diff --git a/ChangeLog b/ChangeLog new file mode 100644 index 0000000..c4ee927 --- /dev/null +++ b/ChangeLog @@ -0,0 +1 @@ +The ChangeLog is maintained in the git history. diff --git a/README b/README index 700c552..eb8c158 100644 --- a/README +++ b/README @@ -1,103 +1 @@ -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: - - - - -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:: - Allow Tinyproxy to be used as a transparent proxy daemon. - ---enable-static:: - Compile a static version of Tinyproxy. - ---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 product at: - - - -You may also wish to subscribe to the Tinyproxy mailing lists. To do so -please visit: - - - - - -for more information on how to subscribe and post messages to the lists. - - -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 'tinyproxy-developers-list'. Please include a description -of what your patch does. - -Tinyproxy's source code is maintained in a Git repository. The following -command creates a local copy of it: - ----- -git clone git://banu.com/tinyproxy.git ----- - -The easiest and preferred way to create a patch for submission is to -check in your changes locally against the 'master' branch and use `git -format-patch` to generate a mbox-style patch file that contains the diff -along with the commit message and author information. Such a formatted -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`). +see README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..dfc763f --- /dev/null +++ b/README.md @@ -0,0 +1,89 @@ +# 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](https://tinyproxy.github.io/). + + +## 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 fom 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. + +- `--enable-static`: +Compile a static version of Tinyproxy. + +- `--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](https://github.com/tinyproxy/tinyproxy/issues). + + +## 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](https://github.com/tinyproxy/tinyproxy/pulls). + + +## Community + +You can meet developers and users to discuss development, +patches and deployment issues in the `#tinyproxy` IRC channel on +Freenode (`irc.freenode.net`).