Go to file
rofl0r 8b373f804e update html documentation, add quickstart section 2022-05-30 19:10:27 +00:00
.github CI: add github workflow to build release tarball 2022-05-27 14:06:16 +00:00
data Prettify stats.html 2022-04-22 06:13:38 +00:00
docs update html documentation, add quickstart section 2022-05-30 19:10:27 +00:00
etc implement filtertype keyword and fnmatch-based filtering 2022-05-02 13:13:40 +00:00
m4macros configure: remove checks for standard types 2016-12-21 21:16:06 +00:00
scripts version.sh: relax regex for release tag detection 2020-09-27 15:44:50 +01:00
src add gperf generated files to make dist 2022-05-27 14:06:16 +00:00
tests Add test case for unavailable upstream 2022-02-13 21:46:03 +00:00
.gitignore add 'compile' to gitignore 2016-12-24 03:04:50 +01:00
.travis.yml travis: asciidoc is no longer needed 2020-08-20 14:32:16 +01:00
AUTHORS Update AUTHORS 2018-09-01 04:06:59 +02:00
COPYING [BB#53] Add a GPLv2 COPYING file 2009-08-04 04:21:46 +05:30
ChangeLog Add placeholder ChangeLog to keep automake happy 2016-12-20 19:22:17 +01:00
Makefile.am build: add new version mechanism based on VERSION file and a version.sh script 2018-09-05 00:56:31 +02:00
NEWS NEWS: just mention to use git log 2018-09-01 04:06:59 +02:00
README README: add README pointing to README.md to make automake happy 2016-12-20 19:22:17 +01:00
README.md README.md: freenode is dead, long live libera 2021-09-22 12:07:33 +00:00
TODO Remove suggester (see Banu RT #138) 2014-05-01 13:58:54 +05:30
VERSION release 1.11.1 2022-05-27 14:08:03 +00:00
autogen.sh Remove AM_MAINTAINER_MODE 2009-12-08 10:52:17 +05:30
configure.ac configure: use release tarball provided gperf file 2022-05-27 14:06:16 +00:00
tinyproxy-indent.sh Add Tinyproxy indent script 2009-09-15 01:00:50 +05:30

README.md

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 the Tinyproxy web site.

Installation

Tinyproxy uses a standard GNU configure script based on the automake system. If compiling from a git checkout, you need to first run

./autogen.sh

from the top level directory to generate the configure script. The release tarball contains the pre-created configure script, so when building from a release, you can skip this step. Then basically all you need to do is

./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: Allow Tinyproxy to be used as a transparent proxy daemon. Unlike other work modes, transparent proxying doesn't require explicit configuration and works automatically when traffic is redirected to the proxy using the appropriate firewall rules.

  • --enable-reverse: Enable reverse proxying.

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

For more information about the build system, read the INSTALL file that is generated by autogen.sh and comes with the release tar ball.

Support

If you are having problems with Tinyproxy, please raise an issue on github.

Contributing

If you would like to contribute a feature, or a bug fix to the Tinyproxy source, please clone the git repository from github and create a pull request.

Community

You can meet developers and users to discuss development, patches and deployment issues in the #tinyproxy IRC channel on libera (irc.libera.chat).