Update documentation to state that Dendrite requires PostgreSQL UTF-8 encoding

This commit is contained in:
Neil Alexander 2022-09-26 09:33:34 +01:00
parent d5978d98fd
commit 8d64c24b23
No known key found for this signature in database
GPG key ID: A02A2019A2BB0944

View file

@ -16,6 +16,9 @@ Dendrite can automatically populate the database with the relevant tables and in
it is not capable of creating the databases themselves. You will need to create the databases it is not capable of creating the databases themselves. You will need to create the databases
manually. manually.
The databases **must** be created with UTF-8 encoding configured or you will likely run into problems
with your Dendrite deployment.
At this point, you can choose to either use a single database for all Dendrite components, At this point, you can choose to either use a single database for all Dendrite components,
or you can run each component with its own separate database: or you can run each component with its own separate database:
@ -65,7 +68,7 @@ sudo -u postgres createuser -P dendrite
Create the database itself, using the `dendrite` role from above: Create the database itself, using the `dendrite` role from above:
```bash ```bash
sudo -u postgres createdb -O dendrite dendrite sudo -u postgres createdb -O dendrite -E UTF-8 dendrite
``` ```
### Multiple database creation ### Multiple database creation
@ -85,7 +88,7 @@ The following eight components require a database. In this example they will be
```bash ```bash
for i in appservice federationapi mediaapi mscs roomserver syncapi keyserver userapi; do for i in appservice federationapi mediaapi mscs roomserver syncapi keyserver userapi; do
sudo -u postgres createdb -O dendrite dendrite_$i sudo -u postgres createdb -O dendrite -E UTF-8 dendrite_$i
done done
``` ```