]>
Commit | Line | Data |
---|---|---|
3a278cb8 | 1 | |
0f74202c | 2 | COMMENT_START |
3 | WELCOME TO SQUID 1.2 | |
4 | -------------------- | |
3a278cb8 | 5 | |
cf5cc17e | 6 | This is the default Squid configuration file. You may wish |
b58b1ad6 | 7 | to look at http://cache.is.co.za/squid/ for documentation, |
8 | or the Squid home page (http://squid.nlanr.net/) for the FAQ. | |
3a278cb8 | 9 | |
0f74202c | 10 | COMMENT_END |
3a278cb8 | 11 | |
0f74202c | 12 | COMMENT_START |
3a278cb8 | 13 | NETWORK OPTIONS |
14 | ----------------------------------------------------------------------------- | |
0f74202c | 15 | COMMENT_END |
3a278cb8 | 16 | |
934b03fc | 17 | NAME: http_port ascii_port |
18 | TYPE: ushortlist | |
f53b06f9 | 19 | DEFAULT: none |
20 | DEFAULT_IF_NONE: 3128 | |
934b03fc | 21 | LOC: Config.Port.http |
22 | DOC_START | |
cf5cc17e | 23 | The port number where Squid will listen for HTTP client |
934b03fc | 24 | requests. Default is 3128, for httpd-accel mode use port 80. |
25 | May be overridden with -a on the command line. | |
26 | ||
27 | You may specify multiple ports here, but they MUST all be on | |
28 | a single line. | |
29 | ||
30 | http_port 3128 | |
31 | DOC_END | |
32 | ||
33 | ||
34 | NAME: icp_port udp_port | |
35 | TYPE: ushort | |
36 | DEFAULT: 3130 | |
37 | LOC: Config.Port.icp | |
38 | DOC_START | |
459f1836 | 39 | The port number where Squid sends and receives ICP requests to |
934b03fc | 40 | and from neighbor caches. Default is 3130. To disable use |
41 | "0". May be overridden with -u on the command line. | |
42 | ||
43 | icp_port 3130 | |
44 | DOC_END | |
45 | ||
459f1836 | 46 | NAME: htcp_port |
47 | IFDEF: USE_HTCP | |
48 | TYPE: ushort | |
49 | DEFAULT: 4827 | |
50 | LOC: Config.Port.htcp | |
51 | DOC_START | |
52 | The port number where Squid sends and receives ICP requests to | |
53 | and from neighbor caches. Default is 4827. To disable use | |
54 | "0". | |
55 | ||
56 | htcp_port 4827 | |
57 | DOC_END | |
58 | ||
934b03fc | 59 | |
60 | NAME: mcast_groups | |
61 | TYPE: wordlist | |
62 | LOC: Config.mcast_group_list | |
1273d501 | 63 | DEFAULT: none |
934b03fc | 64 | DOC_START |
cf5cc17e | 65 | This tag specifies a list of multicast groups which your server |
66 | should join to receive multicasted ICP requests. | |
934b03fc | 67 | |
68 | NOTE! Be very careful what you put here! Be sure you | |
69 | understand the difference between an ICP _query_ and an ICP | |
70 | _reply_. This option is to be set only if you want to RECEIVE | |
71 | multicast queries. Do NOT set this option to SEND multicast | |
a95856a0 | 72 | ICP (use cache_peer for that). ICP replies are always sent via |
934b03fc | 73 | unicast, so this option does not affect whether or not you will |
74 | receive replies from multicast group members. | |
75 | ||
76 | You must be very careful to NOT use a multicast address which | |
77 | is already in use by another group of caches. NLANR has been | |
78 | assigned a block of multicast address space for use in Web | |
79 | Caching. Plese write to us at nlanr-cache@nlanr.net to receive | |
80 | an address for your own use. | |
81 | ||
cf5cc17e | 82 | If you are unsure about multicast, please read the Multicast |
83 | chapter in the Squid FAQ (http://squid.nlanr.net/Squid/FAQ/). | |
84 | ||
934b03fc | 85 | Usage: mcast_groups 239.128.16.128 224.0.1.20 |
86 | ||
cf5cc17e | 87 | By default, Squid doesn't listen on any multicast groups. |
934b03fc | 88 | |
89 | mcast_groups 239.128.16.128 | |
90 | DOC_END | |
91 | ||
92 | ||
93 | NAME: tcp_incoming_address bind_address | |
94 | TYPE: address | |
95 | LOC: Config.Addrs.tcp_incoming | |
270b86af | 96 | DEFAULT: 0.0.0.0 |
934b03fc | 97 | DOC_NONE |
98 | ||
99 | NAME: tcp_outgoing_address outbound_address | |
100 | TYPE: address | |
101 | LOC: Config.Addrs.tcp_outgoing | |
270b86af | 102 | DEFAULT: 255.255.255.255 |
934b03fc | 103 | DOC_NONE |
104 | ||
105 | NAME: udp_incoming_address | |
106 | TYPE: address | |
107 | LOC:Config.Addrs.udp_incoming | |
270b86af | 108 | DEFAULT: 0.0.0.0 |
934b03fc | 109 | DOC_NONE |
110 | ||
111 | NAME: udp_outgoing_address | |
112 | TYPE: address | |
113 | LOC: Config.Addrs.udp_outgoing | |
270b86af | 114 | DEFAULT: 255.255.255.255 |
934b03fc | 115 | DOC_START |
116 | Usage: tcp_incoming_address 10.20.30.40 | |
117 | udp_outgoing_address fully.qualified.domain.name | |
118 | ||
934b03fc | 119 | tcp_incoming_address is used for the HTTP socket which accepts |
120 | connections from clients and other caches. | |
121 | tcp_outgoing_address is used for connections made to remote | |
122 | servers and other caches. | |
123 | udp_incoming_address is used for the ICP socket receiving packets | |
124 | from other caches. | |
125 | udp_outgoing_address is used for ICP packets sent out to other | |
126 | caches. | |
127 | ||
128 | The defaults behaviour is to not bind to any specific address. | |
129 | ||
130 | NOTE, udp_incoming_address and udp_outgoing_address can not have | |
131 | the same value since they both use port 3130. | |
132 | ||
133 | tcp_incoming_address 0.0.0.0 | |
134 | tcp_outgoing_address 0.0.0.0 | |
135 | udp_incoming_address 0.0.0.0 | |
136 | udp_outgoing_address 0.0.0.0 | |
137 | DOC_END | |
138 | ||
0f74202c | 139 | COMMENT_START |
3a278cb8 | 140 | OPTIONS WHICH AFFECT THE NEIGHBOR SELECTION ALGORITHM |
141 | ----------------------------------------------------------------------------- | |
0f74202c | 142 | COMMENT_END |
934b03fc | 143 | |
40a1495e | 144 | NAME: cache_peer |
145 | TYPE: peer | |
1273d501 | 146 | DEFAULT: none |
0153d498 | 147 | LOC: Config.peers |
934b03fc | 148 | DOC_START |
149 | To specify other caches in a hierarchy, use the format: | |
150 | ||
151 | hostname type http_port icp_port | |
152 | ||
d0d41f07 | 153 | For example, |
934b03fc | 154 | |
155 | # proxy icp | |
156 | # hostname type port port options | |
157 | # -------------------- -------- ----- ----- ----------- | |
cf5cc17e | 158 | cache_peer parent.foo.net parent 3128 3130 [proxy-only] |
159 | cache_peer sib1.foo.net sibling 3128 3130 [proxy-only] | |
160 | cache_peer sib2.foo.net sibling 3128 3130 [proxy-only] | |
934b03fc | 161 | |
162 | type: either 'parent', 'sibling', or 'multicast'. | |
163 | ||
164 | proxy_port: The port number where the cache listens for proxy | |
165 | requests. | |
166 | ||
167 | icp_port: Used for querying neighbor caches about | |
168 | objects. To have a non-ICP neighbor | |
169 | specify '7' for the ICP port and make sure the | |
170 | neighbor machine has the UDP echo port | |
171 | enabled in its /etc/inetd.conf file. | |
172 | ||
173 | options: proxy-only | |
174 | weight=n | |
175 | ttl=n | |
176 | no-query | |
177 | default | |
178 | round-robin | |
179 | multicast-responder | |
b3264694 | 180 | closest-only |
934b03fc | 181 | |
182 | use 'proxy-only' to specify that objects fetched | |
183 | from this cache should not be saved locally. | |
184 | ||
185 | use 'weight=n' to specify a weighted parent. | |
186 | The weight must be an integer. The default weight | |
187 | is 1, larger weights are favored more. | |
188 | ||
189 | use 'ttl=n' to specify a IP multicast TTL to use | |
190 | when sending an ICP request to this address. | |
191 | Only useful when sending to a multicast group. | |
192 | Because we don't accept ICP replies from random | |
193 | hosts, you must configure other group members as | |
194 | peers with the 'multicast-responder' option below. | |
195 | ||
196 | use 'no-query' to NOT send ICP queries to this | |
197 | neighbor. | |
198 | ||
199 | use 'default' if this is a parent cache which can | |
200 | be used as a "last-resort." You should probably | |
201 | only use 'default' in situations where you cannot | |
202 | use ICP with your parent cache(s). | |
203 | ||
204 | use 'round-robin' to define a set of parents which | |
205 | should be used in a round-robin fashion in the | |
206 | absence of any ICP queries. | |
207 | ||
208 | 'multicast-responder' indicates that the named peer | |
209 | is a member of a multicast group. ICP queries will | |
210 | not be sent directly to the peer, but ICP replies | |
211 | will be accepted from it. | |
212 | ||
b3264694 | 213 | 'closest-only' indicates that, for ICP_OP_MISS |
214 | replies, we'll only forward CLOSEST_PARENT_MISSes | |
215 | and never FIRST_PARENT_MISSes. | |
216 | ||
934b03fc | 217 | NOTE: non-ICP neighbors must be specified as 'parent'. |
218 | ||
a95856a0 | 219 | cache_peer hostname type 3128 3130 |
934b03fc | 220 | DOC_END |
221 | ||
222 | ||
af7d912e | 223 | NAME: cache_peer_domain cache_host_domain |
934b03fc | 224 | TYPE: hostdomain |
f1dc9b30 | 225 | DEFAULT: none |
226 | LOC: none | |
934b03fc | 227 | DOC_START |
cf5cc17e | 228 | Use to limit the domains for which a neighbor cache will be |
229 | queried. Usage: | |
934b03fc | 230 | |
af7d912e | 231 | cache_peer_domain cache-host domain [domain ...] |
232 | cache_peer_domain cache-host !domain | |
934b03fc | 233 | |
234 | For example, specifying | |
235 | ||
af7d912e | 236 | cache_peer_domain parent.foo.net .edu |
934b03fc | 237 | |
238 | has the effect such that UDP query packets are sent to | |
239 | 'bigserver' only when the requested object exists on a | |
240 | server in the .edu domain. Prefixing the domainname | |
241 | with '!' means that the cache will be queried for objects | |
242 | NOT in that domain. | |
243 | ||
244 | NOTE: * Any number of domains may be given for a cache-host, | |
245 | either on the same or separate lines. | |
246 | * When multiple domains are given for a particular | |
247 | cache-host, the first matched domain is applied. | |
248 | * Cache hosts with no domain restrictions are queried | |
249 | for all requests. | |
250 | * There are no defaults. | |
af7d912e | 251 | * There is also a 'cache_peer_acl' tag in the ACL |
934b03fc | 252 | section. |
253 | DOC_END | |
254 | ||
255 | ||
256 | NAME: neighbor_type_domain | |
257 | TYPE: hostdomaintype | |
f1dc9b30 | 258 | DEFAULT: none |
259 | LOC: none | |
934b03fc | 260 | DOC_START |
261 | usage: neighbor_type_domain parent|sibling domain domain ... | |
262 | ||
263 | Modifying the neighbor type for specific domains is now | |
264 | possible. You can treat some domains differently than the the | |
a95856a0 | 265 | default neighbor type specified on the 'cache_peer' line. |
934b03fc | 266 | Normally it should only be necessary to list domains which |
267 | should be treated differently because the default neighbor type | |
268 | applies for hostnames which do not match domains listed here. | |
269 | ||
270 | EXAMPLE: | |
a95856a0 | 271 | cache_peer parent cache.foo.org 3128 3130 |
934b03fc | 272 | neighbor_type_domain cache.foo.org sibling .com .net |
273 | neighbor_type_domain cache.foo.org sibling .au .de | |
274 | DOC_END | |
275 | ||
934b03fc | 276 | NAME: neighbor_timeout neighbour_timeout |
277 | COMMENT: (seconds) | |
9e975e4e | 278 | DEFAULT: 2 seconds |
f1dc9b30 | 279 | TYPE: time_t |
934b03fc | 280 | LOC: Config.neighborTimeout |
281 | DOC_START | |
282 | This controls how long to wait for replies from neighbor caches. | |
283 | If none of the parent or neighbor caches reply before this many | |
284 | seconds (due to dropped packets or slow links), then the object | |
285 | request will be satisfied from the default source. The default | |
286 | timeout is two seconds. | |
287 | ||
288 | neighbor_timeout 2 seconds | |
289 | DOC_END | |
290 | ||
dc835977 | 291 | NAME: dead_peer_timeout |
292 | COMMENT: (seconds) | |
293 | DEFAULT: 10 seconds | |
294 | TYPE: time_t | |
295 | LOC: Config.Timeout.deadPeer | |
296 | DOC_START | |
297 | This controls how long Squid waits to declare a peer cache | |
298 | as "dead." If there are no ICP replies received in this | |
299 | amount of time, Squid will declare the peer dead and not | |
300 | expect to receive any further ICP replies. However, it | |
301 | continues to send ICP queries, and will mark the peer as | |
302 | alive upon receipt of the first subsequent ICP reply. | |
303 | ||
304 | dead_peer_timeout 10 seconds | |
305 | DOC_END | |
306 | ||
934b03fc | 307 | |
308 | NAME: hierarchy_stoplist | |
309 | TYPE: wordlist | |
8ad4f479 | 310 | DEFAULT: cgi-bin ? |
934b03fc | 311 | LOC: Config.hierarchy_stoplist |
312 | DOC_START | |
313 | A list of words which, if found in a URL, cause the object to | |
314 | be handled directly by this cache. In other words, use this | |
315 | to not query neighbor caches for certain objects. You may | |
316 | list this option multiple times. | |
317 | ||
318 | The default is to directly fetch URLs containing 'cgi-bin' or '?'. | |
319 | ||
320 | hierarchy_stoplist cgi-bin ? | |
321 | DOC_END | |
322 | ||
323 | ||
324 | NAME: cache_stoplist | |
325 | TYPE: wordlist | |
8ad4f479 | 326 | DEFAULT: cgi-bin ? |
934b03fc | 327 | LOC: Config.cache_stoplist |
328 | DOC_START | |
329 | A list of words which, if found in a URL, cause the object to | |
330 | immediately removed from the cache. In other words, use this | |
331 | to force certain objects to never be cached. You may list this | |
332 | option multiple times. | |
333 | ||
334 | The default is to not cache URLs containing 'cgi-bin' or '?'. | |
335 | ||
336 | cache_stoplist cgi-bin ? | |
337 | DOC_END | |
338 | ||
339 | ||
340 | NAME: cache_stoplist_pattern | |
934b03fc | 341 | TYPE: regexlist |
342 | LOC: Config.cache_stop_relist | |
1273d501 | 343 | DEFAULT: none |
934b03fc | 344 | DOC_START |
345 | Just like 'cache_stoplist' but you can use regular expressions | |
346 | instead of simple string matching. There is no default. | |
0153d498 | 347 | Insert -i to get case-insensitive regular expressions. |
934b03fc | 348 | |
349 | cache_stoplist_pattern | |
350 | DOC_END | |
351 | ||
352 | ||
0f74202c | 353 | COMMENT_START |
3a278cb8 | 354 | OPTIONS WHICH AFFECT THE CACHE SIZE |
355 | ----------------------------------------------------------------------------- | |
0f74202c | 356 | COMMENT_END |
934b03fc | 357 | |
358 | NAME: cache_mem | |
9906e724 | 359 | COMMENT: (bytes) |
1b635117 | 360 | TYPE: b_size_t |
9906e724 | 361 | DEFAULT: 8 MB |
934b03fc | 362 | LOC: Config.Mem.maxSize |
363 | DOC_START | |
364 | Maximum amout of VM used to store objects in memory. | |
365 | This includes: | |
366 | in-transit objects, | |
367 | negative-cached objects, | |
368 | "hot" objects | |
369 | The value of cache_mem is an upper limit on the size of the | |
370 | "in-memory object data" pool. This is a pool of 4k pages used | |
371 | to hold object data. | |
372 | ||
373 | In-transit objects have priority over the others. When | |
374 | additional space is needed for incoming data, negative-cached | |
375 | and hot objects will be released. In other words, the | |
376 | negative-cached and hot objects will fill up any unused space | |
377 | not needed for in-transit objects. | |
378 | ||
379 | The values of cache_mem_low and cache_mem_high (below) can be | |
380 | used to tune the use of the memory pool. When the high mark is | |
381 | reached, in-transit and hot objects will be released to clear | |
382 | space. When an object transfer is completed, it will remain in | |
383 | memory only if the current memory usage is below the low water | |
384 | mark. | |
385 | ||
386 | The default is 8 Megabytes. | |
387 | ||
9906e724 | 388 | cache_mem 8 MB |
934b03fc | 389 | DOC_END |
390 | ||
391 | ||
392 | NAME: cache_swap_low | |
393 | COMMENT: (percent, 0-100) | |
394 | TYPE: int | |
395 | DEFAULT: 90 | |
396 | LOC: Config.Swap.lowWaterMark | |
397 | DOC_NONE | |
398 | ||
399 | NAME: cache_swap_high | |
400 | COMMENT: (percent, 0-100) | |
401 | TYPE: int | |
402 | DEFAULT: 95 | |
403 | LOC: Config.Swap.highWaterMark | |
404 | DOC_START | |
cf5cc17e | 405 | The low- and high-water marks for cache LRU replacement. LRU |
406 | replacement begins when the high-water mark is reached and ends | |
407 | when enough objects have been removed and the low-water mark is | |
408 | reached. Defaults are 90% and 95%. If you have a large cache, 5% | |
409 | could be hundreds of MB. If this is the case you may wish to | |
410 | set these numbers closer together. | |
934b03fc | 411 | |
412 | cache_swap_low 90 | |
413 | cache_swap_high 95 | |
414 | DOC_END | |
415 | ||
416 | ||
417 | NAME: cache_mem_low | |
418 | COMMENT: (in percent, 0-100) | |
419 | TYPE: int | |
420 | DEFAULT: 75 | |
421 | LOC: Config.Mem.lowWaterMark | |
422 | DOC_NONE | |
423 | ||
424 | NAME: cache_mem_high | |
425 | COMMENT: (in percent, 0-100) | |
426 | TYPE: int | |
427 | DEFAULT: 95 | |
428 | LOC: Config.Mem.highWaterMark | |
429 | DOC_START | |
430 | The low- and high-water mark for cache memory storage. When | |
431 | the amount of RAM used by the hot-object RAM cache reaches this | |
432 | point, the cache starts throwing objects out of the RAM cache | |
433 | (but they remain on disk). Defaults are 75% and 90%. | |
434 | ||
435 | cache_mem_low 75 | |
436 | cache_mem_high 90 | |
437 | DOC_END | |
438 | ||
439 | ||
440 | NAME: maximum_object_size | |
9e975e4e | 441 | COMMENT: (bytes) |
1b635117 | 442 | TYPE: b_size_t |
9906e724 | 443 | DEFAULT: 4096 KB |
934b03fc | 444 | LOC: Config.Store.maxObjectSize |
445 | DOC_START | |
446 | Objects larger than this size will NOT be saved on disk. The | |
cf5cc17e | 447 | value is specified in kilobytes, and the default is 4MB. If |
448 | you wish to get a high BYTES hit ratio, you should probably | |
449 | increase this (one 32 MB object hit counts for 3200 10KB | |
450 | hits). If you wish to increase speed more than your want to | |
451 | save bandwidth you should leave this low. | |
934b03fc | 452 | |
9906e724 | 453 | maximum_object_size 4096 KB |
934b03fc | 454 | DOC_END |
455 | ||
456 | ||
457 | NAME: ipcache_size | |
458 | COMMENT: (number of entries) | |
459 | TYPE: int | |
460 | DEFAULT: 1024 | |
461 | LOC: Config.ipcache.size | |
462 | DOC_NONE | |
463 | ||
464 | NAME: ipcache_low | |
465 | COMMENT: (percent) | |
466 | TYPE: int | |
467 | DEFAULT: 90 | |
468 | LOC: Config.ipcache.low | |
469 | DOC_NONE | |
470 | ||
471 | NAME: ipcache_high | |
472 | COMMENT: (percent) | |
473 | TYPE: int | |
474 | DEFAULT: 95 | |
475 | LOC: Config.ipcache.high | |
476 | DOC_START | |
477 | The size, low-, and high-water marks for the IP cache. | |
478 | ||
479 | ipcache_size 1024 | |
480 | ipcache_low 90 | |
481 | ipcache_high 95 | |
482 | DOC_END | |
483 | ||
0f74202c | 484 | COMMENT_START |
3a278cb8 | 485 | LOGFILE PATHNAMES AND CACHE DIRECTORIES |
486 | ----------------------------------------------------------------------------- | |
0f74202c | 487 | COMMENT_END |
934b03fc | 488 | |
489 | NAME: cache_dir | |
490 | TYPE: cachedir | |
f1dc9b30 | 491 | DEFAULT: none |
0108d71f | 492 | DEFAULT_IF_NONE: @DEFAULT_SWAP_DIR@ 100 16 256 |
f1dc9b30 | 493 | LOC: Config.cacheSwap |
934b03fc | 494 | DOC_START |
cf5cc17e | 495 | Usage: |
496 | ||
497 | cache_dir Directory-Name Mbytes Level-1 Level2 | |
934b03fc | 498 | |
499 | You can specify multiple cache_dir lines to spread the | |
500 | cache among different disk partitions. | |
501 | ||
cf5cc17e | 502 | 'Directory' is a top-level directory where cache swap |
503 | files will be stored. If you want to use an entire disk | |
504 | for caching, then this can be the mount-point directory. | |
505 | The directory must exist and be writable by the Squid | |
506 | process. Squid will NOT create this directory for you. | |
507 | ||
508 | If no 'cache_dir' lines are specified, the following | |
509 | default will be used: @DEFAULT_SWAP_DIR@. | |
510 | ||
511 | 'Mbytes' is the amount of disk space (MB) to use under this | |
512 | directory. The default is 100 MB. Change this to suit your | |
513 | configuration. | |
514 | ||
515 | 'Level-1' is the number of first-level subdirectories which | |
516 | will be created under the 'Directory'. The default is 16. | |
517 | ||
518 | 'Level-2' is the number of second-level subdirectories which | |
519 | will be created under each first-level directory. The default | |
520 | is 256. | |
521 | ||
5375428c | 522 | cache_dir @DEFAULT_SWAP_DIR@ 100 16 256 |
934b03fc | 523 | DOC_END |
524 | ||
525 | ||
526 | NAME: cache_access_log | |
527 | TYPE: string | |
d0b98f84 | 528 | DEFAULT: @DEFAULT_ACCESS_LOG@ |
934b03fc | 529 | LOC: Config.Log.access |
530 | DOC_START | |
531 | Logs the client request activity. Contains an entry for | |
532 | every HTTP and ICP request received. | |
533 | ||
5375428c | 534 | cache_access_log @DEFAULT_ACCESS_LOG@ |
934b03fc | 535 | DOC_END |
536 | ||
537 | ||
538 | NAME: cache_log | |
539 | TYPE: string | |
0153d498 | 540 | DEFAULT: @DEFAULT_CACHE_LOG@ |
934b03fc | 541 | LOC: Config.Log.log |
542 | DOC_START | |
cf5cc17e | 543 | Cache logging file. This is where general information about |
544 | your cache's behaviour goes. You can increase the amount of data | |
545 | logged to this file with the "debug_options" tag below. | |
934b03fc | 546 | |
0153d498 | 547 | cache_log @DEFAULT_CACHE_LOG@ |
934b03fc | 548 | DOC_END |
549 | ||
550 | ||
551 | NAME: cache_store_log | |
552 | TYPE: string | |
0153d498 | 553 | DEFAULT: @DEFAULT_STORE_LOG@ |
934b03fc | 554 | LOC: Config.Log.store |
555 | DOC_START | |
556 | Logs the activities of the storage manager. Shows which | |
557 | objects are ejected from the cache, and which objects are | |
cf5cc17e | 558 | saved and for how long. To disable, enter "none". There are |
559 | not really utilities to analyse this data, so you can safely | |
560 | disable it. | |
934b03fc | 561 | |
0153d498 | 562 | cache_store_log @DEFAULT_STORE_LOG@ |
934b03fc | 563 | DOC_END |
564 | ||
565 | ||
566 | NAME: cache_swap_log | |
567 | TYPE: string | |
568 | LOC: Config.Log.swap | |
1273d501 | 569 | DEFAULT: none |
934b03fc | 570 | DOC_START |
d0d3ec94 | 571 | Location for the cache "swap.log." This log file holds the |
934b03fc | 572 | metadata of objects saved on disk. It is used to rebuild the |
573 | cache during startup. Normally this file resides in the first | |
574 | 'cache_dir' directory, but you may specify an alternate | |
575 | pathname here. Note you must give a full filename, not just | |
cf5cc17e | 576 | a directory. Since this is the index for the whole object |
577 | list you CANNOT periodically rotate it! | |
934b03fc | 578 | |
579 | cache_swap_log | |
580 | DOC_END | |
581 | ||
582 | ||
583 | NAME: emulate_httpd_log | |
584 | COMMENT: on|off | |
585 | TYPE: onoff | |
f1dc9b30 | 586 | DEFAULT: off |
17a0a4ee | 587 | LOC: Config.onoff.common_log |
934b03fc | 588 | DOC_START |
589 | The Cache can emulate the log file format which many 'httpd' | |
590 | programs use. To disable/enable this emulation, set | |
591 | emulate_httpd_log to 'off' or 'on'. The default | |
cf5cc17e | 592 | is to use the native log format since it includes useful |
593 | information that Squid-specific log analysers use. | |
934b03fc | 594 | |
595 | emulate_httpd_log off | |
596 | DOC_END | |
597 | ||
598 | ||
599 | NAME: mime_table | |
f0b19334 | 600 | TYPE: string |
0153d498 | 601 | DEFAULT: @DEFAULT_MIME_TABLE@ |
934b03fc | 602 | LOC: Config.mimeTablePathname |
603 | DOC_START | |
cf5cc17e | 604 | Pathname to Squid's MIME table. You shouldn't need to change |
605 | this, but the default file contains examples and formatting | |
606 | information if you do. | |
934b03fc | 607 | |
0153d498 | 608 | mime_table @DEFAULT_MIME_TABLE@ |
934b03fc | 609 | DOC_END |
610 | ||
611 | ||
612 | NAME: log_mime_hdrs | |
613 | COMMENT: on|off | |
614 | TYPE: onoff | |
17a0a4ee | 615 | LOC: Config.onoff.log_mime_hdrs |
f1dc9b30 | 616 | DEFAULT: off |
934b03fc | 617 | DOC_START |
cf5cc17e | 618 | The Cache can record both the request and the response MIME |
619 | headers for each HTTP transaction. The headers are encoded | |
620 | safely and will appear as two bracketed fields at the end of | |
621 | the access log (for either the native or httpd-emulated log | |
622 | formats). To enable this logging set log_mime_hdrs to 'on'. | |
934b03fc | 623 | |
624 | log_mime_hdrs off | |
625 | DOC_END | |
626 | ||
627 | ||
628 | NAME: useragent_log | |
629 | TYPE: string | |
630 | LOC: Config.Log.useragent | |
f1dc9b30 | 631 | DEFAULT: none |
934b03fc | 632 | DOC_START |
cf5cc17e | 633 | If configured with the "--enable-useragent_log" configure |
634 | option, Squid will write the User-Agent field from HTTP | |
635 | requests to the filename specified here. By default | |
636 | useragent_log is disabled. | |
934b03fc | 637 | |
638 | useragent_log none | |
639 | DOC_END | |
640 | ||
641 | ||
642 | NAME: pid_filename | |
643 | TYPE: string | |
0153d498 | 644 | DEFAULT: @DEFAULT_PID_FILE@ |
934b03fc | 645 | LOC: Config.pidFilename |
646 | DOC_START | |
d0d41f07 | 647 | A filename to write the process-id to. To disable, enter "none". |
934b03fc | 648 | |
0153d498 | 649 | pid_filename @DEFAULT_PID_FILE@ |
934b03fc | 650 | DOC_END |
651 | ||
652 | ||
653 | NAME: debug_options | |
f1dc9b30 | 654 | TYPE: eol |
934b03fc | 655 | DEFAULT: ALL,1 |
656 | LOC: Config.debugOptions | |
657 | DOC_START | |
658 | Logging options are set as section,level where each source file | |
659 | is assigned a unique section. Lower levels result in less | |
660 | output, Full debugging (level 9) can result in a very large | |
661 | log file, so be careful. The magic word "ALL" sets debugging | |
662 | levels for all sections. We recommend normally running with | |
663 | "ALL,1". | |
664 | ||
665 | debug_options ALL,1 | |
666 | DOC_END | |
667 | ||
668 | ||
669 | NAME: ident_lookup | |
670 | COMMENT: on|off | |
671 | TYPE: onoff | |
f1dc9b30 | 672 | DEFAULT: off |
17a0a4ee | 673 | LOC: Config.onoff.ident_lookup |
934b03fc | 674 | DOC_START |
cf5cc17e | 675 | If you wish to make an RFC931/ident lookup of the client |
676 | username for each connection, enable this. It is off by | |
677 | default. | |
934b03fc | 678 | |
679 | ident_lookup off | |
680 | DOC_END | |
681 | ||
682 | ||
683 | NAME: log_fqdn | |
684 | COMMENT: on|off | |
685 | TYPE: onoff | |
f1dc9b30 | 686 | DEFAULT: off |
17a0a4ee | 687 | LOC: Config.onoff.log_fqdn |
934b03fc | 688 | DOC_START |
689 | Turn this on if you wish to log fully qualified domain names | |
cf5cc17e | 690 | in the access.log. To do this Squid does a DNS lookup of all |
691 | IP's connecting to it. This can (in some situations) increase | |
692 | latency, which makes your cache seem slower for interactive | |
693 | browsing. | |
934b03fc | 694 | |
695 | log_fqdn off | |
696 | DOC_END | |
697 | ||
698 | ||
699 | NAME: client_netmask | |
700 | TYPE: address | |
701 | LOC: Config.Addrs.client_netmask | |
f1dc9b30 | 702 | DEFAULT: 255.255.255.255 |
934b03fc | 703 | DOC_START |
704 | A netmask for client addresses in logfiles and cachemgr output. | |
705 | Change this to protect the privacy of your cache clients. | |
cf5cc17e | 706 | A netmask of 255.255.255.0 will log all IP's in that range with |
707 | the last digit set to '0'. | |
934b03fc | 708 | |
709 | client_netmask 255.255.255.255 | |
710 | DOC_END | |
711 | ||
712 | ||
0f74202c | 713 | COMMENT_START |
3a278cb8 | 714 | OPTIONS FOR EXTERNAL SUPPORT PROGRAMS |
715 | ----------------------------------------------------------------------------- | |
0f74202c | 716 | COMMENT_END |
934b03fc | 717 | |
934b03fc | 718 | NAME: ftp_user |
719 | TYPE: string | |
cf5cc17e | 720 | DEFAULT: Squid@ |
934b03fc | 721 | LOC: Config.Ftp.anon_user |
722 | DOC_START | |
723 | If you want the anonymous login password to be more informative | |
724 | (and enable the use of picky ftp servers), set this to something | |
725 | resonable for your domain, like wwwuser@somewhere.net | |
726 | ||
727 | The reason why this is domainless by default is that the | |
728 | request can be made on the behalf of a user in any domain, | |
729 | depending on how the cache is used. | |
730 | Some ftp server also validate that the email address is valid | |
731 | (for example perl.com). | |
732 | ||
cf5cc17e | 733 | ftp_user Squid@ |
934b03fc | 734 | DOC_END |
735 | ||
365cb147 | 736 | NAME: ftp_list_width |
1b635117 | 737 | TYPE: size_t |
365cb147 | 738 | DEFAULT: 32 |
739 | LOC: Config.Ftp.list_width | |
740 | DOC_START | |
cf5cc17e | 741 | Sets the width of ftp listings. This should be set to fit in |
742 | the width of a standard browser. Setting this too small | |
743 | can cut off long filenames when browsing ftp sites. | |
744 | ||
365cb147 | 745 | ftp_list_width 32 |
746 | DOC_END | |
747 | ||
934b03fc | 748 | NAME: cache_dns_program |
f0b19334 | 749 | TYPE: string |
0153d498 | 750 | DEFAULT: @DEFAULT_DNSSERVER@ |
934b03fc | 751 | LOC: Config.Program.dnsserver |
752 | DOC_START | |
753 | Specify the location of the executable for dnslookup process. | |
754 | ||
0153d498 | 755 | cache_dns_program @DEFAULT_DNSSERVER@ |
934b03fc | 756 | DOC_END |
757 | ||
934b03fc | 758 | NAME: dns_children |
759 | TYPE: int | |
760 | DEFAULT: 5 | |
761 | LOC: Config.dnsChildren | |
762 | DOC_START | |
763 | The number of processes spawn to service DNS name lookups. | |
764 | For heavily loaded caches on large servers, you should | |
765 | probably increase this value to at least 10. The maximum | |
766 | is 32. The default is 5. | |
767 | ||
768 | To disable dnsservers, set this to 0. NOTE, this is very | |
769 | strongly discouraged. If you disable dnsservers your Squid | |
770 | process will BLOCK on DNS lookups! | |
771 | ||
772 | dns_children 5 | |
773 | DOC_END | |
774 | ||
775 | ||
776 | NAME: dns_defnames | |
777 | COMMENT: on|off | |
778 | TYPE: onoff | |
f1dc9b30 | 779 | DEFAULT: off |
17a0a4ee | 780 | LOC: Config.onoff.res_defnames |
934b03fc | 781 | DOC_START |
782 | Normally the 'dnsserver' disables the RES_DEFNAMES resolver | |
783 | option (see res_init(3)). This prevents caches in a hierarchy | |
784 | from interpreting single-component hostnames locally. To allow | |
785 | dnsserver to handle single-component names, enable this | |
786 | option. | |
787 | ||
788 | dns_defnames off | |
789 | DOC_END | |
790 | ||
09c483ec | 791 | NAME: dns_nameservers |
792 | TYPE: wordlist | |
793 | DEFAULT: none | |
794 | LOC: Config.dns_nameservers | |
795 | DOC_START | |
796 | Use this if you want to specify a list of DNS name servers | |
797 | (IP addresses) to use instead of those given in your | |
798 | /etc/resolv.conf file. | |
799 | ||
800 | Example: dns_nameservers 10.0.0.1 192.172.0.4 | |
801 | ||
802 | dns_nameservers none | |
803 | DOC_END | |
804 | ||
934b03fc | 805 | |
806 | NAME: unlinkd_program | |
f0b19334 | 807 | TYPE: string |
0153d498 | 808 | DEFAULT: @DEFAULT_UNLINKD@ |
934b03fc | 809 | LOC: Config.Program.unlinkd |
810 | DOC_START | |
811 | Specify the location of the executable for file deletion process. | |
cf5cc17e | 812 | This isn't needed if you are using async-io since it's handled by |
813 | a thread. | |
934b03fc | 814 | |
0153d498 | 815 | unlinkd_program @DEFAULT_UNLINKD@ |
934b03fc | 816 | DOC_END |
817 | ||
818 | ||
819 | NAME: pinger_program | |
a95856a0 | 820 | TYPE: string |
0153d498 | 821 | DEFAULT: @DEFAULT_PINGER@ |
934b03fc | 822 | LOC: Config.Program.pinger |
823 | DOC_START | |
824 | Specify the location of the executable for the pinger process. | |
cf5cc17e | 825 | This is only useful if you configured Squid (during compliation) |
826 | with the '--enable-icmp' option. | |
934b03fc | 827 | |
0153d498 | 828 | pinger_program @DEFAULT_PINGER@ |
934b03fc | 829 | DOC_END |
830 | ||
831 | ||
832 | NAME: redirect_program | |
f0b19334 | 833 | TYPE: string |
934b03fc | 834 | LOC: Config.Program.redirect |
62607543 | 835 | DEFAULT: none |
934b03fc | 836 | DOC_START |
837 | Specify the location of the executable for the URL redirector. | |
cf5cc17e | 838 | Since they can perform almost any function there isn't one included. |
839 | See the Release-Notes for information on how to write one. | |
840 | By default, a redirector is not used. | |
934b03fc | 841 | |
f0b19334 | 842 | redirect_program none |
934b03fc | 843 | DOC_END |
844 | ||
845 | ||
846 | NAME: redirect_children | |
847 | TYPE: int | |
848 | DEFAULT: 5 | |
849 | LOC: Config.redirectChildren | |
850 | DOC_START | |
cf5cc17e | 851 | The number of redirector processes to spawn. If you start |
852 | too few Squid will have to wait for them to process a backlog of | |
853 | URLs, slowing it down. If you start too many they will use RAM | |
854 | and other system resources. | |
934b03fc | 855 | |
856 | redirect_children 5 | |
857 | DOC_END | |
858 | ||
0f74202c | 859 | COMMENT_START |
3a278cb8 | 860 | OPTIONS FOR TUNING THE CACHE |
861 | ----------------------------------------------------------------------------- | |
0f74202c | 862 | COMMENT_END |
934b03fc | 863 | |
0153d498 | 864 | NAME: wais_relay_host |
865 | TYPE: string | |
1273d501 | 866 | DEFAULT: none |
0153d498 | 867 | LOC: Config.Wais.relayHost |
868 | DOC_NONE | |
934b03fc | 869 | |
0153d498 | 870 | NAME: wais_relay_port |
871 | TYPE: ushort | |
872 | DEFAULT: 0 | |
873 | LOC: Config.Wais.relayPort | |
934b03fc | 874 | DOC_START |
875 | Relay WAIS request to host (1st arg) at port (2 arg). | |
876 | ||
0153d498 | 877 | wais_relay_host localhost |
878 | wais_relay_port 8000 | |
934b03fc | 879 | DOC_END |
880 | ||
881 | ||
882 | NAME: request_size | |
9906e724 | 883 | COMMENT: (KB) |
518da0bd | 884 | TYPE: b_size_t |
9906e724 | 885 | DEFAULT: 100 KB |
934b03fc | 886 | LOC: Config.maxRequestSize |
887 | DOC_START | |
888 | Maximum allowed request size in kilobytes. If people are using | |
889 | POST to upload files, then set this to the largest acceptable | |
890 | filesize plus a few extra kbytes. | |
891 | ||
9906e724 | 892 | request_size 100 KB |
934b03fc | 893 | DOC_END |
894 | ||
895 | ||
896 | NAME: refresh_pattern | |
934b03fc | 897 | TYPE: refreshpattern |
f1dc9b30 | 898 | LOC: Config.Refresh |
1273d501 | 899 | DEFAULT: none |
934b03fc | 900 | DOC_START |
901 | usage: refresh_pattern regex min percent max | |
902 | ||
903 | min and max are specified in MINUTES. | |
904 | percent is an integer number. | |
905 | ||
906 | Please see the file doc/Release-Notes-1.1.txt for a full | |
907 | description of Squid's refresh algorithm. Basically a | |
908 | cached object is: | |
909 | ||
910 | FRESH if age < min | |
911 | STALE if expires < now | |
912 | STALE if age > max | |
913 | FRESH if lm-factor < percent | |
914 | ||
915 | The refresh_pattern lines are checked in the order listed here. | |
916 | The first entry which matches is used. If none of the entries | |
917 | match, then the default will be used. | |
918 | ||
919 | Default: | |
920 | refresh_pattern . 0 20% 4320 | |
921 | DOC_END | |
922 | ||
923 | ||
924 | NAME: reference_age | |
f1dc9b30 | 925 | TYPE: time_t |
934b03fc | 926 | LOC: Config.referenceAge |
f1dc9b30 | 927 | DEFAULT: 1 year |
934b03fc | 928 | DOC_START |
929 | As a part of normal operation, Squid performs Least Recently | |
930 | Used removal of cached objects. The LRU age for removal is | |
931 | computed dynamically, based on the amount of disk space in | |
932 | use. The 'reference_age' value defines the maximum LRU age. | |
933 | For example, setting reference_age to '1 week' will cause | |
934 | objects to be removed if they have not been accessed for a week | |
935 | or more. If set to zero, LRU removal is disabled, and objects | |
936 | will be removed only when disk usage is over the high water | |
cf5cc17e | 937 | mark. The default value is one month. |
934b03fc | 938 | |
939 | Specify a number here, followed by units of time. For example: | |
940 | 1 week | |
941 | 3.5 days | |
942 | 4 months | |
943 | 2.2 hours | |
944 | ||
f1dc9b30 | 945 | reference_age 1 month |
934b03fc | 946 | DOC_END |
947 | ||
948 | ||
0153d498 | 949 | NAME: quick_abort_min |
9906e724 | 950 | COMMENT: (KB) |
951 | TYPE: kb_size_t | |
9e975e4e | 952 | DEFAULT: -1 kb |
0153d498 | 953 | LOC: Config.quickAbort.min |
954 | DOC_NONE | |
955 | ||
956 | NAME: quick_abort_pct | |
957 | COMMENT: (percent) | |
958 | TYPE: int | |
959 | DEFAULT: 0 | |
960 | LOC: Config.quickAbort.pct | |
961 | DOC_NONE | |
962 | ||
963 | NAME: quick_abort_max | |
9906e724 | 964 | COMMENT: (KB) |
965 | TYPE: kb_size_t | |
9e975e4e | 966 | DEFAULT: 0 kb |
0153d498 | 967 | LOC: Config.quickAbort.max |
934b03fc | 968 | DOC_START |
cf5cc17e | 969 | The cache can be configured to continue downloading aborted |
970 | requests. This may be undesirable on slow (e.g. SLIP) links | |
971 | and/or very busy caches. Impatient users may tie up file | |
972 | descriptors and bandwidth by repeatedly requesting and | |
973 | immediately aborting downloads. | |
934b03fc | 974 | |
975 | When the user aborts a request, Squid will check the | |
976 | quick_abort values to the amount of data transfered until | |
977 | then. | |
978 | ||
cf5cc17e | 979 | If the transfer has less than 'quick_abort_min' KB remaining, |
980 | it will finish the retrieval. Setting 'quick_abort_min' to -1 | |
981 | will disable the quick_abort feature. | |
934b03fc | 982 | |
cf5cc17e | 983 | If more than 'quick_abort_pct' of the transfer has completed, |
984 | it will finish the retrieval. | |
934b03fc | 985 | |
cf5cc17e | 986 | If the transfer has more than 'quick_abort_max' KB remaining, |
987 | it will abort the retrieval. | |
934b03fc | 988 | |
cf5cc17e | 989 | quick_abort_min -1 KB |
0153d498 | 990 | quick_abort_pct 0 |
cf5cc17e | 991 | quick_abort_max 0 KB |
934b03fc | 992 | DOC_END |
993 | ||
994 | ||
995 | NAME: negative_ttl | |
bc0eb004 | 996 | COMMENT: time-units |
f1dc9b30 | 997 | TYPE: time_t |
934b03fc | 998 | LOC: Config.negativeTtl |
9e975e4e | 999 | DEFAULT: 5 minutes |
934b03fc | 1000 | DOC_START |
1001 | Time-to-Live (TTL) for failed requests. Certain types of | |
1002 | failures (such as "connection refused" and "404 Not Found") are | |
cf5cc17e | 1003 | negatively-cached for a configurable amount of time. The |
1004 | default is 5 minutes. Note that this is different from | |
1005 | negative caching of DNS lookups. | |
934b03fc | 1006 | |
1007 | negative_ttl 5 minutes | |
1008 | DOC_END | |
1009 | ||
1010 | ||
1011 | NAME: positive_dns_ttl | |
bc0eb004 | 1012 | COMMENT: time-units |
f1dc9b30 | 1013 | TYPE: time_t |
934b03fc | 1014 | LOC: Config.positiveDnsTtl |
9e975e4e | 1015 | DEFAULT: 6 hours |
934b03fc | 1016 | DOC_START |
1017 | Time-to-Live (TTL) for positive caching of successful DNS lookups. | |
1018 | Default is 6 hours (360 minutes). If you want to minimize the | |
1019 | use of Squid's ipcache, set this to 1, not 0. | |
1020 | ||
9e975e4e | 1021 | positive_dns_ttl 6 hours |
934b03fc | 1022 | DOC_END |
1023 | ||
1024 | ||
1025 | NAME: negative_dns_ttl | |
bc0eb004 | 1026 | COMMENT: time-units |
f1dc9b30 | 1027 | TYPE: time_t |
934b03fc | 1028 | LOC: Config.negativeDnsTtl |
9e975e4e | 1029 | DEFAULT: 5 minutes |
934b03fc | 1030 | DOC_START |
1031 | Time-to-Live (TTL) for negative caching of failed DNS lookups. | |
1032 | ||
1033 | negative_dns_ttl 5 minutes | |
1034 | DOC_END | |
1035 | ||
0f74202c | 1036 | COMMENT_START |
3a278cb8 | 1037 | TIMEOUTS |
1038 | ----------------------------------------------------------------------------- | |
0f74202c | 1039 | COMMENT_END |
934b03fc | 1040 | |
1041 | NAME: connect_timeout | |
bc0eb004 | 1042 | COMMENT: time-units |
f1dc9b30 | 1043 | TYPE: time_t |
934b03fc | 1044 | LOC: Config.Timeout.connect |
9e975e4e | 1045 | DEFAULT: 2 minutes |
934b03fc | 1046 | DOC_START |
1047 | Some systems (notably Linux) can not be relied upon to properly | |
cf5cc17e | 1048 | time out connect(2) requests. Therefore the Squid process |
934b03fc | 1049 | enforces its own timeout on server connections. This parameter |
1050 | specifies how long to wait for the connect to complete. The | |
1051 | default is two minutes (120 seconds). | |
1052 | ||
1053 | connect_timeout 120 seconds | |
1054 | DOC_END | |
1055 | ||
23d92c64 | 1056 | NAME: siteselect_timeout |
1057 | COMMENT: time-units | |
1058 | TYPE: time_t | |
1059 | LOC: Config.Timeout.siteSelect | |
1060 | DEFAULT: 4 seconds | |
1061 | DOC_START | |
1062 | For URN to multiple URL's URL selection | |
1063 | ||
1064 | siteselect_timeout 4 seconds | |
1065 | DOC_END | |
934b03fc | 1066 | |
1067 | NAME: read_timeout | |
bc0eb004 | 1068 | COMMENT: time-units |
f1dc9b30 | 1069 | TYPE: time_t |
934b03fc | 1070 | LOC: Config.Timeout.read |
9e975e4e | 1071 | DEFAULT: 15 minutes |
934b03fc | 1072 | DOC_START |
1073 | The read_timeout is applied on server-side connections. After | |
1074 | each successful read(), the timeout will be extended by this | |
1075 | amount. If no data is read again after this amount of time, | |
1076 | the request is aborted and logged with ERR_READ_TIMEOUT. The | |
1077 | default is 15 minutes. | |
1078 | ||
1079 | read_timeout 15 minutes | |
1080 | DOC_END | |
1081 | ||
1082 | ||
934b03fc | 1083 | NAME: request_timeout |
f1dc9b30 | 1084 | TYPE: time_t |
934b03fc | 1085 | LOC: Config.Timeout.request |
9e975e4e | 1086 | DEFAULT: 30 seconds |
934b03fc | 1087 | DOC_START |
1088 | How long to wait for an HTTP request after connection | |
1089 | establishment. For persistent connections, wait this long | |
1090 | after the previous request completes. | |
1091 | ||
0fbcf3c7 | 1092 | request_timeout 30 seconds |
934b03fc | 1093 | DOC_END |
1094 | ||
1095 | ||
1096 | NAME: client_lifetime | |
bc0eb004 | 1097 | COMMENT: time-units |
f1dc9b30 | 1098 | TYPE: time_t |
934b03fc | 1099 | LOC: Config.Timeout.lifetime |
9e975e4e | 1100 | DEFAULT: 1 day |
934b03fc | 1101 | DOC_START |
1102 | The maximum amount of time that a client (browser) is allowed to | |
1103 | remain connected to the cache process. This protects the Cache | |
1104 | from having alot of sockets (and hence file descriptors) tied up | |
1105 | in a CLOSE_WAIT state from remote clients that go away without | |
1106 | properly shutting down (either because of a network failure or | |
1107 | because of a poor client implementation). The default is one | |
1108 | day, 1440 minutes. | |
1109 | ||
1110 | NOTE: The default value is intended to be much larger than any | |
1111 | client would ever need to be connected to your cache. You | |
1112 | should probably change client_lifetime only as a last resort. | |
1113 | If you seem to have many client connections tying up | |
1114 | filedescriptors, we recommend first tuning the read_timeout, | |
0fbcf3c7 | 1115 | request_timeout, pconn_timeout and quick_abort values. |
934b03fc | 1116 | |
1117 | client_lifetime 1 day | |
1118 | DOC_END | |
1119 | ||
603a02fd | 1120 | NAME: pconn_timeout |
1121 | TYPE: time_t | |
1122 | LOC: Config.Timeout.pconn | |
1123 | DEFAULT: 120 seconds | |
1124 | DOC_START | |
1125 | Timeout for idle persistent connections to servers and other | |
1126 | proxies. | |
1127 | pconn_timeout 120 seconds | |
1128 | DOC_END | |
1129 | ||
934b03fc | 1130 | |
1131 | NAME: shutdown_lifetime | |
bc0eb004 | 1132 | COMMENT: time-units |
f1dc9b30 | 1133 | TYPE: time_t |
934b03fc | 1134 | LOC: Config.shutdownLifetime |
9e975e4e | 1135 | DEFAULT: 30 seconds |
934b03fc | 1136 | DOC_START |
1137 | When SIGTERM or SIGHUP is received, the cache is put into | |
1138 | "shutdown pending" mode until all active sockets are closed. | |
1139 | This value is the lifetime to set for all open descriptors | |
1140 | during shutdown mode. Any active clients after this many | |
1141 | seconds will receive a 'timeout' message. | |
1142 | ||
1143 | shutdown_lifetime 30 seconds | |
1144 | DOC_END | |
1145 | ||
0f74202c | 1146 | COMMENT_START |
3a278cb8 | 1147 | ACCESS CONTROLS |
1148 | ----------------------------------------------------------------------------- | |
0f74202c | 1149 | COMMENT_END |
934b03fc | 1150 | |
1151 | NAME: acl | |
1152 | TYPE: acl | |
f1dc9b30 | 1153 | LOC: Config.aclList |
1154 | DEFAULT: none | |
934b03fc | 1155 | DOC_START |
1156 | Defining an Access List | |
1157 | ||
1158 | acl aclname acltype string1 ... | |
1159 | acl aclname acltype "file" ... | |
1160 | ||
1161 | when using "file", the file should contain one item per line | |
1162 | ||
1163 | acltype is one of src dst srcdomain dstdomain url_pattern | |
1164 | urlpath_pattern time port proto method browser user | |
1165 | ||
1166 | acl aclname src ip-address/netmask ... (clients IP address) | |
1167 | acl aclname src addr1-addr2/netmask ... (range of addresses) | |
1168 | acl aclname dst ip-address/netmask ... (URL host's IP address) | |
d0d41f07 | 1169 | |
1170 | acl aclname srcdomain foo.com ... # reverse lookup, client IP | |
1171 | acl aclname dstdomain foo.com ... # Destination server from URL | |
1172 | acl aclname srcdom_regex xxx ... # regex matching client name | |
1173 | acl aclname dstdom_regex xxx ... # regex matching server | |
1174 | # For dstdomain and dstdom_regex a reverse lookup is tried if a IP | |
1175 | # based URL is used. The name "none" is used if the reverse lookup | |
1176 | # fails. | |
1177 | ||
934b03fc | 1178 | acl aclname time [day-abbrevs] [h1:m1-h2:m2] |
1179 | day-abbrevs: | |
1180 | S - Sunday | |
1181 | M - Monday | |
1182 | T - Tuesday | |
1183 | W - Wednesday | |
1184 | H - Thursday | |
1185 | F - Friday | |
1186 | A - Saturday | |
1187 | h1:m1 must be less than h2:m2 | |
1188 | acl aclname url_regex ^http:// ... # regex matching on whole URL | |
d0d41f07 | 1189 | acl aclname urlpath_regex \.gif$ ... # regex matching on URL path |
934b03fc | 1190 | acl aclname port 80 70 21 ... |
1191 | acl aclname proto HTTP FTP ... | |
1192 | acl aclname method GET POST ... | |
1193 | acl aclname browser regexp | |
1194 | acl aclname user username ... # string match on ident output. | |
1195 | # use REQUIRED to accept any | |
1196 | # non-null ident. | |
6468fe10 | 1197 | acl aclname src_as number ... |
1198 | acl aclname dst_as number ... | |
1199 | # Except for access control, AS numbers can be used for | |
1200 | # routing of requests to specific caches. Here's an | |
1201 | # example for routing all requests for AS#1241 and only | |
1202 | # those to mycache.mydomain.net: | |
1203 | # acl asexample dst_as 1241 | |
af7d912e | 1204 | # cache_peer_acl mycache.mydomain.net asexample |
1205 | # cache_peer_acl mycache_mydomain.net !all | |
6468fe10 | 1206 | |
afe95a7e | 1207 | acl aclname proxy_auth passwd_file [ refresh ] |
1208 | # 'passwd_file' is an Apache-style file of passwords for | |
1209 | # authenticated proxy access. Looks like user:password, with | |
1210 | # the password being standard crypt() format. 'refresh' is | |
1211 | # the time in seconds to check for a changes in the file | |
1212 | # (default = 300 secs). When using a proxy_auth ACL in an | |
1213 | # ACL list, make sure it is the *last* in the list and the | |
1214 | # only proxy_auth ACL in the list. NOTE: when a | |
1215 | # Proxy-Authentication header is sent but it is not needed | |
1216 | # during ACL checking the username is NOT logged in | |
1217 | # access.log. | |
934b03fc | 1218 | |
1219 | acl manager proto cache_object | |
1220 | acl localhost src 127.0.0.1/255.255.255.255 | |
1221 | acl all src 0.0.0.0/0.0.0.0 | |
6468fe10 | 1222 | acl myexample dst_as 1241 |
934b03fc | 1223 | acl SSL_ports port 443 563 |
1224 | acl Dangerous_ports port 7 9 19 | |
1225 | acl CONNECT method CONNECT | |
1226 | DOC_END | |
1227 | ||
1228 | NAME: http_access | |
1229 | TYPE: acl_access | |
f1dc9b30 | 1230 | LOC: Config.accessList.http |
1231 | DEFAULT: none | |
934b03fc | 1232 | DOC_START |
1233 | Allowing or Denying access based on defined access lists | |
1234 | ||
1235 | Access to the HTTP port: | |
1236 | http_access allow|deny [!]aclname ... | |
1237 | ||
1238 | Access to the ICP port: | |
1239 | icp_access allow|deny [!]aclname ... | |
1240 | ||
1241 | NOTE on default values: | |
1242 | ||
1243 | If there are no "access" lines present, the default is to allow | |
1244 | the request. | |
1245 | ||
1246 | If none of the "access" lines cause a match, the default is the | |
1247 | opposite of the last line in the list. If the last line was | |
1248 | deny, then the default is allow. Conversely, if the last line | |
1249 | is allow, the default will be deny. For these reasons, it is a | |
1250 | good idea to have an "deny all" or "allow all" entry at the end | |
1251 | of your access lists to avoid potential confusion. | |
1252 | ||
1253 | ||
1254 | Only allow access to the cache manager functions from the local host. | |
1255 | http_access deny manager !localhost | |
1256 | http_access deny CONNECT !SSL_ports | |
1257 | http_access deny Dangerous_ports | |
1258 | ||
1259 | Allow everything else | |
1260 | http_access allow all | |
1261 | DOC_END | |
1262 | ||
1263 | ||
1264 | NAME: icp_access | |
1265 | TYPE: acl_access | |
f1dc9b30 | 1266 | LOC: Config.accessList.icp |
1267 | DEFAULT: none | |
934b03fc | 1268 | DOC_START |
1269 | Reply to all ICP queries we receive | |
1270 | ||
1271 | icp_access allow all | |
1272 | DOC_END | |
1273 | ||
1274 | ||
1275 | NAME: miss_access | |
1276 | TYPE: acl_access | |
f1dc9b30 | 1277 | LOC: Config.accessList.miss |
1278 | DEFAULT: none | |
934b03fc | 1279 | DOC_START |
1280 | Use to force your neighbors to use you as a sibling instead of | |
1281 | a parent. For example: | |
1282 | ||
1283 | acl localclients src 172.16.0.0/16 | |
1284 | miss_access allow localclients | |
1285 | miss_access deny !localclients | |
1286 | ||
1287 | This means that only your local clients are allowed to fetch | |
1288 | MISSES and all other clients can only fetch HITS. | |
1289 | ||
1290 | By default, allow all clients who passed the http_access rules | |
1291 | to fetch MISSES from us. | |
1292 | ||
1293 | miss_access allow all | |
1294 | DOC_END | |
1295 | ||
1296 | ||
af7d912e | 1297 | NAME: cache_peer_acl cache_host_acl |
f1dc9b30 | 1298 | TYPE: peeracl |
1299 | DEFAULT: none | |
1300 | LOC: none | |
934b03fc | 1301 | DOC_START |
af7d912e | 1302 | Just like 'cache_peer_domain' but provides more flexibility by |
934b03fc | 1303 | using ACL's. |
1304 | ||
af7d912e | 1305 | cache_peer_acl cache-host [!]aclname ... |
934b03fc | 1306 | |
1307 | NOTE: * Any number of ACL's may be given for a cache-host, | |
1308 | either on the same or separate lines. | |
1309 | * When multiple ACL's are given for a particular | |
1310 | cache-host, the first matched ACL is applied. | |
1311 | * Cache hosts with no domain or ACL restrictions are | |
1312 | queried for all requests. | |
1313 | * There are no defaults. | |
1314 | DOC_END | |
1315 | ||
0f74202c | 1316 | COMMENT_START |
3a278cb8 | 1317 | ADMINISTRATIVE PARAMETERS |
1318 | ----------------------------------------------------------------------------- | |
0f74202c | 1319 | COMMENT_END |
934b03fc | 1320 | |
1321 | NAME: cache_mgr | |
1322 | TYPE: string | |
1323 | DEFAULT: webmaster | |
1324 | LOC: Config.adminEmail | |
1325 | DOC_START | |
1326 | Email-address of local cache manager who will receive | |
1327 | mail if the cache dies. The default is "webmaster." | |
1328 | ||
1329 | cache_mgr webmaster | |
1330 | DOC_END | |
1331 | ||
1332 | ||
1333 | NAME: cache_effective_user | |
0153d498 | 1334 | TYPE: string |
a95856a0 | 1335 | DEFAULT: nobody |
0153d498 | 1336 | LOC: Config.effectiveUser |
1337 | DOC_NONE | |
1338 | ||
1339 | NAME: cache_effective_group | |
1340 | TYPE: string | |
a95856a0 | 1341 | DEFAULT: nogroup |
0153d498 | 1342 | LOC: Config.effectiveGroup |
934b03fc | 1343 | DOC_START |
1344 | If the cache is run as root, it will change its effective/real | |
1345 | UID/GID to the UID/GID specified below. The default is not to | |
1346 | change UID/GID. | |
1347 | ||
0153d498 | 1348 | cache_effective_user nobody |
1349 | cache_effective_group nogroup | |
934b03fc | 1350 | DOC_END |
1351 | ||
1352 | ||
1353 | NAME: visible_hostname | |
1354 | TYPE: string | |
1355 | LOC: Config.visibleHostname | |
f1dc9b30 | 1356 | DEFAULT: none |
934b03fc | 1357 | DOC_START |
1358 | If you want to present a special hostname in error messages, etc, | |
1359 | then define this. Otherwise, the return value of gethostname() | |
cf5cc17e | 1360 | will be used. If you have multiple caches in a cluster and |
1361 | get errors about IP-forwarding you must set them to have individual | |
1362 | names with this setting. | |
934b03fc | 1363 | |
1364 | visible_hostname www-cache.foo.org | |
1365 | DOC_END | |
1366 | ||
0f74202c | 1367 | COMMENT_START |
3a278cb8 | 1368 | OPTIONS FOR THE CACHE REGISTRATION SERVICE |
1369 | ----------------------------------------------------------------------------- | |
934b03fc | 1370 | |
3a278cb8 | 1371 | This section contains parameters for the (optional) cache |
1372 | announcement service. This service is provided to help | |
1373 | cache administrators locate one another in order to join or | |
1374 | create cache hierarchies. | |
934b03fc | 1375 | |
3a278cb8 | 1376 | An 'announcement' message is sent (via UDP) to the registration |
1377 | service by Squid. By default, the annoucement message is NOT | |
1378 | SENT unless you enable it with 'cache_announce' below. | |
1379 | ||
1380 | The announcement message includes your hostname, plus the | |
1381 | following information from this configuration file: | |
934b03fc | 1382 | |
3a278cb8 | 1383 | http_port |
1384 | icp_port | |
1385 | cache_mgr | |
1386 | ||
1387 | All current information is processed regularly and made | |
1388 | available on the Web at http://www.nlanr.net/Cache/Tracker/. | |
0f74202c | 1389 | COMMENT_END |
934b03fc | 1390 | |
f1dc9b30 | 1391 | NAME: announce_period |
1392 | TYPE: time_t | |
1393 | LOC: Config.Announce.period | |
9e975e4e | 1394 | DEFAULT: 1 day |
934b03fc | 1395 | DOC_START |
1396 | This is how frequently to send cache announcements. The default | |
1397 | is `0' which disables sending the announcement messages. | |
1398 | ||
1399 | To enable announcing your cache, just uncomment the line below. | |
1400 | ||
9e975e4e | 1401 | announce_period 1 day |
934b03fc | 1402 | DOC_END |
1403 | ||
1404 | ||
f1dc9b30 | 1405 | NAME: announce_host |
1406 | TYPE: string | |
1407 | DEFAULT: sd.cache.nlanr.net | |
1408 | LOC: Config.Announce.host | |
1409 | DOC_NONE | |
1410 | ||
cf5cc17e | 1411 | NAME: announce_file |
1412 | TYPE: string | |
1413 | DEFAULT: /dev/null | |
1414 | LOC: Config.Announce.file | |
1415 | DOC_NONE | |
1416 | ||
f1dc9b30 | 1417 | NAME: announce_port |
1418 | TYPE: ushort | |
1419 | DEFAULT: 3131 | |
1420 | LOC: Config.Announce.port | |
934b03fc | 1421 | DOC_START |
cf5cc17e | 1422 | announce_host and announce_port set the hostname and portnumber where |
1423 | the registration message will be sent. | |
934b03fc | 1424 | |
1425 | Hostname will default to 'sd.cache.nlanr.net' and port will default | |
1426 | to 3131. If the 'filename' argument is given, the contents of that | |
1427 | file will be included in the announce message. | |
1428 | ||
f1dc9b30 | 1429 | announce_host sd.cache.nlanr.net |
1430 | announce_port 3131 | |
cf5cc17e | 1431 | announce_file /dev/null |
934b03fc | 1432 | DOC_END |
1433 | ||
0f74202c | 1434 | COMMENT_START |
3a278cb8 | 1435 | HTTPD-ACCELERATOR OPTIONS |
1436 | ----------------------------------------------------------------------------- | |
0f74202c | 1437 | COMMENT_END |
934b03fc | 1438 | |
f1dc9b30 | 1439 | NAME: httpd_accel_host |
1440 | TYPE: string | |
1441 | LOC: Config.Accel.host | |
1442 | DEFAULT: none | |
1443 | DOC_NONE | |
1444 | ||
1445 | NAME: httpd_accel_port | |
1446 | TYPE: ushort | |
1447 | LOC: Config.Accel.port | |
5b68a4d3 | 1448 | DEFAULT: 80 |
934b03fc | 1449 | DOC_START |
cf5cc17e | 1450 | If you want to run Squid as an httpd accelerator, define the |
934b03fc | 1451 | host name and port number where the real HTTP server is. |
1452 | ||
1453 | If you want virtual host support then specify the hostname | |
1454 | as "virtual". | |
1455 | ||
f1dc9b30 | 1456 | httpd_accel_host hostname |
1457 | httpd_accel_port port | |
934b03fc | 1458 | DOC_END |
1459 | ||
1460 | ||
1461 | NAME: httpd_accel_with_proxy | |
1462 | COMMENT: on|off | |
1463 | TYPE: onoff | |
f1dc9b30 | 1464 | DEFAULT: off |
17a0a4ee | 1465 | LOC: Config.onoff.accel_with_proxy |
934b03fc | 1466 | DOC_START |
cf5cc17e | 1467 | If you want to use Squid as both a local httpd accelerator |
934b03fc | 1468 | and as a proxy, change this to 'on'. |
1469 | ||
1470 | httpd_accel_with_proxy off | |
1471 | DOC_END | |
1472 | ||
1473 | ||
1474 | NAME: httpd_accel_uses_host_header | |
1475 | COMMENT: on|off | |
1476 | TYPE: onoff | |
f1dc9b30 | 1477 | DEFAULT: off |
934b03fc | 1478 | LOC: opt_accel_uses_host |
1479 | DOC_START | |
1480 | HTTP/1.1 requests include a Host: header which is basically the | |
1481 | hostname from the URL. Squid can be an accelerator for | |
1482 | different HTTP servers by looking at this header. However, | |
1483 | Squid does NOT check the value of the Host header, so it opens | |
1484 | a big security hole. We recommend that this option remain | |
1485 | disabled unless you are sure of what you are doing. | |
1486 | ||
04f6f348 | 1487 | However, you will need to enable this option if you run Squid |
1488 | as a transparent proxy. Otherwise, virtual servers which | |
1489 | require the Host: header will not be properly cached. | |
934b03fc | 1490 | httpd_accel_uses_host_header off |
1491 | DOC_END | |
1492 | ||
0f74202c | 1493 | COMMENT_START |
3a278cb8 | 1494 | MISCELLANEOUS |
1495 | ----------------------------------------------------------------------------- | |
0f74202c | 1496 | COMMENT_END |
934b03fc | 1497 | |
1498 | NAME: dns_testnames | |
1499 | TYPE: wordlist | |
1500 | LOC: Config.dns_testname_list | |
f1dc9b30 | 1501 | DEFAULT: none |
934b03fc | 1502 | DOC_START |
1503 | The DNS tests exit as soon as the first site is successfully looked up | |
1504 | ||
1505 | If you want to disable DNS tests, do not comment out or delete this | |
1506 | list. Instead use the -D command line option | |
1507 | ||
cf5cc17e | 1508 | dns_testnames netscape.com internic.net nlanr.net microsoft.com |
934b03fc | 1509 | DOC_END |
1510 | ||
1511 | ||
1512 | NAME: logfile_rotate | |
1513 | TYPE: int | |
1514 | DEFAULT: 10 | |
1515 | LOC: Config.Log.rotateNumber | |
1516 | DOC_START | |
cf5cc17e | 1517 | Specifies the number of logfile rotations to make upon |
1518 | receiving a USR1 signal. The default is 10, which will rotate | |
1519 | with extensions 0 through 9. Setting logfile_rotate to 0 will | |
934b03fc | 1520 | disable the rotation, but the logfiles are still closed and |
cf5cc17e | 1521 | re-opened. This will enable you to rename the logfiles |
1522 | yourself just before sending a USR1 signal to the Squid | |
1523 | process. | |
934b03fc | 1524 | |
1525 | logfile_rotate 10 | |
1526 | DOC_END | |
1527 | ||
1528 | ||
1529 | NAME: append_domain | |
f1dc9b30 | 1530 | TYPE: string |
1531 | LOC: Config.appendDomain | |
1532 | DEFAULT: none | |
934b03fc | 1533 | DOC_START |
cf5cc17e | 1534 | Appends local domain name to hostnames without any dots in |
1535 | them. append_domain must begin with a period. | |
934b03fc | 1536 | |
1537 | append_domain .yourdomain.com | |
1538 | DOC_END | |
1539 | ||
1540 | ||
1541 | NAME: tcp_recv_bufsize | |
89de058c | 1542 | COMMENT: (bytes) |
1b635117 | 1543 | TYPE: b_size_t |
89de058c | 1544 | DEFAULT: 0 bytes |
934b03fc | 1545 | LOC: Config.tcpRcvBufsz |
1546 | DOC_START | |
1547 | Size of receive buffer to set for TCP sockets. Probably just | |
1548 | as easy to change your kernel's default. Set to zero to use | |
1549 | the default buffer size. | |
1550 | ||
89de058c | 1551 | tcp_recv_bufsize 0 bytes |
934b03fc | 1552 | DOC_END |
1553 | ||
934b03fc | 1554 | NAME: err_html_text |
f1dc9b30 | 1555 | TYPE: eol |
1556 | LOC: Config.errHtmlText | |
1557 | DEFAULT: none | |
934b03fc | 1558 | DOC_START |
1559 | HTML text to include in error messages. Make this a "mailto" | |
1560 | URL to your admin address, or maybe just a link to your | |
1561 | organizations Web page. | |
1562 | ||
1563 | err_html_text | |
1564 | DOC_END | |
1565 | ||
1566 | ||
1567 | NAME: deny_info | |
1568 | TYPE: denyinfo | |
1569 | LOC: Config.denyInfoList | |
f1dc9b30 | 1570 | DEFAULT: none |
934b03fc | 1571 | DOC_START |
02922e76 | 1572 | Usage: deny_info err_page_name acl |
1573 | Example: deny_info ERR_CUSTOM_ACCESS_DENIED bad_guys | |
934b03fc | 1574 | |
02922e76 | 1575 | This can be used to return a ERR_ page for requests which |
934b03fc | 1576 | do not pass the 'http_access' rules. A single ACL will cause |
1577 | the http_access check to fail. If a 'deny_info' line exists | |
02922e76 | 1578 | for that ACL then Squid returns a corresponding error page. |
cf5cc17e | 1579 | |
02922e76 | 1580 | You may use ERR_ pages that come with Squid or create your own pages |
1581 | and put them into the configured errors/ directory. | |
934b03fc | 1582 | DOC_END |
1583 | ||
934b03fc | 1584 | NAME: memory_pools |
1585 | COMMENT: on|off | |
1586 | TYPE: onoff | |
f1dc9b30 | 1587 | DEFAULT: on |
3f6c0fb2 | 1588 | LOC: Config.onoff.mem_pools |
934b03fc | 1589 | DOC_START |
1590 | If set, Squid will keep pools of allocated (but unused) memory | |
1591 | available for future use. If memory is a premium on your | |
7021844c | 1592 | system and you believe your malloc library outperforms Squid |
d0d41f07 | 1593 | routines, disable this. |
934b03fc | 1594 | |
1595 | memory_pools on | |
1596 | DOC_END | |
1597 | ||
7021844c | 1598 | NAME: memory_pools_limit |
1599 | COMMENT: (bytes) | |
1600 | TYPE: b_size_t | |
1601 | DEFAULT: none | |
f12c295b | 1602 | LOC: Config.MemPools.limit |
7021844c | 1603 | DOC_START |
f12c295b | 1604 | Used only with memory_pools on: |
1605 | memory_pools_limit 50 MB | |
7021844c | 1606 | |
f12c295b | 1607 | If set to a non-zero value, Squid will keep at most the specified |
1608 | limit of allocated (but unused) memory in memory pools. All free() | |
1609 | requests that exceed this limit will be handled by your malloc | |
1610 | library. Squid does not pre-allocate any memory, just safe-keeps | |
1611 | objects that otherwise would be free()d. Thus, it is safe to set | |
7021844c | 1612 | memory_pools_limit to a reasonably high value even if your |
f12c295b | 1613 | configuration will use less memory. |
1614 | ||
1615 | If not set (default) or set to zero, Squid will keep all memory it | |
1616 | can. That is, there will be no limit on the total amount of memory | |
1617 | used for safe-keeping. | |
7021844c | 1618 | |
1619 | To disable memory allocation optimization, do not set | |
1620 | memory_pools_limit to 0. Set memory_pools to "off" instead. | |
1621 | ||
f12c295b | 1622 | An overhead for maintaining memory pools is not taken into account |
1623 | when the limit is checked. This overhead is close to four bytes per | |
1624 | object kept. However, pools may actually _save_ memory because of | |
1625 | reduced memory thrashing in your malloc library. | |
7021844c | 1626 | DOC_END |
1627 | ||
934b03fc | 1628 | NAME: forwarded_for |
1629 | COMMENT: on|off | |
1630 | TYPE: onoff | |
f1dc9b30 | 1631 | DEFAULT: on |
934b03fc | 1632 | LOC: opt_forwarded_for |
1633 | DOC_START | |
1634 | If set, Squid will include your system's IP address or name | |
1635 | in the HTTP requests it forwards. By default it looks like | |
1636 | this: | |
1637 | ||
1638 | X-Forwarded-For: 192.1.2.3 | |
1639 | ||
1640 | If you disable this, it will appear as | |
1641 | ||
1642 | X-Forwarded-For: unknown | |
1643 | ||
1644 | forwarded_for on | |
1645 | DOC_END | |
1646 | ||
1647 | NAME: log_icp_queries | |
1648 | COMMENT: on|off | |
1649 | TYPE: onoff | |
f1dc9b30 | 1650 | DEFAULT: on |
17a0a4ee | 1651 | LOC: Config.onoff.log_udp |
934b03fc | 1652 | DOC_START |
cf5cc17e | 1653 | If set, ICP queries are logged to access.log. You may wish |
1654 | do disable this if your ICP load is VERY high to speed things | |
1655 | up or to simplify log analysis. | |
934b03fc | 1656 | |
1657 | log_icp_queries on | |
1658 | DOC_END | |
1659 | ||
88738790 | 1660 | NAME: icp_hit_stale |
1661 | COMMENT: on|off | |
1662 | TYPE: onoff | |
1663 | DEFAULT: off | |
17a0a4ee | 1664 | LOC: Config.onoff.icp_hit_stale |
88738790 | 1665 | DOC_START |
1666 | If you want to return ICP_HIT for stale cache objects, set this | |
1667 | option to 'on'. If you have sibling relationships with caches | |
1668 | in other administrative domains, this should be 'off'. If you only | |
1669 | have sibling relationships with caches under your control, then | |
1670 | it is probably okay to set this to 'on'. | |
1671 | ||
1672 | icp_hit_stale off | |
1673 | DOC_END | |
1674 | ||
934b03fc | 1675 | |
1676 | NAME: minimum_direct_hops | |
1677 | TYPE: int | |
1678 | DEFAULT: 4 | |
1679 | LOC: Config.minDirectHops | |
1680 | DOC_START | |
1681 | If using the ICMP pinging stuff, do direct fetches for sites | |
1682 | which are no more than this many hops away. | |
1683 | ||
1684 | minimum_direct_hops 4 | |
1685 | DOC_END | |
1686 | ||
1687 | ||
1688 | NAME: cachemgr_passwd | |
1689 | TYPE: cachemgrpasswd | |
86101e40 | 1690 | DEFAULT: none |
f1dc9b30 | 1691 | LOC: Config.passwd_list |
934b03fc | 1692 | DOC_START |
1693 | Specify passwords for cachemgr operations. | |
1694 | ||
1695 | Usage: cachemgr_passwd password action action ... | |
1696 | ||
1697 | valid actions are: | |
1698 | shutdown * | |
1699 | info | |
cf5cc17e | 1700 | objects |
1701 | vm_objects | |
1702 | utilization | |
1703 | ipcache | |
1704 | fqdncache | |
1705 | dns | |
1706 | redirector | |
1707 | io | |
1708 | reply_headers | |
1709 | filedescriptors | |
1710 | netdb | |
934b03fc | 1711 | server_list |
1712 | client_list | |
cf5cc17e | 1713 | config * |
934b03fc | 1714 | |
1715 | * Indicates actions which will not be performed without a | |
1716 | valid password, others can be performed if not listed here. | |
1717 | ||
1718 | To disable an action, set the password to "disable". | |
1719 | To allow performing an action without a password, set the | |
1720 | password to "none". | |
1721 | ||
1722 | Use the keyword "all" to set the same password for all actions. | |
1723 | ||
1724 | cachemgr_passwd secret shutdown | |
1725 | cachemgr_passwd lesssssssecret info stats/objects | |
1726 | cachemgr_passwd disable all | |
1727 | DOC_END | |
1728 | ||
934b03fc | 1729 | NAME: store_avg_object_size |
86101e40 | 1730 | COMMENT: (kbytes) |
1731 | TYPE: kb_size_t | |
2bf99296 | 1732 | DEFAULT: 13 KB |
934b03fc | 1733 | LOC: Config.Store.avgObjectSize |
1734 | DOC_START | |
1735 | Average object size, used to estimate number of objects your | |
1736 | cache can hold. See doc/Release-Notes-1.1.txt. The default is | |
2bf99296 | 1737 | 13 KB. |
934b03fc | 1738 | |
2bf99296 | 1739 | store_avg_object_size 13 KB |
934b03fc | 1740 | DOC_END |
1741 | ||
1742 | NAME: store_objects_per_bucket | |
1743 | TYPE: int | |
1744 | DEFAULT: 50 | |
1745 | LOC: Config.Store.objectsPerBucket | |
1746 | DOC_START | |
1747 | Target number of objects per bucket in the store hash table. | |
1748 | Lowering this value increases the total number of buckets and | |
1749 | also the storage maintenance rate. The default is 20. | |
1750 | ||
1751 | store_objects_per_bucket 20 | |
1752 | DOC_END | |
1753 | ||
1754 | ||
1755 | NAME: http_anonymizer | |
1756 | TYPE: httpanonymizer | |
17a0a4ee | 1757 | LOC: Config.onoff.anonymizer |
f1dc9b30 | 1758 | DEFAULT: off |
934b03fc | 1759 | DOC_START |
1760 | If you want to filter out certain HTTP request headers for | |
1761 | privacy reasons, enable this option. There are three | |
1762 | appropriate settings: | |
1763 | 'off' All HTTP request headers are passed. | |
1764 | 'standard' Specific headers are removed | |
1765 | 'paranoid' Only specific headers are allowed. | |
1766 | To see which headers are allowed or denied, please see the | |
1767 | http-anon.c source file. | |
1768 | ||
1769 | http_anonymizer off | |
1770 | DOC_END | |
1771 | ||
1772 | ||
1773 | NAME: client_db | |
1774 | COMMENT: on|off | |
1775 | TYPE: onoff | |
f1dc9b30 | 1776 | DEFAULT: on |
17a0a4ee | 1777 | LOC: Config.onoff.client_db |
934b03fc | 1778 | DOC_START |
1779 | If you want to disable collecting per-client statistics, then | |
1780 | turn off client_db here. | |
1781 | ||
1782 | client_db on | |
1783 | DOC_END | |
1784 | ||
1785 | ||
1786 | NAME: netdb_low | |
1787 | TYPE: int | |
1788 | DEFAULT: 900 | |
1789 | LOC: Config.Netdb.low | |
1790 | DOC_NONE | |
1791 | ||
1792 | NAME: netdb_high | |
1793 | TYPE: int | |
1794 | DEFAULT: 1000 | |
1795 | LOC: Config.Netdb.high | |
1796 | DOC_START | |
1797 | The low and high water marks for the ICMP measurement | |
1798 | database. These are counts, not percents. The defaults are | |
1799 | 900 and 1000. When the high water mark is reached, database | |
1800 | entries will be deleted until the low mark is reached. | |
1801 | ||
1802 | netdb_low 900 | |
1803 | netdb_high 1000 | |
1804 | DOC_END | |
1805 | ||
1806 | ||
1807 | NAME: netdb_ping_period | |
f1dc9b30 | 1808 | TYPE: time_t |
934b03fc | 1809 | LOC: Config.Netdb.period |
9e975e4e | 1810 | DEFAULT: 5 minutes |
934b03fc | 1811 | DOC_START |
1812 | The minimum period for measuring a site. There will be at | |
1813 | least this much delay between successive pings to the same | |
1814 | network. The default is five minutes. | |
1815 | ||
1816 | netdb_ping_period 5 minutes | |
1817 | DOC_END | |
1818 | ||
1819 | ||
1820 | NAME: query_icmp | |
1821 | COMMENT: on|off | |
1822 | TYPE: onoff | |
f1dc9b30 | 1823 | DEFAULT: off |
17a0a4ee | 1824 | LOC: Config.onoff.query_icmp |
934b03fc | 1825 | DOC_START |
1826 | If you want to ask your peers to include ICMP data in their ICP | |
1827 | replies, enable this option. | |
1828 | ||
cf5cc17e | 1829 | If your peer has configured Squid (during compilation) with |
1830 | '--enable-icmp' then that peer will send ICMP pings to origin server | |
1831 | sites of the URLs it receives. If you enable this option then the | |
1832 | ICP replies from that peer will include the ICMP data (if available). | |
1833 | Then, when choosing a parent cache, Squid will choose the parent with | |
934b03fc | 1834 | the minimal RTT to the origin server. When this happens, the |
1835 | hierarchy field of the access.log will be | |
1836 | "CLOSEST_PARENT_MISS". This option is off by default. | |
1837 | ||
1838 | query_icmp off | |
1839 | DOC_END | |
1840 | ||
194dd3b8 | 1841 | NAME: test_rechability |
1842 | COMMENT: on|off | |
1843 | TYPE: onoff | |
1844 | DEFAULT: off | |
1845 | LOC: Config.onoff.test_reachability | |
1846 | DOC_START | |
1847 | When this is 'on', ICP MISS replies will be ICP_MISS_NOFETCH | |
1848 | instead of ICP_MISS if the target host is NOT in the ICMP | |
1849 | database, or has a zero RTT. | |
1850 | ||
1851 | test_reachability off | |
1852 | DOC_END | |
1853 | ||
78f1250a | 1854 | NAME: buffered_logs |
1855 | COMMENT: on|off | |
1856 | TYPE: onoff | |
1857 | DEFAULT: off | |
17a0a4ee | 1858 | LOC: Config.onoff.buffered_logs |
78f1250a | 1859 | DOC_START |
1860 | Some log files (cache.log, useragent.log) are written with | |
1861 | stdio functions, and as such they can be buffered or | |
cf5cc17e | 1862 | unbuffered. By default they will be unbuffered. Buffering them |
1863 | can speed up the writing slightly (though you are unlikely to | |
1864 | need to worry). | |
78f1250a | 1865 | buffered_logs off |
1866 | DOC_END | |
1867 | ||
934b03fc | 1868 | NAME: always_direct |
1869 | TYPE: acl_access | |
1870 | LOC: Config.accessList.AlwaysDirect | |
f1dc9b30 | 1871 | DEFAULT: none |
934b03fc | 1872 | DOC_START |
2a78fa67 | 1873 | Usage: always_direct allow|deny [!]aclname ... |
1874 | ||
1875 | Here you can use ACL elements to specify requests which should | |
1876 | ALWAYS be forwarded directly to origin servers. This option | |
1877 | replaces some v1.1 options such as inside_firewall, | |
1878 | firewall_ip, local_domain, and local_ip. For example, to | |
1879 | always directly forward requests for local servers use | |
1880 | something like: | |
1881 | ||
1882 | acl local-servers dstdomain my.domain.net | |
1883 | always_direct allow local-servers | |
1884 | ||
1885 | To always forward FTP requests directly, use | |
1886 | ||
1887 | acl FTP proto FTP | |
1888 | always_direct allow FTP | |
1889 | ||
1890 | NOTE: There is a similar, but opposite option named | |
1891 | 'never_direct'. You need to be aware that "always_direct deny | |
1892 | foo" is NOT the same thing as "never_direct allow foo". You | |
1893 | may need to use a deny rule to exclude a more-specific case of | |
1894 | some other rule. Example: | |
1895 | ||
1896 | acl local-external dstdomain external.foo.net | |
1897 | acl local-servers dstdomain foo.net | |
1898 | always_direct deny local-external | |
1899 | always_direct allow local-servers | |
934b03fc | 1900 | DOC_END |
1901 | ||
1902 | NAME: never_direct | |
1903 | TYPE: acl_access | |
1904 | LOC: Config.accessList.NeverDirect | |
f1dc9b30 | 1905 | DEFAULT: none |
934b03fc | 1906 | DOC_START |
d0d41f07 | 1907 | Usage: never_direct allow|deny [!]aclname ... |
2a78fa67 | 1908 | |
1909 | never_direct is the opposite of always_direct. Please read | |
1910 | the description for always_direct if you have not already. | |
934b03fc | 1911 | |
2a78fa67 | 1912 | With 'never_direct' you can use ACL elements to specify |
1913 | requests which should NEVER be forwarded directly to origin | |
1914 | servers. This option replaces some v1.1 options such as | |
1915 | inside_firewall, firewall_ip, local_domain, and local_ip. For | |
1916 | example, to force the use of a proxy for all requests, except | |
1917 | those in your local domain, use something like: | |
1918 | ||
d0d41f07 | 1919 | acl local-servers dstdomain my.domain.net |
2a78fa67 | 1920 | acl all src 0.0.0.0/0.0.0.0 |
d0d41f07 | 1921 | never_direct deny local-servers |
1922 | never_direct allow all | |
2a78fa67 | 1923 | DOC_END |
934b03fc | 1924 | |
88738790 | 1925 | NAME: fake_user_agent |
1926 | TYPE: eol | |
1927 | LOC: Config.fake_ua | |
1928 | DEFAULT: none | |
1929 | DOC_START | |
d0d41f07 | 1930 | If you use the paranoid http_anonymizer setting, Squid will strip |
1931 | your User-agent string from the request. Some Web servers will | |
1932 | refuse your request without a User-agent string. Use this to | |
1933 | fake one up. For example: | |
88738790 | 1934 | |
d0d41f07 | 1935 | fake_user_agent Nutscrape/1.0 (CP/M; 8-bit) |
1936 | (credit to Paul Southworth pauls@etext.org for this one!) | |
88738790 | 1937 | |
1938 | fake_user_agent none | |
1939 | DOC_END | |
1940 | ||
365cb147 | 1941 | NAME: icon_directory |
f0b19334 | 1942 | TYPE: string |
365cb147 | 1943 | LOC: Config.icons.directory |
1944 | DEFAULT: @DEFAULT_ICON_DIR@ | |
1945 | DOC_START | |
cf5cc17e | 1946 | Where the icons are stored. These are normally kept in |
1947 | @DEFAULT_ICON_DIR@ | |
365cb147 | 1948 | DOC_END |
1949 | ||
cf5cc17e | 1950 | NAME: error_directory |
365cb147 | 1951 | TYPE: string |
cf5cc17e | 1952 | LOC: Config.errorDirectory |
1953 | DEFAULT: @DEFAULT_ERROR_DIR@ | |
365cb147 | 1954 | DOC_START |
cf5cc17e | 1955 | If you wish to create your own versions of the default |
1956 | (English) error files, either to customise them to suit your | |
1957 | language or company copy the template english files to anther | |
1958 | directory and point this tag at them. | |
365cb147 | 1959 | DOC_END |
88738790 | 1960 | |
22c653cd | 1961 | NAME: minimum_retry_timeout |
1962 | COMMENT: (seconds) | |
1963 | TYPE: time_t | |
1964 | LOC: Config.retry.timeout | |
1965 | DEFAULT: 5 seconds | |
1966 | DOC_START | |
1967 | This specifies the minimum connect timeout, for when the | |
1968 | connect timeout is reduced to compensate for the availability | |
1969 | of multiple IP addresses. | |
1970 | ||
cf5cc17e | 1971 | When a connection to a host is initiated, and that host has |
1972 | several IP addresses, the default connection timeout is reduced | |
1973 | by dividing it by the number of addresses. So, a site with 15 | |
1974 | addresses would then have a timeout of 8 seconds for each | |
1975 | address attempted. To avoid having the timeout reduced to the | |
1976 | point where even a working host would not have a chance to | |
1977 | respond, this setting is provided. The default, and the | |
1978 | minimum value, is five seconds, and the maximum value is sixty | |
1979 | seconds, or half of connect_timeout, whichever is greater and | |
1980 | less than connect_timeout. | |
22c653cd | 1981 | |
cf5cc17e | 1982 | minimum_retry_timeout 5 seconds |
22c653cd | 1983 | DOC_END |
1984 | ||
1985 | NAME: maximum_single_addr_tries | |
1986 | TYPE: int | |
1987 | LOC: Config.retry.maxtries | |
1988 | DEFAULT: 3 | |
1989 | DOC_START | |
1990 | This sets the maximum number of connection attempts for a | |
1991 | host that only has one address (for multiple-address hosts, | |
1992 | each address is tried once). | |
1993 | ||
1994 | The default value is three tries, the (not recommended) | |
1995 | maximum is 255 tries. A warning message will be generated | |
1996 | if it is set to a value greater than ten. | |
1997 | ||
1998 | maximum_single_addr_tries 3 | |
1999 | DOC_END | |
6d1c0d53 | 2000 | |
a97cfa48 | 2001 | NAME: snmp_port |
2002 | TYPE: ushort | |
2003 | LOC: Config.Port.snmp | |
2004 | DEFAULT: 3401 | |
1df370e3 | 2005 | IFDEF: SQUID_SNMP |
a97cfa48 | 2006 | DOC_START |
cf5cc17e | 2007 | Squid can now serve statistics and status information via SNMP. |
2008 | By default it listens to port 3401 on the machine. If you don't | |
2009 | wish to use SNMP, set this to '-1'. | |
2010 | ||
2011 | NOTE: SNMP support requires use the --enable-snmp configure | |
2012 | command line option. | |
794a4fea | 2013 | snmp_port 3401 |
a97cfa48 | 2014 | DOC_END |
2015 | ||
a97cfa48 | 2016 | NAME: snmp_do_queueing |
2017 | TYPE: onoff | |
2018 | LOC: Config.Snmp.do_queueing | |
2019 | DEFAULT: on | |
1df370e3 | 2020 | IFDEF: SQUID_SNMP |
a97cfa48 | 2021 | DOC_START |
cf5cc17e | 2022 | If disabled, snmp packets will not be queued but delivered |
2023 | immediately. This could be useful when you want to monitor a | |
2024 | cache in trouble, but this could also make Squid block, slowing | |
2025 | connections and possibly worsening the cache status. | |
794a4fea | 2026 | snmp_do_queueing on |
a97cfa48 | 2027 | DOC_END |
2028 | ||
2029 | NAME: forward_snmpd_port | |
2030 | TYPE: ushort | |
2031 | LOC: Config.Snmp.localPort | |
2032 | DEFAULT: 0 | |
1df370e3 | 2033 | IFDEF: SQUID_SNMP |
a97cfa48 | 2034 | DOC_START |
2035 | This configures whether we should be forwarding SNMP requests | |
cf5cc17e | 2036 | to another snmpd. The reason for putting this piece of |
2037 | functionality into Squid was to enable access to the system's | |
2038 | installed snmpd with minimal changes. This option is turned | |
2039 | off by default, check with your /etc/services for your system's | |
2040 | snmp port (usually 161). We do not use getservbyname() to | |
2041 | allow you to set Squid into port 161 and your system's snmpd to | |
2042 | another port by changing /etc/services. | |
2043 | ||
d0d41f07 | 2044 | WARNING: Because of Squid acting as a proxy snmpd for system |
2045 | you have to do security checks on THIS snmpd for all objects. | |
2046 | Check your snmp_config_file. | |
794a4fea | 2047 | forward_snmpd_port 0 |
a97cfa48 | 2048 | DOC_END |
2049 | ||
2050 | NAME: snmp_mib_path | |
2051 | TYPE: string | |
2052 | LOC: Config.Snmp.mibPath | |
2053 | DEFAULT: @DEFAULT_MIB_PATH@ | |
1df370e3 | 2054 | IFDEF: SQUID_SNMP |
a97cfa48 | 2055 | DOC_START |
cf5cc17e | 2056 | The location of Squid's mib. |
794a4fea | 2057 | snmp_mib_path @DEFAULT_MIB_PATH@ |
a97cfa48 | 2058 | DOC_END |
2059 | ||
a97cfa48 | 2060 | NAME: trap_sink |
4feb7b2e | 2061 | TYPE: string |
a97cfa48 | 2062 | LOC: Config.Snmp.trap_sink |
2063 | DEFAULT: 127.0.0.1 | |
1df370e3 | 2064 | IFDEF: SQUID_SNMP |
4feb7b2e | 2065 | DOC_START |
a97cfa48 | 2066 | Hostname or ip address of trap sink for snmp |
794a4fea | 2067 | trap_sink 127.0.0.1 |
4feb7b2e | 2068 | DOC_END |
2069 | ||
a97cfa48 | 2070 | NAME: snmp_trap_community |
2071 | TYPE: string | |
2072 | LOC: Config.Snmp.trap_community | |
2073 | DEFAULT: public | |
1df370e3 | 2074 | IFDEF: SQUID_SNMP |
a97cfa48 | 2075 | DOC_START |
cf5cc17e | 2076 | Community name for traps. |
794a4fea | 2077 | snmp_trap_community public |
a97cfa48 | 2078 | DOC_END |
2079 | ||
2080 | NAME: snmp_enable_authen_traps | |
2081 | TYPE: onoff | |
2082 | LOC: Config.Snmp.conf_authtraps | |
2083 | DEFAULT: off | |
1df370e3 | 2084 | IFDEF: SQUID_SNMP |
a97cfa48 | 2085 | DOC_START |
cf5cc17e | 2086 | Enable SNMP authenticated traps. Set to 'off' or 'on'. |
794a4fea | 2087 | snmp_enable_authen_traps off |
a97cfa48 | 2088 | DOC_END |
2089 | ||
2090 | NAME: snmp_agent_conf | |
5e14bf6d | 2091 | TYPE: stringlist |
a97cfa48 | 2092 | LOC: Config.Snmp.snmpconf |
2093 | DEFAULT: none | |
1df370e3 | 2094 | IFDEF: SQUID_SNMP |
a97cfa48 | 2095 | DOC_START |
2096 | Define snmp views, users and communities | |
2097 | Example: | |
2098 | snmp_agent_conf view all .1.3.6 included | |
2099 | snmp_agent_conf view squid .1.3.6 included | |
2100 | snmp_agent_conf user squid - all all public | |
2101 | snmp_agent_conf user all all all all squid | |
2102 | snmp_agent_conf community public squid squid | |
2103 | snmp_agent_conf community readwrite all all | |
2104 | DOC_END | |
4feb7b2e | 2105 | |
bdf18524 | 2106 | NAME: snmp_acl |
2107 | TYPE: snmp_access | |
2108 | LOC: Config.Snmp.communities | |
2109 | DEFAULT: none | |
2110 | IFDEF: SQUID_SNMP | |
2111 | DOC_START | |
2112 | Define access controls per community: | |
2113 | snmp_access communityname allow|deny [!]aclname ... | |
2114 | Example: | |
2115 | snmp_acl public allow adminsubnet | |
2116 | snmp_acl public deny all | |
2117 | DOC_END | |
2118 | ||
2119 | ||
53ad48e6 | 2120 | NAME: as_whois_server |
2121 | TYPE: string | |
2122 | LOC: Config.as_whois_server | |
2123 | DEFAULT: whois.ra.net | |
2124 | DEFAULT_IF_NONE: whois.ra.net | |
2125 | DOC_START | |
cf5cc17e | 2126 | WHOIS server to query for AS numbers. NOTE: AS numbers are |
2127 | queried only when Squid starts up, not for every request. | |
53ad48e6 | 2128 | DOC_END |
2129 | ||
6d1c0d53 | 2130 | EOF |