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