bughz/tinyproxy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

REAMDE: convert README to github markdown

Browse Source 
Signed-off-by: Michael Adam <obnox@samba.org>
This commit is contained in:
Michael Adam 2016-12-20 18:37:38 +01:00
parent af6e236521
commit 82ce991b3d
1 changed files with 36 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

75
README
View File

@ -1,5 +1,4 @@
Tinyproxy # Tinyproxy
=========
Tinyproxy is a small, efficient HTTP/SSL proxy daemon released under the Tinyproxy is a small, efficient HTTP/SSL proxy daemon released under the
GNU General Public License. Tinyproxy is very useful in a small network GNU General Public License. Tinyproxy is very useful in a small network
@ -13,69 +12,67 @@ 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 requests to be allowed, then Tinyproxy is a great tool for the network
administrator. administrator.
For more info, please visit: For more info, please visit [the Tinyproxy web site](https://tinyproxy.github.io/).
<https://tinyproxy.github.io/>
Installation ## Installation
------------
To install this package under a UNIX derivative, read the INSTALL file. To install this package under a UNIX derivative, read the INSTALL file.
Tinyproxy uses a standard GNU `configure` script. Basically you should Tinyproxy uses a standard GNU `configure` script. Basically you should
be able to do: be able to do:
----
```
./configure ./configure
make make
make install make install
---- ```
in the top level directory to compile and install Tinyproxy. There are in the top level directory to compile and install Tinyproxy. There are
additional command line arguments you can supply to `configure`. They additional command line arguments you can supply to `configure`. They
include: include:
--enable-debug:: - `--enable-debug`:
If you would like to turn on full debugging support. If you would like to turn on full debugging support.
--enable-xtinyproxy:: - `--enable-xtinyproxy`:
Compile in support for the XTinyproxy header, which is sent to any Compile in support for the XTinyproxy header, which is sent to any
web server in your domain. web server in your domain.
--enable-filter:: - `--enable-filter`:
Allows Tinyproxy to filter out certain domains and URLs. Allows Tinyproxy to filter out certain domains and URLs.
--enable-upstream:: - `--enable-upstream`:
Enable support for proxying connections through another proxy server. Enable support for proxying connections through another proxy server.
--enable-transparent:: - `--enable-transparent`:
Allow Tinyproxy to be used as a transparent proxy daemon. Allow Tinyproxy to be used as a transparent proxy daemon.
--enable-static:: - `--enable-static`:
Compile a static version of Tinyproxy. Compile a static version of Tinyproxy.
--with-stathost=HOST:: - `--with-stathost=HOST`:
Set the default name of the stats host. Set the default name of the stats host.
Support ## Support
-------
If you are having problems with Tinyproxy, please raise an issue
on github:
<https://github.com/tinyproxy/tinyproxy/issues>
Contributing If you are having problems with Tinyproxy, please raise an
------------ [issue on github](https://github.com/tinyproxy/tinyproxy/issues).
## Contributing
If you would like to contribute a feature, or a bug fix to the Tinyproxy If you would like to contribute a feature, or a bug fix to the Tinyproxy
source, please clone the git repository from github source, please clone the
(https://github.com/tinyproxy/tinyproxy.git) and create a pull request: [git repository from github](https://github.com/tinyproxy/tinyproxy.git)
and create a [pull request](https://github.com/tinyproxy/tinyproxy/pulls).
<https://github.com/tinyproxy/tinyproxy/pulls>
You can also meet developers and discuss development issues and patches ## Community
in the `#tinyproxy` IRC channel on Freenode (`irc.freenode.net`).
You can meet developers and users to discuss development,
patches and deployment issues in the `#tinyproxy` IRC channel on
Freenode (`irc.freenode.net`).