README

   1 Tinyproxy
   2 =========
   3
   4 Tinyproxy is a small, efficient HTTP/SSL proxy daemon released under the
   5 GNU General Public License.  Tinyproxy is very useful in a small network
   6 setting, where a larger proxy would either be too resource intensive, or
   7 a security risk.  One of the key features of Tinyproxy is the buffering
   8 connection concept.  In effect, Tinyproxy will buffer a high speed
   9 response from a server, and then relay it to a client at the highest
  10 speed the client will accept.  This feature greatly reduces the problems
  11 with sluggishness on the Internet.  If you are sharing an Internet
  12 connection with a small network, and you only want to allow HTTP
  13 requests to be allowed, then Tinyproxy is a great tool for the network
  14 administrator.
  15
  16 For more info, please visit:
  17
  18         https://www.banu.com/tinyproxy/
  19
  20
  21 Installation
  22 ------------
  23
  24 To install this package under a UNIX derivative, read the INSTALL file.
  25 Tinyproxy uses a standard GNU `configure` script. Basically you should
  26 be able to do:
  27
  28 ----
  29 ./configure
  30 make
  31 make install
  32 ----
  33
  34 in the top level directory to compile and install Tinyproxy. There are
  35 additional command line arguments you can supply to `configure`. They
  36 include:
  37
  38         --enable-debug          If you would like to turn on full
  39                                 debugging support
  40         --enable-xtinyproxy     Compile in support for the XTinyproxy
  41                                 header, which is sent to any web
  42                                 server in your domain.
  43         --enable-filter         Allows Tinyproxy to filter out certain
  44                                 domains and URLs.
  45         --enable-upstream       Enable support for proxying connections
  46                                 through another proxy server.
  47         --enable-transparent-proxy
  48                                 Allow Tinyproxy to be used as a
  49                                 transparent proxy daemon
  50         --enable-static         Compile a static version of Tinyproxy
  51
  52         --with-stathost=HOST    Set the default name of the stats host
  53
  54
  55 Support
  56 -------
  57
  58 If you are having problems with Tinyproxy, please submit a bug report
  59 using Tinyproxy as the product at:
  60
  61         https://www.banu.com/bugzilla/
  62
  63 You may also wish to subscribe to the Tinyproxy mailing lists. To do so
  64 please visit:
  65
  66         https://www.banu.com/mailman/listinfo/tinyproxy-announce-list
  67         https://www.banu.com/mailman/listinfo/tinyproxy-users-list
  68         https://www.banu.com/mailman/listinfo/tinyproxy-developers-list
  69
  70 for more information on how to subscribe and post messages to the lists.
  71
  72
  73 Contributing
  74 ------------
  75
  76 If you would like to contribute a feature, or a bug fix to the Tinyproxy
  77 source, please send a patch (preferably as a unified diff. i.e. `diff
  78 -u` against the "master" branch of the Tinyproxy source code git
  79 repository to tinyproxy-developers-list.  Please include a description
  80 of what your patch does.
  81
  82 Tinyproxy's git repository is git://www.banu.com/tinyproxy.git. The
  83 following command creates a local copy:
  84
  85 ----
  86 git clone git://www.banu.com/tinyproxy.git
  87 ----
  88
  89 The easiest and preferred way to create a patch for submission is to
  90 check in your changes locally and use `git format-patch` to generate a
  91 mbox-style commit file that contains the diff along with the commit
  92 message and author information.  Such a format-patch file can be
  93 integrated into the upstream repository, automatically keeping the
  94 commit message and author information.
  95
  96 You can also meet developers and discuss development issues and patches
  97 in the #tinyproxy IRC channel on Freenode (irc.freenode.net).