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 -v
33 Display version information and exit.
34
36 In addition to command-line options, there are also several signals
37 that can be sent to tinyproxy while it is running to generate debugging
38 information and to force certain events.
39 SIGHUP
41 Force Tinyproxy to do a garbage collection on the current
42 connections linked list. This is usually done automatically after a
43 certain number of connections have been handled.
44
46 There are two occasions when Tinyproxy delivers HTML pages to the
47 client on it’s own right:
48 1. When an error occurred, a corresponding error page is returned.
50 2. When a request for the stathost is made, a page summarizing the
52 connection statistics is returned. (See STATHOST below.)
53 The layout of both error pages and the statistics page can be
55 controlled via configurable HTML template files that are plain HTML
56 files that additionally understand a few template variables.
57
59 There are several standard HTML variables that are available in every
60 template file:
61 request
63 The full HTTP request line.
64 cause
66 The abbreviated cause of the error condition.
67 clientip
69 The IP address of the client making the request.
70 clienthost
72 The hostname of the client making the request.
73 version
75 The version of Tinyproxy.
76 package
78 The package name. Presently, resolves to tinyproxy.
79 date
81 The current date/time in HTTP format.
82 In addition, almost all templates support:
84 detail
86 A detailed, plain English explanation of the error and possible
87 causes.
88 When Tinyproxy finds a variable name enclosed in braces, e.g.
90 "{request}", then this is replaced by the value of the corresponding
91 variable before delivery of the page.
92
94 Tinyproxy returns a HTML page with connection statistics when it
95 receives a HTTP request for a certain host — the stathost. The stathost
96 name defaults to tinyproxy.stats and can be changed at runtime to any
97 name or IP address with the configuration variable StatHost.
98 The stat file template can be changed at runtime through the
100 configuration variable StatFile.
101
103 /etc/tinyproxy/tinyproxy.conf, /var/run/tinyproxy/tinyproxy.pid,
104 /var/log/tinyproxy/tinyproxy.log
105
107 To report bugs in Tinyproxy, please visit
108 <https://tinyproxy.github.io/>.
109
111 tinyproxy.conf(5)
112
114 This manpage was written by the Tinyproxy project team.
115
117 Copyright (c) 1998-2018 the Tinyproxy authors.
118 This program is distributed under the terms of the GNU General Public
120 License version 2 or above. See the COPYING file for additional
121 information.
122Version 1.10.0 07/23/2021 TINYPROXY(8)