Merge branch 'release-v1.13.0' into develop

* release-v1.13.0: Don't UPGRADE database rows RST indenting Put rollback instructions in upgrade notes Fix changelog typo Oh yeah, RST Absolute URL it is then Fix upgrade notes link Provide summary of upgrade issues in changelog. Fix ) Move next version notes from changelog to upgrade notes Changelog fixes 1.13.0rc1 Documentation on setting up redis (#7446) Rework UI Auth session validation for registration (#7455) Fix errors from malformed log line (#7454) Drop support for redis.dbid (#7450)
matrix-org · May 11, 2020 · 5cf758c · 5cf758c
2 parents 67feea8 + fa4af2c
commit 5cf758c
Show file tree

Hide file tree

Showing 150 changed files with 582 additions and 320 deletions.
diff --git a/CHANGES.md b/CHANGES.md
diff --git a/UPGRADE.rst b/UPGRADE.rst
@@ -78,12 +78,13 @@ for example:
 Upgrading to v1.13.0
 ====================
 
+
 Incorrect database migration in old synapse versions
 ----------------------------------------------------
 
 A bug was introduced in Synapse 1.4.0 which could cause the room directory to
-be incomplete or empty if Synapse was upgraded directly from v1.2.1 or earlier,
-to versions between v1.4.0 and v1.12.x.
+be incomplete or empty if Synapse was upgraded directly from v1.2.1 or
+earlier, to versions between v1.4.0 and v1.12.x.
 
 This will *not* be a problem for Synapse installations which were:
  * created at v1.4.0 or later,
@@ -105,6 +106,42 @@ affected can be repaired as follows:
 
 2. Restart synapse.
 
+New Single Sign-on HTML Templates
+---------------------------------
+
+New templates (``sso_auth_confirm.html``, ``sso_auth_success.html``, and
+``sso_account_deactivated.html``) were added to Synapse. If your Synapse is
+configured to use SSO and a custom  ``sso_redirect_confirm_template_dir``
+configuration then these templates will need to be copied from
+`synapse/res/templates <synapse/res/templates>`_ into that directory.
+
+Synapse SSO Plugins Method Deprecation
+--------------------------------------
+
+Plugins using the ``complete_sso_login`` method of
+``synapse.module_api.ModuleApi`` should update to using the async/await
+version ``complete_sso_login_async`` which includes additional checks. The
+non-async version is considered deprecated.
+
+Rolling back to v1.12.4 after a failed upgrade
+----------------------------------------------
+
+v1.13.0 includes a lot of large changes. If something problematic occurs, you
+may want to roll-back to a previous version of Synapse. Because v1.13.0 also
+includes a new database schema version, reverting that version is also required
+alongside the generic rollback instructions mentioned above. In short, to roll
+back to v1.12.4 you need to:
+
+1. Stop the server
+2. Decrease the schema version in the database:
+
+   .. code:: sql
+    
+      UPDATE schema_version SET version = 57;
+
+3. Downgrade Synapse by following the instructions for your installation method
+   in the "Rolling back to older versions" section above.
+
 
 Upgrading to v1.12.0
 ====================

