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