diff --git a/docs/source/configuration.rst b/docs/source/configuration.rst index f6b0d3aa7..924fae2cc 100644 --- a/docs/source/configuration.rst +++ b/docs/source/configuration.rst @@ -473,6 +473,10 @@ bosh_service_url * Default: ``undefined`` +Example: ``http://xmpp.example.com:5280/bosh/`` + +Example with reverse-proxy and TLS: ``https://xmpp.example.com/bosh/`` + To connect to an XMPP server over HTTP you need a `BOSH `_ connection manager which acts as a middle man between the HTTP and XMPP protocols. @@ -752,6 +756,8 @@ enable_smacks Determines whether `XEP-0198 Stream Management `_ support is turned on or not. +Recommended to set to ``true`` if a websocket connection is used. +Please see the :ref:`websocket-url` configuration setting. filter_by_resource ------------------ @@ -1703,6 +1709,10 @@ websocket_url * Default: ``undefined`` +Example: ``ws://xmpp.example.com:5280/ws/`` + +Example with reverse-proxy and TLS: ``wss://xmpp.example.com/ws/`` + This option is used to specify a `websocket `_ URI to which Converse can connect to.