summary refs log tree commit diff
path: root/develop/usage/configuration/config_documentation.html
diff options
context:
space:
mode:
authorreivilibre <reivilibre@users.noreply.github.com>2022-08-03 09:41:58 +0000
committerreivilibre <reivilibre@users.noreply.github.com>2022-08-03 09:41:58 +0000
commit1d45f6edb41332b1cd2f8ecc9ef74b585a2acac9 (patch)
tree2b060cf83405f51e4e87987624e3635adab94d58 /develop/usage/configuration/config_documentation.html
parentdeploy: 5eccfdfafdf957739697d667c05fde829cc0f8bc (diff)
downloadsynapse-1d45f6edb41332b1cd2f8ecc9ef74b585a2acac9.tar.xz
deploy: fb7a2cc4cc7f0b49cabeec08d4ceb2dd2350e945
Diffstat (limited to '')
-rw-r--r--develop/usage/configuration/config_documentation.html11
1 files changed, 8 insertions, 3 deletions
diff --git a/develop/usage/configuration/config_documentation.html b/develop/usage/configuration/config_documentation.html
index d1a7d9d242..f2c43e032d 100644
--- a/develop/usage/configuration/config_documentation.html
+++ b/develop/usage/configuration/config_documentation.html
@@ -2167,9 +2167,14 @@ Implicitly enables MAU tracking for application service users.</p>
 </code></pre>
 <hr />
 <h3 id="macaroon_secret_key"><a class="header" href="#macaroon_secret_key"><code>macaroon_secret_key</code></a></h3>
-<p>A secret which is used to sign access tokens. If none is specified,
-the <code>registration_shared_secret</code> is used, if one is given; otherwise,
-a secret key is derived from the signing key.</p>
+<p>A secret which is used to sign</p>
+<ul>
+<li>access token for guest users,</li>
+<li>short-term login token used during SSO logins (OIDC or SAML2) and</li>
+<li>token used for unsubscribing from email notifications.</li>
+</ul>
+<p>If none is specified, the <code>registration_shared_secret</code> is used, if one is given;
+otherwise, a secret key is derived from the signing key.</p>
 <p>Example configuration:</p>
 <pre><code class="language-yaml">macaroon_secret_key: &lt;PRIVATE STRING&gt;
 </code></pre>