From 74b65bfc5f3c58005e3892b314e73cfde32355f6 Mon Sep 17 00:00:00 2001 From: erikjohnston Date: Tue, 2 Nov 2021 14:27:50 +0000 Subject: deploy: 2d44ee6868805d4ff23489a8dd6b4072ff358663 --- latest/upgrade.html | 66 ++++++++++++++++++++++++++--------------------------- 1 file changed, 33 insertions(+), 33 deletions(-) (limited to 'latest/upgrade.html') diff --git a/latest/upgrade.html b/latest/upgrade.html index 5903e19174..dfba3f66c8 100644 --- a/latest/upgrade.html +++ b/latest/upgrade.html @@ -99,7 +99,7 @@ @@ -337,8 +337,8 @@ of this endpoint modifying the media store.

Deprecation of the current third-party rules module interface

The current third-party rules module interface is deprecated in favour of the new generic modules system introduced in Synapse v1.37.0. Authors of third-party rules modules can refer -to this documentation -to update their modules. Synapse administrators can refer to this documentation +to this documentation +to update their modules. Synapse administrators can refer to this documentation to update their configuration once the modules they are using have been updated.

We plan to remove support for the current third-party rules interface in September 2021.

Upgrading to v1.38.0

@@ -368,9 +368,9 @@ particular server:

Upgrading to v1.37.0

Deprecation of the current spam checker interface

The current spam checker interface is deprecated in favour of a new generic modules system. -Authors of spam checker modules can refer to this -documentation -to update their modules. Synapse administrators can refer to this +Authors of spam checker modules can refer to [this +documentation](modules/porting_legacy_module.md +to update their modules. Synapse administrators can refer to this documentation to update their configuration once the modules they are using have been updated.

We plan to remove support for the current spam checker interface in August 2021.

@@ -448,20 +448,20 @@ Synapse v1.30.0.

Upgrading to v1.29.0

Requirement for X-Forwarded-Proto header

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 +x_forwarded option on an HTTP listener), Synapse now +expects to receive an X-Forwarded-Proto header on incoming HTTP requests. If it is not set, Synapse will log a warning on each received request.

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 X-Forwarded-Proto header to +https or http to indicate the protocol used by the client.

-

Synapse also requires the [Host]{.title-ref} header to be preserved.

+

Synapse also requires the Host header to be preserved.

See the reverse proxy documentation, where the example configurations have been updated to show how to set these headers.

(Users of Caddy are unaffected, since we -believe it sets [X-Forwarded-Proto]{.title-ref} by default.)

+believe it sets X-Forwarded-Proto by default.)

Upgrading to v1.27.0

Changes to callback URI for OAuth2 / OpenID Connect and SAML2

This version changes the URI used for callbacks from OAuth2 and SAML2 @@ -599,13 +599,13 @@ mapping provider to specify different algorithms, instead of the default way.

If your Synapse configuration uses a custom mapping provider -([oidc_config.user_mapping_provider.module]{.title-ref} is specified and +(oidc_config.user_mapping_provider.module is specified and not equal to -[synapse.handlers.oidc_handler.JinjaOidcMappingProvider]{.title-ref}) -then you must ensure that [map_user_attributes]{.title-ref} of the +synapse.handlers.oidc_handler.JinjaOidcMappingProvider) +then you must ensure that map_user_attributes 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 +localpart returned. To match previous behaviour you can +use the map_username_to_mxid_localpart function provided by Synapse. An example is shown below:

from synapse.types import map_username_to_mxid_localpart
 
@@ -630,7 +630,7 @@ v1.24.0. The Admin API is now only accessible under:

 
    
 
  • /_synapse/admin/v1
    • 
 

-
The only exception is the [/admin/whois]{.title-ref} endpoint, which is
+
The only exception is the /admin/whois endpoint, which is
 also available via the client-server
 API.

 
The deprecation of the old endpoints was announced with Synapse 1.20.0
@@ -684,7 +684,7 @@ used if a custom template cannot be found.

 
This page will appear to the user after clicking a password reset link
 that has been emailed to them.

 
To complete password reset, the page must include a way to make a
-[POST]{.title-ref} request to
+POST request to
 /_synapse/client/password_reset/{medium}/submit_token with the query
 parameters from the original link, presented as a URL-encoded form. See
 the file itself for more details.

@@ -702,15 +702,15 @@ but the parameters are slightly different:

 of why a user is seeing the error page.
 
 
Upgrading to v1.18.0

-
Docker [-py3]{.title-ref} suffix will be removed in future versions

+
Docker -py3 suffix will be removed in future versions

 
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
+-py3 tag suffix. The images tagged with the
+-py3 suffix have been identical to the non-suffixed tags
 since release 0.99.0, and the suffix is obsolete.

-
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.

-
Scripts relying on the [-py3]{.title-ref} suffix will need to be
+
On 10th August, we will remove the latest-py3 tag.
+Existing per-release tags (such as v1.18.0-py3 will not
+be removed, but no new -py3 tags will be added.

+
Scripts relying on the -py3 suffix will need to be
 updated.

 
 
When setting up worker processes, we now recommend the use of a Redis
@@ -735,8 +735,8 @@ from v1.2.1 or earlier, to versions between v1.4.0 and v1.12.x.

 are affected can be repaired as follows:

 
    
 
  1. 
-
    Run the following sql from a [psql]{.title-ref} or
-[sqlite3]{.title-ref} console:
    
+
    Run the following sql from a psql or
+sqlite3 console:
    
 
    INSERT INTO background_updates (update_name, progress_json, depends_on) VALUES
    ('populate_stats_process_rooms', '{}', 'current_state_events_membership');
 
@@ -797,8 +797,8 @@ of any problems.
    
 
    2. 
 
  2. 
 
    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 psql or
+sqlite3 console. It is safe to run it while Synapse is
 still running.
    
 
    SELECT MAX(q.v) FROM (
   SELECT (
@@ -1276,9 +1276,9 @@ used on mobile devices).
    
 first need to upgrade the database by running:
    
 
    python scripts/upgrade_db_to_v0.6.0.py <db> <server_name> <signing_key>
 
    
-
    Where []{.title-ref} is the location of the database,
-[<server_name>]{.title-ref} is the server name as specified in the
-synapse configuration, and [<signing_key>]{.title-ref} is the location
+
    Where <db> is the location of the database,
+<server_name> is the server name as specified in the
+synapse configuration, and <signing_key> is the location
 of the signing key as specified in the synapse configuration.
    
 
    This may take some time to complete. Failures of signatures and content
 hashes can safely be ignored.
    
-- 
cgit 1.5.1