home *** CD-ROM | disk | FTP | other *** search
/ PC World 2003 May / PCWorld_2003-05_cd.bin / Komunik / apache / apache_2.0.45-win32-x86-no_ssl.msi / Data.Cab / F232600_env.html.en < prev    next >
Extensible Markup Language  |  2003-03-30  |  22KB  |  375 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>Environment Variables in Apache - 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>Environment Variables in Apache</h1>
  20.     <p>The Apache HTTP Server provides a mechanism for storing
  21.     information in named variables that are called <em>environment
  22.     variables</em>. This information can be used to control various
  23.     operations such as logging or access control. The variables are
  24.     also used as a mechanism to communicate with external programs
  25.     such as CGI scripts. This document discusses different ways to
  26.     manipulate and use these variables.</p>
  27.         
  28.     <p>Although these variables are referred to as <em>environment
  29.     variables</em>, they are not the same as the environment
  30.     variables controlled by the underlying operating system.
  31.     Instead, these variables are stored and manipulated in an
  32.     internal Apache structure. They only become actual operating
  33.     system environment variables when they are provided to CGI
  34.     scripts and Server Side Include scripts. If you wish to
  35.     manipulate the operating system environment under which the
  36.     server itself runs, you must use the standard environment
  37.     manipulation mechanisms provided by your operating system
  38.     shell.</p>
  39.   </div>
  40. <div id="quickview"><ul id="toc"><li><img alt="" src="./images/down.gif" /> <a href="#setting">Setting Environment Variables</a></li>
  41. <li><img alt="" src="./images/down.gif" /> <a href="#using">Using Environment Variables</a></li>
  42. <li><img alt="" src="./images/down.gif" /> <a href="#special">Special Purpose Environment Variables</a></li>
  43. <li><img alt="" src="./images/down.gif" /> <a href="#examples">Examples</a></li>
  44. </ul></div>
  45. <div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
  46. <div class="section">
  47. <h2><a name="setting" id="setting">Setting Environment Variables</a></h2>
  48.     
  49.     <table class="related"><tr><th>Related Modules</th><th>Related Directives</th></tr><tr><td><ul><li><code class="module"><a href="./mod/mod_env.html">mod_env</a></code></li><li><code class="module"><a href="./mod/mod_rewrite.html">mod_rewrite</a></code></li><li><code class="module"><a href="./mod/mod_setenvif.html">mod_setenvif</a></code></li><li><code class="module"><a href="./mod/mod_unique_id.html">mod_unique_id</a></code></li></ul></td><td><ul><li><code class="directive"><a href="./mod/mod_setenvif.html#browsermatch">BrowserMatch</a></code></li><li><code class="directive"><a href="./mod/mod_setenvif.html#browsermatchnocase">BrowserMatchNoCase</a></code></li><li><code class="directive"><a href="./mod/mod_env.html#passenv">PassEnv</a></code></li><li><code class="directive"><a href="./mod/mod_rewrite.html#rewriterule">RewriteRule</a></code></li><li><code class="directive"><a href="./mod/mod_env.html#setenv">SetEnv</a></code></li><li><code class="directive"><a href="./mod/mod_setenvif.html#setenvif">SetEnvIf</a></code></li><li><code class="directive"><a href="./mod/mod_setenvif.html#setenvifnocase">SetEnvIfNoCase</a></code></li><li><code class="directive"><a href="./mod/mod_env.html#unsetenv">UnsetEnv</a></code></li></ul></td></tr></table>
  50.     
  51.     <h3><a name="basic-manipulation" id="basic-manipulation">Basic Environment Manipulation</a></h3>
  52.         
  53.     
  54.         <p>The most basic way to set an environment variable in Apache
  55.         is using the unconditional <code class="directive"><a href="./mod/mod_env.html#setenv">SetEnv</a></code> directive. Variables may also be passed from
  56.         the environment of the shell which started the server using the
  57.         <code class="directive"><a href="./mod/mod_env.html#passenv">PassEnv</a></code> directive.</p>
  58.     
  59.     
  60.     <h3><a name="conditional" id="conditional">Conditional Per-Request Settings</a></h3>
  61.         
  62.     
  63.         <p>For additional flexibility, the directives provided by
  64.         mod_setenvif allow environment variables to be set on a
  65.         per-request basis, conditional on characteristics of particular
  66.         requests. For example, a variable could be set only when a
  67.         specific browser (User-Agent) is making a request, or only when
  68.         a specific Referer [sic] header is found. Even more flexibility
  69.         is available through the mod_rewrite's <code class="directive"><a href="./mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> which uses the 
  70.         <code>[E=...]</code> option to set environment variables.</p>
  71.     
  72.     
  73.     <h3><a name="unique-identifiers" id="unique-identifiers">Unique Identifiers</a></h3>
  74.         
  75.     
  76.         <p>Finally, mod_unique_id sets the environment variable
  77.         <code>UNIQUE_ID</code> for each request to a value which is
  78.         guaranteed to be unique across "all" requests under very
  79.         specific conditions.</p>
  80.     
  81.     
  82.     <h3><a name="standard-cgi" id="standard-cgi">Standard CGI Variables</a></h3>
  83.         
  84.     
  85.         <p>In addition to all environment variables set within the
  86.         Apache configuration and passed from the shell, CGI scripts and
  87.         SSI pages are provided with a set of environment variables
  88.         containing meta-information about the request as required by
  89.         the <a href="http://cgi-spec.golux.com/">CGI
  90.         specification</a>.</p>
  91.     
  92.     
  93.     <h3><a name="caveats" id="caveats">Some Caveats</a></h3>
  94.         
  95.     
  96.         <ul>
  97.           <li>It is not possible to override or change the standard CGI
  98.           variables using the environment manipulation directives.</li>
  99.     
  100.           <li>When <a href="suexec.html">suexec</a> is used to launch
  101.           CGI scripts, the environment will be cleaned down to a set of
  102.           <em>safe</em> variables before CGI scripts are launched. The
  103.           list of <em>safe</em> variables is defined at compile-time in
  104.           <code>suexec.c</code>.</li>
  105.     
  106.           <li>For portability reasons, the names of environment
  107.           variables may contain only letters, numbers, and the
  108.           underscore character. In addition, the first character may
  109.           not be a number. Characters which do not match this
  110.           restriction will be replaced by an underscore when passed to
  111.           CGI scripts and SSI pages.</li>
  112.         </ul>
  113.     
  114.   </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
  115. <div class="section">
  116. <h2><a name="using" id="using">Using Environment Variables</a></h2>
  117.     
  118.     
  119.     <table class="related"><tr><th>Related Modules</th><th>Related Directives</th></tr><tr><td><ul><li><code class="module"><a href="./mod/mod_access.html">mod_access</a></code></li><li><code class="module"><a href="./mod/mod_cgi.html">mod_cgi</a></code></li><li><code class="module"><a href="./mod/mod_ext_filter.html">mod_ext_filter</a></code></li><li><code class="module"><a href="./mod/mod_headers.html">mod_headers</a></code></li><li><code class="module"><a href="./mod/mod_include.html">mod_include</a></code></li><li><code class="module"><a href="./mod/mod_log_config.html">mod_log_config</a></code></li><li><code class="module"><a href="./mod/mod_rewrite.html">mod_rewrite</a></code></li></ul></td><td><ul><li><code class="directive"><a href="./mod/mod_access.html#allow">Allow</a></code></li><li><code class="directive"><a href="./mod/mod_log_config.html#customlog">CustomLog</a></code></li><li><code class="directive"><a href="./mod/mod_access.html#deny">Deny</a></code></li><li><code class="directive"><a href="./mod/mod_ext_filter.html#extfilterdefine">ExtFilterDefine</a></code></li><li><code class="directive"><a href="./mod/mod_headers.html#header">Header</a></code></li><li><code class="directive"><a href="./mod/mod_log_config.html#logformat">LogFormat</a></code></li><li><code class="directive"><a href="./mod/mod_rewrite.html#rewritecond">RewriteCond</a></code></li><li><code class="directive"><a href="./mod/mod_rewrite.html#rewriterule">RewriteRule</a></code></li></ul></td></tr></table>
  120.  
  121.     <h3><a name="cgi-scripts" id="cgi-scripts">CGI Scripts</a></h3>
  122.         
  123.     
  124.         <p>One of the primary uses of environment variables is to
  125.         communicate information to CGI scripts. As discussed above, the
  126.         environment passed to CGI scripts includes standard
  127.         meta-information about the request in addition to any variables
  128.         set within the Apache configuration. For more details, see the
  129.         <a href="howto/cgi.html">CGI tutorial</a>.</p>
  130.     
  131.     
  132.     <h3><a name="ssi-pages" id="ssi-pages">SSI Pages</a></h3>
  133.         
  134.     
  135.         <p>Server-parsed (SSI) documents processed by mod_include's
  136.         <code>INCLUDES</code> filter can print environment variables
  137.         using the <code>echo</code> element, and can use environment
  138.         variables in flow control elements to makes parts of a page
  139.         conditional on characteristics of a request. Apache also
  140.         provides SSI pages with the standard CGI environment variables
  141.         as discussed above. For more details, see the <a href="howto/ssi.html">SSI tutorial</a>.</p>
  142.     
  143.     
  144.     <h3><a name="access-control" id="access-control">Access Control</a></h3>
  145.         
  146.     
  147.         <p>Access to the server can be controlled based on the value of
  148.         environment variables using the <code>allow from env=</code>
  149.         and <code>deny from env=</code> directives. In combination with
  150.         <code class="directive"><a href="./mod/mod_setenvif.html#setenvif">SetEnvIf</a></code>, this 
  151.         allows for flexible control of access to the server based on 
  152.         characteristics of the client. For example, you can use these 
  153.         directives to deny access to a particular browser (User-Agent).
  154.         </p>
  155.     
  156.     
  157.     <h3><a name="logging" id="logging">Conditional Logging</a></h3>
  158.         
  159.     
  160.         <p>Environment variables can be logged in the access log using
  161.         the <code class="directive"><a href="./mod/mod_log_config.html#logformat">LogFormat</a></code>
  162.         option <code>%e</code>. In addition, the decision on whether
  163.         or not to log requests can be made based on the status of 
  164.         environment variables using the conditional form of the 
  165.         <code class="directive"><a href="./mod/mod_log_config.html#customlog">CustomLog</a></code>
  166.         directive. In combination with <code class="directive"><a href="./mod/mod_setenvif.html#setenvif">SetEnvIf</a></code> this allows for flexible control of which 
  167.         requests are logged. For example, you can choose not to log 
  168.         requests for filenames ending in <code>gif</code>, or you can
  169.         choose to only log requests from clients which are outside your
  170.         subnet.</p>
  171.     
  172.     
  173.     <h3><a name="response-headers" id="response-headers">Conditional Response Headers</a></h3>
  174.         
  175.     
  176.         <p>The <code class="directive"><a href="./mod/mod_headers.html#header">Header</a></code>
  177.         directive can use the presence or
  178.         absence of an environment variable to determine whether or not
  179.         a certain HTTP header will be placed in the response to the
  180.         client. This allows, for example, a certain response header to
  181.         be sent only if a corresponding header is received in the
  182.         request from the client.</p>
  183.     
  184.     
  185.  
  186.     <h3><a name="external-filter" id="external-filter">External Filter Activation</a></h3>
  187.         
  188.  
  189.         <p>External filters configured by <code class="module"><a href="./mod/mod_ext_filter.html">mod_ext_filter</a></code>
  190.         using the <code class="directive"><a href="./mod/mod_ext_filter.html#extfilterdefine">ExtFilterDefine</a></code> directive can
  191.         by activated conditional on an environment variable using the
  192.         <code>disableenv=</code> and <code>enableenv=</code> options.</p>
  193.     
  194.  
  195.     <h3><a name="url-rewriting" id="url-rewriting">URL Rewriting</a></h3>
  196.         
  197.     
  198.         <p>The <code>%{ENV:...}</code> form of <em>TestString</em> in
  199.         the <code class="directive"><a href="./mod/mod_rewrite.html#rewritecond">RewriteCond</a></code>
  200.         allows mod_rewrite's rewrite
  201.         engine to make decisions conditional on environment variables.
  202.         Note that the variables accessible in mod_rewrite without the
  203.         <code>ENV:</code> prefix are not actually environment
  204.         variables. Rather, they are variables special to mod_rewrite
  205.         which cannot be accessed from other modules.</p>
  206.     
  207.   </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
  208. <div class="section">
  209. <h2><a name="special" id="special">Special Purpose Environment Variables</a></h2>
  210.     
  211.     
  212.         <p>Interoperability problems have led to the introduction of
  213.         mechanisms to modify the way Apache behaves when talking to
  214.         particular clients. To make these mechanisms as flexible as
  215.         possible, they are invoked by defining environment variables,
  216.         typically with <code class="directive"><a href="./mod/mod_setenvif.html#browsermatch">BrowserMatch</a></code>,
  217.         though <code class="directive"><a href="./mod/mod_env.html#setenv">SetEnv</a></code> and 
  218.         <code class="directive"><a href="./mod/mod_env.html#passenv">PassEnv</a></code> could also be used,
  219.         for example.</p>
  220.     
  221.     <h3><a name="downgrade" id="downgrade">downgrade-1.0</a></h3>
  222.         
  223.     
  224.         <p>This forces the request to be treated as a HTTP/1.0 request
  225.         even if it was in a later dialect.</p>
  226.     
  227.     
  228.     <h3><a name="force-no-vary" id="force-no-vary">force-no-vary</a></h3>
  229.         
  230.     
  231.         <p>This causes any <code>Vary</code> fields to be removed from
  232.         the response header before it is sent back to the client. Some
  233.         clients don't interpret this field correctly (see the <a href="misc/known_client_problems.html">known client
  234.         problems</a> page); setting this variable can work around this
  235.         problem. Setting this variable also implies
  236.         <strong>force-response-1.0</strong>.</p>
  237.     
  238.     
  239.     <h3><a name="force-response" id="force-response">force-response-1.0</a></h3>
  240.         
  241.     
  242.       <p>This forces an HTTP/1.0 response to clients making an HTTP/1.0
  243.       request. It was originally
  244.       implemented as a result of a problem with AOL's proxies. Some
  245.       HTTP/1.0 clients may not behave correctly when given an HTTP/1.1
  246.       response, and this can be used to interoperate with them.</p>
  247.  
  248.     
  249.  
  250.     <h3><a name="gzip-only-text-html" id="gzip-only-text-html">gzip-only-text/html</a></h3>
  251.         
  252.  
  253.         <p>When set to a value of "1", this variable disables the DEFLATE
  254.         output filter provided by <code class="module"><a href="./mod/mod_deflate.html">mod_deflate</a></code> for
  255.         content-types other than <code>text/html</code>.</p>
  256.     
  257.  
  258.     <h3><a name="no-gzip" id="no-gzip">no-gzip</a></h3>
  259.  
  260.         <p>When set, the <code>DEFLATE</code> filter of
  261.         <code class="module"><a href="./mod/mod_deflate.html">mod_deflate</a></code> will be turned off.</p>
  262.  
  263.     
  264.  
  265.     <h3><a name="nokeepalive" id="nokeepalive">nokeepalive</a></h3>
  266.         
  267.     
  268.         <p>This disables <code class="directive"><a href="./mod/core.html#keepalive">KeepAlive</a></code> when set.</p>
  269.     
  270.     
  271.     <h3><a name="redirect-carefully" id="redirect-carefully">redirect-carefully</a></h3>
  272.         
  273.     
  274.         <p>This forces the server to be more careful when sending a redirect
  275.         to the client.  This is typically used when a client has a known
  276.         problem handling redirects.  This was originally implemented as a
  277.         result of a problem with Microsoft's WebFolders software which has
  278.         a problem handling redirects on directory resources via DAV 
  279.         methods.</p>
  280.     
  281.     
  282.  
  283.    <h3><a name="suppress-error-charset" id="suppress-error-charset">suppress-error-charset</a></h3>
  284.        
  285.  
  286.     <p><em>Available in versions after 2.0.40</em></p>
  287.  
  288.     <p>When Apache issues a redirect in response to a client request,
  289.     the response includes some actual text to be displayed in case
  290.     the client can't (or doesn't) automatically follow the redirection.
  291.     Apache ordinarily labels this text according to the character set
  292.     which it uses, which is ISO-8859-1.</p>
  293.     <p> However, if the redirection is to a page that uses a different
  294.     character set, some broken browser versions will try to use the
  295.     character set from the redirection text rather than the actual page.
  296.     This can result in Greek, for instance, being incorrectly rendered.</p>
  297.     <p>Setting this environment variable causes Apache to omit the character
  298.     set for the redirection text, and these broken browsers will then correctly
  299.     use that of the destination page.</p>
  300.  
  301.    
  302.  
  303.   </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
  304. <div class="section">
  305. <h2><a name="examples" id="examples">Examples</a></h2>
  306.     
  307.     
  308.     <h3><a name="misbehaving" id="misbehaving">Changing protocol behavior with misbehaving clients</a></h3>
  309.         
  310.     
  311.         <p>We recommend that the following lines be included in
  312.         httpd.conf to deal with known client problems.</p>
  313. <div class="example"><pre>
  314. #
  315. # The following directives modify normal HTTP response behavior.
  316. # The first directive disables keepalive for Netscape 2.x and browsers that
  317. # spoof it. There are known problems with these browser implementations.
  318. # The second directive is for Microsoft Internet Explorer 4.0b2
  319. # which has a broken HTTP/1.1 implementation and does not properly
  320. # support keepalive when it is used on 301 or 302 (redirect) responses.
  321. #
  322. BrowserMatch "Mozilla/2" nokeepalive
  323. BrowserMatch "MSIE 4\.0b2;" nokeepalive downgrade-1.0 force-response-1.0
  324.  
  325. #
  326. # The following directive disables HTTP/1.1 responses to browsers which
  327. # are in violation of the HTTP/1.0 spec by not being able to grok a
  328. # basic 1.1 response.
  329. #
  330. BrowserMatch "RealPlayer 4\.0" force-response-1.0
  331. BrowserMatch "Java/1\.0" force-response-1.0
  332. BrowserMatch "JDK/1\.0" force-response-1.0</pre></div>
  333.  
  334.     
  335.     <h3><a name="no-img-log" id="no-img-log">Do not log requests for images in the access log</a></h3>
  336.         
  337.     
  338.         <p>This example keeps requests for images from appearing in the
  339.         access log. It can be easily modified to prevent logging of
  340.         particular directories, or to prevent logging of requests
  341.         coming from particular hosts.</p>
  342.     <div class="example"><pre>
  343. SetEnvIf Request_URI \.gif image-request
  344. SetEnvIf Request_URI \.jpg image-request
  345. SetEnvIf Request_URI \.png image-request
  346. CustomLog logs/access_log common env=!image-request</pre></div>
  347.     
  348.     
  349.     <h3><a name="image-theft" id="image-theft">Prevent "Image Theft"</a></h3>
  350.         
  351.     
  352.         <p>This example shows how to keep people not on your server
  353.         from using images on your server as inline-images on their
  354.         pages. This is not a recommended configuration, but it can work
  355.         in limited circumstances. We assume that all your images are in
  356.         a directory called /web/images.</p>
  357.     <div class="example"><pre>
  358. SetEnvIf Referer "^http://www.example.com/" local_referal
  359. # Allow browsers that do not send Referer info
  360. SetEnvIf Referer "^$" local_referal
  361. <Directory /web/images>
  362.    Order Deny,Allow
  363.    Deny from all
  364.    Allow from env=local_referal
  365. </Directory></pre></div>
  366.     
  367.         <p>For more information about this technique, see the
  368.         ApacheToday tutorial " <a href="http://apachetoday.com/news_story.php3?ltsn=2000-06-14-002-01-PS">
  369.     Keeping Your Images from Adorning Other Sites</a>".</p>
  370.     
  371.   </div></div>
  372. <div id="footer">
  373. <p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p>
  374. <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>
  375. </body></html>