Add note to 'federation_domain_whitelist' option (#16416)

matrix-org · Oct 3, 2023 · 1e67191 · 1e67191
1 parent 127b940
commit 1e67191
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/changelog.d/16416.doc b/changelog.d/16416.doc
@@ -0,0 +1 @@
+Add note to `federation_domain_whitelist` config option to clarify its usage.
diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md
@@ -1190,6 +1190,11 @@ inbound federation traffic as early as possible, rather than relying
 purely on this application-layer restriction.  If not specified, the
 default is to whitelist everything.
 
+Note: this does not stop a server from joining rooms that servers not on the
+whitelist are in. As such, this option is really only useful to establish a
+"private federation", where a group of servers all whitelist each other and have
+the same whitelist.
+
 Example configuration:
 ```yaml
 federation_domain_whitelist:
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Add note to `federation_domain_whitelist` config option to clarify its usage.