From af6e236521fb4a780d1108eb30a9d53e206ae228 Mon Sep 17 00:00:00 2001 From: Michael Adam Date: Tue, 20 Dec 2016 18:34:03 +0100 Subject: [PATCH 1/6] README: cleanup readme from legacy content Signed-off-by: Michael Adam --- README | 34 ++++++---------------------------- 1 file changed, 6 insertions(+), 28 deletions(-) diff --git a/README b/README index 700c552..c2a7a62 100644 --- a/README +++ b/README @@ -61,43 +61,21 @@ include: Support ------- -If you are having problems with Tinyproxy, please submit a bug report -using Tinyproxy as the product at: +If you are having problems with Tinyproxy, please raise an issue +on github: - - -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. +source, please clone the git repository from github +(https://github.com/tinyproxy/tinyproxy.git) and create a pull request: -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`). From 82ce991b3de42a0e2ad37ccde7ba18b4914f7d5f Mon Sep 17 00:00:00 2001 From: Michael Adam Date: Tue, 20 Dec 2016 18:37:38 +0100 Subject: [PATCH 2/6] REAMDE: convert README to github markdown Signed-off-by: Michael Adam --- README | 75 ++++++++++++++++++++++++++++------------------------------ 1 file changed, 36 insertions(+), 39 deletions(-) diff --git a/README b/README index c2a7a62..3bef8b7 100644 --- a/README +++ b/README @@ -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/). -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 -------- - -If you are having problems with Tinyproxy, please raise an issue -on github: - - +## Support -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 -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). -You can also meet developers and discuss development issues and patches -in the `#tinyproxy` IRC channel on Freenode (`irc.freenode.net`). +## Community + +You can meet developers and users to discuss development, +patches and deployment issues in the `#tinyproxy` IRC channel on +Freenode (`irc.freenode.net`). From 0d3ca13398e267b7b006059e93414b35b38c5bca Mon Sep 17 00:00:00 2001 From: Michael Adam Date: Tue, 20 Dec 2016 18:38:33 +0100 Subject: [PATCH 3/6] README: Rename README --> README.md Signed-off-by: Michael Adam --- README => README.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename README => README.md (100%) diff --git a/README b/README.md similarity index 100% rename from README rename to README.md From 271c4ecdcb89af1872b678eee90e55ea59473bbd Mon Sep 17 00:00:00 2001 From: Michael Adam Date: Tue, 20 Dec 2016 19:13:23 +0100 Subject: [PATCH 4/6] README: add README pointing to README.md to make automake happy Signed-off-by: Michael Adam --- README | 1 + 1 file changed, 1 insertion(+) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..eb8c158 --- /dev/null +++ b/README @@ -0,0 +1 @@ +see README.md From 7f3fe02d47fcf17073ec382134b797ded6c2d71e Mon Sep 17 00:00:00 2001 From: Michael Adam Date: Tue, 20 Dec 2016 18:58:30 +0100 Subject: [PATCH 5/6] README: update install instructions Closes #30 Signed-off-by: Michael Adam --- README.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3bef8b7..dfc763f 100644 --- a/README.md +++ b/README.md @@ -17,10 +17,17 @@ 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 -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: +``` +./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 ``` @@ -55,6 +62,10 @@ 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 From 85c73d68bddc98c723ebf6613f59b6ded5de8c0b Mon Sep 17 00:00:00 2001 From: Michael Adam Date: Tue, 20 Dec 2016 19:17:47 +0100 Subject: [PATCH 6/6] Add placeholder ChangeLog to keep automake happy Closes #60 Signed-off-by: Michael Adam --- ChangeLog | 1 + 1 file changed, 1 insertion(+) create mode 100644 ChangeLog 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.