Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit a59cb59

Browse files
H-Shayhughns
authored andcommitted
Document exclude_rooms_fom_sync configuration option (#16178)
1 parent a0adf71 commit a59cb59

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

changelog.d/16178.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Document `exclude_rooms_from_sync` configuration option.

docs/usage/configuration/config_documentation.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3867,6 +3867,19 @@ Example configuration:
38673867
```yaml
38683868
forget_rooms_on_leave: false
38693869
```
3870+
---
3871+
### `exclude_rooms_from_sync`
3872+
A list of rooms to exclude from sync responses. This is useful for server
3873+
administrators wishing to group users into a room without these users being able
3874+
to see it from their client.
3875+
3876+
By default, no room is excluded.
3877+
3878+
Example configuration:
3879+
```yaml
3880+
exclude_rooms_from_sync:
3881+
- !foo:example.com
3882+
```
38703883

38713884
---
38723885
## Opentracing

0 commit comments

Comments
 (0)