summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorAndrew Morgan <1342360+anoadragon453@users.noreply.github.com>2023-04-17 18:16:02 -0600
committerGitHub <noreply@github.com>2023-04-17 18:16:02 -0600
commit929797d939e6d55ad7b0838c361396f43903156a (patch)
tree6de8baa3993287dee53a5c514610588c9b287382 /docs
parentSwitch `InstanceLocationConfig` to a pydantic `BaseModel` (#15431) (diff)
downloadsynapse-929797d939e6d55ad7b0838c361396f43903156a.tar.xz
Add a note to the config documentation that the 'delete_stale_devices_after' job always runs on the main process (#15452)
Diffstat (limited to 'docs')
-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 c5c2c2b615..1b6f256949 100644
--- a/docs/usage/configuration/config_documentation.md
+++ b/docs/usage/configuration/config_documentation.md
@@ -577,6 +577,10 @@ delete any device that hasn't been accessed for more than the specified amount o
 
 Defaults to no duration, which means devices are never pruned.
 
+**Note:** This task will always run on the main process, regardless of the value of
+`run_background_tasks_on`. This is due to workers currently not having the ability to
+delete devices.
+
 Example configuration:
 ```yaml
 delete_stale_devices_after: 1y