Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Update doc for setting macaroon_secret_key #13443

Merged
merged 2 commits into from
Aug 3, 2022
Merged

Update doc for setting macaroon_secret_key #13443

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0675990
Update doc for setting `macaroon_secret_key`
dklimpel Aug 3, 2022
8f2df85
newsfile
dklimpel Aug 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/13443.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Update documentation for config setting `macaroon_secret_key`.
10 changes: 7 additions & 3 deletions docs/usage/configuration/config_documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2538,9 +2538,13 @@ track_appservice_user_ips: true
---
### `macaroon_secret_key`

A secret which is used to sign access tokens. If none is specified,
the `registration_shared_secret` is used, if one is given; otherwise,
a secret key is derived from the signing key.
A secret which is used to sign
- access token for guest users,
- short-term login token used during SSO logins (OIDC or SAML2) and
- token used for unsubscribing from email notifications.

If none is specified, the `registration_shared_secret` is used, if one is given;
otherwise, a secret key is derived from the signing key.

Example configuration:
```yaml
Expand Down