Update README to asciidoc format
This commit is contained in:
Mukund Sivaraman
parent
630d44e67b
commit
bf38e2e68b
134
README
134
README
@ -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
|
For more info, please visit:
|
||||||
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: https://www.banu.com/tinyproxy/
|
https://www.banu.com/tinyproxy/
|
||||||
|
|
||||||
|
|
||||||
INSTALLATION
|
Installation
|
||||||
|
------------
|
||||||
|
|
||||||
To install this package under a Unix derivative, read the INSTALL
|
To install this package under a UNIX derivative, read the INSTALL file.
|
||||||
file. tinyproxy uses a standard GNU configure script (basically you
|
Tinyproxy uses a standard GNU `configure` script. Basically you should
|
||||||
should be able to do:
|
be able to do:
|
||||||
|
|
||||||
./configure && make && make install
|
----
|
||||||
|
./configure
|
||||||
|
make
|
||||||
|
make install
|
||||||
|
----
|
||||||
|
|
||||||
in the top level directory to compile and install tinyproxy). There
|
in the top level directory to compile and install Tinyproxy. There are
|
||||||
are additional command line arguments you can supply to configure.
|
additional command line arguments you can supply to `configure`. They
|
||||||
They include:
|
include:
|
||||||
|
|
||||||
--enable-debug If you would like to turn on full
|
--enable-debug If you would like to turn on full
|
||||||
debugging support
|
debugging support
|
||||||
--enable-xtinyproxy Compile in support for the XTinyproxy
|
--enable-xtinyproxy Compile in support for the XTinyproxy
|
||||||
header, which is sent to any web
|
header, which is sent to any web
|
||||||
server in your domain.
|
server in your domain.
|
||||||
--enable-filter Allows tinyproxy to filter out certain
|
--enable-filter Allows Tinyproxy to filter out certain
|
||||||
domains and URLs.
|
domains and URLs.
|
||||||
--enable-upstream Enable support for proxying connections
|
--enable-upstream Enable support for proxying connections
|
||||||
through another proxy server.
|
through another proxy server.
|
||||||
--enable-transparent-proxy
|
--enable-transparent-proxy
|
||||||
Allow tinyproxy to be used as a
|
Allow Tinyproxy to be used as a
|
||||||
transparent proxy daemon
|
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
|
--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
|
If you are having problems with Tinyproxy, please submit a bug report
|
||||||
using Tinyproxy as the component at:
|
using Tinyproxy as the component at:
|
||||||
|
|
||||||
https://www.banu.com/bugzilla/
|
https://www.banu.com/bugzilla/
|
||||||
|
|
||||||
You may also wish to subscribe to the tinyproxy mailing lists. To
|
You may also wish to subscribe to the Tinyproxy mailing lists. To do so
|
||||||
do so please visit:
|
please visit:
|
||||||
|
|
||||||
https://www.banu.com/mailman/listinfo/tinyproxy-announce-list
|
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-users-list
|
||||||
https://www.banu.com/mailman/listinfo/tinyproxy-developers-list
|
https://www.banu.com/mailman/listinfo/tinyproxy-developers-list
|
||||||
|
|
||||||
for more information on how to subscribe and post messages to the
|
for more information on how to subscribe and post messages to the lists.
|
||||||
lists.
|
|
||||||
|
|
||||||
Please recompile tinyproxy with full debug support (--enable-debug)
|
Please recompile Tinyproxy with full debug support (--enable-debug) and
|
||||||
and include a copy of the log file, and any assert errors reported by
|
include a copy of the log file, and any assert errors reported by
|
||||||
tinyproxy. Note that tinyproxy will output memory statistics to
|
Tinyproxy. Note that Tinyproxy will output memory statistics to
|
||||||
standard error if compiled with debugging support so you might want
|
standard error if compiled with debugging support so you might want to
|
||||||
to redirect the output to a file for later examination. Also, if you
|
redirect the output to a file for later examination. Also, if you feel
|
||||||
feel up to it, try running tinyproxy under your debugger and report
|
up to it, try running Tinyproxy under your debugger and report the error
|
||||||
the error your received and a context listing of the location. Under
|
your received and a context listing of the location. Under gdb you
|
||||||
gdb you would run tinyproxy like so:
|
would run Tinyproxy like so:
|
||||||
|
|
||||||
gdb tinyproxy
|
gdb tinyproxy
|
||||||
|
|
||||||
(gdb) run -c location_of_tinyproxy_conf -d 2>/dev/null
|
(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
|
Now access the port Tinyproxy is on until you receive a break in the
|
||||||
gdb. You can now type:
|
gdb. You can now type:
|
||||||
|
|
||||||
(gbd) l
|
(gbd) l
|
||||||
|
|
||||||
to produce a context listing of the location of the error. Send a
|
to produce a context listing of the location of the error. Send a
|
||||||
copy to the authors.
|
copy to the authors.
|
||||||
|
|
||||||
|
|
||||||
CONTRIBUTING
|
Contributing
|
||||||
|
------------
|
||||||
|
|
||||||
If you would like to contribute a feature, or a bug fix to the
|
If you would like to contribute a feature, or a bug fix to the Tinyproxy
|
||||||
tinyproxy source, please send a patch (preferably as a unified
|
source, please send a patch (preferably as a unified diff. i.e. `diff
|
||||||
diff. i.e. "diff -u") against the "master" branch of the tinyproxy
|
-u` against the "master" branch of the Tinyproxy source code git
|
||||||
source code git repository to the tinyproxy-developers mailing list.
|
repository to tinyproxy-developers-list. Please include a description
|
||||||
Please include a description of what your patch does.
|
of what your patch does.
|
||||||
|
|
||||||
Tinyproxy's git repository is git://www.banu.com/tinyproxy.git .
|
Tinyproxy's git repository is git://www.banu.com/tinyproxy.git. The
|
||||||
The command "git clone git://www.banu.com/tinyproxy.git" creates
|
following command creates a local copy:
|
||||||
a local copy.
|
|
||||||
|
|
||||||
The easiest and preferred way to create a patch for submission
|
----
|
||||||
is to check in your changes locally and use the command
|
git clone git://www.banu.com/tinyproxy.git
|
||||||
"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
|
The easiest and preferred way to create a patch for submission is to
|
||||||
patches in the #tinyproxy IRC channel on freenode (irc.freenode.net).
|
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).
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user