Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
synapse
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Monitor
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Maunium
synapse
Commits
73c83c64
Unverified
Commit
73c83c64
authored
2 years ago
by
Shay
Committed by
GitHub
2 years ago
Browse files
Options
Downloads
Patches
Plain Diff
Add a warning to retention documentation regarding the possibility of database corruption (#13497)
parent
344a2f76
No related branches found
No related tags found
No related merge requests found
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
changelog.d/13497.doc
+2
-0
2 additions, 0 deletions
changelog.d/13497.doc
docs/message_retention_policies.md
+2
-1
2 additions, 1 deletion
docs/message_retention_policies.md
docs/usage/configuration/config_documentation.md
+5
-1
5 additions, 1 deletion
docs/usage/configuration/config_documentation.md
with
9 additions
and
2 deletions
changelog.d/13497.doc
0 → 100644
+
2
−
0
View file @
73c83c64
Add a warning to retention documentation regarding the possibility of database corruption.
This diff is collapsed.
Click to expand it.
docs/message_retention_policies.md
+
2
−
1
View file @
73c83c64
...
@@ -8,7 +8,8 @@ and allow server and room admins to configure how long messages should
...
@@ -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
...
...
This diff is collapsed.
Click to expand it.
docs/usage/configuration/config_documentation.md
+
5
−
1
View file @
73c83c64
...
@@ -849,7 +849,11 @@ which are older than the room's maximum retention period. Synapse will also
...
@@ -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
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment