1TINYPROXY(8) Tinyproxy manual TINYPROXY(8)
2
6 tinyproxy - A light-weight HTTP proxy daemon
7
9 tinyproxy [-vldch]
10
12 tinyproxy is a light-weight HTTP proxy daemon designed to consume a
13 minimum amount of system resources. It listens on a given TCP port and
14 handles HTTP proxy requests. Designed from the ground up to be fast and
15 yet small, it is an ideal solution for use cases such as embedded
16 deployments where a full featured HTTP proxy is required, but the
17 system resources for a larger proxy are unavailable.
18
20 tinyproxy accepts the following options:
21 -c <config-file>
23 Use an alternate configuration file.
24 -d
26 Don’t daemonize and stay in the foreground. Useful for debugging
27 purposes.
28 -h
30 Display a short help screen of command line arguments and exit.
31 -l
33 Display the licensing agreement.
34 -v
36 Display version information and exit.
37
39 In addition to command-line options, there are also several signals
40 that can be sent to tinyproxy while it is running to generate debugging
41 information and to force certain events.
42 SIGHUP
44 Force Tinyproxy to do a garbage collection on the current
45 connections linked list. This is usually done automatically after a
46 certain number of connections have been handled.
47
49 There are two occasions when Tinyproxy delivers HTML pages to the
50 client on it’s own right:
51 1. When an error occurred, a corresponding error page is returned.
53 2. When a request for the stathost is made, a page summarizing the
55 connection statistics is returned. (See STATHOST below.)
56 The layout of both error pages and the statistics page can be
58 controlled via configurable HTML template files that are plain HTML
59 files that additionally understand a few template variables.
60
62 There are several standard HTML variables that are available in every
63 template file:
64 request
66 The full HTTP request line.
67 cause
69 The abbreviated cause of the error condition.
70 clientip
72 The IP address of the client making the request.
73 clienthost
75 The hostname of the client making the request.
76 version
78 The version of Tinyproxy.
79 package
81 The package name. Presently, resolves to tinyproxy.
82 date
84 The current date/time in HTTP format.
85 In addition, almost all templates support:
87 detail
89 A detailed, plain English explanation of the error and possible
90 causes.
91 When Tinyproxy finds a variable name enclosed in braces, e.g.
93 "{request}", then this is replaced by the value of the corresponding
94 variable before delivery of the page.
95
97 Tinyproxy returns a HTML page with connection statistics when it
98 receives a HTTP request for a certain host — the stathost. The stathost
99 name defaults to tinyproxy.stats and can be changed at runtime to any
100 name or IP address with the configuration variable StatHost.
101 The stat file template can be changed at runtime through the
103 configuration variable StatFile.
104
106 /etc/tinyproxy/tinyproxy.conf, /var/run/tinyproxy/tinyproxy.pid,
107 /var/log/tinyproxy/tinyproxy.log
108
110 To report bugs in Tinyproxy, please visit
111 <https://www.banu.com/tinyproxy/>.
112
114 tinyproxy.conf(5)
115
117 Written by the Tinyproxy project team.
118
120 Copyright (c) 1998-2000 Steven Young; Copyright (c) 2000-2001 Robert
121 James Kaes; Copyright (c) 2009-2010 Mukund Sivaraman; Copyright (c)
122 2009-2010 Michael Adam.
123 This program is distributed under the terms of the GNU General Public
125 License version 2 or above. See the COPYING file for additional
126 information.
127Version 1.8.2 06/05/2010 TINYPROXY(8)