0
0
Fork 0
mirror of https://github.com/matrix-org/dendrite synced 2024-11-18 07:40:53 +01:00
dendrite/docs/installation
Alex Kirk 05f72fc4be
Update docs and sample config for the relay_api (#3011)
This adds an empty `relay_api` section to the sample configuration. For
SQLite environments, or others where a `database.connection_string` is
needed for each section, there should be an entry in the configuration
sample as a basis.

This PR also changes the "Configuring Dendrite" documentation in that
respect.

The requirement was introduced in #2917. When upgrading dendrite, it
will complain about `relay_api.database.connection_string` not being
configured.

### Pull Request Checklist

<!-- Please read
https://matrix-org.github.io/dendrite/development/contributing before
submitting your pull request -->

* [x] I have added Go unit tests or [Complement integration
tests](https://github.com/matrix-org/complement) for this PR _or_ I have
justified why this PR doesn't need tests
* [x] Pull request includes a [sign off below using a legally
identifiable
name](https://matrix-org.github.io/dendrite/development/contributing#sign-off)
_or_ I have already signed off privately

Signed-off-by: `Alex Kirk <akirk@users.noreply.github.com>`
2023-03-27 10:55:36 +02:00
..
1_planning.md Remove polylith/API mode (#2967) 2023-02-14 12:47:47 +01:00
2_domainname.md Fix Caddy config well-known delegation example (#2879) 2022-11-14 17:15:39 +00:00
3_build.md Updated instructions and references to monolith to their new names (#2994) 2023-03-03 10:20:53 +01:00
4_database.md Update documentation to state that Dendrite requires PostgreSQL UTF-8 encoding 2022-09-26 09:33:34 +01:00
5_install_monolith.md Updated instructions and references to monolith to their new names (#2994) 2023-03-03 10:20:53 +01:00
7_configuration.md Update docs and sample config for the relay_api (#3011) 2023-03-27 10:55:36 +02:00
8_signingkey.md docs: Add build page; correct proxy info; fix Caddy example (#2579) 2022-07-21 07:08:17 +02:00
9_starting_monolith.md Updated instructions and references to monolith to their new names (#2994) 2023-03-03 10:20:53 +01:00
11_optimisation.md Document database connection limits 2022-10-05 14:54:19 +01:00