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