OpenCloud
/
MatrixSynapse
mirror of https://github.com/matrix-org/synapse
1
0
Fork 0
Code Issues Releases Wiki Activity

Tweaks to the upgrade instructions

pull/2428/head
Richard van der Hoff 2017-08-23 15:15:40 +01:00
parent a4d3bfe3d6
commit fc9878f6a4
1 changed files with 51 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
UPGRADE.rst
View File

@ -5,20 +5,25 @@ 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 what you currently have installed to current version of synapse. The extra
instructions that may be required are listed later in this document. instructions that may be required are listed later in this document.
If synapse was installed in a virtualenv then active that virtualenv before 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: upgrading. If synapse is installed in a virtualenv in ``~/.synapse/`` then
run:
.. code:: bash .. code:: bash
source ~/.synapse/bin/activate source ~/.synapse/bin/activate
If synapse was installed using pip then upgrade to the latest version by 2. If synapse was installed using pip then upgrade to the latest version by
running: running:
.. code:: bash .. code:: bash
pip install --upgrade --process-dependency-links https://github.com/matrix-org/synapse/tarball/master 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 If synapse was installed using git then upgrade to the latest version by
running: running:
@ -27,17 +32,21 @@ running:
# Pull the latest version of the master branch. # Pull the latest version of the master branch.
git pull git pull
# Update the versions of synapse's python dependencies. # Update the versions of synapse's python dependencies.
python synapse/python_dependencies.py | xargs -n1 pip install --upgrade python synapse/python_dependencies.py | xargs pip install --upgrade
To check whether your update was sucessfull, run: # restart synapse
./synctl restart
To check whether your update was sucessful, you can check the Server header
returned by the Client-Server API:
.. code:: bash .. code:: bash
# replace your.server.domain with ther domain of your synapse homeserver # replace <host.name> with the hostname of your synapse homeserver.
curl https://<your.server.domain>/_matrix/federation/v1/version # You may need to specify a port (eg, :8448) if your server is not
# configured on port 443.
So for the Matrix.org HS server the URL would be: https://matrix.org/_matrix/federation/v1/version. curl -kv https://<host.name>/_matrix/client/versions 2>&1 | grep "Server:"
Upgrading to v0.15.0 Upgrading to v0.15.0
==================== ====================