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

Make the "don't use retention" warning less subtle #16062

Closed
wants to merge 4 commits into from
Closed

Make the "don't use retention" warning less subtle #16062

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ad2a8f4
Make the "don't use retention" warning less subtle
Aug 3, 2023
0722842
Changelog
Aug 3, 2023
316476e
Be even less subtle
Aug 3, 2023
f7a46a9
Fix syntax
Aug 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/16062.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Emphasise more strongly that message retention is experimental and buggy.
21 changes: 15 additions & 6 deletions docs/usage/configuration/config_documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).

<details>
<summary>I understand I risk corrupting my homeserver, show me the details</summary>


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.
Expand All @@ -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
Expand Down Expand Up @@ -1076,6 +1083,8 @@ retention:
- shortest_max_lifetime: 3d
interval: 1d
```
</details>

---
## TLS

Expand Down
Loading