Helm (Kubernetes)
The official SolidInvoice Helm chart deploys the application, a background worker, and a scheduler to any Kubernetes cluster. It can also bring up MySQL, PostgreSQL, and Redis via Bitnami subcharts.
Prerequisites
- Kubernetes 1.23+
- Helm 3.2+
- A StorageClass that supports
ReadWriteOncePersistentVolumeClaims (required for the application's secrets vault at/etc/solidinvoice)
Add the Helm repository
helm repo add solidinvoice https://charts.solidinvoice.co
helm repo update
The chart is also indexed on Artifact Hub, where you can browse all available versions, read the full values reference, and copy install commands.
Quick start with MySQL
helm install solidinvoice solidinvoice/solidinvoice \
--set mysql.enabled=true \
--set mysql.auth.password="your-mysql-password" \
--set mysql.auth.rootPassword="your-root-password" \
--set app.secret="your-secret-key"
This brings up SolidInvoice with a bundled MySQL instance. Browse to the pod's URL and complete the installation wizard.
Quick start with PostgreSQL
helm install solidinvoice solidinvoice/solidinvoice \
--set postgresql.enabled=true \
--set postgresql.auth.password="your-pg-password" \
--set app.secret="your-secret-key"
External database
Pass a full DATABASE_URL to skip the bundled database subcharts:
helm install solidinvoice solidinvoice/solidinvoice \
--set externalDatabase.url="mysql://user:password@host:3306/solidinvoice" \
--set app.secret="your-secret-key"
Enable async messaging with Redis
Redis is required for asynchronous background jobs (sending emails, processing payments). When redis.enabled=true the chart configures the Messenger transport automatically:
helm install solidinvoice solidinvoice/solidinvoice \
--set mysql.enabled=true \
--set mysql.auth.password="your-mysql-password" \
--set redis.enabled=true \
--set redis.auth.password="your-redis-password" \
--set app.secret="your-secret-key"
Automated install (skip the web wizard)
Set install.enabled=true to run the installer as a Kubernetes Job during the first deploy, so the wizard step is skipped entirely:
helm install solidinvoice solidinvoice/solidinvoice \
--set mysql.enabled=true \
--set mysql.auth.password="your-mysql-password" \
--set app.secret="your-secret-key" \
--set install.enabled=true \
--set install.adminEmail="admin@example.com" \
--set install.adminPassword="your-admin-password"
Expose via Ingress
helm install solidinvoice solidinvoice/solidinvoice \
--set mysql.enabled=true \
--set mysql.auth.password="your-mysql-password" \
--set app.secret="your-secret-key" \
--set ingress.enabled=true \
--set ingress.hosts[0].host="invoices.example.com" \
--set ingress.tls[0].secretName="solidinvoice-tls" \
--set "ingress.tls[0].hosts[0]=invoices.example.com"
OCI registry (alternative)
The chart is also published to GitHub Container Registry as an OCI artifact. Use this if you prefer OCI-native installs or want to pin to an exact version without adding a repo:
helm install solidinvoice oci://ghcr.io/solidinvoice/charts/solidinvoice --version 3.0.0
Key values reference
| Value | Default | Description |
|---|---|---|
app.secret | (auto-generated if empty) | Application secret — save this; changing it invalidates all sessions and API tokens |
app.locale | en | Default locale |
app.allowRegistration | false | Allow public self-registration |
app.workerMode | false | Enable FrankenPHP persistent worker mode |
install.enabled | false | Run the CLI installer as a Job (skips web wizard) |
install.adminEmail | — | Admin user email (used when install.enabled=true) |
install.adminPassword | — | Admin user password (used when install.enabled=true) |
worker.enabled | true | Deploy the Messenger consumer worker |
worker.replicaCount | 1 | Number of worker pods |
scheduler.enabled | true | Deploy the cron scheduler |
persistence.enabled | true | Create a PVC for /etc/solidinvoice |
persistence.size | 1Gi | PVC size |
ingress.enabled | false | Create an Ingress resource |
Upgrading
Always pass --reuse-values (or re-specify app.secret) so the secret doesn't change between releases:
helm repo update solidinvoice
helm upgrade solidinvoice solidinvoice/solidinvoice --reuse-values
Database migrations run automatically as a pre-upgrade Job before the new pods start.
Persistence
/etc/solidinvoice stores the application's Symfony secrets vault. The PVC is annotated with helm.sh/resource-policy: keep so it is not deleted when you run helm uninstall. Back it up before migrating clusters.
For multi-replica deployments (replicaCount > 1), the PVC must use a ReadWriteMany StorageClass so all pods can share the vault. A ReadWriteOnce PVC only works with a single replica.