diff options
| author | Shay <hillerys@element.io> | 2023-08-24 13:57:53 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-08-24 13:57:53 -0700 |
| commit | 5856a8ba4243a11f0d5f97ed2fe742ae31341452 (patch) | |
| tree | c2a32a94a2e3c9140e49c7258067ae5de10439ba | |
| parent | Add configuration setting for CAS protocol version (#15816) (diff) | |
| download | synapse-5856a8ba4243a11f0d5f97ed2fe742ae31341452.tar.xz | |
Document `exclude_rooms_fom_sync` configuration option (#16178)
| -rw-r--r-- | changelog.d/16178.doc | 1 | ||||
| -rw-r--r-- | docs/usage/configuration/config_documentation.md | 13 |
2 files changed, 14 insertions, 0 deletions
diff --git a/changelog.d/16178.doc b/changelog.d/16178.doc new file mode 100644 index 0000000000..ea21e19240 --- /dev/null +++ b/changelog.d/16178.doc @@ -0,0 +1 @@ +Document `exclude_rooms_from_sync` configuration option. 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 |