summaryrefslogtreecommitdiff
path: root/docs/manual/mod/mod_headers.html
blob: da1d7e19bc3b8107d95b066849ad1ec55bf43ecd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML>
<HEAD>
<TITLE>Apache module mod_headers</TITLE>
</HEAD>

<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
<BODY
 BGCOLOR="#FFFFFF"
 TEXT="#000000"
 LINK="#0000FF"
 VLINK="#000080"
 ALINK="#FF0000"
>
<!--#include virtual="header.html" -->
<H1 ALIGN="CENTER">Module mod_headers</H1>

<p>This module provides for the customization of HTTP
response headers.</p>

<P><A
HREF="module-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> Extension
<BR>
<A
HREF="module-dict.html#SourceFile"
REL="Help"
><STRONG>Source File:</STRONG></A> mod_headers.c
<BR>
<A
HREF="module-dict.html#ModuleIdentifier"
REL="Help"
><STRONG>Module Identifier:</STRONG></A> headers_module
<BR>
<A
HREF="module-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> Available in Apache 1.2 and later.
</P>

<h2>Summary</h2>

This module provides a directive to control the sending of HTTP
headers.  Headers can be merged, replaced or removed. 

<H2>Directives</H2>
<UL>
<LI><A HREF="#header">Header</A>
</UL>

<HR>

<H2><A NAME="header">Header</A> directive</H2>
<A
 HREF="directive-dict.html#Syntax"
 REL="Help"
><STRONG>Syntax:</STRONG></A> Header set|append|add
 <EM>header</EM> <EM>value</EM><BR>
<A
 HREF="directive-dict.html#Syntax"
 REL="Help"
><STRONG>Syntax:</STRONG></A> Header unset <EM>header</EM><BR>
<A
 HREF="directive-dict.html#Context"
 REL="Help"
><STRONG>Context:</STRONG></A> server config, virtual host, access.conf,
 .htaccess<BR>
<A
 HREF="directive-dict.html#Override"
 REL="Help"
><STRONG>Override:</STRONG></A> FileInfo<BR>
<A
 HREF="directive-dict.html#Status"
 REL="Help"
><STRONG>Status:</STRONG></A> Extension<BR>
<A
 HREF="directive-dict.html#Module"
 REL="Help"
><STRONG>Module:</STRONG></A> mod_header<P>

This directive can replace, merge or remove HTTP response headers. The
action it performs is determined by the first argument. This can be one
of the following values:

<UL>
<LI><STRONG>set</STRONG><BR>
  The response header is set, replacing any previous header with this name

<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><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><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.
</UL>

This argument is followed by a header name, which can include the
final colon, but it is not required. Case is ignored. For
add, append and set 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.

<H3>Order of Processing</H3>

The Header directive can occur almost anywhere within the server
configuration. It is valid in the main server config and virtual host
sections, inside &lt;Directory&gt;, &lt;Location&gt; and &lt;Files&gt;
sections, and within .htaccess files.
<P>
The Header directives are processed in the following order:
<OL>
<LI>main server
<LI>virtual host
<LI>&lt;Directory&gt; sections and .htaccess
<LI>&lt;Location&gt;
<LI>&lt;Files&gt;
</OL>

Order is important. These two headers have a different effect if reversed:
<PRE>
Header append Author "John P. Doe"
Header unset Author
</PRE>

This way round, the Author header is not set. If reversed, the Author
header is set to "John P. Doe".
<P>

The Header directives are processed just before the response is sent
by its handler. These means that some headers that are added just
before the response is sent cannot be unset or overridden. This
includes headers such as "Date" and "Server".
<P>

<!--#include virtual="footer.html" -->
</BODY>
</HTML>