mirror of
https://github.com/twentyhq/twenty.git
synced 2026-06-12 09:57:03 -04:00
05f31c1837
## Summary - Documents the new at-rest encryption envelope (`ENCRYPTION_KEY` / `FALLBACK_ENCRYPTION_KEY`) introduced in v2.5+ and clarifies its relationship to the legacy `APP_SECRET`-as-encryption-key path. - Adds a new dedicated **Key rotation** guide covering manual / Enterprise-cron JWT signing-key rotation, signing-key revocation, and the online `ENCRYPTION_KEY` rotation procedure (including the new \`secret-encryption:rotate\` CLI shipped in a follow-up PR). - Updates the docker-compose quickstart to generate a dedicated \`ENCRYPTION_KEY\` from day 1. - Mentions the v2.5+ enc:v2 backfill in the upgrade guide. English-only — the localized mirrors will be picked up by i18n CI. ## Test plan - [ ] Mintlify build passes locally / in CI - [ ] Sidebar entry renders under **Self-Host → Key rotation** - [ ] Internal links to /developers/self-host/capabilities/key-rotation resolve from setup.mdx, docker-compose.mdx and upgrade-guide.mdx --------- Co-authored-by: github-actions <github-actions@twenty.com>
23 lines
650 B
Plaintext
23 lines
650 B
Plaintext
TAG=latest
|
|
|
|
#PG_DATABASE_USER=postgres
|
|
#PG_DATABASE_PASSWORD=replace_me_with_a_strong_password_without_special_characters
|
|
#PG_DATABASE_HOST=db
|
|
#PG_DATABASE_PORT=5432
|
|
#REDIS_URL=redis://redis:6379
|
|
|
|
SERVER_URL=http://localhost:3000
|
|
|
|
# Use openssl rand -base64 32 for each secret
|
|
# ENCRYPTION_KEY=replace_me_with_a_random_string
|
|
# FALLBACK_ENCRYPTION_KEY= # set to the previous ENCRYPTION_KEY during a rotation
|
|
# APP_SECRET= # legacy: only required for instances that pre-date ENCRYPTION_KEY
|
|
|
|
STORAGE_TYPE=local
|
|
|
|
# STORAGE_S3_REGION=eu-west3
|
|
# STORAGE_S3_NAME=my-bucket
|
|
# STORAGE_S3_ENDPOINT=
|
|
# STORAGE_S3_ACCESS_KEY_ID=
|
|
# STORAGE_S3_SECRET_ACCESS_KEY=
|