Skip to content

Update docs to clarify outbound_federation_restricted_to can also be used with the SBG #19517

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MadLittleMods merged 3 commits into from
Mar 3, 2026
Merged

Update docs to clarify outbound_federation_restricted_to can also be used with the SBG #19517

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
675987a
Update docs to clarify `outbound_federation_restricted_to` can also b…
MadLittleMods Mar 2, 2026
34c0acb
Use standard casing
MadLittleMods Mar 2, 2026
72624bc
Add changelog
MadLittleMods Mar 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/19517.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Update docs to clarify `outbound_federation_restricted_to` can also be used with the [Secure Border Gateway (SBG)](https://element.io/en/server-suite/secure-border-gateways).
2 changes: 1 addition & 1 deletion docs/usage/configuration/config_documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4484,7 +4484,7 @@ stream_writers:
---
### `outbound_federation_restricted_to`

*(array)* When using workers, you can restrict outbound federation traffic to only go through a specific subset of workers. Any worker specified here must also be in the [`instance_map`](#instance_map). [`worker_replication_secret`](#worker_replication_secret) must also be configured to authorize inter-worker communication.
*(array)* You can restrict outbound federation traffic to only go through a specific subset of workers including the [Secure Border Gateway (SBG)](https://element.io/en/server-suite/secure-border-gateways). Any worker specified here (including the SBG) must also be in the [`instance_map`](#instance_map). [`worker_replication_secret`](#worker_replication_secret) must also be configured to authorize inter-worker communication.

Also see the [worker documentation](../../workers.md#restrict-outbound-federation-traffic-to-a-specific-set-of-workers) for more info.

Expand Down
12 changes: 7 additions & 5 deletions schema/synapse-config.schema.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5529,11 +5529,13 @@ properties:
outbound_federation_restricted_to:
type: array
description: >-
When using workers, you can restrict outbound federation traffic to only
go through a specific subset of workers. Any worker specified here must
also be in the [`instance_map`](#instance_map).
[`worker_replication_secret`](#worker_replication_secret) must also be
configured to authorize inter-worker communication.
You can restrict outbound federation traffic to only go through a specific subset
of workers including the [Secure Border Gateway
(SBG)](https://element.io/en/server-suite/secure-border-gateways). Any worker
specified here (including the SBG) must also be in the
[`instance_map`](#instance_map).
[`worker_replication_secret`](#worker_replication_secret) must also be configured
to authorize inter-worker communication.


Also see the [worker
Expand Down