]>
Commit | Line | Data |
---|---|---|
3a278cb8 | 1 | |
9cef6668 | 2 | # |
c255af72 | 3 | # $Id: cf.data.pre,v 1.502 2008/02/12 00:05:11 amosjeffries Exp $ |
9cef6668 | 4 | # |
6845f129 | 5 | # SQUID Web Proxy Cache http://www.squid-cache.org/ |
9cef6668 | 6 | # ---------------------------------------------------------- |
7 | # | |
2b6662ba | 8 | # Squid is the result of efforts by numerous individuals from |
9 | # the Internet community; see the CONTRIBUTORS file for full | |
10 | # details. Many organizations have provided support for Squid's | |
11 | # development; see the SPONSORS file for full details. Squid is | |
12 | # Copyrighted (C) 2000 by the Regents of the University of | |
13 | # California; see the COPYRIGHT file for full details. Squid | |
14 | # incorporates software developed and/or copyrighted by other | |
15 | # sources; see the CREDITS file for full details. | |
9cef6668 | 16 | # |
17 | # This program is free software; you can redistribute it and/or modify | |
18 | # it under the terms of the GNU General Public License as published by | |
19 | # the Free Software Foundation; either version 2 of the License, or | |
20 | # (at your option) any later version. | |
96d88dcb | 21 | # |
9cef6668 | 22 | # This program is distributed in the hope that it will be useful, |
23 | # but WITHOUT ANY WARRANTY; without even the implied warranty of | |
24 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
25 | # GNU General Public License for more details. | |
96d88dcb | 26 | # |
9cef6668 | 27 | # You should have received a copy of the GNU General Public License |
28 | # along with this program; if not, write to the Free Software | |
29 | # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. | |
30 | # | |
31 | ||
0f74202c | 32 | COMMENT_START |
cccac0a2 | 33 | WELCOME TO SQUID @VERSION@ |
34 | ---------------------------- | |
3a278cb8 | 35 | |
cccac0a2 | 36 | This is the default Squid configuration file. You may wish |
37 | to look at the Squid home page (http://www.squid-cache.org/) | |
38 | for the FAQ and other documentation. | |
3a278cb8 | 39 | |
cccac0a2 | 40 | The default Squid config file shows what the defaults for |
41 | various options happen to be. If you don't need to change the | |
42 | default, you shouldn't uncomment the line. Doing so may cause | |
43 | run-time problems. In some cases "none" refers to no default | |
44 | setting at all, while in other cases it refers to a valid | |
45 | option - the comments for that keyword indicate if this is the | |
46 | case. | |
debd9a31 | 47 | |
cccac0a2 | 48 | COMMENT_END |
3a278cb8 | 49 | |
592a09dc | 50 | COMMENT_START |
51 | Configuration options can be included using the "include" directive. | |
52 | Include takes a list of files to include. Quoting and wildcards is | |
53 | supported. | |
54 | ||
55 | For example, | |
56 | ||
57 | include /path/to/included/file/squid.acl.config | |
58 | ||
59 | Includes can be nested up to a hard-coded depth of 16 levels. | |
60 | This arbitrary restriction is to prevent recursive include references | |
61 | from causing Squid entering an infinite loop whilst trying to load | |
62 | configuration files. | |
63 | COMMENT_END | |
64 | ||
5473c134 | 65 | COMMENT_START |
41bd17a4 | 66 | OPTIONS FOR AUTHENTICATION |
5473c134 | 67 | ----------------------------------------------------------------------------- |
68 | COMMENT_END | |
69 | ||
41bd17a4 | 70 | NAME: auth_param |
71 | TYPE: authparam | |
72 | LOC: Config.authConfiguration | |
cccac0a2 | 73 | DEFAULT: none |
74 | DOC_START | |
41bd17a4 | 75 | This is used to define parameters for the various authentication |
76 | schemes supported by Squid. | |
cccac0a2 | 77 | |
41bd17a4 | 78 | format: auth_param scheme parameter [setting] |
cccac0a2 | 79 | |
41bd17a4 | 80 | The order in which authentication schemes are presented to the client is |
81 | dependent on the order the scheme first appears in config file. IE | |
82 | has a bug (it's not RFC 2617 compliant) in that it will use the basic | |
83 | scheme if basic is the first entry presented, even if more secure | |
84 | schemes are presented. For now use the order in the recommended | |
85 | settings section below. If other browsers have difficulties (don't | |
86 | recognize the schemes offered even if you are using basic) either | |
87 | put basic first, or disable the other schemes (by commenting out their | |
88 | program entry). | |
cccac0a2 | 89 | |
41bd17a4 | 90 | Once an authentication scheme is fully configured, it can only be |
91 | shutdown by shutting squid down and restarting. Changes can be made on | |
92 | the fly and activated with a reconfigure. I.E. You can change to a | |
93 | different helper, but not unconfigure the helper completely. | |
cccac0a2 | 94 | |
41bd17a4 | 95 | Please note that while this directive defines how Squid processes |
96 | authentication it does not automatically activate authentication. | |
97 | To use authentication you must in addition make use of ACLs based | |
98 | on login name in http_access (proxy_auth, proxy_auth_regex or | |
99 | external with %LOGIN used in the format tag). The browser will be | |
100 | challenged for authentication on the first such acl encountered | |
101 | in http_access processing and will also be re-challenged for new | |
102 | login credentials if the request is being denied by a proxy_auth | |
103 | type acl. | |
cccac0a2 | 104 | |
41bd17a4 | 105 | WARNING: authentication can't be used in a transparently intercepting |
106 | proxy as the client then thinks it is talking to an origin server and | |
107 | not the proxy. This is a limitation of bending the TCP/IP protocol to | |
108 | transparently intercepting port 80, not a limitation in Squid. | |
13b5cd0c AJ |
109 | Ports flagged 'transparent', 'intercept', or 'tproxy' have authentication |
110 | disabled. | |
cccac0a2 | 111 | |
41bd17a4 | 112 | === Parameters for the basic scheme follow. === |
cccac0a2 | 113 | |
41bd17a4 | 114 | "program" cmdline |
115 | Specify the command for the external authenticator. Such a program | |
116 | reads a line containing "username password" and replies "OK" or | |
117 | "ERR" in an endless loop. "ERR" responses may optionally be followed | |
118 | by a error description available as %m in the returned error page. | |
119 | If you use an authenticator, make sure you have 1 acl of type proxy_auth. | |
cccac0a2 | 120 | |
41bd17a4 | 121 | By default, the basic authentication scheme is not used unless a |
122 | program is specified. | |
cccac0a2 | 123 | |
41bd17a4 | 124 | If you want to use the traditional NCSA proxy authentication, set |
125 | this line to something like | |
307b83b7 | 126 | |
41bd17a4 | 127 | auth_param basic program @DEFAULT_PREFIX@/libexec/ncsa_auth @DEFAULT_PREFIX@/etc/passwd |
9e7dbc51 | 128 | |
41bd17a4 | 129 | "children" numberofchildren |
130 | The number of authenticator processes to spawn. If you start too few | |
131 | Squid will have to wait for them to process a backlog of credential | |
132 | verifications, slowing it down. When password verifications are | |
133 | done via a (slow) network you are likely to need lots of | |
134 | authenticator processes. | |
135 | auth_param basic children 5 | |
9e7dbc51 | 136 | |
41bd17a4 | 137 | "concurrency" concurrency |
138 | The number of concurrent requests the helper can process. | |
139 | The default of 0 is used for helpers who only supports | |
140 | one request at a time. Setting this changes the protocol used to | |
141 | include a channel number first on the request/response line, allowing | |
142 | multiple requests to be sent to the same helper in parallell without | |
143 | wating for the response. | |
144 | Must not be set unless it's known the helper supports this. | |
145 | auth_param basic concurrency 0 | |
0fdafae7 | 146 | |
41bd17a4 | 147 | "realm" realmstring |
148 | Specifies the realm name which is to be reported to the | |
149 | client for the basic proxy authentication scheme (part of | |
150 | the text the user will see when prompted their username and | |
151 | password). There is no default. | |
152 | auth_param basic realm Squid proxy-caching web server | |
d1b63fc8 | 153 | |
41bd17a4 | 154 | "credentialsttl" timetolive |
155 | Specifies how long squid assumes an externally validated | |
156 | username:password pair is valid for - in other words how | |
157 | often the helper program is called for that user. Set this | |
158 | low to force revalidation with short lived passwords. Note | |
159 | setting this high does not impact your susceptibility | |
160 | to replay attacks unless you are using an one-time password | |
161 | system (such as SecureID). If you are using such a system, | |
162 | you will be vulnerable to replay attacks unless you also | |
163 | use the max_user_ip ACL in an http_access rule. | |
cccac0a2 | 164 | |
41bd17a4 | 165 | "casesensitive" on|off |
166 | Specifies if usernames are case sensitive. Most user databases are | |
167 | case insensitive allowing the same username to be spelled using both | |
168 | lower and upper case letters, but some are case sensitive. This | |
169 | makes a big difference for user_max_ip ACL processing and similar. | |
170 | auth_param basic casesensitive off | |
cccac0a2 | 171 | |
41bd17a4 | 172 | === Parameters for the digest scheme follow === |
cccac0a2 | 173 | |
41bd17a4 | 174 | "program" cmdline |
175 | Specify the command for the external authenticator. Such | |
176 | a program reads a line containing "username":"realm" and | |
177 | replies with the appropriate H(A1) value hex encoded or | |
178 | ERR if the user (or his H(A1) hash) does not exists. | |
179 | See rfc 2616 for the definition of H(A1). | |
180 | "ERR" responses may optionally be followed by a error description | |
181 | available as %m in the returned error page. | |
cccac0a2 | 182 | |
41bd17a4 | 183 | By default, the digest authentication scheme is not used unless a |
184 | program is specified. | |
b8c0c06d | 185 | |
41bd17a4 | 186 | If you want to use a digest authenticator, set this line to |
187 | something like | |
cccac0a2 | 188 | |
41bd17a4 | 189 | auth_param digest program @DEFAULT_PREFIX@/bin/digest_auth_pw @DEFAULT_PREFIX@/etc/digpass |
cccac0a2 | 190 | |
41bd17a4 | 191 | "children" numberofchildren |
192 | The number of authenticator processes to spawn (no default). | |
193 | If you start too few Squid will have to wait for them to | |
194 | process a backlog of H(A1) calculations, slowing it down. | |
195 | When the H(A1) calculations are done via a (slow) network | |
196 | you are likely to need lots of authenticator processes. | |
197 | auth_param digest children 5 | |
cccac0a2 | 198 | |
41bd17a4 | 199 | "realm" realmstring |
200 | Specifies the realm name which is to be reported to the | |
201 | client for the digest proxy authentication scheme (part of | |
202 | the text the user will see when prompted their username and | |
203 | password). There is no default. | |
204 | auth_param digest realm Squid proxy-caching web server | |
cccac0a2 | 205 | |
41bd17a4 | 206 | "nonce_garbage_interval" timeinterval |
207 | Specifies the interval that nonces that have been issued | |
208 | to client_agent's are checked for validity. | |
cccac0a2 | 209 | |
41bd17a4 | 210 | "nonce_max_duration" timeinterval |
211 | Specifies the maximum length of time a given nonce will be | |
212 | valid for. | |
cccac0a2 | 213 | |
41bd17a4 | 214 | "nonce_max_count" number |
215 | Specifies the maximum number of times a given nonce can be | |
216 | used. | |
cccac0a2 | 217 | |
41bd17a4 | 218 | "nonce_strictness" on|off |
219 | Determines if squid requires strict increment-by-1 behavior | |
220 | for nonce counts, or just incrementing (off - for use when | |
221 | useragents generate nonce counts that occasionally miss 1 | |
222 | (ie, 1,2,4,6)). Default off. | |
cccac0a2 | 223 | |
41bd17a4 | 224 | "check_nonce_count" on|off |
225 | This directive if set to off can disable the nonce count check | |
226 | completely to work around buggy digest qop implementations in | |
227 | certain mainstream browser versions. Default on to check the | |
228 | nonce count to protect from authentication replay attacks. | |
cccac0a2 | 229 | |
41bd17a4 | 230 | "post_workaround" on|off |
231 | This is a workaround to certain buggy browsers who sends | |
232 | an incorrect request digest in POST requests when reusing | |
233 | the same nonce as acquired earlier on a GET request. | |
cccac0a2 | 234 | |
41bd17a4 | 235 | === NTLM scheme options follow === |
cccac0a2 | 236 | |
41bd17a4 | 237 | "program" cmdline |
238 | Specify the command for the external NTLM authenticator. | |
239 | Such a program reads exchanged NTLMSSP packets with | |
240 | the browser via Squid until authentication is completed. | |
241 | If you use an NTLM authenticator, make sure you have 1 acl | |
242 | of type proxy_auth. By default, the NTLM authenticator_program | |
243 | is not used. | |
cccac0a2 | 244 | |
41bd17a4 | 245 | auth_param ntlm program @DEFAULT_PREFIX@/bin/ntlm_auth |
cccac0a2 | 246 | |
41bd17a4 | 247 | "children" numberofchildren |
248 | The number of authenticator processes to spawn (no default). | |
249 | If you start too few Squid will have to wait for them to | |
250 | process a backlog of credential verifications, slowing it | |
251 | down. When credential verifications are done via a (slow) | |
252 | network you are likely to need lots of authenticator | |
253 | processes. | |
cccac0a2 | 254 | |
41bd17a4 | 255 | auth_param ntlm children 5 |
cccac0a2 | 256 | |
41bd17a4 | 257 | "keep_alive" on|off |
258 | If you experience problems with PUT/POST requests when using the | |
259 | Negotiate authentication scheme then you can try setting this to | |
260 | off. This will cause Squid to forcibly close the connection on | |
261 | the initial requests where the browser asks which schemes are | |
262 | supported by the proxy. | |
cccac0a2 | 263 | |
41bd17a4 | 264 | auth_param ntlm keep_alive on |
cccac0a2 | 265 | |
41bd17a4 | 266 | === Options for configuring the NEGOTIATE auth-scheme follow === |
cccac0a2 | 267 | |
41bd17a4 | 268 | "program" cmdline |
269 | Specify the command for the external Negotiate authenticator. | |
270 | This protocol is used in Microsoft Active-Directory enabled setups with | |
271 | the Microsoft Internet Explorer or Mozilla Firefox browsers. | |
272 | Its main purpose is to exchange credentials with the Squid proxy | |
273 | using the Kerberos mechanisms. | |
274 | If you use a Negotiate authenticator, make sure you have at least one acl | |
275 | of type proxy_auth active. By default, the negotiate authenticator_program | |
276 | is not used. | |
277 | The only supported program for this role is the ntlm_auth | |
278 | program distributed as part of Samba, version 4 or later. | |
cccac0a2 | 279 | |
41bd17a4 | 280 | auth_param negotiate program @DEFAULT_PREFIX@/bin/ntlm_auth --helper-protocol=gss-spnego |
cccac0a2 | 281 | |
41bd17a4 | 282 | "children" numberofchildren |
283 | The number of authenticator processes to spawn (no default). | |
284 | If you start too few Squid will have to wait for them to | |
285 | process a backlog of credential verifications, slowing it | |
286 | down. When crendential verifications are done via a (slow) | |
287 | network you are likely to need lots of authenticator | |
288 | processes. | |
289 | auth_param negotiate children 5 | |
d3803853 | 290 | |
41bd17a4 | 291 | "keep_alive" on|off |
292 | If you experience problems with PUT/POST requests when using the | |
293 | Negotiate authentication scheme then you can try setting this to | |
294 | off. This will cause Squid to forcibly close the connection on | |
295 | the initial requests where the browser asks which schemes are | |
296 | supported by the proxy. | |
527ee50d | 297 | |
41bd17a4 | 298 | auth_param negotiate keep_alive on |
cccac0a2 | 299 | |
41bd17a4 | 300 | NOCOMMENT_START |
301 | #Recommended minimum configuration per scheme: | |
302 | #auth_param negotiate program <uncomment and complete this line to activate> | |
303 | #auth_param negotiate children 5 | |
304 | #auth_param negotiate keep_alive on | |
305 | #auth_param ntlm program <uncomment and complete this line to activate> | |
306 | #auth_param ntlm children 5 | |
307 | #auth_param ntlm keep_alive on | |
308 | #auth_param digest program <uncomment and complete this line> | |
309 | #auth_param digest children 5 | |
310 | #auth_param digest realm Squid proxy-caching web server | |
311 | #auth_param digest nonce_garbage_interval 5 minutes | |
312 | #auth_param digest nonce_max_duration 30 minutes | |
313 | #auth_param digest nonce_max_count 50 | |
314 | #auth_param basic program <uncomment and complete this line> | |
315 | #auth_param basic children 5 | |
316 | #auth_param basic realm Squid proxy-caching web server | |
317 | #auth_param basic credentialsttl 2 hours | |
318 | NOCOMMENT_END | |
319 | DOC_END | |
cccac0a2 | 320 | |
41bd17a4 | 321 | NAME: authenticate_cache_garbage_interval |
322 | TYPE: time_t | |
323 | DEFAULT: 1 hour | |
324 | LOC: Config.authenticateGCInterval | |
325 | DOC_START | |
326 | The time period between garbage collection across the username cache. | |
327 | This is a tradeoff between memory utilization (long intervals - say | |
328 | 2 days) and CPU (short intervals - say 1 minute). Only change if you | |
329 | have good reason to. | |
330 | DOC_END | |
cccac0a2 | 331 | |
41bd17a4 | 332 | NAME: authenticate_ttl |
333 | TYPE: time_t | |
334 | DEFAULT: 1 hour | |
335 | LOC: Config.authenticateTTL | |
336 | DOC_START | |
337 | The time a user & their credentials stay in the logged in | |
338 | user cache since their last request. When the garbage | |
339 | interval passes, all user credentials that have passed their | |
340 | TTL are removed from memory. | |
341 | DOC_END | |
cccac0a2 | 342 | |
41bd17a4 | 343 | NAME: authenticate_ip_ttl |
344 | TYPE: time_t | |
345 | LOC: Config.authenticateIpTTL | |
346 | DEFAULT: 0 seconds | |
347 | DOC_START | |
348 | If you use proxy authentication and the 'max_user_ip' ACL, | |
349 | this directive controls how long Squid remembers the IP | |
350 | addresses associated with each user. Use a small value | |
351 | (e.g., 60 seconds) if your users might change addresses | |
352 | quickly, as is the case with dialups. You might be safe | |
353 | using a larger value (e.g., 2 hours) in a corporate LAN | |
354 | environment with relatively static address assignments. | |
355 | DOC_END | |
cccac0a2 | 356 | |
3d1e3e43 | 357 | COMMENT_START |
358 | ACCESS CONTROLS | |
359 | ----------------------------------------------------------------------------- | |
360 | COMMENT_END | |
361 | ||
41bd17a4 | 362 | NAME: external_acl_type |
363 | TYPE: externalAclHelper | |
364 | LOC: Config.externalAclHelperList | |
cccac0a2 | 365 | DEFAULT: none |
cccac0a2 | 366 | DOC_START |
41bd17a4 | 367 | This option defines external acl classes using a helper program |
368 | to look up the status | |
cccac0a2 | 369 | |
41bd17a4 | 370 | external_acl_type name [options] FORMAT.. /path/to/helper [helper arguments..] |
cccac0a2 | 371 | |
41bd17a4 | 372 | Options: |
cccac0a2 | 373 | |
41bd17a4 | 374 | ttl=n TTL in seconds for cached results (defaults to 3600 |
375 | for 1 hour) | |
376 | negative_ttl=n | |
377 | TTL for cached negative lookups (default same | |
378 | as ttl) | |
379 | children=n Number of acl helper processes spawn to service | |
380 | external acl lookups of this type. (default 5) | |
381 | concurrency=n concurrency level per process. Only used with helpers | |
382 | capable of processing more than one query at a time. | |
383 | cache=n result cache size, 0 is unbounded (default) | |
384 | grace=n Percentage remaining of TTL where a refresh of a | |
385 | cached entry should be initiated without needing to | |
386 | wait for a new reply. (default 0 for no grace period) | |
387 | protocol=2.5 Compatibility mode for Squid-2.5 external acl helpers | |
cc192b50 | 388 | ipv4 / ipv6 IP-mode used to communicate to this helper. |
389 | For compatability with older configurations and helpers | |
390 | 'ipv4' is the default unless --with-localhost-ipv6 is used. | |
391 | --with-localhost-ipv6 changes the default to 'ipv6'. | |
392 | SPECIAL NOTE: these options override --with-localhost-ipv6 | |
cccac0a2 | 393 | |
41bd17a4 | 394 | FORMAT specifications |
cccac0a2 | 395 | |
41bd17a4 | 396 | %LOGIN Authenticated user login name |
397 | %EXT_USER Username from external acl | |
398 | %IDENT Ident user name | |
399 | %SRC Client IP | |
400 | %SRCPORT Client source port | |
401 | %URI Requested URI | |
402 | %DST Requested host | |
403 | %PROTO Requested protocol | |
404 | %PORT Requested port | |
405 | %PATH Requested URL path | |
406 | %METHOD Request method | |
407 | %MYADDR Squid interface address | |
408 | %MYPORT Squid http_port number | |
409 | %PATH Requested URL-path (including query-string if any) | |
410 | %USER_CERT SSL User certificate in PEM format | |
411 | %USER_CERTCHAIN SSL User certificate chain in PEM format | |
412 | %USER_CERT_xx SSL User certificate subject attribute xx | |
413 | %USER_CA_xx SSL User certificate issuer attribute xx | |
7b0ca1e8 AJ |
414 | |
415 | %>{Header} HTTP request header | |
416 | %>{Hdr:member} | |
417 | HTTP request header list member | |
418 | %>{Hdr:;member} | |
41bd17a4 | 419 | HTTP request header list member using ; as |
420 | list separator. ; can be any non-alphanumeric | |
421 | character. | |
cccac0a2 | 422 | |
7b0ca1e8 AJ |
423 | %<{Header} HTTP reply header |
424 | %<{Hdr:member} | |
425 | HTTP reply header list member | |
426 | %<{Hdr:;member} | |
427 | HTTP reply header list member using ; as | |
428 | list separator. ; can be any non-alphanumeric | |
429 | character. | |
430 | ||
41bd17a4 | 431 | In addition to the above, any string specified in the referencing |
432 | acl will also be included in the helper request line, after the | |
433 | specified formats (see the "acl external" directive) | |
cccac0a2 | 434 | |
41bd17a4 | 435 | The helper receives lines per the above format specification, |
436 | and returns lines starting with OK or ERR indicating the validity | |
437 | of the request and optionally followed by additional keywords with | |
438 | more details. | |
cccac0a2 | 439 | |
41bd17a4 | 440 | General result syntax: |
cccac0a2 | 441 | |
41bd17a4 | 442 | OK/ERR keyword=value ... |
cccac0a2 | 443 | |
41bd17a4 | 444 | Defined keywords: |
cccac0a2 | 445 | |
41bd17a4 | 446 | user= The users name (login) |
447 | password= The users password (for login= cache_peer option) | |
448 | message= Message describing the reason. Available as %o | |
449 | in error pages | |
450 | tag= Apply a tag to a request (for both ERR and OK results) | |
451 | Only sets a tag, does not alter existing tags. | |
452 | log= String to be logged in access.log. Available as | |
453 | %ea in logformat specifications | |
934b03fc | 454 | |
41bd17a4 | 455 | If protocol=3.0 (the default) then URL escaping is used to protect |
456 | each value in both requests and responses. | |
6a566b9c | 457 | |
41bd17a4 | 458 | If using protocol=2.5 then all values need to be enclosed in quotes |
459 | if they may contain whitespace, or the whitespace escaped using \. | |
460 | And quotes or \ characters within the keyword value must be \ escaped. | |
1e5562e3 | 461 | |
41bd17a4 | 462 | When using the concurrency= option the protocol is changed by |
463 | introducing a query channel tag infront of the request/response. | |
464 | The query channel tag is a number between 0 and concurrency-1. | |
cccac0a2 | 465 | DOC_END |
466 | ||
41bd17a4 | 467 | NAME: acl |
468 | TYPE: acl | |
469 | LOC: Config.aclList | |
1f5bd0a4 | 470 | DEFAULT: all src all |
cccac0a2 | 471 | DOC_START |
41bd17a4 | 472 | Defining an Access List |
cccac0a2 | 473 | |
375eeb3b AJ |
474 | Every access list definition must begin with an aclname and acltype, |
475 | followed by either type-specific arguments or a quoted filename that | |
476 | they are read from. | |
cccac0a2 | 477 | |
375eeb3b AJ |
478 | acl aclname acltype argument ... |
479 | acl aclname acltype "file" ... | |
cccac0a2 | 480 | |
375eeb3b | 481 | When using "file", the file should contain one item per line. |
cccac0a2 | 482 | |
41bd17a4 | 483 | By default, regular expressions are CASE-SENSITIVE. To make |
484 | them case-insensitive, use the -i option. | |
cccac0a2 | 485 | |
e988aa40 AJ |
486 | |
487 | ***** ACL TYPES AVAILABLE ***** | |
488 | ||
375eeb3b AJ |
489 | acl aclname src ip-address/netmask ... # clients IP address |
490 | acl aclname src addr1-addr2/netmask ... # range of addresses | |
491 | acl aclname dst ip-address/netmask ... # URL host's IP address | |
492 | acl aclname myip ip-address/netmask ... # local socket IP address | |
cccac0a2 | 493 | |
41bd17a4 | 494 | acl aclname arp mac-address ... (xx:xx:xx:xx:xx:xx notation) |
495 | # The arp ACL requires the special configure option --enable-arp-acl. | |
496 | # Furthermore, the ARP ACL code is not portable to all operating systems. | |
497 | # It works on Linux, Solaris, Windows, FreeBSD, and some other *BSD variants. | |
498 | # | |
499 | # NOTE: Squid can only determine the MAC address for clients that are on | |
500 | # the same subnet. If the client is on a different subnet, then Squid cannot | |
501 | # find out its MAC address. | |
934b03fc | 502 | |
375eeb3b AJ |
503 | acl aclname srcdomain .foo.com ... # reverse lookup, from client IP |
504 | acl aclname dstdomain .foo.com ... # Destination server from URL | |
505 | acl aclname srcdom_regex [-i] \.foo\.com ... # regex matching client name | |
506 | acl aclname dstdom_regex [-i] \.foo\.com ... # regex matching server | |
41bd17a4 | 507 | # For dstdomain and dstdom_regex a reverse lookup is tried if a IP |
508 | # based URL is used and no match is found. The name "none" is used | |
509 | # if the reverse lookup fails. | |
9bc73deb | 510 | |
375eeb3b AJ |
511 | acl aclname src_as number ... |
512 | acl aclname dst_as number ... | |
e988aa40 AJ |
513 | # Except for access control, AS numbers can be used for |
514 | # routing of requests to specific caches. Here's an | |
515 | # example for routing all requests for AS#1241 and only | |
516 | # those to mycache.mydomain.net: | |
517 | # acl asexample dst_as 1241 | |
518 | # cache_peer_access mycache.mydomain.net allow asexample | |
519 | # cache_peer_access mycache_mydomain.net deny all | |
7f7db318 | 520 | |
375eeb3b AJ |
521 | acl aclname time [day-abbrevs] [h1:m1-h2:m2] |
522 | # day-abbrevs: | |
523 | # S - Sunday | |
524 | # M - Monday | |
525 | # T - Tuesday | |
526 | # W - Wednesday | |
527 | # H - Thursday | |
528 | # F - Friday | |
529 | # A - Saturday | |
530 | # h1:m1 must be less than h2:m2 | |
531 | ||
532 | acl aclname url_regex [-i] ^http:// ... # regex matching on whole URL | |
41bd17a4 | 533 | acl aclname urlpath_regex [-i] \.gif$ ... # regex matching on URL path |
e988aa40 | 534 | |
375eeb3b AJ |
535 | acl aclname port 80 70 21 ... |
536 | acl aclname port 0-1024 ... # ranges allowed | |
537 | acl aclname myport 3128 ... # (local socket TCP port) | |
197f6b3c | 538 | acl aclname myportname 3128 ... # http(s)_port name |
e988aa40 | 539 | |
375eeb3b | 540 | acl aclname proto HTTP FTP ... |
e988aa40 | 541 | |
375eeb3b | 542 | acl aclname method GET POST ... |
e988aa40 AJ |
543 | |
544 | acl aclname http_status 200 301 500- 400-403 ... # status code in reply | |
545 | ||
375eeb3b | 546 | acl aclname browser [-i] regexp ... |
41bd17a4 | 547 | # pattern match on User-Agent header (see also req_header below) |
e988aa40 | 548 | |
375eeb3b | 549 | acl aclname referer_regex [-i] regexp ... |
41bd17a4 | 550 | # pattern match on Referer header |
551 | # Referer is highly unreliable, so use with care | |
e988aa40 | 552 | |
375eeb3b | 553 | acl aclname ident username ... |
41bd17a4 | 554 | acl aclname ident_regex [-i] pattern ... |
555 | # string match on ident output. | |
556 | # use REQUIRED to accept any non-null ident. | |
cf5cc17e | 557 | |
41bd17a4 | 558 | acl aclname proxy_auth [-i] username ... |
559 | acl aclname proxy_auth_regex [-i] pattern ... | |
560 | # list of valid usernames | |
561 | # use REQUIRED to accept any valid username. | |
562 | # | |
563 | # NOTE: when a Proxy-Authentication header is sent but it is not | |
564 | # needed during ACL checking the username is NOT logged | |
565 | # in access.log. | |
566 | # | |
567 | # NOTE: proxy_auth requires a EXTERNAL authentication program | |
568 | # to check username/password combinations (see | |
569 | # auth_param directive). | |
570 | # | |
e988aa40 AJ |
571 | # NOTE: proxy_auth can't be used in a transparent/intercepting proxy |
572 | # as the browser needs to be configured for using a proxy in order | |
41bd17a4 | 573 | # to respond to proxy authentication. |
8e8d4f30 | 574 | |
41bd17a4 | 575 | acl aclname snmp_community string ... |
576 | # A community string to limit access to your SNMP Agent | |
577 | # Example: | |
578 | # | |
579 | # acl snmppublic snmp_community public | |
934b03fc | 580 | |
41bd17a4 | 581 | acl aclname maxconn number |
582 | # This will be matched when the client's IP address has | |
583 | # more than <number> HTTP connections established. | |
1e5562e3 | 584 | |
41bd17a4 | 585 | acl aclname max_user_ip [-s] number |
586 | # This will be matched when the user attempts to log in from more | |
587 | # than <number> different ip addresses. The authenticate_ip_ttl | |
588 | # parameter controls the timeout on the ip entries. | |
589 | # If -s is specified the limit is strict, denying browsing | |
590 | # from any further IP addresses until the ttl has expired. Without | |
591 | # -s Squid will just annoy the user by "randomly" denying requests. | |
592 | # (the counter is reset each time the limit is reached and a | |
593 | # request is denied) | |
594 | # NOTE: in acceleration mode or where there is mesh of child proxies, | |
595 | # clients may appear to come from multiple addresses if they are | |
596 | # going through proxy farms, so a limit of 1 may cause user problems. | |
cccac0a2 | 597 | |
375eeb3b | 598 | acl aclname req_mime_type [-i] mime-type ... |
41bd17a4 | 599 | # regex match against the mime type of the request generated |
600 | # by the client. Can be used to detect file upload or some | |
601 | # types HTTP tunneling requests. | |
602 | # NOTE: This does NOT match the reply. You cannot use this | |
603 | # to match the returned file type. | |
cccac0a2 | 604 | |
41bd17a4 | 605 | acl aclname req_header header-name [-i] any\.regex\.here |
606 | # regex match against any of the known request headers. May be | |
607 | # thought of as a superset of "browser", "referer" and "mime-type" | |
608 | # ACLs. | |
cccac0a2 | 609 | |
375eeb3b | 610 | acl aclname rep_mime_type [-i] mime-type ... |
41bd17a4 | 611 | # regex match against the mime type of the reply received by |
612 | # squid. Can be used to detect file download or some | |
613 | # types HTTP tunneling requests. | |
614 | # NOTE: This has no effect in http_access rules. It only has | |
615 | # effect in rules that affect the reply data stream such as | |
616 | # http_reply_access. | |
cccac0a2 | 617 | |
41bd17a4 | 618 | acl aclname rep_header header-name [-i] any\.regex\.here |
619 | # regex match against any of the known reply headers. May be | |
620 | # thought of as a superset of "browser", "referer" and "mime-type" | |
621 | # ACLs. | |
cccac0a2 | 622 | |
375eeb3b | 623 | acl aclname external class_name [arguments...] |
41bd17a4 | 624 | # external ACL lookup via a helper class defined by the |
625 | # external_acl_type directive. | |
cccac0a2 | 626 | |
41bd17a4 | 627 | acl aclname user_cert attribute values... |
628 | # match against attributes in a user SSL certificate | |
629 | # attribute is one of DN/C/O/CN/L/ST | |
cccac0a2 | 630 | |
41bd17a4 | 631 | acl aclname ca_cert attribute values... |
632 | # match against attributes a users issuing CA SSL certificate | |
633 | # attribute is one of DN/C/O/CN/L/ST | |
cccac0a2 | 634 | |
41bd17a4 | 635 | acl aclname ext_user username ... |
636 | acl aclname ext_user_regex [-i] pattern ... | |
637 | # string match on username returned by external acl helper | |
638 | # use REQUIRED to accept any non-null user name. | |
cccac0a2 | 639 | |
41bd17a4 | 640 | Examples: |
641 | acl macaddress arp 09:00:2b:23:45:67 | |
642 | acl myexample dst_as 1241 | |
643 | acl password proxy_auth REQUIRED | |
644 | acl fileupload req_mime_type -i ^multipart/form-data$ | |
645 | acl javascript rep_mime_type -i ^application/x-javascript$ | |
cccac0a2 | 646 | |
41bd17a4 | 647 | NOCOMMENT_START |
648 | #Recommended minimum configuration: | |
41bd17a4 | 649 | acl manager proto cache_object |
ee776778 | 650 | acl localhost src 127.0.0.1/32 |
41bd17a4 | 651 | acl to_localhost dst 127.0.0.0/8 |
ee776778 | 652 | # |
653 | # Example rule allowing access from your local networks. | |
654 | # Adapt to list your (internal) IP networks from where browsing | |
655 | # should be allowed | |
656 | acl localnet src 10.0.0.0/8 # RFC1918 possible internal network | |
657 | acl localnet src 172.16.0.0/12 # RFC1918 possible internal network | |
658 | acl localnet src 192.168.0.0/16 # RFC1918 possible internal network | |
659 | # | |
41bd17a4 | 660 | acl SSL_ports port 443 |
661 | acl Safe_ports port 80 # http | |
662 | acl Safe_ports port 21 # ftp | |
663 | acl Safe_ports port 443 # https | |
664 | acl Safe_ports port 70 # gopher | |
665 | acl Safe_ports port 210 # wais | |
666 | acl Safe_ports port 1025-65535 # unregistered ports | |
667 | acl Safe_ports port 280 # http-mgmt | |
668 | acl Safe_ports port 488 # gss-http | |
669 | acl Safe_ports port 591 # filemaker | |
670 | acl Safe_ports port 777 # multiling http | |
671 | acl CONNECT method CONNECT | |
672 | NOCOMMENT_END | |
673 | DOC_END | |
cccac0a2 | 674 | |
3d674977 AJ |
675 | NAME: follow_x_forwarded_for |
676 | TYPE: acl_access | |
677 | IFDEF: FOLLOW_X_FORWARDED_FOR | |
678 | LOC: Config.accessList.followXFF | |
679 | DEFAULT: none | |
680 | DEFAULT_IF_NONE: deny all | |
681 | DOC_START | |
682 | Allowing or Denying the X-Forwarded-For header to be followed to | |
683 | find the original source of a request. | |
684 | ||
685 | Requests may pass through a chain of several other proxies | |
686 | before reaching us. The X-Forwarded-For header will contain a | |
687 | comma-separated list of the IP addresses in the chain, with the | |
688 | rightmost address being the most recent. | |
689 | ||
690 | If a request reaches us from a source that is allowed by this | |
691 | configuration item, then we consult the X-Forwarded-For header | |
692 | to see where that host received the request from. If the | |
693 | X-Forwarded-For header contains multiple addresses, and if | |
694 | acl_uses_indirect_client is on, then we continue backtracking | |
695 | until we reach an address for which we are not allowed to | |
696 | follow the X-Forwarded-For header, or until we reach the first | |
697 | address in the list. (If acl_uses_indirect_client is off, then | |
698 | it's impossible to backtrack through more than one level of | |
699 | X-Forwarded-For addresses.) | |
700 | ||
701 | The end result of this process is an IP address that we will | |
702 | refer to as the indirect client address. This address may | |
703 | be treated as the client address for access control, delay | |
704 | pools and logging, depending on the acl_uses_indirect_client, | |
705 | delay_pool_uses_indirect_client and log_uses_indirect_client | |
706 | options. | |
707 | ||
708 | SECURITY CONSIDERATIONS: | |
709 | ||
710 | Any host for which we follow the X-Forwarded-For header | |
711 | can place incorrect information in the header, and Squid | |
712 | will use the incorrect information as if it were the | |
713 | source address of the request. This may enable remote | |
714 | hosts to bypass any access control restrictions that are | |
715 | based on the client's source addresses. | |
716 | ||
717 | For example: | |
718 | ||
719 | acl localhost src 127.0.0.1 | |
720 | acl my_other_proxy srcdomain .proxy.example.com | |
721 | follow_x_forwarded_for allow localhost | |
722 | follow_x_forwarded_for allow my_other_proxy | |
723 | DOC_END | |
724 | ||
725 | NAME: acl_uses_indirect_client | |
726 | COMMENT: on|off | |
727 | TYPE: onoff | |
728 | IFDEF: FOLLOW_X_FORWARDED_FOR | |
729 | DEFAULT: on | |
730 | LOC: Config.onoff.acl_uses_indirect_client | |
731 | DOC_START | |
732 | Controls whether the indirect client address | |
733 | (see follow_x_forwarded_for) is used instead of the | |
734 | direct client address in acl matching. | |
735 | DOC_END | |
736 | ||
737 | NAME: delay_pool_uses_indirect_client | |
738 | COMMENT: on|off | |
739 | TYPE: onoff | |
97a616ca | 740 | IFDEF: FOLLOW_X_FORWARDED_FOR DELAY_POOLS |
3d674977 AJ |
741 | DEFAULT: on |
742 | LOC: Config.onoff.delay_pool_uses_indirect_client | |
743 | DOC_START | |
744 | Controls whether the indirect client address | |
745 | (see follow_x_forwarded_for) is used instead of the | |
746 | direct client address in delay pools. | |
747 | DOC_END | |
748 | ||
749 | NAME: log_uses_indirect_client | |
750 | COMMENT: on|off | |
751 | TYPE: onoff | |
752 | IFDEF: FOLLOW_X_FORWARDED_FOR | |
753 | DEFAULT: on | |
754 | LOC: Config.onoff.log_uses_indirect_client | |
755 | DOC_START | |
756 | Controls whether the indirect client address | |
757 | (see follow_x_forwarded_for) is used instead of the | |
758 | direct client address in the access log. | |
759 | DOC_END | |
760 | ||
41bd17a4 | 761 | NAME: http_access |
762 | TYPE: acl_access | |
763 | LOC: Config.accessList.http | |
764 | DEFAULT: none | |
765 | DEFAULT_IF_NONE: deny all | |
766 | DOC_START | |
767 | Allowing or Denying access based on defined access lists | |
cccac0a2 | 768 | |
41bd17a4 | 769 | Access to the HTTP port: |
770 | http_access allow|deny [!]aclname ... | |
cccac0a2 | 771 | |
41bd17a4 | 772 | NOTE on default values: |
cccac0a2 | 773 | |
41bd17a4 | 774 | If there are no "access" lines present, the default is to deny |
775 | the request. | |
cccac0a2 | 776 | |
41bd17a4 | 777 | If none of the "access" lines cause a match, the default is the |
778 | opposite of the last line in the list. If the last line was | |
779 | deny, the default is allow. Conversely, if the last line | |
780 | is allow, the default will be deny. For these reasons, it is a | |
781 | good idea to have an "deny all" or "allow all" entry at the end | |
782 | of your access lists to avoid potential confusion. | |
cccac0a2 | 783 | |
41bd17a4 | 784 | NOCOMMENT_START |
785 | #Recommended minimum configuration: | |
786 | # | |
787 | # Only allow cachemgr access from localhost | |
788 | http_access allow manager localhost | |
789 | http_access deny manager | |
790 | # Deny requests to unknown ports | |
791 | http_access deny !Safe_ports | |
792 | # Deny CONNECT to other than SSL ports | |
793 | http_access deny CONNECT !SSL_ports | |
794 | # | |
795 | # We strongly recommend the following be uncommented to protect innocent | |
796 | # web applications running on the proxy server who think the only | |
797 | # one who can access services on "localhost" is a local user | |
798 | #http_access deny to_localhost | |
799 | # | |
800 | # INSERT YOUR OWN RULE(S) HERE TO ALLOW ACCESS FROM YOUR CLIENTS | |
c8f4eac4 | 801 | |
ee776778 | 802 | # Example rule allowing access from your local networks. |
803 | # Adapt localnet in the ACL section to list your (internal) IP networks | |
804 | # from where browsing should be allowed | |
805 | http_access allow localnet | |
7d90757b | 806 | |
41bd17a4 | 807 | # And finally deny all other access to this proxy |
808 | http_access deny all | |
809 | NOCOMMENT_END | |
810 | DOC_END | |
7d90757b | 811 | |
41bd17a4 | 812 | NAME: http_reply_access |
813 | TYPE: acl_access | |
814 | LOC: Config.accessList.reply | |
815 | DEFAULT: none | |
816 | DOC_START | |
817 | Allow replies to client requests. This is complementary to http_access. | |
cccac0a2 | 818 | |
41bd17a4 | 819 | http_reply_access allow|deny [!] aclname ... |
cccac0a2 | 820 | |
41bd17a4 | 821 | NOTE: if there are no access lines present, the default is to allow |
822 | all replies | |
1a224843 | 823 | |
41bd17a4 | 824 | If none of the access lines cause a match the opposite of the |
825 | last line will apply. Thus it is good practice to end the rules | |
826 | with an "allow all" or "deny all" entry. | |
cccac0a2 | 827 | DOC_END |
828 | ||
41bd17a4 | 829 | NAME: icp_access |
830 | TYPE: acl_access | |
831 | LOC: Config.accessList.icp | |
832 | DEFAULT: none | |
833 | DEFAULT_IF_NONE: deny all | |
5473c134 | 834 | DOC_START |
41bd17a4 | 835 | Allowing or Denying access to the ICP port based on defined |
836 | access lists | |
5473c134 | 837 | |
41bd17a4 | 838 | icp_access allow|deny [!]aclname ... |
5473c134 | 839 | |
41bd17a4 | 840 | See http_access for details |
841 | ||
842 | NOCOMMENT_START | |
ee776778 | 843 | #Allow ICP queries from local networks only |
df2eec10 AJ |
844 | #icp_access allow localnet |
845 | #icp_access deny all | |
41bd17a4 | 846 | NOCOMMENT_END |
5473c134 | 847 | DOC_END |
848 | ||
41bd17a4 | 849 | NAME: htcp_access |
850 | IFDEF: USE_HTCP | |
851 | TYPE: acl_access | |
852 | LOC: Config.accessList.htcp | |
853 | DEFAULT: none | |
854 | DEFAULT_IF_NONE: deny all | |
5473c134 | 855 | DOC_START |
41bd17a4 | 856 | Allowing or Denying access to the HTCP port based on defined |
857 | access lists | |
5473c134 | 858 | |
41bd17a4 | 859 | htcp_access allow|deny [!]aclname ... |
5473c134 | 860 | |
41bd17a4 | 861 | See http_access for details |
5473c134 | 862 | |
0b48417e | 863 | NOTE: The default if no htcp_access lines are present is to |
864 | deny all traffic. This default may cause problems with peers | |
865 | using the htcp or htcp-oldsquid options. | |
866 | ||
ee776778 | 867 | NOCOMMENT_START |
868 | #Allow HTCP queries from local networks only | |
df2eec10 AJ |
869 | #htcp_access allow localnet |
870 | #htcp_access deny all | |
ee776778 | 871 | NOCOMMENT_END |
41bd17a4 | 872 | DOC_END |
5473c134 | 873 | |
41bd17a4 | 874 | NAME: htcp_clr_access |
875 | IFDEF: USE_HTCP | |
876 | TYPE: acl_access | |
877 | LOC: Config.accessList.htcp_clr | |
878 | DEFAULT: none | |
879 | DEFAULT_IF_NONE: deny all | |
880 | DOC_START | |
881 | Allowing or Denying access to purge content using HTCP based | |
882 | on defined access lists | |
5473c134 | 883 | |
41bd17a4 | 884 | htcp_clr_access allow|deny [!]aclname ... |
5473c134 | 885 | |
41bd17a4 | 886 | See http_access for details |
5473c134 | 887 | |
41bd17a4 | 888 | #Allow HTCP CLR requests from trusted peers |
889 | acl htcp_clr_peer src 172.16.1.2 | |
890 | htcp_clr_access allow htcp_clr_peer | |
5473c134 | 891 | DOC_END |
892 | ||
41bd17a4 | 893 | NAME: miss_access |
894 | TYPE: acl_access | |
895 | LOC: Config.accessList.miss | |
df2eec10 | 896 | DEFAULT: allow all |
5473c134 | 897 | DOC_START |
41bd17a4 | 898 | Use to force your neighbors to use you as a sibling instead of |
899 | a parent. For example: | |
5473c134 | 900 | |
41bd17a4 | 901 | acl localclients src 172.16.0.0/16 |
902 | miss_access allow localclients | |
903 | miss_access deny !localclients | |
5473c134 | 904 | |
41bd17a4 | 905 | This means only your local clients are allowed to fetch |
906 | MISSES and all other clients can only fetch HITS. | |
5473c134 | 907 | |
41bd17a4 | 908 | By default, allow all clients who passed the http_access rules |
909 | to fetch MISSES from us. | |
41bd17a4 | 910 | DOC_END |
911 | ||
912 | NAME: ident_lookup_access | |
913 | TYPE: acl_access | |
914 | IFDEF: USE_IDENT | |
915 | DEFAULT: none | |
916 | DEFAULT_IF_NONE: deny all | |
917 | LOC: Config.accessList.identLookup | |
5473c134 | 918 | DOC_START |
41bd17a4 | 919 | A list of ACL elements which, if matched, cause an ident |
920 | (RFC 931) lookup to be performed for this request. For | |
921 | example, you might choose to always perform ident lookups | |
922 | for your main multi-user Unix boxes, but not for your Macs | |
923 | and PCs. By default, ident lookups are not performed for | |
924 | any requests. | |
5473c134 | 925 | |
41bd17a4 | 926 | To enable ident lookups for specific client addresses, you |
927 | can follow this example: | |
5473c134 | 928 | |
41bd17a4 | 929 | acl ident_aware_hosts src 198.168.1.0/255.255.255.0 |
930 | ident_lookup_access allow ident_aware_hosts | |
931 | ident_lookup_access deny all | |
5473c134 | 932 | |
41bd17a4 | 933 | Only src type ACL checks are fully supported. A src_domain |
934 | ACL might work at times, but it will not always provide | |
935 | the correct result. | |
936 | DOC_END | |
5473c134 | 937 | |
5b0f5383 | 938 | NAME: reply_body_max_size |
939 | COMMENT: size [acl acl...] | |
940 | TYPE: acl_b_size_t | |
941 | DEFAULT: none | |
942 | LOC: Config.ReplyBodySize | |
943 | DOC_START | |
944 | This option specifies the maximum size of a reply body. It can be | |
945 | used to prevent users from downloading very large files, such as | |
946 | MP3's and movies. When the reply headers are received, the | |
947 | reply_body_max_size lines are processed, and the first line where | |
948 | all (if any) listed ACLs are true is used as the maximum body size | |
949 | for this reply. | |
950 | ||
951 | This size is checked twice. First when we get the reply headers, | |
952 | we check the content-length value. If the content length value exists | |
953 | and is larger than the allowed size, the request is denied and the | |
954 | user receives an error message that says "the request or reply | |
955 | is too large." If there is no content-length, and the reply | |
956 | size exceeds this limit, the client's connection is just closed | |
957 | and they will receive a partial reply. | |
958 | ||
959 | WARNING: downstream caches probably can not detect a partial reply | |
960 | if there is no content-length header, so they will cache | |
961 | partial responses and give them out as hits. You should NOT | |
962 | use this option if you have downstream caches. | |
963 | ||
964 | WARNING: A maximum size smaller than the size of squid's error messages | |
965 | will cause an infinite loop and crash squid. Ensure that the smallest | |
966 | non-zero value you use is greater that the maximum header size plus | |
967 | the size of your largest error page. | |
968 | ||
969 | If you set this parameter none (the default), there will be | |
970 | no limit imposed. | |
3bc32f2f AJ |
971 | |
972 | Configuration Format is: | |
973 | reply_body_max_size SIZE UNITS [acl ...] | |
974 | ie. | |
975 | reply_body_max_size 10 MB | |
976 | ||
5b0f5383 | 977 | DOC_END |
978 | ||
979 | COMMENT_START | |
980 | NETWORK OPTIONS | |
981 | ----------------------------------------------------------------------------- | |
982 | COMMENT_END | |
983 | ||
984 | NAME: http_port ascii_port | |
985 | TYPE: http_port_list | |
986 | DEFAULT: none | |
987 | LOC: Config.Sockaddr.http | |
988 | DOC_START | |
989 | Usage: port [options] | |
990 | hostname:port [options] | |
991 | 1.2.3.4:port [options] | |
992 | ||
993 | The socket addresses where Squid will listen for HTTP client | |
994 | requests. You may specify multiple socket addresses. | |
995 | There are three forms: port alone, hostname with port, and | |
996 | IP address with port. If you specify a hostname or IP | |
997 | address, Squid binds the socket to that specific | |
998 | address. This replaces the old 'tcp_incoming_address' | |
999 | option. Most likely, you do not need to bind to a specific | |
1000 | address, so you can use the port number alone. | |
1001 | ||
1002 | If you are running Squid in accelerator mode, you | |
1003 | probably want to listen on port 80 also, or instead. | |
1004 | ||
1005 | The -a command line option may be used to specify additional | |
1006 | port(s) where Squid listens for proxy request. Such ports will | |
1007 | be plain proxy ports with no options. | |
1008 | ||
1009 | You may specify multiple socket addresses on multiple lines. | |
1010 | ||
1011 | Options: | |
1012 | ||
e77bdb4e | 1013 | intercept Support for IP-Layer interception of |
5b0f5383 | 1014 | outgoing requests without browser settings. |
13b5cd0c | 1015 | NP: disables authentication and IPv6 on the port. |
5b0f5383 | 1016 | |
1017 | tproxy Support Linux TPROXY for spoofing outgoing | |
1018 | connections using the client IP address. | |
13b5cd0c | 1019 | NP: disables authentication and IPv6 on the port. |
5b0f5383 | 1020 | |
1021 | accel Accelerator mode. Also needs at least one of | |
1022 | vhost / vport / defaultsite. | |
1023 | ||
1024 | defaultsite=domainname | |
1025 | What to use for the Host: header if it is not present | |
1026 | in a request. Determines what site (not origin server) | |
1027 | accelerators should consider the default. | |
1028 | Implies accel. | |
1029 | ||
1030 | vhost Accelerator mode using Host header for virtual | |
1031 | domain support. Implies accel. | |
1032 | ||
1033 | vport Accelerator with IP based virtual host support. | |
1034 | Implies accel. | |
1035 | ||
1036 | vport=NN As above, but uses specified port number rather | |
1037 | than the http_port number. Implies accel. | |
1038 | ||
1039 | protocol= Protocol to reconstruct accelerated requests with. | |
1040 | Defaults to http. | |
1041 | ||
d67acb4e AJ |
1042 | connection-auth[=on|off] |
1043 | use connection-auth=off to tell Squid to prevent | |
1044 | forwarding Microsoft connection oriented authentication | |
1045 | (NTLM, Negotiate and Kerberos) | |
1046 | ||
5b0f5383 | 1047 | disable-pmtu-discovery= |
1048 | Control Path-MTU discovery usage: | |
1049 | off lets OS decide on what to do (default). | |
1050 | transparent disable PMTU discovery when transparent | |
1051 | support is enabled. | |
1052 | always disable always PMTU discovery. | |
1053 | ||
1054 | In many setups of transparently intercepting proxies | |
1055 | Path-MTU discovery can not work on traffic towards the | |
1056 | clients. This is the case when the intercepting device | |
1057 | does not fully track connections and fails to forward | |
1058 | ICMP must fragment messages to the cache server. If you | |
1059 | have such setup and experience that certain clients | |
1060 | sporadically hang or never complete requests set | |
1061 | disable-pmtu-discovery option to 'transparent'. | |
1062 | ||
4c9da963 | 1063 | sslBump Intercept each CONNECT request matching ssl_bump ACL, |
1064 | establish secure connection with the client and with | |
1065 | the server, decrypt HTTP messages as they pass through | |
1066 | Squid, and treat them as unencrypted HTTP messages, | |
1067 | becoming the man-in-the-middle. | |
1068 | ||
1069 | When this option is enabled, additional options become | |
1070 | available to specify SSL-related properties of the | |
1071 | client-side connection: cert, key, version, cipher, | |
1072 | options, clientca, cafile, capath, crlfile, dhparams, | |
1073 | sslflags, and sslcontext. See the https_port directive | |
1074 | for more information on these options. | |
1075 | ||
1076 | The ssl_bump option is required to fully enable | |
1077 | the SslBump feature. | |
1078 | ||
81b6e9a7 | 1079 | name= Specifies a internal name for the port. Defaults to |
1080 | the port specification (port or addr:port) | |
1081 | ||
b2130d58 | 1082 | keepalive[=idle,interval,timeout] |
1083 | Enable TCP keepalive probes of idle connections | |
1084 | idle is the initial time before TCP starts probing | |
1085 | the connection, interval how often to probe, and | |
1086 | timeout the time before giving up. | |
1087 | ||
5b0f5383 | 1088 | If you run Squid on a dual-homed machine with an internal |
1089 | and an external interface we recommend you to specify the | |
1090 | internal address:port in http_port. This way Squid will only be | |
1091 | visible on the internal address. | |
1092 | ||
1093 | NOCOMMENT_START | |
1094 | # Squid normally listens to port 3128 | |
1095 | http_port @DEFAULT_HTTP_PORT@ | |
1096 | NOCOMMENT_END | |
1097 | DOC_END | |
1098 | ||
1099 | NAME: https_port | |
1100 | IFDEF: USE_SSL | |
1101 | TYPE: https_port_list | |
1102 | DEFAULT: none | |
1103 | LOC: Config.Sockaddr.https | |
1104 | DOC_START | |
1105 | Usage: [ip:]port cert=certificate.pem [key=key.pem] [options...] | |
1106 | ||
1107 | The socket address where Squid will listen for HTTPS client | |
1108 | requests. | |
1109 | ||
1110 | This is really only useful for situations where you are running | |
1111 | squid in accelerator mode and you want to do the SSL work at the | |
1112 | accelerator level. | |
1113 | ||
1114 | You may specify multiple socket addresses on multiple lines, | |
1115 | each with their own SSL certificate and/or options. | |
1116 | ||
1117 | Options: | |
1118 | ||
1119 | accel Accelerator mode. Also needs at least one of | |
1120 | defaultsite or vhost. | |
1121 | ||
1122 | defaultsite= The name of the https site presented on | |
1123 | this port. Implies accel. | |
1124 | ||
1125 | vhost Accelerator mode using Host header for virtual | |
1126 | domain support. Requires a wildcard certificate | |
1127 | or other certificate valid for more than one domain. | |
1128 | Implies accel. | |
1129 | ||
1130 | protocol= Protocol to reconstruct accelerated requests with. | |
1131 | Defaults to https. | |
1132 | ||
1133 | cert= Path to SSL certificate (PEM format). | |
1134 | ||
1135 | key= Path to SSL private key file (PEM format) | |
1136 | if not specified, the certificate file is | |
1137 | assumed to be a combined certificate and | |
1138 | key file. | |
1139 | ||
1140 | version= The version of SSL/TLS supported | |
1141 | 1 automatic (default) | |
1142 | 2 SSLv2 only | |
1143 | 3 SSLv3 only | |
1144 | 4 TLSv1 only | |
1145 | ||
1146 | cipher= Colon separated list of supported ciphers. | |
1147 | ||
1148 | options= Various SSL engine options. The most important | |
1149 | being: | |
1150 | NO_SSLv2 Disallow the use of SSLv2 | |
1151 | NO_SSLv3 Disallow the use of SSLv3 | |
1152 | NO_TLSv1 Disallow the use of TLSv1 | |
1153 | SINGLE_DH_USE Always create a new key when using | |
1154 | temporary/ephemeral DH key exchanges | |
1155 | See src/ssl_support.c or OpenSSL SSL_CTX_set_options | |
1156 | documentation for a complete list of options. | |
1157 | ||
1158 | clientca= File containing the list of CAs to use when | |
1159 | requesting a client certificate. | |
1160 | ||
1161 | cafile= File containing additional CA certificates to | |
1162 | use when verifying client certificates. If unset | |
1163 | clientca will be used. | |
1164 | ||
1165 | capath= Directory containing additional CA certificates | |
1166 | and CRL lists to use when verifying client certificates. | |
1167 | ||
1168 | crlfile= File of additional CRL lists to use when verifying | |
1169 | the client certificate, in addition to CRLs stored in | |
1170 | the capath. Implies VERIFY_CRL flag below. | |
1171 | ||
1172 | dhparams= File containing DH parameters for temporary/ephemeral | |
1173 | DH key exchanges. | |
1174 | ||
1175 | sslflags= Various flags modifying the use of SSL: | |
1176 | DELAYED_AUTH | |
1177 | Don't request client certificates | |
1178 | immediately, but wait until acl processing | |
1179 | requires a certificate (not yet implemented). | |
1180 | NO_DEFAULT_CA | |
1181 | Don't use the default CA lists built in | |
1182 | to OpenSSL. | |
1183 | NO_SESSION_REUSE | |
1184 | Don't allow for session reuse. Each connection | |
1185 | will result in a new SSL session. | |
1186 | VERIFY_CRL | |
1187 | Verify CRL lists when accepting client | |
1188 | certificates. | |
1189 | VERIFY_CRL_ALL | |
1190 | Verify CRL lists for all certificates in the | |
1191 | client certificate chain. | |
1192 | ||
1193 | sslcontext= SSL session ID context identifier. | |
1194 | ||
1195 | vport Accelerator with IP based virtual host support. | |
1196 | ||
1197 | vport=NN As above, but uses specified port number rather | |
1198 | than the https_port number. Implies accel. | |
1199 | ||
81b6e9a7 | 1200 | name= Specifies a internal name for the port. Defaults to |
1201 | the port specification (port or addr:port) | |
1202 | ||
5b0f5383 | 1203 | DOC_END |
1204 | ||
41bd17a4 | 1205 | NAME: tcp_outgoing_tos tcp_outgoing_ds tcp_outgoing_dscp |
1206 | TYPE: acl_tos | |
5473c134 | 1207 | DEFAULT: none |
41bd17a4 | 1208 | LOC: Config.accessList.outgoing_tos |
5473c134 | 1209 | DOC_START |
41bd17a4 | 1210 | Allows you to select a TOS/Diffserv value to mark outgoing |
1211 | connections with, based on the username or source address | |
1212 | making the request. | |
5473c134 | 1213 | |
41bd17a4 | 1214 | tcp_outgoing_tos ds-field [!]aclname ... |
cccac0a2 | 1215 | |
41bd17a4 | 1216 | Example where normal_service_net uses the TOS value 0x00 |
1217 | and normal_service_net uses 0x20 | |
cccac0a2 | 1218 | |
41bd17a4 | 1219 | acl normal_service_net src 10.0.0.0/255.255.255.0 |
1220 | acl good_service_net src 10.0.1.0/255.255.255.0 | |
2c73de90 | 1221 | tcp_outgoing_tos 0x00 normal_service_net |
41bd17a4 | 1222 | tcp_outgoing_tos 0x20 good_service_net |
fa38076e | 1223 | |
41bd17a4 | 1224 | TOS/DSCP values really only have local significance - so you should |
1225 | know what you're specifying. For more information, see RFC2474 and | |
1226 | RFC3260. | |
cccac0a2 | 1227 | |
41bd17a4 | 1228 | The TOS/DSCP byte must be exactly that - a octet value 0 - 255, or |
1229 | "default" to use whatever default your host has. Note that in | |
1230 | practice often only values 0 - 63 is usable as the two highest bits | |
1231 | have been redefined for use by ECN (RFC3168). | |
cccac0a2 | 1232 | |
41bd17a4 | 1233 | Processing proceeds in the order specified, and stops at first fully |
1234 | matching line. | |
cccac0a2 | 1235 | |
41bd17a4 | 1236 | Note: The use of this directive using client dependent ACLs is |
1237 | incompatible with the use of server side persistent connections. To | |
1238 | ensure correct results it is best to set server_persisten_connections | |
1239 | to off when using this directive in such configurations. | |
cccac0a2 | 1240 | DOC_END |
1241 | ||
41bd17a4 | 1242 | NAME: clientside_tos |
1243 | TYPE: acl_tos | |
cccac0a2 | 1244 | DEFAULT: none |
41bd17a4 | 1245 | LOC: Config.accessList.clientside_tos |
cccac0a2 | 1246 | DOC_START |
41bd17a4 | 1247 | Allows you to select a TOS/Diffserv value to mark client-side |
1248 | connections with, based on the username or source address | |
1249 | making the request. | |
1250 | DOC_END | |
cccac0a2 | 1251 | |
7172612f AJ |
1252 | NAME: zph_tos_local |
1253 | TYPE: int | |
1254 | IFDEF: USE_ZPH_QOS | |
1255 | DEFAULT: 0 | |
1256 | LOC: Config.zph_tos_local | |
1257 | DOC_START | |
1258 | Allows you to select a TOS/Diffserv value to mark local hits. Read above | |
1259 | (tcp_outgoing_tos) for details/requirements about TOS. | |
1260 | Default: 0 (disabled). | |
1261 | DOC_END | |
1262 | ||
1263 | NAME: zph_tos_peer | |
1264 | TYPE: int | |
1265 | IFDEF: USE_ZPH_QOS | |
1266 | DEFAULT: 0 | |
1267 | LOC: Config.zph_tos_peer | |
1268 | DOC_START | |
1269 | Allows you to select a TOS/Diffserv value to mark peer hits. Read above | |
1270 | (tcp_outgoing_tos) for details/requirements about TOS. | |
1271 | Default: 0 (disabled). | |
1272 | DOC_END | |
1273 | ||
1274 | NAME: zph_tos_parent | |
1275 | COMMENT: on|off | |
1276 | TYPE: onoff | |
1277 | IFDEF: USE_ZPH_QOS | |
1278 | DEFAULT: on | |
1279 | LOC: Config.onoff.zph_tos_parent | |
1280 | DOC_START | |
1281 | Set this to off if you want only sibling hits to be marked. | |
1282 | If set to on (default), parent hits are being marked too. | |
1283 | DOC_END | |
1284 | ||
1285 | NAME: zph_preserve_miss_tos | |
1286 | COMMENT: on|off | |
1287 | TYPE: onoff | |
1288 | IFDEF: USE_ZPH_QOS | |
1289 | DEFAULT: on | |
1290 | LOC: Config.onoff.zph_preserve_miss_tos | |
1291 | DOC_START | |
1292 | If set to on (default), any HTTP response towards clients will | |
1293 | have the TOS value of the response comming from the remote | |
1294 | server masked with the value of zph_preserve_miss_tos_mask. | |
1295 | For this to work correctly, you will need to patch your linux | |
1296 | kernel with the TOS preserving ZPH patch. | |
1297 | The kernel patch can be downloaded from http://zph.bratcheda.org | |
1298 | DOC_END | |
1299 | ||
1300 | NAME: zph_preserve_miss_tos_mask | |
1301 | TYPE: int | |
1302 | IFDEF: USE_ZPH_QOS | |
1303 | DEFAULT: 255 | |
1304 | LOC: Config.zph_preserve_miss_tos_mask | |
1305 | DOC_START | |
1306 | Allows you to mask certain bits in the TOS received from the | |
1307 | remote server, before copying the value to the TOS send towards | |
1308 | clients. | |
1309 | Default: 255 (TOS from server is not changed). | |
1310 | DOC_END | |
1311 | ||
41bd17a4 | 1312 | NAME: tcp_outgoing_address |
1313 | TYPE: acl_address | |
1314 | DEFAULT: none | |
1315 | LOC: Config.accessList.outgoing_address | |
1316 | DOC_START | |
1317 | Allows you to map requests to different outgoing IP addresses | |
1318 | based on the username or source address of the user making | |
1319 | the request. | |
7f7db318 | 1320 | |
41bd17a4 | 1321 | tcp_outgoing_address ipaddr [[!]aclname] ... |
c33aa074 | 1322 | |
41bd17a4 | 1323 | Example where requests from 10.0.0.0/24 will be forwarded |
1324 | with source address 10.1.0.1, 10.0.2.0/24 forwarded with | |
1325 | source address 10.1.0.2 and the rest will be forwarded with | |
1326 | source address 10.1.0.3. | |
9197cd13 | 1327 | |
17148b2f | 1328 | acl normal_service_net src 10.0.0.0/24 |
1329 | acl good_service_net src 10.0.2.0/24 | |
1330 | tcp_outgoing_address 10.1.0.1 normal_service_net | |
1331 | tcp_outgoing_address 10.1.0.2 good_service_net | |
1332 | tcp_outgoing_address 10.1.0.3 | |
9197cd13 | 1333 | |
41bd17a4 | 1334 | Processing proceeds in the order specified, and stops at first fully |
1335 | matching line. | |
cccac0a2 | 1336 | |
41bd17a4 | 1337 | Note: The use of this directive using client dependent ACLs is |
1338 | incompatible with the use of server side persistent connections. To | |
1339 | ensure correct results it is best to set server_persistent_connections | |
1340 | to off when using this directive in such configurations. | |
cc192b50 | 1341 | |
1342 | ||
1343 | IPv6 Magic: | |
1344 | ||
1345 | Squid is built with a capability of bridging the IPv4 and IPv6 internets. | |
1346 | tcp_outgoing_address as exampled above breaks this bridging by forcing | |
1347 | all outbound traffic through a certain IPv4 which may be on the wrong | |
1348 | side of the IPv4/IPv6 boundary. | |
1349 | ||
1350 | To operate with tcp_outgoing_address and keep the bridging benefits | |
1351 | an additional ACL needs to be used which ensures the IPv6-bound traffic | |
1352 | is never forced or permitted out the IPv4 interface. | |
1353 | ||
1354 | acl to_ipv6 dst ipv6 | |
1355 | tcp_outgoing_address 2002::c001 good_service_net to_ipv6 | |
17148b2f | 1356 | tcp_outgoing_address 10.1.0.2 good_service_net !to_ipv6 |
cc192b50 | 1357 | |
1358 | tcp_outgoing_address 2002::beef normal_service_net to_ipv6 | |
17148b2f | 1359 | tcp_outgoing_address 10.1.0.1 normal_service_net !to_ipv6 |
cc192b50 | 1360 | |
1361 | tcp_outgoing_address 2002::1 to_ipv6 | |
17148b2f | 1362 | tcp_outgoing_address 10.1.0.3 !to_ipv6 |
cccac0a2 | 1363 | DOC_END |
1364 | ||
41bd17a4 | 1365 | COMMENT_START |
1366 | SSL OPTIONS | |
1367 | ----------------------------------------------------------------------------- | |
1368 | COMMENT_END | |
1369 | ||
1370 | NAME: ssl_unclean_shutdown | |
1371 | IFDEF: USE_SSL | |
cccac0a2 | 1372 | TYPE: onoff |
1373 | DEFAULT: off | |
41bd17a4 | 1374 | LOC: Config.SSL.unclean_shutdown |
cccac0a2 | 1375 | DOC_START |
41bd17a4 | 1376 | Some browsers (especially MSIE) bugs out on SSL shutdown |
1377 | messages. | |
cccac0a2 | 1378 | DOC_END |
1379 | ||
41bd17a4 | 1380 | NAME: ssl_engine |
1381 | IFDEF: USE_SSL | |
cccac0a2 | 1382 | TYPE: string |
41bd17a4 | 1383 | LOC: Config.SSL.ssl_engine |
1384 | DEFAULT: none | |
cccac0a2 | 1385 | DOC_START |
41bd17a4 | 1386 | The OpenSSL engine to use. You will need to set this if you |
1387 | would like to use hardware SSL acceleration for example. | |
cccac0a2 | 1388 | DOC_END |
1389 | ||
41bd17a4 | 1390 | NAME: sslproxy_client_certificate |
1391 | IFDEF: USE_SSL | |
cccac0a2 | 1392 | DEFAULT: none |
41bd17a4 | 1393 | LOC: Config.ssl_client.cert |
1394 | TYPE: string | |
cccac0a2 | 1395 | DOC_START |
41bd17a4 | 1396 | Client SSL Certificate to use when proxying https:// URLs |
cccac0a2 | 1397 | DOC_END |
1398 | ||
41bd17a4 | 1399 | NAME: sslproxy_client_key |
1400 | IFDEF: USE_SSL | |
cccac0a2 | 1401 | DEFAULT: none |
41bd17a4 | 1402 | LOC: Config.ssl_client.key |
1403 | TYPE: string | |
cccac0a2 | 1404 | DOC_START |
41bd17a4 | 1405 | Client SSL Key to use when proxying https:// URLs |
cccac0a2 | 1406 | DOC_END |
1407 | ||
41bd17a4 | 1408 | NAME: sslproxy_version |
1409 | IFDEF: USE_SSL | |
1410 | DEFAULT: 1 | |
1411 | LOC: Config.ssl_client.version | |
1412 | TYPE: int | |
cccac0a2 | 1413 | DOC_START |
41bd17a4 | 1414 | SSL version level to use when proxying https:// URLs |
cccac0a2 | 1415 | DOC_END |
1416 | ||
41bd17a4 | 1417 | NAME: sslproxy_options |
1418 | IFDEF: USE_SSL | |
1419 | DEFAULT: none | |
1420 | LOC: Config.ssl_client.options | |
1421 | TYPE: string | |
cccac0a2 | 1422 | DOC_START |
41bd17a4 | 1423 | SSL engine options to use when proxying https:// URLs |
cccac0a2 | 1424 | DOC_END |
1425 | ||
41bd17a4 | 1426 | NAME: sslproxy_cipher |
1427 | IFDEF: USE_SSL | |
1428 | DEFAULT: none | |
1429 | LOC: Config.ssl_client.cipher | |
1430 | TYPE: string | |
cccac0a2 | 1431 | DOC_START |
41bd17a4 | 1432 | SSL cipher list to use when proxying https:// URLs |
cccac0a2 | 1433 | DOC_END |
1434 | ||
41bd17a4 | 1435 | NAME: sslproxy_cafile |
1436 | IFDEF: USE_SSL | |
1437 | DEFAULT: none | |
1438 | LOC: Config.ssl_client.cafile | |
1439 | TYPE: string | |
cccac0a2 | 1440 | DOC_START |
41bd17a4 | 1441 | file containing CA certificates to use when verifying server |
1442 | certificates while proxying https:// URLs | |
cccac0a2 | 1443 | DOC_END |
0976f8db | 1444 | |
41bd17a4 | 1445 | NAME: sslproxy_capath |
1446 | IFDEF: USE_SSL | |
5473c134 | 1447 | DEFAULT: none |
41bd17a4 | 1448 | LOC: Config.ssl_client.capath |
1449 | TYPE: string | |
5473c134 | 1450 | DOC_START |
41bd17a4 | 1451 | directory containing CA certificates to use when verifying |
1452 | server certificates while proxying https:// URLs | |
5473c134 | 1453 | DOC_END |
1454 | ||
4c9da963 | 1455 | NAME: ssl_bump |
1456 | IFDEF: USE_SSL | |
1457 | TYPE: acl_access | |
1458 | LOC: Config.accessList.ssl_bump | |
1459 | DEFAULT: none | |
1460 | DOC_START | |
1461 | This ACL controls which CONNECT requests to an http_port | |
1462 | marked with an sslBump flag are actually "bumped". Please | |
1463 | see the sslBump flag of an http_port option for more details | |
1464 | about decoding proxied SSL connections. | |
1465 | ||
1466 | By default, no requests are bumped. | |
1467 | ||
1468 | See also: http_port sslBump | |
1469 | ||
1470 | NOCOMMENT_START | |
1471 | # Example: Bump all requests except those originating from localhost and | |
1472 | # those going to webax.com or example.com sites. | |
1473 | # | |
1474 | # acl localhost src 127.0.0.1/32 | |
1475 | # acl broken_sites dstdomain .webax.com | |
1476 | # acl broken_sites dstdomain .example.com | |
1477 | # ssl_bump deny localhost | |
1478 | # ssl_bump deny broken_sites | |
1479 | # ssl_bump allow all | |
1480 | NOCOMMENT_END | |
1481 | DOC_END | |
1482 | ||
41bd17a4 | 1483 | NAME: sslproxy_flags |
1484 | IFDEF: USE_SSL | |
1485 | DEFAULT: none | |
1486 | LOC: Config.ssl_client.flags | |
1487 | TYPE: string | |
5473c134 | 1488 | DOC_START |
41bd17a4 | 1489 | Various flags modifying the use of SSL while proxying https:// URLs: |
4c9da963 | 1490 | DONT_VERIFY_PEER Accept certificates that fail verification. |
1491 | For refined control, see sslproxy_cert_error. | |
41bd17a4 | 1492 | NO_DEFAULT_CA Don't use the default CA list built in |
1493 | to OpenSSL. | |
5473c134 | 1494 | DOC_END |
1495 | ||
4c9da963 | 1496 | |
1497 | NAME: sslproxy_cert_error | |
1498 | IFDEF: USE_SSL | |
1499 | DEFAULT: none | |
1500 | LOC: Config.ssl_client.cert_error | |
1501 | TYPE: acl_access | |
1502 | DOC_START | |
1503 | Use this ACL to bypass server certificate validation errors. | |
1504 | ||
1505 | For example, the following lines will bypass all validation errors | |
1506 | when talking to servers located at 172.16.0.0/16. All other | |
1507 | validation errors will result in ERR_SECURE_CONNECT_FAIL error. | |
1508 | ||
1509 | acl BrokenServersAtTrustedIP dst 172.16.0.0/16 | |
1510 | sslproxy_cert_error allow BrokenServersAtTrustedIP | |
1511 | sslproxy_cert_error deny all | |
1512 | ||
1513 | This option must use fast ACL expressions only. Expressions that use | |
1514 | external lookups or communication result in unpredictable behavior or | |
1515 | crashes. | |
1516 | ||
1517 | Without this option, all server certificate validation errors | |
1518 | terminate the transaction. Bypassing validation errors is dangerous | |
1519 | because an error usually implies that the server cannot be trusted and | |
1520 | the connection may be insecure. | |
1521 | ||
1522 | See also: sslproxy_flags and DONT_VERIFY_PEER. | |
1523 | ||
1524 | NOCOMMENT_START | |
1525 | #Default setting: | |
1526 | # sslproxy_cert_error deny all | |
1527 | NOCOMMENT_END | |
1528 | DOC_END | |
1529 | ||
1530 | ||
1531 | ||
41bd17a4 | 1532 | NAME: sslpassword_program |
1533 | IFDEF: USE_SSL | |
1534 | DEFAULT: none | |
1535 | LOC: Config.Program.ssl_password | |
1536 | TYPE: string | |
5473c134 | 1537 | DOC_START |
41bd17a4 | 1538 | Specify a program used for entering SSL key passphrases |
1539 | when using encrypted SSL certificate keys. If not specified | |
1540 | keys must either be unencrypted, or Squid started with the -N | |
1541 | option to allow it to query interactively for the passphrase. | |
5473c134 | 1542 | DOC_END |
1543 | ||
cccac0a2 | 1544 | COMMENT_START |
41bd17a4 | 1545 | OPTIONS WHICH AFFECT THE NEIGHBOR SELECTION ALGORITHM |
cccac0a2 | 1546 | ----------------------------------------------------------------------------- |
1547 | COMMENT_END | |
1548 | ||
41bd17a4 | 1549 | NAME: cache_peer |
1550 | TYPE: peer | |
1551 | DEFAULT: none | |
1552 | LOC: Config.peers | |
cccac0a2 | 1553 | DOC_START |
41bd17a4 | 1554 | To specify other caches in a hierarchy, use the format: |
cccac0a2 | 1555 | |
41bd17a4 | 1556 | cache_peer hostname type http-port icp-port [options] |
cccac0a2 | 1557 | |
41bd17a4 | 1558 | For example, |
cccac0a2 | 1559 | |
41bd17a4 | 1560 | # proxy icp |
1561 | # hostname type port port options | |
1562 | # -------------------- -------- ----- ----- ----------- | |
1563 | cache_peer parent.foo.net parent 3128 3130 proxy-only default | |
1564 | cache_peer sib1.foo.net sibling 3128 3130 proxy-only | |
1565 | cache_peer sib2.foo.net sibling 3128 3130 proxy-only | |
cccac0a2 | 1566 | |
41bd17a4 | 1567 | type: either 'parent', 'sibling', or 'multicast'. |
d5277f40 | 1568 | |
41bd17a4 | 1569 | proxy-port: The port number where the cache listens for proxy |
1570 | requests. | |
8d6275c0 | 1571 | |
41bd17a4 | 1572 | icp-port: Used for querying neighbor caches about |
1573 | objects. To have a non-ICP neighbor | |
df2eec10 | 1574 | specify '0' for the ICP port. |
41bd17a4 | 1575 | NOTE: Also requires icp_port option enabled to send/receive |
1576 | requests via this method. | |
a78278e2 | 1577 | |
41bd17a4 | 1578 | options: proxy-only |
1579 | weight=n | |
1580 | basetime=n | |
1581 | ttl=n | |
1582 | no-query | |
1583 | background-ping | |
1584 | default | |
1585 | round-robin | |
1586 | weighted-round-robin | |
1587 | carp | |
f7e1d9ce HN |
1588 | userhash |
1589 | sourcehash | |
41bd17a4 | 1590 | multicast-responder |
1591 | closest-only | |
1592 | no-digest | |
1593 | no-netdb-exchange | |
1594 | no-delay | |
1595 | login=user:password | PASS | *:password | |
1596 | connect-timeout=nn | |
1597 | digest-url=url | |
1598 | allow-miss | |
1599 | max-conn=n | |
1600 | htcp | |
1601 | htcp-oldsquid | |
4f4fa815 BR |
1602 | htcp-no-clr |
1603 | htcp-no-purge-clr | |
1604 | htcp-only-clr | |
1605 | htcp-forward-clr | |
41bd17a4 | 1606 | originserver |
1607 | name=xxx | |
1608 | forceddomain=name | |
1609 | ssl | |
1610 | sslcert=/path/to/ssl/certificate | |
1611 | sslkey=/path/to/ssl/key | |
1612 | sslversion=1|2|3|4 | |
1613 | sslcipher=... | |
1614 | ssloptions=... | |
1615 | front-end-https[=on|auto] | |
d67acb4e | 1616 | connection-auth[=on|off|auto] |
cccac0a2 | 1617 | |
41bd17a4 | 1618 | use 'proxy-only' to specify objects fetched |
1619 | from this cache should not be saved locally. | |
cccac0a2 | 1620 | |
41bd17a4 | 1621 | use 'weight=n' to affect the selection of a peer |
1622 | during any weighted peer-selection mechanisms. | |
1623 | The weight must be an integer; default is 1, | |
1624 | larger weights are favored more. | |
1625 | This option does not affect parent selection if a peering | |
1626 | protocol is not in use. | |
cccac0a2 | 1627 | |
41bd17a4 | 1628 | use 'basetime=n' to specify a base amount to |
1629 | be subtracted from round trip times of parents. | |
1630 | It is subtracted before division by weight in calculating | |
1631 | which parent to fectch from. If the rtt is less than the | |
1632 | base time the rtt is set to a minimal value. | |
cccac0a2 | 1633 | |
41bd17a4 | 1634 | use 'ttl=n' to specify a IP multicast TTL to use |
1635 | when sending an ICP queries to this address. | |
1636 | Only useful when sending to a multicast group. | |
1637 | Because we don't accept ICP replies from random | |
1638 | hosts, you must configure other group members as | |
1639 | peers with the 'multicast-responder' option below. | |
5473c134 | 1640 | |
41bd17a4 | 1641 | use 'no-query' to NOT send ICP queries to this |
1642 | neighbor. | |
5473c134 | 1643 | |
41bd17a4 | 1644 | use 'background-ping' to only send ICP queries to this |
1645 | neighbor infrequently. This is used to keep the neighbor | |
1646 | round trip time updated and is usually used in | |
1647 | conjunction with weighted-round-robin. | |
cccac0a2 | 1648 | |
41bd17a4 | 1649 | use 'default' if this is a parent cache which can |
1650 | be used as a "last-resort" if a peer cannot be located | |
1651 | by any of the peer-selection mechanisms. | |
1652 | If specified more than once, only the first is used. | |
cccac0a2 | 1653 | |
41bd17a4 | 1654 | use 'round-robin' to define a set of parents which |
1655 | should be used in a round-robin fashion in the | |
1656 | absence of any ICP queries. | |
cccac0a2 | 1657 | |
41bd17a4 | 1658 | use 'weighted-round-robin' to define a set of parents |
1659 | which should be used in a round-robin fashion with the | |
1660 | frequency of each parent being based on the round trip | |
1661 | time. Closer parents are used more often. | |
1662 | Usually used for background-ping parents. | |
cccac0a2 | 1663 | |
41bd17a4 | 1664 | use 'carp' to define a set of parents which should |
1665 | be used as a CARP array. The requests will be | |
1666 | distributed among the parents based on the CARP load | |
382db7eb | 1667 | balancing hash function based on their weight. |
cccac0a2 | 1668 | |
f7e1d9ce HN |
1669 | use 'userhash' to load-balance amongst a set of parents |
1670 | based on the client proxy_auth or ident username. | |
1671 | ||
1672 | use 'sourcehash' to load-balance amongst a set of parents | |
1673 | based on the client source ip. | |
1674 | ||
41bd17a4 | 1675 | 'multicast-responder' indicates the named peer |
1676 | is a member of a multicast group. ICP queries will | |
1677 | not be sent directly to the peer, but ICP replies | |
1678 | will be accepted from it. | |
cccac0a2 | 1679 | |
41bd17a4 | 1680 | 'closest-only' indicates that, for ICP_OP_MISS |
1681 | replies, we'll only forward CLOSEST_PARENT_MISSes | |
1682 | and never FIRST_PARENT_MISSes. | |
cccac0a2 | 1683 | |
41bd17a4 | 1684 | use 'no-digest' to NOT request cache digests from |
1685 | this neighbor. | |
cccac0a2 | 1686 | |
41bd17a4 | 1687 | 'no-netdb-exchange' disables requesting ICMP |
1688 | RTT database (NetDB) from the neighbor. | |
cccac0a2 | 1689 | |
41bd17a4 | 1690 | use 'no-delay' to prevent access to this neighbor |
1691 | from influencing the delay pools. | |
7d90757b | 1692 | |
41bd17a4 | 1693 | use 'login=user:password' if this is a personal/workgroup |
1694 | proxy and your parent requires proxy authentication. | |
1695 | Note: The string can include URL escapes (i.e. %20 for | |
1696 | spaces). This also means % must be written as %%. | |
7d90757b | 1697 | |
41bd17a4 | 1698 | use 'login=PASS' if users must authenticate against |
1699 | the upstream proxy or in the case of a reverse proxy | |
1700 | configuration, the origin web server. This will pass | |
1701 | the users credentials as they are to the peer. | |
1702 | This only works for the Basic HTTP authentication scheme. | |
1703 | Note: To combine this with proxy_auth both proxies must | |
1704 | share the same user database as HTTP only allows for | |
1705 | a single login (one for proxy, one for origin server). | |
1706 | Also be warned this will expose your users proxy | |
1707 | password to the peer. USE WITH CAUTION | |
7d90757b | 1708 | |
41bd17a4 | 1709 | use 'login=*:password' to pass the username to the |
1710 | upstream cache, but with a fixed password. This is meant | |
1711 | to be used when the peer is in another administrative | |
1712 | domain, but it is still needed to identify each user. | |
1713 | The star can optionally be followed by some extra | |
1714 | information which is added to the username. This can | |
1715 | be used to identify this proxy to the peer, similar to | |
1716 | the login=username:password option above. | |
cccac0a2 | 1717 | |
41bd17a4 | 1718 | use 'connect-timeout=nn' to specify a peer |
1719 | specific connect timeout (also see the | |
1720 | peer_connect_timeout directive) | |
7f7db318 | 1721 | |
41bd17a4 | 1722 | use 'digest-url=url' to tell Squid to fetch the cache |
1723 | digest (if digests are enabled) for this host from | |
1724 | the specified URL rather than the Squid default | |
1725 | location. | |
cccac0a2 | 1726 | |
41bd17a4 | 1727 | use 'allow-miss' to disable Squid's use of only-if-cached |
1728 | when forwarding requests to siblings. This is primarily | |
1729 | useful when icp_hit_stale is used by the sibling. To | |
1730 | extensive use of this option may result in forwarding | |
1731 | loops, and you should avoid having two-way peerings | |
1732 | with this option. (for example to deny peer usage on | |
1733 | requests from peer by denying cache_peer_access if the | |
1734 | source is a peer) | |
cccac0a2 | 1735 | |
41bd17a4 | 1736 | use 'max-conn=n' to limit the amount of connections Squid |
1737 | may open to this peer. | |
cccac0a2 | 1738 | |
41bd17a4 | 1739 | use 'htcp' to send HTCP, instead of ICP, queries |
1740 | to the neighbor. You probably also want to | |
1741 | set the "icp port" to 4827 instead of 3130. | |
0b48417e | 1742 | You MUST also set htcp_access expicitly. The default of |
1743 | deny all will prevent peer traffic. | |
cccac0a2 | 1744 | |
41bd17a4 | 1745 | use 'htcp-oldsquid' to send HTCP to old Squid versions |
0b48417e | 1746 | You MUST also set htcp_access expicitly. The default of |
1747 | deny all will prevent peer traffic. | |
cccac0a2 | 1748 | |
4f4fa815 BR |
1749 | use 'htcp-no-clr' to send HTCP to the neighbor but without |
1750 | sending any CLR requests. This cannot be used with | |
1751 | htcp-only-clr. | |
1752 | ||
1753 | use 'htcp-no-purge-clr' to send HTCP to the neighbor | |
1754 | including CLRs but only when they do not result from | |
1755 | PURGE requests. | |
1756 | ||
1757 | use 'htcp-only-clr' to send HTCP to the neighbor but ONLY | |
1758 | CLR requests. This cannot be used with htcp-no-clr. | |
1759 | ||
1760 | use 'htcp-forward-clr' to forward any HTCP CLR requests | |
1761 | this proxy receives to the peer. | |
1762 | ||
41bd17a4 | 1763 | 'originserver' causes this parent peer to be contacted as |
1764 | a origin server. Meant to be used in accelerator setups. | |
cccac0a2 | 1765 | |
41bd17a4 | 1766 | use 'name=xxx' if you have multiple peers on the same |
1767 | host but different ports. This name can be used to | |
1768 | differentiate the peers in cache_peer_access and similar | |
1769 | directives. | |
cccac0a2 | 1770 | |
41bd17a4 | 1771 | use 'forceddomain=name' to forcibly set the Host header |
1772 | of requests forwarded to this peer. Useful in accelerator | |
1773 | setups where the server (peer) expects a certain domain | |
1774 | name and using redirectors to feed this domain name | |
1775 | is not feasible. | |
64658378 | 1776 | |
41bd17a4 | 1777 | use 'ssl' to indicate connections to this peer should |
1778 | be SSL/TLS encrypted. | |
cccac0a2 | 1779 | |
41bd17a4 | 1780 | use 'sslcert=/path/to/ssl/certificate' to specify a client |
1781 | SSL certificate to use when connecting to this peer. | |
4c9fa5d5 | 1782 | |
41bd17a4 | 1783 | use 'sslkey=/path/to/ssl/key' to specify the private SSL |
1784 | key corresponding to sslcert above. If 'sslkey' is not | |
1785 | specified 'sslcert' is assumed to reference a | |
1786 | combined file containing both the certificate and the key. | |
4c9fa5d5 | 1787 | |
41bd17a4 | 1788 | use sslversion=1|2|3|4 to specify the SSL version to use |
1789 | when connecting to this peer | |
1790 | 1 = automatic (default) | |
1791 | 2 = SSL v2 only | |
1792 | 3 = SSL v3 only | |
1793 | 4 = TLS v1 only | |
cccac0a2 | 1794 | |
41bd17a4 | 1795 | use sslcipher=... to specify the list of valid SSL ciphers |
1796 | to use when connecting to this peer. | |
cccac0a2 | 1797 | |
41bd17a4 | 1798 | use ssloptions=... to specify various SSL engine options: |
1799 | NO_SSLv2 Disallow the use of SSLv2 | |
1800 | NO_SSLv3 Disallow the use of SSLv3 | |
1801 | NO_TLSv1 Disallow the use of TLSv1 | |
1802 | See src/ssl_support.c or the OpenSSL documentation for | |
1803 | a more complete list. | |
cccac0a2 | 1804 | |
41bd17a4 | 1805 | use sslcafile=... to specify a file containing |
1806 | additional CA certificates to use when verifying the | |
1807 | peer certificate. | |
cccac0a2 | 1808 | |
41bd17a4 | 1809 | use sslcapath=... to specify a directory containing |
1810 | additional CA certificates to use when verifying the | |
1811 | peer certificate. | |
cccac0a2 | 1812 | |
41bd17a4 | 1813 | use sslcrlfile=... to specify a certificate revocation |
1814 | list file to use when verifying the peer certificate. | |
1815 | ||
1816 | use sslflags=... to specify various flags modifying the | |
1817 | SSL implementation: | |
1818 | DONT_VERIFY_PEER | |
1819 | Accept certificates even if they fail to | |
1820 | verify. | |
1821 | NO_DEFAULT_CA | |
1822 | Don't use the default CA list built in | |
1823 | to OpenSSL. | |
1824 | DONT_VERIFY_DOMAIN | |
1825 | Don't verify the peer certificate | |
1826 | matches the server name | |
cccac0a2 | 1827 | |
41bd17a4 | 1828 | use ssldomain= to specify the peer name as advertised |
1829 | in it's certificate. Used for verifying the correctness | |
1830 | of the received peer certificate. If not specified the | |
1831 | peer hostname will be used. | |
cccac0a2 | 1832 | |
41bd17a4 | 1833 | use front-end-https to enable the "Front-End-Https: On" |
1834 | header needed when using Squid as a SSL frontend in front | |
1835 | of Microsoft OWA. See MS KB document Q307347 for details | |
1836 | on this header. If set to auto the header will | |
1837 | only be added if the request is forwarded as a https:// | |
1838 | URL. | |
d67acb4e AJ |
1839 | |
1840 | use connection-auth=off to tell Squid that this peer does | |
1841 | not support Microsoft connection oriented authentication, | |
1842 | and any such challenges received from there should be | |
1843 | ignored. Default is auto to automatically determine the | |
1844 | status of the peer. | |
41bd17a4 | 1845 | DOC_END |
cccac0a2 | 1846 | |
41bd17a4 | 1847 | NAME: cache_peer_domain cache_host_domain |
1848 | TYPE: hostdomain | |
1849 | DEFAULT: none | |
1850 | LOC: none | |
1851 | DOC_START | |
1852 | Use to limit the domains for which a neighbor cache will be | |
1853 | queried. Usage: | |
cccac0a2 | 1854 | |
41bd17a4 | 1855 | cache_peer_domain cache-host domain [domain ...] |
1856 | cache_peer_domain cache-host !domain | |
cccac0a2 | 1857 | |
41bd17a4 | 1858 | For example, specifying |
cccac0a2 | 1859 | |
41bd17a4 | 1860 | cache_peer_domain parent.foo.net .edu |
cccac0a2 | 1861 | |
41bd17a4 | 1862 | has the effect such that UDP query packets are sent to |
1863 | 'bigserver' only when the requested object exists on a | |
1864 | server in the .edu domain. Prefixing the domainname | |
1865 | with '!' means the cache will be queried for objects | |
1866 | NOT in that domain. | |
cccac0a2 | 1867 | |
41bd17a4 | 1868 | NOTE: * Any number of domains may be given for a cache-host, |
1869 | either on the same or separate lines. | |
1870 | * When multiple domains are given for a particular | |
1871 | cache-host, the first matched domain is applied. | |
1872 | * Cache hosts with no domain restrictions are queried | |
1873 | for all requests. | |
1874 | * There are no defaults. | |
1875 | * There is also a 'cache_peer_access' tag in the ACL | |
1876 | section. | |
1877 | DOC_END | |
dd9b1776 | 1878 | |
41bd17a4 | 1879 | NAME: cache_peer_access |
1880 | TYPE: peer_access | |
1881 | DEFAULT: none | |
1882 | LOC: none | |
1883 | DOC_START | |
1884 | Similar to 'cache_peer_domain' but provides more flexibility by | |
1885 | using ACL elements. | |
cccac0a2 | 1886 | |
41bd17a4 | 1887 | cache_peer_access cache-host allow|deny [!]aclname ... |
dd9b1776 | 1888 | |
41bd17a4 | 1889 | The syntax is identical to 'http_access' and the other lists of |
1890 | ACL elements. See the comments for 'http_access' below, or | |
1891 | the Squid FAQ (http://www.squid-cache.org/FAQ/FAQ-10.html). | |
1892 | DOC_END | |
dd9b1776 | 1893 | |
41bd17a4 | 1894 | NAME: neighbor_type_domain |
1895 | TYPE: hostdomaintype | |
1896 | DEFAULT: none | |
1897 | LOC: none | |
1898 | DOC_START | |
1899 | usage: neighbor_type_domain neighbor parent|sibling domain domain ... | |
cccac0a2 | 1900 | |
41bd17a4 | 1901 | Modifying the neighbor type for specific domains is now |
1902 | possible. You can treat some domains differently than the the | |
1903 | default neighbor type specified on the 'cache_peer' line. | |
1904 | Normally it should only be necessary to list domains which | |
1905 | should be treated differently because the default neighbor type | |
1906 | applies for hostnames which do not match domains listed here. | |
6bf4f823 | 1907 | |
41bd17a4 | 1908 | EXAMPLE: |
dbe3992d | 1909 | cache_peer cache.foo.org parent 3128 3130 |
41bd17a4 | 1910 | neighbor_type_domain cache.foo.org sibling .com .net |
1911 | neighbor_type_domain cache.foo.org sibling .au .de | |
1912 | DOC_END | |
6bf4f823 | 1913 | |
41bd17a4 | 1914 | NAME: dead_peer_timeout |
1915 | COMMENT: (seconds) | |
1916 | DEFAULT: 10 seconds | |
1917 | TYPE: time_t | |
1918 | LOC: Config.Timeout.deadPeer | |
1919 | DOC_START | |
1920 | This controls how long Squid waits to declare a peer cache | |
1921 | as "dead." If there are no ICP replies received in this | |
1922 | amount of time, Squid will declare the peer dead and not | |
1923 | expect to receive any further ICP replies. However, it | |
1924 | continues to send ICP queries, and will mark the peer as | |
1925 | alive upon receipt of the first subsequent ICP reply. | |
699acd19 | 1926 | |
41bd17a4 | 1927 | This timeout also affects when Squid expects to receive ICP |
1928 | replies from peers. If more than 'dead_peer' seconds have | |
1929 | passed since the last ICP reply was received, Squid will not | |
1930 | expect to receive an ICP reply on the next query. Thus, if | |
1931 | your time between requests is greater than this timeout, you | |
1932 | will see a lot of requests sent DIRECT to origin servers | |
1933 | instead of to your parents. | |
1934 | DOC_END | |
cccac0a2 | 1935 | |
41bd17a4 | 1936 | NAME: hierarchy_stoplist |
1937 | TYPE: wordlist | |
1938 | DEFAULT: none | |
1939 | LOC: Config.hierarchy_stoplist | |
1940 | DOC_START | |
1941 | A list of words which, if found in a URL, cause the object to | |
1942 | be handled directly by this cache. In other words, use this | |
1943 | to not query neighbor caches for certain objects. You may | |
1944 | list this option multiple times. | |
1945 | Note: never_direct overrides this option. | |
cccac0a2 | 1946 | NOCOMMENT_START |
41bd17a4 | 1947 | #We recommend you to use at least the following line. |
1948 | hierarchy_stoplist cgi-bin ? | |
6b698a21 | 1949 | NOCOMMENT_END |
1950 | DOC_END | |
0976f8db | 1951 | |
41bd17a4 | 1952 | COMMENT_START |
1953 | MEMORY CACHE OPTIONS | |
1954 | ----------------------------------------------------------------------------- | |
1955 | COMMENT_END | |
1956 | ||
1957 | NAME: cache_mem | |
1958 | COMMENT: (bytes) | |
1959 | TYPE: b_size_t | |
df2eec10 | 1960 | DEFAULT: 256 MB |
41bd17a4 | 1961 | LOC: Config.memMaxSize |
6b698a21 | 1962 | DOC_START |
41bd17a4 | 1963 | NOTE: THIS PARAMETER DOES NOT SPECIFY THE MAXIMUM PROCESS SIZE. |
1964 | IT ONLY PLACES A LIMIT ON HOW MUCH ADDITIONAL MEMORY SQUID WILL | |
1965 | USE AS A MEMORY CACHE OF OBJECTS. SQUID USES MEMORY FOR OTHER | |
1966 | THINGS AS WELL. SEE THE SQUID FAQ SECTION 8 FOR DETAILS. | |
1967 | ||
1968 | 'cache_mem' specifies the ideal amount of memory to be used | |
1969 | for: | |
1970 | * In-Transit objects | |
1971 | * Hot Objects | |
1972 | * Negative-Cached objects | |
1973 | ||
1974 | Data for these objects are stored in 4 KB blocks. This | |
1975 | parameter specifies the ideal upper limit on the total size of | |
1976 | 4 KB blocks allocated. In-Transit objects take the highest | |
1977 | priority. | |
1978 | ||
1979 | In-transit objects have priority over the others. When | |
1980 | additional space is needed for incoming data, negative-cached | |
1981 | and hot objects will be released. In other words, the | |
1982 | negative-cached and hot objects will fill up any unused space | |
1983 | not needed for in-transit objects. | |
1984 | ||
1985 | If circumstances require, this limit will be exceeded. | |
1986 | Specifically, if your incoming request rate requires more than | |
1987 | 'cache_mem' of memory to hold in-transit objects, Squid will | |
1988 | exceed this limit to satisfy the new requests. When the load | |
1989 | decreases, blocks will be freed until the high-water mark is | |
1990 | reached. Thereafter, blocks will be used to store hot | |
1991 | objects. | |
6b698a21 | 1992 | DOC_END |
0976f8db | 1993 | |
41bd17a4 | 1994 | NAME: maximum_object_size_in_memory |
1995 | COMMENT: (bytes) | |
1996 | TYPE: b_size_t | |
df2eec10 | 1997 | DEFAULT: 512 KB |
41bd17a4 | 1998 | LOC: Config.Store.maxInMemObjSize |
6b698a21 | 1999 | DOC_START |
41bd17a4 | 2000 | Objects greater than this size will not be attempted to kept in |
2001 | the memory cache. This should be set high enough to keep objects | |
2002 | accessed frequently in memory to improve performance whilst low | |
2003 | enough to keep larger objects from hoarding cache_mem. | |
6b698a21 | 2004 | DOC_END |
0976f8db | 2005 | |
41bd17a4 | 2006 | NAME: memory_replacement_policy |
2007 | TYPE: removalpolicy | |
2008 | LOC: Config.memPolicy | |
2009 | DEFAULT: lru | |
6b698a21 | 2010 | DOC_START |
41bd17a4 | 2011 | The memory replacement policy parameter determines which |
2012 | objects are purged from memory when memory space is needed. | |
7f7db318 | 2013 | |
41bd17a4 | 2014 | See cache_replacement_policy for details. |
2015 | DOC_END | |
6b698a21 | 2016 | |
41bd17a4 | 2017 | COMMENT_START |
2018 | DISK CACHE OPTIONS | |
2019 | ----------------------------------------------------------------------------- | |
2020 | COMMENT_END | |
6b698a21 | 2021 | |
41bd17a4 | 2022 | NAME: cache_replacement_policy |
2023 | TYPE: removalpolicy | |
2024 | LOC: Config.replPolicy | |
2025 | DEFAULT: lru | |
2026 | DOC_START | |
2027 | The cache replacement policy parameter determines which | |
2028 | objects are evicted (replaced) when disk space is needed. | |
6b698a21 | 2029 | |
41bd17a4 | 2030 | lru : Squid's original list based LRU policy |
2031 | heap GDSF : Greedy-Dual Size Frequency | |
2032 | heap LFUDA: Least Frequently Used with Dynamic Aging | |
2033 | heap LRU : LRU policy implemented using a heap | |
6b698a21 | 2034 | |
41bd17a4 | 2035 | Applies to any cache_dir lines listed below this. |
7f7db318 | 2036 | |
41bd17a4 | 2037 | The LRU policies keeps recently referenced objects. |
0976f8db | 2038 | |
41bd17a4 | 2039 | The heap GDSF policy optimizes object hit rate by keeping smaller |
2040 | popular objects in cache so it has a better chance of getting a | |
2041 | hit. It achieves a lower byte hit rate than LFUDA though since | |
2042 | it evicts larger (possibly popular) objects. | |
0976f8db | 2043 | |
41bd17a4 | 2044 | The heap LFUDA policy keeps popular objects in cache regardless of |
2045 | their size and thus optimizes byte hit rate at the expense of | |
2046 | hit rate since one large, popular object will prevent many | |
2047 | smaller, slightly less popular objects from being cached. | |
0976f8db | 2048 | |
41bd17a4 | 2049 | Both policies utilize a dynamic aging mechanism that prevents |
2050 | cache pollution that can otherwise occur with frequency-based | |
2051 | replacement policies. | |
7d90757b | 2052 | |
41bd17a4 | 2053 | NOTE: if using the LFUDA replacement policy you should increase |
2054 | the value of maximum_object_size above its default of 4096 KB to | |
2055 | to maximize the potential byte hit rate improvement of LFUDA. | |
dc1af3cf | 2056 | |
41bd17a4 | 2057 | For more information about the GDSF and LFUDA cache replacement |
2058 | policies see http://www.hpl.hp.com/techreports/1999/HPL-1999-69.html | |
2059 | and http://fog.hpl.external.hp.com/techreports/98/HPL-98-173.html. | |
6b698a21 | 2060 | DOC_END |
0976f8db | 2061 | |
41bd17a4 | 2062 | NAME: cache_dir |
2063 | TYPE: cachedir | |
2064 | DEFAULT: none | |
41bd17a4 | 2065 | LOC: Config.cacheSwap |
6b698a21 | 2066 | DOC_START |
41bd17a4 | 2067 | Usage: |
0976f8db | 2068 | |
41bd17a4 | 2069 | cache_dir Type Directory-Name Fs-specific-data [options] |
0976f8db | 2070 | |
41bd17a4 | 2071 | You can specify multiple cache_dir lines to spread the |
2072 | cache among different disk partitions. | |
0976f8db | 2073 | |
41bd17a4 | 2074 | Type specifies the kind of storage system to use. Only "ufs" |
2075 | is built by default. To enable any of the other storage systems | |
2076 | see the --enable-storeio configure option. | |
0976f8db | 2077 | |
41bd17a4 | 2078 | 'Directory' is a top-level directory where cache swap |
2079 | files will be stored. If you want to use an entire disk | |
2080 | for caching, this can be the mount-point directory. | |
2081 | The directory must exist and be writable by the Squid | |
2082 | process. Squid will NOT create this directory for you. | |
0976f8db | 2083 | |
41bd17a4 | 2084 | The ufs store type: |
0976f8db | 2085 | |
41bd17a4 | 2086 | "ufs" is the old well-known Squid storage format that has always |
2087 | been there. | |
0976f8db | 2088 | |
41bd17a4 | 2089 | cache_dir ufs Directory-Name Mbytes L1 L2 [options] |
0976f8db | 2090 | |
41bd17a4 | 2091 | 'Mbytes' is the amount of disk space (MB) to use under this |
2092 | directory. The default is 100 MB. Change this to suit your | |
2093 | configuration. Do NOT put the size of your disk drive here. | |
2094 | Instead, if you want Squid to use the entire disk drive, | |
2095 | subtract 20% and use that value. | |
0976f8db | 2096 | |
41bd17a4 | 2097 | 'Level-1' is the number of first-level subdirectories which |
2098 | will be created under the 'Directory'. The default is 16. | |
0976f8db | 2099 | |
41bd17a4 | 2100 | 'Level-2' is the number of second-level subdirectories which |
2101 | will be created under each first-level directory. The default | |
2102 | is 256. | |
0976f8db | 2103 | |
41bd17a4 | 2104 | The aufs store type: |
7f7db318 | 2105 | |
41bd17a4 | 2106 | "aufs" uses the same storage format as "ufs", utilizing |
2107 | POSIX-threads to avoid blocking the main Squid process on | |
2108 | disk-I/O. This was formerly known in Squid as async-io. | |
38f9c547 | 2109 | |
41bd17a4 | 2110 | cache_dir aufs Directory-Name Mbytes L1 L2 [options] |
38f9c547 | 2111 | |
41bd17a4 | 2112 | see argument descriptions under ufs above |
38f9c547 | 2113 | |
41bd17a4 | 2114 | The diskd store type: |
38f9c547 | 2115 | |
41bd17a4 | 2116 | "diskd" uses the same storage format as "ufs", utilizing a |
2117 | separate process to avoid blocking the main Squid process on | |
2118 | disk-I/O. | |
4c3ef9b2 | 2119 | |
41bd17a4 | 2120 | cache_dir diskd Directory-Name Mbytes L1 L2 [options] [Q1=n] [Q2=n] |
0976f8db | 2121 | |
41bd17a4 | 2122 | see argument descriptions under ufs above |
0976f8db | 2123 | |
41bd17a4 | 2124 | Q1 specifies the number of unacknowledged I/O requests when Squid |
2125 | stops opening new files. If this many messages are in the queues, | |
2126 | Squid won't open new files. Default is 64 | |
0976f8db | 2127 | |
41bd17a4 | 2128 | Q2 specifies the number of unacknowledged messages when Squid |
2129 | starts blocking. If this many messages are in the queues, | |
2130 | Squid blocks until it receives some replies. Default is 72 | |
0976f8db | 2131 | |
41bd17a4 | 2132 | When Q1 < Q2 (the default), the cache directory is optimized |
2133 | for lower response time at the expense of a decrease in hit | |
2134 | ratio. If Q1 > Q2, the cache directory is optimized for | |
2135 | higher hit ratio at the expense of an increase in response | |
2136 | time. | |
0976f8db | 2137 | |
41bd17a4 | 2138 | The coss store type: |
0976f8db | 2139 | |
41bd17a4 | 2140 | block-size=n defines the "block size" for COSS cache_dir's. |
2141 | Squid uses file numbers as block numbers. Since file numbers | |
2142 | are limited to 24 bits, the block size determines the maximum | |
2143 | size of the COSS partition. The default is 512 bytes, which | |
2144 | leads to a maximum cache_dir size of 512<<24, or 8 GB. Note | |
2145 | you should not change the coss block size after Squid | |
2146 | has written some objects to the cache_dir. | |
0976f8db | 2147 | |
41bd17a4 | 2148 | The coss file store has changed from 2.5. Now it uses a file |
2149 | called 'stripe' in the directory names in the config - and | |
2150 | this will be created by squid -z. | |
0976f8db | 2151 | |
41bd17a4 | 2152 | Common options: |
0976f8db | 2153 | |
41bd17a4 | 2154 | no-store, no new objects should be stored to this cache_dir |
0976f8db | 2155 | |
41bd17a4 | 2156 | max-size=n, refers to the max object size this storedir supports. |
2157 | It is used to initially choose the storedir to dump the object. | |
2158 | Note: To make optimal use of the max-size limits you should order | |
2159 | the cache_dir lines with the smallest max-size value first and the | |
2160 | ones with no max-size specification last. | |
0976f8db | 2161 | |
41bd17a4 | 2162 | Note for coss, max-size must be less than COSS_MEMBUF_SZ, |
2163 | which can be changed with the --with-coss-membuf-size=N configure | |
2164 | option. | |
bebc043b | 2165 | NOCOMMENT_START |
df2eec10 | 2166 | # cache_dir ufs @DEFAULT_SWAP_DIR@ 100 16 256 |
bebc043b | 2167 | NOCOMMENT_END |
6b698a21 | 2168 | DOC_END |
0976f8db | 2169 | |
41bd17a4 | 2170 | NAME: store_dir_select_algorithm |
2171 | TYPE: string | |
2172 | LOC: Config.store_dir_select_algorithm | |
2173 | DEFAULT: least-load | |
6b698a21 | 2174 | DOC_START |
41bd17a4 | 2175 | Set this to 'round-robin' as an alternative. |
6b698a21 | 2176 | DOC_END |
0976f8db | 2177 | |
41bd17a4 | 2178 | NAME: max_open_disk_fds |
2179 | TYPE: int | |
2180 | LOC: Config.max_open_disk_fds | |
2181 | DEFAULT: 0 | |
6b698a21 | 2182 | DOC_START |
41bd17a4 | 2183 | To avoid having disk as the I/O bottleneck Squid can optionally |
2184 | bypass the on-disk cache if more than this amount of disk file | |
2185 | descriptors are open. | |
2186 | ||
2187 | A value of 0 indicates no limit. | |
6b698a21 | 2188 | DOC_END |
0976f8db | 2189 | |
41bd17a4 | 2190 | NAME: minimum_object_size |
6b698a21 | 2191 | COMMENT: (bytes) |
47f6e231 | 2192 | TYPE: b_int64_t |
6b698a21 | 2193 | DEFAULT: 0 KB |
41bd17a4 | 2194 | LOC: Config.Store.minObjectSize |
6b698a21 | 2195 | DOC_START |
41bd17a4 | 2196 | Objects smaller than this size will NOT be saved on disk. The |
2197 | value is specified in kilobytes, and the default is 0 KB, which | |
2198 | means there is no minimum. | |
6b698a21 | 2199 | DOC_END |
0976f8db | 2200 | |
41bd17a4 | 2201 | NAME: maximum_object_size |
2202 | COMMENT: (bytes) | |
2203 | TYPE: b_int64_t | |
2204 | DEFAULT: 4096 KB | |
2205 | LOC: Config.Store.maxObjectSize | |
777831e0 | 2206 | DOC_START |
41bd17a4 | 2207 | Objects larger than this size will NOT be saved on disk. The |
2208 | value is specified in kilobytes, and the default is 4MB. If | |
2209 | you wish to get a high BYTES hit ratio, you should probably | |
2210 | increase this (one 32 MB object hit counts for 3200 10KB | |
2211 | hits). If you wish to increase speed more than your want to | |
2212 | save bandwidth you should leave this low. | |
777831e0 | 2213 | |
41bd17a4 | 2214 | NOTE: if using the LFUDA replacement policy you should increase |
2215 | this value to maximize the byte hit rate improvement of LFUDA! | |
2216 | See replacement_policy below for a discussion of this policy. | |
6b698a21 | 2217 | DOC_END |
0976f8db | 2218 | |
41bd17a4 | 2219 | NAME: cache_swap_low |
2220 | COMMENT: (percent, 0-100) | |
5473c134 | 2221 | TYPE: int |
41bd17a4 | 2222 | DEFAULT: 90 |
2223 | LOC: Config.Swap.lowWaterMark | |
2224 | DOC_NONE | |
2225 | ||
2226 | NAME: cache_swap_high | |
2227 | COMMENT: (percent, 0-100) | |
2228 | TYPE: int | |
2229 | DEFAULT: 95 | |
2230 | LOC: Config.Swap.highWaterMark | |
6b698a21 | 2231 | DOC_START |
41bd17a4 | 2232 | |
2233 | The low- and high-water marks for cache object replacement. | |
2234 | Replacement begins when the swap (disk) usage is above the | |
2235 | low-water mark and attempts to maintain utilization near the | |
2236 | low-water mark. As swap utilization gets close to high-water | |
2237 | mark object eviction becomes more aggressive. If utilization is | |
2238 | close to the low-water mark less replacement is done each time. | |
2239 | ||
2240 | Defaults are 90% and 95%. If you have a large cache, 5% could be | |
2241 | hundreds of MB. If this is the case you may wish to set these | |
2242 | numbers closer together. | |
6b698a21 | 2243 | DOC_END |
0976f8db | 2244 | |
5473c134 | 2245 | COMMENT_START |
41bd17a4 | 2246 | LOGFILE OPTIONS |
5473c134 | 2247 | ----------------------------------------------------------------------------- |
2248 | COMMENT_END | |
0976f8db | 2249 | |
41bd17a4 | 2250 | NAME: logformat |
2251 | TYPE: logformat | |
2252 | LOC: Config.Log.logformats | |
5473c134 | 2253 | DEFAULT: none |
6b698a21 | 2254 | DOC_START |
41bd17a4 | 2255 | Usage: |
0976f8db | 2256 | |
41bd17a4 | 2257 | logformat <name> <format specification> |
0976f8db | 2258 | |
41bd17a4 | 2259 | Defines an access log format. |
6b698a21 | 2260 | |
41bd17a4 | 2261 | The <format specification> is a string with embedded % format codes |
5473c134 | 2262 | |
41bd17a4 | 2263 | % format codes all follow the same basic structure where all but |
2264 | the formatcode is optional. Output strings are automatically escaped | |
2265 | as required according to their context and the output format | |
2266 | modifiers are usually not needed, but can be specified if an explicit | |
2267 | output format is desired. | |
6b698a21 | 2268 | |
41bd17a4 | 2269 | % ["|[|'|#] [-] [[0]width] [{argument}] formatcode |
0976f8db | 2270 | |
41bd17a4 | 2271 | " output in quoted string format |
2272 | [ output in squid text log format as used by log_mime_hdrs | |
2273 | # output in URL quoted format | |
2274 | ' output as-is | |
5473c134 | 2275 | |
41bd17a4 | 2276 | - left aligned |
2277 | width field width. If starting with 0 the | |
2278 | output is zero padded | |
2279 | {arg} argument such as header name etc | |
5473c134 | 2280 | |
41bd17a4 | 2281 | Format codes: |
5473c134 | 2282 | |
41bd17a4 | 2283 | >a Client source IP address |
2284 | >A Client FQDN | |
2285 | >p Client source port | |
2286 | <A Server IP address or peer name | |
2287 | la Local IP address (http_port) | |
2288 | lp Local port number (http_port) | |
2289 | ts Seconds since epoch | |
2290 | tu subsecond time (milliseconds) | |
2291 | tl Local time. Optional strftime format argument | |
2292 | default %d/%b/%Y:%H:%M:%S %z | |
2293 | tg GMT time. Optional strftime format argument | |
2294 | default %d/%b/%Y:%H:%M:%S %z | |
2295 | tr Response time (milliseconds) | |
2296 | >h Request header. Optional header name argument | |
2297 | on the format header[:[separator]element] | |
2298 | <h Reply header. Optional header name argument | |
2299 | as for >h | |
2300 | un User name | |
2301 | ul User name from authentication | |
2302 | ui User name from ident | |
2303 | us User name from SSL | |
2304 | ue User name from external acl helper | |
2305 | Hs HTTP status code | |
2306 | Ss Squid request status (TCP_MISS etc) | |
2307 | Sh Squid hierarchy status (DEFAULT_PARENT etc) | |
2308 | mt MIME content type | |
2309 | rm Request method (GET/POST etc) | |
2310 | ru Request URL | |
2311 | rp Request URL-Path excluding hostname | |
2312 | rv Request protocol version | |
2313 | et Tag returned by external acl | |
2314 | ea Log string returned by external acl | |
2315 | <st Reply size including HTTP headers | |
1a86db31 AJ |
2316 | >st Request size including HTTP headers |
2317 | st Request+Reply size including HTTP headers | |
41bd17a4 | 2318 | <sH Reply high offset sent |
2319 | <sS Upstream object size | |
2320 | % a literal % character | |
5473c134 | 2321 | |
7d9acc3c AJ |
2322 | The default formats available (which do not need re-defining) are: |
2323 | ||
2324 | logformat squid %ts.%03tu %6tr %>a %Ss/%03Hs %<st %rm %ru %un %Sh/%<A %mt | |
2325 | logformat squidmime %ts.%03tu %6tr %>a %Ss/%03Hs %<st %rm %ru %un %Sh/%<A %mt [%>h] [%<h] | |
41bd17a4 | 2326 | logformat common %>a %ui %un [%tl] "%rm %ru HTTP/%rv" %Hs %<st %Ss:%Sh |
2327 | logformat combined %>a %ui %un [%tl] "%rm %ru HTTP/%rv" %Hs %<st "%{Referer}>h" "%{User-Agent}>h" %Ss:%Sh | |
5473c134 | 2328 | DOC_END |
2329 | ||
41bd17a4 | 2330 | NAME: access_log cache_access_log |
2331 | TYPE: access_log | |
2332 | LOC: Config.Log.accesslogs | |
02424612 | 2333 | DEFAULT: none |
01ddaf65 | 2334 | DEFAULT_IF_NONE: @DEFAULT_ACCESS_LOG@ squid |
5473c134 | 2335 | DOC_START |
41bd17a4 | 2336 | These files log client request activities. Has a line every HTTP or |
2337 | ICP request. The format is: | |
2338 | access_log <filepath> [<logformat name> [acl acl ...]] | |
2339 | access_log none [acl acl ...]] | |
5473c134 | 2340 | |
41bd17a4 | 2341 | Will log to the specified file using the specified format (which |
2342 | must be defined in a logformat directive) those entries which match | |
2343 | ALL the acl's specified (which must be defined in acl clauses). | |
2344 | If no acl is specified, all requests will be logged to this file. | |
5473c134 | 2345 | |
41bd17a4 | 2346 | To disable logging of a request use the filepath "none", in which case |
2347 | a logformat name should not be specified. | |
5473c134 | 2348 | |
41bd17a4 | 2349 | To log the request via syslog specify a filepath of "syslog": |
5473c134 | 2350 | |
41bd17a4 | 2351 | access_log syslog[:facility.priority] [format [acl1 [acl2 ....]]] |
2352 | where facility could be any of: | |
2353 | authpriv, daemon, local0 .. local7 or user. | |
5473c134 | 2354 | |
41bd17a4 | 2355 | And priority could be any of: |
2356 | err, warning, notice, info, debug. | |
df2eec10 AJ |
2357 | |
2358 | Default: | |
2359 | access_log @DEFAULT_ACCESS_LOG@ squid | |
41bd17a4 | 2360 | DOC_END |
5473c134 | 2361 | |
5b0f5383 | 2362 | NAME: log_access |
2363 | TYPE: acl_access | |
2364 | LOC: Config.accessList.log | |
2365 | DEFAULT: none | |
2366 | COMMENT: allow|deny acl acl... | |
2367 | DOC_START | |
2368 | This options allows you to control which requests gets logged | |
2369 | to access.log (see access_log directive). Requests denied for | |
2370 | logging will also not be accounted for in performance counters. | |
2371 | DOC_END | |
2372 | ||
41bd17a4 | 2373 | NAME: cache_log |
2374 | TYPE: string | |
02424612 | 2375 | DEFAULT: none |
01ddaf65 | 2376 | DEFAULT_IF_NONE: @DEFAULT_CACHE_LOG@ |
41bd17a4 | 2377 | LOC: Config.Log.log |
2378 | DOC_START | |
2379 | Cache logging file. This is where general information about | |
2380 | your cache's behavior goes. You can increase the amount of data | |
2381 | logged to this file with the "debug_options" tag below. | |
2382 | DOC_END | |
5473c134 | 2383 | |
41bd17a4 | 2384 | NAME: cache_store_log |
2385 | TYPE: string | |
df2eec10 | 2386 | DEFAULT: none |
41bd17a4 | 2387 | LOC: Config.Log.store |
2388 | DOC_START | |
2389 | Logs the activities of the storage manager. Shows which | |
2390 | objects are ejected from the cache, and which objects are | |
df2eec10 AJ |
2391 | saved and for how long. To disable, enter "none" or remove the line. |
2392 | There are not really utilities to analyze this data, so you can safely | |
41bd17a4 | 2393 | disable it. |
df2eec10 AJ |
2394 | NOCOMMENT_START |
2395 | # cache_store_log @DEFAULT_STORE_LOG@ | |
2396 | NOCOMMENT_END | |
5473c134 | 2397 | DOC_END |
2398 | ||
41bd17a4 | 2399 | NAME: cache_swap_state cache_swap_log |
2400 | TYPE: string | |
2401 | LOC: Config.Log.swap | |
5473c134 | 2402 | DEFAULT: none |
2403 | DOC_START | |
41bd17a4 | 2404 | Location for the cache "swap.state" file. This index file holds |
2405 | the metadata of objects saved on disk. It is used to rebuild | |
2406 | the cache during startup. Normally this file resides in each | |
2407 | 'cache_dir' directory, but you may specify an alternate | |
2408 | pathname here. Note you must give a full filename, not just | |
2409 | a directory. Since this is the index for the whole object | |
2410 | list you CANNOT periodically rotate it! | |
5473c134 | 2411 | |
41bd17a4 | 2412 | If %s can be used in the file name it will be replaced with a |
2413 | a representation of the cache_dir name where each / is replaced | |
2414 | with '.'. This is needed to allow adding/removing cache_dir | |
2415 | lines when cache_swap_log is being used. | |
5473c134 | 2416 | |
41bd17a4 | 2417 | If have more than one 'cache_dir', and %s is not used in the name |
2418 | these swap logs will have names such as: | |
5473c134 | 2419 | |
41bd17a4 | 2420 | cache_swap_log.00 |
2421 | cache_swap_log.01 | |
2422 | cache_swap_log.02 | |
5473c134 | 2423 | |
41bd17a4 | 2424 | The numbered extension (which is added automatically) |
2425 | corresponds to the order of the 'cache_dir' lines in this | |
2426 | configuration file. If you change the order of the 'cache_dir' | |
2427 | lines in this file, these index files will NOT correspond to | |
2428 | the correct 'cache_dir' entry (unless you manually rename | |
2429 | them). We recommend you do NOT use this option. It is | |
2430 | better to keep these index files in each 'cache_dir' directory. | |
5473c134 | 2431 | DOC_END |
2432 | ||
41bd17a4 | 2433 | NAME: logfile_rotate |
2434 | TYPE: int | |
2435 | DEFAULT: 10 | |
2436 | LOC: Config.Log.rotateNumber | |
5473c134 | 2437 | DOC_START |
41bd17a4 | 2438 | Specifies the number of logfile rotations to make when you |
2439 | type 'squid -k rotate'. The default is 10, which will rotate | |
2440 | with extensions 0 through 9. Setting logfile_rotate to 0 will | |
2441 | disable the file name rotation, but the logfiles are still closed | |
2442 | and re-opened. This will enable you to rename the logfiles | |
2443 | yourself just before sending the rotate signal. | |
5473c134 | 2444 | |
41bd17a4 | 2445 | Note, the 'squid -k rotate' command normally sends a USR1 |
2446 | signal to the running squid process. In certain situations | |
2447 | (e.g. on Linux with Async I/O), USR1 is used for other | |
2448 | purposes, so -k rotate uses another signal. It is best to get | |
2449 | in the habit of using 'squid -k rotate' instead of 'kill -USR1 | |
2450 | <pid>'. | |
2451 | DOC_END | |
5473c134 | 2452 | |
41bd17a4 | 2453 | NAME: emulate_httpd_log |
2454 | COMMENT: on|off | |
2455 | TYPE: onoff | |
2456 | DEFAULT: off | |
2457 | LOC: Config.onoff.common_log | |
2458 | DOC_START | |
2459 | The Cache can emulate the log file format which many 'httpd' | |
2460 | programs use. To disable/enable this emulation, set | |
2461 | emulate_httpd_log to 'off' or 'on'. The default | |
2462 | is to use the native log format since it includes useful | |
2463 | information Squid-specific log analyzers use. | |
5473c134 | 2464 | DOC_END |
2465 | ||
41bd17a4 | 2466 | NAME: log_ip_on_direct |
2467 | COMMENT: on|off | |
2468 | TYPE: onoff | |
5473c134 | 2469 | DEFAULT: on |
41bd17a4 | 2470 | LOC: Config.onoff.log_ip_on_direct |
5473c134 | 2471 | DOC_START |
41bd17a4 | 2472 | Log the destination IP address in the hierarchy log tag when going |
2473 | direct. Earlier Squid versions logged the hostname here. If you | |
2474 | prefer the old way set this to off. | |
2475 | DOC_END | |
5473c134 | 2476 | |
41bd17a4 | 2477 | NAME: mime_table |
2478 | TYPE: string | |
2479 | DEFAULT: @DEFAULT_MIME_TABLE@ | |
2480 | LOC: Config.mimeTablePathname | |
2481 | DOC_START | |
2482 | Pathname to Squid's MIME table. You shouldn't need to change | |
2483 | this, but the default file contains examples and formatting | |
2484 | information if you do. | |
5473c134 | 2485 | DOC_END |
2486 | ||
41bd17a4 | 2487 | NAME: log_mime_hdrs |
2488 | COMMENT: on|off | |
2489 | TYPE: onoff | |
2490 | LOC: Config.onoff.log_mime_hdrs | |
2491 | DEFAULT: off | |
2492 | DOC_START | |
2493 | The Cache can record both the request and the response MIME | |
2494 | headers for each HTTP transaction. The headers are encoded | |
2495 | safely and will appear as two bracketed fields at the end of | |
2496 | the access log (for either the native or httpd-emulated log | |
2497 | formats). To enable this logging set log_mime_hdrs to 'on'. | |
2498 | DOC_END | |
5473c134 | 2499 | |
41bd17a4 | 2500 | NAME: useragent_log |
2501 | TYPE: string | |
2502 | LOC: Config.Log.useragent | |
2503 | DEFAULT: none | |
2504 | IFDEF: USE_USERAGENT_LOG | |
5473c134 | 2505 | DOC_START |
41bd17a4 | 2506 | Squid will write the User-Agent field from HTTP requests |
2507 | to the filename specified here. By default useragent_log | |
2508 | is disabled. | |
5473c134 | 2509 | DOC_END |
2510 | ||
41bd17a4 | 2511 | NAME: referer_log referrer_log |
2512 | TYPE: string | |
2513 | LOC: Config.Log.referer | |
2514 | DEFAULT: none | |
2515 | IFDEF: USE_REFERER_LOG | |
5473c134 | 2516 | DOC_START |
41bd17a4 | 2517 | Squid will write the Referer field from HTTP requests to the |
2518 | filename specified here. By default referer_log is disabled. | |
2519 | Note that "referer" is actually a misspelling of "referrer" | |
2520 | however the misspelt version has been accepted into the HTTP RFCs | |
2521 | and we accept both. | |
5473c134 | 2522 | DOC_END |
2523 | ||
41bd17a4 | 2524 | NAME: pid_filename |
2525 | TYPE: string | |
2526 | DEFAULT: @DEFAULT_PID_FILE@ | |
2527 | LOC: Config.pidFilename | |
5473c134 | 2528 | DOC_START |
41bd17a4 | 2529 | A filename to write the process-id to. To disable, enter "none". |
5473c134 | 2530 | DOC_END |
2531 | ||
41bd17a4 | 2532 | NAME: debug_options |
fb6a61d1 | 2533 | TYPE: eol |
41bd17a4 | 2534 | DEFAULT: ALL,1 |
2535 | LOC: Config.debugOptions | |
5473c134 | 2536 | DOC_START |
41bd17a4 | 2537 | Logging options are set as section,level where each source file |
2538 | is assigned a unique section. Lower levels result in less | |
2539 | output, Full debugging (level 9) can result in a very large | |
2540 | log file, so be careful. The magic word "ALL" sets debugging | |
2541 | levels for all sections. We recommend normally running with | |
2542 | "ALL,1". | |
5473c134 | 2543 | DOC_END |
2544 | ||
41bd17a4 | 2545 | NAME: log_fqdn |
2546 | COMMENT: on|off | |
2547 | TYPE: onoff | |
2548 | DEFAULT: off | |
2549 | LOC: Config.onoff.log_fqdn | |
5473c134 | 2550 | DOC_START |
41bd17a4 | 2551 | Turn this on if you wish to log fully qualified domain names |
2552 | in the access.log. To do this Squid does a DNS lookup of all | |
2553 | IP's connecting to it. This can (in some situations) increase | |
2554 | latency, which makes your cache seem slower for interactive | |
2555 | browsing. | |
5473c134 | 2556 | DOC_END |
2557 | ||
41bd17a4 | 2558 | NAME: client_netmask |
2559 | TYPE: address | |
2560 | LOC: Config.Addrs.client_netmask | |
2561 | DEFAULT: 255.255.255.255 | |
5473c134 | 2562 | DOC_START |
41bd17a4 | 2563 | A netmask for client addresses in logfiles and cachemgr output. |
2564 | Change this to protect the privacy of your cache clients. | |
2565 | A netmask of 255.255.255.0 will log all IP's in that range with | |
2566 | the last digit set to '0'. | |
5473c134 | 2567 | DOC_END |
2568 | ||
41bd17a4 | 2569 | NAME: forward_log |
2570 | IFDEF: WIP_FWD_LOG | |
2571 | TYPE: string | |
2572 | DEFAULT: none | |
2573 | LOC: Config.Log.forward | |
5473c134 | 2574 | DOC_START |
41bd17a4 | 2575 | Logs the server-side requests. |
5473c134 | 2576 | |
41bd17a4 | 2577 | This is currently work in progress. |
5473c134 | 2578 | DOC_END |
2579 | ||
41bd17a4 | 2580 | NAME: strip_query_terms |
5473c134 | 2581 | TYPE: onoff |
41bd17a4 | 2582 | LOC: Config.onoff.strip_query_terms |
5473c134 | 2583 | DEFAULT: on |
2584 | DOC_START | |
41bd17a4 | 2585 | By default, Squid strips query terms from requested URLs before |
2586 | logging. This protects your user's privacy. | |
5473c134 | 2587 | DOC_END |
2588 | ||
41bd17a4 | 2589 | NAME: buffered_logs |
2590 | COMMENT: on|off | |
2591 | TYPE: onoff | |
2592 | DEFAULT: off | |
2593 | LOC: Config.onoff.buffered_logs | |
5473c134 | 2594 | DOC_START |
41bd17a4 | 2595 | cache.log log file is written with stdio functions, and as such |
2596 | it can be buffered or unbuffered. By default it will be unbuffered. | |
2597 | Buffering it can speed up the writing slightly (though you are | |
2598 | unlikely to need to worry unless you run with tons of debugging | |
2599 | enabled in which case performance will suffer badly anyway..). | |
6b698a21 | 2600 | DOC_END |
0976f8db | 2601 | |
2b753521 | 2602 | NAME: netdb_filename |
2603 | TYPE: string | |
2604 | DEFAULT: @DEFAULT_NETDB_FILE@ | |
2605 | LOC: Config.netdbFilename | |
fb6a61d1 | 2606 | IFDEF: USE_ICMP |
2b753521 | 2607 | DOC_START |
2608 | A filename where Squid stores it's netdb state between restarts. | |
2609 | To disable, enter "none". | |
2610 | DOC_END | |
2611 | ||
41bd17a4 | 2612 | COMMENT_START |
2613 | OPTIONS FOR FTP GATEWAYING | |
2614 | ----------------------------------------------------------------------------- | |
2615 | COMMENT_END | |
2616 | ||
2617 | NAME: ftp_user | |
2618 | TYPE: string | |
2619 | DEFAULT: Squid@ | |
2620 | LOC: Config.Ftp.anon_user | |
6b698a21 | 2621 | DOC_START |
41bd17a4 | 2622 | If you want the anonymous login password to be more informative |
2623 | (and enable the use of picky ftp servers), set this to something | |
2624 | reasonable for your domain, like wwwuser@somewhere.net | |
7f7db318 | 2625 | |
41bd17a4 | 2626 | The reason why this is domainless by default is the |
2627 | request can be made on the behalf of a user in any domain, | |
2628 | depending on how the cache is used. | |
2629 | Some ftp server also validate the email address is valid | |
2630 | (for example perl.com). | |
6b698a21 | 2631 | DOC_END |
0976f8db | 2632 | |
41bd17a4 | 2633 | NAME: ftp_list_width |
2634 | TYPE: size_t | |
2635 | DEFAULT: 32 | |
2636 | LOC: Config.Ftp.list_width | |
6b698a21 | 2637 | DOC_START |
41bd17a4 | 2638 | Sets the width of ftp listings. This should be set to fit in |
2639 | the width of a standard browser. Setting this too small | |
2640 | can cut off long filenames when browsing ftp sites. | |
6b698a21 | 2641 | DOC_END |
9e7dbc51 | 2642 | |
41bd17a4 | 2643 | NAME: ftp_passive |
2644 | TYPE: onoff | |
2645 | DEFAULT: on | |
2646 | LOC: Config.Ftp.passive | |
6b698a21 | 2647 | DOC_START |
41bd17a4 | 2648 | If your firewall does not allow Squid to use passive |
2649 | connections, turn off this option. | |
a689bd4e | 2650 | |
2651 | Use of ftp_epsv_all option requires this to be ON. | |
2652 | DOC_END | |
2653 | ||
2654 | NAME: ftp_epsv_all | |
2655 | TYPE: onoff | |
2656 | DEFAULT: off | |
2657 | LOC: Config.Ftp.epsv_all | |
2658 | DOC_START | |
2659 | FTP Protocol extensions permit the use of a special "EPSV ALL" command. | |
2660 | ||
2661 | NATs may be able to put the connection on a "fast path" through the | |
2662 | translator, as the EPRT command will never be used and therefore, | |
2663 | translation of the data portion of the segments will never be needed. | |
2664 | ||
2665 | When a client only expects to do two-way FTP transfers this may be useful. | |
2666 | If squid finds that it must do a three-way FTP transfer after issuing | |
2667 | an EPSV ALL command, the FTP session will fail. | |
2668 | ||
2669 | If you have any doubts about this option do not use it. | |
2670 | Squid will nicely attempt all other connection methods. | |
2671 | ||
2672 | Requires ftp_passive to be ON (default) | |
41bd17a4 | 2673 | DOC_END |
9e7dbc51 | 2674 | |
41bd17a4 | 2675 | NAME: ftp_sanitycheck |
2676 | TYPE: onoff | |
2677 | DEFAULT: on | |
2678 | LOC: Config.Ftp.sanitycheck | |
2679 | DOC_START | |
2680 | For security and data integrity reasons Squid by default performs | |
2681 | sanity checks of the addresses of FTP data connections ensure the | |
2682 | data connection is to the requested server. If you need to allow | |
2683 | FTP connections to servers using another IP address for the data | |
2684 | connection turn this off. | |
2685 | DOC_END | |
9e7dbc51 | 2686 | |
41bd17a4 | 2687 | NAME: ftp_telnet_protocol |
2688 | TYPE: onoff | |
2689 | DEFAULT: on | |
2690 | LOC: Config.Ftp.telnet | |
2691 | DOC_START | |
2692 | The FTP protocol is officially defined to use the telnet protocol | |
2693 | as transport channel for the control connection. However, many | |
2694 | implementations are broken and does not respect this aspect of | |
2695 | the FTP protocol. | |
2696 | ||
2697 | If you have trouble accessing files with ASCII code 255 in the | |
2698 | path or similar problems involving this ASCII code you can | |
2699 | try setting this directive to off. If that helps, report to the | |
2700 | operator of the FTP server in question that their FTP server | |
2701 | is broken and does not follow the FTP standard. | |
2702 | DOC_END | |
2703 | ||
2704 | COMMENT_START | |
2705 | OPTIONS FOR EXTERNAL SUPPORT PROGRAMS | |
2706 | ----------------------------------------------------------------------------- | |
2707 | COMMENT_END | |
2708 | ||
2709 | NAME: diskd_program | |
2710 | TYPE: string | |
2711 | DEFAULT: @DEFAULT_DISKD@ | |
2712 | LOC: Config.Program.diskd | |
2713 | DOC_START | |
2714 | Specify the location of the diskd executable. | |
2715 | Note this is only useful if you have compiled in | |
2716 | diskd as one of the store io modules. | |
2717 | DOC_END | |
2718 | ||
2719 | NAME: unlinkd_program | |
2720 | IFDEF: USE_UNLINKD | |
2721 | TYPE: string | |
2722 | DEFAULT: @DEFAULT_UNLINKD@ | |
2723 | LOC: Config.Program.unlinkd | |
2724 | DOC_START | |
2725 | Specify the location of the executable for file deletion process. | |
2726 | DOC_END | |
2727 | ||
2728 | NAME: pinger_program | |
2729 | TYPE: string | |
2730 | DEFAULT: @DEFAULT_PINGER@ | |
cc192b50 | 2731 | LOC: Config.pinger.program |
41bd17a4 | 2732 | IFDEF: USE_ICMP |
2733 | DOC_START | |
2734 | Specify the location of the executable for the pinger process. | |
2735 | DOC_END | |
2736 | ||
cc192b50 | 2737 | NAME: pinger_enable |
2738 | TYPE: onoff | |
2739 | DEFAULT: on | |
2740 | LOC: Config.pinger.enable | |
2741 | IFDEF: USE_ICMP | |
2742 | DOC_START | |
2743 | Control whether the pinger is active at run-time. | |
2744 | Enables turning ICMP pinger on and off with a simple squid -k reconfigure. | |
2745 | DOC_END | |
2746 | ||
2747 | ||
41bd17a4 | 2748 | COMMENT_START |
2749 | OPTIONS FOR URL REWRITING | |
2750 | ----------------------------------------------------------------------------- | |
2751 | COMMENT_END | |
2752 | ||
2753 | NAME: url_rewrite_program redirect_program | |
2754 | TYPE: wordlist | |
2755 | LOC: Config.Program.redirect | |
2756 | DEFAULT: none | |
2757 | DOC_START | |
2758 | Specify the location of the executable for the URL rewriter. | |
2759 | Since they can perform almost any function there isn't one included. | |
2760 | ||
2761 | For each requested URL rewriter will receive on line with the format | |
2762 | ||
c71adec1 | 2763 | URL <SP> client_ip "/" fqdn <SP> user <SP> method [<SP> kvpairs]<NL> |
2764 | ||
2765 | In the future, the rewriter interface will be extended with | |
2766 | key=value pairs ("kvpairs" shown above). Rewriter programs | |
2767 | should be prepared to receive and possibly ignore additional | |
2768 | whitespace-separated tokens on each input line. | |
41bd17a4 | 2769 | |
2770 | And the rewriter may return a rewritten URL. The other components of | |
2771 | the request line does not need to be returned (ignored if they are). | |
2772 | ||
2773 | The rewriter can also indicate that a client-side redirect should | |
2774 | be performed to the new URL. This is done by prefixing the returned | |
2775 | URL with "301:" (moved permanently) or 302: (moved temporarily). | |
2776 | ||
2777 | By default, a URL rewriter is not used. | |
2778 | DOC_END | |
2779 | ||
2780 | NAME: url_rewrite_children redirect_children | |
2781 | TYPE: int | |
2782 | DEFAULT: 5 | |
2783 | LOC: Config.redirectChildren | |
2784 | DOC_START | |
2785 | The number of redirector processes to spawn. If you start | |
2786 | too few Squid will have to wait for them to process a backlog of | |
2787 | URLs, slowing it down. If you start too many they will use RAM | |
2788 | and other system resources. | |
2789 | DOC_END | |
2790 | ||
2791 | NAME: url_rewrite_concurrency redirect_concurrency | |
2792 | TYPE: int | |
2793 | DEFAULT: 0 | |
2794 | LOC: Config.redirectConcurrency | |
2795 | DOC_START | |
2796 | The number of requests each redirector helper can handle in | |
2797 | parallel. Defaults to 0 which indicates the redirector | |
2798 | is a old-style single threaded redirector. | |
2799 | DOC_END | |
2800 | ||
2801 | NAME: url_rewrite_host_header redirect_rewrites_host_header | |
2802 | TYPE: onoff | |
2803 | DEFAULT: on | |
2804 | LOC: Config.onoff.redir_rewrites_host | |
2805 | DOC_START | |
2806 | By default Squid rewrites any Host: header in redirected | |
2807 | requests. If you are running an accelerator this may | |
2808 | not be a wanted effect of a redirector. | |
2809 | ||
2810 | WARNING: Entries are cached on the result of the URL rewriting | |
2811 | process, so be careful if you have domain-virtual hosts. | |
2812 | DOC_END | |
2813 | ||
2814 | NAME: url_rewrite_access redirector_access | |
2815 | TYPE: acl_access | |
2816 | DEFAULT: none | |
2817 | LOC: Config.accessList.redirector | |
2818 | DOC_START | |
2819 | If defined, this access list specifies which requests are | |
2820 | sent to the redirector processes. By default all requests | |
2821 | are sent. | |
2822 | DOC_END | |
2823 | ||
2824 | NAME: url_rewrite_bypass redirector_bypass | |
2825 | TYPE: onoff | |
2826 | LOC: Config.onoff.redirector_bypass | |
2827 | DEFAULT: off | |
2828 | DOC_START | |
2829 | When this is 'on', a request will not go through the | |
2830 | redirector if all redirectors are busy. If this is 'off' | |
2831 | and the redirector queue grows too large, Squid will exit | |
2832 | with a FATAL error and ask you to increase the number of | |
2833 | redirectors. You should only enable this if the redirectors | |
2834 | are not critical to your caching system. If you use | |
2835 | redirectors for access control, and you enable this option, | |
2836 | users may have access to pages they should not | |
2837 | be allowed to request. | |
2838 | DOC_END | |
2839 | ||
2840 | COMMENT_START | |
2841 | OPTIONS FOR TUNING THE CACHE | |
2842 | ----------------------------------------------------------------------------- | |
2843 | COMMENT_END | |
2844 | ||
f04b37d8 | 2845 | NAME: cache no_cache |
2846 | TYPE: acl_access | |
2847 | DEFAULT: none | |
2848 | LOC: Config.accessList.noCache | |
41bd17a4 | 2849 | DOC_START |
240887f0 | 2850 | A list of ACL elements which, if matched and denied, cause the request to |
f04b37d8 | 2851 | not be satisfied from the cache and the reply to not be cached. |
2852 | In other words, use this to force certain objects to never be cached. | |
41bd17a4 | 2853 | |
240887f0 | 2854 | You must use the words 'allow' or 'deny' to indicate whether items |
2855 | matching the ACL should be allowed or denied into the cache. | |
f04b37d8 | 2856 | |
240887f0 | 2857 | Default is to allow all to be cached. |
41bd17a4 | 2858 | DOC_END |
2859 | ||
2860 | NAME: refresh_pattern | |
2861 | TYPE: refreshpattern | |
2862 | LOC: Config.Refresh | |
2863 | DEFAULT: none | |
2864 | DOC_START | |
2865 | usage: refresh_pattern [-i] regex min percent max [options] | |
9e7dbc51 | 2866 | |
6b698a21 | 2867 | By default, regular expressions are CASE-SENSITIVE. To make |
2868 | them case-insensitive, use the -i option. | |
9e7dbc51 | 2869 | |
41bd17a4 | 2870 | 'Min' is the time (in minutes) an object without an explicit |
2871 | expiry time should be considered fresh. The recommended | |
2872 | value is 0, any higher values may cause dynamic applications | |
2873 | to be erroneously cached unless the application designer | |
2874 | has taken the appropriate actions. | |
9e7dbc51 | 2875 | |
41bd17a4 | 2876 | 'Percent' is a percentage of the objects age (time since last |
2877 | modification age) an object without explicit expiry time | |
2878 | will be considered fresh. | |
5b807763 | 2879 | |
41bd17a4 | 2880 | 'Max' is an upper limit on how long objects without an explicit |
2881 | expiry time will be considered fresh. | |
9e7dbc51 | 2882 | |
41bd17a4 | 2883 | options: override-expire |
2884 | override-lastmod | |
2885 | reload-into-ims | |
2886 | ignore-reload | |
2887 | ignore-no-cache | |
2888 | ignore-no-store | |
2889 | ignore-private | |
2890 | ignore-auth | |
2891 | refresh-ims | |
a0ec9f68 | 2892 | |
41bd17a4 | 2893 | override-expire enforces min age even if the server |
9b2ad080 HN |
2894 | sent an explicit expiry time (e.g., with the |
2895 | Expires: header or Cache-Control: max-age). Doing this | |
2896 | VIOLATES the HTTP standard. Enabling this feature | |
2897 | could make you liable for problems which it causes. | |
6468fe10 | 2898 | |
41bd17a4 | 2899 | override-lastmod enforces min age even on objects |
2900 | that were modified recently. | |
934b03fc | 2901 | |
41bd17a4 | 2902 | reload-into-ims changes client no-cache or ``reload'' |
2903 | to If-Modified-Since requests. Doing this VIOLATES the | |
2904 | HTTP standard. Enabling this feature could make you | |
2905 | liable for problems which it causes. | |
dba79ac5 | 2906 | |
41bd17a4 | 2907 | ignore-reload ignores a client no-cache or ``reload'' |
2908 | header. Doing this VIOLATES the HTTP standard. Enabling | |
2909 | this feature could make you liable for problems which | |
2910 | it causes. | |
9bc73deb | 2911 | |
41bd17a4 | 2912 | ignore-no-cache ignores any ``Pragma: no-cache'' and |
2913 | ``Cache-control: no-cache'' headers received from a server. | |
2914 | The HTTP RFC never allows the use of this (Pragma) header | |
2915 | from a server, only a client, though plenty of servers | |
2916 | send it anyway. | |
2917 | ||
2918 | ignore-no-store ignores any ``Cache-control: no-store'' | |
2919 | headers received from a server. Doing this VIOLATES | |
2920 | the HTTP standard. Enabling this feature could make you | |
2921 | liable for problems which it causes. | |
2922 | ||
2923 | ignore-private ignores any ``Cache-control: private'' | |
2924 | headers received from a server. Doing this VIOLATES | |
2925 | the HTTP standard. Enabling this feature could make you | |
2926 | liable for problems which it causes. | |
2927 | ||
2928 | ignore-auth caches responses to requests with authorization, | |
2929 | as if the originserver had sent ``Cache-control: public'' | |
2930 | in the response header. Doing this VIOLATES the HTTP standard. | |
2931 | Enabling this feature could make you liable for problems which | |
2932 | it causes. | |
2933 | ||
2934 | refresh-ims causes squid to contact the origin server | |
2935 | when a client issues an If-Modified-Since request. This | |
2936 | ensures that the client will receive an updated version | |
2937 | if one is available. | |
2938 | ||
2939 | Basically a cached object is: | |
2940 | ||
2941 | FRESH if expires < now, else STALE | |
2942 | STALE if age > max | |
2943 | FRESH if lm-factor < percent, else STALE | |
2944 | FRESH if age < min | |
2945 | else STALE | |
2946 | ||
2947 | The refresh_pattern lines are checked in the order listed here. | |
2948 | The first entry which matches is used. If none of the entries | |
2949 | match the default will be used. | |
2950 | ||
2951 | Note, you must uncomment all the default lines if you want | |
2952 | to change one. The default setting is only active if none is | |
2953 | used. | |
2954 | ||
2955 | Suggested default: | |
2956 | NOCOMMENT_START | |
2957 | refresh_pattern ^ftp: 1440 20% 10080 | |
2958 | refresh_pattern ^gopher: 1440 0% 1440 | |
89db45fa | 2959 | refresh_pattern -i (/cgi-bin/|\?) 0 0% 0 |
41bd17a4 | 2960 | refresh_pattern . 0 20% 4320 |
2961 | NOCOMMENT_END | |
2962 | DOC_END | |
2963 | ||
2964 | NAME: quick_abort_min | |
2965 | COMMENT: (KB) | |
2966 | TYPE: kb_int64_t | |
2967 | DEFAULT: 16 KB | |
2968 | LOC: Config.quickAbort.min | |
2969 | DOC_NONE | |
2970 | ||
2971 | NAME: quick_abort_max | |
2972 | COMMENT: (KB) | |
2973 | TYPE: kb_int64_t | |
2974 | DEFAULT: 16 KB | |
2975 | LOC: Config.quickAbort.max | |
2976 | DOC_NONE | |
2977 | ||
2978 | NAME: quick_abort_pct | |
2979 | COMMENT: (percent) | |
2980 | TYPE: int | |
2981 | DEFAULT: 95 | |
2982 | LOC: Config.quickAbort.pct | |
2983 | DOC_START | |
2984 | The cache by default continues downloading aborted requests | |
2985 | which are almost completed (less than 16 KB remaining). This | |
2986 | may be undesirable on slow (e.g. SLIP) links and/or very busy | |
2987 | caches. Impatient users may tie up file descriptors and | |
2988 | bandwidth by repeatedly requesting and immediately aborting | |
2989 | downloads. | |
2990 | ||
2991 | When the user aborts a request, Squid will check the | |
2992 | quick_abort values to the amount of data transfered until | |
2993 | then. | |
2994 | ||
2995 | If the transfer has less than 'quick_abort_min' KB remaining, | |
2996 | it will finish the retrieval. | |
2997 | ||
2998 | If the transfer has more than 'quick_abort_max' KB remaining, | |
2999 | it will abort the retrieval. | |
3000 | ||
3001 | If more than 'quick_abort_pct' of the transfer has completed, | |
3002 | it will finish the retrieval. | |
3003 | ||
3004 | If you do not want any retrieval to continue after the client | |
3005 | has aborted, set both 'quick_abort_min' and 'quick_abort_max' | |
3006 | to '0 KB'. | |
3007 | ||
3008 | If you want retrievals to always continue if they are being | |
3009 | cached set 'quick_abort_min' to '-1 KB'. | |
3010 | DOC_END | |
60d096f4 | 3011 | |
41bd17a4 | 3012 | NAME: read_ahead_gap |
3013 | COMMENT: buffer-size | |
3014 | TYPE: b_int64_t | |
3015 | LOC: Config.readAheadGap | |
3016 | DEFAULT: 16 KB | |
3017 | DOC_START | |
3018 | The amount of data the cache will buffer ahead of what has been | |
3019 | sent to the client when retrieving an object from another server. | |
3020 | DOC_END | |
53e738c6 | 3021 | |
41bd17a4 | 3022 | NAME: negative_ttl |
ac9cc053 | 3023 | IFDEF: HTTP_VIOLATIONS |
41bd17a4 | 3024 | COMMENT: time-units |
3025 | TYPE: time_t | |
3026 | LOC: Config.negativeTtl | |
ac9cc053 | 3027 | DEFAULT: 0 seconds |
41bd17a4 | 3028 | DOC_START |
ac9cc053 AJ |
3029 | Set the Default Time-to-Live (TTL) for failed requests. |
3030 | Certain types of failures (such as "connection refused" and | |
3031 | "404 Not Found") are able to be negatively-cached for a short time. | |
3032 | Modern web servers should provide Expires: header, however if they | |
3033 | do not this can provide a minimum TTL. | |
3034 | The default is not to cache errors with unknown expiry details. | |
3035 | ||
3036 | Note that this is different from negative caching of DNS lookups. | |
39956c7c AJ |
3037 | |
3038 | WARNING: Doing this VIOLATES the HTTP standard. Enabling | |
3039 | this feature could make you liable for problems which it | |
3040 | causes. | |
41bd17a4 | 3041 | DOC_END |
53e738c6 | 3042 | |
41bd17a4 | 3043 | NAME: positive_dns_ttl |
3044 | COMMENT: time-units | |
3045 | TYPE: time_t | |
3046 | LOC: Config.positiveDnsTtl | |
3047 | DEFAULT: 6 hours | |
3048 | DOC_START | |
3049 | Upper limit on how long Squid will cache positive DNS responses. | |
3050 | Default is 6 hours (360 minutes). This directive must be set | |
3051 | larger than negative_dns_ttl. | |
3052 | DOC_END | |
c4ab8329 | 3053 | |
41bd17a4 | 3054 | NAME: negative_dns_ttl |
3055 | COMMENT: time-units | |
3056 | TYPE: time_t | |
3057 | LOC: Config.negativeDnsTtl | |
3058 | DEFAULT: 1 minutes | |
3059 | DOC_START | |
3060 | Time-to-Live (TTL) for negative caching of failed DNS lookups. | |
3061 | This also sets the lower cache limit on positive lookups. | |
3062 | Minimum value is 1 second, and it is not recommendable to go | |
3063 | much below 10 seconds. | |
3064 | DOC_END | |
7df0bfd7 | 3065 | |
41bd17a4 | 3066 | NAME: range_offset_limit |
3067 | COMMENT: (bytes) | |
3068 | TYPE: b_int64_t | |
3069 | LOC: Config.rangeOffsetLimit | |
3070 | DEFAULT: 0 KB | |
3071 | DOC_START | |
3072 | Sets a upper limit on how far into the the file a Range request | |
3073 | may be to cause Squid to prefetch the whole file. If beyond this | |
3074 | limit Squid forwards the Range request as it is and the result | |
3075 | is NOT cached. | |
c4ab8329 | 3076 | |
41bd17a4 | 3077 | This is to stop a far ahead range request (lets say start at 17MB) |
3078 | from making Squid fetch the whole object up to that point before | |
3079 | sending anything to the client. | |
a7ad6e4e | 3080 | |
41bd17a4 | 3081 | A value of -1 causes Squid to always fetch the object from the |
3082 | beginning so it may cache the result. (2.0 style) | |
a7ad6e4e | 3083 | |
41bd17a4 | 3084 | A value of 0 causes Squid to never fetch more than the |
3085 | client requested. (default) | |
3086 | DOC_END | |
d95b862f | 3087 | |
41bd17a4 | 3088 | NAME: minimum_expiry_time |
3089 | COMMENT: (seconds) | |
3090 | TYPE: time_t | |
3091 | LOC: Config.minimum_expiry_time | |
3092 | DEFAULT: 60 seconds | |
3093 | DOC_START | |
3094 | The minimum caching time according to (Expires - Date) | |
3095 | Headers Squid honors if the object can't be revalidated | |
649fa918 | 3096 | defaults to 60 seconds. In reverse proxy environments it |
41bd17a4 | 3097 | might be desirable to honor shorter object lifetimes. It |
3098 | is most likely better to make your server return a | |
3099 | meaningful Last-Modified header however. In ESI environments | |
3100 | where page fragments often have short lifetimes, this will | |
3101 | often be best set to 0. | |
3102 | DOC_END | |
c68e9c6b | 3103 | |
41bd17a4 | 3104 | NAME: store_avg_object_size |
3105 | COMMENT: (kbytes) | |
3e62bd58 | 3106 | TYPE: kb_int64_t |
41bd17a4 | 3107 | DEFAULT: 13 KB |
3108 | LOC: Config.Store.avgObjectSize | |
3109 | DOC_START | |
3110 | Average object size, used to estimate number of objects your | |
3111 | cache can hold. The default is 13 KB. | |
cccac0a2 | 3112 | DOC_END |
3113 | ||
41bd17a4 | 3114 | NAME: store_objects_per_bucket |
3115 | TYPE: int | |
3116 | DEFAULT: 20 | |
3117 | LOC: Config.Store.objectsPerBucket | |
3118 | DOC_START | |
3119 | Target number of objects per bucket in the store hash table. | |
3120 | Lowering this value increases the total number of buckets and | |
3121 | also the storage maintenance rate. The default is 20. | |
3122 | DOC_END | |
3123 | ||
3124 | COMMENT_START | |
3125 | HTTP OPTIONS | |
3126 | ----------------------------------------------------------------------------- | |
3127 | COMMENT_END | |
3128 | ||
f04b37d8 | 3129 | NAME: request_header_max_size |
3130 | COMMENT: (KB) | |
3131 | TYPE: b_size_t | |
df2eec10 | 3132 | DEFAULT: 64 KB |
f04b37d8 | 3133 | LOC: Config.maxRequestHeaderSize |
3134 | DOC_START | |
3135 | This specifies the maximum size for HTTP headers in a request. | |
3136 | Request headers are usually relatively small (about 512 bytes). | |
3137 | Placing a limit on the request header size will catch certain | |
3138 | bugs (for example with persistent connections) and possibly | |
3139 | buffer-overflow or denial-of-service attacks. | |
3140 | DOC_END | |
3141 | ||
3142 | NAME: reply_header_max_size | |
3143 | COMMENT: (KB) | |
3144 | TYPE: b_size_t | |
df2eec10 | 3145 | DEFAULT: 64 KB |
f04b37d8 | 3146 | LOC: Config.maxReplyHeaderSize |
3147 | DOC_START | |
3148 | This specifies the maximum size for HTTP headers in a reply. | |
3149 | Reply headers are usually relatively small (about 512 bytes). | |
3150 | Placing a limit on the reply header size will catch certain | |
3151 | bugs (for example with persistent connections) and possibly | |
3152 | buffer-overflow or denial-of-service attacks. | |
3153 | DOC_END | |
3154 | ||
3155 | NAME: request_body_max_size | |
3156 | COMMENT: (bytes) | |
3157 | TYPE: b_int64_t | |
3158 | DEFAULT: 0 KB | |
3159 | LOC: Config.maxRequestBodySize | |
3160 | DOC_START | |
3161 | This specifies the maximum size for an HTTP request body. | |
3162 | In other words, the maximum size of a PUT/POST request. | |
3163 | A user who attempts to send a request with a body larger | |
3164 | than this limit receives an "Invalid Request" error message. | |
3165 | If you set this parameter to a zero (the default), there will | |
3166 | be no limit imposed. | |
3167 | DOC_END | |
3168 | ||
41bd17a4 | 3169 | NAME: broken_posts |
cccac0a2 | 3170 | TYPE: acl_access |
cccac0a2 | 3171 | DEFAULT: none |
41bd17a4 | 3172 | LOC: Config.accessList.brokenPosts |
cccac0a2 | 3173 | DOC_START |
41bd17a4 | 3174 | A list of ACL elements which, if matched, causes Squid to send |
3175 | an extra CRLF pair after the body of a PUT/POST request. | |
cccac0a2 | 3176 | |
41bd17a4 | 3177 | Some HTTP servers has broken implementations of PUT/POST, |
3178 | and rely on an extra CRLF pair sent by some WWW clients. | |
cccac0a2 | 3179 | |
41bd17a4 | 3180 | Quote from RFC2616 section 4.1 on this matter: |
cccac0a2 | 3181 | |
41bd17a4 | 3182 | Note: certain buggy HTTP/1.0 client implementations generate an |
3183 | extra CRLF's after a POST request. To restate what is explicitly | |
3184 | forbidden by the BNF, an HTTP/1.1 client must not preface or follow | |
3185 | a request with an extra CRLF. | |
cccac0a2 | 3186 | |
41bd17a4 | 3187 | Example: |
3188 | acl buggy_server url_regex ^http://.... | |
3189 | broken_posts allow buggy_server | |
3190 | DOC_END | |
cccac0a2 | 3191 | |
41bd17a4 | 3192 | NAME: via |
3193 | IFDEF: HTTP_VIOLATIONS | |
3194 | COMMENT: on|off | |
3195 | TYPE: onoff | |
3196 | DEFAULT: on | |
3197 | LOC: Config.onoff.via | |
3198 | DOC_START | |
3199 | If set (default), Squid will include a Via header in requests and | |
3200 | replies as required by RFC2616. | |
3201 | DOC_END | |
4cc6eb12 | 3202 | |
41bd17a4 | 3203 | NAME: ie_refresh |
3204 | COMMENT: on|off | |
3205 | TYPE: onoff | |
3206 | LOC: Config.onoff.ie_refresh | |
3207 | DEFAULT: off | |
3208 | DOC_START | |
3209 | Microsoft Internet Explorer up until version 5.5 Service | |
3210 | Pack 1 has an issue with transparent proxies, wherein it | |
3211 | is impossible to force a refresh. Turning this on provides | |
3212 | a partial fix to the problem, by causing all IMS-REFRESH | |
3213 | requests from older IE versions to check the origin server | |
3214 | for fresh content. This reduces hit ratio by some amount | |
3215 | (~10% in my experience), but allows users to actually get | |
3216 | fresh content when they want it. Note because Squid | |
3217 | cannot tell if the user is using 5.5 or 5.5SP1, the behavior | |
3218 | of 5.5 is unchanged from old versions of Squid (i.e. a | |
3219 | forced refresh is impossible). Newer versions of IE will, | |
3220 | hopefully, continue to have the new behavior and will be | |
3221 | handled based on that assumption. This option defaults to | |
3222 | the old Squid behavior, which is better for hit ratios but | |
3223 | worse for clients using IE, if they need to be able to | |
3224 | force fresh content. | |
3225 | DOC_END | |
b9d7fe3e | 3226 | |
41bd17a4 | 3227 | NAME: vary_ignore_expire |
3228 | COMMENT: on|off | |
3229 | TYPE: onoff | |
3230 | LOC: Config.onoff.vary_ignore_expire | |
3231 | DEFAULT: off | |
3232 | DOC_START | |
3233 | Many HTTP servers supporting Vary gives such objects | |
3234 | immediate expiry time with no cache-control header | |
3235 | when requested by a HTTP/1.0 client. This option | |
3236 | enables Squid to ignore such expiry times until | |
3237 | HTTP/1.1 is fully implemented. | |
3238 | WARNING: This may eventually cause some varying | |
3239 | objects not intended for caching to get cached. | |
cccac0a2 | 3240 | DOC_END |
c4ab8329 | 3241 | |
41bd17a4 | 3242 | NAME: request_entities |
3243 | TYPE: onoff | |
3244 | LOC: Config.onoff.request_entities | |
3245 | DEFAULT: off | |
3246 | DOC_START | |
3247 | Squid defaults to deny GET and HEAD requests with request entities, | |
3248 | as the meaning of such requests are undefined in the HTTP standard | |
3249 | even if not explicitly forbidden. | |
0976f8db | 3250 | |
41bd17a4 | 3251 | Set this directive to on if you have clients which insists |
3252 | on sending request entities in GET or HEAD requests. But be warned | |
3253 | that there is server software (both proxies and web servers) which | |
3254 | can fail to properly process this kind of request which may make you | |
3255 | vulnerable to cache pollution attacks if enabled. | |
cccac0a2 | 3256 | DOC_END |
6b53c392 | 3257 | |
41bd17a4 | 3258 | NAME: request_header_access |
3259 | IFDEF: HTTP_VIOLATIONS | |
3260 | TYPE: http_header_access[] | |
3261 | LOC: Config.request_header_access | |
cccac0a2 | 3262 | DEFAULT: none |
cccac0a2 | 3263 | DOC_START |
41bd17a4 | 3264 | Usage: request_header_access header_name allow|deny [!]aclname ... |
0976f8db | 3265 | |
41bd17a4 | 3266 | WARNING: Doing this VIOLATES the HTTP standard. Enabling |
3267 | this feature could make you liable for problems which it | |
3268 | causes. | |
0976f8db | 3269 | |
41bd17a4 | 3270 | This option replaces the old 'anonymize_headers' and the |
3271 | older 'http_anonymizer' option with something that is much | |
3272 | more configurable. This new method creates a list of ACLs | |
3273 | for each header, allowing you very fine-tuned header | |
3274 | mangling. | |
934b03fc | 3275 | |
41bd17a4 | 3276 | This option only applies to request headers, i.e., from the |
3277 | client to the server. | |
5401aa8d | 3278 | |
41bd17a4 | 3279 | You can only specify known headers for the header name. |
3280 | Other headers are reclassified as 'Other'. You can also | |
3281 | refer to all the headers with 'All'. | |
5401aa8d | 3282 | |
41bd17a4 | 3283 | For example, to achieve the same behavior as the old |
3284 | 'http_anonymizer standard' option, you should use: | |
5401aa8d | 3285 | |
41bd17a4 | 3286 | request_header_access From deny all |
3287 | request_header_access Referer deny all | |
3288 | request_header_access Server deny all | |
3289 | request_header_access User-Agent deny all | |
3290 | request_header_access WWW-Authenticate deny all | |
3291 | request_header_access Link deny all | |
5401aa8d | 3292 | |
41bd17a4 | 3293 | Or, to reproduce the old 'http_anonymizer paranoid' feature |
3294 | you should use: | |
5401aa8d | 3295 | |
41bd17a4 | 3296 | request_header_access Allow allow all |
3297 | request_header_access Authorization allow all | |
3298 | request_header_access WWW-Authenticate allow all | |
3299 | request_header_access Proxy-Authorization allow all | |
3300 | request_header_access Proxy-Authenticate allow all | |
3301 | request_header_access Cache-Control allow all | |
3302 | request_header_access Content-Encoding allow all | |
3303 | request_header_access Content-Length allow all | |
3304 | request_header_access Content-Type allow all | |
3305 | request_header_access Date allow all | |
3306 | request_header_access Expires allow all | |
3307 | request_header_access Host allow all | |
3308 | request_header_access If-Modified-Since allow all | |
3309 | request_header_access Last-Modified allow all | |
3310 | request_header_access Location allow all | |
3311 | request_header_access Pragma allow all | |
3312 | request_header_access Accept allow all | |
3313 | request_header_access Accept-Charset allow all | |
3314 | request_header_access Accept-Encoding allow all | |
3315 | request_header_access Accept-Language allow all | |
3316 | request_header_access Content-Language allow all | |
3317 | request_header_access Mime-Version allow all | |
3318 | request_header_access Retry-After allow all | |
3319 | request_header_access Title allow all | |
3320 | request_header_access Connection allow all | |
3321 | request_header_access Proxy-Connection allow all | |
3322 | request_header_access All deny all | |
5401aa8d | 3323 | |
41bd17a4 | 3324 | although many of those are HTTP reply headers, and so should be |
3325 | controlled with the reply_header_access directive. | |
5401aa8d | 3326 | |
41bd17a4 | 3327 | By default, all headers are allowed (no anonymizing is |
3328 | performed). | |
5401aa8d | 3329 | DOC_END |
3330 | ||
41bd17a4 | 3331 | NAME: reply_header_access |
3332 | IFDEF: HTTP_VIOLATIONS | |
3333 | TYPE: http_header_access[] | |
3334 | LOC: Config.reply_header_access | |
cccac0a2 | 3335 | DEFAULT: none |
3336 | DOC_START | |
41bd17a4 | 3337 | Usage: reply_header_access header_name allow|deny [!]aclname ... |
934b03fc | 3338 | |
41bd17a4 | 3339 | WARNING: Doing this VIOLATES the HTTP standard. Enabling |
3340 | this feature could make you liable for problems which it | |
3341 | causes. | |
934b03fc | 3342 | |
41bd17a4 | 3343 | This option only applies to reply headers, i.e., from the |
3344 | server to the client. | |
934b03fc | 3345 | |
41bd17a4 | 3346 | This is the same as request_header_access, but in the other |
3347 | direction. | |
6b53c392 | 3348 | |
41bd17a4 | 3349 | This option replaces the old 'anonymize_headers' and the |
3350 | older 'http_anonymizer' option with something that is much | |
3351 | more configurable. This new method creates a list of ACLs | |
3352 | for each header, allowing you very fine-tuned header | |
3353 | mangling. | |
cccac0a2 | 3354 | |
41bd17a4 | 3355 | You can only specify known headers for the header name. |
3356 | Other headers are reclassified as 'Other'. You can also | |
3357 | refer to all the headers with 'All'. | |
cccac0a2 | 3358 | |
41bd17a4 | 3359 | For example, to achieve the same behavior as the old |
3360 | 'http_anonymizer standard' option, you should use: | |
cccac0a2 | 3361 | |
41bd17a4 | 3362 | reply_header_access From deny all |
3363 | reply_header_access Referer deny all | |
3364 | reply_header_access Server deny all | |
3365 | reply_header_access User-Agent deny all | |
3366 | reply_header_access WWW-Authenticate deny all | |
3367 | reply_header_access Link deny all | |
cccac0a2 | 3368 | |
41bd17a4 | 3369 | Or, to reproduce the old 'http_anonymizer paranoid' feature |
3370 | you should use: | |
cccac0a2 | 3371 | |
41bd17a4 | 3372 | reply_header_access Allow allow all |
3373 | reply_header_access Authorization allow all | |
3374 | reply_header_access WWW-Authenticate allow all | |
3375 | reply_header_access Proxy-Authorization allow all | |
3376 | reply_header_access Proxy-Authenticate allow all | |
3377 | reply_header_access Cache-Control allow all | |
3378 | reply_header_access Content-Encoding allow all | |
3379 | reply_header_access Content-Length allow all | |
3380 | reply_header_access Content-Type allow all | |
3381 | reply_header_access Date allow all | |
3382 | reply_header_access Expires allow all | |
3383 | reply_header_access Host allow all | |
3384 | reply_header_access If-Modified-Since allow all | |
3385 | reply_header_access Last-Modified allow all | |
3386 | reply_header_access Location allow all | |
3387 | reply_header_access Pragma allow all | |
3388 | reply_header_access Accept allow all | |
3389 | reply_header_access Accept-Charset allow all | |
3390 | reply_header_access Accept-Encoding allow all | |
3391 | reply_header_access Accept-Language allow all | |
3392 | reply_header_access Content-Language allow all | |
3393 | reply_header_access Mime-Version allow all | |
3394 | reply_header_access Retry-After allow all | |
3395 | reply_header_access Title allow all | |
3396 | reply_header_access Connection allow all | |
3397 | reply_header_access Proxy-Connection allow all | |
3398 | reply_header_access All deny all | |
cccac0a2 | 3399 | |
41bd17a4 | 3400 | although the HTTP request headers won't be usefully controlled |
3401 | by this directive -- see request_header_access for details. | |
cccac0a2 | 3402 | |
41bd17a4 | 3403 | By default, all headers are allowed (no anonymizing is |
3404 | performed). | |
cccac0a2 | 3405 | DOC_END |
3406 | ||
41bd17a4 | 3407 | NAME: header_replace |
3408 | IFDEF: HTTP_VIOLATIONS | |
3409 | TYPE: http_header_replace[] | |
3410 | LOC: Config.request_header_access | |
cccac0a2 | 3411 | DEFAULT: none |
41bd17a4 | 3412 | DOC_START |
3413 | Usage: header_replace header_name message | |
3414 | Example: header_replace User-Agent Nutscrape/1.0 (CP/M; 8-bit) | |
cccac0a2 | 3415 | |
41bd17a4 | 3416 | This option allows you to change the contents of headers |
3417 | denied with header_access above, by replacing them with | |
3418 | some fixed string. This replaces the old fake_user_agent | |
3419 | option. | |
cccac0a2 | 3420 | |
41bd17a4 | 3421 | This only applies to request headers, not reply headers. |
cccac0a2 | 3422 | |
41bd17a4 | 3423 | By default, headers are removed if denied. |
3424 | DOC_END | |
cccac0a2 | 3425 | |
41bd17a4 | 3426 | NAME: relaxed_header_parser |
3427 | COMMENT: on|off|warn | |
3428 | TYPE: tristate | |
3429 | LOC: Config.onoff.relaxed_header_parser | |
3430 | DEFAULT: on | |
3431 | DOC_START | |
3432 | In the default "on" setting Squid accepts certain forms | |
3433 | of non-compliant HTTP messages where it is unambiguous | |
3434 | what the sending application intended even if the message | |
3435 | is not correctly formatted. The messages is then normalized | |
3436 | to the correct form when forwarded by Squid. | |
cccac0a2 | 3437 | |
41bd17a4 | 3438 | If set to "warn" then a warning will be emitted in cache.log |
3439 | each time such HTTP error is encountered. | |
cccac0a2 | 3440 | |
41bd17a4 | 3441 | If set to "off" then such HTTP errors will cause the request |
3442 | or response to be rejected. | |
3443 | DOC_END | |
7d90757b | 3444 | |
41bd17a4 | 3445 | COMMENT_START |
3446 | TIMEOUTS | |
3447 | ----------------------------------------------------------------------------- | |
3448 | COMMENT_END | |
3449 | ||
3450 | NAME: forward_timeout | |
3451 | COMMENT: time-units | |
3452 | TYPE: time_t | |
3453 | LOC: Config.Timeout.forward | |
3454 | DEFAULT: 4 minutes | |
3455 | DOC_START | |
3456 | This parameter specifies how long Squid should at most attempt in | |
3457 | finding a forwarding path for the request before giving up. | |
cccac0a2 | 3458 | DOC_END |
3459 | ||
41bd17a4 | 3460 | NAME: connect_timeout |
3461 | COMMENT: time-units | |
3462 | TYPE: time_t | |
3463 | LOC: Config.Timeout.connect | |
3464 | DEFAULT: 1 minute | |
057f5854 | 3465 | DOC_START |
41bd17a4 | 3466 | This parameter specifies how long to wait for the TCP connect to |
3467 | the requested server or peer to complete before Squid should | |
3468 | attempt to find another path where to forward the request. | |
057f5854 | 3469 | DOC_END |
3470 | ||
41bd17a4 | 3471 | NAME: peer_connect_timeout |
3472 | COMMENT: time-units | |
3473 | TYPE: time_t | |
3474 | LOC: Config.Timeout.peer_connect | |
3475 | DEFAULT: 30 seconds | |
cccac0a2 | 3476 | DOC_START |
41bd17a4 | 3477 | This parameter specifies how long to wait for a pending TCP |
3478 | connection to a peer cache. The default is 30 seconds. You | |
3479 | may also set different timeout values for individual neighbors | |
3480 | with the 'connect-timeout' option on a 'cache_peer' line. | |
3481 | DOC_END | |
7f7db318 | 3482 | |
41bd17a4 | 3483 | NAME: read_timeout |
3484 | COMMENT: time-units | |
3485 | TYPE: time_t | |
3486 | LOC: Config.Timeout.read | |
3487 | DEFAULT: 15 minutes | |
3488 | DOC_START | |
3489 | The read_timeout is applied on server-side connections. After | |
3490 | each successful read(), the timeout will be extended by this | |
3491 | amount. If no data is read again after this amount of time, | |
3492 | the request is aborted and logged with ERR_READ_TIMEOUT. The | |
3493 | default is 15 minutes. | |
3494 | DOC_END | |
cccac0a2 | 3495 | |
41bd17a4 | 3496 | NAME: request_timeout |
3497 | TYPE: time_t | |
3498 | LOC: Config.Timeout.request | |
3499 | DEFAULT: 5 minutes | |
3500 | DOC_START | |
3501 | How long to wait for an HTTP request after initial | |
3502 | connection establishment. | |
3503 | DOC_END | |
cccac0a2 | 3504 | |
41bd17a4 | 3505 | NAME: persistent_request_timeout |
3506 | TYPE: time_t | |
3507 | LOC: Config.Timeout.persistent_request | |
3508 | DEFAULT: 2 minutes | |
3509 | DOC_START | |
3510 | How long to wait for the next HTTP request on a persistent | |
3511 | connection after the previous request completes. | |
3512 | DOC_END | |
cccac0a2 | 3513 | |
41bd17a4 | 3514 | NAME: client_lifetime |
3515 | COMMENT: time-units | |
3516 | TYPE: time_t | |
3517 | LOC: Config.Timeout.lifetime | |
3518 | DEFAULT: 1 day | |
3519 | DOC_START | |
3520 | The maximum amount of time a client (browser) is allowed to | |
3521 | remain connected to the cache process. This protects the Cache | |
3522 | from having a lot of sockets (and hence file descriptors) tied up | |
3523 | in a CLOSE_WAIT state from remote clients that go away without | |
3524 | properly shutting down (either because of a network failure or | |
3525 | because of a poor client implementation). The default is one | |
3526 | day, 1440 minutes. | |
7d90757b | 3527 | |
41bd17a4 | 3528 | NOTE: The default value is intended to be much larger than any |
3529 | client would ever need to be connected to your cache. You | |
3530 | should probably change client_lifetime only as a last resort. | |
3531 | If you seem to have many client connections tying up | |
3532 | filedescriptors, we recommend first tuning the read_timeout, | |
3533 | request_timeout, persistent_request_timeout and quick_abort values. | |
cccac0a2 | 3534 | DOC_END |
3535 | ||
41bd17a4 | 3536 | NAME: half_closed_clients |
3537 | TYPE: onoff | |
3538 | LOC: Config.onoff.half_closed_clients | |
3539 | DEFAULT: on | |
4eb368f9 | 3540 | DOC_START |
41bd17a4 | 3541 | Some clients may shutdown the sending side of their TCP |
3542 | connections, while leaving their receiving sides open. Sometimes, | |
3543 | Squid can not tell the difference between a half-closed and a | |
3544 | fully-closed TCP connection. By default, half-closed client | |
3545 | connections are kept open until a read(2) or write(2) on the | |
3546 | socket returns an error. Change this option to 'off' and Squid | |
3547 | will immediately close client connections when read(2) returns | |
3548 | "no more data to read." | |
4eb368f9 | 3549 | DOC_END |
3550 | ||
41bd17a4 | 3551 | NAME: pconn_timeout |
3552 | TYPE: time_t | |
3553 | LOC: Config.Timeout.pconn | |
3554 | DEFAULT: 1 minute | |
cccac0a2 | 3555 | DOC_START |
41bd17a4 | 3556 | Timeout for idle persistent connections to servers and other |
3557 | proxies. | |
3558 | DOC_END | |
cccac0a2 | 3559 | |
41bd17a4 | 3560 | NAME: ident_timeout |
3561 | TYPE: time_t | |
3562 | IFDEF: USE_IDENT | |
3563 | LOC: Config.Timeout.ident | |
3564 | DEFAULT: 10 seconds | |
3565 | DOC_START | |
3566 | Maximum time to wait for IDENT lookups to complete. | |
cccac0a2 | 3567 | |
41bd17a4 | 3568 | If this is too high, and you enabled IDENT lookups from untrusted |
3569 | users, you might be susceptible to denial-of-service by having | |
3570 | many ident requests going at once. | |
cccac0a2 | 3571 | DOC_END |
3572 | ||
41bd17a4 | 3573 | NAME: shutdown_lifetime |
3574 | COMMENT: time-units | |
3575 | TYPE: time_t | |
3576 | LOC: Config.shutdownLifetime | |
3577 | DEFAULT: 30 seconds | |
cccac0a2 | 3578 | DOC_START |
41bd17a4 | 3579 | When SIGTERM or SIGHUP is received, the cache is put into |
3580 | "shutdown pending" mode until all active sockets are closed. | |
3581 | This value is the lifetime to set for all open descriptors | |
3582 | during shutdown mode. Any active clients after this many | |
3583 | seconds will receive a 'timeout' message. | |
cccac0a2 | 3584 | DOC_END |
0976f8db | 3585 | |
cccac0a2 | 3586 | COMMENT_START |
3587 | ADMINISTRATIVE PARAMETERS | |
3588 | ----------------------------------------------------------------------------- | |
3589 | COMMENT_END | |
3590 | ||
3591 | NAME: cache_mgr | |
3592 | TYPE: string | |
3593 | DEFAULT: webmaster | |
3594 | LOC: Config.adminEmail | |
3595 | DOC_START | |
3596 | Email-address of local cache manager who will receive | |
3597 | mail if the cache dies. The default is "webmaster." | |
3598 | DOC_END | |
3599 | ||
abacf776 | 3600 | NAME: mail_from |
3601 | TYPE: string | |
3602 | DEFAULT: none | |
3603 | LOC: Config.EmailFrom | |
3604 | DOC_START | |
3605 | From: email-address for mail sent when the cache dies. | |
3606 | The default is to use 'appname@unique_hostname'. | |
b8c0c06d | 3607 | Default appname value is "squid", can be changed into |
abacf776 | 3608 | src/globals.h before building squid. |
3609 | DOC_END | |
3610 | ||
d084bf20 | 3611 | NAME: mail_program |
3612 | TYPE: eol | |
3613 | DEFAULT: mail | |
3614 | LOC: Config.EmailProgram | |
3615 | DOC_START | |
3616 | Email program used to send mail if the cache dies. | |
846a5e31 | 3617 | The default is "mail". The specified program must comply |
d084bf20 | 3618 | with the standard Unix mail syntax: |
846a5e31 | 3619 | mail-program recipient < mailfile |
3620 | ||
d084bf20 | 3621 | Optional command line options can be specified. |
3622 | DOC_END | |
3623 | ||
cccac0a2 | 3624 | NAME: cache_effective_user |
3625 | TYPE: string | |
5483d916 | 3626 | DEFAULT: @DEFAULT_CACHE_EFFECTIVE_USER@ |
cccac0a2 | 3627 | LOC: Config.effectiveUser |
e3d74828 | 3628 | DOC_START |
3629 | If you start Squid as root, it will change its effective/real | |
3630 | UID/GID to the user specified below. The default is to change | |
5483d916 | 3631 | to UID of @DEFAULT_CACHE_EFFECTIVE_USER@. |
64e288bd | 3632 | see also; cache_effective_group |
e3d74828 | 3633 | DOC_END |
3634 | ||
cccac0a2 | 3635 | NAME: cache_effective_group |
3636 | TYPE: string | |
3637 | DEFAULT: none | |
3638 | LOC: Config.effectiveGroup | |
3639 | DOC_START | |
64e288bd | 3640 | Squid sets the GID to the effective user's default group ID |
3641 | (taken from the password file) and supplementary group list | |
3642 | from the groups membership. | |
3643 | ||
e3d74828 | 3644 | If you want Squid to run with a specific GID regardless of |
3645 | the group memberships of the effective user then set this | |
3646 | to the group (or GID) you want Squid to run as. When set | |
64e288bd | 3647 | all other group privileges of the effective user are ignored |
e3d74828 | 3648 | and only this GID is effective. If Squid is not started as |
64e288bd | 3649 | root the user starting Squid MUST be member of the specified |
e3d74828 | 3650 | group. |
64e288bd | 3651 | |
3652 | This option is not recommended by the Squid Team. | |
3653 | Our preference is for administrators to configure a secure | |
3654 | user account for squid with UID/GID matching system policies. | |
cccac0a2 | 3655 | DOC_END |
3656 | ||
d3caee79 | 3657 | NAME: httpd_suppress_version_string |
3658 | COMMENT: on|off | |
3659 | TYPE: onoff | |
3660 | DEFAULT: off | |
3661 | LOC: Config.onoff.httpd_suppress_version_string | |
3662 | DOC_START | |
3663 | Suppress Squid version string info in HTTP headers and HTML error pages. | |
3664 | DOC_END | |
3665 | ||
cccac0a2 | 3666 | NAME: visible_hostname |
3667 | TYPE: string | |
3668 | LOC: Config.visibleHostname | |
3669 | DEFAULT: none | |
3670 | DOC_START | |
3671 | If you want to present a special hostname in error messages, etc, | |
7f7db318 | 3672 | define this. Otherwise, the return value of gethostname() |
cccac0a2 | 3673 | will be used. If you have multiple caches in a cluster and |
3674 | get errors about IP-forwarding you must set them to have individual | |
3675 | names with this setting. | |
3676 | DOC_END | |
3677 | ||
cccac0a2 | 3678 | NAME: unique_hostname |
3679 | TYPE: string | |
3680 | LOC: Config.uniqueHostname | |
3681 | DEFAULT: none | |
3682 | DOC_START | |
3683 | If you want to have multiple machines with the same | |
7f7db318 | 3684 | 'visible_hostname' you must give each machine a different |
3685 | 'unique_hostname' so forwarding loops can be detected. | |
cccac0a2 | 3686 | DOC_END |
3687 | ||
cccac0a2 | 3688 | NAME: hostname_aliases |
3689 | TYPE: wordlist | |
3690 | LOC: Config.hostnameAliases | |
3691 | DEFAULT: none | |
3692 | DOC_START | |
7f7db318 | 3693 | A list of other DNS names your cache has. |
cccac0a2 | 3694 | DOC_END |
0976f8db | 3695 | |
c642c141 AJ |
3696 | NAME: umask |
3697 | TYPE: int | |
3698 | LOC: Config.umask | |
3699 | DEFAULT: 027 | |
3700 | DOC_START | |
3701 | Minimum umask which should be enforced while the proxy | |
3702 | is running, in addition to the umask set at startup. | |
3703 | ||
3704 | For a traditional octal representation of umasks, start | |
3705 | your value with 0. | |
3706 | DOC_END | |
3707 | ||
cccac0a2 | 3708 | COMMENT_START |
3709 | OPTIONS FOR THE CACHE REGISTRATION SERVICE | |
3710 | ----------------------------------------------------------------------------- | |
3711 | ||
3712 | This section contains parameters for the (optional) cache | |
3713 | announcement service. This service is provided to help | |
3714 | cache administrators locate one another in order to join or | |
3715 | create cache hierarchies. | |
3716 | ||
3717 | An 'announcement' message is sent (via UDP) to the registration | |
3718 | service by Squid. By default, the announcement message is NOT | |
3719 | SENT unless you enable it with 'announce_period' below. | |
3720 | ||
3721 | The announcement message includes your hostname, plus the | |
3722 | following information from this configuration file: | |
3723 | ||
3724 | http_port | |
3725 | icp_port | |
3726 | cache_mgr | |
3727 | ||
3728 | All current information is processed regularly and made | |
3729 | available on the Web at http://www.ircache.net/Cache/Tracker/. | |
3730 | COMMENT_END | |
3731 | ||
3732 | NAME: announce_period | |
3733 | TYPE: time_t | |
3734 | LOC: Config.Announce.period | |
3735 | DEFAULT: 0 | |
3736 | DOC_START | |
3737 | This is how frequently to send cache announcements. The | |
3738 | default is `0' which disables sending the announcement | |
3739 | messages. | |
3740 | ||
3741 | To enable announcing your cache, just uncomment the line | |
3742 | below. | |
3743 | ||
3744 | NOCOMMENT_START | |
9e7dbc51 | 3745 | #To enable announcing your cache, just uncomment the line below. |
3746 | #announce_period 1 day | |
cccac0a2 | 3747 | NOCOMMENT_END |
3748 | DOC_END | |
3749 | ||
cccac0a2 | 3750 | NAME: announce_host |
3751 | TYPE: string | |
3752 | DEFAULT: tracker.ircache.net | |
3753 | LOC: Config.Announce.host | |
3754 | DOC_NONE | |
3755 | ||
3756 | NAME: announce_file | |
3757 | TYPE: string | |
3758 | DEFAULT: none | |
3759 | LOC: Config.Announce.file | |
3760 | DOC_NONE | |
3761 | ||
3762 | NAME: announce_port | |
3763 | TYPE: ushort | |
3764 | DEFAULT: 3131 | |
3765 | LOC: Config.Announce.port | |
3766 | DOC_START | |
3767 | announce_host and announce_port set the hostname and port | |
3768 | number where the registration message will be sent. | |
3769 | ||
3770 | Hostname will default to 'tracker.ircache.net' and port will | |
3771 | default default to 3131. If the 'filename' argument is given, | |
3772 | the contents of that file will be included in the announce | |
3773 | message. | |
3774 | DOC_END | |
3775 | ||
8d6275c0 | 3776 | COMMENT_START |
3777 | HTTPD-ACCELERATOR OPTIONS | |
3778 | ----------------------------------------------------------------------------- | |
3779 | COMMENT_END | |
3780 | ||
cccac0a2 | 3781 | NAME: httpd_accel_surrogate_id |
f41735ea | 3782 | IFDEF: USE_SQUID_ESI |
cccac0a2 | 3783 | TYPE: string |
3784 | LOC: Config.Accel.surrogate_id | |
3785 | DEFAULT: unset-id | |
3786 | DOC_START | |
3787 | Surrogates (http://www.esi.org/architecture_spec_1.0.html) | |
3788 | need an identification token to allow control targeting. Because | |
3789 | a farm of surrogates may all perform the same tasks, they may share | |
3790 | an identification token. | |
3791 | DOC_END | |
3792 | ||
3793 | NAME: http_accel_surrogate_remote | |
f41735ea | 3794 | IFDEF: USE_SQUID_ESI |
cccac0a2 | 3795 | COMMENT: on|off |
3796 | TYPE: onoff | |
3797 | DEFAULT: off | |
3798 | LOC: Config.onoff.surrogate_is_remote | |
3799 | DOC_START | |
3800 | Remote surrogates (such as those in a CDN) honour Surrogate-Control: no-store-remote. | |
3801 | Set this to on to have squid behave as a remote surrogate. | |
3802 | DOC_END | |
3803 | ||
3804 | NAME: esi_parser | |
f41735ea | 3805 | IFDEF: USE_SQUID_ESI |
964b44c3 | 3806 | COMMENT: libxml2|expat|custom |
cccac0a2 | 3807 | TYPE: string |
3808 | LOC: ESIParser::Type | |
3809 | DEFAULT: custom | |
3810 | DOC_START | |
3811 | ESI markup is not strictly XML compatible. The custom ESI parser | |
3812 | will give higher performance, but cannot handle non ASCII character | |
3813 | encodings. | |
3814 | DOC_END | |
0976f8db | 3815 | |
9edd9041 | 3816 | COMMENT_START |
8d6275c0 | 3817 | DELAY POOL PARAMETERS |
9edd9041 | 3818 | ----------------------------------------------------------------------------- |
3819 | COMMENT_END | |
3820 | ||
3821 | NAME: delay_pools | |
3822 | TYPE: delay_pool_count | |
3823 | DEFAULT: 0 | |
3824 | IFDEF: DELAY_POOLS | |
3825 | LOC: Config.Delay | |
3826 | DOC_START | |
3827 | This represents the number of delay pools to be used. For example, | |
3828 | if you have one class 2 delay pool and one class 3 delays pool, you | |
3829 | have a total of 2 delay pools. | |
3830 | DOC_END | |
3831 | ||
3832 | NAME: delay_class | |
3833 | TYPE: delay_pool_class | |
3834 | DEFAULT: none | |
3835 | IFDEF: DELAY_POOLS | |
3836 | LOC: Config.Delay | |
3837 | DOC_START | |
3838 | This defines the class of each delay pool. There must be exactly one | |
3839 | delay_class line for each delay pool. For example, to define two | |
3840 | delay pools, one of class 2 and one of class 3, the settings above | |
3841 | and here would be: | |
3842 | ||
3843 | Example: | |
3844 | delay_pools 4 # 4 delay pools | |
3845 | delay_class 1 2 # pool 1 is a class 2 pool | |
3846 | delay_class 2 3 # pool 2 is a class 3 pool | |
3847 | delay_class 3 4 # pool 3 is a class 4 pool | |
3848 | delay_class 4 5 # pool 4 is a class 5 pool | |
3849 | ||
3850 | The delay pool classes are: | |
3851 | ||
3852 | class 1 Everything is limited by a single aggregate | |
3853 | bucket. | |
3854 | ||
3855 | class 2 Everything is limited by a single aggregate | |
3856 | bucket as well as an "individual" bucket chosen | |
3857 | from bits 25 through 32 of the IP address. | |
3858 | ||
3859 | class 3 Everything is limited by a single aggregate | |
3860 | bucket as well as a "network" bucket chosen | |
3861 | from bits 17 through 24 of the IP address and a | |
3862 | "individual" bucket chosen from bits 17 through | |
3863 | 32 of the IP address. | |
3864 | ||
3865 | class 4 Everything in a class 3 delay pool, with an | |
3866 | additional limit on a per user basis. This | |
3867 | only takes effect if the username is established | |
3868 | in advance - by forcing authentication in your | |
3869 | http_access rules. | |
3870 | ||
3871 | class 5 Requests are grouped according their tag (see | |
3872 | external_acl's tag= reply). | |
3873 | ||
3874 | NOTE: If an IP address is a.b.c.d | |
3875 | -> bits 25 through 32 are "d" | |
3876 | -> bits 17 through 24 are "c" | |
3877 | -> bits 17 through 32 are "c * 256 + d" | |
3878 | DOC_END | |
3879 | ||
3880 | NAME: delay_access | |
3881 | TYPE: delay_pool_access | |
3882 | DEFAULT: none | |
3883 | IFDEF: DELAY_POOLS | |
3884 | LOC: Config.Delay | |
3885 | DOC_START | |
3886 | This is used to determine which delay pool a request falls into. | |
3887 | ||
3888 | delay_access is sorted per pool and the matching starts with pool 1, | |
3889 | then pool 2, ..., and finally pool N. The first delay pool where the | |
3890 | request is allowed is selected for the request. If it does not allow | |
3891 | the request to any pool then the request is not delayed (default). | |
3892 | ||
3893 | For example, if you want some_big_clients in delay | |
3894 | pool 1 and lotsa_little_clients in delay pool 2: | |
3895 | ||
3896 | Example: | |
3897 | delay_access 1 allow some_big_clients | |
3898 | delay_access 1 deny all | |
3899 | delay_access 2 allow lotsa_little_clients | |
3900 | delay_access 2 deny all | |
3901 | delay_access 3 allow authenticated_clients | |
3902 | DOC_END | |
3903 | ||
3904 | NAME: delay_parameters | |
3905 | TYPE: delay_pool_rates | |
3906 | DEFAULT: none | |
3907 | IFDEF: DELAY_POOLS | |
3908 | LOC: Config.Delay | |
3909 | DOC_START | |
3910 | This defines the parameters for a delay pool. Each delay pool has | |
3911 | a number of "buckets" associated with it, as explained in the | |
3912 | description of delay_class. For a class 1 delay pool, the syntax is: | |
3913 | ||
3914 | delay_parameters pool aggregate | |
3915 | ||
3916 | For a class 2 delay pool: | |
3917 | ||
3918 | delay_parameters pool aggregate individual | |
3919 | ||
3920 | For a class 3 delay pool: | |
3921 | ||
3922 | delay_parameters pool aggregate network individual | |
3923 | ||
3924 | For a class 4 delay pool: | |
3925 | ||
3926 | delay_parameters pool aggregate network individual user | |
3927 | ||
3928 | For a class 5 delay pool: | |
3929 | ||
3930 | delay_parameters pool tag | |
3931 | ||
3932 | The variables here are: | |
3933 | ||
3934 | pool a pool number - ie, a number between 1 and the | |
3935 | number specified in delay_pools as used in | |
3936 | delay_class lines. | |
3937 | ||
3938 | aggregate the "delay parameters" for the aggregate bucket | |
3939 | (class 1, 2, 3). | |
3940 | ||
3941 | individual the "delay parameters" for the individual | |
3942 | buckets (class 2, 3). | |
3943 | ||
3944 | network the "delay parameters" for the network buckets | |
3945 | (class 3). | |
3946 | ||
3947 | user the delay parameters for the user buckets | |
3948 | (class 4). | |
3949 | ||
3950 | tag the delay parameters for the tag buckets | |
3951 | (class 5). | |
3952 | ||
3953 | A pair of delay parameters is written restore/maximum, where restore is | |
3954 | the number of bytes (not bits - modem and network speeds are usually | |
3955 | quoted in bits) per second placed into the bucket, and maximum is the | |
3956 | maximum number of bytes which can be in the bucket at any time. | |
3957 | ||
3958 | For example, if delay pool number 1 is a class 2 delay pool as in the | |
3959 | above example, and is being used to strictly limit each host to 64kbps | |
3960 | (plus overheads), with no overall limit, the line is: | |
3961 | ||
3962 | delay_parameters 1 -1/-1 8000/8000 | |
3963 | ||
3964 | Note that the figure -1 is used to represent "unlimited". | |
3965 | ||
3966 | And, if delay pool number 2 is a class 3 delay pool as in the above | |
3967 | example, and you want to limit it to a total of 256kbps (strict limit) | |
3968 | with each 8-bit network permitted 64kbps (strict limit) and each | |
3969 | individual host permitted 4800bps with a bucket maximum size of 64kb | |
3970 | to permit a decent web page to be downloaded at a decent speed | |
3971 | (if the network is not being limited due to overuse) but slow down | |
3972 | large downloads more significantly: | |
3973 | ||
3974 | delay_parameters 2 32000/32000 8000/8000 600/8000 | |
3975 | ||
3976 | There must be one delay_parameters line for each delay pool. | |
3977 | ||
3978 | Finally, for a class 4 delay pool as in the example - each user will | |
3979 | be limited to 128Kb no matter how many workstations they are logged into.: | |
3980 | ||
3981 | delay_parameters 4 32000/32000 8000/8000 600/64000 16000/16000 | |
3982 | DOC_END | |
3983 | ||
3984 | NAME: delay_initial_bucket_level | |
3985 | COMMENT: (percent, 0-100) | |
3986 | TYPE: ushort | |
3987 | DEFAULT: 50 | |
3988 | IFDEF: DELAY_POOLS | |
3989 | LOC: Config.Delay.initial | |
3990 | DOC_START | |
3991 | The initial bucket percentage is used to determine how much is put | |
3992 | in each bucket when squid starts, is reconfigured, or first notices | |
3993 | a host accessing it (in class 2 and class 3, individual hosts and | |
3994 | networks only have buckets associated with them once they have been | |
3995 | "seen" by squid). | |
3996 | DOC_END | |
3997 | ||
cccac0a2 | 3998 | COMMENT_START |
8d6275c0 | 3999 | WCCPv1 AND WCCPv2 CONFIGURATION OPTIONS |
cccac0a2 | 4000 | ----------------------------------------------------------------------------- |
4001 | COMMENT_END | |
4002 | ||
8d6275c0 | 4003 | NAME: wccp_router |
4004 | TYPE: address | |
4005 | LOC: Config.Wccp.router | |
4006 | DEFAULT: 0.0.0.0 | |
4007 | IFDEF: USE_WCCP | |
e313ab0a AJ |
4008 | DOC_START |
4009 | Use this option to define your WCCP ``home'' router for | |
4010 | Squid. | |
4011 | ||
4012 | wccp_router supports a single WCCP(v1) router | |
4013 | ||
4014 | wccp2_router supports multiple WCCPv2 routers | |
4015 | ||
4016 | only one of the two may be used at the same time and defines | |
4017 | which version of WCCP to use. | |
4018 | DOC_END | |
df2eec10 | 4019 | |
8d6275c0 | 4020 | NAME: wccp2_router |
cc192b50 | 4021 | TYPE: IPAddress_list |
8d6275c0 | 4022 | LOC: Config.Wccp2.router |
cccac0a2 | 4023 | DEFAULT: none |
8d6275c0 | 4024 | IFDEF: USE_WCCPv2 |
cccac0a2 | 4025 | DOC_START |
8d6275c0 | 4026 | Use this option to define your WCCP ``home'' router for |
4027 | Squid. | |
cccac0a2 | 4028 | |
8d6275c0 | 4029 | wccp_router supports a single WCCP(v1) router |
cccac0a2 | 4030 | |
8d6275c0 | 4031 | wccp2_router supports multiple WCCPv2 routers |
cccac0a2 | 4032 | |
8d6275c0 | 4033 | only one of the two may be used at the same time and defines |
4034 | which version of WCCP to use. | |
4035 | DOC_END | |
4036 | ||
4037 | NAME: wccp_version | |
cccac0a2 | 4038 | TYPE: int |
8d6275c0 | 4039 | LOC: Config.Wccp.version |
4040 | DEFAULT: 4 | |
4041 | IFDEF: USE_WCCP | |
cccac0a2 | 4042 | DOC_START |
8d6275c0 | 4043 | This directive is only relevant if you need to set up WCCP(v1) |
4044 | to some very old and end-of-life Cisco routers. In all other | |
4045 | setups it must be left unset or at the default setting. | |
4046 | It defines an internal version in the WCCP(v1) protocol, | |
4047 | with version 4 being the officially documented protocol. | |
cccac0a2 | 4048 | |
8d6275c0 | 4049 | According to some users, Cisco IOS 11.2 and earlier only |
4050 | support WCCP version 3. If you're using that or an earlier | |
4051 | version of IOS, you may need to change this value to 3, otherwise | |
4052 | do not specify this parameter. | |
cccac0a2 | 4053 | DOC_END |
4054 | ||
8d6275c0 | 4055 | NAME: wccp2_rebuild_wait |
4056 | TYPE: onoff | |
4057 | LOC: Config.Wccp2.rebuildwait | |
4058 | DEFAULT: on | |
4059 | IFDEF: USE_WCCPv2 | |
4060 | DOC_START | |
4061 | If this is enabled Squid will wait for the cache dir rebuild to finish | |
4062 | before sending the first wccp2 HereIAm packet | |
4063 | DOC_END | |
cccac0a2 | 4064 | |
8d6275c0 | 4065 | NAME: wccp2_forwarding_method |
e313ab0a | 4066 | TYPE: wccp2_method |
8d6275c0 | 4067 | LOC: Config.Wccp2.forwarding_method |
451c4786 | 4068 | DEFAULT: gre |
8d6275c0 | 4069 | IFDEF: USE_WCCPv2 |
cccac0a2 | 4070 | DOC_START |
699acd19 | 4071 | WCCP2 allows the setting of forwarding methods between the |
8d6275c0 | 4072 | router/switch and the cache. Valid values are as follows: |
cccac0a2 | 4073 | |
451c4786 AJ |
4074 | gre - GRE encapsulation (forward the packet in a GRE/WCCP tunnel) |
4075 | l2 - L2 redirect (forward the packet using Layer 2/MAC rewriting) | |
cccac0a2 | 4076 | |
8d6275c0 | 4077 | Currently (as of IOS 12.4) cisco routers only support GRE. |
4078 | Cisco switches only support the L2 redirect assignment method. | |
cccac0a2 | 4079 | DOC_END |
4080 | ||
8d6275c0 | 4081 | NAME: wccp2_return_method |
e313ab0a | 4082 | TYPE: wccp2_method |
8d6275c0 | 4083 | LOC: Config.Wccp2.return_method |
451c4786 | 4084 | DEFAULT: gre |
8d6275c0 | 4085 | IFDEF: USE_WCCPv2 |
cccac0a2 | 4086 | DOC_START |
699acd19 | 4087 | WCCP2 allows the setting of return methods between the |
8d6275c0 | 4088 | router/switch and the cache for packets that the cache |
4089 | decides not to handle. Valid values are as follows: | |
cccac0a2 | 4090 | |
451c4786 AJ |
4091 | gre - GRE encapsulation (forward the packet in a GRE/WCCP tunnel) |
4092 | l2 - L2 redirect (forward the packet using Layer 2/MAC rewriting) | |
cccac0a2 | 4093 | |
8d6275c0 | 4094 | Currently (as of IOS 12.4) cisco routers only support GRE. |
4095 | Cisco switches only support the L2 redirect assignment. | |
cccac0a2 | 4096 | |
699acd19 | 4097 | If the "ip wccp redirect exclude in" command has been |
8d6275c0 | 4098 | enabled on the cache interface, then it is still safe for |
4099 | the proxy server to use a l2 redirect method even if this | |
4100 | option is set to GRE. | |
cccac0a2 | 4101 | DOC_END |
4102 | ||
8d6275c0 | 4103 | NAME: wccp2_assignment_method |
451c4786 | 4104 | TYPE: wccp2_amethod |
8d6275c0 | 4105 | LOC: Config.Wccp2.assignment_method |
451c4786 | 4106 | DEFAULT: hash |
8d6275c0 | 4107 | IFDEF: USE_WCCPv2 |
cccac0a2 | 4108 | DOC_START |
8d6275c0 | 4109 | WCCP2 allows the setting of methods to assign the WCCP hash |
4110 | Valid values are as follows: | |
cccac0a2 | 4111 | |
451c4786 AJ |
4112 | hash - Hash assignment |
4113 | mask - Mask assignment | |
cccac0a2 | 4114 | |
8d6275c0 | 4115 | As a general rule, cisco routers support the hash assignment method |
4116 | and cisco switches support the mask assignment method. | |
4117 | DOC_END | |
cccac0a2 | 4118 | |
8d6275c0 | 4119 | NAME: wccp2_service |
4120 | TYPE: wccp2_service | |
4121 | LOC: Config.Wccp2.info | |
4122 | DEFAULT: none | |
4123 | DEFAULT_IF_NONE: standard 0 | |
4124 | IFDEF: USE_WCCPv2 | |
4125 | DOC_START | |
4126 | WCCP2 allows for multiple traffic services. There are two | |
4127 | types: "standard" and "dynamic". The standard type defines | |
4128 | one service id - http (id 0). The dynamic service ids can be from | |
4129 | 51 to 255 inclusive. In order to use a dynamic service id | |
4130 | one must define the type of traffic to be redirected; this is done | |
4131 | using the wccp2_service_info option. | |
4132 | ||
4133 | The "standard" type does not require a wccp2_service_info option, | |
4134 | just specifying the service id will suffice. | |
4135 | ||
4136 | MD5 service authentication can be enabled by adding | |
4137 | "password=<password>" to the end of this service declaration. | |
4138 | ||
4139 | Examples: | |
4140 | ||
4141 | wccp2_service standard 0 # for the 'web-cache' standard service | |
4142 | wccp2_service dynamic 80 # a dynamic service type which will be | |
4143 | # fleshed out with subsequent options. | |
4144 | wccp2_service standard 0 password=foo | |
8d6275c0 | 4145 | DOC_END |
4146 | ||
4147 | NAME: wccp2_service_info | |
4148 | TYPE: wccp2_service_info | |
4149 | LOC: Config.Wccp2.info | |
4150 | DEFAULT: none | |
4151 | IFDEF: USE_WCCPv2 | |
4152 | DOC_START | |
4153 | Dynamic WCCPv2 services require further information to define the | |
4154 | traffic you wish to have diverted. | |
4155 | ||
4156 | The format is: | |
4157 | ||
4158 | wccp2_service_info <id> protocol=<protocol> flags=<flag>,<flag>.. | |
4159 | priority=<priority> ports=<port>,<port>.. | |
4160 | ||
4161 | The relevant WCCPv2 flags: | |
4162 | + src_ip_hash, dst_ip_hash | |
005fe566 | 4163 | + source_port_hash, dst_port_hash |
8d6275c0 | 4164 | + src_ip_alt_hash, dst_ip_alt_hash |
4165 | + src_port_alt_hash, dst_port_alt_hash | |
4166 | + ports_source | |
4167 | ||
4168 | The port list can be one to eight entries. | |
4169 | ||
4170 | Example: | |
4171 | ||
4172 | wccp2_service_info 80 protocol=tcp flags=src_ip_hash,ports_source | |
4173 | priority=240 ports=80 | |
4174 | ||
4175 | Note: the service id must have been defined by a previous | |
4176 | 'wccp2_service dynamic <id>' entry. | |
4177 | DOC_END | |
4178 | ||
4179 | NAME: wccp2_weight | |
4180 | TYPE: int | |
4181 | LOC: Config.Wccp2.weight | |
4182 | DEFAULT: 10000 | |
4183 | IFDEF: USE_WCCPv2 | |
4184 | DOC_START | |
4185 | Each cache server gets assigned a set of the destination | |
4186 | hash proportional to their weight. | |
4187 | DOC_END | |
4188 | ||
4189 | NAME: wccp_address | |
4190 | TYPE: address | |
4191 | LOC: Config.Wccp.address | |
4192 | DEFAULT: 0.0.0.0 | |
4193 | IFDEF: USE_WCCP | |
4194 | DOC_NONE | |
df2eec10 | 4195 | |
8d6275c0 | 4196 | NAME: wccp2_address |
4197 | TYPE: address | |
4198 | LOC: Config.Wccp2.address | |
4199 | DEFAULT: 0.0.0.0 | |
4200 | IFDEF: USE_WCCPv2 | |
4201 | DOC_START | |
4202 | Use this option if you require WCCP to use a specific | |
4203 | interface address. | |
4204 | ||
4205 | The default behavior is to not bind to any specific address. | |
4206 | DOC_END | |
4207 | ||
4208 | COMMENT_START | |
4209 | PERSISTENT CONNECTION HANDLING | |
4210 | ----------------------------------------------------------------------------- | |
4211 | ||
4212 | Also see "pconn_timeout" in the TIMEOUTS section | |
4213 | COMMENT_END | |
4214 | ||
4215 | NAME: client_persistent_connections | |
4216 | TYPE: onoff | |
4217 | LOC: Config.onoff.client_pconns | |
4218 | DEFAULT: on | |
4219 | DOC_NONE | |
4220 | ||
4221 | NAME: server_persistent_connections | |
4222 | TYPE: onoff | |
4223 | LOC: Config.onoff.server_pconns | |
4224 | DEFAULT: on | |
4225 | DOC_START | |
4226 | Persistent connection support for clients and servers. By | |
4227 | default, Squid uses persistent connections (when allowed) | |
4228 | with its clients and servers. You can use these options to | |
4229 | disable persistent connections with clients and/or servers. | |
4230 | DOC_END | |
4231 | ||
4232 | NAME: persistent_connection_after_error | |
4233 | TYPE: onoff | |
4234 | LOC: Config.onoff.error_pconns | |
4235 | DEFAULT: off | |
4236 | DOC_START | |
4237 | With this directive the use of persistent connections after | |
4238 | HTTP errors can be disabled. Useful if you have clients | |
4239 | who fail to handle errors on persistent connections proper. | |
4240 | DOC_END | |
4241 | ||
4242 | NAME: detect_broken_pconn | |
4243 | TYPE: onoff | |
4244 | LOC: Config.onoff.detect_broken_server_pconns | |
4245 | DEFAULT: off | |
4246 | DOC_START | |
4247 | Some servers have been found to incorrectly signal the use | |
4248 | of HTTP/1.0 persistent connections even on replies not | |
4249 | compatible, causing significant delays. This server problem | |
4250 | has mostly been seen on redirects. | |
4251 | ||
4252 | By enabling this directive Squid attempts to detect such | |
4253 | broken replies and automatically assume the reply is finished | |
4254 | after 10 seconds timeout. | |
4255 | DOC_END | |
4256 | ||
4257 | COMMENT_START | |
4258 | CACHE DIGEST OPTIONS | |
4259 | ----------------------------------------------------------------------------- | |
4260 | COMMENT_END | |
4261 | ||
4262 | NAME: digest_generation | |
4263 | IFDEF: USE_CACHE_DIGESTS | |
4264 | TYPE: onoff | |
4265 | LOC: Config.onoff.digest_generation | |
4266 | DEFAULT: on | |
4267 | DOC_START | |
4268 | This controls whether the server will generate a Cache Digest | |
4269 | of its contents. By default, Cache Digest generation is | |
13e917b5 | 4270 | enabled if Squid is compiled with --enable-cache-digests defined. |
8d6275c0 | 4271 | DOC_END |
4272 | ||
4273 | NAME: digest_bits_per_entry | |
4274 | IFDEF: USE_CACHE_DIGESTS | |
4275 | TYPE: int | |
4276 | LOC: Config.digest.bits_per_entry | |
4277 | DEFAULT: 5 | |
4278 | DOC_START | |
4279 | This is the number of bits of the server's Cache Digest which | |
4280 | will be associated with the Digest entry for a given HTTP | |
4281 | Method and URL (public key) combination. The default is 5. | |
4282 | DOC_END | |
4283 | ||
4284 | NAME: digest_rebuild_period | |
4285 | IFDEF: USE_CACHE_DIGESTS | |
4286 | COMMENT: (seconds) | |
4287 | TYPE: time_t | |
4288 | LOC: Config.digest.rebuild_period | |
4289 | DEFAULT: 1 hour | |
4290 | DOC_START | |
749ceff8 | 4291 | This is the wait time between Cache Digest rebuilds. |
8d6275c0 | 4292 | DOC_END |
4293 | ||
4294 | NAME: digest_rewrite_period | |
4295 | COMMENT: (seconds) | |
4296 | IFDEF: USE_CACHE_DIGESTS | |
4297 | TYPE: time_t | |
4298 | LOC: Config.digest.rewrite_period | |
4299 | DEFAULT: 1 hour | |
4300 | DOC_START | |
749ceff8 | 4301 | This is the wait time between Cache Digest writes to |
8d6275c0 | 4302 | disk. |
4303 | DOC_END | |
4304 | ||
4305 | NAME: digest_swapout_chunk_size | |
4306 | COMMENT: (bytes) | |
4307 | TYPE: b_size_t | |
4308 | IFDEF: USE_CACHE_DIGESTS | |
4309 | LOC: Config.digest.swapout_chunk_size | |
4310 | DEFAULT: 4096 bytes | |
4311 | DOC_START | |
4312 | This is the number of bytes of the Cache Digest to write to | |
4313 | disk at a time. It defaults to 4096 bytes (4KB), the Squid | |
4314 | default swap page. | |
4315 | DOC_END | |
4316 | ||
4317 | NAME: digest_rebuild_chunk_percentage | |
4318 | COMMENT: (percent, 0-100) | |
4319 | IFDEF: USE_CACHE_DIGESTS | |
4320 | TYPE: int | |
4321 | LOC: Config.digest.rebuild_chunk_percentage | |
4322 | DEFAULT: 10 | |
4323 | DOC_START | |
4324 | This is the percentage of the Cache Digest to be scanned at a | |
4325 | time. By default it is set to 10% of the Cache Digest. | |
4326 | DOC_END | |
4327 | ||
1db9eacd | 4328 | COMMENT_START |
5473c134 | 4329 | SNMP OPTIONS |
1db9eacd | 4330 | ----------------------------------------------------------------------------- |
4331 | COMMENT_END | |
4332 | ||
5473c134 | 4333 | NAME: snmp_port |
4334 | TYPE: ushort | |
4335 | LOC: Config.Port.snmp | |
87630341 | 4336 | DEFAULT: 0 |
5473c134 | 4337 | IFDEF: SQUID_SNMP |
8d6275c0 | 4338 | DOC_START |
87630341 | 4339 | The port number where Squid listens for SNMP requests. To enable |
4340 | SNMP support set this to a suitable port number. Port number | |
4341 | 3401 is often used for the Squid SNMP agent. By default it's | |
4342 | set to "0" (disabled) | |
4343 | NOCOMMENT_START | |
4344 | #snmp_port 3401 | |
4345 | NOCOMMENT_END | |
8d6275c0 | 4346 | DOC_END |
4347 | ||
5473c134 | 4348 | NAME: snmp_access |
4349 | TYPE: acl_access | |
4350 | LOC: Config.accessList.snmp | |
8d6275c0 | 4351 | DEFAULT: none |
5473c134 | 4352 | DEFAULT_IF_NONE: deny all |
4353 | IFDEF: SQUID_SNMP | |
8d6275c0 | 4354 | DOC_START |
5473c134 | 4355 | Allowing or denying access to the SNMP port. |
8d6275c0 | 4356 | |
5473c134 | 4357 | All access to the agent is denied by default. |
4358 | usage: | |
8d6275c0 | 4359 | |
5473c134 | 4360 | snmp_access allow|deny [!]aclname ... |
8d6275c0 | 4361 | |
5473c134 | 4362 | Example: |
4363 | snmp_access allow snmppublic localhost | |
4364 | snmp_access deny all | |
cccac0a2 | 4365 | DOC_END |
4366 | ||
5473c134 | 4367 | NAME: snmp_incoming_address |
4368 | TYPE: address | |
4369 | LOC: Config.Addrs.snmp_incoming | |
4370 | DEFAULT: 0.0.0.0 | |
4371 | IFDEF: SQUID_SNMP | |
4372 | DOC_NONE | |
df2eec10 | 4373 | |
5473c134 | 4374 | NAME: snmp_outgoing_address |
4375 | TYPE: address | |
4376 | LOC: Config.Addrs.snmp_outgoing | |
4377 | DEFAULT: 255.255.255.255 | |
4378 | IFDEF: SQUID_SNMP | |
cccac0a2 | 4379 | DOC_START |
df2eec10 | 4380 | Just like 'udp_incoming_address', but for the SNMP port. |
cccac0a2 | 4381 | |
5473c134 | 4382 | snmp_incoming_address is used for the SNMP socket receiving |
4383 | messages from SNMP agents. | |
4384 | snmp_outgoing_address is used for SNMP packets returned to SNMP | |
4385 | agents. | |
cccac0a2 | 4386 | |
5473c134 | 4387 | The default snmp_incoming_address (0.0.0.0) is to listen on all |
4388 | available network interfaces. | |
cccac0a2 | 4389 | |
5473c134 | 4390 | If snmp_outgoing_address is set to 255.255.255.255 (the default) |
4391 | it will use the same socket as snmp_incoming_address. Only | |
4392 | change this if you want to have SNMP replies sent using another | |
4393 | address than where this Squid listens for SNMP queries. | |
cccac0a2 | 4394 | |
5473c134 | 4395 | NOTE, snmp_incoming_address and snmp_outgoing_address can not have |
4396 | the same value since they both use port 3401. | |
cccac0a2 | 4397 | DOC_END |
4398 | ||
5473c134 | 4399 | COMMENT_START |
4400 | ICP OPTIONS | |
4401 | ----------------------------------------------------------------------------- | |
4402 | COMMENT_END | |
4403 | ||
4404 | NAME: icp_port udp_port | |
4405 | TYPE: ushort | |
4406 | DEFAULT: 0 | |
4407 | LOC: Config.Port.icp | |
cccac0a2 | 4408 | DOC_START |
5473c134 | 4409 | The port number where Squid sends and receives ICP queries to |
4410 | and from neighbor caches. The standard UDP port for ICP is 3130. | |
4411 | Default is disabled (0). | |
4412 | NOCOMMENT_START | |
df2eec10 | 4413 | #icp_port @DEFAULT_ICP_PORT@ |
5473c134 | 4414 | NOCOMMENT_END |
cccac0a2 | 4415 | DOC_END |
4416 | ||
5473c134 | 4417 | NAME: htcp_port |
4418 | IFDEF: USE_HTCP | |
4419 | TYPE: ushort | |
87630341 | 4420 | DEFAULT: 0 |
5473c134 | 4421 | LOC: Config.Port.htcp |
cccac0a2 | 4422 | DOC_START |
5473c134 | 4423 | The port number where Squid sends and receives HTCP queries to |
87630341 | 4424 | and from neighbor caches. To turn it on you want to set it to |
4425 | 4827. By default it is set to "0" (disabled). | |
4426 | NOCOMMENT_START | |
4427 | #htcp_port 4827 | |
4428 | NOCOMMENT_END | |
cccac0a2 | 4429 | DOC_END |
4430 | ||
4431 | NAME: log_icp_queries | |
4432 | COMMENT: on|off | |
4433 | TYPE: onoff | |
4434 | DEFAULT: on | |
4435 | LOC: Config.onoff.log_udp | |
4436 | DOC_START | |
4437 | If set, ICP queries are logged to access.log. You may wish | |
4438 | do disable this if your ICP load is VERY high to speed things | |
4439 | up or to simplify log analysis. | |
4440 | DOC_END | |
4441 | ||
5473c134 | 4442 | NAME: udp_incoming_address |
4443 | TYPE: address | |
4444 | LOC:Config.Addrs.udp_incoming | |
4445 | DEFAULT: 0.0.0.0 | |
8524d4b2 | 4446 | DOC_START |
4447 | udp_incoming_address is used for UDP packets received from other | |
4448 | caches. | |
4449 | ||
4450 | The default behavior is to not bind to any specific address. | |
4451 | ||
4452 | Only change this if you want to have all UDP queries received on | |
4453 | a specific interface/address. | |
4454 | ||
4455 | NOTE: udp_incoming_address is used by the ICP, HTCP, and DNS | |
4456 | modules. Altering it will affect all of them in the same manner. | |
4457 | ||
4458 | see also; udp_outgoing_address | |
4459 | ||
4460 | NOTE, udp_incoming_address and udp_outgoing_address can not | |
4461 | have the same value since they both use the same port. | |
4462 | DOC_END | |
cccac0a2 | 4463 | |
5473c134 | 4464 | NAME: udp_outgoing_address |
4465 | TYPE: address | |
4466 | LOC: Config.Addrs.udp_outgoing | |
4467 | DEFAULT: 255.255.255.255 | |
cccac0a2 | 4468 | DOC_START |
8524d4b2 | 4469 | udp_outgoing_address is used for UDP packets sent out to other |
5473c134 | 4470 | caches. |
cccac0a2 | 4471 | |
5473c134 | 4472 | The default behavior is to not bind to any specific address. |
cccac0a2 | 4473 | |
8524d4b2 | 4474 | Instead it will use the same socket as udp_incoming_address. |
4475 | Only change this if you want to have UDP queries sent using another | |
4476 | address than where this Squid listens for UDP queries from other | |
5473c134 | 4477 | caches. |
4478 | ||
8524d4b2 | 4479 | NOTE: udp_outgoing_address is used by the ICP, HTCP, and DNS |
4480 | modules. Altering it will affect all of them in the same manner. | |
4481 | ||
4482 | see also; udp_incoming_address | |
4483 | ||
5473c134 | 4484 | NOTE, udp_incoming_address and udp_outgoing_address can not |
8524d4b2 | 4485 | have the same value since they both use the same port. |
cccac0a2 | 4486 | DOC_END |
4487 | ||
3d1e3e43 | 4488 | NAME: icp_hit_stale |
4489 | COMMENT: on|off | |
4490 | TYPE: onoff | |
4491 | DEFAULT: off | |
4492 | LOC: Config.onoff.icp_hit_stale | |
4493 | DOC_START | |
4494 | If you want to return ICP_HIT for stale cache objects, set this | |
4495 | option to 'on'. If you have sibling relationships with caches | |
4496 | in other administrative domains, this should be 'off'. If you only | |
4497 | have sibling relationships with caches under your control, | |
4498 | it is probably okay to set this to 'on'. | |
4499 | If set to 'on', your siblings should use the option "allow-miss" | |
4500 | on their cache_peer lines for connecting to you. | |
4501 | DOC_END | |
4502 | ||
5473c134 | 4503 | NAME: minimum_direct_hops |
cccac0a2 | 4504 | TYPE: int |
5473c134 | 4505 | DEFAULT: 4 |
4506 | LOC: Config.minDirectHops | |
cccac0a2 | 4507 | DOC_START |
5473c134 | 4508 | If using the ICMP pinging stuff, do direct fetches for sites |
4509 | which are no more than this many hops away. | |
cccac0a2 | 4510 | DOC_END |
4511 | ||
5473c134 | 4512 | NAME: minimum_direct_rtt |
4513 | TYPE: int | |
4514 | DEFAULT: 400 | |
4515 | LOC: Config.minDirectRtt | |
cccac0a2 | 4516 | DOC_START |
5473c134 | 4517 | If using the ICMP pinging stuff, do direct fetches for sites |
4518 | which are no more than this many rtt milliseconds away. | |
cccac0a2 | 4519 | DOC_END |
4520 | ||
cccac0a2 | 4521 | NAME: netdb_low |
4522 | TYPE: int | |
4523 | DEFAULT: 900 | |
4524 | LOC: Config.Netdb.low | |
4525 | DOC_NONE | |
4526 | ||
4527 | NAME: netdb_high | |
4528 | TYPE: int | |
4529 | DEFAULT: 1000 | |
4530 | LOC: Config.Netdb.high | |
4531 | DOC_START | |
4532 | The low and high water marks for the ICMP measurement | |
4533 | database. These are counts, not percents. The defaults are | |
4534 | 900 and 1000. When the high water mark is reached, database | |
4535 | entries will be deleted until the low mark is reached. | |
4536 | DOC_END | |
4537 | ||
cccac0a2 | 4538 | NAME: netdb_ping_period |
4539 | TYPE: time_t | |
4540 | LOC: Config.Netdb.period | |
4541 | DEFAULT: 5 minutes | |
4542 | DOC_START | |
4543 | The minimum period for measuring a site. There will be at | |
4544 | least this much delay between successive pings to the same | |
4545 | network. The default is five minutes. | |
4546 | DOC_END | |
4547 | ||
cccac0a2 | 4548 | NAME: query_icmp |
4549 | COMMENT: on|off | |
4550 | TYPE: onoff | |
4551 | DEFAULT: off | |
4552 | LOC: Config.onoff.query_icmp | |
4553 | DOC_START | |
4554 | If you want to ask your peers to include ICMP data in their ICP | |
4555 | replies, enable this option. | |
4556 | ||
4557 | If your peer has configured Squid (during compilation) with | |
7f7db318 | 4558 | '--enable-icmp' that peer will send ICMP pings to origin server |
4559 | sites of the URLs it receives. If you enable this option the | |
cccac0a2 | 4560 | ICP replies from that peer will include the ICMP data (if available). |
4561 | Then, when choosing a parent cache, Squid will choose the parent with | |
4562 | the minimal RTT to the origin server. When this happens, the | |
4563 | hierarchy field of the access.log will be | |
4564 | "CLOSEST_PARENT_MISS". This option is off by default. | |
4565 | DOC_END | |
4566 | ||
4567 | NAME: test_reachability | |
4568 | COMMENT: on|off | |
4569 | TYPE: onoff | |
4570 | DEFAULT: off | |
4571 | LOC: Config.onoff.test_reachability | |
4572 | DOC_START | |
4573 | When this is 'on', ICP MISS replies will be ICP_MISS_NOFETCH | |
4574 | instead of ICP_MISS if the target host is NOT in the ICMP | |
4575 | database, or has a zero RTT. | |
4576 | DOC_END | |
4577 | ||
5473c134 | 4578 | NAME: icp_query_timeout |
4579 | COMMENT: (msec) | |
4580 | DEFAULT: 0 | |
4581 | TYPE: int | |
4582 | LOC: Config.Timeout.icp_query | |
4c3ef9b2 | 4583 | DOC_START |
5473c134 | 4584 | Normally Squid will automatically determine an optimal ICP |
4585 | query timeout value based on the round-trip-time of recent ICP | |
4586 | queries. If you want to override the value determined by | |
4587 | Squid, set this 'icp_query_timeout' to a non-zero value. This | |
4588 | value is specified in MILLISECONDS, so, to use a 2-second | |
4589 | timeout (the old default), you would write: | |
4c3ef9b2 | 4590 | |
5473c134 | 4591 | icp_query_timeout 2000 |
4c3ef9b2 | 4592 | DOC_END |
4593 | ||
5473c134 | 4594 | NAME: maximum_icp_query_timeout |
4595 | COMMENT: (msec) | |
4596 | DEFAULT: 2000 | |
4597 | TYPE: int | |
4598 | LOC: Config.Timeout.icp_query_max | |
cccac0a2 | 4599 | DOC_START |
5473c134 | 4600 | Normally the ICP query timeout is determined dynamically. But |
4601 | sometimes it can lead to very large values (say 5 seconds). | |
4602 | Use this option to put an upper limit on the dynamic timeout | |
4603 | value. Do NOT use this option to always use a fixed (instead | |
4604 | of a dynamic) timeout value. To set a fixed timeout see the | |
4605 | 'icp_query_timeout' directive. | |
cccac0a2 | 4606 | DOC_END |
4607 | ||
5473c134 | 4608 | NAME: minimum_icp_query_timeout |
4609 | COMMENT: (msec) | |
4610 | DEFAULT: 5 | |
4611 | TYPE: int | |
4612 | LOC: Config.Timeout.icp_query_min | |
cccac0a2 | 4613 | DOC_START |
5473c134 | 4614 | Normally the ICP query timeout is determined dynamically. But |
4615 | sometimes it can lead to very small timeouts, even lower than | |
4616 | the normal latency variance on your link due to traffic. | |
4617 | Use this option to put an lower limit on the dynamic timeout | |
4618 | value. Do NOT use this option to always use a fixed (instead | |
4619 | of a dynamic) timeout value. To set a fixed timeout see the | |
4620 | 'icp_query_timeout' directive. | |
cccac0a2 | 4621 | DOC_END |
4622 | ||
5473c134 | 4623 | NAME: background_ping_rate |
4624 | COMMENT: time-units | |
4625 | TYPE: time_t | |
4626 | DEFAULT: 10 seconds | |
4627 | LOC: Config.backgroundPingRate | |
cccac0a2 | 4628 | DOC_START |
5473c134 | 4629 | Controls how often the ICP pings are sent to siblings that |
4630 | have background-ping set. | |
cccac0a2 | 4631 | DOC_END |
4632 | ||
5473c134 | 4633 | COMMENT_START |
4634 | MULTICAST ICP OPTIONS | |
4635 | ----------------------------------------------------------------------------- | |
4636 | COMMENT_END | |
4637 | ||
4638 | NAME: mcast_groups | |
4639 | TYPE: wordlist | |
4640 | LOC: Config.mcast_group_list | |
8c01ada0 | 4641 | DEFAULT: none |
4642 | DOC_START | |
5473c134 | 4643 | This tag specifies a list of multicast groups which your server |
4644 | should join to receive multicasted ICP queries. | |
8c01ada0 | 4645 | |
5473c134 | 4646 | NOTE! Be very careful what you put here! Be sure you |
4647 | understand the difference between an ICP _query_ and an ICP | |
4648 | _reply_. This option is to be set only if you want to RECEIVE | |
4649 | multicast queries. Do NOT set this option to SEND multicast | |
4650 | ICP (use cache_peer for that). ICP replies are always sent via | |
4651 | unicast, so this option does not affect whether or not you will | |
4652 | receive replies from multicast group members. | |
8c01ada0 | 4653 | |
5473c134 | 4654 | You must be very careful to NOT use a multicast address which |
4655 | is already in use by another group of caches. | |
8c01ada0 | 4656 | |
5473c134 | 4657 | If you are unsure about multicast, please read the Multicast |
4658 | chapter in the Squid FAQ (http://www.squid-cache.org/FAQ/). | |
8c01ada0 | 4659 | |
5473c134 | 4660 | Usage: mcast_groups 239.128.16.128 224.0.1.20 |
8c01ada0 | 4661 | |
5473c134 | 4662 | By default, Squid doesn't listen on any multicast groups. |
4663 | DOC_END | |
8c01ada0 | 4664 | |
5473c134 | 4665 | NAME: mcast_miss_addr |
4666 | IFDEF: MULTICAST_MISS_STREAM | |
4667 | TYPE: address | |
4668 | LOC: Config.mcast_miss.addr | |
4669 | DEFAULT: 255.255.255.255 | |
4670 | DOC_START | |
4671 | If you enable this option, every "cache miss" URL will | |
4672 | be sent out on the specified multicast address. | |
cccac0a2 | 4673 | |
5473c134 | 4674 | Do not enable this option unless you are are absolutely |
4675 | certain you understand what you are doing. | |
cccac0a2 | 4676 | DOC_END |
4677 | ||
5473c134 | 4678 | NAME: mcast_miss_ttl |
4679 | IFDEF: MULTICAST_MISS_STREAM | |
4680 | TYPE: ushort | |
4681 | LOC: Config.mcast_miss.ttl | |
4682 | DEFAULT: 16 | |
cccac0a2 | 4683 | DOC_START |
5473c134 | 4684 | This is the time-to-live value for packets multicasted |
4685 | when multicasting off cache miss URLs is enabled. By | |
4686 | default this is set to 'site scope', i.e. 16. | |
4687 | DOC_END | |
cccac0a2 | 4688 | |
5473c134 | 4689 | NAME: mcast_miss_port |
4690 | IFDEF: MULTICAST_MISS_STREAM | |
4691 | TYPE: ushort | |
4692 | LOC: Config.mcast_miss.port | |
4693 | DEFAULT: 3135 | |
4694 | DOC_START | |
4695 | This is the port number to be used in conjunction with | |
4696 | 'mcast_miss_addr'. | |
4697 | DOC_END | |
cccac0a2 | 4698 | |
5473c134 | 4699 | NAME: mcast_miss_encode_key |
4700 | IFDEF: MULTICAST_MISS_STREAM | |
4701 | TYPE: string | |
4702 | LOC: Config.mcast_miss.encode_key | |
4703 | DEFAULT: XXXXXXXXXXXXXXXX | |
4704 | DOC_START | |
4705 | The URLs that are sent in the multicast miss stream are | |
4706 | encrypted. This is the encryption key. | |
4707 | DOC_END | |
8c01ada0 | 4708 | |
5473c134 | 4709 | NAME: mcast_icp_query_timeout |
4710 | COMMENT: (msec) | |
4711 | DEFAULT: 2000 | |
4712 | TYPE: int | |
4713 | LOC: Config.Timeout.mcast_icp_query | |
4714 | DOC_START | |
4715 | For multicast peers, Squid regularly sends out ICP "probes" to | |
4716 | count how many other peers are listening on the given multicast | |
4717 | address. This value specifies how long Squid should wait to | |
4718 | count all the replies. The default is 2000 msec, or 2 | |
4719 | seconds. | |
cccac0a2 | 4720 | DOC_END |
4721 | ||
5473c134 | 4722 | COMMENT_START |
4723 | INTERNAL ICON OPTIONS | |
4724 | ----------------------------------------------------------------------------- | |
4725 | COMMENT_END | |
4726 | ||
cccac0a2 | 4727 | NAME: icon_directory |
4728 | TYPE: string | |
4729 | LOC: Config.icons.directory | |
4730 | DEFAULT: @DEFAULT_ICON_DIR@ | |
4731 | DOC_START | |
4732 | Where the icons are stored. These are normally kept in | |
4733 | @DEFAULT_ICON_DIR@ | |
4734 | DOC_END | |
4735 | ||
f024c970 | 4736 | NAME: global_internal_static |
4737 | TYPE: onoff | |
4738 | LOC: Config.onoff.global_internal_static | |
4739 | DEFAULT: on | |
4740 | DOC_START | |
4741 | This directive controls is Squid should intercept all requests for | |
4742 | /squid-internal-static/ no matter which host the URL is requesting | |
4743 | (default on setting), or if nothing special should be done for | |
4744 | such URLs (off setting). The purpose of this directive is to make | |
4745 | icons etc work better in complex cache hierarchies where it may | |
4746 | not always be possible for all corners in the cache mesh to reach | |
4747 | the server generating a directory listing. | |
4748 | DOC_END | |
4749 | ||
5473c134 | 4750 | NAME: short_icon_urls |
4751 | TYPE: onoff | |
4752 | LOC: Config.icons.use_short_names | |
4753 | DEFAULT: on | |
4754 | DOC_START | |
4755 | If this is enabled Squid will use short URLs for icons. | |
4756 | If disabled it will revert to the old behavior of including | |
4757 | it's own name and port in the URL. | |
4758 | ||
4759 | If you run a complex cache hierarchy with a mix of Squid and | |
4760 | other proxies you may need to disable this directive. | |
4761 | DOC_END | |
4762 | ||
4763 | COMMENT_START | |
4764 | ERROR PAGE OPTIONS | |
4765 | ----------------------------------------------------------------------------- | |
4766 | COMMENT_END | |
4767 | ||
4768 | NAME: error_directory | |
4769 | TYPE: string | |
4770 | LOC: Config.errorDirectory | |
43000484 | 4771 | DEFAULT: none |
5473c134 | 4772 | DOC_START |
4773 | If you wish to create your own versions of the default | |
43000484 AJ |
4774 | error files to customize them to suit your company copy |
4775 | the error/template files to another directory and point | |
4776 | this tag at them. | |
4777 | ||
4778 | WARNING: This option will disable multi-language support | |
4779 | on error pages if used. | |
5473c134 | 4780 | |
4781 | The squid developers are interested in making squid available in | |
4782 | a wide variety of languages. If you are making translations for a | |
43000484 | 4783 | language that Squid does not currently provide please consider |
5473c134 | 4784 | contributing your translation back to the project. |
43000484 AJ |
4785 | http://wiki.squid-cache.org/Translations |
4786 | ||
4787 | The squid developers working on translations are happy to supply drop-in | |
4788 | translated error files in exchange for any new language contributions. | |
4789 | DOC_END | |
4790 | ||
4791 | NAME: error_default_language | |
4792 | IFDEF: USE_ERR_LOCALES | |
4793 | TYPE: string | |
4794 | LOC: Config.errorDefaultLanguage | |
4795 | DEFAULT: none | |
4796 | DOC_START | |
4797 | Set the default language which squid will send error pages in | |
4798 | if no existing translation matches the clients language | |
4799 | preferences. | |
4800 | ||
4801 | If unset (default) generic English will be used. | |
4802 | ||
4803 | The squid developers are interested in making squid available in | |
4804 | a wide variety of languages. If you are interested in making | |
4805 | translations for any language see the squid wiki for details. | |
4806 | http://wiki.squid-cache.org/Translations | |
5473c134 | 4807 | DOC_END |
4808 | ||
c411820c AJ |
4809 | NAME: error_log_languages |
4810 | IFDEF: USE_ERR_LOCALES | |
4811 | TYPE: onoff | |
4812 | LOC: Config.errorLogMissingLanguages | |
4813 | DEFAULT: on | |
4814 | DOC_START | |
4815 | Log to cache.log what languages users are attempting to | |
4816 | auto-negotiate for translations. | |
4817 | ||
4818 | Successful negotiations are not logged. Only failures | |
4819 | have meaning to indicate that Squid may need an upgrade | |
4820 | of is error page translations. | |
4821 | DOC_END | |
4822 | ||
5473c134 | 4823 | NAME: err_html_text |
4824 | TYPE: eol | |
4825 | LOC: Config.errHtmlText | |
4826 | DEFAULT: none | |
4827 | DOC_START | |
4828 | HTML text to include in error messages. Make this a "mailto" | |
4829 | URL to your admin address, or maybe just a link to your | |
4830 | organizations Web page. | |
4831 | ||
4832 | To include this in your error messages, you must rewrite | |
4833 | the error template files (found in the "errors" directory). | |
4834 | Wherever you want the 'err_html_text' line to appear, | |
4835 | insert a %L tag in the error template file. | |
4836 | DOC_END | |
4837 | ||
4838 | NAME: email_err_data | |
4839 | COMMENT: on|off | |
4840 | TYPE: onoff | |
4841 | LOC: Config.onoff.emailErrData | |
4842 | DEFAULT: on | |
4843 | DOC_START | |
4844 | If enabled, information about the occurred error will be | |
4845 | included in the mailto links of the ERR pages (if %W is set) | |
4846 | so that the email body contains the data. | |
4847 | Syntax is <A HREF="mailto:%w%W">%w</A> | |
4848 | DOC_END | |
4849 | ||
4850 | NAME: deny_info | |
4851 | TYPE: denyinfo | |
4852 | LOC: Config.denyInfoList | |
4853 | DEFAULT: none | |
4854 | DOC_START | |
4855 | Usage: deny_info err_page_name acl | |
4856 | or deny_info http://... acl | |
43000484 | 4857 | or deny_info TCP_RESET acl |
5473c134 | 4858 | |
4859 | This can be used to return a ERR_ page for requests which | |
4860 | do not pass the 'http_access' rules. Squid remembers the last | |
4861 | acl it evaluated in http_access, and if a 'deny_info' line exists | |
4862 | for that ACL Squid returns a corresponding error page. | |
4863 | ||
4864 | The acl is typically the last acl on the http_access deny line which | |
4865 | denied access. The exceptions to this rule are: | |
4866 | - When Squid needs to request authentication credentials. It's then | |
4867 | the first authentication related acl encountered | |
4868 | - When none of the http_access lines matches. It's then the last | |
4869 | acl processed on the last http_access line. | |
4870 | ||
43000484 AJ |
4871 | NP: If providing your own custom error pages with error_directory |
4872 | you may also specify them by your custom file name: | |
4873 | Example: deny_info ERR_CUSTOM_ACCESS_DENIED bad_guys | |
5473c134 | 4874 | |
4875 | Alternatively you can specify an error URL. The browsers will | |
4876 | get redirected (302) to the specified URL. %s in the redirection | |
4877 | URL will be replaced by the requested URL. | |
4878 | ||
4879 | Alternatively you can tell Squid to reset the TCP connection | |
4880 | by specifying TCP_RESET. | |
4881 | DOC_END | |
4882 | ||
4883 | COMMENT_START | |
4884 | OPTIONS INFLUENCING REQUEST FORWARDING | |
4885 | ----------------------------------------------------------------------------- | |
4886 | COMMENT_END | |
4887 | ||
4888 | NAME: nonhierarchical_direct | |
e72a0ec0 | 4889 | TYPE: onoff |
5473c134 | 4890 | LOC: Config.onoff.nonhierarchical_direct |
e72a0ec0 | 4891 | DEFAULT: on |
4892 | DOC_START | |
5473c134 | 4893 | By default, Squid will send any non-hierarchical requests |
4894 | (matching hierarchy_stoplist or not cacheable request type) direct | |
4895 | to origin servers. | |
e72a0ec0 | 4896 | |
5473c134 | 4897 | If you set this to off, Squid will prefer to send these |
4898 | requests to parents. | |
0b0cfcf2 | 4899 | |
5473c134 | 4900 | Note that in most configurations, by turning this off you will only |
4901 | add latency to these request without any improvement in global hit | |
4902 | ratio. | |
0b0cfcf2 | 4903 | |
5473c134 | 4904 | If you are inside an firewall see never_direct instead of |
4905 | this directive. | |
8d6275c0 | 4906 | DOC_END |
0b0cfcf2 | 4907 | |
5473c134 | 4908 | NAME: prefer_direct |
8d6275c0 | 4909 | TYPE: onoff |
5473c134 | 4910 | LOC: Config.onoff.prefer_direct |
8d6275c0 | 4911 | DEFAULT: off |
4912 | DOC_START | |
5473c134 | 4913 | Normally Squid tries to use parents for most requests. If you for some |
4914 | reason like it to first try going direct and only use a parent if | |
4915 | going direct fails set this to on. | |
0b0cfcf2 | 4916 | |
5473c134 | 4917 | By combining nonhierarchical_direct off and prefer_direct on you |
4918 | can set up Squid to use a parent as a backup path if going direct | |
4919 | fails. | |
4920 | ||
4921 | Note: If you want Squid to use parents for all requests see | |
4922 | the never_direct directive. prefer_direct only modifies how Squid | |
4923 | acts on cacheable requests. | |
cccac0a2 | 4924 | DOC_END |
4925 | ||
5473c134 | 4926 | NAME: always_direct |
8d6275c0 | 4927 | TYPE: acl_access |
5473c134 | 4928 | LOC: Config.accessList.AlwaysDirect |
0b0cfcf2 | 4929 | DEFAULT: none |
0b0cfcf2 | 4930 | DOC_START |
5473c134 | 4931 | Usage: always_direct allow|deny [!]aclname ... |
0b0cfcf2 | 4932 | |
5473c134 | 4933 | Here you can use ACL elements to specify requests which should |
4934 | ALWAYS be forwarded by Squid to the origin servers without using | |
4935 | any peers. For example, to always directly forward requests for | |
4936 | local servers ignoring any parents or siblings you may have use | |
4937 | something like: | |
0b0cfcf2 | 4938 | |
5473c134 | 4939 | acl local-servers dstdomain my.domain.net |
4940 | always_direct allow local-servers | |
0b0cfcf2 | 4941 | |
5473c134 | 4942 | To always forward FTP requests directly, use |
f16fbc82 | 4943 | |
5473c134 | 4944 | acl FTP proto FTP |
4945 | always_direct allow FTP | |
cccac0a2 | 4946 | |
5473c134 | 4947 | NOTE: There is a similar, but opposite option named |
4948 | 'never_direct'. You need to be aware that "always_direct deny | |
4949 | foo" is NOT the same thing as "never_direct allow foo". You | |
4950 | may need to use a deny rule to exclude a more-specific case of | |
4951 | some other rule. Example: | |
8d6275c0 | 4952 | |
5473c134 | 4953 | acl local-external dstdomain external.foo.net |
4954 | acl local-servers dstdomain .foo.net | |
4955 | always_direct deny local-external | |
4956 | always_direct allow local-servers | |
8d6275c0 | 4957 | |
5473c134 | 4958 | NOTE: If your goal is to make the client forward the request |
4959 | directly to the origin server bypassing Squid then this needs | |
4960 | to be done in the client configuration. Squid configuration | |
4961 | can only tell Squid how Squid should fetch the object. | |
8d6275c0 | 4962 | |
5473c134 | 4963 | NOTE: This directive is not related to caching. The replies |
4964 | is cached as usual even if you use always_direct. To not cache | |
4965 | the replies see no_cache. | |
4966 | ||
4967 | This option replaces some v1.1 options such as local_domain | |
4968 | and local_ip. | |
cccac0a2 | 4969 | DOC_END |
0976f8db | 4970 | |
5473c134 | 4971 | NAME: never_direct |
4972 | TYPE: acl_access | |
4973 | LOC: Config.accessList.NeverDirect | |
4974 | DEFAULT: none | |
8d6275c0 | 4975 | DOC_START |
5473c134 | 4976 | Usage: never_direct allow|deny [!]aclname ... |
4977 | ||
4978 | never_direct is the opposite of always_direct. Please read | |
4979 | the description for always_direct if you have not already. | |
4980 | ||
4981 | With 'never_direct' you can use ACL elements to specify | |
4982 | requests which should NEVER be forwarded directly to origin | |
4983 | servers. For example, to force the use of a proxy for all | |
4984 | requests, except those in your local domain use something like: | |
4985 | ||
4986 | acl local-servers dstdomain .foo.net | |
5473c134 | 4987 | never_direct deny local-servers |
4988 | never_direct allow all | |
4989 | ||
4990 | or if Squid is inside a firewall and there are local intranet | |
4991 | servers inside the firewall use something like: | |
4992 | ||
4993 | acl local-intranet dstdomain .foo.net | |
4994 | acl local-external dstdomain external.foo.net | |
4995 | always_direct deny local-external | |
4996 | always_direct allow local-intranet | |
4997 | never_direct allow all | |
4998 | ||
4999 | This option replaces some v1.1 options such as inside_firewall | |
5000 | and firewall_ip. | |
8d6275c0 | 5001 | DOC_END |
0976f8db | 5002 | |
5473c134 | 5003 | COMMENT_START |
5004 | ADVANCED NETWORKING OPTIONS | |
5005 | ----------------------------------------------------------------------------- | |
5006 | COMMENT_END | |
5007 | ||
cccac0a2 | 5008 | NAME: incoming_icp_average |
5009 | TYPE: int | |
5010 | DEFAULT: 6 | |
5011 | LOC: Config.comm_incoming.icp_average | |
5012 | DOC_NONE | |
5013 | ||
5014 | NAME: incoming_http_average | |
5015 | TYPE: int | |
5016 | DEFAULT: 4 | |
5017 | LOC: Config.comm_incoming.http_average | |
5018 | DOC_NONE | |
5019 | ||
5020 | NAME: incoming_dns_average | |
5021 | TYPE: int | |
5022 | DEFAULT: 4 | |
5023 | LOC: Config.comm_incoming.dns_average | |
5024 | DOC_NONE | |
5025 | ||
5026 | NAME: min_icp_poll_cnt | |
5027 | TYPE: int | |
5028 | DEFAULT: 8 | |
5029 | LOC: Config.comm_incoming.icp_min_poll | |
5030 | DOC_NONE | |
5031 | ||
5032 | NAME: min_dns_poll_cnt | |
5033 | TYPE: int | |
5034 | DEFAULT: 8 | |
5035 | LOC: Config.comm_incoming.dns_min_poll | |
5036 | DOC_NONE | |
5037 | ||
5038 | NAME: min_http_poll_cnt | |
5039 | TYPE: int | |
5040 | DEFAULT: 8 | |
5041 | LOC: Config.comm_incoming.http_min_poll | |
5042 | DOC_START | |
5473c134 | 5043 | Heavy voodoo here. I can't even believe you are reading this. |
5044 | Are you crazy? Don't even think about adjusting these unless | |
5045 | you understand the algorithms in comm_select.c first! | |
5046 | DOC_END | |
5047 | ||
5048 | NAME: accept_filter | |
5473c134 | 5049 | TYPE: string |
5050 | DEFAULT: none | |
5051 | LOC: Config.accept_filter | |
5052 | DOC_START | |
0b4d4be5 | 5053 | FreeBSD: |
5054 | ||
5473c134 | 5055 | The name of an accept(2) filter to install on Squid's |
5056 | listen socket(s). This feature is perhaps specific to | |
5057 | FreeBSD and requires support in the kernel. | |
5058 | ||
5059 | The 'httpready' filter delays delivering new connections | |
2324cda2 | 5060 | to Squid until a full HTTP request has been received. |
0b4d4be5 | 5061 | See the accf_http(9) man page for details. |
5062 | ||
5063 | The 'dataready' filter delays delivering new connections | |
5064 | to Squid until there is some data to process. | |
5065 | See the accf_dataready(9) man page for details. | |
5066 | ||
5067 | Linux: | |
5068 | ||
5069 | The 'data' filter delays delivering of new connections | |
5070 | to Squid until there is some data to process by TCP_ACCEPT_DEFER. | |
5071 | You may optionally specify a number of seconds to wait by | |
5072 | 'data=N' where N is the number of seconds. Defaults to 30 | |
5073 | if not specified. See the tcp(7) man page for details. | |
5473c134 | 5074 | EXAMPLE: |
0b4d4be5 | 5075 | # FreeBSD |
5473c134 | 5076 | accept_filter httpready |
0b4d4be5 | 5077 | # Linux |
5078 | accept_filter data | |
5473c134 | 5079 | DOC_END |
5080 | ||
5081 | NAME: tcp_recv_bufsize | |
5082 | COMMENT: (bytes) | |
5083 | TYPE: b_size_t | |
5084 | DEFAULT: 0 bytes | |
5085 | LOC: Config.tcpRcvBufsz | |
5086 | DOC_START | |
5087 | Size of receive buffer to set for TCP sockets. Probably just | |
5088 | as easy to change your kernel's default. Set to zero to use | |
5089 | the default buffer size. | |
5090 | DOC_END | |
5091 | ||
5092 | COMMENT_START | |
5093 | ICAP OPTIONS | |
5094 | ----------------------------------------------------------------------------- | |
5095 | COMMENT_END | |
5096 | ||
5097 | NAME: icap_enable | |
5098 | TYPE: onoff | |
5099 | IFDEF: ICAP_CLIENT | |
5100 | COMMENT: on|off | |
5101 | LOC: TheICAPConfig.onoff | |
5102 | DEFAULT: off | |
5103 | DOC_START | |
53e738c6 | 5104 | If you want to enable the ICAP module support, set this to on. |
5473c134 | 5105 | DOC_END |
5106 | ||
5107 | NAME: icap_connect_timeout | |
5108 | TYPE: time_t | |
5109 | DEFAULT: none | |
5110 | LOC: TheICAPConfig.connect_timeout_raw | |
5111 | IFDEF: ICAP_CLIENT | |
5112 | DOC_START | |
5113 | This parameter specifies how long to wait for the TCP connect to | |
5114 | the requested ICAP server to complete before giving up and either | |
5115 | terminating the HTTP transaction or bypassing the failure. | |
5116 | ||
5117 | The default for optional services is peer_connect_timeout. | |
5118 | The default for essential services is connect_timeout. | |
5119 | If this option is explicitly set, its value applies to all services. | |
5120 | DOC_END | |
5121 | ||
5122 | NAME: icap_io_timeout | |
5123 | COMMENT: time-units | |
5124 | TYPE: time_t | |
5125 | DEFAULT: none | |
5126 | LOC: TheICAPConfig.io_timeout_raw | |
5127 | IFDEF: ICAP_CLIENT | |
5128 | DOC_START | |
5129 | This parameter specifies how long to wait for an I/O activity on | |
5130 | an established, active ICAP connection before giving up and | |
5131 | either terminating the HTTP transaction or bypassing the | |
5132 | failure. | |
5133 | ||
5134 | The default is read_timeout. | |
5135 | DOC_END | |
5136 | ||
5137 | NAME: icap_service_failure_limit | |
5138 | TYPE: int | |
5139 | IFDEF: ICAP_CLIENT | |
5140 | LOC: TheICAPConfig.service_failure_limit | |
5141 | DEFAULT: 10 | |
5142 | DOC_START | |
5143 | The limit specifies the number of failures that Squid tolerates | |
5144 | when establishing a new TCP connection with an ICAP service. If | |
5145 | the number of failures exceeds the limit, the ICAP service is | |
5146 | not used for new ICAP requests until it is time to refresh its | |
5147 | OPTIONS. The per-service failure counter is reset to zero each | |
5148 | time Squid fetches new service OPTIONS. | |
5149 | ||
5150 | A negative value disables the limit. Without the limit, an ICAP | |
5151 | service will not be considered down due to connectivity failures | |
5152 | between ICAP OPTIONS requests. | |
cccac0a2 | 5153 | DOC_END |
5154 | ||
5473c134 | 5155 | NAME: icap_service_revival_delay |
cccac0a2 | 5156 | TYPE: int |
5473c134 | 5157 | IFDEF: ICAP_CLIENT |
5158 | LOC: TheICAPConfig.service_revival_delay | |
5159 | DEFAULT: 180 | |
cccac0a2 | 5160 | DOC_START |
5473c134 | 5161 | The delay specifies the number of seconds to wait after an ICAP |
5162 | OPTIONS request failure before requesting the options again. The | |
5163 | failed ICAP service is considered "down" until fresh OPTIONS are | |
5164 | fetched. | |
cccac0a2 | 5165 | |
5473c134 | 5166 | The actual delay cannot be smaller than the hardcoded minimum |
5167 | delay of 30 seconds. | |
cccac0a2 | 5168 | DOC_END |
5169 | ||
5473c134 | 5170 | NAME: icap_preview_enable |
cccac0a2 | 5171 | TYPE: onoff |
5473c134 | 5172 | IFDEF: ICAP_CLIENT |
5173 | COMMENT: on|off | |
5174 | LOC: TheICAPConfig.preview_enable | |
ac7a62f9 | 5175 | DEFAULT: on |
cccac0a2 | 5176 | DOC_START |
ac7a62f9 | 5177 | The ICAP Preview feature allows the ICAP server to handle the |
5178 | HTTP message by looking only at the beginning of the message body | |
5179 | or even without receiving the body at all. In some environments, | |
5180 | previews greatly speedup ICAP processing. | |
5181 | ||
5182 | During an ICAP OPTIONS transaction, the server may tell Squid what | |
5183 | HTTP messages should be previewed and how big the preview should be. | |
5184 | Squid will not use Preview if the server did not request one. | |
5185 | ||
5186 | To disable ICAP Preview for all ICAP services, regardless of | |
5187 | individual ICAP server OPTIONS responses, set this option to "off". | |
5188 | Example: | |
5189 | icap_preview_enable off | |
cccac0a2 | 5190 | DOC_END |
5191 | ||
5473c134 | 5192 | NAME: icap_preview_size |
5193 | TYPE: int | |
5194 | IFDEF: ICAP_CLIENT | |
5195 | LOC: TheICAPConfig.preview_size | |
5196 | DEFAULT: -1 | |
cccac0a2 | 5197 | DOC_START |
53e738c6 | 5198 | The default size of preview data to be sent to the ICAP server. |
5199 | -1 means no preview. This value might be overwritten on a per server | |
5200 | basis by OPTIONS requests. | |
cccac0a2 | 5201 | DOC_END |
5202 | ||
5473c134 | 5203 | NAME: icap_default_options_ttl |
5204 | TYPE: int | |
5205 | IFDEF: ICAP_CLIENT | |
5206 | LOC: TheICAPConfig.default_options_ttl | |
5207 | DEFAULT: 60 | |
cccac0a2 | 5208 | DOC_START |
53e738c6 | 5209 | The default TTL value for ICAP OPTIONS responses that don't have |
5473c134 | 5210 | an Options-TTL header. |
cccac0a2 | 5211 | DOC_END |
5212 | ||
5473c134 | 5213 | NAME: icap_persistent_connections |
5214 | TYPE: onoff | |
5215 | IFDEF: ICAP_CLIENT | |
5216 | COMMENT: on|off | |
5217 | LOC: TheICAPConfig.reuse_connections | |
5218 | DEFAULT: on | |
cccac0a2 | 5219 | DOC_START |
5473c134 | 5220 | Whether or not Squid should use persistent connections to |
5221 | an ICAP server. | |
cccac0a2 | 5222 | DOC_END |
5223 | ||
5473c134 | 5224 | NAME: icap_send_client_ip |
5225 | TYPE: onoff | |
5226 | IFDEF: ICAP_CLIENT | |
5227 | COMMENT: on|off | |
5228 | LOC: TheICAPConfig.send_client_ip | |
5229 | DEFAULT: off | |
cccac0a2 | 5230 | DOC_START |
53e738c6 | 5231 | This adds the header "X-Client-IP" to ICAP requests. |
cccac0a2 | 5232 | DOC_END |
5233 | ||
5473c134 | 5234 | NAME: icap_send_client_username |
5235 | TYPE: onoff | |
5236 | IFDEF: ICAP_CLIENT | |
5237 | COMMENT: on|off | |
5238 | LOC: TheICAPConfig.send_client_username | |
5239 | DEFAULT: off | |
cccac0a2 | 5240 | DOC_START |
5473c134 | 5241 | This sends authenticated HTTP client username (if available) to |
5242 | the ICAP service. The username value is encoded based on the | |
5243 | icap_client_username_encode option and is sent using the header | |
5244 | specified by the icap_client_username_header option. | |
cccac0a2 | 5245 | DOC_END |
5246 | ||
5473c134 | 5247 | NAME: icap_client_username_header |
cccac0a2 | 5248 | TYPE: string |
5473c134 | 5249 | IFDEF: ICAP_CLIENT |
5250 | LOC: TheICAPConfig.client_username_header | |
5251 | DEFAULT: X-Client-Username | |
cccac0a2 | 5252 | DOC_START |
5473c134 | 5253 | ICAP request header name to use for send_client_username. |
cccac0a2 | 5254 | DOC_END |
5255 | ||
5473c134 | 5256 | NAME: icap_client_username_encode |
cccac0a2 | 5257 | TYPE: onoff |
5473c134 | 5258 | IFDEF: ICAP_CLIENT |
5259 | COMMENT: on|off | |
5260 | LOC: TheICAPConfig.client_username_encode | |
5261 | DEFAULT: off | |
cccac0a2 | 5262 | DOC_START |
5473c134 | 5263 | Whether to base64 encode the authenticated client username. |
cccac0a2 | 5264 | DOC_END |
5265 | ||
5473c134 | 5266 | NAME: icap_service |
5267 | TYPE: icap_service_type | |
5268 | IFDEF: ICAP_CLIENT | |
5269 | LOC: TheICAPConfig | |
5270 | DEFAULT: none | |
cccac0a2 | 5271 | DOC_START |
53e738c6 | 5272 | Defines a single ICAP service |
cccac0a2 | 5273 | |
53e738c6 | 5274 | icap_service servicename vectoring_point bypass service_url |
7d90757b | 5275 | |
53e738c6 | 5276 | vectoring_point = reqmod_precache|reqmod_postcache|respmod_precache|respmod_postcache |
f3db09e2 | 5277 | This specifies at which point of transaction processing the |
5278 | ICAP service should be activated. *_postcache vectoring points | |
5279 | are not yet supported. | |
53e738c6 | 5280 | bypass = 1|0 |
f3db09e2 | 5281 | If set to 1, the ICAP service is treated as optional. If the |
5282 | service cannot be reached or malfunctions, Squid will try to | |
5283 | ignore any errors and process the message as if the service | |
5284 | was not enabled. No all ICAP errors can be bypassed. | |
5285 | If set to 0, the ICAP service is treated as essential and all | |
5286 | ICAP errors will result in an error page returned to the | |
5287 | HTTP client. | |
53e738c6 | 5288 | service_url = icap://servername:port/service |
5473c134 | 5289 | |
5473c134 | 5290 | Example: |
5291 | icap_service service_1 reqmod_precache 0 icap://icap1.mydomain.net:1344/reqmod | |
5292 | icap_service service_2 respmod_precache 0 icap://icap2.mydomain.net:1344/respmod | |
cccac0a2 | 5293 | DOC_END |
5294 | ||
5473c134 | 5295 | NAME: icap_class |
5296 | TYPE: icap_class_type | |
5297 | IFDEF: ICAP_CLIENT | |
21a26d31 | 5298 | LOC: none |
5473c134 | 5299 | DEFAULT: none |
cccac0a2 | 5300 | DOC_START |
62c7f90e AR |
5301 | This depricated option was documented to define an ICAP service |
5302 | chain, even though it actually defined a set of similar, redundant | |
5303 | services, and the chains were not supported. | |
5473c134 | 5304 | |
62c7f90e AR |
5305 | To define a set of redundant services, please use the |
5306 | adaptation_service_set directive. | |
5473c134 | 5307 | |
62c7f90e AR |
5308 | If you need adaptation service chains, patches or sponsorship |
5309 | is welcome. | |
cccac0a2 | 5310 | DOC_END |
5311 | ||
5473c134 | 5312 | NAME: icap_access |
5313 | TYPE: icap_access_type | |
5314 | IFDEF: ICAP_CLIENT | |
21a26d31 | 5315 | LOC: none |
cccac0a2 | 5316 | DEFAULT: none |
cccac0a2 | 5317 | DOC_START |
62c7f90e AR |
5318 | This option is depricated. Please use adaptation_access, which |
5319 | has the same ICAP functionality, but comes with better | |
5320 | documentation, and eCAP support. | |
cccac0a2 | 5321 | DOC_END |
5322 | ||
57afc994 AR |
5323 | COMMENT_START |
5324 | eCAP OPTIONS | |
5325 | ----------------------------------------------------------------------------- | |
5326 | COMMENT_END | |
5327 | ||
21a26d31 AR |
5328 | NAME: ecap_enable |
5329 | TYPE: onoff | |
5330 | IFDEF: USE_ECAP | |
5331 | COMMENT: on|off | |
5332 | LOC: Ecap::TheConfig.onoff | |
5333 | DEFAULT: off | |
5334 | DOC_START | |
5335 | Controls whether eCAP support is enabled. | |
5336 | DOC_END | |
5337 | ||
5338 | NAME: ecap_service | |
5339 | TYPE: ecap_service_type | |
5340 | IFDEF: USE_ECAP | |
5341 | LOC: Ecap::TheConfig | |
5342 | DEFAULT: none | |
5343 | DOC_START | |
5344 | Defines a single eCAP service | |
5345 | ||
5346 | ecap_service servicename vectoring_point bypass service_url | |
5347 | ||
5348 | vectoring_point = reqmod_precache|reqmod_postcache|respmod_precache|respmod_postcache | |
5349 | This specifies at which point of transaction processing the | |
5350 | eCAP service should be activated. *_postcache vectoring points | |
5351 | are not yet supported. | |
5352 | bypass = 1|0 | |
5353 | If set to 1, the eCAP service is treated as optional. If the | |
5354 | service cannot be reached or malfunctions, Squid will try to | |
5355 | ignore any errors and process the message as if the service | |
5356 | was not enabled. No all eCAP errors can be bypassed. | |
5357 | If set to 0, the eCAP service is treated as essential and all | |
5358 | eCAP errors will result in an error page returned to the | |
5359 | HTTP client. | |
5360 | service_url = ecap://vendor/service_name?custom&cgi=style¶meters=optional | |
5361 | ||
5362 | Example: | |
5363 | ecap_service service_1 reqmod_precache 0 ecap://filters-R-us/leakDetector?on_error=block | |
5364 | ecap_service service_2 respmod_precache 1 icap://filters-R-us/virusFilter?config=/etc/vf.cfg | |
5365 | DOC_END | |
5366 | ||
57afc994 AR |
5367 | NAME: loadable_modules |
5368 | TYPE: wordlist | |
5369 | IFDEF: USE_LOADABLE_MODULES | |
5370 | LOC: Config.loadable_module_names | |
5371 | DEFAULT: none | |
5372 | DOC_START | |
5373 | Instructs Squid to load the specified dynamic module(s) or activate | |
5374 | preloaded module(s). | |
5375 | Example: | |
5376 | loadable_modules @DEFAULT_PREFIX@/lib/MinimalAdapter.so | |
5377 | DOC_END | |
5378 | ||
62c7f90e AR |
5379 | COMMENT_START |
5380 | MESSAGE ADAPTATION OPTIONS | |
5381 | ----------------------------------------------------------------------------- | |
5382 | COMMENT_END | |
5383 | ||
5384 | NAME: adaptation_service_set | |
5385 | TYPE: adaptation_service_set_type | |
5386 | IFDEF: USE_ADAPTATION | |
5387 | LOC: none | |
5388 | DEFAULT: none | |
5389 | DOC_START | |
5390 | ||
5391 | Defines a named adaptation service set. The set is populated in | |
5392 | the order of adaptation_service_set directives in this file. | |
5393 | When adaptation ACLs are processed, the first and only the first | |
5394 | applicable adaptation service from the set will be used. Thus, | |
5395 | the set should group similar, redundant services, rather than a | |
5396 | chain of complementary services. | |
5397 | ||
5398 | If you have a single adaptation service, you do not need to | |
5399 | define a set containing it because adaptation_access accepts | |
5400 | service names. | |
5401 | ||
5402 | See also: adaptation_access | |
5403 | ||
5404 | Example: | |
5405 | adaptation_service_set svcBlocker urlFilterPrimary urlFilterBackup | |
5406 | adaptation service_set svcLogger loggerLocal loggerRemote | |
5407 | DOC_END | |
5408 | ||
5409 | NAME: adaptation_access | |
5410 | TYPE: adaptation_access_type | |
5411 | IFDEF: USE_ADAPTATION | |
5412 | LOC: none | |
5413 | DEFAULT: none | |
5414 | DOC_START | |
5415 | Sends an HTTP transaction to an ICAP or eCAP adaptation service. | |
5416 | ||
5417 | adaptation_access service_name allow|deny [!]aclname... | |
5418 | adaptation_access set_name allow|deny [!]aclname... | |
5419 | ||
5420 | At each supported vectoring point, the adaptation_access | |
5421 | statements are processed in the order they appear in this | |
5422 | configuration file. Statements pointing to the following services | |
5423 | are ignored (i.e., skipped without checking their ACL): | |
5424 | ||
5425 | - services serving different vectoring points | |
5426 | - "broken-but-bypassable" services | |
5427 | - "up" services configured to ignore such transactions | |
5428 | (e.g., based on the ICAP Transfer-Ignore header). | |
5429 | ||
5430 | When a set_name is used, all services in the set are checked | |
5431 | using the same rules, to find the first applicable one. See | |
5432 | adaptation_service_set for details. | |
5433 | ||
5434 | If an access list is checked and there is a match, the | |
5435 | processing stops: For an "allow" rule, the corresponding | |
5436 | adaptation service is used for the transaction. For a "deny" | |
5437 | rule, no adaptation service is activated. | |
5438 | ||
5439 | It is currently not possible to apply more than one adaptation | |
5440 | service at the same vectoring point to the same HTTP transaction. | |
5441 | ||
5442 | See also: icap_service and ecap_service | |
5443 | ||
5444 | Example: | |
5445 | adaptation_access service_1 allow all | |
5446 | DOC_END | |
5447 | ||
5473c134 | 5448 | COMMENT_START |
5449 | DNS OPTIONS | |
5450 | ----------------------------------------------------------------------------- | |
5451 | COMMENT_END | |
5452 | ||
5453 | NAME: check_hostnames | |
cccac0a2 | 5454 | TYPE: onoff |
cccac0a2 | 5455 | DEFAULT: off |
5473c134 | 5456 | LOC: Config.onoff.check_hostnames |
cccac0a2 | 5457 | DOC_START |
5473c134 | 5458 | For security and stability reasons Squid can check |
5459 | hostnames for Internet standard RFC compliance. If you want | |
5460 | Squid to perform these checks turn this directive on. | |
cccac0a2 | 5461 | DOC_END |
5462 | ||
5473c134 | 5463 | NAME: allow_underscore |
cccac0a2 | 5464 | TYPE: onoff |
cccac0a2 | 5465 | DEFAULT: on |
5473c134 | 5466 | LOC: Config.onoff.allow_underscore |
cccac0a2 | 5467 | DOC_START |
5473c134 | 5468 | Underscore characters is not strictly allowed in Internet hostnames |
5469 | but nevertheless used by many sites. Set this to off if you want | |
5470 | Squid to be strict about the standard. | |
5471 | This check is performed only when check_hostnames is set to on. | |
cccac0a2 | 5472 | DOC_END |
5473 | ||
5473c134 | 5474 | NAME: cache_dns_program |
cccac0a2 | 5475 | TYPE: string |
5473c134 | 5476 | IFDEF: USE_DNSSERVERS |
5477 | DEFAULT: @DEFAULT_DNSSERVER@ | |
5478 | LOC: Config.Program.dnsserver | |
cccac0a2 | 5479 | DOC_START |
5473c134 | 5480 | Specify the location of the executable for dnslookup process. |
cccac0a2 | 5481 | DOC_END |
5482 | ||
5473c134 | 5483 | NAME: dns_children |
5484 | TYPE: int | |
5485 | IFDEF: USE_DNSSERVERS | |
5486 | DEFAULT: 5 | |
5487 | LOC: Config.dnsChildren | |
58850d15 | 5488 | DOC_START |
5473c134 | 5489 | The number of processes spawn to service DNS name lookups. |
5490 | For heavily loaded caches on large servers, you should | |
5491 | probably increase this value to at least 10. The maximum | |
5492 | is 32. The default is 5. | |
58850d15 | 5493 | |
5473c134 | 5494 | You must have at least one dnsserver process. |
58850d15 | 5495 | DOC_END |
5496 | ||
5473c134 | 5497 | NAME: dns_retransmit_interval |
5498 | TYPE: time_t | |
5499 | DEFAULT: 5 seconds | |
5500 | LOC: Config.Timeout.idns_retransmit | |
5501 | IFDEF: !USE_DNSSERVERS | |
cccac0a2 | 5502 | DOC_START |
5473c134 | 5503 | Initial retransmit interval for DNS queries. The interval is |
5504 | doubled each time all configured DNS servers have been tried. | |
cccac0a2 | 5505 | |
cccac0a2 | 5506 | DOC_END |
5507 | ||
5473c134 | 5508 | NAME: dns_timeout |
5509 | TYPE: time_t | |
5510 | DEFAULT: 2 minutes | |
5511 | LOC: Config.Timeout.idns_query | |
5512 | IFDEF: !USE_DNSSERVERS | |
cccac0a2 | 5513 | DOC_START |
5473c134 | 5514 | DNS Query timeout. If no response is received to a DNS query |
5515 | within this time all DNS servers for the queried domain | |
5516 | are assumed to be unavailable. | |
cccac0a2 | 5517 | DOC_END |
5518 | ||
5473c134 | 5519 | NAME: dns_defnames |
5520 | COMMENT: on|off | |
cccac0a2 | 5521 | TYPE: onoff |
cccac0a2 | 5522 | DEFAULT: off |
5473c134 | 5523 | LOC: Config.onoff.res_defnames |
cccac0a2 | 5524 | DOC_START |
5473c134 | 5525 | Normally the RES_DEFNAMES resolver option is disabled |
5526 | (see res_init(3)). This prevents caches in a hierarchy | |
5527 | from interpreting single-component hostnames locally. To allow | |
5528 | Squid to handle single-component names, enable this option. | |
cccac0a2 | 5529 | DOC_END |
5530 | ||
5473c134 | 5531 | NAME: dns_nameservers |
5532 | TYPE: wordlist | |
5533 | DEFAULT: none | |
5534 | LOC: Config.dns_nameservers | |
cccac0a2 | 5535 | DOC_START |
5473c134 | 5536 | Use this if you want to specify a list of DNS name servers |
5537 | (IP addresses) to use instead of those given in your | |
5538 | /etc/resolv.conf file. | |
5539 | On Windows platforms, if no value is specified here or in | |
5540 | the /etc/resolv.conf file, the list of DNS name servers are | |
5541 | taken from the Windows registry, both static and dynamic DHCP | |
5542 | configurations are supported. | |
cccac0a2 | 5543 | |
5473c134 | 5544 | Example: dns_nameservers 10.0.0.1 192.172.0.4 |
cccac0a2 | 5545 | DOC_END |
5546 | ||
5473c134 | 5547 | NAME: hosts_file |
cccac0a2 | 5548 | TYPE: string |
5473c134 | 5549 | DEFAULT: @DEFAULT_HOSTS@ |
5550 | LOC: Config.etcHostsPath | |
cccac0a2 | 5551 | DOC_START |
5473c134 | 5552 | Location of the host-local IP name-address associations |
5553 | database. Most Operating Systems have such a file on different | |
5554 | default locations: | |
5555 | - Un*X & Linux: /etc/hosts | |
5556 | - Windows NT/2000: %SystemRoot%\system32\drivers\etc\hosts | |
5557 | (%SystemRoot% value install default is c:\winnt) | |
5558 | - Windows XP/2003: %SystemRoot%\system32\drivers\etc\hosts | |
5559 | (%SystemRoot% value install default is c:\windows) | |
5560 | - Windows 9x/Me: %windir%\hosts | |
5561 | (%windir% value is usually c:\windows) | |
5562 | - Cygwin: /etc/hosts | |
cccac0a2 | 5563 | |
5473c134 | 5564 | The file contains newline-separated definitions, in the |
5565 | form ip_address_in_dotted_form name [name ...] names are | |
5566 | whitespace-separated. Lines beginning with an hash (#) | |
5567 | character are comments. | |
cccac0a2 | 5568 | |
5473c134 | 5569 | The file is checked at startup and upon configuration. |
5570 | If set to 'none', it won't be checked. | |
5571 | If append_domain is used, that domain will be added to | |
5572 | domain-local (i.e. not containing any dot character) host | |
5573 | definitions. | |
cccac0a2 | 5574 | DOC_END |
5575 | ||
5473c134 | 5576 | NAME: append_domain |
5577 | TYPE: string | |
5578 | LOC: Config.appendDomain | |
5579 | DEFAULT: none | |
6a2f3fcf | 5580 | DOC_START |
5473c134 | 5581 | Appends local domain name to hostnames without any dots in |
5582 | them. append_domain must begin with a period. | |
5583 | ||
5584 | Be warned there are now Internet names with no dots in | |
5585 | them using only top-domain names, so setting this may | |
5586 | cause some Internet sites to become unavailable. | |
5587 | ||
5588 | Example: | |
5589 | append_domain .yourdomain.com | |
6a2f3fcf | 5590 | DOC_END |
5591 | ||
5473c134 | 5592 | NAME: ignore_unknown_nameservers |
5593 | TYPE: onoff | |
5594 | LOC: Config.onoff.ignore_unknown_nameservers | |
df6fd596 | 5595 | DEFAULT: on |
5596 | DOC_START | |
5473c134 | 5597 | By default Squid checks that DNS responses are received |
5598 | from the same IP addresses they are sent to. If they | |
5599 | don't match, Squid ignores the response and writes a warning | |
5600 | message to cache.log. You can allow responses from unknown | |
5601 | nameservers by setting this option to 'off'. | |
df6fd596 | 5602 | DOC_END |
5603 | ||
cc192b50 | 5604 | NAME: dns_v4_fallback |
5605 | TYPE: onoff | |
5606 | DEFAULT: on | |
5607 | LOC: Config.onoff.dns_require_A | |
5608 | DOC_START | |
5609 | Standard practice with DNS is to lookup either A or AAAA records | |
5610 | and use the results if it succeeds. Only looking up the other if | |
5611 | the first attempt fails or otherwise produces no results. | |
5612 | ||
5613 | That policy however will cause squid to produce error pages for some | |
5614 | servers that advertise AAAA but are unreachable over IPv6. | |
5615 | ||
5616 | If this is ON squid will always lookup both AAAA and A, using both. | |
5617 | If this is OFF squid will lookup AAAA and only try A if none found. | |
5618 | ||
5619 | WARNING: There are some possibly unwanted side-effects with this on: | |
5620 | *) Doubles the load placed by squid on the DNS network. | |
5621 | *) May negatively impact connection delay times. | |
5622 | DOC_END | |
5623 | ||
6bc15a4f | 5624 | NAME: ipcache_size |
5625 | COMMENT: (number of entries) | |
5626 | TYPE: int | |
5627 | DEFAULT: 1024 | |
5628 | LOC: Config.ipcache.size | |
5629 | DOC_NONE | |
5630 | ||
5631 | NAME: ipcache_low | |
5632 | COMMENT: (percent) | |
5633 | TYPE: int | |
5634 | DEFAULT: 90 | |
5635 | LOC: Config.ipcache.low | |
5636 | DOC_NONE | |
5637 | ||
5638 | NAME: ipcache_high | |
5639 | COMMENT: (percent) | |
5640 | TYPE: int | |
5641 | DEFAULT: 95 | |
5642 | LOC: Config.ipcache.high | |
5643 | DOC_START | |
5644 | The size, low-, and high-water marks for the IP cache. | |
5645 | DOC_END | |
5646 | ||
5647 | NAME: fqdncache_size | |
5648 | COMMENT: (number of entries) | |
5649 | TYPE: int | |
5650 | DEFAULT: 1024 | |
5651 | LOC: Config.fqdncache.size | |
5652 | DOC_START | |
5653 | Maximum number of FQDN cache entries. | |
5654 | DOC_END | |
5655 | ||
a58ff010 | 5656 | COMMENT_START |
5473c134 | 5657 | MISCELLANEOUS |
a58ff010 | 5658 | ----------------------------------------------------------------------------- |
5659 | COMMENT_END | |
5660 | ||
5473c134 | 5661 | NAME: memory_pools |
a58ff010 | 5662 | COMMENT: on|off |
5473c134 | 5663 | TYPE: onoff |
5664 | DEFAULT: on | |
5665 | LOC: Config.onoff.mem_pools | |
a58ff010 | 5666 | DOC_START |
5473c134 | 5667 | If set, Squid will keep pools of allocated (but unused) memory |
5668 | available for future use. If memory is a premium on your | |
5669 | system and you believe your malloc library outperforms Squid | |
5670 | routines, disable this. | |
a58ff010 | 5671 | DOC_END |
5672 | ||
5473c134 | 5673 | NAME: memory_pools_limit |
5674 | COMMENT: (bytes) | |
5675 | TYPE: b_size_t | |
5676 | DEFAULT: 5 MB | |
5677 | LOC: Config.MemPools.limit | |
ec1245f8 | 5678 | DOC_START |
5473c134 | 5679 | Used only with memory_pools on: |
5680 | memory_pools_limit 50 MB | |
ec1245f8 | 5681 | |
5473c134 | 5682 | If set to a non-zero value, Squid will keep at most the specified |
5683 | limit of allocated (but unused) memory in memory pools. All free() | |
5684 | requests that exceed this limit will be handled by your malloc | |
5685 | library. Squid does not pre-allocate any memory, just safe-keeps | |
5686 | objects that otherwise would be free()d. Thus, it is safe to set | |
5687 | memory_pools_limit to a reasonably high value even if your | |
5688 | configuration will use less memory. | |
ec1245f8 | 5689 | |
5473c134 | 5690 | If set to zero, Squid will keep all memory it can. That is, there |
5691 | will be no limit on the total amount of memory used for safe-keeping. | |
ec1245f8 | 5692 | |
5473c134 | 5693 | To disable memory allocation optimization, do not set |
5694 | memory_pools_limit to 0. Set memory_pools to "off" instead. | |
5695 | ||
5696 | An overhead for maintaining memory pools is not taken into account | |
5697 | when the limit is checked. This overhead is close to four bytes per | |
5698 | object kept. However, pools may actually _save_ memory because of | |
5699 | reduced memory thrashing in your malloc library. | |
ec1245f8 | 5700 | DOC_END |
5701 | ||
5473c134 | 5702 | NAME: forwarded_for |
67c06f0d AJ |
5703 | COMMENT: on|off|transparent|truncate|delete |
5704 | TYPE: string | |
5473c134 | 5705 | DEFAULT: on |
5706 | LOC: opt_forwarded_for | |
5f8252d2 | 5707 | DOC_START |
67c06f0d AJ |
5708 | If set to "on", Squid will append your client's IP address |
5709 | in the HTTP requests it forwards. By default it looks like: | |
5f8252d2 | 5710 | |
5473c134 | 5711 | X-Forwarded-For: 192.1.2.3 |
5712 | ||
67c06f0d | 5713 | If set to "off", it will appear as |
5473c134 | 5714 | |
5715 | X-Forwarded-For: unknown | |
67c06f0d AJ |
5716 | |
5717 | If set to "transparent", Squid will not alter the | |
5718 | X-Forwarded-For header in any way. | |
5719 | ||
5720 | If set to "delete", Squid will delete the entire | |
5721 | X-Forwarded-For header. | |
5722 | ||
5723 | If set to "truncate", Squid will remove all existing | |
5724 | X-Forwarded-For entries, and place itself as the sole entry. | |
5f8252d2 | 5725 | DOC_END |
5726 | ||
5473c134 | 5727 | NAME: cachemgr_passwd |
5728 | TYPE: cachemgrpasswd | |
5729 | DEFAULT: none | |
5730 | LOC: Config.passwd_list | |
5f8252d2 | 5731 | DOC_START |
5473c134 | 5732 | Specify passwords for cachemgr operations. |
5f8252d2 | 5733 | |
5473c134 | 5734 | Usage: cachemgr_passwd password action action ... |
5735 | ||
5736 | Some valid actions are (see cache manager menu for a full list): | |
5737 | 5min | |
5738 | 60min | |
5739 | asndb | |
5740 | authenticator | |
5741 | cbdata | |
5742 | client_list | |
5743 | comm_incoming | |
5744 | config * | |
5745 | counters | |
5746 | delay | |
5747 | digest_stats | |
5748 | dns | |
5749 | events | |
5750 | filedescriptors | |
5751 | fqdncache | |
5752 | histograms | |
5753 | http_headers | |
5754 | info | |
5755 | io | |
5756 | ipcache | |
5757 | mem | |
5758 | menu | |
5759 | netdb | |
5760 | non_peers | |
5761 | objects | |
5762 | offline_toggle * | |
5763 | pconn | |
5764 | peer_select | |
b360c477 | 5765 | reconfigure * |
5473c134 | 5766 | redirector |
5767 | refresh | |
5768 | server_list | |
5769 | shutdown * | |
5770 | store_digest | |
5771 | storedir | |
5772 | utilization | |
5773 | via_headers | |
5774 | vm_objects | |
5775 | ||
5776 | * Indicates actions which will not be performed without a | |
5777 | valid password, others can be performed if not listed here. | |
5778 | ||
5779 | To disable an action, set the password to "disable". | |
5780 | To allow performing an action without a password, set the | |
5781 | password to "none". | |
5782 | ||
5783 | Use the keyword "all" to set the same password for all actions. | |
5784 | ||
5785 | Example: | |
5786 | cachemgr_passwd secret shutdown | |
5787 | cachemgr_passwd lesssssssecret info stats/objects | |
5788 | cachemgr_passwd disable all | |
5f8252d2 | 5789 | DOC_END |
5790 | ||
5473c134 | 5791 | NAME: client_db |
a58ff010 | 5792 | COMMENT: on|off |
5473c134 | 5793 | TYPE: onoff |
5794 | DEFAULT: on | |
5795 | LOC: Config.onoff.client_db | |
a58ff010 | 5796 | DOC_START |
5473c134 | 5797 | If you want to disable collecting per-client statistics, |
5798 | turn off client_db here. | |
a58ff010 | 5799 | DOC_END |
5800 | ||
5473c134 | 5801 | NAME: refresh_all_ims |
5802 | COMMENT: on|off | |
5803 | TYPE: onoff | |
5804 | DEFAULT: off | |
5805 | LOC: Config.onoff.refresh_all_ims | |
a58ff010 | 5806 | DOC_START |
5473c134 | 5807 | When you enable this option, squid will always check |
5808 | the origin server for an update when a client sends an | |
5809 | If-Modified-Since request. Many browsers use IMS | |
5810 | requests when the user requests a reload, and this | |
5811 | ensures those clients receive the latest version. | |
a58ff010 | 5812 | |
5473c134 | 5813 | By default (off), squid may return a Not Modified response |
5814 | based on the age of the cached version. | |
78e8cfc4 | 5815 | DOC_END |
5816 | ||
5473c134 | 5817 | NAME: reload_into_ims |
5818 | IFDEF: HTTP_VIOLATIONS | |
12b91c99 | 5819 | COMMENT: on|off |
5473c134 | 5820 | TYPE: onoff |
5821 | DEFAULT: off | |
5822 | LOC: Config.onoff.reload_into_ims | |
12b91c99 | 5823 | DOC_START |
5473c134 | 5824 | When you enable this option, client no-cache or ``reload'' |
5825 | requests will be changed to If-Modified-Since requests. | |
5826 | Doing this VIOLATES the HTTP standard. Enabling this | |
5827 | feature could make you liable for problems which it | |
5828 | causes. | |
5829 | ||
5830 | see also refresh_pattern for a more selective approach. | |
12b91c99 | 5831 | DOC_END |
5832 | ||
5473c134 | 5833 | NAME: maximum_single_addr_tries |
5834 | TYPE: int | |
5835 | LOC: Config.retry.maxtries | |
5836 | DEFAULT: 1 | |
a58ff010 | 5837 | DOC_START |
5473c134 | 5838 | This sets the maximum number of connection attempts for a |
5839 | host that only has one address (for multiple-address hosts, | |
5840 | each address is tried once). | |
5841 | ||
5842 | The default value is one attempt, the (not recommended) | |
5843 | maximum is 255 tries. A warning message will be generated | |
5844 | if it is set to a value greater than ten. | |
5845 | ||
5846 | Note: This is in addition to the request re-forwarding which | |
5847 | takes place if Squid fails to get a satisfying response. | |
a58ff010 | 5848 | DOC_END |
5849 | ||
5473c134 | 5850 | NAME: retry_on_error |
a58ff010 | 5851 | TYPE: onoff |
5473c134 | 5852 | LOC: Config.retry.onerror |
a58ff010 | 5853 | DEFAULT: off |
5854 | DOC_START | |
5473c134 | 5855 | If set to on Squid will automatically retry requests when |
5856 | receiving an error response. This is mainly useful if you | |
5857 | are in a complex cache hierarchy to work around access | |
5858 | control errors. | |
5f8252d2 | 5859 | DOC_END |
5860 | ||
5473c134 | 5861 | NAME: as_whois_server |
5f8252d2 | 5862 | TYPE: string |
5473c134 | 5863 | LOC: Config.as_whois_server |
5864 | DEFAULT: whois.ra.net | |
5865 | DEFAULT_IF_NONE: whois.ra.net | |
5f8252d2 | 5866 | DOC_START |
5473c134 | 5867 | WHOIS server to query for AS numbers. NOTE: AS numbers are |
5868 | queried only when Squid starts up, not for every request. | |
5f8252d2 | 5869 | DOC_END |
5870 | ||
5473c134 | 5871 | NAME: offline_mode |
5f8252d2 | 5872 | TYPE: onoff |
5473c134 | 5873 | LOC: Config.onoff.offline |
5f8252d2 | 5874 | DEFAULT: off |
5875 | DOC_START | |
5473c134 | 5876 | Enable this option and Squid will never try to validate cached |
5877 | objects. | |
a58ff010 | 5878 | DOC_END |
5879 | ||
5473c134 | 5880 | NAME: uri_whitespace |
5881 | TYPE: uri_whitespace | |
5882 | LOC: Config.uri_whitespace | |
5883 | DEFAULT: strip | |
a58ff010 | 5884 | DOC_START |
5473c134 | 5885 | What to do with requests that have whitespace characters in the |
5886 | URI. Options: | |
a58ff010 | 5887 | |
5473c134 | 5888 | strip: The whitespace characters are stripped out of the URL. |
5889 | This is the behavior recommended by RFC2396. | |
5890 | deny: The request is denied. The user receives an "Invalid | |
5891 | Request" message. | |
5892 | allow: The request is allowed and the URI is not changed. The | |
5893 | whitespace characters remain in the URI. Note the | |
5894 | whitespace is passed to redirector processes if they | |
5895 | are in use. | |
5896 | encode: The request is allowed and the whitespace characters are | |
5897 | encoded according to RFC1738. This could be considered | |
5898 | a violation of the HTTP/1.1 | |
5899 | RFC because proxies are not allowed to rewrite URI's. | |
5900 | chop: The request is allowed and the URI is chopped at the | |
5901 | first whitespace. This might also be considered a | |
5902 | violation. | |
5903 | DOC_END | |
a58ff010 | 5904 | |
5473c134 | 5905 | NAME: coredump_dir |
5906 | TYPE: string | |
5907 | LOC: Config.coredump_dir | |
5908 | DEFAULT: none | |
5909 | DEFAULT_IF_NONE: none | |
5910 | DOC_START | |
5911 | By default Squid leaves core files in the directory from where | |
5912 | it was started. If you set 'coredump_dir' to a directory | |
5913 | that exists, Squid will chdir() to that directory at startup | |
5914 | and coredump files will be left there. | |
a58ff010 | 5915 | |
5473c134 | 5916 | NOCOMMENT_START |
5917 | # Leave coredumps in the first cache dir | |
5918 | coredump_dir @DEFAULT_SWAP_DIR@ | |
5919 | NOCOMMENT_END | |
5920 | DOC_END | |
a58ff010 | 5921 | |
5473c134 | 5922 | NAME: chroot |
5923 | TYPE: string | |
5924 | LOC: Config.chroot_dir | |
a58ff010 | 5925 | DEFAULT: none |
5926 | DOC_START | |
5473c134 | 5927 | Use this to have Squid do a chroot() while initializing. This |
5928 | also causes Squid to fully drop root privileges after | |
5929 | initializing. This means, for example, if you use a HTTP | |
5930 | port less than 1024 and try to reconfigure, you will may get an | |
5931 | error saying that Squid can not open the port. | |
5932 | DOC_END | |
a58ff010 | 5933 | |
5473c134 | 5934 | NAME: balance_on_multiple_ip |
5935 | TYPE: onoff | |
5936 | LOC: Config.onoff.balance_on_multiple_ip | |
cc192b50 | 5937 | DEFAULT: off |
5473c134 | 5938 | DOC_START |
cc192b50 | 5939 | Modern IP resolvers in squid sort lookup results by preferred access. |
5940 | By default squid will use these IP in order and only rotates to | |
5941 | the next listed when the most preffered fails. | |
5942 | ||
5473c134 | 5943 | Some load balancing servers based on round robin DNS have been |
5944 | found not to preserve user session state across requests | |
5945 | to different IP addresses. | |
a58ff010 | 5946 | |
cc192b50 | 5947 | Enabling this directive Squid rotates IP's per request. |
a58ff010 | 5948 | DOC_END |
5949 | ||
5473c134 | 5950 | NAME: pipeline_prefetch |
5951 | TYPE: onoff | |
5952 | LOC: Config.onoff.pipeline_prefetch | |
5953 | DEFAULT: off | |
a58ff010 | 5954 | DOC_START |
5473c134 | 5955 | To boost the performance of pipelined requests to closer |
5956 | match that of a non-proxied environment Squid can try to fetch | |
5957 | up to two requests in parallel from a pipeline. | |
a58ff010 | 5958 | |
5473c134 | 5959 | Defaults to off for bandwidth management and access logging |
5960 | reasons. | |
5961 | DOC_END | |
a58ff010 | 5962 | |
5473c134 | 5963 | NAME: high_response_time_warning |
5964 | TYPE: int | |
5965 | COMMENT: (msec) | |
5966 | LOC: Config.warnings.high_rptm | |
5967 | DEFAULT: 0 | |
5968 | DOC_START | |
5969 | If the one-minute median response time exceeds this value, | |
5970 | Squid prints a WARNING with debug level 0 to get the | |
5971 | administrators attention. The value is in milliseconds. | |
a58ff010 | 5972 | DOC_END |
5973 | ||
5473c134 | 5974 | NAME: high_page_fault_warning |
5975 | TYPE: int | |
5976 | LOC: Config.warnings.high_pf | |
5977 | DEFAULT: 0 | |
cc9f92d4 | 5978 | DOC_START |
5473c134 | 5979 | If the one-minute average page fault rate exceeds this |
5980 | value, Squid prints a WARNING with debug level 0 to get | |
5981 | the administrators attention. The value is in page faults | |
5982 | per second. | |
5983 | DOC_END | |
cc9f92d4 | 5984 | |
5473c134 | 5985 | NAME: high_memory_warning |
5986 | TYPE: b_size_t | |
5987 | LOC: Config.warnings.high_memory | |
904971da | 5988 | DEFAULT: 0 KB |
5473c134 | 5989 | DOC_START |
5990 | If the memory usage (as determined by mallinfo) exceeds | |
904971da | 5991 | this amount, Squid prints a WARNING with debug level 0 to get |
5473c134 | 5992 | the administrators attention. |
5993 | DOC_END | |
cc9f92d4 | 5994 | |
5473c134 | 5995 | NAME: sleep_after_fork |
5996 | COMMENT: (microseconds) | |
5997 | TYPE: int | |
5998 | LOC: Config.sleep_after_fork | |
5999 | DEFAULT: 0 | |
6000 | DOC_START | |
6001 | When this is set to a non-zero value, the main Squid process | |
6002 | sleeps the specified number of microseconds after a fork() | |
6003 | system call. This sleep may help the situation where your | |
6004 | system reports fork() failures due to lack of (virtual) | |
6005 | memory. Note, however, if you have a lot of child | |
6006 | processes, these sleep delays will add up and your | |
6007 | Squid will not service requests for some amount of time | |
6008 | until all the child processes have been started. | |
6009 | On Windows value less then 1000 (1 milliseconds) are | |
6010 | rounded to 1000. | |
cc9f92d4 | 6011 | DOC_END |
6012 | ||
b6696974 GS |
6013 | NAME: windows_ipaddrchangemonitor |
6014 | COMMENT: on|off | |
6015 | TYPE: onoff | |
6016 | DEFAULT: on | |
6017 | LOC: Config.onoff.WIN32_IpAddrChangeMonitor | |
6018 | DOC_START | |
6019 | On Windows Squid by default will monitor IP address changes and will | |
6020 | reconfigure itself after any detected event. This is very useful for | |
6021 | proxies connected to internet with dial-up interfaces. | |
6022 | In some cases (a Proxy server acting as VPN gateway is one) it could be | |
6023 | desiderable to disable this behaviour setting this to 'off'. | |
6024 | Note: after changing this, Squid service must be restarted. | |
6025 | DOC_END | |
6026 | ||
cccac0a2 | 6027 | EOF |