diff --git a/changelog.d/6446.misc b/changelog.d/6446.misc
diff --git a/changelog.d/6573.bugfix b/changelog.d/6573.bugfix
diff --git a/changelog.d/6634.bugfix b/changelog.d/6634.bugfix
diff --git a/changelog.d/6639.bugfix b/changelog.d/6639.bugfix
diff --git a/changelog.d/6881.misc b/changelog.d/6881.misc
diff --git a/changelog.d/6892.doc b/changelog.d/6892.doc
diff --git a/changelog.d/6899.bugfix b/changelog.d/6899.bugfix
diff --git a/changelog.d/6946.bugfix b/changelog.d/6946.bugfix
diff --git a/changelog.d/6988.doc b/changelog.d/6988.doc
diff --git a/changelog.d/7006.feature b/changelog.d/7006.feature
diff --git a/changelog.d/7009.feature b/changelog.d/7009.feature
diff --git a/changelog.d/7010.misc b/changelog.d/7010.misc
diff --git a/changelog.d/7011.misc b/changelog.d/7011.misc
diff --git a/changelog.d/7024.misc b/changelog.d/7024.misc
diff --git a/changelog.d/7040.feature b/changelog.d/7040.feature
diff --git a/changelog.d/7051.feature b/changelog.d/7051.feature
diff --git a/changelog.d/7068.bugfix b/changelog.d/7068.bugfix
diff --git a/changelog.d/7089.bugfix b/changelog.d/7089.bugfix
diff --git a/changelog.d/7091.doc b/changelog.d/7091.doc
diff --git a/changelog.d/7096.feature b/changelog.d/7096.feature
diff --git a/changelog.d/7102.feature b/changelog.d/7102.feature
diff --git a/changelog.d/7107.doc b/changelog.d/7107.doc
diff --git a/changelog.d/7109.bugfix b/changelog.d/7109.bugfix
diff --git a/changelog.d/7110.misc b/changelog.d/7110.misc
diff --git a/changelog.d/7115.misc b/changelog.d/7115.misc
diff --git a/changelog.d/7116.misc b/changelog.d/7116.misc
diff --git a/changelog.d/7117.bugfix b/changelog.d/7117.bugfix
diff --git a/changelog.d/7118.feature b/changelog.d/7118.feature
diff --git a/changelog.d/7119.doc b/changelog.d/7119.doc
diff --git a/changelog.d/7120.misc b/changelog.d/7120.misc
diff --git a/changelog.d/7128.misc b/changelog.d/7128.misc
diff --git a/changelog.d/7133.bugfix b/changelog.d/7133.bugfix
diff --git a/changelog.d/7136.misc b/changelog.d/7136.misc
diff --git a/changelog.d/7137.removal b/changelog.d/7137.removal
diff --git a/changelog.d/7141.doc b/changelog.d/7141.doc
diff --git a/changelog.d/7146.misc b/changelog.d/7146.misc
diff --git a/changelog.d/7147.doc b/changelog.d/7147.doc
diff --git a/changelog.d/7150.bugfix b/changelog.d/7150.bugfix
diff --git a/changelog.d/7151.bugfix b/changelog.d/7151.bugfix
diff --git a/changelog.d/7152.feature b/changelog.d/7152.feature
diff --git a/changelog.d/7153.feature b/changelog.d/7153.feature
diff --git a/changelog.d/7155.bugfix b/changelog.d/7155.bugfix
diff --git a/changelog.d/7157.misc b/changelog.d/7157.misc
diff --git a/changelog.d/7158.misc b/changelog.d/7158.misc
diff --git a/changelog.d/7159.bugfix b/changelog.d/7159.bugfix
diff --git a/changelog.d/7167.doc b/changelog.d/7167.doc
diff --git a/changelog.d/7171.doc b/changelog.d/7171.doc
diff --git a/changelog.d/7172.misc b/changelog.d/7172.misc
diff --git a/changelog.d/7177.bugfix b/changelog.d/7177.bugfix
diff --git a/changelog.d/7178.bugfix b/changelog.d/7178.bugfix
diff --git a/changelog.d/7181.misc b/changelog.d/7181.misc
diff --git a/changelog.d/7183.misc b/changelog.d/7183.misc
diff --git a/changelog.d/7184.misc b/changelog.d/7184.misc
diff --git a/changelog.d/7185.misc b/changelog.d/7185.misc
diff --git a/changelog.d/7186.feature b/changelog.d/7186.feature
diff --git a/changelog.d/7187.misc b/changelog.d/7187.misc
diff --git a/changelog.d/7188.misc b/changelog.d/7188.misc
diff --git a/changelog.d/7190.misc b/changelog.d/7190.misc
diff --git a/changelog.d/7191.feature b/changelog.d/7191.feature
diff --git a/changelog.d/7192.misc b/changelog.d/7192.misc
diff --git a/changelog.d/7193.misc b/changelog.d/7193.misc
diff --git a/changelog.d/7195.misc b/changelog.d/7195.misc
diff --git a/changelog.d/7199.bugfix b/changelog.d/7199.bugfix
diff --git a/changelog.d/7203.bugfix b/changelog.d/7203.bugfix
diff --git a/changelog.d/7207.misc b/changelog.d/7207.misc
diff --git a/changelog.d/7213.misc b/changelog.d/7213.misc
diff --git a/changelog.d/7219.misc b/changelog.d/7219.misc
diff --git a/changelog.d/7225.misc b/changelog.d/7225.misc
diff --git a/changelog.d/7226.misc b/changelog.d/7226.misc
diff --git a/changelog.d/7228.misc b/changelog.d/7228.misc
diff --git a/changelog.d/7230.feature b/changelog.d/7230.feature
diff --git a/changelog.d/7233.misc b/changelog.d/7233.misc
diff --git a/changelog.d/7234.doc b/changelog.d/7234.doc
diff --git a/changelog.d/7235.feature b/changelog.d/7235.feature
diff --git a/changelog.d/7236.misc b/changelog.d/7236.misc
diff --git a/changelog.d/7237.misc b/changelog.d/7237.misc
diff --git a/changelog.d/7238.doc b/changelog.d/7238.doc
diff --git a/changelog.d/7239.misc b/changelog.d/7239.misc
diff --git a/changelog.d/7240.bugfix b/changelog.d/7240.bugfix
diff --git a/changelog.d/7241.misc b/changelog.d/7241.misc
diff --git a/changelog.d/7243.misc b/changelog.d/7243.misc
diff --git a/changelog.d/7248.doc b/changelog.d/7248.doc
diff --git a/changelog.d/7249.bugfix b/changelog.d/7249.bugfix
diff --git a/changelog.d/7251.doc b/changelog.d/7251.doc
diff --git a/changelog.d/7259.bugfix b/changelog.d/7259.bugfix
diff --git a/changelog.d/7260.bugfix b/changelog.d/7260.bugfix
diff --git a/changelog.d/7261.misc b/changelog.d/7261.misc
diff --git a/changelog.d/7265.feature b/changelog.d/7265.feature
diff --git a/changelog.d/7268.bugfix b/changelog.d/7268.bugfix
diff --git a/changelog.d/7272.doc b/changelog.d/7272.doc
diff --git a/changelog.d/7274.bugfix b/changelog.d/7274.bugfix
diff --git a/changelog.d/7278.misc b/changelog.d/7278.misc
diff --git a/changelog.d/7279.feature b/changelog.d/7279.feature
diff --git a/changelog.d/7286.misc b/changelog.d/7286.misc
diff --git a/changelog.d/7290.misc b/changelog.d/7290.misc
diff --git a/changelog.d/7291.misc b/changelog.d/7291.misc
diff --git a/changelog.d/7295.misc b/changelog.d/7295.misc
diff --git a/changelog.d/7300.misc b/changelog.d/7300.misc
diff --git a/changelog.d/7302.bugfix b/changelog.d/7302.bugfix
diff --git a/changelog.d/7303.misc b/changelog.d/7303.misc
diff --git a/changelog.d/7315.feature b/changelog.d/7315.feature
diff --git a/changelog.d/7316.bugfix b/changelog.d/7316.bugfix
diff --git a/changelog.d/7318.misc b/changelog.d/7318.misc
diff --git a/changelog.d/7319.misc b/changelog.d/7319.misc
diff --git a/changelog.d/7321.misc b/changelog.d/7321.misc
diff --git a/changelog.d/7325.feature b/changelog.d/7325.feature
diff --git a/changelog.d/7326.misc b/changelog.d/7326.misc
diff --git a/changelog.d/7337.bugfix b/changelog.d/7337.bugfix
diff --git a/changelog.d/7338.misc b/changelog.d/7338.misc
diff --git a/changelog.d/7341.bugfix b/changelog.d/7341.bugfix
diff --git a/changelog.d/7343.feature b/changelog.d/7343.feature
diff --git a/changelog.d/7344.bugfix b/changelog.d/7344.bugfix
diff --git a/changelog.d/7352.feature b/changelog.d/7352.feature
diff --git a/changelog.d/7357.doc b/changelog.d/7357.doc
diff --git a/changelog.d/7358.bugfix b/changelog.d/7358.bugfix
diff --git a/changelog.d/7359.misc b/changelog.d/7359.misc
diff --git a/changelog.d/7361.doc b/changelog.d/7361.doc
diff --git a/changelog.d/7363.misc b/changelog.d/7363.misc
diff --git a/changelog.d/7364.misc b/changelog.d/7364.misc
diff --git a/changelog.d/7367.bugfix b/changelog.d/7367.bugfix
diff --git a/changelog.d/7368.bugfix b/changelog.d/7368.bugfix
diff --git a/changelog.d/7369.misc b/changelog.d/7369.misc
diff --git a/changelog.d/7378.misc b/changelog.d/7378.misc
diff --git a/changelog.d/7387.bugfix b/changelog.d/7387.bugfix
diff --git a/changelog.d/7393.bugfix b/changelog.d/7393.bugfix
diff --git a/changelog.d/7394.misc b/changelog.d/7394.misc
diff --git a/changelog.d/7395.misc b/changelog.d/7395.misc
diff --git a/changelog.d/7401.feature b/changelog.d/7401.feature
diff --git a/changelog.d/7404.misc b/changelog.d/7404.misc
diff --git a/changelog.d/7408.misc b/changelog.d/7408.misc
diff --git a/changelog.d/7420.misc b/changelog.d/7420.misc
diff --git a/changelog.d/7421.misc b/changelog.d/7421.misc
diff --git a/changelog.d/7422.feature b/changelog.d/7422.feature
diff --git a/changelog.d/7423.misc b/changelog.d/7423.misc
diff --git a/changelog.d/7426.misc b/changelog.d/7426.misc
diff --git a/changelog.d/7427.feature b/changelog.d/7427.feature
diff --git a/changelog.d/7439.feature b/changelog.d/7439.feature
diff --git a/changelog.d/7442.misc b/changelog.d/7442.misc