瀏覽代碼

docs: improve mqtt_path doc

zmstone 1 年之前
父節點
當前提交
b96c6c243a
共有 2 個文件被更改,包括 10 次插入3 次删除
  1. 9 3
      rel/i18n/emqx_schema.hocon
  2. 1 0
      scripts/spellcheck/dicts/emqx.txt

+ 9 - 3
rel/i18n/emqx_schema.hocon

@@ -268,9 +268,15 @@ common_ssl_opts_schema_cacerts.desc:
 common_ssl_opts_schema_cacerts.label:
 """Use System CA Certificates"""
 
-fields_ws_opts_mqtt_path.desc:
-"""WebSocket's MQTT protocol path. So the address of EMQX Broker's WebSocket is:
-<code>ws://{ip}:{port}/mqtt</code>"""
+fields_ws_opts_mqtt_path.desc: """~
+    WebSocket's MQTT protocol path. By default, the full URL for the WebSocket client to connect is:
+    `ws://{ip}:{port}/mqtt`.
+    Append `/[...]` to the end of the path to make EMQX accept any subpath.
+    For example, specifying `mqtt/[...]` would allow clients to connect at paths like
+    `mqtt/org1` or `mqtt/group2`, etc.
+
+    NOTE: An unmatched path will cause the client to be rejected immediately at the HTTP layer,
+    meaning it will not be traceable at the MQTT layer."""
 
 fields_ws_opts_mqtt_path.label:
 """WS MQTT Path"""

+ 1 - 0
scripts/spellcheck/dicts/emqx.txt

@@ -234,6 +234,7 @@ src
 ssl
 statsd
 structs
+subpath
 subprotocol
 subprotocols
 superset