e10f6bf9af
Setting JWT_SECRET via environment variable was broken by design: the admin panel rotation updates the in-memory binding and persists the new value to data/.jwt_secret, but an env var would silently override it on the next restart, reverting the rotation. The server now always loads JWT_SECRET from data/.jwt_secret (auto-generating it on first start), making the file the single source of truth. Rotation is handled exclusively through the admin panel. - config.ts: drop process.env.JWT_SECRET fallback and JWT_SECRET_IS_GENERATED export; always read from / write to data/.jwt_secret - index.ts: remove the now-obsolete JWT_SECRET startup warning - .env.example, docker-compose.yml, README: remove JWT_SECRET entries - Helm chart: remove JWT_SECRET from secretEnv, secret.yaml, and deployment.yaml; rename generateJwtSecret → generateEncryptionKey and update NOTES.txt and README accordingly
25 lines
1.6 KiB
Plaintext
25 lines
1.6 KiB
Plaintext
1. ENCRYPTION_KEY handling:
|
|
- ENCRYPTION_KEY encrypts stored secrets (API keys, MFA, SMTP, OIDC) at rest.
|
|
- By default, the chart creates a Kubernetes Secret from `secretEnv.ENCRYPTION_KEY` in values.yaml.
|
|
- To generate a random key at install (preserved across upgrades), set `generateEncryptionKey: true`.
|
|
- To use an existing Kubernetes secret, set `existingSecret` to the secret name. The secret must
|
|
contain a key matching `existingSecretKey` (defaults to `ENCRYPTION_KEY`).
|
|
- If left empty, the server auto-generates and persists the key to the data PVC — safe as long as
|
|
the PVC persists.
|
|
- Upgrading from a version that used JWT_SECRET for encryption: set `secretEnv.ENCRYPTION_KEY` to
|
|
your old JWT_SECRET value, then re-save credentials via the admin panel.
|
|
|
|
2. JWT_SECRET is managed entirely by the server:
|
|
- Auto-generated on first start and persisted to the data PVC (data/.jwt_secret).
|
|
- Rotate it via the admin panel (Settings → Danger Zone → Rotate JWT Secret).
|
|
- No Helm configuration needed or supported.
|
|
|
|
3. Example usage:
|
|
- Set an explicit encryption key: `--set secretEnv.ENCRYPTION_KEY=your_enc_key`
|
|
- Generate a random key at install: `--set generateEncryptionKey=true`
|
|
- Use an existing secret: `--set existingSecret=my-k8s-secret`
|
|
- Use a custom key name in the existing secret: `--set existingSecret=my-k8s-secret --set existingSecretKey=MY_ENC_KEY`
|
|
|
|
4. Only one method should be used at a time. If both `generateEncryptionKey` and `existingSecret` are
|
|
set, `existingSecret` takes precedence. Ensure the referenced secret and key exist in the namespace.
|