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

Commit

Permalink
Make the "don't use retention" warning less subtle
Browse files Browse the repository at this point in the history
No really, don't use it.

Follow up to #13475, #13497.
  • Loading branch information
David Robertson committed Aug 3, 2023
1 parent 9c462f1 commit ad2a8f4
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions docs/usage/configuration/config_documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down

0 comments on commit ad2a8f4

Please sign in to comment.