summary refs log tree commit diff
diff options
context:
space:
mode:
authorAndrew Morgan <andrew@amorgan.xyz>2020-08-21 11:01:25 +0100
committerAndrew Morgan <andrew@amorgan.xyz>2020-08-21 11:41:56 +0100
commit622946e8818838972e3c5dfb5b145a87cbad2236 (patch)
tree556c27e05ef6662b77fb083d303c9595016bbc06
parentAdd confirmation as a step to the password reset unit tests (diff)
downloadsynapse-622946e8818838972e3c5dfb5b145a87cbad2236.tar.xz
Remind people about the new template in the upgrade notes
-rw-r--r--UPGRADE.rst24
1 files changed, 24 insertions, 0 deletions
diff --git a/UPGRADE.rst b/UPGRADE.rst
index 6492fa011f..c1020ade4a 100644
--- a/UPGRADE.rst
+++ b/UPGRADE.rst
@@ -75,6 +75,30 @@ for example:
      wget https://packages.matrix.org/debian/pool/main/m/matrix-synapse-py3/matrix-synapse-py3_1.3.0+stretch1_amd64.deb
      dpkg -i matrix-synapse-py3_1.3.0+stretch1_amd64.deb
 
+Upgrading to v1.20.0
+====================
+
+New HTML templates
+------------------
+
+A new HTML template,
+`password_reset_confirmation.html <https://github.com/matrix-org/synapse/blob/develop/synapse/res/templates/password_reset_confirmation.html>`_,
+has been added to the ``synapse/res/templates`` directory. If you are using a
+custom template directory, you may want to copy the template over and modify it.
+
+Note that as of v1.20.0, templates do not need to be included in custom template
+directories for Synapse to start. The default templates will be 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`
+request to
+``/_matrix/client/unstable/password_reset/{medium}/submit_token_confirm``
+with the query parameters from the original link. See the file itself for more
+details.
+
 Upgrading to v1.18.0
 ====================