Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit f95e7a0

Browse files
authored
Tweak wording of database recommendation in INSTALL.md (#10057)
* Tweak wording of database recommendation in INSTALL.md Signed-off-by: Aaron Raimist <[email protected]>
1 parent 913a761 commit f95e7a0

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

INSTALL.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -399,11 +399,9 @@ Once you have installed synapse as above, you will need to configure it.
399399

400400
### Using PostgreSQL
401401

402-
By default Synapse uses [SQLite](https://sqlite.org/) and in doing so trades performance for convenience.
403-
SQLite is only recommended in Synapse for testing purposes or for servers with
404-
very light workloads.
405-
406-
Almost all installations should opt to use [PostgreSQL](https://www.postgresql.org). Advantages include:
402+
By default Synapse uses an [SQLite](https://sqlite.org/) database and in doing so trades
403+
performance for convenience. Almost all installations should opt to use [PostgreSQL](https://www.postgresql.org)
404+
instead. Advantages include:
407405

408406
- significant performance improvements due to the superior threading and
409407
caching model, smarter query optimiser
@@ -412,6 +410,10 @@ Almost all installations should opt to use [PostgreSQL](https://www.postgresql.o
412410
For information on how to install and use PostgreSQL in Synapse, please see
413411
[docs/postgres.md](docs/postgres.md)
414412

413+
SQLite is only acceptable for testing purposes. SQLite should not be used in
414+
a production server. Synapse will perform poorly when using
415+
SQLite, especially when participating in large rooms.
416+
415417
### TLS certificates
416418

417419
The default configuration exposes a single HTTP port on the local

changelog.d/10057.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Tweak wording of database recommendation in `INSTALL.md`. Contributed by @aaronraimist.

0 commit comments

Comments
 (0)