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