diff options
| author | Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> | 2020-07-20 13:29:25 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-07-20 18:29:25 +0100 |
| commit | 5ecf98f59ecb9eced2fada5cb74bb10a5700f9a3 (patch) | |
| tree | 61f8123b7e3351a8d48d648797dcc933c1e44cb9 | |
| parent | Fix deprecation warning due to invalid escape sequences (#7895) (diff) | |
| download | synapse-5ecf98f59ecb9eced2fada5cb74bb10a5700f9a3.tar.xz | |
Change sample config's postgres user to synapse_user (#7889)
The [postgres setup docs](https://github.com/matrix-org/synapse/blob/develop/docs/postgres.md#set-up-database) recommend setting up your database with user `synapse_user`. However, uncommenting the postgres defaults in the sample config leave you with user `synapse`. This PR switches the sample config to recommend `synapse_user`. Took a me a second to figure this out, so assume this will beneficial to others.
| -rw-r--r-- | changelog.d/7889.doc | 1 | ||||
| -rw-r--r-- | docs/sample_config.yaml | 2 | ||||
| -rw-r--r-- | synapse/config/database.py | 2 |
3 files changed, 3 insertions, 2 deletions
diff --git a/changelog.d/7889.doc b/changelog.d/7889.doc new file mode 100644 index 0000000000..d91f62fd39 --- /dev/null +++ b/changelog.d/7889.doc @@ -0,0 +1 @@ +Change the sample config postgres user section to use `synapse_user` instead of `synapse` to align with the documentation. \ No newline at end of file diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml index 0e83f855bb..2e001fb674 100644 --- a/docs/sample_config.yaml +++ b/docs/sample_config.yaml @@ -685,7 +685,7 @@ caches: #database: # name: psycopg2 # args: -# user: synapse +# user: synapse_user # password: secretpassword # database: synapse # host: localhost diff --git a/synapse/config/database.py b/synapse/config/database.py index 1064c2697b..62bccd9ef5 100644 --- a/synapse/config/database.py +++ b/synapse/config/database.py @@ -55,7 +55,7 @@ DEFAULT_CONFIG = """\ #database: # name: psycopg2 # args: -# user: synapse +# user: synapse_user # password: secretpassword # database: synapse # host: localhost |