granicus.if.org Git - apache/blob - docs/manual/mod/mod_headers.html.en

   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>mod_headers - Apache HTTP Server Version 2.5</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" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
  12 <script src="../style/scripts/prettify.min.js" type="text/javascript">
  13 </script>
  14
  15 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  16 <body>
  17 <div id="page-header">
  18 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  19 <p class="apache">Apache HTTP Server Version 2.5</p>
  20 <img alt="" src="../images/feather.gif" /></div>
  21 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  22 <div id="path">
  23 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.5</a> &gt; <a href="./">Modules</a></div>
  24 <div id="page-content">
  25 <div id="preamble"><h1>Apache Module mod_headers</h1>
  26 <div class="toplang">
  27 <p><span>Available Languages: </span><a href="../en/mod/mod_headers.html" title="English">&nbsp;en&nbsp;</a> |
  28 <a href="../fr/mod/mod_headers.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
  29 <a href="../ja/mod/mod_headers.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
  30 <a href="../ko/mod/mod_headers.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
  31 </div>
  32 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Customization of HTTP request and response
  33 headers</td></tr>
  34 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  35 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>headers_module</td></tr>
  36 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_headers.c</td></tr></table>
  37 <h3>Summary</h3>
  38
  39     <p>This module provides directives to control and modify HTTP
  40     request and response headers. Headers can be merged, replaced
  41     or removed.</p>
  42 </div>
  43 <div id="quickview"><h3 class="directives">Directives</h3>
  44 <ul id="toc">
  45 <li><img alt="" src="../images/down.gif" /> <a href="#header">Header</a></li>
  46 <li><img alt="" src="../images/down.gif" /> <a href="#requestheader">RequestHeader</a></li>
  47 </ul>
  48 <h3>Topics</h3>
  49 <ul id="topics">
  50 <li><img alt="" src="../images/down.gif" /> <a href="#order">Order of Processing</a></li>
  51 <li><img alt="" src="../images/down.gif" /> <a href="#early">Early and Late Processing</a></li>
  52 <li><img alt="" src="../images/down.gif" /> <a href="#examples">Examples</a></li>
  53 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
  54 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  55 <div class="directive-section"><h2><a name="Header" id="Header">Header</a> <a name="header" id="header">Directive</a></h2>
  56 <table class="directive">
  57 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configure HTTP response headers</td></tr>
  58 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Header [<var>condition</var>] add|append|echo|edit|edit*|merge|set|setifempty|unset|note
  59 <var>header</var> [[expr=]<var>value</var> [<var>replacement</var>]
  60 [early|env=[!]<var>varname</var>|expr=<var>expression</var>]]
  61 </code></td></tr>
  62 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
  63 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
  64 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  65 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_headers</td></tr>
  66 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>SetIfEmpty available in 2.4.7 and later, expr=value
  67 available in 2.4.10 and later</td></tr>
  68 </table>
  69     <p>This directive can replace, merge or remove HTTP response
  70     headers. The header is modified just after the content handler
  71     and output filters are run, allowing outgoing headers to be
  72     modified.</p>
  73
  74     <p> The optional <var>condition</var> argument determines which internal
  75     table of responses headers this directive will operate against. Despite the
  76     name, the default value of <code>onsuccess</code> does <em>not</em> limit
  77     an <var>action</var> to responses with a 2xx status code.  Headers set under
  78     this condition are still used when, for example, a request is <em>successfully</em>
  79     proxied or generated by CGI, even when they have generated a failing status code.</p>
  80
  81     <p>When your action is a function of an existing header, you may need to specify
  82     a condition of <code>always</code>, depending on which internal table the
  83     original header was set in.  The table that corresponds to <code>always</code> is
  84     used for locally generated error responses as well as successful responses.
  85     Note also that repeating this directive with both conditions makes sense in
  86     some scenarios because <code>always</code> is not a superset of
  87     <code>onsuccess</code> with respect to existing headers:</p>
  88
  89     <ul>
  90        <li> You're adding a header to a locally generated non-success (non-2xx) response, such
  91             as a redirect, in which case only the table corresponding to
  92             <code>always</code> is used in the ultimate response.</li>
  93        <li> You're modifying or removing a header generated by a CGI script,
  94             in which case the CGI scripts are in the table corresponding to
  95             <code>always</code> and not in the default table.</li>
  96        <li> You're modifying or removing a header generated by some piece of
  97             the server but that header is not being found by the default
  98             <code>onsuccess</code> condition.</li>
  99     </ul>
 100
 101     <p>Separately from the <var>condition</var> parameter described above, you
 102     can limit an action based on HTTP status codes for e.g. proxied or CGI
 103     requests. See the example that uses %{REQUEST_STATUS} in the section above.</p>
 104
 105     <p>The action it performs is determined by the first
 106     argument (second argument if a <var>condition</var> is specified).
 107     This can be one of the following values:</p>
 108
 109     <dl>
 110     <dt><code>add</code></dt>
 111     <dd>The response header is added to the existing set of headers,
 112     even if this header already exists. This can result in two
 113     (or more) headers having the same name. This can lead to
 114     unforeseen consequences, and in general <code>set</code>,
 115     <code>append</code> or <code>merge</code> should be used instead.</dd>
 116
 117     <dt><code>append</code></dt>
 118     <dd>The response header is appended to any existing header of
 119     the same name. When a new value is merged onto an existing
 120     header it is separated from the existing header with a comma.
 121     This is the HTTP standard way of giving a header multiple values.</dd>
 122
 123     <dt><code>echo</code></dt>
 124     <dd>Request headers with this name are echoed back in the
 125     response headers. <var>header</var> may be a
 126     <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular expression</a>.
 127     <var>value</var> must be omitted.</dd>
 128
 129     <dt><code>edit</code></dt>
 130     <dt><code>edit*</code></dt>
 131     <dd>If this response header exists, its value is transformed according
 132     to a <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular expression</a>
 133     search-and-replace.  The <var>value</var> argument is a <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular expression</a>, and the <var>replacement</var>
 134     is a replacement string, which may contain backreferences or format specifiers.
 135     The <code>edit</code> form will match and replace exactly once
 136     in a header value, whereas the <code>edit*</code> form will replace
 137     <em>every</em> instance of the search pattern if it appears more
 138     than once.</dd>
 139
 140     <dt><code>merge</code></dt>
 141     <dd>The response header is appended to any existing header of
 142     the same name, unless the value to be appended already appears in the
 143     header's comma-delimited list of values.  When a new value is merged onto
 144     an existing header it is separated from the existing header with a comma.
 145     This is the HTTP standard way of giving a header multiple values.
 146     Values are compared in a case sensitive manner, and after
 147     all format specifiers have been processed.  Values in double quotes
 148     are considered different from otherwise identical unquoted values.</dd>
 149
 150     <dt><code>set</code></dt>
 151     <dd>The response header is set, replacing any previous header
 152     with this name. The <var>value</var> may be a format string.</dd>
 153
 154     <dt><code>setifempty</code></dt>
 155     <dd>The request header is set, but only if there is no previous header
 156     with this name.<br />
 157     Available in 2.4.7 and later.</dd>
 158
 159     <dt><code>unset</code></dt>
 160     <dd>The response header of this name is removed, if it exists.
 161     If there are multiple headers of the same name, all will be
 162     removed. <var>value</var> must be omitted.</dd>
 163
 164     <dt><code>note</code></dt>
 165     <dd>The value of the named response <var>header</var> is copied into an
 166     internal note whose name is given by <var>value</var>.  This is useful
 167     if a header sent by a CGI or proxied resource is configured to be unset
 168     but should also be logged.<br />
 169     Available in 2.4.7 and later.</dd>
 170
 171     </dl>
 172
 173     <p>This argument is followed by a <var>header</var> name, which
 174     can include the final colon, but it is not required. Case is
 175     ignored for <code>set</code>, <code>append</code>, <code>merge</code>,
 176     <code>add</code>, <code>unset</code> and <code>edit</code>.
 177     The <var>header</var> name for <code>echo</code>
 178     is case sensitive and may be a <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular
 179     expression</a>.</p>
 180
 181     <p>For <code>set</code>, <code>append</code>, <code>merge</code> and
 182     <code>add</code> a <var>value</var> is specified as the next argument.
 183     If <var>value</var>
 184     contains spaces, it should be surrounded by double quotes.
 185     <var>value</var> may be a character string, a string containing
 186     <code class="module"><a href="../mod/mod_headers.html">mod_headers</a></code> specific format specifiers (and character
 187     literals), or an <a href="../expr.html">ap_expr</a> expression prefixed
 188     with <em>expr=</em></p>
 189
 190     <p> The following format specifiers are supported in <var>value</var>:</p>
 191
 192     <table class="bordered"><tr class="header"><th>Format</th><th>Description</th></tr>
 193 <tr><td><code>%%</code></td>
 194         <td>The percent sign</td></tr>
 195 <tr class="odd"><td><code>%t</code></td>
 196         <td>The time the request was received in Universal Coordinated Time
 197         since the epoch (Jan. 1, 1970) measured in microseconds. The value
 198         is preceded by <code>t=</code>.</td></tr>
 199 <tr><td><code>%D</code></td>
 200         <td>The time from when the request was received to the time the
 201         headers are sent on the wire. This is a measure of the duration
 202         of the request. The value is preceded by <code>D=</code>.
 203         The value is measured in microseconds.</td></tr>
 204 <tr class="odd"><td><code>%l</code></td>
 205         <td>The current load averages of the actual server itself. It is
 206         designed to expose the values obtained by <code>getloadavg()</code>
 207         and this represents the current load average, the 5 minute average, and
 208         the 15 minute average. The value is preceded by <code>l=</code> with each
 209         average separated by <code>/</code>.<br />
 210         Available in 2.4.4 and later.
 211         </td></tr>
 212 <tr><td><code>%i</code></td>
 213         <td>The current idle percentage of httpd (0 to 100) based on available
 214         processes and threads. The value is preceded by <code>i=</code>.<br />
 215         Available in 2.4.4 and later.
 216         </td></tr>
 217 <tr class="odd"><td><code>%b</code></td>
 218         <td>The current busy percentage of httpd (0 to 100) based on available
 219         processes and threads. The value is preceded by <code>b=</code>.<br />
 220         Available in 2.4.4 and later.
 221         </td></tr>
 222 <tr><td><code>%{VARNAME}e</code></td>
 223         <td>The contents of the <a href="../env.html">environment
 224         variable</a> <code>VARNAME</code>.</td></tr>
 225 <tr class="odd"><td><code>%{VARNAME}s</code></td>
 226         <td>The contents of the <a href="mod_ssl.html#envvars">SSL environment
 227         variable</a> <code>VARNAME</code>, if <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> is enabled.</td></tr>
 228 </table>
 229
 230     <div class="note"><h3>Note</h3>
 231       <p>The <code>%s</code> format specifier is only available in
 232       Apache 2.1 and later; it can be used instead of <code>%e</code>
 233       to avoid the overhead of enabling <code>SSLOptions
 234       +StdEnvVars</code>.  If <code>SSLOptions +StdEnvVars</code> must
 235       be enabled anyway for some other reason, <code>%e</code> will be
 236       more efficient than <code>%s</code>.</p>
 237     </div>
 238
 239     <div class="note"><h3>Note on expression values</h3>
 240     <p> When the value parameter uses the <a href="../expr.html">ap_expr</a>
 241     parser, some expression syntax will differ from examples that evaluate
 242     <em>boolean</em> expressions such as &lt;If&gt;:</p>
 243     <ul>
 244       <li>The starting point of the grammar is 'string' rather than 'expr'.</li>
 245       <li>Function calls use the %{funcname:arg} syntax rather than
 246           funcname(arg).</li>
 247       <li>Multi-argument functions are not currently accessible from this
 248           starting point</li>
 249       <li>Quote the entire parameter, such as
 250           <pre class="prettyprint lang-config">Header set foo-checksum "expr=%{md5:foo}"</pre>
 251
 252        </li>
 253
 254     </ul>
 255     </div>
 256
 257     <p>For <code>edit</code> there is both a <var>value</var> argument
 258     which is a <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular expression</a>,
 259     and an additional <var>replacement</var> string. As of version 2.4.7
 260     the replacement string may also contain format specifiers.</p>
 261
 262     <p>The <code class="directive">Header</code> directive may be followed by
 263     an additional argument, which may be any of:</p>
 264     <dl>
 265     <dt><code>early</code></dt>
 266     <dd>Specifies <a href="#early">early processing</a>.</dd>
 267     <dt><code>env=[!]<var>varname</var></code></dt>
 268     <dd>The directive is applied if and only if the <a href="../env.html">environment variable</a> <code>varname</code> exists.
 269         A <code>!</code> in front of <code>varname</code> reverses the test,
 270         so the directive applies only if <code>varname</code> is unset.</dd>
 271     <dt><code>expr=<var>expression</var></code></dt>
 272     <dd>The directive is applied if and only if <var>expression</var>
 273         evaluates to true. Details of expression syntax and evaluation are
 274         documented in the <a href="../expr.html">ap_expr</a> documentation.</dd>
 275     </dl>
 276
 277     <p>Except in <a href="#early">early</a> mode, the
 278     <code class="directive">Header</code> directives are processed just
 279     before the response is sent to the network. This means that it is
 280     possible to set and/or override most headers, except for some headers
 281     added by the HTTP header filter.  Prior to 2.2.12, it was not possible
 282     to change the Content-Type header with this directive.</p>
 283
 284
 285 </div>
 286 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 287 <div class="directive-section"><h2><a name="RequestHeader" id="RequestHeader">RequestHeader</a> <a name="requestheader" id="requestheader">Directive</a></h2>
 288 <table class="directive">
 289 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configure HTTP request headers</td></tr>
 290 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RequestHeader add|append|edit|edit*|merge|set|setifempty|unset
 291 <var>header</var> [[expr=]<var>value</var> [<var>replacement</var>]
 292 [early|env=[!]<var>varname</var>|expr=<var>expression</var>]]
 293 </code></td></tr>
 294 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 295 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
 296 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 297 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_headers</td></tr>
 298 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>SetIfEmpty available in 2.4.7 and later, expr=value
 299 available in 2.4.10 and later</td></tr>
 300 </table>
 301     <p>This directive can replace, merge, change or remove HTTP request
 302     headers. The header is modified just before the content handler
 303     is run, allowing incoming headers to be modified. The action it
 304     performs is determined by the first argument. This can be one
 305     of the following values:</p>
 306
 307     <dl>
 308
 309     <dt><code>add</code></dt>
 310     <dd>The request header is added to the existing set of headers,
 311     even if this header already exists. This can result in two
 312     (or more) headers having the same name. This can lead to
 313     unforeseen consequences, and in general <code>set</code>,
 314     <code>append</code> or <code>merge</code> should be used instead.</dd>
 315
 316     <dt><code>append</code></dt>
 317     <dd>The request header is appended to any existing header of the
 318     same name. When a new value is merged onto an existing header
 319     it is separated from the existing header with a comma. This
 320     is the HTTP standard way of giving a header multiple
 321     values.</dd>
 322
 323     <dt><code>edit</code></dt>
 324     <dt><code>edit*</code></dt>
 325     <dd>If this request header exists, its value is transformed according
 326     to a <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular expression</a>
 327     search-and-replace.  The <var>value</var> argument is a <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular expression</a>, and the <var>replacement</var>
 328     is a replacement string, which may contain backreferences or format specifiers.
 329     The <code>edit</code> form will match and replace exactly once
 330     in a header value, whereas the <code>edit*</code> form will replace
 331     <em>every</em> instance of the search pattern if it appears more
 332     than once.</dd>
 333
 334     <dt><code>merge</code></dt>
 335     <dd>The request header is appended to any existing header of
 336     the same name, unless the value to be appended already appears in the
 337     existing header's comma-delimited list of values.  When a new value is
 338     merged onto an existing header it is separated from the existing header
 339     with a comma.  This is the HTTP standard way of giving a header multiple
 340     values.  Values are compared in a case sensitive manner, and after
 341     all format specifiers have been processed.  Values in double quotes
 342     are considered different from otherwise identical unquoted values.</dd>
 343
 344     <dt><code>set</code></dt>
 345     <dd>The request header is set, replacing any previous header
 346     with this name</dd>
 347
 348     <dt><code>setifempty</code></dt>
 349     <dd>The request header is set, but only if there is no previous header
 350     with this name.<br />
 351     Available in 2.4.7 and later.</dd>
 352
 353     <dt><code>unset</code></dt>
 354     <dd>The request header of this name is removed, if it exists. If
 355     there are multiple headers of the same name, all will be removed.
 356     <var>value</var> must be omitted.</dd>
 357     </dl>
 358
 359     <p>This argument is followed by a header name, which can
 360     include the final colon, but it is not required. Case is
 361     ignored. For <code>set</code>, <code>append</code>, <code>merge</code> and
 362     <code>add</code> a <var>value</var> is given as the third argument. If a
 363     <var>value</var> contains spaces, it should be surrounded by double
 364     quotes. For <code>unset</code>, no <var>value</var> should be given.
 365     <var>value</var> may be a character string, a string containing format
 366     specifiers or a combination of both. The supported format specifiers
 367     are the same as for the <code class="directive"><a href="#header">Header</a></code>,
 368     please have a look there for details.  For <code>edit</code> both
 369     a <var>value</var> and a <var>replacement</var> are required, and are
 370     a <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular expression</a> and a
 371     replacement string respectively.</p>
 372
 373     <p>The <code class="directive">RequestHeader</code> directive may be followed by
 374     an additional argument, which may be any of:</p>
 375     <dl>
 376     <dt><code>early</code></dt>
 377     <dd>Specifies <a href="#early">early processing</a>.</dd>
 378     <dt><code>env=[!]<var>varname</var></code></dt>
 379     <dd>The directive is applied if and only if the <a href="../env.html">environment variable</a> <code>varname</code> exists.
 380         A <code>!</code> in front of <code>varname</code> reverses the test,
 381         so the directive applies only if <code>varname</code> is unset.</dd>
 382     <dt><code>expr=<var>expression</var></code></dt>
 383     <dd>The directive is applied if and only if <var>expression</var>
 384         evaluates to true. Details of expression syntax and evaluation are
 385         documented in the <a href="../expr.html">ap_expr</a> documentation.</dd>
 386     </dl>
 387
 388     <p>Except in <a href="#early">early</a> mode, the
 389     <code class="directive">RequestHeader</code> directive is processed
 390     just before the request is run by its handler in the fixup phase.
 391     This should allow headers generated by the browser, or by Apache
 392     input filters to be overridden or modified.</p>
 393
 394 </div>
 395 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 396 <div class="section">
 397 <h2><a name="order" id="order">Order of Processing</a></h2>
 398
 399     <p>The directives provided by <code class="module"><a href="../mod/mod_headers.html">mod_headers</a></code> can
 400     occur almost anywhere within the server configuration, and can be
 401     limited in scope by enclosing them in <a href="../sections.html">configuration sections</a>.</p>
 402
 403     <p>Order of processing is important and is affected both by the
 404     order in the configuration file and by placement in <a href="../sections.html#mergin">configuration sections</a>. These
 405     two directives have a different effect if reversed:</p>
 406
 407     <pre class="prettyprint lang-config">RequestHeader append MirrorID "mirror 12"
 408 RequestHeader unset MirrorID</pre>
 409
 410
 411     <p>This way round, the <code>MirrorID</code> header is not set. If
 412     reversed, the MirrorID header is set to "mirror 12".</p>
 413 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 414 <div class="section">
 415 <h2><a name="early" id="early">Early and Late Processing</a></h2>
 416     <p><code class="module"><a href="../mod/mod_headers.html">mod_headers</a></code> can be applied either early or late
 417     in the request.  The normal mode is late, when <em>Request</em> Headers are
 418     set immediately before running the content generator and <em>Response</em>
 419     Headers just as the response is sent down the wire.  Always use
 420     Late mode in an operational server.</p>
 421
 422     <p>Early mode is designed as a test/debugging aid for developers.
 423     Directives defined using the <code>early</code> keyword are set
 424     right at the beginning of processing the request.  This means
 425     they can be used to simulate different requests and set up test
 426     cases, but it also means that headers may be changed at any time
 427     by other modules before generating a Response.</p>
 428
 429     <p>Because early directives are processed before the request path's
 430     configuration is traversed, early headers can only be set in a
 431     main server or virtual host context.  Early directives cannot depend
 432     on a request path, so they will fail in contexts such as
 433     <code class="directive"><a href="../mod/core.html#directory">&lt;Directory&gt;</a></code> or
 434     <code class="directive"><a href="../mod/core.html#location">&lt;Location&gt;</a></code>.</p>
 435 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 436 <div class="section">
 437 <h2><a name="examples" id="examples">Examples</a></h2>
 438
 439     <ol>
 440       <li>
 441         Copy all request headers that begin with "TS" to the
 442         response headers:
 443
 444         <pre class="prettyprint lang-config">Header echo ^TS</pre>
 445
 446       </li>
 447
 448       <li>
 449         Add a header, <code>MyHeader</code>, to the response including a
 450         timestamp for when the request was received and how long it
 451         took to begin serving the request. This header can be used by
 452         the client to intuit load on the server or in isolating
 453         bottlenecks between the client and the server.
 454
 455         <pre class="prettyprint lang-config">Header set MyHeader "%D %t"</pre>
 456
 457
 458         <p>results in this header being added to the response:</p>
 459
 460         <div class="example"><p><code>
 461           MyHeader: D=3775428 t=991424704447256
 462         </code></p></div>
 463       </li>
 464
 465       <li>
 466         Say hello to Joe
 467
 468         <pre class="prettyprint lang-config">Header set MyHeader "Hello Joe. It took %D microseconds for Apache to serve this request."</pre>
 469
 470
 471         <p>results in this header being added to the response:</p>
 472
 473         <div class="example"><p><code>
 474           MyHeader: Hello Joe. It took D=3775428 microseconds for Apache
 475           to serve this request.
 476         </code></p></div>
 477       </li>
 478
 479       <li>
 480         Conditionally send <code>MyHeader</code> on the response if and
 481         only if header <code>MyRequestHeader</code> is present on the request.
 482         This is useful for constructing headers in response to some client
 483         stimulus. Note that this example requires the services of the
 484         <code class="module"><a href="../mod/mod_setenvif.html">mod_setenvif</a></code> module.
 485
 486         <pre class="prettyprint lang-config">SetEnvIf MyRequestHeader myvalue HAVE_MyRequestHeader
 487 Header set MyHeader "%D %t mytext" env=HAVE_MyRequestHeader</pre>
 488
 489
 490         <p>If the header <code>MyRequestHeader: myvalue</code> is present on
 491         the HTTP request, the response will contain the following header:</p>
 492
 493         <div class="example"><p><code>
 494           MyHeader: D=3775428 t=991424704447256 mytext
 495         </code></p></div>
 496       </li>
 497
 498       <li>
 499         Enable DAV to work with Apache running HTTP through SSL hardware
 500         (<a href="http://svn.haxx.se/users/archive-2006-03/0549.shtml">problem
 501         description</a>) by replacing <var>https:</var> with
 502         <var>http:</var> in the <var>Destination</var> header:
 503
 504         <pre class="prettyprint lang-config">RequestHeader edit Destination ^https: http: early</pre>
 505
 506       </li>
 507
 508       <li>
 509         Set the same header value under multiple nonexclusive conditions,
 510         but do not duplicate the value in the final header.
 511         If all of the following conditions applied to a request (i.e.,
 512         if the <code>CGI</code>, <code>NO_CACHE</code> and
 513         <code>NO_STORE</code> environment variables all existed for the
 514         request):
 515
 516         <pre class="prettyprint lang-config">Header merge Cache-Control no-cache env=CGI
 517 Header merge Cache-Control no-cache env=NO_CACHE
 518 Header merge Cache-Control no-store env=NO_STORE</pre>
 519
 520
 521         <p>then the response would contain the following header:</p>
 522
 523         <div class="example"><p><code>
 524           Cache-Control: no-cache, no-store
 525         </code></p></div>
 526
 527         <p>If <code>append</code> was used instead of <code>merge</code>,
 528         then the response would contain the following header:</p>
 529
 530         <div class="example"><p><code>
 531           Cache-Control: no-cache, no-cache, no-store
 532         </code></p></div>
 533       </li>
 534       <li>
 535         Set a test cookie if and only if the client didn't send us a cookie
 536         <pre class="prettyprint lang-config">Header set Set-Cookie testcookie "expr=-z %{req:Cookie}"</pre>
 537
 538       </li>
 539       <li>
 540         Append a Caching header for responses with a HTTP status code of 200
 541         <pre class="prettyprint lang-config">Header append Cache-Control s-maxage=600 "expr=%{REQUEST_STATUS} == 200"</pre>
 542
 543       </li>
 544
 545     </ol>
 546 </div>
 547 </div>
 548 <div class="bottomlang">
 549 <p><span>Available Languages: </span><a href="../en/mod/mod_headers.html" title="English">&nbsp;en&nbsp;</a> |
 550 <a href="../fr/mod/mod_headers.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
 551 <a href="../ja/mod/mod_headers.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 552 <a href="../ko/mod/mod_headers.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 553 </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&amp;A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
 554 <script type="text/javascript"><!--//--><![CDATA[//><!--
 555 var comments_shortname = 'httpd';
 556 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_headers.html';
 557 (function(w, d) {
 558     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 559         d.write('<div id="comments_thread"><\/div>');
 560         var s = d.createElement('script');
 561         s.type = 'text/javascript';
 562         s.async = true;
 563         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 564         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 565     }
 566     else {
 567         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 568     }
 569 })(window, document);
 570 //--><!]]></script></div><div id="footer">
 571 <p class="apache">Copyright 2015 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>
 572 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
 573 if (typeof(prettyPrint) !== 'undefined') {
 574     prettyPrint();
 575 }
 576 //--><!]]></script>
 577 </body></html>