summary refs log tree commit diff
path: root/docs/sample_config.yaml
diff options
context:
space:
mode:
authorKento Okamoto <Kentokamoto@users.noreply.github.com>2021-08-03 11:13:34 -0700
committerGitHub <noreply@github.com>2021-08-03 18:13:34 +0000
commit72935b7c5053af122c8cb5767a3e85a3a0f3a20c (patch)
tree46445f327f205e76a1285168aa3ac85794563ca2 /docs/sample_config.yaml
parentFix debian package triggers (#10481) (diff)
downloadsynapse-72935b7c5053af122c8cb5767a3e85a3a0f3a20c.tar.xz
Add warnings to ip_range_blacklist usage with proxies (#10129)
Per issue #9812 using `url_preview_ip_range_blacklist` with a proxy via `HTTPS_PROXY` or `HTTP_PROXY` environment variables has some inconsistent bahavior than mentioned. This PR changes the following:

- Changes the Sample Config file to include a note mentioning that `url_preview_ip_range_blacklist` and `ip_range_blacklist` is ignored when using a proxy
- Changes some logic in synapse/config/repository.py to send a warning when both `*ip_range_blacklist` configs and a proxy environment variable are set and but no longer throws an error.

Signed-off-by: Kento Okamoto <kentokamoto@protonmail.com>
Diffstat (limited to 'docs/sample_config.yaml')
-rw-r--r--docs/sample_config.yaml4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml
index a2efc14100..16843dd8c9 100644
--- a/docs/sample_config.yaml
+++ b/docs/sample_config.yaml
@@ -210,6 +210,8 @@ presence:
 #
 # This option replaces federation_ip_range_blacklist in Synapse v1.25.0.
 #
+# Note: The value is ignored when an HTTP proxy is in use
+#
 #ip_range_blacklist:
 #  - '127.0.0.0/8'
 #  - '10.0.0.0/8'
@@ -972,6 +974,8 @@ media_store_path: "DATADIR/media_store"
 # This must be specified if url_preview_enabled is set. It is recommended that
 # you uncomment the following list as a starting point.
 #
+# Note: The value is ignored when an HTTP proxy is in use
+#
 #url_preview_ip_range_blacklist:
 #  - '127.0.0.0/8'
 #  - '10.0.0.0/8'