diff options
| author | Richard van der Hoff <1389908+richvdh@users.noreply.github.com> | 2018-05-17 10:52:54 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-05-17 10:52:54 +0100 |
| commit | ae53c71d90faf70a12f9875ce194440e9c3ad0ea (patch) | |
| tree | 31e6912ff2c3d7602bffb88232323e398784e6d0 /docs | |
| parent | bump version and changelog for 0.29.0 (diff) | |
| parent | postgres.rst: Add instructions how to setup the postgres user and clarify the... (diff) | |
| download | synapse-ae53c71d90faf70a12f9875ce194440e9c3ad0ea.tar.xz | |
Merge pull request #1756 from rubo77/patch-4
Add instructions how to setup the postgres user and clarify the final step
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/postgres.rst | 32 |
1 files changed, 23 insertions, 9 deletions
diff --git a/docs/postgres.rst b/docs/postgres.rst index 904942ec74..296293e859 100644 --- a/docs/postgres.rst +++ b/docs/postgres.rst @@ -6,7 +6,13 @@ Postgres version 9.4 or later is known to work. Set up database =============== -The PostgreSQL database used *must* have the correct encoding set, otherwise +Assuming your PostgreSQL database user is called ``postgres``, create a user +``synapse_user`` with:: + + su - postgres + createuser --pwprompt synapse_user + +The PostgreSQL database used *must* have the correct encoding set, otherwise it would not be able to store UTF8 strings. To create a database with the correct encoding use, e.g.:: @@ -46,8 +52,8 @@ As with Debian/Ubuntu, postgres support depends on the postgres python connector Synapse config ============== -When you are ready to start using PostgreSQL, add the following line to your -config file:: +When you are ready to start using PostgreSQL, edit the ``database`` section in +your config file to match the following lines:: database: name: psycopg2 @@ -96,9 +102,12 @@ complete, restart synapse. For instance:: cp homeserver.db homeserver.db.snapshot ./synctl start -Assuming your new config file (as described in the section *Synapse config*) -is named ``homeserver-postgres.yaml`` and the SQLite snapshot is at -``homeserver.db.snapshot`` then simply run:: +Copy the old config file into a new config file:: + + cp homeserver.yaml homeserver-postgres.yaml + +Edit the database section as described in the section *Synapse config* above +and with the SQLite snapshot located at ``homeserver.db.snapshot`` simply run:: synapse_port_db --sqlite-database homeserver.db.snapshot \ --postgres-config homeserver-postgres.yaml @@ -117,6 +126,11 @@ run:: --postgres-config homeserver-postgres.yaml Once that has completed, change the synapse config to point at the PostgreSQL -database configuration file ``homeserver-postgres.yaml`` (i.e. rename it to -``homeserver.yaml``) and restart synapse. Synapse should now be running against -PostgreSQL. +database configuration file ``homeserver-postgres.yaml``: + + ./synctl stop + mv homeserver.yaml homeserver-old-sqlite.yaml + mv homeserver-postgres.yaml homeserver.yaml + ./synctl start + +Synapse should now be running against PostgreSQL. |