Skip to content

Commit

Permalink
Add docs on upgrading from a very old version (#16951)
Browse files Browse the repository at this point in the history
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
  • Loading branch information
Twi1ightSparkle and anoadragon453 committed Feb 22, 2024
1 parent 4ad70f1 commit 8de3283
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 0 deletions.
1 change: 1 addition & 0 deletions changelog.d/16951.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add docs on upgrading from a very old version.
20 changes: 20 additions & 0 deletions docs/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,26 @@ v1.61.0.

<!-- REPLACE_WITH_SCHEMA_VERSIONS -->

## Upgrading from a very old version

You need to read all of the upgrade notes for each version between your current
version and the latest so that you can update your dependencies, environment,
config files, etc. if necessary. But you do not need to perform an
upgrade to each individual version that was missed.

We do not have a list of which versions must be installed. Instead, we recommend
that you upgrade through each incompatible database schema version, which would
give you the ability to roll back the maximum number of versions should anything
go wrong. See [Rolling back to older versions](#rolling-back-to-older-versions)
above.

Additionally, new versions of Synapse will occasionally run database migrations
and background updates to update the database. Synapse will not start until
database migrations are complete. You should wait until background updates from
each upgrade are complete before moving on to the next upgrade, to avoid
stacking them up. You can monitor the currently running background updates with
[the Admin API](usage/administration/admin_api/background_updates.html#status).

# Upgrading to v1.100.0

## Minimum supported Rust version
Expand Down
5 changes: 5 additions & 0 deletions docs/usage/administration/admin_faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,11 @@ for file in $source_directory/*; do
done
```

How do I upgrade from a very old version of Synapse to the latest?
---
See [this](../../upgrade.html#upgrading-from-a-very-old-version) section in the
upgrade docs.

Manually resetting passwords
---
Users can reset their password through their client. Alternatively, a server admin
Expand Down

0 comments on commit 8de3283

Please sign in to comment.