Document `exclude_rooms_fom_sync` configuration option (#16178)

This commit is contained in:
Shay 2023-08-24 13:57:53 -07:00 committed by GitHub
parent aeeca2a62e
commit 5856a8ba42
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 0 deletions

1
changelog.d/16178.doc Normal file
View File

@ -0,0 +1 @@
Document `exclude_rooms_from_sync` configuration option.

View File

@ -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