Tweak wording of database recommendation in INSTALL.md (#10057)

* Tweak wording of database recommendation in INSTALL.md

Signed-off-by: Aaron Raimist <aaron@raim.ist>
This commit is contained in:
Aaron Raimist 2021-05-26 07:29:02 -05:00 committed by GitHub
parent 913a761a53
commit f95e7a03fa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 5 deletions

View File

@ -399,11 +399,9 @@ Once you have installed synapse as above, you will need to configure it.
### Using PostgreSQL ### Using PostgreSQL
By default Synapse uses [SQLite](https://sqlite.org/) and in doing so trades performance for convenience. By default Synapse uses an [SQLite](https://sqlite.org/) database and in doing so trades
SQLite is only recommended in Synapse for testing purposes or for servers with performance for convenience. Almost all installations should opt to use [PostgreSQL](https://www.postgresql.org)
very light workloads. instead. Advantages include:
Almost all installations should opt to use [PostgreSQL](https://www.postgresql.org). Advantages include:
- significant performance improvements due to the superior threading and - significant performance improvements due to the superior threading and
caching model, smarter query optimiser caching model, smarter query optimiser
@ -412,6 +410,10 @@ Almost all installations should opt to use [PostgreSQL](https://www.postgresql.o
For information on how to install and use PostgreSQL in Synapse, please see For information on how to install and use PostgreSQL in Synapse, please see
[docs/postgres.md](docs/postgres.md) [docs/postgres.md](docs/postgres.md)
SQLite is only acceptable for testing purposes. SQLite should not be used in
a production server. Synapse will perform poorly when using
SQLite, especially when participating in large rooms.
### TLS certificates ### TLS certificates
The default configuration exposes a single HTTP port on the local The default configuration exposes a single HTTP port on the local

1
changelog.d/10057.doc Normal file
View File

@ -0,0 +1 @@
Tweak wording of database recommendation in `INSTALL.md`. Contributed by @aaronraimist.