]>
Commit | Line | Data |
---|---|---|
3a278cb8 | 1 | |
9cef6668 | 2 | # |
710df4ca | 3 | # $Id: cf.data.pre,v 1.128 1998/12/04 16:37:07 wessels Exp $ |
9cef6668 | 4 | # |
5 | # | |
6 | # SQUID Internet Object Cache http://squid.nlanr.net/Squid/ | |
7 | # ---------------------------------------------------------- | |
8 | # | |
9 | # Squid is the result of efforts by numerous individuals from the | |
10 | # Internet community. Development is led by Duane Wessels of the | |
11 | # National Laboratory for Applied Network Research and funded by the | |
12 | # National Science Foundation. Squid is Copyrighted (C) 1998 by | |
13 | # Duane Wessels and the University of California San Diego. Please | |
14 | # see the COPYRIGHT file for full details. Squid incorporates | |
15 | # software developed and/or copyrighted by other sources. Please see | |
16 | # the CREDITS file for full details. | |
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. | |
22 | # | |
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. | |
27 | # | |
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 |
b58b1ad6 | 38 | to look at http://cache.is.co.za/squid/ for documentation, |
39 | or the Squid home page (http://squid.nlanr.net/) for the FAQ. | |
3a278cb8 | 40 | |
0f74202c | 41 | COMMENT_END |
3a278cb8 | 42 | |
0f74202c | 43 | COMMENT_START |
3a278cb8 | 44 | NETWORK OPTIONS |
45 | ----------------------------------------------------------------------------- | |
0f74202c | 46 | COMMENT_END |
3a278cb8 | 47 | |
934b03fc | 48 | NAME: http_port ascii_port |
49 | TYPE: ushortlist | |
f53b06f9 | 50 | DEFAULT: none |
51 | DEFAULT_IF_NONE: 3128 | |
934b03fc | 52 | LOC: Config.Port.http |
53 | DOC_START | |
cf5cc17e | 54 | The port number where Squid will listen for HTTP client |
934b03fc | 55 | requests. Default is 3128, for httpd-accel mode use port 80. |
56 | May be overridden with -a on the command line. | |
57 | ||
58 | You may specify multiple ports here, but they MUST all be on | |
59 | a single line. | |
60 | ||
61 | http_port 3128 | |
62 | DOC_END | |
63 | ||
64 | ||
65 | NAME: icp_port udp_port | |
66 | TYPE: ushort | |
67 | DEFAULT: 3130 | |
68 | LOC: Config.Port.icp | |
69 | DOC_START | |
459f1836 | 70 | The port number where Squid sends and receives ICP requests to |
934b03fc | 71 | and from neighbor caches. Default is 3130. To disable use |
72 | "0". May be overridden with -u on the command line. | |
73 | ||
74 | icp_port 3130 | |
75 | DOC_END | |
76 | ||
459f1836 | 77 | NAME: htcp_port |
78 | IFDEF: USE_HTCP | |
79 | TYPE: ushort | |
80 | DEFAULT: 4827 | |
81 | LOC: Config.Port.htcp | |
82 | DOC_START | |
83 | The port number where Squid sends and receives ICP requests to | |
84 | and from neighbor caches. Default is 4827. To disable use | |
85 | "0". | |
86 | ||
87 | htcp_port 4827 | |
88 | DOC_END | |
89 | ||
934b03fc | 90 | |
91 | NAME: mcast_groups | |
92 | TYPE: wordlist | |
93 | LOC: Config.mcast_group_list | |
1273d501 | 94 | DEFAULT: none |
934b03fc | 95 | DOC_START |
cf5cc17e | 96 | This tag specifies a list of multicast groups which your server |
97 | should join to receive multicasted ICP requests. | |
934b03fc | 98 | |
99 | NOTE! Be very careful what you put here! Be sure you | |
100 | understand the difference between an ICP _query_ and an ICP | |
101 | _reply_. This option is to be set only if you want to RECEIVE | |
102 | multicast queries. Do NOT set this option to SEND multicast | |
a95856a0 | 103 | ICP (use cache_peer for that). ICP replies are always sent via |
934b03fc | 104 | unicast, so this option does not affect whether or not you will |
105 | receive replies from multicast group members. | |
106 | ||
107 | You must be very careful to NOT use a multicast address which | |
108 | is already in use by another group of caches. NLANR has been | |
109 | assigned a block of multicast address space for use in Web | |
110 | Caching. Plese write to us at nlanr-cache@nlanr.net to receive | |
111 | an address for your own use. | |
112 | ||
cf5cc17e | 113 | If you are unsure about multicast, please read the Multicast |
114 | chapter in the Squid FAQ (http://squid.nlanr.net/Squid/FAQ/). | |
115 | ||
934b03fc | 116 | Usage: mcast_groups 239.128.16.128 224.0.1.20 |
117 | ||
cf5cc17e | 118 | By default, Squid doesn't listen on any multicast groups. |
934b03fc | 119 | |
120 | mcast_groups 239.128.16.128 | |
121 | DOC_END | |
122 | ||
123 | ||
124 | NAME: tcp_incoming_address bind_address | |
125 | TYPE: address | |
126 | LOC: Config.Addrs.tcp_incoming | |
270b86af | 127 | DEFAULT: 0.0.0.0 |
934b03fc | 128 | DOC_NONE |
129 | ||
130 | NAME: tcp_outgoing_address outbound_address | |
131 | TYPE: address | |
132 | LOC: Config.Addrs.tcp_outgoing | |
270b86af | 133 | DEFAULT: 255.255.255.255 |
934b03fc | 134 | DOC_NONE |
135 | ||
136 | NAME: udp_incoming_address | |
137 | TYPE: address | |
138 | LOC:Config.Addrs.udp_incoming | |
270b86af | 139 | DEFAULT: 0.0.0.0 |
934b03fc | 140 | DOC_NONE |
141 | ||
142 | NAME: udp_outgoing_address | |
143 | TYPE: address | |
144 | LOC: Config.Addrs.udp_outgoing | |
270b86af | 145 | DEFAULT: 255.255.255.255 |
934b03fc | 146 | DOC_START |
147 | Usage: tcp_incoming_address 10.20.30.40 | |
148 | udp_outgoing_address fully.qualified.domain.name | |
149 | ||
934b03fc | 150 | tcp_incoming_address is used for the HTTP socket which accepts |
151 | connections from clients and other caches. | |
152 | tcp_outgoing_address is used for connections made to remote | |
153 | servers and other caches. | |
154 | udp_incoming_address is used for the ICP socket receiving packets | |
155 | from other caches. | |
156 | udp_outgoing_address is used for ICP packets sent out to other | |
157 | caches. | |
158 | ||
15dcc168 | 159 | The default behaviour is to not bind to any specific address. |
934b03fc | 160 | |
5a3f6538 | 161 | NOTE, udp_incoming_address and udp_outgoing_address can not |
162 | have the same value (unless it is 0.0.0.0) since they both use | |
163 | port 3130. | |
934b03fc | 164 | |
165 | tcp_incoming_address 0.0.0.0 | |
166 | tcp_outgoing_address 0.0.0.0 | |
167 | udp_incoming_address 0.0.0.0 | |
168 | udp_outgoing_address 0.0.0.0 | |
169 | DOC_END | |
170 | ||
0f74202c | 171 | COMMENT_START |
3a278cb8 | 172 | OPTIONS WHICH AFFECT THE NEIGHBOR SELECTION ALGORITHM |
173 | ----------------------------------------------------------------------------- | |
0f74202c | 174 | COMMENT_END |
934b03fc | 175 | |
40a1495e | 176 | NAME: cache_peer |
177 | TYPE: peer | |
1273d501 | 178 | DEFAULT: none |
0153d498 | 179 | LOC: Config.peers |
934b03fc | 180 | DOC_START |
181 | To specify other caches in a hierarchy, use the format: | |
182 | ||
183 | hostname type http_port icp_port | |
184 | ||
d0d41f07 | 185 | For example, |
934b03fc | 186 | |
187 | # proxy icp | |
188 | # hostname type port port options | |
189 | # -------------------- -------- ----- ----- ----------- | |
cf5cc17e | 190 | cache_peer parent.foo.net parent 3128 3130 [proxy-only] |
191 | cache_peer sib1.foo.net sibling 3128 3130 [proxy-only] | |
192 | cache_peer sib2.foo.net sibling 3128 3130 [proxy-only] | |
934b03fc | 193 | |
194 | type: either 'parent', 'sibling', or 'multicast'. | |
195 | ||
196 | proxy_port: The port number where the cache listens for proxy | |
197 | requests. | |
198 | ||
199 | icp_port: Used for querying neighbor caches about | |
200 | objects. To have a non-ICP neighbor | |
201 | specify '7' for the ICP port and make sure the | |
202 | neighbor machine has the UDP echo port | |
203 | enabled in its /etc/inetd.conf file. | |
204 | ||
205 | options: proxy-only | |
206 | weight=n | |
207 | ttl=n | |
208 | no-query | |
209 | default | |
210 | round-robin | |
211 | multicast-responder | |
b3264694 | 212 | closest-only |
46b034a4 | 213 | no-digest |
223213df | 214 | no-netdb-exchange |
95e36d02 | 215 | no-delay |
c68e9c6b | 216 | login=user:password |
934b03fc | 217 | |
218 | use 'proxy-only' to specify that objects fetched | |
219 | from this cache should not be saved locally. | |
220 | ||
221 | use 'weight=n' to specify a weighted parent. | |
222 | The weight must be an integer. The default weight | |
223 | is 1, larger weights are favored more. | |
224 | ||
225 | use 'ttl=n' to specify a IP multicast TTL to use | |
226 | when sending an ICP request to this address. | |
227 | Only useful when sending to a multicast group. | |
228 | Because we don't accept ICP replies from random | |
229 | hosts, you must configure other group members as | |
230 | peers with the 'multicast-responder' option below. | |
231 | ||
232 | use 'no-query' to NOT send ICP queries to this | |
233 | neighbor. | |
234 | ||
235 | use 'default' if this is a parent cache which can | |
236 | be used as a "last-resort." You should probably | |
237 | only use 'default' in situations where you cannot | |
238 | use ICP with your parent cache(s). | |
239 | ||
240 | use 'round-robin' to define a set of parents which | |
241 | should be used in a round-robin fashion in the | |
242 | absence of any ICP queries. | |
243 | ||
244 | 'multicast-responder' indicates that the named peer | |
245 | is a member of a multicast group. ICP queries will | |
246 | not be sent directly to the peer, but ICP replies | |
247 | will be accepted from it. | |
248 | ||
b3264694 | 249 | 'closest-only' indicates that, for ICP_OP_MISS |
250 | replies, we'll only forward CLOSEST_PARENT_MISSes | |
251 | and never FIRST_PARENT_MISSes. | |
252 | ||
46b034a4 | 253 | use 'no-digest' to NOT request cache digests from |
254 | this neighbor. | |
255 | ||
223213df | 256 | 'no-netdb-exchange' disables requesting ICMP |
257 | RTT database (NetDB) from the neighbor. | |
258 | ||
95e36d02 | 259 | use 'no-delay' to prevent access to this neighbor |
260 | from influencing the delay pools. | |
261 | ||
c68e9c6b | 262 | use 'login=user:password' if this is a personal/workgroup |
263 | proxy and your parent requires proxy authentication. | |
264 | ||
934b03fc | 265 | NOTE: non-ICP neighbors must be specified as 'parent'. |
266 | ||
a95856a0 | 267 | cache_peer hostname type 3128 3130 |
934b03fc | 268 | DOC_END |
269 | ||
270 | ||
af7d912e | 271 | NAME: cache_peer_domain cache_host_domain |
934b03fc | 272 | TYPE: hostdomain |
f1dc9b30 | 273 | DEFAULT: none |
274 | LOC: none | |
934b03fc | 275 | DOC_START |
cf5cc17e | 276 | Use to limit the domains for which a neighbor cache will be |
277 | queried. Usage: | |
934b03fc | 278 | |
af7d912e | 279 | cache_peer_domain cache-host domain [domain ...] |
280 | cache_peer_domain cache-host !domain | |
934b03fc | 281 | |
282 | For example, specifying | |
283 | ||
af7d912e | 284 | cache_peer_domain parent.foo.net .edu |
934b03fc | 285 | |
286 | has the effect such that UDP query packets are sent to | |
287 | 'bigserver' only when the requested object exists on a | |
288 | server in the .edu domain. Prefixing the domainname | |
289 | with '!' means that the cache will be queried for objects | |
290 | NOT in that domain. | |
291 | ||
292 | NOTE: * Any number of domains may be given for a cache-host, | |
293 | either on the same or separate lines. | |
294 | * When multiple domains are given for a particular | |
295 | cache-host, the first matched domain is applied. | |
296 | * Cache hosts with no domain restrictions are queried | |
297 | for all requests. | |
298 | * There are no defaults. | |
3794b2b6 | 299 | * There is also a 'cache_peer_access' tag in the ACL |
934b03fc | 300 | section. |
301 | DOC_END | |
302 | ||
303 | ||
304 | NAME: neighbor_type_domain | |
305 | TYPE: hostdomaintype | |
f1dc9b30 | 306 | DEFAULT: none |
307 | LOC: none | |
934b03fc | 308 | DOC_START |
309 | usage: neighbor_type_domain parent|sibling domain domain ... | |
310 | ||
311 | Modifying the neighbor type for specific domains is now | |
312 | possible. You can treat some domains differently than the the | |
a95856a0 | 313 | default neighbor type specified on the 'cache_peer' line. |
934b03fc | 314 | Normally it should only be necessary to list domains which |
315 | should be treated differently because the default neighbor type | |
316 | applies for hostnames which do not match domains listed here. | |
317 | ||
318 | EXAMPLE: | |
a95856a0 | 319 | cache_peer parent cache.foo.org 3128 3130 |
934b03fc | 320 | neighbor_type_domain cache.foo.org sibling .com .net |
321 | neighbor_type_domain cache.foo.org sibling .au .de | |
322 | DOC_END | |
323 | ||
465dc415 | 324 | NAME: icp_query_timeout |
325 | COMMENT: (msec) | |
326 | DEFAULT: 0 | |
327 | TYPE: int | |
328 | LOC: Config.Timeout.icp_query | |
934b03fc | 329 | DOC_START |
465dc415 | 330 | Normally Squid will automatically determine an optimal ICP |
331 | query timeout value based on the round-trip-time of recent ICP | |
332 | queries. If you want to override the value determined by | |
333 | Squid, set this 'icp_query_timeout' to a non-zero value. This | |
334 | value is specified in MILLISECONDS, so, to use a 2-second | |
335 | timeout (the old default), you would write: | |
934b03fc | 336 | |
465dc415 | 337 | icp_query_timeout 2000 |
338 | ||
339 | icp_query_timeout 0 | |
340 | DOC_END | |
341 | ||
342 | NAME: mcast_icp_query_timeout | |
343 | COMMENT: (msec) | |
344 | DEFAULT: 2000 | |
345 | TYPE: int | |
346 | LOC: Config.Timeout.mcast_icp_query | |
347 | DOC_START | |
348 | For Multicast peers, Squid regularly sends out ICP "probes" to | |
349 | count how many other peers are listening on the given multicast | |
350 | address. This value specifies how long Squid should wait to | |
351 | count all the replies. The default is 2000 msec, or 2 | |
352 | seconds. | |
353 | ||
354 | mcast_icp_query_timeout 2000 | |
934b03fc | 355 | DOC_END |
356 | ||
dc835977 | 357 | NAME: dead_peer_timeout |
358 | COMMENT: (seconds) | |
359 | DEFAULT: 10 seconds | |
360 | TYPE: time_t | |
361 | LOC: Config.Timeout.deadPeer | |
362 | DOC_START | |
363 | This controls how long Squid waits to declare a peer cache | |
364 | as "dead." If there are no ICP replies received in this | |
365 | amount of time, Squid will declare the peer dead and not | |
366 | expect to receive any further ICP replies. However, it | |
367 | continues to send ICP queries, and will mark the peer as | |
368 | alive upon receipt of the first subsequent ICP reply. | |
369 | ||
a8ad9a81 | 370 | This timeout also affects when Squid expects to receive ICP |
371 | replies from peers. If more than 'dead_peer' seconds have | |
372 | passed since the last ICP reply was received, Squid will not | |
373 | expect to receive an ICP reply on the next query. Thus, if | |
374 | your time between requests is greater than this timeout, you | |
375 | will see a lot of requests sent DIRECT to origin servers | |
376 | instead of to your parents. | |
377 | ||
dc835977 | 378 | dead_peer_timeout 10 seconds |
379 | DOC_END | |
380 | ||
934b03fc | 381 | |
382 | NAME: hierarchy_stoplist | |
383 | TYPE: wordlist | |
f8d9f54a | 384 | DEFAULT: none |
385 | DEFAULT_IF_NONE: cgi-bin ? | |
934b03fc | 386 | LOC: Config.hierarchy_stoplist |
387 | DOC_START | |
388 | A list of words which, if found in a URL, cause the object to | |
389 | be handled directly by this cache. In other words, use this | |
390 | to not query neighbor caches for certain objects. You may | |
391 | list this option multiple times. | |
392 | ||
393 | The default is to directly fetch URLs containing 'cgi-bin' or '?'. | |
394 | ||
395 | hierarchy_stoplist cgi-bin ? | |
396 | DOC_END | |
397 | ||
398 | ||
bd05e3e3 | 399 | NAME: no_cache |
400 | TYPE: acl_access | |
401 | DEFAULT: none | |
402 | LOC: Config.accessList.noCache | |
934b03fc | 403 | DOC_START |
bd05e3e3 | 404 | A list of ACL elements which, if matched, cause the reply to |
934b03fc | 405 | immediately removed from the cache. In other words, use this |
bd05e3e3 | 406 | to force certain objects to never be cached. |
934b03fc | 407 | |
b269cf4e | 408 | You must use the word 'DENY' to indicate the ACL names which should |
409 | NOT be cached. | |
0fdafae7 | 410 | |
bd05e3e3 | 411 | There is no default. We recommend you uncomment the following |
412 | two lines. | |
934b03fc | 413 | |
bd05e3e3 | 414 | acl QUERY urlpath_regex cgi-bin \? |
b269cf4e | 415 | no_cache deny QUERY |
934b03fc | 416 | DOC_END |
417 | ||
934b03fc | 418 | |
0f74202c | 419 | COMMENT_START |
3a278cb8 | 420 | OPTIONS WHICH AFFECT THE CACHE SIZE |
421 | ----------------------------------------------------------------------------- | |
0f74202c | 422 | COMMENT_END |
934b03fc | 423 | |
424 | NAME: cache_mem | |
9906e724 | 425 | COMMENT: (bytes) |
1b635117 | 426 | TYPE: b_size_t |
9906e724 | 427 | DEFAULT: 8 MB |
934b03fc | 428 | LOC: Config.Mem.maxSize |
429 | DOC_START | |
7b2496ca | 430 | NOTE: THIS PARAMETER DOES NOT SPECIFY THE MAXIMUM PROCESS |
431 | SIZE. IT PLACES A LIMIT ON ONE ASPECT OF SQUID'S MEMORY | |
432 | USAGE. SQUID USES MEMORY FOR OTHER THINGS AS WELL. | |
433 | YOUR PROCESS WILL PROBABLY BECOME TWICE OR THREE TIMES | |
434 | BIGGER THAN THE VALUE YOU PUT HERE | |
435 | ||
436 | 'cache_mem' specifies the ideal amount of memory to be used | |
437 | for: | |
438 | * In-Transit objects | |
439 | * Hot Objects | |
440 | * Negative-Cached objects | |
441 | ||
442 | Data for these objects are stored in 4 KB blocks. This | |
443 | parameter specifies the ideal upper limit on the total size of | |
444 | 4 KB blocks allocated. In-Transit objects take the highest | |
445 | priority. | |
934b03fc | 446 | |
447 | In-transit objects have priority over the others. When | |
448 | additional space is needed for incoming data, negative-cached | |
449 | and hot objects will be released. In other words, the | |
450 | negative-cached and hot objects will fill up any unused space | |
451 | not needed for in-transit objects. | |
452 | ||
7b2496ca | 453 | If circumstances require, this limit will be exceeded. |
454 | Specifically, if your incoming request rate requires more than | |
455 | 'cache_mem' of memory to hold in-transit objects, Squid will | |
456 | exceed this limit to satisfy the new requests. When the load | |
457 | decreases, blocks will be freed until the high-water mark is | |
458 | reached. Thereafter, blocks will be used to store hot | |
459 | objects. | |
460 | ||
934b03fc | 461 | The values of cache_mem_low and cache_mem_high (below) can be |
462 | used to tune the use of the memory pool. When the high mark is | |
463 | reached, in-transit and hot objects will be released to clear | |
464 | space. When an object transfer is completed, it will remain in | |
465 | memory only if the current memory usage is below the low water | |
466 | mark. | |
467 | ||
468 | The default is 8 Megabytes. | |
469 | ||
9906e724 | 470 | cache_mem 8 MB |
934b03fc | 471 | DOC_END |
472 | ||
473 | ||
474 | NAME: cache_swap_low | |
475 | COMMENT: (percent, 0-100) | |
476 | TYPE: int | |
477 | DEFAULT: 90 | |
478 | LOC: Config.Swap.lowWaterMark | |
479 | DOC_NONE | |
480 | ||
481 | NAME: cache_swap_high | |
482 | COMMENT: (percent, 0-100) | |
483 | TYPE: int | |
484 | DEFAULT: 95 | |
485 | LOC: Config.Swap.highWaterMark | |
486 | DOC_START | |
cf5cc17e | 487 | The low- and high-water marks for cache LRU replacement. LRU |
488 | replacement begins when the high-water mark is reached and ends | |
489 | when enough objects have been removed and the low-water mark is | |
490 | reached. Defaults are 90% and 95%. If you have a large cache, 5% | |
491 | could be hundreds of MB. If this is the case you may wish to | |
492 | set these numbers closer together. | |
934b03fc | 493 | |
494 | cache_swap_low 90 | |
495 | cache_swap_high 95 | |
496 | DOC_END | |
497 | ||
498 | ||
499 | NAME: cache_mem_low | |
500 | COMMENT: (in percent, 0-100) | |
501 | TYPE: int | |
502 | DEFAULT: 75 | |
503 | LOC: Config.Mem.lowWaterMark | |
504 | DOC_NONE | |
505 | ||
506 | NAME: cache_mem_high | |
507 | COMMENT: (in percent, 0-100) | |
508 | TYPE: int | |
509 | DEFAULT: 95 | |
510 | LOC: Config.Mem.highWaterMark | |
511 | DOC_START | |
512 | The low- and high-water mark for cache memory storage. When | |
513 | the amount of RAM used by the hot-object RAM cache reaches this | |
514 | point, the cache starts throwing objects out of the RAM cache | |
515 | (but they remain on disk). Defaults are 75% and 90%. | |
516 | ||
517 | cache_mem_low 75 | |
518 | cache_mem_high 90 | |
519 | DOC_END | |
520 | ||
521 | ||
522 | NAME: maximum_object_size | |
9e975e4e | 523 | COMMENT: (bytes) |
1b635117 | 524 | TYPE: b_size_t |
9906e724 | 525 | DEFAULT: 4096 KB |
934b03fc | 526 | LOC: Config.Store.maxObjectSize |
527 | DOC_START | |
528 | Objects larger than this size will NOT be saved on disk. The | |
cf5cc17e | 529 | value is specified in kilobytes, and the default is 4MB. If |
530 | you wish to get a high BYTES hit ratio, you should probably | |
531 | increase this (one 32 MB object hit counts for 3200 10KB | |
532 | hits). If you wish to increase speed more than your want to | |
533 | save bandwidth you should leave this low. | |
934b03fc | 534 | |
9906e724 | 535 | maximum_object_size 4096 KB |
934b03fc | 536 | DOC_END |
537 | ||
538 | ||
539 | NAME: ipcache_size | |
540 | COMMENT: (number of entries) | |
541 | TYPE: int | |
542 | DEFAULT: 1024 | |
543 | LOC: Config.ipcache.size | |
544 | DOC_NONE | |
545 | ||
546 | NAME: ipcache_low | |
547 | COMMENT: (percent) | |
548 | TYPE: int | |
549 | DEFAULT: 90 | |
550 | LOC: Config.ipcache.low | |
551 | DOC_NONE | |
552 | ||
553 | NAME: ipcache_high | |
554 | COMMENT: (percent) | |
555 | TYPE: int | |
556 | DEFAULT: 95 | |
557 | LOC: Config.ipcache.high | |
558 | DOC_START | |
559 | The size, low-, and high-water marks for the IP cache. | |
560 | ||
561 | ipcache_size 1024 | |
562 | ipcache_low 90 | |
563 | ipcache_high 95 | |
564 | DOC_END | |
565 | ||
e55650e3 | 566 | NAME: fqdncache_size |
567 | COMMENT: (number of entries) | |
568 | TYPE: int | |
569 | DEFAULT: 1024 | |
570 | LOC: Config.fqdncache.size | |
571 | DOC_START | |
572 | Maximum number of FQDN cache entries. | |
573 | fqdncache_size 1024 | |
574 | DOC_END | |
575 | ||
0f74202c | 576 | COMMENT_START |
3a278cb8 | 577 | LOGFILE PATHNAMES AND CACHE DIRECTORIES |
578 | ----------------------------------------------------------------------------- | |
0f74202c | 579 | COMMENT_END |
934b03fc | 580 | |
581 | NAME: cache_dir | |
582 | TYPE: cachedir | |
f1dc9b30 | 583 | DEFAULT: none |
0108d71f | 584 | DEFAULT_IF_NONE: @DEFAULT_SWAP_DIR@ 100 16 256 |
f1dc9b30 | 585 | LOC: Config.cacheSwap |
934b03fc | 586 | DOC_START |
cf5cc17e | 587 | Usage: |
588 | ||
589 | cache_dir Directory-Name Mbytes Level-1 Level2 | |
934b03fc | 590 | |
591 | You can specify multiple cache_dir lines to spread the | |
592 | cache among different disk partitions. | |
593 | ||
cf5cc17e | 594 | 'Directory' is a top-level directory where cache swap |
595 | files will be stored. If you want to use an entire disk | |
596 | for caching, then this can be the mount-point directory. | |
597 | The directory must exist and be writable by the Squid | |
598 | process. Squid will NOT create this directory for you. | |
599 | ||
600 | If no 'cache_dir' lines are specified, the following | |
601 | default will be used: @DEFAULT_SWAP_DIR@. | |
602 | ||
603 | 'Mbytes' is the amount of disk space (MB) to use under this | |
604 | directory. The default is 100 MB. Change this to suit your | |
605 | configuration. | |
606 | ||
607 | 'Level-1' is the number of first-level subdirectories which | |
608 | will be created under the 'Directory'. The default is 16. | |
609 | ||
610 | 'Level-2' is the number of second-level subdirectories which | |
611 | will be created under each first-level directory. The default | |
612 | is 256. | |
613 | ||
5375428c | 614 | cache_dir @DEFAULT_SWAP_DIR@ 100 16 256 |
934b03fc | 615 | DOC_END |
616 | ||
617 | ||
618 | NAME: cache_access_log | |
619 | TYPE: string | |
d0b98f84 | 620 | DEFAULT: @DEFAULT_ACCESS_LOG@ |
934b03fc | 621 | LOC: Config.Log.access |
622 | DOC_START | |
623 | Logs the client request activity. Contains an entry for | |
624 | every HTTP and ICP request received. | |
625 | ||
5375428c | 626 | cache_access_log @DEFAULT_ACCESS_LOG@ |
934b03fc | 627 | DOC_END |
628 | ||
629 | ||
630 | NAME: cache_log | |
631 | TYPE: string | |
0153d498 | 632 | DEFAULT: @DEFAULT_CACHE_LOG@ |
934b03fc | 633 | LOC: Config.Log.log |
634 | DOC_START | |
cf5cc17e | 635 | Cache logging file. This is where general information about |
636 | your cache's behaviour goes. You can increase the amount of data | |
637 | logged to this file with the "debug_options" tag below. | |
934b03fc | 638 | |
0153d498 | 639 | cache_log @DEFAULT_CACHE_LOG@ |
934b03fc | 640 | DOC_END |
641 | ||
642 | ||
643 | NAME: cache_store_log | |
644 | TYPE: string | |
0153d498 | 645 | DEFAULT: @DEFAULT_STORE_LOG@ |
934b03fc | 646 | LOC: Config.Log.store |
647 | DOC_START | |
648 | Logs the activities of the storage manager. Shows which | |
649 | objects are ejected from the cache, and which objects are | |
cf5cc17e | 650 | saved and for how long. To disable, enter "none". There are |
651 | not really utilities to analyse this data, so you can safely | |
652 | disable it. | |
934b03fc | 653 | |
0153d498 | 654 | cache_store_log @DEFAULT_STORE_LOG@ |
934b03fc | 655 | DOC_END |
656 | ||
657 | ||
658 | NAME: cache_swap_log | |
659 | TYPE: string | |
660 | LOC: Config.Log.swap | |
1273d501 | 661 | DEFAULT: none |
934b03fc | 662 | DOC_START |
d0d3ec94 | 663 | Location for the cache "swap.log." This log file holds the |
934b03fc | 664 | metadata of objects saved on disk. It is used to rebuild the |
665 | cache during startup. Normally this file resides in the first | |
666 | 'cache_dir' directory, but you may specify an alternate | |
667 | pathname here. Note you must give a full filename, not just | |
cf5cc17e | 668 | a directory. Since this is the index for the whole object |
669 | list you CANNOT periodically rotate it! | |
934b03fc | 670 | |
710df4ca | 671 | If you have more than one 'cache_dir', these swap logs will |
672 | have names such as: | |
673 | ||
674 | cache_swap_log.00 | |
675 | cache_swap_log.01 | |
676 | cache_swap_log.02 | |
677 | ||
678 | The numbered extension (which is added automatically) | |
679 | corresponds to the order of the 'cache_dir' lines in this | |
680 | configuration file. If you change the order of the 'cache_dir' | |
681 | lines in this file, then these log files will NOT correspond to | |
682 | the correct 'cache_dir' entry (unless you manually rename | |
683 | them). We recommend that you do NOT use this option. It is | |
684 | better to keep these log files in each 'cache_dir' directory. | |
685 | ||
934b03fc | 686 | cache_swap_log |
687 | DOC_END | |
688 | ||
689 | ||
690 | NAME: emulate_httpd_log | |
691 | COMMENT: on|off | |
692 | TYPE: onoff | |
f1dc9b30 | 693 | DEFAULT: off |
17a0a4ee | 694 | LOC: Config.onoff.common_log |
934b03fc | 695 | DOC_START |
696 | The Cache can emulate the log file format which many 'httpd' | |
697 | programs use. To disable/enable this emulation, set | |
698 | emulate_httpd_log to 'off' or 'on'. The default | |
cf5cc17e | 699 | is to use the native log format since it includes useful |
700 | information that Squid-specific log analysers use. | |
934b03fc | 701 | |
702 | emulate_httpd_log off | |
703 | DOC_END | |
704 | ||
705 | ||
706 | NAME: mime_table | |
f0b19334 | 707 | TYPE: string |
0153d498 | 708 | DEFAULT: @DEFAULT_MIME_TABLE@ |
934b03fc | 709 | LOC: Config.mimeTablePathname |
710 | DOC_START | |
cf5cc17e | 711 | Pathname to Squid's MIME table. You shouldn't need to change |
712 | this, but the default file contains examples and formatting | |
713 | information if you do. | |
934b03fc | 714 | |
0153d498 | 715 | mime_table @DEFAULT_MIME_TABLE@ |
934b03fc | 716 | DOC_END |
717 | ||
718 | ||
719 | NAME: log_mime_hdrs | |
720 | COMMENT: on|off | |
721 | TYPE: onoff | |
17a0a4ee | 722 | LOC: Config.onoff.log_mime_hdrs |
f1dc9b30 | 723 | DEFAULT: off |
934b03fc | 724 | DOC_START |
cf5cc17e | 725 | The Cache can record both the request and the response MIME |
726 | headers for each HTTP transaction. The headers are encoded | |
727 | safely and will appear as two bracketed fields at the end of | |
728 | the access log (for either the native or httpd-emulated log | |
729 | formats). To enable this logging set log_mime_hdrs to 'on'. | |
934b03fc | 730 | |
731 | log_mime_hdrs off | |
732 | DOC_END | |
733 | ||
734 | ||
735 | NAME: useragent_log | |
736 | TYPE: string | |
737 | LOC: Config.Log.useragent | |
f1dc9b30 | 738 | DEFAULT: none |
934b03fc | 739 | DOC_START |
cf5cc17e | 740 | If configured with the "--enable-useragent_log" configure |
741 | option, Squid will write the User-Agent field from HTTP | |
742 | requests to the filename specified here. By default | |
743 | useragent_log is disabled. | |
934b03fc | 744 | |
745 | useragent_log none | |
746 | DOC_END | |
747 | ||
748 | ||
749 | NAME: pid_filename | |
750 | TYPE: string | |
0153d498 | 751 | DEFAULT: @DEFAULT_PID_FILE@ |
934b03fc | 752 | LOC: Config.pidFilename |
753 | DOC_START | |
d0d41f07 | 754 | A filename to write the process-id to. To disable, enter "none". |
934b03fc | 755 | |
0153d498 | 756 | pid_filename @DEFAULT_PID_FILE@ |
934b03fc | 757 | DOC_END |
758 | ||
759 | ||
760 | NAME: debug_options | |
f1dc9b30 | 761 | TYPE: eol |
934b03fc | 762 | DEFAULT: ALL,1 |
763 | LOC: Config.debugOptions | |
764 | DOC_START | |
765 | Logging options are set as section,level where each source file | |
766 | is assigned a unique section. Lower levels result in less | |
767 | output, Full debugging (level 9) can result in a very large | |
768 | log file, so be careful. The magic word "ALL" sets debugging | |
769 | levels for all sections. We recommend normally running with | |
770 | "ALL,1". | |
771 | ||
772 | debug_options ALL,1 | |
773 | DOC_END | |
774 | ||
775 | ||
776 | NAME: ident_lookup | |
777 | COMMENT: on|off | |
778 | TYPE: onoff | |
f1dc9b30 | 779 | DEFAULT: off |
17a0a4ee | 780 | LOC: Config.onoff.ident_lookup |
934b03fc | 781 | DOC_START |
cf5cc17e | 782 | If you wish to make an RFC931/ident lookup of the client |
783 | username for each connection, enable this. It is off by | |
784 | default. | |
934b03fc | 785 | |
786 | ident_lookup off | |
787 | DOC_END | |
788 | ||
789 | ||
790 | NAME: log_fqdn | |
791 | COMMENT: on|off | |
792 | TYPE: onoff | |
f1dc9b30 | 793 | DEFAULT: off |
17a0a4ee | 794 | LOC: Config.onoff.log_fqdn |
934b03fc | 795 | DOC_START |
796 | Turn this on if you wish to log fully qualified domain names | |
cf5cc17e | 797 | in the access.log. To do this Squid does a DNS lookup of all |
798 | IP's connecting to it. This can (in some situations) increase | |
799 | latency, which makes your cache seem slower for interactive | |
800 | browsing. | |
934b03fc | 801 | |
802 | log_fqdn off | |
803 | DOC_END | |
804 | ||
805 | ||
806 | NAME: client_netmask | |
807 | TYPE: address | |
808 | LOC: Config.Addrs.client_netmask | |
f1dc9b30 | 809 | DEFAULT: 255.255.255.255 |
934b03fc | 810 | DOC_START |
811 | A netmask for client addresses in logfiles and cachemgr output. | |
812 | Change this to protect the privacy of your cache clients. | |
cf5cc17e | 813 | A netmask of 255.255.255.0 will log all IP's in that range with |
814 | the last digit set to '0'. | |
934b03fc | 815 | |
816 | client_netmask 255.255.255.255 | |
817 | DOC_END | |
818 | ||
819 | ||
0f74202c | 820 | COMMENT_START |
3a278cb8 | 821 | OPTIONS FOR EXTERNAL SUPPORT PROGRAMS |
822 | ----------------------------------------------------------------------------- | |
0f74202c | 823 | COMMENT_END |
934b03fc | 824 | |
934b03fc | 825 | NAME: ftp_user |
826 | TYPE: string | |
cf5cc17e | 827 | DEFAULT: Squid@ |
934b03fc | 828 | LOC: Config.Ftp.anon_user |
829 | DOC_START | |
830 | If you want the anonymous login password to be more informative | |
831 | (and enable the use of picky ftp servers), set this to something | |
832 | resonable for your domain, like wwwuser@somewhere.net | |
833 | ||
834 | The reason why this is domainless by default is that the | |
835 | request can be made on the behalf of a user in any domain, | |
836 | depending on how the cache is used. | |
837 | Some ftp server also validate that the email address is valid | |
838 | (for example perl.com). | |
839 | ||
cf5cc17e | 840 | ftp_user Squid@ |
934b03fc | 841 | DOC_END |
842 | ||
365cb147 | 843 | NAME: ftp_list_width |
1b635117 | 844 | TYPE: size_t |
365cb147 | 845 | DEFAULT: 32 |
846 | LOC: Config.Ftp.list_width | |
847 | DOC_START | |
cf5cc17e | 848 | Sets the width of ftp listings. This should be set to fit in |
849 | the width of a standard browser. Setting this too small | |
850 | can cut off long filenames when browsing ftp sites. | |
851 | ||
365cb147 | 852 | ftp_list_width 32 |
853 | DOC_END | |
854 | ||
934b03fc | 855 | NAME: cache_dns_program |
f0b19334 | 856 | TYPE: string |
0153d498 | 857 | DEFAULT: @DEFAULT_DNSSERVER@ |
934b03fc | 858 | LOC: Config.Program.dnsserver |
859 | DOC_START | |
860 | Specify the location of the executable for dnslookup process. | |
861 | ||
0153d498 | 862 | cache_dns_program @DEFAULT_DNSSERVER@ |
934b03fc | 863 | DOC_END |
864 | ||
934b03fc | 865 | NAME: dns_children |
866 | TYPE: int | |
867 | DEFAULT: 5 | |
868 | LOC: Config.dnsChildren | |
869 | DOC_START | |
870 | The number of processes spawn to service DNS name lookups. | |
871 | For heavily loaded caches on large servers, you should | |
872 | probably increase this value to at least 10. The maximum | |
873 | is 32. The default is 5. | |
874 | ||
875 | To disable dnsservers, set this to 0. NOTE, this is very | |
876 | strongly discouraged. If you disable dnsservers your Squid | |
877 | process will BLOCK on DNS lookups! | |
878 | ||
879 | dns_children 5 | |
880 | DOC_END | |
881 | ||
882 | ||
883 | NAME: dns_defnames | |
884 | COMMENT: on|off | |
885 | TYPE: onoff | |
f1dc9b30 | 886 | DEFAULT: off |
17a0a4ee | 887 | LOC: Config.onoff.res_defnames |
934b03fc | 888 | DOC_START |
889 | Normally the 'dnsserver' disables the RES_DEFNAMES resolver | |
890 | option (see res_init(3)). This prevents caches in a hierarchy | |
891 | from interpreting single-component hostnames locally. To allow | |
892 | dnsserver to handle single-component names, enable this | |
893 | option. | |
894 | ||
895 | dns_defnames off | |
896 | DOC_END | |
897 | ||
09c483ec | 898 | NAME: dns_nameservers |
899 | TYPE: wordlist | |
900 | DEFAULT: none | |
901 | LOC: Config.dns_nameservers | |
902 | DOC_START | |
903 | Use this if you want to specify a list of DNS name servers | |
904 | (IP addresses) to use instead of those given in your | |
905 | /etc/resolv.conf file. | |
906 | ||
907 | Example: dns_nameservers 10.0.0.1 192.172.0.4 | |
908 | ||
909 | dns_nameservers none | |
910 | DOC_END | |
911 | ||
934b03fc | 912 | |
913 | NAME: unlinkd_program | |
f0b19334 | 914 | TYPE: string |
0153d498 | 915 | DEFAULT: @DEFAULT_UNLINKD@ |
934b03fc | 916 | LOC: Config.Program.unlinkd |
917 | DOC_START | |
918 | Specify the location of the executable for file deletion process. | |
cf5cc17e | 919 | This isn't needed if you are using async-io since it's handled by |
920 | a thread. | |
934b03fc | 921 | |
0153d498 | 922 | unlinkd_program @DEFAULT_UNLINKD@ |
934b03fc | 923 | DOC_END |
924 | ||
925 | ||
926 | NAME: pinger_program | |
a95856a0 | 927 | TYPE: string |
0153d498 | 928 | DEFAULT: @DEFAULT_PINGER@ |
934b03fc | 929 | LOC: Config.Program.pinger |
930 | DOC_START | |
931 | Specify the location of the executable for the pinger process. | |
cf5cc17e | 932 | This is only useful if you configured Squid (during compliation) |
933 | with the '--enable-icmp' option. | |
934b03fc | 934 | |
0153d498 | 935 | pinger_program @DEFAULT_PINGER@ |
934b03fc | 936 | DOC_END |
937 | ||
938 | ||
939 | NAME: redirect_program | |
f0b19334 | 940 | TYPE: string |
934b03fc | 941 | LOC: Config.Program.redirect |
62607543 | 942 | DEFAULT: none |
934b03fc | 943 | DOC_START |
944 | Specify the location of the executable for the URL redirector. | |
cf5cc17e | 945 | Since they can perform almost any function there isn't one included. |
946 | See the Release-Notes for information on how to write one. | |
947 | By default, a redirector is not used. | |
934b03fc | 948 | |
f0b19334 | 949 | redirect_program none |
934b03fc | 950 | DOC_END |
951 | ||
952 | ||
953 | NAME: redirect_children | |
954 | TYPE: int | |
955 | DEFAULT: 5 | |
956 | LOC: Config.redirectChildren | |
957 | DOC_START | |
cf5cc17e | 958 | The number of redirector processes to spawn. If you start |
959 | too few Squid will have to wait for them to process a backlog of | |
960 | URLs, slowing it down. If you start too many they will use RAM | |
961 | and other system resources. | |
934b03fc | 962 | |
963 | redirect_children 5 | |
964 | DOC_END | |
965 | ||
c68e9c6b | 966 | NAME: redirect_rewrites_host_header |
967 | TYPE: onoff | |
968 | DEFAULT: on | |
969 | LOC: Config.onoff.redir_rewrites_host | |
970 | DOC_START | |
971 | By default Squid rewrites any Host: header in redirected requests. | |
972 | If you are running a accelerator then this may not be a wanted effect | |
973 | of a redirector. | |
974 | redirect_rewrites_host_header on | |
975 | DOC_END | |
976 | ||
977 | ||
73e67ee0 | 978 | NAME: authenticate_program |
6c20b822 | 979 | TYPE: wordlist |
73e67ee0 | 980 | LOC: Config.Program.authenticate |
981 | DEFAULT: none | |
982 | DOC_START | |
6c20b822 | 983 | Specify the command for the external authenticator. Such a |
984 | program reads a line containing "username password" and replies | |
985 | "OK" or "ERR" in an endless loop. If you use an authenticator, | |
986 | make sure you have 1 acl of type proxy_auth. By default, the | |
987 | authenticator_program is not used. | |
73e67ee0 | 988 | |
6c20b822 | 989 | If you want to use the traditional proxy authentication, |
990 | jump over to the ../auth_modules/NCSA directory and | |
991 | type: | |
992 | % make | |
993 | % make install | |
73e67ee0 | 994 | |
6c20b822 | 995 | Then, set this line to something like |
73e67ee0 | 996 | |
6c20b822 | 997 | authenticate_program @DEFAULT_PREFIX@/bin/ncsa_auth @DEFAULT_PREFIX@/etc/passwd |
73e67ee0 | 998 | |
6c20b822 | 999 | authenticate_program none |
73e67ee0 | 1000 | DOC_END |
1001 | ||
73e67ee0 | 1002 | NAME: authenticate_children |
1003 | TYPE: int | |
1004 | DEFAULT: 5 | |
1005 | LOC: Config.authenticateChildren | |
1006 | DOC_START | |
1007 | The number of authenticator processes to spawn (default 5). If you | |
1008 | start too few Squid will have to wait for them to process a backlog | |
1009 | of usercode/password verifications, slowing it down. When password | |
1010 | verifications are done via a (slow) network you are likely to need | |
1011 | lots of authenticator processes. | |
1012 | ||
1013 | authenticate_children 5 | |
1014 | DOC_END | |
1015 | ||
c68e9c6b | 1016 | NAME: authenticate_ttl |
1017 | TYPE: int | |
1018 | DEFAULT: 3600 | |
1019 | LOC: Config.authenticateTTL | |
1020 | DOC_START | |
1021 | The time a checked username/password combination remains cached | |
1022 | (default 3600). If a wrong password is given for a cached user, | |
1023 | the user gets removed from the username/password cache forcing | |
1024 | a revalidation. | |
1025 | ||
1026 | authenticate_ttl 3600 | |
1027 | DOC_END | |
1028 | ||
0f74202c | 1029 | COMMENT_START |
3a278cb8 | 1030 | OPTIONS FOR TUNING THE CACHE |
1031 | ----------------------------------------------------------------------------- | |
0f74202c | 1032 | COMMENT_END |
934b03fc | 1033 | |
0153d498 | 1034 | NAME: wais_relay_host |
1035 | TYPE: string | |
1273d501 | 1036 | DEFAULT: none |
0153d498 | 1037 | LOC: Config.Wais.relayHost |
1038 | DOC_NONE | |
934b03fc | 1039 | |
0153d498 | 1040 | NAME: wais_relay_port |
1041 | TYPE: ushort | |
1042 | DEFAULT: 0 | |
1043 | LOC: Config.Wais.relayPort | |
934b03fc | 1044 | DOC_START |
1045 | Relay WAIS request to host (1st arg) at port (2 arg). | |
1046 | ||
0153d498 | 1047 | wais_relay_host localhost |
1048 | wais_relay_port 8000 | |
934b03fc | 1049 | DOC_END |
1050 | ||
1051 | ||
1052 | NAME: request_size | |
9906e724 | 1053 | COMMENT: (KB) |
518da0bd | 1054 | TYPE: b_size_t |
9906e724 | 1055 | DEFAULT: 100 KB |
934b03fc | 1056 | LOC: Config.maxRequestSize |
1057 | DOC_START | |
1058 | Maximum allowed request size in kilobytes. If people are using | |
1059 | POST to upload files, then set this to the largest acceptable | |
1060 | filesize plus a few extra kbytes. | |
1061 | ||
9906e724 | 1062 | request_size 100 KB |
934b03fc | 1063 | DOC_END |
1064 | ||
1065 | ||
1066 | NAME: refresh_pattern | |
934b03fc | 1067 | TYPE: refreshpattern |
f1dc9b30 | 1068 | LOC: Config.Refresh |
1273d501 | 1069 | DEFAULT: none |
934b03fc | 1070 | DOC_START |
7ddc902f | 1071 | usage: refresh_pattern [-i] regex min percent max [options] |
1072 | ||
1073 | By default, regular expressions are CASE-SENSITIVE. To make | |
1074 | them case-insensitive, use the -i option. | |
934b03fc | 1075 | |
1076 | min and max are specified in MINUTES. | |
1077 | percent is an integer number. | |
1078 | ||
1dfa1d81 | 1079 | options: override-expire |
1080 | override-lastmod | |
cbe3a719 | 1081 | reload-into-ims |
1082 | ignore-reload | |
1dfa1d81 | 1083 | |
1084 | override-expire enforces min age even if the server | |
cbe3a719 | 1085 | sent a Expires: header. Doing this VIOLATES the HTTP |
1086 | standard. Enabling this feature could make you liable | |
1087 | for problems which it causes. | |
1dfa1d81 | 1088 | |
1089 | override-lastmod enforces min age even on objects | |
1090 | that was modified recently. | |
cbe3a719 | 1091 | |
1092 | reload-into-ims changes client no-cache or ``reload'' | |
1093 | to If-Modified-Since requests. Doing this VIOLATES the | |
1094 | HTTP standard. Enabling this feature could make you | |
1095 | liable for problems which it causes. | |
1096 | ||
1097 | ignore-reload ignores a client no-cache or ``reload'' | |
1098 | header. Doing this VIOLATES the HTTP standard. Enabling | |
1099 | this feature could make you liable for problems which | |
1100 | it causes. | |
1dfa1d81 | 1101 | |
934b03fc | 1102 | Please see the file doc/Release-Notes-1.1.txt for a full |
1103 | description of Squid's refresh algorithm. Basically a | |
1dfa1d81 | 1104 | cached object is: (the order is changed from 1.1.X) |
934b03fc | 1105 | |
934b03fc | 1106 | STALE if age > max |
1dfa1d81 | 1107 | FRESH if expires < now, else STALE |
1108 | FRESH if lm-factor < percent, else STALE | |
1109 | FRESH if age < min | |
1110 | else STALE | |
934b03fc | 1111 | |
1112 | The refresh_pattern lines are checked in the order listed here. | |
1113 | The first entry which matches is used. If none of the entries | |
1114 | match, then the default will be used. | |
1115 | ||
1116 | Default: | |
1117 | refresh_pattern . 0 20% 4320 | |
1118 | DOC_END | |
1119 | ||
1120 | ||
1121 | NAME: reference_age | |
f1dc9b30 | 1122 | TYPE: time_t |
934b03fc | 1123 | LOC: Config.referenceAge |
f1dc9b30 | 1124 | DEFAULT: 1 year |
934b03fc | 1125 | DOC_START |
1126 | As a part of normal operation, Squid performs Least Recently | |
1127 | Used removal of cached objects. The LRU age for removal is | |
1128 | computed dynamically, based on the amount of disk space in | |
6778c757 | 1129 | use. The dynamic value can be seen in the Cache Manager 'info' |
1130 | output. | |
1131 | ||
1132 | The 'reference_age' parameter defines the maximum LRU age. For | |
1133 | example, setting reference_age to '1 week' will cause objects | |
1134 | to be removed if they have not been accessed for a week or | |
1135 | more. The default value is one month. | |
934b03fc | 1136 | |
1137 | Specify a number here, followed by units of time. For example: | |
1138 | 1 week | |
1139 | 3.5 days | |
1140 | 4 months | |
1141 | 2.2 hours | |
1142 | ||
f1dc9b30 | 1143 | reference_age 1 month |
934b03fc | 1144 | DOC_END |
1145 | ||
1146 | ||
0153d498 | 1147 | NAME: quick_abort_min |
9906e724 | 1148 | COMMENT: (KB) |
1149 | TYPE: kb_size_t | |
c68e9c6b | 1150 | DEFAULT: 16 KB |
0153d498 | 1151 | LOC: Config.quickAbort.min |
1152 | DOC_NONE | |
1153 | ||
0153d498 | 1154 | NAME: quick_abort_max |
9906e724 | 1155 | COMMENT: (KB) |
1156 | TYPE: kb_size_t | |
c68e9c6b | 1157 | DEFAULT: 16 kb |
0153d498 | 1158 | LOC: Config.quickAbort.max |
1b2f5c2f | 1159 | DOC_NONE |
1160 | ||
1161 | NAME: quick_abort_pct | |
1162 | COMMENT: (percent) | |
1163 | TYPE: int | |
c68e9c6b | 1164 | DEFAULT: 95 |
1b2f5c2f | 1165 | LOC: Config.quickAbort.pct |
934b03fc | 1166 | DOC_START |
cf5cc17e | 1167 | The cache can be configured to continue downloading aborted |
1168 | requests. This may be undesirable on slow (e.g. SLIP) links | |
1169 | and/or very busy caches. Impatient users may tie up file | |
1170 | descriptors and bandwidth by repeatedly requesting and | |
1171 | immediately aborting downloads. | |
934b03fc | 1172 | |
1173 | When the user aborts a request, Squid will check the | |
1174 | quick_abort values to the amount of data transfered until | |
1175 | then. | |
1176 | ||
cf5cc17e | 1177 | If the transfer has less than 'quick_abort_min' KB remaining, |
1178 | it will finish the retrieval. Setting 'quick_abort_min' to -1 | |
1179 | will disable the quick_abort feature. | |
934b03fc | 1180 | |
cf5cc17e | 1181 | If the transfer has more than 'quick_abort_max' KB remaining, |
1182 | it will abort the retrieval. | |
934b03fc | 1183 | |
1b2f5c2f | 1184 | If more than 'quick_abort_pct' of the transfer has completed, |
1185 | it will finish the retrieval. | |
1186 | ||
c68e9c6b | 1187 | quick_abort_min 16 KB |
1188 | quick_abort_max 16 KB | |
1189 | quick_abort_pct 95 | |
934b03fc | 1190 | DOC_END |
1191 | ||
1192 | ||
1193 | NAME: negative_ttl | |
bc0eb004 | 1194 | COMMENT: time-units |
f1dc9b30 | 1195 | TYPE: time_t |
934b03fc | 1196 | LOC: Config.negativeTtl |
9e975e4e | 1197 | DEFAULT: 5 minutes |
934b03fc | 1198 | DOC_START |
1199 | Time-to-Live (TTL) for failed requests. Certain types of | |
1200 | failures (such as "connection refused" and "404 Not Found") are | |
cf5cc17e | 1201 | negatively-cached for a configurable amount of time. The |
1202 | default is 5 minutes. Note that this is different from | |
1203 | negative caching of DNS lookups. | |
934b03fc | 1204 | |
1205 | negative_ttl 5 minutes | |
1206 | DOC_END | |
1207 | ||
1208 | ||
1209 | NAME: positive_dns_ttl | |
bc0eb004 | 1210 | COMMENT: time-units |
f1dc9b30 | 1211 | TYPE: time_t |
934b03fc | 1212 | LOC: Config.positiveDnsTtl |
9e975e4e | 1213 | DEFAULT: 6 hours |
934b03fc | 1214 | DOC_START |
1215 | Time-to-Live (TTL) for positive caching of successful DNS lookups. | |
1216 | Default is 6 hours (360 minutes). If you want to minimize the | |
1217 | use of Squid's ipcache, set this to 1, not 0. | |
1218 | ||
9e975e4e | 1219 | positive_dns_ttl 6 hours |
934b03fc | 1220 | DOC_END |
1221 | ||
1222 | ||
1223 | NAME: negative_dns_ttl | |
bc0eb004 | 1224 | COMMENT: time-units |
f1dc9b30 | 1225 | TYPE: time_t |
934b03fc | 1226 | LOC: Config.negativeDnsTtl |
9e975e4e | 1227 | DEFAULT: 5 minutes |
934b03fc | 1228 | DOC_START |
1229 | Time-to-Live (TTL) for negative caching of failed DNS lookups. | |
1230 | ||
1231 | negative_dns_ttl 5 minutes | |
1232 | DOC_END | |
1233 | ||
c68e9c6b | 1234 | NAME: range_offset_limit |
1235 | COMMENT: (bytes) | |
1236 | TYPE: b_size_t | |
1237 | LOC: Config.rangeOffsetLimit | |
1238 | DEFAULT: 0 KB | |
1239 | DOC_START | |
1240 | Sets a upper limit on how far into the the file a Range request | |
1241 | may be to cause Squid to prefetch the whole file. If beyond this | |
1242 | limit then Squid forwards the Range request as it is and the result | |
1243 | is NOT cached. | |
1244 | ||
1245 | This is to stop a far ahead range request (lets say start at 17MB) | |
1246 | from making Squid fetch the whole object up to that point before | |
1247 | sending anything to the client. | |
1248 | ||
1249 | A value of -1 causes Squid to always fetch the object from the | |
1250 | beginning so that it may cache the result. (2.0 style) | |
1251 | ||
1252 | A value of 0 causes Squid to never fetch more than the client | |
1253 | client requested. (default) | |
1254 | ||
1255 | range_offset_limit 0 KB | |
1256 | DOC_END | |
1257 | ||
1258 | ||
0f74202c | 1259 | COMMENT_START |
3a278cb8 | 1260 | TIMEOUTS |
1261 | ----------------------------------------------------------------------------- | |
0f74202c | 1262 | COMMENT_END |
934b03fc | 1263 | |
1264 | NAME: connect_timeout | |
bc0eb004 | 1265 | COMMENT: time-units |
f1dc9b30 | 1266 | TYPE: time_t |
934b03fc | 1267 | LOC: Config.Timeout.connect |
9e975e4e | 1268 | DEFAULT: 2 minutes |
934b03fc | 1269 | DOC_START |
1270 | Some systems (notably Linux) can not be relied upon to properly | |
cf5cc17e | 1271 | time out connect(2) requests. Therefore the Squid process |
934b03fc | 1272 | enforces its own timeout on server connections. This parameter |
1273 | specifies how long to wait for the connect to complete. The | |
1274 | default is two minutes (120 seconds). | |
1275 | ||
1276 | connect_timeout 120 seconds | |
1277 | DOC_END | |
1278 | ||
23d92c64 | 1279 | NAME: siteselect_timeout |
1280 | COMMENT: time-units | |
1281 | TYPE: time_t | |
1282 | LOC: Config.Timeout.siteSelect | |
1283 | DEFAULT: 4 seconds | |
1284 | DOC_START | |
1285 | For URN to multiple URL's URL selection | |
1286 | ||
1287 | siteselect_timeout 4 seconds | |
1288 | DOC_END | |
934b03fc | 1289 | |
1290 | NAME: read_timeout | |
bc0eb004 | 1291 | COMMENT: time-units |
f1dc9b30 | 1292 | TYPE: time_t |
934b03fc | 1293 | LOC: Config.Timeout.read |
9e975e4e | 1294 | DEFAULT: 15 minutes |
934b03fc | 1295 | DOC_START |
1296 | The read_timeout is applied on server-side connections. After | |
1297 | each successful read(), the timeout will be extended by this | |
1298 | amount. If no data is read again after this amount of time, | |
1299 | the request is aborted and logged with ERR_READ_TIMEOUT. The | |
1300 | default is 15 minutes. | |
1301 | ||
1302 | read_timeout 15 minutes | |
1303 | DOC_END | |
1304 | ||
1305 | ||
934b03fc | 1306 | NAME: request_timeout |
f1dc9b30 | 1307 | TYPE: time_t |
934b03fc | 1308 | LOC: Config.Timeout.request |
9e975e4e | 1309 | DEFAULT: 30 seconds |
934b03fc | 1310 | DOC_START |
1311 | How long to wait for an HTTP request after connection | |
1312 | establishment. For persistent connections, wait this long | |
1313 | after the previous request completes. | |
1314 | ||
0fbcf3c7 | 1315 | request_timeout 30 seconds |
934b03fc | 1316 | DOC_END |
1317 | ||
1318 | ||
1319 | NAME: client_lifetime | |
bc0eb004 | 1320 | COMMENT: time-units |
f1dc9b30 | 1321 | TYPE: time_t |
934b03fc | 1322 | LOC: Config.Timeout.lifetime |
9e975e4e | 1323 | DEFAULT: 1 day |
934b03fc | 1324 | DOC_START |
1325 | The maximum amount of time that a client (browser) is allowed to | |
1326 | remain connected to the cache process. This protects the Cache | |
1327 | from having alot of sockets (and hence file descriptors) tied up | |
1328 | in a CLOSE_WAIT state from remote clients that go away without | |
1329 | properly shutting down (either because of a network failure or | |
1330 | because of a poor client implementation). The default is one | |
1331 | day, 1440 minutes. | |
1332 | ||
1333 | NOTE: The default value is intended to be much larger than any | |
1334 | client would ever need to be connected to your cache. You | |
1335 | should probably change client_lifetime only as a last resort. | |
1336 | If you seem to have many client connections tying up | |
1337 | filedescriptors, we recommend first tuning the read_timeout, | |
0fbcf3c7 | 1338 | request_timeout, pconn_timeout and quick_abort values. |
934b03fc | 1339 | |
1340 | client_lifetime 1 day | |
1341 | DOC_END | |
1342 | ||
ea285003 | 1343 | NAME: half_closed_clients |
1344 | TYPE: onoff | |
1345 | LOC: Config.onoff.half_closed_clients | |
1346 | DEFAULT: on | |
1347 | DOC_START | |
1348 | Some clients may shutdown the sending side of their TCP | |
1349 | connections, while leaving their receiving sides open. Sometimes, | |
1350 | Squid can not tell the difference between a half-closed and a | |
1351 | fully-closed TCP connection. By default, half-closed client | |
1352 | connections are kept open until a read(2) or write(2) on the | |
1353 | socket returns an error. Change this option to 'off' and Squid | |
1354 | will immediately close client connections when read(2) returns | |
1355 | "no more data to read." | |
1356 | ||
1357 | half_closed_clients on | |
1358 | DOC_END | |
1359 | ||
603a02fd | 1360 | NAME: pconn_timeout |
1361 | TYPE: time_t | |
1362 | LOC: Config.Timeout.pconn | |
1363 | DEFAULT: 120 seconds | |
1364 | DOC_START | |
1365 | Timeout for idle persistent connections to servers and other | |
1366 | proxies. | |
1367 | pconn_timeout 120 seconds | |
1368 | DOC_END | |
1369 | ||
934b03fc | 1370 | |
1371 | NAME: shutdown_lifetime | |
bc0eb004 | 1372 | COMMENT: time-units |
f1dc9b30 | 1373 | TYPE: time_t |
934b03fc | 1374 | LOC: Config.shutdownLifetime |
9e975e4e | 1375 | DEFAULT: 30 seconds |
934b03fc | 1376 | DOC_START |
1377 | When SIGTERM or SIGHUP is received, the cache is put into | |
1378 | "shutdown pending" mode until all active sockets are closed. | |
1379 | This value is the lifetime to set for all open descriptors | |
1380 | during shutdown mode. Any active clients after this many | |
1381 | seconds will receive a 'timeout' message. | |
1382 | ||
1383 | shutdown_lifetime 30 seconds | |
1384 | DOC_END | |
1385 | ||
0f74202c | 1386 | COMMENT_START |
3a278cb8 | 1387 | ACCESS CONTROLS |
1388 | ----------------------------------------------------------------------------- | |
0f74202c | 1389 | COMMENT_END |
934b03fc | 1390 | |
1391 | NAME: acl | |
1392 | TYPE: acl | |
f1dc9b30 | 1393 | LOC: Config.aclList |
1394 | DEFAULT: none | |
934b03fc | 1395 | DOC_START |
1396 | Defining an Access List | |
1397 | ||
1398 | acl aclname acltype string1 ... | |
1399 | acl aclname acltype "file" ... | |
1400 | ||
1401 | when using "file", the file should contain one item per line | |
1402 | ||
1403 | acltype is one of src dst srcdomain dstdomain url_pattern | |
1404 | urlpath_pattern time port proto method browser user | |
1405 | ||
1406 | acl aclname src ip-address/netmask ... (clients IP address) | |
1407 | acl aclname src addr1-addr2/netmask ... (range of addresses) | |
1408 | acl aclname dst ip-address/netmask ... (URL host's IP address) | |
d0d41f07 | 1409 | |
1410 | acl aclname srcdomain foo.com ... # reverse lookup, client IP | |
1411 | acl aclname dstdomain foo.com ... # Destination server from URL | |
1412 | acl aclname srcdom_regex xxx ... # regex matching client name | |
1413 | acl aclname dstdom_regex xxx ... # regex matching server | |
1414 | # For dstdomain and dstdom_regex a reverse lookup is tried if a IP | |
1415 | # based URL is used. The name "none" is used if the reverse lookup | |
1416 | # fails. | |
1417 | ||
934b03fc | 1418 | acl aclname time [day-abbrevs] [h1:m1-h2:m2] |
1419 | day-abbrevs: | |
1420 | S - Sunday | |
1421 | M - Monday | |
1422 | T - Tuesday | |
1423 | W - Wednesday | |
1424 | H - Thursday | |
1425 | F - Friday | |
1426 | A - Saturday | |
1427 | h1:m1 must be less than h2:m2 | |
1428 | acl aclname url_regex ^http:// ... # regex matching on whole URL | |
d0d41f07 | 1429 | acl aclname urlpath_regex \.gif$ ... # regex matching on URL path |
934b03fc | 1430 | acl aclname port 80 70 21 ... |
ec5bba4d | 1431 | acl aclname port 0-1024 ... # ranges allowed |
934b03fc | 1432 | acl aclname proto HTTP FTP ... |
1433 | acl aclname method GET POST ... | |
1434 | acl aclname browser regexp | |
c68e9c6b | 1435 | acl aclname ident username ... |
1436 | # string match on ident output. | |
1437 | # use REQUIRED to accept any non-null ident. | |
6468fe10 | 1438 | acl aclname src_as number ... |
1439 | acl aclname dst_as number ... | |
1440 | # Except for access control, AS numbers can be used for | |
1441 | # routing of requests to specific caches. Here's an | |
1442 | # example for routing all requests for AS#1241 and only | |
1443 | # those to mycache.mydomain.net: | |
1444 | # acl asexample dst_as 1241 | |
d87ebd78 | 1445 | # cache_peer_access mycache.mydomain.net allow asexample |
1446 | # cache_peer_access mycache_mydomain.net deny all | |
6468fe10 | 1447 | |
c68e9c6b | 1448 | acl aclname proxy_auth username ... |
1449 | # list of valid usernames | |
1450 | # use REQUIRED to accept any valid username. | |
73e67ee0 | 1451 | # |
1452 | # NOTE: when a Proxy-Authentication header is sent but it is not | |
1453 | # needed during ACL checking the username is NOT logged | |
1454 | # in access.log. | |
c68e9c6b | 1455 | # |
1456 | # NOTE: proxy_auth requires a EXTERNAL authentication program | |
1457 | # to check username/password combinations (see | |
1458 | # authenticate_program). | |
1459 | # | |
1460 | # WARNING: proxy_auth can't be used in a transparent proxy. It | |
1461 | # collides with any authentication done by origin servers. It may | |
1462 | # seem like it works at first, but it doesn't. | |
934b03fc | 1463 | |
dba79ac5 | 1464 | acl aclname snmp_community string ... |
08f6b5e0 | 1465 | # A community string to limit access to your SNMP Agent |
dba79ac5 | 1466 | # Example: |
1467 | # | |
1468 | # acl snmppublic snmp_community public | |
1469 | ||
c68e9c6b | 1470 | |
1471 | Examples: | |
1472 | acl myexample dst_as 1241 | |
1473 | acl password proxy_auth 300 | |
1474 | ||
1475 | Defaults: | |
1476 | NOCOMMENT_START | |
1477 | acl all src 0.0.0.0/0.0.0.0 | |
934b03fc | 1478 | acl manager proto cache_object |
1479 | acl localhost src 127.0.0.1/255.255.255.255 | |
934b03fc | 1480 | acl SSL_ports port 443 563 |
4d62b0af | 1481 | acl Safe_ports port 80 21 443 563 70 210 1025-65535 |
934b03fc | 1482 | acl CONNECT method CONNECT |
c68e9c6b | 1483 | NOCOMMENT_END |
934b03fc | 1484 | DOC_END |
1485 | ||
1486 | NAME: http_access | |
1487 | TYPE: acl_access | |
f1dc9b30 | 1488 | LOC: Config.accessList.http |
1489 | DEFAULT: none | |
934b03fc | 1490 | DOC_START |
1491 | Allowing or Denying access based on defined access lists | |
1492 | ||
1493 | Access to the HTTP port: | |
1494 | http_access allow|deny [!]aclname ... | |
1495 | ||
1496 | Access to the ICP port: | |
1497 | icp_access allow|deny [!]aclname ... | |
1498 | ||
1499 | NOTE on default values: | |
1500 | ||
1501 | If there are no "access" lines present, the default is to allow | |
1502 | the request. | |
1503 | ||
1504 | If none of the "access" lines cause a match, the default is the | |
1505 | opposite of the last line in the list. If the last line was | |
1506 | deny, then the default is allow. Conversely, if the last line | |
1507 | is allow, the default will be deny. For these reasons, it is a | |
1508 | good idea to have an "deny all" or "allow all" entry at the end | |
1509 | of your access lists to avoid potential confusion. | |
1510 | ||
c68e9c6b | 1511 | Default configuration: |
1512 | NOCOMMENT_START | |
1513 | http_access allow manager localhost | |
1514 | http_access deny manager | |
499558df | 1515 | http_access deny !Safe_ports |
c68e9c6b | 1516 | http_access deny CONNECT !SSL_ports |
1517 | # | |
1518 | # INSERT YOUR OWN RULE(S) HERE TO ALLOW ACCESS FROM YOUR CLIENTS | |
1519 | # | |
1520 | http_access deny all | |
1521 | NOCOMMENT_END | |
934b03fc | 1522 | DOC_END |
1523 | ||
1524 | ||
1525 | NAME: icp_access | |
1526 | TYPE: acl_access | |
f1dc9b30 | 1527 | LOC: Config.accessList.icp |
1528 | DEFAULT: none | |
934b03fc | 1529 | DOC_START |
1530 | Reply to all ICP queries we receive | |
1531 | ||
c68e9c6b | 1532 | NOCOMMENT_START |
1533 | icp_access allow all | |
1534 | NOCOMMENT_END | |
934b03fc | 1535 | DOC_END |
1536 | ||
1537 | ||
1538 | NAME: miss_access | |
1539 | TYPE: acl_access | |
f1dc9b30 | 1540 | LOC: Config.accessList.miss |
1541 | DEFAULT: none | |
934b03fc | 1542 | DOC_START |
1543 | Use to force your neighbors to use you as a sibling instead of | |
1544 | a parent. For example: | |
1545 | ||
1546 | acl localclients src 172.16.0.0/16 | |
1547 | miss_access allow localclients | |
1548 | miss_access deny !localclients | |
1549 | ||
1550 | This means that only your local clients are allowed to fetch | |
1551 | MISSES and all other clients can only fetch HITS. | |
1552 | ||
1553 | By default, allow all clients who passed the http_access rules | |
1554 | to fetch MISSES from us. | |
c68e9c6b | 1555 | NOCOMMENT_START |
1556 | miss_access allow all | |
1557 | NOCOMMENT_END | |
934b03fc | 1558 | DOC_END |
1559 | ||
1560 | ||
505e35db | 1561 | NAME: cache_peer_access |
1562 | TYPE: peer_access | |
f1dc9b30 | 1563 | DEFAULT: none |
1564 | LOC: none | |
934b03fc | 1565 | DOC_START |
505e35db | 1566 | Similar to 'cache_peer_domain' but provides more flexibility by |
1567 | using ACL elements. | |
934b03fc | 1568 | |
505e35db | 1569 | cache_peer_access cache-host allow|deny [!]aclname ... |
934b03fc | 1570 | |
505e35db | 1571 | The syntax is identical to 'http_access' and the other lists of |
1572 | ACL elements. See the comments for 'http_access' below, or | |
1573 | the Squid FAQ (http://squid.nlanr.net/Squid/FAQ/FAQ-10.html). | |
934b03fc | 1574 | DOC_END |
1575 | ||
f715bd3a | 1576 | NAME: proxy_auth_realm |
1577 | TYPE: eol | |
1578 | DEFAULT: Squid proxy-caching web server | |
1579 | LOC: Config.proxyAuthRealm | |
1580 | DOC_START | |
1581 | Specifies the realm name which is to be reported to the client for | |
1582 | proxy authentication (part of the text the user will see when | |
1583 | prompted their username and password). | |
1584 | ||
1585 | proxy_auth_realm Squid proxy-caching web server | |
1586 | DOC_END | |
1587 | ||
1588 | ||
0f74202c | 1589 | COMMENT_START |
3a278cb8 | 1590 | ADMINISTRATIVE PARAMETERS |
1591 | ----------------------------------------------------------------------------- | |
0f74202c | 1592 | COMMENT_END |
934b03fc | 1593 | |
1594 | NAME: cache_mgr | |
1595 | TYPE: string | |
1596 | DEFAULT: webmaster | |
1597 | LOC: Config.adminEmail | |
1598 | DOC_START | |
1599 | Email-address of local cache manager who will receive | |
1600 | mail if the cache dies. The default is "webmaster." | |
1601 | ||
1602 | cache_mgr webmaster | |
1603 | DOC_END | |
1604 | ||
1605 | ||
1606 | NAME: cache_effective_user | |
0153d498 | 1607 | TYPE: string |
a95856a0 | 1608 | DEFAULT: nobody |
0153d498 | 1609 | LOC: Config.effectiveUser |
1610 | DOC_NONE | |
1611 | ||
1612 | NAME: cache_effective_group | |
1613 | TYPE: string | |
a95856a0 | 1614 | DEFAULT: nogroup |
0153d498 | 1615 | LOC: Config.effectiveGroup |
934b03fc | 1616 | DOC_START |
5a3f6538 | 1617 | |
934b03fc | 1618 | If the cache is run as root, it will change its effective/real |
5a3f6538 | 1619 | UID/GID to the UID/GID specified below. The default is to |
1620 | change to UID to nobody and GID to nogroup. | |
1621 | ||
1622 | If Squid is not started as root, the default is to keep the | |
1623 | current UID/GID. Note that if Squid is not started as root then | |
1624 | you cannot set http_port to a value lower than 1024. | |
934b03fc | 1625 | |
0153d498 | 1626 | cache_effective_user nobody |
1627 | cache_effective_group nogroup | |
934b03fc | 1628 | DOC_END |
1629 | ||
1630 | ||
1631 | NAME: visible_hostname | |
1632 | TYPE: string | |
1633 | LOC: Config.visibleHostname | |
f1dc9b30 | 1634 | DEFAULT: none |
934b03fc | 1635 | DOC_START |
1636 | If you want to present a special hostname in error messages, etc, | |
1637 | then define this. Otherwise, the return value of gethostname() | |
cf5cc17e | 1638 | will be used. If you have multiple caches in a cluster and |
1639 | get errors about IP-forwarding you must set them to have individual | |
1640 | names with this setting. | |
934b03fc | 1641 | |
1642 | visible_hostname www-cache.foo.org | |
1643 | DOC_END | |
1644 | ||
98829f69 | 1645 | |
1646 | NAME: unique_hostname | |
1647 | TYPE: string | |
1648 | LOC: Config.uniqueHostname | |
1649 | DEFAULT: none | |
1650 | DOC_START | |
1651 | If you want to have multiple machines with the same | |
1652 | 'visible_hostname' then you must give each machine a different | |
1653 | 'unique_hostname' so that forwarding loops can be detected. | |
1654 | ||
1655 | unique_hostname www-cache1.foo.org | |
1656 | DOC_END | |
1657 | ||
0f74202c | 1658 | COMMENT_START |
3a278cb8 | 1659 | OPTIONS FOR THE CACHE REGISTRATION SERVICE |
1660 | ----------------------------------------------------------------------------- | |
934b03fc | 1661 | |
3a278cb8 | 1662 | This section contains parameters for the (optional) cache |
1663 | announcement service. This service is provided to help | |
1664 | cache administrators locate one another in order to join or | |
1665 | create cache hierarchies. | |
934b03fc | 1666 | |
3a278cb8 | 1667 | An 'announcement' message is sent (via UDP) to the registration |
1668 | service by Squid. By default, the annoucement message is NOT | |
d2d631ce | 1669 | SENT unless you enable it with 'announce_period' below. |
3a278cb8 | 1670 | |
1671 | The announcement message includes your hostname, plus the | |
1672 | following information from this configuration file: | |
934b03fc | 1673 | |
3a278cb8 | 1674 | http_port |
1675 | icp_port | |
1676 | cache_mgr | |
1677 | ||
1678 | All current information is processed regularly and made | |
d2d631ce | 1679 | available on the Web at http://ircache.nlanr.net/Cache/Tracker/. |
0f74202c | 1680 | COMMENT_END |
934b03fc | 1681 | |
f1dc9b30 | 1682 | NAME: announce_period |
1683 | TYPE: time_t | |
1684 | LOC: Config.Announce.period | |
d2d631ce | 1685 | DEFAULT: 0 |
934b03fc | 1686 | DOC_START |
d2d631ce | 1687 | This is how frequently to send cache announcements. The |
1688 | default is `0' which disables sending the announcement | |
1689 | messages. | |
934b03fc | 1690 | |
d2d631ce | 1691 | To enable announcing your cache, just uncomment the line |
1692 | below. | |
934b03fc | 1693 | |
9e975e4e | 1694 | announce_period 1 day |
934b03fc | 1695 | DOC_END |
1696 | ||
1697 | ||
f1dc9b30 | 1698 | NAME: announce_host |
1699 | TYPE: string | |
61735fcf | 1700 | DEFAULT: tracker.ircache.net |
f1dc9b30 | 1701 | LOC: Config.Announce.host |
1702 | DOC_NONE | |
1703 | ||
cf5cc17e | 1704 | NAME: announce_file |
1705 | TYPE: string | |
61735fcf | 1706 | DEFAULT: none |
cf5cc17e | 1707 | LOC: Config.Announce.file |
1708 | DOC_NONE | |
1709 | ||
f1dc9b30 | 1710 | NAME: announce_port |
1711 | TYPE: ushort | |
1712 | DEFAULT: 3131 | |
1713 | LOC: Config.Announce.port | |
934b03fc | 1714 | DOC_START |
d2d631ce | 1715 | announce_host and announce_port set the hostname and port |
1716 | number where the registration message will be sent. | |
934b03fc | 1717 | |
d2d631ce | 1718 | Hostname will default to 'tracker.ircache.net' and port will |
1719 | default default to 3131. If the 'filename' argument is given, | |
1720 | the contents of that file will be included in the announce | |
1721 | message. | |
934b03fc | 1722 | |
61735fcf | 1723 | announce_host tracker.ircache.net |
f1dc9b30 | 1724 | announce_port 3131 |
934b03fc | 1725 | DOC_END |
1726 | ||
0f74202c | 1727 | COMMENT_START |
3a278cb8 | 1728 | HTTPD-ACCELERATOR OPTIONS |
1729 | ----------------------------------------------------------------------------- | |
0f74202c | 1730 | COMMENT_END |
934b03fc | 1731 | |
f1dc9b30 | 1732 | NAME: httpd_accel_host |
1733 | TYPE: string | |
1734 | LOC: Config.Accel.host | |
1735 | DEFAULT: none | |
1736 | DOC_NONE | |
1737 | ||
1738 | NAME: httpd_accel_port | |
1739 | TYPE: ushort | |
1740 | LOC: Config.Accel.port | |
5b68a4d3 | 1741 | DEFAULT: 80 |
934b03fc | 1742 | DOC_START |
cf5cc17e | 1743 | If you want to run Squid as an httpd accelerator, define the |
934b03fc | 1744 | host name and port number where the real HTTP server is. |
1745 | ||
1746 | If you want virtual host support then specify the hostname | |
1747 | as "virtual". | |
1748 | ||
839491ad | 1749 | NOTE: enabling httpd_accel_host disables proxy-caching and |
1750 | ICP. If you want these features enabled also, then set | |
1751 | the 'httpd_accel_with_proxy' option. | |
1752 | ||
f1dc9b30 | 1753 | httpd_accel_host hostname |
1754 | httpd_accel_port port | |
934b03fc | 1755 | DOC_END |
1756 | ||
1757 | ||
1758 | NAME: httpd_accel_with_proxy | |
1759 | COMMENT: on|off | |
1760 | TYPE: onoff | |
f1dc9b30 | 1761 | DEFAULT: off |
17a0a4ee | 1762 | LOC: Config.onoff.accel_with_proxy |
934b03fc | 1763 | DOC_START |
cf5cc17e | 1764 | If you want to use Squid as both a local httpd accelerator |
934b03fc | 1765 | and as a proxy, change this to 'on'. |
1766 | ||
1767 | httpd_accel_with_proxy off | |
1768 | DOC_END | |
1769 | ||
1770 | ||
1771 | NAME: httpd_accel_uses_host_header | |
1772 | COMMENT: on|off | |
1773 | TYPE: onoff | |
f1dc9b30 | 1774 | DEFAULT: off |
934b03fc | 1775 | LOC: opt_accel_uses_host |
1776 | DOC_START | |
1777 | HTTP/1.1 requests include a Host: header which is basically the | |
1778 | hostname from the URL. Squid can be an accelerator for | |
1779 | different HTTP servers by looking at this header. However, | |
1780 | Squid does NOT check the value of the Host header, so it opens | |
1781 | a big security hole. We recommend that this option remain | |
1782 | disabled unless you are sure of what you are doing. | |
1783 | ||
04f6f348 | 1784 | However, you will need to enable this option if you run Squid |
1785 | as a transparent proxy. Otherwise, virtual servers which | |
1786 | require the Host: header will not be properly cached. | |
934b03fc | 1787 | httpd_accel_uses_host_header off |
1788 | DOC_END | |
1789 | ||
0f74202c | 1790 | COMMENT_START |
3a278cb8 | 1791 | MISCELLANEOUS |
1792 | ----------------------------------------------------------------------------- | |
0f74202c | 1793 | COMMENT_END |
934b03fc | 1794 | |
1795 | NAME: dns_testnames | |
1796 | TYPE: wordlist | |
1797 | LOC: Config.dns_testname_list | |
f1dc9b30 | 1798 | DEFAULT: none |
934b03fc | 1799 | DOC_START |
1800 | The DNS tests exit as soon as the first site is successfully looked up | |
1801 | ||
1802 | If you want to disable DNS tests, do not comment out or delete this | |
1803 | list. Instead use the -D command line option | |
1804 | ||
cf5cc17e | 1805 | dns_testnames netscape.com internic.net nlanr.net microsoft.com |
934b03fc | 1806 | DOC_END |
1807 | ||
1808 | ||
1809 | NAME: logfile_rotate | |
1810 | TYPE: int | |
1811 | DEFAULT: 10 | |
1812 | LOC: Config.Log.rotateNumber | |
1813 | DOC_START | |
5a3f6538 | 1814 | Specifies the number of logfile rotations to make when you |
1815 | type 'squid -k rotate'. The default is 10, which will rotate | |
cf5cc17e | 1816 | with extensions 0 through 9. Setting logfile_rotate to 0 will |
934b03fc | 1817 | disable the rotation, but the logfiles are still closed and |
cf5cc17e | 1818 | re-opened. This will enable you to rename the logfiles |
5a3f6538 | 1819 | yourself just before sending the rotate signal. |
1820 | ||
1821 | Note, the 'squid -k rotate' command normally sends a USR1 | |
1822 | signal to the running squid process. In certain situations | |
1823 | (e.g. on Linux with Async I/O), USR1 is used for other | |
1824 | purposes, so -k rotate uses another signal. It is best to get | |
1825 | in the habit of using 'squid -k rotate' instead of 'kill -USR1 | |
1826 | <pid>'. | |
934b03fc | 1827 | |
1828 | logfile_rotate 10 | |
1829 | DOC_END | |
1830 | ||
1831 | ||
1832 | NAME: append_domain | |
f1dc9b30 | 1833 | TYPE: string |
1834 | LOC: Config.appendDomain | |
1835 | DEFAULT: none | |
934b03fc | 1836 | DOC_START |
cf5cc17e | 1837 | Appends local domain name to hostnames without any dots in |
1838 | them. append_domain must begin with a period. | |
934b03fc | 1839 | |
1840 | append_domain .yourdomain.com | |
1841 | DOC_END | |
1842 | ||
1843 | ||
1844 | NAME: tcp_recv_bufsize | |
89de058c | 1845 | COMMENT: (bytes) |
1b635117 | 1846 | TYPE: b_size_t |
89de058c | 1847 | DEFAULT: 0 bytes |
934b03fc | 1848 | LOC: Config.tcpRcvBufsz |
1849 | DOC_START | |
1850 | Size of receive buffer to set for TCP sockets. Probably just | |
1851 | as easy to change your kernel's default. Set to zero to use | |
1852 | the default buffer size. | |
1853 | ||
89de058c | 1854 | tcp_recv_bufsize 0 bytes |
934b03fc | 1855 | DOC_END |
1856 | ||
934b03fc | 1857 | NAME: err_html_text |
f1dc9b30 | 1858 | TYPE: eol |
1859 | LOC: Config.errHtmlText | |
1860 | DEFAULT: none | |
934b03fc | 1861 | DOC_START |
1862 | HTML text to include in error messages. Make this a "mailto" | |
1863 | URL to your admin address, or maybe just a link to your | |
1864 | organizations Web page. | |
1865 | ||
ab1e6b8a | 1866 | To include this in your error messages, you must rewrite |
1867 | the error template files (found in the "errors" directory). | |
1868 | Wherever you want the 'err_html_text' line to appear, | |
1869 | insert a %L tag in the error template file. | |
934b03fc | 1870 | err_html_text |
1871 | DOC_END | |
1872 | ||
1873 | ||
1874 | NAME: deny_info | |
1875 | TYPE: denyinfo | |
1876 | LOC: Config.denyInfoList | |
f1dc9b30 | 1877 | DEFAULT: none |
934b03fc | 1878 | DOC_START |
02922e76 | 1879 | Usage: deny_info err_page_name acl |
1880 | Example: deny_info ERR_CUSTOM_ACCESS_DENIED bad_guys | |
934b03fc | 1881 | |
02922e76 | 1882 | This can be used to return a ERR_ page for requests which |
934b03fc | 1883 | do not pass the 'http_access' rules. A single ACL will cause |
1884 | the http_access check to fail. If a 'deny_info' line exists | |
02922e76 | 1885 | for that ACL then Squid returns a corresponding error page. |
cf5cc17e | 1886 | |
02922e76 | 1887 | You may use ERR_ pages that come with Squid or create your own pages |
1888 | and put them into the configured errors/ directory. | |
934b03fc | 1889 | DOC_END |
1890 | ||
934b03fc | 1891 | NAME: memory_pools |
1892 | COMMENT: on|off | |
1893 | TYPE: onoff | |
f1dc9b30 | 1894 | DEFAULT: on |
3f6c0fb2 | 1895 | LOC: Config.onoff.mem_pools |
934b03fc | 1896 | DOC_START |
1897 | If set, Squid will keep pools of allocated (but unused) memory | |
1898 | available for future use. If memory is a premium on your | |
7021844c | 1899 | system and you believe your malloc library outperforms Squid |
d0d41f07 | 1900 | routines, disable this. |
934b03fc | 1901 | |
1902 | memory_pools on | |
1903 | DOC_END | |
1904 | ||
7021844c | 1905 | NAME: memory_pools_limit |
1906 | COMMENT: (bytes) | |
1907 | TYPE: b_size_t | |
1908 | DEFAULT: none | |
f12c295b | 1909 | LOC: Config.MemPools.limit |
7021844c | 1910 | DOC_START |
f12c295b | 1911 | Used only with memory_pools on: |
1912 | memory_pools_limit 50 MB | |
7021844c | 1913 | |
f12c295b | 1914 | If set to a non-zero value, Squid will keep at most the specified |
1915 | limit of allocated (but unused) memory in memory pools. All free() | |
1916 | requests that exceed this limit will be handled by your malloc | |
1917 | library. Squid does not pre-allocate any memory, just safe-keeps | |
1918 | objects that otherwise would be free()d. Thus, it is safe to set | |
7021844c | 1919 | memory_pools_limit to a reasonably high value even if your |
f12c295b | 1920 | configuration will use less memory. |
1921 | ||
1922 | If not set (default) or set to zero, Squid will keep all memory it | |
1923 | can. That is, there will be no limit on the total amount of memory | |
1924 | used for safe-keeping. | |
7021844c | 1925 | |
1926 | To disable memory allocation optimization, do not set | |
1927 | memory_pools_limit to 0. Set memory_pools to "off" instead. | |
1928 | ||
f12c295b | 1929 | An overhead for maintaining memory pools is not taken into account |
1930 | when the limit is checked. This overhead is close to four bytes per | |
1931 | object kept. However, pools may actually _save_ memory because of | |
1932 | reduced memory thrashing in your malloc library. | |
7021844c | 1933 | DOC_END |
1934 | ||
934b03fc | 1935 | NAME: forwarded_for |
1936 | COMMENT: on|off | |
1937 | TYPE: onoff | |
f1dc9b30 | 1938 | DEFAULT: on |
934b03fc | 1939 | LOC: opt_forwarded_for |
1940 | DOC_START | |
1941 | If set, Squid will include your system's IP address or name | |
1942 | in the HTTP requests it forwards. By default it looks like | |
1943 | this: | |
1944 | ||
1945 | X-Forwarded-For: 192.1.2.3 | |
1946 | ||
1947 | If you disable this, it will appear as | |
1948 | ||
1949 | X-Forwarded-For: unknown | |
1950 | ||
1951 | forwarded_for on | |
1952 | DOC_END | |
1953 | ||
1954 | NAME: log_icp_queries | |
1955 | COMMENT: on|off | |
1956 | TYPE: onoff | |
f1dc9b30 | 1957 | DEFAULT: on |
17a0a4ee | 1958 | LOC: Config.onoff.log_udp |
934b03fc | 1959 | DOC_START |
cf5cc17e | 1960 | If set, ICP queries are logged to access.log. You may wish |
1961 | do disable this if your ICP load is VERY high to speed things | |
1962 | up or to simplify log analysis. | |
934b03fc | 1963 | |
1964 | log_icp_queries on | |
1965 | DOC_END | |
1966 | ||
88738790 | 1967 | NAME: icp_hit_stale |
1968 | COMMENT: on|off | |
1969 | TYPE: onoff | |
1970 | DEFAULT: off | |
17a0a4ee | 1971 | LOC: Config.onoff.icp_hit_stale |
88738790 | 1972 | DOC_START |
1973 | If you want to return ICP_HIT for stale cache objects, set this | |
1974 | option to 'on'. If you have sibling relationships with caches | |
1975 | in other administrative domains, this should be 'off'. If you only | |
1976 | have sibling relationships with caches under your control, then | |
1977 | it is probably okay to set this to 'on'. | |
1978 | ||
1979 | icp_hit_stale off | |
1980 | DOC_END | |
1981 | ||
934b03fc | 1982 | |
1983 | NAME: minimum_direct_hops | |
1984 | TYPE: int | |
1985 | DEFAULT: 4 | |
1986 | LOC: Config.minDirectHops | |
1987 | DOC_START | |
1988 | If using the ICMP pinging stuff, do direct fetches for sites | |
1989 | which are no more than this many hops away. | |
1990 | ||
1991 | minimum_direct_hops 4 | |
1992 | DOC_END | |
1993 | ||
1994 | ||
1995 | NAME: cachemgr_passwd | |
1996 | TYPE: cachemgrpasswd | |
86101e40 | 1997 | DEFAULT: none |
f1dc9b30 | 1998 | LOC: Config.passwd_list |
934b03fc | 1999 | DOC_START |
2000 | Specify passwords for cachemgr operations. | |
2001 | ||
2002 | Usage: cachemgr_passwd password action action ... | |
2003 | ||
064a674d | 2004 | Some valid actions are (see cache manager menu for a full list): |
2005 | 5min | |
2006 | 60min | |
2007 | asndb | |
2008 | authenticator | |
2009 | cbdata | |
2010 | client_list | |
2011 | comm_incoming | |
2012 | config * | |
2013 | counters | |
2014 | delay | |
2015 | digest_stats | |
cf5cc17e | 2016 | dns |
064a674d | 2017 | events |
cf5cc17e | 2018 | filedescriptors |
064a674d | 2019 | fqdncache |
2020 | histograms | |
2021 | http_headers | |
2022 | info | |
2023 | io | |
2024 | ipcache | |
2025 | mem | |
2026 | menu | |
cf5cc17e | 2027 | netdb |
064a674d | 2028 | non_peers |
2029 | objects | |
2030 | pconn | |
2031 | peer_select | |
2032 | redirector | |
2033 | refresh | |
934b03fc | 2034 | server_list |
064a674d | 2035 | shutdown * |
2036 | store_digest | |
2037 | storedir | |
2038 | utilization | |
2039 | via_headers | |
2040 | vm_objects | |
934b03fc | 2041 | |
2042 | * Indicates actions which will not be performed without a | |
2043 | valid password, others can be performed if not listed here. | |
2044 | ||
2045 | To disable an action, set the password to "disable". | |
2046 | To allow performing an action without a password, set the | |
2047 | password to "none". | |
2048 | ||
2049 | Use the keyword "all" to set the same password for all actions. | |
2050 | ||
2051 | cachemgr_passwd secret shutdown | |
2052 | cachemgr_passwd lesssssssecret info stats/objects | |
2053 | cachemgr_passwd disable all | |
2054 | DOC_END | |
2055 | ||
934b03fc | 2056 | NAME: store_avg_object_size |
86101e40 | 2057 | COMMENT: (kbytes) |
2058 | TYPE: kb_size_t | |
2bf99296 | 2059 | DEFAULT: 13 KB |
934b03fc | 2060 | LOC: Config.Store.avgObjectSize |
2061 | DOC_START | |
2062 | Average object size, used to estimate number of objects your | |
2063 | cache can hold. See doc/Release-Notes-1.1.txt. The default is | |
2bf99296 | 2064 | 13 KB. |
934b03fc | 2065 | |
2bf99296 | 2066 | store_avg_object_size 13 KB |
934b03fc | 2067 | DOC_END |
2068 | ||
2069 | NAME: store_objects_per_bucket | |
2070 | TYPE: int | |
2071 | DEFAULT: 50 | |
2072 | LOC: Config.Store.objectsPerBucket | |
2073 | DOC_START | |
2074 | Target number of objects per bucket in the store hash table. | |
2075 | Lowering this value increases the total number of buckets and | |
2076 | also the storage maintenance rate. The default is 20. | |
2077 | ||
2078 | store_objects_per_bucket 20 | |
2079 | DOC_END | |
2080 | ||
2081 | ||
2082 | NAME: http_anonymizer | |
2083 | TYPE: httpanonymizer | |
17a0a4ee | 2084 | LOC: Config.onoff.anonymizer |
f1dc9b30 | 2085 | DEFAULT: off |
934b03fc | 2086 | DOC_START |
2087 | If you want to filter out certain HTTP request headers for | |
2088 | privacy reasons, enable this option. There are three | |
2089 | appropriate settings: | |
2090 | 'off' All HTTP request headers are passed. | |
2091 | 'standard' Specific headers are removed | |
2092 | 'paranoid' Only specific headers are allowed. | |
2093 | To see which headers are allowed or denied, please see the | |
2094 | http-anon.c source file. | |
2095 | ||
2096 | http_anonymizer off | |
2097 | DOC_END | |
2098 | ||
2099 | ||
2100 | NAME: client_db | |
2101 | COMMENT: on|off | |
2102 | TYPE: onoff | |
f1dc9b30 | 2103 | DEFAULT: on |
17a0a4ee | 2104 | LOC: Config.onoff.client_db |
934b03fc | 2105 | DOC_START |
2106 | If you want to disable collecting per-client statistics, then | |
2107 | turn off client_db here. | |
2108 | ||
2109 | client_db on | |
2110 | DOC_END | |
2111 | ||
2112 | ||
2113 | NAME: netdb_low | |
2114 | TYPE: int | |
2115 | DEFAULT: 900 | |
2116 | LOC: Config.Netdb.low | |
2117 | DOC_NONE | |
2118 | ||
2119 | NAME: netdb_high | |
2120 | TYPE: int | |
2121 | DEFAULT: 1000 | |
2122 | LOC: Config.Netdb.high | |
2123 | DOC_START | |
2124 | The low and high water marks for the ICMP measurement | |
2125 | database. These are counts, not percents. The defaults are | |
2126 | 900 and 1000. When the high water mark is reached, database | |
2127 | entries will be deleted until the low mark is reached. | |
2128 | ||
2129 | netdb_low 900 | |
2130 | netdb_high 1000 | |
2131 | DOC_END | |
2132 | ||
2133 | ||
2134 | NAME: netdb_ping_period | |
f1dc9b30 | 2135 | TYPE: time_t |
934b03fc | 2136 | LOC: Config.Netdb.period |
9e975e4e | 2137 | DEFAULT: 5 minutes |
934b03fc | 2138 | DOC_START |
2139 | The minimum period for measuring a site. There will be at | |
2140 | least this much delay between successive pings to the same | |
2141 | network. The default is five minutes. | |
2142 | ||
2143 | netdb_ping_period 5 minutes | |
2144 | DOC_END | |
2145 | ||
2146 | ||
2147 | NAME: query_icmp | |
2148 | COMMENT: on|off | |
2149 | TYPE: onoff | |
f1dc9b30 | 2150 | DEFAULT: off |
17a0a4ee | 2151 | LOC: Config.onoff.query_icmp |
934b03fc | 2152 | DOC_START |
2153 | If you want to ask your peers to include ICMP data in their ICP | |
2154 | replies, enable this option. | |
2155 | ||
cf5cc17e | 2156 | If your peer has configured Squid (during compilation) with |
2157 | '--enable-icmp' then that peer will send ICMP pings to origin server | |
2158 | sites of the URLs it receives. If you enable this option then the | |
2159 | ICP replies from that peer will include the ICMP data (if available). | |
2160 | Then, when choosing a parent cache, Squid will choose the parent with | |
934b03fc | 2161 | the minimal RTT to the origin server. When this happens, the |
2162 | hierarchy field of the access.log will be | |
2163 | "CLOSEST_PARENT_MISS". This option is off by default. | |
2164 | ||
2165 | query_icmp off | |
2166 | DOC_END | |
2167 | ||
88500f96 | 2168 | NAME: test_reachability |
194dd3b8 | 2169 | COMMENT: on|off |
2170 | TYPE: onoff | |
2171 | DEFAULT: off | |
2172 | LOC: Config.onoff.test_reachability | |
2173 | DOC_START | |
2174 | When this is 'on', ICP MISS replies will be ICP_MISS_NOFETCH | |
2175 | instead of ICP_MISS if the target host is NOT in the ICMP | |
2176 | database, or has a zero RTT. | |
2177 | ||
2178 | test_reachability off | |
2179 | DOC_END | |
2180 | ||
78f1250a | 2181 | NAME: buffered_logs |
2182 | COMMENT: on|off | |
2183 | TYPE: onoff | |
2184 | DEFAULT: off | |
17a0a4ee | 2185 | LOC: Config.onoff.buffered_logs |
78f1250a | 2186 | DOC_START |
2187 | Some log files (cache.log, useragent.log) are written with | |
2188 | stdio functions, and as such they can be buffered or | |
cf5cc17e | 2189 | unbuffered. By default they will be unbuffered. Buffering them |
2190 | can speed up the writing slightly (though you are unlikely to | |
2191 | need to worry). | |
78f1250a | 2192 | buffered_logs off |
2193 | DOC_END | |
2194 | ||
465dc415 | 2195 | NAME: reload_into_ims |
9f60cfdf | 2196 | IFDEF: HTTP_VIOLATIONS |
465dc415 | 2197 | COMMENT: on|off |
2198 | TYPE: onoff | |
2199 | DEFAULT: off | |
2200 | LOC: Config.onoff.reload_into_ims | |
2201 | DOC_START | |
2202 | When you enable this option, client no-cache or ``reload'' | |
2203 | requests will be changed to If-Modified-Since requests. | |
2204 | Doing this VIOLATES the HTTP standard. Enabling this | |
2205 | feature could make you liable for problems which it | |
2206 | causes. | |
cbe3a719 | 2207 | |
2208 | see also refresh_pattern for a more selective approach. | |
2209 | ||
465dc415 | 2210 | reload_into_ims off |
2211 | DOC_END | |
2212 | ||
934b03fc | 2213 | NAME: always_direct |
2214 | TYPE: acl_access | |
2215 | LOC: Config.accessList.AlwaysDirect | |
f1dc9b30 | 2216 | DEFAULT: none |
934b03fc | 2217 | DOC_START |
2a78fa67 | 2218 | Usage: always_direct allow|deny [!]aclname ... |
2219 | ||
2220 | Here you can use ACL elements to specify requests which should | |
3445a83a | 2221 | ALWAYS be forwarded directly to origin servers. For example, |
2222 | to always directly forward requests for local servers use | |
2a78fa67 | 2223 | something like: |
2224 | ||
2225 | acl local-servers dstdomain my.domain.net | |
2226 | always_direct allow local-servers | |
2227 | ||
2228 | To always forward FTP requests directly, use | |
2229 | ||
2230 | acl FTP proto FTP | |
2231 | always_direct allow FTP | |
2232 | ||
2233 | NOTE: There is a similar, but opposite option named | |
2234 | 'never_direct'. You need to be aware that "always_direct deny | |
2235 | foo" is NOT the same thing as "never_direct allow foo". You | |
2236 | may need to use a deny rule to exclude a more-specific case of | |
2237 | some other rule. Example: | |
2238 | ||
2239 | acl local-external dstdomain external.foo.net | |
2240 | acl local-servers dstdomain foo.net | |
2241 | always_direct deny local-external | |
2242 | always_direct allow local-servers | |
3445a83a | 2243 | |
2244 | This option replaces some v1.1 options such as local_domain | |
2245 | and local_ip. | |
934b03fc | 2246 | DOC_END |
2247 | ||
2248 | NAME: never_direct | |
2249 | TYPE: acl_access | |
2250 | LOC: Config.accessList.NeverDirect | |
f1dc9b30 | 2251 | DEFAULT: none |
934b03fc | 2252 | DOC_START |
d0d41f07 | 2253 | Usage: never_direct allow|deny [!]aclname ... |
2a78fa67 | 2254 | |
2255 | never_direct is the opposite of always_direct. Please read | |
2256 | the description for always_direct if you have not already. | |
934b03fc | 2257 | |
2a78fa67 | 2258 | With 'never_direct' you can use ACL elements to specify |
2259 | requests which should NEVER be forwarded directly to origin | |
3445a83a | 2260 | servers. For example, to force the use of a proxy for all |
2261 | requests, except those in your local domain use something like: | |
2a78fa67 | 2262 | |
3445a83a | 2263 | acl local-servers dstdomain foo.net |
2a78fa67 | 2264 | acl all src 0.0.0.0/0.0.0.0 |
d0d41f07 | 2265 | never_direct deny local-servers |
2266 | never_direct allow all | |
3445a83a | 2267 | |
2268 | or if squid is inside a firewall and there is local intranet | |
2269 | servers inside the firewall then use something like: | |
2270 | ||
2271 | acl local-intranet dstdomain foo.net | |
2272 | acl local-external dstdomain external.foo.net | |
2273 | always_direct deny local-external | |
2274 | always_direct allow local-intranet | |
2275 | never_direct allow all | |
2276 | ||
2277 | This option replaces some v1.1 options such as inside_firewall | |
2278 | and firewall_ip. | |
2a78fa67 | 2279 | DOC_END |
934b03fc | 2280 | |
88738790 | 2281 | NAME: fake_user_agent |
2282 | TYPE: eol | |
2283 | LOC: Config.fake_ua | |
2284 | DEFAULT: none | |
2285 | DOC_START | |
d0d41f07 | 2286 | If you use the paranoid http_anonymizer setting, Squid will strip |
2287 | your User-agent string from the request. Some Web servers will | |
2288 | refuse your request without a User-agent string. Use this to | |
2289 | fake one up. For example: | |
88738790 | 2290 | |
d0d41f07 | 2291 | fake_user_agent Nutscrape/1.0 (CP/M; 8-bit) |
2292 | (credit to Paul Southworth pauls@etext.org for this one!) | |
88738790 | 2293 | |
2294 | fake_user_agent none | |
2295 | DOC_END | |
2296 | ||
365cb147 | 2297 | NAME: icon_directory |
f0b19334 | 2298 | TYPE: string |
365cb147 | 2299 | LOC: Config.icons.directory |
2300 | DEFAULT: @DEFAULT_ICON_DIR@ | |
2301 | DOC_START | |
cf5cc17e | 2302 | Where the icons are stored. These are normally kept in |
2303 | @DEFAULT_ICON_DIR@ | |
365cb147 | 2304 | DOC_END |
2305 | ||
cf5cc17e | 2306 | NAME: error_directory |
365cb147 | 2307 | TYPE: string |
cf5cc17e | 2308 | LOC: Config.errorDirectory |
2309 | DEFAULT: @DEFAULT_ERROR_DIR@ | |
365cb147 | 2310 | DOC_START |
cf5cc17e | 2311 | If you wish to create your own versions of the default |
2312 | (English) error files, either to customise them to suit your | |
2313 | language or company copy the template english files to anther | |
2314 | directory and point this tag at them. | |
365cb147 | 2315 | DOC_END |
88738790 | 2316 | |
22c653cd | 2317 | NAME: minimum_retry_timeout |
2318 | COMMENT: (seconds) | |
2319 | TYPE: time_t | |
2320 | LOC: Config.retry.timeout | |
2321 | DEFAULT: 5 seconds | |
2322 | DOC_START | |
2323 | This specifies the minimum connect timeout, for when the | |
2324 | connect timeout is reduced to compensate for the availability | |
2325 | of multiple IP addresses. | |
2326 | ||
cf5cc17e | 2327 | When a connection to a host is initiated, and that host has |
2328 | several IP addresses, the default connection timeout is reduced | |
2329 | by dividing it by the number of addresses. So, a site with 15 | |
2330 | addresses would then have a timeout of 8 seconds for each | |
2331 | address attempted. To avoid having the timeout reduced to the | |
2332 | point where even a working host would not have a chance to | |
2333 | respond, this setting is provided. The default, and the | |
2334 | minimum value, is five seconds, and the maximum value is sixty | |
2335 | seconds, or half of connect_timeout, whichever is greater and | |
2336 | less than connect_timeout. | |
22c653cd | 2337 | |
cf5cc17e | 2338 | minimum_retry_timeout 5 seconds |
22c653cd | 2339 | DOC_END |
2340 | ||
2341 | NAME: maximum_single_addr_tries | |
2342 | TYPE: int | |
2343 | LOC: Config.retry.maxtries | |
2344 | DEFAULT: 3 | |
2345 | DOC_START | |
2346 | This sets the maximum number of connection attempts for a | |
2347 | host that only has one address (for multiple-address hosts, | |
2348 | each address is tried once). | |
2349 | ||
2350 | The default value is three tries, the (not recommended) | |
2351 | maximum is 255 tries. A warning message will be generated | |
2352 | if it is set to a value greater than ten. | |
2353 | ||
2354 | maximum_single_addr_tries 3 | |
2355 | DOC_END | |
6d1c0d53 | 2356 | |
a97cfa48 | 2357 | NAME: snmp_port |
2358 | TYPE: ushort | |
2359 | LOC: Config.Port.snmp | |
2360 | DEFAULT: 3401 | |
1df370e3 | 2361 | IFDEF: SQUID_SNMP |
a97cfa48 | 2362 | DOC_START |
cf5cc17e | 2363 | Squid can now serve statistics and status information via SNMP. |
2364 | By default it listens to port 3401 on the machine. If you don't | |
2365 | wish to use SNMP, set this to '-1'. | |
2366 | ||
2367 | NOTE: SNMP support requires use the --enable-snmp configure | |
2368 | command line option. | |
794a4fea | 2369 | snmp_port 3401 |
a97cfa48 | 2370 | DOC_END |
2371 | ||
a97cfa48 | 2372 | NAME: forward_snmpd_port |
2373 | TYPE: ushort | |
2374 | LOC: Config.Snmp.localPort | |
2375 | DEFAULT: 0 | |
1df370e3 | 2376 | IFDEF: SQUID_SNMP |
a97cfa48 | 2377 | DOC_START |
2378 | This configures whether we should be forwarding SNMP requests | |
cf5cc17e | 2379 | to another snmpd. The reason for putting this piece of |
2380 | functionality into Squid was to enable access to the system's | |
2381 | installed snmpd with minimal changes. This option is turned | |
2382 | off by default, check with your /etc/services for your system's | |
2383 | snmp port (usually 161). We do not use getservbyname() to | |
2384 | allow you to set Squid into port 161 and your system's snmpd to | |
2385 | another port by changing /etc/services. | |
2386 | ||
d0d41f07 | 2387 | WARNING: Because of Squid acting as a proxy snmpd for system |
2388 | you have to do security checks on THIS snmpd for all objects. | |
2389 | Check your snmp_config_file. | |
794a4fea | 2390 | forward_snmpd_port 0 |
a97cfa48 | 2391 | DOC_END |
2392 | ||
dba79ac5 | 2393 | NAME: snmp_access |
2394 | TYPE: acl_access | |
2395 | LOC: Config.accessList.snmp | |
a97cfa48 | 2396 | DEFAULT: none |
1df370e3 | 2397 | IFDEF: SQUID_SNMP |
a97cfa48 | 2398 | DOC_START |
dba79ac5 | 2399 | Allowing or denying access to the SNMP port. |
08f6b5e0 | 2400 | |
2401 | All access to the agent is denied by default. | |
dba79ac5 | 2402 | usage: |
4feb7b2e | 2403 | |
dba79ac5 | 2404 | snmp_access allow|deny [!]aclname ... |
08f6b5e0 | 2405 | |
2406 | Example: | |
2407 | snmp_access allow public localhost | |
2408 | snmp_access deny all | |
2409 | ||
2410 | NOCOMMENT_START | |
2411 | snmp_access deny all | |
2412 | NOCOMMENT_END | |
bdf18524 | 2413 | DOC_END |
2414 | ||
15dcc168 | 2415 | NAME: snmp_incoming_address |
2416 | TYPE: address | |
2417 | LOC: Config.Addrs.snmp_outgoing | |
2418 | DEFAULT: 0.0.0.0 | |
2419 | IFDEF: SQUID_SNMP | |
2420 | DOC_NONE | |
2421 | NAME: snmp_outgoing_address | |
2422 | TYPE: address | |
2423 | LOC: Config.Addrs.snmp_outgoing | |
2424 | DEFAULT: 255.255.255.255 | |
2425 | IFDEF: SQUID_SNMP | |
2426 | DOC_START | |
2427 | Just like 'udp_incoming_address' above, but for the SNMP port. | |
2428 | ||
2429 | snmp_incoming_address is used for the SNMP socket receiving | |
2430 | messages from SNMP agents. | |
2431 | snmp_outgoing_address is used for SNMP packets returned to SNMP | |
2432 | agents. | |
2433 | ||
2434 | The default behaviour is to not bind to any specific address. | |
2435 | ||
2436 | NOTE, snmp_incoming_address and snmp_outgoing_address can not have | |
2437 | the same value since they both use port 3130. | |
2438 | ||
2439 | snmp_incoming_address 0.0.0.0 | |
2440 | snmp_outgoing_address 0.0.0.0 | |
2441 | DOC_END | |
bdf18524 | 2442 | |
53ad48e6 | 2443 | NAME: as_whois_server |
2444 | TYPE: string | |
2445 | LOC: Config.as_whois_server | |
2446 | DEFAULT: whois.ra.net | |
2447 | DEFAULT_IF_NONE: whois.ra.net | |
2448 | DOC_START | |
cf5cc17e | 2449 | WHOIS server to query for AS numbers. NOTE: AS numbers are |
2450 | queried only when Squid starts up, not for every request. | |
53ad48e6 | 2451 | DOC_END |
95e36d02 | 2452 | |
2453 | COMMENT_START | |
2454 | DELAY POOL PARAMETERS (all require DELAY_POOLS compilation option) | |
2455 | ----------------------------------------------------------------------------- | |
2456 | ||
2457 | A general note on delay pools - the first matched delay pool is used, | |
2458 | that is, if a request falls into class1 then it isn't checked for class2 | |
2459 | or class3 (and similarly a class2 request isn't checked for class3). | |
2460 | COMMENT_END | |
2461 | ||
2462 | NAME: delay_class1_access | |
2463 | TYPE: acl_access | |
2464 | DEFAULT: none | |
2465 | IFDEF: DELAY_POOLS | |
2466 | LOC: Config.Delay.class1.access | |
2467 | DOC_START | |
2468 | This is used to select what client requests are processed via | |
2469 | the first ("class 1") delay pool. In this delay pool only the | |
2470 | aggregate traffic allowance is configurable. | |
2471 | DOC_END | |
2472 | ||
2473 | NAME: delay_class2_access | |
2474 | TYPE: acl_access | |
2475 | DEFAULT: none | |
2476 | IFDEF: DELAY_POOLS | |
2477 | LOC: Config.Delay.class2.access | |
2478 | DOC_START | |
2479 | This is used to select what client requests are processed via | |
2480 | the first ("class 2") delay pool. In this delay pool both the | |
2481 | aggregate and per-host traffic allowance are configurable. | |
2482 | There are 254 individual delay pools based on the last 8 bits | |
2483 | of the client IP address (addresses ending in 0 and 255 are not | |
2484 | permitted). | |
2485 | DOC_END | |
2486 | ||
2487 | NAME: delay_class3_access | |
2488 | TYPE: acl_access | |
2489 | DEFAULT: none | |
2490 | IFDEF: DELAY_POOLS | |
2491 | LOC: Config.Delay.class3.access | |
2492 | DOC_START | |
2493 | This is used to select what client requests are processed via | |
2494 | the first ("class 3") delay pool. In this delay pool, the | |
2495 | aggregate, network and per-host traffic allowance are | |
2496 | configurable. There are 255 network delay pools based on the | |
2497 | 17th to 24th bit of the client IP address (network 255 is not | |
2498 | permitted), and individual delay pools based on the last 16 | |
2499 | bits of the client IP address (network 255 and hosts ending in | |
2500 | 0 and 255 are not permitted). | |
2501 | DOC_END | |
2502 | ||
2503 | NAME: delay_class1_aggregate_restore | |
2504 | TYPE: int | |
2505 | DEFAULT: -1 | |
2506 | IFDEF: DELAY_POOLS | |
2507 | COMMENT: (bps) | |
2508 | LOC: Config.Delay.class1.aggregate.restore_bps | |
2509 | DOC_START | |
2510 | The number of bytes per second added to the class 1 aggregate | |
2511 | delay pool traffic allowance (-1 to disable the delay pool). | |
2512 | DOC_END | |
2513 | ||
2514 | NAME: delay_class1_aggregate_max | |
2515 | TYPE: int | |
2516 | DEFAULT: -1 | |
2517 | IFDEF: DELAY_POOLS | |
2518 | COMMENT: (bytes) | |
2519 | LOC: Config.Delay.class1.aggregate.max_bytes | |
2520 | DOC_START | |
2521 | The maximum number of bytes which can be in the class 1 | |
2522 | aggregate delay pool traffic allowance. | |
2523 | DOC_END | |
2524 | ||
2525 | NAME: delay_class2_aggregate_restore | |
2526 | TYPE: int | |
2527 | DEFAULT: -1 | |
2528 | IFDEF: DELAY_POOLS | |
2529 | COMMENT: (bps) | |
2530 | LOC: Config.Delay.class2.aggregate.restore_bps | |
2531 | DOC_START | |
2532 | The number of bytes per second added to the class 2 aggregate | |
2533 | delay pool traffic allowance (-1 to disable the delay pool). | |
2534 | DOC_END | |
2535 | ||
2536 | NAME: delay_class2_aggregate_max | |
2537 | TYPE: int | |
2538 | DEFAULT: -1 | |
2539 | IFDEF: DELAY_POOLS | |
2540 | COMMENT: (bytes) | |
2541 | LOC: Config.Delay.class2.aggregate.max_bytes | |
2542 | DOC_START | |
2543 | The maximum number of bytes which can be in the class 2 | |
2544 | aggregate delay pool traffic allowance. | |
2545 | DOC_END | |
2546 | ||
2547 | NAME: delay_class2_individual_restore | |
2548 | TYPE: int | |
2549 | DEFAULT: -1 | |
2550 | IFDEF: DELAY_POOLS | |
2551 | COMMENT: (bps) | |
2552 | LOC: Config.Delay.class2.individual.restore_bps | |
2553 | DOC_START | |
2554 | The number of bytes per second added to the class 2 individual | |
2555 | host delay pool traffic allowances (-1 to disable these delay | |
2556 | pools). | |
2557 | DOC_END | |
2558 | ||
2559 | NAME: delay_class2_individual_max | |
2560 | TYPE: int | |
2561 | DEFAULT: -1 | |
2562 | IFDEF: DELAY_POOLS | |
2563 | COMMENT: (bytes) | |
2564 | LOC: Config.Delay.class2.individual.max_bytes | |
2565 | DOC_START | |
2566 | The maximum number of bytes which can be in the class 2 | |
2567 | individual host delay pool traffic allowances. | |
2568 | DOC_END | |
2569 | ||
2570 | NAME: delay_class3_aggregate_restore | |
2571 | TYPE: int | |
2572 | DEFAULT: -1 | |
2573 | IFDEF: DELAY_POOLS | |
2574 | COMMENT: (bps) | |
2575 | LOC: Config.Delay.class3.aggregate.restore_bps | |
2576 | DOC_START | |
2577 | The number of bytes per second added to the class 3 aggregate | |
2578 | delay pool traffic allowance (-1 to disable the delay pool). | |
2579 | DOC_END | |
2580 | ||
2581 | NAME: delay_class3_aggregate_max | |
2582 | TYPE: int | |
2583 | DEFAULT: -1 | |
2584 | IFDEF: DELAY_POOLS | |
2585 | COMMENT: (bytes) | |
2586 | LOC: Config.Delay.class3.aggregate.max_bytes | |
2587 | DOC_START | |
2588 | The maximum number of bytes which can be in the class 3 | |
2589 | aggregate delay pool traffic allowance. | |
2590 | DOC_END | |
2591 | ||
2592 | NAME: delay_class3_network_restore | |
2593 | TYPE: int | |
2594 | DEFAULT: -1 | |
2595 | IFDEF: DELAY_POOLS | |
2596 | COMMENT: (bps) | |
2597 | LOC: Config.Delay.class3.network.restore_bps | |
2598 | DOC_START | |
2599 | The number of bytes per second added to the class 3 8-bit | |
2600 | network delay pool traffic allowances (-1 to disable these | |
2601 | delay pools). | |
2602 | DOC_END | |
2603 | ||
2604 | NAME: delay_class3_network_max | |
2605 | TYPE: int | |
2606 | DEFAULT: -1 | |
2607 | IFDEF: DELAY_POOLS | |
2608 | COMMENT: (bytes) | |
2609 | LOC: Config.Delay.class3.network.max_bytes | |
2610 | DOC_START | |
2611 | The maximum number of bytes which can be in the class 3 8-bit | |
2612 | network delay pool traffic allowances. | |
2613 | DOC_END | |
2614 | ||
2615 | NAME: delay_class3_individual_restore | |
2616 | TYPE: int | |
2617 | DEFAULT: -1 | |
2618 | IFDEF: DELAY_POOLS | |
2619 | COMMENT: (bps) | |
2620 | LOC: Config.Delay.class3.individual.restore_bps | |
2621 | DOC_START | |
2622 | The number of bytes per second added to the class 3 individual | |
2623 | host delay pool traffic allowances (-1 to disable these delay | |
2624 | pools). | |
2625 | DOC_END | |
2626 | ||
2627 | NAME: delay_class3_individual_max | |
2628 | TYPE: int | |
2629 | DEFAULT: -1 | |
2630 | IFDEF: DELAY_POOLS | |
2631 | COMMENT: (bytes) | |
2632 | LOC: Config.Delay.class3.individual.max_bytes | |
2633 | DOC_START | |
2634 | The maximum number of bytes which can be in the class 3 | |
2635 | individual host delay pool traffic allowances. | |
2636 | DOC_END | |
6be2389e | 2637 | |
9cd6c6fb | 2638 | NAME: incoming_icp_average |
6be2389e | 2639 | TYPE: int |
2640 | DEFAULT: 6 | |
2641 | LOC: Config.comm_incoming.icp_average | |
2642 | DOC_NONE | |
2643 | ||
9cd6c6fb | 2644 | NAME: incoming_http_average |
6be2389e | 2645 | TYPE: int |
2646 | DEFAULT: 4 | |
2647 | LOC: Config.comm_incoming.http_average | |
2648 | DOC_NONE | |
2649 | ||
9cd6c6fb | 2650 | NAME: min_icp_poll_cnt |
6be2389e | 2651 | TYPE: int |
2652 | DEFAULT: 8 | |
2653 | LOC: Config.comm_incoming.icp_min_poll | |
2654 | DOC_NONE | |
2655 | ||
9cd6c6fb | 2656 | NAME: min_http_poll_cnt |
6be2389e | 2657 | TYPE: int |
2658 | DEFAULT: 8 | |
2659 | LOC: Config.comm_incoming.http_min_poll | |
2660 | DOC_START | |
2661 | Heavy voodoo here. I can't even beleve you are reading this. | |
2662 | Are you crazy? Don't even think about adjusting these unless | |
2663 | you understand the algorithms in comm_select.c first! | |
8d3285ea | 2664 | |
2665 | incoming_icp_average 6 | |
2666 | incoming_http_average 4 | |
2667 | min_icp_poll_cnt 8 | |
2668 | min_http_poll_cnt 8 | |
6be2389e | 2669 | DOC_END |
2b4283e4 | 2670 | |
c5f627c2 | 2671 | NAME: max_open_disk_fds |
2672 | TYPE: int | |
2673 | LOC: Config.max_open_disk_fds | |
2674 | DEFAULT: 0 | |
2675 | DOC_NONE | |
2676 | ||
b540e168 | 2677 | NAME: offline_mode |
2678 | TYPE: onoff | |
2679 | LOC: Config.onoff.offline | |
2680 | DEFAULT: off | |
2681 | DOC_START | |
2682 | Enable this option and Squid will never try to validate cached | |
2683 | objects. | |
2684 | DOC_END | |
2685 | ||
d548ee64 | 2686 | NAME: uri_whitespace |
2687 | TYPE: uri_whitespace | |
2688 | LOC: Config.uri_whitespace | |
2689 | DEFAULT: deny | |
2690 | DOC_START | |
2691 | What to do with requests that have whitespace characters in the | |
2692 | URI. Options: | |
2693 | ||
2694 | deny: The request is denied. The user receives an "Invalid | |
2695 | Request" message. | |
2696 | allow: The request is allowed and the URI is not changed. The | |
2697 | whitespace characters remain in the URI. Note the | |
2698 | whitespace is passed to redirector processes if they | |
2699 | are in use. | |
2700 | encode: The request is allowed and the whitespace characters are | |
2701 | encoded according to RFC1738. This could be considered | |
2702 | a violation of the HTTP/1.1 | |
2703 | RFC because proxies are not allowed to rewrite URI's. | |
2704 | chop: The request is allowed and the URI is chopped at the | |
2705 | first whitespace. This might also be considered a | |
2706 | violation. | |
2707 | uri_whitespace deny | |
2708 | DOC_END | |
2709 | ||
c68e9c6b | 2710 | NAME: persistent_client_posts |
2711 | TYPE: onoff | |
2712 | LOC: Config.onoff.persistent_client_posts | |
2713 | DEFAULT: on | |
2714 | DOC_START | |
2715 | Turn this 'off' to disable persistent connections for POST | |
2716 | requests. When you disable this, Squid reads all bytes | |
2717 | from the client request and sends them to the server. This | |
2718 | makes Squid work with broken HTTP servers which expect the | |
2719 | additional CRLF pair from broken web clients. | |
2720 | persistent_client_posts on | |
2721 | DOC_END | |
9b094667 | 2722 | |
2723 | NAME: prefer_direct | |
2724 | TYPE: onoff | |
2725 | LOC: Config.onoff.prefer_direct | |
2726 | DEFAULT: on | |
2727 | DOC_START | |
2728 | By default, if the ICP, HTCP, Cache Digest, etc. techniques | |
2729 | do not yield a parent cache, Squid gives higher preference | |
2730 | to forwarding the request direct to origin servers, rather | |
2731 | than selecting a parent cache anyway. | |
2732 | ||
2733 | If you want Squid to give higher precedence to a parent | |
2734 | cache, instead of going direct, then turn this option off. | |
2735 | prefer_direct on | |
2736 | DOC_END | |
4d62b0af | 2737 | |
2b4283e4 | 2738 | EOF |