Skip to content

Commit fbee4bf

Browse files
committed
Document secrets.encryption_file
Signed-off-by: Kai A. Hiller <[email protected]>
1 parent c8cbb73 commit fbee4bf

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

docs/reference/configuration.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -232,6 +232,21 @@ secrets:
232232
-----END EC PRIVATE KEY-----
233233
```
234234

235+
### `secrets.encryption{_file}`
236+
237+
The encryption secret used for encrypting cookies and database fields. It takes
238+
the form of a 32-bytes-long hex-encoded string. To provide the encryption secret
239+
via file, set `secrets.encryption_file` to the file path; alternatively use
240+
`secrets.encryption` for declaring the secret inline. The options
241+
`secrets.encryption_file` and `secrets.encryption` are mutually exclusive.
242+
243+
If given via file, the encyption secret is only read at application startup.
244+
The secret is not updated when the content of the file changes.
245+
246+
> ⚠️ **Warning** – Do not change the encryption secret after the initial start.
247+
> Changing the encryption secret afterwards will lead to a loss of all
248+
> information stored in the database.
249+
235250
### `secrets.keys`
236251

237252
The service can use a number of key types for signing.

0 commit comments

Comments
 (0)