93219ea0db
Somehow, I don't quite get the asciidoc formatting yet. I can't get the extra paragraph on templates to look nice in the manpage output. But at least there is some content... Michael
121 lines
3.5 KiB
Plaintext
121 lines
3.5 KiB
Plaintext
TINYPROXY.CONF(5)
|
|
=================
|
|
:man source: Version @VERSION@
|
|
:man manual: Tinyproxy manual
|
|
|
|
NAME
|
|
----
|
|
|
|
tinyproxy.conf - Tinyproxy HTTP proxy daemon configuration file
|
|
|
|
|
|
SYNOPSIS
|
|
--------
|
|
|
|
*tinyproxy.conf*
|
|
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
|
|
`tinyproxy(8)` reads its configuration file, typically stored in
|
|
`/etc/tinyproxy/tinyproxy.conf` (or passed to Tinyproxy with -c on the
|
|
command line). This manpage describes the syntax and contents of the
|
|
configuration file.
|
|
|
|
The Tinyproxy configuration file contains key-value pairs, one per
|
|
line. Lines starting with `#` and empty lines are comments and are
|
|
ignored. Keywords are case-insensitive, whereas values are
|
|
case-sensitive. Values may be enclosed in double-quotes (") if they
|
|
contain spaces.
|
|
|
|
The possible keywords and their descriptions are as follows:
|
|
|
|
*User*::
|
|
|
|
The user which the Tinyproxy process should run as, after the
|
|
initial port-binding has been done as the `root` user. Either the
|
|
user name or the UID may be specified.
|
|
|
|
*Group*::
|
|
|
|
The group which the Tinyproxy process should run as, after the
|
|
initial port-binding has been done as the `root` user. Either the
|
|
group name or the GID may be specified.
|
|
|
|
*Port*::
|
|
|
|
The port which the Tinyproxy service will listen on. If the port is
|
|
less than 1024, you will need to start the Tinyproxy process as the
|
|
`root` user.
|
|
|
|
*Listen*::
|
|
|
|
By default, Tinyproxy listens for connections on all available
|
|
interfaces (i.e. it listens on the wildcard address `0.0.0.0`).
|
|
With this configuration parameter, Tinyproxy can be told to listen
|
|
only on one specific address.
|
|
|
|
*Bind*::
|
|
|
|
This allows you to specify which address Tinyproxy will bind
|
|
to for outgoing connections to web servers or upstream proxies.
|
|
|
|
*BindSame*::
|
|
|
|
If this boolean parameter is set to `yes`, then Tinyproxy will
|
|
bind the outgoing connection to the IP address of the incoming
|
|
connection that triggered the outgoing request.
|
|
|
|
*Timeout*::
|
|
|
|
The maximum number of seconds of inactivity a connection is
|
|
allowed to have before it is closed by Tinyproxy.
|
|
|
|
*ErrorFile*::
|
|
|
|
This parameter controls which HTML file Tinyproxy returns when a
|
|
given HTTP error occurs. It takes two arguments, the error number
|
|
and the location of the HTML error file.
|
|
|
|
*DefaultErrorFile*::
|
|
|
|
This parameter controls the HTML template file returned when an
|
|
error occurs for which no specific error file has been set.
|
|
|
|
|
|
*StatFile*::
|
|
|
|
This configures the HTML file that Tinyproxy sends when
|
|
a request for the stathost is received. If this parameter is
|
|
not set, Tinyproxy returns a hardcoded basic statistics page.
|
|
See the STATHOST section in the `tinyproxy(8)` manual page
|
|
for details.
|
|
|
|
|
|
Note that the StatFile and the error files configured with ErrorFile
|
|
and DefaultErrorFile are template files that can contain a few
|
|
template variables that Tinyproxy expands prior to delivery.
|
|
Examples are "\{cause}" for an abbreviated error description and
|
|
"\{detail}" for a datiled error message. The `tinyproxy(8)`
|
|
manual page contains a description of all template variables.
|
|
|
|
BUGS
|
|
----
|
|
|
|
To report bugs in Tinyproxy, please visit
|
|
<https://www.banu.com/tinyproxy/support/[https://www.banu.com/tinyproxy/support/]>.
|
|
|
|
|
|
COPYRIGHT
|
|
---------
|
|
|
|
Copyright (c) 1998-2000 Steven Young;
|
|
Copyright (c) 2000-2001 Robert James Kaes;
|
|
Copyright (c) 2009 Mukund Sivaraman;
|
|
Copyright (c) 2009 Michael Adam.
|
|
|
|
This program is distributed under the terms of the GNU General Public
|
|
License version 2 or above. See the COPYING file for additional
|
|
information.
|