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