diff options
author | Peter Powell <petpow@saberuk.com> | 2019-11-28 17:59:35 +0000 |
---|---|---|
committer | Peter Powell <petpow@saberuk.com> | 2019-11-28 17:59:35 +0000 |
commit | bb1f892f68cb70537b224bca85cc40f1ed23017d (patch) | |
tree | c4722306888be6c4864b5b39220313affbb886d2 /docs | |
parent | 6f2d0b505f4715c696cc5d49874d442cf790b98a (diff) |
Implement support for websocket connections via a proxy like nginx.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/conf/modules.conf.example | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/docs/conf/modules.conf.example b/docs/conf/modules.conf.example index 639f02335..9cb78daee 100644 --- a/docs/conf/modules.conf.example +++ b/docs/conf/modules.conf.example @@ -2307,11 +2307,18 @@ # Requires SHA-1 hash support available in the sha1 module. #<module name="websocket"> # -# Whether to re-encode messages as UTF-8 before sending to WebSocket -# clients. This is recommended as the WebSocket protocol requires all -# text frames to be sent as UTF-8. If you do not have this enabled -# messages will be sent as binary frames instead. -#<websocket sendastext="yes"> +# behindproxy: Whether the server is behind a proxy that sends the +# X-Real-IP or X-Forwarded-For headers. If enabled the +# server will use the IP address specified by those HTTP +# headers. You should NOT enable this unless you are using +# a HTTP proxy like nginx as it will allow IP spoofing. +# sendastext: Whether to re-encode messages as UTF-8 before sending to +# WebSocket clients. This is recommended as the WebSocket +# protocol requires all text frames to be sent as UTF-8. +# If you do not have this enabled messages will be sent as +# binary frames instead. +#<websocket behindproxy="no" +# sendastext="yes"> # # If you use the websocket module you MUST specify one or more origins # which are allowed to connect to the server. You should set this as |