diff options
Diffstat (limited to 'docs/getting_started')
| -rw-r--r-- | docs/getting_started/index.rst | 2 | ||||
| -rw-r--r-- | docs/getting_started/proxy.rst | 40 |
2 files changed, 0 insertions, 42 deletions
diff --git a/docs/getting_started/index.rst b/docs/getting_started/index.rst index 97c34a22..cbad1be8 100644 --- a/docs/getting_started/index.rst +++ b/docs/getting_started/index.rst @@ -9,7 +9,5 @@ Getting Started (with examples) component presence muc - proxy scheduler iq - diff --git a/docs/getting_started/proxy.rst b/docs/getting_started/proxy.rst deleted file mode 100644 index 22439d4e..00000000 --- a/docs/getting_started/proxy.rst +++ /dev/null @@ -1,40 +0,0 @@ -.. _proxy: - -========================= -Enable HTTP Proxy Support -========================= - -.. note:: - - If you have any issues working through this quickstart guide - join the chat room at `slixmpp@muc.poez.io - <xmpp:slixmpp@muc.poez.io?join>`_. - -In some instances, you may wish to route XMPP traffic through -an HTTP proxy, probably to get around restrictive firewalls. -Slixmpp provides support for basic HTTP proxying with DIGEST -authentication. - -Enabling proxy support is done in two steps. The first is to instruct Slixmpp -to use a proxy, and the second is to configure the proxy details: - -.. code-block:: python - - xmpp = ClientXMPP(...) - xmpp.use_proxy = True - xmpp.proxy_config = { - 'host': 'proxy.example.com', - 'port': 5555, - 'username': 'example_user', - 'password': '******' - } - -The ``'username'`` and ``'password'`` fields are optional if the proxy does not -require authentication. - - -The Final Product ------------------ - -.. include:: ../../examples/proxy_echo_client.py - :literal: |