summary refs log tree commit diff
path: root/docs/upgrade.md
diff options
context:
space:
mode:
authorDavid Robertson <davidr@element.io>2023-01-24 15:28:20 +0000
committerGitHub <noreply@github.com>2023-01-24 15:28:20 +0000
commit4607be0b7b2165710dc2e5e68ec4281b593ca8c5 (patch)
tree9d5b3ceb98eb23364ee11f81d70b66077e5c5541 /docs/upgrade.md
parentFaster joins: omit partial rooms from eager syncs until the resync completes ... (diff)
downloadsynapse-4607be0b7b2165710dc2e5e68ec4281b593ca8c5.tar.xz
Request partial joins by default (#14905)
* Request partial joins by default

This is a little sloppy, but we are trying to gain confidence in faster
joins in the upcoming RC.

Admins can still opt out by adding the following to their Synapse
config:

```yaml
experimental:
    faster_joins: false
```

We may revert this change before the release proper, depending on how
testing in the wild goes.

* Changelog

* Try to fix the backfill test failures

* Upgrade notes

* Postgres compat?
Diffstat (limited to 'docs/upgrade.md')
-rw-r--r--docs/upgrade.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/upgrade.md b/docs/upgrade.md
index 0d486a3c82..6316db563b 100644
--- a/docs/upgrade.md
+++ b/docs/upgrade.md
@@ -90,6 +90,19 @@ process, for example:
 
 # Upgrading to v1.76.0
 
+## Faster joins are enabled by default
+
+When joining a room for the first time, Synapse 1.76.0rc1 will request a partial join from the other server by default. Previously, server admins had to opt-in to this using an experimental config flag.
+
+Server admins can opt out of this feature for the time being by setting
+
+```yaml
+experimental:
+    faster_joins: false
+```
+
+in their server config.
+
 ## Changes to the account data replication streams
 
 Synapse has changed the format of the account data and devices replication