summary refs log tree commit diff
path: root/docs/usage
diff options
context:
space:
mode:
authorAndrew Morgan <1342360+anoadragon453@users.noreply.github.com>2022-08-11 14:06:09 +0100
committerGitHub <noreply@github.com>2022-08-11 14:06:09 +0100
commit953df2ad88fb9fc7d1a67966c79980136321119d (patch)
treeb62fb95168f2cf1e612174a070dbe395741e7b9c /docs/usage
parentAdd viewport directive to HTML templates to optimise for mobile (#13493) (diff)
downloadsynapse-953df2ad88fb9fc7d1a67966c79980136321119d.tar.xz
Add note to `redaction_retention_period` documentation mentioning that event purging runs at most every 5m (#13492)
Diffstat (limited to 'docs/usage')
-rw-r--r--docs/usage/configuration/config_documentation.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md
index 2af32a6155..bc3d2bec6a 100644
--- a/docs/usage/configuration/config_documentation.md
+++ b/docs/usage/configuration/config_documentation.md
@@ -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
 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.
 
 Example configuration: