core.html.en revision 9ddbdeddba1798d402758d94e5d6d85f8f96eec7
2d2eda71267231c2526be701fe655db125852c1ffielding<?xml version="1.0" encoding="ISO-8859-1"?>
f062ed7bd262a37a909dd77ce5fc23b446818823fielding<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
f062ed7bd262a37a909dd77ce5fc23b446818823fielding<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
f062ed7bd262a37a909dd77ce5fc23b446818823fielding XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
f062ed7bd262a37a909dd77ce5fc23b446818823fielding This file is generated from xml source: DO NOT EDIT
2d2eda71267231c2526be701fe655db125852c1ffielding XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
2d2eda71267231c2526be701fe655db125852c1ffielding -->
2d2eda71267231c2526be701fe655db125852c1ffielding<title>core - Apache HTTP Server</title>
2d2eda71267231c2526be701fe655db125852c1ffielding<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
2d2eda71267231c2526be701fe655db125852c1ffielding<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
2d2eda71267231c2526be701fe655db125852c1ffielding<link href="/style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
f062ed7bd262a37a909dd77ce5fc23b446818823fielding<link href="/images/favicon.ico" rel="shortcut icon" /></head>
2d2eda71267231c2526be701fe655db125852c1ffielding<body>
2d2eda71267231c2526be701fe655db125852c1ffielding<div id="page-header">
2d2eda71267231c2526be701fe655db125852c1ffielding<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="/faq/">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p>
2d2eda71267231c2526be701fe655db125852c1ffielding<p class="apache">Apache HTTP Server Version 2.1</p>
2d2eda71267231c2526be701fe655db125852c1ffielding<img alt="" src="/images/feather.gif" /></div>
2d2eda71267231c2526be701fe655db125852c1ffielding<div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="/images/left.gif" /></a></div>
f062ed7bd262a37a909dd77ce5fc23b446818823fielding<div id="path">
f062ed7bd262a37a909dd77ce5fc23b446818823fielding<a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs-project/">Documentation</a> &gt; <a href="../">Version 2.1</a> &gt; <a href="./">Modules</a></div>
f062ed7bd262a37a909dd77ce5fc23b446818823fielding<div id="page-content">
f062ed7bd262a37a909dd77ce5fc23b446818823fielding<div id="preamble"><h1>Apache Core Features</h1>
f062ed7bd262a37a909dd77ce5fc23b446818823fielding<div class="toplang">
f062ed7bd262a37a909dd77ce5fc23b446818823fielding<p><span>Available Languages: </span><a href="/de/mod/core.html" hreflang="de" title="Deutsch">&nbsp;de&nbsp;</a> | <a href="/en/mod/core.html" hreflang="en" title="English">&nbsp;en&nbsp;</a></p>
2d2eda71267231c2526be701fe655db125852c1ffielding</div>
f062ed7bd262a37a909dd77ce5fc23b446818823fielding<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Core Apache HTTP Server features that are always
f062ed7bd262a37a909dd77ce5fc23b446818823fieldingavailable</td></tr>
f062ed7bd262a37a909dd77ce5fc23b446818823fielding<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Core</td></tr></table>
f062ed7bd262a37a909dd77ce5fc23b446818823fielding</div>
2d2eda71267231c2526be701fe655db125852c1ffielding<div id="quickview"><h3 class="directives">Directives</h3>
f062ed7bd262a37a909dd77ce5fc23b446818823fielding<ul id="toc">
f062ed7bd262a37a909dd77ce5fc23b446818823fielding<li><img alt="" src="/images/down.gif" /> <a href="#acceptpathinfo">AcceptPathInfo</a></li>
64185f9824e42f21ca7b9ae6c004484215c031a7rbb<li><img alt="" src="/images/down.gif" /> <a href="#accessfilename">AccessFileName</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#adddefaultcharset">AddDefaultCharset</a></li>
f062ed7bd262a37a909dd77ce5fc23b446818823fielding<li><img alt="" src="/images/down.gif" /> <a href="#addoutputfilterbytype">AddOutputFilterByType</a></li>
f062ed7bd262a37a909dd77ce5fc23b446818823fielding<li><img alt="" src="/images/down.gif" /> <a href="#allowencodedslashes">AllowEncodedSlashes</a></li>
f062ed7bd262a37a909dd77ce5fc23b446818823fielding<li><img alt="" src="/images/down.gif" /> <a href="#allowoverride">AllowOverride</a></li>
f062ed7bd262a37a909dd77ce5fc23b446818823fielding<li><img alt="" src="/images/down.gif" /> <a href="#authname">AuthName</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#authtype">AuthType</a></li>
f062ed7bd262a37a909dd77ce5fc23b446818823fielding<li><img alt="" src="/images/down.gif" /> <a href="#cgimapextension">CGIMapExtension</a></li>
f062ed7bd262a37a909dd77ce5fc23b446818823fielding<li><img alt="" src="/images/down.gif" /> <a href="#contentdigest">ContentDigest</a></li>
f062ed7bd262a37a909dd77ce5fc23b446818823fielding<li><img alt="" src="/images/down.gif" /> <a href="#defaulttype">DefaultType</a></li>
f062ed7bd262a37a909dd77ce5fc23b446818823fielding<li><img alt="" src="/images/down.gif" /> <a href="#directory">&lt;Directory&gt;</a></li>
f062ed7bd262a37a909dd77ce5fc23b446818823fielding<li><img alt="" src="/images/down.gif" /> <a href="#directorymatch">&lt;DirectoryMatch&gt;</a></li>
f062ed7bd262a37a909dd77ce5fc23b446818823fielding<li><img alt="" src="/images/down.gif" /> <a href="#documentroot">DocumentRoot</a></li>
f062ed7bd262a37a909dd77ce5fc23b446818823fielding<li><img alt="" src="/images/down.gif" /> <a href="#enablemmap">EnableMMAP</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#enablesendfile">EnableSendfile</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#errordocument">ErrorDocument</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#errorlog">ErrorLog</a></li>
f062ed7bd262a37a909dd77ce5fc23b446818823fielding<li><img alt="" src="/images/down.gif" /> <a href="#fileetag">FileETag</a></li>
f062ed7bd262a37a909dd77ce5fc23b446818823fielding<li><img alt="" src="/images/down.gif" /> <a href="#files">&lt;Files&gt;</a></li>
f062ed7bd262a37a909dd77ce5fc23b446818823fielding<li><img alt="" src="/images/down.gif" /> <a href="#filesmatch">&lt;FilesMatch&gt;</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#forcetype">ForceType</a></li>
f062ed7bd262a37a909dd77ce5fc23b446818823fielding<li><img alt="" src="/images/down.gif" /> <a href="#hostnamelookups">HostnameLookups</a></li>
f062ed7bd262a37a909dd77ce5fc23b446818823fielding<li><img alt="" src="/images/down.gif" /> <a href="#ifdefine">&lt;IfDefine&gt;</a></li>
f062ed7bd262a37a909dd77ce5fc23b446818823fielding<li><img alt="" src="/images/down.gif" /> <a href="#ifmodule">&lt;IfModule&gt;</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#include">Include</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#keepalive">KeepAlive</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#keepalivetimeout">KeepAliveTimeout</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#limit">&lt;Limit&gt;</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#limitexcept">&lt;LimitExcept&gt;</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#limitinternalrecursion">LimitInternalRecursion</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#limitrequestbody">LimitRequestBody</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#limitrequestfields">LimitRequestFields</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#limitrequestfieldsize">LimitRequestFieldSize</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#limitrequestline">LimitRequestLine</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#limitxmlrequestbody">LimitXMLRequestBody</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#location">&lt;Location&gt;</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#locationmatch">&lt;LocationMatch&gt;</a></li>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<li><img alt="" src="/images/down.gif" /> <a href="#loglevel">LogLevel</a></li>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<li><img alt="" src="/images/down.gif" /> <a href="#maxkeepaliverequests">MaxKeepAliveRequests</a></li>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<li><img alt="" src="/images/down.gif" /> <a href="#namevirtualhost">NameVirtualHost</a></li>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<li><img alt="" src="/images/down.gif" /> <a href="#options">Options</a></li>
952908500d5f99f35afc5ed510391b9bdc3833farbb<li><img alt="" src="/images/down.gif" /> <a href="#require">Require</a></li>
952908500d5f99f35afc5ed510391b9bdc3833farbb<li><img alt="" src="/images/down.gif" /> <a href="#rlimitcpu">RLimitCPU</a></li>
952908500d5f99f35afc5ed510391b9bdc3833farbb<li><img alt="" src="/images/down.gif" /> <a href="#rlimitmem">RLimitMEM</a></li>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<li><img alt="" src="/images/down.gif" /> <a href="#rlimitnproc">RLimitNPROC</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#satisfy">Satisfy</a></li>
30c289e6bc6d28d210b21edd800ab2cfc78a8381wrowe<li><img alt="" src="/images/down.gif" /> <a href="#scriptinterpretersource">ScriptInterpreterSource</a></li>
bd53cb2bf4d77574fd502e1c02d8c3c0d5431967stoddard<li><img alt="" src="/images/down.gif" /> <a href="#serveradmin">ServerAdmin</a></li>
b4c8a80f7dbfc9b56dbe03bdc28f0b5eb5f23697rbb<li><img alt="" src="/images/down.gif" /> <a href="#serveralias">ServerAlias</a></li>
b4c8a80f7dbfc9b56dbe03bdc28f0b5eb5f23697rbb<li><img alt="" src="/images/down.gif" /> <a href="#servername">ServerName</a></li>
44c46ef733836b32585d135d2d90856e7cfd9929rbb<li><img alt="" src="/images/down.gif" /> <a href="#serverpath">ServerPath</a></li>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<li><img alt="" src="/images/down.gif" /> <a href="#serverroot">ServerRoot</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#serversignature">ServerSignature</a></li>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<li><img alt="" src="/images/down.gif" /> <a href="#servertokens">ServerTokens</a></li>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<li><img alt="" src="/images/down.gif" /> <a href="#sethandler">SetHandler</a></li>
14bea4ba98aabaf554e37165a07123bb05d6736bstoddard<li><img alt="" src="/images/down.gif" /> <a href="#setinputfilter">SetInputFilter</a></li>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<li><img alt="" src="/images/down.gif" /> <a href="#setoutputfilter">SetOutputFilter</a></li>
9731f9232bddd7dbac757c780b2b1a2a6931dce7stoddard<li><img alt="" src="/images/down.gif" /> <a href="#timeout">TimeOut</a></li>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<li><img alt="" src="/images/down.gif" /> <a href="#usecanonicalname">UseCanonicalName</a></li>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<li><img alt="" src="/images/down.gif" /> <a href="#virtualhost">&lt;VirtualHost&gt;</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding</ul>
2d2eda71267231c2526be701fe655db125852c1ffielding</div>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
2d2eda71267231c2526be701fe655db125852c1ffielding<div class="directive-section"><h2><a name="AcceptPathInfo" id="AcceptPathInfo">AcceptPathInfo</a> <a name="acceptpathinfo" id="acceptpathinfo">Directive</a></h2>
2d2eda71267231c2526be701fe655db125852c1ffielding<table class="directive">
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Resources accept trailing pathname information</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AcceptPathInfo On|Off|Default</code></td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AcceptPathInfo Default</code></td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2e123e8beedc9f921448c113e2d6823a92fd5261fielding<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.0.30 and later</td></tr>
2e123e8beedc9f921448c113e2d6823a92fd5261fielding</table>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p>This directive controls whether requests that contain trailing
2d2eda71267231c2526be701fe655db125852c1ffielding pathname information that follows an actual filename (or
2d2eda71267231c2526be701fe655db125852c1ffielding non-existent file in an existing directory) will be accepted or
2d2eda71267231c2526be701fe655db125852c1ffielding rejected. The trailing pathname information can be made
2d2eda71267231c2526be701fe655db125852c1ffielding available to scripts in the <code>PATH_INFO</code> environment
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb variable.</p>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <p>For example, assume the location <code>/test/</code> points to
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb a directory that contains only the single file
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <code>here.html</code>. Then requests for
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <code>/test/here.html/more</code> and
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <code>/test/nothere.html/more</code> both collect
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <code>/more</code> as <code>PATH_INFO</code>.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p>The three possible arguments for the
2d2eda71267231c2526be701fe655db125852c1ffielding <code class="directive">AcceptPathInfo</code> directive are:</p>
2d2eda71267231c2526be701fe655db125852c1ffielding <dl>
2d2eda71267231c2526be701fe655db125852c1ffielding <dt><code>Off</code></dt><dd>A request will only be accepted if it
2d2eda71267231c2526be701fe655db125852c1ffielding maps to a literal path that exists. Therefore a request with
2d2eda71267231c2526be701fe655db125852c1ffielding trailing pathname information after the true filename such as
2d2eda71267231c2526be701fe655db125852c1ffielding <code>/test/here.html/more</code> in the above example will return
2d2eda71267231c2526be701fe655db125852c1ffielding a 404 NOT FOUND error.</dd>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <dt><code>On</code></dt><dd>A request will be accepted if a
2d2eda71267231c2526be701fe655db125852c1ffielding leading path component maps to a file that exists. The above
2d2eda71267231c2526be701fe655db125852c1ffielding example <code>/test/here.html/more</code> will be accepted if
2d2eda71267231c2526be701fe655db125852c1ffielding <code>/test/here.html</code> maps to a valid file.</dd>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <dt><code>Default</code></dt><dd>The treatment of requests with
2d2eda71267231c2526be701fe655db125852c1ffielding trailing pathname information is determined by the <a href="/handler.html">handler</a> responsible for the request.
2d2eda71267231c2526be701fe655db125852c1ffielding The core handler for normal files defaults to rejecting
2d2eda71267231c2526be701fe655db125852c1ffielding <code>PATH_INFO</code> requests. Handlers that serve scripts, such as <a href="mod_cgi.html">cgi-script</a> and <a href="mod_isapi.html">isapi-isa</a>, generally accept
2d2eda71267231c2526be701fe655db125852c1ffielding <code>PATH_INFO</code> by default.</dd>
2d2eda71267231c2526be701fe655db125852c1ffielding </dl>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p>The primary purpose of the <code>AcceptPathInfo</code>
2d2eda71267231c2526be701fe655db125852c1ffielding directive is to allow you to override the handler's choice of
2d2eda71267231c2526be701fe655db125852c1ffielding accepting or rejecting <code>PATH_INFO</code>. This override is required,
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb for example, when you use a <a href="/filter.html">filter</a>, such
2d2eda71267231c2526be701fe655db125852c1ffielding as <a href="mod_include.html">INCLUDES</a>, to generate content
2d2eda71267231c2526be701fe655db125852c1ffielding based on <code>PATH_INFO</code>. The core handler would usually reject
2d2eda71267231c2526be701fe655db125852c1ffielding the request, so you can use the following configuration to enable
2d2eda71267231c2526be701fe655db125852c1ffielding such a script:</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <div class="example"><p><code>
2d2eda71267231c2526be701fe655db125852c1ffielding &lt;Files "mypaths.shtml"&gt;<br />
2d2eda71267231c2526be701fe655db125852c1ffielding <span class="indent">
2d2eda71267231c2526be701fe655db125852c1ffielding Options +Includes<br />
2d2eda71267231c2526be701fe655db125852c1ffielding SetOutputFilter INCLUDES<br />
2d2eda71267231c2526be701fe655db125852c1ffielding AcceptPathInfo On<br />
2d2eda71267231c2526be701fe655db125852c1ffielding </span>
2d2eda71267231c2526be701fe655db125852c1ffielding &lt;/Files&gt;
2d2eda71267231c2526be701fe655db125852c1ffielding </code></p></div>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding</div>
2d2eda71267231c2526be701fe655db125852c1ffielding<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
2d2eda71267231c2526be701fe655db125852c1ffielding<div class="directive-section"><h2><a name="AccessFileName" id="AccessFileName">AccessFileName</a> <a name="accessfilename" id="accessfilename">Directive</a></h2>
2d2eda71267231c2526be701fe655db125852c1ffielding<table class="directive">
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Name of the distributed configuration file</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AccessFileName <var>filename</var> [<var>filename</var>] ...</code></td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AccessFileName .htaccess</code></td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding</table>
2d2eda71267231c2526be701fe655db125852c1ffielding <p>While processing a request the server looks for
2d2eda71267231c2526be701fe655db125852c1ffielding the first existing configuration file from this list of names in
2d2eda71267231c2526be701fe655db125852c1ffielding every directory of the path to the document, if distributed
2d2eda71267231c2526be701fe655db125852c1ffielding configuration files are <a href="#allowoverride">enabled for that
2d2eda71267231c2526be701fe655db125852c1ffielding directory</a>. For example:</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <div class="example"><p><code>
2d2eda71267231c2526be701fe655db125852c1ffielding AccessFileName .acl
2d2eda71267231c2526be701fe655db125852c1ffielding </code></p></div>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p>before returning the document
2d2eda71267231c2526be701fe655db125852c1ffielding <code>/usr/local/web/index.html</code>, the server will read
2d2eda71267231c2526be701fe655db125852c1ffielding <code>/.acl</code>, <code>/usr/.acl</code>,
2d2eda71267231c2526be701fe655db125852c1ffielding <code>/usr/local/.acl</code> and <code>/usr/local/web/.acl</code>
2d2eda71267231c2526be701fe655db125852c1ffielding for directives, unless they have been disabled with</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <div class="example"><p><code>
2d2eda71267231c2526be701fe655db125852c1ffielding &lt;Directory /&gt;<br />
2d2eda71267231c2526be701fe655db125852c1ffielding <span class="indent">
2d2eda71267231c2526be701fe655db125852c1ffielding AllowOverride None<br />
2d2eda71267231c2526be701fe655db125852c1ffielding </span>
2d2eda71267231c2526be701fe655db125852c1ffielding &lt;/Directory&gt;
2d2eda71267231c2526be701fe655db125852c1ffielding </code></p></div>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding<h3>See also</h3>
2d2eda71267231c2526be701fe655db125852c1ffielding<ul>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><code class="directive"><a href="#allowoverride">AllowOverride</a></code></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><a href="/configuring.html">Configuration Files</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><a href="/howto/htaccess.html">.htaccess Files</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding</ul>
2d2eda71267231c2526be701fe655db125852c1ffielding</div>
2e123e8beedc9f921448c113e2d6823a92fd5261fielding<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
2d2eda71267231c2526be701fe655db125852c1ffielding<div class="directive-section"><h2><a name="AddDefaultCharset" id="AddDefaultCharset">AddDefaultCharset</a> <a name="adddefaultcharset" id="adddefaultcharset">Directive</a></h2>
2d2eda71267231c2526be701fe655db125852c1ffielding<table class="directive">
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Default character set to be added for a
2d2eda71267231c2526be701fe655db125852c1ffieldingresponse without an explicit character set</td></tr>
2e123e8beedc9f921448c113e2d6823a92fd5261fielding<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AddDefaultCharset On|Off|<var>charset</var></code></td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AddDefaultCharset Off</code></td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding</table>
2d2eda71267231c2526be701fe655db125852c1ffielding <p>This directive specifies the name of the character set that
2d2eda71267231c2526be701fe655db125852c1ffielding will be added to any response that does not have any parameter on
2d2eda71267231c2526be701fe655db125852c1ffielding the content type in the HTTP headers. This will override any
2d2eda71267231c2526be701fe655db125852c1ffielding character set specified in the body of the document via a
2d2eda71267231c2526be701fe655db125852c1ffielding <code>META</code> tag. A setting of <code>AddDefaultCharset
2d2eda71267231c2526be701fe655db125852c1ffielding Off</code> disables this
2d2eda71267231c2526be701fe655db125852c1ffielding functionality. <code>AddDefaultCharset On</code> enables
2d2eda71267231c2526be701fe655db125852c1ffielding Apache's internal default charset of <code>iso-8859-1</code> as
2d2eda71267231c2526be701fe655db125852c1ffielding required by the directive. You can also specify an alternate
2d2eda71267231c2526be701fe655db125852c1ffielding <var>charset</var> to be used. For example:</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <div class="example"><p><code>
2d2eda71267231c2526be701fe655db125852c1ffielding AddDefaultCharset utf-8
2d2eda71267231c2526be701fe655db125852c1ffielding </code></p></div>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding</div>
2d2eda71267231c2526be701fe655db125852c1ffielding<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
2d2eda71267231c2526be701fe655db125852c1ffielding<div class="directive-section"><h2><a name="AddOutputFilterByType" id="AddOutputFilterByType">AddOutputFilterByType</a> <a name="addoutputfilterbytype" id="addoutputfilterbytype">Directive</a></h2>
2d2eda71267231c2526be701fe655db125852c1ffielding<table class="directive">
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>assigns an output filter to a particular MIME-type</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AddOutputFilterByType <var>filter</var>[;<var>filter</var>...]
2d2eda71267231c2526be701fe655db125852c1ffielding<var>MIME-type</var> [<var>MIME-type</var>] ...</code></td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.0.33 and later</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding</table>
2d2eda71267231c2526be701fe655db125852c1ffielding <p>This directive activates a particular output <a href="/filter.html">filter</a> for a request depending on the
2d2eda71267231c2526be701fe655db125852c1ffielding response MIME-type.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p>The following example uses the <code>DEFLATE</code> filter, which
2d2eda71267231c2526be701fe655db125852c1ffielding is provided by <code class="module"><a href="/mod/mod_deflate.html">mod_deflate</a></code>. It will compress all
2d2eda71267231c2526be701fe655db125852c1ffielding output (either static or dynamic) which is labeled as
2d2eda71267231c2526be701fe655db125852c1ffielding <code>text/html</code> or <code>text/plain</code> before it is sent
2d2eda71267231c2526be701fe655db125852c1ffielding to the client.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <div class="example"><p><code>
2d2eda71267231c2526be701fe655db125852c1ffielding AddOutputFilterByType DEFLATE text/html text/plain
2d2eda71267231c2526be701fe655db125852c1ffielding </code></p></div>
2efb935ae8fe12d5192a3bf2c52c28461b6c68afdgaudet
2efb935ae8fe12d5192a3bf2c52c28461b6c68afdgaudet <p>If you want the content to be processed by more than one filter, their
2efb935ae8fe12d5192a3bf2c52c28461b6c68afdgaudet names have to be separated by semicolons. It's also possible to use one
2efb935ae8fe12d5192a3bf2c52c28461b6c68afdgaudet <code class="directive">AddOutputFilterByType</code> directive for each of
2efb935ae8fe12d5192a3bf2c52c28461b6c68afdgaudet these filters.</p>
2efb935ae8fe12d5192a3bf2c52c28461b6c68afdgaudet
2efb935ae8fe12d5192a3bf2c52c28461b6c68afdgaudet <p>The configuration below causes all script output labeled as
2d2eda71267231c2526be701fe655db125852c1ffielding <code>text/html</code> to be processed at first by the
2d2eda71267231c2526be701fe655db125852c1ffielding <code>INCLUDES</code> filter and then by the <code>DEFLATE</code>
2d2eda71267231c2526be701fe655db125852c1ffielding filter.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <div class="example"><p><code>
2d2eda71267231c2526be701fe655db125852c1ffielding &lt;Location /cgi-bin/&gt;<br />
2d2eda71267231c2526be701fe655db125852c1ffielding <span class="indent">
2d2eda71267231c2526be701fe655db125852c1ffielding Options Includes<br />
2d2eda71267231c2526be701fe655db125852c1ffielding AddOutputFilterByType INCLUDES;DEFLATE text/html<br />
2d2eda71267231c2526be701fe655db125852c1ffielding </span>
2d2eda71267231c2526be701fe655db125852c1ffielding &lt;/Location&gt;
2d2eda71267231c2526be701fe655db125852c1ffielding </code></p></div>
2d2eda71267231c2526be701fe655db125852c1ffielding
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <div class="warning"><h3>Note</h3>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <p>Enabling filters with <code class="directive">AddOutputFilterByType</code>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb may fail partially or completely in some cases. For expample, no
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb filters are applied if the MIME-type could not be determined and falls
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb back to the <code class="directive"><a href="#defaulttype">DefaultType</a></code> setting,
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb even if the <code class="directive"><a href="#defaulttype">DefaultType</a></code> is the
32644678e889a3253f71bde0b3d6daea6d9dc21awrowe same.</p>
32644678e889a3253f71bde0b3d6daea6d9dc21awrowe
8da41ac411143966d8c280c6ae54207eef0293b6rbb <p>However, if you want to make sure, that the filters will be
32644678e889a3253f71bde0b3d6daea6d9dc21awrowe applied, assign the content type to a resource explicitely, for
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb example with <code class="directive"><a href="/mod/mod_mime.html#addtype">AddType</a></code> or
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <code class="directive"><a href="#forcetype">ForceType</a></code>. Setting the
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb content type within a (non-nph) CGI script is also safe.</p>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <p>The by-type output filters are never applied on proxy requests.</p>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb </div>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<h3>See also</h3>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<ul>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<li><code class="directive"><a href="/mod/mod_mime.html#addoutputfilter">AddOutputFilter</a></code></li>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<li><code class="directive"><a href="#setoutputfilter">SetOutputFilter</a></code></li>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<li><a href="/filter.html">filters</a></li>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb</ul>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb</div>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<div class="directive-section"><h2><a name="AllowEncodedSlashes" id="AllowEncodedSlashes">AllowEncodedSlashes</a> <a name="allowencodedslashes" id="allowencodedslashes">Directive</a></h2>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<table class="directive">
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Determines, whether encoded path separators in URLs are allowed to
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbbbe passed through</td></tr>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AllowEncodedSlashes On|Off</code></td></tr>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AllowEncodedSlashes Off</code></td></tr>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.0.46 and later</td></tr>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb</table>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <p>The <code class="directive">AllowEncodedSlashes</code> directive allows URLs
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb which contain encoded path separators (<code>%2F</code> for <code>/</code>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb and additionally <code>%5C</code> for <code>\</code> on according systems)
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb to be used. Normally such URLs are refused with a 404 (Not found) error.</p>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <p>Turning <code class="directive">AllowEncodedSlashes</code> <code>On</code> is
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb mostly useful when used in conjunction with <code>PATH_INFO</code>.</p>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <div class="note"><h3>Note</h3>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <p>Allowing encoded slashes does <em>not</em> imply <em>decoding</em>.
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb Occurences of <code>%2F</code> or <code>%5C</code> (<em>only</em> on
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb according systems) will be left as such in the otherwise decoded URL
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb string.</p>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb </div>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<h3>See also</h3>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<ul>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<li><code class="directive"><a href="#acceptpathinfo">AcceptPathInfo</a></code></li>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb</ul>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb</div>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<div class="directive-section"><h2><a name="AllowOverride" id="AllowOverride">AllowOverride</a> <a name="allowoverride" id="allowoverride">Directive</a></h2>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<table class="directive">
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Types of directives that are allowed in
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb.htaccess files</td></tr>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AllowOverride All|None|<var>directive-type</var>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb[<var>directive-type</var>] ...</code></td></tr>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AllowOverride All</code></td></tr>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory</td></tr>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb</table>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <p>When the server finds an <code>.htaccess</code> file (as
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb specified by <code class="directive"><a href="#accessfilename">AccessFileName</a></code>)
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb it needs to know which directives declared in that file can override
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb earlier configuration directives.</p>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <div class="note"><h3>Only available in &lt;Directory&gt; sections</h3>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <code class="directive">AllowOverride</code> is valid only in
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb sections, not in <code class="directive"><a href="#location">&lt;Location&gt;</a></code> or <code class="directive"><a href="#files">&lt;Files&gt;</a></code> sections.
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb </div>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <p>When this directive is set to <code>None</code>, then
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <a href="#accessfilename">.htaccess</a> files are completely ignored.
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb In this case, the server will not even attempt to read
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <code>.htaccess</code> files in the filesystem.</p>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <p>When this directive is set to <code>All</code>, then any
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb directive which has the .htaccess <a href="directive-dict.html#Context">Context</a> is allowed in
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <code>.htaccess</code> files.</p>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <p>The <var>directive-type</var> can be one of the following
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb groupings of directives.</p>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <dl>
2e123e8beedc9f921448c113e2d6823a92fd5261fielding <dt>AuthConfig</dt>
2d2eda71267231c2526be701fe655db125852c1ffielding
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm <dd>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding Allow use of the authorization directives (<code class="directive"><a href="/mod/mod_authn_dbm.html#authdbmgroupfile">AuthDBMGroupFile</a></code>,
2d2eda71267231c2526be701fe655db125852c1ffielding <code class="directive"><a href="/mod/mod_authn_dbm.html#authdbmuserfile">AuthDBMUserFile</a></code>,
2d2eda71267231c2526be701fe655db125852c1ffielding <code class="directive"><a href="/mod/mod_authz_groupfile.html#authgroupfile">AuthGroupFile</a></code>,
2d2eda71267231c2526be701fe655db125852c1ffielding <code class="directive"><a href="#authname">AuthName</a></code>,
2d2eda71267231c2526be701fe655db125852c1ffielding <code class="directive"><a href="#authtype">AuthType</a></code>, <code class="directive"><a href="/mod/mod_authn_file.html#authuserfile">AuthUserFile</a></code>, <code class="directive"><a href="#require">Require</a></code>, <em>etc.</em>).</dd>
8da41ac411143966d8c280c6ae54207eef0293b6rbb
2d2eda71267231c2526be701fe655db125852c1ffielding <dt>FileInfo</dt>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <dd>
2d2eda71267231c2526be701fe655db125852c1ffielding Allow use of the directives controlling document types (<code class="directive"><a href="#defaulttype">DefaultType</a></code>, <code class="directive"><a href="#errordocument">ErrorDocument</a></code>, <code class="directive"><a href="#forcetype">ForceType</a></code>, <code class="directive"><a href="/mod/mod_negotiation.html#languagepriority">LanguagePriority</a></code>,
2d2eda71267231c2526be701fe655db125852c1ffielding <code class="directive"><a href="#sethandler">SetHandler</a></code>, <code class="directive"><a href="#setinputfilter">SetInputFilter</a></code>, <code class="directive"><a href="#setoutputfilter">SetOutputFilter</a></code>, and
2d2eda71267231c2526be701fe655db125852c1ffielding <code class="module"><a href="/mod/mod_mime.html">mod_mime</a></code> Add* and Remove*
7463de0c603f07c9e1820e812d2f1a73661843e6rbb directives, <em>etc.</em>).</dd>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <dt>Indexes</dt>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <dd>
2d2eda71267231c2526be701fe655db125852c1ffielding Allow use of the directives controlling directory indexing
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm (<code class="directive"><a href="/mod/mod_autoindex.html#adddescription">AddDescription</a></code>,
2d2eda71267231c2526be701fe655db125852c1ffielding <code class="directive"><a href="/mod/mod_autoindex.html#addicon">AddIcon</a></code>, <code class="directive"><a href="/mod/mod_autoindex.html#addiconbyencoding">AddIconByEncoding</a></code>,
2d2eda71267231c2526be701fe655db125852c1ffielding <code class="directive"><a href="/mod/mod_autoindex.html#addiconbytype">AddIconByType</a></code>,
2d2eda71267231c2526be701fe655db125852c1ffielding <code class="directive"><a href="/mod/mod_autoindex.html#defaulticon">DefaultIcon</a></code>, <code class="directive"><a href="/mod/mod_dir.html#directoryindex">DirectoryIndex</a></code>, <code class="directive"><a href="/mod/mod_autoindex.html#fancyindexing">FancyIndexing</a></code>, <code class="directive"><a href="/mod/mod_autoindex.html#headername">HeaderName</a></code>, <code class="directive"><a href="/mod/mod_autoindex.html#indexignore">IndexIgnore</a></code>, <code class="directive"><a href="/mod/mod_autoindex.html#indexoptions">IndexOptions</a></code>, <code class="directive"><a href="/mod/mod_autoindex.html#readmename">ReadmeName</a></code>,
2d2eda71267231c2526be701fe655db125852c1ffielding <em>etc.</em>).</dd>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <dt>Limit</dt>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <dd>
2d2eda71267231c2526be701fe655db125852c1ffielding Allow use of the directives controlling host access (<code class="directive"><a href="/mod/mod_authz_host.html#allow">Allow</a></code>, <code class="directive"><a href="/mod/mod_authz_host.html#deny">Deny</a></code> and <code class="directive"><a href="/mod/mod_authz_host.html#order">Order</a></code>).</dd>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <dt>Options</dt>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <dd>
2d2eda71267231c2526be701fe655db125852c1ffielding Allow use of the directives controlling specific directory
2d2eda71267231c2526be701fe655db125852c1ffielding features (<code class="directive"><a href="#options">Options</a></code> and
2d2eda71267231c2526be701fe655db125852c1ffielding <code class="directive"><a href="/mod/mod_include.html#xbithack">XBitHack</a></code>).</dd>
2d2eda71267231c2526be701fe655db125852c1ffielding </dl>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p>Example:</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <div class="example"><p><code>
2d2eda71267231c2526be701fe655db125852c1ffielding AllowOverride AuthConfig Indexes
2d2eda71267231c2526be701fe655db125852c1ffielding </code></p></div>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding<h3>See also</h3>
2d2eda71267231c2526be701fe655db125852c1ffielding<ul>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><code class="directive"><a href="#accessfilename">AccessFileName</a></code></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><a href="/configuring.html">Configuration Files</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><a href="/howto/htaccess.html">.htaccess Files</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding</ul>
2d2eda71267231c2526be701fe655db125852c1ffielding</div>
2d2eda71267231c2526be701fe655db125852c1ffielding<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
2d2eda71267231c2526be701fe655db125852c1ffielding<div class="directive-section"><h2><a name="AuthName" id="AuthName">AuthName</a> <a name="authname" id="authname">Directive</a></h2>
2d2eda71267231c2526be701fe655db125852c1ffielding<table class="directive">
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Authorization realm for use in HTTP
2d2eda71267231c2526be701fe655db125852c1ffieldingauthentication</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthName <var>auth-domain</var></code></td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding</table>
2d2eda71267231c2526be701fe655db125852c1ffielding <p>This directive sets the name of the authorization realm for a
2d2eda71267231c2526be701fe655db125852c1ffielding directory. This realm is given to the client so that the user
2d2eda71267231c2526be701fe655db125852c1ffielding knows which username and password to send.
2d2eda71267231c2526be701fe655db125852c1ffielding <code class="directive">AuthName</code> takes a single argument; if the
2d2eda71267231c2526be701fe655db125852c1ffielding realm name contains spaces, it must be enclosed in quotation
2d2eda71267231c2526be701fe655db125852c1ffielding marks. It must be accompanied by <code class="directive"><a href="#authtype">AuthType</a></code> and <code class="directive"><a href="#require">Require</a></code> directives, and directives such
2d2eda71267231c2526be701fe655db125852c1ffielding as <code class="directive"><a href="/mod/mod_authn_file.html#authuserfile">AuthUserFile</a></code> and
2d2eda71267231c2526be701fe655db125852c1ffielding <code class="directive"><a href="/mod/mod_authz_groupfile.html#authgroupfile">AuthGroupFile</a></code> to
2d2eda71267231c2526be701fe655db125852c1ffielding work.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p>For example:</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <div class="example"><p><code>
2d2eda71267231c2526be701fe655db125852c1ffielding AuthName "Top Secret"
2d2eda71267231c2526be701fe655db125852c1ffielding </code></p></div>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p>The string provided for the <code>AuthName</code> is what will
2d2eda71267231c2526be701fe655db125852c1ffielding appear in the password dialog provided by most browsers.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding<h3>See also</h3>
2d2eda71267231c2526be701fe655db125852c1ffielding<ul>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><a href="/howto/auth.html">Authentication, Authorization, and
2d2eda71267231c2526be701fe655db125852c1ffielding Access Control</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding</ul>
2d2eda71267231c2526be701fe655db125852c1ffielding</div>
2d2eda71267231c2526be701fe655db125852c1ffielding<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
2d2eda71267231c2526be701fe655db125852c1ffielding<div class="directive-section"><h2><a name="AuthType" id="AuthType">AuthType</a> <a name="authtype" id="authtype">Directive</a></h2>
2d2eda71267231c2526be701fe655db125852c1ffielding<table class="directive">
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Type of user authentication</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthType Basic|Digest</code></td></tr>
763f7b125b6d3dd1e4992a3822005efa2616f983coar<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
763f7b125b6d3dd1e4992a3822005efa2616f983coar<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding</table>
2d2eda71267231c2526be701fe655db125852c1ffielding <p>This directive selects the type of user authentication for a
2d2eda71267231c2526be701fe655db125852c1ffielding directory. Only <code>Basic</code> and <code>Digest</code> are
2d2eda71267231c2526be701fe655db125852c1ffielding currently implemented.
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding It must be accompanied by <code class="directive"><a href="#authname">AuthName</a></code> and <code class="directive"><a href="#require">Require</a></code> directives, and directives such
2d2eda71267231c2526be701fe655db125852c1ffielding as <code class="directive"><a href="/mod/mod_authn_file.html#authuserfile">AuthUserFile</a></code> and
2d2eda71267231c2526be701fe655db125852c1ffielding <code class="directive"><a href="/mod/mod_authz_groupfile.html#authgroupfile">AuthGroupFile</a></code> to
2d2eda71267231c2526be701fe655db125852c1ffielding work.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding<h3>See also</h3>
2d2eda71267231c2526be701fe655db125852c1ffielding<ul>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><a href="/howto/auth.html">Authentication, Authorization,
2d2eda71267231c2526be701fe655db125852c1ffieldingand Access Control</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding</ul>
2d2eda71267231c2526be701fe655db125852c1ffielding</div>
2d2eda71267231c2526be701fe655db125852c1ffielding<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
2d2eda71267231c2526be701fe655db125852c1ffielding<div class="directive-section"><h2><a name="CGIMapExtension" id="CGIMapExtension">CGIMapExtension</a> <a name="cgimapextension" id="cgimapextension">Directive</a></h2>
2d2eda71267231c2526be701fe655db125852c1ffielding<table class="directive">
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Technique for locating the interpreter for CGI
2d2eda71267231c2526be701fe655db125852c1ffieldingscripts</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CGIMapExtension <var>cgi-path</var> <var>.extension</var></code></td></tr>
54e94821097724bf413d2d4cc70711760f7494e1trawick<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
54e94821097724bf413d2d4cc70711760f7494e1trawick<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
54e94821097724bf413d2d4cc70711760f7494e1trawick<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
54e94821097724bf413d2d4cc70711760f7494e1trawick<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>NetWare only</td></tr>
54e94821097724bf413d2d4cc70711760f7494e1trawick</table>
2d2eda71267231c2526be701fe655db125852c1ffielding <p>This directive is used to control how Apache finds the
2d2eda71267231c2526be701fe655db125852c1ffielding interpreter used to run CGI scripts. For example, setting
54e94821097724bf413d2d4cc70711760f7494e1trawick <code>CGIMapExtension sys:\foo.nlm .foo</code> will
54e94821097724bf413d2d4cc70711760f7494e1trawick cause all CGI script files with a <code>.foo</code> extension to
54e94821097724bf413d2d4cc70711760f7494e1trawick be passed to the FOO interpreter.</p>
54e94821097724bf413d2d4cc70711760f7494e1trawick
54e94821097724bf413d2d4cc70711760f7494e1trawick</div>
54e94821097724bf413d2d4cc70711760f7494e1trawick<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
54e94821097724bf413d2d4cc70711760f7494e1trawick<div class="directive-section"><h2><a name="ContentDigest" id="ContentDigest">ContentDigest</a> <a name="contentdigest" id="contentdigest">Directive</a></h2>
54e94821097724bf413d2d4cc70711760f7494e1trawick<table class="directive">
54e94821097724bf413d2d4cc70711760f7494e1trawick<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables the generation of Content-MD5 HTTP Response
54e94821097724bf413d2d4cc70711760f7494e1trawickheaders</td></tr>
54e94821097724bf413d2d4cc70711760f7494e1trawick<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ContentDigest On|Off</code></td></tr>
54e94821097724bf413d2d4cc70711760f7494e1trawick<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ContentDigest Off</code></td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Options</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding</table>
2d2eda71267231c2526be701fe655db125852c1ffielding <p>This directive enables the generation of
2d2eda71267231c2526be701fe655db125852c1ffielding <code>Content-MD5</code> headers as defined in RFC1864
2d2eda71267231c2526be701fe655db125852c1ffielding respectively RFC2068.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p>MD5 is an algorithm for computing a "message digest"
2d2eda71267231c2526be701fe655db125852c1ffielding (sometimes called "fingerprint") of arbitrary-length data, with
2d2eda71267231c2526be701fe655db125852c1ffielding a high degree of confidence that any alterations in the data
2d2eda71267231c2526be701fe655db125852c1ffielding will be reflected in alterations in the message digest.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p>The <code>Content-MD5</code> header provides an end-to-end
2d2eda71267231c2526be701fe655db125852c1ffielding message integrity check (MIC) of the entity-body. A proxy or
2d2eda71267231c2526be701fe655db125852c1ffielding client may check this header for detecting accidental
2d2eda71267231c2526be701fe655db125852c1ffielding modification of the entity-body in transit. Example header:</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <div class="example"><p><code>
2d2eda71267231c2526be701fe655db125852c1ffielding Content-MD5: AuLb7Dp1rqtRtxz2m9kRpA==
2d2eda71267231c2526be701fe655db125852c1ffielding </code></p></div>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p>Note that this can cause performance problems on your server
2d2eda71267231c2526be701fe655db125852c1ffielding since the message digest is computed on every request (the
952908500d5f99f35afc5ed510391b9bdc3833farbb values are not cached).</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
2d2eda71267231c2526be701fe655db125852c1ffielding <p><code>Content-MD5</code> is only sent for documents served
2d2eda71267231c2526be701fe655db125852c1ffielding by the <code class="module"><a href="/mod/core.html">core</a></code>, and not by any module. For example,
2d2eda71267231c2526be701fe655db125852c1ffielding SSI documents, output from CGI scripts, and byte range responses
952908500d5f99f35afc5ed510391b9bdc3833farbb do not have this header.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb</div>
952908500d5f99f35afc5ed510391b9bdc3833farbb<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
952908500d5f99f35afc5ed510391b9bdc3833farbb<div class="directive-section"><h2><a name="DefaultType" id="DefaultType">DefaultType</a> <a name="defaulttype" id="defaulttype">Directive</a></h2>
952908500d5f99f35afc5ed510391b9bdc3833farbb<table class="directive">
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>MIME content-type that will be sent if the
2d2eda71267231c2526be701fe655db125852c1ffieldingserver cannot determine a type in any other way</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DefaultType <var>MIME-type</var></code></td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>DefaultType text/plain</code></td></tr>
3887202241db08986e94b252fbd06a55e55d4b2dbhyde<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
3887202241db08986e94b252fbd06a55e55d4b2dbhyde<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
3887202241db08986e94b252fbd06a55e55d4b2dbhyde<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
3887202241db08986e94b252fbd06a55e55d4b2dbhyde<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
3887202241db08986e94b252fbd06a55e55d4b2dbhyde</table>
3887202241db08986e94b252fbd06a55e55d4b2dbhyde <p>There will be times when the server is asked to provide a
3887202241db08986e94b252fbd06a55e55d4b2dbhyde document whose type cannot be determined by its MIME types
3887202241db08986e94b252fbd06a55e55d4b2dbhyde mappings.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
3887202241db08986e94b252fbd06a55e55d4b2dbhyde <p>The server must inform the client of the content-type of the
2d2eda71267231c2526be701fe655db125852c1ffielding document, so in the event of an unknown type it uses the
2d2eda71267231c2526be701fe655db125852c1ffielding <code>DefaultType</code>. For example:</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <div class="example"><p><code>
3a50e4da8a0db4515ab45678e5b39ff7e7594320trawick DefaultType image/gif
3a50e4da8a0db4515ab45678e5b39ff7e7594320trawick </code></p></div>
3a50e4da8a0db4515ab45678e5b39ff7e7594320trawick
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>would be appropriate for a directory which contained many GIF
3a50e4da8a0db4515ab45678e5b39ff7e7594320trawick images with filenames missing the <code>.gif</code> extension.</p>
3a50e4da8a0db4515ab45678e5b39ff7e7594320trawick
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>Note that unlike <code class="directive"><a href="#forcetype">ForceType</a></code>, this directive only
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm provides the default mime-type. All other mime-type definitions,
952908500d5f99f35afc5ed510391b9bdc3833farbb including filename extensions, that might identify the media type
952908500d5f99f35afc5ed510391b9bdc3833farbb will override this default.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm</div>
3a50e4da8a0db4515ab45678e5b39ff7e7594320trawick<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
3a50e4da8a0db4515ab45678e5b39ff7e7594320trawick<div class="directive-section"><h2><a name="Directory" id="Directory">&lt;Directory&gt;</a> <a name="directory" id="directory">Directive</a></h2>
3a50e4da8a0db4515ab45678e5b39ff7e7594320trawick<table class="directive">
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enclose a group of directives that apply only to the
3887202241db08986e94b252fbd06a55e55d4b2dbhydenamed file-system directory and sub-directories</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;Directory <var>directory-path</var>&gt;
952908500d5f99f35afc5ed510391b9bdc3833farbb... &lt;/Directory&gt;</code></td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
3887202241db08986e94b252fbd06a55e55d4b2dbhyde</table>
952908500d5f99f35afc5ed510391b9bdc3833farbb <p><code class="directive">&lt;Directory&gt;</code> and
b28574227fcf956444ac03bde294122a05ad2bderbb <code>&lt;/Directory&gt;</code> are used to enclose a group of
952908500d5f99f35afc5ed510391b9bdc3833farbb directives that will apply only to the named directory and
3887202241db08986e94b252fbd06a55e55d4b2dbhyde sub-directories of that directory. Any directive that is allowed
3887202241db08986e94b252fbd06a55e55d4b2dbhyde in a directory context may be used. <var>Directory-path</var> is
3887202241db08986e94b252fbd06a55e55d4b2dbhyde either the full path to a directory, or a wild-card string using
952908500d5f99f35afc5ed510391b9bdc3833farbb Unix shell-style matching. In a wild-card string, <code>?</code> matches
2d2eda71267231c2526be701fe655db125852c1ffielding any single character, and <code>*</code> matches any sequences of
952908500d5f99f35afc5ed510391b9bdc3833farbb characters. You may also use <code>[]</code> character ranges. None
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm of the wildcards match a `/' character, so <code>&lt;Directory
952908500d5f99f35afc5ed510391b9bdc3833farbb /*/public_html&gt;</code> will not match
2d2eda71267231c2526be701fe655db125852c1ffielding <code>/home/user/public_html</code>, but <code>&lt;Directory
952908500d5f99f35afc5ed510391b9bdc3833farbb /home/*/public_html&gt;</code> will match. Example:</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <div class="example"><p><code>
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;Directory /usr/local/httpd/htdocs&gt;<br />
952908500d5f99f35afc5ed510391b9bdc3833farbb <span class="indent">
952908500d5f99f35afc5ed510391b9bdc3833farbb Options Indexes FollowSymLinks<br />
952908500d5f99f35afc5ed510391b9bdc3833farbb </span>
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;/Directory&gt;
952908500d5f99f35afc5ed510391b9bdc3833farbb </code></p></div>
2d2eda71267231c2526be701fe655db125852c1ffielding
952908500d5f99f35afc5ed510391b9bdc3833farbb <div class="note">
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>Be careful with the <var>directory-path</var> arguments:
952908500d5f99f35afc5ed510391b9bdc3833farbb They have to literally match the filesystem path which Apache uses
2d2eda71267231c2526be701fe655db125852c1ffielding to access the files. Directives applied to a particular
2d2eda71267231c2526be701fe655db125852c1ffielding <code>&lt;Directory&gt;</code> will not apply to files accessed from
2d2eda71267231c2526be701fe655db125852c1ffielding that same directory via a different path, such as via different symbolic
2d2eda71267231c2526be701fe655db125852c1ffielding links.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding </div>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>Extended regular
952908500d5f99f35afc5ed510391b9bdc3833farbb expressions can also be used, with the addition of the
952908500d5f99f35afc5ed510391b9bdc3833farbb <code>~</code> character. For example:</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <div class="example"><p><code>
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;Directory ~ "^/www/.*/[0-9]{3}"&gt;
952908500d5f99f35afc5ed510391b9bdc3833farbb </code></p></div>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>would match directories in <code>/www/</code> that consisted of
952908500d5f99f35afc5ed510391b9bdc3833farbb three numbers.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>If multiple (non-regular expression) <code class="directive">&lt;Directory&gt;</code> sections
952908500d5f99f35afc5ed510391b9bdc3833farbb match the directory (or one of its parents) containing a document,
952908500d5f99f35afc5ed510391b9bdc3833farbb then the directives are applied in the order of shortest match
952908500d5f99f35afc5ed510391b9bdc3833farbb first, interspersed with the directives from the <a href="#accessfilename">.htaccess</a> files. For example,
952908500d5f99f35afc5ed510391b9bdc3833farbb with</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <div class="example"><p><code>
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;Directory /&gt;<br />
952908500d5f99f35afc5ed510391b9bdc3833farbb <span class="indent">
952908500d5f99f35afc5ed510391b9bdc3833farbb AllowOverride None<br />
2d2eda71267231c2526be701fe655db125852c1ffielding </span>
2d2eda71267231c2526be701fe655db125852c1ffielding &lt;/Directory&gt;<br />
2d2eda71267231c2526be701fe655db125852c1ffielding <br />
2d2eda71267231c2526be701fe655db125852c1ffielding &lt;Directory /home/&gt;<br />
2d2eda71267231c2526be701fe655db125852c1ffielding <span class="indent">
952908500d5f99f35afc5ed510391b9bdc3833farbb AllowOverride FileInfo<br />
952908500d5f99f35afc5ed510391b9bdc3833farbb </span>
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;/Directory&gt;
952908500d5f99f35afc5ed510391b9bdc3833farbb </code></p></div>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>for access to the document <code>/home/web/dir/doc.html</code>
952908500d5f99f35afc5ed510391b9bdc3833farbb the steps are:</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <ul>
952908500d5f99f35afc5ed510391b9bdc3833farbb <li>Apply directive <code>AllowOverride None</code>
952908500d5f99f35afc5ed510391b9bdc3833farbb (disabling <code>.htaccess</code> files).</li>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <li>Apply directive <code>AllowOverride FileInfo</code> (for
952908500d5f99f35afc5ed510391b9bdc3833farbb directory <code>/home</code>).</li>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <li>Apply any <code>FileInfo</code> directives in
952908500d5f99f35afc5ed510391b9bdc3833farbb <code>/home/.htaccess</code>, <code>/home/web/.htaccess</code> and
952908500d5f99f35afc5ed510391b9bdc3833farbb <code>/home/web/dir/.htaccess</code> in that order.</li>
952908500d5f99f35afc5ed510391b9bdc3833farbb </ul>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>Regular expressions are not considered until after all of the
952908500d5f99f35afc5ed510391b9bdc3833farbb normal sections have been applied. Then all of the regular
952908500d5f99f35afc5ed510391b9bdc3833farbb expressions are tested in the order they appeared in the
952908500d5f99f35afc5ed510391b9bdc3833farbb configuration file. For example, with</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
2d2eda71267231c2526be701fe655db125852c1ffielding <div class="example"><p><code>
5d54ba1fdf6f8d7167fafcd93bef30df3906b1aecoar &lt;Directory ~ abc$&gt;<br />
2d2eda71267231c2526be701fe655db125852c1ffielding <span class="indent">
952908500d5f99f35afc5ed510391b9bdc3833farbb # ... directives here ...<br />
952908500d5f99f35afc5ed510391b9bdc3833farbb </span>
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;/Directory&gt;
952908500d5f99f35afc5ed510391b9bdc3833farbb </code></p></div>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>the regular expression section won't be considered until after
2d2eda71267231c2526be701fe655db125852c1ffielding all normal <code class="directive">&lt;Directory&gt;</code>s and
2d2eda71267231c2526be701fe655db125852c1ffielding <code>.htaccess</code> files have been applied. Then the regular
2d2eda71267231c2526be701fe655db125852c1ffielding expression will match on <code>/home/abc/public_html/abc</code> and
952908500d5f99f35afc5ed510391b9bdc3833farbb the corresponding <code class="directive">&lt;Directory&gt;</code> will
952908500d5f99f35afc5ed510391b9bdc3833farbb be applied.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p><strong>Note that the default Apache access for
952908500d5f99f35afc5ed510391b9bdc3833farbb <code>&lt;Directory /&gt;</code> is <code>Allow from All</code>.
952908500d5f99f35afc5ed510391b9bdc3833farbb This means that Apache will serve any file mapped from an URL. It is
952908500d5f99f35afc5ed510391b9bdc3833farbb recommended that you change this with a block such
952908500d5f99f35afc5ed510391b9bdc3833farbb as</strong></p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <div class="example"><p><code>
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;Directory /&gt;<br />
952908500d5f99f35afc5ed510391b9bdc3833farbb <span class="indent">
952908500d5f99f35afc5ed510391b9bdc3833farbb Order Deny,Allow<br />
952908500d5f99f35afc5ed510391b9bdc3833farbb Deny from All<br />
952908500d5f99f35afc5ed510391b9bdc3833farbb </span>
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;/Directory&gt;
952908500d5f99f35afc5ed510391b9bdc3833farbb </code></p></div>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p><strong>and then override this for directories you
952908500d5f99f35afc5ed510391b9bdc3833farbb <em>want</em> accessible. See the <a href="/misc/security_tips.html">Security Tips</a> page for more
952908500d5f99f35afc5ed510391b9bdc3833farbb details.</strong></p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p>The directory sections occur in the <code>httpd.conf</code> file.
2d2eda71267231c2526be701fe655db125852c1ffielding <code class="directive">&lt;Directory&gt;</code> directives
2d2eda71267231c2526be701fe655db125852c1ffielding cannot nest, and cannot appear in a <code class="directive"><a href="#limit">&lt;Limit&gt;</a></code> or <code class="directive"><a href="#limitexcept">&lt;LimitExcept&gt;</a></code> section.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding<h3>See also</h3>
2d2eda71267231c2526be701fe655db125852c1ffielding<ul>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><a href="/sections.html">How &lt;Directory&gt;,
2d2eda71267231c2526be701fe655db125852c1ffielding &lt;Location&gt; and &lt;Files&gt; sections work</a> for an
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm explanation of how these different sections are combined when a
2d2eda71267231c2526be701fe655db125852c1ffielding request is received</li>
2d2eda71267231c2526be701fe655db125852c1ffielding</ul>
2d2eda71267231c2526be701fe655db125852c1ffielding</div>
952908500d5f99f35afc5ed510391b9bdc3833farbb<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm<div class="directive-section"><h2><a name="DirectoryMatch" id="DirectoryMatch">&lt;DirectoryMatch&gt;</a> <a name="directorymatch" id="directorymatch">Directive</a></h2>
952908500d5f99f35afc5ed510391b9bdc3833farbb<table class="directive">
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enclose directives that apply to
952908500d5f99f35afc5ed510391b9bdc3833farbbfile-system directories matching a regular expression and their
952908500d5f99f35afc5ed510391b9bdc3833farbbsubdirectories</td></tr>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;DirectoryMatch <var>regex</var>&gt;
952908500d5f99f35afc5ed510391b9bdc3833farbb... &lt;/DirectoryMatch&gt;</code></td></tr>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding</table>
2d2eda71267231c2526be701fe655db125852c1ffielding <p><code class="directive">&lt;DirectoryMatch&gt;</code> and
2d2eda71267231c2526be701fe655db125852c1ffielding <code>&lt;/DirectoryMatch&gt;</code> are used to enclose a group
2d2eda71267231c2526be701fe655db125852c1ffielding of directives which will apply only to the named directory and
2d2eda71267231c2526be701fe655db125852c1ffielding sub-directories of that directory, the same as <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code>. However, it
952908500d5f99f35afc5ed510391b9bdc3833farbb takes as an argument a regular expression. For example:</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
952908500d5f99f35afc5ed510391b9bdc3833farbb <div class="example"><p><code>
2d2eda71267231c2526be701fe655db125852c1ffielding &lt;DirectoryMatch "^/www/.*/[0-9]{3}"&gt;
2d2eda71267231c2526be701fe655db125852c1ffielding </code></p></div>
952908500d5f99f35afc5ed510391b9bdc3833farbb
2d2eda71267231c2526be701fe655db125852c1ffielding <p>would match directories in <code>/www/</code> that consisted of three
952908500d5f99f35afc5ed510391b9bdc3833farbb numbers.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb<h3>See also</h3>
952908500d5f99f35afc5ed510391b9bdc3833farbb<ul>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><code class="directive"><a href="#directory">&lt;Directory&gt;</a></code> for
952908500d5f99f35afc5ed510391b9bdc3833farbba description of how regular expressions are mixed in with normal
952908500d5f99f35afc5ed510391b9bdc3833farbb<code class="directive">&lt;Directory&gt;</code>s</li>
2e123e8beedc9f921448c113e2d6823a92fd5261fielding<li><a href="/sections.html">How &lt;Directory&gt;, &lt;Location&gt; and
952908500d5f99f35afc5ed510391b9bdc3833farbb&lt;Files&gt; sections work</a> for an explanation of how these different
952908500d5f99f35afc5ed510391b9bdc3833farbbsections are combined when a request is received</li>
952908500d5f99f35afc5ed510391b9bdc3833farbb</ul>
952908500d5f99f35afc5ed510391b9bdc3833farbb</div>
2d2eda71267231c2526be701fe655db125852c1ffielding<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
952908500d5f99f35afc5ed510391b9bdc3833farbb<div class="directive-section"><h2><a name="DocumentRoot" id="DocumentRoot">DocumentRoot</a> <a name="documentroot" id="documentroot">Directive</a></h2>
2d2eda71267231c2526be701fe655db125852c1ffielding<table class="directive">
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Directory that forms the main document tree visible
2d2eda71267231c2526be701fe655db125852c1ffieldingfrom the web</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DocumentRoot <var>directory-path</var></code></td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>DocumentRoot /usr/local/apache/htdocs</code></td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb</table>
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>This directive sets the directory from which <code>httpd</code>
952908500d5f99f35afc5ed510391b9bdc3833farbb will serve files. Unless matched by a directive like <code class="directive"><a href="/mod/mod_alias.html#alias">Alias</a></code>, the server appends the
952908500d5f99f35afc5ed510391b9bdc3833farbb path from the requested URL to the document root to make the
952908500d5f99f35afc5ed510391b9bdc3833farbb path to the document. Example:</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
952908500d5f99f35afc5ed510391b9bdc3833farbb <div class="example"><p><code>
2d2eda71267231c2526be701fe655db125852c1ffielding DocumentRoot /usr/web
952908500d5f99f35afc5ed510391b9bdc3833farbb </code></p></div>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>then an access to
952908500d5f99f35afc5ed510391b9bdc3833farbb <code>http://www.my.host.com/index.html</code> refers to
952908500d5f99f35afc5ed510391b9bdc3833farbb <code>/usr/web/index.html</code>.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
2d2eda71267231c2526be701fe655db125852c1ffielding <p>The <code class="directive">DocumentRoot</code> should be specified without
2d2eda71267231c2526be701fe655db125852c1ffielding a trailing slash.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding<h3>See also</h3>
2d2eda71267231c2526be701fe655db125852c1ffielding<ul>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><a href="/urlmapping.html">Mapping URLs to Filesystem
952908500d5f99f35afc5ed510391b9bdc3833farbbLocation</a></li>
952908500d5f99f35afc5ed510391b9bdc3833farbb</ul>
952908500d5f99f35afc5ed510391b9bdc3833farbb</div>
952908500d5f99f35afc5ed510391b9bdc3833farbb<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
2d2eda71267231c2526be701fe655db125852c1ffielding<div class="directive-section"><h2><a name="EnableMMAP" id="EnableMMAP">EnableMMAP</a> <a name="enablemmap" id="enablemmap">Directive</a></h2>
952908500d5f99f35afc5ed510391b9bdc3833farbb<table class="directive">
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Use memory-mapping to read files during delivery</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>EnableMMAP On|Off</code></td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>EnableMMAP On</code></td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding</table>
3a50e4da8a0db4515ab45678e5b39ff7e7594320trawick <p>This directive controls whether the <code>httpd</code> may use
952908500d5f99f35afc5ed510391b9bdc3833farbb memory-mapping if it needs to read the contents of a file during
952908500d5f99f35afc5ed510391b9bdc3833farbb delivery. By default, when the handling of a request requires
3a50e4da8a0db4515ab45678e5b39ff7e7594320trawick access to the data within a file -- for example, when delivering a
3a50e4da8a0db4515ab45678e5b39ff7e7594320trawick server-parsed file using <code class="module"><a href="/mod/mod_include.html">mod_include</a></code> -- Apache
777a2b42697cb8cb94ac4e73774862f879259c45rbb memory-maps the file if the OS supports it.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>This memory-mapping sometimes yields a performance improvement.
eea18cb2519ccf7549091ec417e86d2f12e9f92ctrawick But in some environments, it is better to disable the memory-mapping
777a2b42697cb8cb94ac4e73774862f879259c45rbb to prevent operational problems:</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <ul>
2d2eda71267231c2526be701fe655db125852c1ffielding <li>On some multiprocessor systems, memory-mapping can reduce the
2d2eda71267231c2526be701fe655db125852c1ffielding performance of the <code>httpd</code>.</li>
2d2eda71267231c2526be701fe655db125852c1ffielding <li>With an NFS-mounted <code class="directive"><a href="#documentroot">DocumentRoot</a></code>,
2d2eda71267231c2526be701fe655db125852c1ffielding the <code>httpd</code> may crash due to a segmentation fault if a file
2d2eda71267231c2526be701fe655db125852c1ffielding is deleted or truncated while the <code>httpd</code> has it
2d2eda71267231c2526be701fe655db125852c1ffielding memory-mapped.</li>
952908500d5f99f35afc5ed510391b9bdc3833farbb </ul>
2d2eda71267231c2526be701fe655db125852c1ffielding
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>For server configurations that are vulnerable to these problems,
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm you should disable memory-mapping of delivered files by specifying:</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <div class="example"><p><code>
952908500d5f99f35afc5ed510391b9bdc3833farbb EnableMMAP Off
952908500d5f99f35afc5ed510391b9bdc3833farbb </code></p></div>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p>For NFS mounted files, this feature may be disabled explicitly for
2d2eda71267231c2526be701fe655db125852c1ffielding the offending files by specifying:</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <div class="example"><p><code>
2d2eda71267231c2526be701fe655db125852c1ffielding &lt;Directory "/path-to-nfs-files"&gt;
2d2eda71267231c2526be701fe655db125852c1ffielding <span class="indent">
2d2eda71267231c2526be701fe655db125852c1ffielding EnableMMAP Off
952908500d5f99f35afc5ed510391b9bdc3833farbb </span>
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;/Directory&gt;
952908500d5f99f35afc5ed510391b9bdc3833farbb </code></p></div>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb</div>
952908500d5f99f35afc5ed510391b9bdc3833farbb<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
952908500d5f99f35afc5ed510391b9bdc3833farbb<div class="directive-section"><h2><a name="EnableSendfile" id="EnableSendfile">EnableSendfile</a> <a name="enablesendfile" id="enablesendfile">Directive</a></h2>
952908500d5f99f35afc5ed510391b9bdc3833farbb<table class="directive">
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Use the kernel sendfile support to deliver files to the client</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>EnableSendfile On|Off</code></td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>EnableSendfile On</code></td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.0.44 and later</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb</table>
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>This directive controls whether <code>httpd</code> may use the sendfile
952908500d5f99f35afc5ed510391b9bdc3833farbb support from the kernel to transmit file contents to the client.
952908500d5f99f35afc5ed510391b9bdc3833farbb By default, when the handling of a request requires no access
952908500d5f99f35afc5ed510391b9bdc3833farbb to the data within a file -- for example, when delivering a
952908500d5f99f35afc5ed510391b9bdc3833farbb static file -- Apache uses sendfile to deliver the file contents
952908500d5f99f35afc5ed510391b9bdc3833farbb without ever reading the file if the OS supports it.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>This sendfile mechanism avoids seperate read and send operations,
952908500d5f99f35afc5ed510391b9bdc3833farbb and buffer allocations. But on some platforms or within some
952908500d5f99f35afc5ed510391b9bdc3833farbb filesystems, it is better to disable this feature to avoid
952908500d5f99f35afc5ed510391b9bdc3833farbb operational problems:</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <ul>
952908500d5f99f35afc5ed510391b9bdc3833farbb <li>Some platforms may have broken sendfile support that the build
952908500d5f99f35afc5ed510391b9bdc3833farbb system did not detect, especially if the binaries were built on
952908500d5f99f35afc5ed510391b9bdc3833farbb another box and moved to such a machine with broken sendfile
952908500d5f99f35afc5ed510391b9bdc3833farbb support.</li>
952908500d5f99f35afc5ed510391b9bdc3833farbb <li>With a network-mounted <code class="directive"><a href="#documentroot">DocumentRoot</a></code> (e.g., NFS or SMB),
952908500d5f99f35afc5ed510391b9bdc3833farbb the kernel may be unable to serve the network file through
952908500d5f99f35afc5ed510391b9bdc3833farbb its own cache.</li>
952908500d5f99f35afc5ed510391b9bdc3833farbb </ul>
952908500d5f99f35afc5ed510391b9bdc3833farbb
2d2eda71267231c2526be701fe655db125852c1ffielding <p>For server configurations that are vulnerable to these problems,
2d2eda71267231c2526be701fe655db125852c1ffielding you should disable this feature by specifying:</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <div class="example"><p><code>
2d2eda71267231c2526be701fe655db125852c1ffielding EnableSendfile Off
2d2eda71267231c2526be701fe655db125852c1ffielding </code></p></div>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p>For NFS or SMB mounted files, this feature may be disabled explicitly
2d2eda71267231c2526be701fe655db125852c1ffielding for the offending files by specifying:</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
952908500d5f99f35afc5ed510391b9bdc3833farbb <div class="example"><p><code>
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;Directory "/path-to-nfs-files"&gt;
2d2eda71267231c2526be701fe655db125852c1ffielding <span class="indent">
169f62b04de69074b561b4e6dcf6f82572a5e367trawick EnableSendfile Off
2d2eda71267231c2526be701fe655db125852c1ffielding </span>
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;/Directory&gt;
952908500d5f99f35afc5ed510391b9bdc3833farbb </code></p></div>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb</div>
952908500d5f99f35afc5ed510391b9bdc3833farbb<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
952908500d5f99f35afc5ed510391b9bdc3833farbb<div class="directive-section"><h2><a name="ErrorDocument" id="ErrorDocument">ErrorDocument</a> <a name="errordocument" id="errordocument">Directive</a></h2>
2d2eda71267231c2526be701fe655db125852c1ffielding<table class="directive">
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>What the server will return to the client
952908500d5f99f35afc5ed510391b9bdc3833farbbin case of an error</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ErrorDocument <var>error-code</var> <var>document</var></code></td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
3887202241db08986e94b252fbd06a55e55d4b2dbhyde<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Quoting syntax for text messages is different in Apache
952908500d5f99f35afc5ed510391b9bdc3833farbb2.0</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding</table>
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>In the event of a problem or error, Apache can be configured
2d2eda71267231c2526be701fe655db125852c1ffielding to do one of four things,</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <ol>
2d2eda71267231c2526be701fe655db125852c1ffielding <li>output a simple hardcoded error message</li>
952908500d5f99f35afc5ed510391b9bdc3833farbb
2d2eda71267231c2526be701fe655db125852c1ffielding <li>output a customized message</li>
952908500d5f99f35afc5ed510391b9bdc3833farbb
2d2eda71267231c2526be701fe655db125852c1ffielding <li>redirect to a local <var>URL-path</var> to handle the
952908500d5f99f35afc5ed510391b9bdc3833farbb problem/error</li>
952908500d5f99f35afc5ed510391b9bdc3833farbb
2d2eda71267231c2526be701fe655db125852c1ffielding <li>redirect to an external <var>URL</var> to handle the
2d2eda71267231c2526be701fe655db125852c1ffielding problem/error</li>
2d2eda71267231c2526be701fe655db125852c1ffielding </ol>
952908500d5f99f35afc5ed510391b9bdc3833farbb
2d2eda71267231c2526be701fe655db125852c1ffielding <p>The first option is the default, while options 2-4 are
952908500d5f99f35afc5ed510391b9bdc3833farbb configured using the <code class="directive">ErrorDocument</code>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm directive, which is followed by the HTTP response code and a URL
952908500d5f99f35afc5ed510391b9bdc3833farbb or a message. Apache will sometimes offer additional information
2d2eda71267231c2526be701fe655db125852c1ffielding regarding the problem/error.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p>URLs can begin with a slash (/) for local URLs, or be a full
2d2eda71267231c2526be701fe655db125852c1ffielding URL which the client can resolve. Alternatively, a message can
952908500d5f99f35afc5ed510391b9bdc3833farbb be provided to be displayed by the browser. Examples:</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <div class="example"><p><code>
952908500d5f99f35afc5ed510391b9bdc3833farbb ErrorDocument 500 http://foo.example.com/cgi-bin/tester<br />
169f62b04de69074b561b4e6dcf6f82572a5e367trawick ErrorDocument 404 /cgi-bin/bad_urls.pl<br />
169f62b04de69074b561b4e6dcf6f82572a5e367trawick ErrorDocument 401 /subscription_info.html<br />
169f62b04de69074b561b4e6dcf6f82572a5e367trawick ErrorDocument 403 "Sorry can't allow you access today"
952908500d5f99f35afc5ed510391b9bdc3833farbb </code></p></div>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p>Note that when you specify an <code class="directive">ErrorDocument</code>
952908500d5f99f35afc5ed510391b9bdc3833farbb that points to a remote URL (ie. anything with a method such as
2d2eda71267231c2526be701fe655db125852c1ffielding <code>http</code> in front of it), Apache will send a redirect to the
952908500d5f99f35afc5ed510391b9bdc3833farbb client to tell it where to find the document, even if the
952908500d5f99f35afc5ed510391b9bdc3833farbb document ends up being on the same server. This has several
952908500d5f99f35afc5ed510391b9bdc3833farbb implications, the most important being that the client will not
952908500d5f99f35afc5ed510391b9bdc3833farbb receive the original error status code, but instead will
952908500d5f99f35afc5ed510391b9bdc3833farbb receive a redirect status code. This in turn can confuse web
952908500d5f99f35afc5ed510391b9bdc3833farbb robots and other clients which try to determine if a URL is
952908500d5f99f35afc5ed510391b9bdc3833farbb valid using the status code. In addition, if you use a remote
952908500d5f99f35afc5ed510391b9bdc3833farbb URL in an <code>ErrorDocument 401</code>, the client will not
952908500d5f99f35afc5ed510391b9bdc3833farbb know to prompt the user for a password since it will not
952908500d5f99f35afc5ed510391b9bdc3833farbb receive the 401 status code. Therefore, <strong>if you use an
952908500d5f99f35afc5ed510391b9bdc3833farbb <code>ErrorDocument 401</code> directive then it must refer to a local
952908500d5f99f35afc5ed510391b9bdc3833farbb document.</strong></p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>Microsoft Internet Explorer (MSIE) will by default ignore
952908500d5f99f35afc5ed510391b9bdc3833farbb server-generated error messages when they are "too small" and substitute
952908500d5f99f35afc5ed510391b9bdc3833farbb its own "friendly" error messages. The size threshold varies depending on
952908500d5f99f35afc5ed510391b9bdc3833farbb the type of error, but in general, if you make your error document
952908500d5f99f35afc5ed510391b9bdc3833farbb greater than 512 bytes, then MSIE will show the server-generated
952908500d5f99f35afc5ed510391b9bdc3833farbb error rather than masking it. More information is available in
952908500d5f99f35afc5ed510391b9bdc3833farbb Microsoft Knowledgebase article <a href="http://support.microsoft.com/default.aspx?scid=kb;en-us;Q294807">Q294807</a>.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>Prior to version 2.0, messages were indicated by prefixing
952908500d5f99f35afc5ed510391b9bdc3833farbb them with a single unmatched double quote character.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb<h3>See also</h3>
952908500d5f99f35afc5ed510391b9bdc3833farbb<ul>
952908500d5f99f35afc5ed510391b9bdc3833farbb<li><a href="/custom-error.html">documentation of
952908500d5f99f35afc5ed510391b9bdc3833farbb customizable responses</a></li>
952908500d5f99f35afc5ed510391b9bdc3833farbb</ul>
952908500d5f99f35afc5ed510391b9bdc3833farbb</div>
2d2eda71267231c2526be701fe655db125852c1ffielding<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
2d2eda71267231c2526be701fe655db125852c1ffielding<div class="directive-section"><h2><a name="ErrorLog" id="ErrorLog">ErrorLog</a> <a name="errorlog" id="errorlog">Directive</a></h2>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<table class="directive">
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Location where the server will log errors</td></tr>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code> ErrorLog <var>file-path</var>|syslog[:<var>facility</var>]</code></td></tr>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ErrorLog logs/error_log (Unix)<br />
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbbErrorLog logs/error.log (Windows and OS/2)</code></td></tr>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb</table>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <p>The <code class="directive">ErrorLog</code> directive sets the name of
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb the file to which the server will log any errors it encounters. If
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb the <var>file-path</var> is not absolute (in general: does not begin
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb with a slash (/)) then it is assumed to be relative to the <code class="directive"><a href="#serverroot">ServerRoot</a></code>.</p>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <div class="example"><h3>Example</h3><p><code>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb ErrorLog /var/log/httpd/error_log
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb </code></p></div>
e68becff3c3ddc18723c9799b8cc2e6e9c3dbd66wrowe
e68becff3c3ddc18723c9799b8cc2e6e9c3dbd66wrowe <p>If the <var>file-path</var>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb begins with a pipe (|) then it is assumed to be a command to spawn
e68becff3c3ddc18723c9799b8cc2e6e9c3dbd66wrowe to handle the error log.</p>
e68becff3c3ddc18723c9799b8cc2e6e9c3dbd66wrowe
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <div class="example"><h3>Example</h3><p><code>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb ErrorLog "|/usr/local/bin/httpd_errors"
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb </code></p></div>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <p>Using <code>syslog</code> instead of a filename enables logging
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb via syslogd(8) if the system supports it. The default is to use
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb syslog facility <code>local7</code>, but you can override this by
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb using the <code>syslog:<var>facility</var></code> syntax where
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <var>facility</var> can be one of the names usually documented in
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb syslog(1).</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <div class="example"><h3>Example</h3><p><code>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb ErrorLog syslog:user
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb </code></p></div>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb
2d2eda71267231c2526be701fe655db125852c1ffielding <p>SECURITY: See the <a href="/misc/security_tips.html#serverroot">security tips</a>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb document for details on why your security could be compromised
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb if the directory where logfiles are stored is writable by
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb anyone other than the user that starts the server.</p>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <div class="warning"><h3>Note</h3>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <p>When entering a file path on non-Unix platforms, care should be taken
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb to make sure that only forward slashed are used even though the platform
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb may allow the use of back slashes. In general it is a good idea to always
2d2eda71267231c2526be701fe655db125852c1ffielding use forward slashes throughout the configuration files.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb </div>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb<h3>See also</h3>
952908500d5f99f35afc5ed510391b9bdc3833farbb<ul>
952908500d5f99f35afc5ed510391b9bdc3833farbb<li><code class="directive"><a href="#loglevel">LogLevel</a></code></li>
952908500d5f99f35afc5ed510391b9bdc3833farbb<li><a href="/logs.html">Apache Log Files</a></li>
952908500d5f99f35afc5ed510391b9bdc3833farbb</ul>
952908500d5f99f35afc5ed510391b9bdc3833farbb</div>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
952908500d5f99f35afc5ed510391b9bdc3833farbb<div class="directive-section"><h2><a name="FileETag" id="FileETag">FileETag</a> <a name="fileetag" id="fileetag">Directive</a></h2>
952908500d5f99f35afc5ed510391b9bdc3833farbb<table class="directive">
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File attributes used to create the ETag
952908500d5f99f35afc5ed510391b9bdc3833farbbHTTP response header</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>FileETag <var>component</var> ...</code></td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>FileETag INode MTime Size</code></td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm</table>
2d2eda71267231c2526be701fe655db125852c1ffielding <p>
2d2eda71267231c2526be701fe655db125852c1ffielding The <code class="directive">FileETag</code> directive configures the file
2d2eda71267231c2526be701fe655db125852c1ffielding attributes that are used to create the <code>ETag</code> (entity
2d2eda71267231c2526be701fe655db125852c1ffielding tag) response header field when the document is based on a file.
2d2eda71267231c2526be701fe655db125852c1ffielding (The <code>ETag</code> value is used in cache management to save
952908500d5f99f35afc5ed510391b9bdc3833farbb network bandwidth.) In Apache 1.3.22 and earlier, the
952908500d5f99f35afc5ed510391b9bdc3833farbb <code>ETag</code> value was <em>always</em> formed
952908500d5f99f35afc5ed510391b9bdc3833farbb from the file's inode, size, and last-modified time (mtime). The
952908500d5f99f35afc5ed510391b9bdc3833farbb <code class="directive">FileETag</code> directive allows you to choose
952908500d5f99f35afc5ed510391b9bdc3833farbb which of these -- if any -- should be used. The recognized keywords are:
952908500d5f99f35afc5ed510391b9bdc3833farbb </p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <dl>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm <dt><strong>INode</strong></dt>
952908500d5f99f35afc5ed510391b9bdc3833farbb <dd>The file's i-node number will be included in the calculation</dd>
952908500d5f99f35afc5ed510391b9bdc3833farbb <dt><strong>MTime</strong></dt>
952908500d5f99f35afc5ed510391b9bdc3833farbb <dd>The date and time the file was last modified will be included</dd>
952908500d5f99f35afc5ed510391b9bdc3833farbb <dt><strong>Size</strong></dt>
952908500d5f99f35afc5ed510391b9bdc3833farbb <dd>The number of bytes in the file will be included</dd>
952908500d5f99f35afc5ed510391b9bdc3833farbb <dt><strong>All</strong></dt>
952908500d5f99f35afc5ed510391b9bdc3833farbb <dd>All available fields will be used. This is equivalent to:
952908500d5f99f35afc5ed510391b9bdc3833farbb <div class="example"><p><code>FileETag INode MTime Size</code></p></div></dd>
952908500d5f99f35afc5ed510391b9bdc3833farbb <dt><strong>None</strong></dt>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm <dd>If a document is file-based, no <code>ETag</code> field will be
952908500d5f99f35afc5ed510391b9bdc3833farbb included in the response</dd>
952908500d5f99f35afc5ed510391b9bdc3833farbb </dl>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>The <code>INode</code>, <code>MTime</code>, and <code>Size</code>
952908500d5f99f35afc5ed510391b9bdc3833farbb keywords may be prefixed with either <code>+</code> or <code>-</code>,
952908500d5f99f35afc5ed510391b9bdc3833farbb which allow changes to be made to the default setting inherited
952908500d5f99f35afc5ed510391b9bdc3833farbb from a broader scope. Any keyword appearing without such a prefix
952908500d5f99f35afc5ed510391b9bdc3833farbb immediately and completely cancels the inherited setting.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm <p>If a directory's configuration includes
952908500d5f99f35afc5ed510391b9bdc3833farbb <code>FileETag&nbsp;INode&nbsp;MTime&nbsp;Size</code>, and a
952908500d5f99f35afc5ed510391b9bdc3833farbb subdirectory's includes <code>FileETag&nbsp;-INode</code>,
952908500d5f99f35afc5ed510391b9bdc3833farbb the setting for that subdirectory (which will be inherited by
952908500d5f99f35afc5ed510391b9bdc3833farbb any sub-subdirectories that don't override it) will be equivalent to
952908500d5f99f35afc5ed510391b9bdc3833farbb <code>FileETag&nbsp;MTime&nbsp;Size</code>.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb</div>
952908500d5f99f35afc5ed510391b9bdc3833farbb<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
952908500d5f99f35afc5ed510391b9bdc3833farbb<div class="directive-section"><h2><a name="Files" id="Files">&lt;Files&gt;</a> <a name="files" id="files">Directive</a></h2>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm<table class="directive">
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Contains directives that apply to matched
952908500d5f99f35afc5ed510391b9bdc3833farbbfilenames</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;Files <var>filename</var>&gt; ... &lt;/Files&gt;</code></td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb</table>
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>The <code class="directive">&lt;Files&gt;</code> directive
952908500d5f99f35afc5ed510391b9bdc3833farbb limits the scope of the enclosed directives by filename. It is comparable
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm to the <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code>
952908500d5f99f35afc5ed510391b9bdc3833farbb and <code class="directive"><a href="#location">&lt;Location&gt;</a></code>
952908500d5f99f35afc5ed510391b9bdc3833farbb directives. It should be matched with a <code>&lt;/Files&gt;</code>
952908500d5f99f35afc5ed510391b9bdc3833farbb directive. The directives given within this section will be applied to
952908500d5f99f35afc5ed510391b9bdc3833farbb any object with a basename (last component of filename) matching the
952908500d5f99f35afc5ed510391b9bdc3833farbb specified filename. <code class="directive">&lt;Files&gt;</code>
952908500d5f99f35afc5ed510391b9bdc3833farbb sections are processed in the order they appear in the
952908500d5f99f35afc5ed510391b9bdc3833farbb configuration file, after the <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code> sections and
952908500d5f99f35afc5ed510391b9bdc3833farbb <code>.htaccess</code> files are read, but before <code class="directive"><a href="#location">&lt;Location&gt;</a></code> sections. Note
952908500d5f99f35afc5ed510391b9bdc3833farbb that <code class="directive">&lt;Files&gt;</code> can be nested
952908500d5f99f35afc5ed510391b9bdc3833farbb inside <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code> sections to restrict the
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm portion of the filesystem they apply to.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>The <var>filename</var> argument should include a filename, or
952908500d5f99f35afc5ed510391b9bdc3833farbb a wild-card string, where <code>?</code> matches any single character,
952908500d5f99f35afc5ed510391b9bdc3833farbb and <code>*</code> matches any sequences of characters. Extended regular
952908500d5f99f35afc5ed510391b9bdc3833farbb expressions can also be used, with the addition of the
952908500d5f99f35afc5ed510391b9bdc3833farbb <code>~</code> character. For example:</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <div class="example"><p><code>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm &lt;Files ~ "\.(gif|jpe?g|png)$"&gt;
952908500d5f99f35afc5ed510391b9bdc3833farbb </code></p></div>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>would match most common Internet graphics formats. <code class="directive"><a href="#filesmatch">&lt;FilesMatch&gt;</a></code> is preferred,
952908500d5f99f35afc5ed510391b9bdc3833farbb however.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>Note that unlike <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code> and <code class="directive"><a href="#location">&lt;Location&gt;</a></code> sections, <code class="directive">&lt;Files&gt;</code> sections can be used inside
952908500d5f99f35afc5ed510391b9bdc3833farbb <code>.htaccess</code> files. This allows users to control access to
952908500d5f99f35afc5ed510391b9bdc3833farbb their own files, at a file-by-file level.</p>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb<h3>See also</h3>
952908500d5f99f35afc5ed510391b9bdc3833farbb<ul>
952908500d5f99f35afc5ed510391b9bdc3833farbb<li><a href="/sections.html">How &lt;Directory&gt;, &lt;Location&gt;
952908500d5f99f35afc5ed510391b9bdc3833farbb and &lt;Files&gt; sections work</a> for an explanation of how these
952908500d5f99f35afc5ed510391b9bdc3833farbb different sections are combined when a request is received</li>
952908500d5f99f35afc5ed510391b9bdc3833farbb</ul>
952908500d5f99f35afc5ed510391b9bdc3833farbb</div>
952908500d5f99f35afc5ed510391b9bdc3833farbb<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
952908500d5f99f35afc5ed510391b9bdc3833farbb<div class="directive-section"><h2><a name="FilesMatch" id="FilesMatch">&lt;FilesMatch&gt;</a> <a name="filesmatch" id="filesmatch">Directive</a></h2>
952908500d5f99f35afc5ed510391b9bdc3833farbb<table class="directive">
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Contains directives that apply to regular-expression matched
2d2eda71267231c2526be701fe655db125852c1ffieldingfilenames</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;FilesMatch <var>regex</var>&gt; ... &lt;/FilesMatch&gt;</code></td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb</table>
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>The <code class="directive">&lt;FilesMatch&gt;</code> directive
952908500d5f99f35afc5ed510391b9bdc3833farbb limits the scope of the enclosed directives by filename, just as the
952908500d5f99f35afc5ed510391b9bdc3833farbb <code class="directive"><a href="#files">&lt;Files&gt;</a></code> directive
952908500d5f99f35afc5ed510391b9bdc3833farbb does. However, it accepts a regular expression. For example:</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
952908500d5f99f35afc5ed510391b9bdc3833farbb <div class="example"><p><code>
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;FilesMatch "\.(gif|jpe?g|png)$"&gt;
952908500d5f99f35afc5ed510391b9bdc3833farbb </code></p></div>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>would match most common Internet graphics formats.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb<h3>See also</h3>
952908500d5f99f35afc5ed510391b9bdc3833farbb<ul>
952908500d5f99f35afc5ed510391b9bdc3833farbb<li><a href="/sections.html">How &lt;Directory&gt;, &lt;Location&gt;
952908500d5f99f35afc5ed510391b9bdc3833farbb and &lt;Files&gt; sections work</a> for an explanation of how these
952908500d5f99f35afc5ed510391b9bdc3833farbb different sections are combined when a request is received</li>
952908500d5f99f35afc5ed510391b9bdc3833farbb</ul>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm</div>
952908500d5f99f35afc5ed510391b9bdc3833farbb<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
952908500d5f99f35afc5ed510391b9bdc3833farbb<div class="directive-section"><h2><a name="ForceType" id="ForceType">ForceType</a> <a name="forcetype" id="forcetype">Directive</a></h2>
952908500d5f99f35afc5ed510391b9bdc3833farbb<table class="directive">
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Forces all matching files to be served with the specified
952908500d5f99f35afc5ed510391b9bdc3833farbbMIME content-type</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ForceType <var>MIME-type</var>|None</code></td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Moved to the core in Apache 2.0</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding</table>
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>When placed into an <code>.htaccess</code> file or a
952908500d5f99f35afc5ed510391b9bdc3833farbb <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code>, or
952908500d5f99f35afc5ed510391b9bdc3833farbb <code class="directive"><a href="#location">&lt;Location&gt;</a></code> or
952908500d5f99f35afc5ed510391b9bdc3833farbb <code class="directive"><a href="#files">&lt;Files&gt;</a></code>
952908500d5f99f35afc5ed510391b9bdc3833farbb section, this directive forces all matching files to be served
952908500d5f99f35afc5ed510391b9bdc3833farbb with the content type identification given by
952908500d5f99f35afc5ed510391b9bdc3833farbb <var>MIME-type</var>. For example, if you had a directory full of
952908500d5f99f35afc5ed510391b9bdc3833farbb GIF files, but did not want to label them all with <code>.gif</code>,
952908500d5f99f35afc5ed510391b9bdc3833farbb you might want to use:</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <div class="example"><p><code>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm ForceType image/gif
952908500d5f99f35afc5ed510391b9bdc3833farbb </code></p></div>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>Note that unlike <code class="directive"><a href="#defaulttype">DefaultType</a></code>,
952908500d5f99f35afc5ed510391b9bdc3833farbb this directive overrides all mime-type associations, including
952908500d5f99f35afc5ed510391b9bdc3833farbb filename extensions, that might identify the media type.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>You can override any <code class="directive">ForceType</code> setting
952908500d5f99f35afc5ed510391b9bdc3833farbb by using the value of <code>None</code>:</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm <div class="example"><p><code>
952908500d5f99f35afc5ed510391b9bdc3833farbb # force all files to be image/gif:<br />
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;Location /images&gt;<br />
952908500d5f99f35afc5ed510391b9bdc3833farbb <span class="indent">
952908500d5f99f35afc5ed510391b9bdc3833farbb ForceType image/gif<br />
952908500d5f99f35afc5ed510391b9bdc3833farbb </span>
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;/Location&gt;<br />
952908500d5f99f35afc5ed510391b9bdc3833farbb <br />
952908500d5f99f35afc5ed510391b9bdc3833farbb # but normal mime-type associations here:<br />
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;Location /images/mixed&gt;<br />
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm <span class="indent">
2d2eda71267231c2526be701fe655db125852c1ffielding ForceType None<br />
952908500d5f99f35afc5ed510391b9bdc3833farbb </span>
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;/Location&gt;
952908500d5f99f35afc5ed510391b9bdc3833farbb </code></p></div>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb</div>
952908500d5f99f35afc5ed510391b9bdc3833farbb<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
2d2eda71267231c2526be701fe655db125852c1ffielding<div class="directive-section"><h2><a name="HostnameLookups" id="HostnameLookups">HostnameLookups</a> <a name="hostnamelookups" id="hostnamelookups">Directive</a></h2>
952908500d5f99f35afc5ed510391b9bdc3833farbb<table class="directive">
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables DNS lookups on client IP addresses</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>HostnameLookups On|Off|Double</code></td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>HostnameLookups Off</code></td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding</table>
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>This directive enables DNS lookups so that host names can be
952908500d5f99f35afc5ed510391b9bdc3833farbb logged (and passed to CGIs/SSIs in <code>REMOTE_HOST</code>).
952908500d5f99f35afc5ed510391b9bdc3833farbb The value <code>Double</code> refers to doing double-reverse
952908500d5f99f35afc5ed510391b9bdc3833farbb DNS lookup. That is, after a reverse lookup is performed, a forward
952908500d5f99f35afc5ed510391b9bdc3833farbb lookup is then performed on that result. At least one of the ip
2d2eda71267231c2526be701fe655db125852c1ffielding addresses in the forward lookup must match the original
952908500d5f99f35afc5ed510391b9bdc3833farbb address. (In "tcpwrappers" terminology this is called
952908500d5f99f35afc5ed510391b9bdc3833farbb <code>PARANOID</code>.)</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>Regardless of the setting, when <code class="module"><a href="/mod/mod_authz_host.html">mod_authz_host</a></code> is
952908500d5f99f35afc5ed510391b9bdc3833farbb used for controlling access by hostname, a double reverse lookup
952908500d5f99f35afc5ed510391b9bdc3833farbb will be performed. This is necessary for security. Note that the
2d2eda71267231c2526be701fe655db125852c1ffielding result of this double-reverse isn't generally available unless you
952908500d5f99f35afc5ed510391b9bdc3833farbb set <code>HostnameLookups Double</code>. For example, if only
952908500d5f99f35afc5ed510391b9bdc3833farbb <code>HostnameLookups On</code> and a request is made to an object
952908500d5f99f35afc5ed510391b9bdc3833farbb that is protected by hostname restrictions, regardless of whether
952908500d5f99f35afc5ed510391b9bdc3833farbb the double-reverse fails or not, CGIs will still be passed the
952908500d5f99f35afc5ed510391b9bdc3833farbb single-reverse result in <code>REMOTE_HOST</code>.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>The default is <code>Off</code> in order to save the network
952908500d5f99f35afc5ed510391b9bdc3833farbb traffic for those sites that don't truly need the reverse
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm lookups done. It is also better for the end users because they
952908500d5f99f35afc5ed510391b9bdc3833farbb don't have to suffer the extra latency that a lookup entails.
952908500d5f99f35afc5ed510391b9bdc3833farbb Heavily loaded sites should leave this directive
952908500d5f99f35afc5ed510391b9bdc3833farbb <code>Off</code>, since DNS lookups can take considerable
952908500d5f99f35afc5ed510391b9bdc3833farbb amounts of time. The utility <a href="/programs/logresolve.html">logresolve</a>, compiled by default
952908500d5f99f35afc5ed510391b9bdc3833farbb to the <code>bin</code> subdirectory of your installation directory, can
952908500d5f99f35afc5ed510391b9bdc3833farbb be used to look up host names from logged IP addresses offline.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb</div>
952908500d5f99f35afc5ed510391b9bdc3833farbb<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm<div class="directive-section"><h2><a name="IfDefine" id="IfDefine">&lt;IfDefine&gt;</a> <a name="ifdefine" id="ifdefine">Directive</a></h2>
2d2eda71267231c2526be701fe655db125852c1ffielding<table class="directive">
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Encloses directives that will be processed only
952908500d5f99f35afc5ed510391b9bdc3833farbbif a test is true at startup</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;IfDefine [!]<var>parameter-name</var>&gt; ...
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;/IfDefine&gt;</code></td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm</table>
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>The <code>&lt;IfDefine <var>test</var>&gt;...&lt;/IfDefine&gt;
952908500d5f99f35afc5ed510391b9bdc3833farbb </code> section is used to mark directives that are conditional. The
952908500d5f99f35afc5ed510391b9bdc3833farbb directives within an <code class="directive">&lt;IfDefine&gt;</code>
952908500d5f99f35afc5ed510391b9bdc3833farbb section are only processed if the <var>test</var> is true. If <var>
952908500d5f99f35afc5ed510391b9bdc3833farbb test</var> is false, everything between the start and end markers is
952908500d5f99f35afc5ed510391b9bdc3833farbb ignored.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>The <var>test</var> in the <code class="directive">&lt;IfDefine&gt;</code> section directive can be one of two forms:</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <ul>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm <li><var>parameter-name</var></li>
2d2eda71267231c2526be701fe655db125852c1ffielding
952908500d5f99f35afc5ed510391b9bdc3833farbb <li><code>!</code><var>parameter-name</var></li>
952908500d5f99f35afc5ed510391b9bdc3833farbb </ul>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>In the former case, the directives between the start and end
952908500d5f99f35afc5ed510391b9bdc3833farbb markers are only processed if the parameter named
952908500d5f99f35afc5ed510391b9bdc3833farbb <var>parameter-name</var> is defined. The second format reverses
952908500d5f99f35afc5ed510391b9bdc3833farbb the test, and only processes the directives if
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm <var>parameter-name</var> is <strong>not</strong> defined.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>The <var>parameter-name</var> argument is a define as given on
952908500d5f99f35afc5ed510391b9bdc3833farbb the <code>httpd</code> command line via <code>-D<var>parameter-</var>
952908500d5f99f35afc5ed510391b9bdc3833farbb </code>, at the time the server was started.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p><code class="directive">&lt;IfDefine&gt;</code> sections are
952908500d5f99f35afc5ed510391b9bdc3833farbb nest-able, which can be used to implement simple
2d2eda71267231c2526be701fe655db125852c1ffielding multiple-parameter tests. Example:</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <div class="example"><p><code>
952908500d5f99f35afc5ed510391b9bdc3833farbb httpd -DReverseProxy ...<br />
952908500d5f99f35afc5ed510391b9bdc3833farbb <br />
952908500d5f99f35afc5ed510391b9bdc3833farbb # httpd.conf<br />
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;IfDefine ReverseProxy&gt;<br />
952908500d5f99f35afc5ed510391b9bdc3833farbb <span class="indent">
952908500d5f99f35afc5ed510391b9bdc3833farbb LoadModule rewrite_module modules/mod_rewrite.so<br />
952908500d5f99f35afc5ed510391b9bdc3833farbb LoadModule proxy_module modules/libproxy.so<br />
2d2eda71267231c2526be701fe655db125852c1ffielding </span>
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;/IfDefine&gt;
952908500d5f99f35afc5ed510391b9bdc3833farbb </code></p></div>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb</div>
952908500d5f99f35afc5ed510391b9bdc3833farbb<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
952908500d5f99f35afc5ed510391b9bdc3833farbb<div class="directive-section"><h2><a name="IfModule" id="IfModule">&lt;IfModule&gt;</a> <a name="ifmodule" id="ifmodule">Directive</a></h2>
952908500d5f99f35afc5ed510391b9bdc3833farbb<table class="directive">
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Encloses directives that are processed conditional on the
2d2eda71267231c2526be701fe655db125852c1ffieldingpresence or absence of a specific module</td></tr>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;IfModule [!]<var>module-name</var>&gt; ...
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm &lt;/IfModule&gt;</code></td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
ef7331e9f2c6fb4f671b13db21e0ac27a6dcf4f3dgaudet</table>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm <p>The <code>&lt;IfModule <var>test</var>&gt;...&lt;/IfModule&gt;</code>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm section is used to mark directives that are conditional on the presence of
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm a specific module. The directives within an <code class="directive">&lt;IfModule&gt;</code> section are only processed if the <var>test</var>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm is true. If <var>test</var> is false, everything between the start and
2d2eda71267231c2526be701fe655db125852c1ffielding end markers is ignored.</p>
06924437019f9871bc4ee49748511130548b7d35rbb
2d2eda71267231c2526be701fe655db125852c1ffielding <p>The <var>test</var> in the <code class="directive">&lt;IfModule&gt;</code> section directive can be one of two forms:</p>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm
ffba30a2a49b298bfa65151bdf61ce3e3d4636d1manoj <ul>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm <li><var>module name</var></li>
06924437019f9871bc4ee49748511130548b7d35rbb
2d2eda71267231c2526be701fe655db125852c1ffielding <li>!<var>module name</var></li>
2d2eda71267231c2526be701fe655db125852c1ffielding </ul>
2d2eda71267231c2526be701fe655db125852c1ffielding
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm <p>In the former case, the directives between the start and end
2d2eda71267231c2526be701fe655db125852c1ffielding markers are only processed if the module named <var>module
2d2eda71267231c2526be701fe655db125852c1ffielding name</var> is included in Apache -- either compiled in or
2d2eda71267231c2526be701fe655db125852c1ffielding dynamically loaded using <code class="directive"><a href="/mod/mod_so.html#loadmodule">LoadModule</a></code>. The second format reverses the test,
2d2eda71267231c2526be701fe655db125852c1ffielding and only processes the directives if <var>module name</var> is
2d2eda71267231c2526be701fe655db125852c1ffielding <strong>not</strong> included.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p>The <var>module name</var> argument is the file name of the
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm module, at the time it was compiled. For example,
2d2eda71267231c2526be701fe655db125852c1ffielding <code>mod_rewrite.c</code>. If a module consists of several
2d2eda71267231c2526be701fe655db125852c1ffielding source files, use the name of the file containing the string
2d2eda71267231c2526be701fe655db125852c1ffielding <code>STANDARD20_MODULE_STUFF</code>.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p><code class="directive">&lt;IfModule&gt;</code> sections are
2d2eda71267231c2526be701fe655db125852c1ffielding nest-able, which can be used to implement simple multiple-module
2d2eda71267231c2526be701fe655db125852c1ffielding tests.</p>
50486fceda867c0bb0223d9548c7c1c9b194259dfielding
2d2eda71267231c2526be701fe655db125852c1ffielding <div class="note">This section should only be used if you need to have one
2d2eda71267231c2526be701fe655db125852c1ffielding configuration file that works whether or not a specific module
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm is available. In normal operation, directives need not be
2d2eda71267231c2526be701fe655db125852c1ffielding placed in <code class="directive">&lt;IfModule&gt;</code>
2d2eda71267231c2526be701fe655db125852c1ffielding sections.</div>
2d2eda71267231c2526be701fe655db125852c1ffielding
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm</div>
2d2eda71267231c2526be701fe655db125852c1ffielding<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
2d2eda71267231c2526be701fe655db125852c1ffielding<div class="directive-section"><h2><a name="Include" id="Include">Include</a> <a name="include" id="include">Directive</a></h2>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm<table class="directive">
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Includes other configuration files from within
2d2eda71267231c2526be701fe655db125852c1ffieldingthe server configuration files</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Include <var>file-path</var>|<var>directory-path</var></code></td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Wildcard matching available in 2.0.41 and later</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding</table>
2d2eda71267231c2526be701fe655db125852c1ffielding <p>This directive allows inclusion of other configuration files
2d2eda71267231c2526be701fe655db125852c1ffielding from within the server configuration files.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p>Shell-style (<code>fnmatch()</code>) wildcard characters can be used to
2d2eda71267231c2526be701fe655db125852c1ffielding include several files at once, in alphabetical order. In
2d2eda71267231c2526be701fe655db125852c1ffielding addition, if <code class="directive">Include</code> points to a directory,
2d2eda71267231c2526be701fe655db125852c1ffielding rather than a file, Apache will read all files in that directory
2d2eda71267231c2526be701fe655db125852c1ffielding and any subdirectory. But including entire directories is not
2d2eda71267231c2526be701fe655db125852c1ffielding recommended, because it is easy to accidentally leave temporary
2d2eda71267231c2526be701fe655db125852c1ffielding files in a directory that can cause <code>httpd</code> to
2d2eda71267231c2526be701fe655db125852c1ffielding fail.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p>The file path specified may be an absolute path (i.e.
2d2eda71267231c2526be701fe655db125852c1ffielding starting with a slash), or may be relative to the
2d2eda71267231c2526be701fe655db125852c1ffielding <code class="directive"><a href="#serverroot">ServerRoot</a></code> directory.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p>Examples:</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <div class="example"><p><code>
2d2eda71267231c2526be701fe655db125852c1ffielding Include /usr/local/apache2/conf/ssl.conf<br />
2d2eda71267231c2526be701fe655db125852c1ffielding Include /usr/local/apache2/conf/vhosts/*.conf
2d2eda71267231c2526be701fe655db125852c1ffielding </code></p></div>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p>Or, providing paths relative to your <code class="directive"><a href="#serverroot">ServerRoot</a></code> directory:</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <div class="example"><p><code>
2d2eda71267231c2526be701fe655db125852c1ffielding Include conf/ssl.conf<br />
2d2eda71267231c2526be701fe655db125852c1ffielding Include conf/vhosts/*.conf
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben </code></p></div>
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben <p>Running <code>apachectl configtest</code> will give you a list
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben of the files that are being processed during the configuration
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben check:</p>
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben
5f7c351eb2a69d8cef6c3e98e27ce6158a0b1780rbb <div class="example"><p><code>
66d349e02d1a5a599a01c977d2c5b0009181f7deben root@host# apachectl configtest<br />
5f7c351eb2a69d8cef6c3e98e27ce6158a0b1780rbb Processing config file: /usr/local/apache2/conf/ssl.conf<br />
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben Processing config file: /usr/local/apache2/conf/vhosts/vhost1.conf<br />
dca927eafb338b9de9d0214818136c16d436e3fdrbb Processing config file: /usr/local/apache2/conf/vhosts/vhost2.conf<br />
dca927eafb338b9de9d0214818136c16d436e3fdrbb Syntax OK
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben </code></p></div>
66d349e02d1a5a599a01c977d2c5b0009181f7deben
66d349e02d1a5a599a01c977d2c5b0009181f7deben<h3>See also</h3>
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben<ul>
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben<li><a href="/programs/apachectl.html">apachectl</a></li>
dca927eafb338b9de9d0214818136c16d436e3fdrbb</ul>
dca927eafb338b9de9d0214818136c16d436e3fdrbb</div>
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben<div class="directive-section"><h2><a name="KeepAlive" id="KeepAlive">KeepAlive</a> <a name="keepalive" id="keepalive">Directive</a></h2>
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben<table class="directive">
66d349e02d1a5a599a01c977d2c5b0009181f7deben<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables HTTP persistent connections</td></tr>
66d349e02d1a5a599a01c977d2c5b0009181f7deben<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>KeepAlive On|Off</code></td></tr>
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>KeepAlive On</code></td></tr>
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
dca927eafb338b9de9d0214818136c16d436e3fdrbb<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
dca927eafb338b9de9d0214818136c16d436e3fdrbb<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben</table>
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben <p>The Keep-Alive extension to HTTP/1.0 and the persistent
0a09a4a642f7c0d367598394411dbdd4a6d8cd09fielding connection feature of HTTP/1.1 provide long-lived HTTP sessions
2d2eda71267231c2526be701fe655db125852c1ffielding which allow multiple requests to be sent over the same TCP
2d2eda71267231c2526be701fe655db125852c1ffielding connection. In some cases this has been shown to result in an
2d2eda71267231c2526be701fe655db125852c1ffielding almost 50% speedup in latency times for HTML documents with
2d2eda71267231c2526be701fe655db125852c1ffielding many images. To enable Keep-Alive connections, set
2d2eda71267231c2526be701fe655db125852c1ffielding <code>KeepAlive On</code>.</p>
<p>For HTTP/1.0 clients, Keep-Alive connections will only be
used if they are specifically requested by a client. In
addition, a Keep-Alive connection with an HTTP/1.0 client can
only be used when the length of the content is known in
advance. This implies that dynamic content such as CGI output,
SSI pages, and server-generated directory listings will
generally not use Keep-Alive connections to HTTP/1.0 clients.
For HTTP/1.1 clients, persistent connections are the default
unless otherwise specified. If the client requests it, chunked
encoding will be used in order to send content of unknown
length over persistent connections.</p>
<h3>See also</h3>
<ul>
<li><code class="directive"><a href="#maxkeepaliverequests">MaxKeepAliveRequests</a></code></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="KeepAliveTimeout" id="KeepAliveTimeout">KeepAliveTimeout</a> <a name="keepalivetimeout" id="keepalivetimeout">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Amount of time the server will wait for subsequent
requests on a persistent connection</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>KeepAliveTimeout <var>seconds</var></code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>KeepAliveTimeout 15</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>The number of seconds Apache will wait for a subsequent
request before closing the connection. Once a request has been
received, the timeout value specified by the
<code class="directive"><a href="#timeout">Timeout</a></code> directive applies.</p>
<p>Setting <code class="directive">KeepAliveTimeout</code> to a high value
may cause performance problems in heavily loaded servers. The
higher the timeout, the more server processes will be kept
occupied waiting on connections with idle clients.</p>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="Limit" id="Limit">&lt;Limit&gt;</a> <a name="limit" id="limit">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Restrict enclosed access controls to only certain HTTP
methods</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;Limit <var>method</var> [<var>method</var>] ... &gt; ...
&lt;/Limit&gt;</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>Access controls are normally effective for
<strong>all</strong> access methods, and this is the usual
desired behavior. <strong>In the general case, access control
directives should not be placed within a
<code class="directive">&lt;Limit&gt;</code> section.</strong></p>
<p>The purpose of the <code class="directive">&lt;Limit&gt;</code>
directive is to restrict the effect of the access controls to the
nominated HTTP methods. For all other methods, the access
restrictions that are enclosed in the <code class="directive">&lt;Limit&gt;</code> bracket <strong>will have no
effect</strong>. The following example applies the access control
only to the methods <code>POST</code>, <code>PUT</code>, and
<code>DELETE</code>, leaving all other methods unprotected:</p>
<div class="example"><p><code>
&lt;Limit POST PUT DELETE&gt;<br />
<span class="indent">
Require valid-user<br />
</span>
&lt;/Limit&gt;
</code></p></div>
<p>The method names listed can be one or more of: <code>GET</code>,
<code>POST</code>, <code>PUT</code>, <code>DELETE</code>,
<code>CONNECT</code>, <code>OPTIONS</code>,
<code>PATCH</code>, <code>PROPFIND</code>, <code>PROPPATCH</code>,
<code>MKCOL</code>, <code>COPY</code>, <code>MOVE</code>,
<code>LOCK</code>, and <code>UNLOCK</code>. <strong>The method name is
case-sensitive.</strong> If <code>GET</code> is used it will also
restrict <code>HEAD</code> requests. The <code>TRACE</code> method
cannot be limited.</p>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="LimitExcept" id="LimitExcept">&lt;LimitExcept&gt;</a> <a name="limitexcept" id="limitexcept">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Restrict access controls to all HTTP methods
except the named ones</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;LimitExcept <var>method</var> [<var>method</var>] ... &gt; ...
&lt;/LimitExcept&gt;</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p><code class="directive">&lt;LimitExcept&gt;</code> and
<code>&lt;/LimitExcept&gt;</code> are used to enclose
a group of access control directives which will then apply to any
HTTP access method <strong>not</strong> listed in the arguments;
i.e., it is the opposite of a <code class="directive"><a href="#limit">&lt;Limit&gt;</a></code> section and can be used to control
both standard and nonstandard/unrecognized methods. See the
documentation for <code class="directive"><a href="#limit">&lt;Limit&gt;</a></code> for more details.</p>
<p>For example:</p>
<div class="example"><p><code>
&lt;LimitExcept POST GET&gt;<br />
<span class="indent">
Require valid-user<br />
</span>
&lt;LimitExcept&gt;
</code></p></div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="LimitInternalRecursion" id="LimitInternalRecursion">LimitInternalRecursion</a> <a name="limitinternalrecursion" id="limitinternalrecursion">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Determine maximum number of internal redirects and nested
subrequests</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LimitInternalRecursion <var>number</var> [<var>number</var>]</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LimitInternalRecursion 10</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.1 and later</td></tr>
</table>
<p>An internal redirect happens, for example, when using the <code class="directive"><a href="/mod/mod_actions.html#action">Action</a></code> directive, which internally
redirects the original request to a CGI script. A subrequest is Apache's
mechanism to find out what would happen for some URI if it were requested.
For example, <code class="module"><a href="/mod/mod_dir.html">mod_dir</a></code> uses subrequests to look for the
files listed in the <code class="directive"><a href="/mod/mod_dir.html#directoryindex">DirectoryIndex</a></code>
directive.</p>
<p><code class="directive">LimitInternalRecursion</code> prevents the server
from crashing when entering an infinite loop of internal redirects or
subrequests. Such loops are usually caused by misconfigurations.</p>
<p>The directive stores two different limits, which are evaluated on
per-request basis. The first <var>number</var> is the maximum number of
internal redirects, that may follow each other. The second <var>number</var>
determines, how deep subrequests may be nested. If you specify only one
<var>number</var>, it will be assigned to both limits.</p>
<div class="example"><h3>Example</h3><p><code>
LimitInternalRecursion 5
</code></p></div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="LimitRequestBody" id="LimitRequestBody">LimitRequestBody</a> <a name="limitrequestbody" id="limitrequestbody">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Restricts the total size of the HTTP request body sent
from the client</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LimitRequestBody <var>bytes</var></code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LimitRequestBody 0</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>This directive specifies the number of <var>bytes</var> from 0
(meaning unlimited) to 2147483647 (2GB) that are allowed in a
request body. The default value is defined by the compile-time
constant <code>DEFAULT_LIMIT_REQUEST_BODY</code> (0 as
distributed).</p>
<p>The <code class="directive">LimitRequestBody</code> directive allows
the user to set a limit on the allowed size of an HTTP request
message body within the context in which the directive is given
(server, per-directory, per-file or per-location). If the client
request exceeds that limit, the server will return an error
response instead of servicing the request. The size of a normal
request message body will vary greatly depending on the nature of
the resource and the methods allowed on that resource. CGI scripts
typically use the message body for retrieving form information.
Implementations of the <code>PUT</code> method will require
a value at least as large as any representation that the server
wishes to accept for that resource.</p>
<p>This directive gives the server administrator greater
control over abnormal client request behavior, which may be
useful for avoiding some forms of denial-of-service
attacks.</p>
<p>If, for example, you are permitting file upload to a particular
location, and wish to limit the size of the uploaded file to 100K,
you might use the following directive:</p>
<div class="example"><p><code>
LimitRequestBody 102400
</code></p></div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="LimitRequestFields" id="LimitRequestFields">LimitRequestFields</a> <a name="limitrequestfields" id="limitrequestfields">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limits the number of HTTP request header fields that
will be accepted from the client</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LimitRequestFields <var>number</var></code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LimitRequestFields 100</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p><var>Number</var> is an integer from 0 (meaning unlimited) to
32767. The default value is defined by the compile-time
constant <code>DEFAULT_LIMIT_REQUEST_FIELDS</code> (100 as
distributed).</p>
<p>The <code class="directive">LimitRequestFields</code> directive allows
the server administrator to modify the limit on the number of
request header fields allowed in an HTTP request. A server needs
this value to be larger than the number of fields that a normal
client request might include. The number of request header fields
used by a client rarely exceeds 20, but this may vary among
different client implementations, often depending upon the extent
to which a user has configured their browser to support detailed
content negotiation. Optional HTTP extensions are often expressed
using request header fields.</p>
<p>This directive gives the server administrator greater
control over abnormal client request behavior, which may be
useful for avoiding some forms of denial-of-service attacks.
The value should be increased if normal clients see an error
response from the server that indicates too many fields were
sent in the request.</p>
<p>For example:</p>
<div class="example"><p><code>
LimitRequestFields 50
</code></p></div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="LimitRequestFieldSize" id="LimitRequestFieldSize">LimitRequestFieldSize</a> <a name="limitrequestfieldsize" id="limitrequestfieldsize">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limits the size of the HTTP request header allowed from the
client</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LimitRequestFieldsize <var>bytes</var></code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LimitRequestFieldsize 8190</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>This directive specifies the number of <var>bytes</var> from 0
to the value of the compile-time constant
<code>DEFAULT_LIMIT_REQUEST_FIELDSIZE</code> (8190 as
distributed) that will be allowed in an HTTP request
header.</p>
<p>The <code class="directive">LimitRequestFieldSize</code> directive
allows the server administrator to reduce the limit on the allowed
size of an HTTP request header field below the normal input buffer
size compiled with the server. A server needs this value to be
large enough to hold any one header field from a normal client
request. The size of a normal request header field will vary
greatly among different client implementations, often depending
upon the extent to which a user has configured their browser to
support detailed content negotiation.</p>
<p>This directive gives the server administrator greater
control over abnormal client request behavior, which may be
useful for avoiding some forms of denial-of-service attacks.</p>
<p>For example:</p>
<div class="example"><p><code>
LimitRequestFieldSize 4094
</code></p></div>
<div class="note">Under normal conditions, the value should not be changed from
the default.</div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="LimitRequestLine" id="LimitRequestLine">LimitRequestLine</a> <a name="limitrequestline" id="limitrequestline">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limit the size of the HTTP request line that will be accepted
from the client</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LimitRequestLine <var>bytes</var></code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LimitRequestLine 8190</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>This directive sets the number of <var>bytes</var> from 0 to
the value of the compile-time constant
<code>DEFAULT_LIMIT_REQUEST_LINE</code> (8190 as distributed)
that will be allowed on the HTTP request-line.</p>
<p>The <code class="directive">LimitRequestLine</code> directive allows
the server administrator to reduce the limit on the allowed size
of a client's HTTP request-line below the normal input buffer size
compiled with the server. Since the request-line consists of the
HTTP method, URI, and protocol version, the
<code class="directive">LimitRequestLine</code> directive places a
restriction on the length of a request-URI allowed for a request
on the server. A server needs this value to be large enough to
hold any of its resource names, including any information that
might be passed in the query part of a <code>GET</code> request.</p>
<p>This directive gives the server administrator greater
control over abnormal client request behavior, which may be
useful for avoiding some forms of denial-of-service attacks.</p>
<p>For example:</p>
<div class="example"><p><code>
LimitRequestLine 4094
</code></p></div>
<div class="note">Under normal conditions, the value should not be changed from
the default.</div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="LimitXMLRequestBody" id="LimitXMLRequestBody">LimitXMLRequestBody</a> <a name="limitxmlrequestbody" id="limitxmlrequestbody">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limits the size of an XML-based request body</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LimitXMLRequestBody <var>bytes</var></code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LimitXMLRequestBody 1000000</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>Limit (in bytes) on maximum size of an XML-based request
body. A value of <code>0</code> will disable any checking.</p>
<p>Example:</p>
<div class="example"><p><code>
LimitXMLRequestBody 0
</code></p></div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="Location" id="Location">&lt;Location&gt;</a> <a name="location" id="location">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Applies the enclosed directives only to matching
URLs</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;Location
<var>URL-path</var>|<var>URL</var>&gt; ... &lt;/Location&gt;</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>The <code class="directive">&lt;Location&gt;</code> directive
limits the scope of the enclosed directives by URL. It is similar to the
<code class="directive"><a href="#directory">&lt;Directory&gt;</a></code>
directive, and starts a subsection which is terminated with a
<code>&lt;/Location&gt;</code> directive. <code class="directive">&lt;Location&gt;</code> sections are processed in the
order they appear in the configuration file, after the <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code> sections and
<code>.htaccess</code> files are read, and after the <code class="directive"><a href="#files">&lt;Files&gt;</a></code> sections.</p>
<p><code class="directive">&lt;Location&gt;</code> sections operate
completely outside the filesystem. This has several consequences.
Most importantly, <code class="directive">&lt;Location&gt;</code>
directives should not be used to control access to filesystem
locations. Since several different URLs may map to the same
filesystem location, such access controls may by circumvented.</p>
<div class="note"><h3>When to use <code class="directive">&lt;Location&gt;</code></h3>
<p>Use <code class="directive">&lt;Location&gt;</code> to apply
directives to content that lives outside the filesystem. For
content that lives in the filesystem, use <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code> and <code class="directive"><a href="#files">&lt;Files&gt;</a></code>. An exception is
<code>&lt;Location /&gt;</code>, which is an easy way to
apply a configuration to the entire server.</p>
</div>
<p>For all origin (non-proxy) requests, the URL to be matched is a
URL-path of the form <code>/path/</code>. No scheme, hostname,
port, or query string may be included. For proxy requests, the
URL to be matched is of the form
<code>scheme://servername/path</code>, and you must include the
prefix.</p>
<p>The URL may use wildcards. In a wild-card string, <code>?</code> matches
any single character, and <code>*</code> matches any sequences of
characters.</p>
<p>Extended regular
expressions can also be used, with the addition of the
<code>~</code> character. For example:</p>
<div class="example"><p><code>
&lt;Location ~ "/(extra|special)/data"&gt;
</code></p></div>
<p>would match URLs that contained the substring <code>/extra/data</code>
or <code>/special/data</code>. The directive <code class="directive"><a href="#locationmatch">&lt;LocationMatch&gt;</a></code> behaves
identical to the regex version of <code class="directive">&lt;Location&gt;</code>.</p>
<p>The <code class="directive">&lt;Location&gt;</code>
functionality is especially useful when combined with the
<code class="directive"><a href="#sethandler">SetHandler</a></code>
directive. For example, to enable status requests, but allow them
only from browsers at <code>foo.com</code>, you might use:</p>
<div class="example"><p><code>
&lt;Location /status&gt;<br />
<span class="indent">
SetHandler server-status<br />
Order Deny,Allow<br />
Deny from all<br />
Allow from .foo.com<br />
</span>
&lt;/Location&gt;
</code></p></div>
<div class="note"><h3>Note about / (slash)</h3>
<p>The slash character has special meaning depending on where in a
URL it appears. People may be used to its behavior in the filesystem
where multiple adjacent slashes are frequently collapsed to a single
slash (<em>i.e.</em>, <code>/home///foo</code> is the same as
<code>/home/foo</code>). In URL-space this is not necessarily true.
The <code class="directive"><a href="#locationmatch">&lt;LocationMatch&gt;</a></code>
directive and the regex version of <code class="directive">&lt;Location&gt;</code> require you to explicitly specify multiple
slashes if that is your intention.</p>
<p>For example, <code>&lt;LocationMatch ^/abc&gt;</code> would match
the request URL <code>/abc</code> but not the request URL <code>
//abc</code>. The (non-regex) <code class="directive">&lt;Location&gt;</code> directive behaves similarly when used for
proxy requests. But when (non-regex) <code class="directive">&lt;Location&gt;</code> is used for non-proxy requests it will
implicitly match multiple slashes with a single slash. For example,
if you specify <code>&lt;Location /abc/def&gt;</code> and the
request is to <code>/abc//def</code> then it will match.</p>
</div>
<h3>See also</h3>
<ul>
<li><a href="/sections.html">How &lt;Directory&gt;, &lt;Location&gt;
and &lt;Files&gt; sections work</a> for an explanation of how these
different sections are combined when a request is received</li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="LocationMatch" id="LocationMatch">&lt;LocationMatch&gt;</a> <a name="locationmatch" id="locationmatch">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Applies the enclosed directives only to regular-expression
matching URLs</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;LocationMatch
<var>regex</var>&gt; ... &lt;/LocationMatch&gt;</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>The <code class="directive">&lt;LocationMatch&gt;</code> directive
limits the scope of the enclosed directives by URL, in an identical manner
to <code class="directive"><a href="#location">&lt;Location&gt;</a></code>. However,
it takes a regular expression as an argument instead of a simple
string. For example:</p>
<div class="example"><p><code>
&lt;LocationMatch "/(extra|special)/data"&gt;
</code></p></div>
<p>would match URLs that contained the substring <code>/extra/data</code>
or <code>/special/data</code>.</p>
<h3>See also</h3>
<ul>
<li><a href="/sections.html">How &lt;Directory&gt;, &lt;Location&gt;
and &lt;Files&gt; sections work</a> for an explanation of how these
different sections are combined when a request is received</li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="LogLevel" id="LogLevel">LogLevel</a> <a name="loglevel" id="loglevel">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Controls the verbosity of the ErrorLog</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LogLevel <var>level</var></code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LogLevel warn</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p><code class="directive">LogLevel</code> adjusts the verbosity of the
messages recorded in the error logs (see <code class="directive"><a href="#errorlog">ErrorLog</a></code> directive). The following
<var>level</var>s are available, in order of decreasing
significance:</p>
<table class="bordered">
<tr>
<th><strong>Level</strong> </th>
<th><strong>Description</strong> </th>
<th><strong>Example</strong> </th>
</tr>
<tr>
<td><code>emerg</code> </td>
<td>Emergencies - system is unusable.</td>
<td>"Child cannot open lock file. Exiting"</td>
</tr>
<tr>
<td><code>alert</code> </td>
<td>Action must be taken immediately.</td>
<td>"getpwuid: couldn't determine user name from uid"</td>
</tr>
<tr>
<td><code>crit</code> </td>
<td>Critical Conditions.</td>
<td>"socket: Failed to get a socket, exiting child"</td>
</tr>
<tr>
<td><code>error</code> </td>
<td>Error conditions.</td>
<td>"Premature end of script headers"</td>
</tr>
<tr>
<td><code>warn</code> </td>
<td>Warning conditions.</td>
<td>"child process 1234 did not exit, sending another
SIGHUP"</td>
</tr>
<tr>
<td><code>notice</code> </td>
<td>Normal but significant condition.</td>
<td>"httpd: caught SIGBUS, attempting to dump core in
..."</td>
</tr>
<tr>
<td><code>info</code> </td>
<td>Informational.</td>
<td>"Server seems busy, (you may need to increase
StartServers, or Min/MaxSpareServers)..."</td>
</tr>
<tr>
<td><code>debug</code> </td>
<td>Debug-level messages</td>
<td>"Opening config file ..."</td>
</tr>
</table>
<p>When a particular level is specified, messages from all
other levels of higher significance will be reported as well.
<em>E.g.</em>, when <code>LogLevel info</code> is specified,
then messages with log levels of <code>notice</code> and
<code>warn</code> will also be posted.</p>
<p>Using a level of at least <code>crit</code> is
recommended.</p>
<p>For example:</p>
<div class="example"><p><code>
LogLevel notice
</code></p></div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="MaxKeepAliveRequests" id="MaxKeepAliveRequests">MaxKeepAliveRequests</a> <a name="maxkeepaliverequests" id="maxkeepaliverequests">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Number of requests allowed on a persistent
connection</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>MaxKeepAliveRequests <var>number</var></code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>MaxKeepAliveRequests 100</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>The <code class="directive">MaxKeepAliveRequests</code> directive
limits the number of requests allowed per connection when
<code class="directive"><a href="#keepalive">KeepAlive</a></code> is on. If it is
set to <code>0</code>, unlimited requests will be allowed. We
recommend that this setting be kept to a high value for maximum
server performance.</p>
<p>For example:</p>
<div class="example"><p><code>
MaxKeepAliveRequests 500
</code></p></div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="NameVirtualHost" id="NameVirtualHost">NameVirtualHost</a> <a name="namevirtualhost" id="namevirtualhost">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Designates an IP address for name-virtual
hosting</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>NameVirtualHost <var>addr</var>[:<var>port</var>]</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>The <code class="directive">NameVirtualHost</code> directive is a
required directive if you want to configure <a href="/vhosts/">name-based virtual hosts</a>.</p>
<p>Although <var>addr</var> can be hostname it is recommended
that you always use an IP address, e.g.</p>
<div class="example"><p><code>
NameVirtualHost 111.22.33.44
</code></p></div>
<p>With the <code class="directive">NameVirtualHost</code> directive you
specify the IP address on which the server will receive requests
for the name-based virtual hosts. This will usually be the address
to which your name-based virtual host names resolve. In cases
where a firewall or other proxy receives the requests and forwards
them on a different IP address to the server, you must specify the
IP address of the physical interface on the machine which will be
servicing the requests. If you have multiple name-based hosts on
multiple addresses, repeat the directive for each address.</p>
<div class="note"><h3>Note</h3>
<p>Note, that the "main server" and any <code>_default_</code> servers
will <strong>never</strong> be served for a request to a
<code class="directive">NameVirtualHost</code> IP Address (unless for some
reason you specify <code class="directive">NameVirtualHost</code> but then
don't define any <code class="directive">VirtualHost</code>s for that
address).</p>
</div>
<p>Optionally you can specify a port number on which the
name-based virtual hosts should be used, e.g.</p>
<div class="example"><p><code>
NameVirtualHost 111.22.33.44:8080
</code></p></div>
<p>IPv6 addresses must be enclosed in square brackets, as shown
in the following example:</p>
<div class="example"><p><code>
NameVirtualHost [fe80::a00:20ff:fea7:ccea]:8080
</code></p></div>
<p>To receive requests on all interfaces, you can use an argument of
<code>*</code></p>
<div class="example"><p><code>
NameVirtualHost *
</code></p></div>
<div class="note"><h3>Argument to <code class="directive">&lt;VirtualHost&gt;</code>
directive</h3>
<p>Note that the argument to the <code class="directive">&lt;VirtualHost&gt;</code> directive must
exactly match the argument to the <code class="directive">NameVirtualHost</code> directive.</p>
<div class="example"><p><code>
NameVirtualHost 1.2.3.4<br />
&lt;VirtualHost 1.2.3.4&gt;<br />
# ...<br />
&lt;/VirtualHost&gt;<br />
</code></p></div>
</div>
<h3>See also</h3>
<ul>
<li><a href="/vhosts/">Virtual Hosts
documentation</a></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="Options" id="Options">Options</a> <a name="options" id="options">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures what features are available in a particular
directory</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Options
[+|-]<var>option</var> [[+|-]<var>option</var>] ...</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Options All</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Options</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>The <code class="directive">Options</code> directive controls which
server features are available in a particular directory.</p>
<p><var>option</var> can be set to <code>None</code>, in which
case none of the extra features are enabled, or one or more of
the following:</p>
<dl>
<dt><code>All</code></dt>
<dd>All options except for <code>MultiViews</code>. This is the default
setting.</dd>
<dt><code>ExecCGI</code></dt>
<dd>
Execution of CGI scripts using <code class="module"><a href="/mod/mod_cgi.html">mod_cgi</a></code>
is permitted.</dd>
<dt><code>FollowSymLinks</code></dt>
<dd>
The server will follow symbolic links in this directory.
<div class="note">
<p>Even though the server follows the symlink it does <em>not</em>
change the pathname used to match against <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code> sections.</p>
<p>Note also, that this option <strong>gets ignored</strong> if set
inside a <code class="directive"><a href="#location">&lt;Location&gt;</a></code>
section.</p>
</div></dd>
<dt><code>Includes</code></dt>
<dd>
Server-side includes provided by <code class="module"><a href="/mod/mod_include.html">mod_include</a></code>
are permitted.</dd>
<dt><code>IncludesNOEXEC</code></dt>
<dd>
Server-side includes are permitted, but the <code>#exec
cmd</code> and <code>#exec cgi</code> are disabled. It is still
possible to <code>#include virtual</code> CGI scripts from
<code class="directive"><a href="/mod/mod_cgi.html#scriptalias">ScriptAlias</a></code>ed
directories.</dd>
<dt><code>Indexes</code></dt>
<dd>
If a URL which maps to a directory is requested, and the there
is no <code class="directive"><a href="/mod/mod_dir.html#directoryindex">DirectoryIndex</a></code>
(<em>e.g.</em>, <code>index.html</code>) in that directory, then
<code class="module"><a href="/mod/mod_autoindex.html">mod_autoindex</a></code> will return a formatted listing
of the directory.</dd>
<dt><code>MultiViews</code></dt>
<dd>
<a href="/content-negotiation.html">Content negotiated</a>
"MultiViews" are allowed using
<code class="module"><a href="/mod/mod_negotiation.html">mod_negotiation</a></code>.</dd>
<dt><code>SymLinksIfOwnerMatch</code></dt>
<dd>The server will only follow symbolic links for which the
target file or directory is owned by the same user id as the
link.
<div class="note"><h3>Note</h3> This option gets ignored if
set inside a <code class="directive"><a href="#location">&lt;Location&gt;</a></code> section.</div>
</dd>
</dl>
<p>Normally, if multiple <code class="directive">Options</code> could
apply to a directory, then the most specific one is used and
others are ignored; the options are not merged. (See <a href="/sections.html#mergin">how sections are merged</a>.)
However if <em>all</em> the options on the
<code class="directive">Options</code> directive are preceded by a
<code>+</code> or <code>-</code> symbol, the options are
merged. Any options preceded by a <code>+</code> are added to the
options currently in force, and any options preceded by a
<code>-</code> are removed from the options currently in
force. </p>
<p>For example, without any <code>+</code> and <code>-</code> symbols:</p>
<div class="example"><p><code>
&lt;Directory /web/docs&gt;<br />
<span class="indent">
Options Indexes FollowSymLinks<br />
</span>
&lt;/Directory&gt;<br />
<br />
&lt;Directory /web/docs/spec&gt;<br />
<span class="indent">
Options Includes<br />
</span>
&lt;/Directory&gt;
</code></p></div>
<p>then only <code>Includes</code> will be set for the
<code>/web/docs/spec</code> directory. However if the second
<code class="directive">Options</code> directive uses the <code>+</code> and
<code>-</code> symbols:</p>
<div class="example"><p><code>
&lt;Directory /web/docs&gt;<br />
<span class="indent">
Options Indexes FollowSymLinks<br />
</span>
&lt;/Directory&gt;<br />
<br />
&lt;Directory /web/docs/spec&gt;<br />
<span class="indent">
Options +Includes -Indexes<br />
</span>
&lt;/Directory&gt;
</code></p></div>
<p>then the options <code>FollowSymLinks</code> and
<code>Includes</code> are set for the <code>/web/docs/spec</code>
directory.</p>
<div class="note"><h3>Note</h3>
<p>Using <code>-IncludesNOEXEC</code> or
<code>-Includes</code> disables server-side includes completely
regardless of the previous setting.</p>
</div>
<p>The default in the absence of any other settings is
<code>All</code>.</p>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="Require" id="Require">Require</a> <a name="require" id="require">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Selects which authenticated users can access
a resource</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Require <var>entity-name</var> [<var>entity-name</var>] ...</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>This directive selects which authenticated users can access
a directory. The allowed syntaxes are:</p>
<dl>
<dt><code>Require user <var>userid</var> [<var>userid</var>]
...</code></dt>
<dd>Only the named users can access the resource.</dd>
<dt><code>Require group <var>group-name</var> [<var>group-name</var>]
...</code></dt>
<dd>Only users in the named groups can access the resource.</dd>
<dt><code>Require valid-user</code></dt>
<dd>All valid users can access the resource.</dd>
</dl>
<p><code class="directive">Require</code> must be accompanied by
<code class="directive"><a href="#authname">AuthName</a></code> and <code class="directive"><a href="#authtype">AuthType</a></code> directives, and directives such
as <code class="directive"><a href="/mod/mod_authn_file.html#authuserfile">AuthUserFile</a></code>
and <code class="directive"><a href="/mod/mod_authz_groupfile.html#authgroupfile">AuthGroupFile</a></code> (to
define users and groups) in order to work correctly. Example:</p>
<div class="example"><p><code>
AuthType Basic<br />
AuthName "Restricted Directory"<br />
AuthUserFile /web/users<br />
AuthGroupFile /web/groups<br />
Require group admin
</code></p></div>
<p>Access controls which are applied in this way are effective for
<strong>all</strong> methods. <strong>This is what is normally
desired.</strong> If you wish to apply access controls only to
specific methods, while leaving other methods unprotected, then
place the <code class="directive">Require</code> statement into a
<code class="directive"><a href="#limit">&lt;Limit&gt;</a></code>
section.</p>
<h3>See also</h3>
<ul>
<li><code class="directive"><a href="#satisfy">Satisfy</a></code></li>
<li><code class="module"><a href="/mod/mod_authz_host.html">mod_authz_host</a></code></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="RLimitCPU" id="RLimitCPU">RLimitCPU</a> <a name="rlimitcpu" id="rlimitcpu">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limits the CPU consumption of processes launched
by Apache children</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RLimitCPU <var>seconds</var>|max [<var>seconds</var>|max]</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Unset; uses operating system defaults</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>Takes 1 or 2 parameters. The first parameter sets the soft
resource limit for all processes and the second parameter sets
the maximum resource limit. Either parameter can be a number,
or <code>max</code> to indicate to the server that the limit should
be set to the maximum allowed by the operating system
configuration. Raising the maximum resource limit requires that
the server is running as <code>root</code>, or in the initial startup
phase.</p>
<p>This applies to processes forked off from Apache children
servicing requests, not the Apache children themselves. This
includes CGI scripts and SSI exec commands, but not any
processes forked off from the Apache parent such as piped
logs.</p>
<p>CPU resource limits are expressed in seconds per
process.</p>
<h3>See also</h3>
<ul>
<li><code class="directive"><a href="#rlimitmem">RLimitMEM</a></code></li>
<li><code class="directive"><a href="#rlimitnproc">RLimitNPROC</a></code></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="RLimitMEM" id="RLimitMEM">RLimitMEM</a> <a name="rlimitmem" id="rlimitmem">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limits the memory consumption of processes launched
by Apache children</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RLimitMEM <var>bytes</var>|max [<var>bytes</var>|max]</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Unset; uses operating system defaults</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>Takes 1 or 2 parameters. The first parameter sets the soft
resource limit for all processes and the second parameter sets
the maximum resource limit. Either parameter can be a number,
or <code>max</code> to indicate to the server that the limit should
be set to the maximum allowed by the operating system
configuration. Raising the maximum resource limit requires that
the server is running as <code>root</code>, or in the initial startup
phase.</p>
<p>This applies to processes forked off from Apache children
servicing requests, not the Apache children themselves. This
includes CGI scripts and SSI exec commands, but not any
processes forked off from the Apache parent such as piped
logs.</p>
<p>Memory resource limits are expressed in bytes per
process.</p>
<h3>See also</h3>
<ul>
<li><code class="directive"><a href="#rlimitcpu">RLimitCPU</a></code></li>
<li><code class="directive"><a href="#rlimitnproc">RLimitNPROC</a></code></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="RLimitNPROC" id="RLimitNPROC">RLimitNPROC</a> <a name="rlimitnproc" id="rlimitnproc">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limits the number of processes that can be launched by
processes launched by Apache children</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RLimitNPROC <var>number</var>|max [<var>number</var>|max]</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Unset; uses operating system defaults</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>Takes 1 or 2 parameters. The first parameter sets the soft
resource limit for all processes and the second parameter sets
the maximum resource limit. Either parameter can be a number,
or <code>max</code> to indicate to the server that the limit
should be set to the maximum allowed by the operating system
configuration. Raising the maximum resource limit requires that
the server is running as <code>root</code>, or in the initial startup
phase.</p>
<p>This applies to processes forked off from Apache children
servicing requests, not the Apache children themselves. This
includes CGI scripts and SSI exec commands, but not any
processes forked off from the Apache parent such as piped
logs.</p>
<p>Process limits control the number of processes per user.</p>
<div class="note"><h3>Note</h3>
<p>If CGI processes are <strong>not</strong> running
under userids other than the web server userid, this directive
will limit the number of processes that the server itself can
create. Evidence of this situation will be indicated by
<strong><code>cannot fork</code></strong> messages in the
<code>error_log</code>.</p>
</div>
<h3>See also</h3>
<ul>
<li><code class="directive"><a href="#rlimitmem">RLimitMEM</a></code></li>
<li><code class="directive"><a href="#rlimitcpu">RLimitCPU</a></code></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="Satisfy" id="Satisfy">Satisfy</a> <a name="satisfy" id="satisfy">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Interaction between host-level access control and
user authentication</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Satisfy Any|All</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Satisfy All</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>Access policy if both <code class="directive"><a href="/mod/mod_authz_host.html#allow">Allow</a></code> and <code class="directive"><a href="#require">Require</a></code> used. The parameter can be
either <code>All</code> or <code>Any</code>. This directive is only
useful if access to a particular area is being restricted by both
username/password <em>and</em> client host address. In this case
the default behavior (<code>All</code>) is to require that the client
passes the address access restriction <em>and</em> enters a valid
username and password. With the <code>Any</code> option the client will be
granted access if they either pass the host restriction or enter a
valid username and password. This can be used to password restrict
an area, but to let clients from particular addresses in without
prompting for a password.</p>
<p>For example, if you wanted to let people on your network have
unrestricted access to a portion of your website, but require that
people outside of your network provide a password, you could use a
configuration similar to the following:</p>
<div class="example"><p><code>
Require valid-user<br />
Allow from 192.168.1<br />
Satisfy Any
</code></p></div>
<h3>See also</h3>
<ul>
<li><code class="directive"><a href="/mod/mod_authz_host.html#allow">Allow</a></code></li>
<li><code class="directive"><a href="#require">Require</a></code></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="ScriptInterpreterSource" id="ScriptInterpreterSource">ScriptInterpreterSource</a> <a name="scriptinterpretersource" id="scriptinterpretersource">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Technique for locating the interpreter for CGI
scripts</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ScriptInterpreterSource Registry|Registry-Strict|Script</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ScriptInterpreterSource Script</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Win32 only<br />
option <code>Registry-Strict</code> is available in Apache 2.0 and
later</td></tr>
</table>
<p>This directive is used to control how Apache finds the
interpreter used to run CGI scripts. The default technique is to
use the interpreter pointed to by the <code>#!</code> line in the
script.</p>
<p>Setting <code>ScriptInterpreterSource Registry</code> will
cause the Windows Registry to be searched using the script file
extension (e.g., <code>.pl</code>) as a search key.</p>
<p>The option <code>Registry-Strict</code> which is new in Apache 2.0
does the same as <code>Registry</code> but uses a more strict registry
search.</p>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="ServerAdmin" id="ServerAdmin">ServerAdmin</a> <a name="serveradmin" id="serveradmin">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Email address that the server includes in error
messages sent to the client</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ServerAdmin <var>email-address</var></code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>The <code class="directive">ServerAdmin</code> sets the e-mail address
that the server includes in any error messages it returns to the
client.</p>
<p>It may be worth setting up a dedicated address for this, e.g.</p>
<div class="example"><p><code>
ServerAdmin www-admin@foo.example.com
</code></p></div>
<p>as users do not always mention that they are talking about the
server!</p>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="ServerAlias" id="ServerAlias">ServerAlias</a> <a name="serveralias" id="serveralias">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Alternate names for a host used when matching requests
to name-virtual hosts</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ServerAlias <var>hostname</var> [<var>hostname</var>] ...</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>The <code class="directive">ServerAlias</code> directive sets the
alternate names for a host, for use with <a href="/vhosts/name-based.html">name-based virtual hosts</a>.</p>
<div class="example"><p><code>
&lt;VirtualHost *&gt;<br />
ServerName server.domain.com<br />
ServerAlias server server2.domain.com server2<br />
# ...<br />
&lt;/VirtualHost&gt;
</code></p></div>
<h3>See also</h3>
<ul>
<li><a href="/vhosts/">Apache Virtual Host documentation</a></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="ServerName" id="ServerName">ServerName</a> <a name="servername" id="servername">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Hostname and port that the server uses to identify
itself</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ServerName <var>fully-qualified-domain-name</var>[:<var>port</var>]</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>In version 2.0, this
directive supersedes the functionality of the <code class="directive">Port</code>
directive from version 1.3.</td></tr>
</table>
<p>The <code class="directive">ServerName</code> directive sets the hostname and
port that the server uses to identify itself. This is used when
creating redirection URLs. For example, if the name of the
machine hosting the webserver is <code>simple.example.com</code>,
but the machine also has the DNS alias <code>www.example.com</code>
and you wish the webserver to be so identified, the following
directive should be used:</p>
<div class="example"><p><code>
ServerName www.example.com:80
</code></p></div>
<p>If no <code class="directive">ServerName</code> is specified, then the
server attempts to deduce the hostname by performing a reverse
lookup on the IP address. If no port is specified in the
servername, then the server will use the port from the incoming
request. For optimal reliability and predictability, you should
specify an explicit hostname and port using the
<code class="directive">ServerName</code> directive.</p>
<p>If you are using <a href="/vhosts/name-based.html">name-based virtual hosts</a>,
the <code class="directive">ServerName</code> inside a
<code class="directive"><a href="#virtualhost">&lt;VirtualHost&gt;</a></code>
section specifies what hostname must appear in the request's
<code>Host:</code> header to match this virtual host.</p>
<p>See the description of the
<code class="directive"><a href="#usecanonicalname">UseCanonicalName</a></code> directive for
settings which determine whether self-referential URL's (e.g., by the
<code class="module"><a href="/mod/mod_dir.html">mod_dir</a></code> module) will refer to the
specified port, or to the port number given in the client's request.
</p>
<h3>See also</h3>
<ul>
<li><a href="/dns-caveats.html">Issues Regarding DNS and
Apache</a></li>
<li><a href="/vhosts/">Apache virtual host
documentation</a></li>
<li><code class="directive"><a href="#usecanonicalname">UseCanonicalName</a></code></li>
<li><code class="directive"><a href="#namevirtualhost">NameVirtualHost</a></code></li>
<li><code class="directive"><a href="#serveralias">ServerAlias</a></code></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="ServerPath" id="ServerPath">ServerPath</a> <a name="serverpath" id="serverpath">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Legacy URL pathname for a name-based virtual host that
is accessed by an incompatible browser</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ServerPath <var>URL-path</var></code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>The <code class="directive">ServerPath</code> directive sets the legacy
URL pathname for a host, for use with <a href="/vhosts/">name-based virtual hosts</a>.</p>
<h3>See also</h3>
<ul>
<li><a href="/vhosts/">Apache Virtual Host documentation</a></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="ServerRoot" id="ServerRoot">ServerRoot</a> <a name="serverroot" id="serverroot">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Base directory for the server installation</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ServerRoot <var>directory-path</var></code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ServerRoot /usr/local/apache</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>The <code class="directive">ServerRoot</code> directive sets the
directory in which the server lives. Typically it will contain the
subdirectories <code>conf/</code> and <code>logs/</code>. Relative
paths for other configuration files are taken as relative to this
directory.</p>
<div class="example"><h3>Example</h3><p><code>
ServerRoot /home/httpd
</code></p></div>
<h3>See also</h3>
<ul>
<li><a href="/invoking.html">the <code>-d</code>
option to <code>httpd</code></a></li>
<li><a href="/misc/security_tips.html#serverroot">the
security tips</a> for information on how to properly set
permissions on the <code class="directive">ServerRoot</code></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="ServerSignature" id="ServerSignature">ServerSignature</a> <a name="serversignature" id="serversignature">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures the footer on server-generated documents</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ServerSignature On|Off|EMail</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ServerSignature Off</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>The <code class="directive">ServerSignature</code> directive allows the
configuration of a trailing footer line under server-generated
documents (error messages, <code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code> ftp directory
listings, <code class="module"><a href="/mod/mod_info.html">mod_info</a></code> output, ...). The reason why you
would want to enable such a footer line is that in a chain of proxies,
the user often has no possibility to tell which of the chained servers
actually produced a returned error message.</p>
<p>The <code>Off</code>
setting, which is the default, suppresses the footer line (and is
therefore compatible with the behavior of Apache-1.2 and
below). The <code>On</code> setting simply adds a line with the
server version number and <code class="directive"><a href="#servername">ServerName</a></code> of the serving virtual host,
and the <code>EMail</code> setting additionally creates a
"mailto:" reference to the <code class="directive"><a href="#serveradmin">ServerAdmin</a></code> of the referenced
document.</p>
<p>After version 2.0.44, the details of the server version number
presented are controlled by the <code class="directive"><a href="#servertokens">ServerTokens</a></code> directive.</p>
<h3>See also</h3>
<ul>
<li><code class="directive"><a href="#servertokens">ServerTokens</a></code></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="ServerTokens" id="ServerTokens">ServerTokens</a> <a name="servertokens" id="servertokens">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures the Server HTTP response
header</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ServerTokens Major|Minor|Min[imal]|Prod[uctOnly]|OS|Full</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ServerTokens Full</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>This directive controls whether <code>Server</code> response
header field which is sent back to clients includes a
description of the generic OS-type of the server as well as
information about compiled-in modules.</p>
<dl>
<dt><code>ServerTokens Prod[uctOnly]</code></dt>
<dd>Server sends (<em>e.g.</em>): <code>Server:
Apache</code></dd>
<dt><code>ServerTokens Major</code></dt>
<dd>Server sends (<em>e.g.</em>): <code>Server:
Apache/2</code></dd>
<dt><code>ServerTokens Minor</code></dt>
<dd>Server sends (<em>e.g.</em>): <code>Server:
Apache/2.0</code></dd>
<dt><code>ServerTokens Min[imal]</code></dt>
<dd>Server sends (<em>e.g.</em>): <code>Server:
Apache/2.0.41</code></dd>
<dt><code>ServerTokens OS</code></dt>
<dd>Server sends (<em>e.g.</em>): <code>Server: Apache/2.0.41
(Unix)</code></dd>
<dt><code>ServerTokens Full</code> (or not specified)</dt>
<dd>Server sends (<em>e.g.</em>): <code>Server: Apache/2.0.41
(Unix) PHP/4.2.2 MyMod/1.2</code></dd>
</dl>
<p>This setting applies to the entire server, and cannot be
enabled or disabled on a virtualhost-by-virtualhost basis.</p>
<p>After version 2.0.44, this directive also controls the
information presented by the <code class="directive"><a href="#serversignature">ServerSignature</a></code> directive.</p>
<h3>See also</h3>
<ul>
<li><code class="directive"><a href="#serversignature">ServerSignature</a></code></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="SetHandler" id="SetHandler">SetHandler</a> <a name="sethandler" id="sethandler">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Forces all matching files to be processed by a
handler</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SetHandler <var>handler-name</var>|None</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Moved into the core in Apache 2.0</td></tr>
</table>
<p>When placed into an <code>.htaccess</code> file or a
<code class="directive"><a href="#directory">&lt;Directory&gt;</a></code> or
<code class="directive"><a href="#location">&lt;Location&gt;</a></code>
section, this directive forces all matching files to be parsed
through the <a href="/handler.html">handler</a> given by
<var>handler-name</var>. For example, if you had a directory you
wanted to be parsed entirely as imagemap rule files, regardless
of extension, you might put the following into an
<code>.htaccess</code> file in that directory:</p>
<div class="example"><p><code>
SetHandler imap-file
</code></p></div>
<p>Another example: if you wanted to have the server display a
status report whenever a URL of
<code>http://servername/status</code> was called, you might put
the following into <code>httpd.conf</code>:</p>
<div class="example"><p><code>
&lt;Location /status&gt;<br />
<span class="indent">
SetHandler server-status<br />
</span>
&lt;/Location&gt;
</code></p></div>
<p>You can override an earlier defined <code class="directive">SetHandler</code>
directive by using the value <code>None</code>.</p>
<h3>See also</h3>
<ul>
<li><code class="directive"><a href="/mod/mod_mime.html#addhandler">AddHandler</a></code></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="SetInputFilter" id="SetInputFilter">SetInputFilter</a> <a name="setinputfilter" id="setinputfilter">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the filters that will process client requests and POST
input</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SetInputFilter <var>filter</var>[;<var>filter</var>...]</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>The <code class="directive">SetInputFilter</code> directive sets the
filter or filters which will process client requests and POST
input when they are received by the server. This is in addition to
any filters defined elsewhere, including the
<code class="directive"><a href="/mod/mod_mime.html#addinputfilter">AddInputFilter</a></code>
directive.</p>
<p>If more than one filter is specified, they must be separated
by semicolons in the order in which they should process the
content.</p>
<h3>See also</h3>
<ul>
<li><a href="/filter.html">Filters</a> documentation</li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="SetOutputFilter" id="SetOutputFilter">SetOutputFilter</a> <a name="setoutputfilter" id="setoutputfilter">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the filters that will process responses from the
server</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SetOutputFilter <var>filter</var>[;<var>filter</var>...]</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>The <code class="directive">SetOutputFilter</code> directive sets the filters
which will process responses from the server before they are
sent to the client. This is in addition to any filters defined
elsewhere, including the
<code class="directive"><a href="/mod/mod_mime.html#addoutputfilter">AddOutputFilter</a></code>
directive.</p>
<p>For example, the following configuration will process all files
in the <code>/www/data/</code> directory for server-side
includes.</p>
<div class="example"><p><code>
&lt;Directory /www/data/&gt;<br />
<span class="indent">
SetOutputFilter INCLUDES<br />
</span>
&lt;/Directory&gt;
</code></p></div>
<p>If more than one filter is specified, they must be separated
by semicolons in the order in which they should process the
content.</p>
<h3>See also</h3>
<ul>
<li><a href="/filter.html">Filters</a> documentation</li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="TimeOut" id="TimeOut">TimeOut</a> <a name="timeout" id="timeout">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Amount of time the server will wait for
certain events before failing a request</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>TimeOut <var>seconds</var></code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>TimeOut 300</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>The <code class="directive">TimeOut</code> directive currently defines
the amount of time Apache will wait for three things:</p>
<ol>
<li>The total amount of time it takes to receive a GET
request.</li>
<li>The amount of time between receipt of TCP packets on a
POST or PUT request.</li>
<li>The amount of time between ACKs on transmissions of TCP
packets in responses.</li>
</ol>
<p>We plan on making these separately configurable at some point
down the road. The timer used to default to 1200 before 1.2,
but has been lowered to 300 which is still far more than
necessary in most situations. It is not set any lower by
default because there may still be odd places in the code where
the timer is not reset when a packet is sent. </p>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="UseCanonicalName" id="UseCanonicalName">UseCanonicalName</a> <a name="usecanonicalname" id="usecanonicalname">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures how the server determines its own name and
port</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>UseCanonicalName On|Off|DNS</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>UseCanonicalName On</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>In many situations Apache must construct a <em>self-referential</em>
URL -- that is, a URL that refers back to the same server. With
<code>UseCanonicalName On</code> Apache will use the hostname and port
specified in the <code class="directive"><a href="#servername">ServerName</a></code>
directive to construct the canonical name for the server. This name
is used in all self-referential URLs, and for the values of
<code>SERVER_NAME</code> and <code>SERVER_PORT</code> in CGIs.</p>
<p>With <code>UseCanonicalName Off</code> Apache will form
self-referential URLs using the hostname and port supplied by
the client if any are supplied (otherwise it will use the
canonical name, as defined above). These values are the same
that are used to implement <a href="/vhosts/name-based.html">name based virtual hosts</a>,
and are available with the same clients. The CGI variables
<code>SERVER_NAME</code> and <code>SERVER_PORT</code> will be
constructed from the client supplied values as well.</p>
<p>An example where this may be useful is on an intranet server
where you have users connecting to the machine using short
names such as <code>www</code>. You'll notice that if the users
type a shortname, and a URL which is a directory, such as
<code>http://www/splat</code>, <em>without the trailing
slash</em> then Apache will redirect them to
<code>http://www.domain.com/splat/</code>. If you have
authentication enabled, this will cause the user to have to
authenticate twice (once for <code>www</code> and once again
for <code>www.domain.com</code> -- see <a href="http://httpd.apache.org/docs/misc/FAQ.html#prompted-twice">the
FAQ on this subject for more information</a>). But if
<code class="directive">UseCanonicalName</code> is set <code>Off</code>, then
Apache will redirect to <code>http://www/splat/</code>.</p>
<p>There is a third option, <code>UseCanonicalName DNS</code>,
which is intended for use with mass IP-based virtual hosting to
support ancient clients that do not provide a
<code>Host:</code> header. With this option Apache does a
reverse DNS lookup on the server IP address that the client
connected to in order to work out self-referential URLs.</p>
<div class="warning"><h3>Warning</h3>
<p>If CGIs make assumptions about the values of <code>SERVER_NAME</code>
they may be broken by this option. The client is essentially free
to give whatever value they want as a hostname. But if the CGI is
only using <code>SERVER_NAME</code> to construct self-referential URLs
then it should be just fine.</p>
</div>
<h3>See also</h3>
<ul>
<li><code class="directive"><a href="#servername">ServerName</a></code></li>
<li><code class="directive"><a href="/mod/mpm_common.html#listen">Listen</a></code></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="VirtualHost" id="VirtualHost">&lt;VirtualHost&gt;</a> <a name="virtualhost" id="virtualhost">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Contains directives that apply only to a specific
hostname or IP address</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;VirtualHost
<var>addr</var>[:<var>port</var>] [<var>addr</var>[:<var>port</var>]]
...&gt; ... &lt;/VirtualHost&gt;</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p><code class="directive">&lt;VirtualHost&gt;</code> and
<code>&lt;/VirtualHost&gt;</code> are used to enclose a group of
directives that will apply only to a particular virtual host. Any
directive that is allowed in a virtual host context may be
used. When the server receives a request for a document on a
particular virtual host, it uses the configuration directives
enclosed in the <code class="directive">&lt;VirtualHost&gt;</code>
section. <var>Addr</var> can be:</p>
<ul>
<li>The IP address of the virtual host;</li>
<li>A fully qualified domain name for the IP address of the
virtual host;</li>
<li>The character <code>*</code>, which is used only in combination with
<code>NameVirtualHost *</code> to match all IP addresses; or</li>
<li>The string <code>_default_</code>, which is used only
with IP virtual hosting to catch unmatched IP addresses.</li>
</ul>
<div class="example"><h3>Example</h3><p><code>
&lt;VirtualHost 10.1.2.3&gt;<br />
<span class="indent">
ServerAdmin webmaster@host.foo.com<br />
DocumentRoot /www/docs/host.foo.com<br />
ServerName host.foo.com<br />
ErrorLog logs/host.foo.com-error_log<br />
TransferLog logs/host.foo.com-access_log<br />
</span>
&lt;/VirtualHost&gt;
</code></p></div>
<p>IPv6 addresses must be specified in square brackets because
the optional port number could not be determined otherwise. An
IPv6 example is shown below:</p>
<div class="example"><p><code>
&lt;VirtualHost [fe80::a00:20ff:fea7:ccea]&gt;<br />
<span class="indent">
ServerAdmin webmaster@host.example.com<br />
DocumentRoot /www/docs/host.example.com<br />
ServerName host.example.com<br />
ErrorLog logs/host.example.com-error_log<br />
TransferLog logs/host.example.com-access_log<br />
</span>
&lt;/VirtualHost&gt;
</code></p></div>
<p>Each Virtual Host must correspond to a different IP address,
different port number or a different host name for the server,
in the former case the server machine must be configured to
accept IP packets for multiple addresses. (If the machine does
not have multiple network interfaces, then this can be
accomplished with the <code>ifconfig alias</code> command -- if
your OS supports it).</p>
<div class="note"><h3>Note</h3>
<p>The use of <code class="directive">&lt;VirtualHost&gt;</code> does
<strong>not</strong> affect what addresses Apache listens on. You
may need to ensure that Apache is listening on the correct addresses
using <code class="directive"><a href="/mod/mpm_common.html#listen">Listen</a></code>.</p>
</div>
<p>When using IP-based virtual hosting, the special name
<code>_default_</code> can be specified in
which case this virtual host will match any IP address that is
not explicitly listed in another virtual host. In the absence
of any <code>_default_</code> virtual host the "main" server config,
consisting of all those definitions outside any VirtualHost
section, is used when no IP-match occurs. (But note that any IP
address that matches a <code class="directive"><a href="#namevirtualhost">NameVirtualHost</a></code> directive will use neither
the "main" server config nor the <code>_default_</code> virtual host.
See the <a href="/vhosts/name-based.html">name-based virtual hosting</a>
documentation for further details.)</p>
<p>You can specify a <code>:port</code> to change the port that is
matched. If unspecified then it defaults to the same port as the
most recent <code class="directive"><a href="/mod/mpm_common.html#listen">Listen</a></code>
statement of the main server. You may also specify <code>:*</code>
to match all ports on that address. (This is recommended when used
with <code>_default_</code>.)</p>
<div class="warning"><h3>Security</h3>
<p>See the <a href="/misc/security_tips.html">security tips</a>
document for details on why your security could be compromised if the
directory where logfiles are stored is writable by anyone other
than the user that starts the server.</p>
</div>
<h3>See also</h3>
<ul>
<li><a href="/vhosts/">Apache Virtual Host documentation</a></li>
<li><a href="/dns-caveats.html">Issues Regarding DNS and
Apache</a></li>
<li><a href="/bind.html">Setting
which addresses and ports Apache uses</a></li>
<li><a href="/sections.html">How &lt;Directory&gt;, &lt;Location&gt;
and &lt;Files&gt; sections work</a> for an explanation of how these
different sections are combined when a request is received</li>
</ul>
</div>
</div>
<div class="bottomlang">
<p><span>Available Languages: </span><a href="/de/mod/core.html" hreflang="de" title="Deutsch">&nbsp;de&nbsp;</a> | <a href="/en/mod/core.html" hreflang="en" title="English">&nbsp;en&nbsp;</a></p>
</div><div id="footer">
<p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p>
<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="/faq/">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p></div>
</body></html>