]>
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 | ---------------------------- |
5945964d AJ |
32 | |
33 | This is the documentation for the Squid configuration file. | |
34 | This documentation can also be found online at: | |
35 | http://www.squid-cache.org/Doc/config/ | |
36 | ||
37 | You may wish to look at the Squid home page and wiki for the | |
38 | FAQ and other documentation: | |
39 | http://www.squid-cache.org/ | |
40 | http://wiki.squid-cache.org/SquidFaq | |
41 | http://wiki.squid-cache.org/ConfigExamples | |
42 | ||
43 | This documentation shows what the defaults for various directives | |
44 | happen to be. If you don't need to change the default, you should | |
45 | leave the line out of your squid.conf in most cases. | |
46 | ||
47 | In some cases "none" refers to no default setting at all, | |
48 | while in other cases it refers to the value of the option | |
49 | - the comments for that keyword indicate if this is the case. | |
debd9a31 | 50 | |
cccac0a2 | 51 | COMMENT_END |
3a278cb8 | 52 | |
592a09dc | 53 | COMMENT_START |
54 | Configuration options can be included using the "include" directive. | |
5945964d | 55 | Include takes a list of files to include. Quoting and wildcards are |
592a09dc | 56 | supported. |
57 | ||
58 | For example, | |
59 | ||
60 | include /path/to/included/file/squid.acl.config | |
61 | ||
62 | Includes can be nested up to a hard-coded depth of 16 levels. | |
63 | This arbitrary restriction is to prevent recursive include references | |
64 | from causing Squid entering an infinite loop whilst trying to load | |
65 | configuration files. | |
d4a3e179 AR |
66 | |
67 | ||
2eceb328 CT |
68 | Values with spaces, quotes, and other special characters |
69 | ||
70 | Squid supports directive parameters with spaces, quotes, and other | |
71 | special characters. Surround such parameters with "double quotes". Use | |
72 | the configuration_includes_quoted_values directive to enable or | |
73 | disable that support. | |
74 | ||
75 | Squid supports reading configuration option parameters from external | |
76 | files using the syntax: | |
77 | parameters("/path/filename") | |
78 | For example: | |
79 | acl whitelist dstdomain parameters("/etc/squid/whitelist.txt") | |
80 | ||
5735d30b AR |
81 | Conditional configuration |
82 | ||
83 | If-statements can be used to make configuration directives | |
84 | depend on conditions: | |
85 | ||
86 | if <CONDITION> | |
87 | ... regular configuration directives ... | |
88 | [else | |
89 | ... regular configuration directives ...] | |
90 | endif | |
91 | ||
92 | The else part is optional. The keywords "if", "else", and "endif" | |
93 | must be typed on their own lines, as if they were regular | |
94 | configuration directives. | |
95 | ||
5945964d AJ |
96 | NOTE: An else-if condition is not supported. |
97 | ||
5735d30b AR |
98 | These individual conditions types are supported: |
99 | ||
100 | true | |
101 | Always evaluates to true. | |
102 | false | |
103 | Always evaluates to false. | |
104 | <integer> = <integer> | |
105 | Equality comparison of two integer numbers. | |
106 | ||
107 | ||
d4a3e179 AR |
108 | SMP-Related Macros |
109 | ||
110 | The following SMP-related preprocessor macros can be used. | |
111 | ||
112 | ${process_name} expands to the current Squid process "name" | |
113 | (e.g., squid1, squid2, or cache1). | |
114 | ||
115 | ${process_number} expands to the current Squid process | |
116 | identifier, which is an integer number (e.g., 1, 2, 3) unique | |
6fe8c876 AJ |
117 | across all Squid processes of the current service instance. |
118 | ||
119 | ${service_name} expands into the current Squid service instance | |
120 | name identifier which is provided by -n on the command line. | |
121 | ||
592a09dc | 122 | COMMENT_END |
123 | ||
25234ebd AJ |
124 | # options still not yet ported from 2.7 to 3.x |
125 | NAME: broken_vary_encoding | |
126 | TYPE: obsolete | |
127 | DOC_START | |
128 | This option is not yet supported by Squid-3. | |
129 | DOC_END | |
130 | ||
131 | NAME: cache_vary | |
132 | TYPE: obsolete | |
133 | DOC_START | |
134 | This option is not yet supported by Squid-3. | |
135 | DOC_END | |
136 | ||
25234ebd AJ |
137 | NAME: error_map |
138 | TYPE: obsolete | |
139 | DOC_START | |
140 | This option is not yet supported by Squid-3. | |
141 | DOC_END | |
142 | ||
143 | NAME: external_refresh_check | |
144 | TYPE: obsolete | |
145 | DOC_START | |
146 | This option is not yet supported by Squid-3. | |
147 | DOC_END | |
148 | ||
96598f93 | 149 | NAME: location_rewrite_program location_rewrite_access location_rewrite_children location_rewrite_concurrency |
25234ebd AJ |
150 | TYPE: obsolete |
151 | DOC_START | |
152 | This option is not yet supported by Squid-3. | |
153 | DOC_END | |
154 | ||
96598f93 | 155 | NAME: refresh_stale_hit |
25234ebd AJ |
156 | TYPE: obsolete |
157 | DOC_START | |
158 | This option is not yet supported by Squid-3. | |
159 | DOC_END | |
160 | ||
96598f93 AJ |
161 | # Options Removed in 3.3 |
162 | NAME: ignore_ims_on_miss | |
25234ebd AJ |
163 | TYPE: obsolete |
164 | DOC_START | |
96598f93 | 165 | Remove this line. The HTTP/1.1 feature is now fully supported by default. |
25234ebd AJ |
166 | DOC_END |
167 | ||
76f44481 AJ |
168 | # Options Removed in 3.2 |
169 | NAME: ignore_expect_100 | |
170 | TYPE: obsolete | |
171 | DOC_START | |
172 | Remove this line. The HTTP/1.1 feature is now fully supported by default. | |
173 | DOC_END | |
174 | ||
6e095b46 AJ |
175 | NAME: dns_v4_fallback |
176 | TYPE: obsolete | |
177 | DOC_START | |
4ded749e | 178 | Remove this line. Squid performs a 'Happy Eyeballs' algorithm, the 'fallback' algorithm is no longer relevant. |
6e095b46 AJ |
179 | DOC_END |
180 | ||
76f44481 AJ |
181 | NAME: ftp_list_width |
182 | TYPE: obsolete | |
183 | DOC_START | |
184 | Remove this line. Configure FTP page display using the CSS controls in errorpages.css instead. | |
185 | DOC_END | |
186 | ||
38493d67 AJ |
187 | NAME: maximum_single_addr_tries |
188 | TYPE: obsolete | |
189 | DOC_START | |
190 | Replaced by connect_retries. The behaviour has changed, please read the documentation before altering. | |
191 | DOC_END | |
192 | ||
4ded749e AJ |
193 | NAME: update_headers |
194 | TYPE: obsolete | |
195 | DOC_START | |
196 | Remove this line. The feature is supported by default in storage types where update is implemented. | |
197 | DOC_END | |
198 | ||
76f44481 AJ |
199 | NAME: url_rewrite_concurrency |
200 | TYPE: obsolete | |
201 | DOC_START | |
202 | Remove this line. Set the 'concurrency=' option of url_rewrite_children instead. | |
203 | DOC_END | |
204 | ||
205 | # Options Removed in 3.1 | |
206 | NAME: dns_testnames | |
207 | TYPE: obsolete | |
208 | DOC_START | |
209 | Remove this line. DNS is no longer tested on startup. | |
210 | DOC_END | |
211 | ||
212 | NAME: extension_methods | |
213 | TYPE: obsolete | |
214 | DOC_START | |
215 | Remove this line. All valid methods for HTTP are accepted by default. | |
216 | DOC_END | |
217 | ||
c72a2049 AJ |
218 | # 2.7 Options Removed/Replaced in 3.2 |
219 | NAME: zero_buffers | |
220 | TYPE: obsolete | |
221 | DOC_NONE | |
222 | ||
76f44481 AJ |
223 | # 2.7 Options Removed/Replaced in 3.1 |
224 | NAME: incoming_rate | |
225 | TYPE: obsolete | |
226 | DOC_NONE | |
227 | ||
228 | NAME: server_http11 | |
229 | TYPE: obsolete | |
230 | DOC_START | |
231 | Remove this line. HTTP/1.1 is supported by default. | |
232 | DOC_END | |
233 | ||
234 | NAME: upgrade_http0.9 | |
235 | TYPE: obsolete | |
236 | DOC_START | |
237 | Remove this line. ICY/1.0 streaming protocol is supported by default. | |
238 | DOC_END | |
239 | ||
240 | NAME: zph_local zph_mode zph_option zph_parent zph_sibling | |
241 | TYPE: obsolete | |
242 | DOC_START | |
243 | Alter these entries. Use the qos_flows directive instead. | |
244 | DOC_END | |
245 | ||
246 | # Options Removed in 3.0 | |
247 | NAME: header_access | |
248 | TYPE: obsolete | |
249 | DOC_START | |
250 | Since squid-3.0 replace with request_header_access or reply_header_access | |
251 | depending on whether you wish to match client requests or server replies. | |
252 | DOC_END | |
253 | ||
254 | NAME: httpd_accel_no_pmtu_disc | |
255 | TYPE: obsolete | |
256 | DOC_START | |
257 | Since squid-3.0 use the 'disable-pmtu-discovery' flag on http_port instead. | |
258 | DOC_END | |
259 | ||
3b31a711 AJ |
260 | NAME: wais_relay_host |
261 | TYPE: obsolete | |
262 | DOC_START | |
263 | Replace this line with 'cache_peer' configuration. | |
264 | DOC_END | |
265 | ||
266 | NAME: wais_relay_port | |
267 | TYPE: obsolete | |
268 | DOC_START | |
269 | Replace this line with 'cache_peer' configuration. | |
270 | DOC_END | |
271 | ||
5473c134 | 272 | COMMENT_START |
41bd17a4 | 273 | OPTIONS FOR AUTHENTICATION |
5473c134 | 274 | ----------------------------------------------------------------------------- |
275 | COMMENT_END | |
276 | ||
41bd17a4 | 277 | NAME: auth_param |
278 | TYPE: authparam | |
2f1431ea | 279 | IFDEF: USE_AUTH |
5817ee13 | 280 | LOC: Auth::TheConfig |
cccac0a2 | 281 | DEFAULT: none |
282 | DOC_START | |
41bd17a4 | 283 | This is used to define parameters for the various authentication |
284 | schemes supported by Squid. | |
cccac0a2 | 285 | |
41bd17a4 | 286 | format: auth_param scheme parameter [setting] |
cccac0a2 | 287 | |
41bd17a4 | 288 | The order in which authentication schemes are presented to the client is |
289 | dependent on the order the scheme first appears in config file. IE | |
290 | has a bug (it's not RFC 2617 compliant) in that it will use the basic | |
291 | scheme if basic is the first entry presented, even if more secure | |
292 | schemes are presented. For now use the order in the recommended | |
293 | settings section below. If other browsers have difficulties (don't | |
294 | recognize the schemes offered even if you are using basic) either | |
295 | put basic first, or disable the other schemes (by commenting out their | |
296 | program entry). | |
cccac0a2 | 297 | |
41bd17a4 | 298 | Once an authentication scheme is fully configured, it can only be |
299 | shutdown by shutting squid down and restarting. Changes can be made on | |
300 | the fly and activated with a reconfigure. I.E. You can change to a | |
301 | different helper, but not unconfigure the helper completely. | |
cccac0a2 | 302 | |
41bd17a4 | 303 | Please note that while this directive defines how Squid processes |
304 | authentication it does not automatically activate authentication. | |
305 | To use authentication you must in addition make use of ACLs based | |
306 | on login name in http_access (proxy_auth, proxy_auth_regex or | |
307 | external with %LOGIN used in the format tag). The browser will be | |
308 | challenged for authentication on the first such acl encountered | |
309 | in http_access processing and will also be re-challenged for new | |
310 | login credentials if the request is being denied by a proxy_auth | |
311 | type acl. | |
cccac0a2 | 312 | |
41bd17a4 | 313 | WARNING: authentication can't be used in a transparently intercepting |
314 | proxy as the client then thinks it is talking to an origin server and | |
315 | not the proxy. This is a limitation of bending the TCP/IP protocol to | |
316 | transparently intercepting port 80, not a limitation in Squid. | |
b3567eb5 FC |
317 | Ports flagged 'transparent', 'intercept', or 'tproxy' have |
318 | authentication disabled. | |
cccac0a2 | 319 | |
d4806c91 CT |
320 | === Parameters common to all schemes. === |
321 | ||
322 | "program" cmdline | |
323 | Specifies the command for the external authenticator. Such a program | |
324 | runs a loop that, on every iteration, reads a request line from | |
325 | the standard and responds with a scheme-specific answer. The loop | |
326 | stops when all input is exchausted (EOF). See scheme-specific | |
327 | "program" descriptions below for details. | |
328 | ||
329 | "key_extras" format | |
330 | Specifies a string to be append to request line format for the | |
331 | authentication helper. "Quoted" format values may contain spaces and | |
332 | logformat %macros. In theory, any logformat %macro can be used. | |
333 | In practice, a %macro expands as a dash (-) if the helper request is | |
334 | sent before the required macro information is available to Squid. | |
335 | By default, Squid uses request formats provided in scheme-specific | |
336 | examples below (search for %credentials). | |
b853db41 CT |
337 | The expanded key_extras value is added to the Squid credentials |
338 | cache and, hence, will affect authentication. It can be used to | |
339 | autenticate different users with identical user names (e.g., when user | |
340 | authentication depends on http_port). | |
341 | Avoid adding frequently changing information to key_extras. For | |
342 | example, if you add user source IP, and it changes frequently | |
343 | in your environment, then max_user_ip ACL is going to treat every | |
344 | user+IP combination as a unique "user", breaking the ACL and | |
345 | wasting a lot of memory on those user records. It will also force | |
346 | users to authenticate from scratch whenever their IP changes. | |
d4806c91 | 347 | |
41bd17a4 | 348 | === Parameters for the basic scheme follow. === |
cccac0a2 | 349 | |
41bd17a4 | 350 | "program" cmdline |
351 | Specify the command for the external authenticator. Such a program | |
d4806c91 CT |
352 | reads a request_format line ("username password" by default) and |
353 | replies with one of three results: | |
5269ec0e AJ |
354 | |
355 | OK | |
356 | the user exists. | |
357 | ||
358 | ERR | |
359 | the user does not exist. | |
360 | ||
361 | BH | |
4ded749e | 362 | An internal error occurred in the helper, preventing |
5269ec0e AJ |
363 | a result being identified. |
364 | ||
365 | "ERR" and "BH" results may optionally be followed by message="..." | |
366 | containing a description available as %m in the returned error page. | |
367 | ||
b3567eb5 FC |
368 | If you use an authenticator, make sure you have 1 acl of type |
369 | proxy_auth. | |
cccac0a2 | 370 | |
41bd17a4 | 371 | By default, the basic authentication scheme is not used unless a |
372 | program is specified. | |
cccac0a2 | 373 | |
41bd17a4 | 374 | If you want to use the traditional NCSA proxy authentication, set |
375 | this line to something like | |
307b83b7 | 376 | |
f6c0fef2 | 377 | auth_param basic program @DEFAULT_PREFIX@/libexec/basic_ncsa_auth @DEFAULT_PREFIX@/etc/passwd |
9e7dbc51 | 378 | |
d2a89ac1 | 379 | "utf8" on|off |
4ded749e | 380 | HTTP uses iso-latin-1 as character set, while some authentication |
d2a89ac1 AJ |
381 | backends such as LDAP expects UTF-8. If this is set to on Squid will |
382 | translate the HTTP iso-latin-1 charset to UTF-8 before sending the | |
383 | username & password to the helper. | |
384 | ||
7353861b | 385 | "children" numberofchildren [startup=N] [idle=N] [concurrency=N] |
48d54e4d | 386 | The maximum number of authenticator processes to spawn. If you start too few |
41bd17a4 | 387 | Squid will have to wait for them to process a backlog of credential |
388 | verifications, slowing it down. When password verifications are | |
389 | done via a (slow) network you are likely to need lots of | |
390 | authenticator processes. | |
48d54e4d AJ |
391 | |
392 | The startup= and idle= options permit some skew in the exact amount | |
64d2327b AJ |
393 | run. A minimum of startup=N will begin during startup and reconfigure. |
394 | Squid will start more in groups of up to idle=N in an attempt to meet | |
48d54e4d AJ |
395 | traffic needs and to keep idle=N free above those traffic needs up to |
396 | the maximum. | |
397 | ||
7353861b HN |
398 | The concurrency= option sets the number of concurrent requests the |
399 | helper can process. The default of 0 is used for helpers who only | |
400 | supports one request at a time. Setting this to a number greater than | |
401 | 0 changes the protocol used to include a channel number first on the | |
402 | request/response line, allowing multiple requests to be sent to the | |
4ded749e | 403 | same helper in parallel without waiting for the response. |
41bd17a4 | 404 | Must not be set unless it's known the helper supports this. |
7353861b HN |
405 | |
406 | auth_param basic children 20 startup=0 idle=1 | |
0fdafae7 | 407 | |
41bd17a4 | 408 | "realm" realmstring |
409 | Specifies the realm name which is to be reported to the | |
410 | client for the basic proxy authentication scheme (part of | |
411 | the text the user will see when prompted their username and | |
412 | password). There is no default. | |
413 | auth_param basic realm Squid proxy-caching web server | |
d1b63fc8 | 414 | |
41bd17a4 | 415 | "credentialsttl" timetolive |
416 | Specifies how long squid assumes an externally validated | |
417 | username:password pair is valid for - in other words how | |
418 | often the helper program is called for that user. Set this | |
419 | low to force revalidation with short lived passwords. Note | |
420 | setting this high does not impact your susceptibility | |
421 | to replay attacks unless you are using an one-time password | |
422 | system (such as SecureID). If you are using such a system, | |
423 | you will be vulnerable to replay attacks unless you also | |
424 | use the max_user_ip ACL in an http_access rule. | |
cccac0a2 | 425 | |
41bd17a4 | 426 | "casesensitive" on|off |
427 | Specifies if usernames are case sensitive. Most user databases are | |
428 | case insensitive allowing the same username to be spelled using both | |
429 | lower and upper case letters, but some are case sensitive. This | |
430 | makes a big difference for user_max_ip ACL processing and similar. | |
431 | auth_param basic casesensitive off | |
cccac0a2 | 432 | |
41bd17a4 | 433 | === Parameters for the digest scheme follow === |
cccac0a2 | 434 | |
41bd17a4 | 435 | "program" cmdline |
d4806c91 CT |
436 | Specify the command for the external authenticator. Such a program |
437 | reads a request_format line ("username":"realm" by default) and | |
5269ec0e AJ |
438 | replies with one of three results: |
439 | ||
440 | OK ha1="..." | |
441 | the user exists. The ha1= key is mandatory and | |
442 | contains the appropriate H(A1) value, hex encoded. | |
443 | See rfc 2616 for the definition of H(A1). | |
444 | ||
445 | ERR | |
446 | the user does not exist. | |
447 | ||
448 | BH | |
4ded749e | 449 | An internal error occurred in the helper, preventing |
5269ec0e AJ |
450 | a result being identified. |
451 | ||
452 | "ERR" and "BH" results may optionally be followed by message="..." | |
453 | containing a description available as %m in the returned error page. | |
cccac0a2 | 454 | |
41bd17a4 | 455 | By default, the digest authentication scheme is not used unless a |
456 | program is specified. | |
b8c0c06d | 457 | |
41bd17a4 | 458 | If you want to use a digest authenticator, set this line to |
459 | something like | |
cccac0a2 | 460 | |
7ce93108 | 461 | auth_param digest program @DEFAULT_PREFIX@/bin/digest_pw_auth @DEFAULT_PREFIX@/etc/digpass |
cccac0a2 | 462 | |
d2a89ac1 | 463 | "utf8" on|off |
4ded749e | 464 | HTTP uses iso-latin-1 as character set, while some authentication |
d2a89ac1 AJ |
465 | backends such as LDAP expects UTF-8. If this is set to on Squid will |
466 | translate the HTTP iso-latin-1 charset to UTF-8 before sending the | |
467 | username & password to the helper. | |
468 | ||
7353861b | 469 | "children" numberofchildren [startup=N] [idle=N] [concurrency=N] |
48d54e4d | 470 | The maximum number of authenticator processes to spawn (default 5). |
41bd17a4 | 471 | If you start too few Squid will have to wait for them to |
472 | process a backlog of H(A1) calculations, slowing it down. | |
473 | When the H(A1) calculations are done via a (slow) network | |
474 | you are likely to need lots of authenticator processes. | |
48d54e4d AJ |
475 | |
476 | The startup= and idle= options permit some skew in the exact amount | |
64d2327b AJ |
477 | run. A minimum of startup=N will begin during startup and reconfigure. |
478 | Squid will start more in groups of up to idle=N in an attempt to meet | |
48d54e4d AJ |
479 | traffic needs and to keep idle=N free above those traffic needs up to |
480 | the maximum. | |
481 | ||
7353861b HN |
482 | The concurrency= option sets the number of concurrent requests the |
483 | helper can process. The default of 0 is used for helpers who only | |
484 | supports one request at a time. Setting this to a number greater than | |
485 | 0 changes the protocol used to include a channel number first on the | |
486 | request/response line, allowing multiple requests to be sent to the | |
4ded749e | 487 | same helper in parallel without waiting for the response. |
7353861b HN |
488 | Must not be set unless it's known the helper supports this. |
489 | ||
48d54e4d | 490 | auth_param digest children 20 startup=0 idle=1 |
cccac0a2 | 491 | |
41bd17a4 | 492 | "realm" realmstring |
493 | Specifies the realm name which is to be reported to the | |
494 | client for the digest proxy authentication scheme (part of | |
495 | the text the user will see when prompted their username and | |
496 | password). There is no default. | |
497 | auth_param digest realm Squid proxy-caching web server | |
cccac0a2 | 498 | |
41bd17a4 | 499 | "nonce_garbage_interval" timeinterval |
500 | Specifies the interval that nonces that have been issued | |
501 | to client_agent's are checked for validity. | |
cccac0a2 | 502 | |
41bd17a4 | 503 | "nonce_max_duration" timeinterval |
504 | Specifies the maximum length of time a given nonce will be | |
505 | valid for. | |
cccac0a2 | 506 | |
41bd17a4 | 507 | "nonce_max_count" number |
508 | Specifies the maximum number of times a given nonce can be | |
509 | used. | |
cccac0a2 | 510 | |
41bd17a4 | 511 | "nonce_strictness" on|off |
512 | Determines if squid requires strict increment-by-1 behavior | |
513 | for nonce counts, or just incrementing (off - for use when | |
4ded749e | 514 | user agents generate nonce counts that occasionally miss 1 |
41bd17a4 | 515 | (ie, 1,2,4,6)). Default off. |
cccac0a2 | 516 | |
41bd17a4 | 517 | "check_nonce_count" on|off |
518 | This directive if set to off can disable the nonce count check | |
519 | completely to work around buggy digest qop implementations in | |
520 | certain mainstream browser versions. Default on to check the | |
521 | nonce count to protect from authentication replay attacks. | |
cccac0a2 | 522 | |
41bd17a4 | 523 | "post_workaround" on|off |
524 | This is a workaround to certain buggy browsers who sends | |
525 | an incorrect request digest in POST requests when reusing | |
526 | the same nonce as acquired earlier on a GET request. | |
cccac0a2 | 527 | |
41bd17a4 | 528 | === NTLM scheme options follow === |
cccac0a2 | 529 | |
41bd17a4 | 530 | "program" cmdline |
531 | Specify the command for the external NTLM authenticator. | |
532 | Such a program reads exchanged NTLMSSP packets with | |
533 | the browser via Squid until authentication is completed. | |
534 | If you use an NTLM authenticator, make sure you have 1 acl | |
5269ec0e | 535 | of type proxy_auth. By default, the NTLM authenticator program |
41bd17a4 | 536 | is not used. |
cccac0a2 | 537 | |
e4752e21 | 538 | auth_param ntlm program /usr/bin/ntlm_auth |
cccac0a2 | 539 | |
48d54e4d AJ |
540 | "children" numberofchildren [startup=N] [idle=N] |
541 | The maximum number of authenticator processes to spawn (default 5). | |
41bd17a4 | 542 | If you start too few Squid will have to wait for them to |
543 | process a backlog of credential verifications, slowing it | |
544 | down. When credential verifications are done via a (slow) | |
545 | network you are likely to need lots of authenticator | |
546 | processes. | |
cccac0a2 | 547 | |
48d54e4d | 548 | The startup= and idle= options permit some skew in the exact amount |
64d2327b AJ |
549 | run. A minimum of startup=N will begin during startup and reconfigure. |
550 | Squid will start more in groups of up to idle=N in an attempt to meet | |
48d54e4d AJ |
551 | traffic needs and to keep idle=N free above those traffic needs up to |
552 | the maximum. | |
553 | ||
554 | auth_param ntlm children 20 startup=0 idle=1 | |
cccac0a2 | 555 | |
41bd17a4 | 556 | "keep_alive" on|off |
557 | If you experience problems with PUT/POST requests when using the | |
558 | Negotiate authentication scheme then you can try setting this to | |
559 | off. This will cause Squid to forcibly close the connection on | |
560 | the initial requests where the browser asks which schemes are | |
561 | supported by the proxy. | |
cccac0a2 | 562 | |
41bd17a4 | 563 | auth_param ntlm keep_alive on |
cccac0a2 | 564 | |
41bd17a4 | 565 | === Options for configuring the NEGOTIATE auth-scheme follow === |
cccac0a2 | 566 | |
41bd17a4 | 567 | "program" cmdline |
568 | Specify the command for the external Negotiate authenticator. | |
569 | This protocol is used in Microsoft Active-Directory enabled setups with | |
570 | the Microsoft Internet Explorer or Mozilla Firefox browsers. | |
571 | Its main purpose is to exchange credentials with the Squid proxy | |
572 | using the Kerberos mechanisms. | |
b3567eb5 FC |
573 | If you use a Negotiate authenticator, make sure you have at least |
574 | one acl of type proxy_auth active. By default, the negotiate | |
5269ec0e | 575 | authenticator program is not used. |
41bd17a4 | 576 | The only supported program for this role is the ntlm_auth |
577 | program distributed as part of Samba, version 4 or later. | |
cccac0a2 | 578 | |
e4752e21 | 579 | auth_param negotiate program /usr/bin/ntlm_auth --helper-protocol=gss-spnego |
cccac0a2 | 580 | |
48d54e4d AJ |
581 | "children" numberofchildren [startup=N] [idle=N] |
582 | The maximum number of authenticator processes to spawn (default 5). | |
41bd17a4 | 583 | If you start too few Squid will have to wait for them to |
584 | process a backlog of credential verifications, slowing it | |
4ded749e | 585 | down. When credential verifications are done via a (slow) |
41bd17a4 | 586 | network you are likely to need lots of authenticator |
587 | processes. | |
48d54e4d AJ |
588 | |
589 | The startup= and idle= options permit some skew in the exact amount | |
64d2327b AJ |
590 | run. A minimum of startup=N will begin during startup and reconfigure. |
591 | Squid will start more in groups of up to idle=N in an attempt to meet | |
48d54e4d AJ |
592 | traffic needs and to keep idle=N free above those traffic needs up to |
593 | the maximum. | |
594 | ||
595 | auth_param negotiate children 20 startup=0 idle=1 | |
d3803853 | 596 | |
41bd17a4 | 597 | "keep_alive" on|off |
598 | If you experience problems with PUT/POST requests when using the | |
599 | Negotiate authentication scheme then you can try setting this to | |
600 | off. This will cause Squid to forcibly close the connection on | |
601 | the initial requests where the browser asks which schemes are | |
602 | supported by the proxy. | |
527ee50d | 603 | |
41bd17a4 | 604 | auth_param negotiate keep_alive on |
e0855596 AJ |
605 | |
606 | Examples: | |
607 | ||
41bd17a4 | 608 | #Recommended minimum configuration per scheme: |
609 | #auth_param negotiate program <uncomment and complete this line to activate> | |
48d54e4d | 610 | #auth_param negotiate children 20 startup=0 idle=1 |
41bd17a4 | 611 | #auth_param negotiate keep_alive on |
e0855596 | 612 | # |
41bd17a4 | 613 | #auth_param ntlm program <uncomment and complete this line to activate> |
48d54e4d | 614 | #auth_param ntlm children 20 startup=0 idle=1 |
41bd17a4 | 615 | #auth_param ntlm keep_alive on |
e0855596 | 616 | # |
41bd17a4 | 617 | #auth_param digest program <uncomment and complete this line> |
48d54e4d | 618 | #auth_param digest children 20 startup=0 idle=1 |
41bd17a4 | 619 | #auth_param digest realm Squid proxy-caching web server |
620 | #auth_param digest nonce_garbage_interval 5 minutes | |
621 | #auth_param digest nonce_max_duration 30 minutes | |
622 | #auth_param digest nonce_max_count 50 | |
e0855596 | 623 | # |
41bd17a4 | 624 | #auth_param basic program <uncomment and complete this line> |
6f4d3ed6 | 625 | #auth_param basic children 5 startup=5 idle=1 |
41bd17a4 | 626 | #auth_param basic realm Squid proxy-caching web server |
627 | #auth_param basic credentialsttl 2 hours | |
41bd17a4 | 628 | DOC_END |
cccac0a2 | 629 | |
41bd17a4 | 630 | NAME: authenticate_cache_garbage_interval |
631 | TYPE: time_t | |
632 | DEFAULT: 1 hour | |
633 | LOC: Config.authenticateGCInterval | |
634 | DOC_START | |
635 | The time period between garbage collection across the username cache. | |
4ded749e | 636 | This is a trade-off between memory utilization (long intervals - say |
41bd17a4 | 637 | 2 days) and CPU (short intervals - say 1 minute). Only change if you |
638 | have good reason to. | |
639 | DOC_END | |
cccac0a2 | 640 | |
41bd17a4 | 641 | NAME: authenticate_ttl |
642 | TYPE: time_t | |
643 | DEFAULT: 1 hour | |
644 | LOC: Config.authenticateTTL | |
645 | DOC_START | |
646 | The time a user & their credentials stay in the logged in | |
647 | user cache since their last request. When the garbage | |
648 | interval passes, all user credentials that have passed their | |
649 | TTL are removed from memory. | |
650 | DOC_END | |
cccac0a2 | 651 | |
41bd17a4 | 652 | NAME: authenticate_ip_ttl |
653 | TYPE: time_t | |
654 | LOC: Config.authenticateIpTTL | |
c35dd848 | 655 | DEFAULT: 1 second |
41bd17a4 | 656 | DOC_START |
657 | If you use proxy authentication and the 'max_user_ip' ACL, | |
658 | this directive controls how long Squid remembers the IP | |
659 | addresses associated with each user. Use a small value | |
660 | (e.g., 60 seconds) if your users might change addresses | |
4ded749e | 661 | quickly, as is the case with dialup. You might be safe |
41bd17a4 | 662 | using a larger value (e.g., 2 hours) in a corporate LAN |
663 | environment with relatively static address assignments. | |
664 | DOC_END | |
cccac0a2 | 665 | |
3d1e3e43 | 666 | COMMENT_START |
667 | ACCESS CONTROLS | |
668 | ----------------------------------------------------------------------------- | |
669 | COMMENT_END | |
670 | ||
41bd17a4 | 671 | NAME: external_acl_type |
672 | TYPE: externalAclHelper | |
673 | LOC: Config.externalAclHelperList | |
cccac0a2 | 674 | DEFAULT: none |
cccac0a2 | 675 | DOC_START |
41bd17a4 | 676 | This option defines external acl classes using a helper program |
677 | to look up the status | |
cccac0a2 | 678 | |
41bd17a4 | 679 | external_acl_type name [options] FORMAT.. /path/to/helper [helper arguments..] |
cccac0a2 | 680 | |
41bd17a4 | 681 | Options: |
cccac0a2 | 682 | |
41bd17a4 | 683 | ttl=n TTL in seconds for cached results (defaults to 3600 |
684 | for 1 hour) | |
685 | negative_ttl=n | |
686 | TTL for cached negative lookups (default same | |
687 | as ttl) | |
48d54e4d AJ |
688 | children-max=n |
689 | Maximum number of acl helper processes spawned to service | |
690 | external acl lookups of this type. (default 20) | |
691 | children-startup=n | |
692 | Minimum number of acl helper processes to spawn during | |
693 | startup and reconfigure to service external acl lookups | |
694 | of this type. (default 0) | |
695 | children-idle=n | |
696 | Number of acl helper processes to keep ahead of traffic | |
697 | loads. Squid will spawn this many at once whenever load | |
698 | rises above the capabilities of existing processes. | |
699 | Up to the value of children-max. (default 1) | |
41bd17a4 | 700 | concurrency=n concurrency level per process. Only used with helpers |
701 | capable of processing more than one query at a time. | |
48d54e4d | 702 | cache=n limit the result cache size, default is unbounded. |
41bd17a4 | 703 | grace=n Percentage remaining of TTL where a refresh of a |
704 | cached entry should be initiated without needing to | |
48d54e4d | 705 | wait for a new reply. (default is for no grace period) |
41bd17a4 | 706 | protocol=2.5 Compatibility mode for Squid-2.5 external acl helpers |
91e64de9 AJ |
707 | ipv4 / ipv6 IP protocol used to communicate with this helper. |
708 | The default is to auto-detect IPv6 and use it when available. | |
cccac0a2 | 709 | |
41bd17a4 | 710 | FORMAT specifications |
cccac0a2 | 711 | |
41bd17a4 | 712 | %LOGIN Authenticated user login name |
99e4ad67 JB |
713 | %EXT_USER Username from previous external acl |
714 | %EXT_LOG Log details from previous external acl | |
715 | %EXT_TAG Tag from previous external acl | |
41bd17a4 | 716 | %IDENT Ident user name |
717 | %SRC Client IP | |
718 | %SRCPORT Client source port | |
719 | %URI Requested URI | |
720 | %DST Requested host | |
721 | %PROTO Requested protocol | |
722 | %PORT Requested port | |
723 | %PATH Requested URL path | |
724 | %METHOD Request method | |
725 | %MYADDR Squid interface address | |
726 | %MYPORT Squid http_port number | |
727 | %PATH Requested URL-path (including query-string if any) | |
728 | %USER_CERT SSL User certificate in PEM format | |
729 | %USER_CERTCHAIN SSL User certificate chain in PEM format | |
730 | %USER_CERT_xx SSL User certificate subject attribute xx | |
731 | %USER_CA_xx SSL User certificate issuer attribute xx | |
7b0ca1e8 | 732 | |
c68c9682 | 733 | %>{Header} HTTP request header "Header" |
7b0ca1e8 | 734 | %>{Hdr:member} |
c68c9682 | 735 | HTTP request header "Hdr" list member "member" |
7b0ca1e8 | 736 | %>{Hdr:;member} |
41bd17a4 | 737 | HTTP request header list member using ; as |
738 | list separator. ; can be any non-alphanumeric | |
739 | character. | |
cccac0a2 | 740 | |
c68c9682 | 741 | %<{Header} HTTP reply header "Header" |
7b0ca1e8 | 742 | %<{Hdr:member} |
c68c9682 | 743 | HTTP reply header "Hdr" list member "member" |
7b0ca1e8 AJ |
744 | %<{Hdr:;member} |
745 | HTTP reply header list member using ; as | |
746 | list separator. ; can be any non-alphanumeric | |
747 | character. | |
748 | ||
ec2d5242 HN |
749 | %ACL The name of the ACL being tested. |
750 | %DATA The ACL arguments. If not used then any arguments | |
751 | is automatically added at the end of the line | |
752 | sent to the helper. | |
753 | NOTE: this will encode the arguments as one token, | |
754 | whereas the default will pass each separately. | |
755 | ||
0db8942f AJ |
756 | %% The percent sign. Useful for helpers which need |
757 | an unchanging input format. | |
758 | ||
cccac0a2 | 759 | |
5269ec0e AJ |
760 | General request syntax: |
761 | ||
762 | [channel-ID] FORMAT-values [acl-values ...] | |
763 | ||
764 | ||
765 | FORMAT-values consists of transaction details expanded with | |
766 | whitespace separation per the config file FORMAT specification | |
767 | using the FORMAT macros listed above. | |
768 | ||
769 | acl-values consists of any string specified in the referencing | |
770 | config 'acl ... external' line. see the "acl external" directive. | |
771 | ||
772 | Request values sent to the helper are URL escaped to protect | |
773 | each value in requests against whitespaces. | |
774 | ||
775 | If using protocol=2.5 then the request sent to the helper is not | |
776 | URL escaped to protect against whitespace. | |
777 | ||
778 | NOTE: protocol=3.0 is deprecated as no longer necessary. | |
779 | ||
780 | When using the concurrency= option the protocol is changed by | |
781 | introducing a query channel tag in front of the request/response. | |
782 | The query channel tag is a number between 0 and concurrency-1. | |
783 | This value must be echoed back unchanged to Squid as the first part | |
784 | of the response relating to its request. | |
785 | ||
786 | ||
787 | The helper receives lines expanded per the above format specification | |
788 | and for each input line returns 1 line starting with OK/ERR/BH result | |
789 | code and optionally followed by additional keywords with more details. | |
790 | ||
cccac0a2 | 791 | |
41bd17a4 | 792 | General result syntax: |
cccac0a2 | 793 | |
5269ec0e AJ |
794 | [channel-ID] result keyword=value ... |
795 | ||
796 | Result consists of one of the codes: | |
797 | ||
798 | OK | |
799 | the ACL test produced a match. | |
800 | ||
801 | ERR | |
802 | the ACL test does not produce a match. | |
803 | ||
804 | BH | |
4ded749e | 805 | An internal error occurred in the helper, preventing |
5269ec0e AJ |
806 | a result being identified. |
807 | ||
808 | The meaning of 'a match' is determined by your squid.conf | |
809 | access control configuration. See the Squid wiki for details. | |
cccac0a2 | 810 | |
41bd17a4 | 811 | Defined keywords: |
cccac0a2 | 812 | |
41bd17a4 | 813 | user= The users name (login) |
5269ec0e | 814 | |
41bd17a4 | 815 | password= The users password (for login= cache_peer option) |
5269ec0e | 816 | |
05e52854 | 817 | message= Message describing the reason for this response. |
5269ec0e AJ |
818 | Available as %o in error pages. |
819 | Useful on (ERR and BH results). | |
820 | ||
05e52854 AJ |
821 | tag= Apply a tag to a request. Only sets a tag once, |
822 | does not alter existing tags. | |
5269ec0e | 823 | |
41bd17a4 | 824 | log= String to be logged in access.log. Available as |
5269ec0e | 825 | %ea in logformat specifications. |
934b03fc | 826 | |
05e52854 | 827 | Any keywords may be sent on any response whether OK, ERR or BH. |
6a566b9c | 828 | |
05e52854 AJ |
829 | All response keyword values need to be a single token with URL |
830 | escaping, or enclosed in double quotes (") and escaped using \ on | |
24eac830 AJ |
831 | any double quotes or \ characters within the value. The wrapping |
832 | double quotes are removed before the value is interpreted by Squid. | |
833 | \r and \n are also replace by CR and LF. | |
1e5562e3 | 834 | |
24eac830 AJ |
835 | Some example key values: |
836 | ||
5269ec0e | 837 | user=John%20Smith |
24eac830 AJ |
838 | user="John Smith" |
839 | user="J. \"Bob\" Smith" | |
cccac0a2 | 840 | DOC_END |
841 | ||
41bd17a4 | 842 | NAME: acl |
843 | TYPE: acl | |
844 | LOC: Config.aclList | |
38450a50 | 845 | IF USE_SSL |
cf1c09f6 CT |
846 | DEFAULT: ssl::certHasExpired ssl_error X509_V_ERR_CERT_HAS_EXPIRED |
847 | DEFAULT: ssl::certNotYetValid ssl_error X509_V_ERR_CERT_NOT_YET_VALID | |
848 | DEFAULT: ssl::certDomainMismatch ssl_error SQUID_X509_V_ERR_DOMAIN_MISMATCH | |
849 | DEFAULT: ssl::certUntrusted ssl_error X509_V_ERR_INVALID_CA X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY X509_V_ERR_CERT_UNTRUSTED | |
850 | DEFAULT: ssl::certSelfSigned ssl_error X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT | |
851 | ENDIF | |
1f5bd0a4 | 852 | DEFAULT: all src all |
b8a25eaa AJ |
853 | DEFAULT: manager url_regex -i ^cache_object:// +i ^https?://[^/]+/squid-internal-mgr/ |
854 | DEFAULT: localhost src 127.0.0.1/32 ::1 | |
855 | DEFAULT: to_localhost dst 127.0.0.0/8 0.0.0.0/32 ::1 | |
856 | DEFAULT_DOC: ACLs all, manager, localhost, and to_localhost are predefined. | |
cccac0a2 | 857 | DOC_START |
41bd17a4 | 858 | Defining an Access List |
cccac0a2 | 859 | |
375eeb3b AJ |
860 | Every access list definition must begin with an aclname and acltype, |
861 | followed by either type-specific arguments or a quoted filename that | |
862 | they are read from. | |
cccac0a2 | 863 | |
375eeb3b AJ |
864 | acl aclname acltype argument ... |
865 | acl aclname acltype "file" ... | |
cccac0a2 | 866 | |
375eeb3b | 867 | When using "file", the file should contain one item per line. |
cccac0a2 | 868 | |
0f987978 CT |
869 | Some acl types supports options which changes their default behaviour. |
870 | The available options are: | |
871 | ||
872 | -i,+i By default, regular expressions are CASE-SENSITIVE. To make them | |
873 | case-insensitive, use the -i option. To return case-sensitive | |
874 | use the +i option between patterns, or make a new ACL line | |
875 | without -i. | |
876 | ||
877 | -n Disable lookups and address type conversions. If lookup or | |
878 | conversion is required because the parameter type (IP or | |
879 | domain name) does not match the message address type (domain | |
880 | name or IP), then the ACL would immediately declare a mismatch | |
881 | without any warnings or lookups. | |
882 | ||
883 | -- Used to stop processing all options, in the case the first acl | |
884 | value has '-' character as first character (for example the '-' | |
885 | is a valid domain name) | |
cccac0a2 | 886 | |
b3567eb5 FC |
887 | Some acl types require suspending the current request in order |
888 | to access some external data source. | |
889 | Those which do are marked with the tag [slow], those which | |
890 | don't are marked as [fast]. | |
891 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl | |
892 | for further information | |
e988aa40 AJ |
893 | |
894 | ***** ACL TYPES AVAILABLE ***** | |
895 | ||
1e40905d AJ |
896 | acl aclname src ip-address/mask ... # clients IP address [fast] |
897 | acl aclname src addr1-addr2/mask ... # range of addresses [fast] | |
0f987978 | 898 | acl aclname dst [-n] ip-address/mask ... # URL host's IP address [slow] |
1e40905d | 899 | acl aclname localip ip-address/mask ... # IP address the client connected to [fast] |
cccac0a2 | 900 | |
41bd17a4 | 901 | acl aclname arp mac-address ... (xx:xx:xx:xx:xx:xx notation) |
902 | # The arp ACL requires the special configure option --enable-arp-acl. | |
903 | # Furthermore, the ARP ACL code is not portable to all operating systems. | |
b3567eb5 FC |
904 | # It works on Linux, Solaris, Windows, FreeBSD, and some |
905 | # other *BSD variants. | |
906 | # [fast] | |
41bd17a4 | 907 | # |
908 | # NOTE: Squid can only determine the MAC address for clients that are on | |
b3567eb5 FC |
909 | # the same subnet. If the client is on a different subnet, |
910 | # then Squid cannot find out its MAC address. | |
911 | ||
912 | acl aclname srcdomain .foo.com ... | |
913 | # reverse lookup, from client IP [slow] | |
0f987978 | 914 | acl aclname dstdomain [-n] .foo.com ... |
e38c7724 | 915 | # Destination server from URL [fast] |
b3567eb5 FC |
916 | acl aclname srcdom_regex [-i] \.foo\.com ... |
917 | # regex matching client name [slow] | |
0f987978 | 918 | acl aclname dstdom_regex [-n] [-i] \.foo\.com ... |
e38c7724 | 919 | # regex matching server [fast] |
b3567eb5 | 920 | # |
41bd17a4 | 921 | # For dstdomain and dstdom_regex a reverse lookup is tried if a IP |
922 | # based URL is used and no match is found. The name "none" is used | |
923 | # if the reverse lookup fails. | |
9bc73deb | 924 | |
375eeb3b AJ |
925 | acl aclname src_as number ... |
926 | acl aclname dst_as number ... | |
b3567eb5 | 927 | # [fast] |
e988aa40 AJ |
928 | # Except for access control, AS numbers can be used for |
929 | # routing of requests to specific caches. Here's an | |
930 | # example for routing all requests for AS#1241 and only | |
931 | # those to mycache.mydomain.net: | |
932 | # acl asexample dst_as 1241 | |
933 | # cache_peer_access mycache.mydomain.net allow asexample | |
934 | # cache_peer_access mycache_mydomain.net deny all | |
7f7db318 | 935 | |
6db78a1a | 936 | acl aclname peername myPeer ... |
b3567eb5 | 937 | # [fast] |
6db78a1a AJ |
938 | # match against a named cache_peer entry |
939 | # set unique name= on cache_peer lines for reliable use. | |
940 | ||
375eeb3b | 941 | acl aclname time [day-abbrevs] [h1:m1-h2:m2] |
b3567eb5 | 942 | # [fast] |
375eeb3b AJ |
943 | # day-abbrevs: |
944 | # S - Sunday | |
945 | # M - Monday | |
946 | # T - Tuesday | |
947 | # W - Wednesday | |
948 | # H - Thursday | |
949 | # F - Friday | |
950 | # A - Saturday | |
951 | # h1:m1 must be less than h2:m2 | |
952 | ||
b3567eb5 FC |
953 | acl aclname url_regex [-i] ^http:// ... |
954 | # regex matching on whole URL [fast] | |
9d35fe37 AJ |
955 | acl aclname urllogin [-i] [^a-zA-Z0-9] ... |
956 | # regex matching on URL login field | |
b3567eb5 FC |
957 | acl aclname urlpath_regex [-i] \.gif$ ... |
958 | # regex matching on URL path [fast] | |
e988aa40 | 959 | |
b3567eb5 FC |
960 | acl aclname port 80 70 21 0-1024... # destination TCP port [fast] |
961 | # ranges are alloed | |
1e40905d AJ |
962 | acl aclname localport 3128 ... # TCP port the client connected to [fast] |
963 | # NP: for interception mode this is usually '80' | |
964 | ||
b3567eb5 | 965 | acl aclname myportname 3128 ... # http(s)_port name [fast] |
e988aa40 | 966 | |
b3567eb5 FC |
967 | acl aclname proto HTTP FTP ... # request protocol [fast] |
968 | ||
969 | acl aclname method GET POST ... # HTTP request method [fast] | |
e988aa40 | 970 | |
b3567eb5 FC |
971 | acl aclname http_status 200 301 500- 400-403 ... |
972 | # status code in reply [fast] | |
e988aa40 | 973 | |
375eeb3b | 974 | acl aclname browser [-i] regexp ... |
b3567eb5 | 975 | # pattern match on User-Agent header (see also req_header below) [fast] |
e988aa40 | 976 | |
375eeb3b | 977 | acl aclname referer_regex [-i] regexp ... |
b3567eb5 | 978 | # pattern match on Referer header [fast] |
41bd17a4 | 979 | # Referer is highly unreliable, so use with care |
e988aa40 | 980 | |
375eeb3b | 981 | acl aclname ident username ... |
41bd17a4 | 982 | acl aclname ident_regex [-i] pattern ... |
b3567eb5 | 983 | # string match on ident output [slow] |
41bd17a4 | 984 | # use REQUIRED to accept any non-null ident. |
cf5cc17e | 985 | |
41bd17a4 | 986 | acl aclname proxy_auth [-i] username ... |
987 | acl aclname proxy_auth_regex [-i] pattern ... | |
b3567eb5 FC |
988 | # perform http authentication challenge to the client and match against |
989 | # supplied credentials [slow] | |
990 | # | |
991 | # takes a list of allowed usernames. | |
41bd17a4 | 992 | # use REQUIRED to accept any valid username. |
993 | # | |
b3567eb5 FC |
994 | # Will use proxy authentication in forward-proxy scenarios, and plain |
995 | # http authenticaiton in reverse-proxy scenarios | |
996 | # | |
41bd17a4 | 997 | # NOTE: when a Proxy-Authentication header is sent but it is not |
998 | # needed during ACL checking the username is NOT logged | |
999 | # in access.log. | |
1000 | # | |
1001 | # NOTE: proxy_auth requires a EXTERNAL authentication program | |
1002 | # to check username/password combinations (see | |
1003 | # auth_param directive). | |
1004 | # | |
e988aa40 AJ |
1005 | # NOTE: proxy_auth can't be used in a transparent/intercepting proxy |
1006 | # as the browser needs to be configured for using a proxy in order | |
41bd17a4 | 1007 | # to respond to proxy authentication. |
8e8d4f30 | 1008 | |
41bd17a4 | 1009 | acl aclname snmp_community string ... |
b3567eb5 | 1010 | # A community string to limit access to your SNMP Agent [fast] |
41bd17a4 | 1011 | # Example: |
1012 | # | |
1013 | # acl snmppublic snmp_community public | |
934b03fc | 1014 | |
41bd17a4 | 1015 | acl aclname maxconn number |
1016 | # This will be matched when the client's IP address has | |
55d0fae8 AJ |
1017 | # more than <number> TCP connections established. [fast] |
1018 | # NOTE: This only measures direct TCP links so X-Forwarded-For | |
1019 | # indirect clients are not counted. | |
1e5562e3 | 1020 | |
41bd17a4 | 1021 | acl aclname max_user_ip [-s] number |
1022 | # This will be matched when the user attempts to log in from more | |
1023 | # than <number> different ip addresses. The authenticate_ip_ttl | |
b3567eb5 | 1024 | # parameter controls the timeout on the ip entries. [fast] |
41bd17a4 | 1025 | # If -s is specified the limit is strict, denying browsing |
1026 | # from any further IP addresses until the ttl has expired. Without | |
1027 | # -s Squid will just annoy the user by "randomly" denying requests. | |
1028 | # (the counter is reset each time the limit is reached and a | |
1029 | # request is denied) | |
1030 | # NOTE: in acceleration mode or where there is mesh of child proxies, | |
1031 | # clients may appear to come from multiple addresses if they are | |
1032 | # going through proxy farms, so a limit of 1 may cause user problems. | |
cccac0a2 | 1033 | |
cb1b906f AJ |
1034 | acl aclname random probability |
1035 | # Pseudo-randomly match requests. Based on the probability given. | |
1036 | # Probability may be written as a decimal (0.333), fraction (1/3) | |
1037 | # or ratio of matches:non-matches (3:5). | |
1038 | ||
375eeb3b | 1039 | acl aclname req_mime_type [-i] mime-type ... |
41bd17a4 | 1040 | # regex match against the mime type of the request generated |
1041 | # by the client. Can be used to detect file upload or some | |
b3567eb5 | 1042 | # types HTTP tunneling requests [fast] |
41bd17a4 | 1043 | # NOTE: This does NOT match the reply. You cannot use this |
1044 | # to match the returned file type. | |
cccac0a2 | 1045 | |
41bd17a4 | 1046 | acl aclname req_header header-name [-i] any\.regex\.here |
1047 | # regex match against any of the known request headers. May be | |
1048 | # thought of as a superset of "browser", "referer" and "mime-type" | |
b3567eb5 | 1049 | # ACL [fast] |
cccac0a2 | 1050 | |
375eeb3b | 1051 | acl aclname rep_mime_type [-i] mime-type ... |
41bd17a4 | 1052 | # regex match against the mime type of the reply received by |
1053 | # squid. Can be used to detect file download or some | |
b3567eb5 | 1054 | # types HTTP tunneling requests. [fast] |
41bd17a4 | 1055 | # NOTE: This has no effect in http_access rules. It only has |
1056 | # effect in rules that affect the reply data stream such as | |
1057 | # http_reply_access. | |
cccac0a2 | 1058 | |
41bd17a4 | 1059 | acl aclname rep_header header-name [-i] any\.regex\.here |
1060 | # regex match against any of the known reply headers. May be | |
1061 | # thought of as a superset of "browser", "referer" and "mime-type" | |
b3567eb5 | 1062 | # ACLs [fast] |
cccac0a2 | 1063 | |
375eeb3b | 1064 | acl aclname external class_name [arguments...] |
41bd17a4 | 1065 | # external ACL lookup via a helper class defined by the |
b3567eb5 | 1066 | # external_acl_type directive [slow] |
cccac0a2 | 1067 | |
41bd17a4 | 1068 | acl aclname user_cert attribute values... |
1069 | # match against attributes in a user SSL certificate | |
b3567eb5 | 1070 | # attribute is one of DN/C/O/CN/L/ST [fast] |
cccac0a2 | 1071 | |
41bd17a4 | 1072 | acl aclname ca_cert attribute values... |
1073 | # match against attributes a users issuing CA SSL certificate | |
b3567eb5 | 1074 | # attribute is one of DN/C/O/CN/L/ST [fast] |
cccac0a2 | 1075 | |
41bd17a4 | 1076 | acl aclname ext_user username ... |
1077 | acl aclname ext_user_regex [-i] pattern ... | |
b3567eb5 | 1078 | # string match on username returned by external acl helper [slow] |
41bd17a4 | 1079 | # use REQUIRED to accept any non-null user name. |
b3567eb5 | 1080 | |
0ab50441 | 1081 | acl aclname tag tagvalue ... |
b3567eb5 | 1082 | # string match on tag returned by external acl helper [slow] |
cccac0a2 | 1083 | |
bbaf2685 AJ |
1084 | acl aclname hier_code codename ... |
1085 | # string match against squid hierarchy code(s); [fast] | |
1086 | # e.g., DIRECT, PARENT_HIT, NONE, etc. | |
1087 | # | |
1088 | # NOTE: This has no effect in http_access rules. It only has | |
1089 | # effect in rules that affect the reply data stream such as | |
1090 | # http_reply_access. | |
1091 | ||
39baccc8 CT |
1092 | acl aclname note name [value ...] |
1093 | # match transaction annotation [fast] | |
1094 | # Without values, matches any annotation with a given name. | |
1095 | # With value(s), matches any annotation with a given name that | |
1096 | # also has one of the given values. | |
1097 | # Names and values are compared using a string equality test. | |
1098 | # Annotation sources include note and adaptation_meta directives | |
1099 | # as well as helper and eCAP responses. | |
1100 | ||
c302ddb5 CT |
1101 | acl aclname adaptation_service service ... |
1102 | # Matches the name of any icap_service, ecap_service, | |
1103 | # adaptation_service_set, or adaptation_service_chain that Squid | |
1104 | # has used (or attempted to use) for the master transaction. | |
1105 | # This ACL must be defined after the corresponding adaptation | |
1106 | # service is named in squid.conf. This ACL is usable with | |
1107 | # adaptation_meta because it starts matching immediately after | |
1108 | # the service has been selected for adaptation. | |
1109 | ||
38450a50 | 1110 | IF USE_SSL |
cf1c09f6 CT |
1111 | acl aclname ssl_error errorname |
1112 | # match against SSL certificate validation error [fast] | |
cf1c09f6 | 1113 | # |
7a957a93 AR |
1114 | # For valid error names see in @DEFAULT_ERROR_DIR@/templates/error-details.txt |
1115 | # template file. | |
cf1c09f6 | 1116 | # |
7a957a93 AR |
1117 | # The following can be used as shortcuts for certificate properties: |
1118 | # [ssl::]certHasExpired: the "not after" field is in the past | |
1119 | # [ssl::]certNotYetValid: the "not before" field is in the future | |
1120 | # [ssl::]certUntrusted: The certificate issuer is not to be trusted. | |
1121 | # [ssl::]certSelfSigned: The certificate is self signed. | |
1122 | # [ssl::]certDomainMismatch: The certificate CN domain does not | |
1123 | # match the name the name of the host we are connecting to. | |
1124 | # | |
1125 | # The ssl::certHasExpired, ssl::certNotYetValid, ssl::certDomainMismatch, | |
1126 | # ssl::certUntrusted, and ssl::certSelfSigned can also be used as | |
1127 | # predefined ACLs, just like the 'all' ACL. | |
1128 | # | |
1129 | # NOTE: The ssl_error ACL is only supported with sslproxy_cert_error, | |
1130 | # sslproxy_cert_sign, and sslproxy_cert_adapt options. | |
00352183 | 1131 | |
72b12f9e | 1132 | acl aclname server_cert_fingerprint [-sha1] fingerprint |
00352183 AR |
1133 | # match against server SSL certificate fingerprint [fast] |
1134 | # | |
1135 | # The fingerprint is the digest of the DER encoded version | |
1136 | # of the whole certificate. The user should use the form: XX:XX:... | |
1137 | # Optional argument specifies the digest algorithm to use. | |
1138 | # The SHA1 digest algorithm is the default and is currently | |
1139 | # the only algorithm supported (-sha1). | |
cf1c09f6 | 1140 | ENDIF |
6f58d7d7 AR |
1141 | acl aclname any-of acl1 acl2 ... |
1142 | # match any one of the acls [fast or slow] | |
1143 | # The first matching ACL stops further ACL evaluation. | |
1144 | # | |
1145 | # ACLs from multiple any-of lines with the same name are ORed. | |
1146 | # For example, A = (a1 or a2) or (a3 or a4) can be written as | |
1147 | # acl A any-of a1 a2 | |
1148 | # acl A any-of a3 a4 | |
1149 | # | |
1150 | # This group ACL is fast if all evaluated ACLs in the group are fast | |
1151 | # and slow otherwise. | |
1152 | ||
1153 | acl aclname all-of acl1 acl2 ... | |
1154 | # match all of the acls [fast or slow] | |
1155 | # The first mismatching ACL stops further ACL evaluation. | |
1156 | # | |
1157 | # ACLs from multiple all-of lines with the same name are ORed. | |
1158 | # For example, B = (b1 and b2) or (b3 and b4) can be written as | |
1159 | # acl B all-of b1 b2 | |
1160 | # acl B all-of b3 b4 | |
1161 | # | |
1162 | # This group ACL is fast if all evaluated ACLs in the group are fast | |
1163 | # and slow otherwise. | |
cf1c09f6 | 1164 | |
e0855596 AJ |
1165 | Examples: |
1166 | acl macaddress arp 09:00:2b:23:45:67 | |
1167 | acl myexample dst_as 1241 | |
1168 | acl password proxy_auth REQUIRED | |
1169 | acl fileupload req_mime_type -i ^multipart/form-data$ | |
1170 | acl javascript rep_mime_type -i ^application/x-javascript$ | |
cccac0a2 | 1171 | |
41bd17a4 | 1172 | NOCOMMENT_START |
e0855596 AJ |
1173 | # |
1174 | # Recommended minimum configuration: | |
1175 | # | |
e0855596 | 1176 | |
ee776778 | 1177 | # Example rule allowing access from your local networks. |
1178 | # Adapt to list your (internal) IP networks from where browsing | |
1179 | # should be allowed | |
1180 | acl localnet src 10.0.0.0/8 # RFC1918 possible internal network | |
1181 | acl localnet src 172.16.0.0/12 # RFC1918 possible internal network | |
1182 | acl localnet src 192.168.0.0/16 # RFC1918 possible internal network | |
055421ee AJ |
1183 | acl localnet src fc00::/7 # RFC 4193 local private network range |
1184 | acl localnet src fe80::/10 # RFC 4291 link-local (directly plugged) machines | |
e0855596 | 1185 | |
41bd17a4 | 1186 | acl SSL_ports port 443 |
1187 | acl Safe_ports port 80 # http | |
1188 | acl Safe_ports port 21 # ftp | |
1189 | acl Safe_ports port 443 # https | |
1190 | acl Safe_ports port 70 # gopher | |
1191 | acl Safe_ports port 210 # wais | |
1192 | acl Safe_ports port 1025-65535 # unregistered ports | |
1193 | acl Safe_ports port 280 # http-mgmt | |
1194 | acl Safe_ports port 488 # gss-http | |
1195 | acl Safe_ports port 591 # filemaker | |
1196 | acl Safe_ports port 777 # multiling http | |
1197 | acl CONNECT method CONNECT | |
1198 | NOCOMMENT_END | |
1199 | DOC_END | |
cccac0a2 | 1200 | |
3d674977 AJ |
1201 | NAME: follow_x_forwarded_for |
1202 | TYPE: acl_access | |
1203 | IFDEF: FOLLOW_X_FORWARDED_FOR | |
1204 | LOC: Config.accessList.followXFF | |
3d674977 | 1205 | DEFAULT_IF_NONE: deny all |
638402dd | 1206 | DEFAULT_DOC: X-Forwarded-For header will be ignored. |
3d674977 AJ |
1207 | DOC_START |
1208 | Allowing or Denying the X-Forwarded-For header to be followed to | |
1209 | find the original source of a request. | |
1210 | ||
1211 | Requests may pass through a chain of several other proxies | |
1212 | before reaching us. The X-Forwarded-For header will contain a | |
1213 | comma-separated list of the IP addresses in the chain, with the | |
1214 | rightmost address being the most recent. | |
1215 | ||
1216 | If a request reaches us from a source that is allowed by this | |
1217 | configuration item, then we consult the X-Forwarded-For header | |
1218 | to see where that host received the request from. If the | |
2bf4e8fa AJ |
1219 | X-Forwarded-For header contains multiple addresses, we continue |
1220 | backtracking until we reach an address for which we are not allowed | |
1221 | to follow the X-Forwarded-For header, or until we reach the first | |
1222 | address in the list. For the purpose of ACL used in the | |
1223 | follow_x_forwarded_for directive the src ACL type always matches | |
1224 | the address we are testing and srcdomain matches its rDNS. | |
3d674977 AJ |
1225 | |
1226 | The end result of this process is an IP address that we will | |
1227 | refer to as the indirect client address. This address may | |
57d76dd4 | 1228 | be treated as the client address for access control, ICAP, delay |
3d674977 | 1229 | pools and logging, depending on the acl_uses_indirect_client, |
96d64448 AJ |
1230 | icap_uses_indirect_client, delay_pool_uses_indirect_client, |
1231 | log_uses_indirect_client and tproxy_uses_indirect_client options. | |
3d674977 | 1232 | |
b3567eb5 FC |
1233 | This clause only supports fast acl types. |
1234 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
1235 | ||
3d674977 AJ |
1236 | SECURITY CONSIDERATIONS: |
1237 | ||
1238 | Any host for which we follow the X-Forwarded-For header | |
1239 | can place incorrect information in the header, and Squid | |
1240 | will use the incorrect information as if it were the | |
1241 | source address of the request. This may enable remote | |
1242 | hosts to bypass any access control restrictions that are | |
1243 | based on the client's source addresses. | |
1244 | ||
1245 | For example: | |
1246 | ||
1247 | acl localhost src 127.0.0.1 | |
1248 | acl my_other_proxy srcdomain .proxy.example.com | |
1249 | follow_x_forwarded_for allow localhost | |
1250 | follow_x_forwarded_for allow my_other_proxy | |
1251 | DOC_END | |
1252 | ||
1253 | NAME: acl_uses_indirect_client | |
1254 | COMMENT: on|off | |
1255 | TYPE: onoff | |
1256 | IFDEF: FOLLOW_X_FORWARDED_FOR | |
1257 | DEFAULT: on | |
1258 | LOC: Config.onoff.acl_uses_indirect_client | |
1259 | DOC_START | |
1260 | Controls whether the indirect client address | |
1261 | (see follow_x_forwarded_for) is used instead of the | |
1262 | direct client address in acl matching. | |
55d0fae8 AJ |
1263 | |
1264 | NOTE: maxconn ACL considers direct TCP links and indirect | |
1265 | clients will always have zero. So no match. | |
3d674977 AJ |
1266 | DOC_END |
1267 | ||
1268 | NAME: delay_pool_uses_indirect_client | |
1269 | COMMENT: on|off | |
1270 | TYPE: onoff | |
9a0a18de | 1271 | IFDEF: FOLLOW_X_FORWARDED_FOR&&USE_DELAY_POOLS |
3d674977 AJ |
1272 | DEFAULT: on |
1273 | LOC: Config.onoff.delay_pool_uses_indirect_client | |
1274 | DOC_START | |
1275 | Controls whether the indirect client address | |
1276 | (see follow_x_forwarded_for) is used instead of the | |
1277 | direct client address in delay pools. | |
1278 | DOC_END | |
1279 | ||
1280 | NAME: log_uses_indirect_client | |
1281 | COMMENT: on|off | |
1282 | TYPE: onoff | |
1283 | IFDEF: FOLLOW_X_FORWARDED_FOR | |
1284 | DEFAULT: on | |
1285 | LOC: Config.onoff.log_uses_indirect_client | |
1286 | DOC_START | |
1287 | Controls whether the indirect client address | |
1288 | (see follow_x_forwarded_for) is used instead of the | |
1289 | direct client address in the access log. | |
1290 | DOC_END | |
1291 | ||
96d64448 AJ |
1292 | NAME: tproxy_uses_indirect_client |
1293 | COMMENT: on|off | |
1294 | TYPE: onoff | |
1295 | IFDEF: FOLLOW_X_FORWARDED_FOR&&LINUX_NETFILTER | |
4d7ab5a2 | 1296 | DEFAULT: off |
96d64448 AJ |
1297 | LOC: Config.onoff.tproxy_uses_indirect_client |
1298 | DOC_START | |
1299 | Controls whether the indirect client address | |
1300 | (see follow_x_forwarded_for) is used instead of the | |
1301 | direct client address when spoofing the outgoing client. | |
4d7ab5a2 AJ |
1302 | |
1303 | This has no effect on requests arriving in non-tproxy | |
1304 | mode ports. | |
1305 | ||
1306 | SECURITY WARNING: Usage of this option is dangerous | |
1307 | and should not be used trivially. Correct configuration | |
b01a2238 | 1308 | of follow_x_forewarded_for with a limited set of trusted |
4d7ab5a2 | 1309 | sources is required to prevent abuse of your proxy. |
96d64448 AJ |
1310 | DOC_END |
1311 | ||
0d901ef4 SH |
1312 | NAME: spoof_client_ip |
1313 | TYPE: acl_access | |
1314 | LOC: Config.accessList.spoof_client_ip | |
1315 | DEFAULT: none | |
1316 | DEFAULT_DOC: Allow spoofing on all TPROXY traffic. | |
1317 | DOC_START | |
1318 | Control client IP address spoofing of TPROXY traffic based on | |
1319 | defined access lists. | |
1320 | ||
1321 | spoof_client_ip allow|deny [!]aclname ... | |
1322 | ||
1323 | If there are no "spoof_client_ip" lines present, the default | |
1324 | is to "allow" spoofing of any suitable request. | |
1325 | ||
1326 | Note that the cache_peer "no-tproxy" option overrides this ACL. | |
1327 | ||
1328 | This clause supports fast acl types. | |
1329 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
1330 | DOC_END | |
1331 | ||
41bd17a4 | 1332 | NAME: http_access |
1333 | TYPE: acl_access | |
1334 | LOC: Config.accessList.http | |
41bd17a4 | 1335 | DEFAULT_IF_NONE: deny all |
638402dd | 1336 | DEFAULT_DOC: Deny, unless rules exist in squid.conf. |
41bd17a4 | 1337 | DOC_START |
1338 | Allowing or Denying access based on defined access lists | |
cccac0a2 | 1339 | |
41bd17a4 | 1340 | Access to the HTTP port: |
1341 | http_access allow|deny [!]aclname ... | |
cccac0a2 | 1342 | |
41bd17a4 | 1343 | NOTE on default values: |
cccac0a2 | 1344 | |
41bd17a4 | 1345 | If there are no "access" lines present, the default is to deny |
1346 | the request. | |
cccac0a2 | 1347 | |
41bd17a4 | 1348 | If none of the "access" lines cause a match, the default is the |
1349 | opposite of the last line in the list. If the last line was | |
1350 | deny, the default is allow. Conversely, if the last line | |
1351 | is allow, the default will be deny. For these reasons, it is a | |
51ae86b2 HN |
1352 | good idea to have an "deny all" entry at the end of your access |
1353 | lists to avoid potential confusion. | |
cccac0a2 | 1354 | |
b3567eb5 FC |
1355 | This clause supports both fast and slow acl types. |
1356 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
1357 | ||
41bd17a4 | 1358 | NOCOMMENT_START |
e0855596 AJ |
1359 | |
1360 | # | |
1361 | # Recommended minimum Access Permission configuration: | |
41bd17a4 | 1362 | # |
e0855596 | 1363 | # Deny requests to certain unsafe ports |
41bd17a4 | 1364 | http_access deny !Safe_ports |
e0855596 AJ |
1365 | |
1366 | # Deny CONNECT to other than secure SSL ports | |
41bd17a4 | 1367 | http_access deny CONNECT !SSL_ports |
e0855596 | 1368 | |
baa3ea7e AJ |
1369 | # Only allow cachemgr access from localhost |
1370 | http_access allow localhost manager | |
1371 | http_access deny manager | |
1372 | ||
41bd17a4 | 1373 | # We strongly recommend the following be uncommented to protect innocent |
1374 | # web applications running on the proxy server who think the only | |
1375 | # one who can access services on "localhost" is a local user | |
1376 | #http_access deny to_localhost | |
e0855596 | 1377 | |
41bd17a4 | 1378 | # |
1379 | # INSERT YOUR OWN RULE(S) HERE TO ALLOW ACCESS FROM YOUR CLIENTS | |
e0855596 | 1380 | # |
c8f4eac4 | 1381 | |
ee776778 | 1382 | # Example rule allowing access from your local networks. |
1383 | # Adapt localnet in the ACL section to list your (internal) IP networks | |
1384 | # from where browsing should be allowed | |
1385 | http_access allow localnet | |
afb33856 | 1386 | http_access allow localhost |
7d90757b | 1387 | |
41bd17a4 | 1388 | # And finally deny all other access to this proxy |
1389 | http_access deny all | |
1390 | NOCOMMENT_END | |
1391 | DOC_END | |
7d90757b | 1392 | |
533493da AJ |
1393 | NAME: adapted_http_access http_access2 |
1394 | TYPE: acl_access | |
1395 | LOC: Config.accessList.adapted_http | |
1396 | DEFAULT: none | |
638402dd | 1397 | DEFAULT_DOC: Allow, unless rules exist in squid.conf. |
533493da AJ |
1398 | DOC_START |
1399 | Allowing or Denying access based on defined access lists | |
1400 | ||
1401 | Essentially identical to http_access, but runs after redirectors | |
1402 | and ICAP/eCAP adaptation. Allowing access control based on their | |
1403 | output. | |
1404 | ||
1405 | If not set then only http_access is used. | |
1406 | DOC_END | |
1407 | ||
41bd17a4 | 1408 | NAME: http_reply_access |
1409 | TYPE: acl_access | |
1410 | LOC: Config.accessList.reply | |
1411 | DEFAULT: none | |
638402dd | 1412 | DEFAULT_DOC: Allow, unless rules exist in squid.conf. |
41bd17a4 | 1413 | DOC_START |
1414 | Allow replies to client requests. This is complementary to http_access. | |
cccac0a2 | 1415 | |
41bd17a4 | 1416 | http_reply_access allow|deny [!] aclname ... |
cccac0a2 | 1417 | |
41bd17a4 | 1418 | NOTE: if there are no access lines present, the default is to allow |
638402dd | 1419 | all replies. |
1a224843 | 1420 | |
41bd17a4 | 1421 | If none of the access lines cause a match the opposite of the |
1422 | last line will apply. Thus it is good practice to end the rules | |
1423 | with an "allow all" or "deny all" entry. | |
b3567eb5 FC |
1424 | |
1425 | This clause supports both fast and slow acl types. | |
1426 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
cccac0a2 | 1427 | DOC_END |
1428 | ||
41bd17a4 | 1429 | NAME: icp_access |
1430 | TYPE: acl_access | |
1431 | LOC: Config.accessList.icp | |
638402dd AJ |
1432 | DEFAULT: none |
1433 | DEFAULT_DOC: Deny, unless rules exist in squid.conf. | |
5473c134 | 1434 | DOC_START |
41bd17a4 | 1435 | Allowing or Denying access to the ICP port based on defined |
1436 | access lists | |
5473c134 | 1437 | |
41bd17a4 | 1438 | icp_access allow|deny [!]aclname ... |
5473c134 | 1439 | |
638402dd AJ |
1440 | NOTE: The default if no icp_access lines are present is to |
1441 | deny all traffic. This default may cause problems with peers | |
1442 | using ICP. | |
41bd17a4 | 1443 | |
b3567eb5 FC |
1444 | This clause only supports fast acl types. |
1445 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
e0855596 AJ |
1446 | |
1447 | # Allow ICP queries from local networks only | |
df2eec10 AJ |
1448 | #icp_access allow localnet |
1449 | #icp_access deny all | |
5473c134 | 1450 | DOC_END |
1451 | ||
41bd17a4 | 1452 | NAME: htcp_access |
1453 | IFDEF: USE_HTCP | |
1454 | TYPE: acl_access | |
1455 | LOC: Config.accessList.htcp | |
638402dd AJ |
1456 | DEFAULT: none |
1457 | DEFAULT_DOC: Deny, unless rules exist in squid.conf. | |
5473c134 | 1458 | DOC_START |
41bd17a4 | 1459 | Allowing or Denying access to the HTCP port based on defined |
1460 | access lists | |
5473c134 | 1461 | |
41bd17a4 | 1462 | htcp_access allow|deny [!]aclname ... |
5473c134 | 1463 | |
638402dd AJ |
1464 | See also htcp_clr_access for details on access control for |
1465 | cache purge (CLR) HTCP messages. | |
5473c134 | 1466 | |
0b48417e | 1467 | NOTE: The default if no htcp_access lines are present is to |
1468 | deny all traffic. This default may cause problems with peers | |
18191440 | 1469 | using the htcp option. |
0b48417e | 1470 | |
b3567eb5 FC |
1471 | This clause only supports fast acl types. |
1472 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
e0855596 AJ |
1473 | |
1474 | # Allow HTCP queries from local networks only | |
df2eec10 AJ |
1475 | #htcp_access allow localnet |
1476 | #htcp_access deny all | |
41bd17a4 | 1477 | DOC_END |
5473c134 | 1478 | |
41bd17a4 | 1479 | NAME: htcp_clr_access |
1480 | IFDEF: USE_HTCP | |
1481 | TYPE: acl_access | |
1482 | LOC: Config.accessList.htcp_clr | |
638402dd AJ |
1483 | DEFAULT: none |
1484 | DEFAULT_DOC: Deny, unless rules exist in squid.conf. | |
41bd17a4 | 1485 | DOC_START |
1486 | Allowing or Denying access to purge content using HTCP based | |
638402dd AJ |
1487 | on defined access lists. |
1488 | See htcp_access for details on general HTCP access control. | |
5473c134 | 1489 | |
41bd17a4 | 1490 | htcp_clr_access allow|deny [!]aclname ... |
5473c134 | 1491 | |
b3567eb5 FC |
1492 | This clause only supports fast acl types. |
1493 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
e0855596 AJ |
1494 | |
1495 | # Allow HTCP CLR requests from trusted peers | |
638402dd | 1496 | acl htcp_clr_peer src 192.0.2.2 2001:DB8::2 |
41bd17a4 | 1497 | htcp_clr_access allow htcp_clr_peer |
638402dd | 1498 | htcp_clr_access deny all |
5473c134 | 1499 | DOC_END |
1500 | ||
41bd17a4 | 1501 | NAME: miss_access |
1502 | TYPE: acl_access | |
1503 | LOC: Config.accessList.miss | |
b8a25eaa | 1504 | DEFAULT: none |
638402dd | 1505 | DEFAULT_DOC: Allow, unless rules exist in squid.conf. |
5473c134 | 1506 | DOC_START |
0b4fb91a AJ |
1507 | Determins whether network access is permitted when satisfying a request. |
1508 | ||
1509 | For example; | |
1510 | to force your neighbors to use you as a sibling instead of | |
1511 | a parent. | |
5473c134 | 1512 | |
638402dd | 1513 | acl localclients src 192.0.2.0/24 2001:DB8::a:0/64 |
41bd17a4 | 1514 | miss_access deny !localclients |
638402dd | 1515 | miss_access allow all |
5473c134 | 1516 | |
0b4fb91a AJ |
1517 | This means only your local clients are allowed to fetch relayed/MISS |
1518 | replies from the network and all other clients can only fetch cached | |
1519 | objects (HITs). | |
1520 | ||
0b4fb91a AJ |
1521 | The default for this setting allows all clients who passed the |
1522 | http_access rules to relay via this proxy. | |
b3567eb5 FC |
1523 | |
1524 | This clause only supports fast acl types. | |
1525 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
41bd17a4 | 1526 | DOC_END |
1527 | ||
1528 | NAME: ident_lookup_access | |
1529 | TYPE: acl_access | |
1530 | IFDEF: USE_IDENT | |
638402dd AJ |
1531 | DEFAULT: none |
1532 | DEFAULT_DOC: Unless rules exist in squid.conf, IDENT is not fetched. | |
4daaf3cb | 1533 | LOC: Ident::TheConfig.identLookup |
5473c134 | 1534 | DOC_START |
41bd17a4 | 1535 | A list of ACL elements which, if matched, cause an ident |
1536 | (RFC 931) lookup to be performed for this request. For | |
1537 | example, you might choose to always perform ident lookups | |
1538 | for your main multi-user Unix boxes, but not for your Macs | |
1539 | and PCs. By default, ident lookups are not performed for | |
1540 | any requests. | |
5473c134 | 1541 | |
41bd17a4 | 1542 | To enable ident lookups for specific client addresses, you |
1543 | can follow this example: | |
5473c134 | 1544 | |
4daaf3cb | 1545 | acl ident_aware_hosts src 198.168.1.0/24 |
41bd17a4 | 1546 | ident_lookup_access allow ident_aware_hosts |
1547 | ident_lookup_access deny all | |
5473c134 | 1548 | |
4daaf3cb | 1549 | Only src type ACL checks are fully supported. A srcdomain |
41bd17a4 | 1550 | ACL might work at times, but it will not always provide |
1551 | the correct result. | |
b3567eb5 FC |
1552 | |
1553 | This clause only supports fast acl types. | |
1554 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
41bd17a4 | 1555 | DOC_END |
5473c134 | 1556 | |
5b0f5383 | 1557 | NAME: reply_body_max_size |
1558 | COMMENT: size [acl acl...] | |
1559 | TYPE: acl_b_size_t | |
1560 | DEFAULT: none | |
638402dd | 1561 | DEFAULT_DOC: No limit is applied. |
5b0f5383 | 1562 | LOC: Config.ReplyBodySize |
1563 | DOC_START | |
1564 | This option specifies the maximum size of a reply body. It can be | |
1565 | used to prevent users from downloading very large files, such as | |
1566 | MP3's and movies. When the reply headers are received, the | |
1567 | reply_body_max_size lines are processed, and the first line where | |
1568 | all (if any) listed ACLs are true is used as the maximum body size | |
1569 | for this reply. | |
1570 | ||
1571 | This size is checked twice. First when we get the reply headers, | |
1572 | we check the content-length value. If the content length value exists | |
1573 | and is larger than the allowed size, the request is denied and the | |
1574 | user receives an error message that says "the request or reply | |
1575 | is too large." If there is no content-length, and the reply | |
1576 | size exceeds this limit, the client's connection is just closed | |
1577 | and they will receive a partial reply. | |
1578 | ||
1579 | WARNING: downstream caches probably can not detect a partial reply | |
1580 | if there is no content-length header, so they will cache | |
1581 | partial responses and give them out as hits. You should NOT | |
1582 | use this option if you have downstream caches. | |
1583 | ||
1584 | WARNING: A maximum size smaller than the size of squid's error messages | |
1585 | will cause an infinite loop and crash squid. Ensure that the smallest | |
1586 | non-zero value you use is greater that the maximum header size plus | |
1587 | the size of your largest error page. | |
1588 | ||
1589 | If you set this parameter none (the default), there will be | |
1590 | no limit imposed. | |
3bc32f2f AJ |
1591 | |
1592 | Configuration Format is: | |
1593 | reply_body_max_size SIZE UNITS [acl ...] | |
1594 | ie. | |
1595 | reply_body_max_size 10 MB | |
1596 | ||
5b0f5383 | 1597 | DOC_END |
1598 | ||
1599 | COMMENT_START | |
1600 | NETWORK OPTIONS | |
1601 | ----------------------------------------------------------------------------- | |
1602 | COMMENT_END | |
1603 | ||
1604 | NAME: http_port ascii_port | |
65d448bc | 1605 | TYPE: PortCfg |
5b0f5383 | 1606 | DEFAULT: none |
1607 | LOC: Config.Sockaddr.http | |
1608 | DOC_START | |
c7b1dd5d AJ |
1609 | Usage: port [mode] [options] |
1610 | hostname:port [mode] [options] | |
1611 | 1.2.3.4:port [mode] [options] | |
5b0f5383 | 1612 | |
1613 | The socket addresses where Squid will listen for HTTP client | |
1614 | requests. You may specify multiple socket addresses. | |
1615 | There are three forms: port alone, hostname with port, and | |
1616 | IP address with port. If you specify a hostname or IP | |
1617 | address, Squid binds the socket to that specific | |
c7b1dd5d | 1618 | address. Most likely, you do not need to bind to a specific |
5b0f5383 | 1619 | address, so you can use the port number alone. |
1620 | ||
1621 | If you are running Squid in accelerator mode, you | |
1622 | probably want to listen on port 80 also, or instead. | |
1623 | ||
1624 | The -a command line option may be used to specify additional | |
1625 | port(s) where Squid listens for proxy request. Such ports will | |
1626 | be plain proxy ports with no options. | |
1627 | ||
1628 | You may specify multiple socket addresses on multiple lines. | |
1629 | ||
c7b1dd5d | 1630 | Modes: |
5b0f5383 | 1631 | |
e77bdb4e | 1632 | intercept Support for IP-Layer interception of |
5b0f5383 | 1633 | outgoing requests without browser settings. |
13b5cd0c | 1634 | NP: disables authentication and IPv6 on the port. |
5b0f5383 | 1635 | |
1636 | tproxy Support Linux TPROXY for spoofing outgoing | |
1637 | connections using the client IP address. | |
6f05d9c8 | 1638 | NP: disables authentication and maybe IPv6 on the port. |
5b0f5383 | 1639 | |
7f45065d | 1640 | accel Accelerator / reverse proxy mode |
5b0f5383 | 1641 | |
caf3666d | 1642 | ssl-bump For each CONNECT request allowed by ssl_bump ACLs, |
c7b1dd5d | 1643 | establish secure connection with the client and with |
caf3666d | 1644 | the server, decrypt HTTPS messages as they pass through |
c7b1dd5d AJ |
1645 | Squid, and treat them as unencrypted HTTP messages, |
1646 | becoming the man-in-the-middle. | |
1647 | ||
7a957a93 | 1648 | The ssl_bump option is required to fully enable |
caf3666d | 1649 | bumping of CONNECT requests. |
c7b1dd5d AJ |
1650 | |
1651 | Omitting the mode flag causes default forward proxy mode to be used. | |
1652 | ||
1653 | ||
1654 | Accelerator Mode Options: | |
1655 | ||
5b0f5383 | 1656 | defaultsite=domainname |
1657 | What to use for the Host: header if it is not present | |
1658 | in a request. Determines what site (not origin server) | |
1659 | accelerators should consider the default. | |
5b0f5383 | 1660 | |
cf673853 | 1661 | no-vhost Disable using HTTP/1.1 Host header for virtual domain support. |
5b0f5383 | 1662 | |
a9f60805 AJ |
1663 | protocol= Protocol to reconstruct accelerated and intercepted |
1664 | requests with. Defaults to HTTP/1.1 for http_port and | |
1665 | HTTPS/1.1 for https_port. | |
1666 | When an unsupported value is configured Squid will | |
1667 | produce a FATAL error. | |
1668 | Values: HTTP or HTTP/1.1, HTTPS or HTTPS/1.1 | |
5b0f5383 | 1669 | |
cf673853 AJ |
1670 | vport Virtual host port support. Using the http_port number |
1671 | instead of the port passed on Host: headers. | |
5b0f5383 | 1672 | |
cf673853 AJ |
1673 | vport=NN Virtual host port support. Using the specified port |
1674 | number instead of the port passed on Host: headers. | |
5b0f5383 | 1675 | |
7f45065d HN |
1676 | act-as-origin |
1677 | Act as if this Squid is the origin server. | |
1678 | This currently means generate new Date: and Expires: | |
1679 | headers on HIT instead of adding Age:. | |
5b0f5383 | 1680 | |
432bc83c HN |
1681 | ignore-cc Ignore request Cache-Control headers. |
1682 | ||
7f45065d | 1683 | WARNING: This option violates HTTP specifications if |
432bc83c HN |
1684 | used in non-accelerator setups. |
1685 | ||
7f45065d HN |
1686 | allow-direct Allow direct forwarding in accelerator mode. Normally |
1687 | accelerated requests are denied direct forwarding as if | |
1688 | never_direct was used. | |
1689 | ||
1690 | WARNING: this option opens accelerator mode to security | |
1691 | vulnerabilities usually only affecting in interception | |
1692 | mode. Make sure to protect forwarding with suitable | |
1693 | http_access rules when using this. | |
1694 | ||
c7b1dd5d AJ |
1695 | |
1696 | SSL Bump Mode Options: | |
859741ed AJ |
1697 | In addition to these options ssl-bump requires TLS/SSL options. |
1698 | ||
1699 | generate-host-certificates[=<on|off>] | |
1700 | Dynamically create SSL server certificates for the | |
1701 | destination hosts of bumped CONNECT requests.When | |
1702 | enabled, the cert and key options are used to sign | |
1703 | generated certificates. Otherwise generated | |
1704 | certificate will be selfsigned. | |
1705 | If there is a CA certificate lifetime of the generated | |
1706 | certificate equals lifetime of the CA certificate. If | |
1707 | generated certificate is selfsigned lifetime is three | |
1708 | years. | |
1709 | This option is enabled by default when ssl-bump is used. | |
1710 | See the ssl-bump option above for more information. | |
1711 | ||
1712 | dynamic_cert_mem_cache_size=SIZE | |
1713 | Approximate total RAM size spent on cached generated | |
1714 | certificates. If set to zero, caching is disabled. The | |
23bb0ebf | 1715 | default value is 4MB. |
859741ed AJ |
1716 | |
1717 | TLS / SSL Options: | |
c7b1dd5d AJ |
1718 | |
1719 | cert= Path to SSL certificate (PEM format). | |
1720 | ||
1721 | key= Path to SSL private key file (PEM format) | |
1722 | if not specified, the certificate file is | |
1723 | assumed to be a combined certificate and | |
1724 | key file. | |
1725 | ||
1726 | version= The version of SSL/TLS supported | |
1727 | 1 automatic (default) | |
1728 | 2 SSLv2 only | |
1729 | 3 SSLv3 only | |
3d96b0e8 AJ |
1730 | 4 TLSv1.0 only |
1731 | 5 TLSv1.1 only | |
1732 | 6 TLSv1.2 only | |
c7b1dd5d AJ |
1733 | |
1734 | cipher= Colon separated list of supported ciphers. | |
bebdc6fb AJ |
1735 | NOTE: some ciphers such as EDH ciphers depend on |
1736 | additional settings. If those settings are | |
1737 | omitted the ciphers may be silently ignored | |
1738 | by the OpenSSL library. | |
c7b1dd5d | 1739 | |
943c5f16 | 1740 | options= Various SSL implementation options. The most important |
c7b1dd5d | 1741 | being: |
3d96b0e8 AJ |
1742 | NO_SSLv2 Disallow the use of SSLv2 |
1743 | NO_SSLv3 Disallow the use of SSLv3 | |
1744 | NO_TLSv1 Disallow the use of TLSv1.0 | |
1745 | NO_TLSv1_1 Disallow the use of TLSv1.1 | |
1746 | NO_TLSv1_2 Disallow the use of TLSv1.2 | |
c7b1dd5d AJ |
1747 | SINGLE_DH_USE Always create a new key when using |
1748 | temporary/ephemeral DH key exchanges | |
943c5f16 HN |
1749 | ALL Enable various bug workarounds |
1750 | suggested as "harmless" by OpenSSL | |
1751 | Be warned that this reduces SSL/TLS | |
1752 | strength to some attacks. | |
bebdc6fb AJ |
1753 | See OpenSSL SSL_CTX_set_options documentation for a |
1754 | complete list of options. | |
c7b1dd5d AJ |
1755 | |
1756 | clientca= File containing the list of CAs to use when | |
1757 | requesting a client certificate. | |
1758 | ||
1759 | cafile= File containing additional CA certificates to | |
1760 | use when verifying client certificates. If unset | |
1761 | clientca will be used. | |
1762 | ||
1763 | capath= Directory containing additional CA certificates | |
1764 | and CRL lists to use when verifying client certificates. | |
1765 | ||
1766 | crlfile= File of additional CRL lists to use when verifying | |
1767 | the client certificate, in addition to CRLs stored in | |
1768 | the capath. Implies VERIFY_CRL flag below. | |
1769 | ||
1770 | dhparams= File containing DH parameters for temporary/ephemeral | |
bebdc6fb AJ |
1771 | DH key exchanges. See OpenSSL documentation for details |
1772 | on how to create this file. | |
1773 | WARNING: EDH ciphers will be silently disabled if this | |
1774 | option is not set. | |
c7b1dd5d AJ |
1775 | |
1776 | sslflags= Various flags modifying the use of SSL: | |
1777 | DELAYED_AUTH | |
1778 | Don't request client certificates | |
1779 | immediately, but wait until acl processing | |
1780 | requires a certificate (not yet implemented). | |
1781 | NO_DEFAULT_CA | |
1782 | Don't use the default CA lists built in | |
1783 | to OpenSSL. | |
1784 | NO_SESSION_REUSE | |
1785 | Don't allow for session reuse. Each connection | |
1786 | will result in a new SSL session. | |
1787 | VERIFY_CRL | |
1788 | Verify CRL lists when accepting client | |
1789 | certificates. | |
1790 | VERIFY_CRL_ALL | |
1791 | Verify CRL lists for all certificates in the | |
1792 | client certificate chain. | |
1793 | ||
1794 | sslcontext= SSL session ID context identifier. | |
1795 | ||
c7b1dd5d AJ |
1796 | Other Options: |
1797 | ||
6b185b50 AJ |
1798 | connection-auth[=on|off] |
1799 | use connection-auth=off to tell Squid to prevent | |
1800 | forwarding Microsoft connection oriented authentication | |
d67acb4e AJ |
1801 | (NTLM, Negotiate and Kerberos) |
1802 | ||
5b0f5383 | 1803 | disable-pmtu-discovery= |
1804 | Control Path-MTU discovery usage: | |
1805 | off lets OS decide on what to do (default). | |
1806 | transparent disable PMTU discovery when transparent | |
1807 | support is enabled. | |
1808 | always disable always PMTU discovery. | |
1809 | ||
1810 | In many setups of transparently intercepting proxies | |
1811 | Path-MTU discovery can not work on traffic towards the | |
1812 | clients. This is the case when the intercepting device | |
1813 | does not fully track connections and fails to forward | |
1814 | ICMP must fragment messages to the cache server. If you | |
1815 | have such setup and experience that certain clients | |
1816 | sporadically hang or never complete requests set | |
1817 | disable-pmtu-discovery option to 'transparent'. | |
1818 | ||
81b6e9a7 | 1819 | name= Specifies a internal name for the port. Defaults to |
1820 | the port specification (port or addr:port) | |
1821 | ||
68924b6d | 1822 | tcpkeepalive[=idle,interval,timeout] |
fb6c6dbe AJ |
1823 | Enable TCP keepalive probes of idle connections. |
1824 | In seconds; idle is the initial time before TCP starts | |
1825 | probing the connection, interval how often to probe, and | |
b2130d58 | 1826 | timeout the time before giving up. |
1827 | ||
5b0f5383 | 1828 | If you run Squid on a dual-homed machine with an internal |
1829 | and an external interface we recommend you to specify the | |
1830 | internal address:port in http_port. This way Squid will only be | |
1831 | visible on the internal address. | |
1832 | ||
1833 | NOCOMMENT_START | |
e0855596 | 1834 | |
5b0f5383 | 1835 | # Squid normally listens to port 3128 |
1836 | http_port @DEFAULT_HTTP_PORT@ | |
1837 | NOCOMMENT_END | |
1838 | DOC_END | |
1839 | ||
1840 | NAME: https_port | |
1841 | IFDEF: USE_SSL | |
65d448bc | 1842 | TYPE: PortCfg |
5b0f5383 | 1843 | DEFAULT: none |
1844 | LOC: Config.Sockaddr.https | |
1845 | DOC_START | |
7f45065d | 1846 | Usage: [ip:]port cert=certificate.pem [key=key.pem] [mode] [options...] |
5b0f5383 | 1847 | |
859741ed AJ |
1848 | The socket address where Squid will listen for client requests made |
1849 | over TLS or SSL connections. Commonly referred to as HTTPS. | |
5b0f5383 | 1850 | |
859741ed AJ |
1851 | This is most useful for situations where you are running squid in |
1852 | accelerator mode and you want to do the SSL work at the accelerator level. | |
5b0f5383 | 1853 | |
1854 | You may specify multiple socket addresses on multiple lines, | |
1855 | each with their own SSL certificate and/or options. | |
1856 | ||
7f45065d | 1857 | Modes: |
5b0f5383 | 1858 | |
7f45065d | 1859 | accel Accelerator / reverse proxy mode |
5b0f5383 | 1860 | |
38450a50 CT |
1861 | intercept Support for IP-Layer interception of |
1862 | outgoing requests without browser settings. | |
1863 | NP: disables authentication and IPv6 on the port. | |
1864 | ||
379e8c1c AR |
1865 | tproxy Support Linux TPROXY for spoofing outgoing |
1866 | connections using the client IP address. | |
1867 | NP: disables authentication and maybe IPv6 on the port. | |
1868 | ||
caf3666d | 1869 | ssl-bump For each intercepted connection allowed by ssl_bump |
7a957a93 | 1870 | ACLs, establish a secure connection with the client and with |
caf3666d | 1871 | the server, decrypt HTTPS messages as they pass through |
379e8c1c AR |
1872 | Squid, and treat them as unencrypted HTTP messages, |
1873 | becoming the man-in-the-middle. | |
1874 | ||
caf3666d AR |
1875 | An "ssl_bump server-first" match is required to |
1876 | fully enable bumping of intercepted SSL connections. | |
379e8c1c | 1877 | |
38450a50 | 1878 | Requires tproxy or intercept. |
379e8c1c | 1879 | |
7f45065d | 1880 | Omitting the mode flag causes default forward proxy mode to be used. |
5b0f5383 | 1881 | |
5b0f5383 | 1882 | |
7f45065d HN |
1883 | See http_port for a list of generic options |
1884 | ||
1885 | ||
1886 | SSL Options: | |
5b0f5383 | 1887 | |
1888 | cert= Path to SSL certificate (PEM format). | |
1889 | ||
1890 | key= Path to SSL private key file (PEM format) | |
1891 | if not specified, the certificate file is | |
1892 | assumed to be a combined certificate and | |
1893 | key file. | |
1894 | ||
1895 | version= The version of SSL/TLS supported | |
1896 | 1 automatic (default) | |
1897 | 2 SSLv2 only | |
1898 | 3 SSLv3 only | |
1899 | 4 TLSv1 only | |
1900 | ||
1901 | cipher= Colon separated list of supported ciphers. | |
1902 | ||
1903 | options= Various SSL engine options. The most important | |
1904 | being: | |
1905 | NO_SSLv2 Disallow the use of SSLv2 | |
1906 | NO_SSLv3 Disallow the use of SSLv3 | |
1907 | NO_TLSv1 Disallow the use of TLSv1 | |
1908 | SINGLE_DH_USE Always create a new key when using | |
1909 | temporary/ephemeral DH key exchanges | |
1910 | See src/ssl_support.c or OpenSSL SSL_CTX_set_options | |
1911 | documentation for a complete list of options. | |
1912 | ||
1913 | clientca= File containing the list of CAs to use when | |
1914 | requesting a client certificate. | |
1915 | ||
1916 | cafile= File containing additional CA certificates to | |
1917 | use when verifying client certificates. If unset | |
1918 | clientca will be used. | |
1919 | ||
1920 | capath= Directory containing additional CA certificates | |
1921 | and CRL lists to use when verifying client certificates. | |
1922 | ||
1923 | crlfile= File of additional CRL lists to use when verifying | |
1924 | the client certificate, in addition to CRLs stored in | |
1925 | the capath. Implies VERIFY_CRL flag below. | |
1926 | ||
1927 | dhparams= File containing DH parameters for temporary/ephemeral | |
1928 | DH key exchanges. | |
1929 | ||
1930 | sslflags= Various flags modifying the use of SSL: | |
1931 | DELAYED_AUTH | |
1932 | Don't request client certificates | |
1933 | immediately, but wait until acl processing | |
1934 | requires a certificate (not yet implemented). | |
1935 | NO_DEFAULT_CA | |
1936 | Don't use the default CA lists built in | |
1937 | to OpenSSL. | |
1938 | NO_SESSION_REUSE | |
1939 | Don't allow for session reuse. Each connection | |
1940 | will result in a new SSL session. | |
1941 | VERIFY_CRL | |
1942 | Verify CRL lists when accepting client | |
1943 | certificates. | |
1944 | VERIFY_CRL_ALL | |
1945 | Verify CRL lists for all certificates in the | |
1946 | client certificate chain. | |
1947 | ||
1948 | sslcontext= SSL session ID context identifier. | |
1949 | ||
379e8c1c AR |
1950 | generate-host-certificates[=<on|off>] |
1951 | Dynamically create SSL server certificates for the | |
1952 | destination hosts of bumped SSL requests.When | |
1953 | enabled, the cert and key options are used to sign | |
1954 | generated certificates. Otherwise generated | |
1955 | certificate will be selfsigned. | |
1956 | If there is CA certificate life time of generated | |
1957 | certificate equals lifetime of CA certificate. If | |
1958 | generated certificate is selfsigned lifetime is three | |
1959 | years. | |
1960 | This option is enabled by default when SslBump is used. | |
1961 | See the sslBump option above for more information. | |
1962 | ||
1963 | dynamic_cert_mem_cache_size=SIZE | |
1964 | Approximate total RAM size spent on cached generated | |
1965 | certificates. If set to zero, caching is disabled. The | |
23bb0ebf | 1966 | default value is 4MB. |
379e8c1c | 1967 | |
859741ed | 1968 | See http_port for a list of available options. |
5b0f5383 | 1969 | DOC_END |
1970 | ||
41bd17a4 | 1971 | NAME: tcp_outgoing_tos tcp_outgoing_ds tcp_outgoing_dscp |
1972 | TYPE: acl_tos | |
5473c134 | 1973 | DEFAULT: none |
425de4c8 | 1974 | LOC: Ip::Qos::TheConfig.tosToServer |
5473c134 | 1975 | DOC_START |
425de4c8 AJ |
1976 | Allows you to select a TOS/Diffserv value for packets outgoing |
1977 | on the server side, based on an ACL. | |
5473c134 | 1978 | |
41bd17a4 | 1979 | tcp_outgoing_tos ds-field [!]aclname ... |
cccac0a2 | 1980 | |
41bd17a4 | 1981 | Example where normal_service_net uses the TOS value 0x00 |
7def7206 | 1982 | and good_service_net uses 0x20 |
cccac0a2 | 1983 | |
864a62b5 AJ |
1984 | acl normal_service_net src 10.0.0.0/24 |
1985 | acl good_service_net src 10.0.1.0/24 | |
2c73de90 | 1986 | tcp_outgoing_tos 0x00 normal_service_net |
41bd17a4 | 1987 | tcp_outgoing_tos 0x20 good_service_net |
fa38076e | 1988 | |
41bd17a4 | 1989 | TOS/DSCP values really only have local significance - so you should |
575cb927 AJ |
1990 | know what you're specifying. For more information, see RFC2474, |
1991 | RFC2475, and RFC3260. | |
cccac0a2 | 1992 | |
41bd17a4 | 1993 | The TOS/DSCP byte must be exactly that - a octet value 0 - 255, or |
1994 | "default" to use whatever default your host has. Note that in | |
864a62b5 AJ |
1995 | practice often only multiples of 4 is usable as the two rightmost bits |
1996 | have been redefined for use by ECN (RFC 3168 section 23.1). | |
cccac0a2 | 1997 | |
41bd17a4 | 1998 | Processing proceeds in the order specified, and stops at first fully |
1999 | matching line. | |
cccac0a2 | 2000 | DOC_END |
2001 | ||
41bd17a4 | 2002 | NAME: clientside_tos |
2003 | TYPE: acl_tos | |
cccac0a2 | 2004 | DEFAULT: none |
425de4c8 AJ |
2005 | LOC: Ip::Qos::TheConfig.tosToClient |
2006 | DOC_START | |
2007 | Allows you to select a TOS/Diffserv value for packets being transmitted | |
2008 | on the client-side, based on an ACL. | |
2009 | ||
2010 | clientside_tos ds-field [!]aclname ... | |
2011 | ||
2012 | Example where normal_service_net uses the TOS value 0x00 | |
2013 | and good_service_net uses 0x20 | |
2014 | ||
2015 | acl normal_service_net src 10.0.0.0/24 | |
2016 | acl good_service_net src 10.0.1.0/24 | |
2017 | clientside_tos 0x00 normal_service_net | |
2018 | clientside_tos 0x20 good_service_net | |
2019 | ||
2020 | Note: This feature is incompatible with qos_flows. Any TOS values set here | |
2021 | will be overwritten by TOS values in qos_flows. | |
2022 | DOC_END | |
2023 | ||
2024 | NAME: tcp_outgoing_mark | |
2025 | TYPE: acl_nfmark | |
11e8cfe3 | 2026 | IFDEF: SO_MARK&&USE_LIBCAP |
425de4c8 AJ |
2027 | DEFAULT: none |
2028 | LOC: Ip::Qos::TheConfig.nfmarkToServer | |
2029 | DOC_START | |
2030 | Allows you to apply a Netfilter mark value to outgoing packets | |
2031 | on the server side, based on an ACL. | |
2032 | ||
2033 | tcp_outgoing_mark mark-value [!]aclname ... | |
2034 | ||
2035 | Example where normal_service_net uses the mark value 0x00 | |
2036 | and good_service_net uses 0x20 | |
2037 | ||
2038 | acl normal_service_net src 10.0.0.0/24 | |
2039 | acl good_service_net src 10.0.1.0/24 | |
2040 | tcp_outgoing_mark 0x00 normal_service_net | |
2041 | tcp_outgoing_mark 0x20 good_service_net | |
2042 | DOC_END | |
2043 | ||
2044 | NAME: clientside_mark | |
2045 | TYPE: acl_nfmark | |
11e8cfe3 | 2046 | IFDEF: SO_MARK&&USE_LIBCAP |
425de4c8 AJ |
2047 | DEFAULT: none |
2048 | LOC: Ip::Qos::TheConfig.nfmarkToClient | |
cccac0a2 | 2049 | DOC_START |
425de4c8 AJ |
2050 | Allows you to apply a Netfilter mark value to packets being transmitted |
2051 | on the client-side, based on an ACL. | |
2052 | ||
2053 | clientside_mark mark-value [!]aclname ... | |
2054 | ||
2055 | Example where normal_service_net uses the mark value 0x00 | |
2056 | and good_service_net uses 0x20 | |
2057 | ||
2058 | acl normal_service_net src 10.0.0.0/24 | |
2059 | acl good_service_net src 10.0.1.0/24 | |
2060 | clientside_mark 0x00 normal_service_net | |
2061 | clientside_mark 0x20 good_service_net | |
2062 | ||
2063 | Note: This feature is incompatible with qos_flows. Any mark values set here | |
2064 | will be overwritten by mark values in qos_flows. | |
41bd17a4 | 2065 | DOC_END |
cccac0a2 | 2066 | |
575cb927 AJ |
2067 | NAME: qos_flows |
2068 | TYPE: QosConfig | |
425de4c8 | 2069 | IFDEF: USE_QOS_TOS |
575cb927 | 2070 | DEFAULT: none |
b7ac5457 | 2071 | LOC: Ip::Qos::TheConfig |
7172612f | 2072 | DOC_START |
575cb927 | 2073 | Allows you to select a TOS/DSCP value to mark outgoing |
425de4c8 AJ |
2074 | connections with, based on where the reply was sourced. For |
2075 | platforms using netfilter, allows you to set a netfilter mark | |
2076 | value instead of, or in addition to, a TOS value. | |
7172612f | 2077 | |
575cb927 AJ |
2078 | TOS values really only have local significance - so you should |
2079 | know what you're specifying. For more information, see RFC2474, | |
2080 | RFC2475, and RFC3260. | |
7172612f | 2081 | |
425de4c8 AJ |
2082 | The TOS/DSCP byte must be exactly that - a octet value 0 - 255. Note that |
2083 | in practice often only multiples of 4 is usable as the two rightmost bits | |
2084 | have been redefined for use by ECN (RFC 3168 section 23.1). | |
2085 | ||
2086 | Mark values can be any unsigned 32-bit integer value. | |
7172612f | 2087 | |
425de4c8 AJ |
2088 | This setting is configured by setting the following values: |
2089 | ||
2090 | tos|mark Whether to set TOS or netfilter mark values | |
575cb927 AJ |
2091 | |
2092 | local-hit=0xFF Value to mark local cache hits. | |
2093 | ||
2094 | sibling-hit=0xFF Value to mark hits from sibling peers. | |
2095 | ||
2096 | parent-hit=0xFF Value to mark hits from parent peers. | |
2097 | ||
a29d2a95 AB |
2098 | miss=0xFF[/mask] Value to mark cache misses. Takes precedence |
2099 | over the preserve-miss feature (see below), unless | |
2100 | mask is specified, in which case only the bits | |
2101 | specified in the mask are written. | |
575cb927 | 2102 | |
425de4c8 AJ |
2103 | The TOS variant of the following features are only possible on Linux |
2104 | and require your kernel to be patched with the TOS preserving ZPH | |
2105 | patch, available from http://zph.bratcheda.org | |
2106 | No patch is needed to preserve the netfilter mark, which will work | |
2107 | with all variants of netfilter. | |
575cb927 | 2108 | |
575cb927 | 2109 | disable-preserve-miss |
425de4c8 AJ |
2110 | This option disables the preservation of the TOS or netfilter |
2111 | mark. By default, the existing TOS or netfilter mark value of | |
2112 | the response coming from the remote server will be retained | |
2113 | and masked with miss-mark. | |
2114 | NOTE: in the case of a netfilter mark, the mark must be set on | |
2115 | the connection (using the CONNMARK target) not on the packet | |
2116 | (MARK target). | |
575cb927 AJ |
2117 | |
2118 | miss-mask=0xFF | |
425de4c8 AJ |
2119 | Allows you to mask certain bits in the TOS or mark value |
2120 | received from the remote server, before copying the value to | |
2121 | the TOS sent towards clients. | |
2122 | Default for tos: 0xFF (TOS from server is not changed). | |
2123 | Default for mark: 0xFFFFFFFF (mark from server is not changed). | |
2124 | ||
2125 | All of these features require the --enable-zph-qos compilation flag | |
2126 | (enabled by default). Netfilter marking also requires the | |
2127 | libnetfilter_conntrack libraries (--with-netfilter-conntrack) and | |
2128 | libcap 2.09+ (--with-libcap). | |
7172612f | 2129 | |
7172612f AJ |
2130 | DOC_END |
2131 | ||
41bd17a4 | 2132 | NAME: tcp_outgoing_address |
2133 | TYPE: acl_address | |
2134 | DEFAULT: none | |
638402dd | 2135 | DEFAULT_DOC: Address selection is performed by the operating system. |
41bd17a4 | 2136 | LOC: Config.accessList.outgoing_address |
2137 | DOC_START | |
2138 | Allows you to map requests to different outgoing IP addresses | |
2139 | based on the username or source address of the user making | |
2140 | the request. | |
7f7db318 | 2141 | |
41bd17a4 | 2142 | tcp_outgoing_address ipaddr [[!]aclname] ... |
c33aa074 | 2143 | |
2dd51400 AJ |
2144 | For example; |
2145 | Forwarding clients with dedicated IPs for certain subnets. | |
9197cd13 | 2146 | |
2dd51400 AJ |
2147 | acl normal_service_net src 10.0.0.0/24 |
2148 | acl good_service_net src 10.0.2.0/24 | |
2149 | ||
2150 | tcp_outgoing_address 2001:db8::c001 good_service_net | |
2151 | tcp_outgoing_address 10.1.0.2 good_service_net | |
2152 | ||
2153 | tcp_outgoing_address 2001:db8::beef normal_service_net | |
2154 | tcp_outgoing_address 10.1.0.1 normal_service_net | |
2155 | ||
2156 | tcp_outgoing_address 2001:db8::1 | |
2157 | tcp_outgoing_address 10.1.0.3 | |
9197cd13 | 2158 | |
41bd17a4 | 2159 | Processing proceeds in the order specified, and stops at first fully |
2160 | matching line. | |
cccac0a2 | 2161 | |
2dd51400 AJ |
2162 | Squid will add an implicit IP version test to each line. |
2163 | Requests going to IPv4 websites will use the outgoing 10.1.0.* addresses. | |
2164 | Requests going to IPv6 websites will use the outgoing 2001:db8:* addresses. | |
2165 | ||
2166 | ||
2167 | NOTE: The use of this directive using client dependent ACLs is | |
41bd17a4 | 2168 | incompatible with the use of server side persistent connections. To |
2169 | ensure correct results it is best to set server_persistent_connections | |
2170 | to off when using this directive in such configurations. | |
cc192b50 | 2171 | |
2dd51400 | 2172 | NOTE: The use of this directive to set a local IP on outgoing TCP links |
4ed968be | 2173 | is incompatible with using TPROXY to set client IP out outbound TCP links. |
2dd51400 AJ |
2174 | When needing to contact peers use the no-tproxy cache_peer option and the |
2175 | client_dst_passthru directive re-enable normal forwarding such as this. | |
cc192b50 | 2176 | |
cccac0a2 | 2177 | DOC_END |
6db78a1a | 2178 | |
90529125 AJ |
2179 | NAME: host_verify_strict |
2180 | TYPE: onoff | |
2181 | DEFAULT: off | |
2182 | LOC: Config.onoff.hostStrictVerify | |
2183 | DOC_START | |
d8821934 AR |
2184 | Regardless of this option setting, when dealing with intercepted |
2185 | traffic, Squid always verifies that the destination IP address matches | |
2962f8b8 | 2186 | the Host header domain or IP (called 'authority form URL'). |
d8821934 AR |
2187 | |
2188 | This enforcement is performed to satisfy a MUST-level requirement in | |
2189 | RFC 2616 section 14.23: "The Host field value MUST represent the naming | |
2190 | authority of the origin server or gateway given by the original URL". | |
2962f8b8 AJ |
2191 | |
2192 | When set to ON: | |
2193 | Squid always responds with an HTTP 409 (Conflict) error | |
2194 | page and logs a security warning if there is no match. | |
2195 | ||
2196 | Squid verifies that the destination IP address matches | |
2197 | the Host header for forward-proxy and reverse-proxy traffic | |
2198 | as well. For those traffic types, Squid also enables the | |
2199 | following checks, comparing the corresponding Host header | |
2200 | and Request-URI components: | |
2201 | ||
2202 | * The host names (domain or IP) must be identical, | |
2203 | but valueless or missing Host header disables all checks. | |
2204 | For the two host names to match, both must be either IP | |
2205 | or FQDN. | |
2206 | ||
2207 | * Port numbers must be identical, but if a port is missing | |
2208 | the scheme-default port is assumed. | |
2209 | ||
2210 | ||
2211 | When set to OFF (the default): | |
2212 | Squid allows suspicious requests to continue but logs a | |
2213 | security warning and blocks caching of the response. | |
2214 | ||
2215 | * Forward-proxy traffic is not checked at all. | |
2216 | ||
2217 | * Reverse-proxy traffic is not checked at all. | |
2218 | ||
2219 | * Intercepted traffic which passes verification is handled | |
32c32865 | 2220 | according to client_dst_passthru. |
2962f8b8 | 2221 | |
7177edfb AJ |
2222 | * Intercepted requests which fail verification are sent |
2223 | to the client original destination instead of DIRECT. | |
2224 | This overrides 'client_dst_passthru off'. | |
2962f8b8 AJ |
2225 | |
2226 | For now suspicious intercepted CONNECT requests are always | |
2227 | responded to with an HTTP 409 (Conflict) error page. | |
bfe4e2fe | 2228 | |
bfe4e2fe | 2229 | |
7177edfb | 2230 | SECURITY NOTE: |
bfe4e2fe AJ |
2231 | |
2232 | As described in CVE-2009-0801 when the Host: header alone is used | |
2233 | to determine the destination of a request it becomes trivial for | |
2234 | malicious scripts on remote websites to bypass browser same-origin | |
2235 | security policy and sandboxing protections. | |
2236 | ||
2237 | The cause of this is that such applets are allowed to perform their | |
2238 | own HTTP stack, in which case the same-origin policy of the browser | |
2239 | sandbox only verifies that the applet tries to contact the same IP | |
2240 | as from where it was loaded at the IP level. The Host: header may | |
2241 | be different from the connected IP and approved origin. | |
7177edfb AJ |
2242 | |
2243 | DOC_END | |
6b185b50 | 2244 | |
7177edfb AJ |
2245 | NAME: client_dst_passthru |
2246 | TYPE: onoff | |
2247 | DEFAULT: on | |
2248 | LOC: Config.onoff.client_dst_passthru | |
2249 | DOC_START | |
2250 | With NAT or TPROXY intercepted traffic Squid may pass the request | |
2251 | directly to the original client destination IP or seek a faster | |
2252 | source using the HTTP Host header. | |
2253 | ||
2254 | Using Host to locate alternative servers can provide faster | |
2255 | connectivity with a range of failure recovery options. | |
2256 | But can also lead to connectivity trouble when the client and | |
2257 | server are attempting stateful interactions unaware of the proxy. | |
2258 | ||
2259 | This option (on by default) prevents alternative DNS entries being | |
2260 | located to send intercepted traffic DIRECT to an origin server. | |
2261 | The clients original destination IP and port will be used instead. | |
2262 | ||
2263 | Regardless of this option setting, when dealing with intercepted | |
2264 | traffic Squid will verify the Host: header and any traffic which | |
2265 | fails Host verification will be treated as if this option were ON. | |
2266 | ||
2267 | see host_verify_strict for details on the verification process. | |
cccac0a2 | 2268 | DOC_END |
2269 | ||
41bd17a4 | 2270 | COMMENT_START |
2271 | SSL OPTIONS | |
2272 | ----------------------------------------------------------------------------- | |
2273 | COMMENT_END | |
2274 | ||
2275 | NAME: ssl_unclean_shutdown | |
2276 | IFDEF: USE_SSL | |
cccac0a2 | 2277 | TYPE: onoff |
2278 | DEFAULT: off | |
41bd17a4 | 2279 | LOC: Config.SSL.unclean_shutdown |
cccac0a2 | 2280 | DOC_START |
41bd17a4 | 2281 | Some browsers (especially MSIE) bugs out on SSL shutdown |
2282 | messages. | |
cccac0a2 | 2283 | DOC_END |
2284 | ||
41bd17a4 | 2285 | NAME: ssl_engine |
2286 | IFDEF: USE_SSL | |
cccac0a2 | 2287 | TYPE: string |
41bd17a4 | 2288 | LOC: Config.SSL.ssl_engine |
2289 | DEFAULT: none | |
cccac0a2 | 2290 | DOC_START |
41bd17a4 | 2291 | The OpenSSL engine to use. You will need to set this if you |
2292 | would like to use hardware SSL acceleration for example. | |
cccac0a2 | 2293 | DOC_END |
2294 | ||
41bd17a4 | 2295 | NAME: sslproxy_client_certificate |
2296 | IFDEF: USE_SSL | |
cccac0a2 | 2297 | DEFAULT: none |
41bd17a4 | 2298 | LOC: Config.ssl_client.cert |
2299 | TYPE: string | |
cccac0a2 | 2300 | DOC_START |
41bd17a4 | 2301 | Client SSL Certificate to use when proxying https:// URLs |
cccac0a2 | 2302 | DOC_END |
2303 | ||
41bd17a4 | 2304 | NAME: sslproxy_client_key |
2305 | IFDEF: USE_SSL | |
cccac0a2 | 2306 | DEFAULT: none |
41bd17a4 | 2307 | LOC: Config.ssl_client.key |
2308 | TYPE: string | |
cccac0a2 | 2309 | DOC_START |
41bd17a4 | 2310 | Client SSL Key to use when proxying https:// URLs |
cccac0a2 | 2311 | DOC_END |
2312 | ||
41bd17a4 | 2313 | NAME: sslproxy_version |
2314 | IFDEF: USE_SSL | |
2315 | DEFAULT: 1 | |
638402dd | 2316 | DEFAULT_DOC: automatic SSL/TLS version negotiation |
41bd17a4 | 2317 | LOC: Config.ssl_client.version |
2318 | TYPE: int | |
cccac0a2 | 2319 | DOC_START |
41bd17a4 | 2320 | SSL version level to use when proxying https:// URLs |
3d96b0e8 AJ |
2321 | |
2322 | The versions of SSL/TLS supported: | |
2323 | ||
2324 | 1 automatic (default) | |
2325 | 2 SSLv2 only | |
2326 | 3 SSLv3 only | |
2327 | 4 TLSv1.0 only | |
2328 | 5 TLSv1.1 only | |
2329 | 6 TLSv1.2 only | |
cccac0a2 | 2330 | DOC_END |
2331 | ||
41bd17a4 | 2332 | NAME: sslproxy_options |
2333 | IFDEF: USE_SSL | |
2334 | DEFAULT: none | |
2335 | LOC: Config.ssl_client.options | |
2336 | TYPE: string | |
cccac0a2 | 2337 | DOC_START |
943c5f16 | 2338 | SSL implementation options to use when proxying https:// URLs |
ab202e4c AJ |
2339 | |
2340 | The most important being: | |
2341 | ||
3d96b0e8 AJ |
2342 | NO_SSLv2 Disallow the use of SSLv2 |
2343 | NO_SSLv3 Disallow the use of SSLv3 | |
2344 | NO_TLSv1 Disallow the use of TLSv1.0 | |
2345 | NO_TLSv1_1 Disallow the use of TLSv1.1 | |
2346 | NO_TLSv1_2 Disallow the use of TLSv1.2 | |
943c5f16 HN |
2347 | SINGLE_DH_USE |
2348 | Always create a new key when using temporary/ephemeral | |
2349 | DH key exchanges | |
2350 | SSL_OP_NO_TICKET | |
2351 | Disable use of RFC5077 session tickets. Some servers | |
2352 | may have problems understanding the TLS extension due | |
2353 | to ambiguous specification in RFC4507. | |
2354 | ALL Enable various bug workarounds suggested as "harmless" | |
2355 | by OpenSSL. Be warned that this may reduce SSL/TLS | |
2356 | strength to some attacks. | |
ab202e4c | 2357 | |
ab202e4c AJ |
2358 | See the OpenSSL SSL_CTX_set_options documentation for a |
2359 | complete list of possible options. | |
cccac0a2 | 2360 | DOC_END |
2361 | ||
41bd17a4 | 2362 | NAME: sslproxy_cipher |
2363 | IFDEF: USE_SSL | |
2364 | DEFAULT: none | |
2365 | LOC: Config.ssl_client.cipher | |
2366 | TYPE: string | |
cccac0a2 | 2367 | DOC_START |
41bd17a4 | 2368 | SSL cipher list to use when proxying https:// URLs |
ab202e4c AJ |
2369 | |
2370 | Colon separated list of supported ciphers. | |
cccac0a2 | 2371 | DOC_END |
2372 | ||
41bd17a4 | 2373 | NAME: sslproxy_cafile |
2374 | IFDEF: USE_SSL | |
2375 | DEFAULT: none | |
2376 | LOC: Config.ssl_client.cafile | |
2377 | TYPE: string | |
cccac0a2 | 2378 | DOC_START |
41bd17a4 | 2379 | file containing CA certificates to use when verifying server |
2380 | certificates while proxying https:// URLs | |
cccac0a2 | 2381 | DOC_END |
0976f8db | 2382 | |
41bd17a4 | 2383 | NAME: sslproxy_capath |
2384 | IFDEF: USE_SSL | |
5473c134 | 2385 | DEFAULT: none |
41bd17a4 | 2386 | LOC: Config.ssl_client.capath |
2387 | TYPE: string | |
5473c134 | 2388 | DOC_START |
41bd17a4 | 2389 | directory containing CA certificates to use when verifying |
2390 | server certificates while proxying https:// URLs | |
5473c134 | 2391 | DOC_END |
2392 | ||
10a69fc0 CT |
2393 | NAME: sslproxy_session_ttl |
2394 | IFDEF: USE_SSL | |
2395 | DEFAULT: 300 | |
2396 | LOC: Config.SSL.session_ttl | |
2397 | TYPE: int | |
2398 | DOC_START | |
2399 | Sets the timeout value for SSL sessions | |
2400 | DOC_END | |
2401 | ||
2402 | NAME: sslproxy_session_cache_size | |
2403 | IFDEF: USE_SSL | |
2404 | DEFAULT: 2 MB | |
2405 | LOC: Config.SSL.sessionCacheSize | |
2406 | TYPE: b_size_t | |
2407 | DOC_START | |
2408 | Sets the cache size to use for ssl session | |
2409 | DOC_END | |
2410 | ||
4c9da963 | 2411 | NAME: ssl_bump |
2412 | IFDEF: USE_SSL | |
caf3666d | 2413 | TYPE: sslproxy_ssl_bump |
4c9da963 | 2414 | LOC: Config.accessList.ssl_bump |
638402dd | 2415 | DEFAULT_DOC: Does not bump unless rules are present in squid.conf |
4c9da963 | 2416 | DEFAULT: none |
2417 | DOC_START | |
caf3666d AR |
2418 | This option is consulted when a CONNECT request is received on |
2419 | an http_port (or a new connection is intercepted at an | |
2420 | https_port), provided that port was configured with an ssl-bump | |
2421 | flag. The subsequent data on the connection is either treated as | |
2422 | HTTPS and decrypted OR tunneled at TCP level without decryption, | |
2423 | depending on the first bumping "mode" which ACLs match. | |
2424 | ||
2425 | ssl_bump <mode> [!]acl ... | |
2426 | ||
2427 | The following bumping modes are supported: | |
2428 | ||
2429 | client-first | |
2430 | Allow bumping of the connection. Establish a secure connection | |
2431 | with the client first, then connect to the server. This old mode | |
2432 | does not allow Squid to mimic server SSL certificate and does | |
2433 | not work with intercepted SSL connections. | |
2434 | ||
2435 | server-first | |
2436 | Allow bumping of the connection. Establish a secure connection | |
2437 | with the server first, then establish a secure connection with | |
2438 | the client, using a mimicked server certificate. Works with both | |
2439 | CONNECT requests and intercepted SSL connections. | |
2440 | ||
2441 | none | |
2442 | Become a TCP tunnel without decoding the connection. | |
2443 | Works with both CONNECT requests and intercepted SSL | |
2444 | connections. This is the default behavior when no | |
2445 | ssl_bump option is given or no ssl_bump ACLs match. | |
2446 | ||
2447 | By default, no connections are bumped. | |
2448 | ||
2449 | The first matching ssl_bump option wins. If no ACLs match, the | |
2450 | connection is not bumped. Unlike most allow/deny ACL lists, ssl_bump | |
2451 | does not have an implicit "negate the last given option" rule. You | |
2452 | must make that rule explicit if you convert old ssl_bump allow/deny | |
2453 | rules that rely on such an implicit rule. | |
4c9da963 | 2454 | |
e0c0d54c | 2455 | This clause supports both fast and slow acl types. |
b3567eb5 | 2456 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. |
e0855596 | 2457 | |
caf3666d AR |
2458 | See also: http_port ssl-bump, https_port ssl-bump |
2459 | ||
e0855596 | 2460 | |
caf3666d | 2461 | # Example: Bump all requests except those originating from |
638402dd | 2462 | # localhost or those going to example.com. |
e0855596 | 2463 | |
e0855596 | 2464 | acl broken_sites dstdomain .example.com |
caf3666d AR |
2465 | ssl_bump none localhost |
2466 | ssl_bump none broken_sites | |
2467 | ssl_bump server-first all | |
4c9da963 | 2468 | DOC_END |
2469 | ||
41bd17a4 | 2470 | NAME: sslproxy_flags |
2471 | IFDEF: USE_SSL | |
2472 | DEFAULT: none | |
2473 | LOC: Config.ssl_client.flags | |
2474 | TYPE: string | |
5473c134 | 2475 | DOC_START |
41bd17a4 | 2476 | Various flags modifying the use of SSL while proxying https:// URLs: |
4c9da963 | 2477 | DONT_VERIFY_PEER Accept certificates that fail verification. |
2478 | For refined control, see sslproxy_cert_error. | |
41bd17a4 | 2479 | NO_DEFAULT_CA Don't use the default CA list built in |
2480 | to OpenSSL. | |
5473c134 | 2481 | DOC_END |
2482 | ||
4c9da963 | 2483 | NAME: sslproxy_cert_error |
2484 | IFDEF: USE_SSL | |
2485 | DEFAULT: none | |
638402dd | 2486 | DEFAULT_DOC: Server certificate errors terminate the transaction. |
4c9da963 | 2487 | LOC: Config.ssl_client.cert_error |
2488 | TYPE: acl_access | |
2489 | DOC_START | |
2490 | Use this ACL to bypass server certificate validation errors. | |
2491 | ||
2492 | For example, the following lines will bypass all validation errors | |
3b8f558c | 2493 | when talking to servers for example.com. All other |
4c9da963 | 2494 | validation errors will result in ERR_SECURE_CONNECT_FAIL error. |
2495 | ||
a87bfd3b AR |
2496 | acl BrokenButTrustedServers dstdomain example.com |
2497 | sslproxy_cert_error allow BrokenButTrustedServers | |
4c9da963 | 2498 | sslproxy_cert_error deny all |
2499 | ||
b3567eb5 FC |
2500 | This clause only supports fast acl types. |
2501 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
2502 | Using slow acl types may result in server crashes | |
4c9da963 | 2503 | |
2504 | Without this option, all server certificate validation errors | |
638402dd | 2505 | terminate the transaction to protect Squid and the client. |
4c9da963 | 2506 | |
0ad3ff51 CT |
2507 | SQUID_X509_V_ERR_INFINITE_VALIDATION error cannot be bypassed |
2508 | but should not happen unless your OpenSSL library is buggy. | |
2509 | ||
638402dd AJ |
2510 | SECURITY WARNING: |
2511 | Bypassing validation errors is dangerous because an | |
2512 | error usually implies that the server cannot be trusted | |
2513 | and the connection may be insecure. | |
4c9da963 | 2514 | |
638402dd | 2515 | See also: sslproxy_flags and DONT_VERIFY_PEER. |
4c9da963 | 2516 | DOC_END |
2517 | ||
aebe6888 CT |
2518 | NAME: sslproxy_cert_sign |
2519 | IFDEF: USE_SSL | |
2520 | DEFAULT: none | |
10d914f6 CT |
2521 | POSTSCRIPTUM: signUntrusted ssl::certUntrusted |
2522 | POSTSCRIPTUM: signSelf ssl::certSelfSigned | |
2523 | POSTSCRIPTUM: signTrusted all | |
aebe6888 CT |
2524 | TYPE: sslproxy_cert_sign |
2525 | LOC: Config.ssl_client.cert_sign | |
2526 | DOC_START | |
2527 | ||
69742b76 | 2528 | sslproxy_cert_sign <signing algorithm> acl ... |
aebe6888 | 2529 | |
69742b76 | 2530 | The following certificate signing algorithms are supported: |
638402dd | 2531 | |
aebe6888 | 2532 | signTrusted |
69742b76 AR |
2533 | Sign using the configured CA certificate which is usually |
2534 | placed in and trusted by end-user browsers. This is the | |
2535 | default for trusted origin server certificates. | |
638402dd | 2536 | |
aebe6888 | 2537 | signUntrusted |
69742b76 AR |
2538 | Sign to guarantee an X509_V_ERR_CERT_UNTRUSTED browser error. |
2539 | This is the default for untrusted origin server certificates | |
2540 | that are not self-signed (see ssl::certUntrusted). | |
638402dd | 2541 | |
aebe6888 | 2542 | signSelf |
69742b76 | 2543 | Sign using a self-signed certificate with the right CN to |
aebe6888 | 2544 | generate a X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT error in the |
69742b76 AR |
2545 | browser. This is the default for self-signed origin server |
2546 | certificates (see ssl::certSelfSigned). | |
aebe6888 | 2547 | |
cf1c09f6 CT |
2548 | This clause only supports fast acl types. |
2549 | ||
69742b76 AR |
2550 | When sslproxy_cert_sign acl(s) match, Squid uses the corresponding |
2551 | signing algorithm to generate the certificate and ignores all | |
2552 | subsequent sslproxy_cert_sign options (the first match wins). If no | |
2553 | acl(s) match, the default signing algorithm is determined by errors | |
2554 | detected when obtaining and validating the origin server certificate. | |
cf1c09f6 | 2555 | |
4b0d23b7 CT |
2556 | WARNING: SQUID_X509_V_ERR_DOMAIN_MISMATCH and ssl:certDomainMismatch can |
2557 | be used with sslproxy_cert_adapt, but if and only if Squid is bumping a | |
2558 | CONNECT request that carries a domain name. In all other cases (CONNECT | |
2559 | to an IP address or an intercepted SSL connection), Squid cannot detect | |
2560 | the domain mismatch at certificate generation time when | |
2561 | bump-server-first is used. | |
aebe6888 CT |
2562 | DOC_END |
2563 | ||
638402dd | 2564 | NAME: sslproxy_cert_adapt |
fb2178bb CT |
2565 | IFDEF: USE_SSL |
2566 | DEFAULT: none | |
2567 | TYPE: sslproxy_cert_adapt | |
2568 | LOC: Config.ssl_client.cert_adapt | |
2569 | DOC_START | |
2570 | ||
2571 | sslproxy_cert_adapt <adaptation algorithm> acl ... | |
2572 | ||
69742b76 | 2573 | The following certificate adaptation algorithms are supported: |
638402dd | 2574 | |
fb2178bb | 2575 | setValidAfter |
69742b76 AR |
2576 | Sets the "Not After" property to the "Not After" property of |
2577 | the CA certificate used to sign generated certificates. | |
638402dd | 2578 | |
fb2178bb | 2579 | setValidBefore |
69742b76 AR |
2580 | Sets the "Not Before" property to the "Not Before" property of |
2581 | the CA certificate used to sign generated certificates. | |
638402dd | 2582 | |
69742b76 AR |
2583 | setCommonName or setCommonName{CN} |
2584 | Sets Subject.CN property to the host name specified as a | |
2585 | CN parameter or, if no explicit CN parameter was specified, | |
2586 | extracted from the CONNECT request. It is a misconfiguration | |
2587 | to use setCommonName without an explicit parameter for | |
2588 | intercepted or tproxied SSL connections. | |
fb2178bb | 2589 | |
cf1c09f6 CT |
2590 | This clause only supports fast acl types. |
2591 | ||
69742b76 AR |
2592 | Squid first groups sslproxy_cert_adapt options by adaptation algorithm. |
2593 | Within a group, when sslproxy_cert_adapt acl(s) match, Squid uses the | |
2594 | corresponding adaptation algorithm to generate the certificate and | |
2595 | ignores all subsequent sslproxy_cert_adapt options in that algorithm's | |
2596 | group (i.e., the first match wins within each algorithm group). If no | |
2597 | acl(s) match, the default mimicking action takes place. | |
cf1c09f6 | 2598 | |
4b0d23b7 CT |
2599 | WARNING: SQUID_X509_V_ERR_DOMAIN_MISMATCH and ssl:certDomainMismatch can |
2600 | be used with sslproxy_cert_adapt, but if and only if Squid is bumping a | |
2601 | CONNECT request that carries a domain name. In all other cases (CONNECT | |
2602 | to an IP address or an intercepted SSL connection), Squid cannot detect | |
2603 | the domain mismatch at certificate generation time when | |
2604 | bump-server-first is used. | |
fb2178bb CT |
2605 | DOC_END |
2606 | ||
41bd17a4 | 2607 | NAME: sslpassword_program |
2608 | IFDEF: USE_SSL | |
2609 | DEFAULT: none | |
2610 | LOC: Config.Program.ssl_password | |
2611 | TYPE: string | |
5473c134 | 2612 | DOC_START |
41bd17a4 | 2613 | Specify a program used for entering SSL key passphrases |
2614 | when using encrypted SSL certificate keys. If not specified | |
2615 | keys must either be unencrypted, or Squid started with the -N | |
2616 | option to allow it to query interactively for the passphrase. | |
7acb9ddd HN |
2617 | |
2618 | The key file name is given as argument to the program allowing | |
2619 | selection of the right password if you have multiple encrypted | |
2620 | keys. | |
5473c134 | 2621 | DOC_END |
2622 | ||
95d2589c CT |
2623 | COMMENT_START |
2624 | OPTIONS RELATING TO EXTERNAL SSL_CRTD | |
2625 | ----------------------------------------------------------------------------- | |
2626 | COMMENT_END | |
2627 | ||
2628 | NAME: sslcrtd_program | |
2629 | TYPE: eol | |
2630 | IFDEF: USE_SSL_CRTD | |
2631 | DEFAULT: @DEFAULT_SSL_CRTD@ -s @DEFAULT_SSL_DB_DIR@ -M 4MB | |
2632 | LOC: Ssl::TheConfig.ssl_crtd | |
2633 | DOC_START | |
2634 | Specify the location and options of the executable for ssl_crtd process. | |
2635 | @DEFAULT_SSL_CRTD@ program requires -s and -M parameters | |
2636 | For more information use: | |
2637 | @DEFAULT_SSL_CRTD@ -h | |
2638 | DOC_END | |
2639 | ||
2640 | NAME: sslcrtd_children | |
2641 | TYPE: HelperChildConfig | |
2642 | IFDEF: USE_SSL_CRTD | |
2643 | DEFAULT: 32 startup=5 idle=1 | |
2644 | LOC: Ssl::TheConfig.ssl_crtdChildren | |
2645 | DOC_START | |
2646 | The maximum number of processes spawn to service ssl server. | |
2647 | The maximum this may be safely set to is 32. | |
2648 | ||
2649 | The startup= and idle= options allow some measure of skew in your | |
2650 | tuning. | |
2651 | ||
2652 | startup=N | |
2653 | ||
2654 | Sets the minimum number of processes to spawn when Squid | |
2655 | starts or reconfigures. When set to zero the first request will | |
2656 | cause spawning of the first child process to handle it. | |
2657 | ||
2658 | Starting too few children temporary slows Squid under load while it | |
2659 | tries to spawn enough additional processes to cope with traffic. | |
2660 | ||
2661 | idle=N | |
2662 | ||
2663 | Sets a minimum of how many processes Squid is to try and keep available | |
2664 | at all times. When traffic begins to rise above what the existing | |
2665 | processes can handle this many more will be spawned up to the maximum | |
2666 | configured. A minimum setting of 1 is required. | |
2667 | ||
2668 | You must have at least one ssl_crtd process. | |
2669 | DOC_END | |
2670 | ||
2cef0ca6 AR |
2671 | NAME: sslcrtvalidator_program |
2672 | TYPE: eol | |
2673 | IFDEF: USE_SSL | |
2674 | DEFAULT: none | |
2675 | LOC: Ssl::TheConfig.ssl_crt_validator | |
2676 | DOC_START | |
2677 | Specify the location and options of the executable for ssl_crt_validator | |
638402dd AJ |
2678 | process. |
2679 | ||
2680 | Usage: sslcrtvalidator_program [ttl=n] [cache=n] path ... | |
14798e73 CT |
2681 | |
2682 | Options: | |
638402dd | 2683 | ttl=n TTL in seconds for cached results. The default is 60 secs |
14798e73 | 2684 | cache=n limit the result cache size. The default value is 2048 |
2cef0ca6 AR |
2685 | DOC_END |
2686 | ||
2687 | NAME: sslcrtvalidator_children | |
2688 | TYPE: HelperChildConfig | |
2689 | IFDEF: USE_SSL | |
413bb969 | 2690 | DEFAULT: 32 startup=5 idle=1 concurrency=1 |
2cef0ca6 AR |
2691 | LOC: Ssl::TheConfig.ssl_crt_validator_Children |
2692 | DOC_START | |
638402dd | 2693 | The maximum number of processes spawn to service SSL server. |
2cef0ca6 AR |
2694 | The maximum this may be safely set to is 32. |
2695 | ||
2696 | The startup= and idle= options allow some measure of skew in your | |
2697 | tuning. | |
2698 | ||
2699 | startup=N | |
2700 | ||
2701 | Sets the minimum number of processes to spawn when Squid | |
2702 | starts or reconfigures. When set to zero the first request will | |
2703 | cause spawning of the first child process to handle it. | |
2704 | ||
2705 | Starting too few children temporary slows Squid under load while it | |
2706 | tries to spawn enough additional processes to cope with traffic. | |
2707 | ||
2708 | idle=N | |
2709 | ||
2710 | Sets a minimum of how many processes Squid is to try and keep available | |
2711 | at all times. When traffic begins to rise above what the existing | |
2712 | processes can handle this many more will be spawned up to the maximum | |
2713 | configured. A minimum setting of 1 is required. | |
4a77bb4e CT |
2714 | |
2715 | concurrency= | |
2716 | ||
2717 | The number of requests each certificate validator helper can handle in | |
dffc462a CT |
2718 | parallel. A value of 0 indicates the certficate validator does not |
2719 | support concurrency. Defaults to 1. | |
4a77bb4e CT |
2720 | |
2721 | When this directive is set to a value >= 1 then the protocol | |
2722 | used to communicate with the helper is modified to include | |
2723 | a request ID in front of the request/response. The request | |
2724 | ID from the request must be echoed back with the response | |
2725 | to that request. | |
2cef0ca6 AR |
2726 | |
2727 | You must have at least one ssl_crt_validator process. | |
2728 | DOC_END | |
2729 | ||
cccac0a2 | 2730 | COMMENT_START |
41bd17a4 | 2731 | OPTIONS WHICH AFFECT THE NEIGHBOR SELECTION ALGORITHM |
cccac0a2 | 2732 | ----------------------------------------------------------------------------- |
2733 | COMMENT_END | |
2734 | ||
41bd17a4 | 2735 | NAME: cache_peer |
2736 | TYPE: peer | |
2737 | DEFAULT: none | |
2738 | LOC: Config.peers | |
cccac0a2 | 2739 | DOC_START |
41bd17a4 | 2740 | To specify other caches in a hierarchy, use the format: |
2b94f655 | 2741 | |
41bd17a4 | 2742 | cache_peer hostname type http-port icp-port [options] |
2b94f655 | 2743 | |
41bd17a4 | 2744 | For example, |
2b94f655 | 2745 | |
41bd17a4 | 2746 | # proxy icp |
2747 | # hostname type port port options | |
2748 | # -------------------- -------- ----- ----- ----------- | |
2b94f655 | 2749 | cache_peer parent.foo.net parent 3128 3130 default |
41bd17a4 | 2750 | cache_peer sib1.foo.net sibling 3128 3130 proxy-only |
2751 | cache_peer sib2.foo.net sibling 3128 3130 proxy-only | |
2e9993e1 | 2752 | cache_peer example.com parent 80 0 default |
2b94f655 AJ |
2753 | cache_peer cdn.example.com sibling 3128 0 |
2754 | ||
2755 | type: either 'parent', 'sibling', or 'multicast'. | |
2756 | ||
2757 | proxy-port: The port number where the peer accept HTTP requests. | |
2758 | For other Squid proxies this is usually 3128 | |
2759 | For web servers this is usually 80 | |
2760 | ||
2761 | icp-port: Used for querying neighbor caches about objects. | |
2762 | Set to 0 if the peer does not support ICP or HTCP. | |
2763 | See ICP and HTCP options below for additional details. | |
2764 | ||
2765 | ||
2766 | ==== ICP OPTIONS ==== | |
2767 | ||
2768 | You MUST also set icp_port and icp_access explicitly when using these options. | |
2769 | The defaults will prevent peer traffic using ICP. | |
2770 | ||
2771 | ||
2772 | no-query Disable ICP queries to this neighbor. | |
2773 | ||
2774 | multicast-responder | |
2775 | Indicates the named peer is a member of a multicast group. | |
2776 | ICP queries will not be sent directly to the peer, but ICP | |
2777 | replies will be accepted from it. | |
2778 | ||
2779 | closest-only Indicates that, for ICP_OP_MISS replies, we'll only forward | |
2780 | CLOSEST_PARENT_MISSes and never FIRST_PARENT_MISSes. | |
2781 | ||
2782 | background-ping | |
2783 | To only send ICP queries to this neighbor infrequently. | |
2784 | This is used to keep the neighbor round trip time updated | |
2785 | and is usually used in conjunction with weighted-round-robin. | |
2786 | ||
2787 | ||
2788 | ==== HTCP OPTIONS ==== | |
2789 | ||
2790 | You MUST also set htcp_port and htcp_access explicitly when using these options. | |
2791 | The defaults will prevent peer traffic using HTCP. | |
2792 | ||
2793 | ||
2794 | htcp Send HTCP, instead of ICP, queries to the neighbor. | |
2795 | You probably also want to set the "icp-port" to 4827 | |
18191440 AJ |
2796 | instead of 3130. This directive accepts a comma separated |
2797 | list of options described below. | |
2b94f655 | 2798 | |
18191440 | 2799 | htcp=oldsquid Send HTCP to old Squid versions (2.5 or earlier). |
2b94f655 | 2800 | |
18191440 | 2801 | htcp=no-clr Send HTCP to the neighbor but without |
2b94f655 | 2802 | sending any CLR requests. This cannot be used with |
18191440 | 2803 | only-clr. |
2b94f655 | 2804 | |
18191440 AJ |
2805 | htcp=only-clr Send HTCP to the neighbor but ONLY CLR requests. |
2806 | This cannot be used with no-clr. | |
2b94f655 | 2807 | |
18191440 | 2808 | htcp=no-purge-clr |
2b94f655 AJ |
2809 | Send HTCP to the neighbor including CLRs but only when |
2810 | they do not result from PURGE requests. | |
2811 | ||
18191440 | 2812 | htcp=forward-clr |
2b94f655 AJ |
2813 | Forward any HTCP CLR requests this proxy receives to the peer. |
2814 | ||
2815 | ||
2816 | ==== PEER SELECTION METHODS ==== | |
2817 | ||
2818 | The default peer selection method is ICP, with the first responding peer | |
2819 | being used as source. These options can be used for better load balancing. | |
2820 | ||
2821 | ||
2822 | default This is a parent cache which can be used as a "last-resort" | |
2823 | if a peer cannot be located by any of the peer-selection methods. | |
2824 | If specified more than once, only the first is used. | |
2825 | ||
2826 | round-robin Load-Balance parents which should be used in a round-robin | |
2827 | fashion in the absence of any ICP queries. | |
2828 | weight=N can be used to add bias. | |
2829 | ||
2830 | weighted-round-robin | |
2831 | Load-Balance parents which should be used in a round-robin | |
2832 | fashion with the frequency of each parent being based on the | |
2833 | round trip time. Closer parents are used more often. | |
2834 | Usually used for background-ping parents. | |
2835 | weight=N can be used to add bias. | |
2836 | ||
2837 | carp Load-Balance parents which should be used as a CARP array. | |
2838 | The requests will be distributed among the parents based on the | |
2839 | CARP load balancing hash function based on their weight. | |
2840 | ||
2841 | userhash Load-balance parents based on the client proxy_auth or ident username. | |
2842 | ||
2843 | sourcehash Load-balance parents based on the client source IP. | |
8a368316 AJ |
2844 | |
2845 | multicast-siblings | |
2846 | To be used only for cache peers of type "multicast". | |
2847 | ALL members of this multicast group have "sibling" | |
2e9993e1 | 2848 | relationship with it, not "parent". This is to a multicast |
8a368316 AJ |
2849 | group when the requested object would be fetched only from |
2850 | a "parent" cache, anyway. It's useful, e.g., when | |
2851 | configuring a pool of redundant Squid proxies, being | |
2852 | members of the same multicast group. | |
2b94f655 AJ |
2853 | |
2854 | ||
2855 | ==== PEER SELECTION OPTIONS ==== | |
2856 | ||
2857 | weight=N use to affect the selection of a peer during any weighted | |
2858 | peer-selection mechanisms. | |
2859 | The weight must be an integer; default is 1, | |
2860 | larger weights are favored more. | |
2861 | This option does not affect parent selection if a peering | |
2862 | protocol is not in use. | |
2863 | ||
2864 | basetime=N Specify a base amount to be subtracted from round trip | |
2865 | times of parents. | |
2866 | It is subtracted before division by weight in calculating | |
2867 | which parent to fectch from. If the rtt is less than the | |
2868 | base time the rtt is set to a minimal value. | |
2869 | ||
3c72389f AJ |
2870 | ttl=N Specify a TTL to use when sending multicast ICP queries |
2871 | to this address. | |
2b94f655 AJ |
2872 | Only useful when sending to a multicast group. |
2873 | Because we don't accept ICP replies from random | |
2874 | hosts, you must configure other group members as | |
2875 | peers with the 'multicast-responder' option. | |
2876 | ||
2877 | no-delay To prevent access to this neighbor from influencing the | |
2878 | delay pools. | |
2879 | ||
2880 | digest-url=URL Tell Squid to fetch the cache digest (if digests are | |
2881 | enabled) for this host from the specified URL rather | |
2882 | than the Squid default location. | |
2883 | ||
2884 | ||
de03b596 FC |
2885 | ==== CARP OPTIONS ==== |
2886 | ||
2887 | carp-key=key-specification | |
2888 | use a different key than the full URL to hash against the peer. | |
2889 | the key-specification is a comma-separated list of the keywords | |
2890 | scheme, host, port, path, params | |
2891 | Order is not important. | |
2892 | ||
2b94f655 AJ |
2893 | ==== ACCELERATOR / REVERSE-PROXY OPTIONS ==== |
2894 | ||
2895 | originserver Causes this parent to be contacted as an origin server. | |
2896 | Meant to be used in accelerator setups when the peer | |
2897 | is a web server. | |
2898 | ||
2899 | forceddomain=name | |
2900 | Set the Host header of requests forwarded to this peer. | |
2901 | Useful in accelerator setups where the server (peer) | |
2902 | expects a certain domain name but clients may request | |
2903 | others. ie example.com or www.example.com | |
2904 | ||
2905 | no-digest Disable request of cache digests. | |
2906 | ||
2907 | no-netdb-exchange | |
2908 | Disables requesting ICMP RTT database (NetDB). | |
2909 | ||
2910 | ||
2911 | ==== AUTHENTICATION OPTIONS ==== | |
2912 | ||
2913 | login=user:password | |
2914 | If this is a personal/workgroup proxy and your parent | |
2915 | requires proxy authentication. | |
2916 | ||
2917 | Note: The string can include URL escapes (i.e. %20 for | |
2918 | spaces). This also means % must be written as %%. | |
2919 | ||
11e4c5e5 AJ |
2920 | login=PASSTHRU |
2921 | Send login details received from client to this peer. | |
2922 | Both Proxy- and WWW-Authorization headers are passed | |
2923 | without alteration to the peer. | |
2924 | Authentication is not required by Squid for this to work. | |
2925 | ||
2926 | Note: This will pass any form of authentication but | |
2927 | only Basic auth will work through a proxy unless the | |
2928 | connection-auth options are also used. | |
ee0b94f4 | 2929 | |
2b94f655 AJ |
2930 | login=PASS Send login details received from client to this peer. |
2931 | Authentication is not required by this option. | |
11e4c5e5 | 2932 | |
2b94f655 AJ |
2933 | If there are no client-provided authentication headers |
2934 | to pass on, but username and password are available | |
ee0b94f4 HN |
2935 | from an external ACL user= and password= result tags |
2936 | they may be sent instead. | |
2b94f655 AJ |
2937 | |
2938 | Note: To combine this with proxy_auth both proxies must | |
2939 | share the same user database as HTTP only allows for | |
2940 | a single login (one for proxy, one for origin server). | |
2941 | Also be warned this will expose your users proxy | |
2942 | password to the peer. USE WITH CAUTION | |
2943 | ||
2944 | login=*:password | |
2945 | Send the username to the upstream cache, but with a | |
2946 | fixed password. This is meant to be used when the peer | |
2947 | is in another administrative domain, but it is still | |
2948 | needed to identify each user. | |
2949 | The star can optionally be followed by some extra | |
2950 | information which is added to the username. This can | |
2951 | be used to identify this proxy to the peer, similar to | |
2952 | the login=username:password option above. | |
2953 | ||
9ca29d23 AJ |
2954 | login=NEGOTIATE |
2955 | If this is a personal/workgroup proxy and your parent | |
2956 | requires a secure proxy authentication. | |
2957 | The first principal from the default keytab or defined by | |
2958 | the environment variable KRB5_KTNAME will be used. | |
2959 | ||
63f03f79 PL |
2960 | WARNING: The connection may transmit requests from multiple |
2961 | clients. Negotiate often assumes end-to-end authentication | |
2962 | and a single-client. Which is not strictly true here. | |
2963 | ||
9ca29d23 AJ |
2964 | login=NEGOTIATE:principal_name |
2965 | If this is a personal/workgroup proxy and your parent | |
2966 | requires a secure proxy authentication. | |
2967 | The principal principal_name from the default keytab or | |
2968 | defined by the environment variable KRB5_KTNAME will be | |
2969 | used. | |
2970 | ||
63f03f79 PL |
2971 | WARNING: The connection may transmit requests from multiple |
2972 | clients. Negotiate often assumes end-to-end authentication | |
2973 | and a single-client. Which is not strictly true here. | |
2974 | ||
2b94f655 AJ |
2975 | connection-auth=on|off |
2976 | Tell Squid that this peer does or not support Microsoft | |
2977 | connection oriented authentication, and any such | |
2978 | challenges received from there should be ignored. | |
2979 | Default is auto to automatically determine the status | |
2980 | of the peer. | |
2981 | ||
2982 | ||
2983 | ==== SSL / HTTPS / TLS OPTIONS ==== | |
2984 | ||
2985 | ssl Encrypt connections to this peer with SSL/TLS. | |
2986 | ||
2987 | sslcert=/path/to/ssl/certificate | |
2988 | A client SSL certificate to use when connecting to | |
2989 | this peer. | |
2990 | ||
2991 | sslkey=/path/to/ssl/key | |
2992 | The private SSL key corresponding to sslcert above. | |
2993 | If 'sslkey' is not specified 'sslcert' is assumed to | |
2994 | reference a combined file containing both the | |
2995 | certificate and the key. | |
2996 | ||
3d96b0e8 | 2997 | sslversion=1|2|3|4|5|6 |
2b94f655 AJ |
2998 | The SSL version to use when connecting to this peer |
2999 | 1 = automatic (default) | |
3000 | 2 = SSL v2 only | |
3001 | 3 = SSL v3 only | |
3d96b0e8 AJ |
3002 | 4 = TLS v1.0 only |
3003 | 5 = TLS v1.1 only | |
3004 | 6 = TLS v1.2 only | |
2b94f655 AJ |
3005 | |
3006 | sslcipher=... The list of valid SSL ciphers to use when connecting | |
3007 | to this peer. | |
3008 | ||
943c5f16 HN |
3009 | ssloptions=... Specify various SSL implementation options: |
3010 | ||
3d96b0e8 AJ |
3011 | NO_SSLv2 Disallow the use of SSLv2 |
3012 | NO_SSLv3 Disallow the use of SSLv3 | |
3013 | NO_TLSv1 Disallow the use of TLSv1.0 | |
3014 | NO_TLSv1_1 Disallow the use of TLSv1.1 | |
3015 | NO_TLSv1_2 Disallow the use of TLSv1.2 | |
943c5f16 HN |
3016 | SINGLE_DH_USE |
3017 | Always create a new key when using | |
3018 | temporary/ephemeral DH key exchanges | |
3019 | ALL Enable various bug workarounds | |
3020 | suggested as "harmless" by OpenSSL | |
3021 | Be warned that this reduces SSL/TLS | |
3022 | strength to some attacks. | |
3023 | ||
3024 | See the OpenSSL SSL_CTX_set_options documentation for a | |
3025 | more complete list. | |
2b94f655 AJ |
3026 | |
3027 | sslcafile=... A file containing additional CA certificates to use | |
3028 | when verifying the peer certificate. | |
3029 | ||
3030 | sslcapath=... A directory containing additional CA certificates to | |
3031 | use when verifying the peer certificate. | |
3032 | ||
3033 | sslcrlfile=... A certificate revocation list file to use when | |
3034 | verifying the peer certificate. | |
3035 | ||
3036 | sslflags=... Specify various flags modifying the SSL implementation: | |
3037 | ||
41bd17a4 | 3038 | DONT_VERIFY_PEER |
3039 | Accept certificates even if they fail to | |
3040 | verify. | |
3041 | NO_DEFAULT_CA | |
3042 | Don't use the default CA list built in | |
3043 | to OpenSSL. | |
3044 | DONT_VERIFY_DOMAIN | |
3045 | Don't verify the peer certificate | |
3046 | matches the server name | |
2b94f655 AJ |
3047 | |
3048 | ssldomain= The peer name as advertised in it's certificate. | |
3049 | Used for verifying the correctness of the received peer | |
3050 | certificate. If not specified the peer hostname will be | |
3051 | used. | |
3052 | ||
3053 | front-end-https | |
3054 | Enable the "Front-End-Https: On" header needed when | |
3055 | using Squid as a SSL frontend in front of Microsoft OWA. | |
3056 | See MS KB document Q307347 for details on this header. | |
3057 | If set to auto the header will only be added if the | |
3058 | request is forwarded as a https:// URL. | |
3059 | ||
3060 | ||
3061 | ==== GENERAL OPTIONS ==== | |
3062 | ||
3063 | connect-timeout=N | |
3064 | A peer-specific connect timeout. | |
3065 | Also see the peer_connect_timeout directive. | |
3066 | ||
3067 | connect-fail-limit=N | |
3068 | How many times connecting to a peer must fail before | |
3069 | it is marked as down. Default is 10. | |
3070 | ||
3071 | allow-miss Disable Squid's use of only-if-cached when forwarding | |
3072 | requests to siblings. This is primarily useful when | |
3073 | icp_hit_stale is used by the sibling. To extensive use | |
3074 | of this option may result in forwarding loops, and you | |
3075 | should avoid having two-way peerings with this option. | |
3076 | For example to deny peer usage on requests from peer | |
3077 | by denying cache_peer_access if the source is a peer. | |
3078 | ||
3079 | max-conn=N Limit the amount of connections Squid may open to this | |
3080 | peer. see also | |
3081 | ||
3082 | name=xxx Unique name for the peer. | |
3083 | Required if you have multiple peers on the same host | |
3084 | but different ports. | |
3085 | This name can be used in cache_peer_access and similar | |
3086 | directives to dentify the peer. | |
3087 | Can be used by outgoing access controls through the | |
3088 | peername ACL type. | |
3089 | ||
b0758e04 AJ |
3090 | no-tproxy Do not use the client-spoof TPROXY support when forwarding |
3091 | requests to this peer. Use normal address selection instead. | |
0d901ef4 | 3092 | This overrides the spoof_client_ip ACL. |
b0758e04 | 3093 | |
2b94f655 AJ |
3094 | proxy-only objects fetched from the peer will not be stored locally. |
3095 | ||
41bd17a4 | 3096 | DOC_END |
cccac0a2 | 3097 | |
41bd17a4 | 3098 | NAME: cache_peer_domain cache_host_domain |
3099 | TYPE: hostdomain | |
3100 | DEFAULT: none | |
3101 | LOC: none | |
3102 | DOC_START | |
3103 | Use to limit the domains for which a neighbor cache will be | |
638402dd | 3104 | queried. |
cccac0a2 | 3105 | |
638402dd AJ |
3106 | Usage: |
3107 | cache_peer_domain cache-host domain [domain ...] | |
3108 | cache_peer_domain cache-host !domain | |
cccac0a2 | 3109 | |
41bd17a4 | 3110 | For example, specifying |
cccac0a2 | 3111 | |
41bd17a4 | 3112 | cache_peer_domain parent.foo.net .edu |
cccac0a2 | 3113 | |
41bd17a4 | 3114 | has the effect such that UDP query packets are sent to |
3115 | 'bigserver' only when the requested object exists on a | |
3116 | server in the .edu domain. Prefixing the domainname | |
3117 | with '!' means the cache will be queried for objects | |
3118 | NOT in that domain. | |
cccac0a2 | 3119 | |
41bd17a4 | 3120 | NOTE: * Any number of domains may be given for a cache-host, |
3121 | either on the same or separate lines. | |
3122 | * When multiple domains are given for a particular | |
3123 | cache-host, the first matched domain is applied. | |
3124 | * Cache hosts with no domain restrictions are queried | |
3125 | for all requests. | |
3126 | * There are no defaults. | |
3127 | * There is also a 'cache_peer_access' tag in the ACL | |
3128 | section. | |
3129 | DOC_END | |
dd9b1776 | 3130 | |
41bd17a4 | 3131 | NAME: cache_peer_access |
3132 | TYPE: peer_access | |
3133 | DEFAULT: none | |
3134 | LOC: none | |
3135 | DOC_START | |
3136 | Similar to 'cache_peer_domain' but provides more flexibility by | |
3137 | using ACL elements. | |
cccac0a2 | 3138 | |
638402dd AJ |
3139 | Usage: |
3140 | cache_peer_access cache-host allow|deny [!]aclname ... | |
dd9b1776 | 3141 | |
41bd17a4 | 3142 | The syntax is identical to 'http_access' and the other lists of |
3143 | ACL elements. See the comments for 'http_access' below, or | |
e314b7b9 | 3144 | the Squid FAQ (http://wiki.squid-cache.org/SquidFaq/SquidAcl). |
41bd17a4 | 3145 | DOC_END |
dd9b1776 | 3146 | |
41bd17a4 | 3147 | NAME: neighbor_type_domain |
3148 | TYPE: hostdomaintype | |
3149 | DEFAULT: none | |
638402dd | 3150 | DEFAULT_DOC: The peer type from cache_peer directive is used for all requests to that peer. |
41bd17a4 | 3151 | LOC: none |
3152 | DOC_START | |
638402dd AJ |
3153 | Modify the cache_peer neighbor type when passing requests |
3154 | about specific domains to the peer. | |
cccac0a2 | 3155 | |
638402dd AJ |
3156 | Usage: |
3157 | neighbor_type_domain neighbor parent|sibling domain domain ... | |
6bf4f823 | 3158 | |
638402dd AJ |
3159 | For example: |
3160 | cache_peer foo.example.com parent 3128 3130 | |
3161 | neighbor_type_domain foo.example.com sibling .au .de | |
6bf4f823 | 3162 | |
638402dd AJ |
3163 | The above configuration treats all requests to foo.example.com as a |
3164 | parent proxy unless the request is for a .au or .de ccTLD domain name. | |
41bd17a4 | 3165 | DOC_END |
6bf4f823 | 3166 | |
41bd17a4 | 3167 | NAME: dead_peer_timeout |
3168 | COMMENT: (seconds) | |
3169 | DEFAULT: 10 seconds | |
3170 | TYPE: time_t | |
3171 | LOC: Config.Timeout.deadPeer | |
3172 | DOC_START | |
3173 | This controls how long Squid waits to declare a peer cache | |
3174 | as "dead." If there are no ICP replies received in this | |
3175 | amount of time, Squid will declare the peer dead and not | |
3176 | expect to receive any further ICP replies. However, it | |
3177 | continues to send ICP queries, and will mark the peer as | |
3178 | alive upon receipt of the first subsequent ICP reply. | |
699acd19 | 3179 | |
41bd17a4 | 3180 | This timeout also affects when Squid expects to receive ICP |
3181 | replies from peers. If more than 'dead_peer' seconds have | |
3182 | passed since the last ICP reply was received, Squid will not | |
3183 | expect to receive an ICP reply on the next query. Thus, if | |
3184 | your time between requests is greater than this timeout, you | |
3185 | will see a lot of requests sent DIRECT to origin servers | |
3186 | instead of to your parents. | |
3187 | DOC_END | |
cccac0a2 | 3188 | |
437823b4 | 3189 | NAME: forward_max_tries |
6c367206 | 3190 | DEFAULT: 25 |
437823b4 AJ |
3191 | TYPE: int |
3192 | LOC: Config.forward_max_tries | |
3193 | DOC_START | |
3194 | Controls how many different forward paths Squid will try | |
3195 | before giving up. See also forward_timeout. | |
31ef19cd AJ |
3196 | |
3197 | NOTE: connect_retries (default: none) can make each of these | |
3198 | possible forwarding paths be tried multiple times. | |
437823b4 AJ |
3199 | DOC_END |
3200 | ||
41bd17a4 | 3201 | NAME: hierarchy_stoplist |
3202 | TYPE: wordlist | |
3203 | DEFAULT: none | |
3204 | LOC: Config.hierarchy_stoplist | |
3205 | DOC_START | |
3206 | A list of words which, if found in a URL, cause the object to | |
3207 | be handled directly by this cache. In other words, use this | |
3208 | to not query neighbor caches for certain objects. You may | |
3209 | list this option multiple times. | |
e0855596 | 3210 | |
3387b5a4 AJ |
3211 | Example: |
3212 | hierarchy_stoplist cgi-bin ? | |
3213 | ||
3214 | Note: never_direct overrides this option. | |
6b698a21 | 3215 | DOC_END |
0976f8db | 3216 | |
41bd17a4 | 3217 | COMMENT_START |
3218 | MEMORY CACHE OPTIONS | |
3219 | ----------------------------------------------------------------------------- | |
3220 | COMMENT_END | |
3221 | ||
3222 | NAME: cache_mem | |
3223 | COMMENT: (bytes) | |
3224 | TYPE: b_size_t | |
df2eec10 | 3225 | DEFAULT: 256 MB |
41bd17a4 | 3226 | LOC: Config.memMaxSize |
6b698a21 | 3227 | DOC_START |
41bd17a4 | 3228 | NOTE: THIS PARAMETER DOES NOT SPECIFY THE MAXIMUM PROCESS SIZE. |
3229 | IT ONLY PLACES A LIMIT ON HOW MUCH ADDITIONAL MEMORY SQUID WILL | |
3230 | USE AS A MEMORY CACHE OF OBJECTS. SQUID USES MEMORY FOR OTHER | |
3231 | THINGS AS WELL. SEE THE SQUID FAQ SECTION 8 FOR DETAILS. | |
3232 | ||
3233 | 'cache_mem' specifies the ideal amount of memory to be used | |
3234 | for: | |
3235 | * In-Transit objects | |
3236 | * Hot Objects | |
3237 | * Negative-Cached objects | |
3238 | ||
3239 | Data for these objects are stored in 4 KB blocks. This | |
3240 | parameter specifies the ideal upper limit on the total size of | |
3241 | 4 KB blocks allocated. In-Transit objects take the highest | |
3242 | priority. | |
3243 | ||
3244 | In-transit objects have priority over the others. When | |
3245 | additional space is needed for incoming data, negative-cached | |
3246 | and hot objects will be released. In other words, the | |
3247 | negative-cached and hot objects will fill up any unused space | |
3248 | not needed for in-transit objects. | |
3249 | ||
3250 | If circumstances require, this limit will be exceeded. | |
3251 | Specifically, if your incoming request rate requires more than | |
3252 | 'cache_mem' of memory to hold in-transit objects, Squid will | |
3253 | exceed this limit to satisfy the new requests. When the load | |
3254 | decreases, blocks will be freed until the high-water mark is | |
3255 | reached. Thereafter, blocks will be used to store hot | |
3256 | objects. | |
29f35ca5 AR |
3257 | |
3258 | If shared memory caching is enabled, Squid does not use the shared | |
3259 | cache space for in-transit objects, but they still consume as much | |
3260 | local memory as they need. For more details about the shared memory | |
3261 | cache, see memory_cache_shared. | |
6b698a21 | 3262 | DOC_END |
0976f8db | 3263 | |
41bd17a4 | 3264 | NAME: maximum_object_size_in_memory |
3265 | COMMENT: (bytes) | |
3266 | TYPE: b_size_t | |
df2eec10 | 3267 | DEFAULT: 512 KB |
41bd17a4 | 3268 | LOC: Config.Store.maxInMemObjSize |
6b698a21 | 3269 | DOC_START |
41bd17a4 | 3270 | Objects greater than this size will not be attempted to kept in |
3271 | the memory cache. This should be set high enough to keep objects | |
3272 | accessed frequently in memory to improve performance whilst low | |
3273 | enough to keep larger objects from hoarding cache_mem. | |
6b698a21 | 3274 | DOC_END |
0976f8db | 3275 | |
57af1e3f AR |
3276 | NAME: memory_cache_shared |
3277 | COMMENT: on|off | |
3278 | TYPE: YesNoNone | |
3279 | LOC: Config.memShared | |
3280 | DEFAULT: none | |
70f856bc | 3281 | DEFAULT_DOC: "on" where supported if doing memory caching with multiple SMP workers. |
57af1e3f AR |
3282 | DOC_START |
3283 | Controls whether the memory cache is shared among SMP workers. | |
3284 | ||
70f856bc AR |
3285 | The shared memory cache is meant to occupy cache_mem bytes and replace |
3286 | the non-shared memory cache, although some entities may still be | |
3287 | cached locally by workers for now (e.g., internal and in-transit | |
3288 | objects may be served from a local memory cache even if shared memory | |
3289 | caching is enabled). | |
3290 | ||
65b81b27 | 3291 | By default, the memory cache is shared if and only if all of the |
70f856bc AR |
3292 | following conditions are satisfied: Squid runs in SMP mode with |
3293 | multiple workers, cache_mem is positive, and Squid environment | |
3294 | supports required IPC primitives (e.g., POSIX shared memory segments | |
3295 | and GCC-style atomic operations). | |
3296 | ||
3297 | To avoid blocking locks, shared memory uses opportunistic algorithms | |
3298 | that do not guarantee that every cachable entity that could have been | |
3299 | shared among SMP workers will actually be shared. | |
3300 | ||
3301 | Currently, entities exceeding 32KB in size cannot be shared. | |
57af1e3f AR |
3302 | DOC_END |
3303 | ||
ea21d497 HN |
3304 | NAME: memory_cache_mode |
3305 | TYPE: memcachemode | |
3306 | LOC: Config | |
3307 | DEFAULT: always | |
638402dd | 3308 | DEFAULT_DOC: Keep the most recently fetched objects in memory |
ff4b33f4 | 3309 | DOC_START |
ea21d497 | 3310 | Controls which objects to keep in the memory cache (cache_mem) |
ff4b33f4 | 3311 | |
ea21d497 HN |
3312 | always Keep most recently fetched objects in memory (default) |
3313 | ||
3314 | disk Only disk cache hits are kept in memory, which means | |
3315 | an object must first be cached on disk and then hit | |
3316 | a second time before cached in memory. | |
3317 | ||
3318 | network Only objects fetched from network is kept in memory | |
ff4b33f4 HN |
3319 | DOC_END |
3320 | ||
41bd17a4 | 3321 | NAME: memory_replacement_policy |
3322 | TYPE: removalpolicy | |
3323 | LOC: Config.memPolicy | |
3324 | DEFAULT: lru | |
6b698a21 | 3325 | DOC_START |
41bd17a4 | 3326 | The memory replacement policy parameter determines which |
3327 | objects are purged from memory when memory space is needed. | |
7f7db318 | 3328 | |
638402dd | 3329 | See cache_replacement_policy for details on algorithms. |
41bd17a4 | 3330 | DOC_END |
6b698a21 | 3331 | |
41bd17a4 | 3332 | COMMENT_START |
3333 | DISK CACHE OPTIONS | |
3334 | ----------------------------------------------------------------------------- | |
3335 | COMMENT_END | |
6b698a21 | 3336 | |
41bd17a4 | 3337 | NAME: cache_replacement_policy |
3338 | TYPE: removalpolicy | |
3339 | LOC: Config.replPolicy | |
3340 | DEFAULT: lru | |
3341 | DOC_START | |
3342 | The cache replacement policy parameter determines which | |
3343 | objects are evicted (replaced) when disk space is needed. | |
6b698a21 | 3344 | |
41bd17a4 | 3345 | lru : Squid's original list based LRU policy |
3346 | heap GDSF : Greedy-Dual Size Frequency | |
3347 | heap LFUDA: Least Frequently Used with Dynamic Aging | |
3348 | heap LRU : LRU policy implemented using a heap | |
6b698a21 | 3349 | |
638402dd | 3350 | Applies to any cache_dir lines listed below this directive. |
7f7db318 | 3351 | |
41bd17a4 | 3352 | The LRU policies keeps recently referenced objects. |
0976f8db | 3353 | |
41bd17a4 | 3354 | The heap GDSF policy optimizes object hit rate by keeping smaller |
3355 | popular objects in cache so it has a better chance of getting a | |
3356 | hit. It achieves a lower byte hit rate than LFUDA though since | |
3357 | it evicts larger (possibly popular) objects. | |
0976f8db | 3358 | |
41bd17a4 | 3359 | The heap LFUDA policy keeps popular objects in cache regardless of |
3360 | their size and thus optimizes byte hit rate at the expense of | |
3361 | hit rate since one large, popular object will prevent many | |
3362 | smaller, slightly less popular objects from being cached. | |
0976f8db | 3363 | |
41bd17a4 | 3364 | Both policies utilize a dynamic aging mechanism that prevents |
3365 | cache pollution that can otherwise occur with frequency-based | |
3366 | replacement policies. | |
7d90757b | 3367 | |
41bd17a4 | 3368 | NOTE: if using the LFUDA replacement policy you should increase |
b51ec8c8 | 3369 | the value of maximum_object_size above its default of 4 MB to |
41bd17a4 | 3370 | to maximize the potential byte hit rate improvement of LFUDA. |
dc1af3cf | 3371 | |
41bd17a4 | 3372 | For more information about the GDSF and LFUDA cache replacement |
3373 | policies see http://www.hpl.hp.com/techreports/1999/HPL-1999-69.html | |
3374 | and http://fog.hpl.external.hp.com/techreports/98/HPL-98-173.html. | |
6b698a21 | 3375 | DOC_END |
0976f8db | 3376 | |
41bd17a4 | 3377 | NAME: cache_dir |
3378 | TYPE: cachedir | |
3379 | DEFAULT: none | |
638402dd | 3380 | DEFAULT_DOC: No disk cache. Store cache ojects only in memory. |
41bd17a4 | 3381 | LOC: Config.cacheSwap |
6b698a21 | 3382 | DOC_START |
638402dd AJ |
3383 | Format: |
3384 | cache_dir Type Directory-Name Fs-specific-data [options] | |
0976f8db | 3385 | |
41bd17a4 | 3386 | You can specify multiple cache_dir lines to spread the |
3387 | cache among different disk partitions. | |
0976f8db | 3388 | |
41bd17a4 | 3389 | Type specifies the kind of storage system to use. Only "ufs" |
3390 | is built by default. To enable any of the other storage systems | |
3391 | see the --enable-storeio configure option. | |
0976f8db | 3392 | |
41bd17a4 | 3393 | 'Directory' is a top-level directory where cache swap |
3394 | files will be stored. If you want to use an entire disk | |
3395 | for caching, this can be the mount-point directory. | |
3396 | The directory must exist and be writable by the Squid | |
3397 | process. Squid will NOT create this directory for you. | |
0976f8db | 3398 | |
acf69d74 AJ |
3399 | In SMP configurations, cache_dir must not precede the workers option |
3400 | and should use configuration macros or conditionals to give each | |
3401 | worker interested in disk caching a dedicated cache directory. | |
3402 | ||
638402dd AJ |
3403 | |
3404 | ==== The ufs store type ==== | |
0976f8db | 3405 | |
41bd17a4 | 3406 | "ufs" is the old well-known Squid storage format that has always |
3407 | been there. | |
0976f8db | 3408 | |
638402dd AJ |
3409 | Usage: |
3410 | cache_dir ufs Directory-Name Mbytes L1 L2 [options] | |
0976f8db | 3411 | |
41bd17a4 | 3412 | 'Mbytes' is the amount of disk space (MB) to use under this |
3413 | directory. The default is 100 MB. Change this to suit your | |
3414 | configuration. Do NOT put the size of your disk drive here. | |
3415 | Instead, if you want Squid to use the entire disk drive, | |
3416 | subtract 20% and use that value. | |
0976f8db | 3417 | |
56fba4d0 | 3418 | 'L1' is the number of first-level subdirectories which |
41bd17a4 | 3419 | will be created under the 'Directory'. The default is 16. |
0976f8db | 3420 | |
56fba4d0 | 3421 | 'L2' is the number of second-level subdirectories which |
41bd17a4 | 3422 | will be created under each first-level directory. The default |
3423 | is 256. | |
0976f8db | 3424 | |
638402dd AJ |
3425 | |
3426 | ==== The aufs store type ==== | |
7f7db318 | 3427 | |
41bd17a4 | 3428 | "aufs" uses the same storage format as "ufs", utilizing |
3429 | POSIX-threads to avoid blocking the main Squid process on | |
3430 | disk-I/O. This was formerly known in Squid as async-io. | |
38f9c547 | 3431 | |
638402dd AJ |
3432 | Usage: |
3433 | cache_dir aufs Directory-Name Mbytes L1 L2 [options] | |
38f9c547 | 3434 | |
41bd17a4 | 3435 | see argument descriptions under ufs above |
38f9c547 | 3436 | |
638402dd AJ |
3437 | |
3438 | ==== The diskd store type ==== | |
38f9c547 | 3439 | |
41bd17a4 | 3440 | "diskd" uses the same storage format as "ufs", utilizing a |
3441 | separate process to avoid blocking the main Squid process on | |
3442 | disk-I/O. | |
4c3ef9b2 | 3443 | |
638402dd AJ |
3444 | Usage: |
3445 | cache_dir diskd Directory-Name Mbytes L1 L2 [options] [Q1=n] [Q2=n] | |
0976f8db | 3446 | |
41bd17a4 | 3447 | see argument descriptions under ufs above |
0976f8db | 3448 | |
41bd17a4 | 3449 | Q1 specifies the number of unacknowledged I/O requests when Squid |
3450 | stops opening new files. If this many messages are in the queues, | |
3451 | Squid won't open new files. Default is 64 | |
0976f8db | 3452 | |
41bd17a4 | 3453 | Q2 specifies the number of unacknowledged messages when Squid |
3454 | starts blocking. If this many messages are in the queues, | |
3455 | Squid blocks until it receives some replies. Default is 72 | |
0976f8db | 3456 | |
41bd17a4 | 3457 | When Q1 < Q2 (the default), the cache directory is optimized |
3458 | for lower response time at the expense of a decrease in hit | |
3459 | ratio. If Q1 > Q2, the cache directory is optimized for | |
3460 | higher hit ratio at the expense of an increase in response | |
3461 | time. | |
0976f8db | 3462 | |
e2851fe7 | 3463 | |
638402dd AJ |
3464 | ==== The rock store type ==== |
3465 | ||
3466 | Usage: | |
e51ce7da | 3467 | cache_dir rock Directory-Name Mbytes [options] |
e2851fe7 | 3468 | |
2e55f083 | 3469 | The Rock Store type is a database-style storage. All cached |
e51ce7da AR |
3470 | entries are stored in a "database" file, using fixed-size slots. |
3471 | A single entry occupies one or more slots. | |
e2851fe7 | 3472 | |
3e1dfe3d AR |
3473 | If possible, Squid using Rock Store creates a dedicated kid |
3474 | process called "disker" to avoid blocking Squid worker(s) on disk | |
3475 | I/O. One disker kid is created for each rock cache_dir. Diskers | |
3476 | are created only when Squid, running in daemon mode, has support | |
3477 | for the IpcIo disk I/O module. | |
3478 | ||
43ebbac3 AR |
3479 | swap-timeout=msec: Squid will not start writing a miss to or |
3480 | reading a hit from disk if it estimates that the swap operation | |
3481 | will take more than the specified number of milliseconds. By | |
3482 | default and when set to zero, disables the disk I/O time limit | |
3483 | enforcement. Ignored when using blocking I/O module because | |
3484 | blocking synchronous I/O does not allow Squid to estimate the | |
3485 | expected swap wait time. | |
3486 | ||
df881a0f | 3487 | max-swap-rate=swaps/sec: Artificially limits disk access using |
1e614370 | 3488 | the specified I/O rate limit. Swap out requests that |
df881a0f | 3489 | would cause the average I/O rate to exceed the limit are |
1e614370 DK |
3490 | delayed. Individual swap in requests (i.e., hits or reads) are |
3491 | not delayed, but they do contribute to measured swap rate and | |
3492 | since they are placed in the same FIFO queue as swap out | |
3493 | requests, they may wait longer if max-swap-rate is smaller. | |
3494 | This is necessary on file systems that buffer "too | |
df881a0f AR |
3495 | many" writes and then start blocking Squid and other processes |
3496 | while committing those writes to disk. Usually used together | |
3497 | with swap-timeout to avoid excessive delays and queue overflows | |
3498 | when disk demand exceeds available disk "bandwidth". By default | |
3499 | and when set to zero, disables the disk I/O rate limit | |
3500 | enforcement. Currently supported by IpcIo module only. | |
3501 | ||
e51ce7da AR |
3502 | slot-size=bytes: The size of a database "record" used for |
3503 | storing cached responses. A cached response occupies at least | |
3504 | one slot and all database I/O is done using individual slots so | |
3505 | increasing this parameter leads to more disk space waste while | |
3506 | decreasing it leads to more disk I/O overheads. Should be a | |
3507 | multiple of your operating system I/O page size. Defaults to | |
3508 | 16KBytes. A housekeeping header is stored with each slot and | |
3509 | smaller slot-sizes will be rejected. The header is smaller than | |
3510 | 100 bytes. | |
3511 | ||
df881a0f | 3512 | |
638402dd | 3513 | ==== COMMON OPTIONS ==== |
0976f8db | 3514 | |
638402dd AJ |
3515 | no-store no new objects should be stored to this cache_dir. |
3516 | ||
3517 | min-size=n the minimum object size in bytes this cache_dir | |
3518 | will accept. It's used to restrict a cache_dir | |
3519 | to only store large objects (e.g. AUFS) while | |
3520 | other stores are optimized for smaller objects | |
73656056 | 3521 | (e.g. Rock). |
638402dd | 3522 | Defaults to 0. |
0976f8db | 3523 | |
638402dd AJ |
3524 | max-size=n the maximum object size in bytes this cache_dir |
3525 | supports. | |
3526 | The value in maximum_object_size directive, sets | |
3527 | a default unless more specific details are available | |
3528 | about the cache_dir (ie a small store capacity). | |
b6662ffd | 3529 | |
41bd17a4 | 3530 | Note: To make optimal use of the max-size limits you should order |
638402dd | 3531 | the cache_dir lines with the smallest max-size value first. |
0976f8db | 3532 | |
bebc043b | 3533 | NOCOMMENT_START |
e0855596 AJ |
3534 | |
3535 | # Uncomment and adjust the following to add a disk cache directory. | |
3536 | #cache_dir ufs @DEFAULT_SWAP_DIR@ 100 16 256 | |
bebc043b | 3537 | NOCOMMENT_END |
6b698a21 | 3538 | DOC_END |
0976f8db | 3539 | |
41bd17a4 | 3540 | NAME: store_dir_select_algorithm |
3541 | TYPE: string | |
3542 | LOC: Config.store_dir_select_algorithm | |
3543 | DEFAULT: least-load | |
6b698a21 | 3544 | DOC_START |
638402dd AJ |
3545 | How Squid selects which cache_dir to use when the response |
3546 | object will fit into more than one. | |
3547 | ||
3548 | Regardless of which algorithm is used the cache_dir min-size | |
3549 | and max-size parameters are obeyed. As such they can affect | |
3550 | the selection algorithm by limiting the set of considered | |
3551 | cache_dir. | |
3552 | ||
3553 | Algorithms: | |
3554 | ||
3555 | least-load | |
3556 | ||
3557 | This algorithm is suited to caches with similar cache_dir | |
3558 | sizes and disk speeds. | |
3559 | ||
3560 | The disk with the least I/O pending is selected. | |
3561 | When there are multiple disks with the same I/O load ranking | |
3562 | the cache_dir with most available capacity is selected. | |
3563 | ||
3564 | When a mix of cache_dir sizes are configured the faster disks | |
3565 | have a naturally lower I/O loading and larger disks have more | |
3566 | capacity. So space used to store objects and data throughput | |
3567 | may be very unbalanced towards larger disks. | |
3568 | ||
3569 | ||
3570 | round-robin | |
3571 | ||
3572 | This algorithm is suited to caches with unequal cache_dir | |
3573 | disk sizes. | |
3574 | ||
3575 | Each cache_dir is selected in a rotation. The next suitable | |
3576 | cache_dir is used. | |
3577 | ||
3578 | Available cache_dir capacity is only considered in relation | |
3579 | to whether the object will fit and meets the min-size and | |
3580 | max-size parameters. | |
3581 | ||
3582 | Disk I/O loading is only considered to prevent overload on slow | |
3583 | disks. This algorithm does not spread objects by size, so any | |
3584 | I/O loading per-disk may appear very unbalanced and volatile. | |
3585 | ||
6b698a21 | 3586 | DOC_END |
0976f8db | 3587 | |
41bd17a4 | 3588 | NAME: max_open_disk_fds |
3589 | TYPE: int | |
3590 | LOC: Config.max_open_disk_fds | |
3591 | DEFAULT: 0 | |
638402dd | 3592 | DEFAULT_DOC: no limit |
6b698a21 | 3593 | DOC_START |
41bd17a4 | 3594 | To avoid having disk as the I/O bottleneck Squid can optionally |
3595 | bypass the on-disk cache if more than this amount of disk file | |
3596 | descriptors are open. | |
3597 | ||
3598 | A value of 0 indicates no limit. | |
6b698a21 | 3599 | DOC_END |
0976f8db | 3600 | |
41bd17a4 | 3601 | NAME: minimum_object_size |
6b698a21 | 3602 | COMMENT: (bytes) |
47f6e231 | 3603 | TYPE: b_int64_t |
6b698a21 | 3604 | DEFAULT: 0 KB |
638402dd | 3605 | DEFAULT_DOC: no limit |
41bd17a4 | 3606 | LOC: Config.Store.minObjectSize |
6b698a21 | 3607 | DOC_START |
41bd17a4 | 3608 | Objects smaller than this size will NOT be saved on disk. The |
638402dd AJ |
3609 | value is specified in bytes, and the default is 0 KB, which |
3610 | means all responses can be stored. | |
6b698a21 | 3611 | DOC_END |
0976f8db | 3612 | |
41bd17a4 | 3613 | NAME: maximum_object_size |
3614 | COMMENT: (bytes) | |
3615 | TYPE: b_int64_t | |
b51ec8c8 | 3616 | DEFAULT: 4 MB |
41bd17a4 | 3617 | LOC: Config.Store.maxObjectSize |
777831e0 | 3618 | DOC_START |
b51ec8c8 AJ |
3619 | The default limit on size of objects stored to disk. |
3620 | This size is used for cache_dir where max-size is not set. | |
3621 | The value is specified in bytes, and the default is 4 MB. | |
3622 | ||
3623 | If you wish to get a high BYTES hit ratio, you should probably | |
41bd17a4 | 3624 | increase this (one 32 MB object hit counts for 3200 10KB |
b51ec8c8 AJ |
3625 | hits). |
3626 | ||
3627 | If you wish to increase hit ratio more than you want to | |
41bd17a4 | 3628 | save bandwidth you should leave this low. |
777831e0 | 3629 | |
41bd17a4 | 3630 | NOTE: if using the LFUDA replacement policy you should increase |
3631 | this value to maximize the byte hit rate improvement of LFUDA! | |
3632 | See replacement_policy below for a discussion of this policy. | |
6b698a21 | 3633 | DOC_END |
0976f8db | 3634 | |
41bd17a4 | 3635 | NAME: cache_swap_low |
3636 | COMMENT: (percent, 0-100) | |
5473c134 | 3637 | TYPE: int |
41bd17a4 | 3638 | DEFAULT: 90 |
3639 | LOC: Config.Swap.lowWaterMark | |
638402dd AJ |
3640 | DOC_START |
3641 | The low-water mark for cache object replacement. | |
3642 | Replacement begins when the swap (disk) usage is above the | |
3643 | low-water mark and attempts to maintain utilization near the | |
3644 | low-water mark. As swap utilization gets close to high-water | |
3645 | mark object eviction becomes more aggressive. If utilization is | |
3646 | close to the low-water mark less replacement is done each time. | |
3647 | ||
3648 | Defaults are 90% and 95%. If you have a large cache, 5% could be | |
3649 | hundreds of MB. If this is the case you may wish to set these | |
3650 | numbers closer together. | |
3651 | ||
3652 | See also cache_swap_high | |
3653 | DOC_END | |
41bd17a4 | 3654 | |
3655 | NAME: cache_swap_high | |
3656 | COMMENT: (percent, 0-100) | |
3657 | TYPE: int | |
3658 | DEFAULT: 95 | |
3659 | LOC: Config.Swap.highWaterMark | |
6b698a21 | 3660 | DOC_START |
638402dd | 3661 | The high-water mark for cache object replacement. |
41bd17a4 | 3662 | Replacement begins when the swap (disk) usage is above the |
3663 | low-water mark and attempts to maintain utilization near the | |
3664 | low-water mark. As swap utilization gets close to high-water | |
3665 | mark object eviction becomes more aggressive. If utilization is | |
3666 | close to the low-water mark less replacement is done each time. | |
3667 | ||
3668 | Defaults are 90% and 95%. If you have a large cache, 5% could be | |
3669 | hundreds of MB. If this is the case you may wish to set these | |
3670 | numbers closer together. | |
638402dd AJ |
3671 | |
3672 | See also cache_swap_low | |
6b698a21 | 3673 | DOC_END |
0976f8db | 3674 | |
5473c134 | 3675 | COMMENT_START |
41bd17a4 | 3676 | LOGFILE OPTIONS |
5473c134 | 3677 | ----------------------------------------------------------------------------- |
3678 | COMMENT_END | |
0976f8db | 3679 | |
41bd17a4 | 3680 | NAME: logformat |
3681 | TYPE: logformat | |
20efa1c2 | 3682 | LOC: Log::TheConfig |
5473c134 | 3683 | DEFAULT: none |
638402dd | 3684 | DEFAULT_DOC: The format definitions squid, common, combined, referrer, useragent are built in. |
6b698a21 | 3685 | DOC_START |
41bd17a4 | 3686 | Usage: |
0976f8db | 3687 | |
41bd17a4 | 3688 | logformat <name> <format specification> |
0976f8db | 3689 | |
41bd17a4 | 3690 | Defines an access log format. |
6b698a21 | 3691 | |
41bd17a4 | 3692 | The <format specification> is a string with embedded % format codes |
5473c134 | 3693 | |
41bd17a4 | 3694 | % format codes all follow the same basic structure where all but |
3695 | the formatcode is optional. Output strings are automatically escaped | |
3696 | as required according to their context and the output format | |
3697 | modifiers are usually not needed, but can be specified if an explicit | |
3698 | output format is desired. | |
6b698a21 | 3699 | |
41bd17a4 | 3700 | % ["|[|'|#] [-] [[0]width] [{argument}] formatcode |
0976f8db | 3701 | |
41bd17a4 | 3702 | " output in quoted string format |
3703 | [ output in squid text log format as used by log_mime_hdrs | |
3704 | # output in URL quoted format | |
3705 | ' output as-is | |
5473c134 | 3706 | |
41bd17a4 | 3707 | - left aligned |
c32c6db7 AR |
3708 | |
3709 | width minimum and/or maximum field width: | |
3710 | [width_min][.width_max] | |
e2851fe7 AR |
3711 | When minimum starts with 0, the field is zero-padded. |
3712 | String values exceeding maximum width are truncated. | |
c32c6db7 | 3713 | |
41bd17a4 | 3714 | {arg} argument such as header name etc |
5473c134 | 3715 | |
41bd17a4 | 3716 | Format codes: |
5473c134 | 3717 | |
3ff65596 | 3718 | % a literal % character |
f4b68e1a AJ |
3719 | sn Unique sequence number per log line entry |
3720 | err_code The ID of an error response served by Squid or | |
3721 | a similar internal error identifier. | |
3722 | err_detail Additional err_code-dependent error information. | |
d7f4a0b7 CT |
3723 | note The meta header specified by the argument. Also |
3724 | logs the adaptation meta headers set by the | |
3725 | adaptation_meta configuration parameter. | |
3726 | If no argument given all meta headers logged. | |
f4b68e1a AJ |
3727 | |
3728 | Connection related format codes: | |
3729 | ||
41bd17a4 | 3730 | >a Client source IP address |
3731 | >A Client FQDN | |
3732 | >p Client source port | |
8652f8e7 AJ |
3733 | >eui Client source EUI (MAC address, EUI-48 or EUI-64 identifier) |
3734 | >la Local IP address the client connected to | |
3735 | >lp Local port number the client connected to | |
f123f5e9 CT |
3736 | >qos Client connection TOS/DSCP value set by Squid |
3737 | >nfmark Client connection netfilter mark set by Squid | |
8652f8e7 | 3738 | |
28417506 CT |
3739 | la Local listening IP address the client connection was connected to. |
3740 | lp Local listening port number the client connection was connected to. | |
3741 | ||
8652f8e7 AJ |
3742 | <a Server IP address of the last server or peer connection |
3743 | <A Server FQDN or peer name | |
3744 | <p Server port number of the last server or peer connection | |
c3a082ae | 3745 | <la Local IP address of the last server or peer connection |
152e24b3 | 3746 | <lp Local port number of the last server or peer connection |
f123f5e9 CT |
3747 | <qos Server connection TOS/DSCP value set by Squid |
3748 | <nfmark Server connection netfilter mark set by Squid | |
f4b68e1a AJ |
3749 | |
3750 | Time related format codes: | |
3751 | ||
41bd17a4 | 3752 | ts Seconds since epoch |
3753 | tu subsecond time (milliseconds) | |
3754 | tl Local time. Optional strftime format argument | |
3ff65596 | 3755 | default %d/%b/%Y:%H:%M:%S %z |
41bd17a4 | 3756 | tg GMT time. Optional strftime format argument |
3ff65596 | 3757 | default %d/%b/%Y:%H:%M:%S %z |
41bd17a4 | 3758 | tr Response time (milliseconds) |
3ff65596 | 3759 | dt Total time spent making DNS lookups (milliseconds) |
af0ded40 CT |
3760 | tS Approximate master transaction start time in |
3761 | <full seconds since epoch>.<fractional seconds> format. | |
3762 | Currently, Squid considers the master transaction | |
3763 | started when a complete HTTP request header initiating | |
3764 | the transaction is received from the client. This is | |
3765 | the same value that Squid uses to calculate transaction | |
3766 | response time when logging %tr to access.log. Currently, | |
3767 | Squid uses millisecond resolution for %tS values, | |
3768 | similar to the default access.log "current time" field | |
3769 | (%ts.%03tu). | |
3ff65596 | 3770 | |
8652f8e7 AJ |
3771 | Access Control related format codes: |
3772 | ||
3773 | et Tag returned by external acl | |
3774 | ea Log string returned by external acl | |
3775 | un User name (any available) | |
3776 | ul User name from authentication | |
3777 | ue User name from external acl helper | |
3778 | ui User name from ident | |
3779 | us User name from SSL | |
d4806c91 CT |
3780 | credentials Client credentials. The exact meaning depends on |
3781 | the authentication scheme: For Basic authentication, | |
3782 | it is the password; for Digest, the realm sent by the | |
3783 | client; for NTLM and Negotiate, the client challenge | |
3784 | or client credentials prefixed with "YR " or "KK ". | |
8652f8e7 AJ |
3785 | |
3786 | HTTP related format codes: | |
3ff65596 | 3787 | |
d6df21d2 AJ |
3788 | REQUEST |
3789 | ||
3790 | [http::]rm Request method (GET/POST etc) | |
3791 | [http::]>rm Request method from client | |
3792 | [http::]<rm Request method sent to server or peer | |
3793 | [http::]ru Request URL from client (historic, filtered for logging) | |
3794 | [http::]>ru Request URL from client | |
3795 | [http::]<ru Request URL sent to server or peer | |
fa450988 | 3796 | [http::]>rd Request URL domain from client |
d6df21d2 AJ |
3797 | [http::]rp Request URL-Path excluding hostname |
3798 | [http::]>rp Request URL-Path excluding hostname from client | |
3799 | [http::]<rp Request URL-Path excluding hostname sent to server or peer | |
3800 | [http::]rv Request protocol version | |
3801 | [http::]>rv Request protocol version from client | |
3802 | [http::]<rv Request protocol version sent to server or peer | |
3803 | ||
19483c50 AR |
3804 | [http::]>h Original received request header. |
3805 | Usually differs from the request header sent by | |
3806 | Squid, although most fields are often preserved. | |
3807 | Accepts optional header field name/value filter | |
3808 | argument using name[:[separator]element] format. | |
3809 | [http::]>ha Received request header after adaptation and | |
3810 | redirection (pre-cache REQMOD vectoring point). | |
3811 | Usually differs from the request header sent by | |
3812 | Squid, although most fields are often preserved. | |
6fca33e0 | 3813 | Optional header name argument as for >h |
d6df21d2 AJ |
3814 | |
3815 | ||
3816 | RESPONSE | |
3817 | ||
3818 | [http::]<Hs HTTP status code received from the next hop | |
3819 | [http::]>Hs HTTP status code sent to the client | |
3820 | ||
3ff65596 AR |
3821 | [http::]<h Reply header. Optional header name argument |
3822 | as for >h | |
d6df21d2 AJ |
3823 | |
3824 | [http::]mt MIME content type | |
3825 | ||
3826 | ||
3827 | SIZE COUNTERS | |
3828 | ||
3829 | [http::]st Total size of request + reply traffic with client | |
3830 | [http::]>st Total size of request received from client. | |
3831 | Excluding chunked encoding bytes. | |
3832 | [http::]<st Total size of reply sent to client (after adaptation) | |
3833 | ||
3834 | [http::]>sh Size of request headers received from client | |
3835 | [http::]<sh Size of reply headers sent to client (after adaptation) | |
3836 | ||
3837 | [http::]<sH Reply high offset sent | |
3838 | [http::]<sS Upstream object size | |
3839 | ||
bae917ac CT |
3840 | [http::]<bs Number of HTTP-equivalent message body bytes |
3841 | received from the next hop, excluding chunked | |
3842 | transfer encoding and control messages. | |
3843 | Generated FTP/Gopher listings are treated as | |
3844 | received bodies. | |
d6df21d2 AJ |
3845 | |
3846 | ||
3847 | TIMING | |
3848 | ||
3ff65596 AR |
3849 | [http::]<pt Peer response time in milliseconds. The timer starts |
3850 | when the last request byte is sent to the next hop | |
3851 | and stops when the last response byte is received. | |
3852 | [http::]<tt Total server-side time in milliseconds. The timer | |
3853 | starts with the first connect request (or write I/O) | |
3854 | sent to the first selected peer. The timer stops | |
3855 | with the last I/O with the last peer. | |
3856 | ||
8652f8e7 AJ |
3857 | Squid handling related format codes: |
3858 | ||
3859 | Ss Squid request status (TCP_MISS etc) | |
3860 | Sh Squid hierarchy status (DEFAULT_PARENT etc) | |
3861 | ||
08097970 AR |
3862 | SSL-related format codes: |
3863 | ||
3864 | ssl::bump_mode SslBump decision for the transaction: | |
3865 | ||
3866 | For CONNECT requests that initiated bumping of | |
3867 | a connection and for any request received on | |
3868 | an already bumped connection, Squid logs the | |
3869 | corresponding SslBump mode ("server-first" or | |
3870 | "client-first"). See the ssl_bump option for | |
3871 | more information about these modes. | |
3872 | ||
3873 | A "none" token is logged for requests that | |
3874 | triggered "ssl_bump" ACL evaluation matching | |
3875 | either a "none" rule or no rules at all. | |
3876 | ||
3877 | In all other cases, a single dash ("-") is | |
3878 | logged. | |
3879 | ||
5038f9d8 | 3880 | If ICAP is enabled, the following code becomes available (as |
3ff65596 AR |
3881 | well as ICAP log codes documented with the icap_log option): |
3882 | ||
3883 | icap::tt Total ICAP processing time for the HTTP | |
3884 | transaction. The timer ticks when ICAP | |
3885 | ACLs are checked and when ICAP | |
3886 | transaction is in progress. | |
3887 | ||
5038f9d8 | 3888 | If adaptation is enabled the following three codes become available: |
3ff65596 | 3889 | |
5038f9d8 AR |
3890 | adapt::<last_h The header of the last ICAP response or |
3891 | meta-information from the last eCAP | |
3892 | transaction related to the HTTP transaction. | |
3893 | Like <h, accepts an optional header name | |
3894 | argument. | |
3ff65596 AR |
3895 | |
3896 | adapt::sum_trs Summed adaptation transaction response | |
3897 | times recorded as a comma-separated list in | |
3898 | the order of transaction start time. Each time | |
3899 | value is recorded as an integer number, | |
3900 | representing response time of one or more | |
3901 | adaptation (ICAP or eCAP) transaction in | |
3902 | milliseconds. When a failed transaction is | |
3903 | being retried or repeated, its time is not | |
3904 | logged individually but added to the | |
3905 | replacement (next) transaction. See also: | |
3906 | adapt::all_trs. | |
3907 | ||
3908 | adapt::all_trs All adaptation transaction response times. | |
3909 | Same as adaptation_strs but response times of | |
3910 | individual transactions are never added | |
3911 | together. Instead, all transaction response | |
3912 | times are recorded individually. | |
3913 | ||
3914 | You can prefix adapt::*_trs format codes with adaptation | |
3915 | service name in curly braces to record response time(s) specific | |
3916 | to that service. For example: %{my_service}adapt::sum_trs | |
5473c134 | 3917 | |
f4698e0b CT |
3918 | If SSL is enabled, the following formating codes become available: |
3919 | ||
3920 | %ssl::>cert_subject The Subject field of the received client | |
3921 | SSL certificate or a dash ('-') if Squid has | |
3922 | received an invalid/malformed certificate or | |
3923 | no certificate at all. Consider encoding the | |
3924 | logged value because Subject often has spaces. | |
3925 | ||
3926 | %ssl::>cert_issuer The Issuer field of the received client | |
3927 | SSL certificate or a dash ('-') if Squid has | |
3928 | received an invalid/malformed certificate or | |
3929 | no certificate at all. Consider encoding the | |
3930 | logged value because Issuer often has spaces. | |
3931 | ||
7d9acc3c AJ |
3932 | The default formats available (which do not need re-defining) are: |
3933 | ||
bd85ea1f AJ |
3934 | logformat squid %ts.%03tu %6tr %>a %Ss/%03>Hs %<st %rm %ru %[un %Sh/%<a %mt |
3935 | logformat common %>a %[ui %[un [%tl] "%rm %ru HTTP/%rv" %>Hs %<st %Ss:%Sh | |
3936 | logformat combined %>a %[ui %[un [%tl] "%rm %ru HTTP/%rv" %>Hs %<st "%{Referer}>h" "%{User-Agent}>h" %Ss:%Sh | |
20efa1c2 AJ |
3937 | logformat referrer %ts.%03tu %>a %{Referer}>h %ru |
3938 | logformat useragent %>a [%tl] "%{User-Agent}>h" | |
3939 | ||
8652f8e7 AJ |
3940 | NOTE: When the log_mime_hdrs directive is set to ON. |
3941 | The squid, common and combined formats have a safely encoded copy | |
3942 | of the mime headers appended to each line within a pair of brackets. | |
3943 | ||
3944 | NOTE: The common and combined formats are not quite true to the Apache definition. | |
3945 | The logs from Squid contain an extra status and hierarchy code appended. | |
20efa1c2 | 3946 | |
5473c134 | 3947 | DOC_END |
3948 | ||
41bd17a4 | 3949 | NAME: access_log cache_access_log |
3950 | TYPE: access_log | |
3951 | LOC: Config.Log.accesslogs | |
82b7abe3 | 3952 | DEFAULT_IF_NONE: daemon:@DEFAULT_ACCESS_LOG@ squid |
5473c134 | 3953 | DOC_START |
fb0c2f17 NH |
3954 | Configures whether and how Squid logs HTTP and ICP transactions. |
3955 | If access logging is enabled, a single line is logged for every | |
3956 | matching HTTP or ICP request. The recommended directive formats are: | |
3957 | ||
3958 | access_log <module>:<place> [option ...] [acl acl ...] | |
3959 | access_log none [acl acl ...] | |
3960 | ||
3961 | The following directive format is accepted but may be deprecated: | |
82b7abe3 | 3962 | access_log <module>:<place> [<logformat name> [acl acl ...]] |
fb0c2f17 NH |
3963 | |
3964 | In most cases, the first ACL name must not contain the '=' character | |
3965 | and should not be equal to an existing logformat name. You can always | |
3966 | start with an 'all' ACL to work around those restrictions. | |
82b7abe3 AJ |
3967 | |
3968 | Will log to the specified module:place using the specified format (which | |
41bd17a4 | 3969 | must be defined in a logformat directive) those entries which match |
3970 | ALL the acl's specified (which must be defined in acl clauses). | |
82b7abe3 AJ |
3971 | If no acl is specified, all requests will be logged to this destination. |
3972 | ||
fb0c2f17 NH |
3973 | ===== Available options for the recommended directive format ===== |
3974 | ||
3975 | logformat=name Names log line format (either built-in or | |
3976 | defined by a logformat directive). Defaults | |
3977 | to 'squid'. | |
3978 | ||
3979 | buffer-size=64KB Defines approximate buffering limit for log | |
3980 | records (see buffered_logs). Squid should not | |
3981 | keep more than the specified size and, hence, | |
3982 | should flush records before the buffer becomes | |
3983 | full to avoid overflows under normal | |
3984 | conditions (the exact flushing algorithm is | |
3985 | module-dependent though). The on-error option | |
3986 | controls overflow handling. | |
3987 | ||
3988 | on-error=die|drop Defines action on unrecoverable errors. The | |
3989 | 'drop' action ignores (i.e., does not log) | |
3990 | affected log records. The default 'die' action | |
3991 | kills the affected worker. The drop action | |
3992 | support has not been tested for modules other | |
3993 | than tcp. | |
3994 | ||
82b7abe3 AJ |
3995 | ===== Modules Currently available ===== |
3996 | ||
bb7a1781 | 3997 | none Do not log any requests matching these ACL. |
82b7abe3 AJ |
3998 | Do not specify Place or logformat name. |
3999 | ||
4000 | stdio Write each log line to disk immediately at the completion of | |
4001 | each request. | |
4002 | Place: the filename and path to be written. | |
4003 | ||
4004 | daemon Very similar to stdio. But instead of writing to disk the log | |
4005 | line is passed to a daemon helper for asychronous handling instead. | |
4006 | Place: varies depending on the daemon. | |
4007 | ||
4008 | log_file_daemon Place: the file name and path to be written. | |
4009 | ||
4010 | syslog To log each request via syslog facility. | |
4011 | Place: The syslog facility and priority level for these entries. | |
4012 | Place Format: facility.priority | |
5473c134 | 4013 | |
82b7abe3 AJ |
4014 | where facility could be any of: |
4015 | authpriv, daemon, local0 ... local7 or user. | |
5473c134 | 4016 | |
82b7abe3 AJ |
4017 | And priority could be any of: |
4018 | err, warning, notice, info, debug. | |
4019 | ||
4020 | udp To send each log line as text data to a UDP receiver. | |
4021 | Place: The destination host name or IP and port. | |
f4fc8610 | 4022 | Place Format: //host:port |
df2eec10 | 4023 | |
2bf4e8fa | 4024 | tcp To send each log line as text data to a TCP receiver. |
fb0c2f17 | 4025 | Lines may be accumulated before sending (see buffered_logs). |
2bf4e8fa | 4026 | Place: The destination host name or IP and port. |
f4fc8610 | 4027 | Place Format: //host:port |
df2eec10 AJ |
4028 | |
4029 | Default: | |
82b7abe3 | 4030 | access_log daemon:@DEFAULT_ACCESS_LOG@ squid |
41bd17a4 | 4031 | DOC_END |
5473c134 | 4032 | |
3ff65596 AR |
4033 | NAME: icap_log |
4034 | TYPE: access_log | |
4035 | IFDEF: ICAP_CLIENT | |
4036 | LOC: Config.Log.icaplogs | |
4037 | DEFAULT: none | |
4038 | DOC_START | |
4039 | ICAP log files record ICAP transaction summaries, one line per | |
4040 | transaction. | |
4041 | ||
4042 | The icap_log option format is: | |
4043 | icap_log <filepath> [<logformat name> [acl acl ...]] | |
4044 | icap_log none [acl acl ...]] | |
4045 | ||
4046 | Please see access_log option documentation for details. The two | |
4047 | kinds of logs share the overall configuration approach and many | |
4048 | features. | |
4049 | ||
4050 | ICAP processing of a single HTTP message or transaction may | |
4051 | require multiple ICAP transactions. In such cases, multiple | |
4052 | ICAP transaction log lines will correspond to a single access | |
4053 | log line. | |
4054 | ||
4055 | ICAP log uses logformat codes that make sense for an ICAP | |
4056 | transaction. Header-related codes are applied to the HTTP header | |
4057 | embedded in an ICAP server response, with the following caveats: | |
4058 | For REQMOD, there is no HTTP response header unless the ICAP | |
4059 | server performed request satisfaction. For RESPMOD, the HTTP | |
4060 | request header is the header sent to the ICAP server. For | |
4061 | OPTIONS, there are no HTTP headers. | |
4062 | ||
4063 | The following format codes are also available for ICAP logs: | |
4064 | ||
4065 | icap::<A ICAP server IP address. Similar to <A. | |
4066 | ||
4067 | icap::<service_name ICAP service name from the icap_service | |
4068 | option in Squid configuration file. | |
4069 | ||
4070 | icap::ru ICAP Request-URI. Similar to ru. | |
4071 | ||
4072 | icap::rm ICAP request method (REQMOD, RESPMOD, or | |
4073 | OPTIONS). Similar to existing rm. | |
4074 | ||
4075 | icap::>st Bytes sent to the ICAP server (TCP payload | |
4076 | only; i.e., what Squid writes to the socket). | |
4077 | ||
4078 | icap::<st Bytes received from the ICAP server (TCP | |
4079 | payload only; i.e., what Squid reads from | |
4080 | the socket). | |
4081 | ||
bae917ac CT |
4082 | icap::<bs Number of message body bytes received from the |
4083 | ICAP server. ICAP message body, if any, usually | |
4084 | includes encapsulated HTTP message headers and | |
4085 | possibly encapsulated HTTP message body. The | |
4086 | HTTP body part is dechunked before its size is | |
4087 | computed. | |
4088 | ||
3ff65596 AR |
4089 | icap::tr Transaction response time (in |
4090 | milliseconds). The timer starts when | |
4091 | the ICAP transaction is created and | |
4092 | stops when the transaction is completed. | |
4093 | Similar to tr. | |
4094 | ||
4095 | icap::tio Transaction I/O time (in milliseconds). The | |
4096 | timer starts when the first ICAP request | |
4097 | byte is scheduled for sending. The timers | |
4098 | stops when the last byte of the ICAP response | |
4099 | is received. | |
4100 | ||
4101 | icap::to Transaction outcome: ICAP_ERR* for all | |
4102 | transaction errors, ICAP_OPT for OPTION | |
4103 | transactions, ICAP_ECHO for 204 | |
4104 | responses, ICAP_MOD for message | |
4105 | modification, and ICAP_SAT for request | |
4106 | satisfaction. Similar to Ss. | |
4107 | ||
4108 | icap::Hs ICAP response status code. Similar to Hs. | |
4109 | ||
4110 | icap::>h ICAP request header(s). Similar to >h. | |
4111 | ||
4112 | icap::<h ICAP response header(s). Similar to <h. | |
4113 | ||
4114 | The default ICAP log format, which can be used without an explicit | |
4115 | definition, is called icap_squid: | |
4116 | ||
4117 | logformat icap_squid %ts.%03tu %6icap::tr %>a %icap::to/%03icap::Hs %icap::<size %icap::rm %icap::ru% %un -/%icap::<A - | |
4118 | ||
5038f9d8 | 4119 | See also: logformat, log_icap, and %adapt::<last_h |
3ff65596 AR |
4120 | DOC_END |
4121 | ||
82b7abe3 AJ |
4122 | NAME: logfile_daemon |
4123 | TYPE: string | |
4124 | DEFAULT: @DEFAULT_LOGFILED@ | |
4125 | LOC: Log::TheConfig.logfile_daemon | |
4126 | DOC_START | |
4127 | Specify the path to the logfile-writing daemon. This daemon is | |
4128 | used to write the access and store logs, if configured. | |
14b24caf HN |
4129 | |
4130 | Squid sends a number of commands to the log daemon: | |
4131 | L<data>\n - logfile data | |
4132 | R\n - rotate file | |
4133 | T\n - truncate file | |
dd68402f | 4134 | O\n - reopen file |
14b24caf HN |
4135 | F\n - flush file |
4136 | r<n>\n - set rotate count to <n> | |
4137 | b<n>\n - 1 = buffer output, 0 = don't buffer output | |
4138 | ||
4139 | No responses is expected. | |
82b7abe3 AJ |
4140 | DOC_END |
4141 | ||
5b0f5383 | 4142 | NAME: log_access |
8ebad780 | 4143 | TYPE: obsolete |
5b0f5383 | 4144 | DOC_START |
8ebad780 | 4145 | Remove this line. Use acls with access_log directives to control access logging |
5b0f5383 | 4146 | DOC_END |
4147 | ||
3ff65596 | 4148 | NAME: log_icap |
8ebad780 CT |
4149 | TYPE: obsolete |
4150 | DOC_START | |
4151 | Remove this line. Use acls with icap_log directives to control icap logging | |
4152 | DOC_END | |
4153 | ||
4154 | NAME: stats_collection | |
3ff65596 | 4155 | TYPE: acl_access |
8ebad780 | 4156 | LOC: Config.accessList.stats_collection |
3ff65596 | 4157 | DEFAULT: none |
638402dd | 4158 | DEFAULT_DOC: Allow logging for all transactions. |
5b0f5383 | 4159 | COMMENT: allow|deny acl acl... |
3ff65596 | 4160 | DOC_START |
8ebad780 CT |
4161 | This options allows you to control which requests gets accounted |
4162 | in performance counters. | |
b3567eb5 FC |
4163 | |
4164 | This clause only supports fast acl types. | |
4165 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
3ff65596 AR |
4166 | DOC_END |
4167 | ||
41bd17a4 | 4168 | NAME: cache_store_log |
4169 | TYPE: string | |
df2eec10 | 4170 | DEFAULT: none |
41bd17a4 | 4171 | LOC: Config.Log.store |
4172 | DOC_START | |
4173 | Logs the activities of the storage manager. Shows which | |
4174 | objects are ejected from the cache, and which objects are | |
6d1dfcfc | 4175 | saved and for how long. |
df2eec10 | 4176 | There are not really utilities to analyze this data, so you can safely |
6d1dfcfc AJ |
4177 | disable it (the default). |
4178 | ||
4179 | Store log uses modular logging outputs. See access_log for the list | |
4180 | of modules supported. | |
4181 | ||
e0855596 | 4182 | Example: |
6d1dfcfc AJ |
4183 | cache_store_log stdio:@DEFAULT_STORE_LOG@ |
4184 | cache_store_log daemon:@DEFAULT_STORE_LOG@ | |
5473c134 | 4185 | DOC_END |
4186 | ||
41bd17a4 | 4187 | NAME: cache_swap_state cache_swap_log |
4188 | TYPE: string | |
4189 | LOC: Config.Log.swap | |
5473c134 | 4190 | DEFAULT: none |
638402dd | 4191 | DEFAULT_DOC: Store the journal inside its cache_dir |
5473c134 | 4192 | DOC_START |
41bd17a4 | 4193 | Location for the cache "swap.state" file. This index file holds |
4194 | the metadata of objects saved on disk. It is used to rebuild | |
4195 | the cache during startup. Normally this file resides in each | |
4196 | 'cache_dir' directory, but you may specify an alternate | |
4197 | pathname here. Note you must give a full filename, not just | |
4198 | a directory. Since this is the index for the whole object | |
4199 | list you CANNOT periodically rotate it! | |
5473c134 | 4200 | |
41bd17a4 | 4201 | If %s can be used in the file name it will be replaced with a |
4202 | a representation of the cache_dir name where each / is replaced | |
4203 | with '.'. This is needed to allow adding/removing cache_dir | |
4204 | lines when cache_swap_log is being used. | |
5473c134 | 4205 | |
41bd17a4 | 4206 | If have more than one 'cache_dir', and %s is not used in the name |
4207 | these swap logs will have names such as: | |
5473c134 | 4208 | |
41bd17a4 | 4209 | cache_swap_log.00 |
4210 | cache_swap_log.01 | |
4211 | cache_swap_log.02 | |
5473c134 | 4212 | |
41bd17a4 | 4213 | The numbered extension (which is added automatically) |
4214 | corresponds to the order of the 'cache_dir' lines in this | |
4215 | configuration file. If you change the order of the 'cache_dir' | |
4216 | lines in this file, these index files will NOT correspond to | |
4217 | the correct 'cache_dir' entry (unless you manually rename | |
4218 | them). We recommend you do NOT use this option. It is | |
4219 | better to keep these index files in each 'cache_dir' directory. | |
5473c134 | 4220 | DOC_END |
4221 | ||
41bd17a4 | 4222 | NAME: logfile_rotate |
4223 | TYPE: int | |
4224 | DEFAULT: 10 | |
4225 | LOC: Config.Log.rotateNumber | |
5473c134 | 4226 | DOC_START |
41bd17a4 | 4227 | Specifies the number of logfile rotations to make when you |
4228 | type 'squid -k rotate'. The default is 10, which will rotate | |
4229 | with extensions 0 through 9. Setting logfile_rotate to 0 will | |
4230 | disable the file name rotation, but the logfiles are still closed | |
4231 | and re-opened. This will enable you to rename the logfiles | |
4232 | yourself just before sending the rotate signal. | |
5473c134 | 4233 | |
41bd17a4 | 4234 | Note, the 'squid -k rotate' command normally sends a USR1 |
4235 | signal to the running squid process. In certain situations | |
4236 | (e.g. on Linux with Async I/O), USR1 is used for other | |
4237 | purposes, so -k rotate uses another signal. It is best to get | |
4238 | in the habit of using 'squid -k rotate' instead of 'kill -USR1 | |
4239 | <pid>'. | |
62493678 | 4240 | |
638402dd AJ |
4241 | Note, from Squid-3.1 this option is only a default for cache.log, |
4242 | that log can be rotated separately by using debug_options. | |
41bd17a4 | 4243 | DOC_END |
5473c134 | 4244 | |
41bd17a4 | 4245 | NAME: emulate_httpd_log |
20efa1c2 | 4246 | TYPE: obsolete |
41bd17a4 | 4247 | DOC_START |
20efa1c2 | 4248 | Replace this with an access_log directive using the format 'common' or 'combined'. |
5473c134 | 4249 | DOC_END |
4250 | ||
41bd17a4 | 4251 | NAME: log_ip_on_direct |
8652f8e7 | 4252 | TYPE: obsolete |
5473c134 | 4253 | DOC_START |
8652f8e7 | 4254 | Remove this option from your config. To log server or peer names use %<A in the log format. |
41bd17a4 | 4255 | DOC_END |
5473c134 | 4256 | |
41bd17a4 | 4257 | NAME: mime_table |
4258 | TYPE: string | |
4259 | DEFAULT: @DEFAULT_MIME_TABLE@ | |
4260 | LOC: Config.mimeTablePathname | |
4261 | DOC_START | |
638402dd AJ |
4262 | Path to Squid's icon configuration file. |
4263 | ||
4264 | You shouldn't need to change this, but the default file contains | |
4265 | examples and formatting information if you do. | |
5473c134 | 4266 | DOC_END |
4267 | ||
41bd17a4 | 4268 | NAME: log_mime_hdrs |
4269 | COMMENT: on|off | |
4270 | TYPE: onoff | |
4271 | LOC: Config.onoff.log_mime_hdrs | |
4272 | DEFAULT: off | |
4273 | DOC_START | |
4274 | The Cache can record both the request and the response MIME | |
4275 | headers for each HTTP transaction. The headers are encoded | |
4276 | safely and will appear as two bracketed fields at the end of | |
4277 | the access log (for either the native or httpd-emulated log | |
4278 | formats). To enable this logging set log_mime_hdrs to 'on'. | |
4279 | DOC_END | |
5473c134 | 4280 | |
41bd17a4 | 4281 | NAME: useragent_log |
20efa1c2 | 4282 | TYPE: obsolete |
5473c134 | 4283 | DOC_START |
20efa1c2 | 4284 | Replace this with an access_log directive using the format 'useragent'. |
5473c134 | 4285 | DOC_END |
4286 | ||
41bd17a4 | 4287 | NAME: referer_log referrer_log |
20efa1c2 | 4288 | TYPE: obsolete |
5473c134 | 4289 | DOC_START |
20efa1c2 | 4290 | Replace this with an access_log directive using the format 'referrer'. |
5473c134 | 4291 | DOC_END |
4292 | ||
41bd17a4 | 4293 | NAME: pid_filename |
4294 | TYPE: string | |
4295 | DEFAULT: @DEFAULT_PID_FILE@ | |
4296 | LOC: Config.pidFilename | |
5473c134 | 4297 | DOC_START |
41bd17a4 | 4298 | A filename to write the process-id to. To disable, enter "none". |
5473c134 | 4299 | DOC_END |
4300 | ||
41bd17a4 | 4301 | NAME: log_fqdn |
c581e96b | 4302 | TYPE: obsolete |
5473c134 | 4303 | DOC_START |
c581e96b | 4304 | Remove this option from your config. To log FQDN use %>A in the log format. |
5473c134 | 4305 | DOC_END |
4306 | ||
41bd17a4 | 4307 | NAME: client_netmask |
4308 | TYPE: address | |
4309 | LOC: Config.Addrs.client_netmask | |
0eb08770 | 4310 | DEFAULT: no_addr |
638402dd | 4311 | DEFAULT_DOC: Log full client IP address |
5473c134 | 4312 | DOC_START |
41bd17a4 | 4313 | A netmask for client addresses in logfiles and cachemgr output. |
4314 | Change this to protect the privacy of your cache clients. | |
4315 | A netmask of 255.255.255.0 will log all IP's in that range with | |
4316 | the last digit set to '0'. | |
5473c134 | 4317 | DOC_END |
4318 | ||
41bd17a4 | 4319 | NAME: forward_log |
20efa1c2 | 4320 | TYPE: obsolete |
5473c134 | 4321 | DOC_START |
20efa1c2 | 4322 | Use a regular access.log with ACL limiting it to MISS events. |
5473c134 | 4323 | DOC_END |
4324 | ||
41bd17a4 | 4325 | NAME: strip_query_terms |
5473c134 | 4326 | TYPE: onoff |
41bd17a4 | 4327 | LOC: Config.onoff.strip_query_terms |
5473c134 | 4328 | DEFAULT: on |
4329 | DOC_START | |
41bd17a4 | 4330 | By default, Squid strips query terms from requested URLs before |
638402dd AJ |
4331 | logging. This protects your user's privacy and reduces log size. |
4332 | ||
4333 | When investigating HIT/MISS or other caching behaviour you | |
4334 | will need to disable this to see the full URL used by Squid. | |
5473c134 | 4335 | DOC_END |
4336 | ||
41bd17a4 | 4337 | NAME: buffered_logs |
4338 | COMMENT: on|off | |
4339 | TYPE: onoff | |
4340 | DEFAULT: off | |
4341 | LOC: Config.onoff.buffered_logs | |
5473c134 | 4342 | DOC_START |
638402dd AJ |
4343 | Whether to write/send access_log records ASAP or accumulate them and |
4344 | then write/send them in larger chunks. Buffering may improve | |
4345 | performance because it decreases the number of I/Os. However, | |
4346 | buffering increases the delay before log records become available to | |
4347 | the final recipient (e.g., a disk file or logging daemon) and, | |
4348 | hence, increases the risk of log records loss. | |
4349 | ||
4350 | Note that even when buffered_logs are off, Squid may have to buffer | |
4351 | records if it cannot write/send them immediately due to pending I/Os | |
4352 | (e.g., the I/O writing the previous log record) or connectivity loss. | |
4353 | ||
fb0c2f17 | 4354 | Currently honored by 'daemon' and 'tcp' access_log modules only. |
6b698a21 | 4355 | DOC_END |
0976f8db | 4356 | |
2b753521 | 4357 | NAME: netdb_filename |
4358 | TYPE: string | |
221faecb | 4359 | DEFAULT: stdio:@DEFAULT_NETDB_FILE@ |
2b753521 | 4360 | LOC: Config.netdbFilename |
fb6a61d1 | 4361 | IFDEF: USE_ICMP |
2b753521 | 4362 | DOC_START |
638402dd AJ |
4363 | Where Squid stores it's netdb journal. |
4364 | When enabled this journal preserves netdb state between restarts. | |
4365 | ||
2b753521 | 4366 | To disable, enter "none". |
4367 | DOC_END | |
4368 | ||
62493678 AJ |
4369 | COMMENT_START |
4370 | OPTIONS FOR TROUBLESHOOTING | |
4371 | ----------------------------------------------------------------------------- | |
4372 | COMMENT_END | |
4373 | ||
4374 | NAME: cache_log | |
4375 | TYPE: string | |
62493678 AJ |
4376 | DEFAULT_IF_NONE: @DEFAULT_CACHE_LOG@ |
4377 | LOC: Debug::cache_log | |
4378 | DOC_START | |
638402dd AJ |
4379 | Squid administrative logging file. |
4380 | ||
4381 | This is where general information about Squid behavior goes. You can | |
4382 | increase the amount of data logged to this file and how often it is | |
4383 | rotated with "debug_options" | |
62493678 AJ |
4384 | DOC_END |
4385 | ||
4386 | NAME: debug_options | |
4387 | TYPE: eol | |
47df1aa7 | 4388 | DEFAULT: ALL,1 |
638402dd | 4389 | DEFAULT_DOC: Log all critical and important messages. |
62493678 AJ |
4390 | LOC: Debug::debugOptions |
4391 | DOC_START | |
4392 | Logging options are set as section,level where each source file | |
4393 | is assigned a unique section. Lower levels result in less | |
4394 | output, Full debugging (level 9) can result in a very large | |
4395 | log file, so be careful. | |
4396 | ||
4397 | The magic word "ALL" sets debugging levels for all sections. | |
638402dd | 4398 | The default is to run with "ALL,1" to record important warnings. |
62493678 | 4399 | |
47df1aa7 AJ |
4400 | The rotate=N option can be used to keep more or less of these logs |
4401 | than would otherwise be kept by logfile_rotate. | |
62493678 AJ |
4402 | For most uses a single log should be enough to monitor current |
4403 | events affecting Squid. | |
4404 | DOC_END | |
4405 | ||
4406 | NAME: coredump_dir | |
4407 | TYPE: string | |
4408 | LOC: Config.coredump_dir | |
62493678 | 4409 | DEFAULT_IF_NONE: none |
638402dd | 4410 | DEFAULT_DOC: Use the directory from where Squid was started. |
62493678 AJ |
4411 | DOC_START |
4412 | By default Squid leaves core files in the directory from where | |
4413 | it was started. If you set 'coredump_dir' to a directory | |
4414 | that exists, Squid will chdir() to that directory at startup | |
4415 | and coredump files will be left there. | |
4416 | ||
4417 | NOCOMMENT_START | |
e0855596 | 4418 | |
62493678 AJ |
4419 | # Leave coredumps in the first cache dir |
4420 | coredump_dir @DEFAULT_SWAP_DIR@ | |
4421 | NOCOMMENT_END | |
4422 | DOC_END | |
4423 | ||
4424 | ||
41bd17a4 | 4425 | COMMENT_START |
4426 | OPTIONS FOR FTP GATEWAYING | |
4427 | ----------------------------------------------------------------------------- | |
4428 | COMMENT_END | |
4429 | ||
4430 | NAME: ftp_user | |
4431 | TYPE: string | |
4432 | DEFAULT: Squid@ | |
4433 | LOC: Config.Ftp.anon_user | |
6b698a21 | 4434 | DOC_START |
41bd17a4 | 4435 | If you want the anonymous login password to be more informative |
638402dd | 4436 | (and enable the use of picky FTP servers), set this to something |
41bd17a4 | 4437 | reasonable for your domain, like wwwuser@somewhere.net |
7f7db318 | 4438 | |
41bd17a4 | 4439 | The reason why this is domainless by default is the |
4440 | request can be made on the behalf of a user in any domain, | |
4441 | depending on how the cache is used. | |
638402dd | 4442 | Some FTP server also validate the email address is valid |
41bd17a4 | 4443 | (for example perl.com). |
6b698a21 | 4444 | DOC_END |
0976f8db | 4445 | |
41bd17a4 | 4446 | NAME: ftp_passive |
4447 | TYPE: onoff | |
4448 | DEFAULT: on | |
4449 | LOC: Config.Ftp.passive | |
6b698a21 | 4450 | DOC_START |
41bd17a4 | 4451 | If your firewall does not allow Squid to use passive |
4452 | connections, turn off this option. | |
a689bd4e | 4453 | |
4454 | Use of ftp_epsv_all option requires this to be ON. | |
4455 | DOC_END | |
4456 | ||
4457 | NAME: ftp_epsv_all | |
4458 | TYPE: onoff | |
4459 | DEFAULT: off | |
4460 | LOC: Config.Ftp.epsv_all | |
4461 | DOC_START | |
4462 | FTP Protocol extensions permit the use of a special "EPSV ALL" command. | |
4463 | ||
4464 | NATs may be able to put the connection on a "fast path" through the | |
4465 | translator, as the EPRT command will never be used and therefore, | |
4466 | translation of the data portion of the segments will never be needed. | |
4467 | ||
b3567eb5 FC |
4468 | When a client only expects to do two-way FTP transfers this may be |
4469 | useful. | |
a689bd4e | 4470 | If squid finds that it must do a three-way FTP transfer after issuing |
4471 | an EPSV ALL command, the FTP session will fail. | |
4472 | ||
4473 | If you have any doubts about this option do not use it. | |
4474 | Squid will nicely attempt all other connection methods. | |
4475 | ||
51ee534d AJ |
4476 | Requires ftp_passive to be ON (default) for any effect. |
4477 | DOC_END | |
4478 | ||
4479 | NAME: ftp_epsv | |
4480 | TYPE: onoff | |
4481 | DEFAULT: on | |
4482 | LOC: Config.Ftp.epsv | |
4483 | DOC_START | |
4484 | FTP Protocol extensions permit the use of a special "EPSV" command. | |
4485 | ||
4486 | NATs may be able to put the connection on a "fast path" through the | |
b3567eb5 FC |
4487 | translator using EPSV, as the EPRT command will never be used |
4488 | and therefore, translation of the data portion of the segments | |
4489 | will never be needed. | |
51ee534d AJ |
4490 | |
4491 | Turning this OFF will prevent EPSV being attempted. | |
4492 | WARNING: Doing so will convert Squid back to the old behavior with all | |
4493 | the related problems with external NAT devices/layers. | |
4494 | ||
4495 | Requires ftp_passive to be ON (default) for any effect. | |
41bd17a4 | 4496 | DOC_END |
9e7dbc51 | 4497 | |
63ee5443 AJ |
4498 | NAME: ftp_eprt |
4499 | TYPE: onoff | |
4500 | DEFAULT: on | |
4501 | LOC: Config.Ftp.eprt | |
4502 | DOC_START | |
4503 | FTP Protocol extensions permit the use of a special "EPRT" command. | |
4504 | ||
4505 | This extension provides a protocol neutral alternative to the | |
4506 | IPv4-only PORT command. When supported it enables active FTP data | |
4507 | channels over IPv6 and efficient NAT handling. | |
4508 | ||
4509 | Turning this OFF will prevent EPRT being attempted and will skip | |
4510 | straight to using PORT for IPv4 servers. | |
4511 | ||
4512 | Some devices are known to not handle this extension correctly and | |
4513 | may result in crashes. Devices which suport EPRT enough to fail | |
4514 | cleanly will result in Squid attempting PORT anyway. This directive | |
4515 | should only be disabled when EPRT results in device failures. | |
4516 | ||
4517 | WARNING: Doing so will convert Squid back to the old behavior with all | |
4518 | the related problems with external NAT devices/layers and IPv4-only FTP. | |
4519 | DOC_END | |
4520 | ||
41bd17a4 | 4521 | NAME: ftp_sanitycheck |
4522 | TYPE: onoff | |
4523 | DEFAULT: on | |
4524 | LOC: Config.Ftp.sanitycheck | |
4525 | DOC_START | |
4526 | For security and data integrity reasons Squid by default performs | |
4527 | sanity checks of the addresses of FTP data connections ensure the | |
4528 | data connection is to the requested server. If you need to allow | |
4529 | FTP connections to servers using another IP address for the data | |
4530 | connection turn this off. | |
4531 | DOC_END | |
9e7dbc51 | 4532 | |
41bd17a4 | 4533 | NAME: ftp_telnet_protocol |
4534 | TYPE: onoff | |
4535 | DEFAULT: on | |
4536 | LOC: Config.Ftp.telnet | |
4537 | DOC_START | |
4538 | The FTP protocol is officially defined to use the telnet protocol | |
4539 | as transport channel for the control connection. However, many | |
4540 | implementations are broken and does not respect this aspect of | |
4541 | the FTP protocol. | |
4542 | ||
4543 | If you have trouble accessing files with ASCII code 255 in the | |
4544 | path or similar problems involving this ASCII code you can | |
4545 | try setting this directive to off. If that helps, report to the | |
4546 | operator of the FTP server in question that their FTP server | |
4547 | is broken and does not follow the FTP standard. | |
4548 | DOC_END | |
4549 | ||
4550 | COMMENT_START | |
4551 | OPTIONS FOR EXTERNAL SUPPORT PROGRAMS | |
4552 | ----------------------------------------------------------------------------- | |
4553 | COMMENT_END | |
4554 | ||
4555 | NAME: diskd_program | |
4556 | TYPE: string | |
4557 | DEFAULT: @DEFAULT_DISKD@ | |
4558 | LOC: Config.Program.diskd | |
4559 | DOC_START | |
4560 | Specify the location of the diskd executable. | |
4561 | Note this is only useful if you have compiled in | |
4562 | diskd as one of the store io modules. | |
4563 | DOC_END | |
4564 | ||
4565 | NAME: unlinkd_program | |
4566 | IFDEF: USE_UNLINKD | |
4567 | TYPE: string | |
4568 | DEFAULT: @DEFAULT_UNLINKD@ | |
4569 | LOC: Config.Program.unlinkd | |
4570 | DOC_START | |
4571 | Specify the location of the executable for file deletion process. | |
4572 | DOC_END | |
4573 | ||
4574 | NAME: pinger_program | |
4575 | TYPE: string | |
4576 | DEFAULT: @DEFAULT_PINGER@ | |
cc192b50 | 4577 | LOC: Config.pinger.program |
41bd17a4 | 4578 | IFDEF: USE_ICMP |
4579 | DOC_START | |
4580 | Specify the location of the executable for the pinger process. | |
4581 | DOC_END | |
4582 | ||
cc192b50 | 4583 | NAME: pinger_enable |
4584 | TYPE: onoff | |
4585 | DEFAULT: on | |
4586 | LOC: Config.pinger.enable | |
4587 | IFDEF: USE_ICMP | |
4588 | DOC_START | |
4589 | Control whether the pinger is active at run-time. | |
b3567eb5 FC |
4590 | Enables turning ICMP pinger on and off with a simple |
4591 | squid -k reconfigure. | |
cc192b50 | 4592 | DOC_END |
4593 | ||
4594 | ||
41bd17a4 | 4595 | COMMENT_START |
4596 | OPTIONS FOR URL REWRITING | |
4597 | ----------------------------------------------------------------------------- | |
4598 | COMMENT_END | |
4599 | ||
4600 | NAME: url_rewrite_program redirect_program | |
4601 | TYPE: wordlist | |
4602 | LOC: Config.Program.redirect | |
4603 | DEFAULT: none | |
4604 | DOC_START | |
2c7aad89 | 4605 | Specify the location of the executable URL rewriter to use. |
41bd17a4 | 4606 | Since they can perform almost any function there isn't one included. |
4607 | ||
2c7aad89 | 4608 | For each requested URL, the rewriter will receive on line with the format |
41bd17a4 | 4609 | |
b11724bb | 4610 | [channel-ID <SP>] URL [<SP> extras]<NL> |
5269ec0e | 4611 | |
c71adec1 | 4612 | |
5269ec0e AJ |
4613 | After processing the request the helper must reply using the following format: |
4614 | ||
24eac830 | 4615 | [channel-ID <SP>] result [<SP> kv-pairs] |
5269ec0e AJ |
4616 | |
4617 | The result code can be: | |
4618 | ||
4619 | OK status=30N url="..." | |
4620 | Redirect the URL to the one supplied in 'url='. | |
4621 | 'status=' is optional and contains the status code to send | |
4622 | the client in Squids HTTP response. It must be one of the | |
4623 | HTTP redirect status codes: 301, 302, 303, 307, 308. | |
4624 | When no status is given Squid will use 302. | |
c71adec1 | 4625 | |
5269ec0e AJ |
4626 | OK rewrite-url="..." |
4627 | Rewrite the URL to the one supplied in 'rewrite-url='. | |
4628 | The new URL is fetched directly by Squid and returned to | |
4629 | the client as the response to its request. | |
4630 | ||
c2cbbb02 AJ |
4631 | OK |
4632 | When neither of url= and rewrite-url= are sent Squid does | |
4633 | not change the URL. | |
4634 | ||
5269ec0e AJ |
4635 | ERR |
4636 | Do not change the URL. | |
4637 | ||
4638 | BH | |
4ded749e | 4639 | An internal error occurred in the helper, preventing |
c2cbbb02 AJ |
4640 | a result being identified. The 'message=' key name is |
4641 | reserved for delivering a log message. | |
5269ec0e AJ |
4642 | |
4643 | ||
4644 | In the future, the interface protocol will be extended with | |
24eac830 | 4645 | key=value pairs ("kv-pairs" shown above). Helper programs |
c71adec1 | 4646 | should be prepared to receive and possibly ignore additional |
4647 | whitespace-separated tokens on each input line. | |
41bd17a4 | 4648 | |
5269ec0e AJ |
4649 | When using the concurrency= option the protocol is changed by |
4650 | introducing a query channel tag in front of the request/response. | |
4651 | The query channel tag is a number between 0 and concurrency-1. | |
4652 | This value must be echoed back unchanged to Squid as the first part | |
4653 | of the response relating to its request. | |
4654 | ||
4655 | WARNING: URL re-writing ability should be avoided whenever possible. | |
4656 | Use the URL redirect form of response instead. | |
41bd17a4 | 4657 | |
5269ec0e AJ |
4658 | Re-write creates a difference in the state held by the client |
4659 | and server. Possibly causing confusion when the server response | |
4660 | contains snippets of its view state. Embeded URLs, response | |
4661 | and content Location headers, etc. are not re-written by this | |
4662 | interface. | |
41bd17a4 | 4663 | |
4664 | By default, a URL rewriter is not used. | |
4665 | DOC_END | |
4666 | ||
4667 | NAME: url_rewrite_children redirect_children | |
48d54e4d | 4668 | TYPE: HelperChildConfig |
5b708d95 | 4669 | DEFAULT: 20 startup=0 idle=1 concurrency=0 |
41bd17a4 | 4670 | LOC: Config.redirectChildren |
4671 | DOC_START | |
48d54e4d AJ |
4672 | The maximum number of redirector processes to spawn. If you limit |
4673 | it too few Squid will have to wait for them to process a backlog of | |
4674 | URLs, slowing it down. If you allow too many they will use RAM | |
4675 | and other system resources noticably. | |
4676 | ||
4677 | The startup= and idle= options allow some measure of skew in your | |
4678 | tuning. | |
4679 | ||
4680 | startup= | |
4681 | ||
4682 | Sets a minimum of how many processes are to be spawned when Squid | |
4683 | starts or reconfigures. When set to zero the first request will | |
4684 | cause spawning of the first child process to handle it. | |
4685 | ||
4686 | Starting too few will cause an initial slowdown in traffic as Squid | |
4687 | attempts to simultaneously spawn enough processes to cope. | |
4688 | ||
4689 | idle= | |
4690 | ||
4691 | Sets a minimum of how many processes Squid is to try and keep available | |
4692 | at all times. When traffic begins to rise above what the existing | |
4693 | processes can handle this many more will be spawned up to the maximum | |
4694 | configured. A minimum setting of 1 is required. | |
4695 | ||
4696 | concurrency= | |
41bd17a4 | 4697 | |
41bd17a4 | 4698 | The number of requests each redirector helper can handle in |
4699 | parallel. Defaults to 0 which indicates the redirector | |
4700 | is a old-style single threaded redirector. | |
6a171502 AJ |
4701 | |
4702 | When this directive is set to a value >= 1 then the protocol | |
4703 | used to communicate with the helper is modified to include | |
9bef05b1 AJ |
4704 | an ID in front of the request/response. The ID from the request |
4705 | must be echoed back with the response to that request. | |
41bd17a4 | 4706 | DOC_END |
4707 | ||
4708 | NAME: url_rewrite_host_header redirect_rewrites_host_header | |
4709 | TYPE: onoff | |
4710 | DEFAULT: on | |
4711 | LOC: Config.onoff.redir_rewrites_host | |
4712 | DOC_START | |
3ce33807 AJ |
4713 | To preserve same-origin security policies in browsers and |
4714 | prevent Host: header forgery by redirectors Squid rewrites | |
4715 | any Host: header in redirected requests. | |
4716 | ||
4717 | If you are running an accelerator this may not be a wanted | |
4718 | effect of a redirector. This directive enables you disable | |
4719 | Host: alteration in reverse-proxy traffic. | |
4720 | ||
41bd17a4 | 4721 | WARNING: Entries are cached on the result of the URL rewriting |
4722 | process, so be careful if you have domain-virtual hosts. | |
3ce33807 AJ |
4723 | |
4724 | WARNING: Squid and other software verifies the URL and Host | |
4725 | are matching, so be careful not to relay through other proxies | |
4726 | or inspecting firewalls with this disabled. | |
41bd17a4 | 4727 | DOC_END |
4728 | ||
4729 | NAME: url_rewrite_access redirector_access | |
4730 | TYPE: acl_access | |
4731 | DEFAULT: none | |
638402dd | 4732 | DEFAULT_DOC: Allow, unless rules exist in squid.conf. |
41bd17a4 | 4733 | LOC: Config.accessList.redirector |
4734 | DOC_START | |
4735 | If defined, this access list specifies which requests are | |
638402dd | 4736 | sent to the redirector processes. |
b3567eb5 FC |
4737 | |
4738 | This clause supports both fast and slow acl types. | |
4739 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
41bd17a4 | 4740 | DOC_END |
4741 | ||
4742 | NAME: url_rewrite_bypass redirector_bypass | |
4743 | TYPE: onoff | |
4744 | LOC: Config.onoff.redirector_bypass | |
4745 | DEFAULT: off | |
4746 | DOC_START | |
4747 | When this is 'on', a request will not go through the | |
638402dd | 4748 | redirector if all the helpers are busy. If this is 'off' |
41bd17a4 | 4749 | and the redirector queue grows too large, Squid will exit |
4750 | with a FATAL error and ask you to increase the number of | |
4751 | redirectors. You should only enable this if the redirectors | |
4752 | are not critical to your caching system. If you use | |
4753 | redirectors for access control, and you enable this option, | |
4754 | users may have access to pages they should not | |
4755 | be allowed to request. | |
4756 | DOC_END | |
4757 | ||
fe7966ec | 4758 | NAME: url_rewrite_extras |
b11724bb CT |
4759 | TYPE: TokenOrQuotedString |
4760 | LOC: Config.redirector_extras | |
4761 | DEFAULT: "%>a/%>A %un %>rm myip=%la myport=%lp" | |
4762 | DOC_START | |
4763 | Specifies a string to be append to request line format for the | |
4764 | rewriter helper. "Quoted" format values may contain spaces and | |
4765 | logformat %macros. In theory, any logformat %macro can be used. | |
4766 | In practice, a %macro expands as a dash (-) if the helper request is | |
4767 | sent before the required macro information is available to Squid. | |
4768 | DOC_END | |
4769 | ||
a8a0b1c2 EC |
4770 | COMMENT_START |
4771 | OPTIONS FOR STORE ID | |
4772 | ----------------------------------------------------------------------------- | |
4773 | COMMENT_END | |
4774 | ||
4775 | NAME: store_id_program storeurl_rewrite_program | |
4776 | TYPE: wordlist | |
4777 | LOC: Config.Program.store_id | |
4778 | DEFAULT: none | |
4779 | DOC_START | |
4780 | Specify the location of the executable StoreID helper to use. | |
4781 | Since they can perform almost any function there isn't one included. | |
4782 | ||
4783 | For each requested URL, the helper will receive one line with the format | |
4784 | ||
b11724bb | 4785 | [channel-ID <SP>] URL [<SP> extras]<NL> |
a8a0b1c2 EC |
4786 | |
4787 | ||
4788 | After processing the request the helper must reply using the following format: | |
4789 | ||
4790 | [channel-ID <SP>] result [<SP> kv-pairs] | |
4791 | ||
4792 | The result code can be: | |
4793 | ||
4794 | OK store-id="..." | |
4795 | Use the StoreID supplied in 'store-id='. | |
4796 | ||
4797 | ERR | |
4798 | The default is to use HTTP request URL as the store ID. | |
4799 | ||
4800 | BH | |
4801 | An internal error occured in the helper, preventing | |
4802 | a result being identified. | |
4803 | ||
4804 | ||
b11724bb CT |
4805 | Helper programs should be prepared to receive and possibly ignore |
4806 | additional whitespace-separated tokens on each input line. | |
a8a0b1c2 EC |
4807 | |
4808 | When using the concurrency= option the protocol is changed by | |
4809 | introducing a query channel tag in front of the request/response. | |
4810 | The query channel tag is a number between 0 and concurrency-1. | |
4811 | This value must be echoed back unchanged to Squid as the first part | |
4812 | of the response relating to its request. | |
4813 | ||
4814 | NOTE: when using StoreID refresh_pattern will apply to the StoreID | |
4815 | returned from the helper and not the URL. | |
4816 | ||
4817 | WARNING: Wrong StoreID value returned by a careless helper may result | |
4818 | in the wrong cached response returned to the user. | |
4819 | ||
4820 | By default, a StoreID helper is not used. | |
4821 | DOC_END | |
4822 | ||
fe7966ec | 4823 | NAME: store_id_extras |
b11724bb CT |
4824 | TYPE: TokenOrQuotedString |
4825 | LOC: Config.storeId_extras | |
4826 | DEFAULT: "%>a/%>A %un %>rm myip=%la myport=%lp" | |
4827 | DOC_START | |
4828 | Specifies a string to be append to request line format for the | |
4829 | StoreId helper. "Quoted" format values may contain spaces and | |
4830 | logformat %macros. In theory, any logformat %macro can be used. | |
4831 | In practice, a %macro expands as a dash (-) if the helper request is | |
4832 | sent before the required macro information is available to Squid. | |
4833 | DOC_END | |
4834 | ||
a8a0b1c2 EC |
4835 | NAME: store_id_children storeurl_rewrite_children |
4836 | TYPE: HelperChildConfig | |
4837 | DEFAULT: 20 startup=0 idle=1 concurrency=0 | |
4838 | LOC: Config.storeIdChildren | |
4839 | DOC_START | |
4840 | The maximum number of StoreID helper processes to spawn. If you limit | |
4841 | it too few Squid will have to wait for them to process a backlog of | |
4842 | requests, slowing it down. If you allow too many they will use RAM | |
4843 | and other system resources noticably. | |
4844 | ||
4845 | The startup= and idle= options allow some measure of skew in your | |
4846 | tuning. | |
4847 | ||
4848 | startup= | |
4849 | ||
4850 | Sets a minimum of how many processes are to be spawned when Squid | |
4851 | starts or reconfigures. When set to zero the first request will | |
4852 | cause spawning of the first child process to handle it. | |
4853 | ||
4854 | Starting too few will cause an initial slowdown in traffic as Squid | |
4855 | attempts to simultaneously spawn enough processes to cope. | |
4856 | ||
4857 | idle= | |
4858 | ||
4859 | Sets a minimum of how many processes Squid is to try and keep available | |
4860 | at all times. When traffic begins to rise above what the existing | |
4861 | processes can handle this many more will be spawned up to the maximum | |
4862 | configured. A minimum setting of 1 is required. | |
4863 | ||
4864 | concurrency= | |
4865 | ||
4866 | The number of requests each storeID helper can handle in | |
4867 | parallel. Defaults to 0 which indicates the helper | |
4868 | is a old-style single threaded program. | |
4869 | ||
4870 | When this directive is set to a value >= 1 then the protocol | |
4871 | used to communicate with the helper is modified to include | |
4872 | an ID in front of the request/response. The ID from the request | |
4873 | must be echoed back with the response to that request. | |
4874 | DOC_END | |
4875 | ||
4876 | NAME: store_id_access storeurl_rewrite_access | |
4877 | TYPE: acl_access | |
4878 | DEFAULT: none | |
638402dd | 4879 | DEFAULT_DOC: Allow, unless rules exist in squid.conf. |
a8a0b1c2 EC |
4880 | LOC: Config.accessList.store_id |
4881 | DOC_START | |
4882 | If defined, this access list specifies which requests are | |
4883 | sent to the StoreID processes. By default all requests | |
4884 | are sent. | |
4885 | ||
4886 | This clause supports both fast and slow acl types. | |
4887 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
4888 | DOC_END | |
4889 | ||
4890 | NAME: store_id_bypass storeurl_rewrite_bypass | |
4891 | TYPE: onoff | |
4892 | LOC: Config.onoff.store_id_bypass | |
4893 | DEFAULT: on | |
4894 | DOC_START | |
4895 | When this is 'on', a request will not go through the | |
4896 | helper if all helpers are busy. If this is 'off' | |
4897 | and the helper queue grows too large, Squid will exit | |
4898 | with a FATAL error and ask you to increase the number of | |
4899 | helpers. You should only enable this if the helperss | |
4900 | are not critical to your caching system. If you use | |
4901 | helpers for critical caching components, and you enable this | |
4902 | option, users may not get objects from cache. | |
4903 | DOC_END | |
4904 | ||
41bd17a4 | 4905 | COMMENT_START |
4906 | OPTIONS FOR TUNING THE CACHE | |
4907 | ----------------------------------------------------------------------------- | |
4908 | COMMENT_END | |
4909 | ||
f04b37d8 | 4910 | NAME: cache no_cache |
4911 | TYPE: acl_access | |
4912 | DEFAULT: none | |
70706149 | 4913 | DEFAULT_DOC: By default, this directive is unused and has no effect. |
f04b37d8 | 4914 | LOC: Config.accessList.noCache |
41bd17a4 | 4915 | DOC_START |
70706149 AR |
4916 | Requests denied by this directive will not be served from the cache |
4917 | and their responses will not be stored in the cache. This directive | |
4918 | has no effect on other transactions and on already cached responses. | |
f04b37d8 | 4919 | |
b3567eb5 FC |
4920 | This clause supports both fast and slow acl types. |
4921 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
70706149 AR |
4922 | |
4923 | This and the two other similar caching directives listed below are | |
4924 | checked at different transaction processing stages, have different | |
4925 | access to response information, affect different cache operations, | |
4926 | and differ in slow ACLs support: | |
4927 | ||
4928 | * cache: Checked before Squid makes a hit/miss determination. | |
4929 | No access to reply information! | |
4930 | Denies both serving a hit and storing a miss. | |
4931 | Supports both fast and slow ACLs. | |
4932 | * send_hit: Checked after a hit was detected. | |
4933 | Has access to reply (hit) information. | |
4934 | Denies serving a hit only. | |
4935 | Supports fast ACLs only. | |
4936 | * store_miss: Checked before storing a cachable miss. | |
4937 | Has access to reply (miss) information. | |
4938 | Denies storing a miss only. | |
4939 | Supports fast ACLs only. | |
4940 | ||
4941 | If you are not sure which of the three directives to use, apply the | |
4942 | following decision logic: | |
4943 | ||
4944 | * If your ACL(s) are of slow type _and_ need response info, redesign. | |
4945 | Squid does not support that particular combination at this time. | |
4946 | Otherwise: | |
4947 | * If your directive ACL(s) are of slow type, use "cache"; and/or | |
4948 | * if your directive ACL(s) need no response info, use "cache". | |
4949 | Otherwise: | |
4950 | * If you do not want the response cached, use store_miss; and/or | |
4951 | * if you do not want a hit on a cached response, use send_hit. | |
4952 | DOC_END | |
4953 | ||
4954 | NAME: send_hit | |
4955 | TYPE: acl_access | |
4956 | DEFAULT: none | |
4957 | DEFAULT_DOC: By default, this directive is unused and has no effect. | |
4958 | LOC: Config.accessList.sendHit | |
4959 | DOC_START | |
4960 | Responses denied by this directive will not be served from the cache | |
4961 | (but may still be cached, see store_miss). This directive has no | |
4962 | effect on the responses it allows and on the cached objects. | |
4963 | ||
4964 | Please see the "cache" directive for a summary of differences among | |
4965 | store_miss, send_hit, and cache directives. | |
4966 | ||
4967 | Unlike the "cache" directive, send_hit only supports fast acl | |
4968 | types. See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
4969 | ||
4970 | For example: | |
4971 | ||
4972 | # apply custom Store ID mapping to some URLs | |
4973 | acl MapMe dstdomain .c.example.com | |
4974 | store_id_program ... | |
4975 | store_id_access allow MapMe | |
4976 | ||
4977 | # but prevent caching of special responses | |
4978 | # such as 302 redirects that cause StoreID loops | |
4979 | acl Ordinary http_status 200-299 | |
4980 | store_miss deny MapMe !Ordinary | |
4981 | ||
4982 | # and do not serve any previously stored special responses | |
4983 | # from the cache (in case they were already cached before | |
4984 | # the above store_miss rule was in effect). | |
4985 | send_hit deny MapMe !Ordinary | |
4986 | DOC_END | |
4987 | ||
4988 | NAME: store_miss | |
4989 | TYPE: acl_access | |
4990 | DEFAULT: none | |
4991 | DEFAULT_DOC: By default, this directive is unused and has no effect. | |
4992 | LOC: Config.accessList.storeMiss | |
4993 | DOC_START | |
4994 | Responses denied by this directive will not be cached (but may still | |
4995 | be served from the cache, see send_hit). This directive has no | |
4996 | effect on the responses it allows and on the already cached responses. | |
4997 | ||
4998 | Please see the "cache" directive for a summary of differences among | |
4999 | store_miss, send_hit, and cache directives. See the | |
5000 | send_hit directive for a usage example. | |
5001 | ||
5002 | Unlike the "cache" directive, store_miss only supports fast acl | |
5003 | types. See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
41bd17a4 | 5004 | DOC_END |
5005 | ||
570d3f75 AJ |
5006 | NAME: max_stale |
5007 | COMMENT: time-units | |
5008 | TYPE: time_t | |
5009 | LOC: Config.maxStale | |
5010 | DEFAULT: 1 week | |
5011 | DOC_START | |
5012 | This option puts an upper limit on how stale content Squid | |
5013 | will serve from the cache if cache validation fails. | |
5014 | Can be overriden by the refresh_pattern max-stale option. | |
5015 | DOC_END | |
5016 | ||
41bd17a4 | 5017 | NAME: refresh_pattern |
5018 | TYPE: refreshpattern | |
5019 | LOC: Config.Refresh | |
5020 | DEFAULT: none | |
5021 | DOC_START | |
5022 | usage: refresh_pattern [-i] regex min percent max [options] | |
9e7dbc51 | 5023 | |
6b698a21 | 5024 | By default, regular expressions are CASE-SENSITIVE. To make |
5025 | them case-insensitive, use the -i option. | |
9e7dbc51 | 5026 | |
41bd17a4 | 5027 | 'Min' is the time (in minutes) an object without an explicit |
5028 | expiry time should be considered fresh. The recommended | |
5029 | value is 0, any higher values may cause dynamic applications | |
5030 | to be erroneously cached unless the application designer | |
5031 | has taken the appropriate actions. | |
9e7dbc51 | 5032 | |
41bd17a4 | 5033 | 'Percent' is a percentage of the objects age (time since last |
5034 | modification age) an object without explicit expiry time | |
5035 | will be considered fresh. | |
5b807763 | 5036 | |
41bd17a4 | 5037 | 'Max' is an upper limit on how long objects without an explicit |
5038 | expiry time will be considered fresh. | |
9e7dbc51 | 5039 | |
41bd17a4 | 5040 | options: override-expire |
5041 | override-lastmod | |
5042 | reload-into-ims | |
5043 | ignore-reload | |
41bd17a4 | 5044 | ignore-no-store |
4ca08219 | 5045 | ignore-must-revalidate |
41bd17a4 | 5046 | ignore-private |
5047 | ignore-auth | |
570d3f75 | 5048 | max-stale=NN |
41bd17a4 | 5049 | refresh-ims |
3d8b6ba4 | 5050 | store-stale |
a0ec9f68 | 5051 | |
41bd17a4 | 5052 | override-expire enforces min age even if the server |
9b2ad080 HN |
5053 | sent an explicit expiry time (e.g., with the |
5054 | Expires: header or Cache-Control: max-age). Doing this | |
5055 | VIOLATES the HTTP standard. Enabling this feature | |
5056 | could make you liable for problems which it causes. | |
6468fe10 | 5057 | |
04925576 AJ |
5058 | Note: override-expire does not enforce staleness - it only extends |
5059 | freshness / min. If the server returns a Expires time which | |
5060 | is longer than your max time, Squid will still consider | |
5061 | the object fresh for that period of time. | |
5062 | ||
41bd17a4 | 5063 | override-lastmod enforces min age even on objects |
5064 | that were modified recently. | |
934b03fc | 5065 | |
46017fdd CT |
5066 | reload-into-ims changes a client no-cache or ``reload'' |
5067 | request for a cached entry into a conditional request using | |
5068 | If-Modified-Since and/or If-None-Match headers, provided the | |
5069 | cached entry has a Last-Modified and/or a strong ETag header. | |
5070 | Doing this VIOLATES the HTTP standard. Enabling this feature | |
5071 | could make you liable for problems which it causes. | |
dba79ac5 | 5072 | |
41bd17a4 | 5073 | ignore-reload ignores a client no-cache or ``reload'' |
5074 | header. Doing this VIOLATES the HTTP standard. Enabling | |
5075 | this feature could make you liable for problems which | |
5076 | it causes. | |
9bc73deb | 5077 | |
41bd17a4 | 5078 | ignore-no-store ignores any ``Cache-control: no-store'' |
5079 | headers received from a server. Doing this VIOLATES | |
5080 | the HTTP standard. Enabling this feature could make you | |
5081 | liable for problems which it causes. | |
5082 | ||
4ca08219 AJ |
5083 | ignore-must-revalidate ignores any ``Cache-Control: must-revalidate`` |
5084 | headers received from a server. Doing this VIOLATES | |
5085 | the HTTP standard. Enabling this feature could make you | |
5086 | liable for problems which it causes. | |
5087 | ||
41bd17a4 | 5088 | ignore-private ignores any ``Cache-control: private'' |
5089 | headers received from a server. Doing this VIOLATES | |
5090 | the HTTP standard. Enabling this feature could make you | |
5091 | liable for problems which it causes. | |
5092 | ||
5093 | ignore-auth caches responses to requests with authorization, | |
5094 | as if the originserver had sent ``Cache-control: public'' | |
5095 | in the response header. Doing this VIOLATES the HTTP standard. | |
5096 | Enabling this feature could make you liable for problems which | |
5097 | it causes. | |
5098 | ||
5099 | refresh-ims causes squid to contact the origin server | |
5100 | when a client issues an If-Modified-Since request. This | |
5101 | ensures that the client will receive an updated version | |
5102 | if one is available. | |
5103 | ||
3d8b6ba4 AJ |
5104 | store-stale stores responses even if they don't have explicit |
5105 | freshness or a validator (i.e., Last-Modified or an ETag) | |
5106 | present, or if they're already stale. By default, Squid will | |
5107 | not cache such responses because they usually can't be | |
5108 | reused. Note that such responses will be stale by default. | |
5109 | ||
570d3f75 AJ |
5110 | max-stale=NN provide a maximum staleness factor. Squid won't |
5111 | serve objects more stale than this even if it failed to | |
5112 | validate the object. Default: use the max_stale global limit. | |
5113 | ||
41bd17a4 | 5114 | Basically a cached object is: |
5115 | ||
5116 | FRESH if expires < now, else STALE | |
5117 | STALE if age > max | |
5118 | FRESH if lm-factor < percent, else STALE | |
5119 | FRESH if age < min | |
5120 | else STALE | |
5121 | ||
5122 | The refresh_pattern lines are checked in the order listed here. | |
5123 | The first entry which matches is used. If none of the entries | |
5124 | match the default will be used. | |
5125 | ||
5126 | Note, you must uncomment all the default lines if you want | |
5127 | to change one. The default setting is only active if none is | |
5128 | used. | |
5129 | ||
41bd17a4 | 5130 | NOCOMMENT_START |
e0855596 | 5131 | |
638402dd | 5132 | # |
e0855596 | 5133 | # Add any of your own refresh_pattern entries above these. |
638402dd | 5134 | # |
41bd17a4 | 5135 | refresh_pattern ^ftp: 1440 20% 10080 |
5136 | refresh_pattern ^gopher: 1440 0% 1440 | |
89db45fa | 5137 | refresh_pattern -i (/cgi-bin/|\?) 0 0% 0 |
41bd17a4 | 5138 | refresh_pattern . 0 20% 4320 |
5139 | NOCOMMENT_END | |
5140 | DOC_END | |
5141 | ||
5142 | NAME: quick_abort_min | |
5143 | COMMENT: (KB) | |
5144 | TYPE: kb_int64_t | |
5145 | DEFAULT: 16 KB | |
5146 | LOC: Config.quickAbort.min | |
5147 | DOC_NONE | |
5148 | ||
5149 | NAME: quick_abort_max | |
5150 | COMMENT: (KB) | |
5151 | TYPE: kb_int64_t | |
5152 | DEFAULT: 16 KB | |
5153 | LOC: Config.quickAbort.max | |
5154 | DOC_NONE | |
5155 | ||
5156 | NAME: quick_abort_pct | |
5157 | COMMENT: (percent) | |
5158 | TYPE: int | |
5159 | DEFAULT: 95 | |
5160 | LOC: Config.quickAbort.pct | |
5161 | DOC_START | |
5162 | The cache by default continues downloading aborted requests | |
5163 | which are almost completed (less than 16 KB remaining). This | |
5164 | may be undesirable on slow (e.g. SLIP) links and/or very busy | |
5165 | caches. Impatient users may tie up file descriptors and | |
5166 | bandwidth by repeatedly requesting and immediately aborting | |
5167 | downloads. | |
5168 | ||
5169 | When the user aborts a request, Squid will check the | |
5170 | quick_abort values to the amount of data transfered until | |
5171 | then. | |
5172 | ||
5173 | If the transfer has less than 'quick_abort_min' KB remaining, | |
5174 | it will finish the retrieval. | |
5175 | ||
5176 | If the transfer has more than 'quick_abort_max' KB remaining, | |
5177 | it will abort the retrieval. | |
5178 | ||
5179 | If more than 'quick_abort_pct' of the transfer has completed, | |
5180 | it will finish the retrieval. | |
5181 | ||
5182 | If you do not want any retrieval to continue after the client | |
5183 | has aborted, set both 'quick_abort_min' and 'quick_abort_max' | |
5184 | to '0 KB'. | |
5185 | ||
5186 | If you want retrievals to always continue if they are being | |
5187 | cached set 'quick_abort_min' to '-1 KB'. | |
5188 | DOC_END | |
60d096f4 | 5189 | |
41bd17a4 | 5190 | NAME: read_ahead_gap |
5191 | COMMENT: buffer-size | |
5192 | TYPE: b_int64_t | |
5193 | LOC: Config.readAheadGap | |
5194 | DEFAULT: 16 KB | |
5195 | DOC_START | |
5196 | The amount of data the cache will buffer ahead of what has been | |
5197 | sent to the client when retrieving an object from another server. | |
5198 | DOC_END | |
53e738c6 | 5199 | |
41bd17a4 | 5200 | NAME: negative_ttl |
626096be | 5201 | IFDEF: USE_HTTP_VIOLATIONS |
41bd17a4 | 5202 | COMMENT: time-units |
5203 | TYPE: time_t | |
5204 | LOC: Config.negativeTtl | |
ac9cc053 | 5205 | DEFAULT: 0 seconds |
41bd17a4 | 5206 | DOC_START |
ac9cc053 AJ |
5207 | Set the Default Time-to-Live (TTL) for failed requests. |
5208 | Certain types of failures (such as "connection refused" and | |
5209 | "404 Not Found") are able to be negatively-cached for a short time. | |
5210 | Modern web servers should provide Expires: header, however if they | |
5211 | do not this can provide a minimum TTL. | |
5212 | The default is not to cache errors with unknown expiry details. | |
5213 | ||
5214 | Note that this is different from negative caching of DNS lookups. | |
39956c7c AJ |
5215 | |
5216 | WARNING: Doing this VIOLATES the HTTP standard. Enabling | |
5217 | this feature could make you liable for problems which it | |
5218 | causes. | |
41bd17a4 | 5219 | DOC_END |
53e738c6 | 5220 | |
41bd17a4 | 5221 | NAME: positive_dns_ttl |
5222 | COMMENT: time-units | |
5223 | TYPE: time_t | |
5224 | LOC: Config.positiveDnsTtl | |
5225 | DEFAULT: 6 hours | |
5226 | DOC_START | |
5227 | Upper limit on how long Squid will cache positive DNS responses. | |
5228 | Default is 6 hours (360 minutes). This directive must be set | |
5229 | larger than negative_dns_ttl. | |
5230 | DOC_END | |
c4ab8329 | 5231 | |
41bd17a4 | 5232 | NAME: negative_dns_ttl |
5233 | COMMENT: time-units | |
5234 | TYPE: time_t | |
5235 | LOC: Config.negativeDnsTtl | |
5236 | DEFAULT: 1 minutes | |
5237 | DOC_START | |
5238 | Time-to-Live (TTL) for negative caching of failed DNS lookups. | |
5239 | This also sets the lower cache limit on positive lookups. | |
5240 | Minimum value is 1 second, and it is not recommendable to go | |
5241 | much below 10 seconds. | |
5242 | DOC_END | |
7df0bfd7 | 5243 | |
41bd17a4 | 5244 | NAME: range_offset_limit |
11e3fa1c AJ |
5245 | COMMENT: size [acl acl...] |
5246 | TYPE: acl_b_size_t | |
41bd17a4 | 5247 | LOC: Config.rangeOffsetLimit |
11e3fa1c | 5248 | DEFAULT: none |
41bd17a4 | 5249 | DOC_START |
11e3fa1c AJ |
5250 | usage: (size) [units] [[!]aclname] |
5251 | ||
5252 | Sets an upper limit on how far (number of bytes) into the file | |
5253 | a Range request may be to cause Squid to prefetch the whole file. | |
5254 | If beyond this limit, Squid forwards the Range request as it is and | |
5255 | the result is NOT cached. | |
5256 | ||
41bd17a4 | 5257 | This is to stop a far ahead range request (lets say start at 17MB) |
5258 | from making Squid fetch the whole object up to that point before | |
5259 | sending anything to the client. | |
11e3fa1c AJ |
5260 | |
5261 | Multiple range_offset_limit lines may be specified, and they will | |
5262 | be searched from top to bottom on each request until a match is found. | |
5263 | The first match found will be used. If no line matches a request, the | |
5264 | default limit of 0 bytes will be used. | |
5265 | ||
5266 | 'size' is the limit specified as a number of units. | |
5267 | ||
5268 | 'units' specifies whether to use bytes, KB, MB, etc. | |
5269 | If no units are specified bytes are assumed. | |
5270 | ||
5271 | A size of 0 causes Squid to never fetch more than the | |
ab275c7b | 5272 | client requested. (default) |
11e3fa1c AJ |
5273 | |
5274 | A size of 'none' causes Squid to always fetch the object from the | |
41bd17a4 | 5275 | beginning so it may cache the result. (2.0 style) |
11e3fa1c AJ |
5276 | |
5277 | 'aclname' is the name of a defined ACL. | |
5278 | ||
5279 | NP: Using 'none' as the byte value here will override any quick_abort settings | |
5280 | that may otherwise apply to the range request. The range request will | |
ab275c7b AJ |
5281 | be fully fetched from start to finish regardless of the client |
5282 | actions. This affects bandwidth usage. | |
41bd17a4 | 5283 | DOC_END |
d95b862f | 5284 | |
41bd17a4 | 5285 | NAME: minimum_expiry_time |
5286 | COMMENT: (seconds) | |
5287 | TYPE: time_t | |
5288 | LOC: Config.minimum_expiry_time | |
5289 | DEFAULT: 60 seconds | |
5290 | DOC_START | |
5291 | The minimum caching time according to (Expires - Date) | |
638402dd AJ |
5292 | headers Squid honors if the object can't be revalidated. |
5293 | The default is 60 seconds. | |
5294 | ||
5295 | In reverse proxy environments it might be desirable to honor | |
5296 | shorter object lifetimes. It is most likely better to make | |
5297 | your server return a meaningful Last-Modified header however. | |
5298 | ||
5299 | In ESI environments where page fragments often have short | |
5300 | lifetimes, this will often be best set to 0. | |
41bd17a4 | 5301 | DOC_END |
c68e9c6b | 5302 | |
41bd17a4 | 5303 | NAME: store_avg_object_size |
58d5c5dd DK |
5304 | COMMENT: (bytes) |
5305 | TYPE: b_int64_t | |
41bd17a4 | 5306 | DEFAULT: 13 KB |
5307 | LOC: Config.Store.avgObjectSize | |
5308 | DOC_START | |
5309 | Average object size, used to estimate number of objects your | |
5310 | cache can hold. The default is 13 KB. | |
638402dd AJ |
5311 | |
5312 | This is used to pre-seed the cache index memory allocation to | |
5313 | reduce expensive reallocate operations while handling clients | |
5314 | traffic. Too-large values may result in memory allocation during | |
5315 | peak traffic, too-small values will result in wasted memory. | |
5316 | ||
5317 | Check the cache manager 'info' report metrics for the real | |
5318 | object sizes seen by your Squid before tuning this. | |
cccac0a2 | 5319 | DOC_END |
5320 | ||
41bd17a4 | 5321 | NAME: store_objects_per_bucket |
5322 | TYPE: int | |
5323 | DEFAULT: 20 | |
5324 | LOC: Config.Store.objectsPerBucket | |
5325 | DOC_START | |
5326 | Target number of objects per bucket in the store hash table. | |
5327 | Lowering this value increases the total number of buckets and | |
5328 | also the storage maintenance rate. The default is 20. | |
5329 | DOC_END | |
5330 | ||
5331 | COMMENT_START | |
5332 | HTTP OPTIONS | |
5333 | ----------------------------------------------------------------------------- | |
5334 | COMMENT_END | |
5335 | ||
f04b37d8 | 5336 | NAME: request_header_max_size |
5337 | COMMENT: (KB) | |
5338 | TYPE: b_size_t | |
df2eec10 | 5339 | DEFAULT: 64 KB |
f04b37d8 | 5340 | LOC: Config.maxRequestHeaderSize |
5341 | DOC_START | |
5342 | This specifies the maximum size for HTTP headers in a request. | |
5343 | Request headers are usually relatively small (about 512 bytes). | |
5344 | Placing a limit on the request header size will catch certain | |
5345 | bugs (for example with persistent connections) and possibly | |
5346 | buffer-overflow or denial-of-service attacks. | |
5347 | DOC_END | |
5348 | ||
5349 | NAME: reply_header_max_size | |
5350 | COMMENT: (KB) | |
5351 | TYPE: b_size_t | |
df2eec10 | 5352 | DEFAULT: 64 KB |
f04b37d8 | 5353 | LOC: Config.maxReplyHeaderSize |
5354 | DOC_START | |
5355 | This specifies the maximum size for HTTP headers in a reply. | |
5356 | Reply headers are usually relatively small (about 512 bytes). | |
5357 | Placing a limit on the reply header size will catch certain | |
5358 | bugs (for example with persistent connections) and possibly | |
5359 | buffer-overflow or denial-of-service attacks. | |
5360 | DOC_END | |
5361 | ||
5362 | NAME: request_body_max_size | |
5363 | COMMENT: (bytes) | |
5364 | TYPE: b_int64_t | |
5365 | DEFAULT: 0 KB | |
638402dd | 5366 | DEFAULT_DOC: No limit. |
f04b37d8 | 5367 | LOC: Config.maxRequestBodySize |
5368 | DOC_START | |
5369 | This specifies the maximum size for an HTTP request body. | |
5370 | In other words, the maximum size of a PUT/POST request. | |
5371 | A user who attempts to send a request with a body larger | |
5372 | than this limit receives an "Invalid Request" error message. | |
5373 | If you set this parameter to a zero (the default), there will | |
5374 | be no limit imposed. | |
638402dd AJ |
5375 | |
5376 | See also client_request_buffer_max_size for an alternative | |
5377 | limitation on client uploads which can be configured. | |
f04b37d8 | 5378 | DOC_END |
5379 | ||
1368d115 CT |
5380 | NAME: client_request_buffer_max_size |
5381 | COMMENT: (bytes) | |
5382 | TYPE: b_size_t | |
5383 | DEFAULT: 512 KB | |
5384 | LOC: Config.maxRequestBufferSize | |
5385 | DOC_START | |
5386 | This specifies the maximum buffer size of a client request. | |
5387 | It prevents squid eating too much memory when somebody uploads | |
5388 | a large file. | |
5389 | DOC_END | |
5390 | ||
3ff65596 AR |
5391 | NAME: chunked_request_body_max_size |
5392 | COMMENT: (bytes) | |
5393 | TYPE: b_int64_t | |
5394 | DEFAULT: 64 KB | |
5395 | LOC: Config.maxChunkedRequestBodySize | |
5396 | DOC_START | |
5397 | A broken or confused HTTP/1.1 client may send a chunked HTTP | |
5398 | request to Squid. Squid does not have full support for that | |
5399 | feature yet. To cope with such requests, Squid buffers the | |
5400 | entire request and then dechunks request body to create a | |
5401 | plain HTTP/1.0 request with a known content length. The plain | |
5402 | request is then used by the rest of Squid code as usual. | |
5403 | ||
5404 | The option value specifies the maximum size of the buffer used | |
5405 | to hold the request before the conversion. If the chunked | |
5406 | request size exceeds the specified limit, the conversion | |
5407 | fails, and the client receives an "unsupported request" error, | |
5408 | as if dechunking was disabled. | |
5409 | ||
5410 | Dechunking is enabled by default. To disable conversion of | |
5411 | chunked requests, set the maximum to zero. | |
5412 | ||
5413 | Request dechunking feature and this option in particular are a | |
5414 | temporary hack. When chunking requests and responses are fully | |
5415 | supported, there will be no need to buffer a chunked request. | |
5416 | DOC_END | |
5417 | ||
41bd17a4 | 5418 | NAME: broken_posts |
626096be | 5419 | IFDEF: USE_HTTP_VIOLATIONS |
cccac0a2 | 5420 | TYPE: acl_access |
cccac0a2 | 5421 | DEFAULT: none |
638402dd | 5422 | DEFAULT_DOC: Obey RFC 2616. |
41bd17a4 | 5423 | LOC: Config.accessList.brokenPosts |
cccac0a2 | 5424 | DOC_START |
41bd17a4 | 5425 | A list of ACL elements which, if matched, causes Squid to send |
5426 | an extra CRLF pair after the body of a PUT/POST request. | |
cccac0a2 | 5427 | |
41bd17a4 | 5428 | Some HTTP servers has broken implementations of PUT/POST, |
5429 | and rely on an extra CRLF pair sent by some WWW clients. | |
cccac0a2 | 5430 | |
41bd17a4 | 5431 | Quote from RFC2616 section 4.1 on this matter: |
cccac0a2 | 5432 | |
41bd17a4 | 5433 | Note: certain buggy HTTP/1.0 client implementations generate an |
5434 | extra CRLF's after a POST request. To restate what is explicitly | |
5435 | forbidden by the BNF, an HTTP/1.1 client must not preface or follow | |
5436 | a request with an extra CRLF. | |
cccac0a2 | 5437 | |
b3567eb5 FC |
5438 | This clause only supports fast acl types. |
5439 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
5440 | ||
41bd17a4 | 5441 | Example: |
5442 | acl buggy_server url_regex ^http://.... | |
5443 | broken_posts allow buggy_server | |
5444 | DOC_END | |
cccac0a2 | 5445 | |
22fff3bf | 5446 | NAME: adaptation_uses_indirect_client icap_uses_indirect_client |
57d76dd4 AJ |
5447 | COMMENT: on|off |
5448 | TYPE: onoff | |
22fff3bf | 5449 | IFDEF: FOLLOW_X_FORWARDED_FOR&&USE_ADAPTATION |
57d76dd4 | 5450 | DEFAULT: on |
22fff3bf | 5451 | LOC: Adaptation::Config::use_indirect_client |
57d76dd4 | 5452 | DOC_START |
ea3ae478 AR |
5453 | Controls whether the indirect client IP address (instead of the direct |
5454 | client IP address) is passed to adaptation services. | |
5455 | ||
5456 | See also: follow_x_forwarded_for adaptation_send_client_ip | |
57d76dd4 AJ |
5457 | DOC_END |
5458 | ||
41bd17a4 | 5459 | NAME: via |
626096be | 5460 | IFDEF: USE_HTTP_VIOLATIONS |
41bd17a4 | 5461 | COMMENT: on|off |
5462 | TYPE: onoff | |
5463 | DEFAULT: on | |
5464 | LOC: Config.onoff.via | |
5465 | DOC_START | |
5466 | If set (default), Squid will include a Via header in requests and | |
5467 | replies as required by RFC2616. | |
5468 | DOC_END | |
4cc6eb12 | 5469 | |
41bd17a4 | 5470 | NAME: ie_refresh |
5471 | COMMENT: on|off | |
5472 | TYPE: onoff | |
5473 | LOC: Config.onoff.ie_refresh | |
5474 | DEFAULT: off | |
5475 | DOC_START | |
5476 | Microsoft Internet Explorer up until version 5.5 Service | |
5477 | Pack 1 has an issue with transparent proxies, wherein it | |
5478 | is impossible to force a refresh. Turning this on provides | |
5479 | a partial fix to the problem, by causing all IMS-REFRESH | |
5480 | requests from older IE versions to check the origin server | |
5481 | for fresh content. This reduces hit ratio by some amount | |
5482 | (~10% in my experience), but allows users to actually get | |
5483 | fresh content when they want it. Note because Squid | |
5484 | cannot tell if the user is using 5.5 or 5.5SP1, the behavior | |
5485 | of 5.5 is unchanged from old versions of Squid (i.e. a | |
5486 | forced refresh is impossible). Newer versions of IE will, | |
5487 | hopefully, continue to have the new behavior and will be | |
5488 | handled based on that assumption. This option defaults to | |
5489 | the old Squid behavior, which is better for hit ratios but | |
5490 | worse for clients using IE, if they need to be able to | |
5491 | force fresh content. | |
5492 | DOC_END | |
b9d7fe3e | 5493 | |
41bd17a4 | 5494 | NAME: vary_ignore_expire |
5495 | COMMENT: on|off | |
5496 | TYPE: onoff | |
5497 | LOC: Config.onoff.vary_ignore_expire | |
5498 | DEFAULT: off | |
5499 | DOC_START | |
5500 | Many HTTP servers supporting Vary gives such objects | |
5501 | immediate expiry time with no cache-control header | |
5502 | when requested by a HTTP/1.0 client. This option | |
5503 | enables Squid to ignore such expiry times until | |
5504 | HTTP/1.1 is fully implemented. | |
7e73cd78 AJ |
5505 | |
5506 | WARNING: If turned on this may eventually cause some | |
5507 | varying objects not intended for caching to get cached. | |
cccac0a2 | 5508 | DOC_END |
c4ab8329 | 5509 | |
41bd17a4 | 5510 | NAME: request_entities |
5511 | TYPE: onoff | |
5512 | LOC: Config.onoff.request_entities | |
5513 | DEFAULT: off | |
5514 | DOC_START | |
5515 | Squid defaults to deny GET and HEAD requests with request entities, | |
5516 | as the meaning of such requests are undefined in the HTTP standard | |
5517 | even if not explicitly forbidden. | |
0976f8db | 5518 | |
41bd17a4 | 5519 | Set this directive to on if you have clients which insists |
5520 | on sending request entities in GET or HEAD requests. But be warned | |
5521 | that there is server software (both proxies and web servers) which | |
5522 | can fail to properly process this kind of request which may make you | |
5523 | vulnerable to cache pollution attacks if enabled. | |
cccac0a2 | 5524 | DOC_END |
6b53c392 | 5525 | |
41bd17a4 | 5526 | NAME: request_header_access |
626096be | 5527 | IFDEF: USE_HTTP_VIOLATIONS |
3b07476b | 5528 | TYPE: http_header_access |
41bd17a4 | 5529 | LOC: Config.request_header_access |
cccac0a2 | 5530 | DEFAULT: none |
638402dd | 5531 | DEFAULT_DOC: No limits. |
cccac0a2 | 5532 | DOC_START |
41bd17a4 | 5533 | Usage: request_header_access header_name allow|deny [!]aclname ... |
0976f8db | 5534 | |
41bd17a4 | 5535 | WARNING: Doing this VIOLATES the HTTP standard. Enabling |
5536 | this feature could make you liable for problems which it | |
5537 | causes. | |
0976f8db | 5538 | |
41bd17a4 | 5539 | This option replaces the old 'anonymize_headers' and the |
5540 | older 'http_anonymizer' option with something that is much | |
3b07476b CT |
5541 | more configurable. A list of ACLs for each header name allows |
5542 | removal of specific header fields under specific conditions. | |
5543 | ||
5544 | This option only applies to outgoing HTTP request headers (i.e., | |
5545 | headers sent by Squid to the next HTTP hop such as a cache peer | |
5546 | or an origin server). The option has no effect during cache hit | |
5547 | detection. The equivalent adaptation vectoring point in ICAP | |
5548 | terminology is post-cache REQMOD. | |
5549 | ||
5550 | The option is applied to individual outgoing request header | |
5551 | fields. For each request header field F, Squid uses the first | |
5552 | qualifying sets of request_header_access rules: | |
5553 | ||
5554 | 1. Rules with header_name equal to F's name. | |
5555 | 2. Rules with header_name 'Other', provided F's name is not | |
5556 | on the hard-coded list of commonly used HTTP header names. | |
5557 | 3. Rules with header_name 'All'. | |
5558 | ||
5559 | Within that qualifying rule set, rule ACLs are checked as usual. | |
5560 | If ACLs of an "allow" rule match, the header field is allowed to | |
5561 | go through as is. If ACLs of a "deny" rule match, the header is | |
5562 | removed and request_header_replace is then checked to identify | |
5563 | if the removed header has a replacement. If no rules within the | |
5564 | set have matching ACLs, the header field is left as is. | |
5401aa8d | 5565 | |
41bd17a4 | 5566 | For example, to achieve the same behavior as the old |
5567 | 'http_anonymizer standard' option, you should use: | |
5401aa8d | 5568 | |
41bd17a4 | 5569 | request_header_access From deny all |
5570 | request_header_access Referer deny all | |
41bd17a4 | 5571 | request_header_access User-Agent deny all |
5401aa8d | 5572 | |
41bd17a4 | 5573 | Or, to reproduce the old 'http_anonymizer paranoid' feature |
5574 | you should use: | |
5401aa8d | 5575 | |
41bd17a4 | 5576 | request_header_access Authorization allow all |
41bd17a4 | 5577 | request_header_access Proxy-Authorization allow all |
41bd17a4 | 5578 | request_header_access Cache-Control allow all |
41bd17a4 | 5579 | request_header_access Content-Length allow all |
5580 | request_header_access Content-Type allow all | |
5581 | request_header_access Date allow all | |
41bd17a4 | 5582 | request_header_access Host allow all |
5583 | request_header_access If-Modified-Since allow all | |
41bd17a4 | 5584 | request_header_access Pragma allow all |
5585 | request_header_access Accept allow all | |
5586 | request_header_access Accept-Charset allow all | |
5587 | request_header_access Accept-Encoding allow all | |
5588 | request_header_access Accept-Language allow all | |
41bd17a4 | 5589 | request_header_access Connection allow all |
41bd17a4 | 5590 | request_header_access All deny all |
5401aa8d | 5591 | |
638402dd | 5592 | HTTP reply headers are controlled with the reply_header_access directive. |
5401aa8d | 5593 | |
638402dd | 5594 | By default, all headers are allowed (no anonymizing is performed). |
5401aa8d | 5595 | DOC_END |
5596 | ||
41bd17a4 | 5597 | NAME: reply_header_access |
626096be | 5598 | IFDEF: USE_HTTP_VIOLATIONS |
3b07476b | 5599 | TYPE: http_header_access |
41bd17a4 | 5600 | LOC: Config.reply_header_access |
cccac0a2 | 5601 | DEFAULT: none |
638402dd | 5602 | DEFAULT_DOC: No limits. |
cccac0a2 | 5603 | DOC_START |
41bd17a4 | 5604 | Usage: reply_header_access header_name allow|deny [!]aclname ... |
934b03fc | 5605 | |
41bd17a4 | 5606 | WARNING: Doing this VIOLATES the HTTP standard. Enabling |
5607 | this feature could make you liable for problems which it | |
5608 | causes. | |
934b03fc | 5609 | |
41bd17a4 | 5610 | This option only applies to reply headers, i.e., from the |
5611 | server to the client. | |
934b03fc | 5612 | |
41bd17a4 | 5613 | This is the same as request_header_access, but in the other |
3b07476b CT |
5614 | direction. Please see request_header_access for detailed |
5615 | documentation. | |
cccac0a2 | 5616 | |
41bd17a4 | 5617 | For example, to achieve the same behavior as the old |
5618 | 'http_anonymizer standard' option, you should use: | |
cccac0a2 | 5619 | |
41bd17a4 | 5620 | reply_header_access Server deny all |
41bd17a4 | 5621 | reply_header_access WWW-Authenticate deny all |
5622 | reply_header_access Link deny all | |
cccac0a2 | 5623 | |
41bd17a4 | 5624 | Or, to reproduce the old 'http_anonymizer paranoid' feature |
5625 | you should use: | |
cccac0a2 | 5626 | |
41bd17a4 | 5627 | reply_header_access Allow allow all |
41bd17a4 | 5628 | reply_header_access WWW-Authenticate allow all |
41bd17a4 | 5629 | reply_header_access Proxy-Authenticate allow all |
5630 | reply_header_access Cache-Control allow all | |
5631 | reply_header_access Content-Encoding allow all | |
5632 | reply_header_access Content-Length allow all | |
5633 | reply_header_access Content-Type allow all | |
5634 | reply_header_access Date allow all | |
5635 | reply_header_access Expires allow all | |
41bd17a4 | 5636 | reply_header_access Last-Modified allow all |
5637 | reply_header_access Location allow all | |
5638 | reply_header_access Pragma allow all | |
41bd17a4 | 5639 | reply_header_access Content-Language allow all |
41bd17a4 | 5640 | reply_header_access Retry-After allow all |
5641 | reply_header_access Title allow all | |
638402dd | 5642 | reply_header_access Content-Disposition allow all |
41bd17a4 | 5643 | reply_header_access Connection allow all |
41bd17a4 | 5644 | reply_header_access All deny all |
cccac0a2 | 5645 | |
638402dd | 5646 | HTTP request headers are controlled with the request_header_access directive. |
cccac0a2 | 5647 | |
41bd17a4 | 5648 | By default, all headers are allowed (no anonymizing is |
5649 | performed). | |
cccac0a2 | 5650 | DOC_END |
5651 | ||
75e4f2ea | 5652 | NAME: request_header_replace header_replace |
626096be | 5653 | IFDEF: USE_HTTP_VIOLATIONS |
3b07476b | 5654 | TYPE: http_header_replace |
41bd17a4 | 5655 | LOC: Config.request_header_access |
cccac0a2 | 5656 | DEFAULT: none |
41bd17a4 | 5657 | DOC_START |
75e4f2ea MB |
5658 | Usage: request_header_replace header_name message |
5659 | Example: request_header_replace User-Agent Nutscrape/1.0 (CP/M; 8-bit) | |
cccac0a2 | 5660 | |
41bd17a4 | 5661 | This option allows you to change the contents of headers |
75e4f2ea | 5662 | denied with request_header_access above, by replacing them |
638402dd | 5663 | with some fixed string. |
cccac0a2 | 5664 | |
41bd17a4 | 5665 | This only applies to request headers, not reply headers. |
cccac0a2 | 5666 | |
41bd17a4 | 5667 | By default, headers are removed if denied. |
5668 | DOC_END | |
cccac0a2 | 5669 | |
75e4f2ea MB |
5670 | NAME: reply_header_replace |
5671 | IFDEF: USE_HTTP_VIOLATIONS | |
3b07476b | 5672 | TYPE: http_header_replace |
75e4f2ea MB |
5673 | LOC: Config.reply_header_access |
5674 | DEFAULT: none | |
5675 | DOC_START | |
5676 | Usage: reply_header_replace header_name message | |
5677 | Example: reply_header_replace Server Foo/1.0 | |
5678 | ||
5679 | This option allows you to change the contents of headers | |
5680 | denied with reply_header_access above, by replacing them | |
5681 | with some fixed string. | |
5682 | ||
5683 | This only applies to reply headers, not request headers. | |
5684 | ||
5685 | By default, headers are removed if denied. | |
5686 | DOC_END | |
5687 | ||
f4698e0b CT |
5688 | NAME: request_header_add |
5689 | TYPE: HeaderWithAclList | |
5690 | LOC: Config.request_header_add | |
5691 | DEFAULT: none | |
5692 | DOC_START | |
5693 | Usage: request_header_add field-name field-value acl1 [acl2] ... | |
5694 | Example: request_header_add X-Client-CA "CA=%ssl::>cert_issuer" all | |
5695 | ||
5696 | This option adds header fields to outgoing HTTP requests (i.e., | |
5697 | request headers sent by Squid to the next HTTP hop such as a | |
5698 | cache peer or an origin server). The option has no effect during | |
5699 | cache hit detection. The equivalent adaptation vectoring point | |
5700 | in ICAP terminology is post-cache REQMOD. | |
5701 | ||
5702 | Field-name is a token specifying an HTTP header name. If a | |
5703 | standard HTTP header name is used, Squid does not check whether | |
5704 | the new header conflicts with any existing headers or violates | |
5705 | HTTP rules. If the request to be modified already contains a | |
5706 | field with the same name, the old field is preserved but the | |
5707 | header field values are not merged. | |
5708 | ||
5709 | Field-value is either a token or a quoted string. If quoted | |
5710 | string format is used, then the surrounding quotes are removed | |
5711 | while escape sequences and %macros are processed. | |
5712 | ||
5713 | In theory, all of the logformat codes can be used as %macros. | |
5714 | However, unlike logging (which happens at the very end of | |
5715 | transaction lifetime), the transaction may not yet have enough | |
5716 | information to expand a macro when the new header value is needed. | |
5717 | And some information may already be available to Squid but not yet | |
5718 | committed where the macro expansion code can access it (report | |
5719 | such instances!). The macro will be expanded into a single dash | |
5720 | ('-') in such cases. Not all macros have been tested. | |
5721 | ||
5722 | One or more Squid ACLs may be specified to restrict header | |
5723 | injection to matching requests. As always in squid.conf, all | |
5724 | ACLs in an option ACL list must be satisfied for the insertion | |
5725 | to happen. The request_header_add option supports fast ACLs | |
5726 | only. | |
5727 | DOC_END | |
5728 | ||
d7f4a0b7 CT |
5729 | NAME: note |
5730 | TYPE: note | |
5731 | LOC: Config.notes | |
5732 | DEFAULT: none | |
5733 | DOC_START | |
5734 | This option used to log custom information about the master | |
5735 | transaction. For example, an admin may configure Squid to log | |
5736 | which "user group" the transaction belongs to, where "user group" | |
5737 | will be determined based on a set of ACLs and not [just] | |
5738 | authentication information. | |
5739 | Values of key/value pairs can be logged using %{key}note macros: | |
5740 | ||
5741 | note key value acl ... | |
5742 | logformat myFormat ... %{key}note ... | |
5743 | DOC_END | |
5744 | ||
41bd17a4 | 5745 | NAME: relaxed_header_parser |
5746 | COMMENT: on|off|warn | |
5747 | TYPE: tristate | |
5748 | LOC: Config.onoff.relaxed_header_parser | |
5749 | DEFAULT: on | |
5750 | DOC_START | |
5751 | In the default "on" setting Squid accepts certain forms | |
5752 | of non-compliant HTTP messages where it is unambiguous | |
5753 | what the sending application intended even if the message | |
5754 | is not correctly formatted. The messages is then normalized | |
5755 | to the correct form when forwarded by Squid. | |
cccac0a2 | 5756 | |
41bd17a4 | 5757 | If set to "warn" then a warning will be emitted in cache.log |
5758 | each time such HTTP error is encountered. | |
cccac0a2 | 5759 | |
41bd17a4 | 5760 | If set to "off" then such HTTP errors will cause the request |
5761 | or response to be rejected. | |
5762 | DOC_END | |
7d90757b | 5763 | |
55eae904 AR |
5764 | NAME: collapsed_forwarding |
5765 | COMMENT: (on|off) | |
5766 | TYPE: onoff | |
5767 | LOC: Config.onoff.collapsed_forwarding | |
5768 | DEFAULT: off | |
5769 | DOC_START | |
5770 | This option controls whether Squid is allowed to merge multiple | |
5771 | potentially cachable requests for the same URI before Squid knows | |
5772 | whether the response is going to be cachable. | |
5773 | ||
5774 | This feature is disabled by default: Enabling collapsed forwarding | |
5775 | needlessly delays forwarding requests that look cachable (when they are | |
5776 | collapsed) but then need to be forwarded individually anyway because | |
5777 | they end up being for uncachable content. However, in some cases, such | |
5778 | as accelleration of highly cachable content with periodic or groupped | |
5779 | expiration times, the gains from collapsing [large volumes of | |
5780 | simultenous refresh requests] outweigh losses from such delays. | |
5781 | DOC_END | |
5782 | ||
41bd17a4 | 5783 | COMMENT_START |
5784 | TIMEOUTS | |
5785 | ----------------------------------------------------------------------------- | |
5786 | COMMENT_END | |
5787 | ||
5788 | NAME: forward_timeout | |
5789 | COMMENT: time-units | |
5790 | TYPE: time_t | |
5791 | LOC: Config.Timeout.forward | |
5792 | DEFAULT: 4 minutes | |
5793 | DOC_START | |
5794 | This parameter specifies how long Squid should at most attempt in | |
5795 | finding a forwarding path for the request before giving up. | |
cccac0a2 | 5796 | DOC_END |
5797 | ||
41bd17a4 | 5798 | NAME: connect_timeout |
5799 | COMMENT: time-units | |
5800 | TYPE: time_t | |
5801 | LOC: Config.Timeout.connect | |
5802 | DEFAULT: 1 minute | |
057f5854 | 5803 | DOC_START |
41bd17a4 | 5804 | This parameter specifies how long to wait for the TCP connect to |
5805 | the requested server or peer to complete before Squid should | |
5806 | attempt to find another path where to forward the request. | |
057f5854 | 5807 | DOC_END |
5808 | ||
41bd17a4 | 5809 | NAME: peer_connect_timeout |
5810 | COMMENT: time-units | |
5811 | TYPE: time_t | |
5812 | LOC: Config.Timeout.peer_connect | |
5813 | DEFAULT: 30 seconds | |
cccac0a2 | 5814 | DOC_START |
41bd17a4 | 5815 | This parameter specifies how long to wait for a pending TCP |
5816 | connection to a peer cache. The default is 30 seconds. You | |
5817 | may also set different timeout values for individual neighbors | |
5818 | with the 'connect-timeout' option on a 'cache_peer' line. | |
5819 | DOC_END | |
7f7db318 | 5820 | |
41bd17a4 | 5821 | NAME: read_timeout |
5822 | COMMENT: time-units | |
5823 | TYPE: time_t | |
5824 | LOC: Config.Timeout.read | |
5825 | DEFAULT: 15 minutes | |
5826 | DOC_START | |
5827 | The read_timeout is applied on server-side connections. After | |
5828 | each successful read(), the timeout will be extended by this | |
5829 | amount. If no data is read again after this amount of time, | |
5830 | the request is aborted and logged with ERR_READ_TIMEOUT. The | |
5831 | default is 15 minutes. | |
5832 | DOC_END | |
cccac0a2 | 5833 | |
5ef5e5cc AJ |
5834 | NAME: write_timeout |
5835 | COMMENT: time-units | |
5836 | TYPE: time_t | |
5837 | LOC: Config.Timeout.write | |
5838 | DEFAULT: 15 minutes | |
5839 | DOC_START | |
5840 | This timeout is tracked for all connections that have data | |
5841 | available for writing and are waiting for the socket to become | |
5842 | ready. After each successful write, the timeout is extended by | |
5843 | the configured amount. If Squid has data to write but the | |
5844 | connection is not ready for the configured duration, the | |
5845 | transaction associated with the connection is terminated. The | |
5846 | default is 15 minutes. | |
5847 | DOC_END | |
5848 | ||
41bd17a4 | 5849 | NAME: request_timeout |
5850 | TYPE: time_t | |
5851 | LOC: Config.Timeout.request | |
5852 | DEFAULT: 5 minutes | |
5853 | DOC_START | |
6b2a2108 | 5854 | How long to wait for complete HTTP request headers after initial |
41bd17a4 | 5855 | connection establishment. |
5856 | DOC_END | |
cccac0a2 | 5857 | |
97b32442 | 5858 | NAME: client_idle_pconn_timeout persistent_request_timeout |
41bd17a4 | 5859 | TYPE: time_t |
97b32442 | 5860 | LOC: Config.Timeout.clientIdlePconn |
41bd17a4 | 5861 | DEFAULT: 2 minutes |
5862 | DOC_START | |
5863 | How long to wait for the next HTTP request on a persistent | |
97b32442 | 5864 | client connection after the previous request completes. |
41bd17a4 | 5865 | DOC_END |
cccac0a2 | 5866 | |
41bd17a4 | 5867 | NAME: client_lifetime |
5868 | COMMENT: time-units | |
5869 | TYPE: time_t | |
5870 | LOC: Config.Timeout.lifetime | |
5871 | DEFAULT: 1 day | |
5872 | DOC_START | |
5873 | The maximum amount of time a client (browser) is allowed to | |
5874 | remain connected to the cache process. This protects the Cache | |
5875 | from having a lot of sockets (and hence file descriptors) tied up | |
5876 | in a CLOSE_WAIT state from remote clients that go away without | |
5877 | properly shutting down (either because of a network failure or | |
5878 | because of a poor client implementation). The default is one | |
5879 | day, 1440 minutes. | |
7d90757b | 5880 | |
41bd17a4 | 5881 | NOTE: The default value is intended to be much larger than any |
5882 | client would ever need to be connected to your cache. You | |
5883 | should probably change client_lifetime only as a last resort. | |
5884 | If you seem to have many client connections tying up | |
5885 | filedescriptors, we recommend first tuning the read_timeout, | |
5886 | request_timeout, persistent_request_timeout and quick_abort values. | |
cccac0a2 | 5887 | DOC_END |
5888 | ||
41bd17a4 | 5889 | NAME: half_closed_clients |
5890 | TYPE: onoff | |
5891 | LOC: Config.onoff.half_closed_clients | |
0c2f5c4f | 5892 | DEFAULT: off |
4eb368f9 | 5893 | DOC_START |
41bd17a4 | 5894 | Some clients may shutdown the sending side of their TCP |
5895 | connections, while leaving their receiving sides open. Sometimes, | |
5896 | Squid can not tell the difference between a half-closed and a | |
0c2f5c4f AJ |
5897 | fully-closed TCP connection. |
5898 | ||
5899 | By default, Squid will immediately close client connections when | |
5900 | read(2) returns "no more data to read." | |
5901 | ||
abdf1651 | 5902 | Change this option to 'on' and Squid will keep open connections |
0c2f5c4f AJ |
5903 | until a read(2) or write(2) on the socket returns an error. |
5904 | This may show some benefits for reverse proxies. But if not | |
5905 | it is recommended to leave OFF. | |
4eb368f9 | 5906 | DOC_END |
5907 | ||
97b32442 | 5908 | NAME: server_idle_pconn_timeout pconn_timeout |
41bd17a4 | 5909 | TYPE: time_t |
97b32442 | 5910 | LOC: Config.Timeout.serverIdlePconn |
41bd17a4 | 5911 | DEFAULT: 1 minute |
cccac0a2 | 5912 | DOC_START |
41bd17a4 | 5913 | Timeout for idle persistent connections to servers and other |
5914 | proxies. | |
5915 | DOC_END | |
cccac0a2 | 5916 | |
41bd17a4 | 5917 | NAME: ident_timeout |
5918 | TYPE: time_t | |
5919 | IFDEF: USE_IDENT | |
4daaf3cb | 5920 | LOC: Ident::TheConfig.timeout |
41bd17a4 | 5921 | DEFAULT: 10 seconds |
5922 | DOC_START | |
5923 | Maximum time to wait for IDENT lookups to complete. | |
cccac0a2 | 5924 | |
41bd17a4 | 5925 | If this is too high, and you enabled IDENT lookups from untrusted |
5926 | users, you might be susceptible to denial-of-service by having | |
5927 | many ident requests going at once. | |
cccac0a2 | 5928 | DOC_END |
5929 | ||
41bd17a4 | 5930 | NAME: shutdown_lifetime |
5931 | COMMENT: time-units | |
5932 | TYPE: time_t | |
5933 | LOC: Config.shutdownLifetime | |
5934 | DEFAULT: 30 seconds | |
cccac0a2 | 5935 | DOC_START |
41bd17a4 | 5936 | When SIGTERM or SIGHUP is received, the cache is put into |
5937 | "shutdown pending" mode until all active sockets are closed. | |
5938 | This value is the lifetime to set for all open descriptors | |
5939 | during shutdown mode. Any active clients after this many | |
5940 | seconds will receive a 'timeout' message. | |
cccac0a2 | 5941 | DOC_END |
0976f8db | 5942 | |
cccac0a2 | 5943 | COMMENT_START |
5944 | ADMINISTRATIVE PARAMETERS | |
5945 | ----------------------------------------------------------------------------- | |
5946 | COMMENT_END | |
5947 | ||
5948 | NAME: cache_mgr | |
5949 | TYPE: string | |
5950 | DEFAULT: webmaster | |
5951 | LOC: Config.adminEmail | |
5952 | DOC_START | |
5953 | Email-address of local cache manager who will receive | |
638402dd | 5954 | mail if the cache dies. The default is "webmaster". |
cccac0a2 | 5955 | DOC_END |
5956 | ||
abacf776 | 5957 | NAME: mail_from |
5958 | TYPE: string | |
5959 | DEFAULT: none | |
5960 | LOC: Config.EmailFrom | |
5961 | DOC_START | |
5962 | From: email-address for mail sent when the cache dies. | |
638402dd AJ |
5963 | The default is to use 'squid@unique_hostname'. |
5964 | ||
5965 | See also: unique_hostname directive. | |
abacf776 | 5966 | DOC_END |
5967 | ||
d084bf20 | 5968 | NAME: mail_program |
5969 | TYPE: eol | |
5970 | DEFAULT: mail | |
5971 | LOC: Config.EmailProgram | |
5972 | DOC_START | |
5973 | Email program used to send mail if the cache dies. | |
846a5e31 | 5974 | The default is "mail". The specified program must comply |
d084bf20 | 5975 | with the standard Unix mail syntax: |
846a5e31 | 5976 | mail-program recipient < mailfile |
5977 | ||
d084bf20 | 5978 | Optional command line options can be specified. |
5979 | DOC_END | |
5980 | ||
cccac0a2 | 5981 | NAME: cache_effective_user |
5982 | TYPE: string | |
5483d916 | 5983 | DEFAULT: @DEFAULT_CACHE_EFFECTIVE_USER@ |
cccac0a2 | 5984 | LOC: Config.effectiveUser |
e3d74828 | 5985 | DOC_START |
5986 | If you start Squid as root, it will change its effective/real | |
5987 | UID/GID to the user specified below. The default is to change | |
5483d916 | 5988 | to UID of @DEFAULT_CACHE_EFFECTIVE_USER@. |
64e288bd | 5989 | see also; cache_effective_group |
e3d74828 | 5990 | DOC_END |
5991 | ||
cccac0a2 | 5992 | NAME: cache_effective_group |
5993 | TYPE: string | |
5994 | DEFAULT: none | |
638402dd | 5995 | DEFAULT_DOC: Use system group memberships of the cache_effective_user account |
cccac0a2 | 5996 | LOC: Config.effectiveGroup |
5997 | DOC_START | |
64e288bd | 5998 | Squid sets the GID to the effective user's default group ID |
5999 | (taken from the password file) and supplementary group list | |
6000 | from the groups membership. | |
6001 | ||
e3d74828 | 6002 | If you want Squid to run with a specific GID regardless of |
6003 | the group memberships of the effective user then set this | |
6004 | to the group (or GID) you want Squid to run as. When set | |
64e288bd | 6005 | all other group privileges of the effective user are ignored |
e3d74828 | 6006 | and only this GID is effective. If Squid is not started as |
64e288bd | 6007 | root the user starting Squid MUST be member of the specified |
e3d74828 | 6008 | group. |
64e288bd | 6009 | |
6010 | This option is not recommended by the Squid Team. | |
6011 | Our preference is for administrators to configure a secure | |
6012 | user account for squid with UID/GID matching system policies. | |
cccac0a2 | 6013 | DOC_END |
6014 | ||
d3caee79 | 6015 | NAME: httpd_suppress_version_string |
6016 | COMMENT: on|off | |
6017 | TYPE: onoff | |
6018 | DEFAULT: off | |
6019 | LOC: Config.onoff.httpd_suppress_version_string | |
6020 | DOC_START | |
6021 | Suppress Squid version string info in HTTP headers and HTML error pages. | |
6022 | DOC_END | |
6023 | ||
cccac0a2 | 6024 | NAME: visible_hostname |
6025 | TYPE: string | |
6026 | LOC: Config.visibleHostname | |
6027 | DEFAULT: none | |
638402dd | 6028 | DEFAULT_DOC: Automatically detect the system host name |
cccac0a2 | 6029 | DOC_START |
6030 | If you want to present a special hostname in error messages, etc, | |
7f7db318 | 6031 | define this. Otherwise, the return value of gethostname() |
cccac0a2 | 6032 | will be used. If you have multiple caches in a cluster and |
6033 | get errors about IP-forwarding you must set them to have individual | |
6034 | names with this setting. | |
6035 | DOC_END | |
6036 | ||
cccac0a2 | 6037 | NAME: unique_hostname |
6038 | TYPE: string | |
6039 | LOC: Config.uniqueHostname | |
6040 | DEFAULT: none | |
638402dd | 6041 | DEFAULT_DOC: Copy the value from visible_hostname |
cccac0a2 | 6042 | DOC_START |
6043 | If you want to have multiple machines with the same | |
7f7db318 | 6044 | 'visible_hostname' you must give each machine a different |
6045 | 'unique_hostname' so forwarding loops can be detected. | |
cccac0a2 | 6046 | DOC_END |
6047 | ||
cccac0a2 | 6048 | NAME: hostname_aliases |
6049 | TYPE: wordlist | |
6050 | LOC: Config.hostnameAliases | |
6051 | DEFAULT: none | |
6052 | DOC_START | |
7f7db318 | 6053 | A list of other DNS names your cache has. |
cccac0a2 | 6054 | DOC_END |
0976f8db | 6055 | |
c642c141 AJ |
6056 | NAME: umask |
6057 | TYPE: int | |
6058 | LOC: Config.umask | |
6059 | DEFAULT: 027 | |
6060 | DOC_START | |
6061 | Minimum umask which should be enforced while the proxy | |
6062 | is running, in addition to the umask set at startup. | |
6063 | ||
6064 | For a traditional octal representation of umasks, start | |
6065 | your value with 0. | |
6066 | DOC_END | |
6067 | ||
cccac0a2 | 6068 | COMMENT_START |
6069 | OPTIONS FOR THE CACHE REGISTRATION SERVICE | |
6070 | ----------------------------------------------------------------------------- | |
6071 | ||
6072 | This section contains parameters for the (optional) cache | |
6073 | announcement service. This service is provided to help | |
6074 | cache administrators locate one another in order to join or | |
6075 | create cache hierarchies. | |
6076 | ||
6077 | An 'announcement' message is sent (via UDP) to the registration | |
6078 | service by Squid. By default, the announcement message is NOT | |
6079 | SENT unless you enable it with 'announce_period' below. | |
6080 | ||
6081 | The announcement message includes your hostname, plus the | |
6082 | following information from this configuration file: | |
6083 | ||
6084 | http_port | |
6085 | icp_port | |
6086 | cache_mgr | |
6087 | ||
6088 | All current information is processed regularly and made | |
6089 | available on the Web at http://www.ircache.net/Cache/Tracker/. | |
6090 | COMMENT_END | |
6091 | ||
6092 | NAME: announce_period | |
6093 | TYPE: time_t | |
6094 | LOC: Config.Announce.period | |
6095 | DEFAULT: 0 | |
638402dd | 6096 | DEFAULT_DOC: Announcement messages disabled. |
cccac0a2 | 6097 | DOC_START |
638402dd | 6098 | This is how frequently to send cache announcements. |
cccac0a2 | 6099 | |
e0855596 | 6100 | To enable announcing your cache, just set an announce period. |
cccac0a2 | 6101 | |
e0855596 AJ |
6102 | Example: |
6103 | announce_period 1 day | |
cccac0a2 | 6104 | DOC_END |
6105 | ||
cccac0a2 | 6106 | NAME: announce_host |
6107 | TYPE: string | |
6108 | DEFAULT: tracker.ircache.net | |
6109 | LOC: Config.Announce.host | |
638402dd AJ |
6110 | DOC_START |
6111 | Set the hostname where announce registration messages will be sent. | |
6112 | ||
6113 | See also announce_port and announce_file | |
6114 | DOC_END | |
cccac0a2 | 6115 | |
6116 | NAME: announce_file | |
6117 | TYPE: string | |
6118 | DEFAULT: none | |
6119 | LOC: Config.Announce.file | |
638402dd AJ |
6120 | DOC_START |
6121 | The contents of this file will be included in the announce | |
6122 | registration messages. | |
6123 | DOC_END | |
cccac0a2 | 6124 | |
6125 | NAME: announce_port | |
ae870270 | 6126 | TYPE: u_short |
cccac0a2 | 6127 | DEFAULT: 3131 |
6128 | LOC: Config.Announce.port | |
6129 | DOC_START | |
638402dd | 6130 | Set the port where announce registration messages will be sent. |
cccac0a2 | 6131 | |
638402dd | 6132 | See also announce_host and announce_file |
cccac0a2 | 6133 | DOC_END |
6134 | ||
8d6275c0 | 6135 | COMMENT_START |
6136 | HTTPD-ACCELERATOR OPTIONS | |
6137 | ----------------------------------------------------------------------------- | |
6138 | COMMENT_END | |
6139 | ||
cccac0a2 | 6140 | NAME: httpd_accel_surrogate_id |
cccac0a2 | 6141 | TYPE: string |
b2b40d8c | 6142 | DEFAULT: none |
638402dd | 6143 | DEFAULT_DOC: visible_hostname is used if no specific ID is set. |
cccac0a2 | 6144 | LOC: Config.Accel.surrogate_id |
cccac0a2 | 6145 | DOC_START |
6146 | Surrogates (http://www.esi.org/architecture_spec_1.0.html) | |
6147 | need an identification token to allow control targeting. Because | |
6148 | a farm of surrogates may all perform the same tasks, they may share | |
6149 | an identification token. | |
6150 | DOC_END | |
6151 | ||
6152 | NAME: http_accel_surrogate_remote | |
cccac0a2 | 6153 | COMMENT: on|off |
6154 | TYPE: onoff | |
6155 | DEFAULT: off | |
6156 | LOC: Config.onoff.surrogate_is_remote | |
6157 | DOC_START | |
638402dd AJ |
6158 | Remote surrogates (such as those in a CDN) honour the header |
6159 | "Surrogate-Control: no-store-remote". | |
6160 | ||
cccac0a2 | 6161 | Set this to on to have squid behave as a remote surrogate. |
6162 | DOC_END | |
6163 | ||
6164 | NAME: esi_parser | |
f41735ea | 6165 | IFDEF: USE_SQUID_ESI |
964b44c3 | 6166 | COMMENT: libxml2|expat|custom |
cccac0a2 | 6167 | TYPE: string |
6168 | LOC: ESIParser::Type | |
6169 | DEFAULT: custom | |
6170 | DOC_START | |
6171 | ESI markup is not strictly XML compatible. The custom ESI parser | |
6172 | will give higher performance, but cannot handle non ASCII character | |
6173 | encodings. | |
6174 | DOC_END | |
0976f8db | 6175 | |
9edd9041 | 6176 | COMMENT_START |
8d6275c0 | 6177 | DELAY POOL PARAMETERS |
9edd9041 | 6178 | ----------------------------------------------------------------------------- |
6179 | COMMENT_END | |
6180 | ||
6181 | NAME: delay_pools | |
6182 | TYPE: delay_pool_count | |
6183 | DEFAULT: 0 | |
9a0a18de | 6184 | IFDEF: USE_DELAY_POOLS |
9edd9041 | 6185 | LOC: Config.Delay |
6186 | DOC_START | |
6187 | This represents the number of delay pools to be used. For example, | |
6188 | if you have one class 2 delay pool and one class 3 delays pool, you | |
6189 | have a total of 2 delay pools. | |
638402dd AJ |
6190 | |
6191 | See also delay_parameters, delay_class, delay_access for pool | |
6192 | configuration details. | |
9edd9041 | 6193 | DOC_END |
6194 | ||
6195 | NAME: delay_class | |
6196 | TYPE: delay_pool_class | |
6197 | DEFAULT: none | |
9a0a18de | 6198 | IFDEF: USE_DELAY_POOLS |
9edd9041 | 6199 | LOC: Config.Delay |
6200 | DOC_START | |
6201 | This defines the class of each delay pool. There must be exactly one | |
6202 | delay_class line for each delay pool. For example, to define two | |
6203 | delay pools, one of class 2 and one of class 3, the settings above | |
6204 | and here would be: | |
6205 | ||
b1fb3348 AJ |
6206 | Example: |
6207 | delay_pools 4 # 4 delay pools | |
6208 | delay_class 1 2 # pool 1 is a class 2 pool | |
6209 | delay_class 2 3 # pool 2 is a class 3 pool | |
6210 | delay_class 3 4 # pool 3 is a class 4 pool | |
6211 | delay_class 4 5 # pool 4 is a class 5 pool | |
9edd9041 | 6212 | |
6213 | The delay pool classes are: | |
6214 | ||
6215 | class 1 Everything is limited by a single aggregate | |
6216 | bucket. | |
6217 | ||
6218 | class 2 Everything is limited by a single aggregate | |
6219 | bucket as well as an "individual" bucket chosen | |
b1fb3348 | 6220 | from bits 25 through 32 of the IPv4 address. |
9edd9041 | 6221 | |
6222 | class 3 Everything is limited by a single aggregate | |
6223 | bucket as well as a "network" bucket chosen | |
6224 | from bits 17 through 24 of the IP address and a | |
6225 | "individual" bucket chosen from bits 17 through | |
b1fb3348 | 6226 | 32 of the IPv4 address. |
9edd9041 | 6227 | |
6228 | class 4 Everything in a class 3 delay pool, with an | |
6229 | additional limit on a per user basis. This | |
6230 | only takes effect if the username is established | |
6231 | in advance - by forcing authentication in your | |
6232 | http_access rules. | |
6233 | ||
6234 | class 5 Requests are grouped according their tag (see | |
6235 | external_acl's tag= reply). | |
6236 | ||
0b68481a AJ |
6237 | |
6238 | Each pool also requires a delay_parameters directive to configure the pool size | |
6239 | and speed limits used whenever the pool is applied to a request. Along with | |
6240 | a set of delay_access directives to determine when it is used. | |
6241 | ||
9edd9041 | 6242 | NOTE: If an IP address is a.b.c.d |
6243 | -> bits 25 through 32 are "d" | |
6244 | -> bits 17 through 24 are "c" | |
6245 | -> bits 17 through 32 are "c * 256 + d" | |
b1fb3348 AJ |
6246 | |
6247 | NOTE-2: Due to the use of bitmasks in class 2,3,4 pools they only apply to | |
6248 | IPv4 traffic. Class 1 and 5 pools may be used with IPv6 traffic. | |
638402dd AJ |
6249 | |
6250 | This clause only supports fast acl types. | |
6251 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
6252 | ||
6253 | See also delay_parameters and delay_access. | |
9edd9041 | 6254 | DOC_END |
6255 | ||
6256 | NAME: delay_access | |
6257 | TYPE: delay_pool_access | |
6258 | DEFAULT: none | |
638402dd | 6259 | DEFAULT_DOC: Deny using the pool, unless allow rules exist in squid.conf for the pool. |
9a0a18de | 6260 | IFDEF: USE_DELAY_POOLS |
9edd9041 | 6261 | LOC: Config.Delay |
6262 | DOC_START | |
6263 | This is used to determine which delay pool a request falls into. | |
6264 | ||
6265 | delay_access is sorted per pool and the matching starts with pool 1, | |
6266 | then pool 2, ..., and finally pool N. The first delay pool where the | |
6267 | request is allowed is selected for the request. If it does not allow | |
6268 | the request to any pool then the request is not delayed (default). | |
6269 | ||
6270 | For example, if you want some_big_clients in delay | |
6271 | pool 1 and lotsa_little_clients in delay pool 2: | |
6272 | ||
638402dd AJ |
6273 | delay_access 1 allow some_big_clients |
6274 | delay_access 1 deny all | |
6275 | delay_access 2 allow lotsa_little_clients | |
6276 | delay_access 2 deny all | |
6277 | delay_access 3 allow authenticated_clients | |
6278 | ||
6279 | See also delay_parameters and delay_class. | |
6280 | ||
9edd9041 | 6281 | DOC_END |
6282 | ||
6283 | NAME: delay_parameters | |
6284 | TYPE: delay_pool_rates | |
6285 | DEFAULT: none | |
9a0a18de | 6286 | IFDEF: USE_DELAY_POOLS |
9edd9041 | 6287 | LOC: Config.Delay |
6288 | DOC_START | |
6289 | This defines the parameters for a delay pool. Each delay pool has | |
6290 | a number of "buckets" associated with it, as explained in the | |
0b68481a | 6291 | description of delay_class. |
9edd9041 | 6292 | |
0b68481a AJ |
6293 | For a class 1 delay pool, the syntax is: |
6294 | delay_pools pool 1 | |
6295 | delay_parameters pool aggregate | |
9edd9041 | 6296 | |
6297 | For a class 2 delay pool: | |
0b68481a AJ |
6298 | delay_pools pool 2 |
6299 | delay_parameters pool aggregate individual | |
9edd9041 | 6300 | |
6301 | For a class 3 delay pool: | |
0b68481a AJ |
6302 | delay_pools pool 3 |
6303 | delay_parameters pool aggregate network individual | |
9edd9041 | 6304 | |
6305 | For a class 4 delay pool: | |
0b68481a AJ |
6306 | delay_pools pool 4 |
6307 | delay_parameters pool aggregate network individual user | |
9edd9041 | 6308 | |
6309 | For a class 5 delay pool: | |
0b68481a AJ |
6310 | delay_pools pool 5 |
6311 | delay_parameters pool tagrate | |
9edd9041 | 6312 | |
0b68481a | 6313 | The option variables are: |
9edd9041 | 6314 | |
6315 | pool a pool number - ie, a number between 1 and the | |
6316 | number specified in delay_pools as used in | |
6317 | delay_class lines. | |
6318 | ||
fdb47ac6 | 6319 | aggregate the speed limit parameters for the aggregate bucket |
9edd9041 | 6320 | (class 1, 2, 3). |
6321 | ||
fdb47ac6 | 6322 | individual the speed limit parameters for the individual |
9edd9041 | 6323 | buckets (class 2, 3). |
6324 | ||
fdb47ac6 | 6325 | network the speed limit parameters for the network buckets |
9edd9041 | 6326 | (class 3). |
6327 | ||
fdb47ac6 | 6328 | user the speed limit parameters for the user buckets |
9edd9041 | 6329 | (class 4). |
6330 | ||
fdb47ac6 | 6331 | tagrate the speed limit parameters for the tag buckets |
9edd9041 | 6332 | (class 5). |
6333 | ||
6334 | A pair of delay parameters is written restore/maximum, where restore is | |
6335 | the number of bytes (not bits - modem and network speeds are usually | |
6336 | quoted in bits) per second placed into the bucket, and maximum is the | |
6337 | maximum number of bytes which can be in the bucket at any time. | |
6338 | ||
0b68481a AJ |
6339 | There must be one delay_parameters line for each delay pool. |
6340 | ||
6341 | ||
9edd9041 | 6342 | For example, if delay pool number 1 is a class 2 delay pool as in the |
0b68481a | 6343 | above example, and is being used to strictly limit each host to 64Kbit/sec |
9edd9041 | 6344 | (plus overheads), with no overall limit, the line is: |
6345 | ||
0b68481a AJ |
6346 | delay_parameters 1 -1/-1 8000/8000 |
6347 | ||
6348 | Note that 8 x 8000 KByte/sec -> 64Kbit/sec. | |
9edd9041 | 6349 | |
6350 | Note that the figure -1 is used to represent "unlimited". | |
6351 | ||
0b68481a | 6352 | |
9edd9041 | 6353 | And, if delay pool number 2 is a class 3 delay pool as in the above |
0b68481a AJ |
6354 | example, and you want to limit it to a total of 256Kbit/sec (strict limit) |
6355 | with each 8-bit network permitted 64Kbit/sec (strict limit) and each | |
6356 | individual host permitted 4800bit/sec with a bucket maximum size of 64Kbits | |
9edd9041 | 6357 | to permit a decent web page to be downloaded at a decent speed |
6358 | (if the network is not being limited due to overuse) but slow down | |
6359 | large downloads more significantly: | |
6360 | ||
0b68481a AJ |
6361 | delay_parameters 2 32000/32000 8000/8000 600/8000 |
6362 | ||
6363 | Note that 8 x 32000 KByte/sec -> 256Kbit/sec. | |
6364 | 8 x 8000 KByte/sec -> 64Kbit/sec. | |
6365 | 8 x 600 Byte/sec -> 4800bit/sec. | |
9edd9041 | 6366 | |
9edd9041 | 6367 | |
6368 | Finally, for a class 4 delay pool as in the example - each user will | |
0b68481a | 6369 | be limited to 128Kbits/sec no matter how many workstations they are logged into.: |
9edd9041 | 6370 | |
0b68481a | 6371 | delay_parameters 4 32000/32000 8000/8000 600/64000 16000/16000 |
638402dd AJ |
6372 | |
6373 | ||
6374 | See also delay_class and delay_access. | |
6375 | ||
9edd9041 | 6376 | DOC_END |
6377 | ||
6378 | NAME: delay_initial_bucket_level | |
6379 | COMMENT: (percent, 0-100) | |
ae870270 | 6380 | TYPE: u_short |
9edd9041 | 6381 | DEFAULT: 50 |
9a0a18de | 6382 | IFDEF: USE_DELAY_POOLS |
9edd9041 | 6383 | LOC: Config.Delay.initial |
6384 | DOC_START | |
6385 | The initial bucket percentage is used to determine how much is put | |
6386 | in each bucket when squid starts, is reconfigured, or first notices | |
6387 | a host accessing it (in class 2 and class 3, individual hosts and | |
6388 | networks only have buckets associated with them once they have been | |
6389 | "seen" by squid). | |
6390 | DOC_END | |
6391 | ||
b4cd430a CT |
6392 | COMMENT_START |
6393 | CLIENT DELAY POOL PARAMETERS | |
6394 | ----------------------------------------------------------------------------- | |
6395 | COMMENT_END | |
6396 | ||
6397 | NAME: client_delay_pools | |
6398 | TYPE: client_delay_pool_count | |
6399 | DEFAULT: 0 | |
9a0a18de | 6400 | IFDEF: USE_DELAY_POOLS |
b4cd430a CT |
6401 | LOC: Config.ClientDelay |
6402 | DOC_START | |
6403 | This option specifies the number of client delay pools used. It must | |
6404 | preceed other client_delay_* options. | |
6405 | ||
638402dd AJ |
6406 | Example: |
6407 | client_delay_pools 2 | |
6408 | ||
6409 | See also client_delay_parameters and client_delay_access. | |
b4cd430a CT |
6410 | DOC_END |
6411 | ||
6412 | NAME: client_delay_initial_bucket_level | |
6413 | COMMENT: (percent, 0-no_limit) | |
ae870270 | 6414 | TYPE: u_short |
b4cd430a | 6415 | DEFAULT: 50 |
9a0a18de | 6416 | IFDEF: USE_DELAY_POOLS |
b4cd430a CT |
6417 | LOC: Config.ClientDelay.initial |
6418 | DOC_START | |
6419 | This option determines the initial bucket size as a percentage of | |
6420 | max_bucket_size from client_delay_parameters. Buckets are created | |
6421 | at the time of the "first" connection from the matching IP. Idle | |
6422 | buckets are periodically deleted up. | |
6423 | ||
6424 | You can specify more than 100 percent but note that such "oversized" | |
6425 | buckets are not refilled until their size goes down to max_bucket_size | |
6426 | from client_delay_parameters. | |
6427 | ||
638402dd AJ |
6428 | Example: |
6429 | client_delay_initial_bucket_level 50 | |
b4cd430a CT |
6430 | DOC_END |
6431 | ||
6432 | NAME: client_delay_parameters | |
6433 | TYPE: client_delay_pool_rates | |
6434 | DEFAULT: none | |
9a0a18de | 6435 | IFDEF: USE_DELAY_POOLS |
b4cd430a CT |
6436 | LOC: Config.ClientDelay |
6437 | DOC_START | |
6438 | ||
6439 | This option configures client-side bandwidth limits using the | |
6440 | following format: | |
6441 | ||
6442 | client_delay_parameters pool speed_limit max_bucket_size | |
6443 | ||
6444 | pool is an integer ID used for client_delay_access matching. | |
6445 | ||
6446 | speed_limit is bytes added to the bucket per second. | |
6447 | ||
6448 | max_bucket_size is the maximum size of a bucket, enforced after any | |
6449 | speed_limit additions. | |
6450 | ||
6451 | Please see the delay_parameters option for more information and | |
6452 | examples. | |
6453 | ||
638402dd AJ |
6454 | Example: |
6455 | client_delay_parameters 1 1024 2048 | |
6456 | client_delay_parameters 2 51200 16384 | |
6457 | ||
6458 | See also client_delay_access. | |
6459 | ||
b4cd430a CT |
6460 | DOC_END |
6461 | ||
6462 | NAME: client_delay_access | |
6463 | TYPE: client_delay_pool_access | |
6464 | DEFAULT: none | |
638402dd | 6465 | DEFAULT_DOC: Deny use of the pool, unless allow rules exist in squid.conf for the pool. |
9a0a18de | 6466 | IFDEF: USE_DELAY_POOLS |
b4cd430a CT |
6467 | LOC: Config.ClientDelay |
6468 | DOC_START | |
b4cd430a CT |
6469 | This option determines the client-side delay pool for the |
6470 | request: | |
6471 | ||
6472 | client_delay_access pool_ID allow|deny acl_name | |
6473 | ||
6474 | All client_delay_access options are checked in their pool ID | |
6475 | order, starting with pool 1. The first checked pool with allowed | |
6476 | request is selected for the request. If no ACL matches or there | |
6477 | are no client_delay_access options, the request bandwidth is not | |
6478 | limited. | |
6479 | ||
6480 | The ACL-selected pool is then used to find the | |
6481 | client_delay_parameters for the request. Client-side pools are | |
6482 | not used to aggregate clients. Clients are always aggregated | |
6483 | based on their source IP addresses (one bucket per source IP). | |
6484 | ||
638402dd AJ |
6485 | This clause only supports fast acl types. |
6486 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
6487 | Additionally, only the client TCP connection details are available. | |
6488 | ACLs testing HTTP properties will not work. | |
6489 | ||
b4cd430a CT |
6490 | Please see delay_access for more examples. |
6491 | ||
638402dd AJ |
6492 | Example: |
6493 | client_delay_access 1 allow low_rate_network | |
6494 | client_delay_access 2 allow vips_network | |
6495 | ||
6496 | ||
6497 | See also client_delay_parameters and client_delay_pools. | |
b4cd430a CT |
6498 | DOC_END |
6499 | ||
cccac0a2 | 6500 | COMMENT_START |
8d6275c0 | 6501 | WCCPv1 AND WCCPv2 CONFIGURATION OPTIONS |
cccac0a2 | 6502 | ----------------------------------------------------------------------------- |
6503 | COMMENT_END | |
6504 | ||
8d6275c0 | 6505 | NAME: wccp_router |
6506 | TYPE: address | |
6507 | LOC: Config.Wccp.router | |
0eb08770 | 6508 | DEFAULT: any_addr |
638402dd | 6509 | DEFAULT_DOC: WCCP disabled. |
8d6275c0 | 6510 | IFDEF: USE_WCCP |
e313ab0a AJ |
6511 | DOC_START |
6512 | Use this option to define your WCCP ``home'' router for | |
6513 | Squid. | |
6514 | ||
6515 | wccp_router supports a single WCCP(v1) router | |
6516 | ||
6517 | wccp2_router supports multiple WCCPv2 routers | |
6518 | ||
6519 | only one of the two may be used at the same time and defines | |
6520 | which version of WCCP to use. | |
6521 | DOC_END | |
df2eec10 | 6522 | |
8d6275c0 | 6523 | NAME: wccp2_router |
9fb4efad | 6524 | TYPE: IpAddress_list |
8d6275c0 | 6525 | LOC: Config.Wccp2.router |
cccac0a2 | 6526 | DEFAULT: none |
638402dd | 6527 | DEFAULT_DOC: WCCPv2 disabled. |
8d6275c0 | 6528 | IFDEF: USE_WCCPv2 |
cccac0a2 | 6529 | DOC_START |
8d6275c0 | 6530 | Use this option to define your WCCP ``home'' router for |
6531 | Squid. | |
cccac0a2 | 6532 | |
8d6275c0 | 6533 | wccp_router supports a single WCCP(v1) router |
cccac0a2 | 6534 | |
8d6275c0 | 6535 | wccp2_router supports multiple WCCPv2 routers |
cccac0a2 | 6536 | |
8d6275c0 | 6537 | only one of the two may be used at the same time and defines |
6538 | which version of WCCP to use. | |
6539 | DOC_END | |
6540 | ||
6541 | NAME: wccp_version | |
cccac0a2 | 6542 | TYPE: int |
8d6275c0 | 6543 | LOC: Config.Wccp.version |
6544 | DEFAULT: 4 | |
6545 | IFDEF: USE_WCCP | |
cccac0a2 | 6546 | DOC_START |
8d6275c0 | 6547 | This directive is only relevant if you need to set up WCCP(v1) |
6548 | to some very old and end-of-life Cisco routers. In all other | |
6549 | setups it must be left unset or at the default setting. | |
6550 | It defines an internal version in the WCCP(v1) protocol, | |
6551 | with version 4 being the officially documented protocol. | |
cccac0a2 | 6552 | |
8d6275c0 | 6553 | According to some users, Cisco IOS 11.2 and earlier only |
6554 | support WCCP version 3. If you're using that or an earlier | |
6555 | version of IOS, you may need to change this value to 3, otherwise | |
6556 | do not specify this parameter. | |
cccac0a2 | 6557 | DOC_END |
6558 | ||
8d6275c0 | 6559 | NAME: wccp2_rebuild_wait |
6560 | TYPE: onoff | |
6561 | LOC: Config.Wccp2.rebuildwait | |
6562 | DEFAULT: on | |
6563 | IFDEF: USE_WCCPv2 | |
6564 | DOC_START | |
6565 | If this is enabled Squid will wait for the cache dir rebuild to finish | |
6566 | before sending the first wccp2 HereIAm packet | |
6567 | DOC_END | |
cccac0a2 | 6568 | |
8d6275c0 | 6569 | NAME: wccp2_forwarding_method |
e313ab0a | 6570 | TYPE: wccp2_method |
8d6275c0 | 6571 | LOC: Config.Wccp2.forwarding_method |
451c4786 | 6572 | DEFAULT: gre |
8d6275c0 | 6573 | IFDEF: USE_WCCPv2 |
cccac0a2 | 6574 | DOC_START |
699acd19 | 6575 | WCCP2 allows the setting of forwarding methods between the |
8d6275c0 | 6576 | router/switch and the cache. Valid values are as follows: |
cccac0a2 | 6577 | |
451c4786 AJ |
6578 | gre - GRE encapsulation (forward the packet in a GRE/WCCP tunnel) |
6579 | l2 - L2 redirect (forward the packet using Layer 2/MAC rewriting) | |
cccac0a2 | 6580 | |
8d6275c0 | 6581 | Currently (as of IOS 12.4) cisco routers only support GRE. |
6582 | Cisco switches only support the L2 redirect assignment method. | |
cccac0a2 | 6583 | DOC_END |
6584 | ||
8d6275c0 | 6585 | NAME: wccp2_return_method |
e313ab0a | 6586 | TYPE: wccp2_method |
8d6275c0 | 6587 | LOC: Config.Wccp2.return_method |
451c4786 | 6588 | DEFAULT: gre |
8d6275c0 | 6589 | IFDEF: USE_WCCPv2 |
cccac0a2 | 6590 | DOC_START |
699acd19 | 6591 | WCCP2 allows the setting of return methods between the |
8d6275c0 | 6592 | router/switch and the cache for packets that the cache |
6593 | decides not to handle. Valid values are as follows: | |
cccac0a2 | 6594 | |
451c4786 AJ |
6595 | gre - GRE encapsulation (forward the packet in a GRE/WCCP tunnel) |
6596 | l2 - L2 redirect (forward the packet using Layer 2/MAC rewriting) | |
cccac0a2 | 6597 | |
8d6275c0 | 6598 | Currently (as of IOS 12.4) cisco routers only support GRE. |
6599 | Cisco switches only support the L2 redirect assignment. | |
cccac0a2 | 6600 | |
699acd19 | 6601 | If the "ip wccp redirect exclude in" command has been |
8d6275c0 | 6602 | enabled on the cache interface, then it is still safe for |
6603 | the proxy server to use a l2 redirect method even if this | |
6604 | option is set to GRE. | |
cccac0a2 | 6605 | DOC_END |
6606 | ||
8d6275c0 | 6607 | NAME: wccp2_assignment_method |
451c4786 | 6608 | TYPE: wccp2_amethod |
8d6275c0 | 6609 | LOC: Config.Wccp2.assignment_method |
451c4786 | 6610 | DEFAULT: hash |
8d6275c0 | 6611 | IFDEF: USE_WCCPv2 |
cccac0a2 | 6612 | DOC_START |
8d6275c0 | 6613 | WCCP2 allows the setting of methods to assign the WCCP hash |
6614 | Valid values are as follows: | |
cccac0a2 | 6615 | |
451c4786 | 6616 | hash - Hash assignment |
bb7a1781 | 6617 | mask - Mask assignment |
cccac0a2 | 6618 | |
8d6275c0 | 6619 | As a general rule, cisco routers support the hash assignment method |
6620 | and cisco switches support the mask assignment method. | |
6621 | DOC_END | |
cccac0a2 | 6622 | |
8d6275c0 | 6623 | NAME: wccp2_service |
6624 | TYPE: wccp2_service | |
6625 | LOC: Config.Wccp2.info | |
8d6275c0 | 6626 | DEFAULT_IF_NONE: standard 0 |
638402dd | 6627 | DEFAULT_DOC: Use the 'web-cache' standard service. |
8d6275c0 | 6628 | IFDEF: USE_WCCPv2 |
6629 | DOC_START | |
6630 | WCCP2 allows for multiple traffic services. There are two | |
6631 | types: "standard" and "dynamic". The standard type defines | |
6632 | one service id - http (id 0). The dynamic service ids can be from | |
6633 | 51 to 255 inclusive. In order to use a dynamic service id | |
6634 | one must define the type of traffic to be redirected; this is done | |
6635 | using the wccp2_service_info option. | |
6636 | ||
6637 | The "standard" type does not require a wccp2_service_info option, | |
6638 | just specifying the service id will suffice. | |
6639 | ||
6640 | MD5 service authentication can be enabled by adding | |
6641 | "password=<password>" to the end of this service declaration. | |
6642 | ||
6643 | Examples: | |
6644 | ||
6645 | wccp2_service standard 0 # for the 'web-cache' standard service | |
6646 | wccp2_service dynamic 80 # a dynamic service type which will be | |
6647 | # fleshed out with subsequent options. | |
6648 | wccp2_service standard 0 password=foo | |
8d6275c0 | 6649 | DOC_END |
6650 | ||
6651 | NAME: wccp2_service_info | |
6652 | TYPE: wccp2_service_info | |
6653 | LOC: Config.Wccp2.info | |
6654 | DEFAULT: none | |
6655 | IFDEF: USE_WCCPv2 | |
6656 | DOC_START | |
6657 | Dynamic WCCPv2 services require further information to define the | |
6658 | traffic you wish to have diverted. | |
6659 | ||
6660 | The format is: | |
6661 | ||
6662 | wccp2_service_info <id> protocol=<protocol> flags=<flag>,<flag>.. | |
6663 | priority=<priority> ports=<port>,<port>.. | |
6664 | ||
6665 | The relevant WCCPv2 flags: | |
6666 | + src_ip_hash, dst_ip_hash | |
005fe566 | 6667 | + source_port_hash, dst_port_hash |
8d6275c0 | 6668 | + src_ip_alt_hash, dst_ip_alt_hash |
6669 | + src_port_alt_hash, dst_port_alt_hash | |
6670 | + ports_source | |
6671 | ||
6672 | The port list can be one to eight entries. | |
6673 | ||
6674 | Example: | |
6675 | ||
6676 | wccp2_service_info 80 protocol=tcp flags=src_ip_hash,ports_source | |
6677 | priority=240 ports=80 | |
6678 | ||
6679 | Note: the service id must have been defined by a previous | |
6680 | 'wccp2_service dynamic <id>' entry. | |
6681 | DOC_END | |
6682 | ||
6683 | NAME: wccp2_weight | |
6684 | TYPE: int | |
6685 | LOC: Config.Wccp2.weight | |
6686 | DEFAULT: 10000 | |
6687 | IFDEF: USE_WCCPv2 | |
6688 | DOC_START | |
6689 | Each cache server gets assigned a set of the destination | |
6690 | hash proportional to their weight. | |
6691 | DOC_END | |
6692 | ||
6693 | NAME: wccp_address | |
6694 | TYPE: address | |
6695 | LOC: Config.Wccp.address | |
6696 | DEFAULT: 0.0.0.0 | |
638402dd | 6697 | DEFAULT_DOC: Address selected by the operating system. |
8d6275c0 | 6698 | IFDEF: USE_WCCP |
638402dd AJ |
6699 | DOC_START |
6700 | Use this option if you require WCCPv2 to use a specific | |
6701 | interface address. | |
6702 | ||
6703 | The default behavior is to not bind to any specific address. | |
6704 | DOC_END | |
df2eec10 | 6705 | |
8d6275c0 | 6706 | NAME: wccp2_address |
6707 | TYPE: address | |
6708 | LOC: Config.Wccp2.address | |
6709 | DEFAULT: 0.0.0.0 | |
638402dd | 6710 | DEFAULT_DOC: Address selected by the operating system. |
8d6275c0 | 6711 | IFDEF: USE_WCCPv2 |
6712 | DOC_START | |
6713 | Use this option if you require WCCP to use a specific | |
6714 | interface address. | |
6715 | ||
6716 | The default behavior is to not bind to any specific address. | |
6717 | DOC_END | |
6718 | ||
6719 | COMMENT_START | |
6720 | PERSISTENT CONNECTION HANDLING | |
6721 | ----------------------------------------------------------------------------- | |
6722 | ||
6723 | Also see "pconn_timeout" in the TIMEOUTS section | |
6724 | COMMENT_END | |
6725 | ||
6726 | NAME: client_persistent_connections | |
6727 | TYPE: onoff | |
6728 | LOC: Config.onoff.client_pconns | |
6729 | DEFAULT: on | |
638402dd AJ |
6730 | DOC_START |
6731 | Persistent connection support for clients. | |
6732 | Squid uses persistent connections (when allowed). You can use | |
6733 | this option to disable persistent connections with clients. | |
6734 | DOC_END | |
8d6275c0 | 6735 | |
6736 | NAME: server_persistent_connections | |
6737 | TYPE: onoff | |
6738 | LOC: Config.onoff.server_pconns | |
6739 | DEFAULT: on | |
6740 | DOC_START | |
638402dd AJ |
6741 | Persistent connection support for servers. |
6742 | Squid uses persistent connections (when allowed). You can use | |
6743 | this option to disable persistent connections with servers. | |
8d6275c0 | 6744 | DOC_END |
6745 | ||
6746 | NAME: persistent_connection_after_error | |
6747 | TYPE: onoff | |
6748 | LOC: Config.onoff.error_pconns | |
0fccfb7f | 6749 | DEFAULT: on |
8d6275c0 | 6750 | DOC_START |
6751 | With this directive the use of persistent connections after | |
6752 | HTTP errors can be disabled. Useful if you have clients | |
6753 | who fail to handle errors on persistent connections proper. | |
6754 | DOC_END | |
6755 | ||
6756 | NAME: detect_broken_pconn | |
6757 | TYPE: onoff | |
6758 | LOC: Config.onoff.detect_broken_server_pconns | |
6759 | DEFAULT: off | |
6760 | DOC_START | |
6761 | Some servers have been found to incorrectly signal the use | |
6762 | of HTTP/1.0 persistent connections even on replies not | |
6763 | compatible, causing significant delays. This server problem | |
6764 | has mostly been seen on redirects. | |
6765 | ||
6766 | By enabling this directive Squid attempts to detect such | |
6767 | broken replies and automatically assume the reply is finished | |
6768 | after 10 seconds timeout. | |
6769 | DOC_END | |
6770 | ||
6771 | COMMENT_START | |
6772 | CACHE DIGEST OPTIONS | |
6773 | ----------------------------------------------------------------------------- | |
6774 | COMMENT_END | |
6775 | ||
6776 | NAME: digest_generation | |
6777 | IFDEF: USE_CACHE_DIGESTS | |
6778 | TYPE: onoff | |
6779 | LOC: Config.onoff.digest_generation | |
6780 | DEFAULT: on | |
6781 | DOC_START | |
6782 | This controls whether the server will generate a Cache Digest | |
6783 | of its contents. By default, Cache Digest generation is | |
13e917b5 | 6784 | enabled if Squid is compiled with --enable-cache-digests defined. |
8d6275c0 | 6785 | DOC_END |
6786 | ||
6787 | NAME: digest_bits_per_entry | |
6788 | IFDEF: USE_CACHE_DIGESTS | |
6789 | TYPE: int | |
6790 | LOC: Config.digest.bits_per_entry | |
6791 | DEFAULT: 5 | |
6792 | DOC_START | |
6793 | This is the number of bits of the server's Cache Digest which | |
6794 | will be associated with the Digest entry for a given HTTP | |
6795 | Method and URL (public key) combination. The default is 5. | |
6796 | DOC_END | |
6797 | ||
6798 | NAME: digest_rebuild_period | |
6799 | IFDEF: USE_CACHE_DIGESTS | |
6800 | COMMENT: (seconds) | |
6801 | TYPE: time_t | |
6802 | LOC: Config.digest.rebuild_period | |
6803 | DEFAULT: 1 hour | |
6804 | DOC_START | |
749ceff8 | 6805 | This is the wait time between Cache Digest rebuilds. |
8d6275c0 | 6806 | DOC_END |
6807 | ||
6808 | NAME: digest_rewrite_period | |
6809 | COMMENT: (seconds) | |
6810 | IFDEF: USE_CACHE_DIGESTS | |
6811 | TYPE: time_t | |
6812 | LOC: Config.digest.rewrite_period | |
6813 | DEFAULT: 1 hour | |
6814 | DOC_START | |
749ceff8 | 6815 | This is the wait time between Cache Digest writes to |
8d6275c0 | 6816 | disk. |
6817 | DOC_END | |
6818 | ||
6819 | NAME: digest_swapout_chunk_size | |
6820 | COMMENT: (bytes) | |
6821 | TYPE: b_size_t | |
6822 | IFDEF: USE_CACHE_DIGESTS | |
6823 | LOC: Config.digest.swapout_chunk_size | |
6824 | DEFAULT: 4096 bytes | |
6825 | DOC_START | |
6826 | This is the number of bytes of the Cache Digest to write to | |
6827 | disk at a time. It defaults to 4096 bytes (4KB), the Squid | |
6828 | default swap page. | |
6829 | DOC_END | |
6830 | ||
6831 | NAME: digest_rebuild_chunk_percentage | |
6832 | COMMENT: (percent, 0-100) | |
6833 | IFDEF: USE_CACHE_DIGESTS | |
6834 | TYPE: int | |
6835 | LOC: Config.digest.rebuild_chunk_percentage | |
6836 | DEFAULT: 10 | |
6837 | DOC_START | |
6838 | This is the percentage of the Cache Digest to be scanned at a | |
6839 | time. By default it is set to 10% of the Cache Digest. | |
6840 | DOC_END | |
6841 | ||
1db9eacd | 6842 | COMMENT_START |
5473c134 | 6843 | SNMP OPTIONS |
1db9eacd | 6844 | ----------------------------------------------------------------------------- |
6845 | COMMENT_END | |
6846 | ||
5473c134 | 6847 | NAME: snmp_port |
ae870270 | 6848 | TYPE: u_short |
5473c134 | 6849 | LOC: Config.Port.snmp |
87630341 | 6850 | DEFAULT: 0 |
638402dd | 6851 | DEFAULT_DOC: SNMP disabled. |
5473c134 | 6852 | IFDEF: SQUID_SNMP |
8d6275c0 | 6853 | DOC_START |
87630341 | 6854 | The port number where Squid listens for SNMP requests. To enable |
6855 | SNMP support set this to a suitable port number. Port number | |
6856 | 3401 is often used for the Squid SNMP agent. By default it's | |
6857 | set to "0" (disabled) | |
e0855596 AJ |
6858 | |
6859 | Example: | |
6860 | snmp_port 3401 | |
8d6275c0 | 6861 | DOC_END |
6862 | ||
5473c134 | 6863 | NAME: snmp_access |
6864 | TYPE: acl_access | |
6865 | LOC: Config.accessList.snmp | |
638402dd AJ |
6866 | DEFAULT: none |
6867 | DEFAULT_DOC: Deny, unless rules exist in squid.conf. | |
5473c134 | 6868 | IFDEF: SQUID_SNMP |
8d6275c0 | 6869 | DOC_START |
5473c134 | 6870 | Allowing or denying access to the SNMP port. |
8d6275c0 | 6871 | |
5473c134 | 6872 | All access to the agent is denied by default. |
6873 | usage: | |
8d6275c0 | 6874 | |
5473c134 | 6875 | snmp_access allow|deny [!]aclname ... |
8d6275c0 | 6876 | |
b3567eb5 FC |
6877 | This clause only supports fast acl types. |
6878 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
638402dd | 6879 | |
5473c134 | 6880 | Example: |
6881 | snmp_access allow snmppublic localhost | |
6882 | snmp_access deny all | |
cccac0a2 | 6883 | DOC_END |
6884 | ||
5473c134 | 6885 | NAME: snmp_incoming_address |
6886 | TYPE: address | |
6887 | LOC: Config.Addrs.snmp_incoming | |
0eb08770 | 6888 | DEFAULT: any_addr |
638402dd | 6889 | DEFAULT_DOC: Accept SNMP packets from all machine interfaces. |
5473c134 | 6890 | IFDEF: SQUID_SNMP |
638402dd AJ |
6891 | DOC_START |
6892 | Just like 'udp_incoming_address', but for the SNMP port. | |
6893 | ||
6894 | snmp_incoming_address is used for the SNMP socket receiving | |
6895 | messages from SNMP agents. | |
6896 | ||
6897 | The default snmp_incoming_address is to listen on all | |
6898 | available network interfaces. | |
6899 | DOC_END | |
df2eec10 | 6900 | |
5473c134 | 6901 | NAME: snmp_outgoing_address |
6902 | TYPE: address | |
6903 | LOC: Config.Addrs.snmp_outgoing | |
0eb08770 | 6904 | DEFAULT: no_addr |
638402dd | 6905 | DEFAULT_DOC: Use snmp_incoming_address or an address selected by the operating system. |
5473c134 | 6906 | IFDEF: SQUID_SNMP |
cccac0a2 | 6907 | DOC_START |
638402dd | 6908 | Just like 'udp_outgoing_address', but for the SNMP port. |
cccac0a2 | 6909 | |
5473c134 | 6910 | snmp_outgoing_address is used for SNMP packets returned to SNMP |
6911 | agents. | |
cccac0a2 | 6912 | |
0eb08770 HN |
6913 | If snmp_outgoing_address is not set it will use the same socket |
6914 | as snmp_incoming_address. Only change this if you want to have | |
6915 | SNMP replies sent using another address than where this Squid | |
6916 | listens for SNMP queries. | |
cccac0a2 | 6917 | |
5473c134 | 6918 | NOTE, snmp_incoming_address and snmp_outgoing_address can not have |
638402dd | 6919 | the same value since they both use the same port. |
cccac0a2 | 6920 | DOC_END |
6921 | ||
5473c134 | 6922 | COMMENT_START |
6923 | ICP OPTIONS | |
6924 | ----------------------------------------------------------------------------- | |
6925 | COMMENT_END | |
6926 | ||
6927 | NAME: icp_port udp_port | |
ae870270 | 6928 | TYPE: u_short |
5473c134 | 6929 | DEFAULT: 0 |
638402dd | 6930 | DEFAULT_DOC: ICP disabled. |
5473c134 | 6931 | LOC: Config.Port.icp |
cccac0a2 | 6932 | DOC_START |
5473c134 | 6933 | The port number where Squid sends and receives ICP queries to |
6934 | and from neighbor caches. The standard UDP port for ICP is 3130. | |
e0855596 AJ |
6935 | |
6936 | Example: | |
6937 | icp_port @DEFAULT_ICP_PORT@ | |
cccac0a2 | 6938 | DOC_END |
6939 | ||
5473c134 | 6940 | NAME: htcp_port |
6941 | IFDEF: USE_HTCP | |
ae870270 | 6942 | TYPE: u_short |
87630341 | 6943 | DEFAULT: 0 |
638402dd | 6944 | DEFAULT_DOC: HTCP disabled. |
5473c134 | 6945 | LOC: Config.Port.htcp |
cccac0a2 | 6946 | DOC_START |
5473c134 | 6947 | The port number where Squid sends and receives HTCP queries to |
87630341 | 6948 | and from neighbor caches. To turn it on you want to set it to |
638402dd | 6949 | 4827. |
e0855596 AJ |
6950 | |
6951 | Example: | |
6952 | htcp_port 4827 | |
cccac0a2 | 6953 | DOC_END |
6954 | ||
6955 | NAME: log_icp_queries | |
6956 | COMMENT: on|off | |
6957 | TYPE: onoff | |
6958 | DEFAULT: on | |
6959 | LOC: Config.onoff.log_udp | |
6960 | DOC_START | |
6961 | If set, ICP queries are logged to access.log. You may wish | |
6962 | do disable this if your ICP load is VERY high to speed things | |
6963 | up or to simplify log analysis. | |
6964 | DOC_END | |
6965 | ||
5473c134 | 6966 | NAME: udp_incoming_address |
6967 | TYPE: address | |
6968 | LOC:Config.Addrs.udp_incoming | |
0eb08770 | 6969 | DEFAULT: any_addr |
638402dd | 6970 | DEFAULT_DOC: Accept packets from all machine interfaces. |
8524d4b2 | 6971 | DOC_START |
6972 | udp_incoming_address is used for UDP packets received from other | |
6973 | caches. | |
6974 | ||
6975 | The default behavior is to not bind to any specific address. | |
6976 | ||
6977 | Only change this if you want to have all UDP queries received on | |
6978 | a specific interface/address. | |
6979 | ||
6980 | NOTE: udp_incoming_address is used by the ICP, HTCP, and DNS | |
6981 | modules. Altering it will affect all of them in the same manner. | |
6982 | ||
6983 | see also; udp_outgoing_address | |
6984 | ||
6985 | NOTE, udp_incoming_address and udp_outgoing_address can not | |
6986 | have the same value since they both use the same port. | |
6987 | DOC_END | |
cccac0a2 | 6988 | |
5473c134 | 6989 | NAME: udp_outgoing_address |
6990 | TYPE: address | |
6991 | LOC: Config.Addrs.udp_outgoing | |
0eb08770 | 6992 | DEFAULT: no_addr |
638402dd | 6993 | DEFAULT_DOC: Use udp_incoming_address or an address selected by the operating system. |
cccac0a2 | 6994 | DOC_START |
8524d4b2 | 6995 | udp_outgoing_address is used for UDP packets sent out to other |
5473c134 | 6996 | caches. |
cccac0a2 | 6997 | |
5473c134 | 6998 | The default behavior is to not bind to any specific address. |
cccac0a2 | 6999 | |
8524d4b2 | 7000 | Instead it will use the same socket as udp_incoming_address. |
7001 | Only change this if you want to have UDP queries sent using another | |
7002 | address than where this Squid listens for UDP queries from other | |
5473c134 | 7003 | caches. |
7004 | ||
8524d4b2 | 7005 | NOTE: udp_outgoing_address is used by the ICP, HTCP, and DNS |
7006 | modules. Altering it will affect all of them in the same manner. | |
7007 | ||
7008 | see also; udp_incoming_address | |
7009 | ||
5473c134 | 7010 | NOTE, udp_incoming_address and udp_outgoing_address can not |
8524d4b2 | 7011 | have the same value since they both use the same port. |
cccac0a2 | 7012 | DOC_END |
7013 | ||
3d1e3e43 | 7014 | NAME: icp_hit_stale |
7015 | COMMENT: on|off | |
7016 | TYPE: onoff | |
7017 | DEFAULT: off | |
7018 | LOC: Config.onoff.icp_hit_stale | |
7019 | DOC_START | |
7020 | If you want to return ICP_HIT for stale cache objects, set this | |
7021 | option to 'on'. If you have sibling relationships with caches | |
7022 | in other administrative domains, this should be 'off'. If you only | |
7023 | have sibling relationships with caches under your control, | |
7024 | it is probably okay to set this to 'on'. | |
7025 | If set to 'on', your siblings should use the option "allow-miss" | |
7026 | on their cache_peer lines for connecting to you. | |
7027 | DOC_END | |
7028 | ||
5473c134 | 7029 | NAME: minimum_direct_hops |
cccac0a2 | 7030 | TYPE: int |
5473c134 | 7031 | DEFAULT: 4 |
7032 | LOC: Config.minDirectHops | |
cccac0a2 | 7033 | DOC_START |
5473c134 | 7034 | If using the ICMP pinging stuff, do direct fetches for sites |
7035 | which are no more than this many hops away. | |
cccac0a2 | 7036 | DOC_END |
7037 | ||
5473c134 | 7038 | NAME: minimum_direct_rtt |
638402dd | 7039 | COMMENT: (msec) |
5473c134 | 7040 | TYPE: int |
7041 | DEFAULT: 400 | |
7042 | LOC: Config.minDirectRtt | |
cccac0a2 | 7043 | DOC_START |
5473c134 | 7044 | If using the ICMP pinging stuff, do direct fetches for sites |
7045 | which are no more than this many rtt milliseconds away. | |
cccac0a2 | 7046 | DOC_END |
7047 | ||
cccac0a2 | 7048 | NAME: netdb_low |
7049 | TYPE: int | |
7050 | DEFAULT: 900 | |
7051 | LOC: Config.Netdb.low | |
638402dd AJ |
7052 | DOC_START |
7053 | The low water mark for the ICMP measurement database. | |
7054 | ||
7055 | Note: high watermark controlled by netdb_high directive. | |
7056 | ||
7057 | These watermarks are counts, not percents. The defaults are | |
7058 | (low) 900 and (high) 1000. When the high water mark is | |
7059 | reached, database entries will be deleted until the low | |
7060 | mark is reached. | |
7061 | DOC_END | |
cccac0a2 | 7062 | |
7063 | NAME: netdb_high | |
7064 | TYPE: int | |
7065 | DEFAULT: 1000 | |
7066 | LOC: Config.Netdb.high | |
7067 | DOC_START | |
638402dd AJ |
7068 | The high water mark for the ICMP measurement database. |
7069 | ||
7070 | Note: low watermark controlled by netdb_low directive. | |
7071 | ||
7072 | These watermarks are counts, not percents. The defaults are | |
7073 | (low) 900 and (high) 1000. When the high water mark is | |
7074 | reached, database entries will be deleted until the low | |
7075 | mark is reached. | |
cccac0a2 | 7076 | DOC_END |
7077 | ||
cccac0a2 | 7078 | NAME: netdb_ping_period |
7079 | TYPE: time_t | |
7080 | LOC: Config.Netdb.period | |
7081 | DEFAULT: 5 minutes | |
7082 | DOC_START | |
7083 | The minimum period for measuring a site. There will be at | |
7084 | least this much delay between successive pings to the same | |
7085 | network. The default is five minutes. | |
7086 | DOC_END | |
7087 | ||
cccac0a2 | 7088 | NAME: query_icmp |
7089 | COMMENT: on|off | |
7090 | TYPE: onoff | |
7091 | DEFAULT: off | |
7092 | LOC: Config.onoff.query_icmp | |
7093 | DOC_START | |
7094 | If you want to ask your peers to include ICMP data in their ICP | |
7095 | replies, enable this option. | |
7096 | ||
7097 | If your peer has configured Squid (during compilation) with | |
7f7db318 | 7098 | '--enable-icmp' that peer will send ICMP pings to origin server |
7099 | sites of the URLs it receives. If you enable this option the | |
cccac0a2 | 7100 | ICP replies from that peer will include the ICMP data (if available). |
7101 | Then, when choosing a parent cache, Squid will choose the parent with | |
7102 | the minimal RTT to the origin server. When this happens, the | |
7103 | hierarchy field of the access.log will be | |
7104 | "CLOSEST_PARENT_MISS". This option is off by default. | |
7105 | DOC_END | |
7106 | ||
7107 | NAME: test_reachability | |
7108 | COMMENT: on|off | |
7109 | TYPE: onoff | |
7110 | DEFAULT: off | |
7111 | LOC: Config.onoff.test_reachability | |
7112 | DOC_START | |
7113 | When this is 'on', ICP MISS replies will be ICP_MISS_NOFETCH | |
7114 | instead of ICP_MISS if the target host is NOT in the ICMP | |
7115 | database, or has a zero RTT. | |
7116 | DOC_END | |
7117 | ||
5473c134 | 7118 | NAME: icp_query_timeout |
7119 | COMMENT: (msec) | |
7120 | DEFAULT: 0 | |
638402dd | 7121 | DEFAULT_DOC: Dynamic detection. |
5473c134 | 7122 | TYPE: int |
7123 | LOC: Config.Timeout.icp_query | |
4c3ef9b2 | 7124 | DOC_START |
5473c134 | 7125 | Normally Squid will automatically determine an optimal ICP |
7126 | query timeout value based on the round-trip-time of recent ICP | |
7127 | queries. If you want to override the value determined by | |
7128 | Squid, set this 'icp_query_timeout' to a non-zero value. This | |
7129 | value is specified in MILLISECONDS, so, to use a 2-second | |
7130 | timeout (the old default), you would write: | |
4c3ef9b2 | 7131 | |
5473c134 | 7132 | icp_query_timeout 2000 |
4c3ef9b2 | 7133 | DOC_END |
7134 | ||
5473c134 | 7135 | NAME: maximum_icp_query_timeout |
7136 | COMMENT: (msec) | |
7137 | DEFAULT: 2000 | |
7138 | TYPE: int | |
7139 | LOC: Config.Timeout.icp_query_max | |
cccac0a2 | 7140 | DOC_START |
5473c134 | 7141 | Normally the ICP query timeout is determined dynamically. But |
7142 | sometimes it can lead to very large values (say 5 seconds). | |
7143 | Use this option to put an upper limit on the dynamic timeout | |
7144 | value. Do NOT use this option to always use a fixed (instead | |
7145 | of a dynamic) timeout value. To set a fixed timeout see the | |
7146 | 'icp_query_timeout' directive. | |
cccac0a2 | 7147 | DOC_END |
7148 | ||
5473c134 | 7149 | NAME: minimum_icp_query_timeout |
7150 | COMMENT: (msec) | |
7151 | DEFAULT: 5 | |
7152 | TYPE: int | |
7153 | LOC: Config.Timeout.icp_query_min | |
cccac0a2 | 7154 | DOC_START |
5473c134 | 7155 | Normally the ICP query timeout is determined dynamically. But |
7156 | sometimes it can lead to very small timeouts, even lower than | |
7157 | the normal latency variance on your link due to traffic. | |
7158 | Use this option to put an lower limit on the dynamic timeout | |
7159 | value. Do NOT use this option to always use a fixed (instead | |
7160 | of a dynamic) timeout value. To set a fixed timeout see the | |
7161 | 'icp_query_timeout' directive. | |
cccac0a2 | 7162 | DOC_END |
7163 | ||
5473c134 | 7164 | NAME: background_ping_rate |
7165 | COMMENT: time-units | |
7166 | TYPE: time_t | |
7167 | DEFAULT: 10 seconds | |
7168 | LOC: Config.backgroundPingRate | |
cccac0a2 | 7169 | DOC_START |
5473c134 | 7170 | Controls how often the ICP pings are sent to siblings that |
7171 | have background-ping set. | |
cccac0a2 | 7172 | DOC_END |
7173 | ||
5473c134 | 7174 | COMMENT_START |
7175 | MULTICAST ICP OPTIONS | |
7176 | ----------------------------------------------------------------------------- | |
7177 | COMMENT_END | |
7178 | ||
7179 | NAME: mcast_groups | |
7180 | TYPE: wordlist | |
7181 | LOC: Config.mcast_group_list | |
8c01ada0 | 7182 | DEFAULT: none |
7183 | DOC_START | |
5473c134 | 7184 | This tag specifies a list of multicast groups which your server |
7185 | should join to receive multicasted ICP queries. | |
8c01ada0 | 7186 | |
5473c134 | 7187 | NOTE! Be very careful what you put here! Be sure you |
7188 | understand the difference between an ICP _query_ and an ICP | |
7189 | _reply_. This option is to be set only if you want to RECEIVE | |
7190 | multicast queries. Do NOT set this option to SEND multicast | |
7191 | ICP (use cache_peer for that). ICP replies are always sent via | |
7192 | unicast, so this option does not affect whether or not you will | |
7193 | receive replies from multicast group members. | |
8c01ada0 | 7194 | |
5473c134 | 7195 | You must be very careful to NOT use a multicast address which |
7196 | is already in use by another group of caches. | |
8c01ada0 | 7197 | |
5473c134 | 7198 | If you are unsure about multicast, please read the Multicast |
7199 | chapter in the Squid FAQ (http://www.squid-cache.org/FAQ/). | |
8c01ada0 | 7200 | |
5473c134 | 7201 | Usage: mcast_groups 239.128.16.128 224.0.1.20 |
8c01ada0 | 7202 | |
5473c134 | 7203 | By default, Squid doesn't listen on any multicast groups. |
7204 | DOC_END | |
8c01ada0 | 7205 | |
5473c134 | 7206 | NAME: mcast_miss_addr |
7207 | IFDEF: MULTICAST_MISS_STREAM | |
7208 | TYPE: address | |
7209 | LOC: Config.mcast_miss.addr | |
0eb08770 | 7210 | DEFAULT: no_addr |
638402dd | 7211 | DEFAULT_DOC: disabled. |
5473c134 | 7212 | DOC_START |
7213 | If you enable this option, every "cache miss" URL will | |
7214 | be sent out on the specified multicast address. | |
cccac0a2 | 7215 | |
5473c134 | 7216 | Do not enable this option unless you are are absolutely |
7217 | certain you understand what you are doing. | |
cccac0a2 | 7218 | DOC_END |
7219 | ||
5473c134 | 7220 | NAME: mcast_miss_ttl |
7221 | IFDEF: MULTICAST_MISS_STREAM | |
ae870270 | 7222 | TYPE: u_short |
5473c134 | 7223 | LOC: Config.mcast_miss.ttl |
7224 | DEFAULT: 16 | |
cccac0a2 | 7225 | DOC_START |
5473c134 | 7226 | This is the time-to-live value for packets multicasted |
7227 | when multicasting off cache miss URLs is enabled. By | |
7228 | default this is set to 'site scope', i.e. 16. | |
7229 | DOC_END | |
cccac0a2 | 7230 | |
5473c134 | 7231 | NAME: mcast_miss_port |
7232 | IFDEF: MULTICAST_MISS_STREAM | |
ae870270 | 7233 | TYPE: u_short |
5473c134 | 7234 | LOC: Config.mcast_miss.port |
7235 | DEFAULT: 3135 | |
7236 | DOC_START | |
7237 | This is the port number to be used in conjunction with | |
7238 | 'mcast_miss_addr'. | |
7239 | DOC_END | |
cccac0a2 | 7240 | |
5473c134 | 7241 | NAME: mcast_miss_encode_key |
7242 | IFDEF: MULTICAST_MISS_STREAM | |
7243 | TYPE: string | |
7244 | LOC: Config.mcast_miss.encode_key | |
7245 | DEFAULT: XXXXXXXXXXXXXXXX | |
7246 | DOC_START | |
7247 | The URLs that are sent in the multicast miss stream are | |
7248 | encrypted. This is the encryption key. | |
7249 | DOC_END | |
8c01ada0 | 7250 | |
5473c134 | 7251 | NAME: mcast_icp_query_timeout |
7252 | COMMENT: (msec) | |
7253 | DEFAULT: 2000 | |
7254 | TYPE: int | |
7255 | LOC: Config.Timeout.mcast_icp_query | |
7256 | DOC_START | |
7257 | For multicast peers, Squid regularly sends out ICP "probes" to | |
7258 | count how many other peers are listening on the given multicast | |
7259 | address. This value specifies how long Squid should wait to | |
7260 | count all the replies. The default is 2000 msec, or 2 | |
7261 | seconds. | |
cccac0a2 | 7262 | DOC_END |
7263 | ||
5473c134 | 7264 | COMMENT_START |
7265 | INTERNAL ICON OPTIONS | |
7266 | ----------------------------------------------------------------------------- | |
7267 | COMMENT_END | |
7268 | ||
cccac0a2 | 7269 | NAME: icon_directory |
7270 | TYPE: string | |
7271 | LOC: Config.icons.directory | |
7272 | DEFAULT: @DEFAULT_ICON_DIR@ | |
7273 | DOC_START | |
7274 | Where the icons are stored. These are normally kept in | |
7275 | @DEFAULT_ICON_DIR@ | |
7276 | DOC_END | |
7277 | ||
f024c970 | 7278 | NAME: global_internal_static |
7279 | TYPE: onoff | |
7280 | LOC: Config.onoff.global_internal_static | |
7281 | DEFAULT: on | |
7282 | DOC_START | |
7283 | This directive controls is Squid should intercept all requests for | |
7284 | /squid-internal-static/ no matter which host the URL is requesting | |
7285 | (default on setting), or if nothing special should be done for | |
7286 | such URLs (off setting). The purpose of this directive is to make | |
7287 | icons etc work better in complex cache hierarchies where it may | |
7288 | not always be possible for all corners in the cache mesh to reach | |
7289 | the server generating a directory listing. | |
7290 | DOC_END | |
7291 | ||
5473c134 | 7292 | NAME: short_icon_urls |
7293 | TYPE: onoff | |
7294 | LOC: Config.icons.use_short_names | |
7295 | DEFAULT: on | |
7296 | DOC_START | |
7297 | If this is enabled Squid will use short URLs for icons. | |
7298 | If disabled it will revert to the old behavior of including | |
7299 | it's own name and port in the URL. | |
7300 | ||
7301 | If you run a complex cache hierarchy with a mix of Squid and | |
7302 | other proxies you may need to disable this directive. | |
7303 | DOC_END | |
7304 | ||
7305 | COMMENT_START | |
7306 | ERROR PAGE OPTIONS | |
7307 | ----------------------------------------------------------------------------- | |
7308 | COMMENT_END | |
7309 | ||
7310 | NAME: error_directory | |
7311 | TYPE: string | |
7312 | LOC: Config.errorDirectory | |
43000484 | 7313 | DEFAULT: none |
638402dd | 7314 | DEFAULT_DOC: Send error pages in the clients preferred language |
5473c134 | 7315 | DOC_START |
7316 | If you wish to create your own versions of the default | |
43000484 AJ |
7317 | error files to customize them to suit your company copy |
7318 | the error/template files to another directory and point | |
7319 | this tag at them. | |
7320 | ||
7321 | WARNING: This option will disable multi-language support | |
7322 | on error pages if used. | |
5473c134 | 7323 | |
7324 | The squid developers are interested in making squid available in | |
7325 | a wide variety of languages. If you are making translations for a | |
43000484 | 7326 | language that Squid does not currently provide please consider |
5473c134 | 7327 | contributing your translation back to the project. |
43000484 AJ |
7328 | http://wiki.squid-cache.org/Translations |
7329 | ||
7330 | The squid developers working on translations are happy to supply drop-in | |
7331 | translated error files in exchange for any new language contributions. | |
7332 | DOC_END | |
7333 | ||
7334 | NAME: error_default_language | |
7335 | IFDEF: USE_ERR_LOCALES | |
7336 | TYPE: string | |
7337 | LOC: Config.errorDefaultLanguage | |
7338 | DEFAULT: none | |
638402dd | 7339 | DEFAULT_DOC: Generate English language pages. |
43000484 AJ |
7340 | DOC_START |
7341 | Set the default language which squid will send error pages in | |
7342 | if no existing translation matches the clients language | |
7343 | preferences. | |
7344 | ||
7345 | If unset (default) generic English will be used. | |
7346 | ||
7347 | The squid developers are interested in making squid available in | |
7348 | a wide variety of languages. If you are interested in making | |
7349 | translations for any language see the squid wiki for details. | |
7350 | http://wiki.squid-cache.org/Translations | |
5473c134 | 7351 | DOC_END |
7352 | ||
c411820c AJ |
7353 | NAME: error_log_languages |
7354 | IFDEF: USE_ERR_LOCALES | |
7355 | TYPE: onoff | |
7356 | LOC: Config.errorLogMissingLanguages | |
7357 | DEFAULT: on | |
7358 | DOC_START | |
7359 | Log to cache.log what languages users are attempting to | |
7360 | auto-negotiate for translations. | |
7361 | ||
7362 | Successful negotiations are not logged. Only failures | |
7363 | have meaning to indicate that Squid may need an upgrade | |
0c49f10e | 7364 | of its error page translations. |
c411820c AJ |
7365 | DOC_END |
7366 | ||
5b52cb6c AJ |
7367 | NAME: err_page_stylesheet |
7368 | TYPE: string | |
7369 | LOC: Config.errorStylesheet | |
7370 | DEFAULT: @DEFAULT_CONFIG_DIR@/errorpage.css | |
7371 | DOC_START | |
7372 | CSS Stylesheet to pattern the display of Squid default error pages. | |
7373 | ||
7374 | For information on CSS see http://www.w3.org/Style/CSS/ | |
7375 | DOC_END | |
7376 | ||
5473c134 | 7377 | NAME: err_html_text |
7378 | TYPE: eol | |
7379 | LOC: Config.errHtmlText | |
7380 | DEFAULT: none | |
7381 | DOC_START | |
7382 | HTML text to include in error messages. Make this a "mailto" | |
7383 | URL to your admin address, or maybe just a link to your | |
7384 | organizations Web page. | |
7385 | ||
7386 | To include this in your error messages, you must rewrite | |
7387 | the error template files (found in the "errors" directory). | |
7388 | Wherever you want the 'err_html_text' line to appear, | |
7389 | insert a %L tag in the error template file. | |
7390 | DOC_END | |
7391 | ||
7392 | NAME: email_err_data | |
7393 | COMMENT: on|off | |
7394 | TYPE: onoff | |
7395 | LOC: Config.onoff.emailErrData | |
7396 | DEFAULT: on | |
7397 | DOC_START | |
7398 | If enabled, information about the occurred error will be | |
7399 | included in the mailto links of the ERR pages (if %W is set) | |
7400 | so that the email body contains the data. | |
7401 | Syntax is <A HREF="mailto:%w%W">%w</A> | |
7402 | DOC_END | |
7403 | ||
7404 | NAME: deny_info | |
7405 | TYPE: denyinfo | |
7406 | LOC: Config.denyInfoList | |
7407 | DEFAULT: none | |
7408 | DOC_START | |
7409 | Usage: deny_info err_page_name acl | |
7410 | or deny_info http://... acl | |
43000484 | 7411 | or deny_info TCP_RESET acl |
5473c134 | 7412 | |
7413 | This can be used to return a ERR_ page for requests which | |
7414 | do not pass the 'http_access' rules. Squid remembers the last | |
7415 | acl it evaluated in http_access, and if a 'deny_info' line exists | |
7416 | for that ACL Squid returns a corresponding error page. | |
7417 | ||
7418 | The acl is typically the last acl on the http_access deny line which | |
7419 | denied access. The exceptions to this rule are: | |
7420 | - When Squid needs to request authentication credentials. It's then | |
7421 | the first authentication related acl encountered | |
7422 | - When none of the http_access lines matches. It's then the last | |
7423 | acl processed on the last http_access line. | |
3af10ac0 AR |
7424 | - When the decision to deny access was made by an adaptation service, |
7425 | the acl name is the corresponding eCAP or ICAP service_name. | |
5473c134 | 7426 | |
43000484 AJ |
7427 | NP: If providing your own custom error pages with error_directory |
7428 | you may also specify them by your custom file name: | |
7429 | Example: deny_info ERR_CUSTOM_ACCESS_DENIED bad_guys | |
5473c134 | 7430 | |
aed9a15b AJ |
7431 | By defaut Squid will send "403 Forbidden". A different 4xx or 5xx |
7432 | may be specified by prefixing the file name with the code and a colon. | |
7433 | e.g. 404:ERR_CUSTOM_ACCESS_DENIED | |
7434 | ||
5473c134 | 7435 | Alternatively you can tell Squid to reset the TCP connection |
7436 | by specifying TCP_RESET. | |
15b02e9a AJ |
7437 | |
7438 | Or you can specify an error URL or URL pattern. The browsers will | |
aed9a15b AJ |
7439 | get redirected to the specified URL after formatting tags have |
7440 | been replaced. Redirect will be done with 302 or 307 according to | |
7441 | HTTP/1.1 specs. A different 3xx code may be specified by prefixing | |
7442 | the URL. e.g. 303:http://example.com/ | |
15b02e9a AJ |
7443 | |
7444 | URL FORMAT TAGS: | |
7445 | %a - username (if available. Password NOT included) | |
7446 | %B - FTP path URL | |
7447 | %e - Error number | |
7448 | %E - Error description | |
7449 | %h - Squid hostname | |
7450 | %H - Request domain name | |
7451 | %i - Client IP Address | |
7452 | %M - Request Method | |
7453 | %o - Message result from external ACL helper | |
7454 | %p - Request Port number | |
7455 | %P - Request Protocol name | |
7456 | %R - Request URL path | |
7457 | %T - Timestamp in RFC 1123 format | |
7458 | %U - Full canonical URL from client | |
7459 | (HTTPS URLs terminate with *) | |
7460 | %u - Full canonical URL from client | |
7461 | %w - Admin email from squid.conf | |
e4a8468d | 7462 | %x - Error name |
15b02e9a AJ |
7463 | %% - Literal percent (%) code |
7464 | ||
5473c134 | 7465 | DOC_END |
7466 | ||
7467 | COMMENT_START | |
7468 | OPTIONS INFLUENCING REQUEST FORWARDING | |
7469 | ----------------------------------------------------------------------------- | |
7470 | COMMENT_END | |
7471 | ||
7472 | NAME: nonhierarchical_direct | |
e72a0ec0 | 7473 | TYPE: onoff |
5473c134 | 7474 | LOC: Config.onoff.nonhierarchical_direct |
e72a0ec0 | 7475 | DEFAULT: on |
7476 | DOC_START | |
5473c134 | 7477 | By default, Squid will send any non-hierarchical requests |
7478 | (matching hierarchy_stoplist or not cacheable request type) direct | |
7479 | to origin servers. | |
e72a0ec0 | 7480 | |
638402dd | 7481 | When this is set to "off", Squid will prefer to send these |
5473c134 | 7482 | requests to parents. |
0b0cfcf2 | 7483 | |
5473c134 | 7484 | Note that in most configurations, by turning this off you will only |
7485 | add latency to these request without any improvement in global hit | |
7486 | ratio. | |
0b0cfcf2 | 7487 | |
638402dd AJ |
7488 | This option only sets a preference. If the parent is unavailable a |
7489 | direct connection to the origin server may still be attempted. To | |
7490 | completely prevent direct connections use never_direct. | |
8d6275c0 | 7491 | DOC_END |
0b0cfcf2 | 7492 | |
5473c134 | 7493 | NAME: prefer_direct |
8d6275c0 | 7494 | TYPE: onoff |
5473c134 | 7495 | LOC: Config.onoff.prefer_direct |
8d6275c0 | 7496 | DEFAULT: off |
7497 | DOC_START | |
5473c134 | 7498 | Normally Squid tries to use parents for most requests. If you for some |
7499 | reason like it to first try going direct and only use a parent if | |
7500 | going direct fails set this to on. | |
0b0cfcf2 | 7501 | |
5473c134 | 7502 | By combining nonhierarchical_direct off and prefer_direct on you |
7503 | can set up Squid to use a parent as a backup path if going direct | |
7504 | fails. | |
7505 | ||
7506 | Note: If you want Squid to use parents for all requests see | |
7507 | the never_direct directive. prefer_direct only modifies how Squid | |
7508 | acts on cacheable requests. | |
cccac0a2 | 7509 | DOC_END |
7510 | ||
96598f93 AJ |
7511 | NAME: cache_miss_revalidate |
7512 | COMMENT: on|off | |
7513 | TYPE: onoff | |
7514 | DEFAULT: on | |
7515 | LOC: Config.onoff.cache_miss_revalidate | |
7516 | DOC_START | |
7517 | Whether Squid on cache MISS will pass client revalidation requests | |
7518 | to the server or tries to fetch new content for caching. | |
7519 | This is useful while the cache is mostly empty to more quickly | |
7520 | have the cache populated. | |
7521 | ||
7522 | When set to 'on' (default), Squid will pass all client If-* headers | |
7523 | to the server. | |
7524 | ||
7525 | When set to 'off' and if the request is cacheable, Squid will | |
7526 | remove the clients If-Modified-Since and If-None-Match headers from | |
7527 | the request sent to the server. | |
7528 | DOC_END | |
7529 | ||
5473c134 | 7530 | NAME: always_direct |
8d6275c0 | 7531 | TYPE: acl_access |
5473c134 | 7532 | LOC: Config.accessList.AlwaysDirect |
0b0cfcf2 | 7533 | DEFAULT: none |
638402dd | 7534 | DEFAULT_DOC: Prevent any cache_peer being used for this request. |
0b0cfcf2 | 7535 | DOC_START |
5473c134 | 7536 | Usage: always_direct allow|deny [!]aclname ... |
0b0cfcf2 | 7537 | |
5473c134 | 7538 | Here you can use ACL elements to specify requests which should |
7539 | ALWAYS be forwarded by Squid to the origin servers without using | |
7540 | any peers. For example, to always directly forward requests for | |
7541 | local servers ignoring any parents or siblings you may have use | |
7542 | something like: | |
0b0cfcf2 | 7543 | |
5473c134 | 7544 | acl local-servers dstdomain my.domain.net |
7545 | always_direct allow local-servers | |
0b0cfcf2 | 7546 | |
5473c134 | 7547 | To always forward FTP requests directly, use |
f16fbc82 | 7548 | |
5473c134 | 7549 | acl FTP proto FTP |
7550 | always_direct allow FTP | |
cccac0a2 | 7551 | |
5473c134 | 7552 | NOTE: There is a similar, but opposite option named |
7553 | 'never_direct'. You need to be aware that "always_direct deny | |
7554 | foo" is NOT the same thing as "never_direct allow foo". You | |
7555 | may need to use a deny rule to exclude a more-specific case of | |
7556 | some other rule. Example: | |
8d6275c0 | 7557 | |
5473c134 | 7558 | acl local-external dstdomain external.foo.net |
7559 | acl local-servers dstdomain .foo.net | |
7560 | always_direct deny local-external | |
7561 | always_direct allow local-servers | |
8d6275c0 | 7562 | |
5473c134 | 7563 | NOTE: If your goal is to make the client forward the request |
7564 | directly to the origin server bypassing Squid then this needs | |
7565 | to be done in the client configuration. Squid configuration | |
7566 | can only tell Squid how Squid should fetch the object. | |
8d6275c0 | 7567 | |
5473c134 | 7568 | NOTE: This directive is not related to caching. The replies |
7569 | is cached as usual even if you use always_direct. To not cache | |
b3567eb5 | 7570 | the replies see the 'cache' directive. |
5473c134 | 7571 | |
b3567eb5 FC |
7572 | This clause supports both fast and slow acl types. |
7573 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
cccac0a2 | 7574 | DOC_END |
0976f8db | 7575 | |
5473c134 | 7576 | NAME: never_direct |
7577 | TYPE: acl_access | |
7578 | LOC: Config.accessList.NeverDirect | |
7579 | DEFAULT: none | |
638402dd | 7580 | DEFAULT_DOC: Allow DNS results to be used for this request. |
8d6275c0 | 7581 | DOC_START |
5473c134 | 7582 | Usage: never_direct allow|deny [!]aclname ... |
7583 | ||
7584 | never_direct is the opposite of always_direct. Please read | |
7585 | the description for always_direct if you have not already. | |
7586 | ||
7587 | With 'never_direct' you can use ACL elements to specify | |
7588 | requests which should NEVER be forwarded directly to origin | |
7589 | servers. For example, to force the use of a proxy for all | |
7590 | requests, except those in your local domain use something like: | |
7591 | ||
7592 | acl local-servers dstdomain .foo.net | |
5473c134 | 7593 | never_direct deny local-servers |
7594 | never_direct allow all | |
7595 | ||
7596 | or if Squid is inside a firewall and there are local intranet | |
7597 | servers inside the firewall use something like: | |
7598 | ||
7599 | acl local-intranet dstdomain .foo.net | |
7600 | acl local-external dstdomain external.foo.net | |
7601 | always_direct deny local-external | |
7602 | always_direct allow local-intranet | |
7603 | never_direct allow all | |
7604 | ||
b3567eb5 FC |
7605 | This clause supports both fast and slow acl types. |
7606 | See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details. | |
8d6275c0 | 7607 | DOC_END |
0976f8db | 7608 | |
5473c134 | 7609 | COMMENT_START |
7610 | ADVANCED NETWORKING OPTIONS | |
7611 | ----------------------------------------------------------------------------- | |
7612 | COMMENT_END | |
7613 | ||
65d448bc | 7614 | NAME: incoming_udp_average incoming_icp_average |
cccac0a2 | 7615 | TYPE: int |
7616 | DEFAULT: 6 | |
65d448bc AJ |
7617 | LOC: Config.comm_incoming.udp.average |
7618 | DOC_START | |
7619 | Heavy voodoo here. I can't even believe you are reading this. | |
7620 | Are you crazy? Don't even think about adjusting these unless | |
7621 | you understand the algorithms in comm_select.c first! | |
7622 | DOC_END | |
cccac0a2 | 7623 | |
65d448bc | 7624 | NAME: incoming_tcp_average incoming_http_average |
cccac0a2 | 7625 | TYPE: int |
7626 | DEFAULT: 4 | |
65d448bc AJ |
7627 | LOC: Config.comm_incoming.tcp.average |
7628 | DOC_START | |
7629 | Heavy voodoo here. I can't even believe you are reading this. | |
7630 | Are you crazy? Don't even think about adjusting these unless | |
7631 | you understand the algorithms in comm_select.c first! | |
7632 | DOC_END | |
cccac0a2 | 7633 | |
7634 | NAME: incoming_dns_average | |
7635 | TYPE: int | |
7636 | DEFAULT: 4 | |
65d448bc AJ |
7637 | LOC: Config.comm_incoming.dns.average |
7638 | DOC_START | |
7639 | Heavy voodoo here. I can't even believe you are reading this. | |
7640 | Are you crazy? Don't even think about adjusting these unless | |
7641 | you understand the algorithms in comm_select.c first! | |
7642 | DOC_END | |
cccac0a2 | 7643 | |
65d448bc | 7644 | NAME: min_udp_poll_cnt min_icp_poll_cnt |
cccac0a2 | 7645 | TYPE: int |
7646 | DEFAULT: 8 | |
65d448bc AJ |
7647 | LOC: Config.comm_incoming.udp.min_poll |
7648 | DOC_START | |
7649 | Heavy voodoo here. I can't even believe you are reading this. | |
7650 | Are you crazy? Don't even think about adjusting these unless | |
7651 | you understand the algorithms in comm_select.c first! | |
7652 | DOC_END | |
cccac0a2 | 7653 | |
7654 | NAME: min_dns_poll_cnt | |
7655 | TYPE: int | |
7656 | DEFAULT: 8 | |
65d448bc AJ |
7657 | LOC: Config.comm_incoming.dns.min_poll |
7658 | DOC_START | |
7659 | Heavy voodoo here. I can't even believe you are reading this. | |
7660 | Are you crazy? Don't even think about adjusting these unless | |
7661 | you understand the algorithms in comm_select.c first! | |
7662 | DOC_END | |
cccac0a2 | 7663 | |
65d448bc | 7664 | NAME: min_tcp_poll_cnt min_http_poll_cnt |
cccac0a2 | 7665 | TYPE: int |
7666 | DEFAULT: 8 | |
65d448bc | 7667 | LOC: Config.comm_incoming.tcp.min_poll |
cccac0a2 | 7668 | DOC_START |
5473c134 | 7669 | Heavy voodoo here. I can't even believe you are reading this. |
7670 | Are you crazy? Don't even think about adjusting these unless | |
7671 | you understand the algorithms in comm_select.c first! | |
7672 | DOC_END | |
7673 | ||
7674 | NAME: accept_filter | |
5473c134 | 7675 | TYPE: string |
7676 | DEFAULT: none | |
7677 | LOC: Config.accept_filter | |
7678 | DOC_START | |
0b4d4be5 | 7679 | FreeBSD: |
7680 | ||
5473c134 | 7681 | The name of an accept(2) filter to install on Squid's |
7682 | listen socket(s). This feature is perhaps specific to | |
7683 | FreeBSD and requires support in the kernel. | |
7684 | ||
7685 | The 'httpready' filter delays delivering new connections | |
2324cda2 | 7686 | to Squid until a full HTTP request has been received. |
0b4d4be5 | 7687 | See the accf_http(9) man page for details. |
7688 | ||
7689 | The 'dataready' filter delays delivering new connections | |
7690 | to Squid until there is some data to process. | |
7691 | See the accf_dataready(9) man page for details. | |
7692 | ||
7693 | Linux: | |
7694 | ||
7695 | The 'data' filter delays delivering of new connections | |
7696 | to Squid until there is some data to process by TCP_ACCEPT_DEFER. | |
7697 | You may optionally specify a number of seconds to wait by | |
7698 | 'data=N' where N is the number of seconds. Defaults to 30 | |
7699 | if not specified. See the tcp(7) man page for details. | |
5473c134 | 7700 | EXAMPLE: |
0b4d4be5 | 7701 | # FreeBSD |
5473c134 | 7702 | accept_filter httpready |
0b4d4be5 | 7703 | # Linux |
7704 | accept_filter data | |
5473c134 | 7705 | DOC_END |
7706 | ||
ab2ecb0e AJ |
7707 | NAME: client_ip_max_connections |
7708 | TYPE: int | |
7709 | LOC: Config.client_ip_max_connections | |
7710 | DEFAULT: -1 | |
638402dd | 7711 | DEFAULT_DOC: No limit. |
ab2ecb0e AJ |
7712 | DOC_START |
7713 | Set an absolute limit on the number of connections a single | |
7714 | client IP can use. Any more than this and Squid will begin to drop | |
7715 | new connections from the client until it closes some links. | |
7716 | ||
7717 | Note that this is a global limit. It affects all HTTP, HTCP, Gopher and FTP | |
7718 | connections from the client. For finer control use the ACL access controls. | |
7719 | ||
7720 | Requires client_db to be enabled (the default). | |
7721 | ||
7722 | WARNING: This may noticably slow down traffic received via external proxies | |
7723 | or NAT devices and cause them to rebound error messages back to their clients. | |
7724 | DOC_END | |
7725 | ||
5473c134 | 7726 | NAME: tcp_recv_bufsize |
7727 | COMMENT: (bytes) | |
7728 | TYPE: b_size_t | |
7729 | DEFAULT: 0 bytes | |
638402dd | 7730 | DEFAULT_DOC: Use operating system TCP defaults. |
5473c134 | 7731 | LOC: Config.tcpRcvBufsz |
7732 | DOC_START | |
7733 | Size of receive buffer to set for TCP sockets. Probably just | |
638402dd AJ |
7734 | as easy to change your kernel's default. |
7735 | Omit from squid.conf to use the default buffer size. | |
5473c134 | 7736 | DOC_END |
7737 | ||
7738 | COMMENT_START | |
7739 | ICAP OPTIONS | |
7740 | ----------------------------------------------------------------------------- | |
7741 | COMMENT_END | |
7742 | ||
7743 | NAME: icap_enable | |
7744 | TYPE: onoff | |
7745 | IFDEF: ICAP_CLIENT | |
7746 | COMMENT: on|off | |
26cc52cb | 7747 | LOC: Adaptation::Icap::TheConfig.onoff |
5473c134 | 7748 | DEFAULT: off |
7749 | DOC_START | |
53e738c6 | 7750 | If you want to enable the ICAP module support, set this to on. |
5473c134 | 7751 | DOC_END |
7752 | ||
7753 | NAME: icap_connect_timeout | |
7754 | TYPE: time_t | |
7755 | DEFAULT: none | |
26cc52cb | 7756 | LOC: Adaptation::Icap::TheConfig.connect_timeout_raw |
5473c134 | 7757 | IFDEF: ICAP_CLIENT |
7758 | DOC_START | |
7759 | This parameter specifies how long to wait for the TCP connect to | |
7760 | the requested ICAP server to complete before giving up and either | |
7761 | terminating the HTTP transaction or bypassing the failure. | |
7762 | ||
7763 | The default for optional services is peer_connect_timeout. | |
7764 | The default for essential services is connect_timeout. | |
7765 | If this option is explicitly set, its value applies to all services. | |
7766 | DOC_END | |
7767 | ||
7768 | NAME: icap_io_timeout | |
7769 | COMMENT: time-units | |
7770 | TYPE: time_t | |
7771 | DEFAULT: none | |
638402dd | 7772 | DEFAULT_DOC: Use read_timeout. |
26cc52cb | 7773 | LOC: Adaptation::Icap::TheConfig.io_timeout_raw |
5473c134 | 7774 | IFDEF: ICAP_CLIENT |
7775 | DOC_START | |
7776 | This parameter specifies how long to wait for an I/O activity on | |
7777 | an established, active ICAP connection before giving up and | |
7778 | either terminating the HTTP transaction or bypassing the | |
7779 | failure. | |
5473c134 | 7780 | DOC_END |
7781 | ||
7782 | NAME: icap_service_failure_limit | |
8277060a CT |
7783 | COMMENT: limit [in memory-depth time-units] |
7784 | TYPE: icap_service_failure_limit | |
5473c134 | 7785 | IFDEF: ICAP_CLIENT |
8277060a | 7786 | LOC: Adaptation::Icap::TheConfig |
5473c134 | 7787 | DEFAULT: 10 |
7788 | DOC_START | |
7789 | The limit specifies the number of failures that Squid tolerates | |
7790 | when establishing a new TCP connection with an ICAP service. If | |
7791 | the number of failures exceeds the limit, the ICAP service is | |
7792 | not used for new ICAP requests until it is time to refresh its | |
8277060a | 7793 | OPTIONS. |
5473c134 | 7794 | |
7795 | A negative value disables the limit. Without the limit, an ICAP | |
7796 | service will not be considered down due to connectivity failures | |
7797 | between ICAP OPTIONS requests. | |
8277060a CT |
7798 | |
7799 | Squid forgets ICAP service failures older than the specified | |
7800 | value of memory-depth. The memory fading algorithm | |
7801 | is approximate because Squid does not remember individual | |
7802 | errors but groups them instead, splitting the option | |
7803 | value into ten time slots of equal length. | |
7804 | ||
7805 | When memory-depth is 0 and by default this option has no | |
7806 | effect on service failure expiration. | |
7807 | ||
7808 | Squid always forgets failures when updating service settings | |
7809 | using an ICAP OPTIONS transaction, regardless of this option | |
7810 | setting. | |
7811 | ||
7812 | For example, | |
7813 | # suspend service usage after 10 failures in 5 seconds: | |
7814 | icap_service_failure_limit 10 in 5 seconds | |
cccac0a2 | 7815 | DOC_END |
7816 | ||
5473c134 | 7817 | NAME: icap_service_revival_delay |
cccac0a2 | 7818 | TYPE: int |
5473c134 | 7819 | IFDEF: ICAP_CLIENT |
26cc52cb | 7820 | LOC: Adaptation::Icap::TheConfig.service_revival_delay |
5473c134 | 7821 | DEFAULT: 180 |
cccac0a2 | 7822 | DOC_START |
5473c134 | 7823 | The delay specifies the number of seconds to wait after an ICAP |
7824 | OPTIONS request failure before requesting the options again. The | |
7825 | failed ICAP service is considered "down" until fresh OPTIONS are | |
7826 | fetched. | |
cccac0a2 | 7827 | |
5473c134 | 7828 | The actual delay cannot be smaller than the hardcoded minimum |
7829 | delay of 30 seconds. | |
cccac0a2 | 7830 | DOC_END |
7831 | ||
5473c134 | 7832 | NAME: icap_preview_enable |
cccac0a2 | 7833 | TYPE: onoff |
5473c134 | 7834 | IFDEF: ICAP_CLIENT |
7835 | COMMENT: on|off | |
26cc52cb | 7836 | LOC: Adaptation::Icap::TheConfig.preview_enable |
ac7a62f9 | 7837 | DEFAULT: on |
cccac0a2 | 7838 | DOC_START |
ac7a62f9 | 7839 | The ICAP Preview feature allows the ICAP server to handle the |
7840 | HTTP message by looking only at the beginning of the message body | |
7841 | or even without receiving the body at all. In some environments, | |
7842 | previews greatly speedup ICAP processing. | |
7843 | ||
7844 | During an ICAP OPTIONS transaction, the server may tell Squid what | |
7845 | HTTP messages should be previewed and how big the preview should be. | |
7846 | Squid will not use Preview if the server did not request one. | |
7847 | ||
7848 | To disable ICAP Preview for all ICAP services, regardless of | |
7849 | individual ICAP server OPTIONS responses, set this option to "off". | |
7850 | Example: | |
7851 | icap_preview_enable off | |
cccac0a2 | 7852 | DOC_END |
7853 | ||
5473c134 | 7854 | NAME: icap_preview_size |
7855 | TYPE: int | |
7856 | IFDEF: ICAP_CLIENT | |
26cc52cb | 7857 | LOC: Adaptation::Icap::TheConfig.preview_size |
5473c134 | 7858 | DEFAULT: -1 |
638402dd | 7859 | DEFAULT_DOC: No preview sent. |
cccac0a2 | 7860 | DOC_START |
53e738c6 | 7861 | The default size of preview data to be sent to the ICAP server. |
638402dd | 7862 | This value might be overwritten on a per server basis by OPTIONS requests. |
cccac0a2 | 7863 | DOC_END |
7864 | ||
83c51da9 CT |
7865 | NAME: icap_206_enable |
7866 | TYPE: onoff | |
7867 | IFDEF: ICAP_CLIENT | |
7868 | COMMENT: on|off | |
7869 | LOC: Adaptation::Icap::TheConfig.allow206_enable | |
7870 | DEFAULT: on | |
7871 | DOC_START | |
7872 | 206 (Partial Content) responses is an ICAP extension that allows the | |
7873 | ICAP agents to optionally combine adapted and original HTTP message | |
7874 | content. The decision to combine is postponed until the end of the | |
7875 | ICAP response. Squid supports Partial Content extension by default. | |
7876 | ||
7877 | Activation of the Partial Content extension is negotiated with each | |
7878 | ICAP service during OPTIONS exchange. Most ICAP servers should handle | |
7879 | negotation correctly even if they do not support the extension, but | |
7880 | some might fail. To disable Partial Content support for all ICAP | |
7881 | services and to avoid any negotiation, set this option to "off". | |
7882 | ||
7883 | Example: | |
7884 | icap_206_enable off | |
7885 | DOC_END | |
7886 | ||
5473c134 | 7887 | NAME: icap_default_options_ttl |
7888 | TYPE: int | |
7889 | IFDEF: ICAP_CLIENT | |
26cc52cb | 7890 | LOC: Adaptation::Icap::TheConfig.default_options_ttl |
5473c134 | 7891 | DEFAULT: 60 |
cccac0a2 | 7892 | DOC_START |
53e738c6 | 7893 | The default TTL value for ICAP OPTIONS responses that don't have |
5473c134 | 7894 | an Options-TTL header. |
cccac0a2 | 7895 | DOC_END |
7896 | ||
5473c134 | 7897 | NAME: icap_persistent_connections |
7898 | TYPE: onoff | |
7899 | IFDEF: ICAP_CLIENT | |
7900 | COMMENT: on|off | |
26cc52cb | 7901 | LOC: Adaptation::Icap::TheConfig.reuse_connections |
5473c134 | 7902 | DEFAULT: on |
cccac0a2 | 7903 | DOC_START |
5473c134 | 7904 | Whether or not Squid should use persistent connections to |
7905 | an ICAP server. | |
cccac0a2 | 7906 | DOC_END |
7907 | ||
22fff3bf | 7908 | NAME: adaptation_send_client_ip icap_send_client_ip |
5473c134 | 7909 | TYPE: onoff |
22fff3bf | 7910 | IFDEF: USE_ADAPTATION |
5473c134 | 7911 | COMMENT: on|off |
22fff3bf | 7912 | LOC: Adaptation::Config::send_client_ip |
5473c134 | 7913 | DEFAULT: off |
cccac0a2 | 7914 | DOC_START |
ea3ae478 AR |
7915 | If enabled, Squid shares HTTP client IP information with adaptation |
7916 | services. For ICAP, Squid adds the X-Client-IP header to ICAP requests. | |
7917 | For eCAP, Squid sets the libecap::metaClientIp transaction option. | |
7918 | ||
7919 | See also: adaptation_uses_indirect_client | |
cccac0a2 | 7920 | DOC_END |
7921 | ||
22fff3bf | 7922 | NAME: adaptation_send_username icap_send_client_username |
5473c134 | 7923 | TYPE: onoff |
22fff3bf | 7924 | IFDEF: USE_ADAPTATION |
5473c134 | 7925 | COMMENT: on|off |
22fff3bf | 7926 | LOC: Adaptation::Config::send_username |
5473c134 | 7927 | DEFAULT: off |
cccac0a2 | 7928 | DOC_START |
5473c134 | 7929 | This sends authenticated HTTP client username (if available) to |
22fff3bf AR |
7930 | the adaptation service. |
7931 | ||
7932 | For ICAP, the username value is encoded based on the | |
5473c134 | 7933 | icap_client_username_encode option and is sent using the header |
7934 | specified by the icap_client_username_header option. | |
cccac0a2 | 7935 | DOC_END |
7936 | ||
5473c134 | 7937 | NAME: icap_client_username_header |
cccac0a2 | 7938 | TYPE: string |
5473c134 | 7939 | IFDEF: ICAP_CLIENT |
26cc52cb | 7940 | LOC: Adaptation::Icap::TheConfig.client_username_header |
5473c134 | 7941 | DEFAULT: X-Client-Username |
cccac0a2 | 7942 | DOC_START |
db49f682 | 7943 | ICAP request header name to use for adaptation_send_username. |
cccac0a2 | 7944 | DOC_END |
7945 | ||
5473c134 | 7946 | NAME: icap_client_username_encode |
cccac0a2 | 7947 | TYPE: onoff |
5473c134 | 7948 | IFDEF: ICAP_CLIENT |
7949 | COMMENT: on|off | |
26cc52cb | 7950 | LOC: Adaptation::Icap::TheConfig.client_username_encode |
5473c134 | 7951 | DEFAULT: off |
cccac0a2 | 7952 | DOC_START |
5473c134 | 7953 | Whether to base64 encode the authenticated client username. |
cccac0a2 | 7954 | DOC_END |
7955 | ||
5473c134 | 7956 | NAME: icap_service |
7957 | TYPE: icap_service_type | |
7958 | IFDEF: ICAP_CLIENT | |
26cc52cb | 7959 | LOC: Adaptation::Icap::TheConfig |
5473c134 | 7960 | DEFAULT: none |
cccac0a2 | 7961 | DOC_START |
a22e6cd3 | 7962 | Defines a single ICAP service using the following format: |
cccac0a2 | 7963 | |
c25c2836 | 7964 | icap_service id vectoring_point uri [option ...] |
7d90757b | 7965 | |
c25c2836 CT |
7966 | id: ID |
7967 | an opaque identifier or name which is used to direct traffic to | |
7968 | this specific service. Must be unique among all adaptation | |
7969 | services in squid.conf. | |
a22e6cd3 AR |
7970 | |
7971 | vectoring_point: reqmod_precache|reqmod_postcache|respmod_precache|respmod_postcache | |
f3db09e2 | 7972 | This specifies at which point of transaction processing the |
7973 | ICAP service should be activated. *_postcache vectoring points | |
7974 | are not yet supported. | |
a22e6cd3 | 7975 | |
c25c2836 | 7976 | uri: icap://servername:port/servicepath |
a22e6cd3 AR |
7977 | ICAP server and service location. |
7978 | ||
7979 | ICAP does not allow a single service to handle both REQMOD and RESPMOD | |
7980 | transactions. Squid does not enforce that requirement. You can specify | |
7981 | services with the same service_url and different vectoring_points. You | |
7982 | can even specify multiple identical services as long as their | |
7983 | service_names differ. | |
7984 | ||
3caa16d2 AR |
7985 | To activate a service, use the adaptation_access directive. To group |
7986 | services, use adaptation_service_chain and adaptation_service_set. | |
a22e6cd3 AR |
7987 | |
7988 | Service options are separated by white space. ICAP services support | |
7989 | the following name=value options: | |
7990 | ||
7991 | bypass=on|off|1|0 | |
7992 | If set to 'on' or '1', the ICAP service is treated as | |
7993 | optional. If the service cannot be reached or malfunctions, | |
7994 | Squid will try to ignore any errors and process the message as | |
7995 | if the service was not enabled. No all ICAP errors can be | |
7996 | bypassed. If set to 0, the ICAP service is treated as | |
7997 | essential and all ICAP errors will result in an error page | |
7998 | returned to the HTTP client. | |
7999 | ||
8000 | Bypass is off by default: services are treated as essential. | |
8001 | ||
8002 | routing=on|off|1|0 | |
8003 | If set to 'on' or '1', the ICAP service is allowed to | |
8004 | dynamically change the current message adaptation plan by | |
8005 | returning a chain of services to be used next. The services | |
8006 | are specified using the X-Next-Services ICAP response header | |
8007 | value, formatted as a comma-separated list of service names. | |
e2851fe7 AR |
8008 | Each named service should be configured in squid.conf. Other |
8009 | services are ignored. An empty X-Next-Services value results | |
8010 | in an empty plan which ends the current adaptation. | |
8011 | ||
8012 | Dynamic adaptation plan may cross or cover multiple supported | |
8013 | vectoring points in their natural processing order. | |
a22e6cd3 AR |
8014 | |
8015 | Routing is not allowed by default: the ICAP X-Next-Services | |
8016 | response header is ignored. | |
8017 | ||
e6713f4e AJ |
8018 | ipv6=on|off |
8019 | Only has effect on split-stack systems. The default on those systems | |
8020 | is to use IPv4-only connections. When set to 'on' this option will | |
8021 | make Squid use IPv6-only connections to contact this ICAP service. | |
8022 | ||
2dba5b8e CT |
8023 | on-overload=block|bypass|wait|force |
8024 | If the service Max-Connections limit has been reached, do | |
8025 | one of the following for each new ICAP transaction: | |
8026 | * block: send an HTTP error response to the client | |
8027 | * bypass: ignore the "over-connected" ICAP service | |
8028 | * wait: wait (in a FIFO queue) for an ICAP connection slot | |
8029 | * force: proceed, ignoring the Max-Connections limit | |
8030 | ||
8031 | In SMP mode with N workers, each worker assumes the service | |
8032 | connection limit is Max-Connections/N, even though not all | |
8033 | workers may use a given service. | |
8034 | ||
8035 | The default value is "bypass" if service is bypassable, | |
8036 | otherwise it is set to "wait". | |
8037 | ||
8038 | ||
8039 | max-conn=number | |
8040 | Use the given number as the Max-Connections limit, regardless | |
8041 | of the Max-Connections value given by the service, if any. | |
8042 | ||
a22e6cd3 AR |
8043 | Older icap_service format without optional named parameters is |
8044 | deprecated but supported for backward compatibility. | |
5473c134 | 8045 | |
5473c134 | 8046 | Example: |
c25c2836 CT |
8047 | icap_service svcBlocker reqmod_precache icap://icap1.mydomain.net:1344/reqmod bypass=0 |
8048 | icap_service svcLogger reqmod_precache icap://icap2.mydomain.net:1344/respmod routing=on | |
cccac0a2 | 8049 | DOC_END |
8050 | ||
5473c134 | 8051 | NAME: icap_class |
8052 | TYPE: icap_class_type | |
8053 | IFDEF: ICAP_CLIENT | |
21a26d31 | 8054 | LOC: none |
5473c134 | 8055 | DEFAULT: none |
cccac0a2 | 8056 | DOC_START |
a22e6cd3 | 8057 | This deprecated option was documented to define an ICAP service |
62c7f90e AR |
8058 | chain, even though it actually defined a set of similar, redundant |
8059 | services, and the chains were not supported. | |
5473c134 | 8060 | |
62c7f90e | 8061 | To define a set of redundant services, please use the |
a22e6cd3 AR |
8062 | adaptation_service_set directive. For service chains, use |
8063 | adaptation_service_chain. | |
cccac0a2 | 8064 | DOC_END |
8065 | ||
5473c134 | 8066 | NAME: icap_access |
8067 | TYPE: icap_access_type | |
8068 | IFDEF: ICAP_CLIENT | |
21a26d31 | 8069 | LOC: none |
cccac0a2 | 8070 | DEFAULT: none |
cccac0a2 | 8071 | DOC_START |
a22e6cd3 | 8072 | This option is deprecated. Please use adaptation_access, which |
62c7f90e AR |
8073 | has the same ICAP functionality, but comes with better |
8074 | documentation, and eCAP support. | |
cccac0a2 | 8075 | DOC_END |
8076 | ||
57afc994 AR |
8077 | COMMENT_START |
8078 | eCAP OPTIONS | |
8079 | ----------------------------------------------------------------------------- | |
8080 | COMMENT_END | |
8081 | ||
21a26d31 AR |
8082 | NAME: ecap_enable |
8083 | TYPE: onoff | |
8084 | IFDEF: USE_ECAP | |
8085 | COMMENT: on|off | |
574b508c | 8086 | LOC: Adaptation::Ecap::TheConfig.onoff |
21a26d31 AR |
8087 | DEFAULT: off |
8088 | DOC_START | |
8089 | Controls whether eCAP support is enabled. | |
8090 | DOC_END | |
8091 | ||
8092 | NAME: ecap_service | |
8093 | TYPE: ecap_service_type | |
8094 | IFDEF: USE_ECAP | |
574b508c | 8095 | LOC: Adaptation::Ecap::TheConfig |
21a26d31 AR |
8096 | DEFAULT: none |
8097 | DOC_START | |
8098 | Defines a single eCAP service | |
8099 | ||
c25c2836 | 8100 | ecap_service id vectoring_point uri [option ...] |
21a26d31 | 8101 | |
c25c2836 CT |
8102 | id: ID |
8103 | an opaque identifier or name which is used to direct traffic to | |
8104 | this specific service. Must be unique among all adaptation | |
8105 | services in squid.conf. | |
8106 | ||
8107 | vectoring_point: reqmod_precache|reqmod_postcache|respmod_precache|respmod_postcache | |
21a26d31 AR |
8108 | This specifies at which point of transaction processing the |
8109 | eCAP service should be activated. *_postcache vectoring points | |
8110 | are not yet supported. | |
c25c2836 CT |
8111 | |
8112 | uri: ecap://vendor/service_name?custom&cgi=style¶meters=optional | |
8113 | Squid uses the eCAP service URI to match this configuration | |
8114 | line with one of the dynamically loaded services. Each loaded | |
8115 | eCAP service must have a unique URI. Obtain the right URI from | |
8116 | the service provider. | |
8117 | ||
3caa16d2 AR |
8118 | To activate a service, use the adaptation_access directive. To group |
8119 | services, use adaptation_service_chain and adaptation_service_set. | |
c25c2836 CT |
8120 | |
8121 | Service options are separated by white space. eCAP services support | |
8122 | the following name=value options: | |
8123 | ||
8124 | bypass=on|off|1|0 | |
8125 | If set to 'on' or '1', the eCAP service is treated as optional. | |
8126 | If the service cannot be reached or malfunctions, Squid will try | |
8127 | to ignore any errors and process the message as if the service | |
21a26d31 | 8128 | was not enabled. No all eCAP errors can be bypassed. |
c25c2836 CT |
8129 | If set to 'off' or '0', the eCAP service is treated as essential |
8130 | and all eCAP errors will result in an error page returned to the | |
21a26d31 | 8131 | HTTP client. |
c25c2836 CT |
8132 | |
8133 | Bypass is off by default: services are treated as essential. | |
8134 | ||
8135 | routing=on|off|1|0 | |
8136 | If set to 'on' or '1', the eCAP service is allowed to | |
8137 | dynamically change the current message adaptation plan by | |
8138 | returning a chain of services to be used next. | |
8139 | ||
8140 | Dynamic adaptation plan may cross or cover multiple supported | |
8141 | vectoring points in their natural processing order. | |
8142 | ||
8143 | Routing is not allowed by default. | |
8144 | ||
8145 | Older ecap_service format without optional named parameters is | |
8146 | deprecated but supported for backward compatibility. | |
8147 | ||
21a26d31 AR |
8148 | |
8149 | Example: | |
c25c2836 CT |
8150 | ecap_service s1 reqmod_precache ecap://filters.R.us/leakDetector?on_error=block bypass=off |
8151 | ecap_service s2 respmod_precache ecap://filters.R.us/virusFilter config=/etc/vf.cfg bypass=on | |
21a26d31 AR |
8152 | DOC_END |
8153 | ||
57afc994 AR |
8154 | NAME: loadable_modules |
8155 | TYPE: wordlist | |
8156 | IFDEF: USE_LOADABLE_MODULES | |
8157 | LOC: Config.loadable_module_names | |
8158 | DEFAULT: none | |
8159 | DOC_START | |
8160 | Instructs Squid to load the specified dynamic module(s) or activate | |
8161 | preloaded module(s). | |
8162 | Example: | |
8163 | loadable_modules @DEFAULT_PREFIX@/lib/MinimalAdapter.so | |
8164 | DOC_END | |
8165 | ||
62c7f90e AR |
8166 | COMMENT_START |
8167 | MESSAGE ADAPTATION OPTIONS | |
8168 | ----------------------------------------------------------------------------- | |
8169 | COMMENT_END | |
8170 | ||
8171 | NAME: adaptation_service_set | |
8172 | TYPE: adaptation_service_set_type | |
8173 | IFDEF: USE_ADAPTATION | |
8174 | LOC: none | |
8175 | DEFAULT: none | |
8176 | DOC_START | |
8177 | ||
a22e6cd3 AR |
8178 | Configures an ordered set of similar, redundant services. This is |
8179 | useful when hot standby or backup adaptation servers are available. | |
8180 | ||
8181 | adaptation_service_set set_name service_name1 service_name2 ... | |
8182 | ||
8183 | The named services are used in the set declaration order. The first | |
8184 | applicable adaptation service from the set is used first. The next | |
8185 | applicable service is tried if and only if the transaction with the | |
8186 | previous service fails and the message waiting to be adapted is still | |
8187 | intact. | |
62c7f90e | 8188 | |
a22e6cd3 AR |
8189 | When adaptation starts, broken services are ignored as if they were |
8190 | not a part of the set. A broken service is a down optional service. | |
62c7f90e | 8191 | |
a22e6cd3 AR |
8192 | The services in a set must be attached to the same vectoring point |
8193 | (e.g., pre-cache) and use the same adaptation method (e.g., REQMOD). | |
8194 | ||
8195 | If all services in a set are optional then adaptation failures are | |
8196 | bypassable. If all services in the set are essential, then a | |
8197 | transaction failure with one service may still be retried using | |
8198 | another service from the set, but when all services fail, the master | |
8199 | transaction fails as well. | |
8200 | ||
8201 | A set may contain a mix of optional and essential services, but that | |
8202 | is likely to lead to surprising results because broken services become | |
8203 | ignored (see above), making previously bypassable failures fatal. | |
8204 | Technically, it is the bypassability of the last failed service that | |
8205 | matters. | |
8206 | ||
8207 | See also: adaptation_access adaptation_service_chain | |
62c7f90e AR |
8208 | |
8209 | Example: | |
8210 | adaptation_service_set svcBlocker urlFilterPrimary urlFilterBackup | |
8211 | adaptation service_set svcLogger loggerLocal loggerRemote | |
8212 | DOC_END | |
8213 | ||
a22e6cd3 AR |
8214 | NAME: adaptation_service_chain |
8215 | TYPE: adaptation_service_chain_type | |
8216 | IFDEF: USE_ADAPTATION | |
8217 | LOC: none | |
8218 | DEFAULT: none | |
8219 | DOC_START | |
8220 | ||
8221 | Configures a list of complementary services that will be applied | |
8222 | one-by-one, forming an adaptation chain or pipeline. This is useful | |
8223 | when Squid must perform different adaptations on the same message. | |
8224 | ||
8225 | adaptation_service_chain chain_name service_name1 svc_name2 ... | |
8226 | ||
8227 | The named services are used in the chain declaration order. The first | |
8228 | applicable adaptation service from the chain is used first. The next | |
8229 | applicable service is applied to the successful adaptation results of | |
8230 | the previous service in the chain. | |
8231 | ||
8232 | When adaptation starts, broken services are ignored as if they were | |
8233 | not a part of the chain. A broken service is a down optional service. | |
8234 | ||
8235 | Request satisfaction terminates the adaptation chain because Squid | |
8236 | does not currently allow declaration of RESPMOD services at the | |
8237 | "reqmod_precache" vectoring point (see icap_service or ecap_service). | |
8238 | ||
8239 | The services in a chain must be attached to the same vectoring point | |
8240 | (e.g., pre-cache) and use the same adaptation method (e.g., REQMOD). | |
8241 | ||
8242 | A chain may contain a mix of optional and essential services. If an | |
8243 | essential adaptation fails (or the failure cannot be bypassed for | |
8244 | other reasons), the master transaction fails. Otherwise, the failure | |
8245 | is bypassed as if the failed adaptation service was not in the chain. | |
8246 | ||
8247 | See also: adaptation_access adaptation_service_set | |
8248 | ||
8249 | Example: | |
8250 | adaptation_service_chain svcRequest requestLogger urlFilter leakDetector | |
8251 | DOC_END | |
8252 | ||
62c7f90e AR |
8253 | NAME: adaptation_access |
8254 | TYPE: adaptation_access_type | |
8255 | IFDEF: USE_ADAPTATION | |
8256 | LOC: none | |
8257 | DEFAULT: none | |
638402dd | 8258 | DEFAULT_DOC: Allow, unless rules exist in squid.conf. |
62c7f90e AR |
8259 | DOC_START |
8260 | Sends an HTTP transaction to an ICAP or eCAP adaptation service. | |
8261 | ||
8262 | adaptation_access service_name allow|deny [!]aclname... | |
8263 | adaptation_access set_name allow|deny [!]aclname... | |
8264 | ||
8265 | At each supported vectoring point, the adaptation_access | |
8266 | statements are processed in the order they appear in this | |
8267 | configuration file. Statements pointing to the following services | |
8268 | are ignored (i.e., skipped without checking their ACL): | |
8269 | ||
8270 | - services serving different vectoring points | |
8271 | - "broken-but-bypassable" services | |
8272 | - "up" services configured to ignore such transactions | |
8273 | (e.g., based on the ICAP Transfer-Ignore header). | |
8274 | ||
8275 | When a set_name is used, all services in the set are checked | |
8276 | using the same rules, to find the first applicable one. See | |
8277 | adaptation_service_set for details. | |
8278 | ||
8279 | If an access list is checked and there is a match, the | |
8280 | processing stops: For an "allow" rule, the corresponding | |
8281 | adaptation service is used for the transaction. For a "deny" | |
8282 | rule, no adaptation service is activated. | |
8283 | ||
8284 | It is currently not possible to apply more than one adaptation | |
8285 | service at the same vectoring point to the same HTTP transaction. | |
8286 | ||
8287 | See also: icap_service and ecap_service | |
8288 | ||
8289 | Example: | |
8290 | adaptation_access service_1 allow all | |
8291 | DOC_END | |
8292 | ||
a22e6cd3 AR |
8293 | NAME: adaptation_service_iteration_limit |
8294 | TYPE: int | |
8295 | IFDEF: USE_ADAPTATION | |
8296 | LOC: Adaptation::Config::service_iteration_limit | |
8297 | DEFAULT: 16 | |
8298 | DOC_START | |
8299 | Limits the number of iterations allowed when applying adaptation | |
8300 | services to a message. If your longest adaptation set or chain | |
8301 | may have more than 16 services, increase the limit beyond its | |
8302 | default value of 16. If detecting infinite iteration loops sooner | |
8303 | is critical, make the iteration limit match the actual number | |
8304 | of services in your longest adaptation set or chain. | |
8305 | ||
8306 | Infinite adaptation loops are most likely with routing services. | |
8307 | ||
8308 | See also: icap_service routing=1 | |
8309 | DOC_END | |
8310 | ||
3ff65596 AR |
8311 | NAME: adaptation_masterx_shared_names |
8312 | TYPE: string | |
8313 | IFDEF: USE_ADAPTATION | |
8314 | LOC: Adaptation::Config::masterx_shared_name | |
8315 | DEFAULT: none | |
8316 | DOC_START | |
8317 | For each master transaction (i.e., the HTTP request and response | |
8318 | sequence, including all related ICAP and eCAP exchanges), Squid | |
8319 | maintains a table of metadata. The table entries are (name, value) | |
8320 | pairs shared among eCAP and ICAP exchanges. The table is destroyed | |
8321 | with the master transaction. | |
8322 | ||
8323 | This option specifies the table entry names that Squid must accept | |
8324 | from and forward to the adaptation transactions. | |
8325 | ||
8326 | An ICAP REQMOD or RESPMOD transaction may set an entry in the | |
8327 | shared table by returning an ICAP header field with a name | |
6666da11 AR |
8328 | specified in adaptation_masterx_shared_names. |
8329 | ||
8330 | An eCAP REQMOD or RESPMOD transaction may set an entry in the | |
8331 | shared table by implementing the libecap::visitEachOption() API | |
8332 | to provide an option with a name specified in | |
8333 | adaptation_masterx_shared_names. | |
5038f9d8 AR |
8334 | |
8335 | Squid will store and forward the set entry to subsequent adaptation | |
3ff65596 AR |
8336 | transactions within the same master transaction scope. |
8337 | ||
8338 | Only one shared entry name is supported at this time. | |
8339 | ||
8340 | Example: | |
8341 | # share authentication information among ICAP services | |
8342 | adaptation_masterx_shared_names X-Subscriber-ID | |
8343 | DOC_END | |
8344 | ||
71be37e0 | 8345 | NAME: adaptation_meta |
d7f4a0b7 | 8346 | TYPE: note |
71be37e0 CT |
8347 | IFDEF: USE_ADAPTATION |
8348 | LOC: Adaptation::Config::metaHeaders | |
8349 | DEFAULT: none | |
8350 | DOC_START | |
8351 | This option allows Squid administrator to add custom ICAP request | |
8352 | headers or eCAP options to Squid ICAP requests or eCAP transactions. | |
8353 | Use it to pass custom authentication tokens and other | |
8354 | transaction-state related meta information to an ICAP/eCAP service. | |
8355 | ||
8356 | The addition of a meta header is ACL-driven: | |
8357 | adaptation_meta name value [!]aclname ... | |
8358 | ||
8359 | Processing for a given header name stops after the first ACL list match. | |
8360 | Thus, it is impossible to add two headers with the same name. If no ACL | |
8361 | lists match for a given header name, no such header is added. For | |
8362 | example: | |
8363 | ||
8364 | # do not debug transactions except for those that need debugging | |
8365 | adaptation_meta X-Debug 1 needs_debugging | |
8366 | ||
8367 | # log all transactions except for those that must remain secret | |
8368 | adaptation_meta X-Log 1 !keep_secret | |
8369 | ||
8370 | # mark transactions from users in the "G 1" group | |
8371 | adaptation_meta X-Authenticated-Groups "G 1" authed_as_G1 | |
8372 | ||
8373 | The "value" parameter may be a regular squid.conf token or a "double | |
8374 | quoted string". Within the quoted string, use backslash (\) to escape | |
8375 | any character, which is currently only useful for escaping backslashes | |
8376 | and double quotes. For example, | |
8377 | "this string has one backslash (\\) and two \"quotes\"" | |
d7f4a0b7 CT |
8378 | |
8379 | Used adaptation_meta header values may be logged via %note | |
8380 | logformat code. If multiple adaptation_meta headers with the same name | |
8381 | are used during master transaction lifetime, the header values are | |
8382 | logged in the order they were used and duplicate values are ignored | |
8383 | (only the first repeated value will be logged). | |
71be37e0 CT |
8384 | DOC_END |
8385 | ||
3ff65596 AR |
8386 | NAME: icap_retry |
8387 | TYPE: acl_access | |
8388 | IFDEF: ICAP_CLIENT | |
8389 | LOC: Adaptation::Icap::TheConfig.repeat | |
3ff65596 AR |
8390 | DEFAULT_IF_NONE: deny all |
8391 | DOC_START | |
8392 | This ACL determines which retriable ICAP transactions are | |
8393 | retried. Transactions that received a complete ICAP response | |
8394 | and did not have to consume or produce HTTP bodies to receive | |
8395 | that response are usually retriable. | |
8396 | ||
8397 | icap_retry allow|deny [!]aclname ... | |
8398 | ||
8399 | Squid automatically retries some ICAP I/O timeouts and errors | |
8400 | due to persistent connection race conditions. | |
8401 | ||
8402 | See also: icap_retry_limit | |
8403 | DOC_END | |
8404 | ||
8405 | NAME: icap_retry_limit | |
8406 | TYPE: int | |
8407 | IFDEF: ICAP_CLIENT | |
8408 | LOC: Adaptation::Icap::TheConfig.repeat_limit | |
8409 | DEFAULT: 0 | |
638402dd | 8410 | DEFAULT_DOC: No retries are allowed. |
3ff65596 | 8411 | DOC_START |
638402dd | 8412 | Limits the number of retries allowed. |
3ff65596 AR |
8413 | |
8414 | Communication errors due to persistent connection race | |
8415 | conditions are unavoidable, automatically retried, and do not | |
8416 | count against this limit. | |
8417 | ||
8418 | See also: icap_retry | |
8419 | DOC_END | |
8420 | ||
8421 | ||
5473c134 | 8422 | COMMENT_START |
8423 | DNS OPTIONS | |
8424 | ----------------------------------------------------------------------------- | |
8425 | COMMENT_END | |
8426 | ||
8427 | NAME: check_hostnames | |
cccac0a2 | 8428 | TYPE: onoff |
cccac0a2 | 8429 | DEFAULT: off |
5473c134 | 8430 | LOC: Config.onoff.check_hostnames |
cccac0a2 | 8431 | DOC_START |
5473c134 | 8432 | For security and stability reasons Squid can check |
8433 | hostnames for Internet standard RFC compliance. If you want | |
8434 | Squid to perform these checks turn this directive on. | |
cccac0a2 | 8435 | DOC_END |
8436 | ||
5473c134 | 8437 | NAME: allow_underscore |
cccac0a2 | 8438 | TYPE: onoff |
cccac0a2 | 8439 | DEFAULT: on |
5473c134 | 8440 | LOC: Config.onoff.allow_underscore |
cccac0a2 | 8441 | DOC_START |
5473c134 | 8442 | Underscore characters is not strictly allowed in Internet hostnames |
8443 | but nevertheless used by many sites. Set this to off if you want | |
8444 | Squid to be strict about the standard. | |
8445 | This check is performed only when check_hostnames is set to on. | |
cccac0a2 | 8446 | DOC_END |
8447 | ||
5473c134 | 8448 | NAME: dns_retransmit_interval |
fd0f51c4 | 8449 | TYPE: time_msec |
5473c134 | 8450 | DEFAULT: 5 seconds |
8451 | LOC: Config.Timeout.idns_retransmit | |
cccac0a2 | 8452 | DOC_START |
5473c134 | 8453 | Initial retransmit interval for DNS queries. The interval is |
8454 | doubled each time all configured DNS servers have been tried. | |
cccac0a2 | 8455 | DOC_END |
8456 | ||
5473c134 | 8457 | NAME: dns_timeout |
fd0f51c4 | 8458 | TYPE: time_msec |
a541c34e | 8459 | DEFAULT: 30 seconds |
5473c134 | 8460 | LOC: Config.Timeout.idns_query |
cccac0a2 | 8461 | DOC_START |
5473c134 | 8462 | DNS Query timeout. If no response is received to a DNS query |
8463 | within this time all DNS servers for the queried domain | |
8464 | are assumed to be unavailable. | |
cccac0a2 | 8465 | DOC_END |
8466 | ||
e210930b AJ |
8467 | NAME: dns_packet_max |
8468 | TYPE: b_ssize_t | |
638402dd | 8469 | DEFAULT_DOC: EDNS disabled |
e210930b AJ |
8470 | DEFAULT: none |
8471 | LOC: Config.dns.packet_max | |
e210930b AJ |
8472 | DOC_START |
8473 | Maximum number of bytes packet size to advertise via EDNS. | |
8474 | Set to "none" to disable EDNS large packet support. | |
8475 | ||
8476 | For legacy reasons DNS UDP replies will default to 512 bytes which | |
8477 | is too small for many responses. EDNS provides a means for Squid to | |
8478 | negotiate receiving larger responses back immediately without having | |
8479 | to failover with repeat requests. Responses larger than this limit | |
8480 | will retain the old behaviour of failover to TCP DNS. | |
8481 | ||
8482 | Squid has no real fixed limit internally, but allowing packet sizes | |
8483 | over 1500 bytes requires network jumbogram support and is usually not | |
8484 | necessary. | |
8485 | ||
8486 | WARNING: The RFC also indicates that some older resolvers will reply | |
8487 | with failure of the whole request if the extension is added. Some | |
8488 | resolvers have already been identified which will reply with mangled | |
8489 | EDNS response on occasion. Usually in response to many-KB jumbogram | |
8490 | sizes being advertised by Squid. | |
8491 | Squid will currently treat these both as an unable-to-resolve domain | |
8492 | even if it would be resolvable without EDNS. | |
8493 | DOC_END | |
8494 | ||
5473c134 | 8495 | NAME: dns_defnames |
8496 | COMMENT: on|off | |
cccac0a2 | 8497 | TYPE: onoff |
cccac0a2 | 8498 | DEFAULT: off |
638402dd | 8499 | DEFAULT_DOC: Search for single-label domain names is disabled. |
5473c134 | 8500 | LOC: Config.onoff.res_defnames |
cccac0a2 | 8501 | DOC_START |
5473c134 | 8502 | Normally the RES_DEFNAMES resolver option is disabled |
8503 | (see res_init(3)). This prevents caches in a hierarchy | |
8504 | from interpreting single-component hostnames locally. To allow | |
8505 | Squid to handle single-component names, enable this option. | |
cccac0a2 | 8506 | DOC_END |
8507 | ||
bce61b00 AJ |
8508 | NAME: dns_multicast_local |
8509 | COMMENT: on|off | |
8510 | TYPE: onoff | |
8511 | DEFAULT: off | |
8512 | DEFAULT_DOC: Search for .local and .arpa names is disabled. | |
8513 | LOC: Config.onoff.dns_mdns | |
8514 | DOC_START | |
8515 | When set to on, Squid sends multicast DNS lookups on the local | |
8516 | network for domains ending in .local and .arpa. | |
8517 | This enables local servers and devices to be contacted in an | |
8518 | ad-hoc or zero-configuration network environment. | |
8519 | DOC_END | |
8520 | ||
5473c134 | 8521 | NAME: dns_nameservers |
8522 | TYPE: wordlist | |
8523 | DEFAULT: none | |
638402dd | 8524 | DEFAULT_DOC: Use operating system definitions |
5473c134 | 8525 | LOC: Config.dns_nameservers |
cccac0a2 | 8526 | DOC_START |
5473c134 | 8527 | Use this if you want to specify a list of DNS name servers |
8528 | (IP addresses) to use instead of those given in your | |
8529 | /etc/resolv.conf file. | |
638402dd | 8530 | |
5473c134 | 8531 | On Windows platforms, if no value is specified here or in |
8532 | the /etc/resolv.conf file, the list of DNS name servers are | |
8533 | taken from the Windows registry, both static and dynamic DHCP | |
8534 | configurations are supported. | |
cccac0a2 | 8535 | |
5473c134 | 8536 | Example: dns_nameservers 10.0.0.1 192.172.0.4 |
cccac0a2 | 8537 | DOC_END |
8538 | ||
5473c134 | 8539 | NAME: hosts_file |
cccac0a2 | 8540 | TYPE: string |
5473c134 | 8541 | DEFAULT: @DEFAULT_HOSTS@ |
8542 | LOC: Config.etcHostsPath | |
cccac0a2 | 8543 | DOC_START |
5473c134 | 8544 | Location of the host-local IP name-address associations |
8545 | database. Most Operating Systems have such a file on different | |
8546 | default locations: | |
8547 | - Un*X & Linux: /etc/hosts | |
8548 | - Windows NT/2000: %SystemRoot%\system32\drivers\etc\hosts | |
8549 | (%SystemRoot% value install default is c:\winnt) | |
8550 | - Windows XP/2003: %SystemRoot%\system32\drivers\etc\hosts | |
8551 | (%SystemRoot% value install default is c:\windows) | |
8552 | - Windows 9x/Me: %windir%\hosts | |
8553 | (%windir% value is usually c:\windows) | |
8554 | - Cygwin: /etc/hosts | |
cccac0a2 | 8555 | |
5473c134 | 8556 | The file contains newline-separated definitions, in the |
8557 | form ip_address_in_dotted_form name [name ...] names are | |
8558 | whitespace-separated. Lines beginning with an hash (#) | |
8559 | character are comments. | |
cccac0a2 | 8560 | |
5473c134 | 8561 | The file is checked at startup and upon configuration. |
8562 | If set to 'none', it won't be checked. | |
8563 | If append_domain is used, that domain will be added to | |
8564 | domain-local (i.e. not containing any dot character) host | |
8565 | definitions. | |
cccac0a2 | 8566 | DOC_END |
8567 | ||
5473c134 | 8568 | NAME: append_domain |
8569 | TYPE: string | |
8570 | LOC: Config.appendDomain | |
8571 | DEFAULT: none | |
638402dd | 8572 | DEFAULT_DOC: Use operating system definitions |
6a2f3fcf | 8573 | DOC_START |
5473c134 | 8574 | Appends local domain name to hostnames without any dots in |
8575 | them. append_domain must begin with a period. | |
8576 | ||
8577 | Be warned there are now Internet names with no dots in | |
8578 | them using only top-domain names, so setting this may | |
8579 | cause some Internet sites to become unavailable. | |
8580 | ||
8581 | Example: | |
8582 | append_domain .yourdomain.com | |
6a2f3fcf | 8583 | DOC_END |
8584 | ||
5473c134 | 8585 | NAME: ignore_unknown_nameservers |
8586 | TYPE: onoff | |
8587 | LOC: Config.onoff.ignore_unknown_nameservers | |
df6fd596 | 8588 | DEFAULT: on |
8589 | DOC_START | |
5473c134 | 8590 | By default Squid checks that DNS responses are received |
8591 | from the same IP addresses they are sent to. If they | |
8592 | don't match, Squid ignores the response and writes a warning | |
8593 | message to cache.log. You can allow responses from unknown | |
8594 | nameservers by setting this option to 'off'. | |
df6fd596 | 8595 | DOC_END |
8596 | ||
5a0da9ec AJ |
8597 | NAME: dns_v4_first |
8598 | TYPE: onoff | |
8599 | DEFAULT: off | |
8600 | LOC: Config.dns.v4_first | |
5a0da9ec AJ |
8601 | DOC_START |
8602 | With the IPv6 Internet being as fast or faster than IPv4 Internet | |
8603 | for most networks Squid prefers to contact websites over IPv6. | |
8604 | ||
8605 | This option reverses the order of preference to make Squid contact | |
8606 | dual-stack websites over IPv4 first. Squid will still perform both | |
8607 | IPv6 and IPv4 DNS lookups before connecting. | |
8608 | ||
8609 | WARNING: | |
8610 | This option will restrict the situations under which IPv6 | |
8611 | connectivity is used (and tested). Hiding network problems | |
8612 | which would otherwise be detected and warned about. | |
8613 | DOC_END | |
8614 | ||
6bc15a4f | 8615 | NAME: ipcache_size |
8616 | COMMENT: (number of entries) | |
8617 | TYPE: int | |
8618 | DEFAULT: 1024 | |
8619 | LOC: Config.ipcache.size | |
638402dd AJ |
8620 | DOC_START |
8621 | Maximum number of DNS IP cache entries. | |
8622 | DOC_END | |
6bc15a4f | 8623 | |
8624 | NAME: ipcache_low | |
8625 | COMMENT: (percent) | |
8626 | TYPE: int | |
8627 | DEFAULT: 90 | |
8628 | LOC: Config.ipcache.low | |
8629 | DOC_NONE | |
8630 | ||
8631 | NAME: ipcache_high | |
8632 | COMMENT: (percent) | |
8633 | TYPE: int | |
8634 | DEFAULT: 95 | |
8635 | LOC: Config.ipcache.high | |
8636 | DOC_START | |
8637 | The size, low-, and high-water marks for the IP cache. | |
8638 | DOC_END | |
8639 | ||
8640 | NAME: fqdncache_size | |
8641 | COMMENT: (number of entries) | |
8642 | TYPE: int | |
8643 | DEFAULT: 1024 | |
8644 | LOC: Config.fqdncache.size | |
8645 | DOC_START | |
8646 | Maximum number of FQDN cache entries. | |
8647 | DOC_END | |
8648 | ||
a58ff010 | 8649 | COMMENT_START |
5473c134 | 8650 | MISCELLANEOUS |
a58ff010 | 8651 | ----------------------------------------------------------------------------- |
8652 | COMMENT_END | |
8653 | ||
2eceb328 CT |
8654 | NAME: configuration_includes_quoted_values |
8655 | COMMENT: on|off | |
bde7a8ce CT |
8656 | TYPE: configuration_includes_quoted_values |
8657 | DEFAULT: off | |
2eceb328 CT |
8658 | LOC: ConfigParser::RecognizeQuotedValues |
8659 | DOC_START | |
8660 | If set, Squid will recognize each "quoted string" after a configuration | |
8661 | directive as a single parameter. The quotes are stripped before the | |
8662 | parameter value is interpreted or used. | |
8663 | See "Values with spaces, quotes, and other special characters" | |
8664 | section for more details. | |
8665 | DOC_END | |
8666 | ||
5473c134 | 8667 | NAME: memory_pools |
a58ff010 | 8668 | COMMENT: on|off |
5473c134 | 8669 | TYPE: onoff |
8670 | DEFAULT: on | |
8671 | LOC: Config.onoff.mem_pools | |
a58ff010 | 8672 | DOC_START |
5473c134 | 8673 | If set, Squid will keep pools of allocated (but unused) memory |
8674 | available for future use. If memory is a premium on your | |
8675 | system and you believe your malloc library outperforms Squid | |
8676 | routines, disable this. | |
a58ff010 | 8677 | DOC_END |
8678 | ||
5473c134 | 8679 | NAME: memory_pools_limit |
8680 | COMMENT: (bytes) | |
70be1349 | 8681 | TYPE: b_int64_t |
5473c134 | 8682 | DEFAULT: 5 MB |
8683 | LOC: Config.MemPools.limit | |
ec1245f8 | 8684 | DOC_START |
5473c134 | 8685 | Used only with memory_pools on: |
8686 | memory_pools_limit 50 MB | |
ec1245f8 | 8687 | |
5473c134 | 8688 | If set to a non-zero value, Squid will keep at most the specified |
8689 | limit of allocated (but unused) memory in memory pools. All free() | |
8690 | requests that exceed this limit will be handled by your malloc | |
8691 | library. Squid does not pre-allocate any memory, just safe-keeps | |
8692 | objects that otherwise would be free()d. Thus, it is safe to set | |
8693 | memory_pools_limit to a reasonably high value even if your | |
8694 | configuration will use less memory. | |
ec1245f8 | 8695 | |
89646bd7 | 8696 | If set to none, Squid will keep all memory it can. That is, there |
5473c134 | 8697 | will be no limit on the total amount of memory used for safe-keeping. |
ec1245f8 | 8698 | |
5473c134 | 8699 | To disable memory allocation optimization, do not set |
70be1349 | 8700 | memory_pools_limit to 0 or none. Set memory_pools to "off" instead. |
5473c134 | 8701 | |
8702 | An overhead for maintaining memory pools is not taken into account | |
8703 | when the limit is checked. This overhead is close to four bytes per | |
8704 | object kept. However, pools may actually _save_ memory because of | |
8705 | reduced memory thrashing in your malloc library. | |
ec1245f8 | 8706 | DOC_END |
8707 | ||
5473c134 | 8708 | NAME: forwarded_for |
67c06f0d AJ |
8709 | COMMENT: on|off|transparent|truncate|delete |
8710 | TYPE: string | |
5473c134 | 8711 | DEFAULT: on |
8712 | LOC: opt_forwarded_for | |
5f8252d2 | 8713 | DOC_START |
67c06f0d AJ |
8714 | If set to "on", Squid will append your client's IP address |
8715 | in the HTTP requests it forwards. By default it looks like: | |
5f8252d2 | 8716 | |
5473c134 | 8717 | X-Forwarded-For: 192.1.2.3 |
8718 | ||
67c06f0d | 8719 | If set to "off", it will appear as |
5473c134 | 8720 | |
8721 | X-Forwarded-For: unknown | |
67c06f0d AJ |
8722 | |
8723 | If set to "transparent", Squid will not alter the | |
8724 | X-Forwarded-For header in any way. | |
8725 | ||
8726 | If set to "delete", Squid will delete the entire | |
8727 | X-Forwarded-For header. | |
8728 | ||
8729 | If set to "truncate", Squid will remove all existing | |
dd68402f | 8730 | X-Forwarded-For entries, and place the client IP as the sole entry. |
5f8252d2 | 8731 | DOC_END |
8732 | ||
5473c134 | 8733 | NAME: cachemgr_passwd |
8734 | TYPE: cachemgrpasswd | |
8735 | DEFAULT: none | |
638402dd | 8736 | DEFAULT_DOC: No password. Actions which require password are denied. |
5473c134 | 8737 | LOC: Config.passwd_list |
5f8252d2 | 8738 | DOC_START |
5473c134 | 8739 | Specify passwords for cachemgr operations. |
5f8252d2 | 8740 | |
5473c134 | 8741 | Usage: cachemgr_passwd password action action ... |
8742 | ||
8743 | Some valid actions are (see cache manager menu for a full list): | |
8744 | 5min | |
8745 | 60min | |
8746 | asndb | |
8747 | authenticator | |
8748 | cbdata | |
8749 | client_list | |
8750 | comm_incoming | |
8751 | config * | |
8752 | counters | |
8753 | delay | |
8754 | digest_stats | |
8755 | dns | |
8756 | events | |
8757 | filedescriptors | |
8758 | fqdncache | |
8759 | histograms | |
8760 | http_headers | |
8761 | info | |
8762 | io | |
8763 | ipcache | |
8764 | mem | |
8765 | menu | |
8766 | netdb | |
8767 | non_peers | |
8768 | objects | |
8769 | offline_toggle * | |
8770 | pconn | |
8771 | peer_select | |
b360c477 | 8772 | reconfigure * |
5473c134 | 8773 | redirector |
8774 | refresh | |
8775 | server_list | |
8776 | shutdown * | |
8777 | store_digest | |
8778 | storedir | |
8779 | utilization | |
8780 | via_headers | |
8781 | vm_objects | |
8782 | ||
8783 | * Indicates actions which will not be performed without a | |
8784 | valid password, others can be performed if not listed here. | |
8785 | ||
8786 | To disable an action, set the password to "disable". | |
8787 | To allow performing an action without a password, set the | |
8788 | password to "none". | |
8789 | ||
8790 | Use the keyword "all" to set the same password for all actions. | |
8791 | ||
8792 | Example: | |
8793 | cachemgr_passwd secret shutdown | |
8794 | cachemgr_passwd lesssssssecret info stats/objects | |
8795 | cachemgr_passwd disable all | |
5f8252d2 | 8796 | DOC_END |
8797 | ||
5473c134 | 8798 | NAME: client_db |
a58ff010 | 8799 | COMMENT: on|off |
5473c134 | 8800 | TYPE: onoff |
8801 | DEFAULT: on | |
8802 | LOC: Config.onoff.client_db | |
a58ff010 | 8803 | DOC_START |
5473c134 | 8804 | If you want to disable collecting per-client statistics, |
8805 | turn off client_db here. | |
a58ff010 | 8806 | DOC_END |
8807 | ||
5473c134 | 8808 | NAME: refresh_all_ims |
8809 | COMMENT: on|off | |
8810 | TYPE: onoff | |
8811 | DEFAULT: off | |
8812 | LOC: Config.onoff.refresh_all_ims | |
a58ff010 | 8813 | DOC_START |
5473c134 | 8814 | When you enable this option, squid will always check |
8815 | the origin server for an update when a client sends an | |
8816 | If-Modified-Since request. Many browsers use IMS | |
8817 | requests when the user requests a reload, and this | |
8818 | ensures those clients receive the latest version. | |
a58ff010 | 8819 | |
5473c134 | 8820 | By default (off), squid may return a Not Modified response |
8821 | based on the age of the cached version. | |
78e8cfc4 | 8822 | DOC_END |
8823 | ||
5473c134 | 8824 | NAME: reload_into_ims |
626096be | 8825 | IFDEF: USE_HTTP_VIOLATIONS |
12b91c99 | 8826 | COMMENT: on|off |
5473c134 | 8827 | TYPE: onoff |
8828 | DEFAULT: off | |
8829 | LOC: Config.onoff.reload_into_ims | |
12b91c99 | 8830 | DOC_START |
5473c134 | 8831 | When you enable this option, client no-cache or ``reload'' |
8832 | requests will be changed to If-Modified-Since requests. | |
8833 | Doing this VIOLATES the HTTP standard. Enabling this | |
8834 | feature could make you liable for problems which it | |
8835 | causes. | |
8836 | ||
8837 | see also refresh_pattern for a more selective approach. | |
12b91c99 | 8838 | DOC_END |
8839 | ||
31ef19cd | 8840 | NAME: connect_retries |
5473c134 | 8841 | TYPE: int |
31ef19cd AJ |
8842 | LOC: Config.connect_retries |
8843 | DEFAULT: 0 | |
638402dd | 8844 | DEFAULT_DOC: Do not retry failed connections. |
a58ff010 | 8845 | DOC_START |
aed188fd AJ |
8846 | This sets the maximum number of connection attempts made for each |
8847 | TCP connection. The connect_retries attempts must all still | |
8848 | complete within the connection timeout period. | |
31ef19cd AJ |
8849 | |
8850 | The default is not to re-try if the first connection attempt fails. | |
8851 | The (not recommended) maximum is 10 tries. | |
5473c134 | 8852 | |
31ef19cd AJ |
8853 | A warning message will be generated if it is set to a too-high |
8854 | value and the configured value will be over-ridden. | |
5473c134 | 8855 | |
31ef19cd AJ |
8856 | Note: These re-tries are in addition to forward_max_tries |
8857 | which limit how many different addresses may be tried to find | |
8858 | a useful server. | |
a58ff010 | 8859 | DOC_END |
8860 | ||
5473c134 | 8861 | NAME: retry_on_error |
a58ff010 | 8862 | TYPE: onoff |
5473c134 | 8863 | LOC: Config.retry.onerror |
a58ff010 | 8864 | DEFAULT: off |
8865 | DOC_START | |
aea8548b AJ |
8866 | If set to ON Squid will automatically retry requests when |
8867 | receiving an error response with status 403 (Forbidden), | |
8868 | 500 (Internal Error), 501 or 503 (Service not available). | |
8869 | Status 502 and 504 (Gateway errors) are always retried. | |
8870 | ||
8871 | This is mainly useful if you are in a complex cache hierarchy to | |
8872 | work around access control errors. | |
8873 | ||
8874 | NOTE: This retry will attempt to find another working destination. | |
8875 | Which is different from the server which just failed. | |
5f8252d2 | 8876 | DOC_END |
8877 | ||
5473c134 | 8878 | NAME: as_whois_server |
5f8252d2 | 8879 | TYPE: string |
5473c134 | 8880 | LOC: Config.as_whois_server |
8881 | DEFAULT: whois.ra.net | |
5f8252d2 | 8882 | DOC_START |
5473c134 | 8883 | WHOIS server to query for AS numbers. NOTE: AS numbers are |
8884 | queried only when Squid starts up, not for every request. | |
5f8252d2 | 8885 | DOC_END |
8886 | ||
5473c134 | 8887 | NAME: offline_mode |
5f8252d2 | 8888 | TYPE: onoff |
5473c134 | 8889 | LOC: Config.onoff.offline |
5f8252d2 | 8890 | DEFAULT: off |
8891 | DOC_START | |
5473c134 | 8892 | Enable this option and Squid will never try to validate cached |
8893 | objects. | |
a58ff010 | 8894 | DOC_END |
8895 | ||
5473c134 | 8896 | NAME: uri_whitespace |
8897 | TYPE: uri_whitespace | |
8898 | LOC: Config.uri_whitespace | |
8899 | DEFAULT: strip | |
a58ff010 | 8900 | DOC_START |
5473c134 | 8901 | What to do with requests that have whitespace characters in the |
8902 | URI. Options: | |
a58ff010 | 8903 | |
5473c134 | 8904 | strip: The whitespace characters are stripped out of the URL. |
82806837 AJ |
8905 | This is the behavior recommended by RFC2396 and RFC3986 |
8906 | for tolerant handling of generic URI. | |
8907 | NOTE: This is one difference between generic URI and HTTP URLs. | |
8908 | ||
5473c134 | 8909 | deny: The request is denied. The user receives an "Invalid |
8910 | Request" message. | |
82806837 AJ |
8911 | This is the behaviour recommended by RFC2616 for safe |
8912 | handling of HTTP request URL. | |
8913 | ||
5473c134 | 8914 | allow: The request is allowed and the URI is not changed. The |
8915 | whitespace characters remain in the URI. Note the | |
8916 | whitespace is passed to redirector processes if they | |
8917 | are in use. | |
82806837 AJ |
8918 | Note this may be considered a violation of RFC2616 |
8919 | request parsing where whitespace is prohibited in the | |
8920 | URL field. | |
8921 | ||
5473c134 | 8922 | encode: The request is allowed and the whitespace characters are |
82806837 AJ |
8923 | encoded according to RFC1738. |
8924 | ||
5473c134 | 8925 | chop: The request is allowed and the URI is chopped at the |
82806837 AJ |
8926 | first whitespace. |
8927 | ||
8928 | ||
8929 | NOTE the current Squid implementation of encode and chop violates | |
8930 | RFC2616 by not using a 301 redirect after altering the URL. | |
5473c134 | 8931 | DOC_END |
a58ff010 | 8932 | |
5473c134 | 8933 | NAME: chroot |
8934 | TYPE: string | |
8935 | LOC: Config.chroot_dir | |
a58ff010 | 8936 | DEFAULT: none |
8937 | DOC_START | |
9f37c18a | 8938 | Specifies a directory where Squid should do a chroot() while |
2d89f399 HN |
8939 | initializing. This also causes Squid to fully drop root |
8940 | privileges after initializing. This means, for example, if you | |
8941 | use a HTTP port less than 1024 and try to reconfigure, you may | |
8942 | get an error saying that Squid can not open the port. | |
5473c134 | 8943 | DOC_END |
a58ff010 | 8944 | |
5473c134 | 8945 | NAME: balance_on_multiple_ip |
8946 | TYPE: onoff | |
8947 | LOC: Config.onoff.balance_on_multiple_ip | |
cc192b50 | 8948 | DEFAULT: off |
5473c134 | 8949 | DOC_START |
cc192b50 | 8950 | Modern IP resolvers in squid sort lookup results by preferred access. |
8951 | By default squid will use these IP in order and only rotates to | |
8952 | the next listed when the most preffered fails. | |
8953 | ||
5473c134 | 8954 | Some load balancing servers based on round robin DNS have been |
8955 | found not to preserve user session state across requests | |
8956 | to different IP addresses. | |
a58ff010 | 8957 | |
cc192b50 | 8958 | Enabling this directive Squid rotates IP's per request. |
a58ff010 | 8959 | DOC_END |
8960 | ||
5473c134 | 8961 | NAME: pipeline_prefetch |
079a8480 AJ |
8962 | TYPE: pipelinePrefetch |
8963 | LOC: Config.pipeline_max_prefetch | |
8964 | DEFAULT: 0 | |
8965 | DEFAULT_DOC: Do not pre-parse pipelined requests. | |
a58ff010 | 8966 | DOC_START |
079a8480 AJ |
8967 | HTTP clients may send a pipeline of 1+N requests to Squid using a |
8968 | single connection, without waiting for Squid to respond to the first | |
8969 | of those requests. This option limits the number of concurrent | |
8970 | requests Squid will try to handle in parallel. If set to N, Squid | |
8971 | will try to receive and process up to 1+N requests on the same | |
8972 | connection concurrently. | |
a58ff010 | 8973 | |
079a8480 | 8974 | Defaults to 0 (off) for bandwidth management and access logging |
5473c134 | 8975 | reasons. |
a0e23afd | 8976 | |
079a8480 AJ |
8977 | NOTE: pipelining requires persistent connections to clients. |
8978 | ||
a0e23afd | 8979 | WARNING: pipelining breaks NTLM and Negotiate/Kerberos authentication. |
5473c134 | 8980 | DOC_END |
a58ff010 | 8981 | |
5473c134 | 8982 | NAME: high_response_time_warning |
8983 | TYPE: int | |
8984 | COMMENT: (msec) | |
8985 | LOC: Config.warnings.high_rptm | |
8986 | DEFAULT: 0 | |
638402dd | 8987 | DEFAULT_DOC: disabled. |
5473c134 | 8988 | DOC_START |
8989 | If the one-minute median response time exceeds this value, | |
8990 | Squid prints a WARNING with debug level 0 to get the | |
8991 | administrators attention. The value is in milliseconds. | |
a58ff010 | 8992 | DOC_END |
8993 | ||
5473c134 | 8994 | NAME: high_page_fault_warning |
8995 | TYPE: int | |
8996 | LOC: Config.warnings.high_pf | |
8997 | DEFAULT: 0 | |
638402dd | 8998 | DEFAULT_DOC: disabled. |
cc9f92d4 | 8999 | DOC_START |
5473c134 | 9000 | If the one-minute average page fault rate exceeds this |
9001 | value, Squid prints a WARNING with debug level 0 to get | |
9002 | the administrators attention. The value is in page faults | |
9003 | per second. | |
9004 | DOC_END | |
cc9f92d4 | 9005 | |
5473c134 | 9006 | NAME: high_memory_warning |
9007 | TYPE: b_size_t | |
9008 | LOC: Config.warnings.high_memory | |
904971da | 9009 | DEFAULT: 0 KB |
638402dd | 9010 | DEFAULT_DOC: disabled. |
5473c134 | 9011 | DOC_START |
9012 | If the memory usage (as determined by mallinfo) exceeds | |
904971da | 9013 | this amount, Squid prints a WARNING with debug level 0 to get |
5473c134 | 9014 | the administrators attention. |
9015 | DOC_END | |
cc9f92d4 | 9016 | |
5473c134 | 9017 | NAME: sleep_after_fork |
9018 | COMMENT: (microseconds) | |
9019 | TYPE: int | |
9020 | LOC: Config.sleep_after_fork | |
9021 | DEFAULT: 0 | |
9022 | DOC_START | |
9023 | When this is set to a non-zero value, the main Squid process | |
9024 | sleeps the specified number of microseconds after a fork() | |
9025 | system call. This sleep may help the situation where your | |
9026 | system reports fork() failures due to lack of (virtual) | |
9027 | memory. Note, however, if you have a lot of child | |
9028 | processes, these sleep delays will add up and your | |
9029 | Squid will not service requests for some amount of time | |
9030 | until all the child processes have been started. | |
9031 | On Windows value less then 1000 (1 milliseconds) are | |
9032 | rounded to 1000. | |
cc9f92d4 | 9033 | DOC_END |
9034 | ||
b6696974 | 9035 | NAME: windows_ipaddrchangemonitor |
7aa9bb3e | 9036 | IFDEF: _SQUID_WINDOWS_ |
b6696974 GS |
9037 | COMMENT: on|off |
9038 | TYPE: onoff | |
9039 | DEFAULT: on | |
9040 | LOC: Config.onoff.WIN32_IpAddrChangeMonitor | |
9041 | DOC_START | |
9042 | On Windows Squid by default will monitor IP address changes and will | |
9043 | reconfigure itself after any detected event. This is very useful for | |
9044 | proxies connected to internet with dial-up interfaces. | |
9045 | In some cases (a Proxy server acting as VPN gateway is one) it could be | |
9046 | desiderable to disable this behaviour setting this to 'off'. | |
9047 | Note: after changing this, Squid service must be restarted. | |
9048 | DOC_END | |
9049 | ||
a98c2da5 AJ |
9050 | NAME: eui_lookup |
9051 | TYPE: onoff | |
9052 | IFDEF: USE_SQUID_EUI | |
9053 | DEFAULT: on | |
9054 | LOC: Eui::TheConfig.euiLookup | |
9055 | DOC_START | |
9056 | Whether to lookup the EUI or MAC address of a connected client. | |
9057 | DOC_END | |
9058 | ||
f3f0f563 AJ |
9059 | NAME: max_filedescriptors max_filedesc |
9060 | TYPE: int | |
9061 | DEFAULT: 0 | |
638402dd | 9062 | DEFAULT_DOC: Use operating system limits set by ulimit. |
f3f0f563 AJ |
9063 | LOC: Config.max_filedescriptors |
9064 | DOC_START | |
638402dd AJ |
9065 | Reduce the maximum number of filedescriptors supported below |
9066 | the usual operating system defaults. | |
f3f0f563 | 9067 | |
638402dd | 9068 | Remove from squid.conf to inherit the current ulimit setting. |
f3f0f563 AJ |
9069 | |
9070 | Note: Changing this requires a restart of Squid. Also | |
638402dd | 9071 | not all I/O types supports large values (eg on Windows). |
f3f0f563 AJ |
9072 | DOC_END |
9073 | ||
13aeac35 | 9074 | NAME: workers |
007d775d | 9075 | TYPE: int |
13aeac35 | 9076 | LOC: Config.workers |
007d775d | 9077 | DEFAULT: 1 |
638402dd | 9078 | DEFAULT_DOC: SMP support disabled. |
007d775d | 9079 | DOC_START |
13aeac35 | 9080 | Number of main Squid processes or "workers" to fork and maintain. |
007d775d AR |
9081 | 0: "no daemon" mode, like running "squid -N ..." |
9082 | 1: "no SMP" mode, start one main Squid process daemon (default) | |
13aeac35 AR |
9083 | N: start N main Squid process daemons (i.e., SMP mode) |
9084 | ||
b87f6632 AR |
9085 | In SMP mode, each worker does nearly all what a single Squid daemon |
9086 | does (e.g., listen on http_port and forward HTTP requests). | |
007d775d AR |
9087 | DOC_END |
9088 | ||
96c2bb61 AR |
9089 | NAME: cpu_affinity_map |
9090 | TYPE: CpuAffinityMap | |
9091 | LOC: Config.cpuAffinityMap | |
9092 | DEFAULT: none | |
638402dd | 9093 | DEFAULT_DOC: Let operating system decide. |
96c2bb61 AR |
9094 | DOC_START |
9095 | Usage: cpu_affinity_map process_numbers=P1,P2,... cores=C1,C2,... | |
9096 | ||
9097 | Sets 1:1 mapping between Squid processes and CPU cores. For example, | |
9098 | ||
9099 | cpu_affinity_map process_numbers=1,2,3,4 cores=1,3,5,7 | |
9100 | ||
9101 | affects processes 1 through 4 only and places them on the first | |
9102 | four even cores, starting with core #1. | |
9103 | ||
9104 | CPU cores are numbered starting from 1. Requires support for | |
9105 | sched_getaffinity(2) and sched_setaffinity(2) system calls. | |
9106 | ||
9107 | Multiple cpu_affinity_map options are merged. | |
9108 | ||
9109 | See also: workers | |
9110 | DOC_END | |
9111 | ||
cccac0a2 | 9112 | EOF |