Chapril/xmpp.chapril.org-conversejs
Chapril/xmpp.chapril.org-conversejs
25
0
Fork 0
Code Issues Pull Requests Projects Releases Activity

Added examples for bosh & websocket connection

Browse Source 
also recommendation to enable smacks
This commit is contained in:
poVoq 2019-11-22 00:11:26 +01:00 committed by JC Brand
parent e85afc9c7c
commit 627f306d1b
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/source/configuration.rst
View File

@ -473,6 +473,10 @@ bosh_service_url
* Default: ``undefined`` * 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 <https://en.wikipedia.org/wiki/BOSH>`_ To connect to an XMPP server over HTTP you need a `BOSH <https://en.wikipedia.org/wiki/BOSH>`_
connection manager which acts as a middle man between the HTTP and XMPP connection manager which acts as a middle man between the HTTP and XMPP
protocols. protocols.
@ -752,6 +756,8 @@ enable_smacks
Determines whether `XEP-0198 Stream Management <https://xmpp.org/extensions/xep-0198.html>`_ Determines whether `XEP-0198 Stream Management <https://xmpp.org/extensions/xep-0198.html>`_
support is turned on or not. 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 filter_by_resource
------------------ ------------------
@ -1703,6 +1709,10 @@ websocket_url
* Default: ``undefined`` * 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 This option is used to specify a
`websocket <https://developer.mozilla.org/en/docs/WebSockets>`_ URI to which `websocket <https://developer.mozilla.org/en/docs/WebSockets>`_ URI to which
Converse can connect to. Converse can connect to.