diff options
| author | Shay <hillerys@element.io> | 2022-08-15 11:54:23 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-08-15 11:54:23 -0700 |
| commit | 73c83c641138f0644582468a869e10f19f389800 (patch) | |
| tree | 33d48f49947dd05f8fd40c4149647c031d6193d2 | |
| parent | Instrument `FederationStateIdsServlet` - `/state_ids` (#13499) (diff) | |
| download | synapse-73c83c641138f0644582468a869e10f19f389800.tar.xz | |
Add a warning to retention documentation regarding the possibility of database corruption (#13497)
| -rw-r--r-- | changelog.d/13497.doc | 2 | ||||
| -rw-r--r-- | docs/message_retention_policies.md | 3 | ||||
| -rw-r--r-- | docs/usage/configuration/config_documentation.md | 6 |
3 files changed, 9 insertions, 2 deletions
diff --git a/changelog.d/13497.doc b/changelog.d/13497.doc new file mode 100644 index 0000000000..ef6dc2308d --- /dev/null +++ b/changelog.d/13497.doc @@ -0,0 +1,2 @@ +Add a warning to retention documentation regarding the possibility of database corruption. + diff --git a/docs/message_retention_policies.md b/docs/message_retention_policies.md index 8c88f93935..7f3e5359f1 100644 --- a/docs/message_retention_policies.md +++ b/docs/message_retention_policies.md @@ -8,7 +8,8 @@ and allow server and room admins to configure how long messages should be kept in a homeserver's database before being purged from it. **Please note that, as this feature isn't part of the Matrix specification yet, this implementation is to be considered as -experimental.** +experimental. There are known bugs which may cause database corruption. +Proceed with caution.** A message retention policy is mainly defined by its `max_lifetime` parameter, which defines how long a message can be kept around after diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md index bc3d2bec6a..d8c29e6063 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md @@ -849,7 +849,11 @@ which are older than the room's maximum retention period. Synapse will also filter events received over federation so that events that should have been purged are ignored and not stored again. -The message retention policies feature is disabled by default. +The message retention policies feature is disabled by default. Please be advised +that enabling this feature carries some risk. There are known bugs with the implementation +which can cause database corruption. Setting retention to delete older history +is less risky than deleting newer history but in general caution is advised when enabling this +experimental feature. You can read more about this feature [here](../../message_retention_policies.md). This setting has the following sub-options: * `default_policy`: Default retention policy. If set, Synapse will apply it to rooms that lack the |