diff options
| author | Aaron Raimist <aaron@raim.ist> | 2021-05-26 07:29:02 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-05-26 13:29:02 +0100 |
| commit | f95e7a03fa66e00b581d11f17244bf1701559f6c (patch) | |
| tree | b33d73e3cfda424f5653b1d3d44597e16b21332a | |
| parent | Tell CircleCI to build Docker images from `main` (#9906) (diff) | |
| download | synapse-f95e7a03fa66e00b581d11f17244bf1701559f6c.tar.xz | |
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>
| -rw-r--r-- | INSTALL.md | 12 | ||||
| -rw-r--r-- | changelog.d/10057.doc | 1 |
2 files changed, 8 insertions, 5 deletions
diff --git a/INSTALL.md b/INSTALL.md index 7b40689234..3c498edd29 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -399,11 +399,9 @@ Once you have installed synapse as above, you will need to configure it. ### Using PostgreSQL -By default Synapse uses [SQLite](https://sqlite.org/) and in doing so trades performance for convenience. -SQLite is only recommended in Synapse for testing purposes or for servers with -very light workloads. - -Almost all installations should opt to use [PostgreSQL](https://www.postgresql.org). Advantages include: +By default Synapse uses an [SQLite](https://sqlite.org/) database and in doing so trades +performance for convenience. Almost all installations should opt to use [PostgreSQL](https://www.postgresql.org) +instead. Advantages include: - significant performance improvements due to the superior threading and 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 [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 The default configuration exposes a single HTTP port on the local diff --git a/changelog.d/10057.doc b/changelog.d/10057.doc new file mode 100644 index 0000000000..35437cb017 --- /dev/null +++ b/changelog.d/10057.doc @@ -0,0 +1 @@ +Tweak wording of database recommendation in `INSTALL.md`. Contributed by @aaronraimist. \ No newline at end of file |