From ad2a8f459c90e4ba7b5d3adc8d5c64667f66ae8e Mon Sep 17 00:00:00 2001 From: David Robertson Date: Thu, 3 Aug 2023 18:31:35 +0100 Subject: [PATCH 1/4] Make the "don't use retention" warning less subtle No really, don't use it. Follow up to #13475, #13497. --- .../usage/configuration/config_documentation.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md index 4e6fcd085acb..e86409deb8d0 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md @@ -1004,6 +1004,17 @@ 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). + +#### 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 +1024,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 From 07228421097ca00aa3454896ee8fb72e3b81bebf Mon Sep 17 00:00:00 2001 From: David Robertson Date: Thu, 3 Aug 2023 18:33:43 +0100 Subject: [PATCH 2/4] Changelog --- changelog.d/16062.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/16062.doc 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. From 316476e02f2a1cdc18f151cb1fecf7ccc00b3c2c Mon Sep 17 00:00:00 2001 From: David Robertson Date: Thu, 3 Aug 2023 18:37:47 +0100 Subject: [PATCH 3/4] Be even less subtle --- .../configuration/config_documentation.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md index e86409deb8d0..787875e5716b 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md @@ -1004,16 +1004,18 @@ templates: This option and the associated options determine message retention policy at the server level. -#### ⚠️ WARNING +> #### ⚠️ 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). -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 -#### 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 @@ -1081,6 +1083,7 @@ retention: - shortest_max_lifetime: 3d interval: 1d ``` +
--- ## TLS From f7a46a9c1d76ec0e3bab4e1e4c94b2b2c29cf774 Mon Sep 17 00:00:00 2001 From: David Robertson Date: Thu, 3 Aug 2023 18:43:36 +0100 Subject: [PATCH 4/4] Fix syntax --- docs/usage/configuration/config_documentation.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md index 787875e5716b..e2c7b8c27131 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md @@ -1084,6 +1084,7 @@ retention: interval: 1d ``` + --- ## TLS