yuanbiao
/
emqx
1
0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #12935 from zmstone/0426-improve-websocket-listener-config-mqtt_path-doc 

docs: improve mqtt_path doc
This commit is contained in:
Zaiming (Stone) Shi 2024-04-29 13:48:10 +02:00 committed by GitHub
parent a41652ec31 b96c6c243a
commit 70d2c6c6cd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
rel/i18n/emqx_schema.hocon
View File

@ -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
scripts/spellcheck/dicts/emqx.txt
View File

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