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