summaryrefslogtreecommitdiff
path: root/docs/getting_started/proxy.rst
diff options
context:
space:
mode:
authorLance Stout <lancestout@gmail.com>2011-12-31 12:33:32 -0500
committerLance Stout <lancestout@gmail.com>2011-12-31 12:33:32 -0500
commit4a12e1059a8cc38a3baf30a18dd6143e7d5beebb (patch)
tree8023a460c3be0e5c74c2746eca7b5b7f15438adc /docs/getting_started/proxy.rst
parentf9cd051209e765c338d3c0e7ed4b3638e89b4a01 (diff)
downloadslixmpp-4a12e1059a8cc38a3baf30a18dd6143e7d5beebb.tar.gz
slixmpp-4a12e1059a8cc38a3baf30a18dd6143e7d5beebb.tar.bz2
slixmpp-4a12e1059a8cc38a3baf30a18dd6143e7d5beebb.tar.xz
slixmpp-4a12e1059a8cc38a3baf30a18dd6143e7d5beebb.zip
Add proxy docs.
Diffstat (limited to 'docs/getting_started/proxy.rst')
-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: