mod_headers.html revision 240a5b8962329911d02566b600be6226e1f857ae
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M SlusarzXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
630c1df5b6aaec452b0ef040df56cffd978fe9c3Timo Sirainen This file is generated from xml source: DO NOT EDIT
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M SlusarzXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz--><title>mod_headers - Apache HTTP Server</title><link rel="stylesheet" type="text/css" href="/style/manual.css"/></head><body><blockquote><div align="center"><img src="/images/sub.gif" alt="[APACHE DOCUMENTATION]"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_headers</h1><table bgcolor="#cccccc" cellpadding="0" cellspacing="1"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td>Customization of HTTP request
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz and response headers</td></tr><tr><td><a class="help" href="module-dict.html#Status">Status:</a></td><td>Extension</td></tr><tr><td><a class="help" href="module-dict.html#ModuleIdentifier">Module&nbsp;Identifier:</a></td><td>headers_module</td></tr><tr><td valign="top" align="left"><a class="help" href="module-dict.html#Compatibility">Compatibility:</a></td><td><compatibility>RequestHeader is available only in Apache 2.0</compatibility></td></tr></table></td></tr></table><h2>Summary</h2>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz <p>This module provides directives to control and modify HTTP
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz request and response headers. Headers can be merged, replaced
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz or removed.</p>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz<h2>Directives</h2><ul><li><a href="#header">Header</a></li><li><a href="#requestheader">RequestHeader</a></li></ul><h2>Order of Processing</h2>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz <p>The directives provided by mod_header can occur almost
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz anywhere within the server configuration. They are valid in the
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz main server config and virtual host sections, inside
1265ab7fdd2e88a1f4b1057593c5e0dbe3fb757aMichael M Slusarz &lt;Directory&gt;, &lt;Location&gt; and &lt;Files&gt; sections,
1265ab7fdd2e88a1f4b1057593c5e0dbe3fb757aMichael M Slusarz and within .htaccess files.</p>
1265ab7fdd2e88a1f4b1057593c5e0dbe3fb757aMichael M Slusarz
1265ab7fdd2e88a1f4b1057593c5e0dbe3fb757aMichael M Slusarz <p>The directives are processed in the following order:</p>
1265ab7fdd2e88a1f4b1057593c5e0dbe3fb757aMichael M Slusarz
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz <ol>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz <li>main server</li>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz <li>virtual host</li>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz <li>&lt;Directory&gt; sections and .htaccess</li>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz <li>&lt;Location&gt;</li>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz <li>&lt;Files&gt;</li>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz </ol>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz <p>Order is important. These two headers have a different
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz effect if reversed:</p>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M SlusarzRequestHeader append MirrorID "mirror 12"<br/>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz RequestHeader unset MirrorID
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz</code></td></tr></table></blockquote>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz <p>This way round, the MirrorID header is not set. If reversed,
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz the MirrorID header is set to "mirror 12".</p>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz<h2>Example</h2>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz <ol>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz <li>Copy all request headers that begin with "TS" to the
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz response headers:
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz Header echo ^TS*
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz</code></td></tr></table></blockquote></li>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz <li>Add a header, MyHeader, to the response including a
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz timestamp for when the request was received and how long it
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz took to begin serving the request. This header can be used by
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz the client to intuit load on the server or in isolating
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz bottlenecks between the client and the server.
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz Header add MyHeader "%D %t"
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz</code></td></tr></table></blockquote>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz results in this header being added to the response:
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz MyHeader: D=3775428 t=991424704447256
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz</code></td></tr></table></blockquote>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz </li>
51ed197520dd9ea534fbc3bc1790ebe3cb5421e2Michael M Slusarz
<li>Say hello to Joe
<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
Header add MyHeader "Hello Joe. It took %D microseconds for Apache to serve this request."
</code></td></tr></table></blockquote>
results in this header being added to the response:
<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
MyHeader: Hello Joe. It took D=3775428 microseconds for Apache to serve this request.
</code></td></tr></table></blockquote>
</li>
<li>Conditionally send MyHeader on the response if and only
if header "MyRequestHeader" is present on the request. This
is useful for constructing headers in response to some client
stimulus. Note that this example requires the services of the
mod_setenvif module.
<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
SetEnvIf MyRequestHeader value HAVE_MyRequestHeader<br/>
Header add MyHeader "%D %t mytext" env=HAVE_MyRequestHeader
</code></td></tr></table></blockquote>
If the header "MyRequestHeader: value" is present on the
HTTP request, the response will contain the following
header:
<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
MyHeader: D=3775428 t=991424704447256 mytext
</code></td></tr></table></blockquote>
</li>
</ol>
<hr/><h2><a name="Header">Header</a> <a name="header">Directive</a></h2><table bgcolor="#cccccc" border="0" cellspacing="0" cellpadding="1"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Configure HTTP response headers</td></tr><tr><td><a class="help" href="directive-dict.html#Syntax">Syntax:</a></td><td>Header set|append|add|unset|echo <em>header</em>
[<em>value</em>]</td></tr><tr><td><a class="help" href="directive-dict.html#Context">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a class="help" href="directive-dict.html#Override">Override:</a></td><td>FileInfo</td></tr><tr><td><a class="help" href="directive-dict.html#Status">Status:</a></td><td>Extension</td></tr><tr><td><a class="help" href="directive-dict.html#Module">Module:</a></td><td>mod_headers</td></tr></table></td></tr></table>
<p>This directive can replace, merge or remove HTTP response
headers. The header is modified just after the content handler
and output filters are run, allowing outgoing headers to be
modified. The action it performs is determined by the first
argument. This can be one of the following values:</p>
<ul>
<li><strong>set</strong><br/>
The response header is set, replacing any previous header
with this name. The <em>value</em> may be a format
string.</li>
<li><strong>append</strong><br/>
The response header is appended to any existing header of
the same name. When a new value is merged onto an existing
header it is separated from the existing header with a comma.
This is the HTTP standard way of giving a header multiple
values.</li>
<li><strong>add</strong><br/>
The response header is added to the existing set of headers,
even if this header already exists. This can result in two
(or more) headers having the same name. This can lead to
unforeseen consequences, and in general "append" should be
used instead.</li>
<li><strong>unset</strong><br/>
The response header of this name is removed, if it exists.
If there are multiple headers of the same name, all will be
removed.</li>
<li><strong>echo</strong><br/>
Request headers with this name are echoed back in the
response headers. <em>header</em> may be a regular
expression.</li>
</ul>
<p>This argument is followed by a <em>header</em> name, which
can include the final colon, but it is not required. Case is
ignored for set, append, add and unset. The <em>header</em>
name for echo is case sensitive and may be a regular
expression.</p>
<p>For <code>add</code>, <code>append</code> and
<code>set</code> a <em>value</em> is specified as the third
argument. If <em>value</em> contains spaces, it should be
surrounded by doublequotes. <em>value</em> may be a character
string, a string containing format specifiers or a combination
of both. The following format specifiers are supported in
<em>value</em>:</p>
<table>
<tr><td>%t: </td> <td>The time the request was received in Universal
Coordinated Time since the epoch (Jan. 1, 1970) measured in
microseconds. The value is preceded by "t=".</td></tr>
<tr><td>%D: </td> <td>The time from when the request was received to
the time the headers are sent on the wire. This is a measure of the
duration of the request. The value is preceded by "D=".</td></tr>
<tr><td>%{FOOBAR}e:</td> <td>The contents of the <a href="/env.html">environment
variable</a> FOOBAR.</td></tr>
</table>
<p>When the <code class="directive">Header</code> directive is used with the
<code>add</code>, <code>append</code>, or <code>set</code>
argument, a fourth argument may be used to specify conditions
under which the action will be taken. If the <a href="/env.html">environment variable</a> specified in the
<code>env=...</code> argument exists (or if the environment
variable does not exist and <code>env=!...</code> is specified)
then the action specified by the <code class="directive">Header</code> directive
will take effect. Otherwise, the directive will have no effect
on the request.</p>
<p>The Header directives are processed just before the response
is sent to the network. These means that it is possible to set
and/or override most headers, except for those headers added by
the header filter.</p>
<hr/><h2><a name="RequestHeader">RequestHeader</a> <a name="requestheader">Directive</a></h2><table bgcolor="#cccccc" border="0" cellspacing="0" cellpadding="1"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Configure HTTP request headers</td></tr><tr><td><a class="help" href="directive-dict.html#Syntax">Syntax:</a></td><td>RequestHeader set|append|add|unset <em>header</em>
[<em>value</em>]</td></tr><tr><td><a class="help" href="directive-dict.html#Context">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a class="help" href="directive-dict.html#Override">Override:</a></td><td>FileInfo</td></tr><tr><td><a class="help" href="directive-dict.html#Status">Status:</a></td><td>Extension</td></tr><tr><td><a class="help" href="directive-dict.html#Module">Module:</a></td><td>mod_headers</td></tr></table></td></tr></table>
<p>This directive can replace, merge or remove HTTP request
headers. The header is modified just before the content handler
is run, allowing incoming headers to be modified. The action it
performs is determined by the first argument. This can be one
of the following values:</p>
<ul>
<li><strong>set</strong><br/>
The request header is set, replacing any previous header
with this name</li>
<li><strong>append</strong><br/>
The request header is appended to any existing header of the
same name. When a new value is merged onto an existing header
it is separated from the existing header with a comma. This
is the HTTP standard way of giving a header multiple
values.</li>
<li><strong>add</strong><br/>
The request header is added to the existing set of headers,
even if this header already exists. This can result in two
(or more) headers having the same name. This can lead to
unforeseen consequences, and in general "append" should be
used instead.</li>
<li><strong>unset</strong><br/>
The request header of this name is removed, if it exists. If
there are multiple headers of the same name, all will be
removed.</li>
</ul>
<p>This argument is followed by a header name, which can
include the final colon, but it is not required. Case is
ignored. For <code>add</code>, <code>append</code> and
<code>set</code> a value is given as the third argument. If
this value contains spaces, it should be surrounded by double
quotes. For unset, no value should be given.</p>
<p>The <code class="directive">RequestHeader</code> directive is processed
just before the request is run by its handler in the fixup phase.
This should allow headers generated by the browser, or by Apache
input filters to be overridden or modified.</p>
<hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img src="/images/index.gif" alt="Index"/></a><a href="../"><img src="/images/home.gif" alt="Home"/></a></blockquote></body></html>