From 06759901a5b0624edf9c459ad79d4cbcd7bbba7f Mon Sep 17 00:00:00 2001 From: dklimpel <5740567+dklimpel@users.noreply.github.com> Date: Wed, 3 Aug 2022 08:05:59 +0200 Subject: [PATCH 1/2] Update doc for setting `macaroon_secret_key` --- docs/usage/configuration/config_documentation.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md index 6f8d7b7d26cd..7c197671dd42 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md @@ -2538,9 +2538,12 @@ 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 From 8f2df853dce409bb28665e6eb81be36f4f13f8db Mon Sep 17 00:00:00 2001 From: dklimpel <5740567+dklimpel@users.noreply.github.com> Date: Wed, 3 Aug 2022 08:13:48 +0200 Subject: [PATCH 2/2] newsfile --- changelog.d/13443.doc | 1 + docs/usage/configuration/config_documentation.md | 1 + 2 files changed, 2 insertions(+) create mode 100644 changelog.d/13443.doc diff --git a/changelog.d/13443.doc b/changelog.d/13443.doc new file mode 100644 index 000000000000..0db5d1b3b4ed --- /dev/null +++ b/changelog.d/13443.doc @@ -0,0 +1 @@ +Update documentation for config setting `macaroon_secret_key`. \ No newline at end of file diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md index 7c197671dd42..9255c46f8fbb 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md @@ -2542,6 +2542,7 @@ 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.