diff options
| author | Erik Johnston <erikj@element.io> | 2024-05-13 20:38:45 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-05-13 19:38:45 +0000 |
| commit | 038b9ec59a5d2080372aa4b7684e7b6580a79bd8 (patch) | |
| tree | 9265faf6a8e8b20c56261b75aa283eec52652083 /docs/usage/configuration/config_documentation.md | |
| parent | Actually fix public rooms (#17184) (diff) | |
| download | synapse-038b9ec59a5d2080372aa4b7684e7b6580a79bd8.tar.xz | |
An federation whitelist query endpoint extension (#16848)
This is to allow clients to query the configured federation whitelist. Disabled by default. --------- Co-authored-by: Devon Hudson <devonhudson@librem.one> Co-authored-by: devonh <devon.dmytro@gmail.com> Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
Diffstat (limited to 'docs/usage/configuration/config_documentation.md')
| -rw-r--r-- | docs/usage/configuration/config_documentation.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md index 2046bf4564..2257318bcc 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md @@ -1232,6 +1232,31 @@ federation_domain_whitelist: - syd.example.com ``` --- +### `federation_whitelist_endpoint_enabled` + +Enables an endpoint for fetching the federation whitelist config. + +The request method and path is `GET /_synapse/client/config/federation_whitelist`, and the +response format is: + +```json +{ + "whitelist_enabled": true, // Whether the federation whitelist is being enforced + "whitelist": [ // Which server names are allowed by the whitelist + "example.com" + ] +} +``` + +If `whitelist_enabled` is `false` then the server is permitted to federate with all others. + +The endpoint requires authentication. + +Example configuration: +```yaml +federation_whitelist_endpoint_enabled: true +``` +--- ### `federation_metrics_domains` Report prometheus metrics on the age of PDUs being sent to and received from |