diff options
| author | Michael Adam <obnox@samba.org> | 2016-12-20 18:37:38 +0100 |
|---|---|---|
| committer | Michael Adam <obnox@samba.org> | 2016-12-20 19:04:47 +0100 |
| commit | 82ce991b3de42a0e2ad37ccde7ba18b4914f7d5f (patch) | |
| tree | 609a4a6babe6e8f08daf9d862313a8640c79a3be | |
| parent | af6e236521fb4a780d1108eb30a9d53e206ae228 (diff) | |
REAMDE: convert README to github markdown
Signed-off-by: Michael Adam <obnox@samba.org>
| -rw-r--r-- | README | 67 |
1 files changed, 32 insertions, 35 deletions
@@ -1,5 +1,4 @@ -Tinyproxy -========= +# 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 @@ -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 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. 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-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-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-filter`: +Allows Tinyproxy to filter out certain domains and URLs. ---enable-upstream:: - Enable support for proxying connections through another proxy server. +- `--enable-upstream`: +Enable support for proxying connections through another proxy server. ---enable-transparent:: - Allow Tinyproxy to be used as a transparent proxy daemon. +- `--enable-transparent`: +Allow Tinyproxy to be used as a transparent proxy daemon. ---enable-static:: - Compile a static version of Tinyproxy. +- `--enable-static`: +Compile a static version of Tinyproxy. ---with-stathost=HOST:: - Set the default name of the stats host. +- `--with-stathost=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> +If you are having problems with Tinyproxy, please raise an +[issue on github](https://github.com/tinyproxy/tinyproxy/issues). -Contributing ------------- +## Contributing If you would like to contribute a feature, or a bug fix to the Tinyproxy -source, please clone the git repository from github -(https://github.com/tinyproxy/tinyproxy.git) and create a pull request: +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). -<https://github.com/tinyproxy/tinyproxy/pulls> +## Community -You can also meet developers and discuss development issues and patches -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`). |