summary refs log tree commit diff
path: root/UPGRADE.rst
diff options
context:
space:
mode:
authorMark Haines <mjark@negativecurvature.net>2015-08-20 16:08:05 +0100
committerMark Haines <mjark@negativecurvature.net>2015-08-20 16:08:05 +0100
commitcb8201ba120e5ca17a7fbdb90799ccb5909aecb1 (patch)
tree5cbb1c147959b9f5f0f159671fea4df372383b6f /UPGRADE.rst
parentUpdate changelog (diff)
parentTweak the wording a bit (diff)
downloadsynapse-cb8201ba120e5ca17a7fbdb90799ccb5909aecb1.tar.xz
Merge pull request #236 from matrix-org/markjh/upgrade-instructions
Add generic update instructions to UPGRADE.rst
Diffstat (limited to 'UPGRADE.rst')
-rw-r--r--UPGRADE.rst33
1 files changed, 33 insertions, 0 deletions
diff --git a/UPGRADE.rst b/UPGRADE.rst
index d98460f643..35a0333a7e 100644
--- a/UPGRADE.rst
+++ b/UPGRADE.rst
@@ -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
 ===================