summary refs log tree commit diff
path: root/develop/print.html
diff options
context:
space:
mode:
authoranoadragon453 <anoadragon453@users.noreply.github.com>2021-10-19 13:14:22 +0000
committeranoadragon453 <anoadragon453@users.noreply.github.com>2021-10-19 13:14:22 +0000
commit5a468c1b2856d3eaac169f3428a51dc430f2e67b (patch)
treec5999bfee57d98c9a931bef9e4a48a55f2ba6636 /develop/print.html
parentdeploy: 95813ff43cc08f2064049050a67e027751d9b091 (diff)
downloadsynapse-5a468c1b2856d3eaac169f3428a51dc430f2e67b.tar.xz
deploy: 5e0e6835416776e4d938f53b3c9a005970f88127
Diffstat (limited to 'develop/print.html')
-rw-r--r--develop/print.html54
1 files changed, 27 insertions, 27 deletions
diff --git a/develop/print.html b/develop/print.html

index fdb7abd8b0..6c5d29243c 100644 --- a/develop/print.html +++ b/develop/print.html
@@ -1758,20 +1758,20 @@ Synapse v1.30.0.</p> <h1 id="upgrading-to-v1290"><a class="header" href="#upgrading-to-v1290">Upgrading to v1.29.0</a></h1> <h2 id="requirement-for-x-forwarded-proto-header"><a class="header" href="#requirement-for-x-forwarded-proto-header">Requirement for X-Forwarded-Proto header</a></h2> <p>When using Synapse with a reverse proxy (in particular, when using the -[x_forwarded]{.title-ref} option on an HTTP listener), Synapse now -expects to receive an [X-Forwarded-Proto]{.title-ref} header on incoming +<code>x_forwarded</code> option on an HTTP listener), Synapse now +expects to receive an <code>X-Forwarded-Proto</code> header on incoming HTTP requests. If it is not set, Synapse will log a warning on each received request.</p> <p>To avoid the warning, administrators using a reverse proxy should ensure -that the reverse proxy sets [X-Forwarded-Proto]{.title-ref} header to -[https]{.title-ref} or [http]{.title-ref} to indicate the protocol used +that the reverse proxy sets <code>X-Forwarded-Proto</code> header to +<code>https</code> or <code>http</code> to indicate the protocol used by the client.</p> -<p>Synapse also requires the [Host]{.title-ref} header to be preserved.</p> +<p>Synapse also requires the <code>Host</code> header to be preserved.</p> <p>See the <a href="reverse_proxy.html">reverse proxy documentation</a>, where the example configurations have been updated to show how to set these headers.</p> <p>(Users of <a href="https://caddyserver.com/">Caddy</a> are unaffected, since we -believe it sets [X-Forwarded-Proto]{.title-ref} by default.)</p> +believe it sets <code>X-Forwarded-Proto</code> by default.)</p> <h1 id="upgrading-to-v1270"><a class="header" href="#upgrading-to-v1270">Upgrading to v1.27.0</a></h1> <h2 id="changes-to-callback-uri-for-oauth2--openid-connect-and-saml2"><a class="header" href="#changes-to-callback-uri-for-oauth2--openid-connect-and-saml2">Changes to callback URI for OAuth2 / OpenID Connect and SAML2</a></h2> <p>This version changes the URI used for callbacks from OAuth2 and SAML2 @@ -1909,13 +1909,13 @@ mapping provider to specify different algorithms, instead of the <a href="https://matrix.org/docs/spec/appendices#mapping-from-other-character-sets">default way</a>.</p> <p>If your Synapse configuration uses a custom mapping provider -([oidc_config.user_mapping_provider.module]{.title-ref} is specified and +(<code>oidc_config.user_mapping_provider.module</code> is specified and not equal to -[synapse.handlers.oidc_handler.JinjaOidcMappingProvider]{.title-ref}) -then you <em>must</em> ensure that [map_user_attributes]{.title-ref} of the +<code>synapse.handlers.oidc_handler.JinjaOidcMappingProvider</code>) +then you <em>must</em> ensure that <code>map_user_attributes</code> of the mapping provider performs some normalisation of the -[localpart]{.title-ref} returned. To match previous behaviour you can -use the [map_username_to_mxid_localpart]{.title-ref} function provided +<code>localpart</code> returned. To match previous behaviour you can +use the <code>map_username_to_mxid_localpart</code> function provided by Synapse. An example is shown below:</p> <pre><code class="language-python">from synapse.types import map_username_to_mxid_localpart @@ -1940,7 +1940,7 @@ v1.24.0. The Admin API is now only accessible under:</p> <ul> <li><code>/_synapse/admin/v1</code></li> </ul> -<p>The only exception is the [/admin/whois]{.title-ref} endpoint, which is +<p>The only exception is the <code>/admin/whois</code> endpoint, which is <a href="https://matrix.org/docs/spec/client_server/r0.6.1#get-matrix-client-r0-admin-whois-userid">also available via the client-server API</a>.</p> <p>The deprecation of the old endpoints was announced with Synapse 1.20.0 @@ -1994,7 +1994,7 @@ used if a custom template cannot be found.</p> <p>This page will appear to the user after clicking a password reset link that has been emailed to them.</p> <p>To complete password reset, the page must include a way to make a -[POST]{.title-ref} request to +<code>POST</code> request to <code>/_synapse/client/password_reset/{medium}/submit_token</code> with the query parameters from the original link, presented as a URL-encoded form. See the file itself for more details.</p> @@ -2012,15 +2012,15 @@ but the parameters are slightly different:</p> of why a user is seeing the error page.</li> </ul> <h1 id="upgrading-to-v1180"><a class="header" href="#upgrading-to-v1180">Upgrading to v1.18.0</a></h1> -<h2 id="docker--py3title-ref-suffix-will-be-removed-in-future-versions"><a class="header" href="#docker--py3title-ref-suffix-will-be-removed-in-future-versions">Docker [-py3]{.title-ref} suffix will be removed in future versions</a></h2> +<h2 id="docker--py3-suffix-will-be-removed-in-future-versions"><a class="header" href="#docker--py3-suffix-will-be-removed-in-future-versions">Docker <code>-py3</code> suffix will be removed in future versions</a></h2> <p>From 10th August 2020, we will no longer publish Docker images with the -[-py3]{.title-ref} tag suffix. The images tagged with the -[-py3]{.title-ref} suffix have been identical to the non-suffixed tags +<code>-py3</code> tag suffix. The images tagged with the +<code>-py3</code> suffix have been identical to the non-suffixed tags since release 0.99.0, and the suffix is obsolete.</p> -<p>On 10th August, we will remove the [latest-py3]{.title-ref} tag. -Existing per-release tags (such as [v1.18.0-py3]{.title-ref}) will not -be removed, but no new [-py3]{.title-ref} tags will be added.</p> -<p>Scripts relying on the [-py3]{.title-ref} suffix will need to be +<p>On 10th August, we will remove the <code>latest-py3</code> tag. +Existing per-release tags (such as <code>v1.18.0-py3</code> will not +be removed, but no new <code>-py3</code> tags will be added.</p> +<p>Scripts relying on the <code>-py3</code> suffix will need to be updated.</p> <h2 id="redis-replication-is-now-recommended-in-lieu-of-tcp-replication"><a class="header" href="#redis-replication-is-now-recommended-in-lieu-of-tcp-replication">Redis replication is now recommended in lieu of TCP replication</a></h2> <p>When setting up worker processes, we now recommend the use of a Redis @@ -2045,8 +2045,8 @@ from v1.2.1 or earlier, to versions between v1.4.0 and v1.12.x.</p> are affected can be repaired as follows:</p> <ol> <li> -<p>Run the following sql from a [psql]{.title-ref} or -[sqlite3]{.title-ref} console:</p> +<p>Run the following sql from a <code>psql</code> or +<code>sqlite3</code> console:</p> <pre><code class="language-sql">INSERT INTO background_updates (update_name, progress_json, depends_on) VALUES ('populate_stats_process_rooms', '{}', 'current_state_events_membership'); @@ -2107,8 +2107,8 @@ of any problems.</p> </li> <li> <p>As an initial check to see if you will be affected, you can try -running the following query from the [psql]{.title-ref} or -[sqlite3]{.title-ref} console. It is safe to run it while Synapse is +running the following query from the <code>psql</code> or +<code>sqlite3</code> console. It is safe to run it while Synapse is still running.</p> <pre><code class="language-sql">SELECT MAX(q.v) FROM ( SELECT ( @@ -2586,9 +2586,9 @@ used on mobile devices).</p> first need to upgrade the database by running:</p> <pre><code>python scripts/upgrade_db_to_v0.6.0.py &lt;db&gt; &lt;server_name&gt; &lt;signing_key&gt; </code></pre> -<p>Where [<db>]{.title-ref} is the location of the database, -[&lt;server_name&gt;]{.title-ref} is the server name as specified in the -synapse configuration, and [&lt;signing_key&gt;]{.title-ref} is the location +<p>Where <code>&lt;db&gt;</code> is the location of the database, +<code>&lt;server_name&gt;</code> is the server name as specified in the +synapse configuration, and <code>&lt;signing_key&gt;</code> is the location of the signing key as specified in the synapse configuration.</p> <p>This may take some time to complete. Failures of signatures and content hashes can safely be ignored.</p>