summary refs log tree commit diff
path: root/latest/usage
diff options
context:
space:
mode:
authorreivilibre <reivilibre@users.noreply.github.com>2022-12-06 13:36:59 +0000
committerreivilibre <reivilibre@users.noreply.github.com>2022-12-06 13:36:59 +0000
commit1f11b0dd86ad4ddf20ca495d78d595af82c2c54b (patch)
tree0e3fdaf91b0855ac790d2b2c13f9a80f57a3ed71 /latest/usage
parentdeploy: e1779bc69fe217b2a8dac36beb9896f0c9dbfb3e (diff)
downloadsynapse-1f11b0dd86ad4ddf20ca495d78d595af82c2c54b.tar.xz
deploy: a16931f30db35241e6618ddfb14fda2459b4476c
Diffstat (limited to 'latest/usage')
-rw-r--r--latest/usage/administration/admin_api/index.html2
-rw-r--r--latest/usage/configuration/config_documentation.html27
2 files changed, 9 insertions, 20 deletions
diff --git a/latest/usage/administration/admin_api/index.html b/latest/usage/administration/admin_api/index.html
index 2b6447abc1..0d5587271d 100644
--- a/latest/usage/administration/admin_api/index.html
+++ b/latest/usage/administration/admin_api/index.html
@@ -159,7 +159,7 @@ command. This is a script that is distributed as part of synapse. It is possibly
 already on your <code>$PATH</code> depending on how Synapse was installed.</p>
 <p>Finding your user's <code>access_token</code> is client-dependent, but will usually be shown in the client's settings.</p>
 <h2 id="making-an-admin-api-request"><a class="header" href="#making-an-admin-api-request">Making an Admin API request</a></h2>
-<p>For security reasons, we <a href="reverse_proxy.html#synapse-administration-endpoints">recommend</a>
+<p>For security reasons, we <a href="../../../reverse_proxy.html#synapse-administration-endpoints">recommend</a>
 that the Admin API (<code>/_synapse/admin/...</code>) should be hidden from public view using a
 reverse proxy. This means you should typically query the Admin API from a terminal on
 the machine which runs Synapse.</p>
diff --git a/latest/usage/configuration/config_documentation.html b/latest/usage/configuration/config_documentation.html
index e0dc6ee087..65ea84fc77 100644
--- a/latest/usage/configuration/config_documentation.html
+++ b/latest/usage/configuration/config_documentation.html
@@ -2112,24 +2112,6 @@ Defaults to false.</p>
 <pre><code class="language-yaml">enable_metrics: true
 </code></pre>
 <hr />
-<h3 id="enable_legacy_metrics"><a class="header" href="#enable_legacy_metrics"><code>enable_legacy_metrics</code></a></h3>
-<p>Set to <code>true</code> to publish both legacy and non-legacy Prometheus metric names,
-or to <code>false</code> to only publish non-legacy Prometheus metric names.
-Defaults to <code>false</code>. Has no effect if <code>enable_metrics</code> is <code>false</code>.
-<strong>In Synapse v1.67.0 up to and including Synapse v1.70.1, this defaulted to <code>true</code>.</strong></p>
-<p>Legacy metric names include:</p>
-<ul>
-<li>metrics containing colons in the name, such as <code>synapse_util_caches_response_cache:hits</code>, because colons are supposed to be reserved for user-defined recording rules;</li>
-<li>counters that don't end with the <code>_total</code> suffix, such as <code>synapse_federation_client_sent_edus</code>, therefore not adhering to the OpenMetrics standard.</li>
-</ul>
-<p>These legacy metric names are unconventional and not compliant with OpenMetrics standards.
-They are included for backwards compatibility.</p>
-<p>Example configuration:</p>
-<pre><code class="language-yaml">enable_legacy_metrics: false
-</code></pre>
-<p>See https://github.com/matrix-org/synapse/issues/11106 for context.</p>
-<p><em>Since v1.67.0.</em></p>
-<h2 id="will-be-removed-in-v1730"><a class="header" href="#will-be-removed-in-v1730"><strong>Will be removed in v1.73.0.</strong></a></h2>
 <h3 id="sentry"><a class="header" href="#sentry"><code>sentry</code></a></h3>
 <p>Use this option to enable sentry integration. Provide the DSN assigned to you by sentry
 with the <code>dsn</code> setting.</p>
@@ -2631,11 +2613,18 @@ module's <code>parse_config</code> method.</p>
 <p>For the default provider, the following settings are available:</p>
 <ul>
 <li>
-<p>subject_claim: name of the claim containing a unique identifier
+<p><code>subject_claim</code>: name of the claim containing a unique identifier
 for the user. Defaults to 'sub', which OpenID Connect
 compliant providers should provide.</p>
 </li>
 <li>
+<p><code>picture_claim</code>: name of the claim containing an url for the user's profile picture.
+Defaults to 'picture', which OpenID Connect compliant providers should provide
+and has to refer to a direct image file such as PNG, JPEG, or GIF image file.</p>
+<p>Currently only supported in monolithic (single-process) server configurations
+where the media repository runs within the Synapse process.</p>
+</li>
+<li>
 <p><code>localpart_template</code>: Jinja2 template for the localpart of the MXID.
 If this is not set, the user will be prompted to choose their
 own username (see the documentation for the <code>sso_auth_account_details.html</code>