diff options
| author | Shay <hillerys@element.io> | 2022-03-23 10:23:05 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-03-23 10:23:05 -0700 |
| commit | e78d4f61fc881851ab35e9a889239a61cf9805e5 (patch) | |
| tree | 3c579083dc15936dac5dec0367d8b21274698b53 /synapse/config/database.py | |
| parent | Use psycopg2 type stubs (#12269) (diff) | |
| download | synapse-e78d4f61fc881851ab35e9a889239a61cf9805e5.tar.xz | |
Refuse to start if DB has an unsafe locale (#12262)
Diffstat (limited to 'synapse/config/database.py')
| -rw-r--r-- | synapse/config/database.py | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/synapse/config/database.py b/synapse/config/database.py index 06ccf15cd9..d7f2219f53 100644 --- a/synapse/config/database.py +++ b/synapse/config/database.py @@ -37,6 +37,12 @@ DEFAULT_CONFIG = """\ # 'txn_limit' gives the maximum number of transactions to run per connection # before reconnecting. Defaults to 0, which means no limit. # +# 'allow_unsafe_locale' is an option specific to Postgres. Under the default behavior, Synapse will refuse to +# start if the postgres db is set to a non-C locale. You can override this behavior (which is *not* recommended) +# by setting 'allow_unsafe_locale' to true. Note that doing so may corrupt your database. You can find more information +# here: https://matrix-org.github.io/synapse/latest/postgres.html#fixing-incorrect-collate-or-ctype and here: +# https://wiki.postgresql.org/wiki/Locale_data_changes +# # 'args' gives options which are passed through to the database engine, # except for options starting 'cp_', which are used to configure the Twisted # connection pool. For a reference to valid arguments, see: |