diff options
| author | Eric Eastwood <erice@element.io> | 2023-07-18 03:49:21 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-07-18 09:49:21 +0100 |
| commit | 1c802de626de3293049206cb788af15cbc8ea17f (patch) | |
| tree | 52d72c2fcd6442e96943a7a565c519240eca19eb /docs/workers.md | |
| parent | Bump anyhow from 1.0.71 to 1.0.72 (#15949) (diff) | |
| download | synapse-1c802de626de3293049206cb788af15cbc8ea17f.tar.xz | |
Re-introduce the outbound federation proxy (#15913)
Allow configuring the set of workers to proxy outbound federation traffic through (`outbound_federation_restricted_to`). This is useful when you have a worker setup with `federation_sender` instances responsible for sending outbound federation requests and want to make sure *all* outbound federation traffic goes through those instances. Before this change, the generic workers would still contact federation themselves for things like profile lookups, backfill, etc. This PR allows you to set more strict access controls/firewall for all workers and only allow the `federation_sender`'s to contact the outside world.
Diffstat (limited to 'docs/workers.md')
| -rw-r--r-- | docs/workers.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/workers.md b/docs/workers.md index cf9c0add82..24bd22724e 100644 --- a/docs/workers.md +++ b/docs/workers.md @@ -531,6 +531,30 @@ the stream writer for the `presence` stream: ^/_matrix/client/(api/v1|r0|v3|unstable)/presence/ +#### Restrict outbound federation traffic to a specific set of workers + +The +[`outbound_federation_restricted_to`](usage/configuration/config_documentation.md#outbound_federation_restricted_to) +configuration is useful to make sure outbound federation traffic only goes through a +specified subset of workers. This allows you to set more strict access controls (like a +firewall) for all workers and only allow the `federation_sender`'s to contact the +outside world. + +```yaml +instance_map: + main: + host: localhost + port: 8030 + federation_sender1: + host: localhost + port: 8034 + +outbound_federation_restricted_to: + - federation_sender1 + +worker_replication_secret: "secret_secret" +``` + #### Background tasks There is also support for moving background tasks to a separate |