From: hno <> Date: Mon, 25 Jun 2007 15:29:29 +0000 (+0000) Subject: Sort config options to match Squid-2. X-Git-Tag: SQUID_3_0_PRE7~199 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=8d6275c04a48aaca952bf262534e228cbcaed3e2;p=thirdparty%2Fsquid.git Sort config options to match Squid-2. --- diff --git a/src/cf.data.pre b/src/cf.data.pre index 35ee11879b..06ff6e9db8 100644 --- a/src/cf.data.pre +++ b/src/cf.data.pre @@ -1,7 +1,6 @@ # -# $Id: cf.data.pre,v 1.439 2007/06/19 21:03:45 rousskov Exp $ -# +# $Id: cf.data.pre,v 1.440 2007/06/25 09:29:29 hno Exp $ # # SQUID Web Proxy Cache http://www.squid-cache.org/ # ---------------------------------------------------------- @@ -123,6 +122,7 @@ DOC_START and an external interface we recommend you to specify the internal address:port in http_port. This way Squid will only be visible on the internal address. + NOCOMMENT_START # Squid normally listens to port 3128 http_port @DEFAULT_HTTP_PORT@ @@ -364,7 +364,6 @@ DOC_START "0". DOC_END - NAME: mcast_groups TYPE: wordlist LOC: Config.mcast_group_list @@ -392,7 +391,6 @@ DOC_START By default, Squid doesn't listen on any multicast groups. DOC_END - NAME: udp_incoming_address TYPE: address LOC:Config.Addrs.udp_incoming @@ -716,7 +714,6 @@ DOC_START section. DOC_END - NAME: neighbor_type_domain TYPE: hostdomaintype DEFAULT: none @@ -817,7 +814,6 @@ DOC_START instead of to your parents. DOC_END - NAME: hierarchy_stoplist TYPE: wordlist DEFAULT: none @@ -833,7 +829,6 @@ hierarchy_stoplist cgi-bin ? NOCOMMENT_END DOC_END - NAME: cache no_cache TYPE: acl_access DEFAULT: none @@ -864,7 +859,6 @@ DOC_START have background-ping set. DOC_END - COMMENT_START OPTIONS WHICH AFFECT THE CACHE SIZE ----------------------------------------------------------------------------- @@ -907,7 +901,6 @@ DOC_START objects. DOC_END - NAME: cache_swap_low COMMENT: (percent, 0-100) TYPE: int @@ -1058,7 +1051,6 @@ DOC_START See cache_replacement_policy for details. DOC_END - COMMENT_START LOGFILE PATHNAMES AND CACHE DIRECTORIES ----------------------------------------------------------------------------- @@ -1174,7 +1166,6 @@ DOC_START no options are allowed or required DOC_END - NAME: logformat TYPE: logformat LOC: Config.Log.logformats @@ -1279,7 +1270,6 @@ DOC_START LOG_ERR, LOG_WARNING, LOG_NOTICE, LOG_INFO, LOG_DEBUG. DOC_END - NAME: cache_log TYPE: string DEFAULT: @DEFAULT_CACHE_LOG@ @@ -1290,7 +1280,6 @@ DOC_START logged to this file with the "debug_options" tag below. DOC_END - NAME: cache_store_log TYPE: string DEFAULT: @DEFAULT_STORE_LOG@ @@ -1303,7 +1292,6 @@ DOC_START disable it. DOC_END - NAME: cache_swap_state cache_swap_log TYPE: string LOC: Config.Log.swap @@ -1338,7 +1326,6 @@ DOC_START better to keep these log files in each 'cache_dir' directory. DOC_END - NAME: emulate_httpd_log COMMENT: on|off TYPE: onoff @@ -1373,7 +1360,6 @@ DOC_START information if you do. DOC_END - NAME: log_mime_hdrs COMMENT: on|off TYPE: onoff @@ -1387,7 +1373,6 @@ DOC_START formats). To enable this logging set log_mime_hdrs to 'on'. DOC_END - NAME: useragent_log TYPE: string LOC: Config.Log.useragent @@ -1399,7 +1384,6 @@ DOC_START is disabled. DOC_END - NAME: referer_log TYPE: string LOC: Config.Log.referer @@ -1410,7 +1394,6 @@ DOC_START filename specified here. By default referer_log is disabled. DOC_END - NAME: pid_filename TYPE: string DEFAULT: @DEFAULT_PID_FILE@ @@ -1419,7 +1402,6 @@ DOC_START A filename to write the process-id to. To disable, enter "none". DOC_END - NAME: debug_options TYPE: debug DEFAULT: ALL,1 @@ -1433,7 +1415,6 @@ DOC_START "ALL,1". DOC_END - NAME: log_fqdn COMMENT: on|off TYPE: onoff @@ -1447,7 +1428,6 @@ DOC_START browsing. DOC_END - NAME: client_netmask TYPE: address LOC: Config.Addrs.client_netmask @@ -1459,7 +1439,6 @@ DOC_START the last digit set to '0'. DOC_END - COMMENT_START OPTIONS FOR EXTERNAL SUPPORT PROGRAMS ----------------------------------------------------------------------------- @@ -1512,6 +1491,23 @@ DOC_START connection turn this off. DOC_END +NAME: ftp_telnet_protocol +TYPE: onoff +DEFAULT: on +LOC: Config.Ftp.telnet +DOC_START +The FTP protocol is officially defined to use the telnet protocol +as transport channel for the control connection. However, many +implementations are broken and does not respect this aspect of +the FTP protocol. + +If you have trouble accessing files with ASCII code 255 in the +path or similar problems involving this ASCII code you can +try setting this directive to off. If that helps, report to the +operator of the FTP server in question that their FTP server +is broken and does not follow the FTP standard. +DOC_END + NAME: check_hostnames TYPE: onoff DEFAULT: off @@ -1533,23 +1529,6 @@ DOC_START This check is performed only when check_hostnames is set to on. DOC_END -NAME: ftp_telnet_protocol -TYPE: onoff -DEFAULT: on -LOC: Config.Ftp.telnet -DOC_START -The FTP protocol is officially defined to use the telnet protocol -as transport channel for the control connection. However, many -implementations are broken and does not respect this aspect of -the FTP protocol. - -If you have trouble accessing files with ASCII code 255 in the -path or similar problems involving this ASCII code you can -try setting this directive to off. If that helps, report to the -operator of the FTP server in question that their FTP server -is broken and does not follow the FTP standard. -DOC_END - NAME: cache_dns_program TYPE: string IFDEF: USE_DNSSERVERS @@ -1680,7 +1659,6 @@ DOC_START Specify the location of the executable for the pinger process. DOC_END - NAME: url_rewrite_program redirect_program TYPE: wordlist LOC: Config.Program.redirect @@ -1692,7 +1670,6 @@ DOC_START By default, a redirector is not used. DOC_END - NAME: url_rewrite_children redirect_children TYPE: int DEFAULT: 5 @@ -1727,7 +1704,7 @@ DOC_START process, so be careful if you have domain-virtual hosts. DOC_END -NAME: redirector_access +NAME: url_rewrite_access redirector_access TYPE: acl_access DEFAULT: none LOC: Config.accessList.redirector @@ -1848,7 +1825,6 @@ DOC_START auth_param digest program @DEFAULT_PREFIX@/bin/digest_auth_pw @DEFAULT_PREFIX@/etc/digpass - "children" numberofchildren The number of authenticator processes to spawn (no default). If you start too few Squid will have to wait for them to @@ -2306,7 +2282,6 @@ DOC_START negative caching of DNS lookups. DOC_END - NAME: positive_dns_ttl COMMENT: time-units TYPE: time_t @@ -2318,7 +2293,6 @@ DOC_START use of Squid's ipcache, set this to 1, not 0. DOC_END - NAME: negative_dns_ttl COMMENT: time-units TYPE: time_t @@ -2350,7 +2324,6 @@ DOC_START client requested. (default) DOC_END - COMMENT_START TIMEOUTS ----------------------------------------------------------------------------- @@ -2402,7 +2375,6 @@ DOC_START default is 15 minutes. DOC_END - NAME: request_timeout TYPE: time_t LOC: Config.Timeout.request @@ -2412,7 +2384,6 @@ DOC_START connection establishment. DOC_END - NAME: persistent_request_timeout TYPE: time_t LOC: Config.Timeout.persistent_request @@ -2422,7 +2393,6 @@ DOC_START connection after the previous request completes. DOC_END - NAME: client_lifetime COMMENT: time-units TYPE: time_t @@ -2482,7 +2452,6 @@ DOC_START many ident requests going at once. DOC_END - NAME: shutdown_lifetime COMMENT: time-units TYPE: time_t @@ -2756,19 +2725,8 @@ DOC_START If none of the access lines cause a match the opposite of the last line will apply. Thus it is good practice to end the rules with an "allow all" or "deny all" entry. - -NOCOMMENT_START -#Recommended minimum configuration: -# -# Insert your own rules here. -# -# -# and finally allow by default -http_reply_access allow all -NOCOMMENT_END DOC_END - NAME: icp_access TYPE: acl_access LOC: Config.accessList.icp @@ -2788,7 +2746,6 @@ icp_access allow all NOCOMMENT_END DOC_END - NAME: htcp_access IFDEF: USE_HTCP TYPE: acl_access @@ -2826,7 +2783,6 @@ acl htcp_clr_peer src 172.16.1.2 htcp_clr_access allow htcp_clr_peer DOC_END - NAME: miss_access TYPE: acl_access LOC: Config.accessList.miss @@ -2851,7 +2807,6 @@ NOCOMMENT_START NOCOMMENT_END DOC_END - NAME: cache_peer_access TYPE: peer_access DEFAULT: none @@ -3031,7 +2986,6 @@ DOC_START mail if the cache dies. The default is "webmaster." DOC_END - NAME: mail_from TYPE: string DEFAULT: none @@ -3043,7 +2997,6 @@ DOC_START src/globals.h before building squid. DOC_END - NAME: mail_program TYPE: eol DEFAULT: mail @@ -3056,7 +3009,6 @@ DOC_START Optional command line options can be specified. DOC_END - NAME: cache_effective_user TYPE: string DEFAULT: nobody @@ -3071,7 +3023,6 @@ DOC_START cache_effective_user. DOC_END - NAME: cache_effective_group TYPE: string DEFAULT: none @@ -3086,7 +3037,6 @@ DOC_START group. DOC_END - NAME: httpd_suppress_version_string COMMENT: on|off TYPE: onoff @@ -3096,7 +3046,6 @@ DOC_START Suppress Squid version string info in HTTP headers and HTML error pages. DOC_END - NAME: visible_hostname TYPE: string LOC: Config.visibleHostname @@ -3109,7 +3058,6 @@ DOC_START names with this setting. DOC_END - NAME: unique_hostname TYPE: string LOC: Config.uniqueHostname @@ -3120,7 +3068,6 @@ DOC_START 'unique_hostname' so forwarding loops can be detected. DOC_END - NAME: hostname_aliases TYPE: wordlist LOC: Config.hostnameAliases @@ -3171,7 +3118,6 @@ NOCOMMENT_START NOCOMMENT_END DOC_END - NAME: announce_host TYPE: string DEFAULT: tracker.ircache.net @@ -3198,6 +3144,11 @@ DOC_START message. DOC_END +COMMENT_START + HTTPD-ACCELERATOR OPTIONS + ----------------------------------------------------------------------------- +COMMENT_END + NAME: httpd_accel_surrogate_id IFDEF: ESI TYPE: string @@ -3233,9 +3184,8 @@ DOC_START encodings. DOC_END - COMMENT_START - DELAY POOL PARAMETERS (all require DELAY_POOLS compilation option) + DELAY POOL PARAMETERS ----------------------------------------------------------------------------- COMMENT_END @@ -3416,121 +3366,435 @@ DOC_START "seen" by squid). DOC_END - COMMENT_START - MISCELLANEOUS + WCCPv1 AND WCCPv2 CONFIGURATION OPTIONS ----------------------------------------------------------------------------- COMMENT_END -NAME: dns_testnames -TYPE: wordlist -LOC: Config.dns_testname_list +NAME: wccp_router +TYPE: address +LOC: Config.Wccp.router +DEFAULT: 0.0.0.0 +IFDEF: USE_WCCP +DOC_NONE +NAME: wccp2_router +TYPE: sockaddr_in_list +LOC: Config.Wccp2.router DEFAULT: none -DEFAULT_IF_NONE: netscape.com internic.net nlanr.net microsoft.com +IFDEF: USE_WCCPv2 DOC_START - The DNS tests exit as soon as the first site is successfully looked up + Use this option to define your WCCP ``home'' router for + Squid. - This test can be disabled with the -D command line option. -DOC_END + wccp_router supports a single WCCP(v1) router + wccp2_router supports multiple WCCPv2 routers -NAME: logfile_rotate + only one of the two may be used at the same time and defines + which version of WCCP to use. +DOC_END + +NAME: wccp_version TYPE: int -DEFAULT: 10 -LOC: Config.Log.rotateNumber +LOC: Config.Wccp.version +DEFAULT: 4 +IFDEF: USE_WCCP DOC_START - Specifies the number of logfile rotations to make when you - type 'squid -k rotate'. The default is 10, which will rotate - with extensions 0 through 9. Setting logfile_rotate to 0 will - disable the file name rotation, but the logfiles are still closed - and re-opened. This will enable you to rename the logfiles - yourself just before sending the rotate signal. + This directive is only relevant if you need to set up WCCP(v1) + to some very old and end-of-life Cisco routers. In all other + setups it must be left unset or at the default setting. + It defines an internal version in the WCCP(v1) protocol, + with version 4 being the officially documented protocol. - Note, the 'squid -k rotate' command normally sends a USR1 - signal to the running squid process. In certain situations - (e.g. on Linux with Async I/O), USR1 is used for other - purposes, so -k rotate uses another signal. It is best to get - in the habit of using 'squid -k rotate' instead of 'kill -USR1 - '. + According to some users, Cisco IOS 11.2 and earlier only + support WCCP version 3. If you're using that or an earlier + version of IOS, you may need to change this value to 3, otherwise + do not specify this parameter. DOC_END +NAME: wccp2_rebuild_wait +TYPE: onoff +LOC: Config.Wccp2.rebuildwait +DEFAULT: on +IFDEF: USE_WCCPv2 +DOC_START + If this is enabled Squid will wait for the cache dir rebuild to finish + before sending the first wccp2 HereIAm packet +DOC_END -NAME: append_domain -TYPE: string -LOC: Config.appendDomain -DEFAULT: none +NAME: wccp2_forwarding_method +TYPE: int +LOC: Config.Wccp2.forwarding_method +DEFAULT: 1 +IFDEF: USE_WCCPv2 DOC_START - Appends local domain name to hostnames without any dots in - them. append_domain must begin with a period. + WCCP2 allows the setting of forwarding methods between the + router/switch and the cache. Valid values are as follows: - Be warned there are now Internet names with no dots in - them using only top-domain names, so setting this may - cause some Internet sites to become unavailable. + 1 - GRE encapsulation (forward the packet in a GRE/WCCP tunnel) + 2 - L2 redirect (forward the packet using Layer 2/MAC rewriting) -Example: - append_domain .yourdomain.com + Currently (as of IOS 12.4) cisco routers only support GRE. + Cisco switches only support the L2 redirect assignment method. DOC_END - -NAME: tcp_recv_bufsize -COMMENT: (bytes) -TYPE: b_size_t -DEFAULT: 0 bytes -LOC: Config.tcpRcvBufsz +NAME: wccp2_return_method +TYPE: int +LOC: Config.Wccp2.return_method +DEFAULT: 1 +IFDEF: USE_WCCPv2 DOC_START - Size of receive buffer to set for TCP sockets. Probably just - as easy to change your kernel's default. Set to zero to use - the default buffer size. -DOC_END + WCCP2 allows the setting of return methods between the + router/switch and the cache for packets that the cache + decides not to handle. Valid values are as follows: -NAME: err_html_text -TYPE: eol -LOC: Config.errHtmlText -DEFAULT: none -DOC_START - HTML text to include in error messages. Make this a "mailto" - URL to your admin address, or maybe just a link to your - organizations Web page. + 1 - GRE encapsulation (forward the packet in a GRE/WCCP tunnel) + 2 - L2 redirect (forward the packet using Layer 2/MAC rewriting) - To include this in your error messages, you must rewrite - the error template files (found in the "errors" directory). - Wherever you want the 'err_html_text' line to appear, - insert a %L tag in the error template file. -DOC_END + Currently (as of IOS 12.4) cisco routers only support GRE. + Cisco switches only support the L2 redirect assignment. -NAME: email_err_data -COMMENT: on|off -TYPE: onoff -LOC: Config.onoff.emailErrData -DEFAULT: on -DOC_START - If enabled, information about the occurred error will be - included in the mailto links of the ERR pages (if %W is set) - so that the email body contains the data. - Syntax is %w + If the "ip wccp redirect exclude in" command has been + enabled on the cache interface, then it is still safe for + the proxy server to use a l2 redirect method even if this + option is set to GRE. DOC_END - -NAME: deny_info -TYPE: denyinfo -LOC: Config.denyInfoList -DEFAULT: none +NAME: wccp2_assignment_method +TYPE: int +LOC: Config.Wccp2.assignment_method +DEFAULT: 1 +IFDEF: USE_WCCPv2 DOC_START - Usage: deny_info err_page_name acl - or deny_info http://... acl - Example: deny_info ERR_CUSTOM_ACCESS_DENIED bad_guys + WCCP2 allows the setting of methods to assign the WCCP hash + Valid values are as follows: - This can be used to return a ERR_ page for requests which - do not pass the 'http_access' rules. A single ACL will cause - the http_access check to fail. If a 'deny_info' line exists - for that ACL Squid returns a corresponding error page. + 1 - Hash assignment + 2 - Mask assignment - You may use ERR_ pages that come with Squid or create your own pages - and put them into the configured errors/ directory. + As a general rule, cisco routers support the hash assignment method + and cisco switches support the mask assignment method. +DOC_END - Alternatively you can specify an error URL. The browsers will - get redirected (302) to the specified URL. %s in the redirection - URL will be replaced by the requested URL. +NAME: wccp2_service +TYPE: wccp2_service +LOC: Config.Wccp2.info +DEFAULT: none +DEFAULT_IF_NONE: standard 0 +IFDEF: USE_WCCPv2 +DOC_START + WCCP2 allows for multiple traffic services. There are two + types: "standard" and "dynamic". The standard type defines + one service id - http (id 0). The dynamic service ids can be from + 51 to 255 inclusive. In order to use a dynamic service id + one must define the type of traffic to be redirected; this is done + using the wccp2_service_info option. + + The "standard" type does not require a wccp2_service_info option, + just specifying the service id will suffice. + + MD5 service authentication can be enabled by adding + "password=" to the end of this service declaration. + + Examples: + + wccp2_service standard 0 # for the 'web-cache' standard service + wccp2_service dynamic 80 # a dynamic service type which will be + # fleshed out with subsequent options. + wccp2_service standard 0 password=foo + +DOC_END + +NAME: wccp2_service_info +TYPE: wccp2_service_info +LOC: Config.Wccp2.info +DEFAULT: none +IFDEF: USE_WCCPv2 +DOC_START + Dynamic WCCPv2 services require further information to define the + traffic you wish to have diverted. + + The format is: + + wccp2_service_info protocol= flags=,.. + priority= ports=,.. + + The relevant WCCPv2 flags: + + src_ip_hash, dst_ip_hash + + source_port_hash, dest_port_hash + + src_ip_alt_hash, dst_ip_alt_hash + + src_port_alt_hash, dst_port_alt_hash + + ports_source + + The port list can be one to eight entries. + + Example: + + wccp2_service_info 80 protocol=tcp flags=src_ip_hash,ports_source + priority=240 ports=80 + + Note: the service id must have been defined by a previous + 'wccp2_service dynamic ' entry. +DOC_END + +NAME: wccp2_weight +TYPE: int +LOC: Config.Wccp2.weight +DEFAULT: 10000 +IFDEF: USE_WCCPv2 +DOC_START + Each cache server gets assigned a set of the destination + hash proportional to their weight. +DOC_END + +NAME: wccp_address +TYPE: address +LOC: Config.Wccp.address +DEFAULT: 0.0.0.0 +IFDEF: USE_WCCP +DOC_NONE +NAME: wccp2_address +TYPE: address +LOC: Config.Wccp2.address +DEFAULT: 0.0.0.0 +IFDEF: USE_WCCPv2 +DOC_START + Use this option if you require WCCP to use a specific + interface address. + + The default behavior is to not bind to any specific address. +DOC_END + +COMMENT_START + PERSISTENT CONNECTION HANDLING + ----------------------------------------------------------------------------- + + Also see "pconn_timeout" in the TIMEOUTS section +COMMENT_END + +NAME: client_persistent_connections +TYPE: onoff +LOC: Config.onoff.client_pconns +DEFAULT: on +DOC_NONE + +NAME: server_persistent_connections +TYPE: onoff +LOC: Config.onoff.server_pconns +DEFAULT: on +DOC_START + Persistent connection support for clients and servers. By + default, Squid uses persistent connections (when allowed) + with its clients and servers. You can use these options to + disable persistent connections with clients and/or servers. +DOC_END + +NAME: persistent_connection_after_error +TYPE: onoff +LOC: Config.onoff.error_pconns +DEFAULT: off +DOC_START + With this directive the use of persistent connections after + HTTP errors can be disabled. Useful if you have clients + who fail to handle errors on persistent connections proper. +DOC_END + +NAME: detect_broken_pconn +TYPE: onoff +LOC: Config.onoff.detect_broken_server_pconns +DEFAULT: off +DOC_START + Some servers have been found to incorrectly signal the use + of HTTP/1.0 persistent connections even on replies not + compatible, causing significant delays. This server problem + has mostly been seen on redirects. + + By enabling this directive Squid attempts to detect such + broken replies and automatically assume the reply is finished + after 10 seconds timeout. +DOC_END + +COMMENT_START + CACHE DIGEST OPTIONS + ----------------------------------------------------------------------------- +COMMENT_END + +NAME: digest_generation +IFDEF: USE_CACHE_DIGESTS +TYPE: onoff +LOC: Config.onoff.digest_generation +DEFAULT: on +DOC_START + This controls whether the server will generate a Cache Digest + of its contents. By default, Cache Digest generation is + enabled if Squid is compiled with USE_CACHE_DIGESTS defined. +DOC_END + +NAME: digest_bits_per_entry +IFDEF: USE_CACHE_DIGESTS +TYPE: int +LOC: Config.digest.bits_per_entry +DEFAULT: 5 +DOC_START + This is the number of bits of the server's Cache Digest which + will be associated with the Digest entry for a given HTTP + Method and URL (public key) combination. The default is 5. +DOC_END + +NAME: digest_rebuild_period +IFDEF: USE_CACHE_DIGESTS +COMMENT: (seconds) +TYPE: time_t +LOC: Config.digest.rebuild_period +DEFAULT: 1 hour +DOC_START + This is the number of seconds between Cache Digest rebuilds. +DOC_END + +NAME: digest_rewrite_period +COMMENT: (seconds) +IFDEF: USE_CACHE_DIGESTS +TYPE: time_t +LOC: Config.digest.rewrite_period +DEFAULT: 1 hour +DOC_START + This is the number of seconds between Cache Digest writes to + disk. +DOC_END + +NAME: digest_swapout_chunk_size +COMMENT: (bytes) +TYPE: b_size_t +IFDEF: USE_CACHE_DIGESTS +LOC: Config.digest.swapout_chunk_size +DEFAULT: 4096 bytes +DOC_START + This is the number of bytes of the Cache Digest to write to + disk at a time. It defaults to 4096 bytes (4KB), the Squid + default swap page. +DOC_END + +NAME: digest_rebuild_chunk_percentage +COMMENT: (percent, 0-100) +IFDEF: USE_CACHE_DIGESTS +TYPE: int +LOC: Config.digest.rebuild_chunk_percentage +DEFAULT: 10 +DOC_START + This is the percentage of the Cache Digest to be scanned at a + time. By default it is set to 10% of the Cache Digest. +DOC_END + +COMMENT_START + MISCELLANEOUS + ----------------------------------------------------------------------------- +COMMENT_END + +NAME: dns_testnames +TYPE: wordlist +LOC: Config.dns_testname_list +DEFAULT: none +DEFAULT_IF_NONE: netscape.com internic.net nlanr.net microsoft.com +DOC_START + The DNS tests exit as soon as the first site is successfully looked up + + This test can be disabled with the -D command line option. +DOC_END + +NAME: logfile_rotate +TYPE: int +DEFAULT: 10 +LOC: Config.Log.rotateNumber +DOC_START + Specifies the number of logfile rotations to make when you + type 'squid -k rotate'. The default is 10, which will rotate + with extensions 0 through 9. Setting logfile_rotate to 0 will + disable the file name rotation, but the logfiles are still closed + and re-opened. This will enable you to rename the logfiles + yourself just before sending the rotate signal. + + Note, the 'squid -k rotate' command normally sends a USR1 + signal to the running squid process. In certain situations + (e.g. on Linux with Async I/O), USR1 is used for other + purposes, so -k rotate uses another signal. It is best to get + in the habit of using 'squid -k rotate' instead of 'kill -USR1 + '. +DOC_END + +NAME: append_domain +TYPE: string +LOC: Config.appendDomain +DEFAULT: none +DOC_START + Appends local domain name to hostnames without any dots in + them. append_domain must begin with a period. + + Be warned there are now Internet names with no dots in + them using only top-domain names, so setting this may + cause some Internet sites to become unavailable. + +Example: + append_domain .yourdomain.com +DOC_END + +NAME: tcp_recv_bufsize +COMMENT: (bytes) +TYPE: b_size_t +DEFAULT: 0 bytes +LOC: Config.tcpRcvBufsz +DOC_START + Size of receive buffer to set for TCP sockets. Probably just + as easy to change your kernel's default. Set to zero to use + the default buffer size. +DOC_END + +NAME: err_html_text +TYPE: eol +LOC: Config.errHtmlText +DEFAULT: none +DOC_START + HTML text to include in error messages. Make this a "mailto" + URL to your admin address, or maybe just a link to your + organizations Web page. + + To include this in your error messages, you must rewrite + the error template files (found in the "errors" directory). + Wherever you want the 'err_html_text' line to appear, + insert a %L tag in the error template file. +DOC_END + +NAME: email_err_data +COMMENT: on|off +TYPE: onoff +LOC: Config.onoff.emailErrData +DEFAULT: on +DOC_START + If enabled, information about the occurred error will be + included in the mailto links of the ERR pages (if %W is set) + so that the email body contains the data. + Syntax is %w +DOC_END + +NAME: deny_info +TYPE: denyinfo +LOC: Config.denyInfoList +DEFAULT: none +DOC_START + Usage: deny_info err_page_name acl + or deny_info http://... acl + Example: deny_info ERR_CUSTOM_ACCESS_DENIED bad_guys + + This can be used to return a ERR_ page for requests which + do not pass the 'http_access' rules. A single ACL will cause + the http_access check to fail. If a 'deny_info' line exists + for that ACL Squid returns a corresponding error page. + + You may use ERR_ pages that come with Squid or create your own pages + and put them into the configured errors/ directory. + + Alternatively you can specify an error URL. The browsers will + get redirected (302) to the specified URL. %s in the redirection + URL will be replaced by the requested URL. Alternatively you can tell Squid to reset the TCP connection by specifying TCP_RESET. @@ -3631,7 +3895,6 @@ DOC_START on their cache_peer lines for connecting to you. DOC_END - NAME: minimum_direct_hops TYPE: int DEFAULT: 4 @@ -3744,7 +4007,6 @@ DOC_START turn off client_db here. DOC_END - NAME: netdb_low TYPE: int DEFAULT: 900 @@ -3762,7 +4024,6 @@ DOC_START entries will be deleted until the low mark is reached. DOC_END - NAME: netdb_ping_period TYPE: time_t LOC: Config.Netdb.period @@ -3773,7 +4034,6 @@ DOC_START network. The default is five minutes. DOC_END - NAME: query_icmp COMMENT: on|off TYPE: onoff @@ -4127,308 +4387,113 @@ LOC: Config.errorDirectory DEFAULT: @DEFAULT_ERROR_DIR@ DOC_START If you wish to create your own versions of the default - (English) error files, either to customize them to suit your - language or company copy the template English files to another - directory and point this tag at them. -DOC_END - -NAME: maximum_single_addr_tries -TYPE: int -LOC: Config.retry.maxtries -DEFAULT: 1 -DOC_START - This sets the maximum number of connection attempts for a - host that only has one address (for multiple-address hosts, - each address is tried once). - - The default value is one attempt, the (not recommended) - maximum is 255 tries. A warning message will be generated - if it is set to a value greater than ten. - - Note: This is in addition to the request re-forwarding which - takes place if Squid fails to get a satisfying response. -DOC_END - -NAME: retry_on_error -TYPE: onoff -LOC: Config.retry.onerror -DEFAULT: off -DOC_START - If set to on Squid will automatically retry requests when - receiving an error response. This is mainly useful if you - are in a complex cache hierarchy to work around access - control errors. -DOC_END - -NAME: snmp_port -TYPE: ushort -LOC: Config.Port.snmp -DEFAULT: 3401 -IFDEF: SQUID_SNMP -DOC_START - Squid can now serve statistics and status information via SNMP. - By default it listens to port 3401 on the machine. If you don't - wish to use SNMP, set this to "0". - - Note: If you want Squid to use parents for all requests see - the never_direct directive. prefer_direct only modifies how Squid - acts on cachable requests. -DOC_END - -NAME: snmp_access -TYPE: acl_access -LOC: Config.accessList.snmp -DEFAULT: none -DEFAULT_IF_NONE: deny all -IFDEF: SQUID_SNMP -DOC_START - Allowing or denying access to the SNMP port. - - All access to the agent is denied by default. - usage: - - snmp_access allow|deny [!]aclname ... - -Example: - snmp_access allow snmppublic localhost - snmp_access deny all -DOC_END - -NAME: snmp_incoming_address -TYPE: address -LOC: Config.Addrs.snmp_incoming -DEFAULT: 0.0.0.0 -IFDEF: SQUID_SNMP -DOC_NONE -NAME: snmp_outgoing_address -TYPE: address -LOC: Config.Addrs.snmp_outgoing -DEFAULT: 255.255.255.255 -IFDEF: SQUID_SNMP -DOC_START - Just like 'udp_incoming_address' above, but for the SNMP port. - - snmp_incoming_address is used for the SNMP socket receiving - messages from SNMP agents. - snmp_outgoing_address is used for SNMP packets returned to SNMP - agents. - - The default snmp_incoming_address (0.0.0.0) is to listen on all - available network interfaces. - - If snmp_outgoing_address is set to 255.255.255.255 (the default) - it will use the same socket as snmp_incoming_address. Only - change this if you want to have SNMP replies sent using another - address than where this Squid listens for SNMP queries. - - NOTE, snmp_incoming_address and snmp_outgoing_address can not have - the same value since they both use port 3401. -DOC_END - -NAME: as_whois_server -TYPE: string -LOC: Config.as_whois_server -DEFAULT: whois.ra.net -DEFAULT_IF_NONE: whois.ra.net -DOC_START - WHOIS server to query for AS numbers. NOTE: AS numbers are - queried only when Squid starts up, not for every request. -DOC_END - -NAME: wccp_router -TYPE: address -LOC: Config.Wccp.router -DEFAULT: 0.0.0.0 -IFDEF: USE_WCCP -DOC_NONE -NAME: wccp2_router -TYPE: sockaddr_in_list -LOC: Config.Wccp2.router -DEFAULT: none -IFDEF: USE_WCCPv2 -DOC_START - Use this option to define your WCCP ``home'' router for - Squid. - - wccp_router supports a single WCCP(v1) router - - wccp2_router supports multiple WCCPv2 routers - - only one of the two may be used at the same time and defines - which version of WCCP to use. -DOC_END - -NAME: wccp_version -TYPE: int -LOC: Config.Wccp.version -DEFAULT: 4 -IFDEF: USE_WCCP -DOC_START - This directive is only relevant if you need to set up WCCP(v1) - to some very old and end-of-life Cisco routers. In all other - setups it must be left unset or at the default setting. - It defines an internal version in the WCCP(v1) protocol, - with version 4 being the officially documented protocol. - - According to some users, Cisco IOS 11.2 and earlier only - support WCCP version 3. If you're using that or an earlier - version of IOS, you may need to change this value to 3, otherwise - do not specify this parameter. -DOC_END - -NAME: wccp2_rebuild_wait -TYPE: onoff -LOC: Config.Wccp2.rebuildwait -DEFAULT: on -IFDEF: USE_WCCPv2 -DOC_START - If this is enabled Squid will wait for the cache dir rebuild to finish - before sending the first wccp2 HereIAm packet -DOC_END - -NAME: wccp2_forwarding_method -TYPE: int -LOC: Config.Wccp2.forwarding_method -DEFAULT: 1 -IFDEF: USE_WCCPv2 -DOC_START - WCCP2 allows the setting of forwarding methods between the - router/switch and the cache. Valid values are as follows: - - 1 - GRE encapsulation (forward the packet in a GRE/WCCP tunnel) - 2 - L2 redirect (forward the packet using Layer 2/MAC rewriting) - - Currently (as of IOS 12.4) cisco routers only support GRE. - Cisco switches only support the L2 redirect assignment method. -DOC_END - -NAME: wccp2_return_method -TYPE: int -LOC: Config.Wccp2.return_method -DEFAULT: 1 -IFDEF: USE_WCCPv2 -DOC_START - WCCP2 allows the setting of return methods between the - router/switch and the cache for packets that the cache - decides not to handle. Valid values are as follows: - - 1 - GRE encapsulation (forward the packet in a GRE/WCCP tunnel) - 2 - L2 redirect (forward the packet using Layer 2/MAC rewriting) - - Currently (as of IOS 12.4) cisco routers only support GRE. - Cisco switches only support the L2 redirect assignment. - - If the "ip wccp redirect exclude in" command has been - enabled on the cache interface, then it is still safe for - the proxy server to use a l2 redirect method even if this - option is set to GRE. -DOC_END - -NAME: wccp2_assignment_method -TYPE: int -LOC: Config.Wccp2.assignment_method -DEFAULT: 1 -IFDEF: USE_WCCPv2 -DOC_START - WCCP2 allows the setting of methods to assign the WCCP hash - Valid values are as follows: - - 1 - Hash assignment - 2 - Mask assignment - - As a general rule, cisco routers support the hash assignment method - and cisco switches support the mask assignment method. + (English) error files, either to customize them to suit your + language or company copy the template English files to another + directory and point this tag at them. DOC_END -NAME: wccp2_service -TYPE: wccp2_service -LOC: Config.Wccp2.info -DEFAULT: none -DEFAULT_IF_NONE: standard 0 -IFDEF: USE_WCCPv2 +NAME: maximum_single_addr_tries +TYPE: int +LOC: Config.retry.maxtries +DEFAULT: 1 DOC_START - WCCP2 allows for multiple traffic services. There are two - types: "standard" and "dynamic". The standard type defines - one service id - http (id 0). The dynamic service ids can be from - 51 to 255 inclusive. In order to use a dynamic service id - one must define the type of traffic to be redirected; this is done - using the wccp2_service_info option. + This sets the maximum number of connection attempts for a + host that only has one address (for multiple-address hosts, + each address is tried once). - The "standard" type does not require a wccp2_service_info option, - just specifying the service id will suffice. + The default value is one attempt, the (not recommended) + maximum is 255 tries. A warning message will be generated + if it is set to a value greater than ten. - MD5 service authentication can be enabled by adding - "password=" to the end of this service declaration. + Note: This is in addition to the request re-forwarding which + takes place if Squid fails to get a satisfying response. +DOC_END - Examples: +NAME: retry_on_error +TYPE: onoff +LOC: Config.retry.onerror +DEFAULT: off +DOC_START + If set to on Squid will automatically retry requests when + receiving an error response. This is mainly useful if you + are in a complex cache hierarchy to work around access + control errors. +DOC_END - wccp2_service standard 0 # for the 'web-cache' standard service - wccp2_service dynamic 80 # a dynamic service type which will be - # fleshed out with subsequent options. - wccp2_service standard 0 password=foo +NAME: snmp_port +TYPE: ushort +LOC: Config.Port.snmp +DEFAULT: 3401 +IFDEF: SQUID_SNMP +DOC_START + Squid can now serve statistics and status information via SNMP. + By default it listens to port 3401 on the machine. If you don't + wish to use SNMP, set this to "0". + Note: If you want Squid to use parents for all requests see + the never_direct directive. prefer_direct only modifies how Squid + acts on cachable requests. DOC_END -NAME: wccp2_service_info -TYPE: wccp2_service_info -LOC: Config.Wccp2.info +NAME: snmp_access +TYPE: acl_access +LOC: Config.accessList.snmp DEFAULT: none -IFDEF: USE_WCCPv2 +DEFAULT_IF_NONE: deny all +IFDEF: SQUID_SNMP DOC_START - Dynamic WCCPv2 services require further information to define the - traffic you wish to have diverted. - - The format is: - - wccp2_service_info protocol= flags=,.. - priority= ports=,.. - - The relevant WCCPv2 flags: - + src_ip_hash, dst_ip_hash - + source_port_hash, dest_port_hash - + src_ip_alt_hash, dst_ip_alt_hash - + src_port_alt_hash, dst_port_alt_hash - + ports_source - - The port list can be one to eight entries. - - Example: + Allowing or denying access to the SNMP port. - wccp2_service_info 80 protocol=tcp flags=src_ip_hash,ports_source - priority=240 ports=80 + All access to the agent is denied by default. + usage: - Note: the service id must have been defined by a previous - 'wccp2_service dynamic ' entry. -DOC_END + snmp_access allow|deny [!]aclname ... -NAME: wccp2_weight -TYPE: int -LOC: Config.Wccp2.weight -DEFAULT: 10000 -IFDEF: USE_WCCPv2 -DOC_START - Each cache server gets assigned a set of the destination - hash proportional to their weight. +Example: + snmp_access allow snmppublic localhost + snmp_access deny all DOC_END -NAME: wccp_address +NAME: snmp_incoming_address TYPE: address -LOC: Config.Wccp.address +LOC: Config.Addrs.snmp_incoming DEFAULT: 0.0.0.0 -IFDEF: USE_WCCP +IFDEF: SQUID_SNMP DOC_NONE -NAME: wccp2_address +NAME: snmp_outgoing_address TYPE: address -LOC: Config.Wccp2.address -DEFAULT: 0.0.0.0 -IFDEF: USE_WCCPv2 +LOC: Config.Addrs.snmp_outgoing +DEFAULT: 255.255.255.255 +IFDEF: SQUID_SNMP DOC_START - Use this option if you require WCCP to use a specific - interface address. + Just like 'udp_incoming_address' above, but for the SNMP port. - The default behavior is to not bind to any specific address. + snmp_incoming_address is used for the SNMP socket receiving + messages from SNMP agents. + snmp_outgoing_address is used for SNMP packets returned to SNMP + agents. + + The default snmp_incoming_address (0.0.0.0) is to listen on all + available network interfaces. + + If snmp_outgoing_address is set to 255.255.255.255 (the default) + it will use the same socket as snmp_incoming_address. Only + change this if you want to have SNMP replies sent using another + address than where this Squid listens for SNMP queries. + + NOTE, snmp_incoming_address and snmp_outgoing_address can not have + the same value since they both use port 3401. DOC_END +NAME: as_whois_server +TYPE: string +LOC: Config.as_whois_server +DEFAULT: whois.ra.net +DEFAULT_IF_NONE: whois.ra.net +DOC_START + WHOIS server to query for AS numbers. NOTE: AS numbers are + queried only when Squid starts up, not for every request. +DOC_END NAME: incoming_icp_average TYPE: int @@ -4671,72 +4736,6 @@ DOC_START nameservers by setting this option to 'off'. DOC_END -NAME: digest_generation -IFDEF: USE_CACHE_DIGESTS -TYPE: onoff -LOC: Config.onoff.digest_generation -DEFAULT: on -DOC_START - This controls whether the server will generate a Cache Digest - of its contents. By default, Cache Digest generation is - enabled if Squid is compiled with USE_CACHE_DIGESTS defined. -DOC_END - -NAME: digest_bits_per_entry -IFDEF: USE_CACHE_DIGESTS -TYPE: int -LOC: Config.digest.bits_per_entry -DEFAULT: 5 -DOC_START - This is the number of bits of the server's Cache Digest which - will be associated with the Digest entry for a given HTTP - Method and URL (public key) combination. The default is 5. -DOC_END - -NAME: digest_rebuild_period -IFDEF: USE_CACHE_DIGESTS -COMMENT: (seconds) -TYPE: time_t -LOC: Config.digest.rebuild_period -DEFAULT: 1 hour -DOC_START - This is the number of seconds between Cache Digest rebuilds. -DOC_END - -NAME: digest_rewrite_period -COMMENT: (seconds) -IFDEF: USE_CACHE_DIGESTS -TYPE: time_t -LOC: Config.digest.rewrite_period -DEFAULT: 1 hour -DOC_START - This is the number of seconds between Cache Digest writes to - disk. -DOC_END - -NAME: digest_swapout_chunk_size -COMMENT: (bytes) -TYPE: b_size_t -IFDEF: USE_CACHE_DIGESTS -LOC: Config.digest.swapout_chunk_size -DEFAULT: 4096 bytes -DOC_START - This is the number of bytes of the Cache Digest to write to - disk at a time. It defaults to 4096 bytes (4KB), the Squid - default swap page. -DOC_END - -NAME: digest_rebuild_chunk_percentage -COMMENT: (percent, 0-100) -IFDEF: USE_CACHE_DIGESTS -TYPE: int -LOC: Config.digest.rebuild_chunk_percentage -DEFAULT: 10 -DOC_START - This is the percentage of the Cache Digest to be scanned at a - time. By default it is set to 10% of the Cache Digest. -DOC_END - NAME: chroot TYPE: string LOC: Config.chroot_dir @@ -4749,48 +4748,6 @@ DOC_START error. DOC_END -NAME: client_persistent_connections -TYPE: onoff -LOC: Config.onoff.client_pconns -DEFAULT: on -DOC_NONE - -NAME: server_persistent_connections -TYPE: onoff -LOC: Config.onoff.server_pconns -DEFAULT: on -DOC_START - Persistent connection support for clients and servers. By - default, Squid uses persistent connections (when allowed) - with its clients and servers. You can use these options to - disable persistent connections with clients and/or servers. -DOC_END - -NAME: persistent_connection_after_error -TYPE: onoff -LOC: Config.onoff.error_pconns -DEFAULT: off -DOC_START - With this directive the use of persistent connections after - HTTP errors can be disabled. Useful if you have clients - who fail to handle errors on persistent connections proper. -DOC_END - -NAME: detect_broken_pconn -TYPE: onoff -LOC: Config.onoff.detect_broken_server_pconns -DEFAULT: off -DOC_START - Some servers have been found to incorrectly signal the use - of HTTP/1.0 persistent connections even on replies not - compatible, causing significant delays. This server problem - has mostly been seen on redirects. - - By enabling this directive Squid attempts to detect such - broken replies and automatically assume the reply is finished - after 10 seconds timeout. -DOC_END - NAME: balance_on_multiple_ip TYPE: onoff LOC: Config.onoff.balance_on_multiple_ip