Go to file
Mukund Sivaraman 54f4e8a91f Use correct format string for POSIX pid_t in pidfile_create()
This patch also adds a gtk-doc comment for pidfile_create().
2009-09-27 08:09:24 +05:30
data data: Cleanup installation of templates 2009-09-13 04:08:06 +05:30
docs docs:tinyproxy.conf: document "PidFile". 2009-09-22 00:22:19 +02:00
etc tinyproxy.conf: add a comment referring to the tinyproxy.conf(5) manpage 2009-09-20 11:01:30 +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 correct format string for POSIX pid_t in pidfile_create() 2009-09-27 08:09:24 +05:30
tests tests: use the debug.html file as DefaultErrorFile in the tests. 2009-09-21 09:42:47 +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
COPYING [BB#53] Add a GPLv2 COPYING file 2009-08-04 04:21:46 +05:30
ChangeLog Merged in changes from 1.6.3 2004-08-10 21:24:24 +00:00
Makefile.am tests: add Makefile.am to tests/ and tests/scripts dir (for packaging) 2009-09-16 22:35:35 +02:00
NEWS Added empty NEWS file that's required by autotools now 2008-03-13 15:07:47 -07:00
README Remove ability to change the name of the default configuration file 2009-09-20 12:33:47 +05:30
TODO # Removed the HTML error suggestion since it's been implemented with 2003-06-19 16:45:58 +00:00
autogen.sh Remove obsolete comment 2009-09-27 08:09:24 +05:30
configure.ac build: Add -Werror to CFLAGS during maintainer mode builds 2009-09-27 08:09:23 +05:30
tinyproxy-indent.sh Add Tinyproxy indent script 2009-09-15 01:00:50 +05:30

README

tinyproxy version 1.7.x

 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


     Options for file locations etc.
        --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.

 Please recompile tinyproxy with full debug support (--enable-debug)
 and include a copy of the log file, and any assert errors reported by
 tinyproxy.  Note that tinyproxy will output memory statistics to
 standard error if compiled with debugging support so you might want
 to redirect the output to a file for later examination.  Also, if you
 feel up to it, try running tinyproxy under your debugger and report
 the error your received and a context listing of the location.  Under
 gdb you would run tinyproxy like so:

	 gdb tinyproxy

	 (gdb) run -c location_of_tinyproxy_conf -d 2>/dev/null

 Now access the port tinyproxy is on until you receive a break in the
 gdb. You can now type:

	 (gbd) l

 to produce a context listing of the location of the error.  Send a
 copy to the authors.


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 the tinyproxy-developers mailing list.
 Please include a description of what your patch does.

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

 The easiest and preferred way to create a patch for submission
 is to check in your changes locally and use the command
 "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).