2016-12-21 01:37:38 +08:00
|
|
|
# Tinyproxy
|
2000-02-17 01:32:49 +08:00
|
|
|
|
2009-09-27 21:38:46 +08:00
|
|
|
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.
|
2000-02-17 01:32:49 +08:00
|
|
|
|
2016-12-21 01:37:38 +08:00
|
|
|
For more info, please visit [the Tinyproxy web site](https://tinyproxy.github.io/).
|
2000-02-17 01:32:49 +08:00
|
|
|
|
|
|
|
|
2016-12-21 01:37:38 +08:00
|
|
|
## Installation
|
2008-05-24 19:18:45 +08:00
|
|
|
|
2000-02-17 01:32:49 +08:00
|
|
|
|
2009-09-27 21:38:46 +08:00
|
|
|
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:
|
2001-10-26 00:28:24 +08:00
|
|
|
|
2016-12-21 01:37:38 +08:00
|
|
|
|
|
|
|
```
|
2009-09-27 21:38:46 +08:00
|
|
|
./configure
|
|
|
|
make
|
|
|
|
make install
|
2016-12-21 01:37:38 +08:00
|
|
|
```
|
2001-10-26 00:28:24 +08:00
|
|
|
|
2009-09-27 21:38:46 +08:00
|
|
|
in the top level directory to compile and install Tinyproxy. There are
|
|
|
|
additional command line arguments you can supply to `configure`. They
|
|
|
|
include:
|
2000-02-17 01:32:49 +08:00
|
|
|
|
2016-12-21 01:37:38 +08:00
|
|
|
- `--enable-debug`:
|
|
|
|
If you would like to turn on full debugging support.
|
2001-10-26 00:28:24 +08:00
|
|
|
|
2016-12-21 01:37:38 +08:00
|
|
|
- `--enable-xtinyproxy`:
|
|
|
|
Compile in support for the XTinyproxy header, which is sent to any
|
|
|
|
web server in your domain.
|
2010-01-19 21:42:24 +08:00
|
|
|
|
2016-12-21 01:37:38 +08:00
|
|
|
- `--enable-filter`:
|
|
|
|
Allows Tinyproxy to filter out certain domains and URLs.
|
2010-01-19 21:42:24 +08:00
|
|
|
|
2016-12-21 01:37:38 +08:00
|
|
|
- `--enable-upstream`:
|
|
|
|
Enable support for proxying connections through another proxy server.
|
2010-01-19 21:42:24 +08:00
|
|
|
|
2016-12-21 01:37:38 +08:00
|
|
|
- `--enable-transparent`:
|
|
|
|
Allow Tinyproxy to be used as a transparent proxy daemon.
|
2010-01-19 21:42:24 +08:00
|
|
|
|
2016-12-21 01:37:38 +08:00
|
|
|
- `--enable-static`:
|
|
|
|
Compile a static version of Tinyproxy.
|
2010-01-19 21:42:24 +08:00
|
|
|
|
2016-12-21 01:37:38 +08:00
|
|
|
- `--with-stathost=HOST`:
|
|
|
|
Set the default name of the stats host.
|
2000-02-17 01:32:49 +08:00
|
|
|
|
2000-09-12 08:16:57 +08:00
|
|
|
|
2016-12-21 01:37:38 +08:00
|
|
|
## Support
|
2000-02-17 01:32:49 +08:00
|
|
|
|
|
|
|
|
2016-12-21 01:37:38 +08:00
|
|
|
If you are having problems with Tinyproxy, please raise an
|
|
|
|
[issue on github](https://github.com/tinyproxy/tinyproxy/issues).
|
2001-10-26 00:28:24 +08:00
|
|
|
|
2000-02-17 01:32:49 +08:00
|
|
|
|
2016-12-21 01:37:38 +08:00
|
|
|
## Contributing
|
2001-06-25 02:19:12 +08:00
|
|
|
|
2009-09-27 21:38:46 +08:00
|
|
|
If you would like to contribute a feature, or a bug fix to the Tinyproxy
|
2016-12-21 01:37:38 +08:00
|
|
|
source, please clone the
|
|
|
|
[git repository from github](https://github.com/tinyproxy/tinyproxy.git)
|
|
|
|
and create a [pull request](https://github.com/tinyproxy/tinyproxy/pulls).
|
2000-02-17 01:32:49 +08:00
|
|
|
|
2009-09-09 16:52:17 +08:00
|
|
|
|
2016-12-21 01:37:38 +08:00
|
|
|
## Community
|
2009-09-09 16:52:17 +08:00
|
|
|
|
2016-12-21 01:37:38 +08:00
|
|
|
You can meet developers and users to discuss development,
|
|
|
|
patches and deployment issues in the `#tinyproxy` IRC channel on
|
|
|
|
Freenode (`irc.freenode.net`).
|