mod_headers - Apache HTTP Server Version 2.5
Modules | Directives | FAQ | Glossary | Sitemap | Report a bug Apache HTTP Server Version 2.5 Apache > HTTP Server > Documentation > Version 2.5 > Modules Apache Module mod_headers Available Languages: en | fr | ja | ko Description: Customization of HTTP request and response headers Status: Extension Module Identifier: headers_module Source File: mod_headers.c Summary This module provides directives to control and modify HTTP request and response headers.
Headers can be merged, replaced or removed. Topics Order of Processing Early and Late Processing Examples Directives Header RequestHeader Bugfix checklist httpd changelog Known issues Report a bug Order of Processing ¶ The directives provided by mod_headers can occur almost anywhere within the server configuration, and can be limited in scope by enclosing them in configuration sections . Order of processing is important and is affected both by the order in the configuration file and by placement in configuration sections .
These two directives have a different effect if reversed: RequestHeader append MirrorID "mirror 12" RequestHeader unset MirrorID This way round, the MirrorID header is not set. If reversed, the MirrorID header is set to "mirror 12". Early and Late Processing ¶ mod_headers can be applied either early or late in the request. The normal mode is late, when Request Headers are set immediately before running the content generator and Response Headers just as the response is sent down the wire.
Always use Late mode in an operational server. Early mode is designed as a test/debugging aid for developers. Directives defined using the early keyword are set right at the beginning of processing the request. This means they can be used to simulate different requests and set up test cases, but it also means that headers may be changed at any time by other modules before generating a Response. Because early directives are processed before the request path's configuration is traversed, early headers can only be set in a main server or virtual host context.
Early directives cannot depend on a request path, so they will fail in contexts such as <Directory> or <Location> . Examples ¶ Copy all request headers that begin with "TS" to the response headers: Header echo ^TS Add a header, MyHeader , to the response including a timestamp for when the request was received and how long it took to begin serving the request. This header can be used by the client to intuit load on the server or in isolating bottlenecks between the client and the server.
Header set MyHeader "%D %t" results in this header being added to the response: MyHeader: D=3775428 t=991424704447256 Say hello to Joe Header set MyHeader "Hello Joe. It took %D microseconds for Apache to serve this request." results in this header being added to the response: MyHeader: Hello Joe. It took D=3775428 microseconds for Apache to serve this request. 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. SetEnvIf MyRequestHeader myvalue HAVE_MyRequestHeader Header set MyHeader "%D %t mytext" env=HAVE_MyRequestHeader If the header MyRequestHeader: myvalue is present on the HTTP request, the response will contain the following header: MyHeader: D=3775428 t=991424704447256 mytext Enable DAV to work with Apache running HTTP through SSL hardware ( problem description ) by replacing https: with http: in the Destination header: RequestHeader edit Destination ^https: http: early Set the same header value under multiple nonexclusive conditions, but do not duplicate the value in the final header.
If all of the following conditions applied to a request (i.e., if the CGI , NO_CACHE and NO_STORE environment variables all existed for the request): Header merge Cache-Control no-cache env=CGI Header merge Cache-Control no-cache env=NO_CACHE Header merge Cache-Control no-store env=NO_STORE then the response would contain the following header: Cache-Control: no-cache, no-store If append was used instead of merge , then the response would contain the following header: Cache-Control: no-cache, no-cache, no-store Set a test cookie if and only if the client didn't send us a cookie Header set Set-Cookie testcookie "expr=-z %{req:Cookie}" Append a Caching header for responses with a HTTP status code of 200 Header append Cache-Control s-maxage=600 "expr=%{REQUEST_STATUS} == 200" Header Directive ¶ Description: Configure HTTP response headers Syntax: Header [ condition ] add|append|echo|edit|edit*|merge|set|setifempty|unset|note header [[expr=] value [ replacement ] [early|env=[!] varname |expr= expression ]] Context: server config, virtual host, directory, .htaccess Override: FileInfo Status: Extension Module: mod_headers Compatibility: SetIfEmpty available in 2.4.7 and later, expr=value available in 2.4.10 and later 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 optional condition argument determines which internal table of responses headers this directive will operate against: onsuccess (default, can be omitted) or always . Guidance on when to specify always is provided relative to each action below. Warning Carefully read the difference between always and onsuccess for each action listed below as the behavior can be unintuitive and is a frequent source of confusion.
Where the guidance suggest repeating the conditions, it is safe to try each experimentally and use the one you find effective to match the pre-existing header. add 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 set , append or merge should be used instead.
Choosing a condition : Specify a condition of always if you want the header to be included in non-2xx response (such as redirects or errors) append 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. Note that the Set-Cookie header is an exception: RFC 6265 requires multiple Set-Cookie headers rather than combining values with commas.
Use add instead of append for Set-Cookie . Choosing a condition : If the existing header to be appended to was added by this module, you must match the condition parameter that was originally used. Otherwise, you must determine by trial and error whether always should be specified because you can't reliably know which internal table the existing value is present in. echo Request headers with this name are echoed back in the response headers. header may be a regular expression . value must be omitted.
Choosing a condition : Specify a condition of always if you want the header to be included in non-2xx response (such as redirects or errors). edit edit* If this response header exists, its value is transformed according to a regular expression search-and-replace. The value argument is a regular expression , and the replacement is a replacement string, which may contain backreferences or format specifiers. The edit form will match and replace exactly once in a header value, whereas the edit* form will replace every instance of the search pattern if it appears more than once.
Choosing a condition : Depending on the origins of the header to be edited, you may have to repeat your edit/edit* directive with both always and onsuccess . Alternatively, determine by experimentation whether a condition of always is necessary. merge The response header is appended to any existing header of the same name, unless the value to be appended al
The rest of this page is on the live site.