Guest User

Untitled

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