diff options
| -rw-r--r-- | README | 134 |
1 files changed, 71 insertions, 63 deletions
@@ -1,110 +1,118 @@ +Tinyproxy +========= -tinyproxy version 1.7.x +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. - 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: - For more info, please visit: https://www.banu.com/tinyproxy/ + https://www.banu.com/tinyproxy/ -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: +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 +---- +./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: +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 + --enable-filter Allows Tinyproxy to filter out certain domains and URLs. --enable-upstream Enable support for proxying connections through another proxy server. --enable-transparent-proxy - Allow tinyproxy to be used as a + 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 - - Options for file locations etc. --with-stathost=HOST Set the default name of the stats host -SUPPORT +Support +------- - If you are having problems with Tinyproxy, please submit a bug report - using Tinyproxy as the component at: +If you are having problems with Tinyproxy, please submit a bug report +using Tinyproxy as the component at: https://www.banu.com/bugzilla/ - You may also wish to subscribe to the tinyproxy mailing lists. To - do so please visit: +You may also wish to subscribe to the Tinyproxy mailing lists. To do so +please visit: https://www.banu.com/mailman/listinfo/tinyproxy-announce-list https://www.banu.com/mailman/listinfo/tinyproxy-users-list https://www.banu.com/mailman/listinfo/tinyproxy-developers-list - for more information on how to subscribe and post messages to the - lists. +for more information on how to subscribe and post messages to the lists. - Please recompile tinyproxy with full debug support (--enable-debug) - and include a copy of the log file, and any assert errors reported by - tinyproxy. Note that tinyproxy will output memory statistics to - standard error if compiled with debugging support so you might want - to redirect the output to a file for later examination. Also, if you - feel up to it, try running tinyproxy under your debugger and report - the error your received and a context listing of the location. Under - gdb you would run tinyproxy like so: +Please recompile Tinyproxy with full debug support (--enable-debug) and +include a copy of the log file, and any assert errors reported by +Tinyproxy. Note that Tinyproxy will output memory statistics to +standard error if compiled with debugging support so you might want to +redirect the output to a file for later examination. Also, if you feel +up to it, try running Tinyproxy under your debugger and report the error +your received and a context listing of the location. Under gdb you +would run Tinyproxy like so: gdb tinyproxy (gdb) run -c location_of_tinyproxy_conf -d 2>/dev/null - Now access the port tinyproxy is on until you receive a break in the - gdb. You can now type: +Now access the port Tinyproxy is on until you receive a break in the +gdb. You can now type: (gbd) l - to produce a context listing of the location of the error. Send a - copy to the authors. +to produce a context listing of the location of the error. Send a +copy to the authors. + +Contributing +------------ -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. - 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 the tinyproxy-developers mailing list. - Please include a description of what your patch does. +Tinyproxy's git repository is git://www.banu.com/tinyproxy.git. The +following command creates a local copy: - Tinyproxy's git repository is git://www.banu.com/tinyproxy.git . - The command "git clone git://www.banu.com/tinyproxy.git" creates - a local copy. +---- +git clone git://www.banu.com/tinyproxy.git +---- - The easiest and preferred way to create a patch for submission - is to check in your changes locally and use the command - "git format-patch" to generate a mbox-style commit file that - contains the diff along with the commit message and author information. - Such a format-patch file can be integrated into the upstream repository, - automatically keeping the commit message and author information. +The easiest and preferred way to create a patch for submission is to +check in your changes locally and use `git format-patch` to generate a +mbox-style commit file that contains the diff along with the commit +message and author information. Such a format-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). +You can also meet developers and discuss development issues and patches +in the #tinyproxy IRC channel on Freenode (irc.freenode.net). |