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