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