tinyproxy - a light-weight HTTP/HTTPS proxy daemon for POSIX operating systems
Go to file
Michael Adam 1fda61b5a0 generate etc/tinyproxy.conf from a tinyproxy.conf.in template
This is a first cut at providing a tinyproxy.conf file with
more useful default or example directories. It uses datadir,
sysconfdir and localstatedir.

Because automake is a little special here, this template can
not simply be processed by configure (AC_CONFIG_FILES(...)),
as these variables can only be used like this in makefiles.
Instead, we need a little sed-processor in the Makfile in etc/.

Michael
2009-10-10 00:58:55 +02:00
data data: Cleanup installation of templates 2009-09-13 04:08:06 +05:30
docs docs: Fix typos in tinyproxy.conf manpage 2009-09-28 18:51:42 +05:30
etc generate etc/tinyproxy.conf from a tinyproxy.conf.in template 2009-10-10 00:58:55 +02:00
m4macros build: Update CFLAGS and also check if they are supported 2009-09-20 13:32:46 +05:30
packaging packaging: Update summary and description in spec file 2009-09-13 17:26:38 +05:30
src Use ssize_t for len argument 2009-10-09 13:50:12 +05:30
tests tests: set XTinyproxy Yes in the test setup 2009-09-27 12:52:39 +02:00
.gitignore .gitignore: ignore vi backup files 2009-08-05 00:28:01 +02:00
AUTHORS Rewrote the "early history" of the project, and added a section for 2004-02-17 19:49:54 +00:00
autogen.sh Remove obsolete comment 2009-09-27 08:09:24 +05:30
ChangeLog Merged in changes from 1.6.3 2004-08-10 21:24:24 +00:00
configure.ac build: Reverse maintainer mode test 2009-09-27 08:09:24 +05:30
COPYING [BB#53] Add a GPLv2 COPYING file 2009-08-04 04:21:46 +05:30
Makefile.am make: add targets "test" and "valgrind-test" 2009-09-27 11:18:52 +02:00
NEWS Add more bugs to NEWS 2009-09-28 19:08:54 +05:30
README Remove section on debugging from README 2009-09-27 19:09:51 +05:30
tinyproxy-indent.sh Add Tinyproxy indent script 2009-09-15 01:00:50 +05:30
TODO Add items to TODO 2009-10-02 15:55:42 +05:30

Tinyproxy
=========

Tinyproxy is a small, efficient HTTP/SSL proxy daemon released under the
GNU General Public License.  Tinyproxy is very useful in a small network
setting, where a larger proxy would either be too resource intensive, or
a security risk.  One of the key features of Tinyproxy is the buffering
connection concept.  In effect, Tinyproxy will buffer a high speed
response from a server, and then relay it to a client at the highest
speed the client will accept.  This feature greatly reduces the problems
with sluggishness on the Internet.  If you are sharing an Internet
connection with a small network, and you only want to allow HTTP
requests to be allowed, then Tinyproxy is a great tool for the network
administrator.

For more info, please visit:

	https://www.banu.com/tinyproxy/


Installation
------------

To install this package under a UNIX derivative, read the INSTALL file.
Tinyproxy uses a standard GNU `configure` script. Basically you should
be able to do:

----
./configure
make
make install
----

in the top level directory to compile and install Tinyproxy. There are
additional command line arguments you can supply to `configure`. They
include:

	--enable-debug		If you would like to turn on full
				debugging support
	--enable-xtinyproxy	Compile in support for the XTinyproxy
				header, which is sent to any web
				server in your domain.
	--enable-filter		Allows Tinyproxy to filter out certain
				domains and URLs.
	--enable-upstream	Enable support for proxying connections
				through another proxy server.
	--enable-transparent-proxy
				Allow Tinyproxy to be used as a
				transparent proxy daemon
	--enable-static		Compile a static version of Tinyproxy

        --with-stathost=HOST	Set the default name of the stats host


Support
-------

If you are having problems with Tinyproxy, please submit a bug report
using Tinyproxy as the component at:

	https://www.banu.com/bugzilla/

You may also wish to subscribe to the Tinyproxy mailing lists. To do so
please visit:

	https://www.banu.com/mailman/listinfo/tinyproxy-announce-list
	https://www.banu.com/mailman/listinfo/tinyproxy-users-list
	https://www.banu.com/mailman/listinfo/tinyproxy-developers-list

for more information on how to subscribe and post messages to the lists.


Contributing
------------

If you would like to contribute a feature, or a bug fix to the Tinyproxy
source, please send a patch (preferably as a unified diff. i.e. `diff
-u` against the "master" branch of the Tinyproxy source code git
repository to tinyproxy-developers-list.  Please include a description
of what your patch does.

Tinyproxy's git repository is git://www.banu.com/tinyproxy.git. The
following command creates a local copy:

----
git clone git://www.banu.com/tinyproxy.git
----

The easiest and preferred way to create a patch for submission is to
check in your changes locally and use `git format-patch` to generate a
mbox-style commit file that contains the diff along with the commit
message and author information.  Such a format-patch file can be
integrated into the upstream repository, automatically keeping the
commit message and author information.

You can also meet developers and discuss development issues and patches
in the #tinyproxy IRC channel on Freenode (irc.freenode.net).