Files
twenty/packages/twenty-docker/helm/twenty/QUICKSTART.md
T
Don Kendall 8630efc3d7 feat: helm chart (#16808)
# Add Helm Chart

- Introduces a Twenty Helm chart with sensible defaults: internal
Postgres/Redis, auto DB creation/user, migrations, TLS via cert-manager,
and quickstart docs.

## Feedback requested
- Handling replicas > 1 with local storage (warn/force S3?).
- Defaults/guards for ephemeral pods + S3.
2026-01-08 12:45:46 +00:00

1.4 KiB

Twenty Helm Chart - Quick Install

Simple Install

Set your domain and install:

export DOMAIN=crm.example.com

helm install my-twenty ./packages/twenty-docker/helm/twenty \
  --namespace twentycrm --create-namespace --wait \
  --set "server.ingress.hosts[0].host=$DOMAIN" \
  --set "server.ingress.tls[0].hosts[0]=$DOMAIN"

That's it! The chart will:

  • Auto-generate a secure access token
  • Create the PostgreSQL database "twenty" and schema "core" automatically
  • Run TypeORM migrations via server init
  • Enable TLS via cert-manager (acme: true by default for letsencrypt-prod)

Access the App

Visit: https://$DOMAIN

Sign up to create your admin account through the web UI.

Retrieve System Credentials

App secret token (for configuration/integrations):

kubectl get secret tokens -n twentycrm -o jsonpath='{.data.accessToken}' | base64 --decode && echo

Internal PostgreSQL credentials are managed by the chart and not exposed by default. If you need direct access, create your own user in the database pod or use an external PostgreSQL instance.

Jobs for DB creation and migrations have been removed to simplify deployments; the server handles readiness and migrations at startup.

Advanced Configuration

See full README for:

  • External PostgreSQL/Redis
  • S3 storage configuration
  • Custom resource limits

Uninstall

helm uninstall my-twenty -n twentycrm
kubectl delete namespace twentycrm