Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs(env): note that compose does not forward WEBHOOK_SSRF_PROTECT

Yudhi Armyndharis1738aaf6884b
diff --git a/.env.example b/.env.example
index 253e25f39..4e7f35972 100644
--- a/.env.example
+++ b/.env.example
@@ -470,10 +470,13 @@ WEBHOOK_RETRY_DELAY=5000 # Delay between retries in ms
# webhook URLs resolving to loopback/private/link-local/metadata ranges are
# refused (at registration AND delivery) and redirects are not followed.
# (Server-side media-by-URL fetches are ALWAYS SSRF-guarded, regardless of this flag.)
+# The bundled Docker Compose does not forward this key (it fails safe), so a value here does not
+# reach the container; for a receiver on the compose network, list it in SSRF_ALLOWED_HOSTS instead.
WEBHOOK_SSRF_PROTECT=true
# Redirect handling when SSRF protection is DISABLED (WEBHOOK_SSRF_PROTECT=false): fail loudly on
# 3xx ('error', the default) or follow them ('true'). Disabling the guard is not opting into
# chasing redirects to arbitrary hosts — set this only if a receiver legitimately redirects.
+# It is never read while protection is on.
# WEBHOOK_SSRF_REDIRECTS=false
# Expose the FULL sender `contact` field set (id, number, shortName, business flags, isBlocked,