mirrors/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse.git synced 2024-12-14 11:57:44 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Update doc for setting macaroon_secret_key (#13443)

Browse source 
* Update doc for setting `macaroon_secret_key`

* newsfile
This commit is contained in:
Dirk Klimpel 2022-08-03 11:41:19 +02:00 committed by GitHub
parent d6e94ad9d9
commit fb7a2cc4cc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
changelog.d/13443.doc Normal file
View file

@ -0,0 +1 @@
Update documentation for config setting `macaroon_secret_key`.

10
docs/usage/configuration/config_documentation.md
View file

@ -2495,9 +2495,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