summaryrefslogtreecommitdiff
path: root/doc/man8/tinyproxy.txt
blob: 4d292fe2d456fdcc9ecbe8ffef4724c7b04ae3de (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
TINYPROXY(8)
============

NAME
----

tinyproxy - A light-weight HTTP proxy daemon


SYNOPSIS
--------

*tinyproxy* [-vldch]


DESCRIPTION
-----------

*tinyproxy* is a light-weight HTTP proxy daemon designed to consume a
minimum amount of system resources. It listens on a given TCP port and
handles HTTP proxy requests. Designed from the ground up to be fast and
yet small, it is an ideal solution for use cases such as embedded
deployments where a full featured HTTP proxy is required, but the system
resources for a larger proxy are unavailable.


OPTIONS
-------

*tinyproxy* accepts the following options:

*-c <config-file>*::
    Use an alternate configuration file.

*-d*::
    Don't daemonize and stay in the foreground. Useful for debugging purposes.

*-h*::
    Display a short help screen of command line arguments and exit.

*-l*::
    Display the licensing agreement.

*-v*::
    Display version information and exit.


SIGNALS
-------

In addition to command-line options, there are also several signals that
can be sent to *tinyproxy* while it is running to generate debugging
information and to force certain events.

*SIGHUP*::
    Force Tinyproxy to do a garbage collection on the current
    connections linked list. This is usually done automatically after a
    certain number of connections have been handled.


TEMPLATE VARIABLES
------------------

There are several standard HTML variables that are available in every
template file:

*request*::
    The full HTTP request line.

*cause*::
    The abbreviated cause of the error condition.

*clientip*::
    The IP address of the client making the request.

*clienthost*::
    The hostname of the client making the request.

*version*::
    The version of tinyproxy.

*package*::
    The package name. Presently, resolves to 'tinyproxy'.

*date*::
    The current date/time in HTTP format.

In addition, almost all templates support:

*detail*::
    A detailed, plain English explanation of the error and possible
    causes.


FILES
-----

`/etc/tinyproxy/tinyproxy.conf`, `/var/run/tinyproxy.pid`, `/var/log/tinyproxy.log`

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.

This program is distributed under the terms of the GNU General Public
License version 2 or above. See the COPYING file for additional
information.