Skip to content

Commit cbad802

Browse files
authored
provide advice for exposing proxy publicly (#459)
1 parent ccb8989 commit cbad802

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,23 @@ on connections. If you have a network load balancer you can preserve the client
113113
2. 8443: Standard web traffic, encrypted (HTTPS) with PROXY protocol expected
114114
3. 8222: Jabber protocol traffic (WhatsApp default) with PROXY protocol expected
115115

116+
## Adverse network conditions
117+
118+
The proxy container exposes many ports for different functionality.
119+
When deploying the container to work around adverse network conditions,
120+
this flexibility may actually be undesirable,
121+
since a proxy instance may be uniquely identified by some of the non-standard ports.
122+
123+
To provide basic functionality (messages and media),
124+
we recommend exposing only ports 443 and 587 on the proxy endpoint.
125+
126+
This is required **only if exposing the proxy on a public IP address**,
127+
and not needed for users connecting to the proxy through a VPN or a private connection.
128+
129+
> Note: When using the proxy enabled HTTPS port (8443),
130+
> make sure port 8443 is exposed publicly as port 443,
131+
> to ensure WhatsApp clients can connect to port 443.
132+
116133
## Certificate generation for SSL encrypted ports
117134

118135
Ports 443 and 8443 are protected by a self-signed encryption certificate generated at container start time. There are some custom options should you wish to tweak the settings of the generated certificates

0 commit comments

Comments
 (0)