Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit 73c83c6

Browse files
authored
Add a warning to retention documentation regarding the possibility of database corruption (#13497)
1 parent 344a2f7 commit 73c83c6

File tree

3 files changed

+9
-2
lines changed

3 files changed

+9
-2
lines changed

changelog.d/13497.doc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Add a warning to retention documentation regarding the possibility of database corruption.
2+

docs/message_retention_policies.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ and allow server and room admins to configure how long messages should
88
be kept in a homeserver's database before being purged from it.
99
**Please note that, as this feature isn't part of the Matrix
1010
specification yet, this implementation is to be considered as
11-
experimental.**
11+
experimental. There are known bugs which may cause database corruption.
12+
Proceed with caution.**
1213

1314
A message retention policy is mainly defined by its `max_lifetime`
1415
parameter, which defines how long a message can be kept around after

docs/usage/configuration/config_documentation.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -849,7 +849,11 @@ which are older than the room's maximum retention period. Synapse will also
849849
filter events received over federation so that events that should have been
850850
purged are ignored and not stored again.
851851

852-
The message retention policies feature is disabled by default.
852+
The message retention policies feature is disabled by default. Please be advised
853+
that enabling this feature carries some risk. There are known bugs with the implementation
854+
which can cause database corruption. Setting retention to delete older history
855+
is less risky than deleting newer history but in general caution is advised when enabling this
856+
experimental feature. You can read more about this feature [here](../../message_retention_policies.md).
853857

854858
This setting has the following sub-options:
855859
* `default_policy`: Default retention policy. If set, Synapse will apply it to rooms that lack the

0 commit comments

Comments
 (0)