summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorBrendan Abolivier <babolivier@matrix.org>2022-05-27 17:47:32 +0200
committerGitHub <noreply@github.com>2022-05-27 17:47:32 +0200
commit28989cb301fecf5a669a634c09bc2b73f97fec5d (patch)
tree1233c0aed9e1b0b3c03be144ab39c323dae1759a /docs
parentAdd code M_USER_ACCOUNT_SUSPENDED, as per MSC3823. (#12845) (diff)
downloadsynapse-28989cb301fecf5a669a634c09bc2b73f97fec5d.tar.xz
Add a background job to automatically delete stale devices (#12855)
Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/usage/configuration/config_documentation.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md
index b71b09ba96..88b9e5744d 100644
--- a/docs/usage/configuration/config_documentation.md
+++ b/docs/usage/configuration/config_documentation.md
@@ -575,6 +575,18 @@ Example configuration:
 dummy_events_threshold: 5
 ```
 ---
+Config option `delete_stale_devices_after`
+
+An optional duration. If set, Synapse will run a daily background task to log out and
+delete any device that hasn't been accessed for more than the specified amount of time.
+
+Defaults to no duration, which means devices are never pruned.
+
+Example configuration:
+```yaml
+delete_stale_devices_after: 1y
+```
+
 ## Homeserver blocking ##
 Useful options for Synapse admins.