Skip to content
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
merged 4 commits into from
Jul 11, 2022

Conversation

anoadragon453
Copy link
Member

@anoadragon453 anoadragon453 commented Jul 7, 2022

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:

@anoadragon453 anoadragon453 marked this pull request as ready for review July 7, 2022 14:53
@anoadragon453 anoadragon453 requested a review from a team as a code owner July 7, 2022 14:53
Copy link
Contributor

@squahtx squahtx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, one small suggestion

docs/usage/configuration/config_documentation.md Outdated Show resolved Hide resolved
@anoadragon453 anoadragon453 enabled auto-merge (squash) July 11, 2022 12:35
@anoadragon453 anoadragon453 merged commit 5ef2f87 into develop Jul 11, 2022
@anoadragon453 anoadragon453 deleted the anoa/databases_doc branch July 11, 2022 14:05
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants