diff --git a/changelog.d/16062.doc b/changelog.d/16062.doc new file mode 100644 index 000000000000..93e38922e5f0 --- /dev/null +++ b/changelog.d/16062.doc @@ -0,0 +1 @@ +Emphasise more strongly that message retention is experimental and buggy. diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md index 4e6fcd085acb..e2c7b8c27131 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md @@ -1004,6 +1004,19 @@ templates: This option and the associated options determine message retention policy at the server level. +> #### ⚠️ WARNING +> +> 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*](https://github.com/matrix-org/synapse/issues/13476)**. +> Setting retention to delete older history is less risky than deleting newer history, +> but in general caution is strongly advised when enabling this +> experimental feature. You can read more about this feature [here](../../message_retention_policies.md). + +
+I understand I risk corrupting my homeserver, show me the details + + Room admins and mods can define a retention period for their rooms using the `m.room.retention` state event, and server admins can cap this period by setting the `allowed_lifetime_min` and `allowed_lifetime_max` config options. @@ -1013,12 +1026,6 @@ 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). - This setting has the following sub-options: * `default_policy`: Default retention policy. If set, Synapse will apply it to rooms that lack the 'm.room.retention' state event. This option is further specified by the @@ -1076,6 +1083,8 @@ retention: - shortest_max_lifetime: 3d interval: 1d ``` +
+ --- ## TLS