View difference between Paste ID: tkD48hUc and eqAGnqqB
SHOW: | | - or go back to the newest paste.
1-
Request URL:http://r9---sn-4g57kn7e.c.youtube.com/videoplayback?algorithm=throttle-factor&burst=40&cp=U0hVSlNMVF9HS0NONV9LRlhCOjhtUlhyd2NCM0JG&cpn=1EBww3QTJvcPaqc8&expire=1365316121&factor=1.25&fexp=931307%2C927605%2C930805%2C914061%2C932000%2C932004%2C906383%2C902000%2C901208%2C919512%2C929903%2C925714%2C931202%2C900821%2C900823%2C931203%2C931401%2C906090%2C909419%2C908529%2C930807%2C919373%2C930803%2C906836%2C920201%2C929602%2C930101%2C926403%2C900824%2C910223&id=b7a76159ba597ea4&ip=181.65.180.2&ipbits=8&itag=34&keepalive=yes&key=yt1&ms=au&mt=1365290176&mv=m&newshard=yes&range=3563520-5345279&ratebypass=yes&signature=C15855113A8799C2107265406D186F4EBA33A379.58E64423E0B25AC8EEE4ABAF6643DB4A981EA9EA&source=youtube&sparams=algorithm%2Cburst%2Ccp%2Cfactor%2Cid%2Cip%2Cipbits%2Citag%2Csource%2Cupn%2Cexpire&sver=3&upn=taXggxdFJS8
1+
#	WELCOME TO SQUID 3.1.6
2-
Request Method:GET
2+
#	----------------------------
3-
Status Code:200 OK
3+
#
4-
Request Headersview source
4+
#	This is the default Squid configuration file. You may wish
5-
Accept:*/*
5+
#	to look at the Squid home page (http://www.squid-cache.org/)
6-
Accept-Charset:ISO-8859-1,utf-8;q=0.7,*;q=0.3
6+
#	for the FAQ and other documentation.
7-
Accept-Encoding:gzip,deflate,sdch
7+
#
8-
Accept-Language:es-ES,es;q=0.8
8+
#	The default Squid config file shows what the defaults for
9-
Connection:keep-alive
9+
#	various options happen to be.  If you don't need to change the
10-
Cookie:VISITOR_INFO1_LIVE=9pSVqxfZ4DI; demographics=0e7d5e0e8d4b04ea70dcb0a542b41843e3QGAAAAZ2VuZGVydAEAAABtdAMAAABhZ2VpHAAAADA=; FrRyR.resume=LwkEifdb26c:201; use_hitbox=d5c5516c3379125f43aa0d495d100d6ddAEAAAAw; s_gl=cb4ec59d03f613ca062215f47d879161cwIAAABQRQ==; recently_watched_video_id_list=0e5ae6f58c86b8d1d726e0758b6aabf4WwMAAABzCwAAAHQ2ZGhXYnBaZnFRcwsAAAB3SnpkQ0g5MW9rWXMLAAAAejhsc19iWVByZTA=; ACTIVITY=1365290210695; PREF=al=es-419&fv=11.6.602&f1=50000000
10+
#	default, you shouldn't uncomment the line.  Doing so may cause
11-
Host:r9---sn-4g57kn7e.c.youtube.com
11+
#	run-time problems.  In some cases "none" refers to no default
12-
Referer:http://www.youtube.com/watch?v=t6dhWbpZfqQ
12+
#	setting at all, while in other cases it refers to a valid
13-
User-Agent:Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.31 (KHTML, like Gecko) Chrome/26.0.1410.43 Safari/537.31
13+
#	option - the comments for that keyword indicate if this is the
14-
Query String Parametersview sourceview URL encoded
14+
#	case.
15-
algorithm:throttle-factor
15+
#
16-
burst:40
16+
17-
cp:U0hVSlNMVF9HS0NONV9LRlhCOjhtUlhyd2NCM0JG
17+
#  Configuration options can be included using the "include" directive.
18-
cpn:1EBww3QTJvcPaqc8
18+
#  Include takes a list of files to include. Quoting and wildcards is
19-
expire:1365316121
19+
#  supported.
20-
factor:1.25
20+
#
21-
fexp:931307,927605,930805,914061,932000,932004,906383,902000,901208,919512,929903,925714,931202,900821,900823,931203,931401,906090,909419,908529,930807,919373,930803,906836,920201,929602,930101,926403,900824,910223
21+
#  For example,
22-
id:b7a76159ba597ea4
22+
#
23-
ip:181.65.180.2
23+
#  include /path/to/included/file/squid.acl.config
24-
ipbits:8
24+
#
25-
itag:34
25+
#  Includes can be nested up to a hard-coded depth of 16 levels.
26-
keepalive:yes
26+
#  This arbitrary restriction is to prevent recursive include references
27-
key:yt1
27+
#  from causing Squid entering an infinite loop whilst trying to load
28-
ms:au
28+
#  configuration files.
29-
mt:1365290176
29+
30-
mv:m
30+
# OPTIONS FOR AUTHENTICATION
31-
newshard:yes
31+
# -----------------------------------------------------------------------------
32-
range:3563520-5345279
32+
33-
ratebypass:yes
33+
#  TAG: auth_param
34-
signature:C15855113A8799C2107265406D186F4EBA33A379.58E64423E0B25AC8EEE4ABAF6643DB4A981EA9EA
34+
#	This is used to define parameters for the various authentication
35-
source:youtube
35+
#	schemes supported by Squid.
36-
sparams:algorithm,burst,cp,factor,id,ip,ipbits,itag,source,upn,expire
36+
#
37-
sver:3
37+
#	format: auth_param scheme parameter [setting]
38-
upn:taXggxdFJS8
38+
#
39-
Response Headersview source
39+
#	The order in which authentication schemes are presented to the client is
40-
Accept-Ranges:bytes
40+
#	dependent on the order the scheme first appears in config file. IE
41-
Cache-Control:private, max-age=25582
41+
#	has a bug (it's not RFC 2617 compliant) in that it will use the basic
42-
Content-Length:1781760
42+
#	scheme if basic is the first entry presented, even if more secure
43-
Content-Type:video/x-flv
43+
#	schemes are presented. For now use the order in the recommended
44-
Date:Sat, 06 Apr 2013 23:17:19 GMT
44+
#	settings section below. If other browsers have difficulties (don't
45-
Expires:Sat, 06 Apr 2013 23:17:19 GMT
45+
#	recognize the schemes offered even if you are using basic) either
46-
Last-Modified:Sat, 08 Sep 2012 04:09:34 GMT
46+
#	put basic first, or disable the other schemes (by commenting out their
47-
Proxy-Connection:keep-alive
47+
#	program entry).
48-
Server:gvs 1.0
48+
#
49-
Via:1.0 localhost (squid/3.1.6)
49+
#	Once an authentication scheme is fully configured, it can only be
50-
X-Cache:MISS from localhost
50+
#	shutdown by shutting squid down and restarting. Changes can be made on
51-
X-Cache-Lookup:MISS from localhost:3128
51+
#	the fly and activated with a reconfigure. I.E. You can change to a
52-
X-Content-Type-Options:nosniff
52+
#	different helper, but not unconfigure the helper completely.
53
#
54
#	Please note that while this directive defines how Squid processes
55
#	authentication it does not automatically activate authentication.
56
#	To use authentication you must in addition make use of ACLs based
57
#	on login name in http_access (proxy_auth, proxy_auth_regex or
58
#	external with %LOGIN used in the format tag). The browser will be
59
#	challenged for authentication on the first such acl encountered
60
#	in http_access processing and will also be re-challenged for new
61
#	login credentials if the request is being denied by a proxy_auth
62
#	type acl.
63
#
64
#	WARNING: authentication can't be used in a transparently intercepting
65
#	proxy as the client then thinks it is talking to an origin server and
66
#	not the proxy. This is a limitation of bending the TCP/IP protocol to
67
#	transparently intercepting port 80, not a limitation in Squid.
68
#	Ports flagged 'transparent', 'intercept', or 'tproxy' have
69
#	authentication disabled.
70
#
71
#	=== Parameters for the basic scheme follow. ===
72
#
73
#	"program" cmdline
74
#	Specify the command for the external authenticator.  Such a program
75
#	reads a line containing "username password" and replies "OK" or
76
#	"ERR" in an endless loop. "ERR" responses may optionally be followed
77
#	by a error description available as %m in the returned error page.
78
#	If you use an authenticator, make sure you have 1 acl of type
79
#	proxy_auth.
80
#
81
#	By default, the basic authentication scheme is not used unless a
82
#	program is specified.
83
#
84
#	If you want to use the traditional NCSA proxy authentication, set
85
#	this line to something like
86
#
87
#	auth_param basic program /usr/lib/squid3/ncsa_auth /usr/etc/passwd
88
#
89
#	"utf8" on|off
90
#	HTTP uses iso-latin-1 as characterset, while some authentication
91
#	backends such as LDAP expects UTF-8. If this is set to on Squid will
92
#	translate the HTTP iso-latin-1 charset to UTF-8 before sending the
93
#	username & password to the helper.
94
#
95
#	"children" numberofchildren
96
#	The number of authenticator processes to spawn. If you start too few
97
#	Squid will have to wait for them to process a backlog of credential
98
#	verifications, slowing it down. When password verifications are
99
#	done via a (slow) network you are likely to need lots of
100
#	authenticator processes.
101
#	auth_param basic children 5
102
#
103
#	"concurrency" concurrency
104
#	The number of concurrent requests the helper can process.
105
#	The default of 0 is used for helpers who only supports
106
#	one request at a time. Setting this changes the protocol used to
107
#	include a channel number first on the request/response line, allowing
108
#	multiple requests to be sent to the same helper in parallell without
109
#	wating for the response.
110
#	Must not be set unless it's known the helper supports this.
111
#	auth_param basic concurrency 0
112
#
113
#	"realm" realmstring
114
#	Specifies the realm name which is to be reported to the
115
#	client for the basic proxy authentication scheme (part of
116
#	the text the user will see when prompted their username and
117
#	password). There is no default.
118
#	auth_param basic realm Squid proxy-caching web server
119
#
120
#	"credentialsttl" timetolive
121
#	Specifies how long squid assumes an externally validated
122
#	username:password pair is valid for - in other words how
123
#	often the helper program is called for that user. Set this
124
#	low to force revalidation with short lived passwords.  Note
125
#	setting this high does not impact your susceptibility
126
#	to replay attacks unless you are using an one-time password
127
#	system (such as SecureID).  If you are using such a system,
128
#	you will be vulnerable to replay attacks unless you also
129
#	use the max_user_ip ACL in an http_access rule.
130
#
131
#	"casesensitive" on|off
132
#	Specifies if usernames are case sensitive. Most user databases are
133
#	case insensitive allowing the same username to be spelled using both
134
#	lower and upper case letters, but some are case sensitive. This
135
#	makes a big difference for user_max_ip ACL processing and similar.
136
#	auth_param basic casesensitive off
137
#
138
#	=== Parameters for the digest scheme follow ===
139
#
140
#	"program" cmdline
141
#	Specify the command for the external authenticator.  Such
142
#	a program reads a line containing "username":"realm" and
143
#	replies with the appropriate H(A1) value hex encoded or
144
#	ERR if the user (or his H(A1) hash) does not exists.
145
#	See rfc 2616 for the definition of H(A1).
146
#	"ERR" responses may optionally be followed by a error description
147
#	available as %m in the returned error page.
148
#
149
#	By default, the digest authentication scheme is not used unless a
150
#	program is specified.
151
#
152
#	If you want to use a digest authenticator, set this line to
153
#	something like
154
#
155
#	auth_param digest program /usr/lib/squid3/digest_pw_auth /usr/etc/digpass
156
#
157
#	"utf8" on|off
158
#	HTTP uses iso-latin-1 as characterset, while some authentication
159
#	backends such as LDAP expects UTF-8. If this is set to on Squid will
160
#	translate the HTTP iso-latin-1 charset to UTF-8 before sending the
161
#	username & password to the helper.
162
#
163
#	"children" numberofchildren
164
#	The number of authenticator processes to spawn (no default).
165
#	If you start too few Squid will have to wait for them to
166
#	process a backlog of H(A1) calculations, slowing it down.
167
#	When the H(A1) calculations are done via a (slow) network
168
#	you are likely to need lots of authenticator processes.
169
#	auth_param digest children 5
170
#
171
#	"realm" realmstring
172
#	Specifies the realm name which is to be reported to the
173
#	client for the digest proxy authentication scheme (part of
174
#	the text the user will see when prompted their username and
175
#	password). There is no default.
176
#	auth_param digest realm Squid proxy-caching web server
177
#
178
#	"nonce_garbage_interval" timeinterval
179
#	Specifies the interval that nonces that have been issued
180
#	to client_agent's are checked for validity.
181
#
182
#	"nonce_max_duration" timeinterval
183
#	Specifies the maximum length of time a given nonce will be
184
#	valid for.
185
#
186
#	"nonce_max_count" number
187
#	Specifies the maximum number of times a given nonce can be
188
#	used.
189
#
190
#	"nonce_strictness" on|off
191
#	Determines if squid requires strict increment-by-1 behavior
192
#	for nonce counts, or just incrementing (off - for use when
193
#	useragents generate nonce counts that occasionally miss 1
194
#	(ie, 1,2,4,6)). Default off.
195
#
196
#	"check_nonce_count" on|off
197
#	This directive if set to off can disable the nonce count check
198
#	completely to work around buggy digest qop implementations in
199
#	certain mainstream browser versions. Default on to check the
200
#	nonce count to protect from authentication replay attacks.
201
#
202
#	"post_workaround" on|off
203
#	This is a workaround to certain buggy browsers who sends
204
#	an incorrect request digest in POST requests when reusing
205
#	the same nonce as acquired earlier on a GET request.
206
#
207
#	=== NTLM scheme options follow ===
208
#
209
#	"program" cmdline
210
#	Specify the command for the external NTLM authenticator.
211
#	Such a program reads exchanged NTLMSSP packets with
212
#	the browser via Squid until authentication is completed.
213
#	If you use an NTLM authenticator, make sure you have 1 acl
214
#	of type proxy_auth.  By default, the NTLM authenticator_program
215
#	is not used.
216
#
217
#	auth_param ntlm program /usr/lib/squid3/ntlm_auth
218
#
219
#	"children" numberofchildren
220
#	The number of authenticator processes to spawn (no default).
221
#	If you start too few Squid will have to wait for them to
222
#	process a backlog of credential verifications, slowing it
223
#	down. When credential verifications are done via a (slow)
224
#	network you are likely to need lots of authenticator
225
#	processes.
226
#
227
#	auth_param ntlm children 5
228
#
229
#	"keep_alive" on|off
230
#	If you experience problems with PUT/POST requests when using the
231
#	Negotiate authentication scheme then you can try setting this to
232
#	off. This will cause Squid to forcibly close the connection on
233
#	the initial requests where the browser asks which schemes are
234
#	supported by the proxy.
235
#
236
#	auth_param ntlm keep_alive on
237
#
238
#	=== Options for configuring the NEGOTIATE auth-scheme follow ===
239
#
240
#	"program" cmdline
241
#	Specify the command for the external Negotiate authenticator.
242
#	This protocol is used in Microsoft Active-Directory enabled setups with
243
#	the Microsoft Internet Explorer or Mozilla Firefox browsers.
244
#	Its main purpose is to exchange credentials with the Squid proxy
245
#	using the Kerberos mechanisms.
246
#	If you use a Negotiate authenticator, make sure you have at least
247
#	one acl of type proxy_auth active. By default, the negotiate
248
#	authenticator_program is not used.
249
#	The only supported program for this role is the ntlm_auth
250
#	program distributed as part of Samba, version 4 or later.
251
#
252
#	auth_param negotiate program /usr/lib/squid3/ntlm_auth --helper-protocol=gss-spnego
253
#
254
#	"children" numberofchildren
255
#	The number of authenticator processes to spawn (no default).
256
#	If you start too few Squid will have to wait for them to
257
#	process a backlog of credential verifications, slowing it
258
#	down. When crendential verifications are done via a (slow)
259
#	network you are likely to need lots of authenticator
260
#	processes.
261
#	auth_param negotiate children 5
262
#
263
#	"keep_alive" on|off
264
#	If you experience problems with PUT/POST requests when using the
265
#	Negotiate authentication scheme then you can try setting this to
266
#	off. This will cause Squid to forcibly close the connection on
267
#	the initial requests where the browser asks which schemes are
268
#	supported by the proxy.
269
#
270
#	auth_param negotiate keep_alive on
271
#
272
#	
273
#	Examples:
274
#
275
##Recommended minimum configuration per scheme:
276
##auth_param negotiate program <uncomment and complete this line to activate>
277
##auth_param negotiate children 5
278
##auth_param negotiate keep_alive on
279
##
280
##auth_param ntlm program <uncomment and complete this line to activate>
281
##auth_param ntlm children 5
282
##auth_param ntlm keep_alive on
283
##
284
##auth_param digest program <uncomment and complete this line>
285
##auth_param digest children 5
286
##auth_param digest realm Squid proxy-caching web server
287
##auth_param digest nonce_garbage_interval 5 minutes
288
##auth_param digest nonce_max_duration 30 minutes
289
##auth_param digest nonce_max_count 50
290
##
291
##auth_param basic program <uncomment and complete this line>
292
##auth_param basic children 5
293
##auth_param basic realm Squid proxy-caching web server
294
##auth_param basic credentialsttl 2 hours
295
#Default:
296
# none
297
298
#  TAG: authenticate_cache_garbage_interval
299
#	The time period between garbage collection across the username cache.
300
#	This is a tradeoff between memory utilization (long intervals - say
301
#	2 days) and CPU (short intervals - say 1 minute). Only change if you
302
#	have good reason to.
303
#Default:
304
# authenticate_cache_garbage_interval 1 hour
305
306
#  TAG: authenticate_ttl
307
#	The time a user & their credentials stay in the logged in
308
#	user cache since their last request. When the garbage
309
#	interval passes, all user credentials that have passed their
310
#	TTL are removed from memory.
311
#Default:
312
# authenticate_ttl 1 hour
313
314
#  TAG: authenticate_ip_ttl
315
#	If you use proxy authentication and the 'max_user_ip' ACL,
316
#	this directive controls how long Squid remembers the IP
317
#	addresses associated with each user.  Use a small value
318
#	(e.g., 60 seconds) if your users might change addresses
319
#	quickly, as is the case with dialups.   You might be safe
320
#	using a larger value (e.g., 2 hours) in a corporate LAN
321
#	environment with relatively static address assignments.
322
#Default:
323
# authenticate_ip_ttl 0 seconds
324
325
# ACCESS CONTROLS
326
# -----------------------------------------------------------------------------
327
328
#  TAG: external_acl_type
329
#	This option defines external acl classes using a helper program
330
#	to look up the status
331
#
332
#	  external_acl_type name [options] FORMAT.. /path/to/helper [helper arguments..]
333
#
334
#	Options:
335
#
336
#	  ttl=n		TTL in seconds for cached results (defaults to 3600
337
#	  		for 1 hour)
338
#	  negative_ttl=n
339
#	  		TTL for cached negative lookups (default same
340
#	  		as ttl)
341
#	  children=n	Number of acl helper processes spawn to service
342
#			external acl lookups of this type. (default 5)
343
#	  concurrency=n	concurrency level per process. Only used with helpers
344
#			capable of processing more than one query at a time.
345
#	  cache=n	result cache size, 0 is unbounded (default)
346
#	  grace=n	Percentage remaining of TTL where a refresh of a
347
#			cached entry should be initiated without needing to
348
#			wait for a new reply. (default 0 for no grace period)
349
#	  protocol=2.5	Compatibility mode for Squid-2.5 external acl helpers
350
#	  ipv4 / ipv6	IP-mode used to communicate to this helper.
351
#			For compatability with older configurations and helpers
352
#			the default is currently 'ipv4'.
353
#
354
#	FORMAT specifications
355
#
356
#	  %LOGIN	Authenticated user login name
357
#	  %EXT_USER	Username from external acl
358
#	  %IDENT	Ident user name
359
#	  %SRC		Client IP
360
#	  %SRCPORT	Client source port
361
#	  %URI		Requested URI
362
#	  %DST		Requested host
363
#	  %PROTO	Requested protocol
364
#	  %PORT		Requested port
365
#	  %PATH		Requested URL path
366
#	  %METHOD	Request method
367
#	  %MYADDR	Squid interface address
368
#	  %MYPORT	Squid http_port number
369
#	  %PATH		Requested URL-path (including query-string if any)
370
#	  %USER_CERT	SSL User certificate in PEM format
371
#	  %USER_CERTCHAIN SSL User certificate chain in PEM format
372
#	  %USER_CERT_xx	SSL User certificate subject attribute xx
373
#	  %USER_CA_xx	SSL User certificate issuer attribute xx
374
#
375
#	  %>{Header}	HTTP request header "Header"
376
#	  %>{Hdr:member}
377
#	  		HTTP request header "Hdr" list member "member"
378
#	  %>{Hdr:;member}
379
#	  		HTTP request header list member using ; as
380
#	  		list separator. ; can be any non-alphanumeric
381
#			character.
382
#
383
#	  %<{Header}	HTTP reply header "Header"
384
#	  %<{Hdr:member}
385
#	  		HTTP reply header "Hdr" list member "member"
386
#	  %<{Hdr:;member}
387
#	  		HTTP reply header list member using ; as
388
#	  		list separator. ; can be any non-alphanumeric
389
#			character.
390
#
391
#	In addition to the above, any string specified in the referencing
392
#	acl will also be included in the helper request line, after the
393
#	specified formats (see the "acl external" directive)
394
#
395
#	The helper receives lines per the above format specification,
396
#	and returns lines starting with OK or ERR indicating the validity
397
#	of the request and optionally followed by additional keywords with
398
#	more details.
399
#
400
#	General result syntax:
401
#
402
#	  OK/ERR keyword=value ...
403
#
404
#	Defined keywords:
405
#
406
#	  user=		The users name (login)
407
#	  password=	The users password (for login= cache_peer option)
408
#	  message=	Message describing the reason. Available as %o
409
#	  		in error pages
410
#	  tag=		Apply a tag to a request (for both ERR and OK results)
411
#	  		Only sets a tag, does not alter existing tags.
412
#	  log=		String to be logged in access.log. Available as
413
#	  		%ea in logformat specifications
414
#
415
#	If protocol=3.0 (the default) then URL escaping is used to protect
416
#	each value in both requests and responses.
417
#
418
#	If using protocol=2.5 then all values need to be enclosed in quotes
419
#	if they may contain whitespace, or the whitespace escaped using \.
420
#	And quotes or \ characters within the keyword value must be \ escaped.
421
#
422
#	When using the concurrency= option the protocol is changed by
423
#	introducing a query channel tag infront of the request/response.
424
#	The query channel tag is a number between 0 and concurrency-1.
425
#Default:
426
# none
427
428
#  TAG: acl
429
#	Defining an Access List
430
#
431
#	Every access list definition must begin with an aclname and acltype, 
432
#	followed by either type-specific arguments or a quoted filename that
433
#	they are read from.
434
#
435
#	   acl aclname acltype argument ...
436
#	   acl aclname acltype "file" ...
437
#
438
#	When using "file", the file should contain one item per line.
439
#
440
#	By default, regular expressions are CASE-SENSITIVE.  To make
441
#	them case-insensitive, use the -i option.
442
#
443
#	Some acl types require suspending the current request in order
444
#	to access some external data source.
445
#	Those which do are marked with the tag [slow], those which
446
#	don't are marked as [fast].
447
#	See http://wiki.squid-cache.org/SquidFaq/SquidAcl
448
#	for further information
449
#
450
#	***** ACL TYPES AVAILABLE *****
451
#
452
#	acl aclname src ip-address/netmask ...	# clients IP address [fast]
453
#	acl aclname src addr1-addr2/netmask ...	# range of addresses [fast]
454
#	acl aclname dst ip-address/netmask ...	# URL host's IP address [slow]
455
#	acl aclname myip ip-address/netmask ...	# local socket IP address [fast]
456
#
457
#	acl aclname arp      mac-address ... (xx:xx:xx:xx:xx:xx notation)
458
#	  # The arp ACL requires the special configure option --enable-arp-acl.
459
#	  # Furthermore, the ARP ACL code is not portable to all operating systems.
460
#	  # It works on Linux, Solaris, Windows, FreeBSD, and some
461
#	  # other *BSD variants.
462
#	  # [fast]
463
#	  #
464
#	  # NOTE: Squid can only determine the MAC address for clients that are on
465
#	  # the same subnet. If the client is on a different subnet,
466
#	  # then Squid cannot find out its MAC address.
467
#
468
#	acl aclname srcdomain   .foo.com ...
469
#	  # reverse lookup, from client IP [slow]
470
#	acl aclname dstdomain   .foo.com ...
471
#	  # Destination server from URL [fast]
472
#	acl aclname srcdom_regex [-i] \.foo\.com ...
473
#	  # regex matching client name [slow]
474
#	acl aclname dstdom_regex [-i] \.foo\.com ...
475
#	  # regex matching server [fast]
476
#	  #
477
#	  # For dstdomain and dstdom_regex a reverse lookup is tried if a IP
478
#	  # based URL is used and no match is found. The name "none" is used
479
#	  # if the reverse lookup fails.
480
#
481
#	acl aclname src_as number ...
482
#	acl aclname dst_as number ...
483
#	  # [fast]
484
#	  # Except for access control, AS numbers can be used for
485
#	  # routing of requests to specific caches. Here's an
486
#	  # example for routing all requests for AS#1241 and only
487
#	  # those to mycache.mydomain.net:
488
#	  # acl asexample dst_as 1241
489
#	  # cache_peer_access mycache.mydomain.net allow asexample
490
#	  # cache_peer_access mycache_mydomain.net deny all
491
#
492
#	acl aclname peername myPeer ...
493
#	  # [fast]
494
#	  # match against a named cache_peer entry
495
#	  # set unique name= on cache_peer lines for reliable use.
496
#
497
#	acl aclname time [day-abbrevs] [h1:m1-h2:m2]
498
#	  # [fast]
499
#	  #  day-abbrevs:
500
#	  #	S - Sunday
501
#	  #	M - Monday
502
#	  #	T - Tuesday
503
#	  #	W - Wednesday
504
#	  #	H - Thursday
505
#	  #	F - Friday
506
#	  #	A - Saturday
507
#	  #  h1:m1 must be less than h2:m2
508
#
509
#	acl aclname url_regex [-i] ^http:// ...
510
#	  # regex matching on whole URL [fast]
511
#	acl aclname urlpath_regex [-i] \.gif$ ...
512
#	  # regex matching on URL path [fast]
513
#
514
#	acl aclname port 80 70 21 0-1024...   # destination TCP port [fast]
515
#	                                      # ranges are alloed
516
#	acl aclname myport 3128 ...	          # local socket TCP port [fast]
517
#	acl aclname myportname 3128 ...       # http(s)_port name [fast]
518
#
519
#	acl aclname proto HTTP FTP ...        # request protocol [fast]
520
# 
521
#	acl aclname method GET POST ...       # HTTP request method [fast]
522
#
523
#	acl aclname http_status 200 301 500- 400-403 ... 
524
#	  # status code in reply [fast]
525
#
526
#	acl aclname browser [-i] regexp ...
527
#	  # pattern match on User-Agent header (see also req_header below) [fast]
528
#
529
#	acl aclname referer_regex [-i] regexp ...
530
#	  # pattern match on Referer header [fast]
531
#	  # Referer is highly unreliable, so use with care
532
#
533
#	acl aclname ident username ...
534
#	acl aclname ident_regex [-i] pattern ...
535
#	  # string match on ident output [slow]
536
#	  # use REQUIRED to accept any non-null ident.
537
#
538
#	acl aclname proxy_auth [-i] username ...
539
#	acl aclname proxy_auth_regex [-i] pattern ...
540
#	  # perform http authentication challenge to the client and match against
541
#	  # supplied credentials [slow]
542
#	  #
543
#	  # takes a list of allowed usernames.
544
#	  # use REQUIRED to accept any valid username.
545
#	  #
546
#	  # Will use proxy authentication in forward-proxy scenarios, and plain
547
#	  # http authenticaiton in reverse-proxy scenarios
548
#	  #
549
#	  # NOTE: when a Proxy-Authentication header is sent but it is not
550
#	  # needed during ACL checking the username is NOT logged
551
#	  # in access.log.
552
#	  #
553
#	  # NOTE: proxy_auth requires a EXTERNAL authentication program
554
#	  # to check username/password combinations (see
555
#	  # auth_param directive).
556
#	  #
557
#	  # NOTE: proxy_auth can't be used in a transparent/intercepting proxy
558
#	  # as the browser needs to be configured for using a proxy in order
559
#	  # to respond to proxy authentication.
560
#
561
#	acl aclname snmp_community string ...
562
#	  # A community string to limit access to your SNMP Agent [fast]
563
#	  # Example:
564
#	  #
565
#	  #	acl snmppublic snmp_community public
566
#
567
#	acl aclname maxconn number
568
#	  # This will be matched when the client's IP address has
569
#	  # more than <number> HTTP connections established. [fast]
570
#
571
#	acl aclname max_user_ip [-s] number
572
#	  # This will be matched when the user attempts to log in from more
573
#	  # than <number> different ip addresses. The authenticate_ip_ttl
574
#	  # parameter controls the timeout on the ip entries. [fast]
575
#	  # If -s is specified the limit is strict, denying browsing
576
#	  # from any further IP addresses until the ttl has expired. Without
577
#	  # -s Squid will just annoy the user by "randomly" denying requests.
578
#	  # (the counter is reset each time the limit is reached and a
579
#	  # request is denied)
580
#	  # NOTE: in acceleration mode or where there is mesh of child proxies,
581
#	  # clients may appear to come from multiple addresses if they are
582
#	  # going through proxy farms, so a limit of 1 may cause user problems.
583
#
584
#	acl aclname req_mime_type [-i] mime-type ...
585
#	  # regex match against the mime type of the request generated
586
#	  # by the client. Can be used to detect file upload or some
587
#	  # types HTTP tunneling requests [fast]
588
#	  # NOTE: This does NOT match the reply. You cannot use this
589
#	  # to match the returned file type.
590
#
591
#	acl aclname req_header header-name [-i] any\.regex\.here
592
#	  # regex match against any of the known request headers.  May be
593
#	  # thought of as a superset of "browser", "referer" and "mime-type"
594
#	  # ACL [fast]
595
#
596
#	acl aclname rep_mime_type [-i] mime-type ...
597
#	  # regex match against the mime type of the reply received by
598
#	  # squid. Can be used to detect file download or some
599
#	  # types HTTP tunneling requests. [fast]
600
#	  # NOTE: This has no effect in http_access rules. It only has
601
#	  # effect in rules that affect the reply data stream such as
602
#	  # http_reply_access.
603
#
604
#	acl aclname rep_header header-name [-i] any\.regex\.here
605
#	  # regex match against any of the known reply headers. May be
606
#	  # thought of as a superset of "browser", "referer" and "mime-type"
607
#	  # ACLs [fast]
608
#
609
#	acl aclname external class_name [arguments...]
610
#	  # external ACL lookup via a helper class defined by the
611
#	  # external_acl_type directive [slow]
612
#
613
#	acl aclname user_cert attribute values...
614
#	  # match against attributes in a user SSL certificate
615
#	  # attribute is one of DN/C/O/CN/L/ST [fast]
616
#
617
#	acl aclname ca_cert attribute values...
618
#	  # match against attributes a users issuing CA SSL certificate
619
#	  # attribute is one of DN/C/O/CN/L/ST [fast]
620
#
621
#	acl aclname ext_user username ...
622
#	acl aclname ext_user_regex [-i] pattern ...
623
#	  # string match on username returned by external acl helper [slow]
624
#	  # use REQUIRED to accept any non-null user name.
625
#
626
#	acl aclname tag tagvalue ...
627
#	  # string match on tag returned by external acl helper [slow]
628
#
629
#	Examples:
630
#		acl macaddress arp 09:00:2b:23:45:67
631
#		acl myexample dst_as 1241
632
#		acl password proxy_auth REQUIRED
633
#		acl fileupload req_mime_type -i ^multipart/form-data$
634
#		acl javascript rep_mime_type -i ^application/x-javascript$
635
#
636
#Default:
637
# acl all src all
638
#
639
#
640
# Recommended minimum configuration:
641
#
642
acl manager proto cache_object
643
acl localhost src 127.0.0.1/32 ::1
644
acl to_localhost dst 127.0.0.0/8 0.0.0.0/32 ::1
645
646
# Example rule allowing access from your local networks.
647
# Adapt to list your (internal) IP networks from where browsing
648
# should be allowed
649
#acl localnet src 10.0.0.0/8	# RFC1918 possible internal network
650
#acl localnet src 172.16.0.0/12	# RFC1918 possible internal network
651
#acl localnet src 192.168.0.0/16	# RFC1918 possible internal network
652
#acl localnet src fc00::/7       # RFC 4193 local private network range
653
#acl localnet src fe80::/10      # RFC 4291 link-local (directly plugged) machines
654
655
acl SSL_ports port 443
656
acl Safe_ports port 80		# http
657
acl Safe_ports port 21		# ftp
658
acl Safe_ports port 443		# https
659
acl Safe_ports port 70		# gopher
660
acl Safe_ports port 210		# wais
661
acl Safe_ports port 1025-65535	# unregistered ports
662
acl Safe_ports port 280		# http-mgmt
663
acl Safe_ports port 488		# gss-http
664
acl Safe_ports port 591		# filemaker
665
acl Safe_ports port 777		# multiling http
666
acl CONNECT method CONNECT
667
668
#  TAG: follow_x_forwarded_for
669
#	Allowing or Denying the X-Forwarded-For header to be followed to
670
#	find the original source of a request.
671
#
672
#	Requests may pass through a chain of several other proxies
673
#	before reaching us.  The X-Forwarded-For header will contain a
674
#	comma-separated list of the IP addresses in the chain, with the
675
#	rightmost address being the most recent.
676
#
677
#	If a request reaches us from a source that is allowed by this
678
#	configuration item, then we consult the X-Forwarded-For header
679
#	to see where that host received the request from.  If the
680
#	X-Forwarded-For header contains multiple addresses, we continue
681
#	backtracking until we reach an address for which we are not allowed
682
#	to follow the X-Forwarded-For header, or until we reach the first
683
#	address in the list. For the purpose of ACL used in the
684
#	follow_x_forwarded_for directive the src ACL type always matches
685
#	the address we are testing and srcdomain matches its rDNS.
686
#
687
#	The end result of this process is an IP address that we will
688
#	refer to as the indirect client address.  This address may
689
#	be treated as the client address for access control, ICAP, delay
690
#	pools and logging, depending on the acl_uses_indirect_client,
691
#	icap_uses_indirect_client, delay_pool_uses_indirect_client and
692
#	log_uses_indirect_client options.
693
#
694
#	This clause only supports fast acl types.
695
#	See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
696
#
697
#	SECURITY CONSIDERATIONS:
698
#
699
#		Any host for which we follow the X-Forwarded-For header
700
#		can place incorrect information in the header, and Squid
701
#		will use the incorrect information as if it were the
702
#		source address of the request.  This may enable remote
703
#		hosts to bypass any access control restrictions that are
704
#		based on the client's source addresses.
705
#
706
#	For example:
707
#
708
#		acl localhost src 127.0.0.1
709
#		acl my_other_proxy srcdomain .proxy.example.com
710
#		follow_x_forwarded_for allow localhost
711
#		follow_x_forwarded_for allow my_other_proxy
712
#Default:
713
# follow_x_forwarded_for deny all
714
715
#  TAG: acl_uses_indirect_client	on|off
716
#	Controls whether the indirect client address
717
#	(see follow_x_forwarded_for) is used instead of the
718
#	direct client address in acl matching.
719
#Default:
720
# acl_uses_indirect_client on
721
722
#  TAG: delay_pool_uses_indirect_client	on|off
723
#	Controls whether the indirect client address
724
#	(see follow_x_forwarded_for) is used instead of the
725
#	direct client address in delay pools.
726
#Default:
727
# delay_pool_uses_indirect_client on
728
729
#  TAG: log_uses_indirect_client	on|off
730
#	Controls whether the indirect client address
731
#	(see follow_x_forwarded_for) is used instead of the
732
#	direct client address in the access log.
733
#Default:
734
# log_uses_indirect_client on
735
736
#  TAG: http_access
737
#	Allowing or Denying access based on defined access lists
738
#
739
#	Access to the HTTP port:
740
#	http_access allow|deny [!]aclname ...
741
#
742
#	NOTE on default values:
743
#
744
#	If there are no "access" lines present, the default is to deny
745
#	the request.
746
#
747
#	If none of the "access" lines cause a match, the default is the
748
#	opposite of the last line in the list.  If the last line was
749
#	deny, the default is allow.  Conversely, if the last line
750
#	is allow, the default will be deny.  For these reasons, it is a
751
#	good idea to have an "deny all" entry at the end of your access
752
#	lists to avoid potential confusion.
753
#
754
#	This clause supports both fast and slow acl types.
755
#	See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
756
#
757
#Default:
758
# http_access deny all
759
#
760
761
#
762
# Recommended minimum Access Permission configuration:
763
#
764
# Only allow cachemgr access from localhost
765
http_access allow manager localhost
766
http_access deny manager
767
768
# Deny requests to certain unsafe ports
769
http_access deny !Safe_ports
770
771
acl red_local src 10.0.0.0/8
772
http_access allow red_local
773
dns_nameservers 8.8.8.8 8.8.4.4 200.48.0.30 200.48.0.36 200.48.0.50 200.48.0.51 200.48.225.130 200.48.225.146
774
775
# Deny CONNECT to other than secure SSL ports
776
http_access deny CONNECT !SSL_ports
777
778
# We strongly recommend the following be uncommented to protect innocent
779
# web applications running on the proxy server who think the only
780
# one who can access services on "localhost" is a local user
781
#http_access deny to_localhost
782
783
#
784
# INSERT YOUR OWN RULE(S) HERE TO ALLOW ACCESS FROM YOUR CLIENTS
785
#
786
acl m_post method POST
787
acl url_block url_regex ^http.{1,4}[\w\.]*\.fwmrm\.net\/ad\/p\/1\?$
788
http_access deny m_post url_block
789
#
790
# Example rule allowing access from your local networks.
791
# Adapt localnet in the ACL section to list your (internal) IP networks
792
# from where browsing should be allowed
793
#http_access allow localnet
794
http_access allow localhost
795
796
# And finally deny all other access to this proxy
797
http_access deny all
798
799
#  TAG: adapted_http_access
800
#	Allowing or Denying access based on defined access lists
801
#
802
#	Essentially identical to http_access, but runs after redirectors
803
#	and ICAP/eCAP adaptation. Allowing access control based on their
804
#	output.
805
#
806
#	If not set then only http_access is used.
807
#Default:
808
# none
809
810
#  TAG: http_reply_access
811
#	Allow replies to client requests. This is complementary to http_access.
812
#
813
#	http_reply_access allow|deny [!] aclname ...
814
#
815
#	NOTE: if there are no access lines present, the default is to allow
816
#	all replies
817
#
818
#	If none of the access lines cause a match the opposite of the
819
#	last line will apply. Thus it is good practice to end the rules
820
#	with an "allow all" or "deny all" entry.
821
#
822
#	This clause supports both fast and slow acl types.
823
#	See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
824
#Default:
825
# none
826
827
#  TAG: icp_access
828
#	Allowing or Denying access to the ICP port based on defined
829
#	access lists
830
#
831
#	icp_access  allow|deny [!]aclname ...
832
#
833
#	See http_access for details
834
#
835
#	This clause only supports fast acl types.
836
#	See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
837
#
838
## Allow ICP queries from local networks only
839
##icp_access allow localnet
840
##icp_access deny all
841
#Default:
842
# icp_access deny all
843
844
#  TAG: htcp_access
845
#	Allowing or Denying access to the HTCP port based on defined
846
#	access lists
847
#
848
#	htcp_access  allow|deny [!]aclname ...
849
#
850
#	See http_access for details
851
#
852
#	NOTE: The default if no htcp_access lines are present is to
853
#	deny all traffic. This default may cause problems with peers
854
#	using the htcp or htcp-oldsquid options.
855
#
856
#	This clause only supports fast acl types.
857
#	See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
858
#
859
## Allow HTCP queries from local networks only
860
##htcp_access allow localnet
861
##htcp_access deny all
862
#Default:
863
# htcp_access deny all
864
865
#  TAG: htcp_clr_access
866
#	Allowing or Denying access to purge content using HTCP based
867
#	on defined access lists
868
#
869
#	htcp_clr_access  allow|deny [!]aclname ...
870
#
871
#	See http_access for details
872
#
873
#	This clause only supports fast acl types.
874
#	See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
875
#
876
## Allow HTCP CLR requests from trusted peers
877
#acl htcp_clr_peer src 172.16.1.2
878
#htcp_clr_access allow htcp_clr_peer
879
#Default:
880
# htcp_clr_access deny all
881
882
#  TAG: miss_access
883
#	Use to force your neighbors to use you as a sibling instead of
884
#	a parent.  For example:
885
#
886
#		acl localclients src 172.16.0.0/16
887
#		miss_access allow localclients
888
#		miss_access deny  !localclients
889
#
890
#	This means only your local clients are allowed to fetch
891
#	MISSES and all other clients can only fetch HITS.
892
#
893
#	By default, allow all clients who passed the http_access rules
894
#	to fetch MISSES from us.
895
#
896
#	This clause only supports fast acl types.
897
#	See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
898
#Default:
899
# miss_access allow all
900
901
#  TAG: ident_lookup_access
902
#	A list of ACL elements which, if matched, cause an ident
903
#	(RFC 931) lookup to be performed for this request.  For
904
#	example, you might choose to always perform ident lookups
905
#	for your main multi-user Unix boxes, but not for your Macs
906
#	and PCs.  By default, ident lookups are not performed for
907
#	any requests.
908
#
909
#	To enable ident lookups for specific client addresses, you
910
#	can follow this example:
911
#
912
#	acl ident_aware_hosts src 198.168.1.0/24
913
#	ident_lookup_access allow ident_aware_hosts
914
#	ident_lookup_access deny all
915
#
916
#	Only src type ACL checks are fully supported.  A srcdomain
917
#	ACL might work at times, but it will not always provide
918
#	the correct result.
919
#
920
#	This clause only supports fast acl types.
921
#	See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
922
#Default:
923
# ident_lookup_access deny all
924
925
#  TAG: reply_body_max_size	size [acl acl...]
926
#	This option specifies the maximum size of a reply body. It can be
927
#	used to prevent users from downloading very large files, such as
928
#	MP3's and movies. When the reply headers are received, the
929
#	reply_body_max_size lines are processed, and the first line where
930
#	all (if any) listed ACLs are true is used as the maximum body size
931
#	for this reply.
932
#
933
#	This size is checked twice. First when we get the reply headers,
934
#	we check the content-length value.  If the content length value exists
935
#	and is larger than the allowed size, the request is denied and the
936
#	user receives an error message that says "the request or reply
937
#	is too large." If there is no content-length, and the reply
938
#	size exceeds this limit, the client's connection is just closed
939
#	and they will receive a partial reply.
940
#
941
#	WARNING: downstream caches probably can not detect a partial reply
942
#	if there is no content-length header, so they will cache
943
#	partial responses and give them out as hits.  You should NOT
944
#	use this option if you have downstream caches.
945
#
946
#	WARNING: A maximum size smaller than the size of squid's error messages
947
#	will cause an infinite loop and crash squid. Ensure that the smallest
948
#	non-zero value you use is greater that the maximum header size plus
949
#	the size of your largest error page.
950
#
951
#	If you set this parameter none (the default), there will be
952
#	no limit imposed.
953
#
954
#	Configuration Format is:
955
#		reply_body_max_size SIZE UNITS [acl ...]
956
#	ie.
957
#		reply_body_max_size 10 MB
958
#
959
#Default:
960
# none
961
962
# NETWORK OPTIONS
963
# -----------------------------------------------------------------------------
964
965
#  TAG: http_port
966
#	Usage:	port [options]
967
#		hostname:port [options]
968
#		1.2.3.4:port [options]
969
#
970
#	The socket addresses where Squid will listen for HTTP client
971
#	requests.  You may specify multiple socket addresses.
972
#	There are three forms: port alone, hostname with port, and
973
#	IP address with port.  If you specify a hostname or IP
974
#	address, Squid binds the socket to that specific
975
#	address.  This replaces the old 'tcp_incoming_address'
976
#	option.  Most likely, you do not need to bind to a specific
977
#	address, so you can use the port number alone.
978
#
979
#	If you are running Squid in accelerator mode, you
980
#	probably want to listen on port 80 also, or instead.
981
#
982
#	The -a command line option may be used to specify additional
983
#	port(s) where Squid listens for proxy request. Such ports will
984
#	be plain proxy ports with no options.
985
#
986
#	You may specify multiple socket addresses on multiple lines.
987
#
988
#	Options:
989
#
990
#	   intercept	Support for IP-Layer interception of
991
#			outgoing requests without browser settings.
992
#			NP: disables authentication and IPv6 on the port.
993
#
994
#	   tproxy	Support Linux TPROXY for spoofing outgoing
995
#			connections using the client IP address.
996
#			NP: disables authentication and maybe IPv6 on the port.
997
#
998
#	   accel	Accelerator mode. Also needs at least one of
999
#			vhost / vport / defaultsite.
1000
#
1001
#	   allow-direct	Allow direct forwarding in accelerator mode. Normally
1002
#			accelerated requests are denied direct forwarding as if
1003
#			never_direct was used.
1004
#
1005
#	   defaultsite=domainname
1006
#			What to use for the Host: header if it is not present
1007
#			in a request. Determines what site (not origin server)
1008
#			accelerators should consider the default.
1009
#			Implies accel.
1010
#
1011
#	   vhost	Accelerator mode using Host header for virtual
1012
#			domain support. Implies accel.
1013
#
1014
#	   vport	Accelerator with IP based virtual host support.
1015
#			Implies accel.
1016
#
1017
#	   vport=NN	As above, but uses specified port number rather
1018
#			than the http_port number. Implies accel.
1019
#
1020
#	   protocol=	Protocol to reconstruct accelerated requests with.
1021
#			Defaults to http.
1022
#
1023
#	   ignore-cc	Ignore request Cache-Control headers.
1024
#
1025
#	   		Warning: This option violates HTTP specifications if
1026
#			used in non-accelerator setups.
1027
#
1028
#	   connection-auth[=on|off]
1029
#	                use connection-auth=off to tell Squid to prevent 
1030
#	                forwarding Microsoft connection oriented authentication
1031
#			(NTLM, Negotiate and Kerberos)
1032
#
1033
#	   disable-pmtu-discovery=
1034
#			Control Path-MTU discovery usage:
1035
#			    off		lets OS decide on what to do (default).
1036
#			    transparent	disable PMTU discovery when transparent
1037
#					support is enabled.
1038
#			    always	disable always PMTU discovery.
1039
#
1040
#			In many setups of transparently intercepting proxies
1041
#			Path-MTU discovery can not work on traffic towards the
1042
#			clients. This is the case when the intercepting device
1043
#			does not fully track connections and fails to forward
1044
#			ICMP must fragment messages to the cache server. If you
1045
#			have such setup and experience that certain clients
1046
#			sporadically hang or never complete requests set
1047
#			disable-pmtu-discovery option to 'transparent'.
1048
#
1049
#	   sslBump 	Intercept each CONNECT request matching ssl_bump ACL,
1050
#			establish secure connection with the client and with
1051
#			the server, decrypt HTTP messages as they pass through
1052
#			Squid, and treat them as unencrypted HTTP messages,
1053
#			becoming the man-in-the-middle.
1054
#
1055
#			When this option is enabled, additional options become
1056
#			available to specify SSL-related properties of the
1057
#			client-side connection: cert, key, version, cipher,
1058
#			options, clientca, cafile, capath, crlfile, dhparams,
1059
#			sslflags, and sslcontext. See the https_port directive
1060
#			for more information on these options.
1061
#
1062
#			The ssl_bump option is required to fully enable
1063
#			the SslBump feature.
1064
#
1065
#	   name=	Specifies a internal name for the port. Defaults to
1066
#			the port specification (port or addr:port)
1067
#
1068
#	   tcpkeepalive[=idle,interval,timeout]
1069
#			Enable TCP keepalive probes of idle connections.
1070
#			In seconds; idle is the initial time before TCP starts
1071
#			probing the connection, interval how often to probe, and
1072
#			timeout the time before giving up.
1073
#
1074
#	If you run Squid on a dual-homed machine with an internal
1075
#	and an external interface we recommend you to specify the
1076
#	internal address:port in http_port. This way Squid will only be
1077
#	visible on the internal address.
1078
#
1079
#
1080
1081
# Squid normally listens to port 3128
1082
http_port 3128 transparent
1083
1084
#  TAG: https_port
1085
# Note: This option is only available if Squid is rebuilt with the
1086
#       --enable-ssl option
1087
#
1088
#	Usage:  [ip:]port cert=certificate.pem [key=key.pem] [options...]
1089
#
1090
#	The socket address where Squid will listen for HTTPS client
1091
#	requests.
1092
#
1093
#	This is really only useful for situations where you are running
1094
#	squid in accelerator mode and you want to do the SSL work at the
1095
#	accelerator level.
1096
#
1097
#	You may specify multiple socket addresses on multiple lines,
1098
#	each with their own SSL certificate and/or options.
1099
#
1100
#	Options:
1101
#
1102
#	   accel	Accelerator mode. Also needs at least one of
1103
#			defaultsite or vhost.
1104
#
1105
#	   defaultsite=	The name of the https site presented on
1106
#	   		this port. Implies accel.
1107
#
1108
#	   vhost	Accelerator mode using Host header for virtual
1109
#			domain support. Requires a wildcard certificate
1110
#			or other certificate valid for more than one domain.
1111
#			Implies accel.
1112
#
1113
#	   protocol=	Protocol to reconstruct accelerated requests with.
1114
#			Defaults to https.
1115
#
1116
#	   cert=	Path to SSL certificate (PEM format).
1117
#
1118
#	   key=		Path to SSL private key file (PEM format)
1119
#			if not specified, the certificate file is
1120
#			assumed to be a combined certificate and
1121
#			key file.
1122
#
1123
#	   version=	The version of SSL/TLS supported
1124
#			    1	automatic (default)
1125
#			    2	SSLv2 only
1126
#			    3	SSLv3 only
1127
#			    4	TLSv1 only
1128
#
1129
#	   cipher=	Colon separated list of supported ciphers.
1130
#
1131
#	   options=	Various SSL engine options. The most important
1132
#			being:
1133
#			    NO_SSLv2  Disallow the use of SSLv2
1134
#			    NO_SSLv3  Disallow the use of SSLv3
1135
#			    NO_TLSv1  Disallow the use of TLSv1
1136
#			    SINGLE_DH_USE Always create a new key when using
1137
#				      temporary/ephemeral DH key exchanges
1138
#			See src/ssl_support.c or OpenSSL SSL_CTX_set_options
1139
#			documentation for a complete list of options.
1140
#
1141
#	   clientca=	File containing the list of CAs to use when
1142
#			requesting a client certificate.
1143
#
1144
#	   cafile=	File containing additional CA certificates to
1145
#			use when verifying client certificates. If unset
1146
#			clientca will be used.
1147
#
1148
#	   capath=	Directory containing additional CA certificates
1149
#			and CRL lists to use when verifying client certificates.
1150
#
1151
#	   crlfile=	File of additional CRL lists to use when verifying
1152
#			the client certificate, in addition to CRLs stored in
1153
#			the capath. Implies VERIFY_CRL flag below.
1154
#
1155
#	   dhparams=	File containing DH parameters for temporary/ephemeral
1156
#			DH key exchanges.
1157
#
1158
#	   sslflags=	Various flags modifying the use of SSL:
1159
#			    DELAYED_AUTH
1160
#				Don't request client certificates
1161
#				immediately, but wait until acl processing
1162
#				requires a certificate (not yet implemented).
1163
#			    NO_DEFAULT_CA
1164
#				Don't use the default CA lists built in
1165
#				to OpenSSL.
1166
#			    NO_SESSION_REUSE
1167
#				Don't allow for session reuse. Each connection
1168
#				will result in a new SSL session.
1169
#			    VERIFY_CRL
1170
#				Verify CRL lists when accepting client
1171
#				certificates.
1172
#			    VERIFY_CRL_ALL
1173
#				Verify CRL lists for all certificates in the
1174
#				client certificate chain.
1175
#
1176
#	   sslcontext=	SSL session ID context identifier.
1177
#
1178
#	   vport	Accelerator with IP based virtual host support.
1179
#
1180
#	   vport=NN	As above, but uses specified port number rather
1181
#			than the https_port number. Implies accel.
1182
#
1183
#	   name=	Specifies a internal name for the port. Defaults to
1184
#			the port specification (port or addr:port)
1185
#
1186
#Default:
1187
# none
1188
1189
#  TAG: tcp_outgoing_tos
1190
#	Allows you to select a TOS/Diffserv value to mark outgoing
1191
#	connections with, based on the username or source address
1192
#	making the request.
1193
#
1194
#	tcp_outgoing_tos ds-field [!]aclname ...
1195
#
1196
#	Example where normal_service_net uses the TOS value 0x00
1197
#	and good_service_net uses 0x20
1198
#
1199
#	acl normal_service_net src 10.0.0.0/255.255.255.0
1200
#	acl good_service_net src 10.0.1.0/255.255.255.0
1201
#	tcp_outgoing_tos 0x00 normal_service_net
1202
#	tcp_outgoing_tos 0x20 good_service_net
1203
#
1204
#	TOS/DSCP values really only have local significance - so you should
1205
#	know what you're specifying. For more information, see RFC2474,
1206
#	RFC2475, and RFC3260.
1207
#
1208
#	The TOS/DSCP byte must be exactly that - a octet value  0 - 255, or
1209
#	"default" to use whatever default your host has. Note that in
1210
#	practice often only values 0 - 63 is usable as the two highest bits
1211
#	have been redefined for use by ECN (RFC3168).
1212
#
1213
#	Processing proceeds in the order specified, and stops at first fully
1214
#	matching line.
1215
#
1216
#	Note: The use of this directive using client dependent ACLs is
1217
#	incompatible with the use of server side persistent connections. To
1218
#	ensure correct results it is best to set server_persisten_connections
1219
#	to off when using this directive in such configurations.
1220
#Default:
1221
# none
1222
1223
#  TAG: clientside_tos
1224
#	Allows you to select a TOS/Diffserv value to mark client-side
1225
#	connections with, based on the username or source address
1226
#	making the request.
1227
#Default:
1228
# none
1229
1230
#  TAG: qos_flows
1231
# Note: This option is only available if Squid is rebuilt with the
1232
#       --enable-zph-qos option
1233
#
1234
#	Allows you to select a TOS/DSCP value to mark outgoing
1235
#	connections with, based on where the reply was sourced.
1236
#
1237
#	TOS values really only have local significance - so you should
1238
#	know what you're specifying. For more information, see RFC2474,
1239
#	RFC2475, and RFC3260.
1240
#
1241
#	The TOS/DSCP byte must be exactly that - octet value 0x00-0xFF.
1242
#	Note that in practice often only values up to 0x3F are usable
1243
#	as the two highest bits have been redefined for use by ECN
1244
#	(RFC3168).
1245
#
1246
#	This setting is configured by setting the source TOS values:
1247
#
1248
#	local-hit=0xFF		Value to mark local cache hits.
1249
#
1250
#	sibling-hit=0xFF	Value to mark hits from sibling peers.
1251
#
1252
#	parent-hit=0xFF		Value to mark hits from parent peers.
1253
#
1254
#
1255
#	NOTE: 'miss' preserve feature is only possible on Linux at this time.
1256
#
1257
#	For the following to work correctly, you will need to patch your
1258
#	linux kernel with the TOS preserving ZPH patch.
1259
#	The kernel patch can be downloaded from http://zph.bratcheda.org
1260
#
1261
#	disable-preserve-miss
1262
#		By default, the existing TOS value of the response coming
1263
#		from the remote server will be retained and masked with
1264
#		miss-mark. This option disables that feature.
1265
#
1266
#	miss-mask=0xFF
1267
#		Allows you to mask certain bits in the TOS received from the
1268
#		remote server, before copying the value to the TOS sent
1269
#		towards clients.
1270
#		Default: 0xFF (TOS from server is not changed).
1271
#
1272
#Default:
1273
# none
1274
1275
#  TAG: tcp_outgoing_address
1276
#	Allows you to map requests to different outgoing IP addresses
1277
#	based on the username or source address of the user making
1278
#	the request.
1279
#
1280
#	tcp_outgoing_address ipaddr [[!]aclname] ...
1281
#
1282
#	Example where requests from 10.0.0.0/24 will be forwarded
1283
#	with source address 10.1.0.1, 10.0.2.0/24 forwarded with
1284
#	source address 10.1.0.2 and the rest will be forwarded with
1285
#	source address 10.1.0.3.
1286
#
1287
#	acl normal_service_net src 10.0.0.0/24
1288
#	acl good_service_net src 10.0.2.0/24
1289
#	tcp_outgoing_address 10.1.0.1 normal_service_net
1290
#	tcp_outgoing_address 10.1.0.2 good_service_net
1291
#	tcp_outgoing_address 10.1.0.3
1292
#
1293
#	Processing proceeds in the order specified, and stops at first fully
1294
#	matching line.
1295
#
1296
#	Note: The use of this directive using client dependent ACLs is
1297
#	incompatible with the use of server side persistent connections. To
1298
#	ensure correct results it is best to set server_persistent_connections
1299
#	to off when using this directive in such configurations.
1300
#
1301
#
1302
#        IPv6 Magic:
1303
#
1304
#	Squid is built with a capability of bridging the IPv4 and IPv6 
1305
#	internets.
1306
#	tcp_outgoing_address as exampled above breaks this bridging by forcing
1307
#	all outbound traffic through a certain IPv4 which may be on the wrong
1308
#	side of the IPv4/IPv6 boundary.
1309
#
1310
#	To operate with tcp_outgoing_address and keep the bridging benefits
1311
#	an additional ACL needs to be used which ensures the IPv6-bound traffic
1312
#	is never forced or permitted out the IPv4 interface.
1313
#
1314
#	acl to_ipv6 dst ipv6
1315
#	tcp_outgoing_address 2002::c001 good_service_net to_ipv6
1316
#	tcp_outgoing_address 10.1.0.2 good_service_net !to_ipv6
1317
#
1318
#	tcp_outgoing_address 2002::beef normal_service_net to_ipv6
1319
#	tcp_outgoing_address 10.1.0.1 normal_service_net !to_ipv6
1320
#
1321
#	tcp_outgoing_address 2002::1 to_ipv6
1322
#	tcp_outgoing_address 10.1.0.3 !to_ipv6
1323
#
1324
#	WARNING:
1325
#	  'dst ipv6' bases its selection assuming DIRECT access.
1326
#	  If peers are used the peername ACL are needed to select outgoing
1327
#	  address which can link to the peer.
1328
#
1329
#	  'dst ipv6' is a slow ACL. It will only work here if 'dst' is used
1330
#	  previously in the http_access rules to locate the destination IP.
1331
#	  Some more magic may be needed for that:
1332
#	    http_access allow to_ipv6 !all
1333
#	  (meaning, allow if to IPv6 but not from anywhere ;)
1334
#
1335
#Default:
1336
# none
1337
1338
# SSL OPTIONS
1339
# -----------------------------------------------------------------------------
1340
1341
#  TAG: ssl_unclean_shutdown
1342
# Note: This option is only available if Squid is rebuilt with the
1343
#       --enable-ssl option
1344
#
1345
#	Some browsers (especially MSIE) bugs out on SSL shutdown
1346
#	messages.
1347
#Default:
1348
# ssl_unclean_shutdown off
1349
1350
#  TAG: ssl_engine
1351
# Note: This option is only available if Squid is rebuilt with the
1352
#       --enable-ssl option
1353
#
1354
#	The OpenSSL engine to use. You will need to set this if you
1355
#	would like to use hardware SSL acceleration for example.
1356
#Default:
1357
# none
1358
1359
#  TAG: sslproxy_client_certificate
1360
# Note: This option is only available if Squid is rebuilt with the
1361
#       --enable-ssl option
1362
#
1363
#	Client SSL Certificate to use when proxying https:// URLs
1364
#Default:
1365
# none
1366
1367
#  TAG: sslproxy_client_key
1368
# Note: This option is only available if Squid is rebuilt with the
1369
#       --enable-ssl option
1370
#
1371
#	Client SSL Key to use when proxying https:// URLs
1372
#Default:
1373
# none
1374
1375
#  TAG: sslproxy_version
1376
# Note: This option is only available if Squid is rebuilt with the
1377
#       --enable-ssl option
1378
#
1379
#	SSL version level to use when proxying https:// URLs
1380
#Default:
1381
# sslproxy_version 1
1382
1383
#  TAG: sslproxy_options
1384
# Note: This option is only available if Squid is rebuilt with the
1385
#       --enable-ssl option
1386
#
1387
#	SSL engine options to use when proxying https:// URLs
1388
#	
1389
#	The most important being:
1390
#
1391
#		NO_SSLv2  Disallow the use of SSLv2
1392
#		NO_SSLv3  Disallow the use of SSLv3
1393
#		NO_TLSv1  Disallow the use of TLSv1
1394
#		SINGLE_DH_USE
1395
#			Always create a new key when using
1396
#			temporary/ephemeral DH key exchanges
1397
#	
1398
#	These options vary depending on your SSL engine.
1399
#	See the OpenSSL SSL_CTX_set_options documentation for a
1400
#	complete list of possible options.
1401
#Default:
1402
# none
1403
1404
#  TAG: sslproxy_cipher
1405
# Note: This option is only available if Squid is rebuilt with the
1406
#       --enable-ssl option
1407
#
1408
#	SSL cipher list to use when proxying https:// URLs
1409
#
1410
#	Colon separated list of supported ciphers.
1411
#Default:
1412
# none
1413
1414
#  TAG: sslproxy_cafile
1415
# Note: This option is only available if Squid is rebuilt with the
1416
#       --enable-ssl option
1417
#
1418
#	file containing CA certificates to use when verifying server
1419
#	certificates while proxying https:// URLs
1420
#Default:
1421
# none
1422
1423
#  TAG: sslproxy_capath
1424
# Note: This option is only available if Squid is rebuilt with the
1425
#       --enable-ssl option
1426
#
1427
#	directory containing CA certificates to use when verifying
1428
#	server certificates while proxying https:// URLs
1429
#Default:
1430
# none
1431
1432
#  TAG: ssl_bump
1433
# Note: This option is only available if Squid is rebuilt with the
1434
#       --enable-ssl option
1435
#
1436
#	This ACL controls which CONNECT requests to an http_port
1437
#	marked with an sslBump flag are actually "bumped". Please 
1438
#	see the sslBump flag of an http_port option for more details
1439
#	about decoding proxied SSL connections.
1440
#
1441
#	By default, no requests are bumped.
1442
#
1443
#	See also: http_port sslBump
1444
#   
1445
#	This clause only supports fast acl types.
1446
#	See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
1447
#
1448
#
1449
#	# Example: Bump all requests except those originating from localhost and 
1450
#	# those going to webax.com or example.com sites.
1451
#
1452
#	acl localhost src 127.0.0.1/32
1453
#	acl broken_sites dstdomain .webax.com
1454
#	acl broken_sites dstdomain .example.com
1455
#	ssl_bump deny localhost
1456
#	ssl_bump deny broken_sites
1457
#	ssl_bump allow all
1458
#Default:
1459
# none
1460
1461
#  TAG: sslproxy_flags
1462
# Note: This option is only available if Squid is rebuilt with the
1463
#       --enable-ssl option
1464
#
1465
#	Various flags modifying the use of SSL while proxying https:// URLs:
1466
#	    DONT_VERIFY_PEER	Accept certificates that fail verification.
1467
#				For refined control, see sslproxy_cert_error.
1468
#	    NO_DEFAULT_CA	Don't use the default CA list built in
1469
#				to OpenSSL.
1470
#Default:
1471
# none
1472
1473
#  TAG: sslproxy_cert_error
1474
# Note: This option is only available if Squid is rebuilt with the
1475
#       --enable-ssl option
1476
#
1477
#	Use this ACL to bypass server certificate validation errors.
1478
#
1479
#	For example, the following lines will bypass all validation errors
1480
#	when talking to servers located at 172.16.0.0/16. All other
1481
#	validation errors will result in ERR_SECURE_CONNECT_FAIL error.
1482
#
1483
#		acl BrokenServersAtTrustedIP dst 172.16.0.0/16
1484
#		sslproxy_cert_error allow BrokenServersAtTrustedIP
1485
#		sslproxy_cert_error deny all
1486
#
1487
#	This clause only supports fast acl types.
1488
#	See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
1489
#	Using slow acl types may result in server crashes
1490
#
1491
#	Without this option, all server certificate validation errors
1492
#	terminate the transaction. Bypassing validation errors is dangerous
1493
#	because an error usually implies that the server cannot be trusted and
1494
#	the connection may be insecure.
1495
#
1496
#	See also: sslproxy_flags and DONT_VERIFY_PEER.
1497
#
1498
#	Default setting:  sslproxy_cert_error deny all
1499
#Default:
1500
# none
1501
1502
#  TAG: sslpassword_program
1503
# Note: This option is only available if Squid is rebuilt with the
1504
#       --enable-ssl option
1505
#
1506
#	Specify a program used for entering SSL key passphrases
1507
#	when using encrypted SSL certificate keys. If not specified
1508
#	keys must either be unencrypted, or Squid started with the -N
1509
#	option to allow it to query interactively for the passphrase.
1510
#Default:
1511
# none
1512
1513
# OPTIONS WHICH AFFECT THE NEIGHBOR SELECTION ALGORITHM
1514
# -----------------------------------------------------------------------------
1515
1516
#  TAG: cache_peer
1517
#	To specify other caches in a hierarchy, use the format:
1518
#	
1519
#		cache_peer hostname type http-port icp-port [options]
1520
#	
1521
#	For example,
1522
#	
1523
#	#                                        proxy  icp
1524
#	#          hostname             type     port   port  options
1525
#	#          -------------------- -------- ----- -----  -----------
1526
#	cache_peer parent.foo.net       parent    3128  3130  default
1527
#	cache_peer sib1.foo.net         sibling   3128  3130  proxy-only
1528
#	cache_peer sib2.foo.net         sibling   3128  3130  proxy-only
1529
#	cache_peer example.com          parent    80       0  no-query default
1530
#	cache_peer cdn.example.com      sibling   3128     0  
1531
#	
1532
#	      type:	either 'parent', 'sibling', or 'multicast'.
1533
#	
1534
#	proxy-port:	The port number where the peer accept HTTP requests.
1535
#			For other Squid proxies this is usually 3128
1536
#			For web servers this is usually 80
1537
#	
1538
#	  icp-port:	Used for querying neighbor caches about objects.
1539
#			Set to 0 if the peer does not support ICP or HTCP.
1540
#			See ICP and HTCP options below for additional details.
1541
#	
1542
#	
1543
#	==== ICP OPTIONS ====
1544
#	
1545
#	You MUST also set icp_port and icp_access explicitly when using these options.
1546
#	The defaults will prevent peer traffic using ICP.
1547
#	
1548
#	
1549
#	no-query	Disable ICP queries to this neighbor.
1550
#	
1551
#	multicast-responder
1552
#			Indicates the named peer is a member of a multicast group.
1553
#			ICP queries will not be sent directly to the peer, but ICP
1554
#			replies will be accepted from it.
1555
#	
1556
#	closest-only	Indicates that, for ICP_OP_MISS replies, we'll only forward
1557
#			CLOSEST_PARENT_MISSes and never FIRST_PARENT_MISSes.
1558
#	
1559
#	background-ping
1560
#			To only send ICP queries to this neighbor infrequently.
1561
#			This is used to keep the neighbor round trip time updated
1562
#			and is usually used in conjunction with weighted-round-robin.
1563
#	
1564
#	
1565
#	==== HTCP OPTIONS ====
1566
#	
1567
#	You MUST also set htcp_port and htcp_access explicitly when using these options.
1568
#	The defaults will prevent peer traffic using HTCP.
1569
#	
1570
#	
1571
#	htcp		Send HTCP, instead of ICP, queries to the neighbor.
1572
#			You probably also want to set the "icp-port" to 4827
1573
#			instead of 3130.
1574
#	
1575
#	htcp-oldsquid	Send HTCP to old Squid versions.
1576
#	
1577
#	htcp-no-clr	Send HTCP to the neighbor but without
1578
#			sending any CLR requests.  This cannot be used with
1579
#			htcp-only-clr.
1580
#	
1581
#	htcp-only-clr	Send HTCP to the neighbor but ONLY CLR requests.
1582
#			This cannot be used with htcp-no-clr.
1583
#	
1584
#	htcp-no-purge-clr
1585
#			Send HTCP to the neighbor including CLRs but only when
1586
#			they do not result from PURGE requests.
1587
#	
1588
#	htcp-forward-clr
1589
#			Forward any HTCP CLR requests this proxy receives to the peer.
1590
#	
1591
#	
1592
#	==== PEER SELECTION METHODS ====
1593
#	
1594
#	The default peer selection method is ICP, with the first responding peer
1595
#	being used as source. These options can be used for better load balancing.
1596
#	
1597
#	
1598
#	default		This is a parent cache which can be used as a "last-resort"
1599
#			if a peer cannot be located by any of the peer-selection methods.
1600
#			If specified more than once, only the first is used.
1601
#	
1602
#	round-robin	Load-Balance parents which should be used in a round-robin
1603
#			fashion in the absence of any ICP queries.
1604
#			weight=N can be used to add bias.
1605
#	
1606
#	weighted-round-robin
1607
#			Load-Balance parents which should be used in a round-robin
1608
#			fashion with the frequency of each parent being based on the
1609
#			round trip time. Closer parents are used more often.
1610
#			Usually used for background-ping parents.
1611
#			weight=N can be used to add bias.
1612
#	
1613
#	carp		Load-Balance parents which should be used as a CARP array.
1614
#			The requests will be distributed among the parents based on the
1615
#			CARP load balancing hash function based on their weight.
1616
#	
1617
#	userhash	Load-balance parents based on the client proxy_auth or ident username.
1618
#	
1619
#	sourcehash	Load-balance parents based on the client source IP.
1620
#
1621
#	multicast-siblings
1622
#			To be used only for cache peers of type "multicast".
1623
#			ALL members of this multicast group have "sibling"
1624
#			relationship with it, not "parent".  This is to a mulicast
1625
#			group when the requested object would be fetched only from
1626
#			a "parent" cache, anyway.  It's useful, e.g., when
1627
#			configuring a pool of redundant Squid proxies, being
1628
#			members of the same multicast group.
1629
#	
1630
#	
1631
#	==== PEER SELECTION OPTIONS ====
1632
#	
1633
#	weight=N	use to affect the selection of a peer during any weighted
1634
#			peer-selection mechanisms.
1635
#			The weight must be an integer; default is 1,
1636
#			larger weights are favored more.
1637
#			This option does not affect parent selection if a peering
1638
#			protocol is not in use.
1639
#	
1640
#	basetime=N	Specify a base amount to be subtracted from round trip
1641
#			times of parents.
1642
#			It is subtracted before division by weight in calculating
1643
#			which parent to fectch from. If the rtt is less than the
1644
#			base time the rtt is set to a minimal value.
1645
#	
1646
#	ttl=N		Specify a IP multicast TTL to use when sending an ICP
1647
#			queries to this address.
1648
#			Only useful when sending to a multicast group.
1649
#			Because we don't accept ICP replies from random
1650
#			hosts, you must configure other group members as
1651
#			peers with the 'multicast-responder' option.
1652
#	
1653
#	no-delay	To prevent access to this neighbor from influencing the
1654
#			delay pools.
1655
#	
1656
#	digest-url=URL	Tell Squid to fetch the cache digest (if digests are
1657
#			enabled) for this host from the specified URL rather
1658
#			than the Squid default location.
1659
#	
1660
#	
1661
#	==== ACCELERATOR / REVERSE-PROXY OPTIONS ====
1662
#	
1663
#	originserver	Causes this parent to be contacted as an origin server.
1664
#			Meant to be used in accelerator setups when the peer
1665
#			is a web server.
1666
#	
1667
#	forceddomain=name
1668
#			Set the Host header of requests forwarded to this peer.
1669
#			Useful in accelerator setups where the server (peer)
1670
#			expects a certain domain name but clients may request
1671
#			others. ie example.com or www.example.com
1672
#	
1673
#	no-digest	Disable request of cache digests.
1674
#	
1675
#	no-netdb-exchange
1676
#			Disables requesting ICMP RTT database (NetDB).
1677
#	
1678
#	
1679
#	==== AUTHENTICATION OPTIONS ====
1680
#	
1681
#	login=user:password
1682
#			If this is a personal/workgroup proxy and your parent
1683
#			requires proxy authentication.
1684
#			
1685
#			Note: The string can include URL escapes (i.e. %20 for
1686
#			spaces). This also means % must be written as %%.
1687
#	
1688
#	login=PROXYPASS
1689
#			Send login details received from client to this peer.
1690
#			Authentication is not required, nor changed.
1691
#			
1692
#			Note: This will pass any form of authentication but
1693
#			only Basic auth will work through a proxy unless the
1694
#			connection-auth options are also used.
1695
#	
1696
#	login=PASS	Send login details received from client to this peer.
1697
#			Authentication is not required by this option.
1698
#			If there are no client-provided authentication headers
1699
#			to pass on, but username and password are available
1700
#			from either proxy login or an external ACL user= and
1701
#			password= result tags they may be sent instead.
1702
#			
1703
#			Note: To combine this with proxy_auth both proxies must
1704
#			share the same user database as HTTP only allows for
1705
#			a single login (one for proxy, one for origin server).
1706
#			Also be warned this will expose your users proxy
1707
#			password to the peer. USE WITH CAUTION
1708
#	
1709
#	login=*:password
1710
#			Send the username to the upstream cache, but with a
1711
#			fixed password. This is meant to be used when the peer
1712
#			is in another administrative domain, but it is still
1713
#			needed to identify each user.
1714
#			The star can optionally be followed by some extra
1715
#			information which is added to the username. This can
1716
#			be used to identify this proxy to the peer, similar to
1717
#			the login=username:password option above.
1718
#	
1719
#	connection-auth=on|off
1720
#			Tell Squid that this peer does or not support Microsoft
1721
#			connection oriented authentication, and any such
1722
#			challenges received from there should be ignored.
1723
#			Default is auto to automatically determine the status
1724
#			of the peer.
1725
#	
1726
#	
1727
#	==== SSL / HTTPS / TLS OPTIONS ====
1728
#	
1729
#	ssl		Encrypt connections to this peer with SSL/TLS.
1730
#	
1731
#	sslcert=/path/to/ssl/certificate
1732
#			A client SSL certificate to use when connecting to
1733
#			this peer.
1734
#	
1735
#	sslkey=/path/to/ssl/key
1736
#			The private SSL key corresponding to sslcert above.
1737
#			If 'sslkey' is not specified 'sslcert' is assumed to
1738
#			reference a combined file containing both the
1739
#			certificate and the key.
1740
#	
1741
#	sslversion=1|2|3|4
1742
#			The SSL version to use when connecting to this peer
1743
#				1 = automatic (default)
1744
#				2 = SSL v2 only
1745
#				3 = SSL v3 only
1746
#				4 = TLS v1 only
1747
#	
1748
#	sslcipher=...	The list of valid SSL ciphers to use when connecting
1749
#			to this peer.
1750
#	
1751
#	ssloptions=... 	Specify various SSL engine options:
1752
#				NO_SSLv2  Disallow the use of SSLv2
1753
#				NO_SSLv3  Disallow the use of SSLv3
1754
#				NO_TLSv1  Disallow the use of TLSv1
1755
#			See src/ssl_support.c or the OpenSSL documentation for
1756
#			a more complete list.
1757
#	
1758
#	sslcafile=... 	A file containing additional CA certificates to use
1759
#			when verifying the peer certificate.
1760
#	
1761
#	sslcapath=...	A directory containing additional CA certificates to
1762
#			use when verifying the peer certificate.
1763
#	
1764
#	sslcrlfile=... 	A certificate revocation list file to use when
1765
#			verifying the peer certificate.
1766
#	
1767
#	sslflags=...	Specify various flags modifying the SSL implementation:
1768
#	
1769
#			DONT_VERIFY_PEER
1770
#				Accept certificates even if they fail to
1771
#				verify.
1772
#			NO_DEFAULT_CA
1773
#				Don't use the default CA list built in
1774
#				to OpenSSL.
1775
#			DONT_VERIFY_DOMAIN
1776
#				Don't verify the peer certificate
1777
#				matches the server name
1778
#	
1779
#	ssldomain= 	The peer name as advertised in it's certificate.
1780
#			Used for verifying the correctness of the received peer
1781
#			certificate. If not specified the peer hostname will be
1782
#			used.
1783
#	
1784
#	front-end-https
1785
#			Enable the "Front-End-Https: On" header needed when
1786
#			using Squid as a SSL frontend in front of Microsoft OWA.
1787
#			See MS KB document Q307347 for details on this header.
1788
#			If set to auto the header will only be added if the
1789
#			request is forwarded as a https:// URL.
1790
#	
1791
#	
1792
#	==== GENERAL OPTIONS ====
1793
#	
1794
#	connect-timeout=N
1795
#			A peer-specific connect timeout.
1796
#			Also see the peer_connect_timeout directive.
1797
#	
1798
#	connect-fail-limit=N
1799
#			How many times connecting to a peer must fail before
1800
#			it is marked as down. Default is 10.
1801
#	
1802
#	allow-miss	Disable Squid's use of only-if-cached when forwarding
1803
#			requests to siblings. This is primarily useful when
1804
#			icp_hit_stale is used by the sibling. To extensive use
1805
#			of this option may result in forwarding loops, and you
1806
#			should avoid having two-way peerings with this option.
1807
#			For example to deny peer usage on requests from peer
1808
#			by denying cache_peer_access if the source is a peer.
1809
#	
1810
#	max-conn=N	Limit the amount of connections Squid may open to this
1811
#			peer. see also 
1812
#	
1813
#	name=xxx	Unique name for the peer.
1814
#			Required if you have multiple peers on the same host
1815
#			but different ports.
1816
#			This name can be used in cache_peer_access and similar
1817
#			directives to dentify the peer.
1818
#			Can be used by outgoing access controls through the
1819
#			peername ACL type.
1820
#	
1821
#	no-tproxy	Do not use the client-spoof TPROXY support when forwarding
1822
#			requests to this peer. Use normal address selection instead.
1823
#	
1824
#	proxy-only	objects fetched from the peer will not be stored locally.
1825
#	
1826
#Default:
1827
# none
1828
1829
#  TAG: cache_peer_domain
1830
#	Use to limit the domains for which a neighbor cache will be
1831
#	queried.  Usage:
1832
#
1833
#	cache_peer_domain cache-host domain [domain ...]
1834
#	cache_peer_domain cache-host !domain
1835
#
1836
#	For example, specifying
1837
#
1838
#		cache_peer_domain parent.foo.net	.edu
1839
#
1840
#	has the effect such that UDP query packets are sent to
1841
#	'bigserver' only when the requested object exists on a
1842
#	server in the .edu domain.  Prefixing the domainname
1843
#	with '!' means the cache will be queried for objects
1844
#	NOT in that domain.
1845
#
1846
#	NOTE:	* Any number of domains may be given for a cache-host,
1847
#		  either on the same or separate lines.
1848
#		* When multiple domains are given for a particular
1849
#		  cache-host, the first matched domain is applied.
1850
#		* Cache hosts with no domain restrictions are queried
1851
#		  for all requests.
1852
#		* There are no defaults.
1853
#		* There is also a 'cache_peer_access' tag in the ACL
1854
#		  section.
1855
#Default:
1856
# none
1857
1858
#  TAG: cache_peer_access
1859
#	Similar to 'cache_peer_domain' but provides more flexibility by
1860
#	using ACL elements.
1861
#
1862
#	cache_peer_access cache-host allow|deny [!]aclname ...
1863
#
1864
#	The syntax is identical to 'http_access' and the other lists of
1865
#	ACL elements.  See the comments for 'http_access' below, or
1866
#	the Squid FAQ (http://wiki.squid-cache.org/SquidFaq/SquidAcl).
1867
#Default:
1868
# none
1869
1870
#  TAG: neighbor_type_domain
1871
#	usage: neighbor_type_domain neighbor parent|sibling domain domain ...
1872
#
1873
#	Modifying the neighbor type for specific domains is now
1874
#	possible.  You can treat some domains differently than the the
1875
#	default neighbor type specified on the 'cache_peer' line.
1876
#	Normally it should only be necessary to list domains which
1877
#	should be treated differently because the default neighbor type
1878
#	applies for hostnames which do not match domains listed here.
1879
#
1880
#EXAMPLE:
1881
#	cache_peer cache.foo.org parent 3128 3130
1882
#	neighbor_type_domain cache.foo.org sibling .com .net
1883
#	neighbor_type_domain cache.foo.org sibling .au .de
1884
#Default:
1885
# none
1886
1887
#  TAG: dead_peer_timeout	(seconds)
1888
#	This controls how long Squid waits to declare a peer cache
1889
#	as "dead."  If there are no ICP replies received in this
1890
#	amount of time, Squid will declare the peer dead and not
1891
#	expect to receive any further ICP replies.  However, it
1892
#	continues to send ICP queries, and will mark the peer as
1893
#	alive upon receipt of the first subsequent ICP reply.
1894
#
1895
#	This timeout also affects when Squid expects to receive ICP
1896
#	replies from peers.  If more than 'dead_peer' seconds have
1897
#	passed since the last ICP reply was received, Squid will not
1898
#	expect to receive an ICP reply on the next query.  Thus, if
1899
#	your time between requests is greater than this timeout, you
1900
#	will see a lot of requests sent DIRECT to origin servers
1901
#	instead of to your parents.
1902
#Default:
1903
# dead_peer_timeout 10 seconds
1904
1905
#  TAG: forward_max_tries
1906
#	Controls how many different forward paths Squid will try
1907
#	before giving up. See also forward_timeout.
1908
#Default:
1909
# forward_max_tries 10
1910
1911
#  TAG: hierarchy_stoplist
1912
#	A list of words which, if found in a URL, cause the object to
1913
#	be handled directly by this cache.  In other words, use this
1914
#	to not query neighbor caches for certain objects.  You may
1915
#	list this option multiple times.
1916
#	Note: never_direct overrides this option.
1917
#
1918
1919
# We recommend you to use at least the following line.
1920
hierarchy_stoplist cgi-bin ?
1921
1922
# MEMORY CACHE OPTIONS
1923
# -----------------------------------------------------------------------------
1924
1925
#  TAG: cache_mem	(bytes)
1926
#	NOTE: THIS PARAMETER DOES NOT SPECIFY THE MAXIMUM PROCESS SIZE.
1927
#	IT ONLY PLACES A LIMIT ON HOW MUCH ADDITIONAL MEMORY SQUID WILL
1928
#	USE AS A MEMORY CACHE OF OBJECTS. SQUID USES MEMORY FOR OTHER
1929
#	THINGS AS WELL. SEE THE SQUID FAQ SECTION 8 FOR DETAILS.
1930
#
1931
#	'cache_mem' specifies the ideal amount of memory to be used
1932
#	for:
1933
#		* In-Transit objects
1934
#		* Hot Objects
1935
#		* Negative-Cached objects
1936
#
1937
#	Data for these objects are stored in 4 KB blocks.  This
1938
#	parameter specifies the ideal upper limit on the total size of
1939
#	4 KB blocks allocated.  In-Transit objects take the highest
1940
#	priority.
1941
#
1942
#	In-transit objects have priority over the others.  When
1943
#	additional space is needed for incoming data, negative-cached
1944
#	and hot objects will be released.  In other words, the
1945
#	negative-cached and hot objects will fill up any unused space
1946
#	not needed for in-transit objects.
1947
#
1948
#	If circumstances require, this limit will be exceeded.
1949
#	Specifically, if your incoming request rate requires more than
1950
#	'cache_mem' of memory to hold in-transit objects, Squid will
1951
#	exceed this limit to satisfy the new requests.  When the load
1952
#	decreases, blocks will be freed until the high-water mark is
1953
#	reached.  Thereafter, blocks will be used to store hot
1954
#	objects.
1955
#Default:
1956
cache_mem 30 MB
1957
1958
#  TAG: maximum_object_size_in_memory	(bytes)
1959
#	Objects greater than this size will not be attempted to kept in
1960
#	the memory cache. This should be set high enough to keep objects
1961
#	accessed frequently in memory to improve performance whilst low
1962
#	enough to keep larger objects from hoarding cache_mem.
1963
#Default:
1964
maximum_object_size_in_memory 100 KB
1965
1966
#  TAG: memory_replacement_policy
1967
#	The memory replacement policy parameter determines which
1968
#	objects are purged from memory when memory space is needed.
1969
#
1970
#	See cache_replacement_policy for details.
1971
#Default:
1972
# memory_replacement_policy lru
1973
1974
# DISK CACHE OPTIONS
1975
# -----------------------------------------------------------------------------
1976
1977
#  TAG: cache_replacement_policy
1978
#	The cache replacement policy parameter determines which
1979
#	objects are evicted (replaced) when disk space is needed.
1980
#
1981
#	    lru       : Squid's original list based LRU policy
1982
#	    heap GDSF : Greedy-Dual Size Frequency
1983
#	    heap LFUDA: Least Frequently Used with Dynamic Aging
1984
#	    heap LRU  : LRU policy implemented using a heap
1985
#
1986
#	Applies to any cache_dir lines listed below this.
1987
#
1988
#	The LRU policies keeps recently referenced objects.
1989
#
1990
#	The heap GDSF policy optimizes object hit rate by keeping smaller
1991
#	popular objects in cache so it has a better chance of getting a
1992
#	hit.  It achieves a lower byte hit rate than LFUDA though since
1993
#	it evicts larger (possibly popular) objects.
1994
#
1995
#	The heap LFUDA policy keeps popular objects in cache regardless of
1996
#	their size and thus optimizes byte hit rate at the expense of
1997
#	hit rate since one large, popular object will prevent many
1998
#	smaller, slightly less popular objects from being cached.
1999
#
2000
#	Both policies utilize a dynamic aging mechanism that prevents
2001
#	cache pollution that can otherwise occur with frequency-based
2002
#	replacement policies.
2003
#
2004
#	NOTE: if using the LFUDA replacement policy you should increase
2005
#	the value of maximum_object_size above its default of 4096 KB to
2006
#	to maximize the potential byte hit rate improvement of LFUDA.
2007
#
2008
#	For more information about the GDSF and LFUDA cache replacement
2009
#	policies see http://www.hpl.hp.com/techreports/1999/HPL-1999-69.html
2010
#	and http://fog.hpl.external.hp.com/techreports/98/HPL-98-173.html.
2011
#Default:
2012
# cache_replacement_policy lru
2013
2014
#  TAG: cache_dir
2015
#	Usage:
2016
#
2017
#	cache_dir Type Directory-Name Fs-specific-data [options]
2018
#
2019
#	You can specify multiple cache_dir lines to spread the
2020
#	cache among different disk partitions.
2021
#
2022
#	Type specifies the kind of storage system to use. Only "ufs"
2023
#	is built by default. To enable any of the other storage systems
2024
#	see the --enable-storeio configure option.
2025
#
2026
#	'Directory' is a top-level directory where cache swap
2027
#	files will be stored.  If you want to use an entire disk
2028
#	for caching, this can be the mount-point directory.
2029
#	The directory must exist and be writable by the Squid
2030
#	process.  Squid will NOT create this directory for you.
2031
#
2032
#	The ufs store type:
2033
#
2034
#	"ufs" is the old well-known Squid storage format that has always
2035
#	been there.
2036
#
2037
#	cache_dir ufs Directory-Name Mbytes L1 L2 [options]
2038
#
2039
#	'Mbytes' is the amount of disk space (MB) to use under this
2040
#	directory.  The default is 100 MB.  Change this to suit your
2041
#	configuration.  Do NOT put the size of your disk drive here.
2042
#	Instead, if you want Squid to use the entire disk drive,
2043
#	subtract 20% and use that value.
2044
#
2045
#	'Level-1' is the number of first-level subdirectories which
2046
#	will be created under the 'Directory'.  The default is 16.
2047
#
2048
#	'Level-2' is the number of second-level subdirectories which
2049
#	will be created under each first-level directory.  The default
2050
#	is 256.
2051
#
2052
#	The aufs store type:
2053
#
2054
#	"aufs" uses the same storage format as "ufs", utilizing
2055
#	POSIX-threads to avoid blocking the main Squid process on
2056
#	disk-I/O. This was formerly known in Squid as async-io.
2057
#
2058
#	cache_dir aufs Directory-Name Mbytes L1 L2 [options]
2059
#
2060
#	see argument descriptions under ufs above
2061
#
2062
#	The diskd store type:
2063
#
2064
#	"diskd" uses the same storage format as "ufs", utilizing a
2065
#	separate process to avoid blocking the main Squid process on
2066
#	disk-I/O.
2067
#
2068
#	cache_dir diskd Directory-Name Mbytes L1 L2 [options] [Q1=n] [Q2=n]
2069
#
2070
#	see argument descriptions under ufs above
2071
#
2072
#	Q1 specifies the number of unacknowledged I/O requests when Squid
2073
#	stops opening new files. If this many messages are in the queues,
2074
#	Squid won't open new files. Default is 64
2075
#
2076
#	Q2 specifies the number of unacknowledged messages when Squid
2077
#	starts blocking.  If this many messages are in the queues,
2078
#	Squid blocks until it receives some replies. Default is 72
2079
#
2080
#	When Q1 < Q2 (the default), the cache directory is optimized
2081
#	for lower response time at the expense of a decrease in hit
2082
#	ratio.  If Q1 > Q2, the cache directory is optimized for
2083
#	higher hit ratio at the expense of an increase in response
2084
#	time.
2085
#
2086
#	The coss store type:
2087
#
2088
#	NP: COSS filesystem in Squid-3 has been deemed too unstable for
2089
#	    production use and has thus been removed from this release.
2090
#	    We hope that it can be made usable again soon.
2091
#
2092
#	block-size=n defines the "block size" for COSS cache_dir's.
2093
#	Squid uses file numbers as block numbers.  Since file numbers
2094
#	are limited to 24 bits, the block size determines the maximum
2095
#	size of the COSS partition.  The default is 512 bytes, which
2096
#	leads to a maximum cache_dir size of 512<<24, or 8 GB.  Note
2097
#	you should not change the coss block size after Squid
2098
#	has written some objects to the cache_dir.
2099
#
2100
#	The coss file store has changed from 2.5. Now it uses a file
2101
#	called 'stripe' in the directory names in the config - and
2102
#	this will be created by squid -z.
2103
#
2104
#	Common options:
2105
#
2106
#	no-store, no new objects should be stored to this cache_dir
2107
#
2108
#	max-size=n, refers to the max object size this storedir supports.
2109
#	It is used to initially choose the storedir to dump the object.
2110
#	Note: To make optimal use of the max-size limits you should order
2111
#	the cache_dir lines with the smallest max-size value first and the
2112
#	ones with no max-size specification last.
2113
#
2114
#	Note for coss, max-size must be less than COSS_MEMBUF_SZ,
2115
#	which can be changed with the --with-coss-membuf-size=N configure
2116
#	option.
2117
#
2118
2119
# Uncomment and adjust the following to add a disk cache directory.
2120
cache_dir ufs /var/spool/squid3 2000 16 256
2121
2122
#  TAG: store_dir_select_algorithm
2123
#	Set this to 'round-robin' as an alternative.
2124
#Default:
2125
# store_dir_select_algorithm least-load
2126
2127
#  TAG: max_open_disk_fds
2128
#	To avoid having disk as the I/O bottleneck Squid can optionally
2129
#	bypass the on-disk cache if more than this amount of disk file
2130
#	descriptors are open.
2131
#
2132
#	A value of 0 indicates no limit.
2133
#Default:
2134
# max_open_disk_fds 0
2135
2136
#  TAG: minimum_object_size	(bytes)
2137
#	Objects smaller than this size will NOT be saved on disk.  The
2138
#	value is specified in kilobytes, and the default is 0 KB, which
2139
#	means there is no minimum.
2140
#Default:
2141
# minimum_object_size 0 KB
2142
2143
#  TAG: maximum_object_size	(bytes)
2144
#	Objects larger than this size will NOT be saved on disk.  The
2145
#	value is specified in kilobytes, and the default is 4MB.  If
2146
#	you wish to get a high BYTES hit ratio, you should probably
2147
#	increase this (one 32 MB object hit counts for 3200 10KB
2148
#	hits).  If you wish to increase speed more than your want to
2149
#	save bandwidth you should leave this low.
2150
#
2151
#	NOTE: if using the LFUDA replacement policy you should increase
2152
#	this value to maximize the byte hit rate improvement of LFUDA!
2153
#	See replacement_policy below for a discussion of this policy.
2154
#Default:
2155
# maximum_object_size 4096 KB
2156
2157
#  TAG: cache_swap_low	(percent, 0-100)
2158
#  TAG: cache_swap_high	(percent, 0-100)
2159
#
2160
#	The low- and high-water marks for cache object replacement.
2161
#	Replacement begins when the swap (disk) usage is above the
2162
#	low-water mark and attempts to maintain utilization near the
2163
#	low-water mark.  As swap utilization gets close to high-water
2164
#	mark object eviction becomes more aggressive.  If utilization is
2165
#	close to the low-water mark less replacement is done each time.
2166
#
2167
#	Defaults are 90% and 95%. If you have a large cache, 5% could be
2168
#	hundreds of MB. If this is the case you may wish to set these
2169
#	numbers closer together.
2170
#Default:
2171
# cache_swap_low 90
2172
# cache_swap_high 95
2173
2174
# LOGFILE OPTIONS
2175
# -----------------------------------------------------------------------------
2176
2177
#  TAG: logformat
2178
#	Usage:
2179
#
2180
#	logformat <name> <format specification>
2181
#
2182
#	Defines an access log format.
2183
#
2184
#	The <format specification> is a string with embedded % format codes
2185
#
2186
#	% format codes all follow the same basic structure where all but
2187
#	the formatcode is optional. Output strings are automatically escaped
2188
#	as required according to their context and the output format
2189
#	modifiers are usually not needed, but can be specified if an explicit
2190
#	output format is desired.
2191
#
2192
#		% ["|[|'|#] [-] [[0]width] [{argument}] formatcode
2193
#
2194
#		"	output in quoted string format
2195
#		[	output in squid text log format as used by log_mime_hdrs
2196
#		#	output in URL quoted format
2197
#		'	output as-is
2198
#
2199
#		-	left aligned
2200
#		width	field width. If starting with 0 the
2201
#			output is zero padded
2202
#		{arg}	argument such as header name etc
2203
#
2204
#	Format codes:
2205
#
2206
#		%	a literal % character
2207
#		>a	Client source IP address
2208
#		>A	Client FQDN
2209
#		>p	Client source port
2210
#		<A	Server IP address or peer name
2211
#		la	Local IP address (http_port)
2212
#		lp	Local port number (http_port)
2213
#		ts	Seconds since epoch
2214
#		tu	subsecond time (milliseconds)
2215
#		tl	Local time. Optional strftime format argument
2216
#				default %d/%b/%Y:%H:%M:%S %z
2217
#		tg	GMT time. Optional strftime format argument
2218
#				default %d/%b/%Y:%H:%M:%S %z
2219
#		tr	Response time (milliseconds)
2220
#		dt	Total time spent making DNS lookups (milliseconds)
2221
#
2222
#	HTTP cache related format codes:
2223
#
2224
#		[http::]>h	Original request header. Optional header name argument
2225
#				on the format header[:[separator]element]
2226
#		[http::]>ha	The HTTP request headers after adaptation and redirection. 
2227
#				Optional header name argument as for >h
2228
#		[http::]<h	Reply header. Optional header name argument
2229
#				as for >h
2230
#		[http::]un	User name
2231
#		[http::]ul	User name from authentication
2232
#		[http::]ui	User name from ident
2233
#		[http::]us	User name from SSL
2234
#		[http::]ue	User name from external acl helper
2235
#		[http::]>Hs	HTTP status code sent to the client
2236
#		[http::]<Hs	HTTP status code received from the next hop
2237
#		[http::]Ss	Squid request status (TCP_MISS etc)
2238
#		[http::]Sh	Squid hierarchy status (DEFAULT_PARENT etc)
2239
#		[http::]mt	MIME content type
2240
#		[http::]rm	Request method (GET/POST etc)
2241
#		[http::]ru	Request URL
2242
#		[http::]rp	Request URL-Path excluding hostname
2243
#		[http::]rv	Request protocol version
2244
#		[http::]et	Tag returned by external acl
2245
#		[http::]ea	Log string returned by external acl
2246
#		[http::]<st	Sent reply size including HTTP headers
2247
#		[http::]>st	Received request size including HTTP headers. In the
2248
#				case of chunked requests the chunked encoding metadata
2249
#				are not included
2250
#		[http::]>sh	Received HTTP request headers size
2251
#		[http::]<sh	Sent HTTP reply headers size
2252
#		[http::]st	Request+Reply size including HTTP headers
2253
#		[http::]<sH	Reply high offset sent
2254
#		[http::]<sS	Upstream object size
2255
#		[http::]<pt	Peer response time in milliseconds. The timer starts
2256
#				when the last request byte is sent to the next hop
2257
#				and stops when the last response byte is received.
2258
#		[http::]<tt	Total server-side time in milliseconds. The timer 
2259
#				starts with the first connect request (or write I/O)
2260
#				sent to the first selected peer. The timer stops
2261
#				with the last I/O with the last peer.
2262
#
2263
#	If ICAP is enabled, the following two codes become available (as
2264
#	well as ICAP log codes documented with the icap_log option):
2265
#
2266
#		icap::tt        Total ICAP processing time for the HTTP
2267
#				transaction. The timer ticks when ICAP
2268
#				ACLs are checked and when ICAP
2269
#				transaction is in progress.
2270
#
2271
#		icap::<last_h	The header of the last ICAP response
2272
#				related to the HTTP transaction. Like
2273
#				<h, accepts an optional header name
2274
#				argument.  Will not change semantics
2275
#				when multiple ICAP transactions per HTTP
2276
#				transaction are supported.
2277
#
2278
#	If adaptation is enabled the following two codes become available:
2279
#
2280
#		adapt::sum_trs Summed adaptation transaction response
2281
#				times recorded as a comma-separated list in
2282
#				the order of transaction start time. Each time
2283
#				value is recorded as an integer number,
2284
#				representing response time of one or more
2285
#				adaptation (ICAP or eCAP) transaction in
2286
#				milliseconds.  When a failed transaction is
2287
#				being retried or repeated, its time is not
2288
#				logged individually but added to the
2289
#				replacement (next) transaction. See also:
2290
#				adapt::all_trs.
2291
#
2292
#		adapt::all_trs All adaptation transaction response times.
2293
#				Same as adaptation_strs but response times of
2294
#				individual transactions are never added
2295
#				together. Instead, all transaction response
2296
#				times are recorded individually.
2297
#
2298
#	You can prefix adapt::*_trs format codes with adaptation
2299
#	service name in curly braces to record response time(s) specific
2300
#	to that service. For example: %{my_service}adapt::sum_trs
2301
#
2302
#	The default formats available (which do not need re-defining) are:
2303
#
2304
#logformat squid %ts.%03tu %6tr %>a %Ss/%03>Hs %<st %rm %ru %un %Sh/%<A %mt
2305
#logformat squidmime %ts.%03tu %6tr %>a %Ss/%03>Hs %<st %rm %ru %un %Sh/%<A %mt [%>h] [%<h]
2306
#logformat common %>a %ui %un [%tl] "%rm %ru HTTP/%rv" %>Hs %<st %Ss:%Sh
2307
#logformat combined %>a %ui %un [%tl] "%rm %ru HTTP/%rv" %>Hs %<st "%{Referer}>h" "%{User-Agent}>h" %Ss:%Sh
2308
#Default:
2309
# none
2310
2311
#  TAG: access_log
2312
#	These files log client request activities. Has a line every HTTP or
2313
#	ICP request. The format is:
2314
#	access_log <filepath> [<logformat name> [acl acl ...]]
2315
#	access_log none [acl acl ...]]
2316
#
2317
#	Will log to the specified file using the specified format (which
2318
#	must be defined in a logformat directive) those entries which match
2319
#	ALL the acl's specified (which must be defined in acl clauses).
2320
#	If no acl is specified, all requests will be logged to this file.
2321
#
2322
#	To disable logging of a request use the filepath "none", in which case
2323
#	a logformat name should not be specified.
2324
#
2325
#	To log the request via syslog specify a filepath of "syslog":
2326
#
2327
#	access_log syslog[:facility.priority] [format [acl1 [acl2 ....]]]
2328
#	where facility could be any of:
2329
#	authpriv, daemon, local0 .. local7 or user.
2330
#
2331
#	And priority could be any of:
2332
#	err, warning, notice, info, debug.
2333
#
2334
#	Default:
2335
#		access_log /var/log/squid3/access.log squid
2336
#Default:
2337
# access_log /var/log/squid3/access.log squid
2338
2339
#  TAG: icap_log
2340
#	ICAP log files record ICAP transaction summaries, one line per
2341
#	transaction.
2342
#
2343
#	The icap_log option format is:
2344
#	icap_log <filepath> [<logformat name> [acl acl ...]]
2345
#	icap_log none [acl acl ...]]
2346
#	
2347
#	Please see access_log option documentation for details. The two
2348
#	kinds of logs share the overall configuration approach and many
2349
#	features.
2350
#
2351
#	ICAP processing of a single HTTP message or transaction may
2352
#	require multiple ICAP transactions.  In such cases, multiple
2353
#	ICAP transaction log lines will correspond to a single access
2354
#	log line.
2355
#
2356
#	ICAP log uses logformat codes that make sense for an ICAP
2357
#	transaction. Header-related codes are applied to the HTTP header
2358
#	embedded in an ICAP server response, with the following caveats:
2359
#	For REQMOD, there is no HTTP response header unless the ICAP
2360
#	server performed request satisfaction. For RESPMOD, the HTTP
2361
#	request header is the header sent to the ICAP server. For
2362
#	OPTIONS, there are no HTTP headers.
2363
#
2364
#	The following format codes are also available for ICAP logs:
2365
#
2366
#		icap::<A	ICAP server IP address. Similar to <A.
2367
#
2368
#		icap::<service_name	ICAP service name from the icap_service
2369
#				option in Squid configuration file.
2370
#
2371
#		icap::ru	ICAP Request-URI. Similar to ru.
2372
#
2373
#		icap::rm	ICAP request method (REQMOD, RESPMOD, or 
2374
#				OPTIONS). Similar to existing rm.
2375
#
2376
#		icap::>st	Bytes sent to the ICAP server (TCP payload
2377
#				only; i.e., what Squid writes to the socket).
2378
#
2379
#		icap::<st	Bytes received from the ICAP server (TCP
2380
#				payload only; i.e., what Squid reads from
2381
#				the socket).
2382
#
2383
#		icap::tr 	Transaction response time (in
2384
#				milliseconds).  The timer starts when
2385
#				the ICAP transaction is created and
2386
#				stops when the transaction is completed.
2387
#				Similar to tr.
2388
#
2389
#		icap::tio	Transaction I/O time (in milliseconds). The
2390
#				timer starts when the first ICAP request
2391
#				byte is scheduled for sending. The timers
2392
#				stops when the last byte of the ICAP response
2393
#				is received.
2394
#
2395
#		icap::to 	Transaction outcome: ICAP_ERR* for all
2396
#				transaction errors, ICAP_OPT for OPTION
2397
#				transactions, ICAP_ECHO for 204
2398
#				responses, ICAP_MOD for message
2399
#				modification, and ICAP_SAT for request
2400
#				satisfaction. Similar to Ss.
2401
#
2402
#		icap::Hs	ICAP response status code. Similar to Hs.
2403
#
2404
#		icap::>h	ICAP request header(s). Similar to >h.
2405
#
2406
#		icap::<h	ICAP response header(s). Similar to <h.
2407
#
2408
#	The default ICAP log format, which can be used without an explicit
2409
#	definition, is called icap_squid:
2410
#
2411
#logformat icap_squid %ts.%03tu %6icap::tr %>a %icap::to/%03icap::Hs %icap::<size %icap::rm %icap::ru% %un -/%icap::<A -
2412
#
2413
#	See also: logformat, log_icap, and %icap::<last_h 
2414
#Default:
2415
# none
2416
2417
#  TAG: log_access	allow|deny acl acl...
2418
#	This options allows you to control which requests gets logged
2419
#	to access.log (see access_log directive). Requests denied for
2420
#	logging will also not be accounted for in performance counters.
2421
#
2422
#	This clause only supports fast acl types.
2423
#	See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
2424
#Default:
2425
# none
2426
2427
#  TAG: log_icap
2428
#	This options allows you to control which requests get logged
2429
#	to icap.log. See the icap_log directive for ICAP log details.
2430
#Default:
2431
# none
2432
2433
#  TAG: cache_store_log
2434
#	Logs the activities of the storage manager.  Shows which
2435
#	objects are ejected from the cache, and which objects are
2436
#	saved and for how long.  To disable, enter "none" or remove the line.
2437
#	There are not really utilities to analyze this data, so you can safely
2438
#	disable it.
2439
#
2440
#	Example:
2441
#		cache_store_log /var/log/squid3/store.log
2442
#Default:
2443
# none
2444
2445
#  TAG: cache_swap_state
2446
#	Location for the cache "swap.state" file. This index file holds
2447
#	the metadata of objects saved on disk.  It is used to rebuild
2448
#	the cache during startup.  Normally this file resides in each
2449
#	'cache_dir' directory, but you may specify an alternate
2450
#	pathname here.  Note you must give a full filename, not just
2451
#	a directory. Since this is the index for the whole object
2452
#	list you CANNOT periodically rotate it!
2453
#
2454
#	If %s can be used in the file name it will be replaced with a
2455
#	a representation of the cache_dir name where each / is replaced
2456
#	with '.'. This is needed to allow adding/removing cache_dir
2457
#	lines when cache_swap_log is being used.
2458
#
2459
#	If have more than one 'cache_dir', and %s is not used in the name
2460
#	these swap logs will have names such as:
2461
#
2462
#		cache_swap_log.00
2463
#		cache_swap_log.01
2464
#		cache_swap_log.02
2465
#
2466
#	The numbered extension (which is added automatically)
2467
#	corresponds to the order of the 'cache_dir' lines in this
2468
#	configuration file.  If you change the order of the 'cache_dir'
2469
#	lines in this file, these index files will NOT correspond to
2470
#	the correct 'cache_dir' entry (unless you manually rename
2471
#	them).  We recommend you do NOT use this option.  It is
2472
#	better to keep these index files in each 'cache_dir' directory.
2473
#Default:
2474
# none
2475
2476
#  TAG: logfile_rotate
2477
#	Specifies the number of logfile rotations to make when you
2478
#	type 'squid -k rotate'. The default is 10, which will rotate
2479
#	with extensions 0 through 9. Setting logfile_rotate to 0 will
2480
#	disable the file name rotation, but the logfiles are still closed
2481
#	and re-opened. This will enable you to rename the logfiles
2482
#	yourself just before sending the rotate signal.
2483
#
2484
#	Note, the 'squid -k rotate' command normally sends a USR1
2485
#	signal to the running squid process.  In certain situations
2486
#	(e.g. on Linux with Async I/O), USR1 is used for other
2487
#	purposes, so -k rotate uses another signal.  It is best to get
2488
#	in the habit of using 'squid -k rotate' instead of 'kill -USR1
2489
#	<pid>'.
2490
#
2491
#	Note, from Squid-3.1 this option has no effect on the cache.log,
2492
#	that log can be rotated separately by using debug_options
2493
#
2494
# 	Note2, for Debian/Linux the default of logfile_rotate is
2495
# 	zero, since it includes external logfile-rotation methods.
2496
#Default:
2497
# logfile_rotate 0
2498
2499
#  TAG: emulate_httpd_log	on|off
2500
#	The Cache can emulate the log file format which many 'httpd'
2501
#	programs use.  To disable/enable this emulation, set
2502
#	emulate_httpd_log to 'off' or 'on'.  The default
2503
#	is to use the native log format since it includes useful
2504
#	information Squid-specific log analyzers use.
2505
#Default:
2506
# emulate_httpd_log off
2507
2508
#  TAG: log_ip_on_direct	on|off
2509
#	Log the destination IP address in the hierarchy log tag when going
2510
#	direct. Earlier Squid versions logged the hostname here. If you
2511
#	prefer the old way set this to off.
2512
#Default:
2513
# log_ip_on_direct on
2514
2515
#  TAG: mime_table
2516
#	Pathname to Squid's MIME table. You shouldn't need to change
2517
#	this, but the default file contains examples and formatting
2518
#	information if you do.
2519
#Default:
2520
# mime_table /usr/share/squid3/mime.conf
2521
2522
#  TAG: log_mime_hdrs	on|off
2523
#	The Cache can record both the request and the response MIME
2524
#	headers for each HTTP transaction.  The headers are encoded
2525
#	safely and will appear as two bracketed fields at the end of
2526
#	the access log (for either the native or httpd-emulated log
2527
#	formats).  To enable this logging set log_mime_hdrs to 'on'.
2528
#Default:
2529
# log_mime_hdrs off
2530
2531
#  TAG: useragent_log
2532
# Note: This option is only available if Squid is rebuilt with the
2533
#       --enable-useragent-log option
2534
#
2535
#	Squid will write the User-Agent field from HTTP requests
2536
#	to the filename specified here.  By default useragent_log
2537
#	is disabled.
2538
#Default:
2539
# none
2540
2541
#  TAG: referer_log
2542
# Note: This option is only available if Squid is rebuilt with the
2543
#       --enable-referer-log option
2544
#
2545
#	Squid will write the Referer field from HTTP requests to the
2546
#	filename specified here.  By default referer_log is disabled.
2547
#	Note that "referer" is actually a misspelling of "referrer"
2548
#	however the misspelt version has been accepted into the HTTP RFCs
2549
#	and we accept both.
2550
#Default:
2551
# none
2552
2553
#  TAG: pid_filename
2554
#	A filename to write the process-id to.  To disable, enter "none".
2555
#Default:
2556
# pid_filename /var/run/squid3.pid
2557
2558
#  TAG: log_fqdn	on|off
2559
#	Turn this on if you wish to log fully qualified domain names
2560
#	in the access.log. To do this Squid does a DNS lookup of all
2561
#	IP's connecting to it. This can (in some situations) increase
2562
#	latency, which makes your cache seem slower for interactive
2563
#	browsing.
2564
#Default:
2565
# log_fqdn off
2566
2567
#  TAG: client_netmask
2568
#	A netmask for client addresses in logfiles and cachemgr output.
2569
#	Change this to protect the privacy of your cache clients.
2570
#	A netmask of 255.255.255.0 will log all IP's in that range with
2571
#	the last digit set to '0'.
2572
#Default:
2573
# client_netmask no_addr
2574
2575
#  TAG: forward_log
2576
# Note: This option is only available if Squid is rebuilt with the
2577
#       -DWIP_FWD_LOG define
2578
#
2579
#	Logs the server-side requests.
2580
#
2581
#	This is currently work in progress.
2582
#Default:
2583
# none
2584
2585
#  TAG: strip_query_terms
2586
#	By default, Squid strips query terms from requested URLs before
2587
#	logging.  This protects your user's privacy.
2588
#Default:
2589
# strip_query_terms on
2590
2591
#  TAG: buffered_logs	on|off
2592
#	cache.log log file is written with stdio functions, and as such
2593
#	it can be buffered or unbuffered. By default it will be unbuffered.
2594
#	Buffering it can speed up the writing slightly (though you are
2595
#	unlikely to need to worry unless you run with tons of debugging
2596
#	enabled in which case performance will suffer badly anyway..).
2597
#Default:
2598
# buffered_logs off
2599
2600
#  TAG: netdb_filename
2601
# Note: This option is only available if Squid is rebuilt with the
2602
#       --enable-icmp option
2603
#
2604
#	A filename where Squid stores it's netdb state between restarts.
2605
#	To disable, enter "none".
2606
#Default:
2607
# netdb_filename /var/log/squid3/netdb.state
2608
2609
# OPTIONS FOR TROUBLESHOOTING
2610
# -----------------------------------------------------------------------------
2611
2612
#  TAG: cache_log
2613
#	Cache logging file. This is where general information about
2614
#	your cache's behavior goes. You can increase the amount of data
2615
#	logged to this file and how often its rotated with "debug_options"
2616
#Default:
2617
# cache_log /var/log/squid3/cache.log
2618
2619
#  TAG: debug_options
2620
#	Logging options are set as section,level where each source file
2621
#	is assigned a unique section.  Lower levels result in less
2622
#	output,  Full debugging (level 9) can result in a very large
2623
#	log file, so be careful.
2624
#
2625
#	The magic word "ALL" sets debugging levels for all sections.
2626
#	We recommend normally running with "ALL,1".
2627
#
2628
#	The rotate=N option can be used to keep more or less of these logs
2629
#	than would otherwise be kept by logfile_rotate.
2630
#	For most uses a single log should be enough to monitor current
2631
#	events affecting Squid.
2632
#Default:
2633
# debug_options ALL,1
2634
2635
#  TAG: coredump_dir
2636
#	By default Squid leaves core files in the directory from where
2637
#	it was started. If you set 'coredump_dir' to a directory
2638
#	that exists, Squid will chdir() to that directory at startup
2639
#	and coredump files will be left there.
2640
#
2641
#Default:
2642
# coredump_dir none
2643
#
2644
2645
# Leave coredumps in the first cache dir
2646
coredump_dir /var/spool/squid3
2647
2648
# OPTIONS FOR FTP GATEWAYING
2649
# -----------------------------------------------------------------------------
2650
2651
#  TAG: ftp_user
2652
#	If you want the anonymous login password to be more informative
2653
#	(and enable the use of picky ftp servers), set this to something
2654
#	reasonable for your domain, like wwwuser@somewhere.net
2655
#
2656
#	The reason why this is domainless by default is the
2657
#	request can be made on the behalf of a user in any domain,
2658
#	depending on how the cache is used.
2659
#	Some ftp server also validate the email address is valid
2660
#	(for example perl.com).
2661
#Default:
2662
# ftp_user Squid@
2663
2664
#  TAG: ftp_list_width
2665
#	Sets the width of ftp listings. This should be set to fit in
2666
#	the width of a standard browser. Setting this too small
2667
#	can cut off long filenames when browsing ftp sites.
2668
#Default:
2669
# ftp_list_width 32
2670
2671
#  TAG: ftp_passive
2672
#	If your firewall does not allow Squid to use passive
2673
#	connections, turn off this option.
2674
#
2675
#	Use of ftp_epsv_all option requires this to be ON.
2676
#Default:
2677
# ftp_passive on
2678
2679
#  TAG: ftp_epsv_all
2680
#	FTP Protocol extensions permit the use of a special "EPSV ALL" command.
2681
#
2682
#	NATs may be able to put the connection on a "fast path" through the
2683
#	translator, as the EPRT command will never be used and therefore,
2684
#	translation of the data portion of the segments will never be needed.
2685
#
2686
#	When a client only expects to do two-way FTP transfers this may be
2687
#	useful.
2688
#	If squid finds that it must do a three-way FTP transfer after issuing
2689
#	an EPSV ALL command, the FTP session will fail.
2690
#
2691
#	If you have any doubts about this option do not use it.
2692
#	Squid will nicely attempt all other connection methods.
2693
#
2694
#	Requires ftp_passive to be ON (default) for any effect.
2695
#Default:
2696
# ftp_epsv_all off
2697
2698
#  TAG: ftp_epsv
2699
#	FTP Protocol extensions permit the use of a special "EPSV" command.
2700
#
2701
#	NATs may be able to put the connection on a "fast path" through the
2702
#	translator using EPSV, as the EPRT command will never be used
2703
#	and therefore, translation of the data portion of the segments 
2704
#	will never be needed.
2705
#
2706
#	Turning this OFF will prevent EPSV being attempted.
2707
#	WARNING: Doing so will convert Squid back to the old behavior with all
2708
#	the related problems with external NAT devices/layers.
2709
#
2710
#	Requires ftp_passive to be ON (default) for any effect.
2711
#Default:
2712
# ftp_epsv on
2713
2714
#  TAG: ftp_sanitycheck
2715
#	For security and data integrity reasons Squid by default performs
2716
#	sanity checks of the addresses of FTP data connections ensure the
2717
#	data connection is to the requested server. If you need to allow
2718
#	FTP connections to servers using another IP address for the data
2719
#	connection turn this off.
2720
#Default:
2721
# ftp_sanitycheck on
2722
2723
#  TAG: ftp_telnet_protocol
2724
#	The FTP protocol is officially defined to use the telnet protocol
2725
#	as transport channel for the control connection. However, many
2726
#	implementations are broken and does not respect this aspect of
2727
#	the FTP protocol.
2728
#
2729
#	If you have trouble accessing files with ASCII code 255 in the
2730
#	path or similar problems involving this ASCII code you can
2731
#	try setting this directive to off. If that helps, report to the
2732
#	operator of the FTP server in question that their FTP server
2733
#	is broken and does not follow the FTP standard.
2734
#Default:
2735
# ftp_telnet_protocol on
2736
2737
# OPTIONS FOR EXTERNAL SUPPORT PROGRAMS
2738
# -----------------------------------------------------------------------------
2739
2740
#  TAG: diskd_program
2741
#	Specify the location of the diskd executable.
2742
#	Note this is only useful if you have compiled in
2743
#	diskd as one of the store io modules.
2744
#Default:
2745
# diskd_program /usr/lib/squid3/diskd
2746
2747
#  TAG: unlinkd_program
2748
#	Specify the location of the executable for file deletion process.
2749
#Default:
2750
# unlinkd_program /usr/lib/squid3/unlinkd
2751
2752
#  TAG: pinger_program
2753
# Note: This option is only available if Squid is rebuilt with the
2754
#       --enable-icmp option
2755
#
2756
#	Specify the location of the executable for the pinger process.
2757
#Default:
2758
# pinger_program /usr/lib/squid3/pinger
2759
2760
#  TAG: pinger_enable
2761
# Note: This option is only available if Squid is rebuilt with the
2762
#       --enable-icmp option
2763
#
2764
#	Control whether the pinger is active at run-time.
2765
#	Enables turning ICMP pinger on and off with a simple
2766
#	squid -k reconfigure.
2767
#Default:
2768
# pinger_enable off
2769
2770
# OPTIONS FOR URL REWRITING
2771
# -----------------------------------------------------------------------------
2772
2773
#  TAG: url_rewrite_program
2774
#	Specify the location of the executable for the URL rewriter.
2775
#	Since they can perform almost any function there isn't one included.
2776
#
2777
#	For each requested URL rewriter will receive on line with the format
2778
#
2779
#	URL <SP> client_ip "/" fqdn <SP> user <SP> method [<SP> kvpairs]<NL>
2780
#
2781
#	In the future, the rewriter interface will be extended with
2782
#	key=value pairs ("kvpairs" shown above).  Rewriter programs
2783
#	should be prepared to receive and possibly ignore additional
2784
#	whitespace-separated tokens on each input line.
2785
#
2786
#	And the rewriter may return a rewritten URL. The other components of
2787
#	the request line does not need to be returned (ignored if they are).
2788
#
2789
#	The rewriter can also indicate that a client-side redirect should
2790
#	be performed to the new URL. This is done by prefixing the returned
2791
#	URL with "301:" (moved permanently) or 302: (moved temporarily).
2792
#
2793
#	By default, a URL rewriter is not used.
2794
#Default:
2795
# none
2796
2797
#  TAG: url_rewrite_children
2798
#	The number of redirector processes to spawn. If you start
2799
#	too few Squid will have to wait for them to process a backlog of
2800
#	URLs, slowing it down. If you start too many they will use RAM
2801
#	and other system resources.
2802
#Default:
2803
# url_rewrite_children 5
2804
2805
#  TAG: url_rewrite_concurrency
2806
#	The number of requests each redirector helper can handle in
2807
#	parallel. Defaults to 0 which indicates the redirector
2808
#	is a old-style single threaded redirector.
2809
#
2810
#	When this directive is set to a value >= 1 then the protocol
2811
#	used to communicate with the helper is modified to include
2812
#	a request ID in front of the request/response. The request
2813
#	ID from the request must be echoed back with the response
2814
#	to that request.
2815
#Default:
2816
# url_rewrite_concurrency 0
2817
2818
#  TAG: url_rewrite_host_header
2819
#	By default Squid rewrites any Host: header in redirected
2820
#	requests.  If you are running an accelerator this may
2821
#	not be a wanted effect of a redirector.
2822
#
2823
#	WARNING: Entries are cached on the result of the URL rewriting
2824
#	process, so be careful if you have domain-virtual hosts.
2825
#Default:
2826
# url_rewrite_host_header on
2827
2828
#  TAG: url_rewrite_access
2829
#	If defined, this access list specifies which requests are
2830
#	sent to the redirector processes.  By default all requests
2831
#	are sent.
2832
#
2833
#	This clause supports both fast and slow acl types.
2834
#	See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
2835
#Default:
2836
# none
2837
2838
#  TAG: url_rewrite_bypass
2839
#	When this is 'on', a request will not go through the
2840
#	redirector if all redirectors are busy.  If this is 'off'
2841
#	and the redirector queue grows too large, Squid will exit
2842
#	with a FATAL error and ask you to increase the number of
2843
#	redirectors.  You should only enable this if the redirectors
2844
#	are not critical to your caching system.  If you use
2845
#	redirectors for access control, and you enable this option,
2846
#	users may have access to pages they should not
2847
#	be allowed to request.
2848
#Default:
2849
# url_rewrite_bypass off
2850
2851
# OPTIONS FOR TUNING THE CACHE
2852
# -----------------------------------------------------------------------------
2853
2854
#  TAG: cache
2855
#	A list of ACL elements which, if matched and denied, cause the request to
2856
#	not be satisfied from the cache and the reply to not be cached.
2857
#	In other words, use this to force certain objects to never be cached.
2858
#
2859
#	You must use the words 'allow' or 'deny' to indicate whether items
2860
#	matching the ACL should be allowed or denied into the cache.
2861
#
2862
#	Default is to allow all to be cached.
2863
#
2864
#	This clause supports both fast and slow acl types.
2865
#	See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
2866
#Default:
2867
# none
2868
2869
#  TAG: refresh_pattern
2870
#	usage: refresh_pattern [-i] regex min percent max [options]
2871
#
2872
#	By default, regular expressions are CASE-SENSITIVE.  To make
2873
#	them case-insensitive, use the -i option.
2874
#
2875
#	'Min' is the time (in minutes) an object without an explicit
2876
#	expiry time should be considered fresh. The recommended
2877
#	value is 0, any higher values may cause dynamic applications
2878
#	to be erroneously cached unless the application designer
2879
#	has taken the appropriate actions.
2880
#
2881
#	'Percent' is a percentage of the objects age (time since last
2882
#	modification age) an object without explicit expiry time
2883
#	will be considered fresh.
2884
#
2885
#	'Max' is an upper limit on how long objects without an explicit
2886
#	expiry time will be considered fresh.
2887
#
2888
#	options: override-expire
2889
#		 override-lastmod
2890
#		 reload-into-ims
2891
#		 ignore-reload
2892
#		 ignore-no-cache
2893
#		 ignore-no-store
2894
#		 ignore-must-revalidate
2895
#		 ignore-private
2896
#		 ignore-auth
2897
#		 refresh-ims
2898
#
2899
#		override-expire enforces min age even if the server
2900
#		sent an explicit expiry time (e.g., with the
2901
#		Expires: header or Cache-Control: max-age). Doing this
2902
#		VIOLATES the HTTP standard.  Enabling this feature
2903
#		could make you liable for problems which it causes.
2904
#
2905
#		Note: override-expire does not enforce staleness - it only extends
2906
#		freshness / min. If the server returns a Expires time which
2907
#		is longer than your max time, Squid will still consider
2908
#		the object fresh for that period of time.
2909
#
2910
#		override-lastmod enforces min age even on objects
2911
#		that were modified recently.
2912
#
2913
#		reload-into-ims changes client no-cache or ``reload''
2914
#		to If-Modified-Since requests. Doing this VIOLATES the
2915
#		HTTP standard. Enabling this feature could make you
2916
#		liable for problems which it causes.
2917
#
2918
#		ignore-reload ignores a client no-cache or ``reload''
2919
#		header. Doing this VIOLATES the HTTP standard. Enabling
2920
#		this feature could make you liable for problems which
2921
#		it causes.
2922
#
2923
#		ignore-no-cache ignores any ``Pragma: no-cache'' and
2924
#		``Cache-control: no-cache'' headers received from a server.
2925
#		The HTTP RFC never allows the use of this (Pragma) header
2926
#		from a server, only a client, though plenty of servers
2927
#		send it anyway.
2928
#
2929
#		ignore-no-store ignores any ``Cache-control: no-store''
2930
#		headers received from a server. Doing this VIOLATES
2931
#		the HTTP standard. Enabling this feature could make you
2932
#		liable for problems which it causes.
2933
#
2934
#		ignore-must-revalidate ignores any ``Cache-Control: must-revalidate``
2935
#		headers received from a server. Doing this VIOLATES
2936
#		the HTTP standard. Enabling this feature could make you
2937
#		liable for problems which it causes.
2938
#
2939
#		ignore-private ignores any ``Cache-control: private''
2940
#		headers received from a server. Doing this VIOLATES
2941
#		the HTTP standard. Enabling this feature could make you
2942
#		liable for problems which it causes.
2943
#
2944
#		ignore-auth caches responses to requests with authorization,
2945
#		as if the originserver had sent ``Cache-control: public''
2946
#		in the response header. Doing this VIOLATES the HTTP standard.
2947
#		Enabling this feature could make you liable for problems which
2948
#		it causes.
2949
#
2950
#		refresh-ims causes squid to contact the origin server
2951
#		when a client issues an If-Modified-Since request. This
2952
#		ensures that the client will receive an updated version
2953
#		if one is available.
2954
#
2955
#	Basically a cached object is:
2956
#
2957
#		FRESH if expires < now, else STALE
2958
#		STALE if age > max
2959
#		FRESH if lm-factor < percent, else STALE
2960
#		FRESH if age < min
2961
#		else STALE
2962
#
2963
#	The refresh_pattern lines are checked in the order listed here.
2964
#	The first entry which matches is used.  If none of the entries
2965
#	match the default will be used.
2966
#
2967
#	Note, you must uncomment all the default lines if you want
2968
#	to change one. The default setting is only active if none is
2969
#	used.
2970
#
2971
#
2972
2973
# Add any of your own refresh_pattern entries above these.
2974
refresh_pattern ^ftp:		1440	20%	10080
2975
refresh_pattern ^gopher:	1440	0%	1440
2976
refresh_pattern -i (/cgi-bin/|\?) 0	0%	0
2977
refresh_pattern .		0	20%	4320
2978
2979
#  TAG: quick_abort_min	(KB)
2980
#  TAG: quick_abort_max	(KB)
2981
#  TAG: quick_abort_pct	(percent)
2982
#	The cache by default continues downloading aborted requests
2983
#	which are almost completed (less than 16 KB remaining). This
2984
#	may be undesirable on slow (e.g. SLIP) links and/or very busy
2985
#	caches.  Impatient users may tie up file descriptors and
2986
#	bandwidth by repeatedly requesting and immediately aborting
2987
#	downloads.
2988
#
2989
#	When the user aborts a request, Squid will check the
2990
#	quick_abort values to the amount of data transfered until
2991
#	then.
2992
#
2993
#	If the transfer has less than 'quick_abort_min' KB remaining,
2994
#	it will finish the retrieval.
2995
#
2996
#	If the transfer has more than 'quick_abort_max' KB remaining,
2997
#	it will abort the retrieval.
2998
#
2999
#	If more than 'quick_abort_pct' of the transfer has completed,
3000
#	it will finish the retrieval.
3001
#
3002
#	If you do not want any retrieval to continue after the client
3003
#	has aborted, set both 'quick_abort_min' and 'quick_abort_max'
3004
#	to '0 KB'.
3005
#
3006
#	If you want retrievals to always continue if they are being
3007
#	cached set 'quick_abort_min' to '-1 KB'.
3008
#Default:
3009
# quick_abort_min 16 KB
3010
# quick_abort_max 16 KB
3011
# quick_abort_pct 95
3012
3013
#  TAG: read_ahead_gap	buffer-size
3014
#	The amount of data the cache will buffer ahead of what has been
3015
#	sent to the client when retrieving an object from another server.
3016
#Default:
3017
# read_ahead_gap 16 KB
3018
3019
#  TAG: negative_ttl	time-units
3020
#	Set the Default Time-to-Live (TTL) for failed requests.
3021
#	Certain types of failures (such as "connection refused" and
3022
#	"404 Not Found") are able to be negatively-cached for a short time.
3023
#	Modern web servers should provide Expires: header, however if they
3024
#	do not this can provide a minimum TTL.
3025
#	The default is not to cache errors with unknown expiry details.
3026
#
3027
#	Note that this is different from negative caching of DNS lookups.
3028
#
3029
#	WARNING: Doing this VIOLATES the HTTP standard.  Enabling
3030
#	this feature could make you liable for problems which it
3031
#	causes.
3032
#Default:
3033
# negative_ttl 0 seconds
3034
3035
#  TAG: positive_dns_ttl	time-units
3036
#	Upper limit on how long Squid will cache positive DNS responses.
3037
#	Default is 6 hours (360 minutes). This directive must be set
3038
#	larger than negative_dns_ttl.
3039
#Default:
3040
# positive_dns_ttl 6 hours
3041
3042
#  TAG: negative_dns_ttl	time-units
3043
#	Time-to-Live (TTL) for negative caching of failed DNS lookups.
3044
#	This also sets the lower cache limit on positive lookups.
3045
#	Minimum value is 1 second, and it is not recommendable to go
3046
#	much below 10 seconds.
3047
#Default:
3048
# negative_dns_ttl 1 minutes
3049
3050
#  TAG: range_offset_limit	(bytes)
3051
#	Sets a upper limit on how far into the the file a Range request
3052
#	may be to cause Squid to prefetch the whole file. If beyond this
3053
#	limit Squid forwards the Range request as it is and the result
3054
#	is NOT cached.
3055
#
3056
#	This is to stop a far ahead range request (lets say start at 17MB)
3057
#	from making Squid fetch the whole object up to that point before
3058
#	sending anything to the client.
3059
#
3060
#	A value of 0 causes Squid to never fetch more than the
3061
#	client requested. (default)
3062
#
3063
#	A value of -1 causes Squid to always fetch the object from the
3064
#	beginning so it may cache the result. (2.0 style)
3065
#
3066
#	NP: Using -1 here will override any quick_abort settings that may
3067
#	    otherwise apply to the range request. The range request will
3068
#	    be fully fetched from start to finish regardless of the client
3069
#	    actions. This affects bandwidth usage.
3070
#Default:
3071
# range_offset_limit 0 KB
3072
3073
#  TAG: minimum_expiry_time	(seconds)
3074
#	The minimum caching time according to (Expires - Date)
3075
#	Headers Squid honors if the object can't be revalidated
3076
#	defaults to 60 seconds. In reverse proxy environments it
3077
#	might be desirable to honor shorter object lifetimes. It
3078
#	is most likely better to make your server return a
3079
#	meaningful Last-Modified header however. In ESI environments
3080
#	where page fragments often have short lifetimes, this will
3081
#	often be best set to 0.
3082
#Default:
3083
# minimum_expiry_time 60 seconds
3084
3085
#  TAG: store_avg_object_size	(kbytes)
3086
#	Average object size, used to estimate number of objects your
3087
#	cache can hold.  The default is 13 KB.
3088
#Default:
3089
# store_avg_object_size 13 KB
3090
3091
#  TAG: store_objects_per_bucket
3092
#	Target number of objects per bucket in the store hash table.
3093
#	Lowering this value increases the total number of buckets and
3094
#	also the storage maintenance rate.  The default is 20.
3095
#Default:
3096
# store_objects_per_bucket 20
3097
3098
# HTTP OPTIONS
3099
# -----------------------------------------------------------------------------
3100
3101
#  TAG: request_header_max_size	(KB)
3102
#	This specifies the maximum size for HTTP headers in a request.
3103
#	Request headers are usually relatively small (about 512 bytes).
3104
#	Placing a limit on the request header size will catch certain
3105
#	bugs (for example with persistent connections) and possibly
3106
#	buffer-overflow or denial-of-service attacks.
3107
#Default:
3108
# request_header_max_size 64 KB
3109
3110
#  TAG: reply_header_max_size	(KB)
3111
#	This specifies the maximum size for HTTP headers in a reply.
3112
#	Reply headers are usually relatively small (about 512 bytes).
3113
#	Placing a limit on the reply header size will catch certain
3114
#	bugs (for example with persistent connections) and possibly
3115
#	buffer-overflow or denial-of-service attacks.
3116
#Default:
3117
# reply_header_max_size 64 KB
3118
3119
#  TAG: request_body_max_size	(bytes)
3120
#	This specifies the maximum size for an HTTP request body.
3121
#	In other words, the maximum size of a PUT/POST request.
3122
#	A user who attempts to send a request with a body larger
3123
#	than this limit receives an "Invalid Request" error message.
3124
#	If you set this parameter to a zero (the default), there will
3125
#	be no limit imposed.
3126
#Default:
3127
# request_body_max_size 0 KB
3128
3129
#  TAG: chunked_request_body_max_size	(bytes)
3130
#	A broken or confused HTTP/1.1 client may send a chunked HTTP
3131
#	request to Squid. Squid does not have full support for that
3132
#	feature yet. To cope with such requests, Squid buffers the
3133
#	entire request and then dechunks request body to create a
3134
#	plain HTTP/1.0 request with a known content length. The plain
3135
#	request is then used by the rest of Squid code as usual.
3136
#
3137
#	The option value specifies the maximum size of the buffer used
3138
#	to hold the request before the conversion. If the chunked
3139
#	request size exceeds the specified limit, the conversion
3140
#	fails, and the client receives an "unsupported request" error,
3141
#	as if dechunking was disabled.
3142
#
3143
#	Dechunking is enabled by default. To disable conversion of
3144
#	chunked requests, set the maximum to zero.
3145
#
3146
#	Request dechunking feature and this option in particular are a
3147
#	temporary hack. When chunking requests and responses are fully
3148
#	supported, there will be no need to buffer a chunked request.
3149
#Default:
3150
# chunked_request_body_max_size 64 KB
3151
3152
#  TAG: broken_posts
3153
#	A list of ACL elements which, if matched, causes Squid to send
3154
#	an extra CRLF pair after the body of a PUT/POST request.
3155
#
3156
#	Some HTTP servers has broken implementations of PUT/POST,
3157
#	and rely on an extra CRLF pair sent by some WWW clients.
3158
#
3159
#	Quote from RFC2616 section 4.1 on this matter:
3160
#
3161
#	  Note: certain buggy HTTP/1.0 client implementations generate an
3162
#	  extra CRLF's after a POST request. To restate what is explicitly
3163
#	  forbidden by the BNF, an HTTP/1.1 client must not preface or follow
3164
#	  a request with an extra CRLF.
3165
#
3166
#	This clause only supports fast acl types.
3167
#	See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
3168
#
3169
#Example:
3170
# acl buggy_server url_regex ^http://....
3171
# broken_posts allow buggy_server
3172
#Default:
3173
# none
3174
3175
#  TAG: icap_uses_indirect_client	on|off
3176
#   Controls whether the indirect client address
3177
#   (see follow_x_forwarded_for) instead of the
3178
#   direct client address is passed to an ICAP
3179
#   server as "X-Client-IP".
3180
#Default:
3181
# icap_uses_indirect_client on
3182
3183
#  TAG: via	on|off
3184
#	If set (default), Squid will include a Via header in requests and
3185
#	replies as required by RFC2616.
3186
#Default:
3187
# via on
3188
3189
#  TAG: ie_refresh	on|off
3190
#	Microsoft Internet Explorer up until version 5.5 Service
3191
#	Pack 1 has an issue with transparent proxies, wherein it
3192
#	is impossible to force a refresh.  Turning this on provides
3193
#	a partial fix to the problem, by causing all IMS-REFRESH
3194
#	requests from older IE versions to check the origin server
3195
#	for fresh content.  This reduces hit ratio by some amount
3196
#	(~10% in my experience), but allows users to actually get
3197
#	fresh content when they want it.  Note because Squid
3198
#	cannot tell if the user is using 5.5 or 5.5SP1, the behavior
3199
#	of 5.5 is unchanged from old versions of Squid (i.e. a
3200
#	forced refresh is impossible).  Newer versions of IE will,
3201
#	hopefully, continue to have the new behavior and will be
3202
#	handled based on that assumption.  This option defaults to
3203
#	the old Squid behavior, which is better for hit ratios but
3204
#	worse for clients using IE, if they need to be able to
3205
#	force fresh content.
3206
#Default:
3207
# ie_refresh off
3208
3209
#  TAG: vary_ignore_expire	on|off
3210
#	Many HTTP servers supporting Vary gives such objects
3211
#	immediate expiry time with no cache-control header
3212
#	when requested by a HTTP/1.0 client. This option
3213
#	enables Squid to ignore such expiry times until
3214
#	HTTP/1.1 is fully implemented.
3215
#
3216
#	WARNING: If turned on this may eventually cause some
3217
#	varying objects not intended for caching to get cached.
3218
#Default:
3219
# vary_ignore_expire off
3220
3221
#  TAG: request_entities
3222
#	Squid defaults to deny GET and HEAD requests with request entities,
3223
#	as the meaning of such requests are undefined in the HTTP standard
3224
#	even if not explicitly forbidden.
3225
#
3226
#	Set this directive to on if you have clients which insists
3227
#	on sending request entities in GET or HEAD requests. But be warned
3228
#	that there is server software (both proxies and web servers) which
3229
#	can fail to properly process this kind of request which may make you
3230
#	vulnerable to cache pollution attacks if enabled.
3231
#Default:
3232
# request_entities off
3233
3234
#  TAG: request_header_access
3235
#	Usage: request_header_access header_name allow|deny [!]aclname ...
3236
#
3237
#	WARNING: Doing this VIOLATES the HTTP standard.  Enabling
3238
#	this feature could make you liable for problems which it
3239
#	causes.
3240
#
3241
#	This option replaces the old 'anonymize_headers' and the
3242
#	older 'http_anonymizer' option with something that is much
3243
#	more configurable. This new method creates a list of ACLs
3244
#	for each header, allowing you very fine-tuned header
3245
#	mangling.
3246
#
3247
#	This option only applies to request headers, i.e., from the
3248
#	client to the server.
3249
#
3250
#	You can only specify known headers for the header name.
3251
#	Other headers are reclassified as 'Other'. You can also
3252
#	refer to all the headers with 'All'.
3253
#
3254
#	For example, to achieve the same behavior as the old
3255
#	'http_anonymizer standard' option, you should use:
3256
#
3257
#		request_header_access From deny all
3258
#		request_header_access Referer deny all
3259
#		request_header_access Server deny all
3260
#		request_header_access User-Agent deny all
3261
#		request_header_access WWW-Authenticate deny all
3262
#		request_header_access Link deny all
3263
#
3264
#	Or, to reproduce the old 'http_anonymizer paranoid' feature
3265
#	you should use:
3266
#
3267
#		request_header_access Allow allow all
3268
#		request_header_access Authorization allow all
3269
#		request_header_access WWW-Authenticate allow all
3270
#		request_header_access Proxy-Authorization allow all
3271
#		request_header_access Proxy-Authenticate allow all
3272
#		request_header_access Cache-Control allow all
3273
#		request_header_access Content-Encoding allow all
3274
#		request_header_access Content-Length allow all
3275
#		request_header_access Content-Type allow all
3276
#		request_header_access Date allow all
3277
#		request_header_access Expires allow all
3278
#		request_header_access Host allow all
3279
#		request_header_access If-Modified-Since allow all
3280
#		request_header_access Last-Modified allow all
3281
#		request_header_access Location allow all
3282
#		request_header_access Pragma allow all
3283
#		request_header_access Accept allow all
3284
#		request_header_access Accept-Charset allow all
3285
#		request_header_access Accept-Encoding allow all
3286
#		request_header_access Accept-Language allow all
3287
#		request_header_access Content-Language allow all
3288
#		request_header_access Mime-Version allow all
3289
#		request_header_access Retry-After allow all
3290
#		request_header_access Title allow all
3291
#		request_header_access Connection allow all
3292
#		request_header_access Proxy-Connection allow all
3293
#		request_header_access All deny all
3294
#
3295
#	although many of those are HTTP reply headers, and so should be
3296
#	controlled with the reply_header_access directive.
3297
#
3298
#	By default, all headers are allowed (no anonymizing is
3299
#	performed).
3300
#Default:
3301
# none
3302
3303
#  TAG: reply_header_access
3304
#	Usage: reply_header_access header_name allow|deny [!]aclname ...
3305
#
3306
#	WARNING: Doing this VIOLATES the HTTP standard.  Enabling
3307
#	this feature could make you liable for problems which it
3308
#	causes.
3309
#
3310
#	This option only applies to reply headers, i.e., from the
3311
#	server to the client.
3312
#
3313
#	This is the same as request_header_access, but in the other
3314
#	direction.
3315
#
3316
#	This option replaces the old 'anonymize_headers' and the
3317
#	older 'http_anonymizer' option with something that is much
3318
#	more configurable. This new method creates a list of ACLs
3319
#	for each header, allowing you very fine-tuned header
3320
#	mangling.
3321
#
3322
#	You can only specify known headers for the header name.
3323
#	Other headers are reclassified as 'Other'. You can also
3324
#	refer to all the headers with 'All'.
3325
#
3326
#	For example, to achieve the same behavior as the old
3327
#	'http_anonymizer standard' option, you should use:
3328
#
3329
#		reply_header_access From deny all
3330
#		reply_header_access Referer deny all
3331
#		reply_header_access Server deny all
3332
#		reply_header_access User-Agent deny all
3333
#		reply_header_access WWW-Authenticate deny all
3334
#		reply_header_access Link deny all
3335
#
3336
#	Or, to reproduce the old 'http_anonymizer paranoid' feature
3337
#	you should use:
3338
#
3339
#		reply_header_access Allow allow all
3340
#		reply_header_access Authorization allow all
3341
#		reply_header_access WWW-Authenticate allow all
3342
#		reply_header_access Proxy-Authorization allow all
3343
#		reply_header_access Proxy-Authenticate allow all
3344
#		reply_header_access Cache-Control allow all
3345
#		reply_header_access Content-Encoding allow all
3346
#		reply_header_access Content-Length allow all
3347
#		reply_header_access Content-Type allow all
3348
#		reply_header_access Date allow all
3349
#		reply_header_access Expires allow all
3350
#		reply_header_access Host allow all
3351
#		reply_header_access If-Modified-Since allow all
3352
#		reply_header_access Last-Modified allow all
3353
#		reply_header_access Location allow all
3354
#		reply_header_access Pragma allow all
3355
#		reply_header_access Accept allow all
3356
#		reply_header_access Accept-Charset allow all
3357
#		reply_header_access Accept-Encoding allow all
3358
#		reply_header_access Accept-Language allow all
3359
#		reply_header_access Content-Language allow all
3360
#		reply_header_access Mime-Version allow all
3361
#		reply_header_access Retry-After allow all
3362
#		reply_header_access Title allow all
3363
#		reply_header_access Connection allow all
3364
#		reply_header_access Proxy-Connection allow all
3365
#		reply_header_access All deny all
3366
#
3367
#	although the HTTP request headers won't be usefully controlled
3368
#	by this directive -- see request_header_access for details.
3369
#
3370
#	By default, all headers are allowed (no anonymizing is
3371
#	performed).
3372
#Default:
3373
# none
3374
3375
#  TAG: header_replace
3376
#	Usage:   header_replace header_name message
3377
#	Example: header_replace User-Agent Nutscrape/1.0 (CP/M; 8-bit)
3378
#
3379
#	This option allows you to change the contents of headers
3380
#	denied with header_access above, by replacing them with
3381
#	some fixed string. This replaces the old fake_user_agent
3382
#	option.
3383
#
3384
#	This only applies to request headers, not reply headers.
3385
#
3386
#	By default, headers are removed if denied.
3387
#Default:
3388
# none
3389
3390
#  TAG: relaxed_header_parser	on|off|warn
3391
#	In the default "on" setting Squid accepts certain forms
3392
#	of non-compliant HTTP messages where it is unambiguous
3393
#	what the sending application intended even if the message
3394
#	is not correctly formatted. The messages is then normalized
3395
#	to the correct form when forwarded by Squid.
3396
#
3397
#	If set to "warn" then a warning will be emitted in cache.log
3398
#	each time such HTTP error is encountered.
3399
#
3400
#	If set to "off" then such HTTP errors will cause the request
3401
#	or response to be rejected.
3402
#Default:
3403
# relaxed_header_parser on
3404
3405
#  TAG: ignore_expect_100	on|off
3406
#	This option makes Squid ignore any Expect: 100-continue header present
3407
#	in the request. RFC 2616 requires that Squid being unable to satisfy
3408
#	the response expectation MUST return a 417 error.
3409
#
3410
#	Note: Enabling this is a HTTP protocol violation, but some clients may
3411
#	not handle it well..
3412
#Default:
3413
# ignore_expect_100 off
3414
3415
# TIMEOUTS
3416
# -----------------------------------------------------------------------------
3417
3418
#  TAG: forward_timeout	time-units
3419
#	This parameter specifies how long Squid should at most attempt in
3420
#	finding a forwarding path for the request before giving up.
3421
#Default:
3422
# forward_timeout 4 minutes
3423
3424
#  TAG: connect_timeout	time-units
3425
#	This parameter specifies how long to wait for the TCP connect to
3426
#	the requested server or peer to complete before Squid should
3427
#	attempt to find another path where to forward the request.
3428
#Default:
3429
# connect_timeout 1 minute
3430
3431
#  TAG: peer_connect_timeout	time-units
3432
#	This parameter specifies how long to wait for a pending TCP
3433
#	connection to a peer cache.  The default is 30 seconds.   You
3434
#	may also set different timeout values for individual neighbors
3435
#	with the 'connect-timeout' option on a 'cache_peer' line.
3436
#Default:
3437
# peer_connect_timeout 30 seconds
3438
3439
#  TAG: read_timeout	time-units
3440
#	The read_timeout is applied on server-side connections.  After
3441
#	each successful read(), the timeout will be extended by this
3442
#	amount.  If no data is read again after this amount of time,
3443
#	the request is aborted and logged with ERR_READ_TIMEOUT.  The
3444
#	default is 15 minutes.
3445
#Default:
3446
# read_timeout 15 minutes
3447
3448
#  TAG: request_timeout
3449
#	How long to wait for an HTTP request after initial
3450
#	connection establishment.
3451
#Default:
3452
# request_timeout 5 minutes
3453
3454
#  TAG: persistent_request_timeout
3455
#	How long to wait for the next HTTP request on a persistent
3456
#	connection after the previous request completes.
3457
#Default:
3458
# persistent_request_timeout 2 minutes
3459
3460
#  TAG: client_lifetime	time-units
3461
#	The maximum amount of time a client (browser) is allowed to
3462
#	remain connected to the cache process.  This protects the Cache
3463
#	from having a lot of sockets (and hence file descriptors) tied up
3464
#	in a CLOSE_WAIT state from remote clients that go away without
3465
#	properly shutting down (either because of a network failure or
3466
#	because of a poor client implementation).  The default is one
3467
#	day, 1440 minutes.
3468
#
3469
#	NOTE:  The default value is intended to be much larger than any
3470
#	client would ever need to be connected to your cache.  You
3471
#	should probably change client_lifetime only as a last resort.
3472
#	If you seem to have many client connections tying up
3473
#	filedescriptors, we recommend first tuning the read_timeout,
3474
#	request_timeout, persistent_request_timeout and quick_abort values.
3475
#Default:
3476
# client_lifetime 1 day
3477
3478
#  TAG: half_closed_clients
3479
#	Some clients may shutdown the sending side of their TCP
3480
#	connections, while leaving their receiving sides open.	Sometimes,
3481
#	Squid can not tell the difference between a half-closed and a
3482
#	fully-closed TCP connection.
3483
#
3484
#	By default, Squid will immediately close client connections when
3485
#	read(2) returns "no more data to read."
3486
#
3487
#	Change this option to 'on' and Squid will keep open connections
3488
#	until a read(2) or write(2) on the socket returns an error.
3489
#	This may show some benefits for reverse proxies. But if not
3490
#	it is recommended to leave OFF.
3491
#Default:
3492
# half_closed_clients off
3493
3494
#  TAG: pconn_timeout
3495
#	Timeout for idle persistent connections to servers and other
3496
#	proxies.
3497
#Default:
3498
# pconn_timeout 1 minute
3499
3500
#  TAG: ident_timeout
3501
#	Maximum time to wait for IDENT lookups to complete.
3502
#
3503
#	If this is too high, and you enabled IDENT lookups from untrusted
3504
#	users, you might be susceptible to denial-of-service by having
3505
#	many ident requests going at once.
3506
#Default:
3507
# ident_timeout 10 seconds
3508
3509
#  TAG: shutdown_lifetime	time-units
3510
#	When SIGTERM or SIGHUP is received, the cache is put into
3511
#	"shutdown pending" mode until all active sockets are closed.
3512
#	This value is the lifetime to set for all open descriptors
3513
#	during shutdown mode.  Any active clients after this many
3514
#	seconds will receive a 'timeout' message.
3515
#Default:
3516
# shutdown_lifetime 30 seconds
3517
3518
# ADMINISTRATIVE PARAMETERS
3519
# -----------------------------------------------------------------------------
3520
3521
#  TAG: cache_mgr
3522
#	Email-address of local cache manager who will receive
3523
#	mail if the cache dies.  The default is "webmaster."
3524
#Default:
3525
# cache_mgr webmaster
3526
3527
#  TAG: mail_from
3528
#	From: email-address for mail sent when the cache dies.
3529
#	The default is to use 'appname@unique_hostname'.
3530
#	Default appname value is "squid", can be changed into
3531
#	src/globals.h before building squid.
3532
#Default:
3533
# none
3534
3535
#  TAG: mail_program
3536
#	Email program used to send mail if the cache dies.
3537
#	The default is "mail". The specified program must comply
3538
#	with the standard Unix mail syntax:
3539
#	  mail-program recipient < mailfile
3540
#
3541
#	Optional command line options can be specified.
3542
#Default:
3543
# mail_program mail
3544
3545
#  TAG: cache_effective_user
3546
#	If you start Squid as root, it will change its effective/real
3547
#	UID/GID to the user specified below.  The default is to change
3548
#	to UID of proxy.
3549
#	see also; cache_effective_group
3550
#Default:
3551
# cache_effective_user proxy
3552
3553
#  TAG: cache_effective_group
3554
#	Squid sets the GID to the effective user's default group ID
3555
#	(taken from the password file) and supplementary group list
3556
#	from the groups membership.
3557
#
3558
#	If you want Squid to run with a specific GID regardless of
3559
#	the group memberships of the effective user then set this
3560
#	to the group (or GID) you want Squid to run as. When set
3561
#	all other group privileges of the effective user are ignored
3562
#	and only this GID is effective. If Squid is not started as
3563
#	root the user starting Squid MUST be member of the specified
3564
#	group.
3565
#
3566
#	This option is not recommended by the Squid Team.
3567
#	Our preference is for administrators to configure a secure
3568
#	user account for squid with UID/GID matching system policies.
3569
#Default:
3570
# none
3571
3572
#  TAG: httpd_suppress_version_string	on|off
3573
#	Suppress Squid version string info in HTTP headers and HTML error pages.
3574
#Default:
3575
# httpd_suppress_version_string off
3576
3577
#  TAG: visible_hostname
3578
#	If you want to present a special hostname in error messages, etc,
3579
#	define this.  Otherwise, the return value of gethostname()
3580
#	will be used. If you have multiple caches in a cluster and
3581
#	get errors about IP-forwarding you must set them to have individual
3582
#	names with this setting.
3583
#Default:
3584
# visible_hostname localhost
3585
3586
#  TAG: unique_hostname
3587
#	If you want to have multiple machines with the same
3588
#	'visible_hostname' you must give each machine a different
3589
#	'unique_hostname' so forwarding loops can be detected.
3590
#Default:
3591
# none
3592
3593
#  TAG: hostname_aliases
3594
#	A list of other DNS names your cache has.
3595
#Default:
3596
# none
3597
3598
#  TAG: umask
3599
#	Minimum umask which should be enforced while the proxy
3600
#	is running, in addition to the umask set at startup.
3601
#
3602
#	For a traditional octal representation of umasks, start
3603
#        your value with 0.
3604
#Default:
3605
# umask 027
3606
3607
# OPTIONS FOR THE CACHE REGISTRATION SERVICE
3608
# -----------------------------------------------------------------------------
3609
#
3610
#	This section contains parameters for the (optional) cache
3611
#	announcement service.  This service is provided to help
3612
#	cache administrators locate one another in order to join or
3613
#	create cache hierarchies.
3614
#
3615
#	An 'announcement' message is sent (via UDP) to the registration
3616
#	service by Squid.  By default, the announcement message is NOT
3617
#	SENT unless you enable it with 'announce_period' below.
3618
#
3619
#	The announcement message includes your hostname, plus the
3620
#	following information from this configuration file:
3621
#
3622
#		http_port
3623
#		icp_port
3624
#		cache_mgr
3625
#
3626
#	All current information is processed regularly and made
3627
#	available on the Web at http://www.ircache.net/Cache/Tracker/.
3628
3629
#  TAG: announce_period
3630
#	This is how frequently to send cache announcements.  The
3631
#	default is `0' which disables sending the announcement
3632
#	messages.
3633
#
3634
#	To enable announcing your cache, just set an announce period.
3635
#
3636
#	Example:
3637
#		announce_period 1 day
3638
#Default:
3639
# announce_period 0
3640
3641
#  TAG: announce_host
3642
#  TAG: announce_file
3643
#  TAG: announce_port
3644
#	announce_host and announce_port set the hostname and port
3645
#	number where the registration message will be sent.
3646
#
3647
#	Hostname will default to 'tracker.ircache.net' and port will
3648
#	default default to 3131.  If the 'filename' argument is given,
3649
#	the contents of that file will be included in the announce
3650
#	message.
3651
#Default:
3652
# announce_host tracker.ircache.net
3653
# announce_port 3131
3654
3655
# HTTPD-ACCELERATOR OPTIONS
3656
# -----------------------------------------------------------------------------
3657
3658
#  TAG: httpd_accel_surrogate_id
3659
#	Surrogates (http://www.esi.org/architecture_spec_1.0.html)
3660
#	need an identification token to allow control targeting. Because
3661
#	a farm of surrogates may all perform the same tasks, they may share
3662
#	an identification token.
3663
#Default:
3664
# httpd_accel_surrogate_id unset-id
3665
3666
#  TAG: http_accel_surrogate_remote	on|off
3667
#	Remote surrogates (such as those in a CDN) honour Surrogate-Control: no-store-remote.
3668
#	Set this to on to have squid behave as a remote surrogate.
3669
#Default:
3670
# http_accel_surrogate_remote off
3671
3672
#  TAG: esi_parser	libxml2|expat|custom
3673
#	ESI markup is not strictly XML compatible. The custom ESI parser
3674
#	will give higher performance, but cannot handle non ASCII character
3675
#	encodings.
3676
#Default:
3677
# esi_parser custom
3678
3679
# DELAY POOL PARAMETERS
3680
# -----------------------------------------------------------------------------
3681
3682
#  TAG: delay_pools
3683
#	This represents the number of delay pools to be used.  For example,
3684
#	if you have one class 2 delay pool and one class 3 delays pool, you
3685
#	have a total of 2 delay pools.
3686
#Default:
3687
# delay_pools 0
3688
3689
#  TAG: delay_class
3690
#	This defines the class of each delay pool.  There must be exactly one
3691
#	delay_class line for each delay pool.  For example, to define two
3692
#	delay pools, one of class 2 and one of class 3, the settings above
3693
#	and here would be:
3694
#
3695
#	Example:
3696
#	    delay_pools 4      # 4 delay pools
3697
#	    delay_class 1 2    # pool 1 is a class 2 pool
3698
#	    delay_class 2 3    # pool 2 is a class 3 pool
3699
#	    delay_class 3 4    # pool 3 is a class 4 pool
3700
#	    delay_class 4 5    # pool 4 is a class 5 pool
3701
#
3702
#	The delay pool classes are:
3703
#
3704
#		class 1		Everything is limited by a single aggregate
3705
#				bucket.
3706
#
3707
#		class 2 	Everything is limited by a single aggregate
3708
#				bucket as well as an "individual" bucket chosen
3709
#				from bits 25 through 32 of the IPv4 address.
3710
#
3711
#		class 3		Everything is limited by a single aggregate
3712
#				bucket as well as a "network" bucket chosen
3713
#				from bits 17 through 24 of the IP address and a
3714
#				"individual" bucket chosen from bits 17 through
3715
#				32 of the IPv4 address.
3716
#
3717
#		class 4		Everything in a class 3 delay pool, with an
3718
#				additional limit on a per user basis. This
3719
#				only takes effect if the username is established
3720
#				in advance - by forcing authentication in your
3721
#				http_access rules.
3722
#
3723
#		class 5		Requests are grouped according their tag (see
3724
#				external_acl's tag= reply).
3725
#
3726
#	NOTE: If an IP address is a.b.c.d
3727
#		-> bits 25 through 32 are "d"
3728
#		-> bits 17 through 24 are "c"
3729
#		-> bits 17 through 32 are "c * 256 + d"
3730
#
3731
#	NOTE-2: Due to the use of bitmasks in class 2,3,4 pools they only apply to
3732
#		IPv4 traffic. Class 1 and 5 pools may be used with IPv6 traffic.
3733
#Default:
3734
# none
3735
3736
#  TAG: delay_access
3737
#	This is used to determine which delay pool a request falls into.
3738
#
3739
#	delay_access is sorted per pool and the matching starts with pool 1,
3740
#	then pool 2, ..., and finally pool N. The first delay pool where the
3741
#	request is allowed is selected for the request. If it does not allow
3742
#	the request to any pool then the request is not delayed (default).
3743
#
3744
#	For example, if you want some_big_clients in delay
3745
#	pool 1 and lotsa_little_clients in delay pool 2:
3746
#
3747
#Example:
3748
# delay_access 1 allow some_big_clients
3749
# delay_access 1 deny all
3750
# delay_access 2 allow lotsa_little_clients
3751
# delay_access 2 deny all
3752
# delay_access 3 allow authenticated_clients
3753
#Default:
3754
# none
3755
3756
#  TAG: delay_parameters
3757
#	This defines the parameters for a delay pool.  Each delay pool has
3758
#	a number of "buckets" associated with it, as explained in the
3759
#	description of delay_class.  For a class 1 delay pool, the syntax is:
3760
#
3761
#delay_parameters pool aggregate
3762
#
3763
#	For a class 2 delay pool:
3764
#
3765
#delay_parameters pool aggregate individual
3766
#
3767
#	For a class 3 delay pool:
3768
#
3769
#delay_parameters pool aggregate network individual
3770
#
3771
#	For a class 4 delay pool:
3772
#
3773
#delay_parameters pool aggregate network individual user
3774
#
3775
#	For a class 5 delay pool:
3776
#
3777
#delay_parameters pool tag
3778
#
3779
#	The variables here are:
3780
#
3781
#		pool		a pool number - ie, a number between 1 and the
3782
#				number specified in delay_pools as used in
3783
#				delay_class lines.
3784
#
3785
#		aggregate	the "delay parameters" for the aggregate bucket
3786
#				(class 1, 2, 3).
3787
#
3788
#		individual	the "delay parameters" for the individual
3789
#				buckets (class 2, 3).
3790
#
3791
#		network		the "delay parameters" for the network buckets
3792
#				(class 3).
3793
#
3794
#		user		the delay parameters for the user buckets
3795
#				(class 4).
3796
#
3797
#		tag		the delay parameters for the tag buckets
3798
#				(class 5).
3799
#
3800
#	A pair of delay parameters is written restore/maximum, where restore is
3801
#	the number of bytes (not bits - modem and network speeds are usually
3802
#	quoted in bits) per second placed into the bucket, and maximum is the
3803
#	maximum number of bytes which can be in the bucket at any time.
3804
#
3805
#	For example, if delay pool number 1 is a class 2 delay pool as in the
3806
#	above example, and is being used to strictly limit each host to 64kbps
3807
#	(plus overheads), with no overall limit, the line is:
3808
#
3809
#delay_parameters 1 -1/-1 8000/8000
3810
#
3811
#	Note that the figure -1 is used to represent "unlimited".
3812
#
3813
#	And, if delay pool number 2 is a class 3 delay pool as in the above
3814
#	example, and you want to limit it to a total of 256kbps (strict limit)
3815
#	with each 8-bit network permitted 64kbps (strict limit) and each
3816
#	individual host permitted 4800bps with a bucket maximum size of 64kb
3817
#	to permit a decent web page to be downloaded at a decent speed
3818
#	(if the network is not being limited due to overuse) but slow down
3819
#	large downloads more significantly:
3820
#
3821
#delay_parameters 2 32000/32000 8000/8000 600/8000
3822
#
3823
#	There must be one delay_parameters line for each delay pool.
3824
#
3825
#	Finally, for a class 4 delay pool as in the example - each user will
3826
#	be limited to 128Kb no matter how many workstations they are logged into.:
3827
#
3828
#delay_parameters 4 32000/32000 8000/8000 600/64000 16000/16000
3829
#Default:
3830
# none
3831
3832
#  TAG: delay_initial_bucket_level	(percent, 0-100)
3833
#	The initial bucket percentage is used to determine how much is put
3834
#	in each bucket when squid starts, is reconfigured, or first notices
3835
#	a host accessing it (in class 2 and class 3, individual hosts and
3836
#	networks only have buckets associated with them once they have been
3837
#	"seen" by squid).
3838
#Default:
3839
# delay_initial_bucket_level 50
3840
3841
# WCCPv1 AND WCCPv2 CONFIGURATION OPTIONS
3842
# -----------------------------------------------------------------------------
3843
3844
#  TAG: wccp_router
3845
#	Use this option to define your WCCP ``home'' router for
3846
#	Squid.
3847
#
3848
#	wccp_router supports a single WCCP(v1) router
3849
#
3850
#	wccp2_router supports multiple WCCPv2 routers
3851
#
3852
#	only one of the two may be used at the same time and defines
3853
#	which version of WCCP to use.
3854
#Default:
3855
# wccp_router any_addr
3856
3857
#  TAG: wccp2_router
3858
#	Use this option to define your WCCP ``home'' router for
3859
#	Squid.
3860
#
3861
#	wccp_router supports a single WCCP(v1) router
3862
#
3863
#	wccp2_router supports multiple WCCPv2 routers
3864
#
3865
#	only one of the two may be used at the same time and defines
3866
#	which version of WCCP to use.
3867
#Default:
3868
# none
3869
3870
#  TAG: wccp_version
3871
#	This directive is only relevant if you need to set up WCCP(v1)
3872
#	to some very old and end-of-life Cisco routers. In all other
3873
#	setups it must be left unset or at the default setting.
3874
#	It defines an internal version in the WCCP(v1) protocol,
3875
#	with version 4 being the officially documented protocol.
3876
#
3877
#	According to some users, Cisco IOS 11.2 and earlier only
3878
#	support WCCP version 3.  If you're using that or an earlier
3879
#	version of IOS, you may need to change this value to 3, otherwise
3880
#	do not specify this parameter.
3881
#Default:
3882
# wccp_version 4
3883
3884
#  TAG: wccp2_rebuild_wait
3885
#	If this is enabled Squid will wait for the cache dir rebuild to finish
3886
#	before sending the first wccp2 HereIAm packet
3887
#Default:
3888
# wccp2_rebuild_wait on
3889
3890
#  TAG: wccp2_forwarding_method
3891
#	WCCP2 allows the setting of forwarding methods between the
3892
#	router/switch and the cache.  Valid values are as follows:
3893
#
3894
#	gre - GRE encapsulation (forward the packet in a GRE/WCCP tunnel)
3895
#	l2  - L2 redirect (forward the packet using Layer 2/MAC rewriting)
3896
#
3897
#	Currently (as of IOS 12.4) cisco routers only support GRE.
3898
#	Cisco switches only support the L2 redirect assignment method.
3899
#Default:
3900
# wccp2_forwarding_method gre
3901
3902
#  TAG: wccp2_return_method
3903
#	WCCP2 allows the setting of return methods between the
3904
#	router/switch and the cache for packets that the cache
3905
#	decides not to handle.  Valid values are as follows:
3906
#
3907
#	gre - GRE encapsulation (forward the packet in a GRE/WCCP tunnel)
3908
#	l2  - L2 redirect (forward the packet using Layer 2/MAC rewriting)
3909
#
3910
#	Currently (as of IOS 12.4) cisco routers only support GRE.
3911
#	Cisco switches only support the L2 redirect assignment.
3912
#
3913
#	If the "ip wccp redirect exclude in" command has been
3914
#	enabled on the cache interface, then it is still safe for
3915
#	the proxy server to use a l2 redirect method even if this
3916
#	option is set to GRE.
3917
#Default:
3918
# wccp2_return_method gre
3919
3920
#  TAG: wccp2_assignment_method
3921
#	WCCP2 allows the setting of methods to assign the WCCP hash
3922
#	Valid values are as follows:
3923
#
3924
#	hash - Hash assignment
3925
#	mask  - Mask assignment
3926
#
3927
#	As a general rule, cisco routers support the hash assignment method
3928
#	and cisco switches support the mask assignment method.
3929
#Default:
3930
# wccp2_assignment_method hash
3931
3932
#  TAG: wccp2_service
3933
#	WCCP2 allows for multiple traffic services. There are two
3934
#	types: "standard" and "dynamic". The standard type defines
3935
#	one service id - http (id 0). The dynamic service ids can be from
3936
#	51 to 255 inclusive.  In order to use a dynamic service id
3937
#	one must define the type of traffic to be redirected; this is done
3938
#	using the wccp2_service_info option.
3939
#
3940
#	The "standard" type does not require a wccp2_service_info option,
3941
#	just specifying the service id will suffice.
3942
#
3943
#	MD5 service authentication can be enabled by adding
3944
#	"password=<password>" to the end of this service declaration.
3945
#
3946
#	Examples:
3947
#
3948
#	wccp2_service standard 0	# for the 'web-cache' standard service
3949
#	wccp2_service dynamic 80	# a dynamic service type which will be
3950
#					# fleshed out with subsequent options.
3951
#	wccp2_service standard 0 password=foo
3952
#Default:
3953
# wccp2_service standard 0
3954
3955
#  TAG: wccp2_service_info
3956
#	Dynamic WCCPv2 services require further information to define the
3957
#	traffic you wish to have diverted.
3958
#
3959
#	The format is:
3960
#
3961
#	wccp2_service_info <id> protocol=<protocol> flags=<flag>,<flag>..
3962
#	    priority=<priority> ports=<port>,<port>..
3963
#
3964
#	The relevant WCCPv2 flags:
3965
#	+ src_ip_hash, dst_ip_hash
3966
#	+ source_port_hash, dst_port_hash
3967
#	+ src_ip_alt_hash, dst_ip_alt_hash
3968
#	+ src_port_alt_hash, dst_port_alt_hash
3969
#	+ ports_source
3970
#
3971
#	The port list can be one to eight entries.
3972
#
3973
#	Example:
3974
#
3975
#	wccp2_service_info 80 protocol=tcp flags=src_ip_hash,ports_source
3976
#	    priority=240 ports=80
3977
#
3978
#	Note: the service id must have been defined by a previous
3979
#	'wccp2_service dynamic <id>' entry.
3980
#Default:
3981
# none
3982
3983
#  TAG: wccp2_weight
3984
#	Each cache server gets assigned a set of the destination
3985
#	hash proportional to their weight.
3986
#Default:
3987
# wccp2_weight 10000
3988
3989
#  TAG: wccp_address
3990
#  TAG: wccp2_address
3991
#	Use this option if you require WCCP to use a specific
3992
#	interface address.
3993
#
3994
#	The default behavior is to not bind to any specific address.
3995
#Default:
3996
# wccp_address 0.0.0.0
3997
# wccp2_address 0.0.0.0
3998
3999
# PERSISTENT CONNECTION HANDLING
4000
# -----------------------------------------------------------------------------
4001
#
4002
# Also see "pconn_timeout" in the TIMEOUTS section
4003
4004
#  TAG: client_persistent_connections
4005
#  TAG: server_persistent_connections
4006
#	Persistent connection support for clients and servers.  By
4007
#	default, Squid uses persistent connections (when allowed)
4008
#	with its clients and servers.  You can use these options to
4009
#	disable persistent connections with clients and/or servers.
4010
#Default:
4011
# client_persistent_connections on
4012
# server_persistent_connections on
4013
4014
#  TAG: persistent_connection_after_error
4015
#	With this directive the use of persistent connections after
4016
#	HTTP errors can be disabled. Useful if you have clients
4017
#	who fail to handle errors on persistent connections proper.
4018
#Default:
4019
# persistent_connection_after_error on
4020
4021
#  TAG: detect_broken_pconn
4022
#	Some servers have been found to incorrectly signal the use
4023
#	of HTTP/1.0 persistent connections even on replies not
4024
#	compatible, causing significant delays. This server problem
4025
#	has mostly been seen on redirects.
4026
#
4027
#	By enabling this directive Squid attempts to detect such
4028
#	broken replies and automatically assume the reply is finished
4029
#	after 10 seconds timeout.
4030
#Default:
4031
# detect_broken_pconn off
4032
4033
# CACHE DIGEST OPTIONS
4034
# -----------------------------------------------------------------------------
4035
4036
#  TAG: digest_generation
4037
#	This controls whether the server will generate a Cache Digest
4038
#	of its contents.  By default, Cache Digest generation is
4039
#	enabled if Squid is compiled with --enable-cache-digests defined.
4040
#Default:
4041
# digest_generation on
4042
4043
#  TAG: digest_bits_per_entry
4044
#	This is the number of bits of the server's Cache Digest which
4045
#	will be associated with the Digest entry for a given HTTP
4046
#	Method and URL (public key) combination.  The default is 5.
4047
#Default:
4048
# digest_bits_per_entry 5
4049
4050
#  TAG: digest_rebuild_period	(seconds)
4051
#	This is the wait time between Cache Digest rebuilds.
4052
#Default:
4053
# digest_rebuild_period 1 hour
4054
4055
#  TAG: digest_rewrite_period	(seconds)
4056
#	This is the wait time between Cache Digest writes to
4057
#	disk.
4058
#Default:
4059
# digest_rewrite_period 1 hour
4060
4061
#  TAG: digest_swapout_chunk_size	(bytes)
4062
#	This is the number of bytes of the Cache Digest to write to
4063
#	disk at a time.  It defaults to 4096 bytes (4KB), the Squid
4064
#	default swap page.
4065
#Default:
4066
# digest_swapout_chunk_size 4096 bytes
4067
4068
#  TAG: digest_rebuild_chunk_percentage	(percent, 0-100)
4069
#	This is the percentage of the Cache Digest to be scanned at a
4070
#	time.  By default it is set to 10% of the Cache Digest.
4071
#Default:
4072
# digest_rebuild_chunk_percentage 10
4073
4074
# SNMP OPTIONS
4075
# -----------------------------------------------------------------------------
4076
4077
#  TAG: snmp_port
4078
#	The port number where Squid listens for SNMP requests. To enable
4079
#	SNMP support set this to a suitable port number. Port number
4080
#	3401 is often used for the Squid SNMP agent. By default it's
4081
#	set to "0" (disabled)
4082
#
4083
#	Example:
4084
#		snmp_port 3401
4085
#Default:
4086
# snmp_port 0
4087
4088
#  TAG: snmp_access
4089
#	Allowing or denying access to the SNMP port.
4090
#
4091
#	All access to the agent is denied by default.
4092
#	usage:
4093
#
4094
#	snmp_access allow|deny [!]aclname ...
4095
#
4096
#	This clause only supports fast acl types.
4097
#	See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
4098
#Example:
4099
# snmp_access allow snmppublic localhost
4100
# snmp_access deny all
4101
#Default:
4102
# snmp_access deny all
4103
4104
#  TAG: snmp_incoming_address
4105
#  TAG: snmp_outgoing_address
4106
#	Just like 'udp_incoming_address', but for the SNMP port.
4107
#
4108
#	snmp_incoming_address	is used for the SNMP socket receiving
4109
#				messages from SNMP agents.
4110
#	snmp_outgoing_address	is used for SNMP packets returned to SNMP
4111
#				agents.
4112
#
4113
#	The default snmp_incoming_address is to listen on all
4114
#	available network interfaces.
4115
#
4116
#	If snmp_outgoing_address is not set it will use the same socket
4117
#	as snmp_incoming_address. Only change this if you want to have
4118
#	SNMP replies sent using another address than where this Squid
4119
#	listens for SNMP queries.
4120
#
4121
#	NOTE, snmp_incoming_address and snmp_outgoing_address can not have
4122
#	the same value since they both use port 3401.
4123
#Default:
4124
# snmp_incoming_address any_addr
4125
# snmp_outgoing_address no_addr
4126
4127
# ICP OPTIONS
4128
# -----------------------------------------------------------------------------
4129
4130
#  TAG: icp_port
4131
#	The port number where Squid sends and receives ICP queries to
4132
#	and from neighbor caches.  The standard UDP port for ICP is 3130.
4133
#	Default is disabled (0).
4134
#
4135
#	Example:
4136
#		icp_port 3130
4137
#Default:
4138
# icp_port 0
4139
4140
#  TAG: htcp_port
4141
#	The port number where Squid sends and receives HTCP queries to
4142
#	and from neighbor caches.  To turn it on you want to set it to
4143
#	4827. By default it is set to "0" (disabled).
4144
#
4145
#	Example:
4146
#		htcp_port 4827
4147
#Default:
4148
# htcp_port 0
4149
4150
#  TAG: log_icp_queries	on|off
4151
#	If set, ICP queries are logged to access.log. You may wish
4152
#	do disable this if your ICP load is VERY high to speed things
4153
#	up or to simplify log analysis.
4154
#Default:
4155
# log_icp_queries on
4156
4157
#  TAG: udp_incoming_address
4158
#	udp_incoming_address	is used for UDP packets received from other
4159
#				caches.
4160
#
4161
#	The default behavior is to not bind to any specific address.
4162
#
4163
#	Only change this if you want to have all UDP queries received on
4164
#	a specific interface/address.
4165
#
4166
#	NOTE: udp_incoming_address is used by the ICP, HTCP, and DNS
4167
#	modules. Altering it will affect all of them in the same manner.
4168
#
4169
#	see also; udp_outgoing_address
4170
#
4171
#	NOTE, udp_incoming_address and udp_outgoing_address can not
4172
#	have the same value since they both use the same port.
4173
#Default:
4174
# udp_incoming_address any_addr
4175
4176
#  TAG: udp_outgoing_address
4177
#	udp_outgoing_address	is used for UDP packets sent out to other
4178
#				caches.
4179
#
4180
#	The default behavior is to not bind to any specific address.
4181
#
4182
#	Instead it will use the same socket as udp_incoming_address.
4183
#	Only change this if you want to have UDP queries sent using another
4184
#	address than where this Squid listens for UDP queries from other
4185
#	caches.
4186
#
4187
#	NOTE: udp_outgoing_address is used by the ICP, HTCP, and DNS
4188
#	modules. Altering it will affect all of them in the same manner.
4189
#
4190
#	see also; udp_incoming_address
4191
#
4192
#	NOTE, udp_incoming_address and udp_outgoing_address can not
4193
#	have the same value since they both use the same port.
4194
#Default:
4195
# udp_outgoing_address no_addr
4196
4197
#  TAG: icp_hit_stale	on|off
4198
#	If you want to return ICP_HIT for stale cache objects, set this
4199
#	option to 'on'.  If you have sibling relationships with caches
4200
#	in other administrative domains, this should be 'off'.  If you only
4201
#	have sibling relationships with caches under your control,
4202
#	it is probably okay to set this to 'on'.
4203
#	If set to 'on', your siblings should use the option "allow-miss"
4204
#	on their cache_peer lines for connecting to you.
4205
#Default:
4206
# icp_hit_stale off
4207
4208
#  TAG: minimum_direct_hops
4209
#	If using the ICMP pinging stuff, do direct fetches for sites
4210
#	which are no more than this many hops away.
4211
#Default:
4212
# minimum_direct_hops 4
4213
4214
#  TAG: minimum_direct_rtt
4215
#	If using the ICMP pinging stuff, do direct fetches for sites
4216
#	which are no more than this many rtt milliseconds away.
4217
#Default:
4218
# minimum_direct_rtt 400
4219
4220
#  TAG: netdb_low
4221
#  TAG: netdb_high
4222
#	The low and high water marks for the ICMP measurement
4223
#	database.  These are counts, not percents.  The defaults are
4224
#	900 and 1000.  When the high water mark is reached, database
4225
#	entries will be deleted until the low mark is reached.
4226
#Default:
4227
# netdb_low 900
4228
# netdb_high 1000
4229
4230
#  TAG: netdb_ping_period
4231
#	The minimum period for measuring a site.  There will be at
4232
#	least this much delay between successive pings to the same
4233
#	network.  The default is five minutes.
4234
#Default:
4235
# netdb_ping_period 5 minutes
4236
4237
#  TAG: query_icmp	on|off
4238
#	If you want to ask your peers to include ICMP data in their ICP
4239
#	replies, enable this option.
4240
#
4241
#	If your peer has configured Squid (during compilation) with
4242
#	'--enable-icmp' that peer will send ICMP pings to origin server
4243
#	sites of the URLs it receives.  If you enable this option the
4244
#	ICP replies from that peer will include the ICMP data (if available).
4245
#	Then, when choosing a parent cache, Squid will choose the parent with
4246
#	the minimal RTT to the origin server.  When this happens, the
4247
#	hierarchy field of the access.log will be
4248
#	"CLOSEST_PARENT_MISS".  This option is off by default.
4249
#Default:
4250
# query_icmp off
4251
4252
#  TAG: test_reachability	on|off
4253
#	When this is 'on', ICP MISS replies will be ICP_MISS_NOFETCH
4254
#	instead of ICP_MISS if the target host is NOT in the ICMP
4255
#	database, or has a zero RTT.
4256
#Default:
4257
# test_reachability off
4258
4259
#  TAG: icp_query_timeout	(msec)
4260
#	Normally Squid will automatically determine an optimal ICP
4261
#	query timeout value based on the round-trip-time of recent ICP
4262
#	queries.  If you want to override the value determined by
4263
#	Squid, set this 'icp_query_timeout' to a non-zero value.  This
4264
#	value is specified in MILLISECONDS, so, to use a 2-second
4265
#	timeout (the old default), you would write:
4266
#
4267
#		icp_query_timeout 2000
4268
#Default:
4269
# icp_query_timeout 0
4270
4271
#  TAG: maximum_icp_query_timeout	(msec)
4272
#	Normally the ICP query timeout is determined dynamically.  But
4273
#	sometimes it can lead to very large values (say 5 seconds).
4274
#	Use this option to put an upper limit on the dynamic timeout
4275
#	value.  Do NOT use this option to always use a fixed (instead
4276
#	of a dynamic) timeout value. To set a fixed timeout see the
4277
#	'icp_query_timeout' directive.
4278
#Default:
4279
# maximum_icp_query_timeout 2000
4280
4281
#  TAG: minimum_icp_query_timeout	(msec)
4282
#	Normally the ICP query timeout is determined dynamically.  But
4283
#	sometimes it can lead to very small timeouts, even lower than
4284
#	the normal latency variance on your link due to traffic.
4285
#	Use this option to put an lower limit on the dynamic timeout
4286
#	value.  Do NOT use this option to always use a fixed (instead
4287
#	of a dynamic) timeout value. To set a fixed timeout see the
4288
#	'icp_query_timeout' directive.
4289
#Default:
4290
# minimum_icp_query_timeout 5
4291
4292
#  TAG: background_ping_rate	time-units
4293
#	Controls how often the ICP pings are sent to siblings that
4294
#	have background-ping set.
4295
#Default:
4296
# background_ping_rate 10 seconds
4297
4298
# MULTICAST ICP OPTIONS
4299
# -----------------------------------------------------------------------------
4300
4301
#  TAG: mcast_groups
4302
#	This tag specifies a list of multicast groups which your server
4303
#	should join to receive multicasted ICP queries.
4304
#
4305
#	NOTE!  Be very careful what you put here!  Be sure you
4306
#	understand the difference between an ICP _query_ and an ICP
4307
#	_reply_.  This option is to be set only if you want to RECEIVE
4308
#	multicast queries.  Do NOT set this option to SEND multicast
4309
#	ICP (use cache_peer for that).  ICP replies are always sent via
4310
#	unicast, so this option does not affect whether or not you will
4311
#	receive replies from multicast group members.
4312
#
4313
#	You must be very careful to NOT use a multicast address which
4314
#	is already in use by another group of caches.
4315
#
4316
#	If you are unsure about multicast, please read the Multicast
4317
#	chapter in the Squid FAQ (http://www.squid-cache.org/FAQ/).
4318
#
4319
#	Usage: mcast_groups 239.128.16.128 224.0.1.20
4320
#
4321
#	By default, Squid doesn't listen on any multicast groups.
4322
#Default:
4323
# none
4324
4325
#  TAG: mcast_miss_addr
4326
# Note: This option is only available if Squid is rebuilt with the
4327
#       -DMULTICAST_MISS_STREAM define
4328
#
4329
#	If you enable this option, every "cache miss" URL will
4330
#	be sent out on the specified multicast address.
4331
#
4332
#	Do not enable this option unless you are are absolutely
4333
#	certain you understand what you are doing.
4334
#Default:
4335
# mcast_miss_addr no_addr
4336
4337
#  TAG: mcast_miss_ttl
4338
# Note: This option is only available if Squid is rebuilt with the
4339
#       -DMULTICAST_MISS_STREAM define
4340
#
4341
#	This is the time-to-live value for packets multicasted
4342
#	when multicasting off cache miss URLs is enabled.  By
4343
#	default this is set to 'site scope', i.e. 16.
4344
#Default:
4345
# mcast_miss_ttl 16
4346
4347
#  TAG: mcast_miss_port
4348
# Note: This option is only available if Squid is rebuilt with the
4349
#       -DMULTICAST_MISS_STREAM define
4350
#
4351
#	This is the port number to be used in conjunction with
4352
#	'mcast_miss_addr'.
4353
#Default:
4354
# mcast_miss_port 3135
4355
4356
#  TAG: mcast_miss_encode_key
4357
# Note: This option is only available if Squid is rebuilt with the
4358
#       -DMULTICAST_MISS_STREAM define
4359
#
4360
#	The URLs that are sent in the multicast miss stream are
4361
#	encrypted.  This is the encryption key.
4362
#Default:
4363
# mcast_miss_encode_key XXXXXXXXXXXXXXXX
4364
4365
#  TAG: mcast_icp_query_timeout	(msec)
4366
#	For multicast peers, Squid regularly sends out ICP "probes" to
4367
#	count how many other peers are listening on the given multicast
4368
#	address.  This value specifies how long Squid should wait to
4369
#	count all the replies.  The default is 2000 msec, or 2
4370
#	seconds.
4371
#Default:
4372
# mcast_icp_query_timeout 2000
4373
4374
# INTERNAL ICON OPTIONS
4375
# -----------------------------------------------------------------------------
4376
4377
#  TAG: icon_directory
4378
#	Where the icons are stored. These are normally kept in
4379
#	/usr/share/squid3/icons
4380
#Default:
4381
# icon_directory /usr/share/squid3/icons
4382
4383
#  TAG: global_internal_static
4384
#	This directive controls is Squid should intercept all requests for
4385
#	/squid-internal-static/ no matter which host the URL is requesting
4386
#	(default on setting), or if nothing special should be done for
4387
#	such URLs (off setting). The purpose of this directive is to make
4388
#	icons etc work better in complex cache hierarchies where it may
4389
#	not always be possible for all corners in the cache mesh to reach
4390
#	the server generating a directory listing.
4391
#Default:
4392
# global_internal_static on
4393
4394
#  TAG: short_icon_urls
4395
#	If this is enabled Squid will use short URLs for icons.
4396
#	If disabled it will revert to the old behavior of including
4397
#	it's own name and port in the URL.
4398
#
4399
#	If you run a complex cache hierarchy with a mix of Squid and
4400
#	other proxies you may need to disable this directive.
4401
#Default:
4402
# short_icon_urls on
4403
4404
# ERROR PAGE OPTIONS
4405
# -----------------------------------------------------------------------------
4406
4407
#  TAG: error_directory
4408
#	If you wish to create your own versions of the default
4409
#	error files to customize them to suit your company copy
4410
#	the error/template files to another directory and point
4411
#	this tag at them.
4412
#
4413
#	WARNING: This option will disable multi-language support
4414
#	         on error pages if used.
4415
#
4416
#	The squid developers are interested in making squid available in
4417
#	a wide variety of languages. If you are making translations for a
4418
#	language that Squid does not currently provide please consider
4419
#	contributing your translation back to the project.
4420
#	http://wiki.squid-cache.org/Translations
4421
#
4422
#	The squid developers working on translations are happy to supply drop-in
4423
#	translated error files in exchange for any new language contributions.
4424
#Default:
4425
# none
4426
4427
#  TAG: error_default_language
4428
#	Set the default language which squid will send error pages in
4429
#	if no existing translation matches the clients language
4430
#	preferences.
4431
#
4432
#	If unset (default) generic English will be used.
4433
#
4434
#	The squid developers are interested in making squid available in
4435
#	a wide variety of languages. If you are interested in making
4436
#	translations for any language see the squid wiki for details.
4437
#	http://wiki.squid-cache.org/Translations
4438
#Default:
4439
# none
4440
4441
#  TAG: error_log_languages
4442
#	Log to cache.log what languages users are attempting to
4443
#	auto-negotiate for translations.
4444
#
4445
#	Successful negotiations are not logged. Only failures
4446
#	have meaning to indicate that Squid may need an upgrade
4447
#	of its error page translations.
4448
#Default:
4449
# error_log_languages on
4450
4451
#  TAG: err_page_stylesheet
4452
#	CSS Stylesheet to pattern the display of Squid default error pages.
4453
#
4454
#	For information on CSS see http://www.w3.org/Style/CSS/
4455
#Default:
4456
# err_page_stylesheet /etc/squid3/errorpage.css
4457
4458
#  TAG: err_html_text
4459
#	HTML text to include in error messages.  Make this a "mailto"
4460
#	URL to your admin address, or maybe just a link to your
4461
#	organizations Web page.
4462
#
4463
#	To include this in your error messages, you must rewrite
4464
#	the error template files (found in the "errors" directory).
4465
#	Wherever you want the 'err_html_text' line to appear,
4466
#	insert a %L tag in the error template file.
4467
#Default:
4468
# none
4469
4470
#  TAG: email_err_data	on|off
4471
#	If enabled, information about the occurred error will be
4472
#	included in the mailto links of the ERR pages (if %W is set)
4473
#	so that the email body contains the data.
4474
#	Syntax is <A HREF="mailto:%w%W">%w</A>
4475
#Default:
4476
# email_err_data on
4477
4478
#  TAG: deny_info
4479
#	Usage:   deny_info err_page_name acl
4480
#	or       deny_info http://... acl
4481
#	or       deny_info TCP_RESET acl
4482
#
4483
#	This can be used to return a ERR_ page for requests which
4484
#	do not pass the 'http_access' rules.  Squid remembers the last
4485
#	acl it evaluated in http_access, and if a 'deny_info' line exists
4486
#	for that ACL Squid returns a corresponding error page.
4487
#
4488
#	The acl is typically the last acl on the http_access deny line which
4489
#	denied access. The exceptions to this rule are:
4490
#	- When Squid needs to request authentication credentials. It's then
4491
#	  the first authentication related acl encountered
4492
#	- When none of the http_access lines matches. It's then the last
4493
#	  acl processed on the last http_access line.
4494
#
4495
#	NP: If providing your own custom error pages with error_directory
4496
#	    you may also specify them by your custom file name:
4497
#	    Example: deny_info ERR_CUSTOM_ACCESS_DENIED bad_guys
4498
#
4499
#	Alternatively you can specify an error URL. The browsers will
4500
#	get redirected (302) to the specified URL. %s in the redirection
4501
#	URL will be replaced by the requested URL.
4502
#
4503
#	Alternatively you can tell Squid to reset the TCP connection
4504
#	by specifying TCP_RESET.
4505
#Default:
4506
# none
4507
4508
# OPTIONS INFLUENCING REQUEST FORWARDING 
4509
# -----------------------------------------------------------------------------
4510
4511
#  TAG: nonhierarchical_direct
4512
#	By default, Squid will send any non-hierarchical requests
4513
#	(matching hierarchy_stoplist or not cacheable request type) direct
4514
#	to origin servers.
4515
#
4516
#	If you set this to off, Squid will prefer to send these
4517
#	requests to parents.
4518
#
4519
#	Note that in most configurations, by turning this off you will only
4520
#	add latency to these request without any improvement in global hit
4521
#	ratio.
4522
#
4523
#	If you are inside an firewall see never_direct instead of
4524
#	this directive.
4525
#Default:
4526
# nonhierarchical_direct on
4527
4528
#  TAG: prefer_direct
4529
#	Normally Squid tries to use parents for most requests. If you for some
4530
#	reason like it to first try going direct and only use a parent if
4531
#	going direct fails set this to on.
4532
#
4533
#	By combining nonhierarchical_direct off and prefer_direct on you
4534
#	can set up Squid to use a parent as a backup path if going direct
4535
#	fails.
4536
#
4537
#	Note: If you want Squid to use parents for all requests see
4538
#	the never_direct directive. prefer_direct only modifies how Squid
4539
#	acts on cacheable requests.
4540
#Default:
4541
# prefer_direct off
4542
4543
#  TAG: always_direct
4544
#	Usage: always_direct allow|deny [!]aclname ...
4545
#
4546
#	Here you can use ACL elements to specify requests which should
4547
#	ALWAYS be forwarded by Squid to the origin servers without using
4548
#	any peers.  For example, to always directly forward requests for
4549
#	local servers ignoring any parents or siblings you may have use
4550
#	something like:
4551
#
4552
#		acl local-servers dstdomain my.domain.net
4553
#		always_direct allow local-servers
4554
#
4555
#	To always forward FTP requests directly, use
4556
#
4557
#		acl FTP proto FTP
4558
#		always_direct allow FTP
4559
#
4560
#	NOTE: There is a similar, but opposite option named
4561
#	'never_direct'.  You need to be aware that "always_direct deny
4562
#	foo" is NOT the same thing as "never_direct allow foo".  You
4563
#	may need to use a deny rule to exclude a more-specific case of
4564
#	some other rule.  Example:
4565
#
4566
#		acl local-external dstdomain external.foo.net
4567
#		acl local-servers dstdomain  .foo.net
4568
#		always_direct deny local-external
4569
#		always_direct allow local-servers
4570
#
4571
#	NOTE: If your goal is to make the client forward the request
4572
#	directly to the origin server bypassing Squid then this needs
4573
#	to be done in the client configuration. Squid configuration
4574
#	can only tell Squid how Squid should fetch the object.
4575
#
4576
#	NOTE: This directive is not related to caching. The replies
4577
#	is cached as usual even if you use always_direct. To not cache
4578
#	the replies see the 'cache' directive.
4579
#
4580
#	This clause supports both fast and slow acl types.
4581
#	See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
4582
#Default:
4583
# none
4584
4585
#  TAG: never_direct
4586
#	Usage: never_direct allow|deny [!]aclname ...
4587
#
4588
#	never_direct is the opposite of always_direct.  Please read
4589
#	the description for always_direct if you have not already.
4590
#
4591
#	With 'never_direct' you can use ACL elements to specify
4592
#	requests which should NEVER be forwarded directly to origin
4593
#	servers.  For example, to force the use of a proxy for all
4594
#	requests, except those in your local domain use something like:
4595
#
4596
#		acl local-servers dstdomain .foo.net
4597
#		never_direct deny local-servers
4598
#		never_direct allow all
4599
#
4600
#	or if Squid is inside a firewall and there are local intranet
4601
#	servers inside the firewall use something like:
4602
#
4603
#		acl local-intranet dstdomain .foo.net
4604
#		acl local-external dstdomain external.foo.net
4605
#		always_direct deny local-external
4606
#		always_direct allow local-intranet
4607
#		never_direct allow all
4608
#
4609
#	This clause supports both fast and slow acl types.
4610
#	See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
4611
#Default:
4612
# none
4613
4614
# ADVANCED NETWORKING OPTIONS
4615
# -----------------------------------------------------------------------------
4616
4617
#  TAG: incoming_icp_average
4618
#  TAG: incoming_http_average
4619
#  TAG: incoming_dns_average
4620
#  TAG: min_icp_poll_cnt
4621
#  TAG: min_dns_poll_cnt
4622
#  TAG: min_http_poll_cnt
4623
#	Heavy voodoo here.  I can't even believe you are reading this.
4624
#	Are you crazy?  Don't even think about adjusting these unless
4625
#	you understand the algorithms in comm_select.c first!
4626
#Default:
4627
# incoming_icp_average 6
4628
# incoming_http_average 4
4629
# incoming_dns_average 4
4630
# min_icp_poll_cnt 8
4631
# min_dns_poll_cnt 8
4632
# min_http_poll_cnt 8
4633
4634
#  TAG: accept_filter
4635
#	FreeBSD:
4636
#
4637
#	The name of an accept(2) filter to install on Squid's
4638
#	listen socket(s).  This feature is perhaps specific to
4639
#	FreeBSD and requires support in the kernel.
4640
#
4641
#	The 'httpready' filter delays delivering new connections
4642
#	to Squid until a full HTTP request has been received.
4643
#	See the accf_http(9) man page for details.
4644
#
4645
#	The 'dataready' filter delays delivering new connections
4646
#	to Squid until there is some data to process.
4647
#	See the accf_dataready(9) man page for details.
4648
#
4649
#	Linux:
4650
#	
4651
#	The 'data' filter delays delivering of new connections
4652
#	to Squid until there is some data to process by TCP_ACCEPT_DEFER.
4653
#	You may optionally specify a number of seconds to wait by
4654
#	'data=N' where N is the number of seconds. Defaults to 30
4655
#	if not specified.  See the tcp(7) man page for details.
4656
#EXAMPLE:
4657
## FreeBSD
4658
#accept_filter httpready
4659
## Linux
4660
#accept_filter data
4661
#Default:
4662
# none
4663
4664
#  TAG: client_ip_max_connections
4665
#	Set an absolute limit on the number of connections a single
4666
#	client IP can use. Any more than this and Squid will begin to drop
4667
#	new connections from the client until it closes some links.
4668
#
4669
#	Note that this is a global limit. It affects all HTTP, HTCP, Gopher and FTP
4670
#	connections from the client. For finer control use the ACL access controls.
4671
#
4672
#	Requires client_db to be enabled (the default).
4673
#
4674
#	WARNING: This may noticably slow down traffic received via external proxies
4675
#	or NAT devices and cause them to rebound error messages back to their clients.
4676
#Default:
4677
# client_ip_max_connections -1
4678
4679
#  TAG: tcp_recv_bufsize	(bytes)
4680
#	Size of receive buffer to set for TCP sockets.  Probably just
4681
#	as easy to change your kernel's default.  Set to zero to use
4682
#	the default buffer size.
4683
#Default:
4684
# tcp_recv_bufsize 0 bytes
4685
4686
# ICAP OPTIONS
4687
# -----------------------------------------------------------------------------
4688
4689
#  TAG: icap_enable	on|off
4690
#	If you want to enable the ICAP module support, set this to on.
4691
#Default:
4692
# icap_enable off
4693
4694
#  TAG: icap_connect_timeout
4695
#	This parameter specifies how long to wait for the TCP connect to
4696
#	the requested ICAP server to complete before giving up and either
4697
#	terminating the HTTP transaction or bypassing the failure.
4698
#
4699
#	The default for optional services is peer_connect_timeout.
4700
#	The default for essential services is connect_timeout.
4701
#	If this option is explicitly set, its value applies to all services.
4702
#Default:
4703
# none
4704
4705
#  TAG: icap_io_timeout	time-units
4706
#	This parameter specifies how long to wait for an I/O activity on
4707
#	an established, active ICAP connection before giving up and
4708
#	either terminating the HTTP transaction or bypassing the
4709
#	failure.
4710
#
4711
#	The default is read_timeout.
4712
#Default:
4713
# none
4714
4715
#  TAG: icap_service_failure_limit
4716
#	The limit specifies the number of failures that Squid tolerates
4717
#	when establishing a new TCP connection with an ICAP service. If
4718
#	the number of failures exceeds the limit, the ICAP service is
4719
#	not used for new ICAP requests until it is time to refresh its
4720
#	OPTIONS. The per-service failure counter is reset to zero each
4721
#	time Squid fetches new service OPTIONS.
4722
#
4723
#	A negative value disables the limit. Without the limit, an ICAP
4724
#	service will not be considered down due to connectivity failures
4725
#	between ICAP OPTIONS requests.
4726
#Default:
4727
# icap_service_failure_limit 10
4728
4729
#  TAG: icap_service_revival_delay
4730
#	The delay specifies the number of seconds to wait after an ICAP
4731
#	OPTIONS request failure before requesting the options again. The
4732
#	failed ICAP service is considered "down" until fresh OPTIONS are
4733
#	fetched.
4734
#
4735
#	The actual delay cannot be smaller than the hardcoded minimum
4736
#	delay of 30 seconds.
4737
#Default:
4738
# icap_service_revival_delay 180
4739
4740
#  TAG: icap_preview_enable	on|off
4741
#	The ICAP Preview feature allows the ICAP server to handle the
4742
#	HTTP message by looking only at the beginning of the message body
4743
#	or even without receiving the body at all. In some environments, 
4744
#	previews greatly speedup ICAP processing.
4745
#
4746
#	During an ICAP OPTIONS transaction, the server may tell	Squid what
4747
#	HTTP messages should be previewed and how big the preview should be.
4748
#	Squid will not use Preview if the server did not request one.
4749
#
4750
#	To disable ICAP Preview for all ICAP services, regardless of
4751
#	individual ICAP server OPTIONS responses, set this option to "off".
4752
#Example:
4753
#icap_preview_enable off
4754
#Default:
4755
# icap_preview_enable on
4756
4757
#  TAG: icap_preview_size
4758
#	The default size of preview data to be sent to the ICAP server.
4759
#	-1 means no preview. This value might be overwritten on a per server
4760
#	basis by OPTIONS requests.
4761
#Default:
4762
# icap_preview_size -1
4763
4764
#  TAG: icap_default_options_ttl
4765
#	The default TTL value for ICAP OPTIONS responses that don't have
4766
#	an Options-TTL header.
4767
#Default:
4768
# icap_default_options_ttl 60
4769
4770
#  TAG: icap_persistent_connections	on|off
4771
#	Whether or not Squid should use persistent connections to
4772
#	an ICAP server.
4773
#Default:
4774
# icap_persistent_connections on
4775
4776
#  TAG: icap_send_client_ip	on|off
4777
#	This adds the header "X-Client-IP" to ICAP requests.
4778
#Default:
4779
# icap_send_client_ip off
4780
4781
#  TAG: icap_send_client_username	on|off
4782
#	This sends authenticated HTTP client username (if available) to
4783
#	the ICAP service. The username value is encoded based on the
4784
#	icap_client_username_encode option and is sent using the header
4785
#	specified by the icap_client_username_header option.
4786
#Default:
4787
# icap_send_client_username off
4788
4789
#  TAG: icap_client_username_header
4790
#	ICAP request header name to use for send_client_username.
4791
#Default:
4792
# icap_client_username_header X-Client-Username
4793
4794
#  TAG: icap_client_username_encode	on|off
4795
#	Whether to base64 encode the authenticated client username.
4796
#Default:
4797
# icap_client_username_encode off
4798
4799
#  TAG: icap_service
4800
#	Defines a single ICAP service using the following format:
4801
#
4802
#	icap_service service_name vectoring_point [options] service_url
4803
#
4804
#	service_name: ID
4805
#		an opaque identifier which must be unique in squid.conf
4806
#
4807
#	vectoring_point: reqmod_precache|reqmod_postcache|respmod_precache|respmod_postcache
4808
#		This specifies at which point of transaction processing the
4809
#		ICAP service should be activated. *_postcache vectoring points
4810
#		are not yet supported.
4811
#
4812
#	service_url: icap://servername:port/servicepath
4813
#		ICAP server and service location.
4814
#
4815
#	ICAP does not allow a single service to handle both REQMOD and RESPMOD
4816
#	transactions. Squid does not enforce that requirement. You can specify
4817
#	services with the same service_url and different vectoring_points. You
4818
#	can even specify multiple identical services as long as their
4819
#	service_names differ.
4820
#
4821
#
4822
#	Service options are separated by white space. ICAP services support
4823
#	the following name=value options:
4824
#
4825
#	bypass=on|off|1|0
4826
#		If set to 'on' or '1', the ICAP service is treated as
4827
#		optional. If the service cannot be reached or malfunctions,
4828
#		Squid will try to ignore any errors and process the message as
4829
#		if the service was not enabled. No all ICAP errors can be
4830
#		bypassed.  If set to 0, the ICAP service is treated as
4831
#		essential and all ICAP errors will result in an error page
4832
#		returned to the HTTP client.
4833
#
4834
#		Bypass is off by default: services are treated as essential.
4835
#
4836
#	routing=on|off|1|0
4837
#		If set to 'on' or '1', the ICAP service is allowed to
4838
#		dynamically change the current message adaptation plan by
4839
#		returning a chain of services to be used next. The services
4840
#		are specified using the X-Next-Services ICAP response header
4841
#		value, formatted as a comma-separated list of service names.
4842
#		Each named service should be configured in squid.conf and
4843
#		should have the same method and vectoring point as the current
4844
#		ICAP transaction.  Services violating these rules are ignored.
4845
#		An empty X-Next-Services value results in an empty plan which
4846
#		ends the current adaptation. 
4847
#
4848
#		Routing is not allowed by default: the ICAP X-Next-Services
4849
#		response header is ignored.
4850
#
4851
#	Older icap_service format without optional named parameters is
4852
#	deprecated but supported for backward compatibility.
4853
#
4854
#Example:
4855
#icap_service svcBlocker reqmod_precache bypass=0 icap://icap1.mydomain.net:1344/reqmod
4856
#icap_service svcLogger reqmod_precache routing=on icap://icap2.mydomain.net:1344/respmod
4857
#Default:
4858
# none
4859
4860
#  TAG: icap_class
4861
#	This deprecated option was documented to define an ICAP service
4862
#	chain, even though it actually defined a set of similar, redundant
4863
#	services, and the chains were not supported. 
4864
#
4865
#	To define a set of redundant services, please use the
4866
#	adaptation_service_set directive. For service chains, use
4867
#	adaptation_service_chain.
4868
#Default:
4869
# none
4870
4871
#  TAG: icap_access
4872
#	This option is deprecated. Please use adaptation_access, which
4873
#	has the same ICAP functionality, but comes with better
4874
#	documentation, and eCAP support.
4875
#Default:
4876
# none
4877
4878
# eCAP OPTIONS
4879
# -----------------------------------------------------------------------------
4880
4881
#  TAG: ecap_enable	on|off
4882
# Note: This option is only available if Squid is rebuilt with the
4883
#       --enable-ecap option
4884
#
4885
#	Controls whether eCAP support is enabled.
4886
#Default:
4887
# ecap_enable off
4888
4889
#  TAG: ecap_service
4890
# Note: This option is only available if Squid is rebuilt with the
4891
#       --enable-ecap option
4892
#
4893
#	Defines a single eCAP service
4894
#
4895
#	ecap_service servicename vectoring_point bypass service_url
4896
#
4897
#	vectoring_point = reqmod_precache|reqmod_postcache|respmod_precache|respmod_postcache
4898
#		This specifies at which point of transaction processing the
4899
#		eCAP service should be activated. *_postcache vectoring points
4900
#		are not yet supported.
4901
#	bypass = 1|0
4902
#		If set to 1, the eCAP service is treated as optional. If the
4903
#		service cannot be reached or malfunctions, Squid will try to
4904
#		ignore any errors and process the message as if the service
4905
#		was not enabled. No all eCAP errors can be bypassed.
4906
#		If set to 0, the eCAP service is treated as essential and all
4907
#		eCAP errors will result in an error page returned to the
4908
#		HTTP client.
4909
#	service_url = ecap://vendor/service_name?custom&cgi=style&parameters=optional
4910
#
4911
#Example:
4912
#ecap_service service_1 reqmod_precache 0 ecap://filters-R-us/leakDetector?on_error=block
4913
#ecap_service service_2 respmod_precache 1 icap://filters-R-us/virusFilter?config=/etc/vf.cfg
4914
#Default:
4915
# none
4916
4917
#  TAG: loadable_modules
4918
#	Instructs Squid to load the specified dynamic module(s) or activate
4919
#	preloaded module(s).
4920
#Example:
4921
#loadable_modules /usr/lib/MinimalAdapter.so
4922
#Default:
4923
# none
4924
4925
# MESSAGE ADAPTATION OPTIONS
4926
# -----------------------------------------------------------------------------
4927
4928
#  TAG: adaptation_service_set
4929
#
4930
#	Configures an ordered set of similar, redundant services. This is
4931
#	useful when hot standby or backup adaptation servers are available.
4932
#
4933
#	    adaptation_service_set set_name service_name1 service_name2 ...
4934
#
4935
# 	The named services are used in the set declaration order. The first
4936
#	applicable adaptation service from the set is used first. The next
4937
#	applicable service is tried if and only if the transaction with the
4938
#	previous service fails and the message waiting to be adapted is still
4939
#	intact.
4940
#
4941
#	When adaptation starts, broken services are ignored as if they were
4942
#	not a part of the set. A broken service is a down optional service.
4943
#
4944
#	The services in a set must be attached to the same vectoring point
4945
#	(e.g., pre-cache) and use the same adaptation method (e.g., REQMOD).
4946
#
4947
#	If all services in a set are optional then adaptation failures are
4948
#	bypassable. If all services in the set are essential, then a
4949
#	transaction failure with one service may still be retried using
4950
#	another service from the set, but when all services fail, the master
4951
#	transaction fails as well.
4952
#
4953
#	A set may contain a mix of optional and essential services, but that
4954
#	is likely to lead to surprising results because broken services become
4955
#	ignored (see above), making previously bypassable failures fatal.
4956
#	Technically, it is the bypassability of the last failed service that
4957
#	matters.
4958
#
4959
#	See also: adaptation_access adaptation_service_chain
4960
#
4961
#Example:
4962
#adaptation_service_set svcBlocker urlFilterPrimary urlFilterBackup
4963
#adaptation service_set svcLogger loggerLocal loggerRemote
4964
#Default:
4965
# none
4966
4967
#  TAG: adaptation_service_chain
4968
#
4969
#	Configures a list of complementary services that will be applied
4970
#	one-by-one, forming an adaptation chain or pipeline. This is useful
4971
#	when Squid must perform different adaptations on the same message.
4972
#
4973
#	    adaptation_service_chain chain_name service_name1 svc_name2 ...
4974
#
4975
# 	The named services are used in the chain declaration order. The first
4976
#	applicable adaptation service from the chain is used first. The next
4977
#	applicable service is applied to the successful adaptation results of
4978
#	the previous service in the chain.
4979
#
4980
#	When adaptation starts, broken services are ignored as if they were
4981
#	not a part of the chain. A broken service is a down optional service.
4982
#
4983
#	Request satisfaction terminates the adaptation chain because Squid
4984
#	does not currently allow declaration of RESPMOD services at the
4985
#	"reqmod_precache" vectoring point (see icap_service or ecap_service).
4986
#
4987
#	The services in a chain must be attached to the same vectoring point
4988
#	(e.g., pre-cache) and use the same adaptation method (e.g., REQMOD).
4989
#
4990
#	A chain may contain a mix of optional and essential services. If an
4991
#	essential adaptation fails (or the failure cannot be bypassed for
4992
#	other reasons), the master transaction fails. Otherwise, the failure
4993
#	is bypassed as if the failed adaptation service was not in the chain.
4994
#
4995
#	See also: adaptation_access adaptation_service_set
4996
#
4997
#Example:
4998
#adaptation_service_chain svcRequest requestLogger urlFilter leakDetector
4999
#Default:
5000
# none
5001
5002
#  TAG: adaptation_access
5003
#	Sends an HTTP transaction to an ICAP or eCAP adaptation	service.
5004
#
5005
#	adaptation_access service_name allow|deny [!]aclname...
5006
#	adaptation_access set_name     allow|deny [!]aclname...
5007
#
5008
#	At each supported vectoring point, the adaptation_access
5009
#	statements are processed in the order they appear in this
5010
#	configuration file. Statements pointing to the following services
5011
#	are ignored (i.e., skipped without checking their ACL):
5012
#
5013
#	    - services serving different vectoring points
5014
#	    - "broken-but-bypassable" services
5015
#	    - "up" services configured to ignore such transactions
5016
#              (e.g., based on the ICAP Transfer-Ignore header).
5017
#
5018
#        When a set_name is used, all services in the set are checked
5019
#	using the same rules, to find the first applicable one. See
5020
#	adaptation_service_set for details.
5021
#
5022
#	If an access list is checked and there is a match, the
5023
#	processing stops: For an "allow" rule, the corresponding
5024
#	adaptation service is used for the transaction. For a "deny"
5025
#	rule, no adaptation service is activated.
5026
#
5027
#	It is currently not possible to apply more than one adaptation
5028
#	service at the same vectoring point to the same HTTP transaction.
5029
#
5030
#        See also: icap_service and ecap_service
5031
#
5032
#Example:
5033
#adaptation_access service_1 allow all
5034
#Default:
5035
# none
5036
5037
#  TAG: adaptation_service_iteration_limit
5038
#	Limits the number of iterations allowed when applying adaptation
5039
#	services to a message. If your longest adaptation set or chain
5040
#	may have more than 16 services, increase the limit beyond its
5041
#	default value of 16. If detecting infinite iteration loops sooner
5042
#	is critical, make the iteration limit match the actual number
5043
#	of services in your longest adaptation set or chain.
5044
#
5045
#	Infinite adaptation loops are most likely with routing services.
5046
#
5047
#	See also: icap_service routing=1
5048
#Default:
5049
# adaptation_service_iteration_limit 16
5050
5051
#  TAG: adaptation_masterx_shared_names
5052
#	For each master transaction (i.e., the HTTP request and response
5053
#	sequence, including all related ICAP and eCAP exchanges), Squid
5054
#	maintains a table of metadata. The table entries are (name, value)
5055
#	pairs shared among eCAP and ICAP exchanges. The table is destroyed
5056
#	with the master transaction.
5057
#
5058
#	This option specifies the table entry names that Squid must accept
5059
#	from and forward to the adaptation transactions.
5060
#
5061
#	An ICAP REQMOD or RESPMOD transaction may set an entry in the 
5062
#	shared table by returning an ICAP header field with a name 
5063
#	specified in adaptation_masterx_shared_names. Squid will store 
5064
#	and forward that ICAP header field to subsequent ICAP 
5065
#	transactions within the same master transaction scope.
5066
#
5067
#	Only one shared entry name is supported at this time.
5068
#
5069
#Example:
5070
## share authentication information among ICAP services
5071
#adaptation_masterx_shared_names X-Subscriber-ID
5072
#Default:
5073
# none
5074
5075
#  TAG: icap_retry
5076
#	This ACL determines which retriable ICAP transactions are
5077
#	retried. Transactions that received a complete ICAP response
5078
#	and did not have to consume or produce HTTP bodies to receive
5079
#	that response are usually retriable.
5080
#
5081
#	icap_retry allow|deny [!]aclname ...
5082
#
5083
#	Squid automatically retries some ICAP I/O timeouts and errors
5084
#	due to persistent connection race conditions.
5085
#
5086
#	See also: icap_retry_limit
5087
#Default:
5088
# icap_retry deny all
5089
5090
#  TAG: icap_retry_limit
5091
#	Limits the number of retries allowed. When set to zero (default),
5092
#	no retries are allowed.
5093
#
5094
#	Communication errors due to persistent connection race
5095
#	conditions are unavoidable, automatically retried, and do not
5096
#	count against this limit.
5097
#
5098
#	See also: icap_retry
5099
#Default:
5100
# icap_retry_limit 0
5101
5102
# DNS OPTIONS
5103
# -----------------------------------------------------------------------------
5104
5105
#  TAG: check_hostnames
5106
#	For security and stability reasons Squid can check
5107
#	hostnames for Internet standard RFC compliance. If you want
5108
#	Squid to perform these checks turn this directive on.
5109
#Default:
5110
# check_hostnames off
5111
5112
#  TAG: allow_underscore
5113
#	Underscore characters is not strictly allowed in Internet hostnames
5114
#	but nevertheless used by many sites. Set this to off if you want
5115
#	Squid to be strict about the standard.
5116
#	This check is performed only when check_hostnames is set to on.
5117
#Default:
5118
# allow_underscore on
5119
5120
#  TAG: cache_dns_program
5121
# Note: This option is only available if Squid is rebuilt with the
5122
#       --disable-internal-dns option
5123
#
5124
#	Specify the location of the executable for dnslookup process.
5125
#Default:
5126
# cache_dns_program /usr/lib/squid3/dnsserver
5127
5128
#  TAG: dns_children
5129
# Note: This option is only available if Squid is rebuilt with the
5130
#       --disable-internal-dns option
5131
#
5132
#	The number of processes spawn to service DNS name lookups.
5133
#	For heavily loaded caches on large servers, you should
5134
#	probably increase this value to at least 10.  The maximum
5135
#	is 32.  The default is 5.
5136
#
5137
#	You must have at least one dnsserver process.
5138
#Default:
5139
# dns_children 5
5140
5141
#  TAG: dns_retransmit_interval
5142
#	Initial retransmit interval for DNS queries. The interval is
5143
#	doubled each time all configured DNS servers have been tried.
5144
#
5145
#Default:
5146
# dns_retransmit_interval 5 seconds
5147
5148
#  TAG: dns_timeout
5149
#	DNS Query timeout. If no response is received to a DNS query
5150
#	within this time all DNS servers for the queried domain
5151
#	are assumed to be unavailable.
5152
#Default:
5153
# dns_timeout 2 minutes
5154
5155
#  TAG: dns_defnames	on|off
5156
#	Normally the RES_DEFNAMES resolver option is disabled
5157
#	(see res_init(3)).  This prevents caches in a hierarchy
5158
#	from interpreting single-component hostnames locally.  To allow
5159
#	Squid to handle single-component names, enable this option.
5160
#Default:
5161
# dns_defnames off
5162
5163
#  TAG: dns_nameservers
5164
#	Use this if you want to specify a list of DNS name servers
5165
#	(IP addresses) to use instead of those given in your
5166
#	/etc/resolv.conf file.
5167
#	On Windows platforms, if no value is specified here or in
5168
#	the /etc/resolv.conf file, the list of DNS name servers are
5169
#	taken from the Windows registry, both static and dynamic DHCP
5170
#	configurations are supported.
5171
#
5172
#	Example: dns_nameservers 10.0.0.1 192.172.0.4
5173
#Default:
5174
# none
5175
5176
#  TAG: hosts_file
5177
#	Location of the host-local IP name-address associations
5178
#	database. Most Operating Systems have such a file on different
5179
#	default locations:
5180
#	- Un*X & Linux:    /etc/hosts
5181
#	- Windows NT/2000: %SystemRoot%\system32\drivers\etc\hosts
5182
#			   (%SystemRoot% value install default is c:\winnt)
5183
#	- Windows XP/2003: %SystemRoot%\system32\drivers\etc\hosts
5184
#			   (%SystemRoot% value install default is c:\windows)
5185
#	- Windows 9x/Me:   %windir%\hosts
5186
#			   (%windir% value is usually c:\windows)
5187
#	- Cygwin:	   /etc/hosts
5188
#
5189
#	The file contains newline-separated definitions, in the
5190
#	form ip_address_in_dotted_form name [name ...] names are
5191
#	whitespace-separated. Lines beginning with an hash (#)
5192
#	character are comments.
5193
#
5194
#	The file is checked at startup and upon configuration.
5195
#	If set to 'none', it won't be checked.
5196
#	If append_domain is used, that domain will be added to
5197
#	domain-local (i.e. not containing any dot character) host
5198
#	definitions.
5199
#Default:
5200
# hosts_file /etc/hosts
5201
5202
#  TAG: append_domain
5203
#	Appends local domain name to hostnames without any dots in
5204
#	them.  append_domain must begin with a period.
5205
#
5206
#	Be warned there are now Internet names with no dots in
5207
#	them using only top-domain names, so setting this may
5208
#	cause some Internet sites to become unavailable.
5209
#
5210
#Example:
5211
# append_domain .yourdomain.com
5212
#Default:
5213
# none
5214
5215
#  TAG: ignore_unknown_nameservers
5216
#	By default Squid checks that DNS responses are received
5217
#	from the same IP addresses they are sent to.  If they
5218
#	don't match, Squid ignores the response and writes a warning
5219
#	message to cache.log.  You can allow responses from unknown
5220
#	nameservers by setting this option to 'off'.
5221
#Default:
5222
# ignore_unknown_nameservers on
5223
5224
#  TAG: dns_v4_fallback
5225
#	Standard practice with DNS is to lookup either A or AAAA records
5226
#	and use the results if it succeeds. Only looking up the other if
5227
#	the first attempt fails or otherwise produces no results.
5228
#
5229
#	That policy however will cause squid to produce error pages for some
5230
#	servers that advertise AAAA but are unreachable over IPv6.
5231
#
5232
#	If this is ON  squid will always lookup both AAAA and A, using both.
5233
#	If this is OFF squid will lookup AAAA and only try A if none found.
5234
#
5235
#	WARNING: There are some possibly unwanted side-effects with this on:
5236
#		*) Doubles the load placed by squid on the DNS network.
5237
#		*) May negatively impact connection delay times.
5238
#Default:
5239
# dns_v4_fallback on
5240
5241
#  TAG: ipcache_size	(number of entries)
5242
#  TAG: ipcache_low	(percent)
5243
#  TAG: ipcache_high	(percent)
5244
#	The size, low-, and high-water marks for the IP cache.
5245
#Default:
5246
# ipcache_size 1024
5247
# ipcache_low 90
5248
# ipcache_high 95
5249
5250
#  TAG: fqdncache_size	(number of entries)
5251
#	Maximum number of FQDN cache entries.
5252
#Default:
5253
# fqdncache_size 1024
5254
5255
# MISCELLANEOUS
5256
# -----------------------------------------------------------------------------
5257
5258
#  TAG: memory_pools	on|off
5259
#	If set, Squid will keep pools of allocated (but unused) memory
5260
#	available for future use.  If memory is a premium on your
5261
#	system and you believe your malloc library outperforms Squid
5262
#	routines, disable this.
5263
#Default:
5264
# memory_pools on
5265
5266
#  TAG: memory_pools_limit	(bytes)
5267
#	Used only with memory_pools on:
5268
#	memory_pools_limit 50 MB
5269
#
5270
#	If set to a non-zero value, Squid will keep at most the specified
5271
#	limit of allocated (but unused) memory in memory pools. All free()
5272
#	requests that exceed this limit will be handled by your malloc
5273
#	library. Squid does not pre-allocate any memory, just safe-keeps
5274
#	objects that otherwise would be free()d. Thus, it is safe to set
5275
#	memory_pools_limit to a reasonably high value even if your
5276
#	configuration will use less memory.
5277
#
5278
#	If set to none, Squid will keep all memory it can. That is, there
5279
#	will be no limit on the total amount of memory used for safe-keeping.
5280
#
5281
#	To disable memory allocation optimization, do not set
5282
#	memory_pools_limit to 0 or none. Set memory_pools to "off" instead.
5283
#
5284
#	An overhead for maintaining memory pools is not taken into account
5285
#	when the limit is checked. This overhead is close to four bytes per
5286
#	object kept. However, pools may actually _save_ memory because of
5287
#	reduced memory thrashing in your malloc library.
5288
#Default:
5289
# memory_pools_limit 5 MB
5290
5291
#  TAG: forwarded_for	on|off|transparent|truncate|delete
5292
#	If set to "on", Squid will append your client's IP address
5293
#	in the HTTP requests it forwards. By default it looks like:
5294
#
5295
#		X-Forwarded-For: 192.1.2.3
5296
#
5297
#	If set to "off", it will appear as
5298
#
5299
#		X-Forwarded-For: unknown
5300
#
5301
#	If set to "transparent", Squid will not alter the
5302
#	X-Forwarded-For header in any way.
5303
#
5304
#	If set to "delete", Squid will delete the entire
5305
#	X-Forwarded-For header.
5306
#
5307
#	If set to "truncate", Squid will remove all existing
5308
#	X-Forwarded-For entries, and place itself as the sole entry.
5309
#Default:
5310
# forwarded_for on
5311
5312
#  TAG: cachemgr_passwd
5313
#	Specify passwords for cachemgr operations.
5314
#
5315
#	Usage: cachemgr_passwd password action action ...
5316
#
5317
#	Some valid actions are (see cache manager menu for a full list):
5318
#		5min
5319
#		60min
5320
#		asndb
5321
#		authenticator
5322
#		cbdata
5323
#		client_list
5324
#		comm_incoming
5325
#		config *
5326
#		counters
5327
#		delay
5328
#		digest_stats
5329
#		dns
5330
#		events
5331
#		filedescriptors
5332
#		fqdncache
5333
#		histograms
5334
#		http_headers
5335
#		info
5336
#		io
5337
#		ipcache
5338
#		mem
5339
#		menu
5340
#		netdb
5341
#		non_peers
5342
#		objects
5343
#		offline_toggle *
5344
#		pconn
5345
#		peer_select
5346
#		reconfigure *
5347
#		redirector
5348
#		refresh
5349
#		server_list
5350
#		shutdown *
5351
#		store_digest
5352
#		storedir
5353
#		utilization
5354
#		via_headers
5355
#		vm_objects
5356
#
5357
#	* Indicates actions which will not be performed without a
5358
#	  valid password, others can be performed if not listed here.
5359
#
5360
#	To disable an action, set the password to "disable".
5361
#	To allow performing an action without a password, set the
5362
#	password to "none".
5363
#
5364
#	Use the keyword "all" to set the same password for all actions.
5365
#
5366
#Example:
5367
# cachemgr_passwd secret shutdown
5368
# cachemgr_passwd lesssssssecret info stats/objects
5369
# cachemgr_passwd disable all
5370
#Default:
5371
# none
5372
5373
#  TAG: client_db	on|off
5374
#	If you want to disable collecting per-client statistics,
5375
#	turn off client_db here.
5376
#Default:
5377
# client_db on
5378
5379
#  TAG: refresh_all_ims	on|off
5380
#	When you enable this option, squid will always check
5381
#	the origin server for an update when a client sends an
5382
#	If-Modified-Since request.  Many browsers use IMS
5383
#	requests when the user requests a reload, and this
5384
#	ensures those clients receive the latest version.
5385
#
5386
#	By default (off), squid may return a Not Modified response
5387
#	based on the age of the cached version.
5388
#Default:
5389
# refresh_all_ims off
5390
5391
#  TAG: reload_into_ims	on|off
5392
#	When you enable this option, client no-cache or ``reload''
5393
#	requests will be changed to If-Modified-Since requests.
5394
#	Doing this VIOLATES the HTTP standard.  Enabling this
5395
#	feature could make you liable for problems which it
5396
#	causes.
5397
#
5398
#	see also refresh_pattern for a more selective approach.
5399
#Default:
5400
# reload_into_ims off
5401
5402
#  TAG: maximum_single_addr_tries
5403
#	This sets the maximum number of connection attempts for a
5404
#	host that only has one address (for multiple-address hosts,
5405
#	each address is tried once).
5406
#
5407
#	The default value is one attempt, the (not recommended)
5408
#	maximum is 255 tries.  A warning message will be generated
5409
#	if it is set to a value greater than ten.
5410
#
5411
#	Note: This is in addition to the request re-forwarding which
5412
#	takes place if Squid fails to get a satisfying response.
5413
#Default:
5414
# maximum_single_addr_tries 1
5415
5416
#  TAG: retry_on_error
5417
#	If set to on Squid will automatically retry requests when
5418
#	receiving an error response. This is mainly useful if you
5419
#	are in a complex cache hierarchy to work around access
5420
#	control errors.
5421
#Default:
5422
# retry_on_error off
5423
5424
#  TAG: as_whois_server
5425
#	WHOIS server to query for AS numbers.  NOTE: AS numbers are
5426
#	queried only when Squid starts up, not for every request.
5427
#Default:
5428
# as_whois_server whois.ra.net
5429
# as_whois_server whois.ra.net
5430
5431
#  TAG: offline_mode
5432
#	Enable this option and Squid will never try to validate cached
5433
#	objects.
5434
#Default:
5435
# offline_mode off
5436
5437
#  TAG: uri_whitespace
5438
#	What to do with requests that have whitespace characters in the
5439
#	URI.  Options:
5440
#
5441
#	strip:  The whitespace characters are stripped out of the URL.
5442
#		This is the behavior recommended by RFC2396.
5443
#	deny:   The request is denied.  The user receives an "Invalid
5444
#		Request" message.
5445
#	allow:  The request is allowed and the URI is not changed.  The
5446
#		whitespace characters remain in the URI.  Note the
5447
#		whitespace is passed to redirector processes if they
5448
#		are in use.
5449
#	encode:	The request is allowed and the whitespace characters are
5450
#		encoded according to RFC1738.  This could be considered
5451
#		a violation of the HTTP/1.1
5452
#		RFC because proxies are not allowed to rewrite URI's.
5453
#	chop:	The request is allowed and the URI is chopped at the
5454
#		first whitespace.  This might also be considered a
5455
#		violation.
5456
#Default:
5457
# uri_whitespace strip
5458
5459
#  TAG: chroot
5460
#	Specifies a directory where Squid should do a chroot() while
5461
#	initializing.  This also causes Squid to fully drop root
5462
#	privileges after initializing.  This means, for example, if you
5463
#	use a HTTP port less than 1024 and try to reconfigure, you may
5464
#	get an error saying that Squid can not open the port.
5465
#Default:
5466
# none
5467
5468
#  TAG: balance_on_multiple_ip
5469
#	Modern IP resolvers in squid sort lookup results by preferred access.
5470
#	By default squid will use these IP in order and only rotates to
5471
#	the next listed when the most preffered fails.
5472
#
5473
#	Some load balancing servers based on round robin DNS have been
5474
#	found not to preserve user session state across requests
5475
#	to different IP addresses.
5476
#
5477
#	Enabling this directive Squid rotates IP's per request.
5478
#Default:
5479
# balance_on_multiple_ip off
5480
5481
#  TAG: pipeline_prefetch
5482
#	To boost the performance of pipelined requests to closer
5483
#	match that of a non-proxied environment Squid can try to fetch
5484
#	up to two requests in parallel from a pipeline.
5485
#
5486
#	Defaults to off for bandwidth management and access logging
5487
#	reasons.
5488
#Default:
5489
# pipeline_prefetch off
5490
5491
#  TAG: high_response_time_warning	(msec)
5492
#	If the one-minute median response time exceeds this value,
5493
#	Squid prints a WARNING with debug level 0 to get the
5494
#	administrators attention.  The value is in milliseconds.
5495
#Default:
5496
# high_response_time_warning 0
5497
5498
#  TAG: high_page_fault_warning
5499
#	If the one-minute average page fault rate exceeds this
5500
#	value, Squid prints a WARNING with debug level 0 to get
5501
#	the administrators attention.  The value is in page faults
5502
#	per second.
5503
#Default:
5504
# high_page_fault_warning 0
5505
5506
#  TAG: high_memory_warning
5507
#	If the memory usage (as determined by mallinfo) exceeds
5508
#	this amount, Squid prints a WARNING with debug level 0 to get
5509
#	the administrators attention.
5510
#Default:
5511
# high_memory_warning 0 KB
5512
5513
#  TAG: sleep_after_fork	(microseconds)
5514
#	When this is set to a non-zero value, the main Squid process
5515
#	sleeps the specified number of microseconds after a fork()
5516
#	system call. This sleep may help the situation where your
5517
#	system reports fork() failures due to lack of (virtual)
5518
#	memory. Note, however, if you have a lot of child
5519
#	processes, these sleep delays will add up and your
5520
#	Squid will not service requests for some amount of time
5521
#	until all the child processes have been started.
5522
#	On Windows value less then 1000 (1 milliseconds) are
5523
#	rounded to 1000.
5524
#Default:
5525
# sleep_after_fork 0
5526
5527
#  TAG: windows_ipaddrchangemonitor	on|off
5528
#	On Windows Squid by default will monitor IP address changes and will 
5529
#	reconfigure itself after any detected event. This is very useful for
5530
#	proxies connected to internet with dial-up interfaces.
5531
#	In some cases (a Proxy server acting as VPN gateway is one) it could be
5532
#	desiderable to disable this behaviour setting this to 'off'.
5533
#	Note: after changing this, Squid service must be restarted.
5534
#Default:
5535
# windows_ipaddrchangemonitor on
5536
5537
#  TAG: max_filedescriptors
5538
#	The maximum number of filedescriptors supported.
5539
#
5540
#	The default "0" means Squid inherits the current ulimit setting.
5541
#
5542
#	Note: Changing this requires a restart of Squid. Also
5543
#	not all comm loops supports large values.
5544
#Default:
5545
# max_filedescriptors 0
5546
5547
# Haarp 1.1
5548
#=========================================================#
5549
acl haarp_lst url_regex -i "/etc/haarp/haarp.lst"
5550
cache deny haarp_lst
5551
cache_peer 10.10.0.2 parent 8080 0 proxy-only no-digest
5552
dead_peer_timeout 2 seconds
5553
cache_peer_access 10.10.0.2 allow haarp_lst
5554
cache_peer_access 10.10.0.2 deny all