diff options
| author | Richard van der Hoff <1389908+richvdh@users.noreply.github.com> | 2019-05-17 12:38:03 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-05-17 12:38:03 +0100 |
| commit | 7ce1f97a1353e7bd9232c22a20835e40fa5662e0 (patch) | |
| tree | 6c3ac7443f3aee2b8585061dd49bd13a95375c72 /docs/postgres.rst | |
| parent | fix some typos in the changelog (diff) | |
| download | synapse-7ce1f97a1353e7bd9232c22a20835e40fa5662e0.tar.xz | |
Stop telling people to install the optional dependencies. (#5197)
* Stop telling people to install the optional dependencies. They're optional. Also update the postgres docs a bit for clarity(?)
Diffstat (limited to 'docs/postgres.rst')
| -rw-r--r-- | docs/postgres.rst | 45 |
1 files changed, 22 insertions, 23 deletions
diff --git a/docs/postgres.rst b/docs/postgres.rst index f7ebbed0c3..e81e10403f 100644 --- a/docs/postgres.rst +++ b/docs/postgres.rst @@ -3,6 +3,28 @@ Using Postgres Postgres version 9.4 or later is known to work. +Install postgres client libraries +================================= + +Synapse will require the python postgres client library in order to connect to +a postgres database. + +* If you are using the `matrix.org debian/ubuntu + packages <../INSTALL.md#matrixorg-packages>`_, + the necessary libraries will already be installed. + +* For other pre-built packages, please consult the documentation from the + relevant package. + +* If you installed synapse `in a virtualenv + <../INSTALL.md#installing-from-source>`_, you can install the library with:: + + ~/synapse/env/bin/pip install matrix-synapse[postgres] + + (substituting the path to your virtualenv for ``~/synapse/env``, if you used a + different path). You will require the postgres development files. These are in + the ``libpq-dev`` package on Debian-derived distributions. + Set up database =============== @@ -26,29 +48,6 @@ encoding use, e.g.:: This would create an appropriate database named ``synapse`` owned by the ``synapse_user`` user (which must already exist). -Set up client in Debian/Ubuntu -=========================== - -Postgres support depends on the postgres python connector ``psycopg2``. In the -virtual env:: - - sudo apt-get install libpq-dev - pip install psycopg2 - -Set up client in RHEL/CentOs 7 -============================== - -Make sure you have the appropriate version of postgres-devel installed. For a -postgres 9.4, use the postgres 9.4 packages from -[here](https://wiki.postgresql.org/wiki/YUM_Installation). - -As with Debian/Ubuntu, postgres support depends on the postgres python connector -``psycopg2``. In the virtual env:: - - sudo yum install postgresql-devel libpqxx-devel.x86_64 - export PATH=/usr/pgsql-9.4/bin/:$PATH - pip install psycopg2 - Tuning Postgres =============== |