summary refs log tree commit diff
path: root/docs/usage
diff options
context:
space:
mode:
authorDirk Klimpel <5740567+dklimpel@users.noreply.github.com>2022-08-03 11:41:19 +0200
committerGitHub <noreply@github.com>2022-08-03 10:41:19 +0100
commitfb7a2cc4cc7f0b49cabeec08d4ceb2dd2350e945 (patch)
treea30523b0f350e9821a523c73b09d69f9d510cd6f /docs/usage
parentRename `RateLimitConfig` to `RatelimitSettings` (#13442) (diff)
downloadsynapse-fb7a2cc4cc7f0b49cabeec08d4ceb2dd2350e945.tar.xz
Update doc for setting `macaroon_secret_key` (#13443)
* Update doc for setting `macaroon_secret_key`

* newsfile
Diffstat (limited to 'docs/usage')
-rw-r--r--docs/usage/configuration/config_documentation.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md
index 2e2e59195b..3a9466a837 100644
--- 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