From 035406ce3586533cc35a49ca463d49ec74caddf8 Mon Sep 17 00:00:00 2001 From: Callum Macdonald Date: Thu, 23 Dec 2021 17:03:48 +0100 Subject: [PATCH 1/5] Add note about postgres to docker docs --- docker/README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docker/README.md b/docker/README.md index 4349e71f87bb..edeb71828aa0 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: From c6aaba45c796489d6a268628ebcace8148dea19c Mon Sep 17 00:00:00 2001 From: Callum Macdonald Date: Thu, 23 Dec 2021 17:09:08 +0100 Subject: [PATCH 2/5] Add warning about sqlite default --- contrib/docker/docker-compose.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/contrib/docker/docker-compose.yml b/contrib/docker/docker-compose.yml index 26d640c44887..9ed9f77a8240 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 the config file to use postgres, it defaults to sqlite environment: - SYNAPSE_CONFIG_PATH=/data/homeserver.yaml volumes: From c7704042fb968c2fc29fa886f22d5102dec23f08 Mon Sep 17 00:00:00 2001 From: reivilibre Date: Wed, 5 Jan 2022 10:20:22 +0000 Subject: [PATCH 3/5] Update contrib/docker/docker-compose.yml Co-authored-by: David Robertson --- contrib/docker/docker-compose.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contrib/docker/docker-compose.yml b/contrib/docker/docker-compose.yml index 9ed9f77a8240..5ac41139e31d 100644 --- a/contrib/docker/docker-compose.yml +++ b/contrib/docker/docker-compose.yml @@ -14,7 +14,7 @@ services: # failure restart: unless-stopped # See the readme for a full documentation of the environment settings - # NOTE: You must edit the config file to use postgres, it defaults to sqlite + # NOTE: You must edit homeserver.yaml to use postgres, it defaults to sqlite environment: - SYNAPSE_CONFIG_PATH=/data/homeserver.yaml volumes: From 953a1243b125e30dbcf33b077363a29d7bb5b212 Mon Sep 17 00:00:00 2001 From: reivilibre Date: Wed, 5 Jan 2022 10:20:51 +0000 Subject: [PATCH 4/5] Update docker/README.md --- docker/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docker/README.md b/docker/README.md index edeb71828aa0..67c3bc65f095 100644 --- a/docker/README.md +++ b/docker/README.md @@ -70,7 +70,7 @@ The following environment variables are supported in `generate` mode: ## 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. +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 From 2efc7c484d2e84d7756756b26717938058f7d95a Mon Sep 17 00:00:00 2001 From: "Olivier Wilkinson (reivilibre)" Date: Wed, 5 Jan 2022 10:22:22 +0000 Subject: [PATCH 5/5] Newsfile --- changelog.d/11640.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/11640.doc diff --git a/changelog.d/11640.doc b/changelog.d/11640.doc new file mode 100644 index 000000000000..c4773e4f3ac5 --- /dev/null +++ b/changelog.d/11640.doc @@ -0,0 +1 @@ +Add references for using Postgres to the Docker documentation.