summary refs log tree commit diff
path: root/docs/upgrade.md
diff options
context:
space:
mode:
authorPatrick Cloke <clokep@users.noreply.github.com>2023-11-28 11:01:24 -0500
committerGitHub <noreply@github.com>2023-11-28 11:01:24 -0500
commit77882b6a7d1ad1ab76b0ff878b3daed894bdb26e (patch)
tree01c34760f3bb2aef2b8cd44a110d5e2f1e325705 /docs/upgrade.md
parentIgnore `encryption_enabled_by_default_for_room_type` for notices room (#16677) (diff)
downloadsynapse-77882b6a7d1ad1ab76b0ff878b3daed894bdb26e.tar.xz
Document which versions of Synapse have compatible schema versions. (#16661)
Diffstat (limited to 'docs/upgrade.md')
-rw-r--r--docs/upgrade.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/upgrade.md b/docs/upgrade.md
index ba2f7703bc..329c9c7787 100644
--- a/docs/upgrade.md
+++ b/docs/upgrade.md
@@ -88,6 +88,15 @@ process, for example:
     dpkg -i matrix-synapse-py3_1.3.0+stretch1_amd64.deb
     ```
 
+Generally Synapse database schemas are compatible across multiple versions, once
+a version of Synapse is deployed you may not be able to rollback automatically.
+The following table gives the version ranges and the earliest version they can
+be rolled back to. E.g. Synapse versions v1.58.0 through v1.61.1 can be rolled
+back safely to v1.57.0, but starting with v1.62.0 it is only safe to rollback to
+v1.61.0.
+
+<!-- REPLACE_WITH_SCHEMA_VERSIONS -->
+
 # Upgrading to v1.93.0
 
 ## Minimum supported Rust version