Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Stop telling people to install the optional dependencies. #5197

Merged
merged 2 commits into from
May 17, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ virtualenv -p python3 ~/synapse/env
source ~/synapse/env/bin/activate
pip install --upgrade pip
pip install --upgrade setuptools
pip install matrix-synapse[all]
pip install matrix-synapse
```

This will download Synapse from [PyPI](https://pypi.org/project/matrix-synapse)
Expand All @@ -48,7 +48,7 @@ update flag:

```
source ~/synapse/env/bin/activate
pip install -U matrix-synapse[all]
pip install -U matrix-synapse
```

Before you can start Synapse, you will need to generate a configuration
Expand Down
1 change: 1 addition & 0 deletions changelog.d/5197.misc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Stop telling people to install the optional dependencies by default.
45 changes: 22 additions & 23 deletions docs/postgres.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
===============

Expand All @@ -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
===============

Expand Down