diff options
| author | 2021-09-21 10:14:49 +0100 | |
|---|---|---|
| committer | 2021-09-22 20:43:49 +0100 | |
| commit | 191fb584780b5651931d703fb17c9bbad273dfa2 (patch) | |
| tree | 87b6dcdf71730238c7e77b0f5522ad8a69a28239 /docs | |
| parent | Add an API for checking if I/O hooks are ready or not. (diff) | |
Replace <websocket:sendastext> with <websocket:defaultmode>.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf/modules.conf.example | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/conf/modules.conf.example b/docs/conf/modules.conf.example index 8668673e6..581212609 100644 --- a/docs/conf/modules.conf.example +++ b/docs/conf/modules.conf.example @@ -2462,19 +2462,19 @@ # Requires SHA-1 hash support available in the sha1 module. #<module name="websocket"> # +# defaultmode: The default frame mode if a client does not send a +# WebSocket subprotocol. Potential values are "text" to +# encode messages as UTF-8 text frames, "binary" to send +# messages as raw binary frames, or "reject" to close +# connections which do not request a subprotocol. Defaults +# to "text". # proxyranges: A space-delimited list of glob or CIDR matches to trust # the X-Real-IP or X-Forwarded-For headers from. 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. Clients can override this using a -# WebSocket subprotocol. See the docs page for more info. -#<websocket proxyranges="192.0.2.0/24 198.51.100.*" -# sendastext="yes"> +#<websocket defaultmode="text" +# proxyranges="192.0.2.0/24 198.51.100.*"> # # 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 |
