OpenCloud
/
MatrixSynapse
mirror of https://github.com/matrix-org/synapse
1
0
Fork 0
Code Issues Releases Wiki Activity

Add a warning to retention documentation regarding the possibility of database corruption (#13497)

pull/13538/head
Shay 2022-08-15 11:54:23 -07:00 committed by GitHub
parent 344a2f767c
commit 73c83c6411
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
changelog.d/13497.doc Normal file
View File

@ -0,0 +1,2 @@
Add a warning to retention documentation regarding the possibility of database corruption.

3
docs/message_retention_policies.md
View File

@ -8,7 +8,8 @@ and allow server and room admins to configure how long messages should
be kept in a homeserver's database before being purged from it. be kept in a homeserver's database before being purged from it.
**Please note that, as this feature isn't part of the Matrix **Please note that, as this feature isn't part of the Matrix
specification yet, this implementation is to be considered as specification yet, this implementation is to be considered as
experimental.** experimental. There are known bugs which may cause database corruption.
Proceed with caution.**
A message retention policy is mainly defined by its `max_lifetime` A message retention policy is mainly defined by its `max_lifetime`
parameter, which defines how long a message can be kept around after parameter, which defines how long a message can be kept around after

6
docs/usage/configuration/config_documentation.md
View File

@ -849,7 +849,11 @@ 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 filter events received over federation so that events that should have been
purged are ignored and not stored again. purged are ignored and not stored again.
The message retention policies feature is disabled by default. 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: This setting has the following sub-options:
* `default_policy`: Default retention policy. If set, Synapse will apply it to rooms that lack the * `default_policy`: Default retention policy. If set, Synapse will apply it to rooms that lack the