summary refs log tree commit diff
path: root/docs/usage/configuration/config_documentation.md
diff options
context:
space:
mode:
authorShay <hillerys@element.io>2023-08-24 13:57:53 -0700
committerGitHub <noreply@github.com>2023-08-24 13:57:53 -0700
commit5856a8ba4243a11f0d5f97ed2fe742ae31341452 (patch)
treec2a32a94a2e3c9140e49c7258067ae5de10439ba /docs/usage/configuration/config_documentation.md
parentAdd configuration setting for CAS protocol version (#15816) (diff)
downloadsynapse-5856a8ba4243a11f0d5f97ed2fe742ae31341452.tar.xz
Document `exclude_rooms_fom_sync` configuration option (#16178)
Diffstat (limited to 'docs/usage/configuration/config_documentation.md')
-rw-r--r--docs/usage/configuration/config_documentation.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md
index 235f873860..0b1725816e 100644
--- a/docs/usage/configuration/config_documentation.md
+++ b/docs/usage/configuration/config_documentation.md
@@ -3867,6 +3867,19 @@ Example configuration:
 ```yaml
 forget_rooms_on_leave: false
 ```
+---
+### `exclude_rooms_from_sync`
+A list of rooms to exclude from sync responses. This is useful for server
+administrators wishing to group users into a room without these users being able
+to see it from their client.
+
+By default, no room is excluded.
+
+Example configuration:
+```yaml
+exclude_rooms_from_sync:
+    - !foo:example.com
+```
 
 ---
 ## Opentracing