home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 November / CMCD1104.ISO / Software / Complet / Apache / apache_2.0.52-win32-x86-no_ssl.msi / Data.Cab / F277535_customerror.html.en < prev    next >
Extensible Markup Language  |  2004-02-20  |  10KB  |  202 lines
  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
  4.         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  5.               This file is generated from xml source: DO NOT EDIT
  6.         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  7.       -->
  8. <title>Custom Error Responses - Apache HTTP Server</title>
  9. <link href="./style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10. <link href="./style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11. <link href="./style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
  12. <link href="./images/favicon.ico" rel="shortcut icon" /></head>
  13. <body id="manual-page"><div id="page-header">
  14. <p class="menu"><a href="./mod/">Modules</a> | <a href="./mod/directives.html">Directives</a> | <a href="./faq/">FAQ</a> | <a href="./glossary.html">Glossary</a> | <a href="./sitemap.html">Sitemap</a></p>
  15. <p class="apache">Apache HTTP Server Version 2.0</p>
  16. <img alt="" src="./images/feather.gif" /></div>
  17. <div class="up"><a href="./"><img title="<-" alt="<-" src="./images/left.gif" /></a></div>
  18. <div id="path">
  19. <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs-project/">Documentation</a> > <a href="./">Version 2.0</a></div><div id="page-content"><div id="preamble"><h1>Custom Error Responses</h1>
  20. <div class="toplang">
  21. <p><span>Available Languages: </span><a href="./en/custom-error.html" title="English"> en </a> |
  22. <a href="./ja/custom-error.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
  23. <a href="./ko/custom-error.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
  24. </div>
  25.  
  26.     <p>Additional functionality allows webmasters to configure the response 
  27.     of Apache to some error or problem.</p>
  28.  
  29.     <p>Customizable responses can be defined to be activated in the event of 
  30.     a server detected error or problem.</p>
  31.  
  32.     <p>If a script crashes and produces a "500 Server Error" response, 
  33.     then this response can be replaced with either some friendlier text or by 
  34.     a redirection to another URL (local or external).</p>
  35.   </div>
  36. <div id="quickview"><ul id="toc"><li><img alt="" src="./images/down.gif" /> <a href="#behavior">Behavior</a></li>
  37. <li><img alt="" src="./images/down.gif" /> <a href="#configuration">Configuration</a></li>
  38. <li><img alt="" src="./images/down.gif" /> <a href="#custom">Custom Error Responses and Redirects</a></li>
  39. </ul></div>
  40. <div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
  41. <div class="section">
  42. <h2><a name="behavior" id="behavior">Behavior</a></h2>
  43.     
  44.  
  45.     <h3>Old Behavior</h3>
  46.       
  47.  
  48.       <p>NCSA httpd 1.3 would return some boring old error/problem message 
  49.       which would often be meaningless to the user, and would provide no 
  50.       means of logging the symptoms which caused it.</p>
  51.     
  52.  
  53.     <h3>New Behavior</h3>
  54.       
  55.  
  56.       <p>The server can be asked to:</p>
  57.  
  58.       <ol>
  59.         <li>Display some other text, instead of the NCSA hard coded 
  60.         messages, or</li>
  61.  
  62.         <li>redirect to a local URL, or</li>
  63.  
  64.         <li>redirect to an external URL.</li>
  65.       </ol>
  66.  
  67.       <p>Redirecting to another URL can be useful, but only if some 
  68.       information can be passed which can then be used to explain and/or log 
  69.       the error/problem more clearly.</p>
  70.  
  71.       <p>To achieve this, Apache will define new CGI-like environment 
  72.       variables:</p>
  73.  
  74.       <div class="example"><p><code>
  75.         REDIRECT_HTTP_ACCEPT=*/*, image/gif, image/x-xbitmap, 
  76.             image/jpeg<br />
  77.         REDIRECT_HTTP_USER_AGENT=Mozilla/1.1b2 (X11; I; HP-UX A.09.05 
  78.             9000/712)<br />
  79.         REDIRECT_PATH=.:/bin:/usr/local/bin:/etc<br />
  80.         REDIRECT_QUERY_STRING=<br />
  81.         REDIRECT_REMOTE_ADDR=121.345.78.123<br />
  82.         REDIRECT_REMOTE_HOST=ooh.ahhh.com<br />
  83.         REDIRECT_SERVER_NAME=crash.bang.edu<br />
  84.         REDIRECT_SERVER_PORT=80<br />
  85.         REDIRECT_SERVER_SOFTWARE=Apache/0.8.15<br />
  86.         REDIRECT_URL=/cgi-bin/buggy.pl
  87.       </code></p></div>
  88.  
  89.       <p>Note the <code>REDIRECT_</code> prefix.</p>
  90.  
  91.       <p>At least <code>REDIRECT_URL</code> and
  92.       <code>REDIRECT_QUERY_STRING</code> will be passed to the
  93.       new URL (assuming it's a cgi-script or a cgi-include). The
  94.       other variables will exist only if they existed prior to
  95.       the error/problem. <strong>None</strong> of these will be
  96.       set if your <code class="directive"><a href="./mod/core.html#errordocument">ErrorDocument</a></code> is an 
  97.       <em>external</em> redirect (anything starting with a 
  98.       scheme name like <code>http:</code>, even if it refers to the same host 
  99.       as the server).</p>
  100.     
  101.   </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
  102. <div class="section">
  103. <h2><a name="configuration" id="configuration">Configuration</a></h2>
  104.     
  105.  
  106.     <p>Use of <code class="directive"><a href="./mod/core.html#errordocument">ErrorDocument</a></code> is enabled 
  107.     for .htaccess files when the 
  108.     <code class="directive"><a href="./mod/core.html#allowoverride">AllowOverride</a></code> is set accordingly.</p>
  109.  
  110.     <p>Here are some examples...</p>
  111.  
  112.     <div class="example"><p><code>
  113.       ErrorDocument 500 /cgi-bin/crash-recover <br />
  114.       ErrorDocument 500 "Sorry, our script crashed. Oh dear" <br />
  115.       ErrorDocument 500 http://xxx/ <br />
  116.       ErrorDocument 404 /Lame_excuses/not_found.html <br />
  117.       ErrorDocument 401 /Subscription/how_to_subscribe.html
  118.     </code></p></div>
  119.  
  120.     <p>The syntax is,</p>
  121.  
  122.     <div class="example"><p><code>
  123.       ErrorDocument <3-digit-code> <action>
  124.     </code></p></div>
  125.  
  126.     <p>where the action can be,</p>
  127.  
  128.     <ol>
  129.       <li>Text to be displayed. Prefix the text with a quote
  130.       ("). Whatever follows the quote is displayed. <em>Note:
  131.       the (") prefix isn't displayed.</em></li>
  132.  
  133.       <li>An external URL to redirect to.</li>
  134.  
  135.       <li>A local URL to redirect to.</li>
  136.     </ol>
  137.   </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
  138. <div class="section">
  139. <h2><a name="custom" id="custom">Custom Error Responses and Redirects</a></h2>
  140.     
  141.  
  142.     <p>Apache's behavior to redirected URLs has been modified so
  143.     that additional environment variables are available to a
  144.     script/server-include.</p>
  145.  
  146.     <h3>Old behavior</h3>
  147.       
  148.  
  149.       <p>Standard CGI vars were made available to a script which
  150.       has been redirected to. No indication of where the
  151.       redirection came from was provided.</p>
  152.     
  153.  
  154.     <h3>New behavior</h3>
  155.       
  156.  
  157.       <p>A new batch of environment variables will be initialized
  158.       for use by a script which has been redirected to. Each new
  159.       variable will have the prefix <code>REDIRECT_</code>.
  160.       <code>REDIRECT_</code> environment variables are created from
  161.       the CGI environment variables which existed prior to the
  162.       redirect, they are renamed with a <code>REDIRECT_</code>
  163.       prefix, <em>i.e.</em>, <code>HTTP_USER_AGENT</code> becomes
  164.       <code>REDIRECT_HTTP_USER_AGENT</code>. In addition to these
  165.       new variables, Apache will define <code>REDIRECT_URL</code>
  166.       and <code>REDIRECT_STATUS</code> to help the script trace its
  167.       origin. Both the original URL and the URL being redirected to
  168.       can be logged in the access log.</p>
  169.  
  170.       <p>If the ErrorDocument specifies a local redirect to a CGI
  171.       script, the script should include a "<code>Status:</code>"
  172.       header field in its output in order to ensure the propagation
  173.       all the way back to the client of the error condition that
  174.       caused it to be invoked. For instance, a Perl ErrorDocument
  175.       script might include the following:</p>
  176.  
  177.       <div class="example"><p><code>
  178.         ... <br />
  179.         print  "Content-type: text/html\n"; <br />
  180.         printf "Status: %s Condition Intercepted\n", $ENV{"REDIRECT_STATUS"}; <br />
  181.         ...
  182.       </code></p></div>
  183.  
  184.       <p>If the script is dedicated to handling a particular error
  185.       condition, such as <code>404 Not Found</code>, it can
  186.       use the specific code and error text instead.</p>
  187.  
  188.       <p>Note that the script <em>must</em> emit an appropriate
  189.       <code>Status:</code> header (such as <code>302 Found</code>), if the
  190.       response contains a <code>Location:</code> header (in order to issue a
  191.       client side redirect). Otherwise the <code>Location:</code> header may
  192.       have no effect.</p>
  193.     
  194.   </div></div>
  195. <div class="bottomlang">
  196. <p><span>Available Languages: </span><a href="./en/custom-error.html" title="English"> en </a> |
  197. <a href="./ja/custom-error.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
  198. <a href="./ko/custom-error.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
  199. </div><div id="footer">
  200. <p class="apache">Copyright 1999-2004 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
  201. <p class="menu"><a href="./mod/">Modules</a> | <a href="./mod/directives.html">Directives</a> | <a href="./faq/">FAQ</a> | <a href="./glossary.html">Glossary</a> | <a href="./sitemap.html">Sitemap</a></p></div>
  202. </body></html>