summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorLance Stout <lancestout@gmail.com>2011-12-31 12:34:17 -0500
committerLance Stout <lancestout@gmail.com>2011-12-31 12:34:17 -0500
commitfa912aeb84a95d1cf72639587488aa64cf556aa7 (patch)
tree68f088d0a0e5164064ac9589eee35ee9468d45f2 /docs
parent9a5e2ae7686a2dad72f2aea2592ab002111003da (diff)
parent4a12e1059a8cc38a3baf30a18dd6143e7d5beebb (diff)
downloadslixmpp-fa912aeb84a95d1cf72639587488aa64cf556aa7.tar.gz
slixmpp-fa912aeb84a95d1cf72639587488aa64cf556aa7.tar.bz2
slixmpp-fa912aeb84a95d1cf72639587488aa64cf556aa7.tar.xz
slixmpp-fa912aeb84a95d1cf72639587488aa64cf556aa7.zip
Merge branch 'develop' into develop-1.1
Diffstat (limited to 'docs')
-rw-r--r--docs/getting_started/proxy.rst40
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/getting_started/proxy.rst b/docs/getting_started/proxy.rst
index 02ad10ae..60d521c5 100644
--- a/docs/getting_started/proxy.rst
+++ b/docs/getting_started/proxy.rst
@@ -1,2 +1,42 @@
+.. _proxy:
+
+=========================
Enable HTTP Proxy Support
=========================
+
+.. note::
+
+ If you have any issues working through this quickstart guide
+ or the other tutorials here, please either send a message to the
+ `mailing list <http://groups.google.com/group/sleekxmpp-discussion>`_
+ or join the chat room at `sleek@conference.jabber.org
+ <xmpp:sleek@conference.jabber.org?join>`_.
+
+In some instances, you may wish to route XMPP traffic through
+an HTTP proxy, probably to get around restrictive firewalls.
+SleekXMPP provides support for basic HTTP proxying with DIGEST
+authentication.
+
+Enabling proxy support is done in two steps. The first is to instruct SleekXMPP
+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: