Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs on upgrading from a very old version #16951

Merged
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.
22 changes: 22 additions & 0 deletions docs/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,28 @@ 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 anything has changed. But you do not need to perform an
anoadragon453 marked this conversation as resolved.
Show resolved Hide resolved
upgrade to each individual version that was missed.

We do not have a list of which versions must be installed. But, we recommend
anoadragon453 marked this conversation as resolved.
Show resolved Hide resolved
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. Say you are upgrading from 1.48.0, you could update to v1.51.0 (and still
be able to roll back to v1.48.0, or all the way back to v1.39.0), then v1.57.1
(and still roll back to v1.49.0), etc.
anoadragon453 marked this conversation as resolved.
Show resolved Hide resolved

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
anoadragon453 marked this conversation as resolved.
Show resolved Hide resolved
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
[this Admin API](usage/administration/admin_api/background_updates.html#status).
anoadragon453 marked this conversation as resolved.
Show resolved Hide resolved

# 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
Loading