summaryrefslogtreecommitdiff
path: root/docs/conf/modules.conf.example
diff options
context:
space:
mode:
authorPeter Powell <petpow@saberuk.com>2018-10-31 05:11:41 +0000
committerPeter Powell <petpow@saberuk.com>2018-11-03 14:12:59 +0000
commitefdb51bc9d46283e55d95cd47398cf463b401d96 (patch)
treec7030efcadbe1293af4c0cc4a7964494309bcc9c /docs/conf/modules.conf.example
parent99af213a58946185621b3e4de01970a7c21cce93 (diff)
WebSocket: send messages as text by default.
This requires all messages to be UTF-8. If you are using a UTF-8 incompatible text encoding then you can disable this by setting <websocket:sendastext> to false.
Diffstat (limited to 'docs/conf/modules.conf.example')
-rw-r--r--docs/conf/modules.conf.example6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/conf/modules.conf.example b/docs/conf/modules.conf.example
index aab89afbf..4dab9f55b 100644
--- a/docs/conf/modules.conf.example
+++ b/docs/conf/modules.conf.example
@@ -2163,6 +2163,12 @@
# 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">
+#
# 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
# strict as possible to prevent malicious webpages from connecting to