File	Date	Author	Commit
bin	2009-10-25	Andrew Warkentin	[c15e11] HTTPClientRequest (this should have been in the...
doc	2009-11-08	Andrew Warkentin	[7e325e] updated top-level README; updated NEWS; increme...
etc	2009-11-08	Andrew Warkentin	[32d90d] added a somewhat better (modular) AdList; remov...
lib	2009-11-08	Andrew Warkentin	[2f9f66] syntax fix for proxo_filter.__init__
share	2009-09-21	Andrew Warkentin	[18dba1] added text URL command (forces the Content-Type...
startup_scripts	2009-11-08	Andrew Warkentin	[ec0339] added descriptive comments to startup scripts; ...
.hgtags	2008-01-02	Andrew Warkentin	[0d8e32] Added tag 0.0.1 for changeset b3d1ffd5ccb5
COPYING.gpl	2007-08-31	Andrew Warkentin	[274035] initial commit
COPYING.twisted	2009-11-08	Andrew Warkentin	[7e325e] updated top-level README; updated NEWS; increme...
Makefile	2007-12-31	Andrew Warkentin	[edff32] changed setup.py to install scripts in /usr/loc...
NEWS	2009-11-08	Andrew Warkentin	[7e325e] updated top-level README; updated NEWS; increme...
README	2009-11-08	Andrew Warkentin	[7e325e] updated top-level README; updated NEWS; increme...
setup.py	2009-11-08	Andrew Warkentin	[6bc063] commented out gcc-specific -Wall option in setu...

Read Me

XUProxy - an eXtensible Universal Proxy
=======================================

=================
Table of Contents
=================

1. Description
2. Requirements
3. Installation
4. Getting Started
A. Links

==============
1. Description
==============

XUProxy[1] is a generic multi-protocol proxy written in Python[2] using the 
Twisted[3] framework. It has a modular architecture, and supports multiple 
dynamically-loadable protocol plugins, and dynamically-loadable "filter" plugins
which can modify or monitor the data being passed in both directions.

The core of XUProxy is under the GNU GPL. (COPYING.gpl in the top level of the 
distribution). Plugins may be under different licenses. See their documentation
for licensing information.

===============
2. Requirements
===============

Core:
----

Python 2.3 or later version of Python 2.x (2.4 or later recommended due to
compatibility issues with certain modules) (XUProxy is not compatible with
Python 3.x)
Twisted 2.5 or later (MAY work with earlier versions of Twisted 2.x)

Plugins: (see plugin documentation for more information)
--------

mod_protocol_http:
twisted.web2[3] 8.1 or later

mod_http_filter_proxofilter:
Python 2.4 or later version of Python 2.x
pyparsing 1.4.11 or later (earlier versions of pyparsing may also work, but they
are untested)

===============
3. Installation
===============

XUProxy is installed like most other Python packages, using the setup.py script.
Use the command

$ python setup.py install

($ represents the shell prompt)
in the top level of the source distribution to install XUProxy.

==================
4. Getting Started
==================

On Unix, the scripts are installed into /usr/local/bin by default. To start 
XUProxy on Unix, simply use the command:

$ xuproxy

to run XUProxy. By default (on Unix), it will run as a daemon. Use the -n option
to run XUProxy in the foreground. The configuration files can be found in 
/etc/xuproxy. Use the -c option to specify a configuration directory other than 
the default.

On other operating systems, the scripts are installed into the default directory
for Python scripts, and the configuration files are installed in 
<site package directory>/xuproxy/etc/xuproxy where <site package directory> 
represents the directory where locally-installed Python packages are placed. 
Consult the Python documentation for your operating system for more information
on where scripts and modules are installed.

A default main configuration file can be found in 
<configuration directory>/xuproxy.conf where <configuration directory> 
represents the configuration directory.

===============
A. Links
===============

[1] http://xuproxy.sf.net/
[2] http://www.python.org/
[3] http://twistedmatrix.com