sections.html.en revision b475917ddf898282aa51ce31b3275c2c4783ce98
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
-->
<title>Configuration Sections - Apache HTTP Server Version 2.5</title>
<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
<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" />
</script>
<body id="manual-page"><div id="page-header">
<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>
<p class="apache">Apache HTTP Server Version 2.5</p>
<div id="path">
<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="./">Version 2.5</a></div><div id="page-content"><div id="preamble"><h1>Configuration Sections</h1>
<div class="toplang">
<p><span>Available Languages: </span><a href="/en/sections.html" title="English"> en </a> |
</div>
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 <code>.htaccess</code> files
to change the scope of other configuration directives.</p>
</div>
<div id="quickview"><ul id="toc"><li><img alt="" src="/images/down.gif" /> <a href="#types">Types of Configuration Section Containers</a></li>
<li><img alt="" src="/images/down.gif" /> <a href="#file-and-web">Filesystem, Webspace, and Boolean Expressions</a></li>
<li><img alt="" src="/images/down.gif" /> <a href="#whatwhere">What Directives are Allowed?</a></li>
</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
<div class="section">
<h2><a name="types" id="types">Types of Configuration Section Containers</a></h2>
<table class="related"><tr><th>Related Modules</th><th>Related Directives</th></tr><tr><td><ul><li><code class="module"><a href="/mod/core.html">core</a></code></li><li><code class="module"><a href="/mod/mod_version.html">mod_version</a></code></li><li><code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code></li></ul></td><td><ul><li><code class="directive"><a href="/mod/core.html#directory"><Directory></a></code></li><li><code class="directive"><a href="/mod/core.html#directorymatch"><DirectoryMatch></a></code></li><li><code class="directive"><a href="/mod/core.html#files"><Files></a></code></li><li><code class="directive"><a href="/mod/core.html#filesmatch"><FilesMatch></a></code></li><li><code class="directive"><a href="/mod/core.html#if"><If></a></code></li><li><code class="directive"><a href="/mod/core.html#ifdefine"><IfDefine></a></code></li><li><code class="directive"><a href="/mod/core.html#ifmodule"><IfModule></a></code></li><li><code class="directive"><a href="/mod/mod_version.html#ifversion"><IfVersion></a></code></li><li><code class="directive"><a href="/mod/core.html#location"><Location></a></code></li><li><code class="directive"><a href="/mod/core.html#locationmatch"><LocationMatch></a></code></li><li><code class="directive"><a href="/mod/mod_proxy.html#proxy"><Proxy></a></code></li><li><code class="directive"><a href="/mod/mod_proxy.html#proxymatch"><ProxyMatch></a></code></li><li><code class="directive"><a href="/mod/core.html#virtualhost"><VirtualHost></a></code></li></ul></td></tr></table>
<p>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 <code class="directive"><a href="/mod/core.html#ifdefine"><IfDefine></a></code>, <code class="directive"><a href="/mod/core.html#ifmodule"><IfModule></a></code>, and
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.</p>
<p>The <code class="directive"><a href="/mod/core.html#ifdefine"><IfDefine></a></code> directive
encloses directives that will only be applied if an appropriate
parameter is defined on the <code class="program"><a href="/programs/httpd.html">httpd</a></code> command line. For example,
with the following configuration, all requests will be redirected
to another site only if the server is started using
<code>httpd -DClosedForNow</code>:</p>
<pre class="prettyprint lang-config"><IfDefine ClosedForNow>
Redirect "/" "http://otherserver.example.com/"
</IfDefine></pre>
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 <code class="directive"><a href="/mod/mod_so.html#loadmodule">LoadModule</a></code> 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.</p>
<p>In the following example, the <code class="directive"><a href="/mod/mod_mime_magic.html#mimemagicfile">MimeMagicFile</a></code> directive will be
applied only if <code class="module"><a href="/mod/mod_mime_magic.html">mod_mime_magic</a></code> is available.</p>
</IfModule></pre>
<p>The <code class="directive"><a href="/mod/mod_version.html#ifversion"><IfVersion></a></code>
directive is very similar to <code class="directive"><a href="/mod/core.html#ifdefine"><IfDefine></a></code> and <code class="directive"><a href="/mod/core.html#ifmodule"><IfModule></a></code>, 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.</p>
<pre class="prettyprint lang-config"><IfVersion >= 2.4>
# this happens only in versions greater or
# equal 2.4.0.
</IfVersion></pre>
can apply negative conditions by preceding their test with "!".
Also, these sections can be nested to achieve more complex
restrictions.</p>
<div class="section">
<h2><a name="file-and-web" id="file-and-web">Filesystem, Webspace, and Boolean Expressions</a></h2>
<p>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,
the Windows filesystem. (Note that forward slashes should always be
used as the path separator in Apache httpd configuration files, 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 <code>/dir/</code> in the
webspace corresponds to the path
default Apache httpd install on Unix. The webspace need not map directly to
the filesystem, since webpages may be generated dynamically
from databases or other locations.</p>
<h3><a name="filesystem" id="filesystem">Filesystem Containers</a></h3>
directives, along with their <a class="glossarylink" href="/glossary.html#regex" title="see glossary">regex</a>
counterparts, apply directives to
parts of the filesystem. Directives enclosed in a <code class="directive"><a href="/mod/core.html#directory"><Directory></a></code> 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 <a href="howto/htaccess.html">.htaccess files</a>. For example, in the
following configuration, directory indexes will be enabled for the
Options +Indexes
</Directory></pre>
<p>Directives enclosed in a <code class="directive"><a href="/mod/core.html#files"><Files></a></code> 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,
of where it is found.</p>
Require all denied
</Files></pre>
<p>To address files found in a particular part of the filesystem, the
can be combined. For example, the following configuration will deny
directory.</p>
<Files "private.html">
Require all denied
</Files>
</Directory></pre>
<h3><a name="webspace" id="webspace">Webspace Containers</a></h3>
directive and its <a class="glossarylink" href="/glossary.html#regex" title="see glossary">regex</a> 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 for
as any other requests starting with the <code>/private</code> string.</p>
<pre class="prettyprint lang-config"><LocationMatch "^/private">
Require all denied
</LocationMatch></pre>
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 HTTP Server handler provided by <code class="module"><a href="/mod/mod_status.html">mod_status</a></code>.
No file called <code>server-status</code> needs to exist in the
filesystem.</p>
<pre class="prettyprint lang-config"><Location "/server-status">
SetHandler server-status
</Location></pre>
<h3><a name="overlapping-webspace" id="overlapping-webspace">Overlapping Webspace</a></h3>
<p>In order to have two overlapping URLs one has to consider the order in which
certain sections or directives are evaluated. For
<code class="directive"><a href="/mod/core.html#location"><Location></a></code> this would be:</p>
<pre class="prettyprint lang-config"><Location "/foo">
</Location>
</Location></pre>
<p><code class="directive"><a href="/mod/mod_alias.html#alias"><Alias></a></code>es on the other hand,
are mapped vice-versa:</p>
<p>The same is true for the <code class="directive"><a href="/mod/mod_proxy.html#proxypass">ProxyPass</a></code>
directives:</p>
<pre class="prettyprint lang-config">ProxyPass /special-area http://special.example.com smax=5 max=10
ProxyPass / balancer://mycluster/ stickysession=JSESSIONID|jsessionid nofailover=On</pre>
<h3><a name="wildcards" id="wildcards">Wildcards and Regular Expressions</a></h3>
directives can each use shell-style wildcard characters as in
<code>fnmatch</code> from the C standard library. The character "*"
matches any sequence of characters, "?" matches any single character,
and "[<em>seq</em>]" matches any character in <em>seq</em>. The "/"
character will not be matched by any wildcard; it must be specified
explicitly.</p>
<p>If even more flexible matching is required, each
container has a regular expression (regex) counterpart <code class="directive"><a href="/mod/core.html#directorymatch"><DirectoryMatch></a></code>, <code class="directive"><a href="/mod/core.html#filesmatch"><FilesMatch></a></code>, and <code class="directive"><a href="/mod/core.html#locationmatch"><LocationMatch></a></code> that allow
perl-compatible
to 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.</p>
<p>A non-regex wildcard section that changes the configuration of
all user directories could look as follows:</p>
<pre class="prettyprint lang-config"><Directory "/home/*/public_html">
Options Indexes
</Directory></pre>
<p>Using regex sections, we can deny access to many types of image files
at once:</p>
<pre class="prettyprint lang-config"><FilesMatch "\.(?i:gif|jpe?g|png)$">
Require all denied
</FilesMatch></pre>
<p>Regular expressions containing <strong>named groups and
backreferences</strong> are added to the environment with the
corresponding name in uppercase. This allows elements of filename paths
<pre class="prettyprint lang-config"><DirectoryMatch "^/var/www/combined/(?<SITENAME>[^/]+)">
require ldap-group cn=%{env:MATCH_SITENAME},ou=combined,o=Example
</DirectoryMatch></pre>
<h3><a name="expressions" id="expressions">Boolean expressions</a></h3>
directive change the configuration depending on a condition which can be
expressed by a boolean expression. For example, the following configuration
denies access if the HTTP Referer header does not start with
"http://www.example.com/".</p>
<pre class="prettyprint lang-config"><If "!(%{HTTP_REFERER} -strmatch 'http://www.example.com/*')">
Require all denied
</If></pre>
<h3><a name="whichwhen" id="whichwhen">What to use When</a></h3>
<p>Choosing between filesystem containers and webspace containers is
actually quite easy. When applying directives to objects that reside
in the filesystem always use <code class="directive"><a href="/mod/core.html#directory"><Directory></a></code> or <code class="directive"><a href="/mod/core.html#files"><Files></a></code>. When applying directives to objects
that do not reside in the filesystem (such as a webpage generated from
a database), use <code class="directive"><a href="/mod/core.html#location"><Location></a></code>.</p>
<p>It is important to never use <code class="directive"><a href="/mod/core.html#location"><Location></a></code> 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:</p>
<pre class="prettyprint lang-config"><Location "/dir/">
Require all denied
</Location></pre>
<p>This works fine if the request is for
a case-insensitive filesystem? Then your restriction could be easily
circumvented by requesting
<code>http://yoursite.example.com/DIR/</code>. The <code class="directive"><a href="/mod/core.html#directory"><Directory></a></code> 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 <code class="directive"><a href="/mod/core.html#directory"><Directory></a></code> 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
<p>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 <code><Location
"/"></code> section is perfectly safe because this section will apply
to all requests regardless of the specific URL.</p>
<h3><a name="nesting" id="nesting">Nesting of sections</a></h3>
<p>Some section types can be nested inside other section types. On the one
be used inside <code class="directive"><a href="/mod/core.html#directory"><Directory></a></code>,
<code class="directive"><a href="/mod/core.html#location"><Location></a></code>, and <code class="directive"><a href="/mod/core.html#files"><Files></a></code> sections. The regex
counterparts of the named section behave identically.</p>
<p>Nested sections are merged after non-nested sections of the same type.</p>
<div class="section">
<h2><a name="virtualhost" id="virtualhost">Virtual Hosts</a></h2>
container encloses directives that apply to specific hosts.
This is useful when serving multiple hosts from the same machine
with a different configuration for each. For more information,
see the <a href="vhosts/">Virtual Host Documentation</a>.</p>
<div class="section">
<h2><a name="proxy" id="proxy">Proxy</a></h2>
containers apply enclosed configuration directives only
to sites accessed through <code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code>'s proxy server
that match the specified URL. For example, the following configuration
will prevent the proxy server from being used to access the
Require all granted
</Proxy></pre>
<div class="section">
<h2><a name="whatwhere" id="whatwhere">What Directives are Allowed?</a></h2>
<p>To find out what directives are allowed in what types of
configuration sections, check the <a href="mod/directive-dict.html#Context">Context</a> of the directive.
Everything that is allowed in
sections is also syntactically allowed in
sections. There are some exceptions, however:</p>
<ul>
<li>The <code class="directive"><a href="/mod/core.html#allowoverride">AllowOverride</a></code> directive
works only in <code class="directive"><a href="/mod/core.html#directory"><Directory></a></code>
sections.</li>
<li>The <code>FollowSymLinks</code> and
<code>SymLinksIfOwnerMatch</code> <code class="directive"><a href="/mod/core.html#options">Options</a></code> work only in <code class="directive"><a href="/mod/core.html#directory"><Directory></a></code> sections or
<code>.htaccess</code> files.</li>
<li>The <code class="directive"><a href="/mod/core.html#options">Options</a></code> directive cannot
sections.</li>
</ul>
<div class="section">
<h2><a name="merging" id="merging">How the sections are merged</a></h2>
<p>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.</p>
<p>The order of merging is:</p>
<ol>
<li> <code class="directive"><a href="/mod/core.html#directory"><Directory></a></code> (except regular expressions)
and <code>.htaccess</code> done simultaneously (with
<code>.htaccess</code>, if allowed, overriding
<li><code class="directive"><a href="/mod/core.html#directorymatch"><DirectoryMatch></a></code>
(and <code><Directory ~></code>)</li>
<li><code class="directive"><a href="/mod/core.html#files"><Files></a></code> and <code class="directive"><a href="/mod/core.html#filesmatch"><FilesMatch></a></code> done
simultaneously</li>
and <code class="directive"><a href="/mod/core.html#locationmatch"><LocationMatch></a></code> done simultaneously</li>
</li>
</ol>
<p>Apart from <code class="directive"><a href="/mod/core.html#directory"><Directory></a></code>, each group is processed in
the order that they appear in the configuration files. <code class="directive"><a href="/mod/core.html#directory"><Directory></a></code> (group 1 above)
is processed in the order shortest directory component to longest.
be processed before <code><Directory
"/var/web/dir/subdir"></code>. If multiple <code class="directive"><a href="/mod/core.html#directory"><Directory></a></code> sections apply
to the same directory they are processed in the configuration file
order. Configurations included via the <code class="directive"><a href="/mod/core.html#include">Include</a></code> directive will be treated as if
they were inside the including file at the location of the
<p>Sections inside <code class="directive"><a href="/mod/core.html#virtualhost"><VirtualHost></a></code> sections
are applied <em>after</em> the corresponding sections outside
the virtual host definition. This allows virtual hosts to
override the main server configuration.</p>
<p>When the request is served by <code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code>, the
container takes the place of the <code class="directive"><a href="/mod/core.html#directory"><Directory></a></code> container in the processing
order.</p>
<p>Later sections override earlier ones, however each module is responsible
for interpreting what form this override takes. A later configuration section
with directives from a given module might cause a conceptual "merge" of some
directives, all directives, or a complete replacement of the modules
configuration with the module defaults and directives explicitly listed in
the later context.</p>
<div class="note"><h3>Technical Note</h3>
There is actually a
<code><Location></code>/<code><LocationMatch></code>
sequence performed just before the name translation phase
(where <code>Aliases</code> and <code>DocumentRoots</code>
are used to map URLs to filenames). The results of this
sequence are completely thrown away after the translation has
completed.
</div>
<h3><a name="merge-examples" id="merge-examples">Some Examples</a></h3>
<p>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.</p>
<pre class="prettyprint lang-config"><Location "/">
E
</Location>
<Files "f.html">
D
</Files>
<VirtualHost *>
B
</Directory>
</VirtualHost>
<DirectoryMatch "^.*b$">
C
</DirectoryMatch>
<Directory "/a/b>
A
</Directory></pre>
<p>For a more concrete example, consider the following. Regardless of
any access restrictions placed in <code class="directive"><a href="/mod/core.html#directory"><Directory></a></code> sections, the <code class="directive"><a href="/mod/core.html#location"><Location></a></code> section will be
evaluated last and will allow unrestricted access to the server. In
other words, order of merging is important, so be careful!</p>
<pre class="prettyprint lang-config"><Location "/">
Require all granted
</Location>
# Whoops! This <Directory> section will have no effect
<Directory "/">
<RequireAll>
Require all granted
Require not host badguy.example.com
</RequireAll>
</Directory></pre>
</div></div>
<div class="bottomlang">
<p><span>Available Languages: </span><a href="/en/sections.html" title="English"> en </a> |
</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&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>
var comments_shortname = 'httpd';
var comments_identifier = 'http://httpd.apache.org/docs/trunk/sections.html';
(function(w, d) {
if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
d.write('<div id="comments_thread"><\/div>');
var s = d.createElement('script');
s.type = 'text/javascript';
s.async = true;
s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
(d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
}
else {
d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
}
})(window, document);
//--><!]]></script></div><div id="footer">
<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>
<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[//><!--
if (typeof(prettyPrint) !== 'undefined') {
prettyPrint();
}
//--><!]]></script>
</body></html>