diff options
| author | Callum Macdonald <github.com@callum-macdonald.com> | 2022-01-05 11:50:28 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-01-05 10:50:28 +0000 |
| commit | 7013e06e2f60e1401349fd054372808376facc87 (patch) | |
| tree | 5bf4b4cc6bfa4400906b25d3f7851267e216264b | |
| parent | Correct Synapse install command for FreeBSD. (#11267) (diff) | |
| download | synapse-7013e06e2f60e1401349fd054372808376facc87.tar.xz | |
Improve Docker docs for use with Postgres (#11640)
| -rw-r--r-- | changelog.d/11640.doc | 1 | ||||
| -rw-r--r-- | contrib/docker/docker-compose.yml | 1 | ||||
| -rw-r--r-- | docker/README.md | 4 |
3 files changed, 6 insertions, 0 deletions
diff --git a/changelog.d/11640.doc b/changelog.d/11640.doc new file mode 100644 index 0000000000..c4773e4f3a --- /dev/null +++ b/changelog.d/11640.doc @@ -0,0 +1 @@ +Add references for using Postgres to the Docker documentation. diff --git a/contrib/docker/docker-compose.yml b/contrib/docker/docker-compose.yml index 26d640c448..5ac41139e3 100644 --- a/contrib/docker/docker-compose.yml +++ b/contrib/docker/docker-compose.yml @@ -14,6 +14,7 @@ services: # failure restart: unless-stopped # See the readme for a full documentation of the environment settings + # NOTE: You must edit homeserver.yaml to use postgres, it defaults to sqlite environment: - SYNAPSE_CONFIG_PATH=/data/homeserver.yaml volumes: diff --git a/docker/README.md b/docker/README.md index 4349e71f87..67c3bc65f0 100644 --- a/docker/README.md +++ b/docker/README.md @@ -68,6 +68,10 @@ The following environment variables are supported in `generate` mode: directories. If unset, and no user is set via `docker run --user`, defaults to `991`, `991`. +## Postgres + +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. + ## Running synapse Once you have a valid configuration file, you can start synapse as follows: |