This documentation site is for the versions of Synapse maintained by the Matrix.org Foundation (github.com/matrix-org/synapse), available under the Apache 2.0 licence.
Before upgrading check if any special steps are required to upgrade from
the version you currently have installed to the current version of
Synapse. The extra instructions that may be required are listed later in
this document.
Check that your versions of Python and PostgreSQL are still
supported.
Synapse follows upstream lifecycles for Python and
PostgreSQL, and removes support for versions
which are no longer maintained.
If Synapse was installed using prebuilt packages,
you will need to follow the normal process for upgrading those packages.
If Synapse was installed using pip then upgrade to the latest
version by running:
pip install --upgrade matrix-synapse
If Synapse was installed from source, then:
Obtain the latest version of the source code. Git users can run
git pull to do this.
If you're running Synapse in a virtualenv, make sure to activate it before
upgrading. For example, if Synapse is installed in a virtualenv in ~/synapse/env then
run:
Include any relevant extras between square brackets, e.g. pip install --upgrade ".[postgres,oidc]".
If you're using poetry to manage a Synapse installation, run:
poetry install
Include any relevant extras with --extras, e.g. poetry install --extras postgres --extras oidc.
It's probably easiest to run poetry install --extras all.
Restart Synapse:
synctl restart
To check whether your update was successful, you can check the running
server version with:
# you may need to replace 'localhost:8008' if synapse is not configured
# to listen on port 8008.
curl http://localhost:8008/_synapse/admin/v1/server_version
Rolling back to previous releases can be difficult, due to database
schema changes between releases. Where we have been able to test the
rollback process, this will be noted below.
In general, you will need to undo any changes made during the upgrade
process, for example:
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.
The minimum supported Rust version has been increased from v1.60.0 to v1.61.0.
Users building from source will need to ensure their rustc version is up to
date.
Synapse v1.81.0 deprecated application service authorization via query parameters as this is
considered insecure - and from Synapse v1.71.0 forwards the application service token has also been sent via
the Authorization header], making the insecure
query parameter authorization redundant. Since removing the ability to continue to use query parameters could break
backwards compatibility it has now been put behind a configuration option, use_appservice_legacy_authorization.
This option defaults to false, but can be activated by adding
Application services can no longer call /register with a user property to create new users.
The standard username property should be used instead. See the
Application Service specification
for more information.
Please ensure that you have migrated to using main on your shared configuration's instance_map
(or create one if necessary). This is required if you have any workers at all;
administrators of single-process (monolith) installations don't need to do anything.
The minimum supported Rust version has been increased from v1.58.1 to v1.60.0.
Users building from source will need to ensure their rustc version is up to
date.
Application services should ensure they call the /register endpoint with a
username property. The legacy user property is considered deprecated and
should no longer be included.
A future version of Synapse (v1.88.0 or later) will remove support for legacy
application service login.
should now be removed from individual worker YAML configurations and the main process should instead be added to the instance_map
in the shared YAML configuration, using the name main.
The old worker_replication_* settings are now considered deprecated and are expected to be removed in Synapse v1.88.0.
Synapse now attempts the versioned appservice paths before falling back to the
legacy paths.
Usage of the legacy routes should be considered deprecated.
Additionally, Synapse has supported sending the application service access token
via the Authorization header
since v1.70.0. For backwards compatibility it is also sent as the access_token
query parameter. This is insecure and should be considered deprecated.
A future version of Synapse (v1.88.0 or later) will remove support for legacy
application service routes and query parameter authorization.
Before this update, the
POST /_matrix/client/v3/rooms/{roomId}/report/{eventId}
endpoint would return a 403 if a user attempted to report an event that they did not have access to.
This endpoint will now return a 404 in this case instead.
Clients that implement event reporting should check that their error handling code will handle this
change.
Synapse v1.79.0 deprecates the
on_threepid_bind
"third-party rules" Synapse module callback method in favour of a new module method,
on_add_user_third_party_identifier.
on_threepid_bind will be removed in a future version of Synapse. You should check whether any Synapse
modules in use in your deployment are making use of on_threepid_bind, and update them where possible.
The arguments and functionality of the new method are the same.
The justification behind the name change is that the old method's name, on_threepid_bind, was
misleading. A user is considered to "bind" their third-party ID to their Matrix ID only if they
do so via an identity server
(so that users on other homeservers may find them). But this method was not called in that case -
it was only called when a user added a third-party identifier on the local homeserver.
Module developers may also be interested in the related
on_remove_user_third_party_identifier
module callback method that was also added in Synapse v1.79.0. This new method is called when a
user removes a third-party identifier from their account.
Synapse 1.78.0 replaces the /_synapse/admin/v1/media/<server_name>/delete
admin API with an identical endpoint at /_synapse/admin/v1/media/delete. Please
update your tooling to use the new endpoint. The deprecated version will be removed
in a future release.
When joining a room for the first time, Synapse 1.76.0 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
Synapse has changed the format of the account data and devices replication
streams (between workers). This is a forwards- and backwards-incompatible
change: v1.75 workers cannot process account data replicated by v1.76 workers,
and vice versa.
Once all workers are upgraded to v1.76 (or downgraded to v1.75), account data
and device replication will resume as normal.
The minimum supported version of Poetry is now 1.3.2 (previously 1.2.0, since
Synapse 1.67). If you have used poetry install to
install Synapse from a source checkout, you should upgrade poetry: see its
installation instructions.
For all other installation methods, no acction is required.
If you want to take advantage of this feature you need to install PyICU,
the ICU native dependency and its development headers
so that PyICU can build since no prebuilt wheels are available.
You can follow the PyICU documentation to do so,
and then do pip install matrix-synapse[user-search] for a PyPI install.
Docker images and Debian packages need nothing specific as they already
include or specify ICU as an explicit dependency.
Synapse 1.74 queues a background update
to rebuild the user directory,
in order to fix missing or erroneous entries.
When this update begins, the user directory will be cleared out and rebuilt from
scratch. User directory lookups will be incomplete until the rebuild completes.
Admins can monitor the rebuild's progress by using the
Background update Admin API.
Synapse v1.69.0 included the deprecation of legacy Prometheus metric names
and offered an option to disable them.
Synapse v1.71.0 disabled legacy Prometheus metric names by default.
This version, v1.73.0, removes those legacy Prometheus metric names entirely.
This also means that the enable_legacy_metrics configuration option has been
removed; it will no longer be possible to re-enable the legacy metric names.
If you use metrics and have not yet updated your Grafana dashboard(s),
Prometheus console(s) or alerting rule(s), please consider doing so when upgrading
to this version.
Note that the included Grafana dashboard was updated in v1.72.0 to correct some
metric names which were missed when legacy metrics were disabled by default.
To align with spec (changed in
MSC3905), Synapse now
only considers local users to be interesting. In other words, the users namespace
regex is only be applied against local users of the homeserver.
Please note, this probably doesn't affect the expected behavior of your application
service, since an interesting local user in a room still means all messages in the room
(from local or remote users) will still be considered interesting. And matching a room
with the rooms or aliases namespace regex will still consider all events sent in the
room to be interesting to the application service.
If one of your application service's users regex was intending to match a remote user,
this will no longer match as you expect. The behavioral mismatch between matching all
local users and some remote users is why the spec was changed/clarified and this
caveat is no longer supported.
Synapse v1.71.0 disables legacy Prometheus metric names by default.
For administrators that still rely on them and have not yet had chance to update their
uses of the metrics, it's still possible to specify enable_legacy_metrics: true in
the configuration to re-enable them temporarily.
Synapse v1.73.0 will remove legacy metric names altogether and at that point,
it will no longer be possible to re-enable them.
If you do not use metrics or you have already updated your Grafana dashboard(s),
Prometheus console(s) and alerting rule(s), there is no action needed.
Synapse now includes information indicating if a receipt applies to a thread when
replicating it to other workers. This is a forwards- and backwards-incompatible
change: v1.68 and workers cannot process receipts replicated by v1.69 workers, and
vice versa.
Once all workers are upgraded to v1.69 (or downgraded to v1.68), receipts
replication will resume as normal.
In current versions of Synapse, some Prometheus metrics are emitted under two different names,
with one of the names being older but non-compliant with OpenMetrics and Prometheus conventions
and one of the names being newer but compliant.
Synapse v1.71.0 will turn the old metric names off by default.
For administrators that still rely on them and have not had chance to update their
uses of the metrics, it's possible to specify enable_legacy_metrics: true in
the configuration to re-enable them temporarily.
Synapse v1.73.0 will remove legacy metric names altogether and it will no longer
be possible to re-enable them.
The Grafana dashboard, Prometheus recording rules and Prometheus Consoles included
in the contrib directory in the Synapse repository have been updated to no longer
rely on the legacy names. These can be used on a current version of Synapse
because current versions of Synapse emit both old and new names.
You may need to update your alerting rules or any other rules that depend on
the names of Prometheus metrics.
If you want to test your changes before legacy names are disabled by default,
you may specify enable_legacy_metrics: false in your homeserver configuration.
Redis support was added in v1.13.0 with it becoming the recommended method in
v1.18.0. It replaced the old direct TCP connections (which was deprecated as of
v1.18.0) to the main process. With Redis, rather than all the workers connecting
to the main process, all the workers and the main process connect to Redis,
which relays replication commands between processes. This can give a significant
CPU saving on the main process and is a prerequisite for upcoming
performance improvements.
To migrate to Redis add the redis config,
and remove the TCP replication listener from config of the master and
worker_replication_port from worker config. Note that a HTTP listener with a
replication resource is still required.
From the next major release (v1.68.0) installing Synapse from a source checkout
will require a recent Rust compiler. Those using packages or
pip install matrix-synapse will not be affected.
The simplest way of installing Rust is via rustup.rs
From the next major release (v1.68.0) Synapse will require SQLite 3.27.0 or
higher. Synapse v1.67.0 will be the last major release supporting SQLite
versions 3.22 to 3.26.
Those using Docker images or Debian packages from Matrix.org will not be
affected. If you have installed from source, you should check the version of
SQLite used by Python with:
As of this version, Synapse no longer allows the tasks of verifying email address
ownership, and password reset confirmation, to be delegated to an identity server.
This removal was previously planned for Synapse 1.64.0, but was
delayed until now to give
homeserver administrators more notice of the change.
To continue to allow users to add email addresses to their homeserver accounts,
and perform password resets, make sure that Synapse is configured with a working
email server in the email configuration
section
(including, at a minimum, a notif_from setting.)
Specifying an email setting under account_threepid_delegates will now cause
an error at startup.
Synapse v1.66.0 will remove the ability to delegate the tasks of verifying email address ownership, and password reset confirmation, to an identity server.
If you require your homeserver to verify e-mail addresses or to support password resets via e-mail, please configure your homeserver with SMTP access so that it can send e-mails on its own behalf.
Consult the configuration documentation for more information.
The option that will be removed is account_threepid_delegates.email.
Synapse now includes a flag indicating if an event is an outlier when
replicating it to other workers. This is a forwards- and backwards-incompatible
change: v1.63 and workers cannot process events replicated by v1.64 workers, and
vice versa.
Once all workers are upgraded to v1.64 (or downgraded to v1.63), event
replication will resume as normal.
frozendict 2.3.3
has recently been released, which fixes a memory leak that occurs during /sync
requests. We advise server administrators who installed Synapse via pip to upgrade
frozendict with pip install --upgrade frozendict. The Docker image
matrixdotorg/synapse and the Debian packages from packages.matrix.org already
include the updated library.
As a followup to changes in v1.60.0, the following spam-checker callbacks have changed signature:
user_may_join_room
user_may_invite
user_may_send_3pid_invite
user_may_create_room
user_may_create_room_alias
user_may_publish_room
check_media_file_for_spam
For each of these methods, the previous callback signature has been deprecated.
Whereas callbacks used to return bool, they should now return Union["synapse.module_api.NOT_SPAM", "synapse.module_api.errors.Codes"].
For instance, if your module implements user_may_join_room as follows:
async def user_may_join_room(self, user_id: str, room_id: str, is_invited: bool)
if ...:
# Request is spam
return False
# Request is not spam
return True
you should rewrite it as follows:
async def user_may_join_room(self, user_id: str, room_id: str, is_invited: bool)
if ...:
# Request is spam, mark it as forbidden (you may use some more precise error
# code if it is useful).
return synapse.module_api.errors.Codes.FORBIDDEN
# Request is not spam, mark it as such.
return synapse.module_api.NOT_SPAM
This release of Synapse will add a unique index to the state_group_edges table, in order
to prevent accidentally introducing duplicate information (for example, because a database
backup was restored multiple times).
Duplicate rows being present in this table could cause drastic performance problems; see
issue 11779 for more details.
If your Synapse database already has had duplicate rows introduced into this table,
this could fail, with either of these errors:
On Postgres:
synapse.storage.background_updates - 623 - INFO - background_updates-0 - Adding index state_group_edges_unique_idx to state_group_edges
synapse.storage.background_updates - 282 - ERROR - background_updates-0 - Error doing update
...
psycopg2.errors.UniqueViolation: could not create unique index "state_group_edges_unique_idx"
DETAIL: Key (state_group, prev_state_group)=(2, 1) is duplicated.
BEGIN;
DELETE FROM state_group_edges WHERE (ctid, state_group, prev_state_group) IN (
SELECT row_id, state_group, prev_state_group
FROM (
SELECT
ctid AS row_id,
MIN(ctid) OVER (PARTITION BY state_group, prev_state_group) AS min_row_id,
state_group,
prev_state_group
FROM state_group_edges
) AS t1
WHERE row_id <> min_row_id
);
COMMIT;
At the command-line, use sqlite3 path/to/your-homeserver-database.db:
BEGIN;
DELETE FROM state_group_edges WHERE (rowid, state_group, prev_state_group) IN (
SELECT row_id, state_group, prev_state_group
FROM (
SELECT
rowid AS row_id,
MIN(rowid) OVER (PARTITION BY state_group, prev_state_group) AS min_row_id,
state_group,
prev_state_group
FROM state_group_edges
)
WHERE row_id <> min_row_id
);
COMMIT;
Whereas check_event_for_spam callbacks used to return Union[str, bool], they should now return Union["synapse.module_api.NOT_SPAM", "synapse.module_api.errors.Codes"].
This is part of an ongoing refactoring of the SpamChecker API to make it less ambiguous and more powerful.
If your module implements check_event_for_spam as follows:
async def check_event_for_spam(event):
if ...:
# Event is spam
return True
# Event is not spam
return False
you should rewrite it as follows:
async def check_event_for_spam(event):
if ...:
# Event is spam, mark it as forbidden (you may use some more precise error
# code if it is useful).
return synapse.module_api.errors.Codes.FORBIDDEN
# Event is not spam, mark it as such.
return synapse.module_api.NOT_SPAM
The names of user devices are no longer visible to users on other homeservers by default.
Device IDs are unaffected, as these are necessary to facilitate end-to-end encryption.
The synapse.app.appservice worker application type allowed you to configure a
single worker to use to notify application services of new events, as long
as this functionality was disabled on the main process with notify_appservices: False.
Further, the synapse.app.user_dir worker application type allowed you to configure
a single worker to be responsible for updating the user directory, as long as this
was disabled on the main process with update_user_directory: False.
To unify Synapse's worker types, the synapse.app.appservice worker application
type and the notify_appservices configuration option have been deprecated.
The synapse.app.user_dir worker application type and update_user_directory
configuration option have also been deprecated.
To get the same functionality as was provided by the deprecated options, it's now recommended that the synapse.app.generic_worker
worker application type is used and that the notify_appservices_from_worker and/or
update_user_directory_from_worker options are set to the name of a worker.
For the time being, the old options can be used alongside the new options to make
it easier to transition between the two configurations, however please note that:
the options must not contradict each other (otherwise Synapse won't start); and
the notify_appservices and update_user_directory options will be removed in a future release of Synapse.
Synapse v1.57.0 includes a change to the
way transaction IDs are managed for application services. If your deployment uses a dedicated
worker for application service traffic, it must be stopped when the database is upgraded
(which normally happens when the main process is upgraded), to ensure the change is made safely
without any risk of reusing transaction IDs.
Deployments which do not use separate worker processes can be upgraded as normal. Similarly,
deployments where no application services are in use can be upgraded as normal.
Recovering from an incorrect upgrade
If the database schema is upgraded without stopping the worker responsible
for AS traffic, then the following error may be given when attempting to start
a Synapse worker or master process:
**********************************************************************************
Error during initialisation:
Postgres sequence 'application_services_txn_id_seq' is inconsistent with associated
table 'application_services_txns'. This can happen if Synapse has been downgraded and
then upgraded again, or due to a bad migration.
To fix this error, shut down Synapse (including any and all workers)
and run the following SQL:
SELECT setval('application_services_txn_id_seq', (
SELECT GREATEST(MAX(txn_id), 0) FROM application_services_txns
));
See docs/postgres.md for more information.
There may be more information in the logs.
**********************************************************************************
This error may also be seen if Synapse is downgraded to an earlier version,
and then upgraded again to v1.57.0 or later.
In either case:
Ensure that the worker responsible for AS traffic is stopped.
Run the SQL command given in the error message via psql.
Synapse will refuse to start if registration is enabled without email, captcha, or token-based verification unless the new config
flag enable_registration_without_verification is set to "true".
Synapse now refuses to start when using PostgreSQL with non-C values for COLLATE and
CTYPE unless the config flag allow_unsafe_locale, found in the database section of
the configuration file, is set to true. See the PostgreSQL documentation
for more information and instructions on how to fix a database with incorrect values.
The synctl script
has been made an
entry point
and no longer exists at the root of Synapse's source tree. If you wish to use
synctl to manage your homeserver, you should invoke synctl directly, e.g.
synctl start instead of ./synctl start or /path/to/synctl start.
When installing from a wheel, sdist, or PyPI, a synctl executable is added
to your Python installation's bin. This should be on your PATH
automatically, though you might need to activate a virtual environment
depending on how you installed Synapse.
Synapse v1.55.0 drops support for Mjolnir 1.3.1 and earlier.
If you use the Mjolnir module to moderate your homeserver,
please upgrade Mjolnir to version 1.3.2 or later before upgrading Synapse.
This release removes support for the structured: true logging configuration
which was deprecated in Synapse v1.23.0. If your logging configuration contains
structured: true then it should be modified based on the
structured logging documentation.
Per the deprecation notice in Synapse v1.51.0, listeners of type webclient
are no longer supported and configuring them is a now a configuration error.
Configuring a non-HTTP(S) web_client_location configuration is is now a
configuration error. Since the webclient listener is no longer supported, this
setting only applies to the root path / of Synapse's web server and no longer
the /_matrix/client/ path.
Formerly, entries in the cache were not evicted regardless of whether they were accessed after storing.
This behavior has now changed. By default entries in the cache are now evicted after 30m of not being accessed.
To change the default behavior, go to the caches section of the config and change the expire_caches and
cache_entry_ttl flags as necessary. Please note that these flags replace the expiry_time flag in the config.
The expiry_time flag will still continue to work, but it has been deprecated and will be removed in the future.
As announced with the release of Synapse 1.47.0,
the deprecated user_may_create_room_with_invites module callback has been removed.
Modules relying on it can instead implement user_may_invite
and use the get_room_state
module API to infer whether the invite is happening while creating a room (see this function
as an example). Alternately, modules can also implement on_create_room.
Note that Twisted 22.1.0
has recently been released, which fixes a security issue
within the Twisted library. We do not believe Synapse is affected by this vulnerability,
though we advise server administrators who installed Synapse via pip to upgrade Twisted
with pip install --upgrade Twisted treq as a matter of good practice. The Docker image
matrixdotorg/synapse and the Debian packages from packages.matrix.org are using the
updated library.
The user_may_create_room_with_invites is deprecated and will be removed in a future
version of Synapse. Modules implementing this callback can instead implement
user_may_invite
and use the get_room_state
module API method to infer whether the invite is happening in the context of creating a
room.
Media storage provider modules that read from the Synapse configuration object (i.e. that
read the value of hs.config.[...]) now need to specify the configuration section they're
reading from. This means that if a module reads the value of e.g. hs.config.media_store_path,
it needs to replace it with hs.config.media.media_store_path.
The url_cache/ and url_cache_thumbnails/ directories in the media store are
no longer mirrored to storage providers. These two directories can be safely
deleted from any configured storage providers to reclaim space.
The available worker applications documentation
has been updated to reflect that calls to the /spaces, /hierarchy, and
/summary endpoints can now be routed to workers for both client API and
federation requests.
Since Synapse 1.6.0 (2019-11-26) you can set a proxy for outbound HTTP requests via
http_proxy/https_proxy environment variables. This proxy was set for:
push
url previews
phone-home stats
recaptcha validation
CAS auth validation
OpenID Connect
Federation (checking public key revocation)
In this version we have added support for outbound requests for:
Outbound federation
Downloading remote media
Fetching public keys of other servers
These requests use the same proxy configuration. If you have a proxy configuration we
recommend to verify the configuration. It may be necessary to adjust the no_proxy
environment variable.
The template_dir settings in the sso, account_validity and email sections of the
configuration file are now deprecated. Server admins should use the new
templates.custom_template_directory setting in the configuration file and use one single
custom template directory for all aforementioned features. Template file names remain
unchanged. See the related documentation
for more information and examples.
We plan to remove support for these settings in October 2021.
The media repository worker documentation
has been updated to reflect that calls to /_synapse/admin/v1/users/{userId}/media
must now be handled by media repository workers. This is due to the new DELETE method
of this endpoint modifying the media store.
The current third-party rules module interface is deprecated in favour of the new generic
modules system introduced in Synapse v1.37.0. Authors of third-party rules modules can refer
to this documentation
to update their modules. Synapse administrators can refer to this documentation
to update their configuration once the modules they are using have been updated.
We plan to remove support for the current third-party rules interface in September 2021.
This release includes a database schema update which requires re-indexing one of
the larger tables in the database, events. This could result in increased
disk I/O for several hours or days after upgrading while the migration
completes. Furthermore, because we have to keep the old indexes until the new
indexes are ready, it could result in a significant, temporary, increase in
disk space.
To get a rough idea of the disk space required, check the current size of one
of the indexes. For example, from a psql shell, run the following sql:
We need to rebuild four indexes, so you will need to multiply this result
by four to give an estimate of the disk space required. For example, on one
particular server:
The current spam checker interface is deprecated in favour of a new generic modules system.
Authors of spam checker modules can refer to [this
documentation](modules/porting_legacy_module.md
to update their modules. Synapse administrators can refer to this
documentation
to update their configuration once the modules they are using have been updated.
We plan to remove support for the current spam checker interface in August 2021.
More module interfaces will be ported over to this new generic system in future versions
of Synapse.
This may affect you if you have enabled the account validity feature,
and have made use of a custom HTML template specified by the
account_validity.template_dir or
account_validity.account_renewed_html_path Synapse config options.
The template can now accept an expiration_ts variable, which
represents the unix timestamp in milliseconds for the future date of
which their account has been renewed until. See the default
template
for an example of usage.
ALso note that a new HTML template, account_previously_renewed.html,
has been added. This is is shown to users when they attempt to renew
their account with a valid renewal token that has already been used
before. The default template contents can been found
here,
and can also accept an expiration_ts variable. This template replaces
the error message users would previously see upon attempting to use a
valid renewal token more than once.
This release introduces a
regression that can
overwhelm connected Prometheus instances. This issue is not present in
Synapse v1.32.0rc1.
If you have been affected, please downgrade to 1.31.0. You then may need
to remove excess writeahead logs in order for Prometheus to recover.
Instructions for doing so are provided
here.
In compliance with the Application Service
spec,
Application Services are now required to use the
m.login.application_service type when registering users via the
/_matrix/client/r0/register endpoint. This behaviour was deprecated in
Synapse v1.30.0.
Please ensure your Application Services are up to date.
When using Synapse with a reverse proxy (in particular, when using the
x_forwarded option on an HTTP listener), Synapse now
expects to receive an X-Forwarded-Proto header on incoming
HTTP requests. If it is not set, Synapse will log a warning on each
received request.
To avoid the warning, administrators using a reverse proxy should ensure
that the reverse proxy sets X-Forwarded-Proto header to
https or http to indicate the protocol used
by the client.
Synapse also requires the Host header to be preserved.
See the reverse proxy documentation, where the
example configurations have been updated to show how to set these
headers.
(Users of Caddy are unaffected, since we
believe it sets X-Forwarded-Proto by default.)
This version changes the URI used for callbacks from OAuth2 and SAML2
identity providers:
If your server is configured for single sign-on via an OpenID
Connect or OAuth2 identity provider, you will need to add
[synapse public baseurl]/_synapse/client/oidc/callback to the list
of permitted "redirect URIs" at the identity provider.
See the OpenID docs for more information on setting
up OpenID Connect.
If your server is configured for single sign-on via a SAML2 identity
provider, you will need to add
[synapse public baseurl]/_synapse/client/saml2/authn_response as a
permitted "ACS location" (also known as "allowed callback URLs")
at the identity provider.
The "Issuer" in the "AuthnRequest" to the SAML2 identity
provider is also updated to
[synapse public baseurl]/_synapse/client/saml2/metadata.xml. If
your SAML2 identity provider uses this property to validate or
otherwise identify Synapse, its configuration will need to be
updated to use the new URL. Alternatively you could create a new,
separate "EntityDescriptor" in your SAML2 identity provider with
the new URLs and leave the URLs in the existing "EntityDescriptor"
as they were.
The HTML templates for SSO and email notifications now have Jinja2's
autoescape
enabled for files ending in .html, .htm, and .xml. If you have
customised these templates and see issues when viewing them you might
need to update them. It is expected that most configurations will need
no changes.
If you have customised the templates names for these templates, it is
recommended to verify they end in .html to ensure autoescape is
enabled.
The above applies to the following templates:
add_threepid.html
add_threepid_failure.html
add_threepid_success.html
notice_expiry.html
notice_expiry.html
notif_mail.html (which, by default, includes room.html and
notif.html)
v1.26.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.26.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.25.0 you need
to:
Stop the server
Decrease the schema version in the database:
UPDATE schema_version SET version = 58;
Delete the ignored users & chain cover data:
DROP TABLE IF EXISTS ignored_users;
UPDATE rooms SET has_auth_chain_index = false;
DELETE FROM event_auth_chain_links;
DELETE FROM event_auth_chains;
Mark the deltas as not run (so they will re-run on upgrade).
DELETE FROM applied_schema_deltas WHERE version = 59 AND file = "59/01ignored_user.py";
DELETE FROM applied_schema_deltas WHERE version = 59 AND file = "59/06chain_cover_index.sql";
Downgrade Synapse by following the instructions for your
installation method in the "Rolling back to older versions"
section above.
This is the last release of Synapse which guarantees support with Python
3.5, which passed its upstream End of Life date several months ago.
We will attempt to maintain support through March 2021, but without
guarantees.
In the future, Synapse will follow upstream schedules for ending support
of older versions of Python and PostgreSQL. Please upgrade to at least
Python 3.6 and PostgreSQL 9.6 as soon as possible.
Synapse v1.25.0 includes new settings, ip_range_blacklist and
ip_range_whitelist, for controlling outgoing requests from Synapse for
federation, identity servers, push, and for checking key validity for
third-party invite events. The previous setting,
federation_ip_range_blacklist, is deprecated. The new
ip_range_blacklist defaults to private IP ranges if it is not defined.
If you have never customised federation_ip_range_blacklist it is
recommended that you remove that setting.
If you have customised federation_ip_range_blacklist you should update
the setting name to ip_range_blacklist.
If you have a custom push server that is reached via private IP space
you may need to customise ip_range_blacklist or ip_range_whitelist.
This release allows the OpenID Connect mapping provider to perform
normalisation of the localpart of the Matrix ID. This allows for the
mapping provider to specify different algorithms, instead of the
default
way.
If your Synapse configuration uses a custom mapping provider
(oidc_config.user_mapping_provider.module is specified and
not equal to
synapse.handlers.oidc_handler.JinjaOidcMappingProvider)
then you must ensure that map_user_attributes of the
mapping provider performs some normalisation of the
localpart returned. To match previous behaviour you can
use the map_username_to_mxid_localpart function provided
by Synapse. An example is shown below:
from synapse.types import map_username_to_mxid_localpart
class MyMappingProvider:
def map_user_attributes(self, userinfo, token):
# ... your custom logic ...
sso_user_id = ...
localpart = map_username_to_mxid_localpart(sso_user_id)
return {"localpart": localpart}
The deprecation of the old endpoints was announced with Synapse 1.20.0
(released on 2020-09-22) and makes it easier for homeserver admins to
lock down external access to the Admin API endpoints.
This release deprecates use of the structured: true logging
configuration for structured logging. If your logging configuration
contains structured: true then it should be modified based on the
structured logging documentation.
The structured and drains logging options are now deprecated and
should be replaced by standard logging configuration of handlers and
formatters.
A future will release of Synapse will make using structured: true an
error.
This release introduces a backwards-incompatible change to modules
making use of ThirdPartyEventRules in Synapse. If you make use of a
module defined under the third_party_event_rules config option, please
make sure it is updated to handle the below change:
The http_client argument is no longer passed to modules as they are
initialised. Instead, modules are expected to make use of the
http_client property on the ModuleApi class. Modules are now passed
a module_api argument during initialisation, which is an instance of
ModuleApi. ModuleApi instances have a http_client property which
acts the same as the http_client argument previously passed to
ThirdPartyEventRules modules.
The reverse proxy documentation
has been updated to include reverse proxy directives for
/_synapse/client/* endpoints. As the user password reset flow now uses
endpoints under this prefix, you must update your reverse proxy
configurations for user password reset to work.
A new HTML template,
password_reset_confirmation.html,
has been added to the synapse/res/templates directory. If you are
using a custom template directory, you may want to copy the template
over and modify it.
Note that as of v1.20.0, templates do not need to be included in custom
template directories for Synapse to start. The default templates will be
used if a custom template cannot be found.
This page will appear to the user after clicking a password reset link
that has been emailed to them.
To complete password reset, the page must include a way to make a
POST request to
/_synapse/client/password_reset/{medium}/submit_token with the query
parameters from the original link, presented as a URL-encoded form. See
the file itself for more details.
The saml_error.html template was removed from Synapse and replaced
with the sso_error.html template. If your Synapse is configured to use
SAML and a custom sso_redirect_confirm_template_dir configuration then
any customisations of the saml_error.html template will need to be
merged into the sso_error.html template. These templates are similar,
but the parameters are slightly different:
The msg parameter should be renamed to error_description.
There is no longer a code parameter for the response code.
A string error parameter is available that includes a short hint
of why a user is seeing the error page.
From 10th August 2020, we will no longer publish Docker images with the
-py3 tag suffix. The images tagged with the
-py3 suffix have been identical to the non-suffixed tags
since release 0.99.0, and the suffix is obsolete.
On 10th August, we will remove the latest-py3 tag.
Existing per-release tags (such as v1.18.0-py3 will not
be removed, but no new -py3 tags will be added.
Scripts relying on the -py3 suffix will need to be
updated.
When setting up worker processes, we now recommend the use of a Redis
server for replication. The old direct TCP connection method is
deprecated and will be removed in a future release. See
the worker documentation for more details.
This version includes a database update which is run as part of the
upgrade, and which may take a couple of minutes in the case of a large
server. Synapse will not respond to HTTP requests while this update is
taking place.
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.
This will not be a problem for Synapse installations which were:
: - created at v1.4.0 or later,
- upgraded via v1.3.x, or
- upgraded straight from v1.2.1 or earlier to v1.13.0 or later.
If completeness of the room directory is a concern, installations which
are affected can be repaired as follows:
Run the following sql from a psql or
sqlite3 console:
INSERT INTO background_updates (update_name, progress_json, depends_on) VALUES
('populate_stats_process_rooms', '{}', 'current_state_events_membership');
INSERT INTO background_updates (update_name, progress_json, depends_on) VALUES
('populate_stats_process_users', '{}', 'populate_stats_process_rooms');
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 into that directory.
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.
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:
Stop the server
Decrease the schema version in the database:
UPDATE schema_version SET version = 57;
Downgrade Synapse by following the instructions for your
installation method in the "Rolling back to older versions"
section above.
This version includes a database update which is run as part of the
upgrade, and which may take some time (several hours in the case of a
large server). Synapse will not respond to HTTP requests while this
update is taking place.
This is only likely to be a problem in the case of a server which is
participating in many rooms.
As with all upgrades, it is recommended that you have a recent
backup of your database which can be used for recovery in the event
of any problems.
As an initial check to see if you will be affected, you can try
running the following query from the psql or
sqlite3 console. It is safe to run it while Synapse is
still running.
SELECT MAX(q.v) FROM (
SELECT (
SELECT ej.json AS v
FROM state_events se INNER JOIN event_json ej USING (event_id)
WHERE se.room_id=rooms.room_id AND se.type='m.room.create' AND se.state_key=''
LIMIT 1
) FROM rooms WHERE rooms.room_version IS NULL
) q;
This query will take about the same amount of time as the upgrade
process: ie, if it takes 5 minutes, then it is likely that Synapse
will be unresponsive for 5 minutes during the upgrade.
If you consider an outage of this duration to be acceptable, no
further action is necessary and you can simply start Synapse 1.12.0.
If you would prefer to reduce the downtime, continue with the steps
below.
The easiest workaround for this issue is to manually create a new
index before upgrading. On PostgreSQL, his can be done as follows:
CREATE INDEX CONCURRENTLY tmp_upgrade_1_12_0_index
ON state_events(room_id) WHERE type = 'm.room.create';
The above query may take some time, but is also safe to run while
Synapse is running.
We assume that no SQLite users have databases large enough to be
affected. If you are affected, you can run a similar query,
omitting the CONCURRENTLY keyword. Note however that this
operation may in itself cause Synapse to stop running for some time.
Synapse admins are reminded that SQLite is not recommended for use
outside a test environment.
Once the index has been created, the SELECT query in step 1 above
should complete quickly. It is therefore safe to upgrade to Synapse
1.12.0.
Once Synapse 1.12.0 has successfully started and is responding to
HTTP requests, the temporary index can be removed:
Specifying a log_file config option will now cause Synapse to refuse
to start, and should be replaced by with the log_config option.
Support for the log_file option was removed in v1.3.0 and has since
had no effect.
In an attempt to configure Synapse in a privacy preserving way, the
default behaviours of allow_public_rooms_without_auth and
allow_public_rooms_over_federation have been inverted. This means that
by default, only authenticated users querying the Client/Server API will
be able to query the room directory, and relatedly that the server will
not share room directory information with other servers over federation.
If your installation does not explicitly set these settings one way or
the other and you want either setting to be true then it will
necessary to update your homeserver configuration file accordingly.
For more details on the surrounding context see our
explainer.
This release includes a database migration which may take several
minutes to complete if there are a large number (more than a million or
so) of entries in the devices table. This is only likely to a be a
problem on very large installations.
If you have configured a custom template directory with the
email.template_dir option, be aware that there are new templates
regarding registration and threepid management (see below) that must be
included.
registration.html and registration.txt
registration_success.html and registration_failure.html
add_threepid.html and add_threepid.txt
add_threepid_failure.html and add_threepid_success.html
Synapse will expect these files to exist inside the configured template
directory, and will fail to start if they are absent. To view the
default templates, see
synapse/res/templates.
Note: As of this release, users will be unable to add phone numbers or
email addresses to their accounts, without changes to the Synapse
configuration. This includes adding an email address during
registration.
It is possible for a user to associate an email address or phone number
with their account, for a number of reasons:
for use when logging in, as an alternative to the user id.
in the case of email, as an alternative contact to help with account
recovery.
in the case of email, to receive notifications of missed messages.
Before an email address or phone number can be added to a user's
account, or before such an address is used to carry out a
password-reset, Synapse must confirm the operation with the owner of the
email address or phone number. It does this by sending an email or text
giving the user a link or token to confirm receipt. This process is
known as '3pid verification'. ('3pid', or 'threepid', stands for
third-party identifier, and we use it to refer to external identifiers
such as email addresses and phone numbers.)
Previous versions of Synapse delegated the task of 3pid verification to
an identity server by default. In most cases this server is vector.im
or matrix.org.
In Synapse 1.4.0, for security and privacy reasons, the homeserver will
no longer delegate this task to an identity server by default. Instead,
the server administrator will need to explicitly decide how they would
like the verification messages to be sent.
In the medium term, the vector.im and matrix.org identity servers
will disable support for delegated 3pid verification entirely. However,
in order to ease the transition, they will retain the capability for a
limited period. Delegated email verification will be disabled on Monday
2nd December 2019 (giving roughly 2 months notice). Disabling delegated
SMS verification will follow some time after that once SMS verification
support lands in Synapse.
Once delegated 3pid verification support has been disabled in the
vector.im and matrix.org identity servers, all Synapse versions that
depend on those instances will be unable to verify email and phone
numbers through them. There are no imminent plans to remove delegated
3pid verification from Sydent generally. (Sydent is the identity server
project that backs the vector.im and matrix.org instances).
To configure an SMTP server for Synapse, modify the configuration
section headed email, and be sure to have at least the
smtp_host, smtp_port and notif_from fields filled out.
You may also need to set smtp_user, smtp_pass, and
require_transport_security.
Some admins will wish to continue using email verification as part of
the registration process, but will not immediately have an appropriate
SMTP server at hand.
To this end, we will continue to support email verification delegation
via the vector.im and matrix.org identity servers for two months.
Support for delegated email verification will be disabled on Monday 2nd
December.
The account_threepid_delegates dictionary defines whether the
homeserver should delegate an external server (typically an identity
server) to handle
sending confirmation messages via email and SMS.
So to delegate email verification, in homeserver.yaml, set
account_threepid_delegates.email to the base URL of an identity
server. For example:
account_threepid_delegates:
email: https://example.com # Delegate email sending to example.com
Note that account_threepid_delegates.email replaces the deprecated
email.trust_identity_server_for_password_resets: if
email.trust_identity_server_for_password_resets is set to true, and
account_threepid_delegates.email is not set, then the first entry in
trusted_third_party_id_servers will be used as the
account_threepid_delegate for email. This is to ensure compatibility
with existing Synapse installs that set up external server handling for
these tasks before v1.4.0. If
email.trust_identity_server_for_password_resets is true and no
trusted identity server domains are configured, Synapse will report an
error and refuse to start.
If email.trust_identity_server_for_password_resets is false or
absent and no email delegate is configured in
account_threepid_delegates, then Synapse will send email verification
messages itself, using the configured SMTP server (see above). that
type.
Synapse does not support phone-number verification itself, so the only
way to maintain the ability for users to add phone numbers to their
accounts will be by continuing to delegate phone number verification to
the matrix.org and vector.im identity servers (or another identity
server that supports SMS sending).
The account_threepid_delegates dictionary defines whether the
homeserver should delegate an external server (typically an identity
server) to handle
sending confirmation messages via email and SMS.
So to delegate phone number verification, in homeserver.yaml, set
account_threepid_delegates.msisdn to the base URL of an identity
server. For example:
account_threepid_delegates:
msisdn: https://example.com # Delegate sms sending to example.com
The matrix.org and vector.im identity servers will continue to
support delegated phone number verification via SMS until such time as
it is possible for admins to configure their servers to perform phone
number verification directly. More details will follow in a future
release.
If you encounter problems with v1.4.0, it should be possible to roll
back to v1.3.1, subject to the following:
The 'room statistics' engine was heavily reworked in this release
(see #5971),
including significant changes to the database schema, which are not
easily reverted. This will cause the room statistics engine to stop
updating when you downgrade.
The room statistics are essentially unused in v1.3.1 (in future
versions of Synapse, they will be used to populate the room
directory), so there should be no loss of functionality. However,
the statistics engine will write errors to the logs, which can be
avoided by setting the following in homeserver.yaml:
stats:
enabled: false
Don't forget to re-enable it when you upgrade again, in preparation
for its use in the room directory!
Synapse v1.1.0 has a minimum Python requirement of Python 3.5. Python
3.6 or Python 3.7 are recommended as they have improved internal string
handling, significantly reducing memory usage.
If you use current versions of the Matrix.org-distributed Debian
packages or Docker images, action is not required.
If you install Synapse in a Python virtual environment, please see
"Upgrading to v0.34.0" for notes on setting up a new virtualenv under
Python 3.
If using PostgreSQL under Synapse, you will need to use PostgreSQL 9.5
or above. Please see the PostgreSQL
documentation for
more details on upgrading your database.
Synapse v1.0 is the first release to enforce validation of TLS
certificates for the federation API. It is therefore essential that your
certificates are correctly configured.
Note, v1.0 installations will also no longer be able to federate with
servers that have not correctly configured their certificates.
In rare cases, it may be desirable to disable certificate checking: for
example, it might be essential to be able to federate with a given
legacy server in a closed federation. This can be done in one of two
ways:-
Configure the global switch federation_verify_certificates to
false.
Configure a whitelist of server domains to trust via
federation_certificate_verification_whitelist.
When a user requests a password reset, Synapse will send an email to the
user to confirm the request.
Previous versions of Synapse delegated the job of sending this email to
an identity server. If the identity server was somehow malicious or
became compromised, it would be theoretically possible to hijack an
account through this means.
Therefore, by default, Synapse v1.0 will send the confirmation email
itself. If Synapse is not configured with an SMTP server, password reset
via email will be disabled.
To configure an SMTP server for Synapse, modify the configuration
section headed email, and be sure to have at least the smtp_host,
smtp_port and notif_from fields filled out. You may also need to set
smtp_user, smtp_pass, and require_transport_security.
If you are absolutely certain that you wish to continue using an
identity server for password resets, set
trust_identity_server_for_password_resets to true.
Some new templates have been added to the default template directory for the purpose of
the homeserver sending its own password reset emails. If you have configured a
custom template_dir in your Synapse config, these files will need to be added.
password_reset.html and password_reset.txt are HTML and plain text
templates respectively that contain the contents of what will be emailed
to the user upon attempting to reset their password via email.
password_reset_success.html and password_reset_failure.html are HTML
files that the content of which (assuming no redirect URL is set) will
be shown to the user after they attempt to click the link in the email
sent to them.
Please be aware that, before Synapse v1.0 is released around March 2019,
you will need to replace any self-signed certificates with those
verified by a root CA. Information on how to do so can be found at the
ACME docs.
This release is the first to fully support Python 3. Synapse will
now run on Python versions 3.5, or 3.6 (as well as 2.7). We
recommend switching to Python 3, as it has been shown to give
performance improvements.
For users who have installed Synapse into a virtualenv, we recommend
doing this by creating a new virtualenv. For example:
You can then start synapse as normal, having activated the new
virtualenv:
cd ~/synapse
source env3/bin/activate
synctl start
Users who have installed from distribution packages should see the
relevant package documentation. See below for notes on Debian
packages.
When upgrading to Python 3, you must make sure that your log
files are configured as UTF-8, by adding encoding: utf8 to the
RotatingFileHandler configuration (if you have one) in your
<server>.log.config file. For example, if your log.config
file contains:
There is no need to revert this change if downgrading to
Python 2.
We are also making available Debian packages which will run Synapse
on Python 3. You can switch to these packages with
apt-get install matrix-synapse-py3, however, please read
debian/NEWS
before doing so. The existing matrix-synapse packages will
continue to use Python 2 for the time being.
This release removes the riot.im from the default list of trusted
identity servers.
If riot.im is in your homeserver's list of
trusted_third_party_id_servers, you should remove it. It was added
in case a hypothetical future identity server was put there. If you
don't remove it, users may be unable to deactivate their accounts.
This release no longer installs the (unmaintained) Matrix Console
web client as part of the default installation. It is possible to
re-enable it by installing it separately and setting the
web_client_location config option, but please consider switching
to another client.
This release removes the example email notification templates from
res/templates (they are now internal to the python package). This
should only affect you if you (a) deploy your Synapse instance from a
git checkout or a github snapshot URL, and (b) have email notifications
enabled.
If you have email notifications enabled, you should ensure that
email.template_dir is either configured to point at a directory where
you have installed customised templates, or leave it unset to use the
default templates.
This release expands the anonymous usage stats sent if the opt-in
report_stats configuration is set to true. We now capture RSS memory
and cpu use at a very coarse level. This requires administrators to
install the optional psutil python module.
We would appreciate it if you could assist by ensuring this module is
available and report_stats is enabled. This will let us see if
performance changes to synapse are having an impact to the general
community.
If you want to use the new URL previewing API
(/_matrix/media/r0/preview_url) then you have to explicitly enable it
in the config and update your dependencies dependencies. See README.rst
for details.
This release includes the option to send anonymous usage stats to
matrix.org, and requires that administrators explicitly opt in or out by
setting the report_stats option to either true or false.
We would really appreciate it if you could help our project out by
reporting anonymized usage statistics from your homeserver. Only very
basic aggregate data (e.g. number of users) will be reported, but it
helps us to track the growth of the Matrix community, and helps us to
make Matrix a success, as well as to convince other networks that they
should peer with us.
Application services have had a breaking API change in this version.
They can no longer register themselves with a home server using the AS
HTTP API. This decision was made because a compromised application
service with free reign to register any regex in effect grants full
read/write access to the home server if a regex of .* is used. An
attack where a compromised AS re-registers itself with .* was deemed
too big of a security risk to ignore, and so the ability to register
with the HS remotely has been removed.
It has been replaced by specifying a list of application service
registrations in homeserver.yaml:
url: <String> # e.g. "https://my.application.service.com"
as_token: <String>
hs_token: <String>
sender_localpart: <String> # This is a new field which denotes the user_id localpart when using the AS token
namespaces:
users:
- exclusive: <Boolean>
regex: <String> # e.g. "@prefix_.*"
aliases:
- exclusive: <Boolean>
regex: <String>
rooms:
- exclusive: <Boolean>
regex: <String>
Where <db> is the location of the database,
<server_name> is the server name as specified in the
synapse configuration, and <signing_key> is the location
of the signing key as specified in the synapse configuration.
This may take some time to complete. Failures of signatures and content
hashes can safely be ignored.
Depending on precisely when you installed v0.5.0 you may have ended up
with a stale release of the reference matrix webclient installed as a
python module. To uninstall it and ensure you are depending on the
latest module, please run:
The webclient has been split out into a separate repository/package in
this release. Before you restart your homeserver you will need to pull
in the webclient package by running:
python setup.py develop --user
This release completely changes the database schema and so requires
upgrading it before starting the new version of the homeserver.
The script "database-prepare-for-0.5.0.sh" should be used to upgrade
the database. This will save all user information, such as logins and
profiles, but will otherwise purge the database. This includes messages,
which rooms the home server was a member of and room alias mappings.
If you would like to keep your history, please take a copy of your
database file and ask for help in #matrix:matrix.org. The upgrade
process is, unfortunately, non trivial and requires human intervention
to resolve any resulting conflicts during the upgrade process.
Before running the command the homeserver should be first completely
shutdown. To run it, simply specify the location of the database, e.g.:
Once this has successfully completed it will be safe to restart the
homeserver. You may notice that the homeserver takes a few seconds
longer to restart than usual as it reinitializes the database.
On startup of the new version, users can either rejoin remote rooms
using room aliases or by being reinvited. Alternatively, if any other
homeserver sends a message to a room that the homeserver was previously
in the local HS will automatically rejoin the room.
This registration API now closely matches the login API. This introduces
a bit more backwards and forwards between the HS and the client, but
this improves the overall flexibility of the API. You can now GET on
/register to retrieve a list of valid registration flows. Upon choosing
one, they are submitted in the same way as login, e.g:
{
type: m.login.password,
user: foo,
password: bar
}
The default HS supports 2 flows, with and without Identity Server email
authentication. Enabling captcha on the HS will add in an extra step to
all flows: m.login.recaptcha which must be completed before you can
transition to the next stage. There is a new login type:
m.login.email.identity which contains the threepidCreds key which
were previously sent in the original register request. For more
information on this, see the specification.
The VoIP specification has changed between v0.2.0 and v0.3.0. Users
should refresh any browser tabs to get the latest web client code. Users
on v0.2.0 of the web client will not be able to call those on v0.3.0 and
vice versa.
This release completely changes the database schema and so requires
upgrading it before starting the new version of the homeserver.
The script "database-prepare-for-0.0.1.sh" should be used to upgrade
the database. This will save all user information, such as logins and
profiles, but will otherwise purge the database. This includes messages,
which rooms the home server was a member of and room alias mappings.
Before running the command the homeserver should be first completely
shutdown. To run it, simply specify the location of the database, e.g.:
Once this has successfully completed it will be safe to restart the
homeserver. You may notice that the homeserver takes a few seconds
longer to restart than usual as it reinitializes the database.
On startup of the new version, users can either rejoin remote rooms
using room aliases or by being reinvited. Alternatively, if any other
homeserver sends a message to a room that the homeserver was previously
in the local HS will automatically rejoin the room.