summary refs log tree commit diff
path: root/UPGRADE.rst
diff options
context:
space:
mode:
Diffstat (limited to 'UPGRADE.rst')
-rw-r--r--UPGRADE.rst21
1 files changed, 18 insertions, 3 deletions
diff --git a/UPGRADE.rst b/UPGRADE.rst

index e62e647a1d..22edfe0d60 100644 --- a/UPGRADE.rst +++ b/UPGRADE.rst
@@ -88,15 +88,30 @@ for example: Upgrading to v1.27.0 ==================== +Changes to callback URI for OAuth2 / OpenID Connect +--------------------------------------------------- + +This version changes the URI used for callbacks from OAuth2 identity providers. If +your server is configured for single sign-on via an OpenID Connect or OAuth2 identity +provider, you will need to add ``[synapse public baseurl]/_synapse/client/oidc/callback`` +to the list of permitted "redirect URIs" at the identity provider. + +See `docs/openid.md <docs/openid.md>`_ for more information on setting up OpenID +Connect. + +(Note: a similar change is being made for SAML2; in this case the old URI +``[synapse public baseurl]/_matrix/saml2`` is being deprecated, but will continue to +work, so no immediate changes are required for existing installations.) + Changes to HTML templates ------------------------- The HTML templates for SSO and email notifications now have `Jinja2's autoescape <https://jinja.palletsprojects.com/en/2.11.x/api/#autoescaping>`_ -enabled for files ending in ``.html``, ``.htm``, and ``.xml``. If you hae customised +enabled for files ending in ``.html``, ``.htm``, and ``.xml``. If you have customised these templates and see issues when viewing them you might need to update them. It is expected that most configurations will need no changes. -If you have customised the templates *names* for these templates it is recommended +If you have customised the templates *names* for these templates, it is recommended to verify they end in ``.html`` to ensure autoescape is enabled. The above applies to the following templates: @@ -235,7 +250,7 @@ shown below: return {"localpart": localpart} -Removal historical Synapse Admin API +Removal historical Synapse Admin API ------------------------------------ Historically, the Synapse Admin API has been accessible under: