Guest User

squid.conf

a guest
Oct 22nd, 2022
32
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 342.30 KB | None | 0 0
  1. # WELCOME TO SQUID 5.2
  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. # Values with byte units
  37. #
  38. # Squid accepts size units on some size related directives. All
  39. # such directives are documented with a default value displaying
  40. # a unit.
  41. #
  42. # Units accepted by Squid are:
  43. # bytes - byte
  44. # KB - Kilobyte (1024 bytes)
  45. # MB - Megabyte
  46. # GB - Gigabyte
  47. #
  48. # Values with time units
  49. #
  50. # Time-related directives marked with either "time-units" or
  51. # "time-units-small" accept a time unit. The supported time units are:
  52. #
  53. # nanosecond (time-units-small only)
  54. # microsecond (time-units-small only)
  55. # millisecond
  56. # second
  57. # minute
  58. # hour
  59. # day
  60. # week
  61. # fortnight
  62. # month - 30 days
  63. # year - 31557790080 milliseconds (just over 365 days)
  64. # decade
  65. #
  66. # Values with spaces, quotes, and other special characters
  67. #
  68. # Squid supports directive parameters with spaces, quotes, and other
  69. # special characters. Surround such parameters with "double quotes". Use
  70. # the configuration_includes_quoted_values directive to enable or
  71. # disable that support.
  72. #
  73. # Squid supports reading configuration option parameters from external
  74. # files using the syntax:
  75. # parameters("/path/filename")
  76. # For example:
  77. # acl allowlist dstdomain parameters("/etc/squid/allowlist.txt")
  78. #
  79. # Conditional configuration
  80. #
  81. # If-statements can be used to make configuration directives
  82. # depend on conditions:
  83. #
  84. # if <CONDITION>
  85. # ... regular configuration directives ...
  86. # [else
  87. # ... regular configuration directives ...]
  88. # endif
  89. #
  90. # The else part is optional. The keywords "if", "else", and "endif"
  91. # must be typed on their own lines, as if they were regular
  92. # configuration directives.
  93. #
  94. # NOTE: An else-if condition is not supported.
  95. #
  96. # These individual conditions types are supported:
  97. #
  98. # true
  99. # Always evaluates to true.
  100. # false
  101. # Always evaluates to false.
  102. # <integer> = <integer>
  103. # Equality comparison of two integer numbers.
  104. #
  105. #
  106. # SMP-Related Macros
  107. #
  108. # The following SMP-related preprocessor macros can be used.
  109. #
  110. # ${process_name} expands to the current Squid process "name"
  111. # (e.g., squid1, squid2, or cache1).
  112. #
  113. # ${process_number} expands to the current Squid process
  114. # identifier, which is an integer number (e.g., 1, 2, 3) unique
  115. # across all Squid processes of the current service instance.
  116. #
  117. # ${service_name} expands into the current Squid service instance
  118. # name identifier which is provided by -n on the command line.
  119. #
  120. # Logformat Macros
  121. #
  122. # Logformat macros can be used in many places outside of the logformat
  123. # directive. In theory, all of the logformat codes can be used as %macros,
  124. # where they are supported. In practice, a %macro expands as a dash (-) when
  125. # the transaction does not yet have enough information and a value is needed.
  126. #
  127. # There is no definitive list of what tokens are available at the various
  128. # stages of the transaction.
  129. #
  130. # And some information may already be available to Squid but not yet
  131. # committed where the macro expansion code can access it (report
  132. # such instances!). The macro will be expanded into a single dash
  133. # ('-') in such cases. Not all macros have been tested.
  134. #
  135.  
  136. # TAG: broken_vary_encoding
  137. # This option is not yet supported by Squid-3.
  138. #Default:
  139. # none
  140.  
  141. # TAG: cache_vary
  142. # This option is not yet supported by Squid-3.
  143. #Default:
  144. # none
  145.  
  146. # TAG: error_map
  147. # This option is not yet supported by Squid-3.
  148. #Default:
  149. # none
  150.  
  151. # TAG: external_refresh_check
  152. # This option is not yet supported by Squid-3.
  153. #Default:
  154. # none
  155.  
  156. # TAG: location_rewrite_program
  157. # This option is not yet supported by Squid-3.
  158. #Default:
  159. # none
  160.  
  161. # TAG: refresh_stale_hit
  162. # This option is not yet supported by Squid-3.
  163. #Default:
  164. # none
  165.  
  166. # TAG: dns_v4_first
  167. # Remove this line. Squid no longer supports preferential treatment of DNS A records.
  168. #Default:
  169. # none
  170.  
  171. # TAG: cache_peer_domain
  172. # Replace with dstdomain ACLs and cache_peer_access.
  173. #Default:
  174. # none
  175.  
  176. # TAG: ie_refresh
  177. # Remove this line. The behaviour enabled by this is no longer needed.
  178. #Default:
  179. # none
  180.  
  181. # TAG: sslproxy_cafile
  182. # Remove this line. Use tls_outgoing_options cafile= instead.
  183. #Default:
  184. # none
  185.  
  186. # TAG: sslproxy_capath
  187. # Remove this line. Use tls_outgoing_options capath= instead.
  188. #Default:
  189. # none
  190.  
  191. # TAG: sslproxy_cipher
  192. # Remove this line. Use tls_outgoing_options cipher= instead.
  193. #Default:
  194. # none
  195.  
  196. # TAG: sslproxy_client_certificate
  197. # Remove this line. Use tls_outgoing_options cert= instead.
  198. #Default:
  199. # none
  200.  
  201. # TAG: sslproxy_client_key
  202. # Remove this line. Use tls_outgoing_options key= instead.
  203. #Default:
  204. # none
  205.  
  206. # TAG: sslproxy_flags
  207. # Remove this line. Use tls_outgoing_options flags= instead.
  208. #Default:
  209. # none
  210.  
  211. # TAG: sslproxy_options
  212. # Remove this line. Use tls_outgoing_options options= instead.
  213. #Default:
  214. # none
  215.  
  216. # TAG: sslproxy_version
  217. # Remove this line. Use tls_outgoing_options options= instead.
  218. #Default:
  219. # none
  220.  
  221. # TAG: hierarchy_stoplist
  222. # Remove this line. Use always_direct or cache_peer_access ACLs instead if you need to prevent cache_peer use.
  223. #Default:
  224. # none
  225.  
  226. # TAG: log_access
  227. # Remove this line. Use acls with access_log directives to control access logging
  228. #Default:
  229. # none
  230.  
  231. # TAG: log_icap
  232. # Remove this line. Use acls with icap_log directives to control icap logging
  233. #Default:
  234. # none
  235.  
  236. # TAG: ignore_ims_on_miss
  237. # Remove this line. The HTTP/1.1 feature is now configured by 'cache_miss_revalidate'.
  238. #Default:
  239. # none
  240.  
  241. # TAG: balance_on_multiple_ip
  242. # Remove this line. Squid performs a 'Happy Eyeballs' algorithm, this multiple-IP algorithm is not longer relevant.
  243. #Default:
  244. # none
  245.  
  246. # TAG: chunked_request_body_max_size
  247. # Remove this line. Squid is now HTTP/1.1 compliant.
  248. #Default:
  249. # none
  250.  
  251. # TAG: dns_v4_fallback
  252. # Remove this line. Squid performs a 'Happy Eyeballs' algorithm, the 'fallback' algorithm is no longer relevant.
  253. #Default:
  254. # none
  255.  
  256. # TAG: emulate_httpd_log
  257. # Replace this with an access_log directive using the format 'common' or 'combined'.
  258. #Default:
  259. # none
  260.  
  261. # TAG: forward_log
  262. # Use a regular access.log with ACL limiting it to MISS events.
  263. #Default:
  264. # none
  265.  
  266. # TAG: ftp_list_width
  267. # Remove this line. Configure FTP page display using the CSS controls in errorpages.css instead.
  268. #Default:
  269. # none
  270.  
  271. # TAG: ignore_expect_100
  272. # Remove this line. The HTTP/1.1 feature is now fully supported by default.
  273. #Default:
  274. # none
  275.  
  276. # TAG: log_fqdn
  277. # Remove this option from your config. To log FQDN use %>A in the log format.
  278. #Default:
  279. # none
  280.  
  281. # TAG: log_ip_on_direct
  282. # Remove this option from your config. To log server or peer names use %<A in the log format.
  283. #Default:
  284. # none
  285.  
  286. # TAG: maximum_single_addr_tries
  287. # Replaced by connect_retries. The behaviour has changed, please read the documentation before altering.
  288. #Default:
  289. # none
  290.  
  291. # TAG: referer_log
  292. # Replace this with an access_log directive using the format 'referrer'.
  293. #Default:
  294. # none
  295.  
  296. # TAG: update_headers
  297. # Remove this line. The feature is supported by default in storage types where update is implemented.
  298. #Default:
  299. # none
  300.  
  301. # TAG: url_rewrite_concurrency
  302. # Remove this line. Set the 'concurrency=' option of url_rewrite_children instead.
  303. #Default:
  304. # none
  305.  
  306. # TAG: useragent_log
  307. # Replace this with an access_log directive using the format 'useragent'.
  308. #Default:
  309. # none
  310.  
  311. # TAG: dns_testnames
  312. # Remove this line. DNS is no longer tested on startup.
  313. #Default:
  314. # none
  315.  
  316. # TAG: extension_methods
  317. # Remove this line. All valid methods for HTTP are accepted by default.
  318. #Default:
  319. # none
  320.  
  321. # TAG: zero_buffers
  322. #Default:
  323. # none
  324.  
  325. # TAG: incoming_rate
  326. #Default:
  327. # none
  328.  
  329. # TAG: server_http11
  330. # Remove this line. HTTP/1.1 is supported by default.
  331. #Default:
  332. # none
  333.  
  334. # TAG: upgrade_http0.9
  335. # Remove this line. ICY/1.0 streaming protocol is supported by default.
  336. #Default:
  337. # none
  338.  
  339. # TAG: zph_local
  340. # Alter these entries. Use the qos_flows directive instead.
  341. #Default:
  342. # none
  343.  
  344. # TAG: header_access
  345. # Since squid-3.0 replace with request_header_access or reply_header_access
  346. # depending on whether you wish to match client requests or server replies.
  347. #Default:
  348. # none
  349.  
  350. # TAG: httpd_accel_no_pmtu_disc
  351. # Since squid-3.0 use the 'disable-pmtu-discovery' flag on http_port instead.
  352. #Default:
  353. # none
  354.  
  355. # TAG: wais_relay_host
  356. # Replace this line with 'cache_peer' configuration.
  357. #Default:
  358. # none
  359.  
  360. # TAG: wais_relay_port
  361. # Replace this line with 'cache_peer' configuration.
  362. #Default:
  363. # none
  364.  
  365. # OPTIONS FOR SMP
  366. # -----------------------------------------------------------------------------
  367.  
  368. # TAG: workers
  369. # Number of main Squid processes or "workers" to fork and maintain.
  370. # 0: "no daemon" mode, like running "squid -N ..."
  371. # 1: "no SMP" mode, start one main Squid process daemon (default)
  372. # N: start N main Squid process daemons (i.e., SMP mode)
  373. #
  374. # In SMP mode, each worker does nearly all what a single Squid daemon
  375. # does (e.g., listen on http_port and forward HTTP requests).
  376. #Default:
  377. # SMP support disabled.
  378.  
  379. # TAG: cpu_affinity_map
  380. # Usage: cpu_affinity_map process_numbers=P1,P2,... cores=C1,C2,...
  381. #
  382. # Sets 1:1 mapping between Squid processes and CPU cores. For example,
  383. #
  384. # cpu_affinity_map process_numbers=1,2,3,4 cores=1,3,5,7
  385. #
  386. # affects processes 1 through 4 only and places them on the first
  387. # four even cores, starting with core #1.
  388. #
  389. # CPU cores are numbered starting from 1. Requires support for
  390. # sched_getaffinity(2) and sched_setaffinity(2) system calls.
  391. #
  392. # Multiple cpu_affinity_map options are merged.
  393. #
  394. # See also: workers
  395. #Default:
  396. # Let operating system decide.
  397.  
  398. # TAG: shared_memory_locking on|off
  399. # Whether to ensure that all required shared memory is available by
  400. # "locking" that shared memory into RAM when Squid starts. The
  401. # alternative is faster startup time followed by slightly slower
  402. # performance and, if not enough RAM is actually available during
  403. # runtime, mysterious crashes.
  404. #
  405. # SMP Squid uses many shared memory segments. These segments are
  406. # brought into Squid memory space using an mmap(2) system call. During
  407. # Squid startup, the mmap() call often succeeds regardless of whether
  408. # the system has enough RAM. In general, Squid cannot tell whether the
  409. # kernel applies this "optimistic" memory allocation policy (but
  410. # popular modern kernels usually use it).
  411. #
  412. # Later, if Squid attempts to actually access the mapped memory
  413. # regions beyond what the kernel is willing to allocate, the
  414. # "optimistic" kernel simply kills Squid kid with a SIGBUS signal.
  415. # Some of the memory limits enforced by the kernel are currently
  416. # poorly understood: We do not know how to detect and check them. This
  417. # option ensures that the mapped memory will be available.
  418. #
  419. # This option may have a positive performance side-effect: Locking
  420. # memory at start avoids runtime paging I/O. Paging slows Squid down.
  421. #
  422. # Locking memory may require a large enough RLIMIT_MEMLOCK OS limit,
  423. # CAP_IPC_LOCK capability, or equivalent.
  424. #Default:
  425. # shared_memory_locking off
  426.  
  427. # TAG: hopeless_kid_revival_delay time-units
  428. # Normally, when a kid process dies, Squid immediately restarts the
  429. # kid. A kid experiencing frequent deaths is marked as "hopeless" for
  430. # the duration specified by this directive. Hopeless kids are not
  431. # automatically restarted.
  432. #
  433. # Currently, zero values are not supported because they result in
  434. # misconfigured SMP Squid instances running forever, endlessly
  435. # restarting each dying kid. To effectively disable hopeless kids
  436. # revival, set the delay to a huge value (e.g., 1 year).
  437. #
  438. # Reconfiguration also clears all hopeless kids designations, allowing
  439. # for manual revival of hopeless kids.
  440. #Default:
  441. # hopeless_kid_revival_delay 1 hour
  442.  
  443. # OPTIONS FOR AUTHENTICATION
  444. # -----------------------------------------------------------------------------
  445.  
  446. # TAG: auth_param
  447. # This is used to define parameters for the various authentication
  448. # schemes supported by Squid.
  449. #
  450. # format: auth_param scheme parameter [setting]
  451. #
  452. # The order in which authentication schemes are presented to the client is
  453. # dependent on the order the scheme first appears in config file. IE
  454. # has a bug (it's not RFC 2617 compliant) in that it will use the basic
  455. # scheme if basic is the first entry presented, even if more secure
  456. # schemes are presented. For now use the order in the recommended
  457. # settings section below. If other browsers have difficulties (don't
  458. # recognize the schemes offered even if you are using basic) either
  459. # put basic first, or disable the other schemes (by commenting out their
  460. # program entry).
  461. #
  462. # Once an authentication scheme is fully configured, it can only be
  463. # shutdown by shutting squid down and restarting. Changes can be made on
  464. # the fly and activated with a reconfigure. I.E. You can change to a
  465. # different helper, but not unconfigure the helper completely.
  466. #
  467. # Please note that while this directive defines how Squid processes
  468. # authentication it does not automatically activate authentication.
  469. # To use authentication you must in addition make use of ACLs based
  470. # on login name in http_access (proxy_auth, proxy_auth_regex or
  471. # external with %LOGIN used in the format tag). The browser will be
  472. # challenged for authentication on the first such acl encountered
  473. # in http_access processing and will also be re-challenged for new
  474. # login credentials if the request is being denied by a proxy_auth
  475. # type acl.
  476. #
  477. # WARNING: authentication can't be used in a transparently intercepting
  478. # proxy as the client then thinks it is talking to an origin server and
  479. # not the proxy. This is a limitation of bending the TCP/IP protocol to
  480. # transparently intercepting port 80, not a limitation in Squid.
  481. # Ports flagged 'transparent', 'intercept', or 'tproxy' have
  482. # authentication disabled.
  483. #
  484. # === Parameters common to all schemes. ===
  485. #
  486. # "program" cmdline
  487. # Specifies the command for the external authenticator.
  488. #
  489. # By default, each authentication scheme is not used unless a
  490. # program is specified.
  491. #
  492. # See http://wiki.squid-cache.org/Features/AddonHelpers for
  493. # more details on helper operations and creating your own.
  494. #
  495. # "key_extras" format
  496. # Specifies a string to be append to request line format for
  497. # the authentication helper. "Quoted" format values may contain
  498. # spaces and logformat %macros. In theory, any logformat %macro
  499. # can be used. In practice, a %macro expands as a dash (-) if
  500. # the helper request is sent before the required macro
  501. # information is available to Squid.
  502. #
  503. # By default, Squid uses request formats provided in
  504. # scheme-specific examples below (search for %credentials).
  505. #
  506. # The expanded key_extras value is added to the Squid credentials
  507. # cache and, hence, will affect authentication. It can be used to
  508. # autenticate different users with identical user names (e.g.,
  509. # when user authentication depends on http_port).
  510. #
  511. # Avoid adding frequently changing information to key_extras. For
  512. # example, if you add user source IP, and it changes frequently
  513. # in your environment, then max_user_ip ACL is going to treat
  514. # every user+IP combination as a unique "user", breaking the ACL
  515. # and wasting a lot of memory on those user records. It will also
  516. # force users to authenticate from scratch whenever their IP
  517. # changes.
  518. #
  519. # "realm" string
  520. # Specifies the protection scope (aka realm name) which is to be
  521. # reported to the client for the authentication scheme. It is
  522. # commonly part of the text the user will see when prompted for
  523. # their username and password.
  524. #
  525. # For Basic the default is "Squid proxy-caching web server".
  526. # For Digest there is no default, this parameter is mandatory.
  527. # For NTLM and Negotiate this parameter is ignored.
  528. #
  529. # "children" numberofchildren [startup=N] [idle=N] [concurrency=N]
  530. # [queue-size=N] [on-persistent-overload=action]
  531. # [reservation-timeout=seconds]
  532. #
  533. # The maximum number of authenticator processes to spawn. If
  534. # you start too few Squid will have to wait for them to process
  535. # a backlog of credential verifications, slowing it down. When
  536. # password verifications are done via a (slow) network you are
  537. # likely to need lots of authenticator processes.
  538. #
  539. # The startup= and idle= options permit some skew in the exact
  540. # amount run. A minimum of startup=N will begin during startup
  541. # and reconfigure. Squid will start more in groups of up to
  542. # idle=N in an attempt to meet traffic needs and to keep idle=N
  543. # free above those traffic needs up to the maximum.
  544. #
  545. # The concurrency= option sets the number of concurrent requests
  546. # the helper can process. The default of 0 is used for helpers
  547. # who only supports one request at a time. Setting this to a
  548. # number greater than 0 changes the protocol used to include a
  549. # channel ID field first on the request/response line, allowing
  550. # multiple requests to be sent to the same helper in parallel
  551. # without waiting for the response.
  552. #
  553. # Concurrency must not be set unless it's known the helper
  554. # supports the input format with channel-ID fields.
  555. #
  556. # The queue-size option sets the maximum number of queued
  557. # requests. A request is queued when no existing child can
  558. # accept it due to concurrency limit and no new child can be
  559. # started due to numberofchildren limit. The default maximum is
  560. # 2*numberofchildren. Squid is allowed to temporarily exceed the
  561. # configured maximum, marking the affected helper as
  562. # "overloaded". If the helper overload lasts more than 3
  563. # minutes, the action prescribed by the on-persistent-overload
  564. # option applies.
  565. #
  566. # The on-persistent-overload=action option specifies Squid
  567. # reaction to a new helper request arriving when the helper
  568. # has been overloaded for more that 3 minutes already. The number
  569. # of queued requests determines whether the helper is overloaded
  570. # (see the queue-size option).
  571. #
  572. # Two actions are supported:
  573. #
  574. # die Squid worker quits. This is the default behavior.
  575. #
  576. # ERR Squid treats the helper request as if it was
  577. # immediately submitted, and the helper immediately
  578. # replied with an ERR response. This action has no effect
  579. # on the already queued and in-progress helper requests.
  580. #
  581. # NOTE: NTLM and Negotiate schemes do not support concurrency
  582. # in the Squid code module even though some helpers can.
  583. #
  584. # The reservation-timeout=seconds option allows NTLM and Negotiate
  585. # helpers to forget about clients that abandon their in-progress
  586. # connection authentication without closing the connection. The
  587. # timeout is measured since the last helper response received by
  588. # Squid for the client. Fractional seconds are not supported.
  589. #
  590. # After the timeout, the helper will be used for other clients if
  591. # there are no unreserved helpers available. In the latter case,
  592. # the old client attempt to resume authentication will not be
  593. # forwarded to the helper (and the client should open a new HTTP
  594. # connection and retry authentication from scratch).
  595. #
  596. # By default, reservations do not expire and clients that keep
  597. # their connections open without completing authentication may
  598. # exhaust all NTLM and Negotiate helpers.
  599. #
  600. # "keep_alive" on|off
  601. # If you experience problems with PUT/POST requests when using
  602. # the NTLM or Negotiate schemes then you can try setting this
  603. # to off. This will cause Squid to forcibly close the connection
  604. # on the initial request where the browser asks which schemes
  605. # are supported by the proxy.
  606. #
  607. # For Basic and Digest this parameter is ignored.
  608. #
  609. # "utf8" on|off
  610. # Useful for sending credentials to authentication backends that
  611. # expect UTF-8 encoding (e.g., LDAP).
  612. #
  613. # When this option is enabled, Squid uses HTTP Accept-Language
  614. # request header to guess the received credentials encoding
  615. # (ISO-Latin-1, CP1251, or UTF-8) and then converts the first
  616. # two encodings into UTF-8.
  617. #
  618. # When this option is disabled and by default, Squid sends
  619. # credentials in their original (i.e. received) encoding.
  620. #
  621. # This parameter is only honored for Basic and Digest schemes.
  622. # For Basic, the entire username:password credentials are
  623. # checked and, if necessary, re-encoded. For Digest -- just the
  624. # username component. For NTLM and Negotiate schemes, this
  625. # parameter is ignored.
  626. #
  627. #
  628. # === Example Configuration ===
  629. #
  630. # This configuration displays the recommended authentication scheme
  631. # order from most to least secure with recommended minimum configuration
  632. # settings for each scheme:
  633. #
  634. ##auth_param negotiate program <uncomment and complete this line to activate>
  635. ##auth_param negotiate children 20 startup=0 idle=1
  636. ##
  637. ##auth_param digest program <uncomment and complete this line to activate>
  638. ##auth_param digest children 20 startup=0 idle=1
  639. ##auth_param digest realm Squid proxy-caching web server
  640. ##auth_param digest nonce_garbage_interval 5 minutes
  641. ##auth_param digest nonce_max_duration 30 minutes
  642. ##auth_param digest nonce_max_count 50
  643. ##
  644. ##auth_param ntlm program <uncomment and complete this line to activate>
  645. ##auth_param ntlm children 20 startup=0 idle=1
  646. ##
  647. ##auth_param basic program <uncomment and complete this line>
  648. ##auth_param basic children 5 startup=5 idle=1
  649. ##auth_param basic credentialsttl 2 hours
  650. #Default:
  651. # none
  652.  
  653. # TAG: authenticate_cache_garbage_interval
  654. # The time period between garbage collection across the username cache.
  655. # This is a trade-off between memory utilization (long intervals - say
  656. # 2 days) and CPU (short intervals - say 1 minute). Only change if you
  657. # have good reason to.
  658. #Default:
  659. # authenticate_cache_garbage_interval 1 hour
  660.  
  661. # TAG: authenticate_ttl
  662. # The time a user & their credentials stay in the logged in
  663. # user cache since their last request. When the garbage
  664. # interval passes, all user credentials that have passed their
  665. # TTL are removed from memory.
  666. #Default:
  667. # authenticate_ttl 1 hour
  668.  
  669. # TAG: authenticate_ip_ttl
  670. # If you use proxy authentication and the 'max_user_ip' ACL,
  671. # this directive controls how long Squid remembers the IP
  672. # addresses associated with each user. Use a small value
  673. # (e.g., 60 seconds) if your users might change addresses
  674. # quickly, as is the case with dialup. You might be safe
  675. # using a larger value (e.g., 2 hours) in a corporate LAN
  676. # environment with relatively static address assignments.
  677. #Default:
  678. # authenticate_ip_ttl 1 second
  679.  
  680. # ACCESS CONTROLS
  681. # -----------------------------------------------------------------------------
  682.  
  683. # TAG: external_acl_type
  684. # This option defines external acl classes using a helper program
  685. # to look up the status
  686. #
  687. # external_acl_type name [options] FORMAT /path/to/helper [helper arguments]
  688. #
  689. # Options:
  690. #
  691. # ttl=n TTL in seconds for cached results (defaults to 3600
  692. # for 1 hour)
  693. #
  694. # negative_ttl=n
  695. # TTL for cached negative lookups (default same
  696. # as ttl)
  697. #
  698. # grace=n Percentage remaining of TTL where a refresh of a
  699. # cached entry should be initiated without needing to
  700. # wait for a new reply. (default is for no grace period)
  701. #
  702. # cache=n The maximum number of entries in the result cache. The
  703. # default limit is 262144 entries. Each cache entry usually
  704. # consumes at least 256 bytes. Squid currently does not remove
  705. # expired cache entries until the limit is reached, so a proxy
  706. # will sooner or later reach the limit. The expanded FORMAT
  707. # value is used as the cache key, so if the details in FORMAT
  708. # are highly variable, a larger cache may be needed to produce
  709. # reduction in helper load.
  710. #
  711. # children-max=n
  712. # Maximum number of acl helper processes spawned to service
  713. # external acl lookups of this type. (default 5)
  714. #
  715. # children-startup=n
  716. # Minimum number of acl helper processes to spawn during
  717. # startup and reconfigure to service external acl lookups
  718. # of this type. (default 0)
  719. #
  720. # children-idle=n
  721. # Number of acl helper processes to keep ahead of traffic
  722. # loads. Squid will spawn this many at once whenever load
  723. # rises above the capabilities of existing processes.
  724. # Up to the value of children-max. (default 1)
  725. #
  726. # concurrency=n concurrency level per process. Only used with helpers
  727. # capable of processing more than one query at a time.
  728. #
  729. # queue-size=N The queue-size option sets the maximum number of
  730. # queued requests. A request is queued when no existing
  731. # helper can accept it due to concurrency limit and no
  732. # new helper can be started due to children-max limit.
  733. # If the queued requests exceed queue size, the acl is
  734. # ignored. The default value is set to 2*children-max.
  735. #
  736. # protocol=2.5 Compatibility mode for Squid-2.5 external acl helpers.
  737. #
  738. # ipv4 / ipv6 IP protocol used to communicate with this helper.
  739. # The default is to auto-detect IPv6 and use it when available.
  740. #
  741. #
  742. # FORMAT is a series of %macro codes. See logformat directive for a full list
  743. # of the accepted codes. Although note that at the time of any external ACL
  744. # being tested data may not be available and thus some %macro expand to '-'.
  745. #
  746. # In addition to the logformat codes; when processing external ACLs these
  747. # additional macros are made available:
  748. #
  749. # %ACL The name of the ACL being tested.
  750. #
  751. # %DATA The ACL arguments specified in the referencing config
  752. # 'acl ... external' line, separated by spaces (an
  753. # "argument string"). see acl external.
  754. #
  755. # If there are no ACL arguments %DATA expands to '-'.
  756. #
  757. # If you do not specify a DATA macro inside FORMAT,
  758. # Squid automatically appends %DATA to your FORMAT.
  759. # Note that Squid-3.x may expand %DATA to whitespace
  760. # or nothing in this case.
  761. #
  762. # By default, Squid applies URL-encoding to each ACL
  763. # argument inside the argument string. If an explicit
  764. # encoding modifier is used (e.g., %#DATA), then Squid
  765. # encodes the whole argument string as a single token
  766. # (e.g., with %#DATA, spaces between arguments become
  767. # %20).
  768. #
  769. # If SSL is enabled, the following formating codes become available:
  770. #
  771. # %USER_CERT SSL User certificate in PEM format
  772. # %USER_CERTCHAIN SSL User certificate chain in PEM format
  773. # %USER_CERT_xx SSL User certificate subject attribute xx
  774. # %USER_CA_CERT_xx SSL User certificate issuer attribute xx
  775. #
  776. #
  777. # NOTE: all other format codes accepted by older Squid versions
  778. # are deprecated.
  779. #
  780. #
  781. # General request syntax:
  782. #
  783. # [channel-ID] FORMAT-values
  784. #
  785. #
  786. # FORMAT-values consists of transaction details expanded with
  787. # whitespace separation per the config file FORMAT specification
  788. # using the FORMAT macros listed above.
  789. #
  790. # Request values sent to the helper are URL escaped to protect
  791. # each value in requests against whitespaces.
  792. #
  793. # If using protocol=2.5 then the request sent to the helper is not
  794. # URL escaped to protect against whitespace.
  795. #
  796. # NOTE: protocol=3.0 is deprecated as no longer necessary.
  797. #
  798. # When using the concurrency= option the protocol is changed by
  799. # introducing a query channel tag in front of the request/response.
  800. # The query channel tag is a number between 0 and concurrency-1.
  801. # This value must be echoed back unchanged to Squid as the first part
  802. # of the response relating to its request.
  803. #
  804. #
  805. # The helper receives lines expanded per the above format specification
  806. # and for each input line returns 1 line starting with OK/ERR/BH result
  807. # code and optionally followed by additional keywords with more details.
  808. #
  809. #
  810. # General result syntax:
  811. #
  812. # [channel-ID] result keyword=value ...
  813. #
  814. # Result consists of one of the codes:
  815. #
  816. # OK
  817. # the ACL test produced a match.
  818. #
  819. # ERR
  820. # the ACL test does not produce a match.
  821. #
  822. # BH
  823. # An internal error occurred in the helper, preventing
  824. # a result being identified.
  825. #
  826. # The meaning of 'a match' is determined by your squid.conf
  827. # access control configuration. See the Squid wiki for details.
  828. #
  829. # Defined keywords:
  830. #
  831. # user= The users name (login)
  832. #
  833. # password= The users password (for login= cache_peer option)
  834. #
  835. # message= Message describing the reason for this response.
  836. # Available as %o in error pages.
  837. # Useful on (ERR and BH results).
  838. #
  839. # tag= Apply a tag to a request. Only sets a tag once,
  840. # does not alter existing tags.
  841. #
  842. # log= String to be logged in access.log. Available as
  843. # %ea in logformat specifications.
  844. #
  845. # clt_conn_tag= Associates a TAG with the client TCP connection.
  846. # Please see url_rewrite_program related documentation
  847. # for this kv-pair.
  848. #
  849. # Any keywords may be sent on any response whether OK, ERR or BH.
  850. #
  851. # All response keyword values need to be a single token with URL
  852. # escaping, or enclosed in double quotes (") and escaped using \ on
  853. # any double quotes or \ characters within the value. The wrapping
  854. # double quotes are removed before the value is interpreted by Squid.
  855. # \r and \n are also replace by CR and LF.
  856. #
  857. # Some example key values:
  858. #
  859. # user=John%20Smith
  860. # user="John Smith"
  861. # user="J. \"Bob\" Smith"
  862. #Default:
  863. # none
  864.  
  865. # TAG: acl
  866. # Defining an Access List
  867. #
  868. # Every access list definition must begin with an aclname and acltype,
  869. # followed by either type-specific arguments or a quoted filename that
  870. # they are read from.
  871. #
  872. # acl aclname acltype argument ...
  873. # acl aclname acltype "file" ...
  874. #
  875. # When using "file", the file should contain one item per line.
  876. #
  877. #
  878. # ACL Options
  879. #
  880. # Some acl types supports options which changes their default behaviour:
  881. #
  882. # -i,+i By default, regular expressions are CASE-SENSITIVE. To make them
  883. # case-insensitive, use the -i option. To return case-sensitive
  884. # use the +i option between patterns, or make a new ACL line
  885. # without -i.
  886. #
  887. # -n Disable lookups and address type conversions. If lookup or
  888. # conversion is required because the parameter type (IP or
  889. # domain name) does not match the message address type (domain
  890. # name or IP), then the ACL would immediately declare a mismatch
  891. # without any warnings or lookups.
  892. #
  893. # -m[=delimiters]
  894. # Perform a list membership test, interpreting values as
  895. # comma-separated token lists and matching against individual
  896. # tokens instead of whole values.
  897. # The optional "delimiters" parameter specifies one or more
  898. # alternative non-alphanumeric delimiter characters.
  899. # non-alphanumeric delimiter characters.
  900. #
  901. # -- Used to stop processing all options, in the case the first acl
  902. # value has '-' character as first character (for example the '-'
  903. # is a valid domain name)
  904. #
  905. # Some acl types require suspending the current request in order
  906. # to access some external data source.
  907. # Those which do are marked with the tag [slow], those which
  908. # don't are marked as [fast].
  909. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl
  910. # for further information
  911. #
  912. # ***** ACL TYPES AVAILABLE *****
  913. #
  914. # acl aclname src ip-address/mask ... # clients IP address [fast]
  915. # acl aclname src addr1-addr2/mask ... # range of addresses [fast]
  916. # acl aclname dst [-n] ip-address/mask ... # URL host's IP address [slow]
  917. # acl aclname localip ip-address/mask ... # IP address the client connected to [fast]
  918. #
  919. #if USE_SQUID_EUI
  920. # acl aclname arp mac-address ...
  921. # acl aclname eui64 eui64-address ...
  922. # # [fast]
  923. # # MAC (EUI-48) and EUI-64 addresses use xx:xx:xx:xx:xx:xx notation.
  924. # #
  925. # # The 'arp' ACL code is not portable to all operating systems.
  926. # # It works on Linux, Solaris, Windows, FreeBSD, and some other
  927. # # BSD variants.
  928. # #
  929. # # The eui_lookup directive is required to be 'on' (the default)
  930. # # and Squid built with --enable-eui for MAC/EUI addresses to be
  931. # # available for this ACL.
  932. # #
  933. # # Squid can only determine the MAC/EUI address for IPv4
  934. # # clients that are on the same subnet. If the client is on a
  935. # # different subnet, then Squid cannot find out its address.
  936. # #
  937. # # IPv6 protocol does not contain ARP. MAC/EUI is either
  938. # # encoded directly in the IPv6 address or not available.
  939. #endif
  940. # acl aclname clientside_mark mark[/mask] ...
  941. # # matches CONNMARK of an accepted connection [fast]
  942. # # DEPRECATED. Use the 'client_connection_mark' instead.
  943. #
  944. # acl aclname client_connection_mark mark[/mask] ...
  945. # # matches CONNMARK of an accepted connection [fast]
  946. # #
  947. # # mark and mask are unsigned integers (hex, octal, or decimal).
  948. # # If multiple marks are given, then the ACL matches if at least
  949. # # one mark matches.
  950. # #
  951. # # Uses netfilter-conntrack library.
  952. # # Requires building Squid with --enable-linux-netfilter.
  953. # #
  954. # # The client, various intermediaries, and Squid itself may set
  955. # # CONNMARK at various times. The last CONNMARK set wins. This ACL
  956. # # checks the mark present on an accepted connection or set by
  957. # # Squid afterwards, depending on the ACL check timing. This ACL
  958. # # effectively ignores any mark set by other agents after Squid has
  959. # # accepted the connection.
  960. #
  961. # acl aclname srcdomain .foo.com ...
  962. # # reverse lookup, from client IP [slow]
  963. # acl aclname dstdomain [-n] .foo.com ...
  964. # # Destination server from URL [fast]
  965. # acl aclname srcdom_regex [-i] \.foo\.com ...
  966. # # regex matching client name [slow]
  967. # acl aclname dstdom_regex [-n] [-i] \.foo\.com ...
  968. # # regex matching server [fast]
  969. # #
  970. # # For dstdomain and dstdom_regex a reverse lookup is tried if a IP
  971. # # based URL is used and no match is found. The name "none" is used
  972. # # if the reverse lookup fails.
  973. #
  974. # acl aclname src_as number ...
  975. # acl aclname dst_as number ...
  976. # # [fast]
  977. # # Except for access control, AS numbers can be used for
  978. # # routing of requests to specific caches. Here's an
  979. # # example for routing all requests for AS#1241 and only
  980. # # those to mycache.mydomain.net:
  981. # # acl asexample dst_as 1241
  982. # # cache_peer_access mycache.mydomain.net allow asexample
  983. # # cache_peer_access mycache_mydomain.net deny all
  984. #
  985. # acl aclname peername myPeer ...
  986. # acl aclname peername_regex [-i] regex-pattern ...
  987. # # [fast]
  988. # # match against a named cache_peer entry
  989. # # set unique name= on cache_peer lines for reliable use.
  990. #
  991. # acl aclname time [day-abbrevs] [h1:m1-h2:m2]
  992. # # [fast]
  993. # # day-abbrevs:
  994. # # S - Sunday
  995. # # M - Monday
  996. # # T - Tuesday
  997. # # W - Wednesday
  998. # # H - Thursday
  999. # # F - Friday
  1000. # # A - Saturday
  1001. # # h1:m1 must be less than h2:m2
  1002. #
  1003. # acl aclname url_regex [-i] ^http:// ...
  1004. # # regex matching on whole URL [fast]
  1005. # acl aclname urllogin [-i] [^a-zA-Z0-9] ...
  1006. # # regex matching on URL login field
  1007. # acl aclname urlpath_regex [-i] \.gif$ ...
  1008. # # regex matching on URL path [fast]
  1009. #
  1010. # acl aclname port 80 70 21 0-1024... # destination TCP port [fast]
  1011. # # ranges are alloed
  1012. # acl aclname localport 3128 ... # TCP port the client connected to [fast]
  1013. # # NP: for interception mode this is usually '80'
  1014. #
  1015. # acl aclname myportname 3128 ... # *_port name [fast]
  1016. #
  1017. # acl aclname proto HTTP FTP ... # request protocol [fast]
  1018. #
  1019. # acl aclname method GET POST ... # HTTP request method [fast]
  1020. #
  1021. # acl aclname http_status 200 301 500- 400-403 ...
  1022. # # status code in reply [fast]
  1023. #
  1024. # acl aclname browser [-i] regexp ...
  1025. # # pattern match on User-Agent header (see also req_header below) [fast]
  1026. #
  1027. # acl aclname referer_regex [-i] regexp ...
  1028. # # pattern match on Referer header [fast]
  1029. # # Referer is highly unreliable, so use with care
  1030. #
  1031. # acl aclname ident [-i] username ...
  1032. # acl aclname ident_regex [-i] pattern ...
  1033. # # string match on ident output [slow]
  1034. # # use REQUIRED to accept any non-null ident.
  1035. #
  1036. # acl aclname proxy_auth [-i] username ...
  1037. # acl aclname proxy_auth_regex [-i] pattern ...
  1038. # # perform http authentication challenge to the client and match against
  1039. # # supplied credentials [slow]
  1040. # #
  1041. # # takes a list of allowed usernames.
  1042. # # use REQUIRED to accept any valid username.
  1043. # #
  1044. # # Will use proxy authentication in forward-proxy scenarios, and plain
  1045. # # http authenticaiton in reverse-proxy scenarios
  1046. # #
  1047. # # NOTE: when a Proxy-Authentication header is sent but it is not
  1048. # # needed during ACL checking the username is NOT logged
  1049. # # in access.log.
  1050. # #
  1051. # # NOTE: proxy_auth requires a EXTERNAL authentication program
  1052. # # to check username/password combinations (see
  1053. # # auth_param directive).
  1054. # #
  1055. # # NOTE: proxy_auth can't be used in a transparent/intercepting proxy
  1056. # # as the browser needs to be configured for using a proxy in order
  1057. # # to respond to proxy authentication.
  1058. #
  1059. # acl aclname snmp_community string ...
  1060. # # A community string to limit access to your SNMP Agent [fast]
  1061. # # Example:
  1062. # #
  1063. # # acl snmppublic snmp_community public
  1064. #
  1065. # acl aclname maxconn number
  1066. # # This will be matched when the client's IP address has
  1067. # # more than <number> TCP connections established. [fast]
  1068. # # NOTE: This only measures direct TCP links so X-Forwarded-For
  1069. # # indirect clients are not counted.
  1070. #
  1071. # acl aclname max_user_ip [-s] number
  1072. # # This will be matched when the user attempts to log in from more
  1073. # # than <number> different ip addresses. The authenticate_ip_ttl
  1074. # # parameter controls the timeout on the ip entries. [fast]
  1075. # # If -s is specified the limit is strict, denying browsing
  1076. # # from any further IP addresses until the ttl has expired. Without
  1077. # # -s Squid will just annoy the user by "randomly" denying requests.
  1078. # # (the counter is reset each time the limit is reached and a
  1079. # # request is denied)
  1080. # # NOTE: in acceleration mode or where there is mesh of child proxies,
  1081. # # clients may appear to come from multiple addresses if they are
  1082. # # going through proxy farms, so a limit of 1 may cause user problems.
  1083. #
  1084. # acl aclname random probability
  1085. # # Pseudo-randomly match requests. Based on the probability given.
  1086. # # Probability may be written as a decimal (0.333), fraction (1/3)
  1087. # # or ratio of matches:non-matches (3:5).
  1088. #
  1089. # acl aclname req_mime_type [-i] mime-type ...
  1090. # # regex match against the mime type of the request generated
  1091. # # by the client. Can be used to detect file upload or some
  1092. # # types HTTP tunneling requests [fast]
  1093. # # NOTE: This does NOT match the reply. You cannot use this
  1094. # # to match the returned file type.
  1095. #
  1096. # acl aclname req_header header-name [-i] any\.regex\.here
  1097. # # regex match against any of the known request headers. May be
  1098. # # thought of as a superset of "browser", "referer" and "mime-type"
  1099. # # ACL [fast]
  1100. #
  1101. # acl aclname rep_mime_type [-i] mime-type ...
  1102. # # regex match against the mime type of the reply received by
  1103. # # squid. Can be used to detect file download or some
  1104. # # types HTTP tunneling requests. [fast]
  1105. # # NOTE: This has no effect in http_access rules. It only has
  1106. # # effect in rules that affect the reply data stream such as
  1107. # # http_reply_access.
  1108. #
  1109. # acl aclname rep_header header-name [-i] any\.regex\.here
  1110. # # regex match against any of the known reply headers. May be
  1111. # # thought of as a superset of "browser", "referer" and "mime-type"
  1112. # # ACLs [fast]
  1113. #
  1114. # acl aclname external class_name [arguments...]
  1115. # # external ACL lookup via a helper class defined by the
  1116. # # external_acl_type directive [slow]
  1117. #
  1118. # acl aclname user_cert attribute values...
  1119. # # match against attributes in a user SSL certificate
  1120. # # attribute is one of DN/C/O/CN/L/ST or a numerical OID [fast]
  1121. #
  1122. # acl aclname ca_cert attribute values...
  1123. # # match against attributes a users issuing CA SSL certificate
  1124. # # attribute is one of DN/C/O/CN/L/ST or a numerical OID [fast]
  1125. #
  1126. # acl aclname ext_user [-i] username ...
  1127. # acl aclname ext_user_regex [-i] pattern ...
  1128. # # string match on username returned by external acl helper [slow]
  1129. # # use REQUIRED to accept any non-null user name.
  1130. #
  1131. # acl aclname tag tagvalue ...
  1132. # # string match on tag returned by external acl helper [fast]
  1133. # # DEPRECATED. Only the first tag will match with this ACL.
  1134. # # Use the 'note' ACL instead for handling multiple tag values.
  1135. #
  1136. # acl aclname hier_code codename ...
  1137. # # string match against squid hierarchy code(s); [fast]
  1138. # # e.g., DIRECT, PARENT_HIT, NONE, etc.
  1139. # #
  1140. # # NOTE: This has no effect in http_access rules. It only has
  1141. # # effect in rules that affect the reply data stream such as
  1142. # # http_reply_access.
  1143. #
  1144. # acl aclname note [-m[=delimiters]] name [value ...]
  1145. # # match transaction annotation [fast]
  1146. # # Without values, matches any annotation with a given name.
  1147. # # With value(s), matches any annotation with a given name that
  1148. # # also has one of the given values.
  1149. # # If the -m flag is used, then the value of the named
  1150. # # annotation is interpreted as a list of tokens, and the ACL
  1151. # # matches individual name=token pairs rather than whole
  1152. # # name=value pairs. See "ACL Options" above for more info.
  1153. # # Annotation sources include note and adaptation_meta directives
  1154. # # as well as helper and eCAP responses.
  1155. #
  1156. # acl aclname annotate_transaction [-m[=delimiters]] key=value ...
  1157. # acl aclname annotate_transaction [-m[=delimiters]] key+=value ...
  1158. # # Always matches. [fast]
  1159. # # Used for its side effect: This ACL immediately adds a
  1160. # # key=value annotation to the current master transaction.
  1161. # # The added annotation can then be tested using note ACL and
  1162. # # logged (or sent to helpers) using %note format code.
  1163. # #
  1164. # # Annotations can be specified using replacement and addition
  1165. # # formats. The key=value form replaces old same-key annotation
  1166. # # value(s). The key+=value form appends a new value to the old
  1167. # # same-key annotation. Both forms create a new key=value
  1168. # # annotation if no same-key annotation exists already. If
  1169. # # -m flag is used, then the value is interpreted as a list
  1170. # # and the annotation will contain key=token pair(s) instead of the
  1171. # # whole key=value pair.
  1172. # #
  1173. # # This ACL is especially useful for recording complex multi-step
  1174. # # ACL-driven decisions. For example, the following configuration
  1175. # # avoids logging transactions accepted after aclX matched:
  1176. # #
  1177. # # # First, mark transactions accepted after aclX matched
  1178. # # acl markSpecial annotate_transaction special=true
  1179. # # http_access allow acl001
  1180. # # ...
  1181. # # http_access deny acl100
  1182. # # http_access allow aclX markSpecial
  1183. # #
  1184. # # # Second, do not log marked transactions:
  1185. # # acl markedSpecial note special true
  1186. # # access_log ... deny markedSpecial
  1187. # #
  1188. # # # Note that the following would not have worked because aclX
  1189. # # # alone does not determine whether the transaction was allowed:
  1190. # # access_log ... deny aclX # Wrong!
  1191. # #
  1192. # # Warning: This ACL annotates the transaction even when negated
  1193. # # and even if subsequent ACLs fail to match. For example, the
  1194. # # following three rules will have exactly the same effect as far
  1195. # # as annotations set by the "mark" ACL are concerned:
  1196. # #
  1197. # # some_directive acl1 ... mark # rule matches if mark is reached
  1198. # # some_directive acl1 ... !mark # rule never matches
  1199. # # some_directive acl1 ... mark !all # rule never matches
  1200. #
  1201. # acl aclname annotate_client [-m[=delimiters]] key=value ...
  1202. # acl aclname annotate_client [-m[=delimiters]] key+=value ...
  1203. # #
  1204. # # Always matches. [fast]
  1205. # # Used for its side effect: This ACL immediately adds a
  1206. # # key=value annotation to the current client-to-Squid
  1207. # # connection. Connection annotations are propagated to the current
  1208. # # and all future master transactions on the annotated connection.
  1209. # # See the annotate_transaction ACL for details.
  1210. # #
  1211. # # For example, the following configuration avoids rewriting URLs
  1212. # # of transactions bumped by SslBump:
  1213. # #
  1214. # # # First, mark bumped connections:
  1215. # # acl markBumped annotate_client bumped=true
  1216. # # ssl_bump peek acl1
  1217. # # ssl_bump stare acl2
  1218. # # ssl_bump bump acl3 markBumped
  1219. # # ssl_bump splice all
  1220. # #
  1221. # # # Second, do not send marked transactions to the redirector:
  1222. # # acl markedBumped note bumped true
  1223. # # url_rewrite_access deny markedBumped
  1224. # #
  1225. # # # Note that the following would not have worked because acl3 alone
  1226. # # # does not determine whether the connection is going to be bumped:
  1227. # # url_rewrite_access deny acl3 # Wrong!
  1228. #
  1229. # acl aclname adaptation_service service ...
  1230. # # Matches the name of any icap_service, ecap_service,
  1231. # # adaptation_service_set, or adaptation_service_chain that Squid
  1232. # # has used (or attempted to use) for the master transaction.
  1233. # # This ACL must be defined after the corresponding adaptation
  1234. # # service is named in squid.conf. This ACL is usable with
  1235. # # adaptation_meta because it starts matching immediately after
  1236. # # the service has been selected for adaptation.
  1237. #
  1238. # acl aclname transaction_initiator initiator ...
  1239. # # Matches transaction's initiator [fast]
  1240. # #
  1241. # # Supported initiators are:
  1242. # # esi: matches transactions fetching ESI resources
  1243. # # certificate-fetching: matches transactions fetching
  1244. # # a missing intermediate TLS certificate
  1245. # # cache-digest: matches transactions fetching Cache Digests
  1246. # # from a cache_peer
  1247. # # htcp: matches HTCP requests from peers
  1248. # # icp: matches ICP requests to peers
  1249. # # icmp: matches ICMP RTT database (NetDB) requests to peers
  1250. # # asn: matches asns db requests
  1251. # # internal: matches any of the above
  1252. # # client: matches transactions containing an HTTP or FTP
  1253. # # client request received at a Squid *_port
  1254. # # all: matches any transaction, including internal transactions
  1255. # # without a configurable initiator and hopefully rare
  1256. # # transactions without a known-to-Squid initiator
  1257. # #
  1258. # # Multiple initiators are ORed.
  1259. #
  1260. # acl aclname has component
  1261. # # matches a transaction "component" [fast]
  1262. # #
  1263. # # Supported transaction components are:
  1264. # # request: transaction has a request header (at least)
  1265. # # response: transaction has a response header (at least)
  1266. # # ALE: transaction has an internally-generated Access Log Entry
  1267. # # structure; bugs notwithstanding, all transaction have it
  1268. # #
  1269. # # For example, the following configuration helps when dealing with HTTP
  1270. # # clients that close connections without sending a request header:
  1271. # #
  1272. # # acl hasRequest has request
  1273. # # acl logMe note important_transaction
  1274. # # # avoid "logMe ACL is used in context without an HTTP request" warnings
  1275. # # access_log ... logformat=detailed hasRequest logMe
  1276. # # # log request-less transactions, instead of ignoring them
  1277. # # access_log ... logformat=brief !hasRequest
  1278. # #
  1279. # # Multiple components are not supported for one "acl" rule, but
  1280. # # can be specified (and are ORed) using multiple same-name rules:
  1281. # #
  1282. # # # OK, this strange logging daemon needs request or response,
  1283. # # # but can work without either a request or a response:
  1284. # # acl hasWhatMyLoggingDaemonNeeds has request
  1285. # # acl hasWhatMyLoggingDaemonNeeds has response
  1286. #
  1287. #acl aclname at_step step
  1288. # # match against the current request processing step [fast]
  1289. # # Valid steps are:
  1290. # # GeneratingCONNECT: Generating HTTP CONNECT request headers
  1291. #
  1292. # acl aclname any-of acl1 acl2 ...
  1293. # # match any one of the acls [fast or slow]
  1294. # # The first matching ACL stops further ACL evaluation.
  1295. # #
  1296. # # ACLs from multiple any-of lines with the same name are ORed.
  1297. # # For example, A = (a1 or a2) or (a3 or a4) can be written as
  1298. # # acl A any-of a1 a2
  1299. # # acl A any-of a3 a4
  1300. # #
  1301. # # This group ACL is fast if all evaluated ACLs in the group are fast
  1302. # # and slow otherwise.
  1303. #
  1304. # acl aclname all-of acl1 acl2 ...
  1305. # # match all of the acls [fast or slow]
  1306. # # The first mismatching ACL stops further ACL evaluation.
  1307. # #
  1308. # # ACLs from multiple all-of lines with the same name are ORed.
  1309. # # For example, B = (b1 and b2) or (b3 and b4) can be written as
  1310. # # acl B all-of b1 b2
  1311. # # acl B all-of b3 b4
  1312. # #
  1313. # # This group ACL is fast if all evaluated ACLs in the group are fast
  1314. # # and slow otherwise.
  1315. #
  1316. # Examples:
  1317. # acl macaddress arp 09:00:2b:23:45:67
  1318. # acl myexample dst_as 1241
  1319. # acl password proxy_auth REQUIRED
  1320. # acl fileupload req_mime_type -i ^multipart/form-data$
  1321. # acl javascript rep_mime_type -i ^application/x-javascript$
  1322. #
  1323. #Default:
  1324. # ACLs all, manager, localhost, to_localhost, and CONNECT are predefined.
  1325. #
  1326. #
  1327. # Recommended minimum configuration:
  1328. #
  1329.  
  1330. # Example rule allowing access from your local networks.
  1331. # Adapt to list your (internal) IP networks from where browsing
  1332. # should be allowed
  1333. acl localnet src 0.0.0.1-0.255.255.255 # RFC 1122 "this" network (LAN)
  1334. acl localnet src 10.0.0.0/8 # RFC 1918 local private network (LAN)
  1335. acl localnet src 100.64.0.0/10 # RFC 6598 shared address space (CGN)
  1336. acl localnet src 169.254.0.0/16 # RFC 3927 link-local (directly plugged) machines
  1337. acl localnet src 172.16.0.0/12 # RFC 1918 local private network (LAN)
  1338. acl localnet src 192.168.0.0/16 # RFC 1918 local private network (LAN)
  1339. acl localnet src fc00::/7 # RFC 4193 local private network range
  1340. acl localnet src fe80::/10 # RFC 4291 link-local (directly plugged) machines
  1341.  
  1342. acl SSL_ports port 443
  1343. acl Safe_ports port 80 # http
  1344. acl Safe_ports port 21 # ftp
  1345. acl Safe_ports port 443 # https
  1346. acl Safe_ports port 70 # gopher
  1347. acl Safe_ports port 210 # wais
  1348. acl Safe_ports port 1025-65535 # unregistered ports
  1349. acl Safe_ports port 280 # http-mgmt
  1350. acl Safe_ports port 488 # gss-http
  1351. acl Safe_ports port 591 # filemaker
  1352. acl Safe_ports port 777 # multiling http
  1353.  
  1354. # TAG: proxy_protocol_access
  1355. # Determine which client proxies can be trusted to provide correct
  1356. # information regarding real client IP address using PROXY protocol.
  1357. #
  1358. # Requests may pass through a chain of several other proxies
  1359. # before reaching us. The original source details may by sent in:
  1360. # * HTTP message Forwarded header, or
  1361. # * HTTP message X-Forwarded-For header, or
  1362. # * PROXY protocol connection header.
  1363. #
  1364. # This directive is solely for validating new PROXY protocol
  1365. # connections received from a port flagged with require-proxy-header.
  1366. # It is checked only once after TCP connection setup.
  1367. #
  1368. # A deny match results in TCP connection closure.
  1369. #
  1370. # An allow match is required for Squid to permit the corresponding
  1371. # TCP connection, before Squid even looks for HTTP request headers.
  1372. # If there is an allow match, Squid starts using PROXY header information
  1373. # to determine the source address of the connection for all future ACL
  1374. # checks, logging, etc.
  1375. #
  1376. # SECURITY CONSIDERATIONS:
  1377. #
  1378. # Any host from which we accept client IP details can place
  1379. # incorrect information in the relevant header, and Squid
  1380. # will use the incorrect information as if it were the
  1381. # source address of the request. This may enable remote
  1382. # hosts to bypass any access control restrictions that are
  1383. # based on the client's source addresses.
  1384. #
  1385. # This clause only supports fast acl types.
  1386. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  1387. #Default:
  1388. # all TCP connections to ports with require-proxy-header will be denied
  1389.  
  1390. # TAG: follow_x_forwarded_for
  1391. # Determine which client proxies can be trusted to provide correct
  1392. # information regarding real client IP address.
  1393. #
  1394. # Requests may pass through a chain of several other proxies
  1395. # before reaching us. The original source details may by sent in:
  1396. # * HTTP message Forwarded header, or
  1397. # * HTTP message X-Forwarded-For header, or
  1398. # * PROXY protocol connection header.
  1399. #
  1400. # PROXY protocol connections are controlled by the proxy_protocol_access
  1401. # directive which is checked before this.
  1402. #
  1403. # If a request reaches us from a source that is allowed by this
  1404. # directive, then we trust the information it provides regarding
  1405. # the IP of the client it received from (if any).
  1406. #
  1407. # For the purpose of ACLs used in this directive the src ACL type always
  1408. # matches the address we are testing and srcdomain matches its rDNS.
  1409. #
  1410. # On each HTTP request Squid checks for X-Forwarded-For header fields.
  1411. # If found the header values are iterated in reverse order and an allow
  1412. # match is required for Squid to continue on to the next value.
  1413. # The verification ends when a value receives a deny match, cannot be
  1414. # tested, or there are no more values to test.
  1415. # NOTE: Squid does not yet follow the Forwarded HTTP header.
  1416. #
  1417. # The end result of this process is an IP address that we will
  1418. # refer to as the indirect client address. This address may
  1419. # be treated as the client address for access control, ICAP, delay
  1420. # pools and logging, depending on the acl_uses_indirect_client,
  1421. # icap_uses_indirect_client, delay_pool_uses_indirect_client,
  1422. # log_uses_indirect_client and tproxy_uses_indirect_client options.
  1423. #
  1424. # This clause only supports fast acl types.
  1425. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  1426. #
  1427. # SECURITY CONSIDERATIONS:
  1428. #
  1429. # Any host from which we accept client IP details can place
  1430. # incorrect information in the relevant header, and Squid
  1431. # will use the incorrect information as if it were the
  1432. # source address of the request. This may enable remote
  1433. # hosts to bypass any access control restrictions that are
  1434. # based on the client's source addresses.
  1435. #
  1436. # For example:
  1437. #
  1438. # acl localhost src 127.0.0.1
  1439. # acl my_other_proxy srcdomain .proxy.example.com
  1440. # follow_x_forwarded_for allow localhost
  1441. # follow_x_forwarded_for allow my_other_proxy
  1442. #Default:
  1443. # X-Forwarded-For header will be ignored.
  1444.  
  1445. # TAG: acl_uses_indirect_client on|off
  1446. # Controls whether the indirect client address
  1447. # (see follow_x_forwarded_for) is used instead of the
  1448. # direct client address in acl matching.
  1449. #
  1450. # NOTE: maxconn ACL considers direct TCP links and indirect
  1451. # clients will always have zero. So no match.
  1452. #Default:
  1453. # acl_uses_indirect_client on
  1454.  
  1455. # TAG: delay_pool_uses_indirect_client on|off
  1456. # Controls whether the indirect client address
  1457. # (see follow_x_forwarded_for) is used instead of the
  1458. # direct client address in delay pools.
  1459. #Default:
  1460. # delay_pool_uses_indirect_client on
  1461.  
  1462. # TAG: log_uses_indirect_client on|off
  1463. # Controls whether the indirect client address
  1464. # (see follow_x_forwarded_for) is used instead of the
  1465. # direct client address in the access log.
  1466. #Default:
  1467. # log_uses_indirect_client on
  1468.  
  1469. # TAG: tproxy_uses_indirect_client on|off
  1470. # Controls whether the indirect client address
  1471. # (see follow_x_forwarded_for) is used instead of the
  1472. # direct client address when spoofing the outgoing client.
  1473. #
  1474. # This has no effect on requests arriving in non-tproxy
  1475. # mode ports.
  1476. #
  1477. # SECURITY WARNING: Usage of this option is dangerous
  1478. # and should not be used trivially. Correct configuration
  1479. # of follow_x_forwarded_for with a limited set of trusted
  1480. # sources is required to prevent abuse of your proxy.
  1481. #Default:
  1482. # tproxy_uses_indirect_client off
  1483.  
  1484. # TAG: spoof_client_ip
  1485. # Control client IP address spoofing of TPROXY traffic based on
  1486. # defined access lists.
  1487. #
  1488. # spoof_client_ip allow|deny [!]aclname ...
  1489. #
  1490. # If there are no "spoof_client_ip" lines present, the default
  1491. # is to "allow" spoofing of any suitable request.
  1492. #
  1493. # Note that the cache_peer "no-tproxy" option overrides this ACL.
  1494. #
  1495. # This clause supports fast acl types.
  1496. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  1497. #Default:
  1498. # Allow spoofing on all TPROXY traffic.
  1499.  
  1500. # TAG: http_access
  1501. # Allowing or Denying access based on defined access lists
  1502. #
  1503. # To allow or deny a message received on an HTTP, HTTPS, or FTP port:
  1504. # http_access allow|deny [!]aclname ...
  1505. #
  1506. # NOTE on default values:
  1507. #
  1508. # If there are no "access" lines present, the default is to deny
  1509. # the request.
  1510. #
  1511. # If none of the "access" lines cause a match, the default is the
  1512. # opposite of the last line in the list. If the last line was
  1513. # deny, the default is allow. Conversely, if the last line
  1514. # is allow, the default will be deny. For these reasons, it is a
  1515. # good idea to have an "deny all" entry at the end of your access
  1516. # lists to avoid potential confusion.
  1517. #
  1518. # This clause supports both fast and slow acl types.
  1519. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  1520. #
  1521. #Default:
  1522. # Deny, unless rules exist in squid.conf.
  1523. #
  1524.  
  1525. #
  1526. # Recommended minimum Access Permission configuration:
  1527. #
  1528. # Deny requests to certain unsafe ports
  1529. http_access deny !Safe_ports
  1530.  
  1531. # Deny CONNECT to other than secure SSL ports
  1532. http_access deny CONNECT !SSL_ports
  1533.  
  1534. # Only allow cachemgr access from localhost
  1535. http_access allow localhost manager
  1536. http_access deny manager
  1537. #http_access allow authenticated
  1538.  
  1539.  
  1540. # We strongly recommend the following be uncommented to protect innocent
  1541. # web applications running on the proxy server who think the only
  1542. # one who can access services on "localhost" is a local user
  1543. #http_access deny to_localhost
  1544.  
  1545. #
  1546. # INSERT YOUR OWN RULE(S) HERE TO ALLOW ACCESS FROM YOUR CLIENTS
  1547. #
  1548. include /etc/squid/conf.d/*.conf
  1549.  
  1550. auth_param basic program /usr/lib/squid/basic_ncsa_auth /etc/squid/passwords
  1551. auth_param basic realm proxy
  1552. acl authenticated proxy_auth REQUIRED
  1553.  
  1554.  
  1555.  
  1556. # Example rule allowing access from your local networks.
  1557. # Adapt localnet in the ACL section to list your (internal) IP networks
  1558. # from where browsing should be allowed
  1559. #http_access allow localnet
  1560. http_access allow localhost
  1561. http_access allow authenticated
  1562.  
  1563. # And finally deny all other access to this proxy
  1564. http_access deny all
  1565.  
  1566. # TAG: adapted_http_access
  1567. # Allowing or Denying access based on defined access lists
  1568. #
  1569. # Essentially identical to http_access, but runs after redirectors
  1570. # and ICAP/eCAP adaptation. Allowing access control based on their
  1571. # output.
  1572. #
  1573. # If not set then only http_access is used.
  1574. #Default:
  1575. # Allow, unless rules exist in squid.conf.
  1576.  
  1577. # TAG: http_reply_access
  1578. # Allow replies to client requests. This is complementary to http_access.
  1579. #
  1580. # http_reply_access allow|deny [!] aclname ...
  1581. #
  1582. # NOTE: if there are no access lines present, the default is to allow
  1583. # all replies.
  1584. #
  1585. # If none of the access lines cause a match the opposite of the
  1586. # last line will apply. Thus it is good practice to end the rules
  1587. # with an "allow all" or "deny all" entry.
  1588. #
  1589. # This clause supports both fast and slow acl types.
  1590. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  1591. #Default:
  1592. # Allow, unless rules exist in squid.conf.
  1593.  
  1594. # TAG: icp_access
  1595. # Allowing or Denying access to the ICP port based on defined
  1596. # access lists
  1597. #
  1598. # icp_access allow|deny [!]aclname ...
  1599. #
  1600. # NOTE: The default if no icp_access lines are present is to
  1601. # deny all traffic. This default may cause problems with peers
  1602. # using ICP.
  1603. #
  1604. # This clause only supports fast acl types.
  1605. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  1606. #
  1607. ## Allow ICP queries from local networks only
  1608. ##icp_access allow localnet
  1609. ##icp_access deny all
  1610. #Default:
  1611. # Deny, unless rules exist in squid.conf.
  1612.  
  1613. # TAG: htcp_access
  1614. # Allowing or Denying access to the HTCP port based on defined
  1615. # access lists
  1616. #
  1617. # htcp_access allow|deny [!]aclname ...
  1618. #
  1619. # See also htcp_clr_access for details on access control for
  1620. # cache purge (CLR) HTCP messages.
  1621. #
  1622. # NOTE: The default if no htcp_access lines are present is to
  1623. # deny all traffic. This default may cause problems with peers
  1624. # using the htcp option.
  1625. #
  1626. # This clause only supports fast acl types.
  1627. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  1628. #
  1629. ## Allow HTCP queries from local networks only
  1630. ##htcp_access allow localnet
  1631. ##htcp_access deny all
  1632. #Default:
  1633. # Deny, unless rules exist in squid.conf.
  1634.  
  1635. # TAG: htcp_clr_access
  1636. # Allowing or Denying access to purge content using HTCP based
  1637. # on defined access lists.
  1638. # See htcp_access for details on general HTCP access control.
  1639. #
  1640. # htcp_clr_access allow|deny [!]aclname ...
  1641. #
  1642. # This clause only supports fast acl types.
  1643. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  1644. #
  1645. ## Allow HTCP CLR requests from trusted peers
  1646. #acl htcp_clr_peer src 192.0.2.2 2001:DB8::2
  1647. #htcp_clr_access allow htcp_clr_peer
  1648. #htcp_clr_access deny all
  1649. #Default:
  1650. # Deny, unless rules exist in squid.conf.
  1651.  
  1652. # TAG: miss_access
  1653. # Determines whether network access is permitted when satisfying a request.
  1654. #
  1655. # For example;
  1656. # to force your neighbors to use you as a sibling instead of
  1657. # a parent.
  1658. #
  1659. # acl localclients src 192.0.2.0/24 2001:DB8::a:0/64
  1660. # miss_access deny !localclients
  1661. # miss_access allow all
  1662. #
  1663. # This means only your local clients are allowed to fetch relayed/MISS
  1664. # replies from the network and all other clients can only fetch cached
  1665. # objects (HITs).
  1666. #
  1667. # The default for this setting allows all clients who passed the
  1668. # http_access rules to relay via this proxy.
  1669. #
  1670. # This clause only supports fast acl types.
  1671. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  1672. #Default:
  1673. # Allow, unless rules exist in squid.conf.
  1674.  
  1675. # TAG: ident_lookup_access
  1676. # A list of ACL elements which, if matched, cause an ident
  1677. # (RFC 931) lookup to be performed for this request. For
  1678. # example, you might choose to always perform ident lookups
  1679. # for your main multi-user Unix boxes, but not for your Macs
  1680. # and PCs. By default, ident lookups are not performed for
  1681. # any requests.
  1682. #
  1683. # To enable ident lookups for specific client addresses, you
  1684. # can follow this example:
  1685. #
  1686. # acl ident_aware_hosts src 198.168.1.0/24
  1687. # ident_lookup_access allow ident_aware_hosts
  1688. # ident_lookup_access deny all
  1689. #
  1690. # Only src type ACL checks are fully supported. A srcdomain
  1691. # ACL might work at times, but it will not always provide
  1692. # the correct result.
  1693. #
  1694. # This clause only supports fast acl types.
  1695. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  1696. #Default:
  1697. # Unless rules exist in squid.conf, IDENT is not fetched.
  1698.  
  1699. # TAG: reply_body_max_size size [acl acl...]
  1700. # This option specifies the maximum size of a reply body. It can be
  1701. # used to prevent users from downloading very large files, such as
  1702. # MP3's and movies. When the reply headers are received, the
  1703. # reply_body_max_size lines are processed, and the first line where
  1704. # all (if any) listed ACLs are true is used as the maximum body size
  1705. # for this reply.
  1706. #
  1707. # This size is checked twice. First when we get the reply headers,
  1708. # we check the content-length value. If the content length value exists
  1709. # and is larger than the allowed size, the request is denied and the
  1710. # user receives an error message that says "the request or reply
  1711. # is too large." If there is no content-length, and the reply
  1712. # size exceeds this limit, the client's connection is just closed
  1713. # and they will receive a partial reply.
  1714. #
  1715. # WARNING: downstream caches probably can not detect a partial reply
  1716. # if there is no content-length header, so they will cache
  1717. # partial responses and give them out as hits. You should NOT
  1718. # use this option if you have downstream caches.
  1719. #
  1720. # WARNING: A maximum size smaller than the size of squid's error messages
  1721. # will cause an infinite loop and crash squid. Ensure that the smallest
  1722. # non-zero value you use is greater that the maximum header size plus
  1723. # the size of your largest error page.
  1724. #
  1725. # If you set this parameter none (the default), there will be
  1726. # no limit imposed.
  1727. #
  1728. # Configuration Format is:
  1729. # reply_body_max_size SIZE UNITS [acl ...]
  1730. # ie.
  1731. # reply_body_max_size 10 MB
  1732. #
  1733. #Default:
  1734. # No limit is applied.
  1735.  
  1736. # TAG: on_unsupported_protocol
  1737. # Determines Squid behavior when encountering strange requests at the
  1738. # beginning of an accepted TCP connection or the beginning of a bumped
  1739. # CONNECT tunnel. Controlling Squid reaction to unexpected traffic is
  1740. # especially useful in interception environments where Squid is likely
  1741. # to see connections for unsupported protocols that Squid should either
  1742. # terminate or tunnel at TCP level.
  1743. #
  1744. # on_unsupported_protocol <action> [!]acl ...
  1745. #
  1746. # The first matching action wins. Only fast ACLs are supported.
  1747. #
  1748. # Supported actions are:
  1749. #
  1750. # tunnel: Establish a TCP connection with the intended server and
  1751. # blindly shovel TCP packets between the client and server.
  1752. #
  1753. # respond: Respond with an error message, using the transfer protocol
  1754. # for the Squid port that received the request (e.g., HTTP
  1755. # for connections intercepted at the http_port). This is the
  1756. # default.
  1757. #
  1758. # Squid expects the following traffic patterns:
  1759. #
  1760. # http_port: a plain HTTP request
  1761. # https_port: SSL/TLS handshake followed by an [encrypted] HTTP request
  1762. # ftp_port: a plain FTP command (no on_unsupported_protocol support yet!)
  1763. # CONNECT tunnel on http_port: same as https_port
  1764. # CONNECT tunnel on https_port: same as https_port
  1765. #
  1766. # Currently, this directive has effect on intercepted connections and
  1767. # bumped tunnels only. Other cases are not supported because Squid
  1768. # cannot know the intended destination of other traffic.
  1769. #
  1770. # For example:
  1771. # # define what Squid errors indicate receiving non-HTTP traffic:
  1772. # acl foreignProtocol squid_error ERR_PROTOCOL_UNKNOWN ERR_TOO_BIG
  1773. # # define what Squid errors indicate receiving nothing:
  1774. # acl serverTalksFirstProtocol squid_error ERR_REQUEST_START_TIMEOUT
  1775. # # tunnel everything that does not look like HTTP:
  1776. # on_unsupported_protocol tunnel foreignProtocol
  1777. # # tunnel if we think the client waits for the server to talk first:
  1778. # on_unsupported_protocol tunnel serverTalksFirstProtocol
  1779. # # in all other error cases, just send an HTTP "error page" response:
  1780. # on_unsupported_protocol respond all
  1781. #
  1782. # See also: squid_error ACL
  1783. #Default:
  1784. # Respond with an error message to unidentifiable traffic
  1785.  
  1786. # TAG: auth_schemes
  1787. # Use this directive to customize authentication schemes presence and
  1788. # order in Squid's Unauthorized and Authentication Required responses.
  1789. #
  1790. # auth_schemes scheme1,scheme2,... [!]aclname ...
  1791. #
  1792. # where schemeN is the name of one of the authentication schemes
  1793. # configured using auth_param directives. At least one scheme name is
  1794. # required. Multiple scheme names are separated by commas. Either
  1795. # avoid whitespace or quote the entire schemes list.
  1796. #
  1797. # A special "ALL" scheme name expands to all auth_param-configured
  1798. # schemes in their configuration order. This directive cannot be used
  1799. # to configure Squid to offer no authentication schemes at all.
  1800. #
  1801. # The first matching auth_schemes rule determines the schemes order
  1802. # for the current Authentication Required transaction. Note that the
  1803. # future response is not yet available during auth_schemes evaluation.
  1804. #
  1805. # If this directive is not used or none of its rules match, then Squid
  1806. # responds with all configured authentication schemes in the order of
  1807. # auth_param directives in the configuration file.
  1808. #
  1809. # This directive does not determine when authentication is used or
  1810. # how each authentication scheme authenticates clients.
  1811. #
  1812. # The following example sends basic and negotiate authentication
  1813. # schemes, in that order, when requesting authentication of HTTP
  1814. # requests matching the isIE ACL (not shown) while sending all
  1815. # auth_param schemes in their configuration order to other clients:
  1816. #
  1817. # auth_schemes basic,negotiate isIE
  1818. # auth_schemes ALL all # explicit default
  1819. #
  1820. # This directive supports fast ACLs only.
  1821. #
  1822. # See also: auth_param.
  1823. #Default:
  1824. # use all auth_param schemes in their configuration order
  1825.  
  1826. # NETWORK OPTIONS
  1827. # -----------------------------------------------------------------------------
  1828.  
  1829. # TAG: http_port
  1830. # Usage: port [mode] [options]
  1831. # hostname:port [mode] [options]
  1832. # 1.2.3.4:port [mode] [options]
  1833. #
  1834. # The socket addresses where Squid will listen for HTTP client
  1835. # requests. You may specify multiple socket addresses.
  1836. # There are three forms: port alone, hostname with port, and
  1837. # IP address with port. If you specify a hostname or IP
  1838. # address, Squid binds the socket to that specific
  1839. # address. Most likely, you do not need to bind to a specific
  1840. # address, so you can use the port number alone.
  1841. #
  1842. # If you are running Squid in accelerator mode, you
  1843. # probably want to listen on port 80 also, or instead.
  1844. #
  1845. # The -a command line option may be used to specify additional
  1846. # port(s) where Squid listens for proxy request. Such ports will
  1847. # be plain proxy ports with no options.
  1848. #
  1849. # You may specify multiple socket addresses on multiple lines.
  1850. #
  1851. # Modes:
  1852. #
  1853. # intercept Support for IP-Layer NAT interception delivering
  1854. # traffic to this Squid port.
  1855. # NP: disables authentication on the port.
  1856. #
  1857. # tproxy Support Linux TPROXY (or BSD divert-to) with spoofing
  1858. # of outgoing connections using the client IP address.
  1859. # NP: disables authentication on the port.
  1860. #
  1861. # accel Accelerator / reverse proxy mode
  1862. #
  1863. # ssl-bump For each CONNECT request allowed by ssl_bump ACLs,
  1864. # establish secure connection with the client and with
  1865. # the server, decrypt HTTPS messages as they pass through
  1866. # Squid, and treat them as unencrypted HTTP messages,
  1867. # becoming the man-in-the-middle.
  1868. #
  1869. # The ssl_bump option is required to fully enable
  1870. # bumping of CONNECT requests.
  1871. #
  1872. # Omitting the mode flag causes default forward proxy mode to be used.
  1873. #
  1874. #
  1875. # Accelerator Mode Options:
  1876. #
  1877. # defaultsite=domainname
  1878. # What to use for the Host: header if it is not present
  1879. # in a request. Determines what site (not origin server)
  1880. # accelerators should consider the default.
  1881. #
  1882. # no-vhost Disable using HTTP/1.1 Host header for virtual domain support.
  1883. #
  1884. # protocol= Protocol to reconstruct accelerated and intercepted
  1885. # requests with. Defaults to HTTP/1.1 for http_port and
  1886. # HTTPS/1.1 for https_port.
  1887. # When an unsupported value is configured Squid will
  1888. # produce a FATAL error.
  1889. # Values: HTTP or HTTP/1.1, HTTPS or HTTPS/1.1
  1890. #
  1891. # vport Virtual host port support. Using the http_port number
  1892. # instead of the port passed on Host: headers.
  1893. #
  1894. # vport=NN Virtual host port support. Using the specified port
  1895. # number instead of the port passed on Host: headers.
  1896. #
  1897. # act-as-origin
  1898. # Act as if this Squid is the origin server.
  1899. # This currently means generate new Date: and Expires:
  1900. # headers on HIT instead of adding Age:.
  1901. #
  1902. # ignore-cc Ignore request Cache-Control headers.
  1903. #
  1904. # WARNING: This option violates HTTP specifications if
  1905. # used in non-accelerator setups.
  1906. #
  1907. # allow-direct Allow direct forwarding in accelerator mode. Normally
  1908. # accelerated requests are denied direct forwarding as if
  1909. # never_direct was used.
  1910. #
  1911. # WARNING: this option opens accelerator mode to security
  1912. # vulnerabilities usually only affecting in interception
  1913. # mode. Make sure to protect forwarding with suitable
  1914. # http_access rules when using this.
  1915. #
  1916. #
  1917. # SSL Bump Mode Options:
  1918. # In addition to these options ssl-bump requires TLS/SSL options.
  1919. #
  1920. # generate-host-certificates[=<on|off>]
  1921. # Dynamically create SSL server certificates for the
  1922. # destination hosts of bumped CONNECT requests.When
  1923. # enabled, the cert and key options are used to sign
  1924. # generated certificates. Otherwise generated
  1925. # certificate will be selfsigned.
  1926. # If there is a CA certificate lifetime of the generated
  1927. # certificate equals lifetime of the CA certificate. If
  1928. # generated certificate is selfsigned lifetime is three
  1929. # years.
  1930. # This option is enabled by default when ssl-bump is used.
  1931. # See the ssl-bump option above for more information.
  1932. #
  1933. # dynamic_cert_mem_cache_size=SIZE
  1934. # Approximate total RAM size spent on cached generated
  1935. # certificates. If set to zero, caching is disabled. The
  1936. # default value is 4MB.
  1937. #
  1938. # TLS / SSL Options:
  1939. #
  1940. # tls-cert= Path to file containing an X.509 certificate (PEM format)
  1941. # to be used in the TLS handshake ServerHello.
  1942. #
  1943. # If this certificate is constrained by KeyUsage TLS
  1944. # feature it must allow HTTP server usage, along with
  1945. # any additional restrictions imposed by your choice
  1946. # of options= settings.
  1947. #
  1948. # When OpenSSL is used this file may also contain a
  1949. # chain of intermediate CA certificates to send in the
  1950. # TLS handshake.
  1951. #
  1952. # When GnuTLS is used this option (and any paired
  1953. # tls-key= option) may be repeated to load multiple
  1954. # certificates for different domains.
  1955. #
  1956. # Also, when generate-host-certificates=on is configured
  1957. # the first tls-cert= option must be a CA certificate
  1958. # capable of signing the automatically generated
  1959. # certificates.
  1960. #
  1961. # tls-key= Path to a file containing private key file (PEM format)
  1962. # for the previous tls-cert= option.
  1963. #
  1964. # If tls-key= is not specified tls-cert= is assumed to
  1965. # reference a PEM file containing both the certificate
  1966. # and private key.
  1967. #
  1968. # cipher= Colon separated list of supported ciphers.
  1969. # NOTE: some ciphers such as EDH ciphers depend on
  1970. # additional settings. If those settings are
  1971. # omitted the ciphers may be silently ignored
  1972. # by the OpenSSL library.
  1973. #
  1974. # options= Various SSL implementation options. The most important
  1975. # being:
  1976. #
  1977. # NO_SSLv3 Disallow the use of SSLv3
  1978. #
  1979. # NO_TLSv1 Disallow the use of TLSv1.0
  1980. #
  1981. # NO_TLSv1_1 Disallow the use of TLSv1.1
  1982. #
  1983. # NO_TLSv1_2 Disallow the use of TLSv1.2
  1984. #
  1985. # SINGLE_DH_USE
  1986. # Always create a new key when using
  1987. # temporary/ephemeral DH key exchanges
  1988. #
  1989. # SINGLE_ECDH_USE
  1990. # Enable ephemeral ECDH key exchange.
  1991. # The adopted curve should be specified
  1992. # using the tls-dh option.
  1993. #
  1994. # NO_TICKET
  1995. # Disable use of RFC5077 session tickets.
  1996. # Some servers may have problems
  1997. # understanding the TLS extension due
  1998. # to ambiguous specification in RFC4507.
  1999. #
  2000. # ALL Enable various bug workarounds
  2001. # suggested as "harmless" by OpenSSL
  2002. # Be warned that this reduces SSL/TLS
  2003. # strength to some attacks.
  2004. #
  2005. # See the OpenSSL SSL_CTX_set_options documentation for a
  2006. # more complete list.
  2007. #
  2008. # clientca= File containing the list of CAs to use when
  2009. # requesting a client certificate.
  2010. #
  2011. # tls-cafile= PEM file containing CA certificates to use when verifying
  2012. # client certificates. If not configured clientca will be
  2013. # used. May be repeated to load multiple files.
  2014. #
  2015. # capath= Directory containing additional CA certificates
  2016. # and CRL lists to use when verifying client certificates.
  2017. # Requires OpenSSL or LibreSSL.
  2018. #
  2019. # crlfile= File of additional CRL lists to use when verifying
  2020. # the client certificate, in addition to CRLs stored in
  2021. # the capath. Implies VERIFY_CRL flag below.
  2022. #
  2023. # tls-dh=[curve:]file
  2024. # File containing DH parameters for temporary/ephemeral DH key
  2025. # exchanges, optionally prefixed by a curve for ephemeral ECDH
  2026. # key exchanges.
  2027. # See OpenSSL documentation for details on how to create the
  2028. # DH parameter file. Supported curves for ECDH can be listed
  2029. # using the "openssl ecparam -list_curves" command.
  2030. # WARNING: EDH and EECDH ciphers will be silently disabled if
  2031. # this option is not set.
  2032. #
  2033. # sslflags= Various flags modifying the use of SSL:
  2034. # DELAYED_AUTH
  2035. # Don't request client certificates
  2036. # immediately, but wait until acl processing
  2037. # requires a certificate (not yet implemented).
  2038. # CONDITIONAL_AUTH
  2039. # Request a client certificate during the TLS
  2040. # handshake, but ignore certificate absence in
  2041. # the TLS client Hello. If the client does
  2042. # supply a certificate, it is validated.
  2043. # NO_SESSION_REUSE
  2044. # Don't allow for session reuse. Each connection
  2045. # will result in a new SSL session.
  2046. # VERIFY_CRL
  2047. # Verify CRL lists when accepting client
  2048. # certificates.
  2049. # VERIFY_CRL_ALL
  2050. # Verify CRL lists for all certificates in the
  2051. # client certificate chain.
  2052. #
  2053. # tls-default-ca[=off]
  2054. # Whether to use the system Trusted CAs. Default is OFF.
  2055. #
  2056. # tls-no-npn Do not use the TLS NPN extension to advertise HTTP/1.1.
  2057. #
  2058. # sslcontext= SSL session ID context identifier.
  2059. #
  2060. # Other Options:
  2061. #
  2062. # connection-auth[=on|off]
  2063. # use connection-auth=off to tell Squid to prevent
  2064. # forwarding Microsoft connection oriented authentication
  2065. # (NTLM, Negotiate and Kerberos)
  2066. #
  2067. # disable-pmtu-discovery=
  2068. # Control Path-MTU discovery usage:
  2069. # off lets OS decide on what to do (default).
  2070. # transparent disable PMTU discovery when transparent
  2071. # support is enabled.
  2072. # always disable always PMTU discovery.
  2073. #
  2074. # In many setups of transparently intercepting proxies
  2075. # Path-MTU discovery can not work on traffic towards the
  2076. # clients. This is the case when the intercepting device
  2077. # does not fully track connections and fails to forward
  2078. # ICMP must fragment messages to the cache server. If you
  2079. # have such setup and experience that certain clients
  2080. # sporadically hang or never complete requests set
  2081. # disable-pmtu-discovery option to 'transparent'.
  2082. #
  2083. # name= Specifies a internal name for the port. Defaults to
  2084. # the port specification (port or addr:port)
  2085. #
  2086. # tcpkeepalive[=idle,interval,timeout]
  2087. # Enable TCP keepalive probes of idle connections.
  2088. # In seconds; idle is the initial time before TCP starts
  2089. # probing the connection, interval how often to probe, and
  2090. # timeout the time before giving up.
  2091. #
  2092. # require-proxy-header
  2093. # Require PROXY protocol version 1 or 2 connections.
  2094. # The proxy_protocol_access is required to permit
  2095. # downstream proxies which can be trusted.
  2096. #
  2097. # worker-queues
  2098. # Ask TCP stack to maintain a dedicated listening queue
  2099. # for each worker accepting requests at this port.
  2100. # Requires TCP stack that supports the SO_REUSEPORT socket
  2101. # option.
  2102. #
  2103. # SECURITY WARNING: Enabling worker-specific queues
  2104. # allows any process running as Squid's effective user to
  2105. # easily accept requests destined to this port.
  2106. #
  2107. # If you run Squid on a dual-homed machine with an internal
  2108. # and an external interface we recommend you to specify the
  2109. # internal address:port in http_port. This way Squid will only be
  2110. # visible on the internal address.
  2111. #
  2112. #
  2113.  
  2114. # Squid normally listens to port 3128
  2115. http_port 3128
  2116.  
  2117. # TAG: https_port
  2118. # Usage: [ip:]port [mode] tls-cert=certificate.pem [options]
  2119. #
  2120. # The socket address where Squid will listen for client requests made
  2121. # over TLS or SSL connections. Commonly referred to as HTTPS.
  2122. #
  2123. # This is most useful for situations where you are running squid in
  2124. # accelerator mode and you want to do the TLS work at the accelerator
  2125. # level.
  2126. #
  2127. # You may specify multiple socket addresses on multiple lines,
  2128. # each with their own certificate and/or options.
  2129. #
  2130. # The tls-cert= option is mandatory on HTTPS ports.
  2131. #
  2132. # See http_port for a list of modes and options.
  2133. #Default:
  2134. # none
  2135.  
  2136. # TAG: ftp_port
  2137. # Enables Native FTP proxy by specifying the socket address where Squid
  2138. # listens for FTP client requests. See http_port directive for various
  2139. # ways to specify the listening address and mode.
  2140. #
  2141. # Usage: ftp_port address [mode] [options]
  2142. #
  2143. # WARNING: This is a new, experimental, complex feature that has seen
  2144. # limited production exposure. Some Squid modules (e.g., caching) do not
  2145. # currently work with native FTP proxying, and many features have not
  2146. # even been tested for compatibility. Test well before deploying!
  2147. #
  2148. # Native FTP proxying differs substantially from proxying HTTP requests
  2149. # with ftp:// URIs because Squid works as an FTP server and receives
  2150. # actual FTP commands (rather than HTTP requests with FTP URLs).
  2151. #
  2152. # Native FTP commands accepted at ftp_port are internally converted or
  2153. # wrapped into HTTP-like messages. The same happens to Native FTP
  2154. # responses received from FTP origin servers. Those HTTP-like messages
  2155. # are shoveled through regular access control and adaptation layers
  2156. # between the FTP client and the FTP origin server. This allows Squid to
  2157. # examine, adapt, block, and log FTP exchanges. Squid reuses most HTTP
  2158. # mechanisms when shoveling wrapped FTP messages. For example,
  2159. # http_access and adaptation_access directives are used.
  2160. #
  2161. # Modes:
  2162. #
  2163. # intercept Same as http_port intercept. The FTP origin address is
  2164. # determined based on the intended destination of the
  2165. # intercepted connection.
  2166. #
  2167. # tproxy Support Linux TPROXY for spoofing outgoing
  2168. # connections using the client IP address.
  2169. # NP: disables authentication and maybe IPv6 on the port.
  2170. #
  2171. # By default (i.e., without an explicit mode option), Squid extracts the
  2172. # FTP origin address from the login@origin parameter of the FTP USER
  2173. # command. Many popular FTP clients support such native FTP proxying.
  2174. #
  2175. # Options:
  2176. #
  2177. # name=token Specifies an internal name for the port. Defaults to
  2178. # the port address. Usable with myportname ACL.
  2179. #
  2180. # ftp-track-dirs
  2181. # Enables tracking of FTP directories by injecting extra
  2182. # PWD commands and adjusting Request-URI (in wrapping
  2183. # HTTP requests) to reflect the current FTP server
  2184. # directory. Tracking is disabled by default.
  2185. #
  2186. # protocol=FTP Protocol to reconstruct accelerated and intercepted
  2187. # requests with. Defaults to FTP. No other accepted
  2188. # values have been tested with. An unsupported value
  2189. # results in a FATAL error. Accepted values are FTP,
  2190. # HTTP (or HTTP/1.1), and HTTPS (or HTTPS/1.1).
  2191. #
  2192. # Other http_port modes and options that are not specific to HTTP and
  2193. # HTTPS may also work.
  2194. #Default:
  2195. # none
  2196.  
  2197. # TAG: tcp_outgoing_tos
  2198. # Allows you to select a TOS/Diffserv value for packets outgoing
  2199. # on the server side, based on an ACL.
  2200. #
  2201. # tcp_outgoing_tos ds-field [!]aclname ...
  2202. #
  2203. # Example where normal_service_net uses the TOS value 0x00
  2204. # and good_service_net uses 0x20
  2205. #
  2206. # acl normal_service_net src 10.0.0.0/24
  2207. # acl good_service_net src 10.0.1.0/24
  2208. # tcp_outgoing_tos 0x00 normal_service_net
  2209. # tcp_outgoing_tos 0x20 good_service_net
  2210. #
  2211. # TOS/DSCP values really only have local significance - so you should
  2212. # know what you're specifying. For more information, see RFC2474,
  2213. # RFC2475, and RFC3260.
  2214. #
  2215. # The TOS/DSCP byte must be exactly that - a octet value 0 - 255, or
  2216. # "default" to use whatever default your host has.
  2217. # Note that only multiples of 4 are usable as the two rightmost bits have
  2218. # been redefined for use by ECN (RFC 3168 section 23.1).
  2219. # The squid parser will enforce this by masking away the ECN bits.
  2220. #
  2221. # Processing proceeds in the order specified, and stops at first fully
  2222. # matching line.
  2223. #
  2224. # Only fast ACLs are supported.
  2225. #Default:
  2226. # none
  2227.  
  2228. # TAG: clientside_tos
  2229. # Allows you to select a TOS/DSCP value for packets being transmitted
  2230. # on the client-side, based on an ACL.
  2231. #
  2232. # clientside_tos ds-field [!]aclname ...
  2233. #
  2234. # Example where normal_service_net uses the TOS value 0x00
  2235. # and good_service_net uses 0x20
  2236. #
  2237. # acl normal_service_net src 10.0.0.0/24
  2238. # acl good_service_net src 10.0.1.0/24
  2239. # clientside_tos 0x00 normal_service_net
  2240. # clientside_tos 0x20 good_service_net
  2241. #
  2242. # Note: This feature is incompatible with qos_flows. Any TOS values set here
  2243. # will be overwritten by TOS values in qos_flows.
  2244. #
  2245. # The TOS/DSCP byte must be exactly that - a octet value 0 - 255, or
  2246. # "default" to use whatever default your host has.
  2247. # Note that only multiples of 4 are usable as the two rightmost bits have
  2248. # been redefined for use by ECN (RFC 3168 section 23.1).
  2249. # The squid parser will enforce this by masking away the ECN bits.
  2250. #
  2251. # This clause only supports fast acl types.
  2252. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  2253. #Default:
  2254. # none
  2255.  
  2256. # TAG: tcp_outgoing_mark
  2257. # Note: This option is only available if Squid is rebuilt with the
  2258. # Packet MARK (Linux)
  2259. #
  2260. # Allows you to apply a Netfilter mark value to outgoing packets
  2261. # on the server side, based on an ACL.
  2262. #
  2263. # tcp_outgoing_mark mark-value [!]aclname ...
  2264. #
  2265. # Example where normal_service_net uses the mark value 0x00
  2266. # and good_service_net uses 0x20
  2267. #
  2268. # acl normal_service_net src 10.0.0.0/24
  2269. # acl good_service_net src 10.0.1.0/24
  2270. # tcp_outgoing_mark 0x00 normal_service_net
  2271. # tcp_outgoing_mark 0x20 good_service_net
  2272. #
  2273. # Only fast ACLs are supported.
  2274. #Default:
  2275. # none
  2276.  
  2277. # TAG: mark_client_packet
  2278. # Note: This option is only available if Squid is rebuilt with the
  2279. # Packet MARK (Linux)
  2280. #
  2281. # Allows you to apply a Netfilter MARK value to packets being transmitted
  2282. # on the client-side, based on an ACL.
  2283. #
  2284. # mark_client_packet mark-value [!]aclname ...
  2285. #
  2286. # Example where normal_service_net uses the MARK value 0x00
  2287. # and good_service_net uses 0x20
  2288. #
  2289. # acl normal_service_net src 10.0.0.0/24
  2290. # acl good_service_net src 10.0.1.0/24
  2291. # mark_client_packet 0x00 normal_service_net
  2292. # mark_client_packet 0x20 good_service_net
  2293. #
  2294. # Note: This feature is incompatible with qos_flows. Any mark values set here
  2295. # will be overwritten by mark values in qos_flows.
  2296. #
  2297. # This clause only supports fast acl types.
  2298. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  2299. #Default:
  2300. # none
  2301.  
  2302. # TAG: mark_client_connection
  2303. # Note: This option is only available if Squid is rebuilt with the
  2304. # Packet MARK (Linux)
  2305. #
  2306. # Allows you to apply a Netfilter CONNMARK value to a connection
  2307. # on the client-side, based on an ACL.
  2308. #
  2309. # mark_client_connection mark-value[/mask] [!]aclname ...
  2310. #
  2311. # The mark-value and mask are unsigned integers (hex, octal, or decimal).
  2312. # The mask may be used to preserve marking previously set by other agents
  2313. # (e.g., iptables).
  2314. #
  2315. # A matching rule replaces the CONNMARK value. If a mask is also
  2316. # specified, then the masked bits of the original value are zeroed, and
  2317. # the configured mark-value is ORed with that adjusted value.
  2318. # For example, applying a mark-value 0xAB/0xF to 0x5F CONNMARK, results
  2319. # in a 0xFB marking (rather than a 0xAB or 0x5B).
  2320. #
  2321. # This directive semantics is similar to iptables --set-mark rather than
  2322. # --set-xmark functionality.
  2323. #
  2324. # The directive does not interfere with qos_flows (which uses packet MARKs,
  2325. # not CONNMARKs).
  2326. #
  2327. # Example where squid marks intercepted FTP connections:
  2328. #
  2329. # acl proto_ftp proto FTP
  2330. # mark_client_connection 0x200/0xff00 proto_ftp
  2331. #
  2332. # This clause only supports fast acl types.
  2333. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  2334. #Default:
  2335. # none
  2336.  
  2337. # TAG: qos_flows
  2338. # Allows you to select a TOS/DSCP value to mark outgoing
  2339. # connections to the client, based on where the reply was sourced.
  2340. # For platforms using netfilter, allows you to set a netfilter mark
  2341. # value instead of, or in addition to, a TOS value.
  2342. #
  2343. # By default this functionality is disabled. To enable it with the default
  2344. # settings simply use "qos_flows mark" or "qos_flows tos". Default
  2345. # settings will result in the netfilter mark or TOS value being copied
  2346. # from the upstream connection to the client. Note that it is the connection
  2347. # CONNMARK value not the packet MARK value that is copied.
  2348. #
  2349. # It is not currently possible to copy the mark or TOS value from the
  2350. # client to the upstream connection request.
  2351. #
  2352. # TOS values really only have local significance - so you should
  2353. # know what you're specifying. For more information, see RFC2474,
  2354. # RFC2475, and RFC3260.
  2355. #
  2356. # The TOS/DSCP byte must be exactly that - a octet value 0 - 255.
  2357. # Note that only multiples of 4 are usable as the two rightmost bits have
  2358. # been redefined for use by ECN (RFC 3168 section 23.1).
  2359. # The squid parser will enforce this by masking away the ECN bits.
  2360. #
  2361. # Mark values can be any unsigned 32-bit integer value.
  2362. #
  2363. # This setting is configured by setting the following values:
  2364. #
  2365. # tos|mark Whether to set TOS or netfilter mark values
  2366. #
  2367. # local-hit=0xFF Value to mark local cache hits.
  2368. #
  2369. # sibling-hit=0xFF Value to mark hits from sibling peers.
  2370. #
  2371. # parent-hit=0xFF Value to mark hits from parent peers.
  2372. #
  2373. # miss=0xFF[/mask] Value to mark cache misses. Takes precedence
  2374. # over the preserve-miss feature (see below), unless
  2375. # mask is specified, in which case only the bits
  2376. # specified in the mask are written.
  2377. #
  2378. # The TOS variant of the following features are only possible on Linux
  2379. # and require your kernel to be patched with the TOS preserving ZPH
  2380. # patch, available from http://zph.bratcheda.org
  2381. # No patch is needed to preserve the netfilter mark, which will work
  2382. # with all variants of netfilter.
  2383. #
  2384. # disable-preserve-miss
  2385. # This option disables the preservation of the TOS or netfilter
  2386. # mark. By default, the existing TOS or netfilter mark value of
  2387. # the response coming from the remote server will be retained
  2388. # and masked with miss-mark.
  2389. # NOTE: in the case of a netfilter mark, the mark must be set on
  2390. # the connection (using the CONNMARK target) not on the packet
  2391. # (MARK target).
  2392. #
  2393. # miss-mask=0xFF
  2394. # Allows you to mask certain bits in the TOS or mark value
  2395. # received from the remote server, before copying the value to
  2396. # the TOS sent towards clients.
  2397. # Default for tos: 0xFF (TOS from server is not changed).
  2398. # Default for mark: 0xFFFFFFFF (mark from server is not changed).
  2399. #
  2400. # All of these features require the --enable-zph-qos compilation flag
  2401. # (enabled by default). Netfilter marking also requires the
  2402. # libnetfilter_conntrack libraries (--with-netfilter-conntrack) and
  2403. # libcap 2.09+ (--with-libcap).
  2404. #
  2405. #Default:
  2406. # none
  2407.  
  2408. # TAG: tcp_outgoing_address
  2409. # Allows you to map requests to different outgoing IP addresses
  2410. # based on the username or source address of the user making
  2411. # the request.
  2412. #
  2413. # tcp_outgoing_address ipaddr [[!]aclname] ...
  2414. #
  2415. # For example;
  2416. # Forwarding clients with dedicated IPs for certain subnets.
  2417. #
  2418. # acl normal_service_net src 10.0.0.0/24
  2419. # acl good_service_net src 10.0.2.0/24
  2420. #
  2421. # tcp_outgoing_address 2001:db8::c001 good_service_net
  2422. # tcp_outgoing_address 10.1.0.2 good_service_net
  2423. #
  2424. # tcp_outgoing_address 2001:db8::beef normal_service_net
  2425. # tcp_outgoing_address 10.1.0.1 normal_service_net
  2426. #
  2427. # tcp_outgoing_address 2001:db8::1
  2428. # tcp_outgoing_address 10.1.0.3
  2429. #
  2430. # Processing proceeds in the order specified, and stops at first fully
  2431. # matching line.
  2432. #
  2433. # Squid will add an implicit IP version test to each line.
  2434. # Requests going to IPv4 websites will use the outgoing 10.1.0.* addresses.
  2435. # Requests going to IPv6 websites will use the outgoing 2001:db8:* addresses.
  2436. #
  2437. #
  2438. # NOTE: The use of this directive using client dependent ACLs is
  2439. # incompatible with the use of server side persistent connections. To
  2440. # ensure correct results it is best to set server_persistent_connections
  2441. # to off when using this directive in such configurations.
  2442. #
  2443. # NOTE: The use of this directive to set a local IP on outgoing TCP links
  2444. # is incompatible with using TPROXY to set client IP out outbound TCP links.
  2445. # When needing to contact peers use the no-tproxy cache_peer option and the
  2446. # client_dst_passthru directive re-enable normal forwarding such as this.
  2447. #
  2448. # This clause only supports fast acl types.
  2449. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  2450. #Default:
  2451. # Address selection is performed by the operating system.
  2452.  
  2453. # TAG: host_verify_strict
  2454. # Regardless of this option setting, when dealing with intercepted
  2455. # traffic, Squid always verifies that the destination IP address matches
  2456. # the Host header domain or IP (called 'authority form URL').
  2457. #
  2458. # This enforcement is performed to satisfy a MUST-level requirement in
  2459. # RFC 2616 section 14.23: "The Host field value MUST represent the naming
  2460. # authority of the origin server or gateway given by the original URL".
  2461. #
  2462. # When set to ON:
  2463. # Squid always responds with an HTTP 409 (Conflict) error
  2464. # page and logs a security warning if there is no match.
  2465. #
  2466. # Squid verifies that the destination IP address matches
  2467. # the Host header for forward-proxy and reverse-proxy traffic
  2468. # as well. For those traffic types, Squid also enables the
  2469. # following checks, comparing the corresponding Host header
  2470. # and Request-URI components:
  2471. #
  2472. # * The host names (domain or IP) must be identical,
  2473. # but valueless or missing Host header disables all checks.
  2474. # For the two host names to match, both must be either IP
  2475. # or FQDN.
  2476. #
  2477. # * Port numbers must be identical, but if a port is missing
  2478. # the scheme-default port is assumed.
  2479. #
  2480. #
  2481. # When set to OFF (the default):
  2482. # Squid allows suspicious requests to continue but logs a
  2483. # security warning and blocks caching of the response.
  2484. #
  2485. # * Forward-proxy traffic is not checked at all.
  2486. #
  2487. # * Reverse-proxy traffic is not checked at all.
  2488. #
  2489. # * Intercepted traffic which passes verification is handled
  2490. # according to client_dst_passthru.
  2491. #
  2492. # * Intercepted requests which fail verification are sent
  2493. # to the client original destination instead of DIRECT.
  2494. # This overrides 'client_dst_passthru off'.
  2495. #
  2496. # For now suspicious intercepted CONNECT requests are always
  2497. # responded to with an HTTP 409 (Conflict) error page.
  2498. #
  2499. #
  2500. # SECURITY NOTE:
  2501. #
  2502. # As described in CVE-2009-0801 when the Host: header alone is used
  2503. # to determine the destination of a request it becomes trivial for
  2504. # malicious scripts on remote websites to bypass browser same-origin
  2505. # security policy and sandboxing protections.
  2506. #
  2507. # The cause of this is that such applets are allowed to perform their
  2508. # own HTTP stack, in which case the same-origin policy of the browser
  2509. # sandbox only verifies that the applet tries to contact the same IP
  2510. # as from where it was loaded at the IP level. The Host: header may
  2511. # be different from the connected IP and approved origin.
  2512. #
  2513. #Default:
  2514. # host_verify_strict off
  2515.  
  2516. # TAG: client_dst_passthru
  2517. # With NAT or TPROXY intercepted traffic Squid may pass the request
  2518. # directly to the original client destination IP or seek a faster
  2519. # source using the HTTP Host header.
  2520. #
  2521. # Using Host to locate alternative servers can provide faster
  2522. # connectivity with a range of failure recovery options.
  2523. # But can also lead to connectivity trouble when the client and
  2524. # server are attempting stateful interactions unaware of the proxy.
  2525. #
  2526. # This option (on by default) prevents alternative DNS entries being
  2527. # located to send intercepted traffic DIRECT to an origin server.
  2528. # The clients original destination IP and port will be used instead.
  2529. #
  2530. # Regardless of this option setting, when dealing with intercepted
  2531. # traffic Squid will verify the Host: header and any traffic which
  2532. # fails Host verification will be treated as if this option were ON.
  2533. #
  2534. # see host_verify_strict for details on the verification process.
  2535. #Default:
  2536. # client_dst_passthru on
  2537.  
  2538. # TLS OPTIONS
  2539. # -----------------------------------------------------------------------------
  2540.  
  2541. # TAG: tls_outgoing_options
  2542. # disable Do not support https:// URLs.
  2543. #
  2544. # cert=/path/to/client/certificate
  2545. # A client X.509 certificate to use when connecting.
  2546. #
  2547. # key=/path/to/client/private_key
  2548. # The private key corresponding to the cert= above.
  2549. #
  2550. # If key= is not specified cert= is assumed to
  2551. # reference a PEM file containing both the certificate
  2552. # and private key.
  2553. #
  2554. # cipher=... The list of valid TLS ciphers to use.
  2555. #
  2556. # min-version=1.N
  2557. # The minimum TLS protocol version to permit.
  2558. # To control SSLv3 use the options= parameter.
  2559. # Supported Values: 1.0 (default), 1.1, 1.2, 1.3
  2560. #
  2561. # options=... Specify various TLS/SSL implementation options.
  2562. #
  2563. # OpenSSL options most important are:
  2564. #
  2565. # NO_SSLv3 Disallow the use of SSLv3
  2566. #
  2567. # SINGLE_DH_USE
  2568. # Always create a new key when using
  2569. # temporary/ephemeral DH key exchanges
  2570. #
  2571. # NO_TICKET
  2572. # Disable use of RFC5077 session tickets.
  2573. # Some servers may have problems
  2574. # understanding the TLS extension due
  2575. # to ambiguous specification in RFC4507.
  2576. #
  2577. # ALL Enable various bug workarounds
  2578. # suggested as "harmless" by OpenSSL
  2579. # Be warned that this reduces SSL/TLS
  2580. # strength to some attacks.
  2581. #
  2582. # See the OpenSSL SSL_CTX_set_options documentation
  2583. # for a more complete list.
  2584. #
  2585. # GnuTLS options most important are:
  2586. #
  2587. # %NO_TICKETS
  2588. # Disable use of RFC5077 session tickets.
  2589. # Some servers may have problems
  2590. # understanding the TLS extension due
  2591. # to ambiguous specification in RFC4507.
  2592. #
  2593. # See the GnuTLS Priority Strings documentation
  2594. # for a more complete list.
  2595. # http://www.gnutls.org/manual/gnutls.html#Priority-Strings
  2596. #
  2597. #
  2598. # cafile= PEM file containing CA certificates to use when verifying
  2599. # the peer certificate. May be repeated to load multiple files.
  2600. #
  2601. # capath= A directory containing additional CA certificates to
  2602. # use when verifying the peer certificate.
  2603. # Requires OpenSSL or LibreSSL.
  2604. #
  2605. # crlfile=... A certificate revocation list file to use when
  2606. # verifying the peer certificate.
  2607. #
  2608. # flags=... Specify various flags modifying the TLS implementation:
  2609. #
  2610. # DONT_VERIFY_PEER
  2611. # Accept certificates even if they fail to
  2612. # verify.
  2613. # DONT_VERIFY_DOMAIN
  2614. # Don't verify the peer certificate
  2615. # matches the server name
  2616. #
  2617. # default-ca[=off]
  2618. # Whether to use the system Trusted CAs. Default is ON.
  2619. #
  2620. # domain= The peer name as advertised in its certificate.
  2621. # Used for verifying the correctness of the received peer
  2622. # certificate. If not specified the peer hostname will be
  2623. # used.
  2624. #Default:
  2625. # tls_outgoing_options min-version=1.0
  2626.  
  2627. # SSL OPTIONS
  2628. # -----------------------------------------------------------------------------
  2629.  
  2630. # TAG: ssl_unclean_shutdown
  2631. # Note: This option is only available if Squid is rebuilt with the
  2632. # --with-openssl
  2633. #
  2634. # Some browsers (especially MSIE) bugs out on SSL shutdown
  2635. # messages.
  2636. #Default:
  2637. # ssl_unclean_shutdown off
  2638.  
  2639. # TAG: ssl_engine
  2640. # Note: This option is only available if Squid is rebuilt with the
  2641. # --with-openssl
  2642. #
  2643. # The OpenSSL engine to use. You will need to set this if you
  2644. # would like to use hardware SSL acceleration for example.
  2645. #
  2646. # Note: OpenSSL 3.0 and newer do not provide Engine support.
  2647. #Default:
  2648. # none
  2649.  
  2650. # TAG: sslproxy_session_ttl
  2651. # Note: This option is only available if Squid is rebuilt with the
  2652. # --with-openssl
  2653. #
  2654. # Sets the timeout value for SSL sessions
  2655. #Default:
  2656. # sslproxy_session_ttl 300
  2657.  
  2658. # TAG: sslproxy_session_cache_size
  2659. # Note: This option is only available if Squid is rebuilt with the
  2660. # --with-openssl
  2661. #
  2662. # Sets the cache size to use for ssl session
  2663. #Default:
  2664. # sslproxy_session_cache_size 2 MB
  2665.  
  2666. # TAG: sslproxy_foreign_intermediate_certs
  2667. # Note: This option is only available if Squid is rebuilt with the
  2668. # --with-openssl
  2669. #
  2670. # Many origin servers fail to send their full server certificate
  2671. # chain for verification, assuming the client already has or can
  2672. # easily locate any missing intermediate certificates.
  2673. #
  2674. # Squid uses the certificates from the specified file to fill in
  2675. # these missing chains when trying to validate origin server
  2676. # certificate chains.
  2677. #
  2678. # The file is expected to contain zero or more PEM-encoded
  2679. # intermediate certificates. These certificates are not treated
  2680. # as trusted root certificates, and any self-signed certificate in
  2681. # this file will be ignored.
  2682. #Default:
  2683. # none
  2684.  
  2685. # TAG: sslproxy_cert_sign_hash
  2686. # Note: This option is only available if Squid is rebuilt with the
  2687. # --with-openssl
  2688. #
  2689. # Sets the hashing algorithm to use when signing generated certificates.
  2690. # Valid algorithm names depend on the OpenSSL library used. The following
  2691. # names are usually available: sha1, sha256, sha512, and md5. Please see
  2692. # your OpenSSL library manual for the available hashes. By default, Squids
  2693. # that support this option use sha256 hashes.
  2694. #
  2695. # Squid does not forcefully purge cached certificates that were generated
  2696. # with an algorithm other than the currently configured one. They remain
  2697. # in the cache, subject to the regular cache eviction policy, and become
  2698. # useful if the algorithm changes again.
  2699. #Default:
  2700. # none
  2701.  
  2702. # TAG: ssl_bump
  2703. # Note: This option is only available if Squid is rebuilt with the
  2704. # --with-openssl
  2705. #
  2706. # This option is consulted when a CONNECT request is received on
  2707. # an http_port (or a new connection is intercepted at an
  2708. # https_port), provided that port was configured with an ssl-bump
  2709. # flag. The subsequent data on the connection is either treated as
  2710. # HTTPS and decrypted OR tunneled at TCP level without decryption,
  2711. # depending on the first matching bumping "action".
  2712. #
  2713. # ssl_bump <action> [!]acl ...
  2714. #
  2715. # The following bumping actions are currently supported:
  2716. #
  2717. # splice
  2718. # Become a TCP tunnel without decrypting proxied traffic.
  2719. # This is the default action.
  2720. #
  2721. # bump
  2722. # When used on step SslBump1, establishes a secure connection
  2723. # with the client first, then connect to the server.
  2724. # When used on step SslBump2 or SslBump3, establishes a secure
  2725. # connection with the server and, using a mimicked server
  2726. # certificate, with the client.
  2727. #
  2728. # peek
  2729. # Receive client (step SslBump1) or server (step SslBump2)
  2730. # certificate while preserving the possibility of splicing the
  2731. # connection. Peeking at the server certificate (during step 2)
  2732. # usually precludes bumping of the connection at step 3.
  2733. #
  2734. # stare
  2735. # Receive client (step SslBump1) or server (step SslBump2)
  2736. # certificate while preserving the possibility of bumping the
  2737. # connection. Staring at the server certificate (during step 2)
  2738. # usually precludes splicing of the connection at step 3.
  2739. #
  2740. # terminate
  2741. # Close client and server connections.
  2742. #
  2743. # Backward compatibility actions available at step SslBump1:
  2744. #
  2745. # client-first
  2746. # Bump the connection. Establish a secure connection with the
  2747. # client first, then connect to the server. This old mode does
  2748. # not allow Squid to mimic server SSL certificate and does not
  2749. # work with intercepted SSL connections.
  2750. #
  2751. # server-first
  2752. # Bump the connection. Establish a secure connection with the
  2753. # server first, then establish a secure connection with the
  2754. # client, using a mimicked server certificate. Works with both
  2755. # CONNECT requests and intercepted SSL connections, but does
  2756. # not allow to make decisions based on SSL handshake info.
  2757. #
  2758. # peek-and-splice
  2759. # Decide whether to bump or splice the connection based on
  2760. # client-to-squid and server-to-squid SSL hello messages.
  2761. # XXX: Remove.
  2762. #
  2763. # none
  2764. # Same as the "splice" action.
  2765. #
  2766. # All ssl_bump rules are evaluated at each of the supported bumping
  2767. # steps. Rules with actions that are impossible at the current step are
  2768. # ignored. The first matching ssl_bump action wins and is applied at the
  2769. # end of the current step. If no rules match, the splice action is used.
  2770. # See the at_step ACL for a list of the supported SslBump steps.
  2771. #
  2772. # This clause supports both fast and slow acl types.
  2773. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  2774. #
  2775. # See also: http_port ssl-bump, https_port ssl-bump, and acl at_step.
  2776. #
  2777. #
  2778. # # Example: Bump all TLS connections except those originating from
  2779. # # localhost or those going to example.com.
  2780. #
  2781. # acl broken_sites ssl::server_name .example.com
  2782. # ssl_bump splice localhost
  2783. # ssl_bump splice broken_sites
  2784. # ssl_bump bump all
  2785. #Default:
  2786. # Become a TCP tunnel without decrypting proxied traffic.
  2787.  
  2788. # TAG: sslproxy_cert_error
  2789. # Note: This option is only available if Squid is rebuilt with the
  2790. # --with-openssl
  2791. #
  2792. # Use this ACL to bypass server certificate validation errors.
  2793. #
  2794. # For example, the following lines will bypass all validation errors
  2795. # when talking to servers for example.com. All other
  2796. # validation errors will result in ERR_SECURE_CONNECT_FAIL error.
  2797. #
  2798. # acl BrokenButTrustedServers dstdomain example.com
  2799. # sslproxy_cert_error allow BrokenButTrustedServers
  2800. # sslproxy_cert_error deny all
  2801. #
  2802. # This clause only supports fast acl types.
  2803. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  2804. # Using slow acl types may result in server crashes
  2805. #
  2806. # Without this option, all server certificate validation errors
  2807. # terminate the transaction to protect Squid and the client.
  2808. #
  2809. # SQUID_X509_V_ERR_INFINITE_VALIDATION error cannot be bypassed
  2810. # but should not happen unless your OpenSSL library is buggy.
  2811. #
  2812. # SECURITY WARNING:
  2813. # Bypassing validation errors is dangerous because an
  2814. # error usually implies that the server cannot be trusted
  2815. # and the connection may be insecure.
  2816. #
  2817. # See also: sslproxy_flags and DONT_VERIFY_PEER.
  2818. #Default:
  2819. # Server certificate errors terminate the transaction.
  2820.  
  2821. # TAG: sslproxy_cert_sign
  2822. # Note: This option is only available if Squid is rebuilt with the
  2823. # --with-openssl
  2824. #
  2825. #
  2826. # sslproxy_cert_sign <signing algorithm> acl ...
  2827. #
  2828. # The following certificate signing algorithms are supported:
  2829. #
  2830. # signTrusted
  2831. # Sign using the configured CA certificate which is usually
  2832. # placed in and trusted by end-user browsers. This is the
  2833. # default for trusted origin server certificates.
  2834. #
  2835. # signUntrusted
  2836. # Sign to guarantee an X509_V_ERR_CERT_UNTRUSTED browser error.
  2837. # This is the default for untrusted origin server certificates
  2838. # that are not self-signed (see ssl::certUntrusted).
  2839. #
  2840. # signSelf
  2841. # Sign using a self-signed certificate with the right CN to
  2842. # generate a X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT error in the
  2843. # browser. This is the default for self-signed origin server
  2844. # certificates (see ssl::certSelfSigned).
  2845. #
  2846. # This clause only supports fast acl types.
  2847. #
  2848. # When sslproxy_cert_sign acl(s) match, Squid uses the corresponding
  2849. # signing algorithm to generate the certificate and ignores all
  2850. # subsequent sslproxy_cert_sign options (the first match wins). If no
  2851. # acl(s) match, the default signing algorithm is determined by errors
  2852. # detected when obtaining and validating the origin server certificate.
  2853. #
  2854. # WARNING: SQUID_X509_V_ERR_DOMAIN_MISMATCH and ssl:certDomainMismatch can
  2855. # be used with sslproxy_cert_adapt, but if and only if Squid is bumping a
  2856. # CONNECT request that carries a domain name. In all other cases (CONNECT
  2857. # to an IP address or an intercepted SSL connection), Squid cannot detect
  2858. # the domain mismatch at certificate generation time when
  2859. # bump-server-first is used.
  2860. #Default:
  2861. # none
  2862.  
  2863. # TAG: sslproxy_cert_adapt
  2864. # Note: This option is only available if Squid is rebuilt with the
  2865. # --with-openssl
  2866. #
  2867. #
  2868. # sslproxy_cert_adapt <adaptation algorithm> acl ...
  2869. #
  2870. # The following certificate adaptation algorithms are supported:
  2871. #
  2872. # setValidAfter
  2873. # Sets the "Not After" property to the "Not After" property of
  2874. # the CA certificate used to sign generated certificates.
  2875. #
  2876. # setValidBefore
  2877. # Sets the "Not Before" property to the "Not Before" property of
  2878. # the CA certificate used to sign generated certificates.
  2879. #
  2880. # setCommonName or setCommonName{CN}
  2881. # Sets Subject.CN property to the host name specified as a
  2882. # CN parameter or, if no explicit CN parameter was specified,
  2883. # extracted from the CONNECT request. It is a misconfiguration
  2884. # to use setCommonName without an explicit parameter for
  2885. # intercepted or tproxied SSL connections.
  2886. #
  2887. # This clause only supports fast acl types.
  2888. #
  2889. # Squid first groups sslproxy_cert_adapt options by adaptation algorithm.
  2890. # Within a group, when sslproxy_cert_adapt acl(s) match, Squid uses the
  2891. # corresponding adaptation algorithm to generate the certificate and
  2892. # ignores all subsequent sslproxy_cert_adapt options in that algorithm's
  2893. # group (i.e., the first match wins within each algorithm group). If no
  2894. # acl(s) match, the default mimicking action takes place.
  2895. #
  2896. # WARNING: SQUID_X509_V_ERR_DOMAIN_MISMATCH and ssl:certDomainMismatch can
  2897. # be used with sslproxy_cert_adapt, but if and only if Squid is bumping a
  2898. # CONNECT request that carries a domain name. In all other cases (CONNECT
  2899. # to an IP address or an intercepted SSL connection), Squid cannot detect
  2900. # the domain mismatch at certificate generation time when
  2901. # bump-server-first is used.
  2902. #Default:
  2903. # none
  2904.  
  2905. # TAG: sslpassword_program
  2906. # Note: This option is only available if Squid is rebuilt with the
  2907. # --with-openssl
  2908. #
  2909. # Specify a program used for entering SSL key passphrases
  2910. # when using encrypted SSL certificate keys. If not specified
  2911. # keys must either be unencrypted, or Squid started with the -N
  2912. # option to allow it to query interactively for the passphrase.
  2913. #
  2914. # The key file name is given as argument to the program allowing
  2915. # selection of the right password if you have multiple encrypted
  2916. # keys.
  2917. #Default:
  2918. # none
  2919.  
  2920. # OPTIONS RELATING TO EXTERNAL SSL_CRTD
  2921. # -----------------------------------------------------------------------------
  2922.  
  2923. # TAG: sslcrtd_program
  2924. # Note: This option is only available if Squid is rebuilt with the
  2925. # --enable-ssl-crtd
  2926. #
  2927. # Specify the location and options of the executable for certificate
  2928. # generator.
  2929. #
  2930. # /usr/lib/squid/security_file_certgen program can use a disk cache to improve response
  2931. # times on repeated requests. To enable caching, specify -s and -M
  2932. # parameters. If those parameters are not given, the program generates
  2933. # a new certificate on every request.
  2934. #
  2935. # For more information use:
  2936. # /usr/lib/squid/security_file_certgen -h
  2937. #Default:
  2938. # sslcrtd_program /usr/lib/squid/security_file_certgen -s /var/spool/squid/ssl_db -M 4MB
  2939.  
  2940. # TAG: sslcrtd_children
  2941. # Note: This option is only available if Squid is rebuilt with the
  2942. # --enable-ssl-crtd
  2943. #
  2944. # Specifies the maximum number of certificate generation processes that
  2945. # Squid may spawn (numberofchildren) and several related options. Using
  2946. # too few of these helper processes (a.k.a. "helpers") creates request
  2947. # queues. Using too many helpers wastes your system resources. Squid
  2948. # does not support spawning more than 32 helpers.
  2949. #
  2950. # Usage: numberofchildren [option]...
  2951. #
  2952. # The startup= and idle= options allow some measure of skew in your
  2953. # tuning.
  2954. #
  2955. # startup=N
  2956. #
  2957. # Sets the minimum number of processes to spawn when Squid
  2958. # starts or reconfigures. When set to zero the first request will
  2959. # cause spawning of the first child process to handle it.
  2960. #
  2961. # Starting too few children temporary slows Squid under load while it
  2962. # tries to spawn enough additional processes to cope with traffic.
  2963. #
  2964. # idle=N
  2965. #
  2966. # Sets a minimum of how many processes Squid is to try and keep available
  2967. # at all times. When traffic begins to rise above what the existing
  2968. # processes can handle this many more will be spawned up to the maximum
  2969. # configured. A minimum setting of 1 is required.
  2970. #
  2971. # queue-size=N
  2972. #
  2973. # Sets the maximum number of queued requests. A request is queued when
  2974. # no existing child is idle and no new child can be started due to
  2975. # numberofchildren limit. If the queued requests exceed queue size for
  2976. # more than 3 minutes squid aborts its operation. The default value is
  2977. # set to 2*numberofchildren.
  2978. #
  2979. # You must have at least one ssl_crtd process.
  2980. #Default:
  2981. # sslcrtd_children 32 startup=5 idle=1
  2982.  
  2983. # TAG: sslcrtvalidator_program
  2984. # Note: This option is only available if Squid is rebuilt with the
  2985. # --with-openssl
  2986. #
  2987. # Specify the location and options of the executable for ssl_crt_validator
  2988. # process.
  2989. #
  2990. # Usage: sslcrtvalidator_program [ttl=n] [cache=n] path ...
  2991. #
  2992. # Options:
  2993. # ttl=n TTL in seconds for cached results. The default is 60 secs
  2994. # cache=n limit the result cache size. The default value is 2048
  2995. #Default:
  2996. # none
  2997.  
  2998. # TAG: sslcrtvalidator_children
  2999. # Note: This option is only available if Squid is rebuilt with the
  3000. # --with-openssl
  3001. #
  3002. # Specifies the maximum number of certificate validation processes that
  3003. # Squid may spawn (numberofchildren) and several related options. Using
  3004. # too few of these helper processes (a.k.a. "helpers") creates request
  3005. # queues. Using too many helpers wastes your system resources. Squid
  3006. # does not support spawning more than 32 helpers.
  3007. #
  3008. # Usage: numberofchildren [option]...
  3009. #
  3010. # The startup= and idle= options allow some measure of skew in your
  3011. # tuning.
  3012. #
  3013. # startup=N
  3014. #
  3015. # Sets the minimum number of processes to spawn when Squid
  3016. # starts or reconfigures. When set to zero the first request will
  3017. # cause spawning of the first child process to handle it.
  3018. #
  3019. # Starting too few children temporary slows Squid under load while it
  3020. # tries to spawn enough additional processes to cope with traffic.
  3021. #
  3022. # idle=N
  3023. #
  3024. # Sets a minimum of how many processes Squid is to try and keep available
  3025. # at all times. When traffic begins to rise above what the existing
  3026. # processes can handle this many more will be spawned up to the maximum
  3027. # configured. A minimum setting of 1 is required.
  3028. #
  3029. # concurrency=
  3030. #
  3031. # The number of requests each certificate validator helper can handle in
  3032. # parallel. A value of 0 indicates the certficate validator does not
  3033. # support concurrency. Defaults to 1.
  3034. #
  3035. # When this directive is set to a value >= 1 then the protocol
  3036. # used to communicate with the helper is modified to include
  3037. # a request ID in front of the request/response. The request
  3038. # ID from the request must be echoed back with the response
  3039. # to that request.
  3040. #
  3041. # queue-size=N
  3042. #
  3043. # Sets the maximum number of queued requests. A request is queued when
  3044. # no existing child can accept it due to concurrency limit and no new
  3045. # child can be started due to numberofchildren limit. If the queued
  3046. # requests exceed queue size for more than 3 minutes squid aborts its
  3047. # operation. The default value is set to 2*numberofchildren.
  3048. #
  3049. # You must have at least one ssl_crt_validator process.
  3050. #Default:
  3051. # sslcrtvalidator_children 32 startup=5 idle=1 concurrency=1
  3052.  
  3053. # OPTIONS WHICH AFFECT THE NEIGHBOR SELECTION ALGORITHM
  3054. # -----------------------------------------------------------------------------
  3055.  
  3056. # TAG: cache_peer
  3057. # To specify other caches in a hierarchy, use the format:
  3058. #
  3059. # cache_peer hostname type http-port icp-port [options]
  3060. #
  3061. # For example,
  3062. #
  3063. # # proxy icp
  3064. # # hostname type port port options
  3065. # # -------------------- -------- ----- ----- -----------
  3066. # cache_peer parent.foo.net parent 3128 3130 default
  3067. # cache_peer sib1.foo.net sibling 3128 3130 proxy-only
  3068. # cache_peer sib2.foo.net sibling 3128 3130 proxy-only
  3069. # cache_peer example.com parent 80 0 default
  3070. # cache_peer cdn.example.com sibling 3128 0
  3071. #
  3072. # type: either 'parent', 'sibling', or 'multicast'.
  3073. #
  3074. # proxy-port: The port number where the peer accept HTTP requests.
  3075. # For other Squid proxies this is usually 3128
  3076. # For web servers this is usually 80
  3077. #
  3078. # icp-port: Used for querying neighbor caches about objects.
  3079. # Set to 0 if the peer does not support ICP or HTCP.
  3080. # See ICP and HTCP options below for additional details.
  3081. #
  3082. #
  3083. # ==== ICP OPTIONS ====
  3084. #
  3085. # You MUST also set icp_port and icp_access explicitly when using these options.
  3086. # The defaults will prevent peer traffic using ICP.
  3087. #
  3088. #
  3089. # no-query Disable ICP queries to this neighbor.
  3090. #
  3091. # multicast-responder
  3092. # Indicates the named peer is a member of a multicast group.
  3093. # ICP queries will not be sent directly to the peer, but ICP
  3094. # replies will be accepted from it.
  3095. #
  3096. # closest-only Indicates that, for ICP_OP_MISS replies, we'll only forward
  3097. # CLOSEST_PARENT_MISSes and never FIRST_PARENT_MISSes.
  3098. #
  3099. # background-ping
  3100. # To only send ICP queries to this neighbor infrequently.
  3101. # This is used to keep the neighbor round trip time updated
  3102. # and is usually used in conjunction with weighted-round-robin.
  3103. #
  3104. #
  3105. # ==== HTCP OPTIONS ====
  3106. #
  3107. # You MUST also set htcp_port and htcp_access explicitly when using these options.
  3108. # The defaults will prevent peer traffic using HTCP.
  3109. #
  3110. #
  3111. # htcp Send HTCP, instead of ICP, queries to the neighbor.
  3112. # You probably also want to set the "icp-port" to 4827
  3113. # instead of 3130. This directive accepts a comma separated
  3114. # list of options described below.
  3115. #
  3116. # htcp=oldsquid Send HTCP to old Squid versions (2.5 or earlier).
  3117. #
  3118. # htcp=no-clr Send HTCP to the neighbor but without
  3119. # sending any CLR requests. This cannot be used with
  3120. # only-clr.
  3121. #
  3122. # htcp=only-clr Send HTCP to the neighbor but ONLY CLR requests.
  3123. # This cannot be used with no-clr.
  3124. #
  3125. # htcp=no-purge-clr
  3126. # Send HTCP to the neighbor including CLRs but only when
  3127. # they do not result from PURGE requests.
  3128. #
  3129. # htcp=forward-clr
  3130. # Forward any HTCP CLR requests this proxy receives to the peer.
  3131. #
  3132. #
  3133. # ==== PEER SELECTION METHODS ====
  3134. #
  3135. # The default peer selection method is ICP, with the first responding peer
  3136. # being used as source. These options can be used for better load balancing.
  3137. #
  3138. #
  3139. # default This is a parent cache which can be used as a "last-resort"
  3140. # if a peer cannot be located by any of the peer-selection methods.
  3141. # If specified more than once, only the first is used.
  3142. #
  3143. # round-robin Load-Balance parents which should be used in a round-robin
  3144. # fashion in the absence of any ICP queries.
  3145. # weight=N can be used to add bias.
  3146. #
  3147. # weighted-round-robin
  3148. # Load-Balance parents which should be used in a round-robin
  3149. # fashion with the frequency of each parent being based on the
  3150. # round trip time. Closer parents are used more often.
  3151. # Usually used for background-ping parents.
  3152. # weight=N can be used to add bias.
  3153. #
  3154. # carp Load-Balance parents which should be used as a CARP array.
  3155. # The requests will be distributed among the parents based on the
  3156. # CARP load balancing hash function based on their weight.
  3157. #
  3158. # userhash Load-balance parents based on the client proxy_auth or ident username.
  3159. #
  3160. # sourcehash Load-balance parents based on the client source IP.
  3161. #
  3162. # multicast-siblings
  3163. # To be used only for cache peers of type "multicast".
  3164. # ALL members of this multicast group have "sibling"
  3165. # relationship with it, not "parent". This is to a multicast
  3166. # group when the requested object would be fetched only from
  3167. # a "parent" cache, anyway. It's useful, e.g., when
  3168. # configuring a pool of redundant Squid proxies, being
  3169. # members of the same multicast group.
  3170. #
  3171. #
  3172. # ==== PEER SELECTION OPTIONS ====
  3173. #
  3174. # weight=N use to affect the selection of a peer during any weighted
  3175. # peer-selection mechanisms.
  3176. # The weight must be an integer; default is 1,
  3177. # larger weights are favored more.
  3178. # This option does not affect parent selection if a peering
  3179. # protocol is not in use.
  3180. #
  3181. # basetime=N Specify a base amount to be subtracted from round trip
  3182. # times of parents.
  3183. # It is subtracted before division by weight in calculating
  3184. # which parent to fectch from. If the rtt is less than the
  3185. # base time the rtt is set to a minimal value.
  3186. #
  3187. # ttl=N Specify a TTL to use when sending multicast ICP queries
  3188. # to this address.
  3189. # Only useful when sending to a multicast group.
  3190. # Because we don't accept ICP replies from random
  3191. # hosts, you must configure other group members as
  3192. # peers with the 'multicast-responder' option.
  3193. #
  3194. # no-delay To prevent access to this neighbor from influencing the
  3195. # delay pools.
  3196. #
  3197. # digest-url=URL Tell Squid to fetch the cache digest (if digests are
  3198. # enabled) for this host from the specified URL rather
  3199. # than the Squid default location.
  3200. #
  3201. #
  3202. # ==== CARP OPTIONS ====
  3203. #
  3204. # carp-key=key-specification
  3205. # use a different key than the full URL to hash against the peer.
  3206. # the key-specification is a comma-separated list of the keywords
  3207. # scheme, host, port, path, params
  3208. # Order is not important.
  3209. #
  3210. # ==== ACCELERATOR / REVERSE-PROXY OPTIONS ====
  3211. #
  3212. # originserver Causes this parent to be contacted as an origin server.
  3213. # Meant to be used in accelerator setups when the peer
  3214. # is a web server.
  3215. #
  3216. # forceddomain=name
  3217. # Set the Host header of requests forwarded to this peer.
  3218. # Useful in accelerator setups where the server (peer)
  3219. # expects a certain domain name but clients may request
  3220. # others. ie example.com or www.example.com
  3221. #
  3222. # no-digest Disable request of cache digests.
  3223. #
  3224. # no-netdb-exchange
  3225. # Disables requesting ICMP RTT database (NetDB).
  3226. #
  3227. #
  3228. # ==== AUTHENTICATION OPTIONS ====
  3229. #
  3230. # login=user:password
  3231. # If this is a personal/workgroup proxy and your parent
  3232. # requires proxy authentication.
  3233. #
  3234. # Note: The string can include URL escapes (i.e. %20 for
  3235. # spaces). This also means % must be written as %%.
  3236. #
  3237. # login=PASSTHRU
  3238. # Send login details received from client to this peer.
  3239. # Both Proxy- and WWW-Authorization headers are passed
  3240. # without alteration to the peer.
  3241. # Authentication is not required by Squid for this to work.
  3242. #
  3243. # Note: This will pass any form of authentication but
  3244. # only Basic auth will work through a proxy unless the
  3245. # connection-auth options are also used.
  3246. #
  3247. # login=PASS Send login details received from client to this peer.
  3248. # Authentication is not required by this option.
  3249. #
  3250. # If there are no client-provided authentication headers
  3251. # to pass on, but username and password are available
  3252. # from an external ACL user= and password= result tags
  3253. # they may be sent instead.
  3254. #
  3255. # Note: To combine this with proxy_auth both proxies must
  3256. # share the same user database as HTTP only allows for
  3257. # a single login (one for proxy, one for origin server).
  3258. # Also be warned this will expose your users proxy
  3259. # password to the peer. USE WITH CAUTION
  3260. #
  3261. # login=*:password
  3262. # Send the username to the upstream cache, but with a
  3263. # fixed password. This is meant to be used when the peer
  3264. # is in another administrative domain, but it is still
  3265. # needed to identify each user.
  3266. # The star can optionally be followed by some extra
  3267. # information which is added to the username. This can
  3268. # be used to identify this proxy to the peer, similar to
  3269. # the login=username:password option above.
  3270. #
  3271. # login=NEGOTIATE
  3272. # If this is a personal/workgroup proxy and your parent
  3273. # requires a secure proxy authentication.
  3274. # The first principal from the default keytab or defined by
  3275. # the environment variable KRB5_KTNAME will be used.
  3276. #
  3277. # WARNING: The connection may transmit requests from multiple
  3278. # clients. Negotiate often assumes end-to-end authentication
  3279. # and a single-client. Which is not strictly true here.
  3280. #
  3281. # login=NEGOTIATE:principal_name
  3282. # If this is a personal/workgroup proxy and your parent
  3283. # requires a secure proxy authentication.
  3284. # The principal principal_name from the default keytab or
  3285. # defined by the environment variable KRB5_KTNAME will be
  3286. # used.
  3287. #
  3288. # WARNING: The connection may transmit requests from multiple
  3289. # clients. Negotiate often assumes end-to-end authentication
  3290. # and a single-client. Which is not strictly true here.
  3291. #
  3292. # connection-auth=on|off
  3293. # Tell Squid that this peer does or not support Microsoft
  3294. # connection oriented authentication, and any such
  3295. # challenges received from there should be ignored.
  3296. # Default is auto to automatically determine the status
  3297. # of the peer.
  3298. #
  3299. # auth-no-keytab
  3300. # Do not use a keytab to authenticate to a peer when
  3301. # login=NEGOTIATE is specified. Let the GSSAPI
  3302. # implementation determine which already existing
  3303. # credentials cache to use instead.
  3304. #
  3305. #
  3306. # ==== SSL / HTTPS / TLS OPTIONS ====
  3307. #
  3308. # tls Encrypt connections to this peer with TLS.
  3309. #
  3310. # sslcert=/path/to/ssl/certificate
  3311. # A client X.509 certificate to use when connecting to
  3312. # this peer.
  3313. #
  3314. # sslkey=/path/to/ssl/key
  3315. # The private key corresponding to sslcert above.
  3316. #
  3317. # If sslkey= is not specified sslcert= is assumed to
  3318. # reference a PEM file containing both the certificate
  3319. # and private key.
  3320. #
  3321. # Notes:
  3322. #
  3323. # On Debian/Ubuntu systems a default snakeoil certificate is
  3324. # available in /etc/ssl and users can set:
  3325. #
  3326. # sslcert=/etc/ssl/certs/ssl-cert-snakeoil.pem
  3327. #
  3328. # and
  3329. #
  3330. # sslkey=/etc/ssl/private/ssl-cert-snakeoil.key
  3331. #
  3332. # for testing.
  3333. #
  3334. # sslcipher=... The list of valid SSL ciphers to use when connecting
  3335. # to this peer.
  3336. #
  3337. # tls-min-version=1.N
  3338. # The minimum TLS protocol version to permit. To control
  3339. # SSLv3 use the tls-options= parameter.
  3340. # Supported Values: 1.0 (default), 1.1, 1.2
  3341. #
  3342. # tls-options=... Specify various TLS implementation options.
  3343. #
  3344. # OpenSSL options most important are:
  3345. #
  3346. # NO_SSLv3 Disallow the use of SSLv3
  3347. #
  3348. # SINGLE_DH_USE
  3349. # Always create a new key when using
  3350. # temporary/ephemeral DH key exchanges
  3351. #
  3352. # NO_TICKET
  3353. # Disable use of RFC5077 session tickets.
  3354. # Some servers may have problems
  3355. # understanding the TLS extension due
  3356. # to ambiguous specification in RFC4507.
  3357. #
  3358. # ALL Enable various bug workarounds
  3359. # suggested as "harmless" by OpenSSL
  3360. # Be warned that this reduces SSL/TLS
  3361. # strength to some attacks.
  3362. #
  3363. # See the OpenSSL SSL_CTX_set_options documentation for a
  3364. # more complete list.
  3365. #
  3366. # GnuTLS options most important are:
  3367. #
  3368. # %NO_TICKETS
  3369. # Disable use of RFC5077 session tickets.
  3370. # Some servers may have problems
  3371. # understanding the TLS extension due
  3372. # to ambiguous specification in RFC4507.
  3373. #
  3374. # See the GnuTLS Priority Strings documentation
  3375. # for a more complete list.
  3376. # http://www.gnutls.org/manual/gnutls.html#Priority-Strings
  3377. #
  3378. # tls-cafile= PEM file containing CA certificates to use when verifying
  3379. # the peer certificate. May be repeated to load multiple files.
  3380. #
  3381. # sslcapath=... A directory containing additional CA certificates to
  3382. # use when verifying the peer certificate.
  3383. # Requires OpenSSL or LibreSSL.
  3384. #
  3385. # sslcrlfile=... A certificate revocation list file to use when
  3386. # verifying the peer certificate.
  3387. #
  3388. # sslflags=... Specify various flags modifying the SSL implementation:
  3389. #
  3390. # DONT_VERIFY_PEER
  3391. # Accept certificates even if they fail to
  3392. # verify.
  3393. #
  3394. # DONT_VERIFY_DOMAIN
  3395. # Don't verify the peer certificate
  3396. # matches the server name
  3397. #
  3398. # ssldomain= The peer name as advertised in it's certificate.
  3399. # Used for verifying the correctness of the received peer
  3400. # certificate. If not specified the peer hostname will be
  3401. # used.
  3402. #
  3403. # front-end-https[=off|on|auto]
  3404. # Enable the "Front-End-Https: On" header needed when
  3405. # using Squid as a SSL frontend in front of Microsoft OWA.
  3406. # See MS KB document Q307347 for details on this header.
  3407. # If set to auto the header will only be added if the
  3408. # request is forwarded as a https:// URL.
  3409. #
  3410. # tls-default-ca[=off]
  3411. # Whether to use the system Trusted CAs. Default is ON.
  3412. #
  3413. # tls-no-npn Do not use the TLS NPN extension to advertise HTTP/1.1.
  3414. #
  3415. # ==== GENERAL OPTIONS ====
  3416. #
  3417. # connect-timeout=N
  3418. # A peer-specific connect timeout.
  3419. # Also see the peer_connect_timeout directive.
  3420. #
  3421. # connect-fail-limit=N
  3422. # How many times connecting to a peer must fail before
  3423. # it is marked as down. Standby connection failures
  3424. # count towards this limit. Default is 10.
  3425. #
  3426. # allow-miss Disable Squid's use of only-if-cached when forwarding
  3427. # requests to siblings. This is primarily useful when
  3428. # icp_hit_stale is used by the sibling. Excessive use
  3429. # of this option may result in forwarding loops. One way
  3430. # to prevent peering loops when using this option, is to
  3431. # deny cache peer usage on requests from a peer:
  3432. # acl fromPeer ...
  3433. # cache_peer_access peerName deny fromPeer
  3434. #
  3435. # max-conn=N Limit the number of concurrent connections the Squid
  3436. # may open to this peer, including already opened idle
  3437. # and standby connections. There is no peer-specific
  3438. # connection limit by default.
  3439. #
  3440. # A peer exceeding the limit is not used for new
  3441. # requests unless a standby connection is available.
  3442. #
  3443. # max-conn currently works poorly with idle persistent
  3444. # connections: When a peer reaches its max-conn limit,
  3445. # and there are idle persistent connections to the peer,
  3446. # the peer may not be selected because the limiting code
  3447. # does not know whether Squid can reuse those idle
  3448. # connections.
  3449. #
  3450. # standby=N Maintain a pool of N "hot standby" connections to an
  3451. # UP peer, available for requests when no idle
  3452. # persistent connection is available (or safe) to use.
  3453. # By default and with zero N, no such pool is maintained.
  3454. # N must not exceed the max-conn limit (if any).
  3455. #
  3456. # At start or after reconfiguration, Squid opens new TCP
  3457. # standby connections until there are N connections
  3458. # available and then replenishes the standby pool as
  3459. # opened connections are used up for requests. A used
  3460. # connection never goes back to the standby pool, but
  3461. # may go to the regular idle persistent connection pool
  3462. # shared by all peers and origin servers.
  3463. #
  3464. # Squid never opens multiple new standby connections
  3465. # concurrently. This one-at-a-time approach minimizes
  3466. # flooding-like effect on peers. Furthermore, just a few
  3467. # standby connections should be sufficient in most cases
  3468. # to supply most new requests with a ready-to-use
  3469. # connection.
  3470. #
  3471. # Standby connections obey server_idle_pconn_timeout.
  3472. # For the feature to work as intended, the peer must be
  3473. # configured to accept and keep them open longer than
  3474. # the idle timeout at the connecting Squid, to minimize
  3475. # race conditions typical to idle used persistent
  3476. # connections. Default request_timeout and
  3477. # server_idle_pconn_timeout values ensure such a
  3478. # configuration.
  3479. #
  3480. # name=xxx Unique name for the peer.
  3481. # Required if you have multiple peers on the same host
  3482. # but different ports.
  3483. # This name can be used in cache_peer_access and similar
  3484. # directives to identify the peer.
  3485. # Can be used by outgoing access controls through the
  3486. # peername ACL type.
  3487. #
  3488. # no-tproxy Do not use the client-spoof TPROXY support when forwarding
  3489. # requests to this peer. Use normal address selection instead.
  3490. # This overrides the spoof_client_ip ACL.
  3491. #
  3492. # proxy-only objects fetched from the peer will not be stored locally.
  3493. #
  3494. #Default:
  3495. # none
  3496.  
  3497. # TAG: cache_peer_access
  3498. # Restricts usage of cache_peer proxies.
  3499. #
  3500. # Usage:
  3501. # cache_peer_access peer-name allow|deny [!]aclname ...
  3502. #
  3503. # For the required peer-name parameter, use either the value of the
  3504. # cache_peer name=value parameter or, if name=value is missing, the
  3505. # cache_peer hostname parameter.
  3506. #
  3507. # This directive narrows down the selection of peering candidates, but
  3508. # does not determine the order in which the selected candidates are
  3509. # contacted. That order is determined by the peer selection algorithms
  3510. # (see PEER SELECTION sections in the cache_peer documentation).
  3511. #
  3512. # If a deny rule matches, the corresponding peer will not be contacted
  3513. # for the current transaction -- Squid will not send ICP queries and
  3514. # will not forward HTTP requests to that peer. An allow match leaves
  3515. # the corresponding peer in the selection. The first match for a given
  3516. # peer wins for that peer.
  3517. #
  3518. # The relative order of cache_peer_access directives for the same peer
  3519. # matters. The relative order of any two cache_peer_access directives
  3520. # for different peers does not matter. To ease interpretation, it is a
  3521. # good idea to group cache_peer_access directives for the same peer
  3522. # together.
  3523. #
  3524. # A single cache_peer_access directive may be evaluated multiple times
  3525. # for a given transaction because individual peer selection algorithms
  3526. # may check it independently from each other. These redundant checks
  3527. # may be optimized away in future Squid versions.
  3528. #
  3529. # This clause only supports fast acl types.
  3530. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  3531. #
  3532. #Default:
  3533. # No peer usage restrictions.
  3534.  
  3535. # TAG: neighbor_type_domain
  3536. # Modify the cache_peer neighbor type when passing requests
  3537. # about specific domains to the peer.
  3538. #
  3539. # Usage:
  3540. # neighbor_type_domain neighbor parent|sibling domain domain ...
  3541. #
  3542. # For example:
  3543. # cache_peer foo.example.com parent 3128 3130
  3544. # neighbor_type_domain foo.example.com sibling .au .de
  3545. #
  3546. # The above configuration treats all requests to foo.example.com as a
  3547. # parent proxy unless the request is for a .au or .de ccTLD domain name.
  3548. #Default:
  3549. # The peer type from cache_peer directive is used for all requests to that peer.
  3550.  
  3551. # TAG: dead_peer_timeout (seconds)
  3552. # This controls how long Squid waits to declare a peer cache
  3553. # as "dead." If there are no ICP replies received in this
  3554. # amount of time, Squid will declare the peer dead and not
  3555. # expect to receive any further ICP replies. However, it
  3556. # continues to send ICP queries, and will mark the peer as
  3557. # alive upon receipt of the first subsequent ICP reply.
  3558. #
  3559. # This timeout also affects when Squid expects to receive ICP
  3560. # replies from peers. If more than 'dead_peer' seconds have
  3561. # passed since the last ICP reply was received, Squid will not
  3562. # expect to receive an ICP reply on the next query. Thus, if
  3563. # your time between requests is greater than this timeout, you
  3564. # will see a lot of requests sent DIRECT to origin servers
  3565. # instead of to your parents.
  3566. #Default:
  3567. # dead_peer_timeout 10 seconds
  3568.  
  3569. # TAG: forward_max_tries
  3570. # Limits the number of attempts to forward the request.
  3571. #
  3572. # For the purpose of this limit, Squid counts all high-level request
  3573. # forwarding attempts, including any same-destination retries after
  3574. # certain persistent connection failures and any attempts to use a
  3575. # different peer. However, low-level connection reopening attempts
  3576. # (enabled using connect_retries) are not counted.
  3577. #
  3578. # See also: forward_timeout and connect_retries.
  3579. #Default:
  3580. # forward_max_tries 25
  3581.  
  3582. # MEMORY CACHE OPTIONS
  3583. # -----------------------------------------------------------------------------
  3584.  
  3585. # TAG: cache_mem (bytes)
  3586. # NOTE: THIS PARAMETER DOES NOT SPECIFY THE MAXIMUM PROCESS SIZE.
  3587. # IT ONLY PLACES A LIMIT ON HOW MUCH ADDITIONAL MEMORY SQUID WILL
  3588. # USE AS A MEMORY CACHE OF OBJECTS. SQUID USES MEMORY FOR OTHER
  3589. # THINGS AS WELL. SEE THE SQUID FAQ SECTION 8 FOR DETAILS.
  3590. #
  3591. # 'cache_mem' specifies the ideal amount of memory to be used
  3592. # for:
  3593. # * In-Transit objects
  3594. # * Hot Objects
  3595. # * Negative-Cached objects
  3596. #
  3597. # Data for these objects are stored in 4 KB blocks. This
  3598. # parameter specifies the ideal upper limit on the total size of
  3599. # 4 KB blocks allocated. In-Transit objects take the highest
  3600. # priority.
  3601. #
  3602. # In-transit objects have priority over the others. When
  3603. # additional space is needed for incoming data, negative-cached
  3604. # and hot objects will be released. In other words, the
  3605. # negative-cached and hot objects will fill up any unused space
  3606. # not needed for in-transit objects.
  3607. #
  3608. # If circumstances require, this limit will be exceeded.
  3609. # Specifically, if your incoming request rate requires more than
  3610. # 'cache_mem' of memory to hold in-transit objects, Squid will
  3611. # exceed this limit to satisfy the new requests. When the load
  3612. # decreases, blocks will be freed until the high-water mark is
  3613. # reached. Thereafter, blocks will be used to store hot
  3614. # objects.
  3615. #
  3616. # If shared memory caching is enabled, Squid does not use the shared
  3617. # cache space for in-transit objects, but they still consume as much
  3618. # local memory as they need. For more details about the shared memory
  3619. # cache, see memory_cache_shared.
  3620. #Default:
  3621. # cache_mem 256 MB
  3622.  
  3623. # TAG: maximum_object_size_in_memory (bytes)
  3624. # Objects greater than this size will not be attempted to kept in
  3625. # the memory cache. This should be set high enough to keep objects
  3626. # accessed frequently in memory to improve performance whilst low
  3627. # enough to keep larger objects from hoarding cache_mem.
  3628. #Default:
  3629. # maximum_object_size_in_memory 512 KB
  3630.  
  3631. # TAG: memory_cache_shared on|off
  3632. # Controls whether the memory cache is shared among SMP workers.
  3633. #
  3634. # The shared memory cache is meant to occupy cache_mem bytes and replace
  3635. # the non-shared memory cache, although some entities may still be
  3636. # cached locally by workers for now (e.g., internal and in-transit
  3637. # objects may be served from a local memory cache even if shared memory
  3638. # caching is enabled).
  3639. #
  3640. # By default, the memory cache is shared if and only if all of the
  3641. # following conditions are satisfied: Squid runs in SMP mode with
  3642. # multiple workers, cache_mem is positive, and Squid environment
  3643. # supports required IPC primitives (e.g., POSIX shared memory segments
  3644. # and GCC-style atomic operations).
  3645. #
  3646. # To avoid blocking locks, shared memory uses opportunistic algorithms
  3647. # that do not guarantee that every cachable entity that could have been
  3648. # shared among SMP workers will actually be shared.
  3649. #Default:
  3650. # "on" where supported if doing memory caching with multiple SMP workers.
  3651.  
  3652. # TAG: memory_cache_mode
  3653. # Controls which objects to keep in the memory cache (cache_mem)
  3654. #
  3655. # always Keep most recently fetched objects in memory (default)
  3656. #
  3657. # disk Only disk cache hits are kept in memory, which means
  3658. # an object must first be cached on disk and then hit
  3659. # a second time before cached in memory.
  3660. #
  3661. # network Only objects fetched from network is kept in memory
  3662. #Default:
  3663. # Keep the most recently fetched objects in memory
  3664.  
  3665. # TAG: memory_replacement_policy
  3666. # The memory replacement policy parameter determines which
  3667. # objects are purged from memory when memory space is needed.
  3668. #
  3669. # See cache_replacement_policy for details on algorithms.
  3670. #Default:
  3671. # memory_replacement_policy lru
  3672.  
  3673. # DISK CACHE OPTIONS
  3674. # -----------------------------------------------------------------------------
  3675.  
  3676. # TAG: cache_replacement_policy
  3677. # The cache replacement policy parameter determines which
  3678. # objects are evicted (replaced) when disk space is needed.
  3679. #
  3680. # lru : Squid's original list based LRU policy
  3681. # heap GDSF : Greedy-Dual Size Frequency
  3682. # heap LFUDA: Least Frequently Used with Dynamic Aging
  3683. # heap LRU : LRU policy implemented using a heap
  3684. #
  3685. # Applies to any cache_dir lines listed below this directive.
  3686. #
  3687. # The LRU policies keeps recently referenced objects.
  3688. #
  3689. # The heap GDSF policy optimizes object hit rate by keeping smaller
  3690. # popular objects in cache so it has a better chance of getting a
  3691. # hit. It achieves a lower byte hit rate than LFUDA though since
  3692. # it evicts larger (possibly popular) objects.
  3693. #
  3694. # The heap LFUDA policy keeps popular objects in cache regardless of
  3695. # their size and thus optimizes byte hit rate at the expense of
  3696. # hit rate since one large, popular object will prevent many
  3697. # smaller, slightly less popular objects from being cached.
  3698. #
  3699. # Both policies utilize a dynamic aging mechanism that prevents
  3700. # cache pollution that can otherwise occur with frequency-based
  3701. # replacement policies.
  3702. #
  3703. # NOTE: if using the LFUDA replacement policy you should increase
  3704. # the value of maximum_object_size above its default of 4 MB to
  3705. # to maximize the potential byte hit rate improvement of LFUDA.
  3706. #
  3707. # For more information about the GDSF and LFUDA cache replacement
  3708. # policies see http://www.hpl.hp.com/techreports/1999/HPL-1999-69.html
  3709. # and http://fog.hpl.external.hp.com/techreports/98/HPL-98-173.html.
  3710. #Default:
  3711. # cache_replacement_policy lru
  3712.  
  3713. # TAG: minimum_object_size (bytes)
  3714. # Objects smaller than this size will NOT be saved on disk. The
  3715. # value is specified in bytes, and the default is 0 KB, which
  3716. # means all responses can be stored.
  3717. #Default:
  3718. # no limit
  3719.  
  3720. # TAG: maximum_object_size (bytes)
  3721. # Set the default value for max-size parameter on any cache_dir.
  3722. # The value is specified in bytes, and the default is 4 MB.
  3723. #
  3724. # If you wish to get a high BYTES hit ratio, you should probably
  3725. # increase this (one 32 MB object hit counts for 3200 10KB
  3726. # hits).
  3727. #
  3728. # If you wish to increase hit ratio more than you want to
  3729. # save bandwidth you should leave this low.
  3730. #
  3731. # NOTE: if using the LFUDA replacement policy you should increase
  3732. # this value to maximize the byte hit rate improvement of LFUDA!
  3733. # See cache_replacement_policy for a discussion of this policy.
  3734. #Default:
  3735. # maximum_object_size 4 MB
  3736.  
  3737. # TAG: cache_dir
  3738. # Format:
  3739. # cache_dir Type Directory-Name Fs-specific-data [options]
  3740. #
  3741. # You can specify multiple cache_dir lines to spread the
  3742. # cache among different disk partitions.
  3743. #
  3744. # Type specifies the kind of storage system to use. Only "ufs"
  3745. # is built by default. To enable any of the other storage systems
  3746. # see the --enable-storeio configure option.
  3747. #
  3748. # 'Directory' is a top-level directory where cache swap
  3749. # files will be stored. If you want to use an entire disk
  3750. # for caching, this can be the mount-point directory.
  3751. # The directory must exist and be writable by the Squid
  3752. # process. Squid will NOT create this directory for you.
  3753. #
  3754. # In SMP configurations, cache_dir must not precede the workers option
  3755. # and should use configuration macros or conditionals to give each
  3756. # worker interested in disk caching a dedicated cache directory.
  3757. #
  3758. #
  3759. # ==== The ufs store type ====
  3760. #
  3761. # "ufs" is the old well-known Squid storage format that has always
  3762. # been there.
  3763. #
  3764. # Usage:
  3765. # cache_dir ufs Directory-Name Mbytes L1 L2 [options]
  3766. #
  3767. # 'Mbytes' is the amount of disk space (MB) to use under this
  3768. # directory. The default is 100 MB. Change this to suit your
  3769. # configuration. Do NOT put the size of your disk drive here.
  3770. # Instead, if you want Squid to use the entire disk drive,
  3771. # subtract 20% and use that value.
  3772. #
  3773. # 'L1' is the number of first-level subdirectories which
  3774. # will be created under the 'Directory'. The default is 16.
  3775. #
  3776. # 'L2' is the number of second-level subdirectories which
  3777. # will be created under each first-level directory. The default
  3778. # is 256.
  3779. #
  3780. #
  3781. # ==== The aufs store type ====
  3782. #
  3783. # "aufs" uses the same storage format as "ufs", utilizing
  3784. # POSIX-threads to avoid blocking the main Squid process on
  3785. # disk-I/O. This was formerly known in Squid as async-io.
  3786. #
  3787. # Usage:
  3788. # cache_dir aufs Directory-Name Mbytes L1 L2 [options]
  3789. #
  3790. # see argument descriptions under ufs above
  3791. #
  3792. #
  3793. # ==== The diskd store type ====
  3794. #
  3795. # "diskd" uses the same storage format as "ufs", utilizing a
  3796. # separate process to avoid blocking the main Squid process on
  3797. # disk-I/O.
  3798. #
  3799. # Usage:
  3800. # cache_dir diskd Directory-Name Mbytes L1 L2 [options] [Q1=n] [Q2=n]
  3801. #
  3802. # see argument descriptions under ufs above
  3803. #
  3804. # Q1 specifies the number of unacknowledged I/O requests when Squid
  3805. # stops opening new files. If this many messages are in the queues,
  3806. # Squid won't open new files. Default is 64
  3807. #
  3808. # Q2 specifies the number of unacknowledged messages when Squid
  3809. # starts blocking. If this many messages are in the queues,
  3810. # Squid blocks until it receives some replies. Default is 72
  3811. #
  3812. # When Q1 < Q2 (the default), the cache directory is optimized
  3813. # for lower response time at the expense of a decrease in hit
  3814. # ratio. If Q1 > Q2, the cache directory is optimized for
  3815. # higher hit ratio at the expense of an increase in response
  3816. # time.
  3817. #
  3818. #
  3819. # ==== The rock store type ====
  3820. #
  3821. # Usage:
  3822. # cache_dir rock Directory-Name Mbytes [options]
  3823. #
  3824. # The Rock Store type is a database-style storage. All cached
  3825. # entries are stored in a "database" file, using fixed-size slots.
  3826. # A single entry occupies one or more slots.
  3827. #
  3828. # If possible, Squid using Rock Store creates a dedicated kid
  3829. # process called "disker" to avoid blocking Squid worker(s) on disk
  3830. # I/O. One disker kid is created for each rock cache_dir. Diskers
  3831. # are created only when Squid, running in daemon mode, has support
  3832. # for the IpcIo disk I/O module.
  3833. #
  3834. # swap-timeout=msec: Squid will not start writing a miss to or
  3835. # reading a hit from disk if it estimates that the swap operation
  3836. # will take more than the specified number of milliseconds. By
  3837. # default and when set to zero, disables the disk I/O time limit
  3838. # enforcement. Ignored when using blocking I/O module because
  3839. # blocking synchronous I/O does not allow Squid to estimate the
  3840. # expected swap wait time.
  3841. #
  3842. # max-swap-rate=swaps/sec: Artificially limits disk access using
  3843. # the specified I/O rate limit. Swap out requests that
  3844. # would cause the average I/O rate to exceed the limit are
  3845. # delayed. Individual swap in requests (i.e., hits or reads) are
  3846. # not delayed, but they do contribute to measured swap rate and
  3847. # since they are placed in the same FIFO queue as swap out
  3848. # requests, they may wait longer if max-swap-rate is smaller.
  3849. # This is necessary on file systems that buffer "too
  3850. # many" writes and then start blocking Squid and other processes
  3851. # while committing those writes to disk. Usually used together
  3852. # with swap-timeout to avoid excessive delays and queue overflows
  3853. # when disk demand exceeds available disk "bandwidth". By default
  3854. # and when set to zero, disables the disk I/O rate limit
  3855. # enforcement. Currently supported by IpcIo module only.
  3856. #
  3857. # slot-size=bytes: The size of a database "record" used for
  3858. # storing cached responses. A cached response occupies at least
  3859. # one slot and all database I/O is done using individual slots so
  3860. # increasing this parameter leads to more disk space waste while
  3861. # decreasing it leads to more disk I/O overheads. Should be a
  3862. # multiple of your operating system I/O page size. Defaults to
  3863. # 16KBytes. A housekeeping header is stored with each slot and
  3864. # smaller slot-sizes will be rejected. The header is smaller than
  3865. # 100 bytes.
  3866. #
  3867. #
  3868. # ==== COMMON OPTIONS ====
  3869. #
  3870. # no-store no new objects should be stored to this cache_dir.
  3871. #
  3872. # min-size=n the minimum object size in bytes this cache_dir
  3873. # will accept. It's used to restrict a cache_dir
  3874. # to only store large objects (e.g. AUFS) while
  3875. # other stores are optimized for smaller objects
  3876. # (e.g. Rock).
  3877. # Defaults to 0.
  3878. #
  3879. # max-size=n the maximum object size in bytes this cache_dir
  3880. # supports.
  3881. # The value in maximum_object_size directive sets
  3882. # the default unless more specific details are
  3883. # available (ie a small store capacity).
  3884. #
  3885. # Note: To make optimal use of the max-size limits you should order
  3886. # the cache_dir lines with the smallest max-size value first.
  3887. #
  3888. #Default:
  3889. # No disk cache. Store cache ojects only in memory.
  3890. #
  3891.  
  3892. # Uncomment and adjust the following to add a disk cache directory.
  3893. #cache_dir ufs /var/spool/squid 100 16 256
  3894.  
  3895. # TAG: store_dir_select_algorithm
  3896. # How Squid selects which cache_dir to use when the response
  3897. # object will fit into more than one.
  3898. #
  3899. # Regardless of which algorithm is used the cache_dir min-size
  3900. # and max-size parameters are obeyed. As such they can affect
  3901. # the selection algorithm by limiting the set of considered
  3902. # cache_dir.
  3903. #
  3904. # Algorithms:
  3905. #
  3906. # least-load
  3907. #
  3908. # This algorithm is suited to caches with similar cache_dir
  3909. # sizes and disk speeds.
  3910. #
  3911. # The disk with the least I/O pending is selected.
  3912. # When there are multiple disks with the same I/O load ranking
  3913. # the cache_dir with most available capacity is selected.
  3914. #
  3915. # When a mix of cache_dir sizes are configured the faster disks
  3916. # have a naturally lower I/O loading and larger disks have more
  3917. # capacity. So space used to store objects and data throughput
  3918. # may be very unbalanced towards larger disks.
  3919. #
  3920. #
  3921. # round-robin
  3922. #
  3923. # This algorithm is suited to caches with unequal cache_dir
  3924. # disk sizes.
  3925. #
  3926. # Each cache_dir is selected in a rotation. The next suitable
  3927. # cache_dir is used.
  3928. #
  3929. # Available cache_dir capacity is only considered in relation
  3930. # to whether the object will fit and meets the min-size and
  3931. # max-size parameters.
  3932. #
  3933. # Disk I/O loading is only considered to prevent overload on slow
  3934. # disks. This algorithm does not spread objects by size, so any
  3935. # I/O loading per-disk may appear very unbalanced and volatile.
  3936. #
  3937. # If several cache_dirs use similar min-size, max-size, or other
  3938. # limits to to reject certain responses, then do not group such
  3939. # cache_dir lines together, to avoid round-robin selection bias
  3940. # towards the first cache_dir after the group. Instead, interleave
  3941. # cache_dir lines from different groups. For example:
  3942. #
  3943. # store_dir_select_algorithm round-robin
  3944. # cache_dir rock /hdd1 ... min-size=100000
  3945. # cache_dir rock /ssd1 ... max-size=99999
  3946. # cache_dir rock /hdd2 ... min-size=100000
  3947. # cache_dir rock /ssd2 ... max-size=99999
  3948. # cache_dir rock /hdd3 ... min-size=100000
  3949. # cache_dir rock /ssd3 ... max-size=99999
  3950. #Default:
  3951. # store_dir_select_algorithm least-load
  3952.  
  3953. # TAG: max_open_disk_fds
  3954. # To avoid having disk as the I/O bottleneck Squid can optionally
  3955. # bypass the on-disk cache if more than this amount of disk file
  3956. # descriptors are open.
  3957. #
  3958. # A value of 0 indicates no limit.
  3959. #Default:
  3960. # no limit
  3961.  
  3962. # TAG: cache_swap_low (percent, 0-100)
  3963. # The low-water mark for AUFS/UFS/diskd cache object eviction by
  3964. # the cache_replacement_policy algorithm.
  3965. #
  3966. # Removal begins when the swap (disk) usage of a cache_dir is
  3967. # above this low-water mark and attempts to maintain utilization
  3968. # near the low-water mark.
  3969. #
  3970. # As swap utilization increases towards the high-water mark set
  3971. # by cache_swap_high object eviction becomes more agressive.
  3972. #
  3973. # The value difference in percentages between low- and high-water
  3974. # marks represent an eviction rate of 300 objects per second and
  3975. # the rate continues to scale in agressiveness by multiples of
  3976. # this above the high-water mark.
  3977. #
  3978. # Defaults are 90% and 95%. If you have a large cache, 5% could be
  3979. # hundreds of MB. If this is the case you may wish to set these
  3980. # numbers closer together.
  3981. #
  3982. # See also cache_swap_high and cache_replacement_policy
  3983. #Default:
  3984. # cache_swap_low 90
  3985.  
  3986. # TAG: cache_swap_high (percent, 0-100)
  3987. # The high-water mark for AUFS/UFS/diskd cache object eviction by
  3988. # the cache_replacement_policy algorithm.
  3989. #
  3990. # Removal begins when the swap (disk) usage of a cache_dir is
  3991. # above the low-water mark set by cache_swap_low and attempts to
  3992. # maintain utilization near the low-water mark.
  3993. #
  3994. # As swap utilization increases towards this high-water mark object
  3995. # eviction becomes more agressive.
  3996. #
  3997. # The value difference in percentages between low- and high-water
  3998. # marks represent an eviction rate of 300 objects per second and
  3999. # the rate continues to scale in agressiveness by multiples of
  4000. # this above the high-water mark.
  4001. #
  4002. # Defaults are 90% and 95%. If you have a large cache, 5% could be
  4003. # hundreds of MB. If this is the case you may wish to set these
  4004. # numbers closer together.
  4005. #
  4006. # See also cache_swap_low and cache_replacement_policy
  4007. #Default:
  4008. # cache_swap_high 95
  4009.  
  4010. # LOGFILE OPTIONS
  4011. # -----------------------------------------------------------------------------
  4012.  
  4013. # TAG: logformat
  4014. # Usage:
  4015. #
  4016. # logformat <name> <format specification>
  4017. #
  4018. # Defines an access log format.
  4019. #
  4020. # The <format specification> is a string with embedded % format codes
  4021. #
  4022. # % format codes all follow the same basic structure where all
  4023. # components but the formatcode are optional and usually unnecessary,
  4024. # especially when dealing with common codes.
  4025. #
  4026. # % [encoding] [-] [[0]width] [{arg}] formatcode [{arg}]
  4027. #
  4028. # encoding escapes or otherwise protects "special" characters:
  4029. #
  4030. # " Quoted string encoding where quote(") and
  4031. # backslash(\) characters are \-escaped while
  4032. # CR, LF, and TAB characters are encoded as \r,
  4033. # \n, and \t two-character sequences.
  4034. #
  4035. # [ Custom Squid encoding where percent(%), square
  4036. # brackets([]), backslash(\) and characters with
  4037. # codes outside of [32,126] range are %-encoded.
  4038. # SP is not encoded. Used by log_mime_hdrs.
  4039. #
  4040. # # URL encoding (a.k.a. percent-encoding) where
  4041. # all URL unsafe and control characters (per RFC
  4042. # 1738) are %-encoded.
  4043. #
  4044. # / Shell-like encoding where quote(") and
  4045. # backslash(\) characters are \-escaped while CR
  4046. # and LF characters are encoded as \r and \n
  4047. # two-character sequences. Values containing SP
  4048. # character(s) are surrounded by quotes(").
  4049. #
  4050. # ' Raw/as-is encoding with no escaping/quoting.
  4051. #
  4052. # Default encoding: When no explicit encoding is
  4053. # specified, each %code determines its own encoding.
  4054. # Most %codes use raw/as-is encoding, but some codes use
  4055. # a so called "pass-through URL encoding" where all URL
  4056. # unsafe and control characters (per RFC 1738) are
  4057. # %-encoded, but the percent character(%) is left as is.
  4058. #
  4059. # - left aligned
  4060. #
  4061. # width minimum and/or maximum field width:
  4062. # [width_min][.width_max]
  4063. # When minimum starts with 0, the field is zero-padded.
  4064. # String values exceeding maximum width are truncated.
  4065. #
  4066. # {arg} argument such as header name etc. This field may be
  4067. # placed before or after the token, but not both at once.
  4068. #
  4069. # Format codes:
  4070. #
  4071. # % a literal % character
  4072. # sn Unique sequence number per log line entry
  4073. # err_code The ID of an error response served by Squid or
  4074. # a similar internal error identifier.
  4075. # err_detail Additional err_code-dependent error information.
  4076. # note The annotation specified by the argument. Also
  4077. # logs the adaptation meta headers set by the
  4078. # adaptation_meta configuration parameter.
  4079. # If no argument given all annotations logged.
  4080. # The argument may include a separator to use with
  4081. # annotation values:
  4082. # name[:separator]
  4083. # By default, multiple note values are separated with ","
  4084. # and multiple notes are separated with "\r\n".
  4085. # When logging named notes with %{name}note, the
  4086. # explicitly configured separator is used between note
  4087. # values. When logging all notes with %note, the
  4088. # explicitly configured separator is used between
  4089. # individual notes. There is currently no way to
  4090. # specify both value and notes separators when logging
  4091. # all notes with %note.
  4092. # master_xaction The master transaction identifier is an unsigned
  4093. # integer. These IDs are guaranteed to monotonically
  4094. # increase within a single worker process lifetime, with
  4095. # higher values corresponding to transactions that were
  4096. # accepted or initiated later. Due to current implementation
  4097. # deficiencies, some IDs are skipped (i.e. never logged).
  4098. # Concurrent workers and restarted workers use similar,
  4099. # overlapping sequences of master transaction IDs.
  4100. #
  4101. # Connection related format codes:
  4102. #
  4103. # >a Client source IP address
  4104. # >A Client FQDN
  4105. # >p Client source port
  4106. # >eui Client source EUI (MAC address, EUI-48 or EUI-64 identifier)
  4107. # >la Local IP address the client connected to
  4108. # >lp Local port number the client connected to
  4109. # >qos Client connection TOS/DSCP value set by Squid
  4110. # >nfmark Client connection netfilter packet MARK set by Squid
  4111. #
  4112. # la Local listening IP address the client connection was connected to.
  4113. # lp Local listening port number the client connection was connected to.
  4114. #
  4115. # <a Server IP address of the last server or peer connection
  4116. # <A Server FQDN or peer name
  4117. # <p Server port number of the last server or peer connection
  4118. # <la Local IP address of the last server or peer connection
  4119. # <lp Local port number of the last server or peer connection
  4120. # <qos Server connection TOS/DSCP value set by Squid
  4121. # <nfmark Server connection netfilter packet MARK set by Squid
  4122. #
  4123. # >handshake Raw client handshake
  4124. # Initial client bytes received by Squid on a newly
  4125. # accepted TCP connection or inside a just established
  4126. # CONNECT tunnel. Squid stops accumulating handshake
  4127. # bytes as soon as the handshake parser succeeds or
  4128. # fails (determining whether the client is using the
  4129. # expected protocol).
  4130. #
  4131. # For HTTP clients, the handshake is the request line.
  4132. # For TLS clients, the handshake consists of all TLS
  4133. # records up to and including the TLS record that
  4134. # contains the last byte of the first ClientHello
  4135. # message. For clients using an unsupported protocol,
  4136. # this field contains the bytes received by Squid at the
  4137. # time of the handshake parsing failure.
  4138. #
  4139. # See the on_unsupported_protocol directive for more
  4140. # information on Squid handshake traffic expectations.
  4141. #
  4142. # Current support is limited to these contexts:
  4143. # - http_port connections, but only when the
  4144. # on_unsupported_protocol directive is in use.
  4145. # - https_port connections (and CONNECT tunnels) that
  4146. # are subject to the ssl_bump peek or stare action.
  4147. #
  4148. # To protect binary handshake data, this field is always
  4149. # base64-encoded (RFC 4648 Section 4). If logformat
  4150. # field encoding is configured, that encoding is applied
  4151. # on top of base64. Otherwise, the computed base64 value
  4152. # is recorded as is.
  4153. #
  4154. # Time related format codes:
  4155. #
  4156. # ts Seconds since epoch
  4157. # tu subsecond time (milliseconds)
  4158. # tl Local time. Optional strftime format argument
  4159. # default %d/%b/%Y:%H:%M:%S %z
  4160. # tg GMT time. Optional strftime format argument
  4161. # default %d/%b/%Y:%H:%M:%S %z
  4162. # tr Response time (milliseconds)
  4163. # dt Total time spent making DNS lookups (milliseconds)
  4164. # tS Approximate master transaction start time in
  4165. # <full seconds since epoch>.<fractional seconds> format.
  4166. # Currently, Squid considers the master transaction
  4167. # started when a complete HTTP request header initiating
  4168. # the transaction is received from the client. This is
  4169. # the same value that Squid uses to calculate transaction
  4170. # response time when logging %tr to access.log. Currently,
  4171. # Squid uses millisecond resolution for %tS values,
  4172. # similar to the default access.log "current time" field
  4173. # (%ts.%03tu).
  4174. #
  4175. # Access Control related format codes:
  4176. #
  4177. # et Tag returned by external acl
  4178. # ea Log string returned by external acl
  4179. # un User name (any available)
  4180. # ul User name from authentication
  4181. # ue User name from external acl helper
  4182. # ui User name from ident
  4183. # un A user name. Expands to the first available name
  4184. # from the following list of information sources:
  4185. # - authenticated user name, like %ul
  4186. # - user name supplied by an external ACL, like %ue
  4187. # - SSL client name, like %us
  4188. # - ident user name, like %ui
  4189. # credentials Client credentials. The exact meaning depends on
  4190. # the authentication scheme: For Basic authentication,
  4191. # it is the password; for Digest, the realm sent by the
  4192. # client; for NTLM and Negotiate, the client challenge
  4193. # or client credentials prefixed with "YR " or "KK ".
  4194. #
  4195. # HTTP related format codes:
  4196. #
  4197. # REQUEST
  4198. #
  4199. # [http::]rm Request method (GET/POST etc)
  4200. # [http::]>rm Request method from client
  4201. # [http::]<rm Request method sent to server or peer
  4202. #
  4203. # [http::]ru Request URL received (or computed) and sanitized
  4204. #
  4205. # Logs request URI received from the client, a
  4206. # request adaptation service, or a request
  4207. # redirector (whichever was applied last).
  4208. #
  4209. # Computed URLs are URIs of internally generated
  4210. # requests and various "error:..." URIs.
  4211. #
  4212. # Honors strip_query_terms and uri_whitespace.
  4213. #
  4214. # This field is not encoded by default. Encoding
  4215. # this field using variants of %-encoding will
  4216. # clash with uri_whitespace modifications that
  4217. # also use %-encoding.
  4218. #
  4219. # [http::]>ru Request URL received from the client (or computed)
  4220. #
  4221. # Computed URLs are URIs of internally generated
  4222. # requests and various "error:..." URIs.
  4223. #
  4224. # Unlike %ru, this request URI is not affected
  4225. # by request adaptation, URL rewriting services,
  4226. # and strip_query_terms.
  4227. #
  4228. # Honors uri_whitespace.
  4229. #
  4230. # This field is using pass-through URL encoding
  4231. # by default. Encoding this field using other
  4232. # variants of %-encoding will clash with
  4233. # uri_whitespace modifications that also use
  4234. # %-encoding.
  4235. #
  4236. # [http::]<ru Request URL sent to server or peer
  4237. # [http::]>rs Request URL scheme from client
  4238. # [http::]<rs Request URL scheme sent to server or peer
  4239. # [http::]>rd Request URL domain from client
  4240. # [http::]<rd Request URL domain sent to server or peer
  4241. # [http::]>rP Request URL port from client
  4242. # [http::]<rP Request URL port sent to server or peer
  4243. # [http::]rp Request URL path excluding hostname
  4244. # [http::]>rp Request URL path excluding hostname from client
  4245. # [http::]<rp Request URL path excluding hostname sent to server or peer
  4246. # [http::]rv Request protocol version
  4247. # [http::]>rv Request protocol version from client
  4248. # [http::]<rv Request protocol version sent to server or peer
  4249. #
  4250. # [http::]>h Original received request header.
  4251. # Usually differs from the request header sent by
  4252. # Squid, although most fields are often preserved.
  4253. # Accepts optional header field name/value filter
  4254. # argument using name[:[separator]element] format.
  4255. # [http::]>ha Received request header after adaptation and
  4256. # redirection (pre-cache REQMOD vectoring point).
  4257. # Usually differs from the request header sent by
  4258. # Squid, although most fields are often preserved.
  4259. # Optional header name argument as for >h
  4260. #
  4261. # RESPONSE
  4262. #
  4263. # [http::]<Hs HTTP status code received from the next hop
  4264. # [http::]>Hs HTTP status code sent to the client
  4265. #
  4266. # [http::]<h Reply header. Optional header name argument
  4267. # as for >h
  4268. #
  4269. # [http::]mt MIME content type
  4270. #
  4271. #
  4272. # SIZE COUNTERS
  4273. #
  4274. # [http::]st Total size of request + reply traffic with client
  4275. # [http::]>st Total size of request received from client.
  4276. # Excluding chunked encoding bytes.
  4277. # [http::]<st Total size of reply sent to client (after adaptation)
  4278. #
  4279. # [http::]>sh Size of request headers received from client
  4280. # [http::]<sh Size of reply headers sent to client (after adaptation)
  4281. #
  4282. # [http::]<sH Reply high offset sent
  4283. # [http::]<sS Upstream object size
  4284. #
  4285. # [http::]<bs Number of HTTP-equivalent message body bytes
  4286. # received from the next hop, excluding chunked
  4287. # transfer encoding and control messages.
  4288. # Generated FTP/Gopher listings are treated as
  4289. # received bodies.
  4290. #
  4291. # TIMING
  4292. #
  4293. # [http::]<pt Peer response time in milliseconds. The timer starts
  4294. # when the last request byte is sent to the next hop
  4295. # and stops when the last response byte is received.
  4296. # [http::]<tt Total time in milliseconds. The timer
  4297. # starts with the first connect request (or write I/O)
  4298. # sent to the first selected peer. The timer stops
  4299. # with the last I/O with the last peer.
  4300. #
  4301. # Squid handling related format codes:
  4302. #
  4303. # Ss Squid request status (TCP_MISS etc)
  4304. # Sh Squid hierarchy status (DEFAULT_PARENT etc)
  4305. #
  4306. # SSL-related format codes:
  4307. #
  4308. # ssl::bump_mode SslBump decision for the transaction:
  4309. #
  4310. # For CONNECT requests that initiated bumping of
  4311. # a connection and for any request received on
  4312. # an already bumped connection, Squid logs the
  4313. # corresponding SslBump mode ("splice", "bump",
  4314. # "peek", "stare", "terminate", "server-first"
  4315. # or "client-first"). See the ssl_bump option
  4316. # for more information about these modes.
  4317. #
  4318. # A "none" token is logged for requests that
  4319. # triggered "ssl_bump" ACL evaluation matching
  4320. # a "none" rule.
  4321. #
  4322. # In all other cases, a single dash ("-") is
  4323. # logged.
  4324. #
  4325. # ssl::>sni SSL client SNI sent to Squid.
  4326. #
  4327. # ssl::>cert_subject
  4328. # The Subject field of the received client
  4329. # SSL certificate or a dash ('-') if Squid has
  4330. # received an invalid/malformed certificate or
  4331. # no certificate at all. Consider encoding the
  4332. # logged value because Subject often has spaces.
  4333. #
  4334. # ssl::>cert_issuer
  4335. # The Issuer field of the received client
  4336. # SSL certificate or a dash ('-') if Squid has
  4337. # received an invalid/malformed certificate or
  4338. # no certificate at all. Consider encoding the
  4339. # logged value because Issuer often has spaces.
  4340. #
  4341. # ssl::<cert_subject
  4342. # The Subject field of the received server
  4343. # TLS certificate or a dash ('-') if this is
  4344. # not available. Consider encoding the logged
  4345. # value because Subject often has spaces.
  4346. #
  4347. # ssl::<cert_issuer
  4348. # The Issuer field of the received server
  4349. # TLS certificate or a dash ('-') if this is
  4350. # not available. Consider encoding the logged
  4351. # value because Issuer often has spaces.
  4352. #
  4353. # ssl::<cert
  4354. # The received server x509 certificate in PEM
  4355. # format, including BEGIN and END lines (or a
  4356. # dash ('-') if the certificate is unavailable).
  4357. #
  4358. # WARNING: Large certificates will exceed the
  4359. # current 8KB access.log record limit, resulting
  4360. # in truncated records. Such truncation usually
  4361. # happens in the middle of a record field. The
  4362. # limit applies to all access logging modules.
  4363. #
  4364. # The logged certificate may have failed
  4365. # validation and may not be trusted by Squid.
  4366. # This field does not include any intermediate
  4367. # certificates that may have been received from
  4368. # the server or fetched during certificate
  4369. # validation process.
  4370. #
  4371. # Currently, Squid only collects server
  4372. # certificates during step3 of SslBump
  4373. # processing; connections that were not subject
  4374. # to ssl_bump rules or that did not match a peek
  4375. # or stare rule at step2 will not have the
  4376. # server certificate information.
  4377. #
  4378. # This field is using pass-through URL encoding
  4379. # by default.
  4380. #
  4381. # ssl::<cert_errors
  4382. # The list of certificate validation errors
  4383. # detected by Squid (including OpenSSL and
  4384. # certificate validation helper components). The
  4385. # errors are listed in the discovery order. By
  4386. # default, the error codes are separated by ':'.
  4387. # Accepts an optional separator argument.
  4388. #
  4389. # %ssl::>negotiated_version The negotiated TLS version of the
  4390. # client connection.
  4391. #
  4392. # %ssl::<negotiated_version The negotiated TLS version of the
  4393. # last server or peer connection.
  4394. #
  4395. # %ssl::>received_hello_version The TLS version of the Hello
  4396. # message received from TLS client.
  4397. #
  4398. # %ssl::<received_hello_version The TLS version of the Hello
  4399. # message received from TLS server.
  4400. #
  4401. # %ssl::>received_supported_version The maximum TLS version
  4402. # supported by the TLS client.
  4403. #
  4404. # %ssl::<received_supported_version The maximum TLS version
  4405. # supported by the TLS server.
  4406. #
  4407. # %ssl::>negotiated_cipher The negotiated cipher of the
  4408. # client connection.
  4409. #
  4410. # %ssl::<negotiated_cipher The negotiated cipher of the
  4411. # last server or peer connection.
  4412. #
  4413. # If ICAP is enabled, the following code becomes available (as
  4414. # well as ICAP log codes documented with the icap_log option):
  4415. #
  4416. # icap::tt Total ICAP processing time for the HTTP
  4417. # transaction. The timer ticks when ICAP
  4418. # ACLs are checked and when ICAP
  4419. # transaction is in progress.
  4420. #
  4421. # If adaptation is enabled the following codes become available:
  4422. #
  4423. # adapt::<last_h The header of the last ICAP response or
  4424. # meta-information from the last eCAP
  4425. # transaction related to the HTTP transaction.
  4426. # Like <h, accepts an optional header name
  4427. # argument.
  4428. #
  4429. # adapt::sum_trs Summed adaptation transaction response
  4430. # times recorded as a comma-separated list in
  4431. # the order of transaction start time. Each time
  4432. # value is recorded as an integer number,
  4433. # representing response time of one or more
  4434. # adaptation (ICAP or eCAP) transaction in
  4435. # milliseconds. When a failed transaction is
  4436. # being retried or repeated, its time is not
  4437. # logged individually but added to the
  4438. # replacement (next) transaction. See also:
  4439. # adapt::all_trs.
  4440. #
  4441. # adapt::all_trs All adaptation transaction response times.
  4442. # Same as adaptation_strs but response times of
  4443. # individual transactions are never added
  4444. # together. Instead, all transaction response
  4445. # times are recorded individually.
  4446. #
  4447. # You can prefix adapt::*_trs format codes with adaptation
  4448. # service name in curly braces to record response time(s) specific
  4449. # to that service. For example: %{my_service}adapt::sum_trs
  4450. #
  4451. # Format codes related to the PROXY protocol:
  4452. #
  4453. # proxy_protocol::>h PROXY protocol header, including optional TLVs.
  4454. #
  4455. # Supports the same field and element reporting/extraction logic
  4456. # as %http::>h. For configuration and reporting purposes, Squid
  4457. # maps each PROXY TLV to an HTTP header field: the TLV type
  4458. # (configured as a decimal integer) is the field name, and the
  4459. # TLV value is the field value. All TLVs of "LOCAL" connections
  4460. # (in PROXY protocol terminology) are currently skipped/ignored.
  4461. #
  4462. # Squid also maps the following standard PROXY protocol header
  4463. # blocks to pseudo HTTP headers (their names use PROXY
  4464. # terminology and start with a colon, following HTTP tradition
  4465. # for pseudo headers): :command, :version, :src_addr, :dst_addr,
  4466. # :src_port, and :dst_port.
  4467. #
  4468. # Without optional parameters, this logformat code logs
  4469. # pseudo headers and TLVs.
  4470. #
  4471. # This format code uses pass-through URL encoding by default.
  4472. #
  4473. # Example:
  4474. # # relay custom PROXY TLV #224 to adaptation services
  4475. # adaptation_meta Client-Foo "%proxy_protocol::>h{224}"
  4476. #
  4477. # See also: %http::>h
  4478. #
  4479. # The default formats available (which do not need re-defining) are:
  4480. #
  4481. #logformat squid %ts.%03tu %6tr %>a %Ss/%03>Hs %<st %rm %ru %[un %Sh/%<a %mt
  4482. #logformat common %>a %[ui %[un [%tl] "%rm %ru HTTP/%rv" %>Hs %<st %Ss:%Sh
  4483. #logformat combined %>a %[ui %[un [%tl] "%rm %ru HTTP/%rv" %>Hs %<st "%{Referer}>h" "%{User-Agent}>h" %Ss:%Sh
  4484. #logformat referrer %ts.%03tu %>a %{Referer}>h %ru
  4485. #logformat useragent %>a [%tl] "%{User-Agent}>h"
  4486. #
  4487. # NOTE: When the log_mime_hdrs directive is set to ON.
  4488. # The squid, common and combined formats have a safely encoded copy
  4489. # of the mime headers appended to each line within a pair of brackets.
  4490. #
  4491. # NOTE: The common and combined formats are not quite true to the Apache definition.
  4492. # The logs from Squid contain an extra status and hierarchy code appended.
  4493. #
  4494. #Default:
  4495. # The format definitions squid, common, combined, referrer, useragent are built in.
  4496.  
  4497. # TAG: access_log
  4498. # Configures whether and how Squid logs HTTP and ICP transactions.
  4499. # If access logging is enabled, a single line is logged for every
  4500. # matching HTTP or ICP request. The recommended directive formats are:
  4501. #
  4502. # access_log <module>:<place> [option ...] [acl acl ...]
  4503. # access_log none [acl acl ...]
  4504. #
  4505. # The following directive format is accepted but may be deprecated:
  4506. # access_log <module>:<place> [<logformat name> [acl acl ...]]
  4507. #
  4508. # In most cases, the first ACL name must not contain the '=' character
  4509. # and should not be equal to an existing logformat name. You can always
  4510. # start with an 'all' ACL to work around those restrictions.
  4511. #
  4512. # Will log to the specified module:place using the specified format (which
  4513. # must be defined in a logformat directive) those entries which match
  4514. # ALL the acl's specified (which must be defined in acl clauses).
  4515. # If no acl is specified, all requests will be logged to this destination.
  4516. #
  4517. # ===== Available options for the recommended directive format =====
  4518. #
  4519. # logformat=name Names log line format (either built-in or
  4520. # defined by a logformat directive). Defaults
  4521. # to 'squid'.
  4522. #
  4523. # buffer-size=64KB Defines approximate buffering limit for log
  4524. # records (see buffered_logs). Squid should not
  4525. # keep more than the specified size and, hence,
  4526. # should flush records before the buffer becomes
  4527. # full to avoid overflows under normal
  4528. # conditions (the exact flushing algorithm is
  4529. # module-dependent though). The on-error option
  4530. # controls overflow handling.
  4531. #
  4532. # on-error=die|drop Defines action on unrecoverable errors. The
  4533. # 'drop' action ignores (i.e., does not log)
  4534. # affected log records. The default 'die' action
  4535. # kills the affected worker. The drop action
  4536. # support has not been tested for modules other
  4537. # than tcp.
  4538. #
  4539. # rotate=N Specifies the number of log file rotations to
  4540. # make when you run 'squid -k rotate'. The default
  4541. # is to obey the logfile_rotate directive. Setting
  4542. # rotate=0 will disable the file name rotation,
  4543. # but the log files are still closed and re-opened.
  4544. # This will enable you to rename the logfiles
  4545. # yourself just before sending the rotate signal.
  4546. # Only supported by the stdio module.
  4547. #
  4548. # ===== Modules Currently available =====
  4549. #
  4550. # none Do not log any requests matching these ACL.
  4551. # Do not specify Place or logformat name.
  4552. #
  4553. # stdio Write each log line to disk immediately at the completion of
  4554. # each request.
  4555. # Place: the filename and path to be written.
  4556. #
  4557. # daemon Very similar to stdio. But instead of writing to disk the log
  4558. # line is passed to a daemon helper for asychronous handling instead.
  4559. # Place: varies depending on the daemon.
  4560. #
  4561. # log_file_daemon Place: the file name and path to be written.
  4562. #
  4563. # syslog To log each request via syslog facility.
  4564. # Place: The syslog facility and priority level for these entries.
  4565. # Place Format: facility.priority
  4566. #
  4567. # where facility could be any of:
  4568. # authpriv, daemon, local0 ... local7 or user.
  4569. #
  4570. # And priority could be any of:
  4571. # err, warning, notice, info, debug.
  4572. #
  4573. # udp To send each log line as text data to a UDP receiver.
  4574. # Place: The destination host name or IP and port.
  4575. # Place Format: //host:port
  4576. #
  4577. # tcp To send each log line as text data to a TCP receiver.
  4578. # Lines may be accumulated before sending (see buffered_logs).
  4579. # Place: The destination host name or IP and port.
  4580. # Place Format: //host:port
  4581. #
  4582. # Default:
  4583. # access_log daemon:/var/log/squid/access.log squid
  4584. #Default:
  4585. # access_log daemon:/var/log/squid/access.log squid
  4586.  
  4587. # TAG: icap_log
  4588. # ICAP log files record ICAP transaction summaries, one line per
  4589. # transaction.
  4590. #
  4591. # The icap_log option format is:
  4592. # icap_log <filepath> [<logformat name> [acl acl ...]]
  4593. # icap_log none [acl acl ...]]
  4594. #
  4595. # Please see access_log option documentation for details. The two
  4596. # kinds of logs share the overall configuration approach and many
  4597. # features.
  4598. #
  4599. # ICAP processing of a single HTTP message or transaction may
  4600. # require multiple ICAP transactions. In such cases, multiple
  4601. # ICAP transaction log lines will correspond to a single access
  4602. # log line.
  4603. #
  4604. # ICAP log supports many access.log logformat %codes. In ICAP context,
  4605. # HTTP message-related %codes are applied to the HTTP message embedded
  4606. # in an ICAP message. Logformat "%http::>..." codes are used for HTTP
  4607. # messages embedded in ICAP requests while "%http::<..." codes are used
  4608. # for HTTP messages embedded in ICAP responses. For example:
  4609. #
  4610. # http::>h To-be-adapted HTTP message headers sent by Squid to
  4611. # the ICAP service. For REQMOD transactions, these are
  4612. # HTTP request headers. For RESPMOD, these are HTTP
  4613. # response headers, but Squid currently cannot log them
  4614. # (i.e., %http::>h will expand to "-" for RESPMOD).
  4615. #
  4616. # http::<h Adapted HTTP message headers sent by the ICAP
  4617. # service to Squid (i.e., HTTP request headers in regular
  4618. # REQMOD; HTTP response headers in RESPMOD and during
  4619. # request satisfaction in REQMOD).
  4620. #
  4621. # ICAP OPTIONS transactions do not embed HTTP messages.
  4622. #
  4623. # Several logformat codes below deal with ICAP message bodies. An ICAP
  4624. # message body, if any, typically includes a complete HTTP message
  4625. # (required HTTP headers plus optional HTTP message body). When
  4626. # computing HTTP message body size for these logformat codes, Squid
  4627. # either includes or excludes chunked encoding overheads; see
  4628. # code-specific documentation for details.
  4629. #
  4630. # For Secure ICAP services, all size-related information is currently
  4631. # computed before/after TLS encryption/decryption, as if TLS was not
  4632. # in use at all.
  4633. #
  4634. # The following format codes are also available for ICAP logs:
  4635. #
  4636. # icap::<A ICAP server IP address. Similar to <A.
  4637. #
  4638. # icap::<service_name ICAP service name from the icap_service
  4639. # option in Squid configuration file.
  4640. #
  4641. # icap::ru ICAP Request-URI. Similar to ru.
  4642. #
  4643. # icap::rm ICAP request method (REQMOD, RESPMOD, or
  4644. # OPTIONS). Similar to existing rm.
  4645. #
  4646. # icap::>st The total size of the ICAP request sent to the ICAP
  4647. # server (ICAP headers + ICAP body), including chunking
  4648. # metadata (if any).
  4649. #
  4650. # icap::<st The total size of the ICAP response received from the
  4651. # ICAP server (ICAP headers + ICAP body), including
  4652. # chunking metadata (if any).
  4653. #
  4654. # icap::<bs The size of the ICAP response body received from the
  4655. # ICAP server, excluding chunking metadata (if any).
  4656. #
  4657. # icap::tr Transaction response time (in
  4658. # milliseconds). The timer starts when
  4659. # the ICAP transaction is created and
  4660. # stops when the transaction is completed.
  4661. # Similar to tr.
  4662. #
  4663. # icap::tio Transaction I/O time (in milliseconds). The
  4664. # timer starts when the first ICAP request
  4665. # byte is scheduled for sending. The timers
  4666. # stops when the last byte of the ICAP response
  4667. # is received.
  4668. #
  4669. # icap::to Transaction outcome: ICAP_ERR* for all
  4670. # transaction errors, ICAP_OPT for OPTION
  4671. # transactions, ICAP_ECHO for 204
  4672. # responses, ICAP_MOD for message
  4673. # modification, and ICAP_SAT for request
  4674. # satisfaction. Similar to Ss.
  4675. #
  4676. # icap::Hs ICAP response status code. Similar to Hs.
  4677. #
  4678. # icap::>h ICAP request header(s). Similar to >h.
  4679. #
  4680. # icap::<h ICAP response header(s). Similar to <h.
  4681. #
  4682. # The default ICAP log format, which can be used without an explicit
  4683. # definition, is called icap_squid:
  4684. #
  4685. #logformat icap_squid %ts.%03tu %6icap::tr %>A %icap::to/%03icap::Hs %icap::<st %icap::rm %icap::ru %un -/%icap::<A -
  4686. #
  4687. # See also: logformat and %adapt::<last_h
  4688. #Default:
  4689. # none
  4690.  
  4691. # TAG: logfile_daemon
  4692. # Specify the path to the logfile-writing daemon. This daemon is
  4693. # used to write the access and store logs, if configured.
  4694. #
  4695. # Squid sends a number of commands to the log daemon:
  4696. # L<data>\n - logfile data
  4697. # R\n - rotate file
  4698. # T\n - truncate file
  4699. # O\n - reopen file
  4700. # F\n - flush file
  4701. # r<n>\n - set rotate count to <n>
  4702. # b<n>\n - 1 = buffer output, 0 = don't buffer output
  4703. #
  4704. # No responses is expected.
  4705. #Default:
  4706. # logfile_daemon /usr/lib/squid/log_file_daemon
  4707.  
  4708. # TAG: stats_collection allow|deny acl acl...
  4709. # This options allows you to control which requests gets accounted
  4710. # in performance counters.
  4711. #
  4712. # This clause only supports fast acl types.
  4713. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  4714. #Default:
  4715. # Allow logging for all transactions.
  4716.  
  4717. # TAG: cache_store_log
  4718. # Logs the activities of the storage manager. Shows which
  4719. # objects are ejected from the cache, and which objects are
  4720. # saved and for how long.
  4721. # There are not really utilities to analyze this data, so you can safely
  4722. # disable it (the default).
  4723. #
  4724. # Store log uses modular logging outputs. See access_log for the list
  4725. # of modules supported.
  4726. #
  4727. # Example:
  4728. # cache_store_log stdio:/var/log/squid/store.log
  4729. # cache_store_log daemon:/var/log/squid/store.log
  4730. #Default:
  4731. # none
  4732.  
  4733. # TAG: cache_swap_state
  4734. # Location for the cache "swap.state" file. This index file holds
  4735. # the metadata of objects saved on disk. It is used to rebuild
  4736. # the cache during startup. Normally this file resides in each
  4737. # 'cache_dir' directory, but you may specify an alternate
  4738. # pathname here. Note you must give a full filename, not just
  4739. # a directory. Since this is the index for the whole object
  4740. # list you CANNOT periodically rotate it!
  4741. #
  4742. # If %s can be used in the file name it will be replaced with a
  4743. # a representation of the cache_dir name where each / is replaced
  4744. # with '.'. This is needed to allow adding/removing cache_dir
  4745. # lines when cache_swap_log is being used.
  4746. #
  4747. # If have more than one 'cache_dir', and %s is not used in the name
  4748. # these swap logs will have names such as:
  4749. #
  4750. # cache_swap_log.00
  4751. # cache_swap_log.01
  4752. # cache_swap_log.02
  4753. #
  4754. # The numbered extension (which is added automatically)
  4755. # corresponds to the order of the 'cache_dir' lines in this
  4756. # configuration file. If you change the order of the 'cache_dir'
  4757. # lines in this file, these index files will NOT correspond to
  4758. # the correct 'cache_dir' entry (unless you manually rename
  4759. # them). We recommend you do NOT use this option. It is
  4760. # better to keep these index files in each 'cache_dir' directory.
  4761. #Default:
  4762. # Store the journal inside its cache_dir
  4763.  
  4764. # TAG: logfile_rotate
  4765. # Specifies the default number of logfile rotations to make when you
  4766. # type 'squid -k rotate'. The default is 10, which will rotate
  4767. # with extensions 0 through 9. Setting logfile_rotate to 0 will
  4768. # disable the file name rotation, but the logfiles are still closed
  4769. # and re-opened. This will enable you to rename the logfiles
  4770. # yourself just before sending the rotate signal.
  4771. #
  4772. # Note, from Squid-3.1 this option is only a default for cache.log,
  4773. # that log can be rotated separately by using debug_options.
  4774. #
  4775. # Note, from Squid-4 this option is only a default for access.log
  4776. # recorded by stdio: module. Those logs can be rotated separately by
  4777. # using the rotate=N option on their access_log directive.
  4778. #
  4779. # Note, the 'squid -k rotate' command normally sends a USR1
  4780. # signal to the running squid process. In certain situations
  4781. # (e.g. on Linux with Async I/O), USR1 is used for other
  4782. # purposes, so -k rotate uses another signal. It is best to get
  4783. # in the habit of using 'squid -k rotate' instead of 'kill -USR1
  4784. # <pid>'.
  4785. #
  4786. # Note, for Debian/Linux the default of logfile_rotate is
  4787. # zero, since it includes external logfile-rotation methods.
  4788. #Default:
  4789. # logfile_rotate 0
  4790.  
  4791. # TAG: mime_table
  4792. # Path to Squid's icon configuration file.
  4793. #
  4794. # You shouldn't need to change this, but the default file contains
  4795. # examples and formatting information if you do.
  4796. #Default:
  4797. # mime_table /usr/share/squid/mime.conf
  4798.  
  4799. # TAG: log_mime_hdrs on|off
  4800. # The Cache can record both the request and the response MIME
  4801. # headers for each HTTP transaction. The headers are encoded
  4802. # safely and will appear as two bracketed fields at the end of
  4803. # the access log (for either the native or httpd-emulated log
  4804. # formats). To enable this logging set log_mime_hdrs to 'on'.
  4805. #Default:
  4806. # log_mime_hdrs off
  4807.  
  4808. # TAG: pid_filename
  4809. # A filename to write the process-id to. To disable, enter "none".
  4810. #Default:
  4811. # pid_filename /run/squid.pid
  4812.  
  4813. # TAG: client_netmask
  4814. # A netmask for client addresses in logfiles and cachemgr output.
  4815. # Change this to protect the privacy of your cache clients.
  4816. # A netmask of 255.255.255.0 will log all IP's in that range with
  4817. # the last digit set to '0'.
  4818. #Default:
  4819. # Log full client IP address
  4820.  
  4821. # TAG: strip_query_terms
  4822. # By default, Squid strips query terms from requested URLs before
  4823. # logging. This protects your user's privacy and reduces log size.
  4824. #
  4825. # When investigating HIT/MISS or other caching behaviour you
  4826. # will need to disable this to see the full URL used by Squid.
  4827. #Default:
  4828. # strip_query_terms on
  4829.  
  4830. # TAG: buffered_logs on|off
  4831. # Whether to write/send access_log records ASAP or accumulate them and
  4832. # then write/send them in larger chunks. Buffering may improve
  4833. # performance because it decreases the number of I/Os. However,
  4834. # buffering increases the delay before log records become available to
  4835. # the final recipient (e.g., a disk file or logging daemon) and,
  4836. # hence, increases the risk of log records loss.
  4837. #
  4838. # Note that even when buffered_logs are off, Squid may have to buffer
  4839. # records if it cannot write/send them immediately due to pending I/Os
  4840. # (e.g., the I/O writing the previous log record) or connectivity loss.
  4841. #
  4842. # Currently honored by 'daemon' and 'tcp' access_log modules only.
  4843. #Default:
  4844. # buffered_logs off
  4845.  
  4846. # TAG: netdb_filename
  4847. # Where Squid stores it's netdb journal.
  4848. # When enabled this journal preserves netdb state between restarts.
  4849. #
  4850. # To disable, enter "none".
  4851. #Default:
  4852. # netdb_filename stdio:/var/spool/squid/netdb.state
  4853.  
  4854. # OPTIONS FOR TROUBLESHOOTING
  4855. # -----------------------------------------------------------------------------
  4856.  
  4857. # TAG: cache_log
  4858. # Squid administrative logging file.
  4859. #
  4860. # This is where general information about Squid behavior goes. You can
  4861. # increase the amount of data logged to this file and how often it is
  4862. # rotated with "debug_options"
  4863. #Default:
  4864. # cache_log /var/log/squid/cache.log
  4865.  
  4866. # TAG: debug_options
  4867. # Logging options are set as section,level where each source file
  4868. # is assigned a unique section. Lower levels result in less
  4869. # output, Full debugging (level 9) can result in a very large
  4870. # log file, so be careful.
  4871. #
  4872. # The magic word "ALL" sets debugging levels for all sections.
  4873. # The default is to run with "ALL,1" to record important warnings.
  4874. #
  4875. # The rotate=N option can be used to keep more or less of these logs
  4876. # than would otherwise be kept by logfile_rotate.
  4877. # For most uses a single log should be enough to monitor current
  4878. # events affecting Squid.
  4879. #Default:
  4880. # Log all critical and important messages.
  4881.  
  4882. # TAG: coredump_dir
  4883. # By default Squid leaves core files in the directory from where
  4884. # it was started. If you set 'coredump_dir' to a directory
  4885. # that exists, Squid will chdir() to that directory at startup
  4886. # and coredump files will be left there.
  4887. #
  4888. #Default:
  4889. # Use the directory from where Squid was started.
  4890. #
  4891.  
  4892. # Leave coredumps in the first cache dir
  4893. coredump_dir /var/spool/squid
  4894.  
  4895. # OPTIONS FOR FTP GATEWAYING
  4896. # -----------------------------------------------------------------------------
  4897.  
  4898. # TAG: ftp_user
  4899. # If you want the anonymous login password to be more informative
  4900. # (and enable the use of picky FTP servers), set this to something
  4901. # reasonable for your domain, like wwwuser@somewhere.net
  4902. #
  4903. # The reason why this is domainless by default is the
  4904. # request can be made on the behalf of a user in any domain,
  4905. # depending on how the cache is used.
  4906. # Some FTP server also validate the email address is valid
  4907. # (for example perl.com).
  4908. #Default:
  4909. # ftp_user Squid@
  4910.  
  4911. # TAG: ftp_passive
  4912. # If your firewall does not allow Squid to use passive
  4913. # connections, turn off this option.
  4914. #
  4915. # Use of ftp_epsv_all option requires this to be ON.
  4916. #Default:
  4917. # ftp_passive on
  4918.  
  4919. # TAG: ftp_epsv_all
  4920. # FTP Protocol extensions permit the use of a special "EPSV ALL" command.
  4921. #
  4922. # NATs may be able to put the connection on a "fast path" through the
  4923. # translator, as the EPRT command will never be used and therefore,
  4924. # translation of the data portion of the segments will never be needed.
  4925. #
  4926. # When a client only expects to do two-way FTP transfers this may be
  4927. # useful.
  4928. # If squid finds that it must do a three-way FTP transfer after issuing
  4929. # an EPSV ALL command, the FTP session will fail.
  4930. #
  4931. # If you have any doubts about this option do not use it.
  4932. # Squid will nicely attempt all other connection methods.
  4933. #
  4934. # Requires ftp_passive to be ON (default) for any effect.
  4935. #Default:
  4936. # ftp_epsv_all off
  4937.  
  4938. # TAG: ftp_epsv
  4939. # FTP Protocol extensions permit the use of a special "EPSV" command.
  4940. #
  4941. # NATs may be able to put the connection on a "fast path" through the
  4942. # translator using EPSV, as the EPRT command will never be used
  4943. # and therefore, translation of the data portion of the segments
  4944. # will never be needed.
  4945. #
  4946. # EPSV is often required to interoperate with FTP servers on IPv6
  4947. # networks. On the other hand, it may break some IPv4 servers.
  4948. #
  4949. # By default, EPSV may try EPSV with any FTP server. To fine tune
  4950. # that decision, you may restrict EPSV to certain clients or servers
  4951. # using ACLs:
  4952. #
  4953. # ftp_epsv allow|deny al1 acl2 ...
  4954. #
  4955. # WARNING: Disabling EPSV may cause problems with external NAT and IPv6.
  4956. #
  4957. # Only fast ACLs are supported.
  4958. # Requires ftp_passive to be ON (default) for any effect.
  4959. #Default:
  4960. # none
  4961.  
  4962. # TAG: ftp_eprt
  4963. # FTP Protocol extensions permit the use of a special "EPRT" command.
  4964. #
  4965. # This extension provides a protocol neutral alternative to the
  4966. # IPv4-only PORT command. When supported it enables active FTP data
  4967. # channels over IPv6 and efficient NAT handling.
  4968. #
  4969. # Turning this OFF will prevent EPRT being attempted and will skip
  4970. # straight to using PORT for IPv4 servers.
  4971. #
  4972. # Some devices are known to not handle this extension correctly and
  4973. # may result in crashes. Devices which suport EPRT enough to fail
  4974. # cleanly will result in Squid attempting PORT anyway. This directive
  4975. # should only be disabled when EPRT results in device failures.
  4976. #
  4977. # WARNING: Doing so will convert Squid back to the old behavior with all
  4978. # the related problems with external NAT devices/layers and IPv4-only FTP.
  4979. #Default:
  4980. # ftp_eprt on
  4981.  
  4982. # TAG: ftp_sanitycheck
  4983. # For security and data integrity reasons Squid by default performs
  4984. # sanity checks of the addresses of FTP data connections ensure the
  4985. # data connection is to the requested server. If you need to allow
  4986. # FTP connections to servers using another IP address for the data
  4987. # connection turn this off.
  4988. #Default:
  4989. # ftp_sanitycheck on
  4990.  
  4991. # TAG: ftp_telnet_protocol
  4992. # The FTP protocol is officially defined to use the telnet protocol
  4993. # as transport channel for the control connection. However, many
  4994. # implementations are broken and does not respect this aspect of
  4995. # the FTP protocol.
  4996. #
  4997. # If you have trouble accessing files with ASCII code 255 in the
  4998. # path or similar problems involving this ASCII code you can
  4999. # try setting this directive to off. If that helps, report to the
  5000. # operator of the FTP server in question that their FTP server
  5001. # is broken and does not follow the FTP standard.
  5002. #Default:
  5003. # ftp_telnet_protocol on
  5004.  
  5005. # OPTIONS FOR EXTERNAL SUPPORT PROGRAMS
  5006. # -----------------------------------------------------------------------------
  5007.  
  5008. # TAG: diskd_program
  5009. # Specify the location of the diskd executable.
  5010. # Note this is only useful if you have compiled in
  5011. # diskd as one of the store io modules.
  5012. #Default:
  5013. # diskd_program /usr/lib/squid/diskd
  5014.  
  5015. # TAG: unlinkd_program
  5016. # Specify the location of the executable for file deletion process.
  5017. #Default:
  5018. # unlinkd_program /usr/lib/squid/unlinkd
  5019.  
  5020. # TAG: pinger_program
  5021. # Specify the location of the executable for the pinger process.
  5022. #Default:
  5023. # pinger_program /usr/lib/squid/pinger
  5024.  
  5025. # TAG: pinger_enable
  5026. # Control whether the pinger is active at run-time.
  5027. # Enables turning ICMP pinger on and off with a simple
  5028. # squid -k reconfigure.
  5029. #Default:
  5030. # pinger_enable on
  5031.  
  5032. # OPTIONS FOR URL REWRITING
  5033. # -----------------------------------------------------------------------------
  5034.  
  5035. # TAG: url_rewrite_program
  5036. # The name and command line parameters of an admin-provided executable
  5037. # for redirecting clients or adjusting/replacing client request URLs.
  5038. #
  5039. # This helper is consulted after the received request is cleared by
  5040. # http_access and adapted using eICAP/ICAP services (if any). If the
  5041. # helper does not redirect the client, Squid checks adapted_http_access
  5042. # and may consult the cache or forward the request to the next hop.
  5043. #
  5044. #
  5045. # For each request, the helper gets one line in the following format:
  5046. #
  5047. # [channel-ID <SP>] request-URL [<SP> extras] <NL>
  5048. #
  5049. # Use url_rewrite_extras to configure what Squid sends as 'extras'.
  5050. #
  5051. #
  5052. # The helper must reply to each query using a single line:
  5053. #
  5054. # [channel-ID <SP>] result [<SP> kv-pairs] <NL>
  5055. #
  5056. # The result section must match exactly one of the following outcomes:
  5057. #
  5058. # OK [status=30N] url="..."
  5059. #
  5060. # Redirect the client to a URL supplied in the 'url' parameter.
  5061. # Optional 'status' specifies the status code to send to the
  5062. # client in Squid's HTTP redirect response. It must be one of
  5063. # the standard HTTP redirect status codes: 301, 302, 303, 307,
  5064. # or 308. When no specific status is requested, Squid uses 302.
  5065. #
  5066. # OK rewrite-url="..."
  5067. #
  5068. # Replace the current request URL with the one supplied in the
  5069. # 'rewrite-url' parameter. Squid fetches the resource specified
  5070. # by the new URL and forwards the received response (or its
  5071. # cached copy) to the client.
  5072. #
  5073. # WARNING: Avoid rewriting URLs! When possible, redirect the
  5074. # client using an "OK url=..." helper response instead.
  5075. # Rewriting URLs may create inconsistent requests and/or break
  5076. # synchronization between internal client and origin server
  5077. # states, especially when URLs or other message parts contain
  5078. # snippets of that state. For example, Squid does not adjust
  5079. # Location headers and embedded URLs after the helper rewrites
  5080. # the request URL.
  5081. #
  5082. # OK
  5083. # Keep the client request intact.
  5084. #
  5085. # ERR
  5086. # Keep the client request intact.
  5087. #
  5088. # BH [message="..."]
  5089. # A helper problem that should be reported to the Squid admin
  5090. # via a level-1 cache.log message. The 'message' parameter is
  5091. # reserved for specifying the log message.
  5092. #
  5093. # In addition to the kv-pairs mentioned above, Squid also understands
  5094. # the following optional kv-pairs in URL rewriter responses:
  5095. #
  5096. # clt_conn_tag=TAG
  5097. # Associates a TAG with the client TCP connection.
  5098. #
  5099. # The clt_conn_tag=TAG pair is treated as a regular transaction
  5100. # annotation for the current request and also annotates future
  5101. # requests on the same client connection. A helper may update
  5102. # the TAG during subsequent requests by returning a new kv-pair.
  5103. #
  5104. #
  5105. # Helper messages contain the channel-ID part if and only if the
  5106. # url_rewrite_children directive specifies positive concurrency. As a
  5107. # channel-ID value, Squid sends a number between 0 and concurrency-1.
  5108. # The helper must echo back the received channel-ID in its response.
  5109. #
  5110. # By default, Squid does not use a URL rewriter.
  5111. #Default:
  5112. # none
  5113.  
  5114. # TAG: url_rewrite_children
  5115. # Specifies the maximum number of redirector processes that Squid may
  5116. # spawn (numberofchildren) and several related options. Using too few of
  5117. # these helper processes (a.k.a. "helpers") creates request queues.
  5118. # Using too many helpers wastes your system resources.
  5119. #
  5120. # Usage: numberofchildren [option]...
  5121. #
  5122. # The startup= and idle= options allow some measure of skew in your
  5123. # tuning.
  5124. #
  5125. # startup=
  5126. #
  5127. # Sets a minimum of how many processes are to be spawned when Squid
  5128. # starts or reconfigures. When set to zero the first request will
  5129. # cause spawning of the first child process to handle it.
  5130. #
  5131. # Starting too few will cause an initial slowdown in traffic as Squid
  5132. # attempts to simultaneously spawn enough processes to cope.
  5133. #
  5134. # idle=
  5135. #
  5136. # Sets a minimum of how many processes Squid is to try and keep available
  5137. # at all times. When traffic begins to rise above what the existing
  5138. # processes can handle this many more will be spawned up to the maximum
  5139. # configured. A minimum setting of 1 is required.
  5140. #
  5141. # concurrency=
  5142. #
  5143. # The number of requests each redirector helper can handle in
  5144. # parallel. Defaults to 0 which indicates the redirector
  5145. # is a old-style single threaded redirector.
  5146. #
  5147. # When this directive is set to a value >= 1 then the protocol
  5148. # used to communicate with the helper is modified to include
  5149. # an ID in front of the request/response. The ID from the request
  5150. # must be echoed back with the response to that request.
  5151. #
  5152. # queue-size=N
  5153. #
  5154. # Sets the maximum number of queued requests. A request is queued when
  5155. # no existing child can accept it due to concurrency limit and no new
  5156. # child can be started due to numberofchildren limit. The default
  5157. # maximum is zero if url_rewrite_bypass is enabled and
  5158. # 2*numberofchildren otherwise. If the queued requests exceed queue size
  5159. # and redirector_bypass configuration option is set, then redirector is
  5160. # bypassed. Otherwise, Squid is allowed to temporarily exceed the
  5161. # configured maximum, marking the affected helper as "overloaded". If
  5162. # the helper overload lasts more than 3 minutes, the action prescribed
  5163. # by the on-persistent-overload option applies.
  5164. #
  5165. # on-persistent-overload=action
  5166. #
  5167. # Specifies Squid reaction to a new helper request arriving when the helper
  5168. # has been overloaded for more that 3 minutes already. The number of queued
  5169. # requests determines whether the helper is overloaded (see the queue-size
  5170. # option).
  5171. #
  5172. # Two actions are supported:
  5173. #
  5174. # die Squid worker quits. This is the default behavior.
  5175. #
  5176. # ERR Squid treats the helper request as if it was
  5177. # immediately submitted, and the helper immediately
  5178. # replied with an ERR response. This action has no effect
  5179. # on the already queued and in-progress helper requests.
  5180. #Default:
  5181. # url_rewrite_children 20 startup=0 idle=1 concurrency=0
  5182.  
  5183. # TAG: url_rewrite_host_header
  5184. # To preserve same-origin security policies in browsers and
  5185. # prevent Host: header forgery by redirectors Squid rewrites
  5186. # any Host: header in redirected requests.
  5187. #
  5188. # If you are running an accelerator this may not be a wanted
  5189. # effect of a redirector. This directive enables you disable
  5190. # Host: alteration in reverse-proxy traffic.
  5191. #
  5192. # WARNING: Entries are cached on the result of the URL rewriting
  5193. # process, so be careful if you have domain-virtual hosts.
  5194. #
  5195. # WARNING: Squid and other software verifies the URL and Host
  5196. # are matching, so be careful not to relay through other proxies
  5197. # or inspecting firewalls with this disabled.
  5198. #Default:
  5199. # url_rewrite_host_header on
  5200.  
  5201. # TAG: url_rewrite_access
  5202. # If defined, this access list specifies which requests are
  5203. # sent to the redirector processes.
  5204. #
  5205. # This clause supports both fast and slow acl types.
  5206. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  5207. #Default:
  5208. # Allow, unless rules exist in squid.conf.
  5209.  
  5210. # TAG: url_rewrite_bypass
  5211. # When this is 'on', a request will not go through the
  5212. # redirector if all the helpers are busy. If this is 'off' and the
  5213. # redirector queue grows too large, the action is prescribed by the
  5214. # on-persistent-overload option. You should only enable this if the
  5215. # redirectors are not critical to your caching system. If you use
  5216. # redirectors for access control, and you enable this option,
  5217. # users may have access to pages they should not
  5218. # be allowed to request.
  5219. #
  5220. # Enabling this option sets the default url_rewrite_children queue-size
  5221. # option value to 0.
  5222. #Default:
  5223. # url_rewrite_bypass off
  5224.  
  5225. # TAG: url_rewrite_extras
  5226. # Specifies a string to be append to request line format for the
  5227. # rewriter helper. "Quoted" format values may contain spaces and
  5228. # logformat %macros. In theory, any logformat %macro can be used.
  5229. # In practice, a %macro expands as a dash (-) if the helper request is
  5230. # sent before the required macro information is available to Squid.
  5231. #Default:
  5232. # url_rewrite_extras "%>a/%>A %un %>rm myip=%la myport=%lp"
  5233.  
  5234. # TAG: url_rewrite_timeout
  5235. # Squid times active requests to redirector. The timeout value and Squid
  5236. # reaction to a timed out request are configurable using the following
  5237. # format:
  5238. #
  5239. # url_rewrite_timeout timeout time-units on_timeout=<action> [response=<quoted-response>]
  5240. #
  5241. # supported timeout actions:
  5242. # fail Squid return a ERR_GATEWAY_FAILURE error page
  5243. #
  5244. # bypass Do not re-write the URL
  5245. #
  5246. # retry Send the lookup to the helper again
  5247. #
  5248. # use_configured_response
  5249. # Use the <quoted-response> as helper response
  5250. #Default:
  5251. # Squid waits for the helper response forever
  5252.  
  5253. # OPTIONS FOR STORE ID
  5254. # -----------------------------------------------------------------------------
  5255.  
  5256. # TAG: store_id_program
  5257. # Specify the location of the executable StoreID helper to use.
  5258. # Since they can perform almost any function there isn't one included.
  5259. #
  5260. # For each requested URL, the helper will receive one line with the format
  5261. #
  5262. # [channel-ID <SP>] URL [<SP> extras]<NL>
  5263. #
  5264. #
  5265. # After processing the request the helper must reply using the following format:
  5266. #
  5267. # [channel-ID <SP>] result [<SP> kv-pairs]
  5268. #
  5269. # The result code can be:
  5270. #
  5271. # OK store-id="..."
  5272. # Use the StoreID supplied in 'store-id='.
  5273. #
  5274. # ERR
  5275. # The default is to use HTTP request URL as the store ID.
  5276. #
  5277. # BH
  5278. # An internal error occurred in the helper, preventing
  5279. # a result being identified.
  5280. #
  5281. # In addition to the above kv-pairs Squid also understands the following
  5282. # optional kv-pairs received from URL rewriters:
  5283. # clt_conn_tag=TAG
  5284. # Associates a TAG with the client TCP connection.
  5285. # Please see url_rewrite_program related documentation for this
  5286. # kv-pair
  5287. #
  5288. # Helper programs should be prepared to receive and possibly ignore
  5289. # additional whitespace-separated tokens on each input line.
  5290. #
  5291. # When using the concurrency= option the protocol is changed by
  5292. # introducing a query channel tag in front of the request/response.
  5293. # The query channel tag is a number between 0 and concurrency-1.
  5294. # This value must be echoed back unchanged to Squid as the first part
  5295. # of the response relating to its request.
  5296. #
  5297. # NOTE: when using StoreID refresh_pattern will apply to the StoreID
  5298. # returned from the helper and not the URL.
  5299. #
  5300. # WARNING: Wrong StoreID value returned by a careless helper may result
  5301. # in the wrong cached response returned to the user.
  5302. #
  5303. # By default, a StoreID helper is not used.
  5304. #Default:
  5305. # none
  5306.  
  5307. # TAG: store_id_extras
  5308. # Specifies a string to be append to request line format for the
  5309. # StoreId helper. "Quoted" format values may contain spaces and
  5310. # logformat %macros. In theory, any logformat %macro can be used.
  5311. # In practice, a %macro expands as a dash (-) if the helper request is
  5312. # sent before the required macro information is available to Squid.
  5313. #Default:
  5314. # store_id_extras "%>a/%>A %un %>rm myip=%la myport=%lp"
  5315.  
  5316. # TAG: store_id_children
  5317. # Specifies the maximum number of StoreID helper processes that Squid
  5318. # may spawn (numberofchildren) and several related options. Using
  5319. # too few of these helper processes (a.k.a. "helpers") creates request
  5320. # queues. Using too many helpers wastes your system resources.
  5321. #
  5322. # Usage: numberofchildren [option]...
  5323. #
  5324. # The startup= and idle= options allow some measure of skew in your
  5325. # tuning.
  5326. #
  5327. # startup=
  5328. #
  5329. # Sets a minimum of how many processes are to be spawned when Squid
  5330. # starts or reconfigures. When set to zero the first request will
  5331. # cause spawning of the first child process to handle it.
  5332. #
  5333. # Starting too few will cause an initial slowdown in traffic as Squid
  5334. # attempts to simultaneously spawn enough processes to cope.
  5335. #
  5336. # idle=
  5337. #
  5338. # Sets a minimum of how many processes Squid is to try and keep available
  5339. # at all times. When traffic begins to rise above what the existing
  5340. # processes can handle this many more will be spawned up to the maximum
  5341. # configured. A minimum setting of 1 is required.
  5342. #
  5343. # concurrency=
  5344. #
  5345. # The number of requests each storeID helper can handle in
  5346. # parallel. Defaults to 0 which indicates the helper
  5347. # is a old-style single threaded program.
  5348. #
  5349. # When this directive is set to a value >= 1 then the protocol
  5350. # used to communicate with the helper is modified to include
  5351. # an ID in front of the request/response. The ID from the request
  5352. # must be echoed back with the response to that request.
  5353. #
  5354. # queue-size=N
  5355. #
  5356. # Sets the maximum number of queued requests to N. A request is queued
  5357. # when no existing child can accept it due to concurrency limit and no
  5358. # new child can be started due to numberofchildren limit. The default
  5359. # maximum is 2*numberofchildren. If the queued requests exceed queue
  5360. # size and redirector_bypass configuration option is set, then
  5361. # redirector is bypassed. Otherwise, Squid is allowed to temporarily
  5362. # exceed the configured maximum, marking the affected helper as
  5363. # "overloaded". If the helper overload lasts more than 3 minutes, the
  5364. # action prescribed by the on-persistent-overload option applies.
  5365. #
  5366. # on-persistent-overload=action
  5367. #
  5368. # Specifies Squid reaction to a new helper request arriving when the helper
  5369. # has been overloaded for more that 3 minutes already. The number of queued
  5370. # requests determines whether the helper is overloaded (see the queue-size
  5371. # option).
  5372. #
  5373. # Two actions are supported:
  5374. #
  5375. # die Squid worker quits. This is the default behavior.
  5376. #
  5377. # ERR Squid treats the helper request as if it was
  5378. # immediately submitted, and the helper immediately
  5379. # replied with an ERR response. This action has no effect
  5380. # on the already queued and in-progress helper requests.
  5381. #Default:
  5382. # store_id_children 20 startup=0 idle=1 concurrency=0
  5383.  
  5384. # TAG: store_id_access
  5385. # If defined, this access list specifies which requests are
  5386. # sent to the StoreID processes. By default all requests
  5387. # are sent.
  5388. #
  5389. # This clause supports both fast and slow acl types.
  5390. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  5391. #Default:
  5392. # Allow, unless rules exist in squid.conf.
  5393.  
  5394. # TAG: store_id_bypass
  5395. # When this is 'on', a request will not go through the
  5396. # helper if all helpers are busy. If this is 'off' and the helper
  5397. # queue grows too large, the action is prescribed by the
  5398. # on-persistent-overload option. You should only enable this if the
  5399. # helpers are not critical to your caching system. If you use
  5400. # helpers for critical caching components, and you enable this
  5401. # option, users may not get objects from cache.
  5402. # This options sets default queue-size option of the store_id_children
  5403. # to 0.
  5404. #Default:
  5405. # store_id_bypass on
  5406.  
  5407. # OPTIONS FOR TUNING THE CACHE
  5408. # -----------------------------------------------------------------------------
  5409.  
  5410. # TAG: cache
  5411. # Requests denied by this directive will not be served from the cache
  5412. # and their responses will not be stored in the cache. This directive
  5413. # has no effect on other transactions and on already cached responses.
  5414. #
  5415. # This clause supports both fast and slow acl types.
  5416. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  5417. #
  5418. # This and the two other similar caching directives listed below are
  5419. # checked at different transaction processing stages, have different
  5420. # access to response information, affect different cache operations,
  5421. # and differ in slow ACLs support:
  5422. #
  5423. # * cache: Checked before Squid makes a hit/miss determination.
  5424. # No access to reply information!
  5425. # Denies both serving a hit and storing a miss.
  5426. # Supports both fast and slow ACLs.
  5427. # * send_hit: Checked after a hit was detected.
  5428. # Has access to reply (hit) information.
  5429. # Denies serving a hit only.
  5430. # Supports fast ACLs only.
  5431. # * store_miss: Checked before storing a cachable miss.
  5432. # Has access to reply (miss) information.
  5433. # Denies storing a miss only.
  5434. # Supports fast ACLs only.
  5435. #
  5436. # If you are not sure which of the three directives to use, apply the
  5437. # following decision logic:
  5438. #
  5439. # * If your ACL(s) are of slow type _and_ need response info, redesign.
  5440. # Squid does not support that particular combination at this time.
  5441. # Otherwise:
  5442. # * If your directive ACL(s) are of slow type, use "cache"; and/or
  5443. # * if your directive ACL(s) need no response info, use "cache".
  5444. # Otherwise:
  5445. # * If you do not want the response cached, use store_miss; and/or
  5446. # * if you do not want a hit on a cached response, use send_hit.
  5447. #Default:
  5448. # By default, this directive is unused and has no effect.
  5449.  
  5450. # TAG: send_hit
  5451. # Responses denied by this directive will not be served from the cache
  5452. # (but may still be cached, see store_miss). This directive has no
  5453. # effect on the responses it allows and on the cached objects.
  5454. #
  5455. # Please see the "cache" directive for a summary of differences among
  5456. # store_miss, send_hit, and cache directives.
  5457. #
  5458. # Unlike the "cache" directive, send_hit only supports fast acl
  5459. # types. See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  5460. #
  5461. # For example:
  5462. #
  5463. # # apply custom Store ID mapping to some URLs
  5464. # acl MapMe dstdomain .c.example.com
  5465. # store_id_program ...
  5466. # store_id_access allow MapMe
  5467. #
  5468. # # but prevent caching of special responses
  5469. # # such as 302 redirects that cause StoreID loops
  5470. # acl Ordinary http_status 200-299
  5471. # store_miss deny MapMe !Ordinary
  5472. #
  5473. # # and do not serve any previously stored special responses
  5474. # # from the cache (in case they were already cached before
  5475. # # the above store_miss rule was in effect).
  5476. # send_hit deny MapMe !Ordinary
  5477. #Default:
  5478. # By default, this directive is unused and has no effect.
  5479.  
  5480. # TAG: store_miss
  5481. # Responses denied by this directive will not be cached (but may still
  5482. # be served from the cache, see send_hit). This directive has no
  5483. # effect on the responses it allows and on the already cached responses.
  5484. #
  5485. # Please see the "cache" directive for a summary of differences among
  5486. # store_miss, send_hit, and cache directives. See the
  5487. # send_hit directive for a usage example.
  5488. #
  5489. # Unlike the "cache" directive, store_miss only supports fast acl
  5490. # types. See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  5491. #Default:
  5492. # By default, this directive is unused and has no effect.
  5493.  
  5494. # TAG: max_stale time-units
  5495. # This option puts an upper limit on how stale content Squid
  5496. # will serve from the cache if cache validation fails.
  5497. # Can be overriden by the refresh_pattern max-stale option.
  5498. #Default:
  5499. # max_stale 1 week
  5500.  
  5501. # TAG: refresh_pattern
  5502. # usage: refresh_pattern [-i] regex min percent max [options]
  5503. #
  5504. # By default, regular expressions are CASE-SENSITIVE. To make
  5505. # them case-insensitive, use the -i option.
  5506. #
  5507. # 'Min' is the time (in minutes) an object without an explicit
  5508. # expiry time should be considered fresh. The recommended
  5509. # value is 0, any higher values may cause dynamic applications
  5510. # to be erroneously cached unless the application designer
  5511. # has taken the appropriate actions.
  5512. #
  5513. # 'Percent' is a percentage of the objects age (time since last
  5514. # modification age) an object without explicit expiry time
  5515. # will be considered fresh.
  5516. #
  5517. # 'Max' is an upper limit on how long objects without an explicit
  5518. # expiry time will be considered fresh. The value is also used
  5519. # to form Cache-Control: max-age header for a request sent from
  5520. # Squid to origin/parent.
  5521. #
  5522. # options: override-expire
  5523. # override-lastmod
  5524. # reload-into-ims
  5525. # ignore-reload
  5526. # ignore-no-store
  5527. # ignore-private
  5528. # max-stale=NN
  5529. # refresh-ims
  5530. # store-stale
  5531. #
  5532. # override-expire enforces min age even if the server
  5533. # sent an explicit expiry time (e.g., with the
  5534. # Expires: header or Cache-Control: max-age). Doing this
  5535. # VIOLATES the HTTP standard. Enabling this feature
  5536. # could make you liable for problems which it causes.
  5537. #
  5538. # Note: override-expire does not enforce staleness - it only extends
  5539. # freshness / min. If the server returns a Expires time which
  5540. # is longer than your max time, Squid will still consider
  5541. # the object fresh for that period of time.
  5542. #
  5543. # override-lastmod enforces min age even on objects
  5544. # that were modified recently.
  5545. #
  5546. # reload-into-ims changes a client no-cache or ``reload''
  5547. # request for a cached entry into a conditional request using
  5548. # If-Modified-Since and/or If-None-Match headers, provided the
  5549. # cached entry has a Last-Modified and/or a strong ETag header.
  5550. # Doing this VIOLATES the HTTP standard. Enabling this feature
  5551. # could make you liable for problems which it causes.
  5552. #
  5553. # ignore-reload ignores a client no-cache or ``reload''
  5554. # header. Doing this VIOLATES the HTTP standard. Enabling
  5555. # this feature could make you liable for problems which
  5556. # it causes.
  5557. #
  5558. # ignore-no-store ignores any ``Cache-control: no-store''
  5559. # headers received from a server. Doing this VIOLATES
  5560. # the HTTP standard. Enabling this feature could make you
  5561. # liable for problems which it causes.
  5562. #
  5563. # ignore-private ignores any ``Cache-control: private''
  5564. # headers received from a server. Doing this VIOLATES
  5565. # the HTTP standard. Enabling this feature could make you
  5566. # liable for problems which it causes.
  5567. #
  5568. # refresh-ims causes squid to contact the origin server
  5569. # when a client issues an If-Modified-Since request. This
  5570. # ensures that the client will receive an updated version
  5571. # if one is available.
  5572. #
  5573. # store-stale stores responses even if they don't have explicit
  5574. # freshness or a validator (i.e., Last-Modified or an ETag)
  5575. # present, or if they're already stale. By default, Squid will
  5576. # not cache such responses because they usually can't be
  5577. # reused. Note that such responses will be stale by default.
  5578. #
  5579. # max-stale=NN provide a maximum staleness factor. Squid won't
  5580. # serve objects more stale than this even if it failed to
  5581. # validate the object. Default: use the max_stale global limit.
  5582. #
  5583. # Basically a cached object is:
  5584. #
  5585. # FRESH if expire > now, else STALE
  5586. # STALE if age > max
  5587. # FRESH if lm-factor < percent, else STALE
  5588. # FRESH if age < min
  5589. # else STALE
  5590. #
  5591. # The refresh_pattern lines are checked in the order listed here.
  5592. # The first entry which matches is used. If none of the entries
  5593. # match the default will be used.
  5594. #
  5595. # Note, you must uncomment all the default lines if you want
  5596. # to change one. The default setting is only active if none is
  5597. # used.
  5598. #
  5599. #
  5600.  
  5601. #
  5602. # Add any of your own refresh_pattern entries above these.
  5603. #
  5604. refresh_pattern ^ftp: 1440 20% 10080
  5605. refresh_pattern ^gopher: 1440 0% 1440
  5606. refresh_pattern -i (/cgi-bin/|\?) 0 0% 0
  5607. refresh_pattern \/(Packages|Sources)(|\.bz2|\.gz|\.xz)$ 0 0% 0 refresh-ims
  5608. refresh_pattern \/Release(|\.gpg)$ 0 0% 0 refresh-ims
  5609. refresh_pattern \/InRelease$ 0 0% 0 refresh-ims
  5610. refresh_pattern \/(Translation-.*)(|\.bz2|\.gz|\.xz)$ 0 0% 0 refresh-ims
  5611. # example pattern for deb packages
  5612. #refresh_pattern (\.deb|\.udeb)$ 129600 100% 129600
  5613. refresh_pattern . 0 20% 4320
  5614.  
  5615. # TAG: quick_abort_min (KB)
  5616. #Default:
  5617. # quick_abort_min 16 KB
  5618.  
  5619. # TAG: quick_abort_max (KB)
  5620. #Default:
  5621. # quick_abort_max 16 KB
  5622.  
  5623. # TAG: quick_abort_pct (percent)
  5624. # The cache by default continues downloading aborted requests
  5625. # which are almost completed (less than 16 KB remaining). This
  5626. # may be undesirable on slow (e.g. SLIP) links and/or very busy
  5627. # caches. Impatient users may tie up file descriptors and
  5628. # bandwidth by repeatedly requesting and immediately aborting
  5629. # downloads.
  5630. #
  5631. # When the user aborts a request, Squid will check the
  5632. # quick_abort values to the amount of data transferred until
  5633. # then.
  5634. #
  5635. # If the transfer has less than 'quick_abort_min' KB remaining,
  5636. # it will finish the retrieval.
  5637. #
  5638. # If the transfer has more than 'quick_abort_max' KB remaining,
  5639. # it will abort the retrieval.
  5640. #
  5641. # If more than 'quick_abort_pct' of the transfer has completed,
  5642. # it will finish the retrieval.
  5643. #
  5644. # If you do not want any retrieval to continue after the client
  5645. # has aborted, set both 'quick_abort_min' and 'quick_abort_max'
  5646. # to '0 KB'.
  5647. #
  5648. # If you want retrievals to always continue if they are being
  5649. # cached set 'quick_abort_min' to '-1 KB'.
  5650. #Default:
  5651. # quick_abort_pct 95
  5652.  
  5653. # TAG: read_ahead_gap buffer-size
  5654. # The amount of data the cache will buffer ahead of what has been
  5655. # sent to the client when retrieving an object from another server.
  5656. #Default:
  5657. # read_ahead_gap 16 KB
  5658.  
  5659. # TAG: negative_ttl time-units
  5660. # Set the Default Time-to-Live (TTL) for failed requests.
  5661. # Certain types of failures (such as "connection refused" and
  5662. # "404 Not Found") are able to be negatively-cached for a short time.
  5663. # Modern web servers should provide Expires: header, however if they
  5664. # do not this can provide a minimum TTL.
  5665. # The default is not to cache errors with unknown expiry details.
  5666. #
  5667. # Note that this is different from negative caching of DNS lookups.
  5668. #
  5669. # WARNING: Doing this VIOLATES the HTTP standard. Enabling
  5670. # this feature could make you liable for problems which it
  5671. # causes.
  5672. #Default:
  5673. # negative_ttl 0 seconds
  5674.  
  5675. # TAG: positive_dns_ttl time-units
  5676. # Upper limit on how long Squid will cache positive DNS responses.
  5677. # Default is 6 hours (360 minutes). This directive must be set
  5678. # larger than negative_dns_ttl.
  5679. #Default:
  5680. # positive_dns_ttl 6 hours
  5681.  
  5682. # TAG: negative_dns_ttl time-units
  5683. # Time-to-Live (TTL) for negative caching of failed DNS lookups.
  5684. # This also sets the lower cache limit on positive lookups.
  5685. # Minimum value is 1 second, and it is not recommendable to go
  5686. # much below 10 seconds.
  5687. #Default:
  5688. # negative_dns_ttl 1 minutes
  5689.  
  5690. # TAG: range_offset_limit size [acl acl...]
  5691. # usage: (size) [units] [[!]aclname]
  5692. #
  5693. # Sets an upper limit on how far (number of bytes) into the file
  5694. # a Range request may be to cause Squid to prefetch the whole file.
  5695. # If beyond this limit, Squid forwards the Range request as it is and
  5696. # the result is NOT cached.
  5697. #
  5698. # This is to stop a far ahead range request (lets say start at 17MB)
  5699. # from making Squid fetch the whole object up to that point before
  5700. # sending anything to the client.
  5701. #
  5702. # Multiple range_offset_limit lines may be specified, and they will
  5703. # be searched from top to bottom on each request until a match is found.
  5704. # The first match found will be used. If no line matches a request, the
  5705. # default limit of 0 bytes will be used.
  5706. #
  5707. # 'size' is the limit specified as a number of units.
  5708. #
  5709. # 'units' specifies whether to use bytes, KB, MB, etc.
  5710. # If no units are specified bytes are assumed.
  5711. #
  5712. # A size of 0 causes Squid to never fetch more than the
  5713. # client requested. (default)
  5714. #
  5715. # A size of 'none' causes Squid to always fetch the object from the
  5716. # beginning so it may cache the result. (2.0 style)
  5717. #
  5718. # 'aclname' is the name of a defined ACL.
  5719. #
  5720. # NP: Using 'none' as the byte value here will override any quick_abort settings
  5721. # that may otherwise apply to the range request. The range request will
  5722. # be fully fetched from start to finish regardless of the client
  5723. # actions. This affects bandwidth usage.
  5724. #Default:
  5725. # none
  5726.  
  5727. # TAG: minimum_expiry_time (seconds)
  5728. # The minimum caching time according to (Expires - Date)
  5729. # headers Squid honors if the object can't be revalidated.
  5730. # The default is 60 seconds.
  5731. #
  5732. # In reverse proxy environments it might be desirable to honor
  5733. # shorter object lifetimes. It is most likely better to make
  5734. # your server return a meaningful Last-Modified header however.
  5735. #
  5736. # In ESI environments where page fragments often have short
  5737. # lifetimes, this will often be best set to 0.
  5738. #Default:
  5739. # minimum_expiry_time 60 seconds
  5740.  
  5741. # TAG: store_avg_object_size (bytes)
  5742. # Average object size, used to estimate number of objects your
  5743. # cache can hold. The default is 13 KB.
  5744. #
  5745. # This is used to pre-seed the cache index memory allocation to
  5746. # reduce expensive reallocate operations while handling clients
  5747. # traffic. Too-large values may result in memory allocation during
  5748. # peak traffic, too-small values will result in wasted memory.
  5749. #
  5750. # Check the cache manager 'info' report metrics for the real
  5751. # object sizes seen by your Squid before tuning this.
  5752. #Default:
  5753. # store_avg_object_size 13 KB
  5754.  
  5755. # TAG: store_objects_per_bucket
  5756. # Target number of objects per bucket in the store hash table.
  5757. # Lowering this value increases the total number of buckets and
  5758. # also the storage maintenance rate. The default is 20.
  5759. #Default:
  5760. # store_objects_per_bucket 20
  5761.  
  5762. # HTTP OPTIONS
  5763. # -----------------------------------------------------------------------------
  5764.  
  5765. # TAG: request_header_max_size (KB)
  5766. # This specifies the maximum size for HTTP headers in a request.
  5767. # Request headers are usually relatively small (about 512 bytes).
  5768. # Placing a limit on the request header size will catch certain
  5769. # bugs (for example with persistent connections) and possibly
  5770. # buffer-overflow or denial-of-service attacks.
  5771. #Default:
  5772. # request_header_max_size 64 KB
  5773.  
  5774. # TAG: reply_header_max_size (KB)
  5775. # This specifies the maximum size for HTTP headers in a reply.
  5776. # Reply headers are usually relatively small (about 512 bytes).
  5777. # Placing a limit on the reply header size will catch certain
  5778. # bugs (for example with persistent connections) and possibly
  5779. # buffer-overflow or denial-of-service attacks.
  5780. #Default:
  5781. # reply_header_max_size 64 KB
  5782.  
  5783. # TAG: request_body_max_size (bytes)
  5784. # This specifies the maximum size for an HTTP request body.
  5785. # In other words, the maximum size of a PUT/POST request.
  5786. # A user who attempts to send a request with a body larger
  5787. # than this limit receives an "Invalid Request" error message.
  5788. # If you set this parameter to a zero (the default), there will
  5789. # be no limit imposed.
  5790. #
  5791. # See also client_request_buffer_max_size for an alternative
  5792. # limitation on client uploads which can be configured.
  5793. #Default:
  5794. # No limit.
  5795.  
  5796. # TAG: client_request_buffer_max_size (bytes)
  5797. # This specifies the maximum buffer size of a client request.
  5798. # It prevents squid eating too much memory when somebody uploads
  5799. # a large file.
  5800. #Default:
  5801. # client_request_buffer_max_size 512 KB
  5802.  
  5803. # TAG: broken_posts
  5804. # A list of ACL elements which, if matched, causes Squid to send
  5805. # an extra CRLF pair after the body of a PUT/POST request.
  5806. #
  5807. # Some HTTP servers has broken implementations of PUT/POST,
  5808. # and rely on an extra CRLF pair sent by some WWW clients.
  5809. #
  5810. # Quote from RFC2616 section 4.1 on this matter:
  5811. #
  5812. # Note: certain buggy HTTP/1.0 client implementations generate an
  5813. # extra CRLF's after a POST request. To restate what is explicitly
  5814. # forbidden by the BNF, an HTTP/1.1 client must not preface or follow
  5815. # a request with an extra CRLF.
  5816. #
  5817. # This clause only supports fast acl types.
  5818. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  5819. #
  5820. #Example:
  5821. # acl buggy_server url_regex ^http://....
  5822. # broken_posts allow buggy_server
  5823. #Default:
  5824. # Obey RFC 2616.
  5825.  
  5826. # TAG: adaptation_uses_indirect_client on|off
  5827. # Controls whether the indirect client IP address (instead of the direct
  5828. # client IP address) is passed to adaptation services.
  5829. #
  5830. # See also: follow_x_forwarded_for adaptation_send_client_ip
  5831. #Default:
  5832. # adaptation_uses_indirect_client on
  5833.  
  5834. # TAG: via on|off
  5835. # If set (default), Squid will include a Via header in requests and
  5836. # replies as required by RFC2616.
  5837. #Default:
  5838. # via on
  5839.  
  5840. # TAG: vary_ignore_expire on|off
  5841. # Many HTTP servers supporting Vary gives such objects
  5842. # immediate expiry time with no cache-control header
  5843. # when requested by a HTTP/1.0 client. This option
  5844. # enables Squid to ignore such expiry times until
  5845. # HTTP/1.1 is fully implemented.
  5846. #
  5847. # WARNING: If turned on this may eventually cause some
  5848. # varying objects not intended for caching to get cached.
  5849. #Default:
  5850. # vary_ignore_expire off
  5851.  
  5852. # TAG: request_entities
  5853. # Squid defaults to deny GET and HEAD requests with request entities,
  5854. # as the meaning of such requests are undefined in the HTTP standard
  5855. # even if not explicitly forbidden.
  5856. #
  5857. # Set this directive to on if you have clients which insists
  5858. # on sending request entities in GET or HEAD requests. But be warned
  5859. # that there is server software (both proxies and web servers) which
  5860. # can fail to properly process this kind of request which may make you
  5861. # vulnerable to cache pollution attacks if enabled.
  5862. #Default:
  5863. # request_entities off
  5864.  
  5865. # TAG: request_header_access
  5866. # Usage: request_header_access header_name allow|deny [!]aclname ...
  5867. #
  5868. # WARNING: Doing this VIOLATES the HTTP standard. Enabling
  5869. # this feature could make you liable for problems which it
  5870. # causes.
  5871. #
  5872. # This option replaces the old 'anonymize_headers' and the
  5873. # older 'http_anonymizer' option with something that is much
  5874. # more configurable. A list of ACLs for each header name allows
  5875. # removal of specific header fields under specific conditions.
  5876. #
  5877. # This option only applies to outgoing HTTP request headers (i.e.,
  5878. # headers sent by Squid to the next HTTP hop such as a cache peer
  5879. # or an origin server). The option has no effect during cache hit
  5880. # detection. The equivalent adaptation vectoring point in ICAP
  5881. # terminology is post-cache REQMOD.
  5882. #
  5883. # The option is applied to individual outgoing request header
  5884. # fields. For each request header field F, Squid uses the first
  5885. # qualifying sets of request_header_access rules:
  5886. #
  5887. # 1. Rules with header_name equal to F's name.
  5888. # 2. Rules with header_name 'Other', provided F's name is not
  5889. # on the hard-coded list of commonly used HTTP header names.
  5890. # 3. Rules with header_name 'All'.
  5891. #
  5892. # Within that qualifying rule set, rule ACLs are checked as usual.
  5893. # If ACLs of an "allow" rule match, the header field is allowed to
  5894. # go through as is. If ACLs of a "deny" rule match, the header is
  5895. # removed and request_header_replace is then checked to identify
  5896. # if the removed header has a replacement. If no rules within the
  5897. # set have matching ACLs, the header field is left as is.
  5898. #
  5899. # For example, to achieve the same behavior as the old
  5900. # 'http_anonymizer standard' option, you should use:
  5901. #
  5902. # request_header_access From deny all
  5903. # request_header_access Referer deny all
  5904. # request_header_access User-Agent deny all
  5905. #
  5906. # Or, to reproduce the old 'http_anonymizer paranoid' feature
  5907. # you should use:
  5908. #
  5909. # request_header_access Authorization allow all
  5910. # request_header_access Proxy-Authorization allow all
  5911. # request_header_access Cache-Control allow all
  5912. # request_header_access Content-Length allow all
  5913. # request_header_access Content-Type allow all
  5914. # request_header_access Date allow all
  5915. # request_header_access Host allow all
  5916. # request_header_access If-Modified-Since allow all
  5917. # request_header_access Pragma allow all
  5918. # request_header_access Accept allow all
  5919. # request_header_access Accept-Charset allow all
  5920. # request_header_access Accept-Encoding allow all
  5921. # request_header_access Accept-Language allow all
  5922. # request_header_access Connection allow all
  5923. # request_header_access All deny all
  5924. #
  5925. # HTTP reply headers are controlled with the reply_header_access directive.
  5926. #
  5927. # By default, all headers are allowed (no anonymizing is performed).
  5928. #Default:
  5929. # No limits.
  5930.  
  5931. # TAG: reply_header_access
  5932. # Usage: reply_header_access header_name allow|deny [!]aclname ...
  5933. #
  5934. # WARNING: Doing this VIOLATES the HTTP standard. Enabling
  5935. # this feature could make you liable for problems which it
  5936. # causes.
  5937. #
  5938. # This option only applies to reply headers, i.e., from the
  5939. # server to the client.
  5940. #
  5941. # This is the same as request_header_access, but in the other
  5942. # direction. Please see request_header_access for detailed
  5943. # documentation.
  5944. #
  5945. # For example, to achieve the same behavior as the old
  5946. # 'http_anonymizer standard' option, you should use:
  5947. #
  5948. # reply_header_access Server deny all
  5949. # reply_header_access WWW-Authenticate deny all
  5950. # reply_header_access Link deny all
  5951. #
  5952. # Or, to reproduce the old 'http_anonymizer paranoid' feature
  5953. # you should use:
  5954. #
  5955. # reply_header_access Allow allow all
  5956. # reply_header_access WWW-Authenticate allow all
  5957. # reply_header_access Proxy-Authenticate allow all
  5958. # reply_header_access Cache-Control allow all
  5959. # reply_header_access Content-Encoding allow all
  5960. # reply_header_access Content-Length allow all
  5961. # reply_header_access Content-Type allow all
  5962. # reply_header_access Date allow all
  5963. # reply_header_access Expires allow all
  5964. # reply_header_access Last-Modified allow all
  5965. # reply_header_access Location allow all
  5966. # reply_header_access Pragma allow all
  5967. # reply_header_access Content-Language allow all
  5968. # reply_header_access Retry-After allow all
  5969. # reply_header_access Title allow all
  5970. # reply_header_access Content-Disposition allow all
  5971. # reply_header_access Connection allow all
  5972. # reply_header_access All deny all
  5973. #
  5974. # HTTP request headers are controlled with the request_header_access directive.
  5975. #
  5976. # By default, all headers are allowed (no anonymizing is
  5977. # performed).
  5978. #Default:
  5979. # No limits.
  5980.  
  5981. # TAG: request_header_replace
  5982. # Usage: request_header_replace header_name message
  5983. # Example: request_header_replace User-Agent Nutscrape/1.0 (CP/M; 8-bit)
  5984. #
  5985. # This option allows you to change the contents of headers
  5986. # denied with request_header_access above, by replacing them
  5987. # with some fixed string.
  5988. #
  5989. # This only applies to request headers, not reply headers.
  5990. #
  5991. # By default, headers are removed if denied.
  5992. #Default:
  5993. # none
  5994.  
  5995. # TAG: reply_header_replace
  5996. # Usage: reply_header_replace header_name message
  5997. # Example: reply_header_replace Server Foo/1.0
  5998. #
  5999. # This option allows you to change the contents of headers
  6000. # denied with reply_header_access above, by replacing them
  6001. # with some fixed string.
  6002. #
  6003. # This only applies to reply headers, not request headers.
  6004. #
  6005. # By default, headers are removed if denied.
  6006. #Default:
  6007. # none
  6008.  
  6009. # TAG: request_header_add
  6010. # Usage: request_header_add field-name field-value [ acl ... ]
  6011. # Example: request_header_add X-Client-CA "CA=%ssl::>cert_issuer" all
  6012. #
  6013. # This option adds header fields to outgoing HTTP requests (i.e.,
  6014. # request headers sent by Squid to the next HTTP hop such as a
  6015. # cache peer or an origin server). The option has no effect during
  6016. # cache hit detection. The equivalent adaptation vectoring point
  6017. # in ICAP terminology is post-cache REQMOD.
  6018. #
  6019. # Field-name is a token specifying an HTTP header name. If a
  6020. # standard HTTP header name is used, Squid does not check whether
  6021. # the new header conflicts with any existing headers or violates
  6022. # HTTP rules. If the request to be modified already contains a
  6023. # field with the same name, the old field is preserved but the
  6024. # header field values are not merged.
  6025. #
  6026. # Field-value is either a token or a quoted string. If quoted
  6027. # string format is used, then the surrounding quotes are removed
  6028. # while escape sequences and %macros are processed.
  6029. #
  6030. # One or more Squid ACLs may be specified to restrict header
  6031. # injection to matching requests. As always in squid.conf, all
  6032. # ACLs in the ACL list must be satisfied for the insertion to
  6033. # happen. The request_header_add supports fast ACLs only.
  6034. #
  6035. # See also: reply_header_add.
  6036. #Default:
  6037. # none
  6038.  
  6039. # TAG: reply_header_add
  6040. # Usage: reply_header_add field-name field-value [ acl ... ]
  6041. # Example: reply_header_add X-Client-CA "CA=%ssl::>cert_issuer" all
  6042. #
  6043. # This option adds header fields to outgoing HTTP responses (i.e., response
  6044. # headers delivered by Squid to the client). This option has no effect on
  6045. # cache hit detection. The equivalent adaptation vectoring point in
  6046. # ICAP terminology is post-cache RESPMOD. This option does not apply to
  6047. # successful CONNECT replies.
  6048. #
  6049. # Field-name is a token specifying an HTTP header name. If a
  6050. # standard HTTP header name is used, Squid does not check whether
  6051. # the new header conflicts with any existing headers or violates
  6052. # HTTP rules. If the response to be modified already contains a
  6053. # field with the same name, the old field is preserved but the
  6054. # header field values are not merged.
  6055. #
  6056. # Field-value is either a token or a quoted string. If quoted
  6057. # string format is used, then the surrounding quotes are removed
  6058. # while escape sequences and %macros are processed.
  6059. #
  6060. # One or more Squid ACLs may be specified to restrict header
  6061. # injection to matching responses. As always in squid.conf, all
  6062. # ACLs in the ACL list must be satisfied for the insertion to
  6063. # happen. The reply_header_add option supports fast ACLs only.
  6064. #
  6065. # See also: request_header_add.
  6066. #Default:
  6067. # none
  6068.  
  6069. # TAG: note
  6070. # This option used to log custom information about the master
  6071. # transaction. For example, an admin may configure Squid to log
  6072. # which "user group" the transaction belongs to, where "user group"
  6073. # will be determined based on a set of ACLs and not [just]
  6074. # authentication information.
  6075. # Values of key/value pairs can be logged using %{key}note macros:
  6076. #
  6077. # note key value acl ...
  6078. # logformat myFormat ... %{key}note ...
  6079. #
  6080. # This clause only supports fast acl types.
  6081. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  6082. #Default:
  6083. # none
  6084.  
  6085. # TAG: relaxed_header_parser on|off|warn
  6086. # In the default "on" setting Squid accepts certain forms
  6087. # of non-compliant HTTP messages where it is unambiguous
  6088. # what the sending application intended even if the message
  6089. # is not correctly formatted. The messages is then normalized
  6090. # to the correct form when forwarded by Squid.
  6091. #
  6092. # If set to "warn" then a warning will be emitted in cache.log
  6093. # each time such HTTP error is encountered.
  6094. #
  6095. # If set to "off" then such HTTP errors will cause the request
  6096. # or response to be rejected.
  6097. #Default:
  6098. # relaxed_header_parser on
  6099.  
  6100. # TAG: collapsed_forwarding (on|off)
  6101. # This option controls whether Squid is allowed to merge multiple
  6102. # potentially cachable requests for the same URI before Squid knows
  6103. # whether the response is going to be cachable.
  6104. #
  6105. # When enabled, instead of forwarding each concurrent request for
  6106. # the same URL, Squid just sends the first of them. The other, so
  6107. # called "collapsed" requests, wait for the response to the first
  6108. # request and, if it happens to be cachable, use that response.
  6109. # Here, "concurrent requests" means "received after the first
  6110. # request headers were parsed and before the corresponding response
  6111. # headers were parsed".
  6112. #
  6113. # This feature is disabled by default: enabling collapsed
  6114. # forwarding needlessly delays forwarding requests that look
  6115. # cachable (when they are collapsed) but then need to be forwarded
  6116. # individually anyway because they end up being for uncachable
  6117. # content. However, in some cases, such as acceleration of highly
  6118. # cachable content with periodic or grouped expiration times, the
  6119. # gains from collapsing [large volumes of simultaneous refresh
  6120. # requests] outweigh losses from such delays.
  6121. #
  6122. # Squid collapses two kinds of requests: regular client requests
  6123. # received on one of the listening ports and internal "cache
  6124. # revalidation" requests which are triggered by those regular
  6125. # requests hitting a stale cached object. Revalidation collapsing
  6126. # is currently disabled for Squid instances containing SMP-aware
  6127. # disk or memory caches and for Vary-controlled cached objects.
  6128. #Default:
  6129. # collapsed_forwarding off
  6130.  
  6131. # TAG: collapsed_forwarding_access
  6132. # Use this directive to restrict collapsed forwarding to a subset of
  6133. # eligible requests. The directive is checked for regular HTTP
  6134. # requests, internal revalidation requests, and HTCP/ICP requests.
  6135. #
  6136. # collapsed_forwarding_access allow|deny [!]aclname ...
  6137. #
  6138. # This directive cannot force collapsing. It has no effect on
  6139. # collapsing unless collapsed_forwarding is 'on', and all other
  6140. # collapsing preconditions are satisfied.
  6141. #
  6142. # * A denied request will not collapse, and future transactions will
  6143. # not collapse on it (even if they are allowed to collapse).
  6144. #
  6145. # * An allowed request may collapse, or future transactions may
  6146. # collapse on it (provided they are allowed to collapse).
  6147. #
  6148. # This directive is evaluated before receiving HTTP response headers
  6149. # and without access to Squid-to-peer connection (if any).
  6150. #
  6151. # Only fast ACLs are supported.
  6152. #
  6153. # See also: collapsed_forwarding.
  6154. #Default:
  6155. # Requests may be collapsed if collapsed_forwarding is on.
  6156.  
  6157. # TAG: shared_transient_entries_limit (number of entries)
  6158. # This directive limits the size of a table used for sharing current
  6159. # transaction information among SMP workers. A table entry stores meta
  6160. # information about a single cache entry being delivered to Squid
  6161. # client(s) by one or more SMP workers. A single table entry consumes
  6162. # less than 128 shared memory bytes.
  6163. #
  6164. # The limit should be significantly larger than the number of
  6165. # concurrent non-collapsed cachable responses leaving Squid. For a
  6166. # cache that handles less than 5000 concurrent requests, the default
  6167. # setting of 16384 should be plenty.
  6168. #
  6169. # Using excessively large values wastes shared memory. Limiting the
  6170. # table size too much results in hash collisions, leading to lower hit
  6171. # ratio and missed SMP request collapsing opportunities: Transactions
  6172. # left without a table entry cannot cache their responses and are
  6173. # invisible to other concurrent requests for the same resource.
  6174. #
  6175. # A zero limit is allowed but unsupported. A positive small limit
  6176. # lowers hit ratio, but zero limit disables a lot of essential
  6177. # synchronization among SMP workers, leading to HTTP violations (e.g.,
  6178. # stale hit responses). It also disables shared collapsed forwarding:
  6179. # A worker becomes unable to collapse its requests on transactions in
  6180. # other workers, resulting in more trips to the origin server and more
  6181. # cache thrashing.
  6182. #Default:
  6183. # shared_transient_entries_limit 16384
  6184.  
  6185. # TIMEOUTS
  6186. # -----------------------------------------------------------------------------
  6187.  
  6188. # TAG: forward_timeout time-units
  6189. # This parameter specifies how long Squid should at most attempt in
  6190. # finding a forwarding path for the request before giving up.
  6191. #Default:
  6192. # forward_timeout 4 minutes
  6193.  
  6194. # TAG: connect_timeout time-units
  6195. # This parameter specifies how long to wait for the TCP connect to
  6196. # the requested server or peer to complete before Squid should
  6197. # attempt to find another path where to forward the request.
  6198. #Default:
  6199. # connect_timeout 1 minute
  6200.  
  6201. # TAG: peer_connect_timeout time-units
  6202. # This parameter specifies how long to wait for a pending TCP
  6203. # connection to a peer cache. The default is 30 seconds. You
  6204. # may also set different timeout values for individual neighbors
  6205. # with the 'connect-timeout' option on a 'cache_peer' line.
  6206. #Default:
  6207. # peer_connect_timeout 30 seconds
  6208.  
  6209. # TAG: read_timeout time-units
  6210. # Applied on peer server connections.
  6211. #
  6212. # After each successful read(), the timeout will be extended by this
  6213. # amount. If no data is read again after this amount of time,
  6214. # the request is aborted and logged with ERR_READ_TIMEOUT.
  6215. #
  6216. # The default is 15 minutes.
  6217. #Default:
  6218. # read_timeout 15 minutes
  6219.  
  6220. # TAG: write_timeout time-units
  6221. # This timeout is tracked for all connections that have data
  6222. # available for writing and are waiting for the socket to become
  6223. # ready. After each successful write, the timeout is extended by
  6224. # the configured amount. If Squid has data to write but the
  6225. # connection is not ready for the configured duration, the
  6226. # transaction associated with the connection is terminated. The
  6227. # default is 15 minutes.
  6228. #Default:
  6229. # write_timeout 15 minutes
  6230.  
  6231. # TAG: request_timeout
  6232. # How long to wait for complete HTTP request headers after initial
  6233. # connection establishment.
  6234. #Default:
  6235. # request_timeout 5 minutes
  6236.  
  6237. # TAG: request_start_timeout
  6238. # How long to wait for the first request byte after initial
  6239. # connection establishment.
  6240. #Default:
  6241. # request_start_timeout 5 minutes
  6242.  
  6243. # TAG: client_idle_pconn_timeout
  6244. # How long to wait for the next HTTP request on a persistent
  6245. # client connection after the previous request completes.
  6246. #Default:
  6247. # client_idle_pconn_timeout 2 minutes
  6248.  
  6249. # TAG: ftp_client_idle_timeout
  6250. # How long to wait for an FTP request on a connection to Squid ftp_port.
  6251. # Many FTP clients do not deal with idle connection closures well,
  6252. # necessitating a longer default timeout than client_idle_pconn_timeout
  6253. # used for incoming HTTP requests.
  6254. #Default:
  6255. # ftp_client_idle_timeout 30 minutes
  6256.  
  6257. # TAG: client_lifetime time-units
  6258. # The maximum amount of time a client (browser) is allowed to
  6259. # remain connected to the cache process. This protects the Cache
  6260. # from having a lot of sockets (and hence file descriptors) tied up
  6261. # in a CLOSE_WAIT state from remote clients that go away without
  6262. # properly shutting down (either because of a network failure or
  6263. # because of a poor client implementation). The default is one
  6264. # day, 1440 minutes.
  6265. #
  6266. # NOTE: The default value is intended to be much larger than any
  6267. # client would ever need to be connected to your cache. You
  6268. # should probably change client_lifetime only as a last resort.
  6269. # If you seem to have many client connections tying up
  6270. # filedescriptors, we recommend first tuning the read_timeout,
  6271. # request_timeout, persistent_request_timeout and quick_abort values.
  6272. #Default:
  6273. # client_lifetime 1 day
  6274.  
  6275. # TAG: pconn_lifetime time-units
  6276. # Desired maximum lifetime of a persistent connection.
  6277. # When set, Squid will close a now-idle persistent connection that
  6278. # exceeded configured lifetime instead of moving the connection into
  6279. # the idle connection pool (or equivalent). No effect on ongoing/active
  6280. # transactions. Connection lifetime is the time period from the
  6281. # connection acceptance or opening time until "now".
  6282. #
  6283. # This limit is useful in environments with long-lived connections
  6284. # where Squid configuration or environmental factors change during a
  6285. # single connection lifetime. If unrestricted, some connections may
  6286. # last for hours and even days, ignoring those changes that should
  6287. # have affected their behavior or their existence.
  6288. #
  6289. # Currently, a new lifetime value supplied via Squid reconfiguration
  6290. # has no effect on already idle connections unless they become busy.
  6291. #
  6292. # When set to '0' this limit is not used.
  6293. #Default:
  6294. # pconn_lifetime 0 seconds
  6295.  
  6296. # TAG: half_closed_clients
  6297. # Some clients may shutdown the sending side of their TCP
  6298. # connections, while leaving their receiving sides open. Sometimes,
  6299. # Squid can not tell the difference between a half-closed and a
  6300. # fully-closed TCP connection.
  6301. #
  6302. # By default, Squid will immediately close client connections when
  6303. # read(2) returns "no more data to read."
  6304. #
  6305. # Change this option to 'on' and Squid will keep open connections
  6306. # until a read(2) or write(2) on the socket returns an error.
  6307. # This may show some benefits for reverse proxies. But if not
  6308. # it is recommended to leave OFF.
  6309. #Default:
  6310. # half_closed_clients off
  6311.  
  6312. # TAG: server_idle_pconn_timeout
  6313. # Timeout for idle persistent connections to servers and other
  6314. # proxies.
  6315. #Default:
  6316. # server_idle_pconn_timeout 1 minute
  6317.  
  6318. # TAG: ident_timeout
  6319. # Maximum time to wait for IDENT lookups to complete.
  6320. #
  6321. # If this is too high, and you enabled IDENT lookups from untrusted
  6322. # users, you might be susceptible to denial-of-service by having
  6323. # many ident requests going at once.
  6324. #Default:
  6325. # ident_timeout 10 seconds
  6326.  
  6327. # TAG: shutdown_lifetime time-units
  6328. # When SIGTERM or SIGHUP is received, the cache is put into
  6329. # "shutdown pending" mode until all active sockets are closed.
  6330. # This value is the lifetime to set for all open descriptors
  6331. # during shutdown mode. Any active clients after this many
  6332. # seconds will receive a 'timeout' message.
  6333. #Default:
  6334. # shutdown_lifetime 30 seconds
  6335.  
  6336. # ADMINISTRATIVE PARAMETERS
  6337. # -----------------------------------------------------------------------------
  6338.  
  6339. # TAG: cache_mgr
  6340. # Email-address of local cache manager who will receive
  6341. # mail if the cache dies. The default is "webmaster".
  6342. #Default:
  6343. # cache_mgr webmaster
  6344.  
  6345. # TAG: mail_from
  6346. # From: email-address for mail sent when the cache dies.
  6347. # The default is to use 'squid@unique_hostname'.
  6348. #
  6349. # See also: unique_hostname directive.
  6350. #Default:
  6351. # none
  6352.  
  6353. # TAG: mail_program
  6354. # Email program used to send mail if the cache dies.
  6355. # The default is "mail". The specified program must comply
  6356. # with the standard Unix mail syntax:
  6357. # mail-program recipient < mailfile
  6358. #
  6359. # Optional command line options can be specified.
  6360. #Default:
  6361. # mail_program mail
  6362.  
  6363. # TAG: cache_effective_user
  6364. # If you start Squid as root, it will change its effective/real
  6365. # UID/GID to the user specified below. The default is to change
  6366. # to UID of proxy.
  6367. # see also; cache_effective_group
  6368. #Default:
  6369. # cache_effective_user proxy
  6370.  
  6371. # TAG: cache_effective_group
  6372. # Squid sets the GID to the effective user's default group ID
  6373. # (taken from the password file) and supplementary group list
  6374. # from the groups membership.
  6375. #
  6376. # If you want Squid to run with a specific GID regardless of
  6377. # the group memberships of the effective user then set this
  6378. # to the group (or GID) you want Squid to run as. When set
  6379. # all other group privileges of the effective user are ignored
  6380. # and only this GID is effective. If Squid is not started as
  6381. # root the user starting Squid MUST be member of the specified
  6382. # group.
  6383. #
  6384. # This option is not recommended by the Squid Team.
  6385. # Our preference is for administrators to configure a secure
  6386. # user account for squid with UID/GID matching system policies.
  6387. #Default:
  6388. # Use system group memberships of the cache_effective_user account
  6389.  
  6390. # TAG: httpd_suppress_version_string on|off
  6391. # Suppress Squid version string info in HTTP headers and HTML error pages.
  6392. #Default:
  6393. # httpd_suppress_version_string off
  6394.  
  6395. # TAG: visible_hostname
  6396. # If you want to present a special hostname in error messages, etc,
  6397. # define this. Otherwise, the return value of gethostname()
  6398. # will be used. If you have multiple caches in a cluster and
  6399. # get errors about IP-forwarding you must set them to have individual
  6400. # names with this setting.
  6401. #Default:
  6402. # Automatically detect the system host name
  6403.  
  6404. # TAG: unique_hostname
  6405. # If you want to have multiple machines with the same
  6406. # 'visible_hostname' you must give each machine a different
  6407. # 'unique_hostname' so forwarding loops can be detected.
  6408. #Default:
  6409. # Copy the value from visible_hostname
  6410.  
  6411. # TAG: hostname_aliases
  6412. # A list of other DNS names your cache has.
  6413. #Default:
  6414. # none
  6415.  
  6416. # TAG: umask
  6417. # Minimum umask which should be enforced while the proxy
  6418. # is running, in addition to the umask set at startup.
  6419. #
  6420. # For a traditional octal representation of umasks, start
  6421. # your value with 0.
  6422. #Default:
  6423. # umask 027
  6424.  
  6425. # OPTIONS FOR THE CACHE REGISTRATION SERVICE
  6426. # -----------------------------------------------------------------------------
  6427. #
  6428. # This section contains parameters for the (optional) cache
  6429. # announcement service. This service is provided to help
  6430. # cache administrators locate one another in order to join or
  6431. # create cache hierarchies.
  6432. #
  6433. # An 'announcement' message is sent (via UDP) to the registration
  6434. # service by Squid. By default, the announcement message is NOT
  6435. # SENT unless you enable it with 'announce_period' below.
  6436. #
  6437. # The announcement message includes your hostname, plus the
  6438. # following information from this configuration file:
  6439. #
  6440. # http_port
  6441. # icp_port
  6442. # cache_mgr
  6443. #
  6444. # All current information is processed regularly and made
  6445. # available on the Web at http://www.ircache.net/Cache/Tracker/.
  6446.  
  6447. # TAG: announce_period
  6448. # This is how frequently to send cache announcements.
  6449. #
  6450. # To enable announcing your cache, just set an announce period.
  6451. #
  6452. # Example:
  6453. # announce_period 1 day
  6454. #Default:
  6455. # Announcement messages disabled.
  6456.  
  6457. # TAG: announce_host
  6458. # Set the hostname where announce registration messages will be sent.
  6459. #
  6460. # See also announce_port and announce_file
  6461. #Default:
  6462. # announce_host tracker.ircache.net
  6463.  
  6464. # TAG: announce_file
  6465. # The contents of this file will be included in the announce
  6466. # registration messages.
  6467. #Default:
  6468. # none
  6469.  
  6470. # TAG: announce_port
  6471. # Set the port where announce registration messages will be sent.
  6472. #
  6473. # See also announce_host and announce_file
  6474. #Default:
  6475. # announce_port 3131
  6476.  
  6477. # HTTPD-ACCELERATOR OPTIONS
  6478. # -----------------------------------------------------------------------------
  6479.  
  6480. # TAG: httpd_accel_surrogate_id
  6481. # Surrogates (http://www.esi.org/architecture_spec_1.0.html)
  6482. # need an identification token to allow control targeting. Because
  6483. # a farm of surrogates may all perform the same tasks, they may share
  6484. # an identification token.
  6485. #
  6486. # When the surrogate is a reverse-proxy, this ID is also
  6487. # used as cdn-id for CDN-Loop detection (RFC 8586).
  6488. #Default:
  6489. # visible_hostname is used if no specific ID is set.
  6490.  
  6491. # TAG: http_accel_surrogate_remote on|off
  6492. # Remote surrogates (such as those in a CDN) honour the header
  6493. # "Surrogate-Control: no-store-remote".
  6494. #
  6495. # Set this to on to have squid behave as a remote surrogate.
  6496. #Default:
  6497. # http_accel_surrogate_remote off
  6498.  
  6499. # TAG: esi_parser libxml2|expat
  6500. # Selects the XML parsing library to use when interpreting responses with
  6501. # Edge Side Includes.
  6502. #
  6503. # To disable ESI handling completely, ./configure Squid with --disable-esi.
  6504. #Default:
  6505. # Selects libxml2 if available at ./configure time or libexpat otherwise.
  6506.  
  6507. # DELAY POOL PARAMETERS
  6508. # -----------------------------------------------------------------------------
  6509.  
  6510. # TAG: delay_pools
  6511. # This represents the number of delay pools to be used. For example,
  6512. # if you have one class 2 delay pool and one class 3 delays pool, you
  6513. # have a total of 2 delay pools.
  6514. #
  6515. # See also delay_parameters, delay_class, delay_access for pool
  6516. # configuration details.
  6517. #Default:
  6518. # delay_pools 0
  6519.  
  6520. # TAG: delay_class
  6521. # This defines the class of each delay pool. There must be exactly one
  6522. # delay_class line for each delay pool. For example, to define two
  6523. # delay pools, one of class 2 and one of class 3, the settings above
  6524. # and here would be:
  6525. #
  6526. # Example:
  6527. # delay_pools 4 # 4 delay pools
  6528. # delay_class 1 2 # pool 1 is a class 2 pool
  6529. # delay_class 2 3 # pool 2 is a class 3 pool
  6530. # delay_class 3 4 # pool 3 is a class 4 pool
  6531. # delay_class 4 5 # pool 4 is a class 5 pool
  6532. #
  6533. # The delay pool classes are:
  6534. #
  6535. # class 1 Everything is limited by a single aggregate
  6536. # bucket.
  6537. #
  6538. # class 2 Everything is limited by a single aggregate
  6539. # bucket as well as an "individual" bucket chosen
  6540. # from bits 25 through 32 of the IPv4 address.
  6541. #
  6542. # class 3 Everything is limited by a single aggregate
  6543. # bucket as well as a "network" bucket chosen
  6544. # from bits 17 through 24 of the IP address and a
  6545. # "individual" bucket chosen from bits 17 through
  6546. # 32 of the IPv4 address.
  6547. #
  6548. # class 4 Everything in a class 3 delay pool, with an
  6549. # additional limit on a per user basis. This
  6550. # only takes effect if the username is established
  6551. # in advance - by forcing authentication in your
  6552. # http_access rules.
  6553. #
  6554. # class 5 Requests are grouped according their tag (see
  6555. # external_acl's tag= reply).
  6556. #
  6557. #
  6558. # Each pool also requires a delay_parameters directive to configure the pool size
  6559. # and speed limits used whenever the pool is applied to a request. Along with
  6560. # a set of delay_access directives to determine when it is used.
  6561. #
  6562. # NOTE: If an IP address is a.b.c.d
  6563. # -> bits 25 through 32 are "d"
  6564. # -> bits 17 through 24 are "c"
  6565. # -> bits 17 through 32 are "c * 256 + d"
  6566. #
  6567. # NOTE-2: Due to the use of bitmasks in class 2,3,4 pools they only apply to
  6568. # IPv4 traffic. Class 1 and 5 pools may be used with IPv6 traffic.
  6569. #
  6570. # This clause only supports fast acl types.
  6571. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  6572. #
  6573. # See also delay_parameters and delay_access.
  6574. #Default:
  6575. # none
  6576.  
  6577. # TAG: delay_access
  6578. # This is used to determine which delay pool a request falls into.
  6579. #
  6580. # delay_access is sorted per pool and the matching starts with pool 1,
  6581. # then pool 2, ..., and finally pool N. The first delay pool where the
  6582. # request is allowed is selected for the request. If it does not allow
  6583. # the request to any pool then the request is not delayed (default).
  6584. #
  6585. # For example, if you want some_big_clients in delay
  6586. # pool 1 and lotsa_little_clients in delay pool 2:
  6587. #
  6588. # delay_access 1 allow some_big_clients
  6589. # delay_access 1 deny all
  6590. # delay_access 2 allow lotsa_little_clients
  6591. # delay_access 2 deny all
  6592. # delay_access 3 allow authenticated_clients
  6593. #
  6594. # See also delay_parameters and delay_class.
  6595. #
  6596. #Default:
  6597. # Deny using the pool, unless allow rules exist in squid.conf for the pool.
  6598.  
  6599. # TAG: delay_parameters
  6600. # This defines the parameters for a delay pool. Each delay pool has
  6601. # a number of "buckets" associated with it, as explained in the
  6602. # description of delay_class.
  6603. #
  6604. # For a class 1 delay pool, the syntax is:
  6605. # delay_class pool 1
  6606. # delay_parameters pool aggregate
  6607. #
  6608. # For a class 2 delay pool:
  6609. # delay_class pool 2
  6610. # delay_parameters pool aggregate individual
  6611. #
  6612. # For a class 3 delay pool:
  6613. # delay_class pool 3
  6614. # delay_parameters pool aggregate network individual
  6615. #
  6616. # For a class 4 delay pool:
  6617. # delay_class pool 4
  6618. # delay_parameters pool aggregate network individual user
  6619. #
  6620. # For a class 5 delay pool:
  6621. # delay_class pool 5
  6622. # delay_parameters pool tagrate
  6623. #
  6624. # The option variables are:
  6625. #
  6626. # pool a pool number - ie, a number between 1 and the
  6627. # number specified in delay_pools as used in
  6628. # delay_class lines.
  6629. #
  6630. # aggregate the speed limit parameters for the aggregate bucket
  6631. # (class 1, 2, 3).
  6632. #
  6633. # individual the speed limit parameters for the individual
  6634. # buckets (class 2, 3).
  6635. #
  6636. # network the speed limit parameters for the network buckets
  6637. # (class 3).
  6638. #
  6639. # user the speed limit parameters for the user buckets
  6640. # (class 4).
  6641. #
  6642. # tagrate the speed limit parameters for the tag buckets
  6643. # (class 5).
  6644. #
  6645. # A pair of delay parameters is written restore/maximum, where restore is
  6646. # the number of bytes (not bits - modem and network speeds are usually
  6647. # quoted in bits) per second placed into the bucket, and maximum is the
  6648. # maximum number of bytes which can be in the bucket at any time.
  6649. #
  6650. # There must be one delay_parameters line for each delay pool.
  6651. #
  6652. #
  6653. # For example, if delay pool number 1 is a class 2 delay pool as in the
  6654. # above example, and is being used to strictly limit each host to 64Kbit/sec
  6655. # (plus overheads), with no overall limit, the line is:
  6656. #
  6657. # delay_parameters 1 none 8000/8000
  6658. #
  6659. # Note that 8 x 8K Byte/sec -> 64K bit/sec.
  6660. #
  6661. # Note that the word 'none' is used to represent no limit.
  6662. #
  6663. #
  6664. # And, if delay pool number 2 is a class 3 delay pool as in the above
  6665. # example, and you want to limit it to a total of 256Kbit/sec (strict limit)
  6666. # with each 8-bit network permitted 64Kbit/sec (strict limit) and each
  6667. # individual host permitted 4800bit/sec with a bucket maximum size of 64Kbits
  6668. # to permit a decent web page to be downloaded at a decent speed
  6669. # (if the network is not being limited due to overuse) but slow down
  6670. # large downloads more significantly:
  6671. #
  6672. # delay_parameters 2 32000/32000 8000/8000 600/8000
  6673. #
  6674. # Note that 8 x 32K Byte/sec -> 256K bit/sec.
  6675. # 8 x 8K Byte/sec -> 64K bit/sec.
  6676. # 8 x 600 Byte/sec -> 4800 bit/sec.
  6677. #
  6678. #
  6679. # Finally, for a class 4 delay pool as in the example - each user will
  6680. # be limited to 128Kbits/sec no matter how many workstations they are logged into.:
  6681. #
  6682. # delay_parameters 4 32000/32000 8000/8000 600/64000 16000/16000
  6683. #
  6684. #
  6685. # See also delay_class and delay_access.
  6686. #
  6687. #Default:
  6688. # none
  6689.  
  6690. # TAG: delay_initial_bucket_level (percent, 0-100)
  6691. # The initial bucket percentage is used to determine how much is put
  6692. # in each bucket when squid starts, is reconfigured, or first notices
  6693. # a host accessing it (in class 2 and class 3, individual hosts and
  6694. # networks only have buckets associated with them once they have been
  6695. # "seen" by squid).
  6696. #Default:
  6697. # delay_initial_bucket_level 50
  6698.  
  6699. # CLIENT DELAY POOL PARAMETERS
  6700. # -----------------------------------------------------------------------------
  6701.  
  6702. # TAG: client_delay_pools
  6703. # This option specifies the number of client delay pools used. It must
  6704. # preceed other client_delay_* options.
  6705. #
  6706. # Example:
  6707. # client_delay_pools 2
  6708. #
  6709. # See also client_delay_parameters and client_delay_access.
  6710. #Default:
  6711. # client_delay_pools 0
  6712.  
  6713. # TAG: client_delay_initial_bucket_level (percent, 0-no_limit)
  6714. # This option determines the initial bucket size as a percentage of
  6715. # max_bucket_size from client_delay_parameters. Buckets are created
  6716. # at the time of the "first" connection from the matching IP. Idle
  6717. # buckets are periodically deleted up.
  6718. #
  6719. # You can specify more than 100 percent but note that such "oversized"
  6720. # buckets are not refilled until their size goes down to max_bucket_size
  6721. # from client_delay_parameters.
  6722. #
  6723. # Example:
  6724. # client_delay_initial_bucket_level 50
  6725. #Default:
  6726. # client_delay_initial_bucket_level 50
  6727.  
  6728. # TAG: client_delay_parameters
  6729. #
  6730. # This option configures client-side bandwidth limits using the
  6731. # following format:
  6732. #
  6733. # client_delay_parameters pool speed_limit max_bucket_size
  6734. #
  6735. # pool is an integer ID used for client_delay_access matching.
  6736. #
  6737. # speed_limit is bytes added to the bucket per second.
  6738. #
  6739. # max_bucket_size is the maximum size of a bucket, enforced after any
  6740. # speed_limit additions.
  6741. #
  6742. # Please see the delay_parameters option for more information and
  6743. # examples.
  6744. #
  6745. # Example:
  6746. # client_delay_parameters 1 1024 2048
  6747. # client_delay_parameters 2 51200 16384
  6748. #
  6749. # See also client_delay_access.
  6750. #
  6751. #Default:
  6752. # none
  6753.  
  6754. # TAG: client_delay_access
  6755. # This option determines the client-side delay pool for the
  6756. # request:
  6757. #
  6758. # client_delay_access pool_ID allow|deny acl_name
  6759. #
  6760. # All client_delay_access options are checked in their pool ID
  6761. # order, starting with pool 1. The first checked pool with allowed
  6762. # request is selected for the request. If no ACL matches or there
  6763. # are no client_delay_access options, the request bandwidth is not
  6764. # limited.
  6765. #
  6766. # The ACL-selected pool is then used to find the
  6767. # client_delay_parameters for the request. Client-side pools are
  6768. # not used to aggregate clients. Clients are always aggregated
  6769. # based on their source IP addresses (one bucket per source IP).
  6770. #
  6771. # This clause only supports fast acl types.
  6772. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  6773. # Additionally, only the client TCP connection details are available.
  6774. # ACLs testing HTTP properties will not work.
  6775. #
  6776. # Please see delay_access for more examples.
  6777. #
  6778. # Example:
  6779. # client_delay_access 1 allow low_rate_network
  6780. # client_delay_access 2 allow vips_network
  6781. #
  6782. #
  6783. # See also client_delay_parameters and client_delay_pools.
  6784. #Default:
  6785. # Deny use of the pool, unless allow rules exist in squid.conf for the pool.
  6786.  
  6787. # TAG: response_delay_pool
  6788. # This option configures client response bandwidth limits using the
  6789. # following format:
  6790. #
  6791. # response_delay_pool name [option=value] ...
  6792. #
  6793. # name the response delay pool name
  6794. #
  6795. # available options:
  6796. #
  6797. # individual-restore The speed limit of an individual
  6798. # bucket(bytes/s). To be used in conjunction
  6799. # with 'individual-maximum'.
  6800. #
  6801. # individual-maximum The maximum number of bytes which can
  6802. # be placed into the individual bucket. To be used
  6803. # in conjunction with 'individual-restore'.
  6804. #
  6805. # aggregate-restore The speed limit for the aggregate
  6806. # bucket(bytes/s). To be used in conjunction with
  6807. # 'aggregate-maximum'.
  6808. #
  6809. # aggregate-maximum The maximum number of bytes which can
  6810. # be placed into the aggregate bucket. To be used
  6811. # in conjunction with 'aggregate-restore'.
  6812. #
  6813. # initial-bucket-level The initial bucket size as a percentage
  6814. # of individual-maximum.
  6815. #
  6816. # Individual and(or) aggregate bucket options may not be specified,
  6817. # meaning no individual and(or) aggregate speed limitation.
  6818. # See also response_delay_pool_access and delay_parameters for
  6819. # terminology details.
  6820. #Default:
  6821. # none
  6822.  
  6823. # TAG: response_delay_pool_access
  6824. # Determines whether a specific named response delay pool is used
  6825. # for the transaction. The syntax for this directive is:
  6826. #
  6827. # response_delay_pool_access pool_name allow|deny acl_name
  6828. #
  6829. # All response_delay_pool_access options are checked in the order
  6830. # they appear in this configuration file. The first rule with a
  6831. # matching ACL wins. If (and only if) an "allow" rule won, Squid
  6832. # assigns the response to the corresponding named delay pool.
  6833. #Default:
  6834. # Deny use of the pool, unless allow rules exist in squid.conf for the pool.
  6835.  
  6836. # WCCPv1 AND WCCPv2 CONFIGURATION OPTIONS
  6837. # -----------------------------------------------------------------------------
  6838.  
  6839. # TAG: wccp_router
  6840. # Use this option to define your WCCP ``home'' router for
  6841. # Squid.
  6842. #
  6843. # wccp_router supports a single WCCP(v1) router
  6844. #
  6845. # wccp2_router supports multiple WCCPv2 routers
  6846. #
  6847. # only one of the two may be used at the same time and defines
  6848. # which version of WCCP to use.
  6849. #Default:
  6850. # WCCP disabled.
  6851.  
  6852. # TAG: wccp2_router
  6853. # Use this option to define your WCCP ``home'' router for
  6854. # Squid.
  6855. #
  6856. # wccp_router supports a single WCCP(v1) router
  6857. #
  6858. # wccp2_router supports multiple WCCPv2 routers
  6859. #
  6860. # only one of the two may be used at the same time and defines
  6861. # which version of WCCP to use.
  6862. #Default:
  6863. # WCCPv2 disabled.
  6864.  
  6865. # TAG: wccp_version
  6866. # This directive is only relevant if you need to set up WCCP(v1)
  6867. # to some very old and end-of-life Cisco routers. In all other
  6868. # setups it must be left unset or at the default setting.
  6869. # It defines an internal version in the WCCP(v1) protocol,
  6870. # with version 4 being the officially documented protocol.
  6871. #
  6872. # According to some users, Cisco IOS 11.2 and earlier only
  6873. # support WCCP version 3. If you're using that or an earlier
  6874. # version of IOS, you may need to change this value to 3, otherwise
  6875. # do not specify this parameter.
  6876. #Default:
  6877. # wccp_version 4
  6878.  
  6879. # TAG: wccp2_rebuild_wait
  6880. # If this is enabled Squid will wait for the cache dir rebuild to finish
  6881. # before sending the first wccp2 HereIAm packet
  6882. #Default:
  6883. # wccp2_rebuild_wait on
  6884.  
  6885. # TAG: wccp2_forwarding_method
  6886. # WCCP2 allows the setting of forwarding methods between the
  6887. # router/switch and the cache. Valid values are as follows:
  6888. #
  6889. # gre - GRE encapsulation (forward the packet in a GRE/WCCP tunnel)
  6890. # l2 - L2 redirect (forward the packet using Layer 2/MAC rewriting)
  6891. #
  6892. # Currently (as of IOS 12.4) cisco routers only support GRE.
  6893. # Cisco switches only support the L2 redirect assignment method.
  6894. #Default:
  6895. # wccp2_forwarding_method gre
  6896.  
  6897. # TAG: wccp2_return_method
  6898. # WCCP2 allows the setting of return methods between the
  6899. # router/switch and the cache for packets that the cache
  6900. # decides not to handle. Valid values are as follows:
  6901. #
  6902. # gre - GRE encapsulation (forward the packet in a GRE/WCCP tunnel)
  6903. # l2 - L2 redirect (forward the packet using Layer 2/MAC rewriting)
  6904. #
  6905. # Currently (as of IOS 12.4) cisco routers only support GRE.
  6906. # Cisco switches only support the L2 redirect assignment.
  6907. #
  6908. # If the "ip wccp redirect exclude in" command has been
  6909. # enabled on the cache interface, then it is still safe for
  6910. # the proxy server to use a l2 redirect method even if this
  6911. # option is set to GRE.
  6912. #Default:
  6913. # wccp2_return_method gre
  6914.  
  6915. # TAG: wccp2_assignment_method
  6916. # WCCP2 allows the setting of methods to assign the WCCP hash
  6917. # Valid values are as follows:
  6918. #
  6919. # hash - Hash assignment
  6920. # mask - Mask assignment
  6921. #
  6922. # As a general rule, cisco routers support the hash assignment method
  6923. # and cisco switches support the mask assignment method.
  6924. #Default:
  6925. # wccp2_assignment_method hash
  6926.  
  6927. # TAG: wccp2_service
  6928. # WCCP2 allows for multiple traffic services. There are two
  6929. # types: "standard" and "dynamic". The standard type defines
  6930. # one service id - http (id 0). The dynamic service ids can be from
  6931. # 51 to 255 inclusive. In order to use a dynamic service id
  6932. # one must define the type of traffic to be redirected; this is done
  6933. # using the wccp2_service_info option.
  6934. #
  6935. # The "standard" type does not require a wccp2_service_info option,
  6936. # just specifying the service id will suffice.
  6937. #
  6938. # MD5 service authentication can be enabled by adding
  6939. # "password=<password>" to the end of this service declaration.
  6940. #
  6941. # Examples:
  6942. #
  6943. # wccp2_service standard 0 # for the 'web-cache' standard service
  6944. # wccp2_service dynamic 80 # a dynamic service type which will be
  6945. # # fleshed out with subsequent options.
  6946. # wccp2_service standard 0 password=foo
  6947. #Default:
  6948. # Use the 'web-cache' standard service.
  6949.  
  6950. # TAG: wccp2_service_info
  6951. # Dynamic WCCPv2 services require further information to define the
  6952. # traffic you wish to have diverted.
  6953. #
  6954. # The format is:
  6955. #
  6956. # wccp2_service_info <id> protocol=<protocol> flags=<flag>,<flag>..
  6957. # priority=<priority> ports=<port>,<port>..
  6958. #
  6959. # The relevant WCCPv2 flags:
  6960. # + src_ip_hash, dst_ip_hash
  6961. # + source_port_hash, dst_port_hash
  6962. # + src_ip_alt_hash, dst_ip_alt_hash
  6963. # + src_port_alt_hash, dst_port_alt_hash
  6964. # + ports_source
  6965. #
  6966. # The port list can be one to eight entries.
  6967. #
  6968. # Example:
  6969. #
  6970. # wccp2_service_info 80 protocol=tcp flags=src_ip_hash,ports_source
  6971. # priority=240 ports=80
  6972. #
  6973. # Note: the service id must have been defined by a previous
  6974. # 'wccp2_service dynamic <id>' entry.
  6975. #Default:
  6976. # none
  6977.  
  6978. # TAG: wccp2_weight
  6979. # Each cache server gets assigned a set of the destination
  6980. # hash proportional to their weight.
  6981. #Default:
  6982. # wccp2_weight 10000
  6983.  
  6984. # TAG: wccp_address
  6985. # Use this option if you require WCCP(v1) to use a specific
  6986. # interface address.
  6987. #
  6988. # The default behavior is to not bind to any specific address.
  6989. #Default:
  6990. # Address selected by the operating system.
  6991.  
  6992. # TAG: wccp2_address
  6993. # Use this option if you require WCCPv2 to use a specific
  6994. # interface address.
  6995. #
  6996. # The default behavior is to not bind to any specific address.
  6997. #Default:
  6998. # Address selected by the operating system.
  6999.  
  7000. # PERSISTENT CONNECTION HANDLING
  7001. # -----------------------------------------------------------------------------
  7002. #
  7003. # Also see "pconn_timeout" in the TIMEOUTS section
  7004.  
  7005. # TAG: client_persistent_connections
  7006. # Persistent connection support for clients.
  7007. # Squid uses persistent connections (when allowed). You can use
  7008. # this option to disable persistent connections with clients.
  7009. #Default:
  7010. # client_persistent_connections on
  7011.  
  7012. # TAG: server_persistent_connections
  7013. # Persistent connection support for servers.
  7014. # Squid uses persistent connections (when allowed). You can use
  7015. # this option to disable persistent connections with servers.
  7016. #Default:
  7017. # server_persistent_connections on
  7018.  
  7019. # TAG: persistent_connection_after_error
  7020. # With this directive the use of persistent connections after
  7021. # HTTP errors can be disabled. Useful if you have clients
  7022. # who fail to handle errors on persistent connections proper.
  7023. #Default:
  7024. # persistent_connection_after_error on
  7025.  
  7026. # TAG: detect_broken_pconn
  7027. # Some servers have been found to incorrectly signal the use
  7028. # of HTTP/1.0 persistent connections even on replies not
  7029. # compatible, causing significant delays. This server problem
  7030. # has mostly been seen on redirects.
  7031. #
  7032. # By enabling this directive Squid attempts to detect such
  7033. # broken replies and automatically assume the reply is finished
  7034. # after 10 seconds timeout.
  7035. #Default:
  7036. # detect_broken_pconn off
  7037.  
  7038. # CACHE DIGEST OPTIONS
  7039. # -----------------------------------------------------------------------------
  7040.  
  7041. # TAG: digest_generation
  7042. # This controls whether the server will generate a Cache Digest
  7043. # of its contents. By default, Cache Digest generation is
  7044. # enabled if Squid is compiled with --enable-cache-digests defined.
  7045. #Default:
  7046. # digest_generation on
  7047.  
  7048. # TAG: digest_bits_per_entry
  7049. # This is the number of bits of the server's Cache Digest which
  7050. # will be associated with the Digest entry for a given HTTP
  7051. # Method and URL (public key) combination. The default is 5.
  7052. #Default:
  7053. # digest_bits_per_entry 5
  7054.  
  7055. # TAG: digest_rebuild_period (seconds)
  7056. # This is the wait time between Cache Digest rebuilds.
  7057. #Default:
  7058. # digest_rebuild_period 1 hour
  7059.  
  7060. # TAG: digest_rewrite_period (seconds)
  7061. # This is the wait time between Cache Digest writes to
  7062. # disk.
  7063. #Default:
  7064. # digest_rewrite_period 1 hour
  7065.  
  7066. # TAG: digest_swapout_chunk_size (bytes)
  7067. # This is the number of bytes of the Cache Digest to write to
  7068. # disk at a time. It defaults to 4096 bytes (4KB), the Squid
  7069. # default swap page.
  7070. #Default:
  7071. # digest_swapout_chunk_size 4096 bytes
  7072.  
  7073. # TAG: digest_rebuild_chunk_percentage (percent, 0-100)
  7074. # This is the percentage of the Cache Digest to be scanned at a
  7075. # time. By default it is set to 10% of the Cache Digest.
  7076. #Default:
  7077. # digest_rebuild_chunk_percentage 10
  7078.  
  7079. # SNMP OPTIONS
  7080. # -----------------------------------------------------------------------------
  7081.  
  7082. # TAG: snmp_port
  7083. # The port number where Squid listens for SNMP requests. To enable
  7084. # SNMP support set this to a suitable port number. Port number
  7085. # 3401 is often used for the Squid SNMP agent. By default it's
  7086. # set to "0" (disabled)
  7087. #
  7088. # Example:
  7089. # snmp_port 3401
  7090. #Default:
  7091. # SNMP disabled.
  7092.  
  7093. # TAG: snmp_access
  7094. # Allowing or denying access to the SNMP port.
  7095. #
  7096. # All access to the agent is denied by default.
  7097. # usage:
  7098. #
  7099. # snmp_access allow|deny [!]aclname ...
  7100. #
  7101. # This clause only supports fast acl types.
  7102. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  7103. #
  7104. #Example:
  7105. # snmp_access allow snmppublic localhost
  7106. # snmp_access deny all
  7107. #Default:
  7108. # Deny, unless rules exist in squid.conf.
  7109.  
  7110. # TAG: snmp_incoming_address
  7111. # Just like 'udp_incoming_address', but for the SNMP port.
  7112. #
  7113. # snmp_incoming_address is used for the SNMP socket receiving
  7114. # messages from SNMP agents.
  7115. #
  7116. # The default snmp_incoming_address is to listen on all
  7117. # available network interfaces.
  7118. #Default:
  7119. # Accept SNMP packets from all machine interfaces.
  7120.  
  7121. # TAG: snmp_outgoing_address
  7122. # Just like 'udp_outgoing_address', but for the SNMP port.
  7123. #
  7124. # snmp_outgoing_address is used for SNMP packets returned to SNMP
  7125. # agents.
  7126. #
  7127. # If snmp_outgoing_address is not set it will use the same socket
  7128. # as snmp_incoming_address. Only change this if you want to have
  7129. # SNMP replies sent using another address than where this Squid
  7130. # listens for SNMP queries.
  7131. #
  7132. # NOTE, snmp_incoming_address and snmp_outgoing_address can not have
  7133. # the same value since they both use the same port.
  7134. #Default:
  7135. # Use snmp_incoming_address or an address selected by the operating system.
  7136.  
  7137. # ICP OPTIONS
  7138. # -----------------------------------------------------------------------------
  7139.  
  7140. # TAG: icp_port
  7141. # The port number where Squid sends and receives ICP queries to
  7142. # and from neighbor caches. The standard UDP port for ICP is 3130.
  7143. #
  7144. # Example:
  7145. # icp_port 3130
  7146. #Default:
  7147. # ICP disabled.
  7148.  
  7149. # TAG: htcp_port
  7150. # The port number where Squid sends and receives HTCP queries to
  7151. # and from neighbor caches. To turn it on you want to set it to
  7152. # 4827.
  7153. #
  7154. # Example:
  7155. # htcp_port 4827
  7156. #Default:
  7157. # HTCP disabled.
  7158.  
  7159. # TAG: log_icp_queries on|off
  7160. # If set, ICP queries are logged to access.log. You may wish
  7161. # do disable this if your ICP load is VERY high to speed things
  7162. # up or to simplify log analysis.
  7163. #Default:
  7164. # log_icp_queries on
  7165.  
  7166. # TAG: udp_incoming_address
  7167. # udp_incoming_address is used for UDP packets received from other
  7168. # caches.
  7169. #
  7170. # The default behavior is to not bind to any specific address.
  7171. #
  7172. # Only change this if you want to have all UDP queries received on
  7173. # a specific interface/address.
  7174. #
  7175. # NOTE: udp_incoming_address is used by the ICP, HTCP, and DNS
  7176. # modules. Altering it will affect all of them in the same manner.
  7177. #
  7178. # see also; udp_outgoing_address
  7179. #
  7180. # NOTE, udp_incoming_address and udp_outgoing_address can not
  7181. # have the same value since they both use the same port.
  7182. #Default:
  7183. # Accept packets from all machine interfaces.
  7184.  
  7185. # TAG: udp_outgoing_address
  7186. # udp_outgoing_address is used for UDP packets sent out to other
  7187. # caches.
  7188. #
  7189. # The default behavior is to not bind to any specific address.
  7190. #
  7191. # Instead it will use the same socket as udp_incoming_address.
  7192. # Only change this if you want to have UDP queries sent using another
  7193. # address than where this Squid listens for UDP queries from other
  7194. # caches.
  7195. #
  7196. # NOTE: udp_outgoing_address is used by the ICP, HTCP, and DNS
  7197. # modules. Altering it will affect all of them in the same manner.
  7198. #
  7199. # see also; udp_incoming_address
  7200. #
  7201. # NOTE, udp_incoming_address and udp_outgoing_address can not
  7202. # have the same value since they both use the same port.
  7203. #Default:
  7204. # Use udp_incoming_address or an address selected by the operating system.
  7205.  
  7206. # TAG: icp_hit_stale on|off
  7207. # If you want to return ICP_HIT for stale cache objects, set this
  7208. # option to 'on'. If you have sibling relationships with caches
  7209. # in other administrative domains, this should be 'off'. If you only
  7210. # have sibling relationships with caches under your control,
  7211. # it is probably okay to set this to 'on'.
  7212. # If set to 'on', your siblings should use the option "allow-miss"
  7213. # on their cache_peer lines for connecting to you.
  7214. #Default:
  7215. # icp_hit_stale off
  7216.  
  7217. # TAG: minimum_direct_hops
  7218. # If using the ICMP pinging stuff, do direct fetches for sites
  7219. # which are no more than this many hops away.
  7220. #Default:
  7221. # minimum_direct_hops 4
  7222.  
  7223. # TAG: minimum_direct_rtt (msec)
  7224. # If using the ICMP pinging stuff, do direct fetches for sites
  7225. # which are no more than this many rtt milliseconds away.
  7226. #Default:
  7227. # minimum_direct_rtt 400
  7228.  
  7229. # TAG: netdb_low
  7230. # The low water mark for the ICMP measurement database.
  7231. #
  7232. # Note: high watermark controlled by netdb_high directive.
  7233. #
  7234. # These watermarks are counts, not percents. The defaults are
  7235. # (low) 900 and (high) 1000. When the high water mark is
  7236. # reached, database entries will be deleted until the low
  7237. # mark is reached.
  7238. #Default:
  7239. # netdb_low 900
  7240.  
  7241. # TAG: netdb_high
  7242. # The high water mark for the ICMP measurement database.
  7243. #
  7244. # Note: low watermark controlled by netdb_low directive.
  7245. #
  7246. # These watermarks are counts, not percents. The defaults are
  7247. # (low) 900 and (high) 1000. When the high water mark is
  7248. # reached, database entries will be deleted until the low
  7249. # mark is reached.
  7250. #Default:
  7251. # netdb_high 1000
  7252.  
  7253. # TAG: netdb_ping_period
  7254. # The minimum period for measuring a site. There will be at
  7255. # least this much delay between successive pings to the same
  7256. # network. The default is five minutes.
  7257. #Default:
  7258. # netdb_ping_period 5 minutes
  7259.  
  7260. # TAG: query_icmp on|off
  7261. # If you want to ask your peers to include ICMP data in their ICP
  7262. # replies, enable this option.
  7263. #
  7264. # If your peer has configured Squid (during compilation) with
  7265. # '--enable-icmp' that peer will send ICMP pings to origin server
  7266. # sites of the URLs it receives. If you enable this option the
  7267. # ICP replies from that peer will include the ICMP data (if available).
  7268. # Then, when choosing a parent cache, Squid will choose the parent with
  7269. # the minimal RTT to the origin server. When this happens, the
  7270. # hierarchy field of the access.log will be
  7271. # "CLOSEST_PARENT_MISS". This option is off by default.
  7272. #Default:
  7273. # query_icmp off
  7274.  
  7275. # TAG: test_reachability on|off
  7276. # When this is 'on', ICP MISS replies will be ICP_MISS_NOFETCH
  7277. # instead of ICP_MISS if the target host is NOT in the ICMP
  7278. # database, or has a zero RTT.
  7279. #Default:
  7280. # test_reachability off
  7281.  
  7282. # TAG: icp_query_timeout (msec)
  7283. # Normally Squid will automatically determine an optimal ICP
  7284. # query timeout value based on the round-trip-time of recent ICP
  7285. # queries. If you want to override the value determined by
  7286. # Squid, set this 'icp_query_timeout' to a non-zero value. This
  7287. # value is specified in MILLISECONDS, so, to use a 2-second
  7288. # timeout (the old default), you would write:
  7289. #
  7290. # icp_query_timeout 2000
  7291. #Default:
  7292. # Dynamic detection.
  7293.  
  7294. # TAG: maximum_icp_query_timeout (msec)
  7295. # Normally the ICP query timeout is determined dynamically. But
  7296. # sometimes it can lead to very large values (say 5 seconds).
  7297. # Use this option to put an upper limit on the dynamic timeout
  7298. # value. Do NOT use this option to always use a fixed (instead
  7299. # of a dynamic) timeout value. To set a fixed timeout see the
  7300. # 'icp_query_timeout' directive.
  7301. #Default:
  7302. # maximum_icp_query_timeout 2000
  7303.  
  7304. # TAG: minimum_icp_query_timeout (msec)
  7305. # Normally the ICP query timeout is determined dynamically. But
  7306. # sometimes it can lead to very small timeouts, even lower than
  7307. # the normal latency variance on your link due to traffic.
  7308. # Use this option to put an lower limit on the dynamic timeout
  7309. # value. Do NOT use this option to always use a fixed (instead
  7310. # of a dynamic) timeout value. To set a fixed timeout see the
  7311. # 'icp_query_timeout' directive.
  7312. #Default:
  7313. # minimum_icp_query_timeout 5
  7314.  
  7315. # TAG: background_ping_rate time-units
  7316. # Controls how often the ICP pings are sent to siblings that
  7317. # have background-ping set.
  7318. #Default:
  7319. # background_ping_rate 10 seconds
  7320.  
  7321. # MULTICAST ICP OPTIONS
  7322. # -----------------------------------------------------------------------------
  7323.  
  7324. # TAG: mcast_groups
  7325. # This tag specifies a list of multicast groups which your server
  7326. # should join to receive multicasted ICP queries.
  7327. #
  7328. # NOTE! Be very careful what you put here! Be sure you
  7329. # understand the difference between an ICP _query_ and an ICP
  7330. # _reply_. This option is to be set only if you want to RECEIVE
  7331. # multicast queries. Do NOT set this option to SEND multicast
  7332. # ICP (use cache_peer for that). ICP replies are always sent via
  7333. # unicast, so this option does not affect whether or not you will
  7334. # receive replies from multicast group members.
  7335. #
  7336. # You must be very careful to NOT use a multicast address which
  7337. # is already in use by another group of caches.
  7338. #
  7339. # If you are unsure about multicast, please read the Multicast
  7340. # chapter in the Squid FAQ (http://www.squid-cache.org/FAQ/).
  7341. #
  7342. # Usage: mcast_groups 239.128.16.128 224.0.1.20
  7343. #
  7344. # By default, Squid doesn't listen on any multicast groups.
  7345. #Default:
  7346. # none
  7347.  
  7348. # TAG: mcast_miss_addr
  7349. # Note: This option is only available if Squid is rebuilt with the
  7350. # -DMULTICAST_MISS_STREAM define
  7351. #
  7352. # If you enable this option, every "cache miss" URL will
  7353. # be sent out on the specified multicast address.
  7354. #
  7355. # Do not enable this option unless you are are absolutely
  7356. # certain you understand what you are doing.
  7357. #Default:
  7358. # disabled.
  7359.  
  7360. # TAG: mcast_miss_ttl
  7361. # Note: This option is only available if Squid is rebuilt with the
  7362. # -DMULTICAST_MISS_STREAM define
  7363. #
  7364. # This is the time-to-live value for packets multicasted
  7365. # when multicasting off cache miss URLs is enabled. By
  7366. # default this is set to 'site scope', i.e. 16.
  7367. #Default:
  7368. # mcast_miss_ttl 16
  7369.  
  7370. # TAG: mcast_miss_port
  7371. # Note: This option is only available if Squid is rebuilt with the
  7372. # -DMULTICAST_MISS_STREAM define
  7373. #
  7374. # This is the port number to be used in conjunction with
  7375. # 'mcast_miss_addr'.
  7376. #Default:
  7377. # mcast_miss_port 3135
  7378.  
  7379. # TAG: mcast_miss_encode_key
  7380. # Note: This option is only available if Squid is rebuilt with the
  7381. # -DMULTICAST_MISS_STREAM define
  7382. #
  7383. # The URLs that are sent in the multicast miss stream are
  7384. # encrypted. This is the encryption key.
  7385. #Default:
  7386. # mcast_miss_encode_key XXXXXXXXXXXXXXXX
  7387.  
  7388. # TAG: mcast_icp_query_timeout (msec)
  7389. # For multicast peers, Squid regularly sends out ICP "probes" to
  7390. # count how many other peers are listening on the given multicast
  7391. # address. This value specifies how long Squid should wait to
  7392. # count all the replies. The default is 2000 msec, or 2
  7393. # seconds.
  7394. #Default:
  7395. # mcast_icp_query_timeout 2000
  7396.  
  7397. # INTERNAL ICON OPTIONS
  7398. # -----------------------------------------------------------------------------
  7399.  
  7400. # TAG: icon_directory
  7401. # Where the icons are stored. These are normally kept in
  7402. # /usr/share/squid/icons
  7403. #Default:
  7404. # icon_directory /usr/share/squid/icons
  7405.  
  7406. # TAG: global_internal_static
  7407. # This directive controls is Squid should intercept all requests for
  7408. # /squid-internal-static/ no matter which host the URL is requesting
  7409. # (default on setting), or if nothing special should be done for
  7410. # such URLs (off setting). The purpose of this directive is to make
  7411. # icons etc work better in complex cache hierarchies where it may
  7412. # not always be possible for all corners in the cache mesh to reach
  7413. # the server generating a directory listing.
  7414. #Default:
  7415. # global_internal_static on
  7416.  
  7417. # TAG: short_icon_urls
  7418. # If this is enabled Squid will use short URLs for icons.
  7419. # If disabled it will revert to the old behavior of including
  7420. # it's own name and port in the URL.
  7421. #
  7422. # If you run a complex cache hierarchy with a mix of Squid and
  7423. # other proxies you may need to disable this directive.
  7424. #Default:
  7425. # short_icon_urls on
  7426.  
  7427. # ERROR PAGE OPTIONS
  7428. # -----------------------------------------------------------------------------
  7429.  
  7430. # TAG: error_directory
  7431. # If you wish to create your own versions of the default
  7432. # error files to customize them to suit your company copy
  7433. # the error/template files to another directory and point
  7434. # this tag at them.
  7435. #
  7436. # WARNING: This option will disable multi-language support
  7437. # on error pages if used.
  7438. #
  7439. # The squid developers are interested in making squid available in
  7440. # a wide variety of languages. If you are making translations for a
  7441. # language that Squid does not currently provide please consider
  7442. # contributing your translation back to the project.
  7443. # http://wiki.squid-cache.org/Translations
  7444. #
  7445. # The squid developers working on translations are happy to supply drop-in
  7446. # translated error files in exchange for any new language contributions.
  7447. #Default:
  7448. # Send error pages in the clients preferred language
  7449.  
  7450. # TAG: error_default_language
  7451. # Set the default language which squid will send error pages in
  7452. # if no existing translation matches the clients language
  7453. # preferences.
  7454. #
  7455. # If unset (default) generic English will be used.
  7456. #
  7457. # The squid developers are interested in making squid available in
  7458. # a wide variety of languages. If you are interested in making
  7459. # translations for any language see the squid wiki for details.
  7460. # http://wiki.squid-cache.org/Translations
  7461. #Default:
  7462. # Generate English language pages.
  7463.  
  7464. # TAG: error_log_languages
  7465. # Log to cache.log what languages users are attempting to
  7466. # auto-negotiate for translations.
  7467. #
  7468. # Successful negotiations are not logged. Only failures
  7469. # have meaning to indicate that Squid may need an upgrade
  7470. # of its error page translations.
  7471. #Default:
  7472. # error_log_languages on
  7473.  
  7474. # TAG: err_page_stylesheet
  7475. # CSS Stylesheet to pattern the display of Squid default error pages.
  7476. #
  7477. # For information on CSS see http://www.w3.org/Style/CSS/
  7478. #Default:
  7479. # err_page_stylesheet /etc/squid/errorpage.css
  7480.  
  7481. # TAG: err_html_text
  7482. # HTML text to include in error messages. Make this a "mailto"
  7483. # URL to your admin address, or maybe just a link to your
  7484. # organizations Web page.
  7485. #
  7486. # To include this in your error messages, you must rewrite
  7487. # the error template files (found in the "errors" directory).
  7488. # Wherever you want the 'err_html_text' line to appear,
  7489. # insert a %L tag in the error template file.
  7490. #Default:
  7491. # none
  7492.  
  7493. # TAG: email_err_data on|off
  7494. # If enabled, information about the occurred error will be
  7495. # included in the mailto links of the ERR pages (if %W is set)
  7496. # so that the email body contains the data.
  7497. # Syntax is <A HREF="mailto:%w%W">%w</A>
  7498. #Default:
  7499. # email_err_data on
  7500.  
  7501. # TAG: deny_info
  7502. # Usage: deny_info err_page_name acl
  7503. # or deny_info http://... acl
  7504. # or deny_info TCP_RESET acl
  7505. #
  7506. # This can be used to return a ERR_ page for requests which
  7507. # do not pass the 'http_access' rules. Squid remembers the last
  7508. # acl it evaluated in http_access, and if a 'deny_info' line exists
  7509. # for that ACL Squid returns a corresponding error page.
  7510. #
  7511. # The acl is typically the last acl on the http_access deny line which
  7512. # denied access. The exceptions to this rule are:
  7513. # - When Squid needs to request authentication credentials. It's then
  7514. # the first authentication related acl encountered
  7515. # - When none of the http_access lines matches. It's then the last
  7516. # acl processed on the last http_access line.
  7517. # - When the decision to deny access was made by an adaptation service,
  7518. # the acl name is the corresponding eCAP or ICAP service_name.
  7519. #
  7520. # NP: If providing your own custom error pages with error_directory
  7521. # you may also specify them by your custom file name:
  7522. # Example: deny_info ERR_CUSTOM_ACCESS_DENIED bad_guys
  7523. #
  7524. # By defaut Squid will send "403 Forbidden". A different 4xx or 5xx
  7525. # may be specified by prefixing the file name with the code and a colon.
  7526. # e.g. 404:ERR_CUSTOM_ACCESS_DENIED
  7527. #
  7528. # Alternatively you can tell Squid to reset the TCP connection
  7529. # by specifying TCP_RESET.
  7530. #
  7531. # Or you can specify an error URL or URL pattern. The browsers will
  7532. # get redirected to the specified URL after formatting tags have
  7533. # been replaced. Redirect will be done with 302 or 307 according to
  7534. # HTTP/1.1 specs. A different 3xx code may be specified by prefixing
  7535. # the URL. e.g. 303:http://example.com/
  7536. #
  7537. # URL FORMAT TAGS:
  7538. # %a - username (if available. Password NOT included)
  7539. # %A - Local listening IP address the client connection was connected to
  7540. # %B - FTP path URL
  7541. # %e - Error number
  7542. # %E - Error description
  7543. # %h - Squid hostname
  7544. # %H - Request domain name
  7545. # %i - Client IP Address
  7546. # %M - Request Method
  7547. # %O - Unescaped message result from external ACL helper
  7548. # %o - Message result from external ACL helper
  7549. # %p - Request Port number
  7550. # %P - Request Protocol name
  7551. # %R - Request URL path
  7552. # %T - Timestamp in RFC 1123 format
  7553. # %U - Full canonical URL from client
  7554. # (HTTPS URLs terminate with *)
  7555. # %u - Full canonical URL from client
  7556. # %w - Admin email from squid.conf
  7557. # %x - Error name
  7558. # %% - Literal percent (%) code
  7559. #
  7560. #Default:
  7561. # none
  7562.  
  7563. # OPTIONS INFLUENCING REQUEST FORWARDING
  7564. # -----------------------------------------------------------------------------
  7565.  
  7566. # TAG: nonhierarchical_direct
  7567. # By default, Squid will send any non-hierarchical requests
  7568. # (not cacheable request type) direct to origin servers.
  7569. #
  7570. # When this is set to "off", Squid will prefer to send these
  7571. # requests to parents.
  7572. #
  7573. # Note that in most configurations, by turning this off you will only
  7574. # add latency to these request without any improvement in global hit
  7575. # ratio.
  7576. #
  7577. # This option only sets a preference. If the parent is unavailable a
  7578. # direct connection to the origin server may still be attempted. To
  7579. # completely prevent direct connections use never_direct.
  7580. #Default:
  7581. # nonhierarchical_direct on
  7582.  
  7583. # TAG: prefer_direct
  7584. # Normally Squid tries to use parents for most requests. If you for some
  7585. # reason like it to first try going direct and only use a parent if
  7586. # going direct fails set this to on.
  7587. #
  7588. # By combining nonhierarchical_direct off and prefer_direct on you
  7589. # can set up Squid to use a parent as a backup path if going direct
  7590. # fails.
  7591. #
  7592. # Note: If you want Squid to use parents for all requests see
  7593. # the never_direct directive. prefer_direct only modifies how Squid
  7594. # acts on cacheable requests.
  7595. #Default:
  7596. # prefer_direct off
  7597.  
  7598. # TAG: cache_miss_revalidate on|off
  7599. # RFC 7232 defines a conditional request mechanism to prevent
  7600. # response objects being unnecessarily transferred over the network.
  7601. # If that mechanism is used by the client and a cache MISS occurs
  7602. # it can prevent new cache entries being created.
  7603. #
  7604. # This option determines whether Squid on cache MISS will pass the
  7605. # client revalidation request to the server or tries to fetch new
  7606. # content for caching. It can be useful while the cache is mostly
  7607. # empty to more quickly have the cache populated by generating
  7608. # non-conditional GETs.
  7609. #
  7610. # When set to 'on' (default), Squid will pass all client If-* headers
  7611. # to the server. This permits server responses without a cacheable
  7612. # payload to be delivered and on MISS no new cache entry is created.
  7613. #
  7614. # When set to 'off' and if the request is cacheable, Squid will
  7615. # remove the clients If-Modified-Since and If-None-Match headers from
  7616. # the request sent to the server. This requests a 200 status response
  7617. # from the server to create a new cache entry with.
  7618. #Default:
  7619. # cache_miss_revalidate on
  7620.  
  7621. # TAG: always_direct
  7622. # Usage: always_direct allow|deny [!]aclname ...
  7623. #
  7624. # Here you can use ACL elements to specify requests which should
  7625. # ALWAYS be forwarded by Squid to the origin servers without using
  7626. # any peers. For example, to always directly forward requests for
  7627. # local servers ignoring any parents or siblings you may have use
  7628. # something like:
  7629. #
  7630. # acl local-servers dstdomain my.domain.net
  7631. # always_direct allow local-servers
  7632. #
  7633. # To always forward FTP requests directly, use
  7634. #
  7635. # acl FTP proto FTP
  7636. # always_direct allow FTP
  7637. #
  7638. # NOTE: There is a similar, but opposite option named
  7639. # 'never_direct'. You need to be aware that "always_direct deny
  7640. # foo" is NOT the same thing as "never_direct allow foo". You
  7641. # may need to use a deny rule to exclude a more-specific case of
  7642. # some other rule. Example:
  7643. #
  7644. # acl local-external dstdomain external.foo.net
  7645. # acl local-servers dstdomain .foo.net
  7646. # always_direct deny local-external
  7647. # always_direct allow local-servers
  7648. #
  7649. # NOTE: If your goal is to make the client forward the request
  7650. # directly to the origin server bypassing Squid then this needs
  7651. # to be done in the client configuration. Squid configuration
  7652. # can only tell Squid how Squid should fetch the object.
  7653. #
  7654. # NOTE: This directive is not related to caching. The replies
  7655. # is cached as usual even if you use always_direct. To not cache
  7656. # the replies see the 'cache' directive.
  7657. #
  7658. # This clause supports both fast and slow acl types.
  7659. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  7660. #Default:
  7661. # Prevent any cache_peer being used for this request.
  7662.  
  7663. # TAG: never_direct
  7664. # Usage: never_direct allow|deny [!]aclname ...
  7665. #
  7666. # never_direct is the opposite of always_direct. Please read
  7667. # the description for always_direct if you have not already.
  7668. #
  7669. # With 'never_direct' you can use ACL elements to specify
  7670. # requests which should NEVER be forwarded directly to origin
  7671. # servers. For example, to force the use of a proxy for all
  7672. # requests, except those in your local domain use something like:
  7673. #
  7674. # acl local-servers dstdomain .foo.net
  7675. # never_direct deny local-servers
  7676. # never_direct allow all
  7677. #
  7678. # or if Squid is inside a firewall and there are local intranet
  7679. # servers inside the firewall use something like:
  7680. #
  7681. # acl local-intranet dstdomain .foo.net
  7682. # acl local-external dstdomain external.foo.net
  7683. # always_direct deny local-external
  7684. # always_direct allow local-intranet
  7685. # never_direct allow all
  7686. #
  7687. # This clause supports both fast and slow acl types.
  7688. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  7689. #Default:
  7690. # Allow DNS results to be used for this request.
  7691.  
  7692. # ADVANCED NETWORKING OPTIONS
  7693. # -----------------------------------------------------------------------------
  7694.  
  7695. # TAG: incoming_udp_average
  7696. # Heavy voodoo here. I can't even believe you are reading this.
  7697. # Are you crazy? Don't even think about adjusting these unless
  7698. # you understand the algorithms in comm_select.c first!
  7699. #Default:
  7700. # incoming_udp_average 6
  7701.  
  7702. # TAG: incoming_tcp_average
  7703. # Heavy voodoo here. I can't even believe you are reading this.
  7704. # Are you crazy? Don't even think about adjusting these unless
  7705. # you understand the algorithms in comm_select.c first!
  7706. #Default:
  7707. # incoming_tcp_average 4
  7708.  
  7709. # TAG: incoming_dns_average
  7710. # Heavy voodoo here. I can't even believe you are reading this.
  7711. # Are you crazy? Don't even think about adjusting these unless
  7712. # you understand the algorithms in comm_select.c first!
  7713. #Default:
  7714. # incoming_dns_average 4
  7715.  
  7716. # TAG: min_udp_poll_cnt
  7717. # Heavy voodoo here. I can't even believe you are reading this.
  7718. # Are you crazy? Don't even think about adjusting these unless
  7719. # you understand the algorithms in comm_select.c first!
  7720. #Default:
  7721. # min_udp_poll_cnt 8
  7722.  
  7723. # TAG: min_dns_poll_cnt
  7724. # Heavy voodoo here. I can't even believe you are reading this.
  7725. # Are you crazy? Don't even think about adjusting these unless
  7726. # you understand the algorithms in comm_select.c first!
  7727. #Default:
  7728. # min_dns_poll_cnt 8
  7729.  
  7730. # TAG: min_tcp_poll_cnt
  7731. # Heavy voodoo here. I can't even believe you are reading this.
  7732. # Are you crazy? Don't even think about adjusting these unless
  7733. # you understand the algorithms in comm_select.c first!
  7734. #Default:
  7735. # min_tcp_poll_cnt 8
  7736.  
  7737. # TAG: accept_filter
  7738. # FreeBSD:
  7739. #
  7740. # The name of an accept(2) filter to install on Squid's
  7741. # listen socket(s). This feature is perhaps specific to
  7742. # FreeBSD and requires support in the kernel.
  7743. #
  7744. # The 'httpready' filter delays delivering new connections
  7745. # to Squid until a full HTTP request has been received.
  7746. # See the accf_http(9) man page for details.
  7747. #
  7748. # The 'dataready' filter delays delivering new connections
  7749. # to Squid until there is some data to process.
  7750. # See the accf_dataready(9) man page for details.
  7751. #
  7752. # Linux:
  7753. #
  7754. # The 'data' filter delays delivering of new connections
  7755. # to Squid until there is some data to process by TCP_ACCEPT_DEFER.
  7756. # You may optionally specify a number of seconds to wait by
  7757. # 'data=N' where N is the number of seconds. Defaults to 30
  7758. # if not specified. See the tcp(7) man page for details.
  7759. #EXAMPLE:
  7760. ## FreeBSD
  7761. #accept_filter httpready
  7762. ## Linux
  7763. #accept_filter data
  7764. #Default:
  7765. # none
  7766.  
  7767. # TAG: client_ip_max_connections
  7768. # Set an absolute limit on the number of connections a single
  7769. # client IP can use. Any more than this and Squid will begin to drop
  7770. # new connections from the client until it closes some links.
  7771. #
  7772. # Note that this is a global limit. It affects all HTTP, HTCP, Gopher and FTP
  7773. # connections from the client. For finer control use the ACL access controls.
  7774. #
  7775. # Requires client_db to be enabled (the default).
  7776. #
  7777. # WARNING: This may noticably slow down traffic received via external proxies
  7778. # or NAT devices and cause them to rebound error messages back to their clients.
  7779. #Default:
  7780. # No limit.
  7781.  
  7782. # TAG: tcp_recv_bufsize (bytes)
  7783. # Size of receive buffer to set for TCP sockets. Probably just
  7784. # as easy to change your kernel's default.
  7785. # Omit from squid.conf to use the default buffer size.
  7786. #Default:
  7787. # Use operating system TCP defaults.
  7788.  
  7789. # ICAP OPTIONS
  7790. # -----------------------------------------------------------------------------
  7791.  
  7792. # TAG: icap_enable on|off
  7793. # If you want to enable the ICAP module support, set this to on.
  7794. #Default:
  7795. # icap_enable off
  7796.  
  7797. # TAG: icap_connect_timeout
  7798. # This parameter specifies how long to wait for the TCP connect to
  7799. # the requested ICAP server to complete before giving up and either
  7800. # terminating the HTTP transaction or bypassing the failure.
  7801. #
  7802. # The default for optional services is peer_connect_timeout.
  7803. # The default for essential services is connect_timeout.
  7804. # If this option is explicitly set, its value applies to all services.
  7805. #Default:
  7806. # none
  7807.  
  7808. # TAG: icap_io_timeout time-units
  7809. # This parameter specifies how long to wait for an I/O activity on
  7810. # an established, active ICAP connection before giving up and
  7811. # either terminating the HTTP transaction or bypassing the
  7812. # failure.
  7813. #Default:
  7814. # Use read_timeout.
  7815.  
  7816. # TAG: icap_service_failure_limit limit [in memory-depth time-units]
  7817. # The limit specifies the number of failures that Squid tolerates
  7818. # when establishing a new TCP connection with an ICAP service. If
  7819. # the number of failures exceeds the limit, the ICAP service is
  7820. # not used for new ICAP requests until it is time to refresh its
  7821. # OPTIONS.
  7822. #
  7823. # A negative value disables the limit. Without the limit, an ICAP
  7824. # service will not be considered down due to connectivity failures
  7825. # between ICAP OPTIONS requests.
  7826. #
  7827. # Squid forgets ICAP service failures older than the specified
  7828. # value of memory-depth. The memory fading algorithm
  7829. # is approximate because Squid does not remember individual
  7830. # errors but groups them instead, splitting the option
  7831. # value into ten time slots of equal length.
  7832. #
  7833. # When memory-depth is 0 and by default this option has no
  7834. # effect on service failure expiration.
  7835. #
  7836. # Squid always forgets failures when updating service settings
  7837. # using an ICAP OPTIONS transaction, regardless of this option
  7838. # setting.
  7839. #
  7840. # For example,
  7841. # # suspend service usage after 10 failures in 5 seconds:
  7842. # icap_service_failure_limit 10 in 5 seconds
  7843. #Default:
  7844. # icap_service_failure_limit 10
  7845.  
  7846. # TAG: icap_service_revival_delay
  7847. # The delay specifies the number of seconds to wait after an ICAP
  7848. # OPTIONS request failure before requesting the options again. The
  7849. # failed ICAP service is considered "down" until fresh OPTIONS are
  7850. # fetched.
  7851. #
  7852. # The actual delay cannot be smaller than the hardcoded minimum
  7853. # delay of 30 seconds.
  7854. #Default:
  7855. # icap_service_revival_delay 180
  7856.  
  7857. # TAG: icap_preview_enable on|off
  7858. # The ICAP Preview feature allows the ICAP server to handle the
  7859. # HTTP message by looking only at the beginning of the message body
  7860. # or even without receiving the body at all. In some environments,
  7861. # previews greatly speedup ICAP processing.
  7862. #
  7863. # During an ICAP OPTIONS transaction, the server may tell Squid what
  7864. # HTTP messages should be previewed and how big the preview should be.
  7865. # Squid will not use Preview if the server did not request one.
  7866. #
  7867. # To disable ICAP Preview for all ICAP services, regardless of
  7868. # individual ICAP server OPTIONS responses, set this option to "off".
  7869. #Example:
  7870. #icap_preview_enable off
  7871. #Default:
  7872. # icap_preview_enable on
  7873.  
  7874. # TAG: icap_preview_size
  7875. # The default size of preview data to be sent to the ICAP server.
  7876. # This value might be overwritten on a per server basis by OPTIONS requests.
  7877. #Default:
  7878. # No preview sent.
  7879.  
  7880. # TAG: icap_206_enable on|off
  7881. # 206 (Partial Content) responses is an ICAP extension that allows the
  7882. # ICAP agents to optionally combine adapted and original HTTP message
  7883. # content. The decision to combine is postponed until the end of the
  7884. # ICAP response. Squid supports Partial Content extension by default.
  7885. #
  7886. # Activation of the Partial Content extension is negotiated with each
  7887. # ICAP service during OPTIONS exchange. Most ICAP servers should handle
  7888. # negotation correctly even if they do not support the extension, but
  7889. # some might fail. To disable Partial Content support for all ICAP
  7890. # services and to avoid any negotiation, set this option to "off".
  7891. #
  7892. # Example:
  7893. # icap_206_enable off
  7894. #Default:
  7895. # icap_206_enable on
  7896.  
  7897. # TAG: icap_default_options_ttl
  7898. # The default TTL value for ICAP OPTIONS responses that don't have
  7899. # an Options-TTL header.
  7900. #Default:
  7901. # icap_default_options_ttl 60
  7902.  
  7903. # TAG: icap_persistent_connections on|off
  7904. # Whether or not Squid should use persistent connections to
  7905. # an ICAP server.
  7906. #Default:
  7907. # icap_persistent_connections on
  7908.  
  7909. # TAG: adaptation_send_client_ip on|off
  7910. # If enabled, Squid shares HTTP client IP information with adaptation
  7911. # services. For ICAP, Squid adds the X-Client-IP header to ICAP requests.
  7912. # For eCAP, Squid sets the libecap::metaClientIp transaction option.
  7913. #
  7914. # See also: adaptation_uses_indirect_client
  7915. #Default:
  7916. # adaptation_send_client_ip off
  7917.  
  7918. # TAG: adaptation_send_username on|off
  7919. # This sends authenticated HTTP client username (if available) to
  7920. # the adaptation service.
  7921. #
  7922. # For ICAP, the username value is encoded based on the
  7923. # icap_client_username_encode option and is sent using the header
  7924. # specified by the icap_client_username_header option.
  7925. #Default:
  7926. # adaptation_send_username off
  7927.  
  7928. # TAG: icap_client_username_header
  7929. # ICAP request header name to use for adaptation_send_username.
  7930. #Default:
  7931. # icap_client_username_header X-Client-Username
  7932.  
  7933. # TAG: icap_client_username_encode on|off
  7934. # Whether to base64 encode the authenticated client username.
  7935. #Default:
  7936. # icap_client_username_encode off
  7937.  
  7938. # TAG: icap_service
  7939. # Defines a single ICAP service using the following format:
  7940. #
  7941. # icap_service id vectoring_point uri [option ...]
  7942. #
  7943. # id: ID
  7944. # an opaque identifier or name which is used to direct traffic to
  7945. # this specific service. Must be unique among all adaptation
  7946. # services in squid.conf.
  7947. #
  7948. # vectoring_point: reqmod_precache|reqmod_postcache|respmod_precache|respmod_postcache
  7949. # This specifies at which point of transaction processing the
  7950. # ICAP service should be activated. *_postcache vectoring points
  7951. # are not yet supported.
  7952. #
  7953. # uri: icap://servername:port/servicepath
  7954. # ICAP server and service location.
  7955. # icaps://servername:port/servicepath
  7956. # The "icap:" URI scheme is used for traditional ICAP server and
  7957. # service location (default port is 1344, connections are not
  7958. # encrypted). The "icaps:" URI scheme is for Secure ICAP
  7959. # services that use SSL/TLS-encrypted ICAP connections (by
  7960. # default, on port 11344).
  7961. #
  7962. # ICAP does not allow a single service to handle both REQMOD and RESPMOD
  7963. # transactions. Squid does not enforce that requirement. You can specify
  7964. # services with the same service_url and different vectoring_points. You
  7965. # can even specify multiple identical services as long as their
  7966. # service_names differ.
  7967. #
  7968. # To activate a service, use the adaptation_access directive. To group
  7969. # services, use adaptation_service_chain and adaptation_service_set.
  7970. #
  7971. # Service options are separated by white space. ICAP services support
  7972. # the following name=value options:
  7973. #
  7974. # bypass=on|off|1|0
  7975. # If set to 'on' or '1', the ICAP service is treated as
  7976. # optional. If the service cannot be reached or malfunctions,
  7977. # Squid will try to ignore any errors and process the message as
  7978. # if the service was not enabled. No all ICAP errors can be
  7979. # bypassed. If set to 0, the ICAP service is treated as
  7980. # essential and all ICAP errors will result in an error page
  7981. # returned to the HTTP client.
  7982. #
  7983. # Bypass is off by default: services are treated as essential.
  7984. #
  7985. # routing=on|off|1|0
  7986. # If set to 'on' or '1', the ICAP service is allowed to
  7987. # dynamically change the current message adaptation plan by
  7988. # returning a chain of services to be used next. The services
  7989. # are specified using the X-Next-Services ICAP response header
  7990. # value, formatted as a comma-separated list of service names.
  7991. # Each named service should be configured in squid.conf. Other
  7992. # services are ignored. An empty X-Next-Services value results
  7993. # in an empty plan which ends the current adaptation.
  7994. #
  7995. # Dynamic adaptation plan may cross or cover multiple supported
  7996. # vectoring points in their natural processing order.
  7997. #
  7998. # Routing is not allowed by default: the ICAP X-Next-Services
  7999. # response header is ignored.
  8000. #
  8001. # ipv6=on|off
  8002. # Only has effect on split-stack systems. The default on those systems
  8003. # is to use IPv4-only connections. When set to 'on' this option will
  8004. # make Squid use IPv6-only connections to contact this ICAP service.
  8005. #
  8006. # on-overload=block|bypass|wait|force
  8007. # If the service Max-Connections limit has been reached, do
  8008. # one of the following for each new ICAP transaction:
  8009. # * block: send an HTTP error response to the client
  8010. # * bypass: ignore the "over-connected" ICAP service
  8011. # * wait: wait (in a FIFO queue) for an ICAP connection slot
  8012. # * force: proceed, ignoring the Max-Connections limit
  8013. #
  8014. # In SMP mode with N workers, each worker assumes the service
  8015. # connection limit is Max-Connections/N, even though not all
  8016. # workers may use a given service.
  8017. #
  8018. # The default value is "bypass" if service is bypassable,
  8019. # otherwise it is set to "wait".
  8020. #
  8021. #
  8022. # max-conn=number
  8023. # Use the given number as the Max-Connections limit, regardless
  8024. # of the Max-Connections value given by the service, if any.
  8025. #
  8026. # connection-encryption=on|off
  8027. # Determines the ICAP service effect on the connections_encrypted
  8028. # ACL.
  8029. #
  8030. # The default is "on" for Secure ICAP services (i.e., those
  8031. # with the icaps:// service URIs scheme) and "off" for plain ICAP
  8032. # services.
  8033. #
  8034. # Does not affect ICAP connections (e.g., does not turn Secure
  8035. # ICAP on or off).
  8036. #
  8037. # ==== ICAPS / TLS OPTIONS ====
  8038. #
  8039. # These options are used for Secure ICAP (icaps://....) services only.
  8040. #
  8041. # tls-cert=/path/to/ssl/certificate
  8042. # A client X.509 certificate to use when connecting to
  8043. # this ICAP server.
  8044. #
  8045. # tls-key=/path/to/ssl/key
  8046. # The private key corresponding to the previous
  8047. # tls-cert= option.
  8048. #
  8049. # If tls-key= is not specified tls-cert= is assumed to
  8050. # reference a PEM file containing both the certificate
  8051. # and private key.
  8052. #
  8053. # tls-cipher=... The list of valid TLS/SSL ciphers to use when connecting
  8054. # to this icap server.
  8055. #
  8056. # tls-min-version=1.N
  8057. # The minimum TLS protocol version to permit. To control
  8058. # SSLv3 use the tls-options= parameter.
  8059. # Supported Values: 1.0 (default), 1.1, 1.2
  8060. #
  8061. # tls-options=... Specify various OpenSSL library options:
  8062. #
  8063. # NO_SSLv3 Disallow the use of SSLv3
  8064. #
  8065. # SINGLE_DH_USE
  8066. # Always create a new key when using
  8067. # temporary/ephemeral DH key exchanges
  8068. #
  8069. # ALL Enable various bug workarounds
  8070. # suggested as "harmless" by OpenSSL
  8071. # Be warned that this reduces SSL/TLS
  8072. # strength to some attacks.
  8073. #
  8074. # See the OpenSSL SSL_CTX_set_options documentation for a
  8075. # more complete list. Options relevant only to SSLv2 are
  8076. # not supported.
  8077. #
  8078. # tls-cafile= PEM file containing CA certificates to use when verifying
  8079. # the icap server certificate.
  8080. # Use to specify intermediate CA certificate(s) if not sent
  8081. # by the server. Or the full CA chain for the server when
  8082. # using the tls-default-ca=off flag.
  8083. # May be repeated to load multiple files.
  8084. #
  8085. # tls-capath=... A directory containing additional CA certificates to
  8086. # use when verifying the icap server certificate.
  8087. # Requires OpenSSL or LibreSSL.
  8088. #
  8089. # tls-crlfile=... A certificate revocation list file to use when
  8090. # verifying the icap server certificate.
  8091. #
  8092. # tls-flags=... Specify various flags modifying the Squid TLS implementation:
  8093. #
  8094. # DONT_VERIFY_PEER
  8095. # Accept certificates even if they fail to
  8096. # verify.
  8097. # DONT_VERIFY_DOMAIN
  8098. # Don't verify the icap server certificate
  8099. # matches the server name
  8100. #
  8101. # tls-default-ca[=off]
  8102. # Whether to use the system Trusted CAs. Default is ON.
  8103. #
  8104. # tls-domain= The icap server name as advertised in it's certificate.
  8105. # Used for verifying the correctness of the received icap
  8106. # server certificate. If not specified the icap server
  8107. # hostname extracted from ICAP URI will be used.
  8108. #
  8109. # Older icap_service format without optional named parameters is
  8110. # deprecated but supported for backward compatibility.
  8111. #
  8112. #Example:
  8113. #icap_service svcBlocker reqmod_precache icap://icap1.mydomain.net:1344/reqmod bypass=0
  8114. #icap_service svcLogger reqmod_precache icaps://icap2.mydomain.net:11344/reqmod routing=on
  8115. #Default:
  8116. # none
  8117.  
  8118. # TAG: icap_class
  8119. # This deprecated option was documented to define an ICAP service
  8120. # chain, even though it actually defined a set of similar, redundant
  8121. # services, and the chains were not supported.
  8122. #
  8123. # To define a set of redundant services, please use the
  8124. # adaptation_service_set directive. For service chains, use
  8125. # adaptation_service_chain.
  8126. #Default:
  8127. # none
  8128.  
  8129. # TAG: icap_access
  8130. # This option is deprecated. Please use adaptation_access, which
  8131. # has the same ICAP functionality, but comes with better
  8132. # documentation, and eCAP support.
  8133. #Default:
  8134. # none
  8135.  
  8136. # eCAP OPTIONS
  8137. # -----------------------------------------------------------------------------
  8138.  
  8139. # TAG: ecap_enable on|off
  8140. # Controls whether eCAP support is enabled.
  8141. #Default:
  8142. # ecap_enable off
  8143.  
  8144. # TAG: ecap_service
  8145. # Defines a single eCAP service
  8146. #
  8147. # ecap_service id vectoring_point uri [option ...]
  8148. #
  8149. # id: ID
  8150. # an opaque identifier or name which is used to direct traffic to
  8151. # this specific service. Must be unique among all adaptation
  8152. # services in squid.conf.
  8153. #
  8154. # vectoring_point: reqmod_precache|reqmod_postcache|respmod_precache|respmod_postcache
  8155. # This specifies at which point of transaction processing the
  8156. # eCAP service should be activated. *_postcache vectoring points
  8157. # are not yet supported.
  8158. #
  8159. # uri: ecap://vendor/service_name?custom&cgi=style&parameters=optional
  8160. # Squid uses the eCAP service URI to match this configuration
  8161. # line with one of the dynamically loaded services. Each loaded
  8162. # eCAP service must have a unique URI. Obtain the right URI from
  8163. # the service provider.
  8164. #
  8165. # To activate a service, use the adaptation_access directive. To group
  8166. # services, use adaptation_service_chain and adaptation_service_set.
  8167. #
  8168. # Service options are separated by white space. eCAP services support
  8169. # the following name=value options:
  8170. #
  8171. # bypass=on|off|1|0
  8172. # If set to 'on' or '1', the eCAP service is treated as optional.
  8173. # If the service cannot be reached or malfunctions, Squid will try
  8174. # to ignore any errors and process the message as if the service
  8175. # was not enabled. No all eCAP errors can be bypassed.
  8176. # If set to 'off' or '0', the eCAP service is treated as essential
  8177. # and all eCAP errors will result in an error page returned to the
  8178. # HTTP client.
  8179. #
  8180. # Bypass is off by default: services are treated as essential.
  8181. #
  8182. # routing=on|off|1|0
  8183. # If set to 'on' or '1', the eCAP service is allowed to
  8184. # dynamically change the current message adaptation plan by
  8185. # returning a chain of services to be used next.
  8186. #
  8187. # Dynamic adaptation plan may cross or cover multiple supported
  8188. # vectoring points in their natural processing order.
  8189. #
  8190. # Routing is not allowed by default.
  8191. #
  8192. # connection-encryption=on|off
  8193. # Determines the eCAP service effect on the connections_encrypted
  8194. # ACL.
  8195. #
  8196. # Defaults to "on", which does not taint the master transaction
  8197. # w.r.t. that ACL.
  8198. #
  8199. # Does not affect eCAP API calls.
  8200. #
  8201. # Older ecap_service format without optional named parameters is
  8202. # deprecated but supported for backward compatibility.
  8203. #
  8204. #
  8205. #Example:
  8206. #ecap_service s1 reqmod_precache ecap://filters.R.us/leakDetector?on_error=block bypass=off
  8207. #ecap_service s2 respmod_precache ecap://filters.R.us/virusFilter config=/etc/vf.cfg bypass=on
  8208. #Default:
  8209. # none
  8210.  
  8211. # TAG: loadable_modules
  8212. # Instructs Squid to load the specified dynamic module(s) or activate
  8213. # preloaded module(s).
  8214. #Example:
  8215. #loadable_modules /usr/lib/MinimalAdapter.so
  8216. #Default:
  8217. # none
  8218.  
  8219. # MESSAGE ADAPTATION OPTIONS
  8220. # -----------------------------------------------------------------------------
  8221.  
  8222. # TAG: adaptation_service_set
  8223. #
  8224. # Configures an ordered set of similar, redundant services. This is
  8225. # useful when hot standby or backup adaptation servers are available.
  8226. #
  8227. # adaptation_service_set set_name service_name1 service_name2 ...
  8228. #
  8229. # The named services are used in the set declaration order. The first
  8230. # applicable adaptation service from the set is used first. The next
  8231. # applicable service is tried if and only if the transaction with the
  8232. # previous service fails and the message waiting to be adapted is still
  8233. # intact.
  8234. #
  8235. # When adaptation starts, broken services are ignored as if they were
  8236. # not a part of the set. A broken service is a down optional service.
  8237. #
  8238. # The services in a set must be attached to the same vectoring point
  8239. # (e.g., pre-cache) and use the same adaptation method (e.g., REQMOD).
  8240. #
  8241. # If all services in a set are optional then adaptation failures are
  8242. # bypassable. If all services in the set are essential, then a
  8243. # transaction failure with one service may still be retried using
  8244. # another service from the set, but when all services fail, the master
  8245. # transaction fails as well.
  8246. #
  8247. # A set may contain a mix of optional and essential services, but that
  8248. # is likely to lead to surprising results because broken services become
  8249. # ignored (see above), making previously bypassable failures fatal.
  8250. # Technically, it is the bypassability of the last failed service that
  8251. # matters.
  8252. #
  8253. # See also: adaptation_access adaptation_service_chain
  8254. #
  8255. #Example:
  8256. #adaptation_service_set svcBlocker urlFilterPrimary urlFilterBackup
  8257. #adaptation service_set svcLogger loggerLocal loggerRemote
  8258. #Default:
  8259. # none
  8260.  
  8261. # TAG: adaptation_service_chain
  8262. #
  8263. # Configures a list of complementary services that will be applied
  8264. # one-by-one, forming an adaptation chain or pipeline. This is useful
  8265. # when Squid must perform different adaptations on the same message.
  8266. #
  8267. # adaptation_service_chain chain_name service_name1 svc_name2 ...
  8268. #
  8269. # The named services are used in the chain declaration order. The first
  8270. # applicable adaptation service from the chain is used first. The next
  8271. # applicable service is applied to the successful adaptation results of
  8272. # the previous service in the chain.
  8273. #
  8274. # When adaptation starts, broken services are ignored as if they were
  8275. # not a part of the chain. A broken service is a down optional service.
  8276. #
  8277. # Request satisfaction terminates the adaptation chain because Squid
  8278. # does not currently allow declaration of RESPMOD services at the
  8279. # "reqmod_precache" vectoring point (see icap_service or ecap_service).
  8280. #
  8281. # The services in a chain must be attached to the same vectoring point
  8282. # (e.g., pre-cache) and use the same adaptation method (e.g., REQMOD).
  8283. #
  8284. # A chain may contain a mix of optional and essential services. If an
  8285. # essential adaptation fails (or the failure cannot be bypassed for
  8286. # other reasons), the master transaction fails. Otherwise, the failure
  8287. # is bypassed as if the failed adaptation service was not in the chain.
  8288. #
  8289. # See also: adaptation_access adaptation_service_set
  8290. #
  8291. #Example:
  8292. #adaptation_service_chain svcRequest requestLogger urlFilter leakDetector
  8293. #Default:
  8294. # none
  8295.  
  8296. # TAG: adaptation_access
  8297. # Sends an HTTP transaction to an ICAP or eCAP adaptation service.
  8298. #
  8299. # adaptation_access service_name allow|deny [!]aclname...
  8300. # adaptation_access set_name allow|deny [!]aclname...
  8301. #
  8302. # At each supported vectoring point, the adaptation_access
  8303. # statements are processed in the order they appear in this
  8304. # configuration file. Statements pointing to the following services
  8305. # are ignored (i.e., skipped without checking their ACL):
  8306. #
  8307. # - services serving different vectoring points
  8308. # - "broken-but-bypassable" services
  8309. # - "up" services configured to ignore such transactions
  8310. # (e.g., based on the ICAP Transfer-Ignore header).
  8311. #
  8312. # When a set_name is used, all services in the set are checked
  8313. # using the same rules, to find the first applicable one. See
  8314. # adaptation_service_set for details.
  8315. #
  8316. # If an access list is checked and there is a match, the
  8317. # processing stops: For an "allow" rule, the corresponding
  8318. # adaptation service is used for the transaction. For a "deny"
  8319. # rule, no adaptation service is activated.
  8320. #
  8321. # It is currently not possible to apply more than one adaptation
  8322. # service at the same vectoring point to the same HTTP transaction.
  8323. #
  8324. # See also: icap_service and ecap_service
  8325. #
  8326. #Example:
  8327. #adaptation_access service_1 allow all
  8328. #Default:
  8329. # Allow, unless rules exist in squid.conf.
  8330.  
  8331. # TAG: adaptation_service_iteration_limit
  8332. # Limits the number of iterations allowed when applying adaptation
  8333. # services to a message. If your longest adaptation set or chain
  8334. # may have more than 16 services, increase the limit beyond its
  8335. # default value of 16. If detecting infinite iteration loops sooner
  8336. # is critical, make the iteration limit match the actual number
  8337. # of services in your longest adaptation set or chain.
  8338. #
  8339. # Infinite adaptation loops are most likely with routing services.
  8340. #
  8341. # See also: icap_service routing=1
  8342. #Default:
  8343. # adaptation_service_iteration_limit 16
  8344.  
  8345. # TAG: adaptation_masterx_shared_names
  8346. # For each master transaction (i.e., the HTTP request and response
  8347. # sequence, including all related ICAP and eCAP exchanges), Squid
  8348. # maintains a table of metadata. The table entries are (name, value)
  8349. # pairs shared among eCAP and ICAP exchanges. The table is destroyed
  8350. # with the master transaction.
  8351. #
  8352. # This option specifies the table entry names that Squid must accept
  8353. # from and forward to the adaptation transactions.
  8354. #
  8355. # An ICAP REQMOD or RESPMOD transaction may set an entry in the
  8356. # shared table by returning an ICAP header field with a name
  8357. # specified in adaptation_masterx_shared_names.
  8358. #
  8359. # An eCAP REQMOD or RESPMOD transaction may set an entry in the
  8360. # shared table by implementing the libecap::visitEachOption() API
  8361. # to provide an option with a name specified in
  8362. # adaptation_masterx_shared_names.
  8363. #
  8364. # Squid will store and forward the set entry to subsequent adaptation
  8365. # transactions within the same master transaction scope.
  8366. #
  8367. # Only one shared entry name is supported at this time.
  8368. #
  8369. #Example:
  8370. ## share authentication information among ICAP services
  8371. #adaptation_masterx_shared_names X-Subscriber-ID
  8372. #Default:
  8373. # none
  8374.  
  8375. # TAG: adaptation_meta
  8376. # This option allows Squid administrator to add custom ICAP request
  8377. # headers or eCAP options to Squid ICAP requests or eCAP transactions.
  8378. # Use it to pass custom authentication tokens and other
  8379. # transaction-state related meta information to an ICAP/eCAP service.
  8380. #
  8381. # The addition of a meta header is ACL-driven:
  8382. # adaptation_meta name value [!]aclname ...
  8383. #
  8384. # Processing for a given header name stops after the first ACL list match.
  8385. # Thus, it is impossible to add two headers with the same name. If no ACL
  8386. # lists match for a given header name, no such header is added. For
  8387. # example:
  8388. #
  8389. # # do not debug transactions except for those that need debugging
  8390. # adaptation_meta X-Debug 1 needs_debugging
  8391. #
  8392. # # log all transactions except for those that must remain secret
  8393. # adaptation_meta X-Log 1 !keep_secret
  8394. #
  8395. # # mark transactions from users in the "G 1" group
  8396. # adaptation_meta X-Authenticated-Groups "G 1" authed_as_G1
  8397. #
  8398. # The "value" parameter may be a regular squid.conf token or a "double
  8399. # quoted string". Within the quoted string, use backslash (\) to escape
  8400. # any character, which is currently only useful for escaping backslashes
  8401. # and double quotes. For example,
  8402. # "this string has one backslash (\\) and two \"quotes\""
  8403. #
  8404. # Used adaptation_meta header values may be logged via %note
  8405. # logformat code. If multiple adaptation_meta headers with the same name
  8406. # are used during master transaction lifetime, the header values are
  8407. # logged in the order they were used and duplicate values are ignored
  8408. # (only the first repeated value will be logged).
  8409. #Default:
  8410. # none
  8411.  
  8412. # TAG: icap_retry
  8413. # This ACL determines which retriable ICAP transactions are
  8414. # retried. Transactions that received a complete ICAP response
  8415. # and did not have to consume or produce HTTP bodies to receive
  8416. # that response are usually retriable.
  8417. #
  8418. # icap_retry allow|deny [!]aclname ...
  8419. #
  8420. # Squid automatically retries some ICAP I/O timeouts and errors
  8421. # due to persistent connection race conditions.
  8422. #
  8423. # See also: icap_retry_limit
  8424. #Default:
  8425. # icap_retry deny all
  8426.  
  8427. # TAG: icap_retry_limit
  8428. # Limits the number of retries allowed.
  8429. #
  8430. # Communication errors due to persistent connection race
  8431. # conditions are unavoidable, automatically retried, and do not
  8432. # count against this limit.
  8433. #
  8434. # See also: icap_retry
  8435. #Default:
  8436. # No retries are allowed.
  8437.  
  8438. # DNS OPTIONS
  8439. # -----------------------------------------------------------------------------
  8440.  
  8441. # TAG: check_hostnames
  8442. # For security and stability reasons Squid can check
  8443. # hostnames for Internet standard RFC compliance. If you want
  8444. # Squid to perform these checks turn this directive on.
  8445. #Default:
  8446. # check_hostnames off
  8447.  
  8448. # TAG: allow_underscore
  8449. # Underscore characters is not strictly allowed in Internet hostnames
  8450. # but nevertheless used by many sites. Set this to off if you want
  8451. # Squid to be strict about the standard.
  8452. # This check is performed only when check_hostnames is set to on.
  8453. #Default:
  8454. # allow_underscore on
  8455.  
  8456. # TAG: dns_retransmit_interval
  8457. # Initial retransmit interval for DNS queries. The interval is
  8458. # doubled each time all configured DNS servers have been tried.
  8459. #Default:
  8460. # dns_retransmit_interval 5 seconds
  8461.  
  8462. # TAG: dns_timeout
  8463. # DNS Query timeout. If no response is received to a DNS query
  8464. # within this time all DNS servers for the queried domain
  8465. # are assumed to be unavailable.
  8466. #Default:
  8467. # dns_timeout 30 seconds
  8468.  
  8469. # TAG: dns_packet_max
  8470. # Maximum number of bytes packet size to advertise via EDNS.
  8471. # Set to "none" to disable EDNS large packet support.
  8472. #
  8473. # For legacy reasons DNS UDP replies will default to 512 bytes which
  8474. # is too small for many responses. EDNS provides a means for Squid to
  8475. # negotiate receiving larger responses back immediately without having
  8476. # to failover with repeat requests. Responses larger than this limit
  8477. # will retain the old behaviour of failover to TCP DNS.
  8478. #
  8479. # Squid has no real fixed limit internally, but allowing packet sizes
  8480. # over 1500 bytes requires network jumbogram support and is usually not
  8481. # necessary.
  8482. #
  8483. # WARNING: The RFC also indicates that some older resolvers will reply
  8484. # with failure of the whole request if the extension is added. Some
  8485. # resolvers have already been identified which will reply with mangled
  8486. # EDNS response on occasion. Usually in response to many-KB jumbogram
  8487. # sizes being advertised by Squid.
  8488. # Squid will currently treat these both as an unable-to-resolve domain
  8489. # even if it would be resolvable without EDNS.
  8490. #Default:
  8491. # EDNS disabled
  8492.  
  8493. # TAG: dns_defnames on|off
  8494. # Normally the RES_DEFNAMES resolver option is disabled
  8495. # (see res_init(3)). This prevents caches in a hierarchy
  8496. # from interpreting single-component hostnames locally. To allow
  8497. # Squid to handle single-component names, enable this option.
  8498. #Default:
  8499. # Search for single-label domain names is disabled.
  8500.  
  8501. # TAG: dns_multicast_local on|off
  8502. # When set to on, Squid sends multicast DNS lookups on the local
  8503. # network for domains ending in .local and .arpa.
  8504. # This enables local servers and devices to be contacted in an
  8505. # ad-hoc or zero-configuration network environment.
  8506. #Default:
  8507. # Search for .local and .arpa names is disabled.
  8508.  
  8509. # TAG: dns_nameservers
  8510. # Use this if you want to specify a list of DNS name servers
  8511. # (IP addresses) to use instead of those given in your
  8512. # /etc/resolv.conf file.
  8513. #
  8514. # On Windows platforms, if no value is specified here or in
  8515. # the /etc/resolv.conf file, the list of DNS name servers are
  8516. # taken from the Windows registry, both static and dynamic DHCP
  8517. # configurations are supported.
  8518. #
  8519. # Example: dns_nameservers 10.0.0.1 192.172.0.4
  8520. #Default:
  8521. # Use operating system definitions
  8522.  
  8523. # TAG: hosts_file
  8524. # Location of the host-local IP name-address associations
  8525. # database. Most Operating Systems have such a file on different
  8526. # default locations:
  8527. # - Un*X & Linux: /etc/hosts
  8528. # - Windows NT/2000: %SystemRoot%\system32\drivers\etc\hosts
  8529. # (%SystemRoot% value install default is c:\winnt)
  8530. # - Windows XP/2003: %SystemRoot%\system32\drivers\etc\hosts
  8531. # (%SystemRoot% value install default is c:\windows)
  8532. # - Windows 9x/Me: %windir%\hosts
  8533. # (%windir% value is usually c:\windows)
  8534. # - Cygwin: /etc/hosts
  8535. #
  8536. # The file contains newline-separated definitions, in the
  8537. # form ip_address_in_dotted_form name [name ...] names are
  8538. # whitespace-separated. Lines beginning with an hash (#)
  8539. # character are comments.
  8540. #
  8541. # The file is checked at startup and upon configuration.
  8542. # If set to 'none', it won't be checked.
  8543. # If append_domain is used, that domain will be added to
  8544. # domain-local (i.e. not containing any dot character) host
  8545. # definitions.
  8546. #Default:
  8547. # hosts_file /etc/hosts
  8548.  
  8549. # TAG: append_domain
  8550. # Appends local domain name to hostnames without any dots in
  8551. # them. append_domain must begin with a period.
  8552. #
  8553. # Be warned there are now Internet names with no dots in
  8554. # them using only top-domain names, so setting this may
  8555. # cause some Internet sites to become unavailable.
  8556. #
  8557. #Example:
  8558. # append_domain .yourdomain.com
  8559. #Default:
  8560. # Use operating system definitions
  8561.  
  8562. # TAG: ignore_unknown_nameservers
  8563. # By default Squid checks that DNS responses are received
  8564. # from the same IP addresses they are sent to. If they
  8565. # don't match, Squid ignores the response and writes a warning
  8566. # message to cache.log. You can allow responses from unknown
  8567. # nameservers by setting this option to 'off'.
  8568. #Default:
  8569. # ignore_unknown_nameservers on
  8570.  
  8571. # TAG: ipcache_size (number of entries)
  8572. # Maximum number of DNS IP cache entries.
  8573. #Default:
  8574. # ipcache_size 1024
  8575.  
  8576. # TAG: ipcache_low (percent)
  8577. #Default:
  8578. # ipcache_low 90
  8579.  
  8580. # TAG: ipcache_high (percent)
  8581. # The size, low-, and high-water marks for the IP cache.
  8582. #Default:
  8583. # ipcache_high 95
  8584.  
  8585. # TAG: fqdncache_size (number of entries)
  8586. # Maximum number of FQDN cache entries.
  8587. #Default:
  8588. # fqdncache_size 1024
  8589.  
  8590. # MISCELLANEOUS
  8591. # -----------------------------------------------------------------------------
  8592.  
  8593. # TAG: configuration_includes_quoted_values on|off
  8594. # If set, Squid will recognize each "quoted string" after a configuration
  8595. # directive as a single parameter. The quotes are stripped before the
  8596. # parameter value is interpreted or used.
  8597. # See "Values with spaces, quotes, and other special characters"
  8598. # section for more details.
  8599. #Default:
  8600. # configuration_includes_quoted_values off
  8601.  
  8602. # TAG: memory_pools on|off
  8603. # If set, Squid will keep pools of allocated (but unused) memory
  8604. # available for future use. If memory is a premium on your
  8605. # system and you believe your malloc library outperforms Squid
  8606. # routines, disable this.
  8607. #Default:
  8608. # memory_pools on
  8609.  
  8610. # TAG: memory_pools_limit (bytes)
  8611. # Used only with memory_pools on:
  8612. # memory_pools_limit 50 MB
  8613. #
  8614. # If set to a non-zero value, Squid will keep at most the specified
  8615. # limit of allocated (but unused) memory in memory pools. All free()
  8616. # requests that exceed this limit will be handled by your malloc
  8617. # library. Squid does not pre-allocate any memory, just safe-keeps
  8618. # objects that otherwise would be free()d. Thus, it is safe to set
  8619. # memory_pools_limit to a reasonably high value even if your
  8620. # configuration will use less memory.
  8621. #
  8622. # If set to none, Squid will keep all memory it can. That is, there
  8623. # will be no limit on the total amount of memory used for safe-keeping.
  8624. #
  8625. # To disable memory allocation optimization, do not set
  8626. # memory_pools_limit to 0 or none. Set memory_pools to "off" instead.
  8627. #
  8628. # An overhead for maintaining memory pools is not taken into account
  8629. # when the limit is checked. This overhead is close to four bytes per
  8630. # object kept. However, pools may actually _save_ memory because of
  8631. # reduced memory thrashing in your malloc library.
  8632. #Default:
  8633. # memory_pools_limit 5 MB
  8634.  
  8635. # TAG: forwarded_for on|off|transparent|truncate|delete
  8636. # If set to "on", Squid will append your client's IP address
  8637. # in the HTTP requests it forwards. By default it looks like:
  8638. #
  8639. # X-Forwarded-For: 192.1.2.3
  8640. #
  8641. # If set to "off", it will appear as
  8642. #
  8643. # X-Forwarded-For: unknown
  8644. #
  8645. # If set to "transparent", Squid will not alter the
  8646. # X-Forwarded-For header in any way.
  8647. #
  8648. # If set to "delete", Squid will delete the entire
  8649. # X-Forwarded-For header.
  8650. #
  8651. # If set to "truncate", Squid will remove all existing
  8652. # X-Forwarded-For entries, and place the client IP as the sole entry.
  8653. #Default:
  8654. # forwarded_for on
  8655.  
  8656. # TAG: cachemgr_passwd
  8657. # Specify passwords for cachemgr operations.
  8658. #
  8659. # Usage: cachemgr_passwd password action action ...
  8660. #
  8661. # Some valid actions are (see cache manager menu for a full list):
  8662. # 5min
  8663. # 60min
  8664. # asndb
  8665. # authenticator
  8666. # cbdata
  8667. # client_list
  8668. # comm_incoming
  8669. # config *
  8670. # counters
  8671. # delay
  8672. # digest_stats
  8673. # dns
  8674. # events
  8675. # filedescriptors
  8676. # fqdncache
  8677. # histograms
  8678. # http_headers
  8679. # info
  8680. # io
  8681. # ipcache
  8682. # mem
  8683. # menu
  8684. # netdb
  8685. # non_peers
  8686. # objects
  8687. # offline_toggle *
  8688. # pconn
  8689. # peer_select
  8690. # reconfigure *
  8691. # redirector
  8692. # refresh
  8693. # server_list
  8694. # shutdown *
  8695. # store_digest
  8696. # storedir
  8697. # utilization
  8698. # via_headers
  8699. # vm_objects
  8700. #
  8701. # * Indicates actions which will not be performed without a
  8702. # valid password, others can be performed if not listed here.
  8703. #
  8704. # To disable an action, set the password to "disable".
  8705. # To allow performing an action without a password, set the
  8706. # password to "none".
  8707. #
  8708. # Use the keyword "all" to set the same password for all actions.
  8709. #
  8710. #Example:
  8711. # cachemgr_passwd secret shutdown
  8712. # cachemgr_passwd lesssssssecret info stats/objects
  8713. # cachemgr_passwd disable all
  8714. #Default:
  8715. # No password. Actions which require password are denied.
  8716.  
  8717. # TAG: client_db on|off
  8718. # If you want to disable collecting per-client statistics,
  8719. # turn off client_db here.
  8720. #Default:
  8721. # client_db on
  8722.  
  8723. # TAG: refresh_all_ims on|off
  8724. # When you enable this option, squid will always check
  8725. # the origin server for an update when a client sends an
  8726. # If-Modified-Since request. Many browsers use IMS
  8727. # requests when the user requests a reload, and this
  8728. # ensures those clients receive the latest version.
  8729. #
  8730. # By default (off), squid may return a Not Modified response
  8731. # based on the age of the cached version.
  8732. #Default:
  8733. # refresh_all_ims off
  8734.  
  8735. # TAG: reload_into_ims on|off
  8736. # When you enable this option, client no-cache or ``reload''
  8737. # requests will be changed to If-Modified-Since requests.
  8738. # Doing this VIOLATES the HTTP standard. Enabling this
  8739. # feature could make you liable for problems which it
  8740. # causes.
  8741. #
  8742. # see also refresh_pattern for a more selective approach.
  8743. #Default:
  8744. # reload_into_ims off
  8745.  
  8746. # TAG: connect_retries
  8747. # Limits the number of reopening attempts when establishing a single
  8748. # TCP connection. All these attempts must still complete before the
  8749. # applicable connection opening timeout expires.
  8750. #
  8751. # By default and when connect_retries is set to zero, Squid does not
  8752. # retry failed connection opening attempts.
  8753. #
  8754. # The (not recommended) maximum is 10 tries. An attempt to configure a
  8755. # higher value results in the value of 10 being used (with a warning).
  8756. #
  8757. # Squid may open connections to retry various high-level forwarding
  8758. # failures. For an outside observer, that activity may look like a
  8759. # low-level connection reopening attempt, but those high-level retries
  8760. # are governed by forward_max_tries instead.
  8761. #
  8762. # See also: connect_timeout, forward_timeout, icap_connect_timeout,
  8763. # ident_timeout, and forward_max_tries.
  8764. #Default:
  8765. # Do not retry failed connections.
  8766.  
  8767. # TAG: retry_on_error
  8768. # If set to ON Squid will automatically retry requests when
  8769. # receiving an error response with status 403 (Forbidden),
  8770. # 500 (Internal Error), 501 or 503 (Service not available).
  8771. # Status 502 and 504 (Gateway errors) are always retried.
  8772. #
  8773. # This is mainly useful if you are in a complex cache hierarchy to
  8774. # work around access control errors.
  8775. #
  8776. # NOTE: This retry will attempt to find another working destination.
  8777. # Which is different from the server which just failed.
  8778. #Default:
  8779. # retry_on_error off
  8780.  
  8781. # TAG: as_whois_server
  8782. # WHOIS server to query for AS numbers. NOTE: AS numbers are
  8783. # queried only when Squid starts up, not for every request.
  8784. #Default:
  8785. # as_whois_server whois.ra.net
  8786.  
  8787. # TAG: offline_mode
  8788. # Enable this option and Squid will never try to validate cached
  8789. # objects.
  8790. #Default:
  8791. # offline_mode off
  8792.  
  8793. # TAG: uri_whitespace
  8794. # What to do with requests that have whitespace characters in the
  8795. # URI. Options:
  8796. #
  8797. # strip: The whitespace characters are stripped out of the URL.
  8798. # This is the behavior recommended by RFC2396 and RFC3986
  8799. # for tolerant handling of generic URI.
  8800. # NOTE: This is one difference between generic URI and HTTP URLs.
  8801. #
  8802. # deny: The request is denied. The user receives an "Invalid
  8803. # Request" message.
  8804. # This is the behaviour recommended by RFC2616 for safe
  8805. # handling of HTTP request URL.
  8806. #
  8807. # allow: The request is allowed and the URI is not changed. The
  8808. # whitespace characters remain in the URI. Note the
  8809. # whitespace is passed to redirector processes if they
  8810. # are in use.
  8811. # Note this may be considered a violation of RFC2616
  8812. # request parsing where whitespace is prohibited in the
  8813. # URL field.
  8814. #
  8815. # encode: The request is allowed and the whitespace characters are
  8816. # encoded according to RFC1738.
  8817. #
  8818. # chop: The request is allowed and the URI is chopped at the
  8819. # first whitespace.
  8820. #
  8821. #
  8822. # NOTE the current Squid implementation of encode and chop violates
  8823. # RFC2616 by not using a 301 redirect after altering the URL.
  8824. #Default:
  8825. # uri_whitespace strip
  8826.  
  8827. # TAG: chroot
  8828. # Specifies a directory where Squid should do a chroot() while
  8829. # initializing. This also causes Squid to fully drop root
  8830. # privileges after initializing. This means, for example, if you
  8831. # use a HTTP port less than 1024 and try to reconfigure, you may
  8832. # get an error saying that Squid can not open the port.
  8833. #Default:
  8834. # none
  8835.  
  8836. # TAG: pipeline_prefetch
  8837. # HTTP clients may send a pipeline of 1+N requests to Squid using a
  8838. # single connection, without waiting for Squid to respond to the first
  8839. # of those requests. This option limits the number of concurrent
  8840. # requests Squid will try to handle in parallel. If set to N, Squid
  8841. # will try to receive and process up to 1+N requests on the same
  8842. # connection concurrently.
  8843. #
  8844. # Defaults to 0 (off) for bandwidth management and access logging
  8845. # reasons.
  8846. #
  8847. # NOTE: pipelining requires persistent connections to clients.
  8848. #
  8849. # WARNING: pipelining breaks NTLM and Negotiate/Kerberos authentication.
  8850. #Default:
  8851. # Do not pre-parse pipelined requests.
  8852.  
  8853. # TAG: high_response_time_warning (msec)
  8854. # If the one-minute median response time exceeds this value,
  8855. # Squid prints a WARNING with debug level 0 to get the
  8856. # administrators attention. The value is in milliseconds.
  8857. #Default:
  8858. # disabled.
  8859.  
  8860. # TAG: high_page_fault_warning
  8861. # If the one-minute average page fault rate exceeds this
  8862. # value, Squid prints a WARNING with debug level 0 to get
  8863. # the administrators attention. The value is in page faults
  8864. # per second.
  8865. #Default:
  8866. # disabled.
  8867.  
  8868. # TAG: high_memory_warning
  8869. # Note: This option is only available if Squid is rebuilt with the
  8870. # GNU Malloc with mstats()
  8871. #
  8872. # If the memory usage (as determined by gnumalloc, if available and used)
  8873. # exceeds this amount, Squid prints a WARNING with debug level 0 to get
  8874. # the administrators attention.
  8875. #Default:
  8876. # disabled.
  8877.  
  8878. # TAG: sleep_after_fork (microseconds)
  8879. # When this is set to a non-zero value, the main Squid process
  8880. # sleeps the specified number of microseconds after a fork()
  8881. # system call. This sleep may help the situation where your
  8882. # system reports fork() failures due to lack of (virtual)
  8883. # memory. Note, however, if you have a lot of child
  8884. # processes, these sleep delays will add up and your
  8885. # Squid will not service requests for some amount of time
  8886. # until all the child processes have been started.
  8887. # On Windows value less then 1000 (1 milliseconds) are
  8888. # rounded to 1000.
  8889. #Default:
  8890. # sleep_after_fork 0
  8891.  
  8892. # TAG: windows_ipaddrchangemonitor on|off
  8893. # Note: This option is only available if Squid is rebuilt with the
  8894. # MS Windows
  8895. #
  8896. # On Windows Squid by default will monitor IP address changes and will
  8897. # reconfigure itself after any detected event. This is very useful for
  8898. # proxies connected to internet with dial-up interfaces.
  8899. # In some cases (a Proxy server acting as VPN gateway is one) it could be
  8900. # desiderable to disable this behaviour setting this to 'off'.
  8901. # Note: after changing this, Squid service must be restarted.
  8902. #Default:
  8903. # windows_ipaddrchangemonitor on
  8904.  
  8905. # TAG: eui_lookup
  8906. # Whether to lookup the EUI or MAC address of a connected client.
  8907. #Default:
  8908. # eui_lookup on
  8909.  
  8910. # TAG: max_filedescriptors
  8911. # Set the maximum number of filedescriptors, either below the
  8912. # operating system default or up to the hard limit.
  8913. #
  8914. # Remove from squid.conf to inherit the current ulimit soft
  8915. # limit setting.
  8916. #
  8917. # Note: Changing this requires a restart of Squid. Also
  8918. # not all I/O types supports large values (eg on Windows).
  8919. #Default:
  8920. # Use operating system soft limit set by ulimit.
  8921.  
  8922. # TAG: force_request_body_continuation
  8923. # This option controls how Squid handles data upload requests from HTTP
  8924. # and FTP agents that require a "Please Continue" control message response
  8925. # to actually send the request body to Squid. It is mostly useful in
  8926. # adaptation environments.
  8927. #
  8928. # When Squid receives an HTTP request with an "Expect: 100-continue"
  8929. # header or an FTP upload command (e.g., STOR), Squid normally sends the
  8930. # request headers or FTP command information to an adaptation service (or
  8931. # peer) and waits for a response. Most adaptation services (and some
  8932. # broken peers) may not respond to Squid at that stage because they may
  8933. # decide to wait for the HTTP request body or FTP data transfer. However,
  8934. # that request body or data transfer may never come because Squid has not
  8935. # responded with the HTTP 100 or FTP 150 (Please Continue) control message
  8936. # to the request sender yet!
  8937. #
  8938. # An allow match tells Squid to respond with the HTTP 100 or FTP 150
  8939. # (Please Continue) control message on its own, before forwarding the
  8940. # request to an adaptation service or peer. Such a response usually forces
  8941. # the request sender to proceed with sending the body. A deny match tells
  8942. # Squid to delay that control response until the origin server confirms
  8943. # that the request body is needed. Delaying is the default behavior.
  8944. #Default:
  8945. # Deny, unless rules exist in squid.conf.
  8946.  
  8947. # TAG: http_upgrade_request_protocols
  8948. # Controls client-initiated and server-confirmed switching from HTTP to
  8949. # another protocol (or to several protocols) using HTTP Upgrade mechanism
  8950. # defined in RFC 7230 Section 6.7. Squid itself does not understand the
  8951. # protocols being upgraded to and participates in the upgraded
  8952. # communication only as a dumb TCP proxy. Admins should not allow
  8953. # upgrading to protocols that require a more meaningful proxy
  8954. # participation.
  8955. #
  8956. # Usage: http_upgrade_request_protocols <protocol> allow|deny [!]acl ...
  8957. #
  8958. # The required "protocol" parameter is either an all-caps word OTHER or an
  8959. # explicit protocol name (e.g. "WebSocket") optionally followed by a slash
  8960. # and a version token (e.g. "HTTP/3"). Explicit protocol names and
  8961. # versions are case sensitive.
  8962. #
  8963. # When an HTTP client sends an Upgrade request header, Squid iterates over
  8964. # the client-offered protocols and, for each protocol P (with an optional
  8965. # version V), evaluates the first non-empty set of
  8966. # http_upgrade_request_protocols rules (if any) from the following list:
  8967. #
  8968. # * All rules with an explicit protocol name equal to P.
  8969. # * All rules that use OTHER instead of a protocol name.
  8970. #
  8971. # In other words, rules using OTHER are considered for protocol P if and
  8972. # only if there are no rules mentioning P by name.
  8973. #
  8974. # If both of the above sets are empty, then Squid removes protocol P from
  8975. # the Upgrade offer.
  8976. #
  8977. # If the client sent a versioned protocol offer P/X, then explicit rules
  8978. # referring to the same-name but different-version protocol P/Y are
  8979. # declared inapplicable. Inapplicable rules are not evaluated (i.e. are
  8980. # ignored). However, inapplicable rules still belong to the first set of
  8981. # rules for P.
  8982. #
  8983. # Within the applicable rule subset, individual rules are evaluated in
  8984. # their configuration order. If all ACLs of an applicable "allow" rule
  8985. # match, then the protocol offered by the client is forwarded to the next
  8986. # hop as is. If all ACLs of an applicable "deny" rule match, then the
  8987. # offer is dropped. If no applicable rules have matching ACLs, then the
  8988. # offer is also dropped. The first matching rule also ends rules
  8989. # evaluation for the offered protocol.
  8990. #
  8991. # If all client-offered protocols are removed, then Squid forwards the
  8992. # client request without the Upgrade header. Squid never sends an empty
  8993. # Upgrade request header.
  8994. #
  8995. # An Upgrade request header with a value violating HTTP syntax is dropped
  8996. # and ignored without an attempt to use extractable individual protocol
  8997. # offers.
  8998. #
  8999. # Upon receiving an HTTP 101 (Switching Protocols) control message, Squid
  9000. # checks that the server listed at least one protocol name and sent a
  9001. # Connection:upgrade response header. Squid does not understand individual
  9002. # protocol naming and versioning concepts enough to implement stricter
  9003. # checks, but an admin can restrict HTTP 101 (Switching Protocols)
  9004. # responses further using http_reply_access. Responses denied by
  9005. # http_reply_access rules and responses flagged by the internal Upgrade
  9006. # checks result in HTTP 502 (Bad Gateway) ERR_INVALID_RESP errors and
  9007. # Squid-to-server connection closures.
  9008. #
  9009. # If Squid sends an Upgrade request header, and the next hop (e.g., the
  9010. # origin server) responds with an acceptable HTTP 101 (Switching
  9011. # Protocols), then Squid forwards that message to the client and becomes
  9012. # a TCP tunnel.
  9013. #
  9014. # The presence of an Upgrade request header alone does not preclude cache
  9015. # lookups. In other words, an Upgrade request might be satisfied from the
  9016. # cache, using regular HTTP caching rules.
  9017. #
  9018. # This clause only supports fast acl types.
  9019. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  9020. #
  9021. # Each of the following groups of configuration lines represents a
  9022. # separate configuration example:
  9023. #
  9024. # # never upgrade to protocol Foo; all others are OK
  9025. # http_upgrade_request_protocols Foo deny all
  9026. # http_upgrade_request_protocols OTHER allow all
  9027. #
  9028. # # only allow upgrades to protocol Bar (except for its first version)
  9029. # http_upgrade_request_protocols Bar/1 deny all
  9030. # http_upgrade_request_protocols Bar allow all
  9031. # http_upgrade_request_protocols OTHER deny all # this rule is optional
  9032. #
  9033. # # only allow upgrades to protocol Baz, and only if Baz is the only offer
  9034. # acl UpgradeHeaderHasMultipleOffers ...
  9035. # http_upgrade_request_protocols Baz deny UpgradeHeaderHasMultipleOffers
  9036. # http_upgrade_request_protocols Baz allow all
  9037. #Default:
  9038. # Upgrade header dropped, effectively blocking an upgrade attempt.
  9039.  
  9040. # TAG: server_pconn_for_nonretriable
  9041. # This option provides fine-grained control over persistent connection
  9042. # reuse when forwarding HTTP requests that Squid cannot retry. It is useful
  9043. # in environments where opening new connections is very expensive
  9044. # (e.g., all connections are secured with TLS with complex client and server
  9045. # certificate validation) and race conditions associated with persistent
  9046. # connections are very rare and/or only cause minor problems.
  9047. #
  9048. # HTTP prohibits retrying unsafe and non-idempotent requests (e.g., POST).
  9049. # Squid limitations also prohibit retrying all requests with bodies (e.g., PUT).
  9050. # By default, when forwarding such "risky" requests, Squid opens a new
  9051. # connection to the server or cache_peer, even if there is an idle persistent
  9052. # connection available. When Squid is configured to risk sending a non-retriable
  9053. # request on a previously used persistent connection, and the server closes
  9054. # the connection before seeing that risky request, the user gets an error response
  9055. # from Squid. In most cases, that error response will be HTTP 502 (Bad Gateway)
  9056. # with ERR_ZERO_SIZE_OBJECT or ERR_WRITE_ERROR (peer connection reset) error detail.
  9057. #
  9058. # If an allow rule matches, Squid reuses an available idle persistent connection
  9059. # (if any) for the request that Squid cannot retry. If a deny rule matches, then
  9060. # Squid opens a new connection for the request that Squid cannot retry.
  9061. #
  9062. # This option does not affect requests that Squid can retry. They will reuse idle
  9063. # persistent connections (if any).
  9064. #
  9065. # This clause only supports fast acl types.
  9066. # See http://wiki.squid-cache.org/SquidFaq/SquidAcl for details.
  9067. #
  9068. # Example:
  9069. # acl SpeedIsWorthTheRisk method POST
  9070. # server_pconn_for_nonretriable allow SpeedIsWorthTheRisk
  9071. #Default:
  9072. # Open new connections for forwarding requests Squid cannot retry safely.
  9073.  
  9074. # TAG: happy_eyeballs_connect_timeout (msec)
  9075. # This Happy Eyeballs (RFC 8305) tuning directive specifies the minimum
  9076. # delay between opening a primary to-server connection and opening a
  9077. # spare to-server connection for the same master transaction. This delay
  9078. # is similar to the Connection Attempt Delay in RFC 8305, but it is only
  9079. # applied to the first spare connection attempt. Subsequent spare
  9080. # connection attempts use happy_eyeballs_connect_gap, and primary
  9081. # connection attempts are not artificially delayed at all.
  9082. #
  9083. # Terminology: The "primary" and "spare" designations are determined by
  9084. # the order of DNS answers received by Squid: If Squid DNS AAAA query
  9085. # was answered first, then primary connections are connections to IPv6
  9086. # peer addresses (while spare connections use IPv4 addresses).
  9087. # Similarly, if Squid DNS A query was answered first, then primary
  9088. # connections are connections to IPv4 peer addresses (while spare
  9089. # connections use IPv6 addresses).
  9090. #
  9091. # Shorter happy_eyeballs_connect_timeout values reduce master
  9092. # transaction response time, potentially improving user-perceived
  9093. # response times (i.e., making user eyeballs happier). Longer delays
  9094. # reduce both concurrent connection level and server bombardment with
  9095. # connection requests, potentially improving overall Squid performance
  9096. # and reducing the chance of being blocked by servers for opening too
  9097. # many unused connections.
  9098. #
  9099. # RFC 8305 prohibits happy_eyeballs_connect_timeout values smaller than
  9100. # 10 (milliseconds) to "avoid congestion collapse in the presence of
  9101. # high packet-loss rates".
  9102. #
  9103. # The following Happy Eyeballs directives place additional connection
  9104. # opening restrictions: happy_eyeballs_connect_gap and
  9105. # happy_eyeballs_connect_limit.
  9106. #Default:
  9107. # happy_eyeballs_connect_timeout 250
  9108.  
  9109. # TAG: happy_eyeballs_connect_gap (msec)
  9110. # This Happy Eyeballs (RFC 8305) tuning directive specifies the
  9111. # minimum delay between opening spare to-server connections (to any
  9112. # server; i.e. across all concurrent master transactions in a Squid
  9113. # instance). Each SMP worker currently multiplies the configured gap
  9114. # by the total number of workers so that the combined spare connection
  9115. # opening rate of a Squid instance obeys the configured limit. The
  9116. # workers do not coordinate connection openings yet; a micro burst
  9117. # of spare connection openings may violate the configured gap.
  9118. #
  9119. # This directive has similar trade-offs as
  9120. # happy_eyeballs_connect_timeout, but its focus is on limiting traffic
  9121. # amplification effects for Squid as a whole, while
  9122. # happy_eyeballs_connect_timeout works on an individual master
  9123. # transaction level.
  9124. #
  9125. # The following Happy Eyeballs directives place additional connection
  9126. # opening restrictions: happy_eyeballs_connect_timeout and
  9127. # happy_eyeballs_connect_limit. See the former for related terminology.
  9128. #Default:
  9129. # no artificial delays between spare attempts
  9130.  
  9131. # TAG: happy_eyeballs_connect_limit
  9132. # This Happy Eyeballs (RFC 8305) tuning directive specifies the
  9133. # maximum number of spare to-server connections (to any server; i.e.
  9134. # across all concurrent master transactions in a Squid instance).
  9135. # Each SMP worker gets an equal share of the total limit. However,
  9136. # the workers do not share the actual connection counts yet, so one
  9137. # (busier) worker cannot "borrow" spare connection slots from another
  9138. # (less loaded) worker.
  9139. #
  9140. # Setting this limit to zero disables concurrent use of primary and
  9141. # spare TCP connections: Spare connection attempts are made only after
  9142. # all primary attempts fail. However, Squid would still use the
  9143. # DNS-related optimizations of the Happy Eyeballs approach.
  9144. #
  9145. # This directive has similar trade-offs as happy_eyeballs_connect_gap,
  9146. # but its focus is on limiting Squid overheads, while
  9147. # happy_eyeballs_connect_gap focuses on the origin server and peer
  9148. # overheads.
  9149. #
  9150. # The following Happy Eyeballs directives place additional connection
  9151. # opening restrictions: happy_eyeballs_connect_timeout and
  9152. # happy_eyeballs_connect_gap. See the former for related terminology.
  9153. #Default:
  9154. # no artificial limit on the number of concurrent spare attempts
  9155.  
  9156.  
Add Comment
Please, Sign In to add comment