aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorNeil Alexander <neilalexander@users.noreply.github.com>2022-09-26 09:33:34 +0100
committerNeil Alexander <neilalexander@users.noreply.github.com>2022-09-26 09:33:34 +0100
commit8d64c24b23518fde968020e5a093564acc46235a (patch)
tree1f20887e4881618b8ba14820d3b44f1b0278e765 /docs
parentd5978d98fda8a31918973a2481e62eafcec9f80f (diff)
Update documentation to state that Dendrite requires PostgreSQL UTF-8 encoding
Diffstat (limited to 'docs')
-rw-r--r--docs/installation/4_database.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/docs/installation/4_database.md b/docs/installation/4_database.md
index 68f2d44d..d64ee661 100644
--- a/docs/installation/4_database.md
+++ b/docs/installation/4_database.md
@@ -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
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,
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:
```bash
-sudo -u postgres createdb -O dendrite dendrite
+sudo -u postgres createdb -O dendrite -E UTF-8 dendrite
```
### Multiple database creation
@@ -85,7 +88,7 @@ The following eight components require a database. In this example they will be
```bash
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
```