1##
2## tinyproxy.conf -- tinyproxy daemon configuration file
3##
4## This example tinyproxy.conf file contains example settings
5## with explanations in comments. For decriptions of all
6## parameters, see the tinproxy.conf(5) manual page.
7##
8
9#
10# User/Group: This allows you to set the user and group that will be
11# used for tinyproxy after the initial binding to the port has been done
12# as the root user. Either the user or group name or the UID or GID
13# number may be used.
14#
15User tinyproxy
16Group nogroup
17
18#
19# Port: Specify the port which tinyproxy will listen on.  Please note
20# that should you choose to run on a port lower than 1024 you will need
21# to start tinyproxy using root.
22#
23Port 8888
24
25#
26# Listen: If you have multiple interfaces this allows you to bind to
27# only one. If this is commented out, tinyproxy will bind to all
28# interfaces present.
29#
30#Listen 192.168.0.1
31
32#
33# Bind: This allows you to specify which interface will be used for
34# outgoing connections.  This is useful for multi-home'd machines where
35# you want all traffic to appear outgoing from one particular interface.
36#
37#Bind 192.168.0.1
38
39#
40# BindSame: If enabled, tinyproxy will bind the outgoing connection to the
41# ip address of the incoming connection.
42#
43#BindSame yes
44
45#
46# Timeout: The maximum number of seconds of inactivity a connection is
47# allowed to have before it is closed by tinyproxy.
48#
49Timeout 600
50
51#
52# ErrorFile: Defines the HTML file to send when a given HTTP error
53# occurs.  You will probably need to customize the location to your
54# particular install.  The usual locations to check are:
55#   /usr/local/share/tinyproxy
56#   /usr/share/tinyproxy
57#   /etc/tinyproxy
58#
59#ErrorFile 404 "/usr/share/tinyproxy/404.html"
60#ErrorFile 400 "/usr/share/tinyproxy/400.html"
61#ErrorFile 503 "/usr/share/tinyproxy/503.html"
62#ErrorFile 403 "/usr/share/tinyproxy/403.html"
63#ErrorFile 408 "/usr/share/tinyproxy/408.html"
64
65#
66# DefaultErrorFile: The HTML file that gets sent if there is no
67# HTML file defined with an ErrorFile keyword for the HTTP error
68# that has occured.
69#
70DefaultErrorFile "/usr/share/tinyproxy/default.html"
71
72#
73# StatHost: This configures the host name or IP address that is treated
74# as the stat host: Whenever a request for this host is received,
75# Tinyproxy will return an internal statistics page instead of
76# forwarding the request to that host.  The default value of StatHost is
77# tinyproxy.stats.
78#
79#StatHost "tinyproxy.stats"
80#
81
82#
83# StatFile: The HTML file that gets sent when a request is made
84# for the stathost.  If this file doesn't exist a basic page is
85# hardcoded in tinyproxy.
86#
87StatFile "/usr/share/tinyproxy/stats.html"
88
89#
90# LogFile: Allows you to specify the location where information should
91# be logged to.  If you would prefer to log to syslog, then disable this
92# and enable the Syslog directive.  These directives are mutually
93# exclusive.
94#
95#LogFile "/var/log/tinyproxy/tinyproxy.log"
96
97#
98# Syslog: Tell tinyproxy to use syslog instead of a logfile.  This
99# option must not be enabled if the Logfile directive is being used.
100# These two directives are mutually exclusive.
101#
102#Syslog On
103
104#
105# LogLevel:
106#
107# Set the logging level. Allowed settings are:
108#	Critical	(least verbose)
109#	Error
110#	Warning
111#	Notice
112#	Connect		(to log connections without Info's noise)
113#	Info		(most verbose)
114#
115# The LogLevel logs from the set level and above. For example, if the
116# LogLevel was set to Warning, then all log messages from Warning to
117# Critical would be output, but Notice and below would be suppressed.
118#
119LogLevel Info
120
121#
122# PidFile: Write the PID of the main tinyproxy thread to this file so it
123# can be used for signalling purposes.
124#
125PidFile "/var/run/tinyproxy/tinyproxy.pid"
126
127#
128# XTinyproxy: Tell Tinyproxy to include the X-Tinyproxy header, which
129# contains the client's IP address.
130#
131#XTinyproxy Yes
132
133#
134# Upstream:
135#
136# Turns on upstream proxy support.
137#
138# The upstream rules allow you to selectively route upstream connections
139# based on the host/domain of the site being accessed.
140#
141# For example:
142#  # connection to test domain goes through testproxy
143#  upstream testproxy:8008 ".test.domain.invalid"
144#  upstream testproxy:8008 ".our_testbed.example.com"
145#  upstream testproxy:8008 "192.168.128.0/255.255.254.0"
146#
147#  # no upstream proxy for internal websites and unqualified hosts
148#  no upstream ".internal.example.com"
149#  no upstream "www.example.com"
150#  no upstream "10.0.0.0/8"
151#  no upstream "192.168.0.0/255.255.254.0"
152#  no upstream "."
153#
154#  # connection to these boxes go through their DMZ firewalls
155#  upstream cust1_firewall:8008 "testbed_for_cust1"
156#  upstream cust2_firewall:8008 "testbed_for_cust2"
157#
158#  # default upstream is internet firewall
159#  upstream firewall.internal.example.com:80
160#
161# The LAST matching rule wins the route decision.  As you can see, you
162# can use a host, or a domain:
163#  name     matches host exactly
164#  .name    matches any host in domain "name"
165#  .        matches any host with no domain (in 'empty' domain)
166#  IP/bits  matches network/mask
167#  IP/mask  matches network/mask
168#
169#Upstream some.remote.proxy:port
170
171#
172# MaxClients: This is the absolute highest number of threads which will
173# be created. In other words, only MaxClients number of clients can be
174# connected at the same time.
175#
176MaxClients 100
177
178#
179# MinSpareServers/MaxSpareServers: These settings set the upper and
180# lower limit for the number of spare servers which should be available.
181#
182# If the number of spare servers falls below MinSpareServers then new
183# server processes will be spawned.  If the number of servers exceeds
184# MaxSpareServers then the extras will be killed off.
185#
186MinSpareServers 5
187MaxSpareServers 20
188
189#
190# StartServers: The number of servers to start initially.
191#
192StartServers 10
193
194#
195# MaxRequestsPerChild: The number of connections a thread will handle
196# before it is killed. In practise this should be set to 0, which
197# disables thread reaping. If you do notice problems with memory
198# leakage, then set this to something like 10000.
199#
200MaxRequestsPerChild 0
201
202#
203# Allow: Customization of authorization controls. If there are any
204# access control keywords then the default action is to DENY. Otherwise,
205# the default action is ALLOW.
206#
207# The order of the controls are important. All incoming connections are
208# tested against the controls based on order.
209#
210Allow 127.0.0.1
211
212#
213# AddHeader: Adds the specified headers to outgoing HTTP requests that
214# Tinyproxy makes. Note that this option will not work for HTTPS
215# traffic, as Tinyproxy has no control over what headers are exchanged.
216#
217#AddHeader "X-My-Header" "Powered by Tinyproxy"
218
219#
220# ViaProxyName: The "Via" header is required by the HTTP RFC, but using
221# the real host name is a security concern.  If the following directive
222# is enabled, the string supplied will be used as the host name in the
223# Via header; otherwise, the server's host name will be used.
224#
225ViaProxyName "tinyproxy"
226
227#
228# DisableViaHeader: When this is set to yes, Tinyproxy does NOT add
229# the Via header to the requests. This virtually puts Tinyproxy into
230# stealth mode. Note that RFC 2616 requires proxies to set the Via
231# header, so by enabling this option, you break compliance.
232# Don't disable the Via header unless you know what you are doing...
233#
234#DisableViaHeader Yes
235
236#
237# Filter: This allows you to specify the location of the filter file.
238#
239#Filter "/etc/filter"
240
241#
242# FilterURLs: Filter based on URLs rather than domains.
243#
244#FilterURLs On
245
246#
247# FilterExtended: Use POSIX Extended regular expressions rather than
248# basic.
249#
250#FilterExtended On
251
252#
253# FilterCaseSensitive: Use case sensitive regular expressions.
254#
255#FilterCaseSensitive On
256
257#
258# FilterDefaultDeny: Change the default policy of the filtering system.
259# If this directive is commented out, or is set to "No" then the default
260# policy is to allow everything which is not specifically denied by the
261# filter file.
262#
263# However, by setting this directive to "Yes" the default policy becomes
264# to deny everything which is _not_ specifically allowed by the filter
265# file.
266#
267#FilterDefaultDeny Yes
268
269#
270# Anonymous: If an Anonymous keyword is present, then anonymous proxying
271# is enabled.  The headers listed are allowed through, while all others
272# are denied. If no Anonymous keyword is present, then all headers are
273# allowed through.  You must include quotes around the headers.
274#
275# Most sites require cookies to be enabled for them to work correctly, so
276# you will need to allow Cookies through if you access those sites.
277#
278#Anonymous "Host"
279#Anonymous "Authorization"
280#Anonymous "Cookie"
281
282#
283# ConnectPort: This is a list of ports allowed by tinyproxy when the
284# CONNECT method is used.  To disable the CONNECT method altogether, set
285# the value to 0.  If no ConnectPort line is found, all ports are
286# allowed (which is not very secure.)
287#
288# The following two ports are used by SSL.
289#
290ConnectPort 443
291ConnectPort 563
292
293#
294# Configure one or more ReversePath directives to enable reverse proxy
295# support. With reverse proxying it's possible to make a number of
296# sites appear as if they were part of a single site.
297#
298# If you uncomment the following two directives and run tinyproxy
299# on your own computer at port 8888, you can access Google using
300# http://localhost:8888/google/ and Wired News using
301# http://localhost:8888/wired/news/. Neither will actually work
302# until you uncomment ReverseMagic as they use absolute linking.
303#
304#ReversePath "/google/"	"http://www.google.com/"
305#ReversePath "/wired/"	"http://www.wired.com/"
306
307#
308# When using tinyproxy as a reverse proxy, it is STRONGLY recommended
309# that the normal proxy is turned off by uncommenting the next directive.
310#
311#ReverseOnly Yes
312
313#
314# Use a cookie to track reverse proxy mappings. If you need to reverse
315# proxy sites which have absolute links you must uncomment this.
316#
317#ReverseMagic Yes
318
319#
320# The URL that's used to access this reverse proxy. The URL is used to
321# rewrite HTTP redirects so that they won't escape the proxy. If you
322# have a chain of reverse proxies, you'll need to put the outermost
323# URL here (the address which the end user types into his/her browser).
324#
325# If not set then no rewriting occurs.
326#
327#ReverseBaseURL "http://localhost:8888/"
328
329
330
331