From: amosjeffries <> Date: Fri, 3 Aug 2007 04:58:15 +0000 (+0000) Subject: Add new section to squid.conf: ERROR PAGE CUSTOMISATION X-Git-Tag: SQUID_3_0_PRE7~117 X-Git-Url: http://git.ipfire.org/gitweb/?a=commitdiff_plain;h=1db9eacdd3c476a2d7465c50f32f5ea46a7c6844;p=thirdparty%2Fsquid.git Add new section to squid.conf: ERROR PAGE CUSTOMISATION Moves existing error page rerlated options from MISC section to their own. Options moved are: deny_info, error_directory, email_err_data, err_html_text --- diff --git a/src/cf.data.pre b/src/cf.data.pre index e76a997f07..ea3789bc65 100644 --- a/src/cf.data.pre +++ b/src/cf.data.pre @@ -1,6 +1,6 @@ # -# $Id: cf.data.pre,v 1.444 2007/07/09 19:54:13 wessels Exp $ +# $Id: cf.data.pre,v 1.445 2007/08/02 22:58:15 amosjeffries Exp $ # # SQUID Web Proxy Cache http://www.squid-cache.org/ # ---------------------------------------------------------- @@ -3685,6 +3685,79 @@ DOC_START time. By default it is set to 10% of the Cache Digest. DOC_END +COMMENT_START + ERROR PAGE CUSTOMISATION + ----------------------------------------------------------------------------- +COMMENT_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. +DOC_END + +NAME: error_directory +TYPE: string +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. + + The squid developers are interested in making squid available in + a wide variety of languages. If you are making translations for a + langauge that Squid does not currently provide please consider + contributing your translation back to the project. +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 + COMMENT_START MISCELLANEOUS ----------------------------------------------------------------------------- @@ -3748,58 +3821,6 @@ DOC_START 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. -DOC_END - NAME: memory_pools COMMENT: on|off TYPE: onoff @@ -4381,17 +4402,6 @@ DOC_START other proxies you may need to disable this directive. DOC_END -NAME: error_directory -TYPE: string -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