Selaa lähdekoodia

Added examples for bosh & websocket connection

also recommendation to enable smacks
poVoq 5 vuotta sitten
vanhempi
commit
627f306d1b
1 muutettua tiedostoa jossa 10 lisäystä ja 0 poistoa
  1. 10 0
      docs/source/configuration.rst

+ 10 - 0
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 <https://en.wikipedia.org/wiki/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 <https://xmpp.org/extensions/xep-0198.html>`_
 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 <https://developer.mozilla.org/en/docs/WebSockets>`_ URI to which
 Converse can connect to.