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

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

Merged
merged 5 commits into from
Aug 15, 2022
Merged

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

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b3fb021
warn about retention
H-Shay Aug 10, 2022
284812e
newsfragment
H-Shay Aug 10, 2022
10f17e0
fix spelling in changelog
H-Shay Aug 10, 2022
8f69f6a
incorporate reveiw suggestions
H-Shay Aug 12, 2022
dd6f68f
typo
H-Shay Aug 12, 2022
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
2 changes: 2 additions & 0 deletions changelog.d/13497.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Add a warning to retention documentation regarding the possibility of databse corruption.

H-Shay marked this conversation as resolved.
Show resolved Hide resolved
6 changes: 5 additions & 1 deletion docs/usage/configuration/config_documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -845,7 +845,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
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, as it is possible to corrupt your database
due to insufficient cache invalidation. Setting retention to delete older history
H-Shay marked this conversation as resolved.
Show resolved Hide resolved
is less risky than deleting newer history (ie deleting 3-year-old history is safer than history from
H-Shay marked this conversation as resolved.
Show resolved Hide resolved
yesterday), but in general caution is advised when enabling this feature.

H-Shay marked this conversation as resolved.
Show resolved Hide resolved
This setting has the following sub-options:
* `default_policy`: Default retention policy. If set, Synapse will apply it to rooms that lack the
Expand Down