summary refs log tree commit diff
diff options
context:
space:
mode:
authorRichard van der Hoff <1389908+richvdh@users.noreply.github.com>2019-01-31 10:29:15 +0000
committerAmber Brown <hawkowl@atleastfornow.net>2019-01-31 10:29:15 +0000
commit35f544410a63759d0867cad9d6e0e02309e6bf5e (patch)
treea493289bec5468a2844f6bc200f46e2c759b6838
parentcleanups for contrib/prometheus/README (diff)
downloadsynapse-35f544410a63759d0867cad9d6e0e02309e6bf5e.tar.xz
update debian installation instructions (#4526)
* update debian installation instructions

* docs PR is docs
-rw-r--r--README.rst36
-rw-r--r--changelog.d/4526.doc1
2 files changed, 32 insertions, 5 deletions
diff --git a/README.rst b/README.rst
index 05a3bb3751..e6354ccba0 100644
--- a/README.rst
+++ b/README.rst
@@ -333,12 +333,38 @@ https://developer.github.com/changes/2014-04-25-user-content-security for more d
 Platform-Specific Instructions
 ==============================
 
-Debian
-------
+Debian/Ubuntu
+-------------
+
+Matrix.org packages
+~~~~~~~~~~~~~~~~~~~
+
+Matrix.org provides Debian/Ubuntu packages of the latest stable version of
+Synapse via https://matrix.org/packages/debian/. To use them::
+
+    sudo apt install -y lsb-release curl apt-transport-https
+    echo "deb https://matrix.org/packages/debian `lsb_release -cs` main" |
+        sudo tee /etc/apt/sources.list.d/matrix-org.list
+    curl "https://matrix.org/packages/debian/repo-key.asc" |
+        sudo apt-key add -
+    sudo apt update
+    sudo apt install matrix-synapse-py3
+
+Downstream Debian/Ubuntu packages
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+For ``buster`` and ``sid``, Synapse is available in the Debian repositories and
+it should be possible to install it with simply::
+
+    sudo apt install matrix-synapse
+
+There is also a version of ``matrix-synapse`` in ``stretch-backports``. Please
+see the `Debian documentation on backports
+<https://backports.debian.org/Instructions/>`_ for information on how to use
+them.
 
-Matrix provides official Debian packages via apt from https://matrix.org/packages/debian/.
-Note that these packages do not include a client - choose one from
-https://matrix.org/docs/projects/try-matrix-now.html (or build your own with one of our SDKs :)
+We do not recommend using the packages in downstream Ubuntu at this time, as
+they are old and suffer from known security vulnerabilities.
 
 Fedora
 ------
diff --git a/changelog.d/4526.doc b/changelog.d/4526.doc
new file mode 100644
index 0000000000..b7536e25f8
--- /dev/null
+++ b/changelog.d/4526.doc
@@ -0,0 +1 @@
+Update debian installation instructions