Advertisement
Guest User

Untitled

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