]>
Commit | Line | Data |
---|---|---|
3a278cb8 | 1 | |
9cef6668 | 2 | # |
fc659d9d | 3 | # $Id: cf.data.pre,v 1.245 2001/12/21 09:47:34 hno Exp $ |
9cef6668 | 4 | # |
5 | # | |
2b6662ba | 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 |
448cd7c7 | 34 | WELCOME TO SQUID 2 |
35 | ------------------ | |
3a278cb8 | 36 | |
cf5cc17e | 37 | This is the default Squid configuration file. You may wish |
2b6662ba | 38 | to look at the Squid home page (http://www.squid-cache.org/) |
6b8e7481 | 39 | for the FAQ and other documentation. |
3a278cb8 | 40 | |
debd9a31 | 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 | |
efd900cb | 45 | setting at all, while in other cases it refers to a valid |
debd9a31 | 46 | option - the comments for that keyword indicate if this is the |
47 | case. | |
48 | ||
0f74202c | 49 | COMMENT_END |
3a278cb8 | 50 | |
0f74202c | 51 | COMMENT_START |
3a278cb8 | 52 | NETWORK OPTIONS |
53 | ----------------------------------------------------------------------------- | |
0f74202c | 54 | COMMENT_END |
3a278cb8 | 55 | |
934b03fc | 56 | NAME: http_port ascii_port |
7e3ce7b9 | 57 | TYPE: sockaddr_in_list |
f53b06f9 | 58 | DEFAULT: none |
59 | DEFAULT_IF_NONE: 3128 | |
7e3ce7b9 | 60 | LOC: Config.Sockaddr.http |
934b03fc | 61 | DOC_START |
7e3ce7b9 | 62 | Usage: port |
63 | hostname:port | |
64 | 1.2.3.4:port | |
934b03fc | 65 | |
7e3ce7b9 | 66 | The socket addresses where Squid will listen for HTTP client |
67 | requests. You may specify multiple socket addresses. | |
68 | There are three forms: port alone, hostname with port, and | |
69 | IP address with port. If you specify a hostname or IP | |
70 | address, then Squid binds the socket to that specific | |
71 | address. This replaces the old 'tcp_incoming_address' | |
72 | option. Most likely, you do not need to bind to a specific | |
73 | address, so you can use the port number alone. | |
74 | ||
75 | The default port number is 3128. | |
76 | ||
efd900cb | 77 | If you are running Squid in accelerator mode, then you |
7e3ce7b9 | 78 | probably want to listen on port 80 also, or instead. |
79 | ||
80 | The -a command line option will override the *first* port | |
81 | number listed here. That option will NOT override an IP | |
82 | address, however. | |
934b03fc | 83 | |
efd900cb | 84 | You may specify multiple socket addresses on multiple lines. |
934b03fc | 85 | DOC_END |
86 | ||
1f7c9178 | 87 | NAME: https_port |
88 | IFDEF: USE_SSL | |
d193a436 | 89 | TYPE: https_port_list |
1f7c9178 | 90 | DEFAULT: none |
91 | LOC: Config.Sockaddr.https | |
92 | DOC_START | |
9690f3c5 | 93 | Usage: [ip:]port cert=certificate.pem [key=key.pem] [options...] |
1f7c9178 | 94 | |
d193a436 | 95 | The socket address where Squid will listen for HTTPS client |
96 | requests. | |
d6827718 | 97 | |
1f7c9178 | 98 | This is really only useful for situations where you are running |
99 | squid in accelerator mode and you want to do the SSL work at the | |
100 | accelerator level. | |
1f7c9178 | 101 | |
d193a436 | 102 | You may specify multiple socket addresses on multiple lines, |
9690f3c5 | 103 | each with their own SSL certificate and/or options. |
820feeed | 104 | |
105 | Options: | |
106 | ||
107 | cert= Path to SSL certificate (PEM format) | |
108 | ||
109 | key= Path to SSL private key file (PEM format) | |
110 | if not specified, the certificate file is | |
111 | assumed to be a combined certificate and | |
112 | key file | |
113 | ||
114 | version= The version of SSL/TLS supported | |
115 | 1 automatic (default) | |
116 | 2 SSLv2 only | |
117 | 3 SSLv3 only | |
118 | 4 TLSv1 only | |
119 | ||
120 | cipher= Colon separated list of supported ciphers | |
121 | ||
122 | options= Varions SSL engine options. The most important | |
123 | being: | |
124 | NO_SSLv2 Disallow the use of SSLv2 | |
125 | NO_SSLv3 Disallow the use of SSLv3 | |
126 | NO_TLSv1 Disallow the use of TLSv1 | |
127 | See src/ssl_support.c or OpenSSL documentation | |
128 | for a more complete list. | |
1f7c9178 | 129 | DOC_END |
130 | ||
79d4ccdf | 131 | NAME: ssl_unclean_shutdown |
e1d9c13c | 132 | IFDEF: USE_SSL |
79d4ccdf | 133 | TYPE: onoff |
134 | DEFAULT: off | |
135 | LOC: Config.SSL.unclean_shutdown | |
1f7c9178 | 136 | DOC_START |
79d4ccdf | 137 | Some browsers (especially MSIE) bugs out on SSL shutdown |
138 | messages. | |
1f7c9178 | 139 | DOC_END |
140 | ||
934b03fc | 141 | NAME: icp_port udp_port |
142 | TYPE: ushort | |
143 | DEFAULT: 3130 | |
144 | LOC: Config.Port.icp | |
145 | DOC_START | |
78a0e865 | 146 | The port number where Squid sends and receives ICP queries to |
934b03fc | 147 | and from neighbor caches. Default is 3130. To disable use |
148 | "0". May be overridden with -u on the command line. | |
934b03fc | 149 | DOC_END |
150 | ||
459f1836 | 151 | NAME: htcp_port |
152 | IFDEF: USE_HTCP | |
153 | TYPE: ushort | |
154 | DEFAULT: 4827 | |
155 | LOC: Config.Port.htcp | |
156 | DOC_START | |
78a0e865 | 157 | The port number where Squid sends and receives HTCP queries to |
459f1836 | 158 | and from neighbor caches. Default is 4827. To disable use |
159 | "0". | |
459f1836 | 160 | DOC_END |
161 | ||
934b03fc | 162 | |
163 | NAME: mcast_groups | |
164 | TYPE: wordlist | |
165 | LOC: Config.mcast_group_list | |
1273d501 | 166 | DEFAULT: none |
934b03fc | 167 | DOC_START |
cf5cc17e | 168 | This tag specifies a list of multicast groups which your server |
78a0e865 | 169 | should join to receive multicasted ICP queries. |
934b03fc | 170 | |
171 | NOTE! Be very careful what you put here! Be sure you | |
172 | understand the difference between an ICP _query_ and an ICP | |
173 | _reply_. This option is to be set only if you want to RECEIVE | |
174 | multicast queries. Do NOT set this option to SEND multicast | |
a95856a0 | 175 | ICP (use cache_peer for that). ICP replies are always sent via |
934b03fc | 176 | unicast, so this option does not affect whether or not you will |
177 | receive replies from multicast group members. | |
178 | ||
179 | You must be very careful to NOT use a multicast address which | |
efd900cb | 180 | is already in use by another group of caches. |
934b03fc | 181 | |
cf5cc17e | 182 | If you are unsure about multicast, please read the Multicast |
2b6662ba | 183 | chapter in the Squid FAQ (http://www.squid-cache.org/FAQ/). |
cf5cc17e | 184 | |
934b03fc | 185 | Usage: mcast_groups 239.128.16.128 224.0.1.20 |
186 | ||
cf5cc17e | 187 | By default, Squid doesn't listen on any multicast groups. |
934b03fc | 188 | DOC_END |
189 | ||
190 | ||
934b03fc | 191 | NAME: udp_incoming_address |
192 | TYPE: address | |
193 | LOC:Config.Addrs.udp_incoming | |
270b86af | 194 | DEFAULT: 0.0.0.0 |
934b03fc | 195 | DOC_NONE |
196 | ||
197 | NAME: udp_outgoing_address | |
198 | TYPE: address | |
199 | LOC: Config.Addrs.udp_outgoing | |
270b86af | 200 | DEFAULT: 255.255.255.255 |
934b03fc | 201 | DOC_START |
202 | Usage: tcp_incoming_address 10.20.30.40 | |
203 | udp_outgoing_address fully.qualified.domain.name | |
204 | ||
934b03fc | 205 | udp_incoming_address is used for the ICP socket receiving packets |
206 | from other caches. | |
207 | udp_outgoing_address is used for ICP packets sent out to other | |
208 | caches. | |
209 | ||
efd900cb | 210 | The default behavior is to not bind to any specific address. |
934b03fc | 211 | |
6b53c392 | 212 | A *_incoming_address value of 0.0.0.0 indicates that Squid should |
213 | listen on all available interfaces. | |
214 | ||
215 | If udp_outgoing_address is set to 255.255.255.255 (the default) | |
216 | then it will use the same socket as udp_incoming_address. Only | |
217 | change this if you want to have ICP queries sent using another | |
218 | address than where this Squid listens for ICP queries from other | |
219 | caches. | |
220 | ||
5a3f6538 | 221 | NOTE, udp_incoming_address and udp_outgoing_address can not |
6b53c392 | 222 | have the same value since they both use port 3130. |
934b03fc | 223 | |
7e3ce7b9 | 224 | NOTE, tcp_incoming_address has been removed. You can now |
225 | specify IP addresses on the 'http_port' line. | |
934b03fc | 226 | DOC_END |
227 | ||
0f74202c | 228 | COMMENT_START |
3a278cb8 | 229 | OPTIONS WHICH AFFECT THE NEIGHBOR SELECTION ALGORITHM |
230 | ----------------------------------------------------------------------------- | |
0f74202c | 231 | COMMENT_END |
934b03fc | 232 | |
40a1495e | 233 | NAME: cache_peer |
234 | TYPE: peer | |
1273d501 | 235 | DEFAULT: none |
0153d498 | 236 | LOC: Config.peers |
934b03fc | 237 | DOC_START |
238 | To specify other caches in a hierarchy, use the format: | |
239 | ||
6b53c392 | 240 | cache_peer hostname type http_port icp_port |
934b03fc | 241 | |
d0d41f07 | 242 | For example, |
934b03fc | 243 | |
244 | # proxy icp | |
245 | # hostname type port port options | |
246 | # -------------------- -------- ----- ----- ----------- | |
cf5cc17e | 247 | cache_peer parent.foo.net parent 3128 3130 [proxy-only] |
248 | cache_peer sib1.foo.net sibling 3128 3130 [proxy-only] | |
249 | cache_peer sib2.foo.net sibling 3128 3130 [proxy-only] | |
934b03fc | 250 | |
251 | type: either 'parent', 'sibling', or 'multicast'. | |
252 | ||
253 | proxy_port: The port number where the cache listens for proxy | |
254 | requests. | |
255 | ||
256 | icp_port: Used for querying neighbor caches about | |
257 | objects. To have a non-ICP neighbor | |
258 | specify '7' for the ICP port and make sure the | |
259 | neighbor machine has the UDP echo port | |
260 | enabled in its /etc/inetd.conf file. | |
261 | ||
262 | options: proxy-only | |
263 | weight=n | |
264 | ttl=n | |
265 | no-query | |
266 | default | |
267 | round-robin | |
268 | multicast-responder | |
b3264694 | 269 | closest-only |
46b034a4 | 270 | no-digest |
223213df | 271 | no-netdb-exchange |
95e36d02 | 272 | no-delay |
c3b33cb7 | 273 | login=user:password | PASS | *:password |
3f62decd | 274 | connect-timeout=nn |
7e3ce7b9 | 275 | digest-url=url |
987de783 | 276 | allow-miss |
e79a6f05 | 277 | max-conn |
934b03fc | 278 | |
279 | use 'proxy-only' to specify that objects fetched | |
280 | from this cache should not be saved locally. | |
281 | ||
282 | use 'weight=n' to specify a weighted parent. | |
283 | The weight must be an integer. The default weight | |
284 | is 1, larger weights are favored more. | |
285 | ||
286 | use 'ttl=n' to specify a IP multicast TTL to use | |
78a0e865 | 287 | when sending an ICP queries to this address. |
934b03fc | 288 | Only useful when sending to a multicast group. |
289 | Because we don't accept ICP replies from random | |
290 | hosts, you must configure other group members as | |
291 | peers with the 'multicast-responder' option below. | |
292 | ||
293 | use 'no-query' to NOT send ICP queries to this | |
294 | neighbor. | |
295 | ||
296 | use 'default' if this is a parent cache which can | |
297 | be used as a "last-resort." You should probably | |
298 | only use 'default' in situations where you cannot | |
299 | use ICP with your parent cache(s). | |
300 | ||
301 | use 'round-robin' to define a set of parents which | |
302 | should be used in a round-robin fashion in the | |
303 | absence of any ICP queries. | |
304 | ||
305 | 'multicast-responder' indicates that the named peer | |
306 | is a member of a multicast group. ICP queries will | |
307 | not be sent directly to the peer, but ICP replies | |
308 | will be accepted from it. | |
309 | ||
b3264694 | 310 | 'closest-only' indicates that, for ICP_OP_MISS |
311 | replies, we'll only forward CLOSEST_PARENT_MISSes | |
312 | and never FIRST_PARENT_MISSes. | |
313 | ||
46b034a4 | 314 | use 'no-digest' to NOT request cache digests from |
315 | this neighbor. | |
316 | ||
223213df | 317 | 'no-netdb-exchange' disables requesting ICMP |
318 | RTT database (NetDB) from the neighbor. | |
319 | ||
95e36d02 | 320 | use 'no-delay' to prevent access to this neighbor |
321 | from influencing the delay pools. | |
322 | ||
c68e9c6b | 323 | use 'login=user:password' if this is a personal/workgroup |
324 | proxy and your parent requires proxy authentication. | |
4472c779 | 325 | Note: The string can include URL escapes (i.e. %20 for |
326 | spaces). This also means that % must be written as %%. | |
c68e9c6b | 327 | |
94439e4e | 328 | use 'login=PASS' if users must authenticate against |
ac3e1323 | 329 | the upstream proxy. This will pass the users credentials |
330 | as they are to the peer proxy. This only works for the | |
331 | Basic HTTP authentication sheme. Note: To combine this | |
332 | with proxy_auth both proxies must share the same user | |
94439e4e | 333 | database as HTTP only allows for one proxy login. |
334 | Also be warned that this will expose your users proxy | |
ac3e1323 | 335 | password to the peer. USE WITH CAUTION |
94439e4e | 336 | |
c3b33cb7 | 337 | use 'login=*:password' to pass the username to the |
338 | upstream cache, but with a fixed password. This is meant | |
339 | to be used when the peer is in another administrative | |
340 | domain, but it is still needed to identify each user. | |
341 | The star can optionally be followed by some extra | |
342 | information which is added to the username. This can | |
343 | be used to identify this proxy to the peer, similar to | |
344 | the login=username:password option above. | |
345 | ||
3f62decd | 346 | use 'connect-timeout=nn' to specify a peer |
347 | specific connect timeout (also see the | |
348 | peer_connect_timeout directive) | |
349 | ||
7e3ce7b9 | 350 | use 'digest-url=url' to tell Squid to fetch the cache |
351 | digest (if digests are enabled) for this host from | |
352 | the specified URL rather than the Squid default | |
353 | location. | |
3f62decd | 354 | |
987de783 | 355 | use 'allow-miss' to disable Squid's use of only-if-cached |
356 | when forwarding requests to siblings. This is primarily | |
357 | useful when icp_hit_stale is used by the sibling. To | |
358 | extensive use of this option may result in forwarding | |
359 | loops, and you should avoid having two-way peerings | |
360 | with this option. (for example to deny peer usage on | |
361 | requests from peer by denying cache_peer_access if the | |
362 | source is a peer) | |
363 | ||
e79a6f05 | 364 | use 'max-conn' to limit the amount of connections Squid |
365 | may open to this peer. | |
366 | ||
934b03fc | 367 | NOTE: non-ICP neighbors must be specified as 'parent'. |
934b03fc | 368 | DOC_END |
369 | ||
af7d912e | 370 | NAME: cache_peer_domain cache_host_domain |
934b03fc | 371 | TYPE: hostdomain |
f1dc9b30 | 372 | DEFAULT: none |
373 | LOC: none | |
934b03fc | 374 | DOC_START |
cf5cc17e | 375 | Use to limit the domains for which a neighbor cache will be |
376 | queried. Usage: | |
934b03fc | 377 | |
af7d912e | 378 | cache_peer_domain cache-host domain [domain ...] |
379 | cache_peer_domain cache-host !domain | |
934b03fc | 380 | |
381 | For example, specifying | |
382 | ||
af7d912e | 383 | cache_peer_domain parent.foo.net .edu |
934b03fc | 384 | |
385 | has the effect such that UDP query packets are sent to | |
386 | 'bigserver' only when the requested object exists on a | |
387 | server in the .edu domain. Prefixing the domainname | |
388 | with '!' means that the cache will be queried for objects | |
389 | NOT in that domain. | |
390 | ||
391 | NOTE: * Any number of domains may be given for a cache-host, | |
392 | either on the same or separate lines. | |
393 | * When multiple domains are given for a particular | |
394 | cache-host, the first matched domain is applied. | |
395 | * Cache hosts with no domain restrictions are queried | |
396 | for all requests. | |
397 | * There are no defaults. | |
3794b2b6 | 398 | * There is also a 'cache_peer_access' tag in the ACL |
934b03fc | 399 | section. |
400 | DOC_END | |
401 | ||
402 | ||
403 | NAME: neighbor_type_domain | |
404 | TYPE: hostdomaintype | |
f1dc9b30 | 405 | DEFAULT: none |
406 | LOC: none | |
934b03fc | 407 | DOC_START |
408 | usage: neighbor_type_domain parent|sibling domain domain ... | |
409 | ||
410 | Modifying the neighbor type for specific domains is now | |
411 | possible. You can treat some domains differently than the the | |
a95856a0 | 412 | default neighbor type specified on the 'cache_peer' line. |
934b03fc | 413 | Normally it should only be necessary to list domains which |
414 | should be treated differently because the default neighbor type | |
415 | applies for hostnames which do not match domains listed here. | |
416 | ||
417 | EXAMPLE: | |
a95856a0 | 418 | cache_peer parent cache.foo.org 3128 3130 |
934b03fc | 419 | neighbor_type_domain cache.foo.org sibling .com .net |
420 | neighbor_type_domain cache.foo.org sibling .au .de | |
421 | DOC_END | |
422 | ||
465dc415 | 423 | NAME: icp_query_timeout |
424 | COMMENT: (msec) | |
425 | DEFAULT: 0 | |
426 | TYPE: int | |
427 | LOC: Config.Timeout.icp_query | |
934b03fc | 428 | DOC_START |
465dc415 | 429 | Normally Squid will automatically determine an optimal ICP |
430 | query timeout value based on the round-trip-time of recent ICP | |
431 | queries. If you want to override the value determined by | |
432 | Squid, set this 'icp_query_timeout' to a non-zero value. This | |
433 | value is specified in MILLISECONDS, so, to use a 2-second | |
434 | timeout (the old default), you would write: | |
934b03fc | 435 | |
465dc415 | 436 | icp_query_timeout 2000 |
465dc415 | 437 | DOC_END |
438 | ||
28993292 | 439 | NAME: maximum_icp_query_timeout |
440 | COMMENT: (msec) | |
441 | DEFAULT: 2000 | |
442 | TYPE: int | |
443 | LOC: Config.Timeout.icp_query_max | |
444 | DOC_START | |
efd900cb | 445 | Normally the ICP query timeout is determined dynamically. But |
446 | sometimes it can lead to very large values (say 5 seconds). | |
447 | Use this option to put an upper limit on the dynamic timeout | |
448 | value. Do NOT use this option to always use a fixed (instead | |
e0d5ba83 | 449 | of a dynamic) timeout value. To set a fixed timeout see the |
450 | 'icp_query_timeout' directive. | |
28993292 | 451 | DOC_END |
452 | ||
465dc415 | 453 | NAME: mcast_icp_query_timeout |
454 | COMMENT: (msec) | |
455 | DEFAULT: 2000 | |
456 | TYPE: int | |
457 | LOC: Config.Timeout.mcast_icp_query | |
458 | DOC_START | |
459 | For Multicast peers, Squid regularly sends out ICP "probes" to | |
460 | count how many other peers are listening on the given multicast | |
461 | address. This value specifies how long Squid should wait to | |
462 | count all the replies. The default is 2000 msec, or 2 | |
463 | seconds. | |
934b03fc | 464 | DOC_END |
465 | ||
dc835977 | 466 | NAME: dead_peer_timeout |
467 | COMMENT: (seconds) | |
468 | DEFAULT: 10 seconds | |
469 | TYPE: time_t | |
470 | LOC: Config.Timeout.deadPeer | |
471 | DOC_START | |
472 | This controls how long Squid waits to declare a peer cache | |
473 | as "dead." If there are no ICP replies received in this | |
474 | amount of time, Squid will declare the peer dead and not | |
475 | expect to receive any further ICP replies. However, it | |
476 | continues to send ICP queries, and will mark the peer as | |
477 | alive upon receipt of the first subsequent ICP reply. | |
478 | ||
a8ad9a81 | 479 | This timeout also affects when Squid expects to receive ICP |
480 | replies from peers. If more than 'dead_peer' seconds have | |
481 | passed since the last ICP reply was received, Squid will not | |
482 | expect to receive an ICP reply on the next query. Thus, if | |
483 | your time between requests is greater than this timeout, you | |
484 | will see a lot of requests sent DIRECT to origin servers | |
485 | instead of to your parents. | |
dc835977 | 486 | DOC_END |
487 | ||
934b03fc | 488 | |
489 | NAME: hierarchy_stoplist | |
490 | TYPE: wordlist | |
f8d9f54a | 491 | DEFAULT: none |
934b03fc | 492 | LOC: Config.hierarchy_stoplist |
493 | DOC_START | |
494 | A list of words which, if found in a URL, cause the object to | |
495 | be handled directly by this cache. In other words, use this | |
496 | to not query neighbor caches for certain objects. You may | |
497 | list this option multiple times. | |
6b53c392 | 498 | NOCOMMENT_START |
499 | #We recommend you to use at least the following line. | |
934b03fc | 500 | hierarchy_stoplist cgi-bin ? |
6b53c392 | 501 | NOCOMMENT_END |
934b03fc | 502 | DOC_END |
503 | ||
504 | ||
bd05e3e3 | 505 | NAME: no_cache |
506 | TYPE: acl_access | |
507 | DEFAULT: none | |
508 | LOC: Config.accessList.noCache | |
934b03fc | 509 | DOC_START |
d08a99eb | 510 | A list of ACL elements which, if matched, cause the request to |
511 | not be satisfied from the cache and the reply to not be cached. | |
512 | In other words, use this to force certain objects to never be cached. | |
934b03fc | 513 | |
b269cf4e | 514 | You must use the word 'DENY' to indicate the ACL names which should |
515 | NOT be cached. | |
0fdafae7 | 516 | |
6b53c392 | 517 | NOCOMMENT_START |
518 | #We recommend you to use the following two lines. | |
bd05e3e3 | 519 | acl QUERY urlpath_regex cgi-bin \? |
b269cf4e | 520 | no_cache deny QUERY |
6b53c392 | 521 | NOCOMMENT_END |
934b03fc | 522 | DOC_END |
523 | ||
934b03fc | 524 | |
0f74202c | 525 | COMMENT_START |
3a278cb8 | 526 | OPTIONS WHICH AFFECT THE CACHE SIZE |
527 | ----------------------------------------------------------------------------- | |
0f74202c | 528 | COMMENT_END |
934b03fc | 529 | |
530 | NAME: cache_mem | |
9906e724 | 531 | COMMENT: (bytes) |
1b635117 | 532 | TYPE: b_size_t |
9906e724 | 533 | DEFAULT: 8 MB |
43a70238 | 534 | LOC: Config.memMaxSize |
934b03fc | 535 | DOC_START |
7b2496ca | 536 | NOTE: THIS PARAMETER DOES NOT SPECIFY THE MAXIMUM PROCESS |
537 | SIZE. IT PLACES A LIMIT ON ONE ASPECT OF SQUID'S MEMORY | |
538 | USAGE. SQUID USES MEMORY FOR OTHER THINGS AS WELL. | |
539 | YOUR PROCESS WILL PROBABLY BECOME TWICE OR THREE TIMES | |
96d88dcb | 540 | BIGGER THAN THE VALUE YOU PUT HERE |
7b2496ca | 541 | |
542 | 'cache_mem' specifies the ideal amount of memory to be used | |
543 | for: | |
544 | * In-Transit objects | |
545 | * Hot Objects | |
546 | * Negative-Cached objects | |
547 | ||
548 | Data for these objects are stored in 4 KB blocks. This | |
549 | parameter specifies the ideal upper limit on the total size of | |
550 | 4 KB blocks allocated. In-Transit objects take the highest | |
551 | priority. | |
934b03fc | 552 | |
553 | In-transit objects have priority over the others. When | |
554 | additional space is needed for incoming data, negative-cached | |
555 | and hot objects will be released. In other words, the | |
556 | negative-cached and hot objects will fill up any unused space | |
557 | not needed for in-transit objects. | |
558 | ||
7b2496ca | 559 | If circumstances require, this limit will be exceeded. |
560 | Specifically, if your incoming request rate requires more than | |
561 | 'cache_mem' of memory to hold in-transit objects, Squid will | |
562 | exceed this limit to satisfy the new requests. When the load | |
563 | decreases, blocks will be freed until the high-water mark is | |
564 | reached. Thereafter, blocks will be used to store hot | |
565 | objects. | |
934b03fc | 566 | DOC_END |
567 | ||
568 | ||
569 | NAME: cache_swap_low | |
570 | COMMENT: (percent, 0-100) | |
571 | TYPE: int | |
572 | DEFAULT: 90 | |
573 | LOC: Config.Swap.lowWaterMark | |
574 | DOC_NONE | |
575 | ||
576 | NAME: cache_swap_high | |
577 | COMMENT: (percent, 0-100) | |
578 | TYPE: int | |
579 | DEFAULT: 95 | |
580 | LOC: Config.Swap.highWaterMark | |
581 | DOC_START | |
2b906e48 | 582 | |
583 | The low- and high-water marks for cache object replacement. | |
584 | Replacement begins when the swap (disk) usage is above the | |
585 | low-water mark and attempts to maintain utilization near the | |
586 | low-water mark. As swap utilization gets close to high-water | |
587 | mark object eviction becomes more aggressive. If utilization is | |
588 | close to the low-water mark less replacement is done each time. | |
589 | ||
590 | Defaults are 90% and 95%. If you have a large cache, 5% could be | |
591 | hundreds of MB. If this is the case you may wish to set these | |
592 | numbers closer together. | |
934b03fc | 593 | DOC_END |
594 | ||
934b03fc | 595 | NAME: maximum_object_size |
9e975e4e | 596 | COMMENT: (bytes) |
1b635117 | 597 | TYPE: b_size_t |
9906e724 | 598 | DEFAULT: 4096 KB |
934b03fc | 599 | LOC: Config.Store.maxObjectSize |
600 | DOC_START | |
601 | Objects larger than this size will NOT be saved on disk. The | |
cf5cc17e | 602 | value is specified in kilobytes, and the default is 4MB. If |
603 | you wish to get a high BYTES hit ratio, you should probably | |
604 | increase this (one 32 MB object hit counts for 3200 10KB | |
605 | hits). If you wish to increase speed more than your want to | |
606 | save bandwidth you should leave this low. | |
934b03fc | 607 | |
2b906e48 | 608 | NOTE: if using the LFUDA replacement policy you should increase |
609 | this value to maximize the byte hit rate improvement of LFUDA! | |
610 | See replacement_policy below for a discussion of this policy. | |
934b03fc | 611 | DOC_END |
612 | ||
d20b1cd0 | 613 | NAME: minimum_object_size |
614 | COMMENT: (bytes) | |
615 | TYPE: b_size_t | |
616 | DEFAULT: 0 KB | |
617 | LOC: Config.Store.minObjectSize | |
618 | DOC_START | |
619 | Objects smaller than this size will NOT be saved on disk. The | |
620 | value is specified in kilobytes, and the default is 0 KB, which | |
621 | means there is no minimum. | |
622 | DOC_END | |
934b03fc | 623 | |
16689110 | 624 | NAME: maximum_object_size_in_memory |
625 | COMMENT: (bytes) | |
626 | TYPE: b_size_t | |
627 | DEFAULT: 8 KB | |
628 | LOC: Config.Store.maxInMemObjSize | |
629 | DOC_START | |
630 | Objects greater than this size will not be attempted to kept in | |
631 | the memory cache. This should be set high enough to keep objects | |
632 | accessed frequently in memory to improve performance whilst low | |
633 | enough to keep larger objects from hoarding cache_mem . | |
634 | DOC_END | |
635 | ||
934b03fc | 636 | NAME: ipcache_size |
637 | COMMENT: (number of entries) | |
638 | TYPE: int | |
639 | DEFAULT: 1024 | |
640 | LOC: Config.ipcache.size | |
641 | DOC_NONE | |
642 | ||
643 | NAME: ipcache_low | |
644 | COMMENT: (percent) | |
645 | TYPE: int | |
646 | DEFAULT: 90 | |
647 | LOC: Config.ipcache.low | |
648 | DOC_NONE | |
649 | ||
650 | NAME: ipcache_high | |
651 | COMMENT: (percent) | |
652 | TYPE: int | |
653 | DEFAULT: 95 | |
654 | LOC: Config.ipcache.high | |
655 | DOC_START | |
656 | The size, low-, and high-water marks for the IP cache. | |
934b03fc | 657 | DOC_END |
658 | ||
e55650e3 | 659 | NAME: fqdncache_size |
660 | COMMENT: (number of entries) | |
661 | TYPE: int | |
662 | DEFAULT: 1024 | |
663 | LOC: Config.fqdncache.size | |
664 | DOC_START | |
665 | Maximum number of FQDN cache entries. | |
e55650e3 | 666 | DOC_END |
667 | ||
6a566b9c | 668 | NAME: cache_replacement_policy |
669 | TYPE: removalpolicy | |
670 | LOC: Config.replPolicy | |
671 | DEFAULT: lru | |
672 | DOC_START | |
673 | The cache replacement policy parameter determines which | |
674 | objects are evicted (replaced) when disk space is needed. | |
675 | ||
676 | lru : Squid's original list based LRU policy | |
677 | heap GDSF : Greedy-Dual Size Frequency | |
678 | heap LFUDA: Least Frequently Used with Dynamic Aging | |
679 | heap LRU : LRU policy implemented using a heap | |
680 | ||
681 | Applies to any cache_dir lines listed below this. | |
682 | ||
683 | The LRU policies keeps recently referenced objects. | |
684 | ||
685 | The heap GDSF policy optimizes object hit rate by keeping smaller | |
686 | popular objects in cache so it has a better chance of getting a | |
687 | hit. It achieves a lower byte hit rate than LFUDA though since | |
688 | it evicts larger (possibly popular) objects. | |
689 | ||
690 | The heap LFUDA policy keeps popular objects in cache regardless of | |
691 | their size and thus optimizes byte hit rate at the expense of | |
692 | hit rate since one large, popular object will prevent many | |
693 | smaller, slightly less popular objects from being cached. | |
694 | ||
695 | Both policies utilize a dynamic aging mechanism that prevents | |
696 | cache pollution that can otherwise occur with frequency-based | |
697 | replacement policies. | |
698 | ||
699 | NOTE: if using the LFUDA replacement policy you should increase | |
700 | the value of maximum_object_size above its default of 4096 KB to | |
96d88dcb | 701 | to maximize the potential byte hit rate improvement of LFUDA. |
6a566b9c | 702 | |
703 | For more information about the GDSF and LFUDA cache replacement | |
704 | policies see http://www.hpl.hp.com/techreports/1999/HPL-1999-69.html | |
705 | and http://fog.hpl.external.hp.com/techreports/98/HPL-98-173.html. | |
706 | DOC_END | |
707 | ||
708 | NAME: memory_replacement_policy | |
709 | TYPE: removalpolicy | |
710 | LOC: Config.memPolicy | |
711 | DEFAULT: lru | |
712 | DOC_START | |
713 | The memory replacement policy parameter determines which | |
714 | objects are purged from memory when memory space is needed. | |
715 | ||
716 | See cache_replacement_policy for details. | |
717 | DOC_END | |
718 | ||
719 | ||
0f74202c | 720 | COMMENT_START |
3a278cb8 | 721 | LOGFILE PATHNAMES AND CACHE DIRECTORIES |
722 | ----------------------------------------------------------------------------- | |
0f74202c | 723 | COMMENT_END |
934b03fc | 724 | |
725 | NAME: cache_dir | |
726 | TYPE: cachedir | |
f1dc9b30 | 727 | DEFAULT: none |
8e8d4f30 | 728 | DEFAULT_IF_NONE: ufs @DEFAULT_SWAP_DIR@ 100 16 256 |
f1dc9b30 | 729 | LOC: Config.cacheSwap |
934b03fc | 730 | DOC_START |
cf5cc17e | 731 | Usage: |
732 | ||
8e8d4f30 | 733 | cache_dir Type Directory-Name Fs-specific-data [options] |
934b03fc | 734 | |
1f7c9178 | 735 | cache_dir diskd Maxobjsize Directory-Name MB L1 L2 Q1 Q2 |
736 | ||
934b03fc | 737 | You can specify multiple cache_dir lines to spread the |
738 | cache among different disk partitions. | |
739 | ||
c463eb5f | 740 | Type specifies the kind of storage system to use. Only "ufs" |
741 | is built by default. To eanble any of the other storage systems | |
742 | see the --enable-storeio configure option. | |
9bc73deb | 743 | |
cf5cc17e | 744 | 'Directory' is a top-level directory where cache swap |
745 | files will be stored. If you want to use an entire disk | |
746 | for caching, then this can be the mount-point directory. | |
747 | The directory must exist and be writable by the Squid | |
748 | process. Squid will NOT create this directory for you. | |
749 | ||
8e8d4f30 | 750 | The ufs store type: |
751 | ||
752 | "ufs" is the old well-known Squid storage format that has always | |
753 | been there. | |
754 | ||
755 | cache_dir ufs Directory-Name Mbytes L1 L2 [options] | |
cf5cc17e | 756 | |
757 | 'Mbytes' is the amount of disk space (MB) to use under this | |
758 | directory. The default is 100 MB. Change this to suit your | |
759 | configuration. | |
760 | ||
761 | 'Level-1' is the number of first-level subdirectories which | |
762 | will be created under the 'Directory'. The default is 16. | |
763 | ||
764 | 'Level-2' is the number of second-level subdirectories which | |
765 | will be created under each first-level directory. The default | |
766 | is 256. | |
d1595b77 | 767 | |
8e8d4f30 | 768 | The aufs store type: |
769 | ||
770 | "aufs" uses the same storage format as "ufs", utilizing | |
771 | POSIX-threads to avoid blocking the main Squid process on | |
772 | disk-I/O. This was formerly known in Squid as async-io. | |
773 | ||
774 | cache_dir aufs Directory-Name Mbytes L1 L2 [options] | |
775 | ||
776 | see argument descriptions under ufs above | |
777 | ||
778 | The diskd store type: | |
779 | ||
780 | "diskd" uses the same storage format as "ufs", utilizing a | |
781 | separate process to avoid blocking the main Squid process on | |
782 | disk-I/O. | |
783 | ||
784 | cache_dir diskd Directory-Name Mbytes L1 L2 [options] [Q1=n] [Q2=n] | |
785 | ||
786 | see argument descriptions under ufs above | |
787 | ||
788 | Q1 specifies the number of unacknowledged I/O requests when Squid | |
789 | stops opening new files. If this many messages are in the queues, | |
790 | Squid won't open new files. Default is 64 | |
791 | ||
d1595b77 | 792 | Q2 specifies the number of unacknowledged messages when Squid |
793 | starts blocking. If this many messages are in the queues, | |
8e8d4f30 | 794 | Squid blocks until it recevies some replies. Default is 72 |
795 | ||
796 | Common options: | |
797 | ||
798 | read-only, this cache_dir is read only. | |
799 | ||
800 | max-size=n, refers to the max object size this storedir supports. | |
801 | It is used to initially choose the storedir to dump the object. | |
802 | Note: To make optimal use of the max-size limits you should order | |
803 | the cache_dir lines with the smallest max-size value first and the | |
804 | ones with no max-size specification last. | |
934b03fc | 805 | DOC_END |
806 | ||
807 | ||
808 | NAME: cache_access_log | |
809 | TYPE: string | |
d0b98f84 | 810 | DEFAULT: @DEFAULT_ACCESS_LOG@ |
934b03fc | 811 | LOC: Config.Log.access |
812 | DOC_START | |
813 | Logs the client request activity. Contains an entry for | |
0eb83825 | 814 | every HTTP and ICP queries received. To disable, enter "none". |
934b03fc | 815 | DOC_END |
816 | ||
817 | ||
818 | NAME: cache_log | |
819 | TYPE: string | |
0153d498 | 820 | DEFAULT: @DEFAULT_CACHE_LOG@ |
934b03fc | 821 | LOC: Config.Log.log |
822 | DOC_START | |
cf5cc17e | 823 | Cache logging file. This is where general information about |
efd900cb | 824 | your cache's behavior goes. You can increase the amount of data |
cf5cc17e | 825 | logged to this file with the "debug_options" tag below. |
934b03fc | 826 | DOC_END |
827 | ||
828 | ||
829 | NAME: cache_store_log | |
830 | TYPE: string | |
0153d498 | 831 | DEFAULT: @DEFAULT_STORE_LOG@ |
934b03fc | 832 | LOC: Config.Log.store |
833 | DOC_START | |
834 | Logs the activities of the storage manager. Shows which | |
835 | objects are ejected from the cache, and which objects are | |
cf5cc17e | 836 | saved and for how long. To disable, enter "none". There are |
efd900cb | 837 | not really utilities to analyze this data, so you can safely |
cf5cc17e | 838 | disable it. |
934b03fc | 839 | DOC_END |
840 | ||
841 | ||
842 | NAME: cache_swap_log | |
843 | TYPE: string | |
844 | LOC: Config.Log.swap | |
1273d501 | 845 | DEFAULT: none |
934b03fc | 846 | DOC_START |
d0d3ec94 | 847 | Location for the cache "swap.log." This log file holds the |
934b03fc | 848 | metadata of objects saved on disk. It is used to rebuild the |
a80e50c7 | 849 | cache during startup. Normally this file resides in each |
934b03fc | 850 | 'cache_dir' directory, but you may specify an alternate |
851 | pathname here. Note you must give a full filename, not just | |
cf5cc17e | 852 | a directory. Since this is the index for the whole object |
853 | list you CANNOT periodically rotate it! | |
934b03fc | 854 | |
a80e50c7 | 855 | If %s can be used in the file name then it will be replaced with a |
856 | a representation of the cache_dir name where each / is replaced | |
857 | with '.'. This is needed to allow adding/removing cache_dir | |
858 | lines when cache_swap_log is being used. | |
96d88dcb | 859 | |
a80e50c7 | 860 | If have more than one 'cache_dir', and %s is not used in the name |
861 | then these swap logs will have names such as: | |
710df4ca | 862 | |
863 | cache_swap_log.00 | |
864 | cache_swap_log.01 | |
865 | cache_swap_log.02 | |
866 | ||
867 | The numbered extension (which is added automatically) | |
868 | corresponds to the order of the 'cache_dir' lines in this | |
869 | configuration file. If you change the order of the 'cache_dir' | |
870 | lines in this file, then these log files will NOT correspond to | |
871 | the correct 'cache_dir' entry (unless you manually rename | |
872 | them). We recommend that you do NOT use this option. It is | |
873 | better to keep these log files in each 'cache_dir' directory. | |
934b03fc | 874 | DOC_END |
875 | ||
876 | ||
877 | NAME: emulate_httpd_log | |
878 | COMMENT: on|off | |
879 | TYPE: onoff | |
f1dc9b30 | 880 | DEFAULT: off |
17a0a4ee | 881 | LOC: Config.onoff.common_log |
934b03fc | 882 | DOC_START |
883 | The Cache can emulate the log file format which many 'httpd' | |
884 | programs use. To disable/enable this emulation, set | |
885 | emulate_httpd_log to 'off' or 'on'. The default | |
cf5cc17e | 886 | is to use the native log format since it includes useful |
efd900cb | 887 | information that Squid-specific log analyzers use. |
934b03fc | 888 | DOC_END |
889 | ||
890b0fa8 | 890 | NAME: log_ip_on_direct |
891 | COMMENT: on|off | |
892 | TYPE: onoff | |
893 | DEFAULT: on | |
894 | LOC: Config.onoff.log_ip_on_direct | |
895 | DOC_START | |
896 | Log the destination IP address in the hierarchy log tag when going | |
897 | direct. Earlier Squid versions logged the hostname here. If you | |
898 | prefer the old way set this to off. | |
890b0fa8 | 899 | DOC_END |
934b03fc | 900 | |
901 | NAME: mime_table | |
f0b19334 | 902 | TYPE: string |
0153d498 | 903 | DEFAULT: @DEFAULT_MIME_TABLE@ |
934b03fc | 904 | LOC: Config.mimeTablePathname |
905 | DOC_START | |
cf5cc17e | 906 | Pathname to Squid's MIME table. You shouldn't need to change |
907 | this, but the default file contains examples and formatting | |
908 | information if you do. | |
934b03fc | 909 | DOC_END |
910 | ||
911 | ||
912 | NAME: log_mime_hdrs | |
913 | COMMENT: on|off | |
914 | TYPE: onoff | |
17a0a4ee | 915 | LOC: Config.onoff.log_mime_hdrs |
f1dc9b30 | 916 | DEFAULT: off |
934b03fc | 917 | DOC_START |
cf5cc17e | 918 | The Cache can record both the request and the response MIME |
919 | headers for each HTTP transaction. The headers are encoded | |
920 | safely and will appear as two bracketed fields at the end of | |
921 | the access log (for either the native or httpd-emulated log | |
922 | formats). To enable this logging set log_mime_hdrs to 'on'. | |
934b03fc | 923 | DOC_END |
924 | ||
925 | ||
926 | NAME: useragent_log | |
927 | TYPE: string | |
928 | LOC: Config.Log.useragent | |
f1dc9b30 | 929 | DEFAULT: none |
6b53c392 | 930 | IFDEF: USE_USERAGENT_LOG |
934b03fc | 931 | DOC_START |
6b53c392 | 932 | Squid will write the User-Agent field from HTTP requests |
933 | to the filename specified here. By default useragent_log | |
934 | is disabled. | |
934b03fc | 935 | DOC_END |
936 | ||
937 | ||
fd2c5549 | 938 | NAME: referer_log |
939 | TYPE: string | |
940 | LOC: Config.Log.referer | |
941 | DEFAULT: none | |
b81f1cf3 | 942 | IFDEF: USE_REFERER_LOG |
fd2c5549 | 943 | DOC_START |
b81f1cf3 | 944 | Squid will write the Referer field from HTTP requests to the |
945 | filename specified here. By default referer_log is disabled. | |
fd2c5549 | 946 | DOC_END |
947 | ||
948 | ||
934b03fc | 949 | NAME: pid_filename |
950 | TYPE: string | |
0153d498 | 951 | DEFAULT: @DEFAULT_PID_FILE@ |
934b03fc | 952 | LOC: Config.pidFilename |
953 | DOC_START | |
d0d41f07 | 954 | A filename to write the process-id to. To disable, enter "none". |
934b03fc | 955 | DOC_END |
956 | ||
957 | ||
958 | NAME: debug_options | |
f1dc9b30 | 959 | TYPE: eol |
934b03fc | 960 | DEFAULT: ALL,1 |
961 | LOC: Config.debugOptions | |
962 | DOC_START | |
963 | Logging options are set as section,level where each source file | |
964 | is assigned a unique section. Lower levels result in less | |
965 | output, Full debugging (level 9) can result in a very large | |
966 | log file, so be careful. The magic word "ALL" sets debugging | |
967 | levels for all sections. We recommend normally running with | |
968 | "ALL,1". | |
934b03fc | 969 | DOC_END |
970 | ||
971 | ||
934b03fc | 972 | NAME: log_fqdn |
973 | COMMENT: on|off | |
974 | TYPE: onoff | |
f1dc9b30 | 975 | DEFAULT: off |
17a0a4ee | 976 | LOC: Config.onoff.log_fqdn |
934b03fc | 977 | DOC_START |
978 | Turn this on if you wish to log fully qualified domain names | |
cf5cc17e | 979 | in the access.log. To do this Squid does a DNS lookup of all |
980 | IP's connecting to it. This can (in some situations) increase | |
981 | latency, which makes your cache seem slower for interactive | |
96d88dcb | 982 | browsing. |
934b03fc | 983 | DOC_END |
984 | ||
985 | ||
986 | NAME: client_netmask | |
987 | TYPE: address | |
988 | LOC: Config.Addrs.client_netmask | |
f1dc9b30 | 989 | DEFAULT: 255.255.255.255 |
934b03fc | 990 | DOC_START |
991 | A netmask for client addresses in logfiles and cachemgr output. | |
992 | Change this to protect the privacy of your cache clients. | |
cf5cc17e | 993 | A netmask of 255.255.255.0 will log all IP's in that range with |
994 | the last digit set to '0'. | |
934b03fc | 995 | DOC_END |
996 | ||
997 | ||
0f74202c | 998 | COMMENT_START |
3a278cb8 | 999 | OPTIONS FOR EXTERNAL SUPPORT PROGRAMS |
1000 | ----------------------------------------------------------------------------- | |
0f74202c | 1001 | COMMENT_END |
934b03fc | 1002 | |
934b03fc | 1003 | NAME: ftp_user |
1004 | TYPE: string | |
cf5cc17e | 1005 | DEFAULT: Squid@ |
934b03fc | 1006 | LOC: Config.Ftp.anon_user |
1007 | DOC_START | |
1008 | If you want the anonymous login password to be more informative | |
1009 | (and enable the use of picky ftp servers), set this to something | |
efd900cb | 1010 | reasonable for your domain, like wwwuser@somewhere.net |
934b03fc | 1011 | |
1012 | The reason why this is domainless by default is that the | |
1013 | request can be made on the behalf of a user in any domain, | |
1014 | depending on how the cache is used. | |
1015 | Some ftp server also validate that the email address is valid | |
1016 | (for example perl.com). | |
934b03fc | 1017 | DOC_END |
1018 | ||
365cb147 | 1019 | NAME: ftp_list_width |
1b635117 | 1020 | TYPE: size_t |
365cb147 | 1021 | DEFAULT: 32 |
1022 | LOC: Config.Ftp.list_width | |
1023 | DOC_START | |
cf5cc17e | 1024 | Sets the width of ftp listings. This should be set to fit in |
1025 | the width of a standard browser. Setting this too small | |
1026 | can cut off long filenames when browsing ftp sites. | |
365cb147 | 1027 | DOC_END |
1028 | ||
d20b1cd0 | 1029 | NAME: ftp_passive |
1030 | TYPE: onoff | |
1031 | DEFAULT: on | |
1032 | LOC: Config.Ftp.passive | |
1033 | DOC_START | |
1034 | If your firewall does not allow Squid to use passive | |
1035 | connections, then turn off this option. | |
1036 | DOC_END | |
1037 | ||
934b03fc | 1038 | NAME: cache_dns_program |
f0b19334 | 1039 | TYPE: string |
589c90de | 1040 | IFDEF: USE_DNSSERVERS |
0153d498 | 1041 | DEFAULT: @DEFAULT_DNSSERVER@ |
934b03fc | 1042 | LOC: Config.Program.dnsserver |
1043 | DOC_START | |
1044 | Specify the location of the executable for dnslookup process. | |
934b03fc | 1045 | DOC_END |
1046 | ||
934b03fc | 1047 | NAME: dns_children |
1048 | TYPE: int | |
6b53c392 | 1049 | IFDEF: USE_DNSSERVERS |
934b03fc | 1050 | DEFAULT: 5 |
1051 | LOC: Config.dnsChildren | |
1052 | DOC_START | |
1053 | The number of processes spawn to service DNS name lookups. | |
1054 | For heavily loaded caches on large servers, you should | |
1055 | probably increase this value to at least 10. The maximum | |
1056 | is 32. The default is 5. | |
1057 | ||
efd900cb | 1058 | You must have at least one dnsserver process. |
934b03fc | 1059 | DOC_END |
1060 | ||
4fe0e1d0 | 1061 | NAME: dns_retransmit_interval |
1062 | TYPE: time_t | |
1063 | DEFAULT: 5 seconds | |
1064 | LOC: Config.Timeout.idns_retransmit | |
1065 | IFDEF: !USE_DNSSERVERS | |
1066 | DOC_START | |
1067 | Initial retransmit interval for DNS queries. The interval is | |
1068 | doubled each time all configured DNS servers have been tried. | |
1069 | ||
1070 | DOC_END | |
1071 | ||
1072 | NAME: dns_timeout | |
1073 | TYPE: time_t | |
1074 | DEFAULT: 5 minutes | |
1075 | LOC: Config.Timeout.idns_query | |
1076 | IFDEF: !USE_DNSSERVERS | |
1077 | DOC_START | |
1078 | DNS Query timeout. If no response is received to a DNS query | |
1079 | within this time then all DNS servers for the queried domain | |
1080 | is assumed to be unavailable. | |
1081 | DOC_END | |
934b03fc | 1082 | |
1083 | NAME: dns_defnames | |
1084 | COMMENT: on|off | |
589c90de | 1085 | IFDEF: USE_DNSSERVERS |
934b03fc | 1086 | TYPE: onoff |
f1dc9b30 | 1087 | DEFAULT: off |
17a0a4ee | 1088 | LOC: Config.onoff.res_defnames |
6b53c392 | 1089 | IFDEF: USE_DNSSERVERS |
934b03fc | 1090 | DOC_START |
1091 | Normally the 'dnsserver' disables the RES_DEFNAMES resolver | |
1092 | option (see res_init(3)). This prevents caches in a hierarchy | |
1093 | from interpreting single-component hostnames locally. To allow | |
1094 | dnsserver to handle single-component names, enable this | |
1095 | option. | |
934b03fc | 1096 | DOC_END |
1097 | ||
09c483ec | 1098 | NAME: dns_nameservers |
1099 | TYPE: wordlist | |
1100 | DEFAULT: none | |
1101 | LOC: Config.dns_nameservers | |
1102 | DOC_START | |
1103 | Use this if you want to specify a list of DNS name servers | |
1104 | (IP addresses) to use instead of those given in your | |
1105 | /etc/resolv.conf file. | |
1106 | ||
1107 | Example: dns_nameservers 10.0.0.1 192.172.0.4 | |
09c483ec | 1108 | DOC_END |
1109 | ||
0e70aa1e | 1110 | NAME: hosts_file |
1111 | TYPE: string | |
1112 | DEFAULT: /etc/hosts | |
1113 | LOC: Config.etcHostsPath | |
1114 | DOC_START | |
1115 | Location of the host-local IP name-address associations | |
1116 | database. Most Operating Systems have such a file: under | |
1117 | Un*X it's by default in /etc/hosts MS-Windows NT/2000 places | |
1118 | that in %SystemRoot%(by default | |
1119 | c:\winnt)\system32\drivers\etc\hosts, while Windows 9x/ME | |
1120 | places that in %windir%(usually c:\windows)\hosts | |
1121 | ||
1122 | The file contains newline-separated definitions, in the | |
1123 | form ip_address_in_dotted_form name [name ...] names are | |
1124 | whitespace-separated. lines beginnng with an hash (#) | |
1125 | character are comments. | |
1126 | ||
1127 | The file is checked at startup and upon configuration. If | |
1128 | set to 'none', it won't be checked. If append_domain is | |
1129 | used, that domain will be added to domain-local (i.e. not | |
1130 | containing any dot character) host definitions. | |
1131 | DOC_END | |
934b03fc | 1132 | |
be7d89d4 | 1133 | NAME: diskd_program |
1134 | TYPE: string | |
1135 | DEFAULT: @DEFAULT_DISKD@ | |
1136 | LOC: Config.Program.diskd | |
1137 | DOC_START | |
1138 | Specify the location of the diskd executable. | |
1139 | Note that this is only useful if you have compiled in | |
1140 | diskd as one of the store io modules. | |
1141 | DOC_END | |
1142 | ||
934b03fc | 1143 | NAME: unlinkd_program |
a3d0a19d | 1144 | IFDEF: USE_UNLINKD |
f0b19334 | 1145 | TYPE: string |
0153d498 | 1146 | DEFAULT: @DEFAULT_UNLINKD@ |
934b03fc | 1147 | LOC: Config.Program.unlinkd |
1148 | DOC_START | |
1149 | Specify the location of the executable for file deletion process. | |
934b03fc | 1150 | DOC_END |
1151 | ||
934b03fc | 1152 | NAME: pinger_program |
a95856a0 | 1153 | TYPE: string |
0153d498 | 1154 | DEFAULT: @DEFAULT_PINGER@ |
934b03fc | 1155 | LOC: Config.Program.pinger |
6b53c392 | 1156 | IFDEF: USE_ICMP |
934b03fc | 1157 | DOC_START |
1158 | Specify the location of the executable for the pinger process. | |
934b03fc | 1159 | DOC_END |
1160 | ||
1161 | ||
1162 | NAME: redirect_program | |
c6d5b87b | 1163 | TYPE: wordlist |
934b03fc | 1164 | LOC: Config.Program.redirect |
62607543 | 1165 | DEFAULT: none |
934b03fc | 1166 | DOC_START |
1167 | Specify the location of the executable for the URL redirector. | |
cf5cc17e | 1168 | Since they can perform almost any function there isn't one included. |
3f94eab9 | 1169 | See the FAQ (section 15) for information on how to write one. |
cf5cc17e | 1170 | By default, a redirector is not used. |
934b03fc | 1171 | DOC_END |
1172 | ||
1173 | ||
1174 | NAME: redirect_children | |
1175 | TYPE: int | |
1176 | DEFAULT: 5 | |
1177 | LOC: Config.redirectChildren | |
1178 | DOC_START | |
cf5cc17e | 1179 | The number of redirector processes to spawn. If you start |
1180 | too few Squid will have to wait for them to process a backlog of | |
1181 | URLs, slowing it down. If you start too many they will use RAM | |
1182 | and other system resources. | |
934b03fc | 1183 | DOC_END |
1184 | ||
c68e9c6b | 1185 | NAME: redirect_rewrites_host_header |
1186 | TYPE: onoff | |
1187 | DEFAULT: on | |
1188 | LOC: Config.onoff.redir_rewrites_host | |
1189 | DOC_START | |
7e3ce7b9 | 1190 | By default Squid rewrites any Host: header in redirected |
1191 | requests. If you are running a accelerator then this may | |
1192 | not be a wanted effect of a redirector. | |
c68e9c6b | 1193 | DOC_END |
1194 | ||
9bc73deb | 1195 | NAME: redirector_access |
1196 | TYPE: acl_access | |
1197 | DEFAULT: none | |
1198 | LOC: Config.accessList.redirector | |
1199 | DOC_START | |
1200 | If defined, this access list specifies which requests are | |
1201 | sent to the redirector processes. By default all requests | |
1202 | are sent. | |
1203 | DOC_END | |
1204 | ||
94439e4e | 1205 | NAME: auth_param |
1206 | TYPE: authparam | |
1207 | LOC: Config.authConfig | |
73e67ee0 | 1208 | DEFAULT: none |
1209 | DOC_START | |
94439e4e | 1210 | This is used to pass parameters to the various authentication |
1211 | schemes. | |
1212 | format: auth_param scheme parameter [setting] | |
1213 | ||
1214 | auth_param basic program @DEFAULT_PREFIX@/bin/ncsa_auth @DEFAULT_PREFIX@/etc/passwd | |
1215 | would tell the basic authentication scheme it's program parameter. | |
1216 | ||
1217 | The order that authentication prompts are presented to the client_agent | |
1218 | is dependant on the order the scheme first appears in config file. | |
1219 | IE has a bug (it's not rfc 2617 compliant) in that it will use the basic | |
1220 | scheme if basic is the first entry presented, even if more secure schemes | |
1221 | are presented. For now use the order in the file below. If other browsers | |
1222 | have difficulties (don't recognise the schemes offered even if you are using | |
1223 | basic) then either put basic first, or disable the other schemes (by commenting | |
1224 | out their program entry). | |
1225 | ||
2d70df72 | 1226 | Once an authentication scheme is fully configured, it can only be shutdown |
1227 | by shutting squid down and restarting. Changes can be made on the fly and | |
96d88dcb | 1228 | activated with a reconfigure. I.E. You can change to a different helper, |
2d70df72 | 1229 | but not unconfigure the helper completely. |
1230 | ||
94439e4e | 1231 | === Parameters for the basic scheme follow. === |
1232 | ||
1233 | "program" cmdline | |
6c20b822 | 1234 | Specify the command for the external authenticator. Such a |
1235 | program reads a line containing "username password" and replies | |
1236 | "OK" or "ERR" in an endless loop. If you use an authenticator, | |
1237 | make sure you have 1 acl of type proxy_auth. By default, the | |
94439e4e | 1238 | authenticate_program is not used. |
73e67ee0 | 1239 | |
6c20b822 | 1240 | If you want to use the traditional proxy authentication, |
1241 | jump over to the ../auth_modules/NCSA directory and | |
1242 | type: | |
1243 | % make | |
1244 | % make install | |
73e67ee0 | 1245 | |
6c20b822 | 1246 | Then, set this line to something like |
73e67ee0 | 1247 | |
94439e4e | 1248 | auth_param basic program @DEFAULT_PREFIX@/bin/ncsa_auth @DEFAULT_PREFIX@/etc/passwd |
73e67ee0 | 1249 | |
94439e4e | 1250 | "children" numberofchildren |
1251 | The number of authenticator processes to spawn (no default). If you | |
73e67ee0 | 1252 | start too few Squid will have to wait for them to process a backlog |
1253 | of usercode/password verifications, slowing it down. When password | |
1254 | verifications are done via a (slow) network you are likely to need | |
1255 | lots of authenticator processes. | |
94439e4e | 1256 | auth_param basic children 5 |
1257 | ||
1258 | "realm" realmstring | |
1259 | Specifies the realm name which is to be reported to the client for | |
1260 | the basic proxy authentication scheme (part of the text the user will | |
1261 | see when prompted their username and password). Their is no default. | |
1262 | auth_param basic realm Squid proxy-caching web server | |
1263 | ||
1264 | "credentialsttl" timetolive | |
1265 | Specifies how long squid assumes an externally validated username:password | |
96d88dcb | 1266 | pair is valid for - in other words how often the helper program is called |
94439e4e | 1267 | for that user. Set this low to force revalidation with short lived passwords. |
1268 | Note that setting this high does not impact your susceptability to replay | |
1269 | attacks unless you are using a one-time password system (such as SecureID). | |
1270 | If you are using such a system, you will be vulnerable to replay attacks | |
1271 | unless you also enable the IP ttl is strict option. | |
1272 | ||
2d70df72 | 1273 | === Parameters for the digest scheme follow === |
1274 | ||
1275 | "program" cmdline | |
1276 | Specify the command for the external authenticator. Such a | |
1277 | program reads a line containing "username":"realm" and replies | |
1278 | with the appropriate H(A1) value base64 encoded. See rfc 2616 for | |
1279 | the definition of H(A1). If you use an authenticator, | |
96d88dcb | 1280 | make sure you have 1 acl of type proxy_auth. By default, |
2d70df72 | 1281 | authentication is not used. |
1282 | ||
1283 | If you want to use build a authenticator, | |
96d88dcb | 1284 | jump over to the ../digest_auth_modules directory and choose the |
2d70df72 | 1285 | authenticator to use. It it's directory type |
1286 | % make | |
1287 | % make install | |
1288 | ||
1289 | Then, set this line to something like | |
1290 | ||
1291 | auth_param digest program @DEFAULT_PREFIX@/bin/digest_auth_pw @DEFAULT_PREFIX@/etc/digpass | |
1292 | ||
1293 | ||
1294 | "children" numberofchildren | |
1295 | The number of authenticator processes to spawn (no default). If you | |
1296 | start too few Squid will have to wait for them to process a backlog | |
1297 | of H(A1) calculations, slowing it down. When the H(A1) calculations | |
96d88dcb | 1298 | are done via a (slow) network you are likely to need lots of |
2d70df72 | 1299 | authenticator processes. |
1300 | auth_param digest children 5 | |
1301 | ||
1302 | "realm" realmstring | |
1303 | Specifies the realm name which is to be reported to the client for | |
1304 | the digest proxy authentication scheme (part of the text the user will | |
1305 | see when prompted their username and password). There is no default. | |
1306 | auth_param digest realm Squid proxy-caching web server | |
1307 | ||
1308 | "nonce_garbage_interval" timeinterval | |
1309 | Specifies the interval that nonces that have been issued to client_agent's | |
1310 | are checked for validity. | |
1311 | ||
1312 | "nonce_max_duration" timeinterval | |
96d88dcb | 1313 | Specifies the maximum length of time a given nonce will be valid for. |
2d70df72 | 1314 | |
1315 | "nonce_max_count" number | |
1316 | Specifies the maximum number of times a given nonce can be used. | |
1317 | ||
94439e4e | 1318 | === NTLM scheme options follow === |
1319 | ||
1320 | "program" cmdline | |
1321 | Specify the command for the external ntlm authenticator. Such a | |
1322 | program reads a line containing the uuencoded NEGOTIATE and replies | |
1323 | with the ntlm CHALLENGE, then waits for the response and answers with | |
1324 | "OK" or "ERR" in an endless loop. If you use an ntlm authenticator, | |
1325 | make sure you have 1 acl of type proxy_auth. By default, the | |
1326 | ntlm authenticator_program is not used. | |
1327 | ||
1328 | auth_param ntlm program @DEFAULT_PREFIX@/bin/ntlm_auth | |
1329 | ||
1330 | "children" numberofchildren | |
1331 | The number of authenticator processes to spawn (no default). If you | |
1332 | start too few Squid will have to wait for them to process a backlog | |
1333 | of credential verifications, slowing it down. When crendential | |
1334 | verifications are done via a (slow) network you are likely to need | |
1335 | lots of authenticator processes. | |
1336 | auth_param ntlm children 5 | |
1337 | ||
1338 | "max_challenge_reuses" number | |
1339 | The maximum number of times a challenge given by a ntlm authentication | |
96d88dcb | 1340 | helper can be reused. Increasing this number increases your exposure |
1341 | to replay attacks on your network. 0 means use the challenge only once. | |
94439e4e | 1342 | (disable challenge caching) |
1343 | See max_ntlm_challenge_lifetime for more information. | |
1344 | auth_param ntlm max_challenge_reuses 0 | |
1345 | ||
1346 | "max_challenge_lifetime" timespan | |
1347 | The maximum time period that a ntlm challenge is reused over. | |
96d88dcb | 1348 | The actual period will be the minimum of this time AND the number of |
94439e4e | 1349 | reused challenges. |
1350 | auth_param ntlm max_challenge_lifetime 2 minutes | |
1351 | ||
1352 | NOCOMMENT_START | |
1353 | #Recommended minimum configuration: | |
2d70df72 | 1354 | #auth_param digest program <uncomment and complete this line> |
1355 | #auth_param digest children 5 | |
1356 | #auth_param digest realm Squid proxy-caching web server | |
1357 | #auth_param digest nonce_garbage_interval 5 minutes | |
1358 | #auth_param digest nonce_max_duration 30 minutes | |
1359 | #auth_param digest nonce_max_count 50 | |
94439e4e | 1360 | #auth_param ntlm program <uncomment and complete this line to activate> |
2d70df72 | 1361 | #auth_param ntlm children 5 |
1362 | #auth_param ntlm max_challenge_reuses 0 | |
1363 | #auth_param ntlm max_challenge_lifetime 2 minutes | |
94439e4e | 1364 | #auth_param basic program <uncomment and complete this line> |
1365 | auth_param basic children 5 | |
1366 | auth_param basic realm Squid proxy-caching web server | |
1367 | auth_param basic credentialsttl 2 hours | |
1368 | NOCOMMENT_END | |
1369 | DOC_END | |
1370 | ||
1371 | NAME: authenticate_cache_garbage_interval | |
1372 | TYPE: time_t | |
1373 | DEFAULT: 1 hour | |
1374 | LOC: Config.authenticateGCInterval | |
1375 | DOC_START | |
96d88dcb | 1376 | The time period between garbage collection across the username cache. |
94439e4e | 1377 | This is a tradeoff between memory utilisation (long intervals - say |
1378 | 2 days) and CPU (short intervals - say 1 minute). Only change if | |
1379 | you have good reason to. | |
73e67ee0 | 1380 | DOC_END |
1381 | ||
c68e9c6b | 1382 | NAME: authenticate_ttl |
70a76033 | 1383 | TYPE: time_t |
1384 | DEFAULT: 1 hour | |
c68e9c6b | 1385 | LOC: Config.authenticateTTL |
1386 | DOC_START | |
94439e4e | 1387 | The time a user & their credentials stay in the logged in user cache |
1388 | since their last request. When the garbage interval passes, all | |
1389 | user credentials that have passed their TTL are removed from memory. | |
c68e9c6b | 1390 | DOC_END |
1391 | ||
9bc73deb | 1392 | NAME: authenticate_ip_ttl |
70a76033 | 1393 | TYPE: time_t |
9bc73deb | 1394 | LOC: Config.authenticateIpTTL |
70a76033 | 1395 | DEFAULT: 0 seconds |
9bc73deb | 1396 | DOC_START |
1397 | With this option you control how long a proxy authentication | |
1398 | will be bound to a specific IP address. If a request using | |
1399 | the same user name is received during this time then access | |
1400 | will be denied and both users are required to reauthenticate | |
1401 | them selves. The idea behind this is to make it annoying | |
1402 | for people to share their password to their friends, but | |
1403 | yet allow a dialup user to reconnect on a different dialup | |
1404 | port. | |
1405 | ||
1406 | The default is 0 to disable the check. Recommended value | |
70a76033 | 1407 | if you have dialup users are no more than 60 seconds to allow |
1408 | the user to redial without hassle. If all your users are | |
1409 | stationary then higher values may be used. | |
1410 | ||
60d096f4 | 1411 | See also the acl max_user_ip. |
9bc73deb | 1412 | DOC_END |
1413 | ||
0f74202c | 1414 | COMMENT_START |
3a278cb8 | 1415 | OPTIONS FOR TUNING THE CACHE |
1416 | ----------------------------------------------------------------------------- | |
0f74202c | 1417 | COMMENT_END |
934b03fc | 1418 | |
0153d498 | 1419 | NAME: wais_relay_host |
1420 | TYPE: string | |
1273d501 | 1421 | DEFAULT: none |
0153d498 | 1422 | LOC: Config.Wais.relayHost |
1423 | DOC_NONE | |
934b03fc | 1424 | |
0153d498 | 1425 | NAME: wais_relay_port |
1426 | TYPE: ushort | |
1427 | DEFAULT: 0 | |
1428 | LOC: Config.Wais.relayPort | |
934b03fc | 1429 | DOC_START |
1430 | Relay WAIS request to host (1st arg) at port (2 arg). | |
934b03fc | 1431 | DOC_END |
1432 | ||
1433 | ||
0483b991 | 1434 | NAME: request_header_max_size |
1435 | COMMENT: (KB) | |
1436 | TYPE: b_size_t | |
1437 | DEFAULT: 10 KB | |
1438 | LOC: Config.maxRequestHeaderSize | |
1439 | DOC_START | |
1440 | This specifies the maximum size for HTTP headers in a request. | |
1441 | Request headers are usually relatively small (about 512 bytes). | |
1442 | Placing a limit on the request header size will catch certain | |
1443 | bugs (for example with persistent connections) and possibly | |
1444 | buffer-overflow or denial-of-service attacks. | |
0483b991 | 1445 | DOC_END |
1446 | ||
1447 | NAME: request_body_max_size | |
9906e724 | 1448 | COMMENT: (KB) |
518da0bd | 1449 | TYPE: b_size_t |
ec719ae2 | 1450 | DEFAULT: 0 KB |
0483b991 | 1451 | LOC: Config.maxRequestBodySize |
934b03fc | 1452 | DOC_START |
0483b991 | 1453 | This specifies the maximum size for an HTTP request body. |
1454 | In other words, the maximum size of a PUT/POST request. | |
1455 | A user who attempts to send a request with a body larger | |
1456 | than this limit receives an "Invalid Request" error message. | |
ec719ae2 | 1457 | If you set this parameter to a zero (the default), there will |
1458 | be no limit imposed. | |
0483b991 | 1459 | DOC_END |
934b03fc | 1460 | |
934b03fc | 1461 | NAME: refresh_pattern |
934b03fc | 1462 | TYPE: refreshpattern |
f1dc9b30 | 1463 | LOC: Config.Refresh |
1273d501 | 1464 | DEFAULT: none |
6b53c392 | 1465 | DEFAULT_IF_NONE: ^ftp: 1440 20% 10080 |
1466 | DEFAULT_IF_NONE: ^gopher: 1440 0% 1440 | |
1467 | DEFAULT_IF_NONE: . 0 20% 4320 | |
934b03fc | 1468 | DOC_START |
7ddc902f | 1469 | usage: refresh_pattern [-i] regex min percent max [options] |
1470 | ||
1471 | By default, regular expressions are CASE-SENSITIVE. To make | |
1472 | them case-insensitive, use the -i option. | |
934b03fc | 1473 | |
7e3ce7b9 | 1474 | 'Min' is the time (in minutes) an object without an explicit |
1475 | expiry time should be considered fresh. The recommended | |
1476 | value is 0, any higher values may cause dynamic applications | |
efd900cb | 1477 | to be erroneously cached unless the application designer |
7e3ce7b9 | 1478 | has taken the appropriate actions. |
1479 | ||
1480 | 'Percent' is a percentage of the objects age (time since last | |
efd900cb | 1481 | modification age) an object without explicit expiry time |
7e3ce7b9 | 1482 | will be considered fresh. |
1483 | ||
1484 | 'Max' is an upper limit on how long objects without an explicit | |
1485 | expiry time will be considered fresh. | |
934b03fc | 1486 | |
7e3ce7b9 | 1487 | options: overrsde-expire |
1dfa1d81 | 1488 | override-lastmod |
cbe3a719 | 1489 | reload-into-ims |
1490 | ignore-reload | |
1dfa1d81 | 1491 | |
1492 | override-expire enforces min age even if the server | |
cbe3a719 | 1493 | sent a Expires: header. Doing this VIOLATES the HTTP |
1494 | standard. Enabling this feature could make you liable | |
1495 | for problems which it causes. | |
1dfa1d81 | 1496 | |
1497 | override-lastmod enforces min age even on objects | |
1498 | that was modified recently. | |
cbe3a719 | 1499 | |
1500 | reload-into-ims changes client no-cache or ``reload'' | |
1501 | to If-Modified-Since requests. Doing this VIOLATES the | |
1502 | HTTP standard. Enabling this feature could make you | |
1503 | liable for problems which it causes. | |
1504 | ||
1505 | ignore-reload ignores a client no-cache or ``reload'' | |
1506 | header. Doing this VIOLATES the HTTP standard. Enabling | |
1507 | this feature could make you liable for problems which | |
1508 | it causes. | |
1dfa1d81 | 1509 | |
934b03fc | 1510 | Please see the file doc/Release-Notes-1.1.txt for a full |
1511 | description of Squid's refresh algorithm. Basically a | |
1dfa1d81 | 1512 | cached object is: (the order is changed from 1.1.X) |
934b03fc | 1513 | |
1dfa1d81 | 1514 | FRESH if expires < now, else STALE |
6b8e7481 | 1515 | STALE if age > max |
1dfa1d81 | 1516 | FRESH if lm-factor < percent, else STALE |
1517 | FRESH if age < min | |
1518 | else STALE | |
934b03fc | 1519 | |
1520 | The refresh_pattern lines are checked in the order listed here. | |
1521 | The first entry which matches is used. If none of the entries | |
1522 | match, then the default will be used. | |
1523 | ||
6b53c392 | 1524 | Note, you must uncomment all the default lines if you want |
1525 | to change one. The default setting is only active if none is | |
1526 | used. | |
934b03fc | 1527 | DOC_END |
1528 | ||
934b03fc | 1529 | NAME: reference_age |
f1dc9b30 | 1530 | TYPE: time_t |
934b03fc | 1531 | LOC: Config.referenceAge |
f1dc9b30 | 1532 | DEFAULT: 1 year |
934b03fc | 1533 | DOC_START |
1534 | As a part of normal operation, Squid performs Least Recently | |
1535 | Used removal of cached objects. The LRU age for removal is | |
1536 | computed dynamically, based on the amount of disk space in | |
6778c757 | 1537 | use. The dynamic value can be seen in the Cache Manager 'info' |
1538 | output. | |
1539 | ||
1540 | The 'reference_age' parameter defines the maximum LRU age. For | |
1541 | example, setting reference_age to '1 week' will cause objects | |
1542 | to be removed if they have not been accessed for a week or | |
7e3ce7b9 | 1543 | more. The default value is one year. |
934b03fc | 1544 | |
1545 | Specify a number here, followed by units of time. For example: | |
1546 | 1 week | |
1547 | 3.5 days | |
1548 | 4 months | |
1549 | 2.2 hours | |
1550 | ||
2b906e48 | 1551 | NOTE: this parameter is not used when using the enhanced |
1552 | replacement policies, GDSH or LFUDA. | |
934b03fc | 1553 | DOC_END |
1554 | ||
1555 | ||
0153d498 | 1556 | NAME: quick_abort_min |
9906e724 | 1557 | COMMENT: (KB) |
1558 | TYPE: kb_size_t | |
c68e9c6b | 1559 | DEFAULT: 16 KB |
0153d498 | 1560 | LOC: Config.quickAbort.min |
1561 | DOC_NONE | |
1562 | ||
0153d498 | 1563 | NAME: quick_abort_max |
9906e724 | 1564 | COMMENT: (KB) |
1565 | TYPE: kb_size_t | |
6b53c392 | 1566 | DEFAULT: 16 KB |
0153d498 | 1567 | LOC: Config.quickAbort.max |
1b2f5c2f | 1568 | DOC_NONE |
1569 | ||
1570 | NAME: quick_abort_pct | |
1571 | COMMENT: (percent) | |
1572 | TYPE: int | |
c68e9c6b | 1573 | DEFAULT: 95 |
1b2f5c2f | 1574 | LOC: Config.quickAbort.pct |
934b03fc | 1575 | DOC_START |
9923e308 | 1576 | The cache by default continues downloading aborted requests |
7a61d612 | 1577 | which are almost completed (less than 16 KB remaining). This |
1578 | may be undesirable on slow (e.g. SLIP) links and/or very busy | |
1579 | caches. Impatient users may tie up file descriptors and | |
1580 | bandwidth by repeatedly requesting and immediately aborting | |
1581 | downloads. | |
934b03fc | 1582 | |
1583 | When the user aborts a request, Squid will check the | |
1584 | quick_abort values to the amount of data transfered until | |
1585 | then. | |
1586 | ||
cf5cc17e | 1587 | If the transfer has less than 'quick_abort_min' KB remaining, |
2bb84b43 | 1588 | it will finish the retrieval. |
934b03fc | 1589 | |
cf5cc17e | 1590 | If the transfer has more than 'quick_abort_max' KB remaining, |
1591 | it will abort the retrieval. | |
934b03fc | 1592 | |
1b2f5c2f | 1593 | If more than 'quick_abort_pct' of the transfer has completed, |
1594 | it will finish the retrieval. | |
2bb84b43 | 1595 | |
7a61d612 | 1596 | If you do not want any retrieval to continue after the client |
2bb84b43 | 1597 | has aborted, set both 'quick_abort_min' and 'quick_abort_max' |
1598 | to '0 KB'. | |
1599 | ||
9923e308 | 1600 | If you want retrievals to always continue if they are being |
2bb84b43 | 1601 | cached then set 'quick_abort_min' to '-1 KB'. |
934b03fc | 1602 | DOC_END |
1603 | ||
1604 | ||
1605 | NAME: negative_ttl | |
bc0eb004 | 1606 | COMMENT: time-units |
f1dc9b30 | 1607 | TYPE: time_t |
934b03fc | 1608 | LOC: Config.negativeTtl |
9e975e4e | 1609 | DEFAULT: 5 minutes |
934b03fc | 1610 | DOC_START |
1611 | Time-to-Live (TTL) for failed requests. Certain types of | |
1612 | failures (such as "connection refused" and "404 Not Found") are | |
cf5cc17e | 1613 | negatively-cached for a configurable amount of time. The |
1614 | default is 5 minutes. Note that this is different from | |
1615 | negative caching of DNS lookups. | |
934b03fc | 1616 | DOC_END |
1617 | ||
1618 | ||
1619 | NAME: positive_dns_ttl | |
bc0eb004 | 1620 | COMMENT: time-units |
f1dc9b30 | 1621 | TYPE: time_t |
934b03fc | 1622 | LOC: Config.positiveDnsTtl |
9e975e4e | 1623 | DEFAULT: 6 hours |
934b03fc | 1624 | DOC_START |
1625 | Time-to-Live (TTL) for positive caching of successful DNS lookups. | |
1626 | Default is 6 hours (360 minutes). If you want to minimize the | |
1627 | use of Squid's ipcache, set this to 1, not 0. | |
934b03fc | 1628 | DOC_END |
1629 | ||
1630 | ||
1631 | NAME: negative_dns_ttl | |
bc0eb004 | 1632 | COMMENT: time-units |
f1dc9b30 | 1633 | TYPE: time_t |
934b03fc | 1634 | LOC: Config.negativeDnsTtl |
9e975e4e | 1635 | DEFAULT: 5 minutes |
934b03fc | 1636 | DOC_START |
1637 | Time-to-Live (TTL) for negative caching of failed DNS lookups. | |
934b03fc | 1638 | DOC_END |
1639 | ||
c68e9c6b | 1640 | NAME: range_offset_limit |
1641 | COMMENT: (bytes) | |
1642 | TYPE: b_size_t | |
1643 | LOC: Config.rangeOffsetLimit | |
1644 | DEFAULT: 0 KB | |
1645 | DOC_START | |
1646 | Sets a upper limit on how far into the the file a Range request | |
1647 | may be to cause Squid to prefetch the whole file. If beyond this | |
1648 | limit then Squid forwards the Range request as it is and the result | |
1649 | is NOT cached. | |
1650 | ||
1651 | This is to stop a far ahead range request (lets say start at 17MB) | |
1652 | from making Squid fetch the whole object up to that point before | |
1653 | sending anything to the client. | |
1654 | ||
1655 | A value of -1 causes Squid to always fetch the object from the | |
1656 | beginning so that it may cache the result. (2.0 style) | |
1657 | ||
6e7dbcbd | 1658 | A value of 0 causes Squid to never fetch more than the |
c68e9c6b | 1659 | client requested. (default) |
c68e9c6b | 1660 | DOC_END |
1661 | ||
1662 | ||
0f74202c | 1663 | COMMENT_START |
3a278cb8 | 1664 | TIMEOUTS |
1665 | ----------------------------------------------------------------------------- | |
0f74202c | 1666 | COMMENT_END |
934b03fc | 1667 | |
1668 | NAME: connect_timeout | |
bc0eb004 | 1669 | COMMENT: time-units |
f1dc9b30 | 1670 | TYPE: time_t |
934b03fc | 1671 | LOC: Config.Timeout.connect |
9e975e4e | 1672 | DEFAULT: 2 minutes |
934b03fc | 1673 | DOC_START |
1674 | Some systems (notably Linux) can not be relied upon to properly | |
cf5cc17e | 1675 | time out connect(2) requests. Therefore the Squid process |
934b03fc | 1676 | enforces its own timeout on server connections. This parameter |
1677 | specifies how long to wait for the connect to complete. The | |
1678 | default is two minutes (120 seconds). | |
934b03fc | 1679 | DOC_END |
1680 | ||
3f62decd | 1681 | NAME: peer_connect_timeout |
1682 | COMMENT: time-units | |
1683 | TYPE: time_t | |
1684 | LOC: Config.Timeout.peer_connect | |
1685 | DEFAULT: 30 seconds | |
1686 | DOC_START | |
1687 | This parameter specifies how long to wait for a pending TCP | |
1688 | connection to a peer cache. The default is 30 seconds. You | |
1689 | may also set different timeout values for individual neighbors | |
1690 | with the 'connect-timeout' option on a 'cache_peer' line. | |
9bc73deb | 1691 | DOC_END |
3f62decd | 1692 | |
23d92c64 | 1693 | NAME: siteselect_timeout |
1694 | COMMENT: time-units | |
1695 | TYPE: time_t | |
1696 | LOC: Config.Timeout.siteSelect | |
1697 | DEFAULT: 4 seconds | |
1698 | DOC_START | |
1699 | For URN to multiple URL's URL selection | |
23d92c64 | 1700 | DOC_END |
934b03fc | 1701 | |
1702 | NAME: read_timeout | |
bc0eb004 | 1703 | COMMENT: time-units |
f1dc9b30 | 1704 | TYPE: time_t |
934b03fc | 1705 | LOC: Config.Timeout.read |
9e975e4e | 1706 | DEFAULT: 15 minutes |
934b03fc | 1707 | DOC_START |
1708 | The read_timeout is applied on server-side connections. After | |
1709 | each successful read(), the timeout will be extended by this | |
1710 | amount. If no data is read again after this amount of time, | |
1711 | the request is aborted and logged with ERR_READ_TIMEOUT. The | |
1712 | default is 15 minutes. | |
934b03fc | 1713 | DOC_END |
1714 | ||
1715 | ||
934b03fc | 1716 | NAME: request_timeout |
f1dc9b30 | 1717 | TYPE: time_t |
934b03fc | 1718 | LOC: Config.Timeout.request |
049d61bb | 1719 | DEFAULT: 5 minutes |
1720 | DOC_START | |
1721 | How long to wait for an HTTP request after initial | |
1722 | connection establishment. | |
1723 | DOC_END | |
1724 | ||
1725 | ||
1726 | NAME: persistent_request_timeout | |
1727 | TYPE: time_t | |
1728 | LOC: Config.Timeout.persistent_request | |
1729 | DEFAULT: 1 minute | |
934b03fc | 1730 | DOC_START |
049d61bb | 1731 | How long to wait for the next HTTP request on a persistent |
1732 | connection after the previous request completes. | |
934b03fc | 1733 | DOC_END |
1734 | ||
1735 | ||
1736 | NAME: client_lifetime | |
bc0eb004 | 1737 | COMMENT: time-units |
f1dc9b30 | 1738 | TYPE: time_t |
934b03fc | 1739 | LOC: Config.Timeout.lifetime |
9e975e4e | 1740 | DEFAULT: 1 day |
934b03fc | 1741 | DOC_START |
1742 | The maximum amount of time that a client (browser) is allowed to | |
1743 | remain connected to the cache process. This protects the Cache | |
efd900cb | 1744 | from having a lot of sockets (and hence file descriptors) tied up |
934b03fc | 1745 | in a CLOSE_WAIT state from remote clients that go away without |
1746 | properly shutting down (either because of a network failure or | |
1747 | because of a poor client implementation). The default is one | |
1748 | day, 1440 minutes. | |
1749 | ||
1750 | NOTE: The default value is intended to be much larger than any | |
1751 | client would ever need to be connected to your cache. You | |
1752 | should probably change client_lifetime only as a last resort. | |
1753 | If you seem to have many client connections tying up | |
1754 | filedescriptors, we recommend first tuning the read_timeout, | |
049d61bb | 1755 | request_timeout, persistent_request_timeout and quick_abort values. |
934b03fc | 1756 | DOC_END |
1757 | ||
ea285003 | 1758 | NAME: half_closed_clients |
1759 | TYPE: onoff | |
1760 | LOC: Config.onoff.half_closed_clients | |
1761 | DEFAULT: on | |
1762 | DOC_START | |
1763 | Some clients may shutdown the sending side of their TCP | |
1764 | connections, while leaving their receiving sides open. Sometimes, | |
1765 | Squid can not tell the difference between a half-closed and a | |
1766 | fully-closed TCP connection. By default, half-closed client | |
1767 | connections are kept open until a read(2) or write(2) on the | |
1768 | socket returns an error. Change this option to 'off' and Squid | |
1769 | will immediately close client connections when read(2) returns | |
1770 | "no more data to read." | |
ea285003 | 1771 | DOC_END |
1772 | ||
603a02fd | 1773 | NAME: pconn_timeout |
1774 | TYPE: time_t | |
1775 | LOC: Config.Timeout.pconn | |
1776 | DEFAULT: 120 seconds | |
1777 | DOC_START | |
1778 | Timeout for idle persistent connections to servers and other | |
1779 | proxies. | |
603a02fd | 1780 | DOC_END |
1781 | ||
05832ae1 | 1782 | NAME: ident_timeout |
1783 | TYPE: time_t | |
3898f57f | 1784 | IFDEF: USE_IDENT |
05832ae1 | 1785 | LOC: Config.Timeout.ident |
1786 | DEFAULT: 10 seconds | |
1787 | DOC_START | |
c463eb5f | 1788 | Maximum time to wait for IDENT lookups to complete. |
1789 | ||
1790 | If this is too high, and you enabled IDENT lookups from untrusted | |
1791 | users, then you might be susceptible to denial-of-service by having | |
1792 | many ident requests going at once. | |
05832ae1 | 1793 | DOC_END |
1794 | ||
934b03fc | 1795 | |
1796 | NAME: shutdown_lifetime | |
bc0eb004 | 1797 | COMMENT: time-units |
f1dc9b30 | 1798 | TYPE: time_t |
934b03fc | 1799 | LOC: Config.shutdownLifetime |
9e975e4e | 1800 | DEFAULT: 30 seconds |
934b03fc | 1801 | DOC_START |
1802 | When SIGTERM or SIGHUP is received, the cache is put into | |
1803 | "shutdown pending" mode until all active sockets are closed. | |
1804 | This value is the lifetime to set for all open descriptors | |
1805 | during shutdown mode. Any active clients after this many | |
1806 | seconds will receive a 'timeout' message. | |
934b03fc | 1807 | DOC_END |
1808 | ||
0f74202c | 1809 | COMMENT_START |
3a278cb8 | 1810 | ACCESS CONTROLS |
1811 | ----------------------------------------------------------------------------- | |
0f74202c | 1812 | COMMENT_END |
934b03fc | 1813 | |
1814 | NAME: acl | |
1815 | TYPE: acl | |
f1dc9b30 | 1816 | LOC: Config.aclList |
1817 | DEFAULT: none | |
934b03fc | 1818 | DOC_START |
1819 | Defining an Access List | |
1820 | ||
1821 | acl aclname acltype string1 ... | |
1822 | acl aclname acltype "file" ... | |
1823 | ||
1824 | when using "file", the file should contain one item per line | |
1825 | ||
fc659d9d | 1826 | acltype is one of the types described below |
934b03fc | 1827 | |
edd80fbb | 1828 | By default, regular expressions are CASE-SENSITIVE. To make |
1829 | them case-insensitive, use the -i option. | |
1830 | ||
934b03fc | 1831 | acl aclname src ip-address/netmask ... (clients IP address) |
1832 | acl aclname src addr1-addr2/netmask ... (range of addresses) | |
1833 | acl aclname dst ip-address/netmask ... (URL host's IP address) | |
ae2c08a2 | 1834 | acl aclname myip ip-address/netmask ... (local socket IP address) |
d0d41f07 | 1835 | |
efd900cb | 1836 | acl aclname srcdomain .foo.com ... # reverse lookup, client IP |
1837 | acl aclname dstdomain .foo.com ... # Destination server from URL | |
edd80fbb | 1838 | acl aclname srcdom_regex [-i] xxx ... # regex matching client name |
1839 | acl aclname dstdom_regex [-i] xxx ... # regex matching server | |
d0d41f07 | 1840 | # For dstdomain and dstdom_regex a reverse lookup is tried if a IP |
1841 | # based URL is used. The name "none" is used if the reverse lookup | |
1842 | # fails. | |
1843 | ||
934b03fc | 1844 | acl aclname time [day-abbrevs] [h1:m1-h2:m2] |
1845 | day-abbrevs: | |
1846 | S - Sunday | |
1847 | M - Monday | |
1848 | T - Tuesday | |
1849 | W - Wednesday | |
1850 | H - Thursday | |
1851 | F - Friday | |
1852 | A - Saturday | |
1853 | h1:m1 must be less than h2:m2 | |
edd80fbb | 1854 | acl aclname url_regex [-i] ^http:// ... # regex matching on whole URL |
1855 | acl aclname urlpath_regex [-i] \.gif$ ... # regex matching on URL path | |
934b03fc | 1856 | acl aclname port 80 70 21 ... |
ec5bba4d | 1857 | acl aclname port 0-1024 ... # ranges allowed |
7e3ce7b9 | 1858 | acl aclname myport 3128 ... # (local socket TCP port) |
934b03fc | 1859 | acl aclname proto HTTP FTP ... |
1860 | acl aclname method GET POST ... | |
fc659d9d | 1861 | acl aclname browser [-i] regexp ... |
edd80fbb | 1862 | # pattern match on User-Agent header |
fc659d9d | 1863 | acl aclname referer_regex [-i] regexp ... |
1864 | # pattern match on Referer header | |
1865 | # Referer is highly unreliable, so use with care | |
c68e9c6b | 1866 | acl aclname ident username ... |
145cf928 | 1867 | acl aclname ident_regex [-i] pattern ... |
c68e9c6b | 1868 | # string match on ident output. |
1869 | # use REQUIRED to accept any non-null ident. | |
96d88dcb | 1870 | acl aclname src_as number ... |
6468fe10 | 1871 | acl aclname dst_as number ... |
1872 | # Except for access control, AS numbers can be used for | |
96d88dcb | 1873 | # routing of requests to specific caches. Here's an |
1874 | # example for routing all requests for AS#1241 and only | |
6468fe10 | 1875 | # those to mycache.mydomain.net: |
1876 | # acl asexample dst_as 1241 | |
d87ebd78 | 1877 | # cache_peer_access mycache.mydomain.net allow asexample |
1878 | # cache_peer_access mycache_mydomain.net deny all | |
6468fe10 | 1879 | |
c68e9c6b | 1880 | acl aclname proxy_auth username ... |
145cf928 | 1881 | acl aclname proxy_auth_regex [-i] pattern ... |
c68e9c6b | 1882 | # list of valid usernames |
1883 | # use REQUIRED to accept any valid username. | |
73e67ee0 | 1884 | # |
1885 | # NOTE: when a Proxy-Authentication header is sent but it is not | |
1886 | # needed during ACL checking the username is NOT logged | |
1887 | # in access.log. | |
c68e9c6b | 1888 | # |
1889 | # NOTE: proxy_auth requires a EXTERNAL authentication program | |
1890 | # to check username/password combinations (see | |
1891 | # authenticate_program). | |
1892 | # | |
1893 | # WARNING: proxy_auth can't be used in a transparent proxy. It | |
1894 | # collides with any authentication done by origin servers. It may | |
1895 | # seem like it works at first, but it doesn't. | |
934b03fc | 1896 | |
dba79ac5 | 1897 | acl aclname snmp_community string ... |
08f6b5e0 | 1898 | # A community string to limit access to your SNMP Agent |
dba79ac5 | 1899 | # Example: |
96d88dcb | 1900 | # |
dba79ac5 | 1901 | # acl snmppublic snmp_community public |
1902 | ||
9bc73deb | 1903 | acl aclname maxconn number |
1904 | # This will be matched when the client's IP address has | |
1905 | # more than <number> HTTP connections established. | |
1906 | ||
60d096f4 | 1907 | acl aclname max_user_ip |
96d88dcb | 1908 | # This will be matched when the user attempts to log in from more |
60d096f4 | 1909 | # than <number> different ip address's. The authenticate_ip_ttl |
1910 | # parameter controls the timeout on the ip entries. | |
96d88dcb | 1911 | # NOTE: in acceleration mode, clients may appear to come from |
60d096f4 | 1912 | # multiple address's if they are going through proxy farms, |
1913 | # so a limit of 1 may cause user problems. | |
1914 | ||
1915 | ||
fb8ee28e | 1916 | acl aclname req_mime_type mime-type1 ... |
ba2b31a8 | 1917 | # regex match agains the mime type of the request generated |
1918 | # by the client. Can be used to detect file upload or some | |
1919 | # types HTTP tunelling requests. | |
1920 | # NOTE: This does NOT match the reply. You cannot use this | |
1921 | # to match the returned file type. | |
c68e9c6b | 1922 | |
fb8ee28e | 1923 | acl aclname rep_mime_type mime-type1 ... |
c4ab8329 | 1924 | # regex match against the mime type of the reply recieved by |
1925 | # squid. Can be used to detect file download or some | |
1926 | # types HTTP tunelling requests. | |
1927 | # NOTE: This has no effect in http_access rules. It only has | |
1928 | # effect in rules that affect the reply data stream such as | |
1929 | # http_reply_access. | |
1930 | ||
1931 | ||
c68e9c6b | 1932 | Examples: |
1933 | acl myexample dst_as 1241 | |
aa6956a5 | 1934 | acl password proxy_auth REQUIRED |
ba2b31a8 | 1935 | acl fileupload req_mime_type -i ^multipart/form-data$ |
c4ab8329 | 1936 | acl javascript rep_mime_type -i ^application/x-javascript$ |
c68e9c6b | 1937 | |
c68e9c6b | 1938 | NOCOMMENT_START |
6b53c392 | 1939 | #Recommended minimum configuration: |
c68e9c6b | 1940 | acl all src 0.0.0.0/0.0.0.0 |
934b03fc | 1941 | acl manager proto cache_object |
1942 | acl localhost src 127.0.0.1/255.255.255.255 | |
4cc6eb12 | 1943 | acl to_localhost dst 127.0.0.0/8 |
934b03fc | 1944 | acl SSL_ports port 443 563 |
6b53c392 | 1945 | acl Safe_ports port 80 # http |
1946 | acl Safe_ports port 21 # ftp | |
1947 | acl Safe_ports port 443 563 # https, snews | |
1948 | acl Safe_ports port 70 # gopher | |
1949 | acl Safe_ports port 210 # wais | |
1950 | acl Safe_ports port 1025-65535 # unregistered ports | |
9bc73deb | 1951 | acl Safe_ports port 280 # http-mgmt |
1952 | acl Safe_ports port 488 # gss-http | |
1953 | acl Safe_ports port 591 # filemaker | |
1954 | acl Safe_ports port 777 # multiling http | |
934b03fc | 1955 | acl CONNECT method CONNECT |
c68e9c6b | 1956 | NOCOMMENT_END |
934b03fc | 1957 | DOC_END |
1958 | ||
1959 | NAME: http_access | |
1960 | TYPE: acl_access | |
f1dc9b30 | 1961 | LOC: Config.accessList.http |
1962 | DEFAULT: none | |
da7f354f | 1963 | DEFAULT_IF_NONE: deny all |
934b03fc | 1964 | DOC_START |
1965 | Allowing or Denying access based on defined access lists | |
1966 | ||
1967 | Access to the HTTP port: | |
1968 | http_access allow|deny [!]aclname ... | |
1969 | ||
934b03fc | 1970 | NOTE on default values: |
1971 | ||
6b53c392 | 1972 | If there are no "access" lines present, the default is to deny |
934b03fc | 1973 | the request. |
1974 | ||
1975 | If none of the "access" lines cause a match, the default is the | |
1976 | opposite of the last line in the list. If the last line was | |
1977 | deny, then the default is allow. Conversely, if the last line | |
1978 | is allow, the default will be deny. For these reasons, it is a | |
1979 | good idea to have an "deny all" or "allow all" entry at the end | |
1980 | of your access lists to avoid potential confusion. | |
1981 | ||
c68e9c6b | 1982 | NOCOMMENT_START |
6b53c392 | 1983 | #Recommended minimum configuration: |
1984 | # | |
1985 | # Only allow cachemgr access from localhost | |
c68e9c6b | 1986 | http_access allow manager localhost |
1987 | http_access deny manager | |
6b53c392 | 1988 | # Deny requests to unknown ports |
499558df | 1989 | http_access deny !Safe_ports |
6b53c392 | 1990 | # Deny CONNECT to other than SSL ports |
c68e9c6b | 1991 | http_access deny CONNECT !SSL_ports |
1992 | # | |
4cc6eb12 | 1993 | # We strongly recommend to uncomment the following to protect innocent |
1994 | # web applications running on the proxy server who think that the only | |
1995 | # one who can access services on "localhost" is a local user | |
1996 | #http_access deny to_localhost | |
c68e9c6b | 1997 | # |
4cc6eb12 | 1998 | # INSERT YOUR OWN RULE(S) HERE TO ALLOW ACCESS FROM YOUR CLIENTS |
1999 | ||
6b53c392 | 2000 | # And finally deny all other access to this proxy |
c68e9c6b | 2001 | http_access deny all |
2002 | NOCOMMENT_END | |
934b03fc | 2003 | DOC_END |
2004 | ||
c4ab8329 | 2005 | NAME: http_reply_access |
2006 | TYPE: acl_access | |
2007 | LOC: Config.accessList.reply | |
2008 | DEFAULT: none | |
2009 | DEFAULT_IF_NONE: allow all | |
2010 | DOC_START | |
2011 | Allow replies to client requests. This is complementary to http_access. | |
2012 | ||
2013 | http_reply_access allow|deny [!] aclname ... | |
2014 | ||
96d88dcb | 2015 | NOTE: if there are no access lines present, the default is to allow |
c4ab8329 | 2016 | all replies |
2017 | ||
2018 | If none of the access lines cause a match, then the opposite of the | |
2019 | last line will apply. Thus it is good practice to end the rules | |
2020 | with an "allow all" or "deny all" entry. | |
2021 | ||
2022 | NOCOMMENT_START | |
2023 | #Recommended minimum configuration: | |
2024 | # | |
2025 | # Insert your own rules here. | |
2026 | # | |
2027 | # | |
2028 | # and finally allow by default | |
2029 | http_reply_access allow all | |
2030 | NOCOMMENT_END | |
2031 | DOC_END | |
2032 | ||
934b03fc | 2033 | |
2034 | NAME: icp_access | |
2035 | TYPE: acl_access | |
f1dc9b30 | 2036 | LOC: Config.accessList.icp |
2037 | DEFAULT: none | |
da7f354f | 2038 | DEFAULT_IF_NONE: deny all |
934b03fc | 2039 | DOC_START |
6b53c392 | 2040 | Allowing or Denying access to the ICP port based on defined |
2041 | access lists | |
2042 | ||
2043 | icp_access allow|deny [!]aclname ... | |
2044 | ||
2045 | See http_access for details | |
934b03fc | 2046 | |
c68e9c6b | 2047 | NOCOMMENT_START |
6b53c392 | 2048 | #Allow ICP queries from eveyone |
c68e9c6b | 2049 | icp_access allow all |
2050 | NOCOMMENT_END | |
934b03fc | 2051 | DOC_END |
2052 | ||
2053 | ||
2054 | NAME: miss_access | |
2055 | TYPE: acl_access | |
f1dc9b30 | 2056 | LOC: Config.accessList.miss |
2057 | DEFAULT: none | |
934b03fc | 2058 | DOC_START |
2059 | Use to force your neighbors to use you as a sibling instead of | |
2060 | a parent. For example: | |
2061 | ||
2062 | acl localclients src 172.16.0.0/16 | |
2063 | miss_access allow localclients | |
2064 | miss_access deny !localclients | |
2065 | ||
2066 | This means that only your local clients are allowed to fetch | |
2067 | MISSES and all other clients can only fetch HITS. | |
2068 | ||
2069 | By default, allow all clients who passed the http_access rules | |
2070 | to fetch MISSES from us. | |
6b53c392 | 2071 | |
c68e9c6b | 2072 | NOCOMMENT_START |
6b53c392 | 2073 | #Default setting: |
2074 | # miss_access allow all | |
c68e9c6b | 2075 | NOCOMMENT_END |
934b03fc | 2076 | DOC_END |
2077 | ||
2078 | ||
505e35db | 2079 | NAME: cache_peer_access |
2080 | TYPE: peer_access | |
f1dc9b30 | 2081 | DEFAULT: none |
2082 | LOC: none | |
934b03fc | 2083 | DOC_START |
505e35db | 2084 | Similar to 'cache_peer_domain' but provides more flexibility by |
2085 | using ACL elements. | |
934b03fc | 2086 | |
505e35db | 2087 | cache_peer_access cache-host allow|deny [!]aclname ... |
934b03fc | 2088 | |
505e35db | 2089 | The syntax is identical to 'http_access' and the other lists of |
2090 | ACL elements. See the comments for 'http_access' below, or | |
2b6662ba | 2091 | the Squid FAQ (http://www.squid-cache.org/FAQ/FAQ-10.html). |
934b03fc | 2092 | DOC_END |
2093 | ||
ec603b25 | 2094 | NAME: ident_lookup_access |
2095 | TYPE: acl_access | |
2096 | IFDEF: USE_IDENT | |
2097 | DEFAULT: none | |
2098 | DEFAULT_IF_NONE: deny all | |
2099 | LOC: Config.accessList.identLookup | |
2100 | DOC_START | |
2101 | A list of ACL elements which, if matched, cause an ident | |
2102 | (RFC 931) lookup to be performed for this request. For | |
2103 | example, you might choose to always perform ident lookups | |
2104 | for your main multi-user Unix boxes, but not for your Macs | |
2105 | and PCs. By default, ident lookups are not performed for | |
2106 | any requests. | |
2107 | ||
2108 | To enable ident lookups for specific client addresses, you | |
2109 | can follow this example: | |
96d88dcb | 2110 | |
ec603b25 | 2111 | acl ident_aware_hosts src 198.168.1.0/255.255.255.0 |
2112 | ident_lookup_access allow ident_aware_hosts | |
2113 | ident_lookup_access deny all | |
2114 | ||
c463eb5f | 2115 | Only src type ACL checks are fully supported. A src_domain |
2116 | ACL might work at times, but it will not always provide | |
2117 | the correct result. | |
ec603b25 | 2118 | DOC_END |
2119 | ||
d6827718 | 2120 | NAME: tcp_outgoing_tos tcp_outgoing_ds tcp_outgoin_dscp |
2121 | TYPE: acl_tos | |
2122 | DEFAULT: none | |
2123 | LOC: Config.accessList.outgoing_tos | |
2124 | DOC_START | |
2125 | Allows you to select a TOS/Diffserv value to mark outgoing | |
2126 | connections with, based on the username or source address | |
2127 | making the request. | |
2128 | ||
2129 | tcp_outgoing_tos ds-field [!]aclname ... | |
2130 | ||
2131 | Example where normal_service_net uses the TOS value 0x00 | |
2132 | and normal_service_net uses 0x20 | |
2133 | ||
2134 | acl normal_service_net src 10.0.0.0/255.255.255.0 | |
2135 | acl good_service_net src 10.0.1.0/255.255.255.0 | |
2136 | tcp_outgoing_tos 0x00 normal_service_net 0x00 | |
2137 | tcp_outgoing_tos 0x20 good_service_net | |
2138 | ||
2139 | TOS/DSCP values really only have local significance - so you should | |
2140 | know what you're specifying. For more, see RFC 2474 | |
2141 | ||
2142 | The TOS/DSCP byte must be exactly that - a byte, value 0 - 255, or | |
2143 | "default" to use whatever default your host has. | |
2144 | ||
2145 | Processing proceeds in the order specified, and stops at first fully | |
2146 | matching line. | |
2147 | DOC_END | |
2148 | ||
2149 | NAME: tcp_outgoing_address | |
2150 | TYPE: acl_address | |
2151 | DEFAULT: none | |
2152 | LOC: Config.accessList.outgoing_address | |
2153 | DOC_START | |
2154 | Allows you to map requests to different outgoing IP addresses | |
2155 | based on the username or sourceaddress of the user making | |
2156 | the request. | |
2157 | ||
2158 | tcp_outgoing_address ipaddr [[!]aclname] ... | |
2159 | ||
2160 | Example where requests from 10.0.0.0/24 will be forwareded | |
2161 | with source address 10.1.0.1, 10.0.2.0/24 forwarded with | |
2162 | source address 10.1.0.2 and the rest will be forwarded with | |
2163 | source address 10.1.0.3. | |
2164 | ||
2165 | acl normal_service_net src 10.0.0.0/255.255.255.0 | |
2166 | acl good_service_net src 10.0.1.0/255.255.255.0 | |
2167 | tcp_outgoing_address 10.0.0.1 normal_service_net | |
2168 | tcp_outgoing_address 10.0.0.2 good_service_net | |
2169 | tcp_outgoing_address 10.0.0.3 | |
2170 | ||
2171 | Processing proceeds in the order specified, and stops at first fully | |
2172 | matching line. | |
2173 | DOC_END | |
ec603b25 | 2174 | |
a560ee93 | 2175 | NAME: reply_body_max_size |
2176 | COMMENT: bytes allow|deny acl acl... | |
2177 | TYPE: body_size_t | |
2178 | DEFAULT: none | |
2179 | DEFAULT_IF_NONE: 0 allow all | |
2180 | LOC: Config.ReplyBodySize | |
2181 | DOC_START | |
2182 | This option specifies the maximum size of a reply body. It | |
2183 | can be used to prevent users from downloading very large files, | |
2184 | such as MP3's and movies. When the reply headers are recieved, | |
2185 | the reply_body_max_size lines are processed, and the first line with | |
2186 | a result of "allow" is used as the maximum body size for this reply. | |
2187 | This size is then checked twice. First when we get the reply headers, | |
2188 | we check the content-length value. If the content length value exists | |
2189 | and is larger than the allowed size, the request is denied and the | |
2190 | user receives an error message that says "the request or reply | |
2191 | is too large." If there is no content-length, and the reply | |
2192 | size exceeds this limit, the client's connection is just closed | |
2193 | and they will receive a partial reply. | |
2194 | ||
2195 | WARNING: downstream caches probably can not detect a partial reply | |
2196 | if there is no content-length header, so they will cache | |
2197 | partial responses and give them out as hits. You should NOT | |
2198 | use this option if you have downstream caches. | |
2199 | ||
96d88dcb | 2200 | WARNING: A maximum size larger than the size of squid's error messages |
a560ee93 | 2201 | will cause an infinite loop and crash squid. Ensure that the smallest |
2202 | non-zero value you use is greater that the maximum header size plus | |
2203 | the size of your largest error page. | |
2204 | ||
2205 | If you set this parameter to zero (the default), there will be | |
2206 | no limit imposed. | |
2207 | DOC_END | |
2208 | ||
0f74202c | 2209 | COMMENT_START |
3a278cb8 | 2210 | ADMINISTRATIVE PARAMETERS |
2211 | ----------------------------------------------------------------------------- | |
0f74202c | 2212 | COMMENT_END |
934b03fc | 2213 | |
2214 | NAME: cache_mgr | |
2215 | TYPE: string | |
2216 | DEFAULT: webmaster | |
2217 | LOC: Config.adminEmail | |
2218 | DOC_START | |
2219 | Email-address of local cache manager who will receive | |
2220 | mail if the cache dies. The default is "webmaster." | |
934b03fc | 2221 | DOC_END |
2222 | ||
2223 | ||
2224 | NAME: cache_effective_user | |
0153d498 | 2225 | TYPE: string |
a95856a0 | 2226 | DEFAULT: nobody |
0153d498 | 2227 | LOC: Config.effectiveUser |
2228 | DOC_NONE | |
2229 | ||
2230 | NAME: cache_effective_group | |
2231 | TYPE: string | |
8749fa47 | 2232 | DEFAULT: none |
0153d498 | 2233 | LOC: Config.effectiveGroup |
934b03fc | 2234 | DOC_START |
5a3f6538 | 2235 | |
934b03fc | 2236 | If the cache is run as root, it will change its effective/real |
5a3f6538 | 2237 | UID/GID to the UID/GID specified below. The default is to |
8749fa47 | 2238 | change to UID to nobody and GID to the default group of nobody. |
5a3f6538 | 2239 | |
2240 | If Squid is not started as root, the default is to keep the | |
8749fa47 | 2241 | current UID/GID, and only the GID can be changed to any of |
2242 | the groups the user starting Squid is member of. Note that if | |
2243 | Squid is not started as root then you cannot set http_port to | |
2244 | a value lower than 1024. | |
934b03fc | 2245 | DOC_END |
2246 | ||
2247 | ||
2248 | NAME: visible_hostname | |
2249 | TYPE: string | |
2250 | LOC: Config.visibleHostname | |
f1dc9b30 | 2251 | DEFAULT: none |
934b03fc | 2252 | DOC_START |
2253 | If you want to present a special hostname in error messages, etc, | |
2254 | then define this. Otherwise, the return value of gethostname() | |
cf5cc17e | 2255 | will be used. If you have multiple caches in a cluster and |
2256 | get errors about IP-forwarding you must set them to have individual | |
2257 | names with this setting. | |
934b03fc | 2258 | DOC_END |
2259 | ||
98829f69 | 2260 | |
2261 | NAME: unique_hostname | |
2262 | TYPE: string | |
2263 | LOC: Config.uniqueHostname | |
2264 | DEFAULT: none | |
2265 | DOC_START | |
2266 | If you want to have multiple machines with the same | |
2267 | 'visible_hostname' then you must give each machine a different | |
2268 | 'unique_hostname' so that forwarding loops can be detected. | |
98829f69 | 2269 | DOC_END |
2270 | ||
1f38f50a | 2271 | |
2272 | NAME: hostname_aliases | |
2273 | TYPE: wordlist | |
2274 | LOC: Config.hostnameAliases | |
2275 | DEFAULT: none | |
2276 | DOC_START | |
2277 | A list of other DNS names that your cache has. | |
2278 | DOC_END | |
2279 | ||
0f74202c | 2280 | COMMENT_START |
3a278cb8 | 2281 | OPTIONS FOR THE CACHE REGISTRATION SERVICE |
2282 | ----------------------------------------------------------------------------- | |
934b03fc | 2283 | |
3a278cb8 | 2284 | This section contains parameters for the (optional) cache |
2285 | announcement service. This service is provided to help | |
2286 | cache administrators locate one another in order to join or | |
2287 | create cache hierarchies. | |
934b03fc | 2288 | |
3a278cb8 | 2289 | An 'announcement' message is sent (via UDP) to the registration |
efd900cb | 2290 | service by Squid. By default, the announcement message is NOT |
d2d631ce | 2291 | SENT unless you enable it with 'announce_period' below. |
3a278cb8 | 2292 | |
2293 | The announcement message includes your hostname, plus the | |
2294 | following information from this configuration file: | |
934b03fc | 2295 | |
3a278cb8 | 2296 | http_port |
2297 | icp_port | |
2298 | cache_mgr | |
2299 | ||
2300 | All current information is processed regularly and made | |
2b6662ba | 2301 | available on the Web at http://www.ircache.net/Cache/Tracker/. |
0f74202c | 2302 | COMMENT_END |
934b03fc | 2303 | |
f1dc9b30 | 2304 | NAME: announce_period |
2305 | TYPE: time_t | |
2306 | LOC: Config.Announce.period | |
d2d631ce | 2307 | DEFAULT: 0 |
934b03fc | 2308 | DOC_START |
d2d631ce | 2309 | This is how frequently to send cache announcements. The |
2310 | default is `0' which disables sending the announcement | |
2311 | messages. | |
934b03fc | 2312 | |
cd748f27 | 2313 | To enable announcing your cache, just uncomment the line |
2314 | below. | |
2315 | ||
6b53c392 | 2316 | NOCOMMENT_START |
2317 | #To enable announcing your cache, just uncomment the line below. | |
2318 | #announce_period 1 day | |
2319 | NOCOMMENT_END | |
934b03fc | 2320 | DOC_END |
2321 | ||
2322 | ||
f1dc9b30 | 2323 | NAME: announce_host |
2324 | TYPE: string | |
61735fcf | 2325 | DEFAULT: tracker.ircache.net |
f1dc9b30 | 2326 | LOC: Config.Announce.host |
2327 | DOC_NONE | |
2328 | ||
cf5cc17e | 2329 | NAME: announce_file |
2330 | TYPE: string | |
61735fcf | 2331 | DEFAULT: none |
cf5cc17e | 2332 | LOC: Config.Announce.file |
2333 | DOC_NONE | |
2334 | ||
f1dc9b30 | 2335 | NAME: announce_port |
2336 | TYPE: ushort | |
2337 | DEFAULT: 3131 | |
2338 | LOC: Config.Announce.port | |
934b03fc | 2339 | DOC_START |
d2d631ce | 2340 | announce_host and announce_port set the hostname and port |
2341 | number where the registration message will be sent. | |
934b03fc | 2342 | |
d2d631ce | 2343 | Hostname will default to 'tracker.ircache.net' and port will |
2344 | default default to 3131. If the 'filename' argument is given, | |
2345 | the contents of that file will be included in the announce | |
2346 | message. | |
934b03fc | 2347 | DOC_END |
2348 | ||
0f74202c | 2349 | COMMENT_START |
3a278cb8 | 2350 | HTTPD-ACCELERATOR OPTIONS |
2351 | ----------------------------------------------------------------------------- | |
0f74202c | 2352 | COMMENT_END |
934b03fc | 2353 | |
f1dc9b30 | 2354 | NAME: httpd_accel_host |
2355 | TYPE: string | |
2356 | LOC: Config.Accel.host | |
2357 | DEFAULT: none | |
2358 | DOC_NONE | |
2359 | ||
2360 | NAME: httpd_accel_port | |
2361 | TYPE: ushort | |
2362 | LOC: Config.Accel.port | |
5b68a4d3 | 2363 | DEFAULT: 80 |
934b03fc | 2364 | DOC_START |
cf5cc17e | 2365 | If you want to run Squid as an httpd accelerator, define the |
934b03fc | 2366 | host name and port number where the real HTTP server is. |
2367 | ||
2368 | If you want virtual host support then specify the hostname | |
2369 | as "virtual". | |
2370 | ||
42b51993 | 2371 | If you want virtual port support then specify the port as "0". |
2372 | ||
839491ad | 2373 | NOTE: enabling httpd_accel_host disables proxy-caching and |
2374 | ICP. If you want these features enabled also, then set | |
2375 | the 'httpd_accel_with_proxy' option. | |
934b03fc | 2376 | DOC_END |
2377 | ||
13c7936a | 2378 | NAME: httpd_accel_single_host |
2379 | COMMENT: on|off | |
2380 | TYPE: onoff | |
2381 | LOC: Config.Accel.single_host | |
b0a9b5f2 | 2382 | DEFAULT: off |
13c7936a | 2383 | DOC_START |
2384 | If you are running Squid as a accelerator and have a single backend | |
2385 | server then set this to on. This causes Squid to forward the request | |
2386 | to this server irregardles of what any redirectors or Host headers | |
2387 | says. | |
2388 | ||
b0a9b5f2 | 2389 | Leave this at off if you have multiple backend servers, and use a |
2390 | redirector (or host table or private DNS) to map the requests to the | |
13c7936a | 2391 | appropriate backend servers. Note that the mapping needs to be a |
2392 | 1-1 mapping between requested and backend (from redirector) domain | |
2393 | names or caching will fail, as cacing is performed using the | |
2394 | URL returned from the redirector. | |
2395 | ||
2396 | See also redirect_rewrites_host_header. | |
2397 | DOC_END | |
934b03fc | 2398 | |
2399 | NAME: httpd_accel_with_proxy | |
2400 | COMMENT: on|off | |
2401 | TYPE: onoff | |
f1dc9b30 | 2402 | DEFAULT: off |
17a0a4ee | 2403 | LOC: Config.onoff.accel_with_proxy |
934b03fc | 2404 | DOC_START |
cf5cc17e | 2405 | If you want to use Squid as both a local httpd accelerator |
6b53c392 | 2406 | and as a proxy, change this to 'on'. Note however that your |
2407 | proxy users may have trouble to reach the accelerated domains | |
2408 | unless their browsers are configured not to use this proxy for | |
2409 | those domains (for example via the no_proxy browser configuration | |
2410 | setting) | |
934b03fc | 2411 | DOC_END |
2412 | ||
934b03fc | 2413 | NAME: httpd_accel_uses_host_header |
2414 | COMMENT: on|off | |
2415 | TYPE: onoff | |
f1dc9b30 | 2416 | DEFAULT: off |
934b03fc | 2417 | LOC: opt_accel_uses_host |
2418 | DOC_START | |
2419 | HTTP/1.1 requests include a Host: header which is basically the | |
2420 | hostname from the URL. Squid can be an accelerator for | |
2421 | different HTTP servers by looking at this header. However, | |
2422 | Squid does NOT check the value of the Host header, so it opens | |
2423 | a big security hole. We recommend that this option remain | |
2424 | disabled unless you are sure of what you are doing. | |
2425 | ||
04f6f348 | 2426 | However, you will need to enable this option if you run Squid |
2427 | as a transparent proxy. Otherwise, virtual servers which | |
2428 | require the Host: header will not be properly cached. | |
934b03fc | 2429 | DOC_END |
2430 | ||
0f74202c | 2431 | COMMENT_START |
3a278cb8 | 2432 | MISCELLANEOUS |
2433 | ----------------------------------------------------------------------------- | |
0f74202c | 2434 | COMMENT_END |
934b03fc | 2435 | |
2436 | NAME: dns_testnames | |
2437 | TYPE: wordlist | |
2438 | LOC: Config.dns_testname_list | |
f1dc9b30 | 2439 | DEFAULT: none |
6b53c392 | 2440 | DEFAULT_IF_NONE: netscape.com internic.net nlanr.net microsoft.com |
934b03fc | 2441 | DOC_START |
2442 | The DNS tests exit as soon as the first site is successfully looked up | |
2443 | ||
6b53c392 | 2444 | This test can be disabled with the -D command line option. |
934b03fc | 2445 | DOC_END |
2446 | ||
2447 | ||
2448 | NAME: logfile_rotate | |
2449 | TYPE: int | |
2450 | DEFAULT: 10 | |
2451 | LOC: Config.Log.rotateNumber | |
2452 | DOC_START | |
5a3f6538 | 2453 | Specifies the number of logfile rotations to make when you |
2454 | type 'squid -k rotate'. The default is 10, which will rotate | |
cf5cc17e | 2455 | with extensions 0 through 9. Setting logfile_rotate to 0 will |
934b03fc | 2456 | disable the rotation, but the logfiles are still closed and |
cf5cc17e | 2457 | re-opened. This will enable you to rename the logfiles |
5a3f6538 | 2458 | yourself just before sending the rotate signal. |
2459 | ||
2460 | Note, the 'squid -k rotate' command normally sends a USR1 | |
2461 | signal to the running squid process. In certain situations | |
2462 | (e.g. on Linux with Async I/O), USR1 is used for other | |
2463 | purposes, so -k rotate uses another signal. It is best to get | |
2464 | in the habit of using 'squid -k rotate' instead of 'kill -USR1 | |
2465 | <pid>'. | |
934b03fc | 2466 | DOC_END |
2467 | ||
2468 | ||
2469 | NAME: append_domain | |
f1dc9b30 | 2470 | TYPE: string |
2471 | LOC: Config.appendDomain | |
2472 | DEFAULT: none | |
934b03fc | 2473 | DOC_START |
cf5cc17e | 2474 | Appends local domain name to hostnames without any dots in |
2475 | them. append_domain must begin with a period. | |
934b03fc | 2476 | |
cd98395a | 2477 | Be warned that there today is Internet names with no dots in |
2478 | them using only top-domain names, so setting this may | |
2479 | cause some Internet sites to become unavailable. | |
2480 | ||
6b53c392 | 2481 | Example: |
2482 | append_domain .yourdomain.com | |
934b03fc | 2483 | DOC_END |
2484 | ||
2485 | ||
2486 | NAME: tcp_recv_bufsize | |
89de058c | 2487 | COMMENT: (bytes) |
1b635117 | 2488 | TYPE: b_size_t |
89de058c | 2489 | DEFAULT: 0 bytes |
934b03fc | 2490 | LOC: Config.tcpRcvBufsz |
2491 | DOC_START | |
2492 | Size of receive buffer to set for TCP sockets. Probably just | |
2493 | as easy to change your kernel's default. Set to zero to use | |
2494 | the default buffer size. | |
934b03fc | 2495 | DOC_END |
2496 | ||
934b03fc | 2497 | NAME: err_html_text |
f1dc9b30 | 2498 | TYPE: eol |
2499 | LOC: Config.errHtmlText | |
2500 | DEFAULT: none | |
934b03fc | 2501 | DOC_START |
2502 | HTML text to include in error messages. Make this a "mailto" | |
2503 | URL to your admin address, or maybe just a link to your | |
2504 | organizations Web page. | |
2505 | ||
ab1e6b8a | 2506 | To include this in your error messages, you must rewrite |
2507 | the error template files (found in the "errors" directory). | |
2508 | Wherever you want the 'err_html_text' line to appear, | |
2509 | insert a %L tag in the error template file. | |
934b03fc | 2510 | DOC_END |
2511 | ||
2512 | ||
2513 | NAME: deny_info | |
2514 | TYPE: denyinfo | |
2515 | LOC: Config.denyInfoList | |
f1dc9b30 | 2516 | DEFAULT: none |
934b03fc | 2517 | DOC_START |
02922e76 | 2518 | Usage: deny_info err_page_name acl |
2519 | Example: deny_info ERR_CUSTOM_ACCESS_DENIED bad_guys | |
934b03fc | 2520 | |
02922e76 | 2521 | This can be used to return a ERR_ page for requests which |
934b03fc | 2522 | do not pass the 'http_access' rules. A single ACL will cause |
2523 | the http_access check to fail. If a 'deny_info' line exists | |
02922e76 | 2524 | for that ACL then Squid returns a corresponding error page. |
cf5cc17e | 2525 | |
02922e76 | 2526 | You may use ERR_ pages that come with Squid or create your own pages |
2527 | and put them into the configured errors/ directory. | |
934b03fc | 2528 | DOC_END |
2529 | ||
934b03fc | 2530 | NAME: memory_pools |
2531 | COMMENT: on|off | |
2532 | TYPE: onoff | |
f1dc9b30 | 2533 | DEFAULT: on |
3f6c0fb2 | 2534 | LOC: Config.onoff.mem_pools |
934b03fc | 2535 | DOC_START |
2536 | If set, Squid will keep pools of allocated (but unused) memory | |
2537 | available for future use. If memory is a premium on your | |
96d88dcb | 2538 | system and you believe your malloc library outperforms Squid |
d0d41f07 | 2539 | routines, disable this. |
934b03fc | 2540 | DOC_END |
2541 | ||
7021844c | 2542 | NAME: memory_pools_limit |
2543 | COMMENT: (bytes) | |
2544 | TYPE: b_size_t | |
2545 | DEFAULT: none | |
f12c295b | 2546 | LOC: Config.MemPools.limit |
7021844c | 2547 | DOC_START |
f12c295b | 2548 | Used only with memory_pools on: |
2549 | memory_pools_limit 50 MB | |
7021844c | 2550 | |
f12c295b | 2551 | If set to a non-zero value, Squid will keep at most the specified |
2552 | limit of allocated (but unused) memory in memory pools. All free() | |
2553 | requests that exceed this limit will be handled by your malloc | |
2554 | library. Squid does not pre-allocate any memory, just safe-keeps | |
2555 | objects that otherwise would be free()d. Thus, it is safe to set | |
7021844c | 2556 | memory_pools_limit to a reasonably high value even if your |
f12c295b | 2557 | configuration will use less memory. |
2558 | ||
2559 | If not set (default) or set to zero, Squid will keep all memory it | |
2560 | can. That is, there will be no limit on the total amount of memory | |
2561 | used for safe-keeping. | |
7021844c | 2562 | |
2563 | To disable memory allocation optimization, do not set | |
2564 | memory_pools_limit to 0. Set memory_pools to "off" instead. | |
2565 | ||
f12c295b | 2566 | An overhead for maintaining memory pools is not taken into account |
2567 | when the limit is checked. This overhead is close to four bytes per | |
2568 | object kept. However, pools may actually _save_ memory because of | |
2569 | reduced memory thrashing in your malloc library. | |
7021844c | 2570 | DOC_END |
2571 | ||
934b03fc | 2572 | NAME: forwarded_for |
2573 | COMMENT: on|off | |
2574 | TYPE: onoff | |
f1dc9b30 | 2575 | DEFAULT: on |
934b03fc | 2576 | LOC: opt_forwarded_for |
2577 | DOC_START | |
2578 | If set, Squid will include your system's IP address or name | |
2579 | in the HTTP requests it forwards. By default it looks like | |
2580 | this: | |
2581 | ||
2582 | X-Forwarded-For: 192.1.2.3 | |
2583 | ||
2584 | If you disable this, it will appear as | |
2585 | ||
2586 | X-Forwarded-For: unknown | |
934b03fc | 2587 | DOC_END |
2588 | ||
2589 | NAME: log_icp_queries | |
2590 | COMMENT: on|off | |
2591 | TYPE: onoff | |
f1dc9b30 | 2592 | DEFAULT: on |
17a0a4ee | 2593 | LOC: Config.onoff.log_udp |
934b03fc | 2594 | DOC_START |
cf5cc17e | 2595 | If set, ICP queries are logged to access.log. You may wish |
2596 | do disable this if your ICP load is VERY high to speed things | |
2597 | up or to simplify log analysis. | |
934b03fc | 2598 | DOC_END |
2599 | ||
88738790 | 2600 | NAME: icp_hit_stale |
2601 | COMMENT: on|off | |
2602 | TYPE: onoff | |
2603 | DEFAULT: off | |
17a0a4ee | 2604 | LOC: Config.onoff.icp_hit_stale |
88738790 | 2605 | DOC_START |
2606 | If you want to return ICP_HIT for stale cache objects, set this | |
2607 | option to 'on'. If you have sibling relationships with caches | |
2608 | in other administrative domains, this should be 'off'. If you only | |
2609 | have sibling relationships with caches under your control, then | |
2610 | it is probably okay to set this to 'on'. | |
0ccdf88e | 2611 | If set to 'on', then your siblings should use the option "allow-miss" |
2612 | on their cache_peer lines for connecting to you. | |
88738790 | 2613 | DOC_END |
2614 | ||
934b03fc | 2615 | |
2616 | NAME: minimum_direct_hops | |
2617 | TYPE: int | |
2618 | DEFAULT: 4 | |
2619 | LOC: Config.minDirectHops | |
2620 | DOC_START | |
2621 | If using the ICMP pinging stuff, do direct fetches for sites | |
2622 | which are no more than this many hops away. | |
934b03fc | 2623 | DOC_END |
2624 | ||
5f84d830 | 2625 | NAME: minimum_direct_rtt |
2626 | TYPE: int | |
2627 | DEFAULT: 400 | |
2628 | LOC: Config.minDirectRtt | |
2629 | DOC_START | |
2630 | If using the ICMP pinging stuff, do direct fetches for sites | |
2631 | which are no more than this many rtt milliseconds away. | |
2632 | DOC_END | |
934b03fc | 2633 | |
2634 | NAME: cachemgr_passwd | |
2635 | TYPE: cachemgrpasswd | |
86101e40 | 2636 | DEFAULT: none |
f1dc9b30 | 2637 | LOC: Config.passwd_list |
934b03fc | 2638 | DOC_START |
2639 | Specify passwords for cachemgr operations. | |
2640 | ||
2641 | Usage: cachemgr_passwd password action action ... | |
2642 | ||
064a674d | 2643 | Some valid actions are (see cache manager menu for a full list): |
2644 | 5min | |
2645 | 60min | |
2646 | asndb | |
2647 | authenticator | |
2648 | cbdata | |
2649 | client_list | |
2650 | comm_incoming | |
2651 | config * | |
2652 | counters | |
2653 | delay | |
2654 | digest_stats | |
cf5cc17e | 2655 | dns |
064a674d | 2656 | events |
cf5cc17e | 2657 | filedescriptors |
064a674d | 2658 | fqdncache |
2659 | histograms | |
2660 | http_headers | |
2661 | info | |
2662 | io | |
2663 | ipcache | |
2664 | mem | |
2665 | menu | |
cf5cc17e | 2666 | netdb |
064a674d | 2667 | non_peers |
2668 | objects | |
2669 | pconn | |
2670 | peer_select | |
2671 | redirector | |
2672 | refresh | |
934b03fc | 2673 | server_list |
064a674d | 2674 | shutdown * |
2675 | store_digest | |
2676 | storedir | |
2677 | utilization | |
2678 | via_headers | |
2679 | vm_objects | |
934b03fc | 2680 | |
2681 | * Indicates actions which will not be performed without a | |
2682 | valid password, others can be performed if not listed here. | |
2683 | ||
2684 | To disable an action, set the password to "disable". | |
2685 | To allow performing an action without a password, set the | |
2686 | password to "none". | |
2687 | ||
2688 | Use the keyword "all" to set the same password for all actions. | |
2689 | ||
6b53c392 | 2690 | Example: |
2691 | cachemgr_passwd secret shutdown | |
2692 | cachemgr_passwd lesssssssecret info stats/objects | |
2693 | cachemgr_passwd disable all | |
934b03fc | 2694 | DOC_END |
2695 | ||
934b03fc | 2696 | NAME: store_avg_object_size |
86101e40 | 2697 | COMMENT: (kbytes) |
2698 | TYPE: kb_size_t | |
2bf99296 | 2699 | DEFAULT: 13 KB |
934b03fc | 2700 | LOC: Config.Store.avgObjectSize |
2701 | DOC_START | |
2702 | Average object size, used to estimate number of objects your | |
2703 | cache can hold. See doc/Release-Notes-1.1.txt. The default is | |
2bf99296 | 2704 | 13 KB. |
934b03fc | 2705 | DOC_END |
2706 | ||
2707 | NAME: store_objects_per_bucket | |
2708 | TYPE: int | |
baf144ad | 2709 | DEFAULT: 20 |
934b03fc | 2710 | LOC: Config.Store.objectsPerBucket |
2711 | DOC_START | |
2712 | Target number of objects per bucket in the store hash table. | |
2713 | Lowering this value increases the total number of buckets and | |
7e3ce7b9 | 2714 | also the storage maintenance rate. The default is 50. |
934b03fc | 2715 | DOC_END |
2716 | ||
934b03fc | 2717 | NAME: client_db |
2718 | COMMENT: on|off | |
2719 | TYPE: onoff | |
f1dc9b30 | 2720 | DEFAULT: on |
17a0a4ee | 2721 | LOC: Config.onoff.client_db |
934b03fc | 2722 | DOC_START |
2723 | If you want to disable collecting per-client statistics, then | |
2724 | turn off client_db here. | |
934b03fc | 2725 | DOC_END |
2726 | ||
2727 | ||
2728 | NAME: netdb_low | |
2729 | TYPE: int | |
2730 | DEFAULT: 900 | |
2731 | LOC: Config.Netdb.low | |
2732 | DOC_NONE | |
2733 | ||
2734 | NAME: netdb_high | |
2735 | TYPE: int | |
2736 | DEFAULT: 1000 | |
2737 | LOC: Config.Netdb.high | |
2738 | DOC_START | |
2739 | The low and high water marks for the ICMP measurement | |
2740 | database. These are counts, not percents. The defaults are | |
2741 | 900 and 1000. When the high water mark is reached, database | |
2742 | entries will be deleted until the low mark is reached. | |
934b03fc | 2743 | DOC_END |
2744 | ||
2745 | ||
2746 | NAME: netdb_ping_period | |
f1dc9b30 | 2747 | TYPE: time_t |
934b03fc | 2748 | LOC: Config.Netdb.period |
9e975e4e | 2749 | DEFAULT: 5 minutes |
934b03fc | 2750 | DOC_START |
2751 | The minimum period for measuring a site. There will be at | |
2752 | least this much delay between successive pings to the same | |
2753 | network. The default is five minutes. | |
934b03fc | 2754 | DOC_END |
2755 | ||
2756 | ||
2757 | NAME: query_icmp | |
2758 | COMMENT: on|off | |
2759 | TYPE: onoff | |
f1dc9b30 | 2760 | DEFAULT: off |
17a0a4ee | 2761 | LOC: Config.onoff.query_icmp |
934b03fc | 2762 | DOC_START |
2763 | If you want to ask your peers to include ICMP data in their ICP | |
2764 | replies, enable this option. | |
2765 | ||
cf5cc17e | 2766 | If your peer has configured Squid (during compilation) with |
2767 | '--enable-icmp' then that peer will send ICMP pings to origin server | |
2768 | sites of the URLs it receives. If you enable this option then the | |
2769 | ICP replies from that peer will include the ICMP data (if available). | |
2770 | Then, when choosing a parent cache, Squid will choose the parent with | |
934b03fc | 2771 | the minimal RTT to the origin server. When this happens, the |
2772 | hierarchy field of the access.log will be | |
2773 | "CLOSEST_PARENT_MISS". This option is off by default. | |
934b03fc | 2774 | DOC_END |
2775 | ||
88500f96 | 2776 | NAME: test_reachability |
194dd3b8 | 2777 | COMMENT: on|off |
2778 | TYPE: onoff | |
2779 | DEFAULT: off | |
2780 | LOC: Config.onoff.test_reachability | |
2781 | DOC_START | |
2782 | When this is 'on', ICP MISS replies will be ICP_MISS_NOFETCH | |
2783 | instead of ICP_MISS if the target host is NOT in the ICMP | |
2784 | database, or has a zero RTT. | |
194dd3b8 | 2785 | DOC_END |
2786 | ||
78f1250a | 2787 | NAME: buffered_logs |
2788 | COMMENT: on|off | |
2789 | TYPE: onoff | |
2790 | DEFAULT: off | |
17a0a4ee | 2791 | LOC: Config.onoff.buffered_logs |
78f1250a | 2792 | DOC_START |
2793 | Some log files (cache.log, useragent.log) are written with | |
2794 | stdio functions, and as such they can be buffered or | |
cf5cc17e | 2795 | unbuffered. By default they will be unbuffered. Buffering them |
2796 | can speed up the writing slightly (though you are unlikely to | |
2797 | need to worry). | |
78f1250a | 2798 | DOC_END |
2799 | ||
465dc415 | 2800 | NAME: reload_into_ims |
9f60cfdf | 2801 | IFDEF: HTTP_VIOLATIONS |
465dc415 | 2802 | COMMENT: on|off |
2803 | TYPE: onoff | |
2804 | DEFAULT: off | |
2805 | LOC: Config.onoff.reload_into_ims | |
2806 | DOC_START | |
2807 | When you enable this option, client no-cache or ``reload'' | |
2808 | requests will be changed to If-Modified-Since requests. | |
2809 | Doing this VIOLATES the HTTP standard. Enabling this | |
2810 | feature could make you liable for problems which it | |
2811 | causes. | |
cbe3a719 | 2812 | |
2813 | see also refresh_pattern for a more selective approach. | |
465dc415 | 2814 | DOC_END |
2815 | ||
934b03fc | 2816 | NAME: always_direct |
2817 | TYPE: acl_access | |
2818 | LOC: Config.accessList.AlwaysDirect | |
f1dc9b30 | 2819 | DEFAULT: none |
934b03fc | 2820 | DOC_START |
2a78fa67 | 2821 | Usage: always_direct allow|deny [!]aclname ... |
2822 | ||
2823 | Here you can use ACL elements to specify requests which should | |
3445a83a | 2824 | ALWAYS be forwarded directly to origin servers. For example, |
2825 | to always directly forward requests for local servers use | |
2a78fa67 | 2826 | something like: |
2827 | ||
2828 | acl local-servers dstdomain my.domain.net | |
2829 | always_direct allow local-servers | |
2830 | ||
2831 | To always forward FTP requests directly, use | |
2832 | ||
2833 | acl FTP proto FTP | |
2834 | always_direct allow FTP | |
2835 | ||
2836 | NOTE: There is a similar, but opposite option named | |
2837 | 'never_direct'. You need to be aware that "always_direct deny | |
2838 | foo" is NOT the same thing as "never_direct allow foo". You | |
2839 | may need to use a deny rule to exclude a more-specific case of | |
2840 | some other rule. Example: | |
2841 | ||
2842 | acl local-external dstdomain external.foo.net | |
5d8ea528 | 2843 | acl local-servers dstdomain .foo.net |
2a78fa67 | 2844 | always_direct deny local-external |
2845 | always_direct allow local-servers | |
3445a83a | 2846 | |
2847 | This option replaces some v1.1 options such as local_domain | |
2848 | and local_ip. | |
934b03fc | 2849 | DOC_END |
2850 | ||
2851 | NAME: never_direct | |
2852 | TYPE: acl_access | |
2853 | LOC: Config.accessList.NeverDirect | |
f1dc9b30 | 2854 | DEFAULT: none |
934b03fc | 2855 | DOC_START |
d0d41f07 | 2856 | Usage: never_direct allow|deny [!]aclname ... |
2a78fa67 | 2857 | |
2858 | never_direct is the opposite of always_direct. Please read | |
2859 | the description for always_direct if you have not already. | |
934b03fc | 2860 | |
2a78fa67 | 2861 | With 'never_direct' you can use ACL elements to specify |
2862 | requests which should NEVER be forwarded directly to origin | |
3445a83a | 2863 | servers. For example, to force the use of a proxy for all |
2864 | requests, except those in your local domain use something like: | |
2a78fa67 | 2865 | |
5d8ea528 | 2866 | acl local-servers dstdomain .foo.net |
2a78fa67 | 2867 | acl all src 0.0.0.0/0.0.0.0 |
d0d41f07 | 2868 | never_direct deny local-servers |
2869 | never_direct allow all | |
3445a83a | 2870 | |
2871 | or if squid is inside a firewall and there is local intranet | |
2872 | servers inside the firewall then use something like: | |
2873 | ||
5d8ea528 | 2874 | acl local-intranet dstdomain .foo.net |
3445a83a | 2875 | acl local-external dstdomain external.foo.net |
2876 | always_direct deny local-external | |
2877 | always_direct allow local-intranet | |
2878 | never_direct allow all | |
2879 | ||
2880 | This option replaces some v1.1 options such as inside_firewall | |
2881 | and firewall_ip. | |
2a78fa67 | 2882 | DOC_END |
934b03fc | 2883 | |
6bccf575 | 2884 | NAME: header_access |
2885 | TYPE: http_header_access[] | |
2886 | LOC: Config.header_access | |
97474590 | 2887 | DEFAULT: none |
2888 | DOC_START | |
6bccf575 | 2889 | Usage: header_access header_name allow|deny [!]aclname ... |
96d88dcb | 2890 | |
6bccf575 | 2891 | This option replaces the old 'anonymize_headers' and the |
2892 | older 'http_anonymizer' option with something that is much | |
2893 | more configurable. This new method creates a list of ACLs | |
2894 | for each header, allowing you very fine-tuned header | |
2895 | mangling. | |
2896 | ||
2897 | You can only specify known headers for the header name. | |
2898 | Other headers are reclassified as 'Other'. You can also | |
2899 | refer to all the headers with 'All'. | |
96d88dcb | 2900 | |
6bccf575 | 2901 | For example, to achieve the same behaviour as the old |
5bcad01d | 2902 | 'http_anonymizer standard' option, you should use: |
96d88dcb | 2903 | |
6bccf575 | 2904 | header_access From deny all |
2905 | header_access Referer deny all | |
2906 | header_access Server deny all | |
2907 | header_access User-Agent deny all | |
2908 | header_access WWW-Authenticate deny all | |
2909 | header_access Link deny all | |
97474590 | 2910 | |
5bcad01d | 2911 | Or, to reproduce the old 'http_anonymizer paranoid' feature |
2912 | you should use: | |
96d88dcb | 2913 | |
6bccf575 | 2914 | header_access Allow allow all |
2915 | header_access Authorization allow all | |
2916 | header_access Cache-Control allow all | |
2917 | header_access Content-Encoding allow all | |
2918 | header_access Content-Length allow all | |
2919 | header_access Content-Type allow all | |
2920 | header_access Date allow all | |
2921 | header_access Expires allow all | |
2922 | header_access Host allow all | |
2923 | header_access If-Modified-Since allow all | |
2924 | header_access Last-Modified allow all | |
2925 | header_access Location allow all | |
2926 | header_access Pragma allow all | |
2927 | header_access Accept allow all | |
2928 | header_access Charset allow all | |
2929 | header_access Accept-Encoding allow all | |
2930 | header_access Accept-Language allow all | |
2931 | header_access Content-Language allow all | |
2932 | header_access Mime-Version allow all | |
2933 | header_access Retry-After allow all | |
2934 | header_access Title allow all | |
2935 | header_access Connection allow all | |
2936 | header_access Proxy-Connection allow all | |
2937 | header_access All deny all | |
96d88dcb | 2938 | |
5bcad01d | 2939 | By default, all headers are allowed (no anonymizing is |
2940 | performed). | |
97474590 | 2941 | DOC_END |
2942 | ||
6bccf575 | 2943 | NAME: header_replace |
2944 | TYPE: http_header_replace[] | |
2945 | LOC: Config.header_access | |
88738790 | 2946 | DEFAULT: none |
2947 | DOC_START | |
6bccf575 | 2948 | Usage: header_replace header_name message |
2949 | Example: header_replace User-Agent Nutscrape/1.0 (CP/M; 8-bit) | |
96d88dcb | 2950 | |
6bccf575 | 2951 | This option allows you to change the contents of headers |
2952 | denied with header_access above, by replacing them with | |
2953 | some fixed string. This replaces the old fake_user_agent | |
2954 | option. | |
96d88dcb | 2955 | |
6bccf575 | 2956 | By default, headers are removed if denied. |
88738790 | 2957 | DOC_END |
2958 | ||
365cb147 | 2959 | NAME: icon_directory |
f0b19334 | 2960 | TYPE: string |
365cb147 | 2961 | LOC: Config.icons.directory |
2962 | DEFAULT: @DEFAULT_ICON_DIR@ | |
2963 | DOC_START | |
cf5cc17e | 2964 | Where the icons are stored. These are normally kept in |
2965 | @DEFAULT_ICON_DIR@ | |
365cb147 | 2966 | DOC_END |
2967 | ||
cf5cc17e | 2968 | NAME: error_directory |
365cb147 | 2969 | TYPE: string |
cf5cc17e | 2970 | LOC: Config.errorDirectory |
2971 | DEFAULT: @DEFAULT_ERROR_DIR@ | |
365cb147 | 2972 | DOC_START |
cf5cc17e | 2973 | If you wish to create your own versions of the default |
efd900cb | 2974 | (English) error files, either to customize them to suit your |
2975 | language or company copy the template English files to another | |
cf5cc17e | 2976 | directory and point this tag at them. |
365cb147 | 2977 | DOC_END |
88738790 | 2978 | |
22c653cd | 2979 | NAME: minimum_retry_timeout |
2980 | COMMENT: (seconds) | |
2981 | TYPE: time_t | |
2982 | LOC: Config.retry.timeout | |
2983 | DEFAULT: 5 seconds | |
2984 | DOC_START | |
2985 | This specifies the minimum connect timeout, for when the | |
2986 | connect timeout is reduced to compensate for the availability | |
2987 | of multiple IP addresses. | |
2988 | ||
cf5cc17e | 2989 | When a connection to a host is initiated, and that host has |
2990 | several IP addresses, the default connection timeout is reduced | |
2991 | by dividing it by the number of addresses. So, a site with 15 | |
2992 | addresses would then have a timeout of 8 seconds for each | |
2993 | address attempted. To avoid having the timeout reduced to the | |
2994 | point where even a working host would not have a chance to | |
2995 | respond, this setting is provided. The default, and the | |
2996 | minimum value, is five seconds, and the maximum value is sixty | |
2997 | seconds, or half of connect_timeout, whichever is greater and | |
2998 | less than connect_timeout. | |
22c653cd | 2999 | DOC_END |
3000 | ||
3001 | NAME: maximum_single_addr_tries | |
3002 | TYPE: int | |
3003 | LOC: Config.retry.maxtries | |
3004 | DEFAULT: 3 | |
3005 | DOC_START | |
3006 | This sets the maximum number of connection attempts for a | |
3007 | host that only has one address (for multiple-address hosts, | |
3008 | each address is tried once). | |
3009 | ||
3010 | The default value is three tries, the (not recommended) | |
3011 | maximum is 255 tries. A warning message will be generated | |
3012 | if it is set to a value greater than ten. | |
22c653cd | 3013 | DOC_END |
6d1c0d53 | 3014 | |
a97cfa48 | 3015 | NAME: snmp_port |
3016 | TYPE: ushort | |
3017 | LOC: Config.Port.snmp | |
3018 | DEFAULT: 3401 | |
1df370e3 | 3019 | IFDEF: SQUID_SNMP |
a97cfa48 | 3020 | DOC_START |
cf5cc17e | 3021 | Squid can now serve statistics and status information via SNMP. |
3022 | By default it listens to port 3401 on the machine. If you don't | |
9bc73deb | 3023 | wish to use SNMP, set this to "0". |
a97cfa48 | 3024 | DOC_END |
3025 | ||
dba79ac5 | 3026 | NAME: snmp_access |
3027 | TYPE: acl_access | |
3028 | LOC: Config.accessList.snmp | |
a97cfa48 | 3029 | DEFAULT: none |
6502682e | 3030 | DEFAULT_IF_NONE: deny all |
1df370e3 | 3031 | IFDEF: SQUID_SNMP |
a97cfa48 | 3032 | DOC_START |
dba79ac5 | 3033 | Allowing or denying access to the SNMP port. |
08f6b5e0 | 3034 | |
3035 | All access to the agent is denied by default. | |
dba79ac5 | 3036 | usage: |
4feb7b2e | 3037 | |
dba79ac5 | 3038 | snmp_access allow|deny [!]aclname ... |
08f6b5e0 | 3039 | |
3040 | Example: | |
6b53c392 | 3041 | snmp_access allow snmppublic localhost |
3042 | snmp_access deny all | |
bdf18524 | 3043 | DOC_END |
3044 | ||
15dcc168 | 3045 | NAME: snmp_incoming_address |
3046 | TYPE: address | |
1ecaa0a0 | 3047 | LOC: Config.Addrs.snmp_incoming |
15dcc168 | 3048 | DEFAULT: 0.0.0.0 |
3049 | IFDEF: SQUID_SNMP | |
3050 | DOC_NONE | |
3051 | NAME: snmp_outgoing_address | |
3052 | TYPE: address | |
3053 | LOC: Config.Addrs.snmp_outgoing | |
3054 | DEFAULT: 255.255.255.255 | |
3055 | IFDEF: SQUID_SNMP | |
3056 | DOC_START | |
3057 | Just like 'udp_incoming_address' above, but for the SNMP port. | |
3058 | ||
3059 | snmp_incoming_address is used for the SNMP socket receiving | |
3060 | messages from SNMP agents. | |
3061 | snmp_outgoing_address is used for SNMP packets returned to SNMP | |
3062 | agents. | |
3063 | ||
6b53c392 | 3064 | The default snmp_incoming_address (0.0.0.0) is to listen on all |
3065 | available network interfaces. | |
15dcc168 | 3066 | |
6b53c392 | 3067 | If snmp_outgoing_address is set to 255.255.255.255 (the default) |
3068 | then it will use the same socket as snmp_incoming_address. Only | |
3069 | change this if you want to have SNMP replies sent using another | |
3070 | address than where this Squid listens for SNMP queries. | |
15dcc168 | 3071 | |
6b53c392 | 3072 | NOTE, snmp_incoming_address and snmp_outgoing_address can not have |
3073 | the same value since they both use port 3401. | |
15dcc168 | 3074 | DOC_END |
bdf18524 | 3075 | |
53ad48e6 | 3076 | NAME: as_whois_server |
3077 | TYPE: string | |
3078 | LOC: Config.as_whois_server | |
3079 | DEFAULT: whois.ra.net | |
3080 | DEFAULT_IF_NONE: whois.ra.net | |
3081 | DOC_START | |
cf5cc17e | 3082 | WHOIS server to query for AS numbers. NOTE: AS numbers are |
3083 | queried only when Squid starts up, not for every request. | |
53ad48e6 | 3084 | DOC_END |
95e36d02 | 3085 | |
320e9f36 | 3086 | NAME: wccp_router |
3087 | TYPE: address | |
3088 | LOC: Config.Wccp.router | |
3089 | DEFAULT: 0.0.0.0 | |
eb824054 | 3090 | IFDEF: USE_WCCP |
320e9f36 | 3091 | DOC_START |
efd900cb | 3092 | Use this option to define your WCCP ``home'' router for |
3093 | Squid. Setting the 'wccp_router' to 0.0.0.0 (the default) | |
3094 | disables WCCP. | |
320e9f36 | 3095 | DOC_END |
3096 | ||
d20b1cd0 | 3097 | NAME: wccp_version |
3098 | TYPE: int | |
3099 | LOC: Config.Wccp.version | |
3100 | DEFAULT: 4 | |
3101 | IFDEF: USE_WCCP | |
3102 | DOC_START | |
3103 | According to some users, Cisco IOS 11.2 only supports WCCP | |
3104 | version 3. If you're using that version of IOS, change | |
3105 | this value to 3. | |
3106 | DOC_END | |
3107 | ||
320e9f36 | 3108 | NAME: wccp_incoming_address |
3109 | TYPE: address | |
eb824054 | 3110 | LOC: Config.Wccp.incoming |
320e9f36 | 3111 | DEFAULT: 0.0.0.0 |
eb824054 | 3112 | IFDEF: USE_WCCP |
320e9f36 | 3113 | DOC_NONE |
3114 | NAME: wccp_outgoing_address | |
3115 | TYPE: address | |
eb824054 | 3116 | LOC: Config.Wccp.outgoing |
320e9f36 | 3117 | DEFAULT: 255.255.255.255 |
eb824054 | 3118 | IFDEF: USE_WCCP |
320e9f36 | 3119 | DOC_START |
efd900cb | 3120 | wccp_incoming_address Use this option if you require WCCP |
3121 | messages to be received on only one | |
3122 | interface. Do NOT use this option if | |
3123 | you're unsure how many interfaces you | |
3124 | have, or if you know you have only one | |
3125 | interface. | |
320e9f36 | 3126 | |
efd900cb | 3127 | wccp_outgoing_address Use this option if you require WCCP |
3128 | messages to be sent out on only one | |
3129 | interface. Do NOT use this option if | |
3130 | you're unsure how many interfaces you | |
3131 | have, or if you know you have only one | |
3132 | interface. | |
320e9f36 | 3133 | |
efd900cb | 3134 | The default behavior is to not bind to any specific address. |
320e9f36 | 3135 | |
3136 | NOTE, wccp_incoming_address and wccp_outgoing_address can not have | |
3137 | the same value since they both use port 2048. | |
320e9f36 | 3138 | DOC_END |
3139 | ||
3140 | ||
95e36d02 | 3141 | COMMENT_START |
3142 | DELAY POOL PARAMETERS (all require DELAY_POOLS compilation option) | |
3143 | ----------------------------------------------------------------------------- | |
95e36d02 | 3144 | COMMENT_END |
3145 | ||
59715b38 | 3146 | NAME: delay_pools |
3147 | TYPE: delay_pool_count | |
3148 | DEFAULT: 0 | |
95e36d02 | 3149 | IFDEF: DELAY_POOLS |
59715b38 | 3150 | LOC: Config.Delay |
95e36d02 | 3151 | DOC_START |
59715b38 | 3152 | This represents the number of delay pools to be used. For example, |
3153 | if you have one class 2 delay pool and one class 3 delays pool, you | |
3154 | have a total of 2 delay pools. | |
95e36d02 | 3155 | DOC_END |
3156 | ||
59715b38 | 3157 | NAME: delay_class |
3158 | TYPE: delay_pool_class | |
95e36d02 | 3159 | DEFAULT: none |
3160 | IFDEF: DELAY_POOLS | |
59715b38 | 3161 | LOC: Config.Delay |
95e36d02 | 3162 | DOC_START |
59715b38 | 3163 | This defines the class of each delay pool. There must be exactly one |
3164 | delay_class line for each delay pool. For example, to define two | |
3165 | delay pools, one of class 2 and one of class 3, the settings above | |
3166 | and here would be: | |
3167 | ||
6b53c392 | 3168 | Example: |
3169 | delay_pools 2 # 2 delay pools | |
3170 | delay_class 1 2 # pool 1 is a class 2 pool | |
3171 | delay_class 2 3 # pool 2 is a class 3 pool | |
59715b38 | 3172 | |
3173 | The delay pool classes are: | |
3174 | ||
3175 | class 1 Everything is limited by a single aggregate | |
3176 | bucket. | |
3177 | ||
3178 | class 2 Everything is limited by a single aggregate | |
3179 | bucket as well as an "individual" bucket chosen | |
3180 | from bits 25 through 32 of the IP address. | |
3181 | ||
3182 | class 3 Everything is limited by a single aggregate | |
3183 | bucket as well as a "network" bucket chosen | |
3184 | from bits 17 through 24 of the IP address and a | |
3185 | "individual" bucket chosen from bits 17 through | |
3186 | 32 of the IP address. | |
3187 | ||
3188 | NOTE: If an IP address is a.b.c.d | |
3189 | -> bits 25 through 32 are "d" | |
3190 | -> bits 17 through 24 are "c" | |
3191 | -> bits 17 through 32 are "c * 256 + d" | |
95e36d02 | 3192 | DOC_END |
3193 | ||
59715b38 | 3194 | NAME: delay_access |
3195 | TYPE: delay_pool_access | |
95e36d02 | 3196 | DEFAULT: none |
3197 | IFDEF: DELAY_POOLS | |
59715b38 | 3198 | LOC: Config.Delay |
95e36d02 | 3199 | DOC_START |
59715b38 | 3200 | This is used to determine which delay pool a request falls into. |
efd900cb | 3201 | The first matched delay pool is always used, i.e., if a request falls |
59715b38 | 3202 | into delay pool number one, no more delay are checked, otherwise the |
3203 | rest are checked in order of their delay pool number until they have | |
3204 | all been checked. For example, if you want some_big_clients in delay | |
3205 | pool 1 and lotsa_little_clients in delay pool 2: | |
95e36d02 | 3206 | |
6b53c392 | 3207 | Example: |
3208 | delay_access 1 allow some_big_clients | |
3209 | delay_access 1 deny all | |
3210 | delay_access 2 allow lotsa_little_clients | |
3211 | delay_access 2 deny all | |
95e36d02 | 3212 | DOC_END |
3213 | ||
59715b38 | 3214 | NAME: delay_parameters |
3215 | TYPE: delay_pool_rates | |
3216 | DEFAULT: none | |
95e36d02 | 3217 | IFDEF: DELAY_POOLS |
59715b38 | 3218 | LOC: Config.Delay |
95e36d02 | 3219 | DOC_START |
59715b38 | 3220 | This defines the parameters for a delay pool. Each delay pool has |
3221 | a number of "buckets" associated with it, as explained in the | |
3222 | description of delay_class. For a class 1 delay pool, the syntax is: | |
95e36d02 | 3223 | |
59715b38 | 3224 | delay_parameters pool aggregate |
95e36d02 | 3225 | |
59715b38 | 3226 | For a class 2 delay pool: |
95e36d02 | 3227 | |
59715b38 | 3228 | delay_parameters pool aggregate individual |
95e36d02 | 3229 | |
59715b38 | 3230 | For a class 3 delay pool: |
95e36d02 | 3231 | |
59715b38 | 3232 | delay_parameters pool aggregate network individual |
95e36d02 | 3233 | |
59715b38 | 3234 | The variables here are: |
95e36d02 | 3235 | |
59715b38 | 3236 | pool a pool number - ie, a number between 1 and the |
3237 | number specified in delay_pools as used in | |
3238 | delay_class lines. | |
95e36d02 | 3239 | |
59715b38 | 3240 | aggregate the "delay parameters" for the aggregate bucket |
3241 | (class 1, 2, 3). | |
95e36d02 | 3242 | |
59715b38 | 3243 | individual the "delay parameters" for the individual |
3244 | buckets (class 2, 3). | |
3245 | ||
3246 | network the "delay parameters" for the network buckets | |
3247 | (class 3). | |
3248 | ||
3249 | A pair of delay parameters is written restore/maximum, where restore is | |
3250 | the number of bytes (not bits - modem and network speeds are usually | |
3251 | quoted in bits) per second placed into the bucket, and maximum is the | |
3252 | maximum number of bytes which can be in the bucket at any time. | |
3253 | ||
3254 | For example, if delay pool number 1 is a class 2 delay pool as in the | |
3255 | above example, and is being used to strictly limit each host to 64kbps | |
3256 | (plus overheads), with no overall limit, the line is: | |
3257 | ||
3258 | delay_parameters 1 -1/-1 8000/8000 | |
3259 | ||
3260 | Note that the figure -1 is used to represent "unlimited". | |
3261 | ||
3262 | And, if delay pool number 2 is a class 3 delay pool as in the above | |
3263 | example, and you want to limit it to a total of 256kbps (strict limit) | |
3264 | with each 8-bit network permitted 64kbps (strict limit) and each | |
3265 | individual host permitted 4800bps with a bucket maximum size of 64kb | |
3266 | to permit a decent web page to be downloaded at a decent speed | |
3267 | (if the network is not being limited due to overuse) but slow down | |
3268 | large downloads more significantly: | |
3269 | ||
3270 | delay_parameters 2 32000/32000 8000/8000 600/64000 | |
3271 | ||
3272 | There must be one delay_parameters line for each delay pool. | |
95e36d02 | 3273 | DOC_END |
3274 | ||
59715b38 | 3275 | NAME: delay_initial_bucket_level |
3276 | COMMENT: (percent, 0-100) | |
3277 | TYPE: ushort | |
3278 | DEFAULT: 50 | |
95e36d02 | 3279 | IFDEF: DELAY_POOLS |
59715b38 | 3280 | LOC: Config.Delay.initial |
95e36d02 | 3281 | DOC_START |
59715b38 | 3282 | The initial bucket percentage is used to determine how much is put |
3283 | in each bucket when squid starts, is reconfigured, or first notices | |
3284 | a host accessing it (in class 2 and class 3, individual hosts and | |
3285 | networks only have buckets associated with them once they have been | |
3286 | "seen" by squid). | |
95e36d02 | 3287 | DOC_END |
6be2389e | 3288 | |
9cd6c6fb | 3289 | NAME: incoming_icp_average |
6be2389e | 3290 | TYPE: int |
3291 | DEFAULT: 6 | |
3292 | LOC: Config.comm_incoming.icp_average | |
3293 | DOC_NONE | |
3294 | ||
9cd6c6fb | 3295 | NAME: incoming_http_average |
6be2389e | 3296 | TYPE: int |
3297 | DEFAULT: 4 | |
3298 | LOC: Config.comm_incoming.http_average | |
3299 | DOC_NONE | |
3300 | ||
afc28c12 | 3301 | NAME: incoming_dns_average |
3302 | TYPE: int | |
3303 | DEFAULT: 4 | |
3304 | LOC: Config.comm_incoming.dns_average | |
3305 | DOC_NONE | |
3306 | ||
9cd6c6fb | 3307 | NAME: min_icp_poll_cnt |
6be2389e | 3308 | TYPE: int |
3309 | DEFAULT: 8 | |
3310 | LOC: Config.comm_incoming.icp_min_poll | |
3311 | DOC_NONE | |
3312 | ||
afc28c12 | 3313 | NAME: min_dns_poll_cnt |
3314 | TYPE: int | |
3315 | DEFAULT: 8 | |
3316 | LOC: Config.comm_incoming.dns_min_poll | |
3317 | DOC_NONE | |
3318 | ||
9cd6c6fb | 3319 | NAME: min_http_poll_cnt |
6be2389e | 3320 | TYPE: int |
3321 | DEFAULT: 8 | |
3322 | LOC: Config.comm_incoming.http_min_poll | |
3323 | DOC_START | |
b6a2f15e | 3324 | Heavy voodoo here. I can't even believe you are reading this. |
6be2389e | 3325 | Are you crazy? Don't even think about adjusting these unless |
3326 | you understand the algorithms in comm_select.c first! | |
3327 | DOC_END | |
2b4283e4 | 3328 | |
c5f627c2 | 3329 | NAME: max_open_disk_fds |
3330 | TYPE: int | |
3331 | LOC: Config.max_open_disk_fds | |
3332 | DEFAULT: 0 | |
6b53c392 | 3333 | DOC_START |
3334 | To avoid having disk as the I/O bottleneck Squid can optionally | |
3335 | bypass the on-disk cache if more than this amount of disk file | |
3336 | descriptors are open. | |
3337 | ||
3338 | A value of 0 indicates no limit. | |
3339 | DOC_END | |
c5f627c2 | 3340 | |
b540e168 | 3341 | NAME: offline_mode |
3342 | TYPE: onoff | |
3343 | LOC: Config.onoff.offline | |
3344 | DEFAULT: off | |
3345 | DOC_START | |
3346 | Enable this option and Squid will never try to validate cached | |
3347 | objects. | |
3348 | DOC_END | |
3349 | ||
d548ee64 | 3350 | NAME: uri_whitespace |
3351 | TYPE: uri_whitespace | |
3352 | LOC: Config.uri_whitespace | |
7e3ce7b9 | 3353 | DEFAULT: strip |
d548ee64 | 3354 | DOC_START |
3355 | What to do with requests that have whitespace characters in the | |
3356 | URI. Options: | |
3357 | ||
7e3ce7b9 | 3358 | strip: The whitespace characters are stripped out of the URL. |
3359 | This is the behavior recommended by RFC2616. | |
d548ee64 | 3360 | deny: The request is denied. The user receives an "Invalid |
3361 | Request" message. | |
3362 | allow: The request is allowed and the URI is not changed. The | |
3363 | whitespace characters remain in the URI. Note the | |
3364 | whitespace is passed to redirector processes if they | |
3365 | are in use. | |
3366 | encode: The request is allowed and the whitespace characters are | |
3367 | encoded according to RFC1738. This could be considered | |
3368 | a violation of the HTTP/1.1 | |
3369 | RFC because proxies are not allowed to rewrite URI's. | |
3370 | chop: The request is allowed and the URI is chopped at the | |
3371 | first whitespace. This might also be considered a | |
3372 | violation. | |
d548ee64 | 3373 | DOC_END |
3374 | ||
376bb137 | 3375 | NAME: broken_posts |
3376 | TYPE: acl_access | |
3377 | DEFAULT: none | |
3378 | LOC: Config.accessList.brokenPosts | |
c68e9c6b | 3379 | DOC_START |
376bb137 | 3380 | A list of ACL elements which, if matched, causes Squid to send |
3381 | a extra CRLF pair after the body of a PUT/POST request. | |
3382 | ||
3383 | Some HTTP servers has broken implementations of PUT/POST, | |
3384 | and rely on a extra CRLF pair sent by some WWW clients. | |
3385 | ||
3386 | Quote from RFC 2068 section 4.1 on this matter: | |
3387 | ||
3388 | Note: certain buggy HTTP/1.0 client implementations generate an | |
3389 | extra CRLF's after a POST request. To restate what is explicitly | |
3390 | forbidden by the BNF, an HTTP/1.1 client must not preface or follow | |
3391 | a request with an extra CRLF. | |
3392 | ||
6b53c392 | 3393 | Example: |
3394 | acl buggy_server url_regex ^http://.... | |
3395 | broken_posts allow buggy_server | |
c68e9c6b | 3396 | DOC_END |
9b094667 | 3397 | |
e66d7923 | 3398 | NAME: mcast_miss_addr |
3399 | IFDEF: MULTICAST_MISS_STREAM | |
3400 | TYPE: address | |
3401 | LOC: Config.mcast_miss.addr | |
3402 | DEFAULT: 255.255.255.255 | |
b6a2f15e | 3403 | DOC_START |
3404 | If you enable this option, every "cache miss" URL will | |
3405 | be sent out on the specified multicast address. | |
3406 | ||
3407 | Do not enable this option unless you are are absolutely | |
3408 | certain you understand what you are doing. | |
3409 | DOC_END | |
e66d7923 | 3410 | |
7e3ce7b9 | 3411 | NAME: mcast_miss_ttl |
3412 | IFDEF: MULTICAST_MISS_TTL | |
3413 | TYPE: ushort | |
3414 | LOC: Config.mcast_miss.ttl | |
3415 | DEFAULT: 16 | |
3416 | DOC_START | |
3417 | This is the time-to-live value for packets multicasted | |
3418 | when multicasting off cache miss URLs is enabled. By | |
3419 | default this is set to 'site scope', i.e. 16. | |
3420 | DOC_END | |
3421 | ||
e66d7923 | 3422 | NAME: mcast_miss_port |
3423 | IFDEF: MULTICAST_MISS_STREAM | |
3424 | TYPE: ushort | |
3425 | LOC: Config.mcast_miss.port | |
3426 | DEFAULT: 3135 | |
b6a2f15e | 3427 | DOC_START |
efd900cb | 3428 | This is the port number to be used in conjunction with |
b6a2f15e | 3429 | 'mcast_miss_addr'. |
3430 | DOC_END | |
e66d7923 | 3431 | |
3432 | NAME: mcast_miss_encode_key | |
3433 | IFDEF: MULTICAST_MISS_STREAM | |
3434 | TYPE: string | |
3435 | LOC: Config.mcast_miss.encode_key | |
3436 | DEFAULT: XXXXXXXXXXXXXXXX | |
b6a2f15e | 3437 | DOC_START |
3438 | The URLs that are sent in the multicast miss stream are | |
3439 | encrypted. This is the encryption key. | |
3440 | DOC_END | |
e66d7923 | 3441 | |
168dfda9 | 3442 | NAME: nonhierarchical_direct |
3443 | TYPE: onoff | |
3444 | LOC: Config.onoff.nonhierarchical_direct | |
3445 | DEFAULT: on | |
3446 | DOC_START | |
3447 | By default, Squid will send any non-hierarchical requests | |
3448 | (matching hierarchy_stoplist or not cachable request type) direct | |
3449 | to origin servers. | |
3450 | ||
3451 | If you set this to off, then Squid will prefer to send these | |
3452 | requests to parents. | |
3453 | ||
3454 | Note that in most configurations, by turning this off you will only | |
3455 | add latency to these request without any improvement in global hit | |
3456 | ratio. | |
3457 | ||
3458 | If you are inside an firewall then see never_direct instead of | |
3459 | this directive. | |
168dfda9 | 3460 | DOC_END |
3461 | ||
9b094667 | 3462 | NAME: prefer_direct |
3463 | TYPE: onoff | |
3464 | LOC: Config.onoff.prefer_direct | |
168dfda9 | 3465 | DEFAULT: off |
9b094667 | 3466 | DOC_START |
168dfda9 | 3467 | Normally Squid tries to use parents for most requests. If you by some |
3468 | reason like it to first try going direct and only use a parent if | |
3469 | going direct fails then set this to off. | |
3470 | ||
3471 | By combining nonhierarchical_direct off and prefer_direct on you | |
3472 | can set up Squid to use a parent as a backup path if going direct | |
3473 | fails. | |
9b094667 | 3474 | DOC_END |
4d62b0af | 3475 | |
bcbc11b0 | 3476 | NAME: strip_query_terms |
3477 | TYPE: onoff | |
3478 | LOC: Config.onoff.strip_query_terms | |
3479 | DEFAULT: on | |
3480 | DOC_START | |
3481 | By default, Squid strips query terms from requested URLs before | |
3482 | logging. This protects your user's privacy. | |
bcbc11b0 | 3483 | DOC_END |
3484 | ||
b6a2f15e | 3485 | NAME: coredump_dir |
3486 | TYPE: string | |
3487 | LOC: Config.coredump_dir | |
3488 | DEFAULT: none | |
5ff76111 | 3489 | DEFAULT_IF_NONE: none |
b6a2f15e | 3490 | DOC_START |
5ff76111 | 3491 | By default Squid leaves core files in the directory from where |
3492 | it was started. If you set 'coredump_dir' to a directory | |
b6a2f15e | 3493 | that exists, Squid will chdir() to that directory at startup |
3494 | and coredump files will be left there. | |
5ff76111 | 3495 | |
3496 | NOCOMMENT_START | |
3497 | # Leave coredumps in the first cache dir | |
3498 | coredump_dir @DEFAULT_SWAP_DIR@ | |
3499 | NOCOMMENT_END | |
b6a2f15e | 3500 | DOC_END |
3501 | ||
07476a7f | 3502 | NAME: redirector_bypass |
3503 | TYPE: onoff | |
3504 | LOC: Config.onoff.redirector_bypass | |
3505 | DEFAULT: off | |
3506 | DOC_START | |
3507 | When this is 'on', a request will not go through the | |
3508 | redirector if all redirectors are busy. If this is 'off' | |
3509 | and the redirector queue grows too large, Squid will exit | |
29de1a20 | 3510 | with a FATAL error and ask you to increase the number of |
07476a7f | 3511 | redirectors. You should only enable this if the redirectors |
3512 | are not critical to your caching system. If you use | |
3513 | redirectors for access control, and you enable this option, | |
3514 | then users may have access to pages that they should not | |
3515 | be allowed to request. | |
3516 | DOC_END | |
3517 | ||
9bc73deb | 3518 | NAME: ignore_unknown_nameservers |
3519 | TYPE: onoff | |
3520 | LOC: Config.onoff.ignore_unknown_nameservers | |
3521 | DEFAULT: on | |
3522 | DOC_START | |
3523 | By default Squid checks that DNS responses are received | |
3524 | from the same IP addresses that they are sent to. If they | |
3525 | don't match, Squid ignores the response and writes a warning | |
3526 | message to cache.log. You can allow responses from unknown | |
3527 | nameservers by setting this option to 'off'. | |
9bc73deb | 3528 | DOC_END |
3529 | ||
7e3ce7b9 | 3530 | NAME: digest_generation |
3531 | IFDEF: USE_CACHE_DIGESTS | |
3532 | TYPE: onoff | |
3533 | LOC: Config.onoff.digest_generation | |
3534 | DEFAULT: on | |
3535 | DOC_START | |
3536 | This controls whether the server will generate a Cache Digest | |
3537 | of its contents. By default, Cache Digest generation is | |
3538 | enabled if Squid is compiled with USE_CACHE_DIGESTS defined. | |
7e3ce7b9 | 3539 | DOC_END |
3540 | ||
3541 | NAME: digest_bits_per_entry | |
3542 | IFDEF: USE_CACHE_DIGESTS | |
3543 | TYPE: int | |
3544 | LOC: Config.digest.bits_per_entry | |
3545 | DEFAULT: 5 | |
3546 | DOC_START | |
3547 | This is the number of bits of the server's Cache Digest which | |
3548 | will be associated with the Digest entry for a given HTTP | |
3549 | Method and URL (public key) combination. The default is 5. | |
7e3ce7b9 | 3550 | DOC_END |
3551 | ||
3552 | NAME: digest_rebuild_period | |
3553 | IFDEF: USE_CACHE_DIGESTS | |
efd900cb | 3554 | COMMENT: (seconds) |
3555 | TYPE: time_t | |
7e3ce7b9 | 3556 | LOC: Config.digest.rebuild_period |
efd900cb | 3557 | DEFAULT: 1 hour |
7e3ce7b9 | 3558 | DOC_START |
3559 | This is the number of seconds between Cache Digest rebuilds. | |
7e3ce7b9 | 3560 | DOC_END |
3561 | ||
3562 | NAME: digest_rewrite_period | |
efd900cb | 3563 | COMMENT: (seconds) |
7e3ce7b9 | 3564 | IFDEF: USE_CACHE_DIGESTS |
efd900cb | 3565 | TYPE: time_t |
7e3ce7b9 | 3566 | LOC: Config.digest.rewrite_period |
efd900cb | 3567 | DEFAULT: 1 hour |
7e3ce7b9 | 3568 | DOC_START |
3569 | This is the number of seconds between Cache Digest writes to | |
6b53c392 | 3570 | disk. |
7e3ce7b9 | 3571 | DOC_END |
3572 | ||
3573 | NAME: digest_swapout_chunk_size | |
efd900cb | 3574 | COMMENT: (bytes) |
3575 | TYPE: b_size_t | |
7e3ce7b9 | 3576 | IFDEF: USE_CACHE_DIGESTS |
7e3ce7b9 | 3577 | LOC: Config.digest.swapout_chunk_size |
efd900cb | 3578 | DEFAULT: 4096 bytes |
7e3ce7b9 | 3579 | DOC_START |
3580 | This is the number of bytes of the Cache Digest to write to | |
efd900cb | 3581 | disk at a time. It defaults to 4096 bytes (4KB), the Squid |
3582 | default swap page. | |
7e3ce7b9 | 3583 | DOC_END |
3584 | ||
3585 | NAME: digest_rebuild_chunk_percentage | |
efd900cb | 3586 | COMMENT: (percent, 0-100) |
7e3ce7b9 | 3587 | IFDEF: USE_CACHE_DIGESTS |
3588 | TYPE: int | |
3589 | LOC: Config.digest.rebuild_chunk_percentage | |
3590 | DEFAULT: 10 | |
3591 | DOC_START | |
efd900cb | 3592 | This is the percentage of the Cache Digest to be scanned at a |
3593 | time. By default it is set to 10% of the Cache Digest. | |
7e3ce7b9 | 3594 | DOC_END |
3595 | ||
efd900cb | 3596 | NAME: chroot |
3597 | TYPE: string | |
3598 | LOC: Config.chroot_dir | |
3599 | DEFAULT: none | |
3600 | DOC_START | |
3601 | Use this to have Squid do a chroot() while initializing. This | |
3602 | also causes Squid to fully drop root privileges after | |
3603 | initializing. This means, for example, that if you use a HTTP | |
3604 | port less than 1024 and try to reconfigure, you will get an | |
3605 | error. | |
3606 | DOC_END | |
efd900cb | 3607 | |
3608 | NAME: client_persistent_connections | |
3609 | TYPE: onoff | |
3610 | LOC: Config.onoff.client_pconns | |
3611 | DEFAULT: on | |
3612 | DOC_NONE | |
3613 | ||
3614 | NAME: server_persistent_connections | |
3615 | TYPE: onoff | |
3616 | LOC: Config.onoff.server_pconns | |
3617 | DEFAULT: on | |
3618 | DOC_START | |
3619 | Persistent connection support for clients and servers. By | |
3620 | default, Squid uses persistent connections (when allowed) | |
3621 | with its clients and servers. You can use these options to | |
3622 | disable persistent connections with clients and/or servers. | |
efd900cb | 3623 | DOC_END |
9d24d603 | 3624 | |
3d15e2d7 | 3625 | NAME: pipeline_prefetch |
3626 | TYPE: onoff | |
3627 | LOC: Config.onoff.pipeline_prefetch | |
3628 | DEFAULT: on | |
3629 | DOC_START | |
3630 | To boost the performance of pipelined requests to closer | |
3631 | match that of a non-proxied environment Squid tries to fetch | |
3632 | up to two requests in parallell from a pipeline. | |
3633 | DOC_END | |
3634 | ||
56fe752e | 3635 | NAME: extension_methods |
3636 | TYPE: wordlist | |
3637 | LOC: Config.ext_methods | |
3638 | DEFAULT: none | |
3639 | DOC_START | |
3640 | Squid only knows about standardized HTTP request methods. | |
3641 | You can add up to 20 additional "extension" methods here. | |
3642 | DOC_END | |
3643 | ||
b8a46de0 | 3644 | NAME: high_response_time_warning |
3645 | TYPE: int | |
3646 | COMMENT: (msec) | |
3647 | LOC: Config.warnings.high_rptm | |
3648 | DEFAULT: 0 | |
3649 | DOC_START | |
3650 | If the one-minute median response time exceeds this value, | |
3651 | Squid prints a WARNING with debug level 0 to get the | |
3652 | administrators attention. The value is in milliseconds. | |
3653 | DOC_END | |
3654 | ||
3655 | NAME: high_page_fault_warning | |
3656 | TYPE: int | |
3657 | LOC: Config.warnings.high_pf | |
3658 | DEFAULT: 0 | |
3659 | DOC_START | |
3660 | If the one-minute average page fault rate exceeds this | |
3661 | value, Squid prints a WARNING with debug level 0 to get | |
3662 | the administrators attention. The value is in page faults | |
3663 | per second. | |
3664 | DOC_END | |
3665 | ||
3666 | NAME: high_memory_warning | |
3667 | TYPE: b_size_t | |
3668 | LOC: Config.warnings.high_memory | |
3669 | DEFAULT: 0 | |
3670 | DOC_START | |
3671 | If the memory usage (as determined by mallinfo) exceeds | |
3672 | value, Squid prints a WARNING with debug level 0 to get | |
3673 | the administrators attention. | |
3674 | DOC_END | |
3675 | ||
65a53c8e | 3676 | NAME: store_dir_select_algorithm |
3677 | TYPE: string | |
3678 | LOC: Config.store_dir_select_algorithm | |
3679 | DEFAULT: least-load | |
3680 | DOC_START | |
3681 | Set this to 'round-robin' as an alternative. | |
3682 | DOC_END | |
3683 | ||
225644d7 | 3684 | NAME: forward_log |
3685 | IFDEF: WIP_FWD_LOG | |
3686 | TYPE: string | |
3687 | DEFAULT: none | |
3688 | LOC: Config.Log.forward | |
3689 | DOC_START | |
3690 | Logs the server-side requests. | |
3691 | ||
3692 | This is currently work in progress. | |
3693 | DOC_END | |
3694 | ||
7613d09c | 3695 | NAME: ie_refresh |
3696 | COMMENT: on|off | |
3697 | TYPE: onoff | |
3698 | LOC: Config.onoff.ie_refresh | |
3699 | DEFAULT: off | |
3700 | DOC_START | |
3701 | Microsoft Internet Explorer up until version 5.5 Service | |
3702 | Pack 1 has an issue with transparent proxies, wherein it | |
3703 | is impossible to force a refresh. Turning this on provides | |
3704 | a partial fix to the problem, by causing all IMS-REFRESH | |
3705 | requests from older IE versions to check the origin server | |
3706 | for fresh content. This reduces hit ratio by some amount | |
3707 | (~10% in my experience), but allows users to actually get | |
3708 | fresh content when they want it. Note that because Squid | |
3709 | cannot tell if the user is using 5.5 or 5.5SP1, the behavior | |
3710 | of 5.5 is unchanged from old versions of Squid (i.e. a | |
3711 | forced refresh is impossible). Newer versions of IE will, | |
3712 | hopefully, continue to have the new behavior and will be | |
3713 | handled based on that assumption. This option defaults to | |
3714 | the old Squid behavior, which is better for hit ratios but | |
3715 | worse for clients using IE, if they need to be able to | |
3716 | force fresh content. | |
3717 | DOC_END | |
3718 | ||
f66a9ef4 | 3719 | NAME: vary_ignore_expire |
3720 | COMMENT: on|off | |
3721 | TYPE: onoff | |
3722 | LOC: Config.onoff.vary_ignore_expire | |
3723 | DEFAULT: off | |
3724 | DOC_START | |
3725 | Many HTTP servers supporting Vary gives such objects | |
3726 | immediate expiry time with no cache-control header | |
3727 | when requested by a HTTP/1.0 client. This option | |
3728 | enables Squid to ignore such expiry times until | |
3729 | HTTP/1.1 is fully implemented. | |
3730 | WARNING: This may eventually cause some varying | |
3731 | objects not intended for caching to get cached. | |
3732 | DOC_END | |
3733 | ||
d1ec12c7 | 3734 | NAME: sleep_after_fork |
3735 | COMMENT: (microseconds) | |
3736 | TYPE: int | |
3737 | LOC: Config.sleep_after_fork | |
3738 | DEFAULT: 0 | |
3739 | DOC_START | |
96d88dcb | 3740 | When this is set to a non-zero value, the main Squid process |
3741 | sleeps the specified number of microseconds after a fork() | |
3742 | system call. This sleep may help the situation where your | |
3743 | system reports fork() failures due to lack of (virtual) | |
3744 | memory. Note, however, that if you have a lot of child | |
3745 | processes, then these sleep delays will add up and your | |
3746 | Squid will not service requests for some amount of time | |
3747 | until all the child processes have been started. | |
d1ec12c7 | 3748 | DOC_END |
1fbbdcb0 | 3749 | |
2b4283e4 | 3750 | EOF |