This repository has been archived by the owner on Apr 26, 2024. It is now read-only.
Document the 'databases' homeserver config option #13212
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR documents the
databases
config option, which allows for tentative support of sharding your Synapse data storage across multiple database backends. The feature was originally implemented in #6580.This option is considered supported (we test it in our Sytest CI runs) but potentially not production-ready. We don't use it ourselves on matrix.org and don't know of anyone else using it in production.
Nevertheless, there are some people that are eager to try it out (after having taken the necessary database backups) and documenting the option (with the included warning) will help it be discovered.
The added documentation is probably easiest viewed by:
mdbook serve
, and