Merge pull request #236 from matrix-org/markjh/upgrade-instructions

Add generic update instructions to UPGRADE.rst
This commit is contained in:
Mark Haines 2015-08-20 16:08:05 +01:00
commit cb8201ba12
2 changed files with 37 additions and 7 deletions

View File

@ -362,14 +362,11 @@ This should end with a 'PASSED' result::
Upgrading an existing Synapse Upgrading an existing Synapse
============================= =============================
IMPORTANT: Before upgrading an existing synapse to a new version, please The instructions for upgrading synapse are in `UPGRADE.rst`_.
refer to UPGRADE.rst for any additional instructions. Please check these instructions as upgrading may require extra steps for some
versions of synapse.
Otherwise, simply re-install the new codebase over the current one - e.g.
by ``pip install --process-dependency-links
https://github.com/matrix-org/synapse/tarball/master``
if using pip, or by ``git pull`` if running off a git working copy.
.. _UPGRADE.rst: UPGRADE.rst
Setting up Federation Setting up Federation
===================== =====================

View File

@ -1,3 +1,36 @@
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.
If synapse was installed in a virtualenv then active that virtualenv before
upgrading. If synapse is installed in a virtualenv in ``~/.synapse/`` then run:
.. code:: bash
source ~/.synapse/bin/activate
If synapse was installed using pip then upgrade to the latest version by
running:
.. code:: bash
pip install --upgrade --process-dependency-links https://github.com/matrix-org/synapse/tarball/master
If synapse was installed using git then upgrade to the latest version by
running:
.. code:: bash
# Pull the latest version of the master branch.
git pull
# Update the versions of synapse's python dependencies.
python synapse/python_dependencies.py | xargs -n1 pip install
Upgrading to v0.9.0 Upgrading to v0.9.0
=================== ===================