Update doc for setting macaroon_secret_key (matrix-org#13443)

* Update doc for setting `macaroon_secret_key` * newsfile
azmeuk · Aug 8, 2022 · 0dfcf1f · 0dfcf1f
1 parent b9606d8
commit 0dfcf1f
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 3 deletions.
diff --git a/changelog.d/13443.doc b/changelog.d/13443.doc
@@ -0,0 +1 @@
+Update documentation for config setting `macaroon_secret_key`.
diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md
@@ -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