Add note to redaction_retention_period documentation mentioning that event purging runs at most every 5m (#13492)

This commit is contained in:
Andrew Morgan 2022-08-11 14:06:09 +01:00 committed by GitHub
parent 4390121684
commit 953df2ad88
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 0 deletions

1
changelog.d/13492.doc Normal file
View file

@ -0,0 +1 @@
Document that event purging related to the `redaction_retention_period` config option is executed only every 5 minutes.

View file

@ -759,6 +759,10 @@ allowed_avatar_mimetypes: ["image/png", "image/jpeg", "image/gif"]
How long to keep redacted events in unredacted form in the database. After How long to keep redacted events in unredacted form in the database. After
this period redacted events get replaced with their redacted form in the DB. this period redacted events get replaced with their redacted form in the DB.
Synapse will check whether the rentention period has concluded for redacted
events every 5 minutes. Thus, even if this option is set to `0`, Synapse may
still take up to 5 minutes to purge redacted events from the database.
Defaults to `7d`. Set to `null` to disable. Defaults to `7d`. Set to `null` to disable.
Example configuration: Example configuration: