Improve Docker docs for use with Postgres (#11640)

matrix-org · Jan 5, 2022 · 7013e06 · 7013e06
1 parent 0715e77
commit 7013e06
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 0 deletions.
diff --git a/changelog.d/11640.doc 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
@@ -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
@@ -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: