Skip to content

entrypoint: Add PROXY_ALLOW_* settings for setting outgoing proxy rules. #511

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
merged 1 commit into from
Sep 18, 2025
Merged

entrypoint: Add PROXY_ALLOW_* settings for setting outgoing proxy rules. #511

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,14 @@ proxies][other-proxy].
[haproxy-proxy]: https://zulip.readthedocs.io/en/latest/production/reverse-proxies.html#haproxy-configuration
[other-proxy]: https://zulip.readthedocs.io/en/latest/production/reverse-proxies.html#other-proxies

**Outgoing proxy**: Zulip uses [Smokescreen][smokescreen] to proxy all
outgoing HTTP connections and prevent SSRF attacks. If you have
private IPs (e.g., outgoing webhook hosts on private IPs), you can set
`PROXY_ALLOW_ADDRESSES` or `PROXY_ALLOW_RANGES` to comma-separated
lists of IP addresses or CIDR ranges.

[smokescreen]: https://zulip.readthedocs.io/en/latest/production/deployment.html#customizing-the-outgoing-http-proxy

### Manual configuration

The way the environment variables configuration process described in
Expand Down
9 changes: 9 additions & 0 deletions entrypoint.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,15 @@ puppetConfiguration() {
crudini --set /etc/zulip/zulip.conf loadbalancer ips "${LOADBALANCER_IPS}"
fi

if [ -n "$PROXY_ALLOW_ADDRESSES" ]; then
echo "Setting outgoing proxy allowed private IPs"
crudini --set /etc/zulip/zulip.conf http_proxy allow_addresses "${PROXY_ALLOW_ADDRESSES}"
fi
if [ -n "$PROXY_ALLOW_RANGES" ]; then
echo "Setting outgoing proxy allowed private IP ranges"
crudini --set /etc/zulip/zulip.conf http_proxy allow_ranges "${PROXY_ALLOW_RANGES}"
fi

/home/zulip/deployments/current/scripts/zulip-puppet-apply -f
}
configureCerts() {
Expand Down