diff options
| author | Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> | 2022-08-11 14:06:09 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-08-11 14:06:09 +0100 |
| commit | 953df2ad88fb9fc7d1a67966c79980136321119d (patch) | |
| tree | b62fb95168f2cf1e612174a070dbe395741e7b9c | |
| parent | Add viewport directive to HTML templates to optimise for mobile (#13493) (diff) | |
| download | synapse-953df2ad88fb9fc7d1a67966c79980136321119d.tar.xz | |
Add note to `redaction_retention_period` documentation mentioning that event purging runs at most every 5m (#13492)
| -rw-r--r-- | changelog.d/13492.doc | 1 | ||||
| -rw-r--r-- | docs/usage/configuration/config_documentation.md | 4 |
2 files changed, 5 insertions, 0 deletions
diff --git a/changelog.d/13492.doc b/changelog.d/13492.doc new file mode 100644 index 0000000000..fc4850d556 --- /dev/null +++ b/changelog.d/13492.doc @@ -0,0 +1 @@ +Document that event purging related to the `redaction_retention_period` config option is executed only every 5 minutes. 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: |