Configuration Sections - Apache HTTP Server Version 2.2 (original) (raw)

Please note

This document refers to the 2.2 version of Apache httpd, which is no longer maintained. The active release is documented here. If you have not already upgraded, please follow this link for more information.

You may follow this link to go to the current version of this document.

Available Languages: en | fr | ja | ko | tr

Directives in the configuration files may apply to the entire server, or they may be restricted to apply only to particular directories, files, hosts, or URLs. This document describes how to use configuration section containers or .htaccess files to change the scope of other configuration directives.

Comments

Types of Configuration Section Containers

There are two basic types of containers. Most containers are evaluated for each request. The enclosed directives are applied only for those requests that match the containers. The [<IfDefine>](./mod/core.html#ifdefine), [<IfModule>](./mod/core.html#ifmodule), and[<IfVersion>](./mod/mod%5Fversion.html#ifversion)containers, on the other hand, are evaluated only at server startup and restart. If their conditions are true at startup, then the enclosed directives will apply to all requests. If the conditions are not true, the enclosed directives will be ignored.

The [<IfDefine>](./mod/core.html#ifdefine) directive encloses directives that will only be applied if an appropriate parameter is defined on the [httpd](./programs/httpd.html) command line. For example, with the following configuration, all requests will be redirected to another site only if the server is started usinghttpd -DClosedForNow:

Redirect / http://otherserver.example.com/

The [<IfModule>](./mod/core.html#ifmodule)directive is very similar, except it encloses directives that will only be applied if a particular module is available in the server. The module must either be statically compiled in the server, or it must be dynamically compiled and its [LoadModule](./mod/mod%5Fso.html#loadmodule) line must be earlier in the configuration file. This directive should only be used if you need your configuration file to work whether or not certain modules are installed. It should not be used to enclose directives that you want to work all the time, because it can suppress useful error messages about missing modules.

In the following example, the [MimeMagicFile](./mod/mod%5Fmime%5Fmagic.html#mimemagicfile) directive will be applied only if [mod_mime_magic](./mod/mod%5Fmime%5Fmagic.html) is available.

MimeMagicFile conf/magic

The [<IfVersion>](./mod/mod%5Fversion.html#ifversion)directive is very similar to [<IfDefine>](./mod/core.html#ifdefine) and [<IfModule>](./mod/core.html#ifmodule), except it encloses directives that will only be applied if a particular version of the server is executing. This module is designed for the use in test suites and large networks which have to deal with different httpd versions and different configurations.

= 2.1> # this happens only in versions greater or # equal 2.1.0.

[<IfDefine>](./mod/core.html#ifdefine),[<IfModule>](./mod/core.html#ifmodule), and the[<IfVersion>](./mod/mod%5Fversion.html#ifversion)can apply negative conditions by preceding their test with "!". Also, these sections can be nested to achieve more complex restrictions.

Filesystem and Webspace

The most commonly used configuration section containers are the ones that change the configuration of particular places in the filesystem or webspace. First, it is important to understand the difference between the two. The filesystem is the view of your disks as seen by your operating system. For example, in a default install, Apache resides at /usr/local/apache2 in the Unix filesystem or "c:/Program Files/Apache Group/Apache2" in the Windows filesystem. (Note that forward slashes should always be used as the path separator in Apache, even for Windows.) In contrast, the webspace is the view of your site as delivered by the web server and seen by the client. So the path /dir/ in the webspace corresponds to the path/usr/local/apache2/htdocs/dir/ in the filesystem of a default Apache install on Unix. The webspace need not map directly to the filesystem, since webpages may be generated dynamically from databases or other locations.

Filesystem Containers

The [<Directory>](./mod/core.html#directory)and [<Files>](./mod/core.html#files)directives, along with their regexcounterparts, apply directives to parts of the filesystem. Directives enclosed in a [<Directory>](./mod/core.html#directory) section apply to the named filesystem directory and all subdirectories of that directory (as well as the files in those directories). The same effect can be obtained using .htaccess files. For example, in the following configuration, directory indexes will be enabled for the/var/web/dir1 directory and all subdirectories.

<Directory /var/web/dir1> Options +Indexes

Directives enclosed in a [<Files>](./mod/core.html#files) section apply to any file with the specified name, regardless of what directory it lies in. So for example, the following configuration directives will, when placed in the main section of the configuration file, deny access to any file named private.html regardless of where it is found.

Order allow,deny Deny from all

To address files found in a particular part of the filesystem, the[<Files>](./mod/core.html#files) and[<Directory>](./mod/core.html#directory) sections can be combined. For example, the following configuration will deny access to /var/web/dir1/private.html,/var/web/dir1/subdir2/private.html,/var/web/dir1/subdir3/private.html, and any other instance of private.html found under the /var/web/dir1/directory.

<Directory /var/web/dir1> Order allow,deny Deny from all

Webspace Containers

The [<Location>](./mod/core.html#location)directive and its regex counterpart, on the other hand, change the configuration for content in the webspace. For example, the following configuration prevents access to any URL-path that begins in /private. In particular, it will apply to requests forhttp://yoursite.example.com/private,http://yoursite.example.com/private123, andhttp://yoursite.example.com/private/dir/file.html as well as any other requests starting with the /private string.

<LocationMatch ^/private> Order Allow,Deny Deny from all

The [<Location>](./mod/core.html#location)directive need not have anything to do with the filesystem. For example, the following example shows how to map a particular URL to an internal Apache handler provided by [mod_status](./mod/mod%5Fstatus.html). No file called server-status needs to exist in the filesystem.

<Location /server-status> SetHandler server-status

Wildcards and Regular Expressions

The [<Directory>](./mod/core.html#directory),[<Files>](./mod/core.html#files), and[<Location>](./mod/core.html#location)directives can each use shell-style wildcard characters as infnmatch from the C standard library. The character "*" matches any sequence of characters, "?" matches any single character, and "[_seq_]" matches any character in seq. The "/" character will not be matched by any wildcard; it must be specified explicitly.

If even more flexible matching is required, each container has a regular expression (regex) counterpart [<DirectoryMatch>](./mod/core.html#directorymatch), [<FilesMatch>](./mod/core.html#filesmatch), and [<LocationMatch>](./mod/core.html#locationmatch) that allow perl-compatibleregular expressionsto be used in choosing the matches. But see the section below on configuration merging to find out how using regex sections will change how directives are applied.

A non-regex wildcard section that changes the configuration of all user directories could look as follows:

<Directory /home/*/public_html> Options Indexes

Using regex sections, we can deny access to many types of image files at once:

<FilesMatch .(?i:gif|jpe?g|png)$> Order allow,deny Deny from all

What to use When

Choosing between filesystem containers and webspace containers is actually quite easy. When applying directives to objects that reside in the filesystem always use [<Directory>](./mod/core.html#directory) or [<Files>](./mod/core.html#files). When applying directives to objects that do not reside in the filesystem (such as a webpage generated from a database), use [<Location>](./mod/core.html#location).

It is important to never use [<Location>](./mod/core.html#location) when trying to restrict access to objects in the filesystem. This is because many different webspace locations (URLs) could map to the same filesystem location, allowing your restrictions to be circumvented. For example, consider the following configuration:

<Location /dir/> Order allow,deny Deny from all

This works fine if the request is forhttp://yoursite.example.com/dir/. But what if you are on a case-insensitive filesystem? Then your restriction could be easily circumvented by requestinghttp://yoursite.example.com/DIR/. The [<Directory>](./mod/core.html#directory) directive, in contrast, will apply to any content served from that location, regardless of how it is called. (An exception is filesystem links. The same directory can be placed in more than one part of the filesystem using symbolic links. The [<Directory>](./mod/core.html#directory) directive will follow the symbolic link without resetting the pathname. Therefore, for the highest level of security, symbolic links should be disabled with the appropriate[Options](./mod/core.html#options) directive.)

If you are, perhaps, thinking that none of this applies to you because you use a case-sensitive filesystem, remember that there are many other ways to map multiple webspace locations to the same filesystem location. Therefore you should always use the filesystem containers when you can. There is, however, one exception to this rule. Putting configuration restrictions in a <Location /> section is perfectly safe because this section will apply to all requests regardless of the specific URL.

Proxy

The [<Proxy>](./mod/mod%5Fproxy.html#proxy)and [<ProxyMatch>](./mod/mod%5Fproxy.html#proxymatch)containers apply enclosed configuration directives only to sites accessed through [mod_proxy](./mod/mod%5Fproxy.html)'s proxy server that match the specified URL. For example, the following configuration will allow only a subset of clients to access thewww.example.com website using the proxy server:

<Proxy "" title="undefined" rel="noopener noreferrer">http://www.example.com/*"> Order allow,deny Allow from 192.168.1.104 192.168.1.205 Deny from all

How the sections are merged

The configuration sections are applied in a very particular order. Since this can have important effects on how configuration directives are interpreted, it is important to understand how this works.

The order of merging is:

[<Directory>](./mod/core.html#directory) (except regular expressions) and .htaccess done simultaneously (with.htaccess, if allowed, overriding[<Directory>](./mod/core.html#directory))
[<DirectoryMatch>](./mod/core.html#directorymatch) (and <Directory ~>)
[<Files>](./mod/core.html#files) and [<FilesMatch>](./mod/core.html#filesmatch) done simultaneously
[<Location>](./mod/core.html#location) and [<LocationMatch>](./mod/core.html#locationmatch) done simultaneously

Apart from [<Directory>](./mod/core.html#directory), each group is processed in the order that they appear in the configuration files. [<Directory>](./mod/core.html#directory) (group 1 above) is processed in the order shortest directory component to longest. So for example, <Directory /var/web/dir> will be processed before <Directory /var/web/dir/subdir>. If multiple [<Directory>](./mod/core.html#directory) sections apply to the same directory they are processed in the configuration file order. Configurations included via the [Include](./mod/core.html#include) directive will be treated as if they were inside the including file at the location of the[Include](./mod/core.html#include) directive.

Sections inside [<VirtualHost>](./mod/core.html#virtualhost) sections are applied after the corresponding sections outside the virtual host definition. This allows virtual hosts to override the main server configuration.

When the request is served by [mod_proxy](./mod/mod%5Fproxy.html), the[<Proxy>](./mod/mod%5Fproxy.html#proxy) container takes the place of the [<Directory>](./mod/core.html#directory) container in the processing order.

Technical Note

There is actually a<Location>/<LocationMatch> sequence performed just before the name translation phase (where Aliases and DocumentRoots are used to map URLs to filenames). The results of this sequence are completely thrown away after the translation has completed.

Relationship between modules and configuration sections

One question that often arises after reading how configuration sections are merged is related to how and when directives of specific modules like [mod_rewrite](./mod/mod%5Frewrite.html) are processed. The answer is not trivial and needs a bit of background. Each httpd module manages its own configuration, and each of its directives in httpd.conf specify one piece of configuration in a particular context. httpd does not execute a command as it is read.

At runtime, the core of httpd iterates over the defined configuration sections in the order described above to determine which ones apply to the current request. When the first section matches, it is considered the current configuration for this request. If a subsequent section matches too, then each module with a directive in either of the sections is given a chance to merge its configuration between the two sections. The result is a third configuration, and the process goes on until all the configuration sections are evaluated.

After the above step, the "real" processing of the HTTP request begins: each module has a chance to run and perform whatever tasks they like. They can retrieve their own final merged configuration from the core of the httpd to determine how they should act.

An example can help to visualize the whole process. The following configuration uses the [Header](./mod/mod%5Fheaders.html#header) directive of [mod_headers](./mod/mod%5Fheaders.html) to set a specific HTTP header. What value will httpd set in the CustomHeaderName header for a request to/example/index.html ?

<Directory "/"> Header set CustomHeaderName one <FilesMatch ".*"> Header set CustomHeaderName three

<Directory "/example"> Header set CustomHeaderName two

Directory "/" matches and an initial configuration to set the CustomHeaderName header with the value one is created.
Directory "/example" matches, and since [mod_headers](./mod/mod%5Fheaders.html) specifies in its code to override in case of a merge, a new configuration is created to set the CustomHeaderName header with the value two.
FilesMatch ".*" matches and another merge opportunity arises, causing the CustomHeaderName header to be set with the value three.
Eventually during the next steps of the HTTP request processing [mod_headers](./mod/mod%5Fheaders.html) will be called and it will receive the configuration to set the CustomHeaderName header with the value three. [mod_headers](./mod/mod%5Fheaders.html) normally uses this configuration to perfom its job, namely setting the foo header. This does not mean that a module can't perform a more complex action like discarding directives because not needed or deprecated, etc..

This is true for .htaccess too since they have the same priority as Directory in the merge order. The important concept to understand is that configuration sections like Directory and FilesMatch are not comparable to module specific directives like [Header](./mod/mod%5Fheaders.html#header) or [RewriteRule](./mod/mod%5Frewrite.html#rewriterule) because they operate on different levels.

Some Examples

Below is an artificial example to show the order of merging. Assuming they all apply to the request, the directives in this example will be applied in the order A > B > C > D > E.

<Location "/"> E

<Files "f.html"> D

<VirtualHost *> <Directory "/a/b"> B

<DirectoryMatch "^.*b$"> C

<Directory "/a/b"> A

For a more concrete example, consider the following. Regardless of any access restrictions placed in [<Directory>](./mod/core.html#directory) sections, the [<Location>](./mod/core.html#location) section will be evaluated last and will allow unrestricted access to the server. In other words, order of merging is important, so be careful!

<Location "/"> Require all granted

Woops! This section will have no effect

<Directory "/"> Require all granted Require not host badguy.example.com