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

Commit 7013e06

Browse files
authored
Improve Docker docs for use with Postgres (#11640)
1 parent 0715e77 commit 7013e06

File tree

3 files changed

+6
-0
lines changed

3 files changed

+6
-0
lines changed

changelog.d/11640.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add references for using Postgres to the Docker documentation.

contrib/docker/docker-compose.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ services:
1414
# failure
1515
restart: unless-stopped
1616
# See the readme for a full documentation of the environment settings
17+
# NOTE: You must edit homeserver.yaml to use postgres, it defaults to sqlite
1718
environment:
1819
- SYNAPSE_CONFIG_PATH=/data/homeserver.yaml
1920
volumes:

docker/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,10 @@ The following environment variables are supported in `generate` mode:
6868
directories. If unset, and no user is set via `docker run --user`, defaults
6969
to `991`, `991`.
7070

71+
## Postgres
72+
73+
By default the config will use SQLite. See the [docs on using Postgres](https://github.com/matrix-org/synapse/blob/develop/docs/postgres.md) for more info on how to use Postgres. Until this section is improved [this issue](https://github.com/matrix-org/synapse/issues/8304) may provide useful information.
74+
7175
## Running synapse
7276

7377
Once you have a valid configuration file, you can start synapse as follows:

0 commit comments

Comments
 (0)