UPGRADE.rst

Upgrading Synapse

Before upgrading check if any special steps are required to upgrade from the what you currently have installed to current version of synapse. The extra instructions that may be required are listed later in this document.

1. If synapse was installed in a virtualenv then active that virtualenv before upgrading. If synapse is installed in a virtualenv in ~/.synapse/ then run:

   source ~/.synapse/bin/activate

2. If synapse was installed using pip then upgrade to the latest version by running:

   pip install --upgrade --process-dependency-links https://github.com/matrix-org/synapse/tarball/master
   
   # restart synapse
   synctl restart

   If synapse was installed using git then upgrade to the latest version by running:

   # Pull the latest version of the master branch.
   git pull
   # Update the versions of synapse's python dependencies.
   python synapse/python_dependencies.py | xargs pip install --upgrade
   
   # restart synapse
   ./synctl restart

To check whether your update was sucessful, you can check the Server header returned by the Client-Server API:

# replace <host.name> with the hostname of your synapse homeserver.
# You may need to specify a port (eg, :8448) if your server is not
# configured on port 443.
curl -kv https://<host.name>/_matrix/client/versions 2>&1 | grep "Server:"

Upgrading to v0.15.0

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.