This repository was archived by the owner on Apr 26, 2024. It is now read-only.
File tree Expand file tree Collapse file tree 3 files changed +9
-2
lines changed Expand file tree Collapse file tree 3 files changed +9
-2
lines changed Original file line number Diff line number Diff line change 1+ Add a warning to retention documentation regarding the possibility of database corruption.
2+
Original file line number Diff line number Diff line change @@ -8,7 +8,8 @@ and allow server and room admins to configure how long messages should
88be kept in a homeserver's database before being purged from it.
99** Please note that, as this feature isn't part of the Matrix
1010specification 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
1314A message retention policy is mainly defined by its ` max_lifetime `
1415parameter, which defines how long a message can be kept around after
Original file line number Diff line number Diff line change @@ -849,7 +849,11 @@ which are older than the room's maximum retention period. Synapse will also
849849filter events received over federation so that events that should have been
850850purged 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
854858This setting has the following sub-options :
855859* `default_policy`: Default retention policy. If set, Synapse will apply it to rooms that lack the
You can’t perform that action at this time.
0 commit comments