Document secrets.encryption_file

Signed-off-by: Kai A. Hiller <git@kaialexhiller.de>
This commit is contained in:
Kai A. Hiller
2025-06-02 18:08:39 +02:00
parent 1d88c875e8
commit 6db309f796

View File

@@ -232,6 +232,21 @@ secrets:
-----END EC PRIVATE KEY-----
```
### `secrets.encryption{_file}`
The encryption secret used for encrypting cookies and database fields. It takes
the form of a 32-bytes-long hex-encoded string. To provide the encryption secret
via file, set `secrets.encryption_file` to the file path; alternatively use
`secrets.encryption` for declaring the secret inline. The options
`secrets.encryption_file` and `secrets.encryption` are mutually exclusive.
If given via file, the encyption secret is only read at application startup.
The secret is not updated when the content of the file changes.
> ⚠️ **Warning** Do not change the encryption secret after the initial start.
> Changing the encryption secret afterwards will lead to a loss of all
> information stored in the database.
### `secrets.keys`
The service can use a number of key types for signing.