diff --git a/changelog.d/16382.doc b/changelog.d/16382.doc new file mode 100644 index 0000000000000000000000000000000000000000..25495863108fc80309597503e8aea660fcc805d3 --- /dev/null +++ b/changelog.d/16382.doc @@ -0,0 +1 @@ +Update documentation around message retention policies. diff --git a/docs/message_retention_policies.md b/docs/message_retention_policies.md index 7f3e5359f155ad03df2a5b026616582047dcc3d1..2746a106b3d6307b50551df012eb3ef7f7ee1226 100644 --- a/docs/message_retention_policies.md +++ b/docs/message_retention_policies.md @@ -8,8 +8,7 @@ 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. There are known bugs which may cause database corruption. -Proceed with caution.** +experimental.** 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 54315a417ec18d8e83a2f32b7e6c052c9cefb044..502cd9f8236de02afee89d31d6bf264e6d557922 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md @@ -1026,11 +1026,8 @@ 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. 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). +The message retention policies feature is disabled by default. 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