core.html.en revision db682a46f5cc4672f043df7dcdadb5b165749f77
842ae4bd224140319ae7feec1872b93dfd491143fielding<?xml version="1.0" encoding="ISO-8859-1"?>
842ae4bd224140319ae7feec1872b93dfd491143fielding<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
842ae4bd224140319ae7feec1872b93dfd491143fielding<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
842ae4bd224140319ae7feec1872b93dfd491143fielding XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
842ae4bd224140319ae7feec1872b93dfd491143fielding This file is generated from xml source: DO NOT EDIT
842ae4bd224140319ae7feec1872b93dfd491143fielding XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
2d2eda71267231c2526be701fe655db125852c1ffielding -->
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd<title>core - Apache HTTP Server</title>
2d2eda71267231c2526be701fe655db125852c1ffielding<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd<link href="/style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd<link href="/images/favicon.ico" rel="shortcut icon" /></head>
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd<body>
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd<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.3</p>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<img alt="" src="/images/feather.gif" /></div>
0432a26b69eedfb9ca5f34fba590236378a24851ben<div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="/images/left.gif" /></a></div>
0432a26b69eedfb9ca5f34fba590236378a24851ben<div id="path">
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<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/">Documentation</a> &gt; <a href="../">Version 2.3</a> &gt; <a href="./">Modules</a></div>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<div id="page-content">
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<div id="preamble"><h1>Apache Core Features</h1>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<div class="toplang">
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<p><span>Available Languages: </span><a href="/de/mod/core.html" hreflang="de" rel="alternate" title="Deutsch">&nbsp;de&nbsp;</a> |
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<a href="/en/mod/core.html" title="English">&nbsp;en&nbsp;</a> |
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<a href="/es/mod/core.html" hreflang="es" rel="alternate" title="Espa�ol">&nbsp;es&nbsp;</a> |
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<a href="/fr/mod/core.html" hreflang="fr" rel="alternate" title="Fran�ais">&nbsp;fr&nbsp;</a> |
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<a href="/ja/mod/core.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<a href="/tr/mod/core.html" hreflang="tr" rel="alternate" title="T�rk�e">&nbsp;tr&nbsp;</a></p>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh</div>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Core Apache HTTP Server features that are always
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianhavailable</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Core</td></tr></table>
2d2eda71267231c2526be701fe655db125852c1ffielding</div>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<div id="quickview"><h3 class="directives">Directives</h3>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<ul id="toc">
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<li><img alt="" src="/images/down.gif" /> <a href="#acceptfilter">AcceptFilter</a></li>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<li><img alt="" src="/images/down.gif" /> <a href="#acceptpathinfo">AcceptPathInfo</a></li>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<li><img alt="" src="/images/down.gif" /> <a href="#accessfilename">AccessFileName</a></li>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<li><img alt="" src="/images/down.gif" /> <a href="#adddefaultcharset">AddDefaultCharset</a></li>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<li><img alt="" src="/images/down.gif" /> <a href="#allowencodedslashes">AllowEncodedSlashes</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#allowoverride">AllowOverride</a></li>
30c289e6bc6d28d210b21edd800ab2cfc78a8381wrowe<li><img alt="" src="/images/down.gif" /> <a href="#cgimapextension">CGIMapExtension</a></li>
cccd31fa4a72fe23cc3249c06db181b274a55a69gstein<li><img alt="" src="/images/down.gif" /> <a href="#contentdigest">ContentDigest</a></li>
cccd31fa4a72fe23cc3249c06db181b274a55a69gstein<li><img alt="" src="/images/down.gif" /> <a href="#defaulttype">DefaultType</a></li>
cd39d2139743ca0ef899953c6496dcf99e9c791atrawick<li><img alt="" src="/images/down.gif" /> <a href="#define">Define</a></li>
cccd31fa4a72fe23cc3249c06db181b274a55a69gstein<li><img alt="" src="/images/down.gif" /> <a href="#directory">&lt;Directory&gt;</a></li>
a261b81a1044c0e2ea3f21cf9b7019297bad16aajorton<li><img alt="" src="/images/down.gif" /> <a href="#directorymatch">&lt;DirectoryMatch&gt;</a></li>
b627048681b27fe30f979ba471b523be3a6a22adrbb<li><img alt="" src="/images/down.gif" /> <a href="#documentroot">DocumentRoot</a></li>
cccd31fa4a72fe23cc3249c06db181b274a55a69gstein<li><img alt="" src="/images/down.gif" /> <a href="#enablemmap">EnableMMAP</a></li>
cccd31fa4a72fe23cc3249c06db181b274a55a69gstein<li><img alt="" src="/images/down.gif" /> <a href="#enablesendfile">EnableSendfile</a></li>
44c46ef733836b32585d135d2d90856e7cfd9929rbb<li><img alt="" src="/images/down.gif" /> <a href="#error">Error</a></li>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<li><img alt="" src="/images/down.gif" /> <a href="#errordocument">ErrorDocument</a></li>
e6cc28a5eb3371ba0c38e941855e71ff0054f50erbb<li><img alt="" src="/images/down.gif" /> <a href="#errorlog">ErrorLog</a></li>
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna<li><img alt="" src="/images/down.gif" /> <a href="#errorlogformat">ErrorLogFormat</a></li>
cdccf2ac94172d1a4a54bc2e17324e1ef682ccf3pquerna<li><img alt="" src="/images/down.gif" /> <a href="#extendedstatus">ExtendedStatus</a></li>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<li><img alt="" src="/images/down.gif" /> <a href="#fileetag">FileETag</a></li>
9cfc48b742c224c1fbc2c26a4119a3266192c7d2wrowe<li><img alt="" src="/images/down.gif" /> <a href="#files">&lt;Files&gt;</a></li>
9cfc48b742c224c1fbc2c26a4119a3266192c7d2wrowe<li><img alt="" src="/images/down.gif" /> <a href="#filesmatch">&lt;FilesMatch&gt;</a></li>
ef5650b61a8e35f3cc93ec07e73efc17ea329894jorton<li><img alt="" src="/images/down.gif" /> <a href="#forcetype">ForceType</a></li>
7c7372abe2484e7fcf81937b93496d1246e5b816gstein<li><img alt="" src="/images/down.gif" /> <a href="#gprofdir">GprofDir</a></li>
a261b81a1044c0e2ea3f21cf9b7019297bad16aajorton<li><img alt="" src="/images/down.gif" /> <a href="#hostnamelookups">HostnameLookups</a></li>
a261b81a1044c0e2ea3f21cf9b7019297bad16aajorton<li><img alt="" src="/images/down.gif" /> <a href="#if">&lt;If&gt;</a></li>
a261b81a1044c0e2ea3f21cf9b7019297bad16aajorton<li><img alt="" src="/images/down.gif" /> <a href="#ifdefine">&lt;IfDefine&gt;</a></li>
a261b81a1044c0e2ea3f21cf9b7019297bad16aajorton<li><img alt="" src="/images/down.gif" /> <a href="#ifmodule">&lt;IfModule&gt;</a></li>
d71fd7cd9c4815d0647425f21ba3a803919a9148jorton<li><img alt="" src="/images/down.gif" /> <a href="#include">Include</a></li>
7c7372abe2484e7fcf81937b93496d1246e5b816gstein<li><img alt="" src="/images/down.gif" /> <a href="#keepalive">KeepAlive</a></li>
7c7372abe2484e7fcf81937b93496d1246e5b816gstein<li><img alt="" src="/images/down.gif" /> <a href="#keepalivetimeout">KeepAliveTimeout</a></li>
7c7372abe2484e7fcf81937b93496d1246e5b816gstein<li><img alt="" src="/images/down.gif" /> <a href="#limit">&lt;Limit&gt;</a></li>
7c7372abe2484e7fcf81937b93496d1246e5b816gstein<li><img alt="" src="/images/down.gif" /> <a href="#limitexcept">&lt;LimitExcept&gt;</a></li>
7c7372abe2484e7fcf81937b93496d1246e5b816gstein<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>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<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>
4a13940dc2990df0a798718d3a3f9cf1566c2217bjh<li><img alt="" src="/images/down.gif" /> <a href="#locationmatch">&lt;LocationMatch&gt;</a></li>
4a13940dc2990df0a798718d3a3f9cf1566c2217bjh<li><img alt="" src="/images/down.gif" /> <a href="#loglevel">LogLevel</a></li>
4a13940dc2990df0a798718d3a3f9cf1566c2217bjh<li><img alt="" src="/images/down.gif" /> <a href="#maxkeepaliverequests">MaxKeepAliveRequests</a></li>
4a13940dc2990df0a798718d3a3f9cf1566c2217bjh<li><img alt="" src="/images/down.gif" /> <a href="#mutex">Mutex</a></li>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<li><img alt="" src="/images/down.gif" /> <a href="#namevirtualhost">NameVirtualHost</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#options">Options</a></li>
dd5cbadf2df719db2f3c769d03ec847da25854e6bnicholes<li><img alt="" src="/images/down.gif" /> <a href="#protocol">Protocol</a></li>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<li><img alt="" src="/images/down.gif" /> <a href="#rlimitcpu">RLimitCPU</a></li>
dd5cbadf2df719db2f3c769d03ec847da25854e6bnicholes<li><img alt="" src="/images/down.gif" /> <a href="#rlimitmem">RLimitMEM</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#rlimitnproc">RLimitNPROC</a></li>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<li><img alt="" src="/images/down.gif" /> <a href="#scriptinterpretersource">ScriptInterpreterSource</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#seerequesttail">SeeRequestTail</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#serveradmin">ServerAdmin</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#serveralias">ServerAlias</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#servername">ServerName</a></li>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<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>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<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>
72a4ef8eac1adef882246c5bfb9b8bbd82d613c4coar<li><img alt="" src="/images/down.gif" /> <a href="#sethandler">SetHandler</a></li>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<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>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<li><img alt="" src="/images/down.gif" /> <a href="#timeout">TimeOut</a></li>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<li><img alt="" src="/images/down.gif" /> <a href="#traceenable">TraceEnable</a></li>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<li><img alt="" src="/images/down.gif" /> <a href="#undefine">UnDefine</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#usecanonicalname">UseCanonicalName</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#usecanonicalphysicalport">UseCanonicalPhysicalPort</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#virtualhost">&lt;VirtualHost&gt;</a></li>
4a13940dc2990df0a798718d3a3f9cf1566c2217bjh</ul>
4a13940dc2990df0a798718d3a3f9cf1566c2217bjh</div>
4a13940dc2990df0a798718d3a3f9cf1566c2217bjh
4a13940dc2990df0a798718d3a3f9cf1566c2217bjh<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
4a13940dc2990df0a798718d3a3f9cf1566c2217bjh<div class="directive-section"><h2><a name="AcceptFilter" id="AcceptFilter">AcceptFilter</a> <a name="acceptfilter" id="acceptfilter">Directive</a></h2>
2d2eda71267231c2526be701fe655db125852c1ffielding<table class="directive">
4a13940dc2990df0a798718d3a3f9cf1566c2217bjh<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures optimizations for a Protocol's Listener Sockets</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AcceptFilter <var>protocol</var> <var>accept_filter</var></code></td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<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>
a77c6787a1ea7dd88cb6cf8e4ad968b235af2a20jorton<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache httpd 2.1.5 and later.
2d2eda71267231c2526be701fe655db125852c1ffieldingOn Windows from Apache httpd 2.3.3 and later.</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding</table>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <p>This directive enables operating system specific optimizations for a
2d2eda71267231c2526be701fe655db125852c1ffielding listening socket by the <code class="directive">Protocol</code>type.
2d2eda71267231c2526be701fe655db125852c1ffielding The basic premise is for the kernel to not send a socket to the server
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh process until either data is received or an entire HTTP Request is buffered.
2d2eda71267231c2526be701fe655db125852c1ffielding Only <a href="http://www.freebsd.org/cgi/man.cgi?query=accept_filter&amp;sektion=9">
4a13940dc2990df0a798718d3a3f9cf1566c2217bjh FreeBSD's Accept Filters</a>, Linux's more primitive
2d2eda71267231c2526be701fe655db125852c1ffielding <code>TCP_DEFER_ACCEPT</code>, and Windows' optimized AcceptEx()
2d2eda71267231c2526be701fe655db125852c1ffielding are currently supported.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p>Using <code>none</code> for an argument will disable any accept filters
2d2eda71267231c2526be701fe655db125852c1ffielding for that protocol. This is useful for protocols that require a server
2d2eda71267231c2526be701fe655db125852c1ffielding send data first, such as <code>ftp:</code> or <code>nntp</code>:</p>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <div class="example"><p><code>AcceptFilter nntp none</code></p></div>
2d2eda71267231c2526be701fe655db125852c1ffielding
4a13940dc2990df0a798718d3a3f9cf1566c2217bjh <p>The default protocol names are <code>https</code> for port 443
4a13940dc2990df0a798718d3a3f9cf1566c2217bjh and <code>http</code> for all other ports. To specify another protocol
4a13940dc2990df0a798718d3a3f9cf1566c2217bjh is being used with a listening port, add the <var>protocol</var>
4a13940dc2990df0a798718d3a3f9cf1566c2217bjh argument to the <code class="directive"><a href="/mod/mpm_common.html#listen">Listen</a></code>
2d2eda71267231c2526be701fe655db125852c1ffielding directive.</p>
4a13940dc2990df0a798718d3a3f9cf1566c2217bjh
2d2eda71267231c2526be701fe655db125852c1ffielding <p>The default values on FreeBSD are:</p>
2d2eda71267231c2526be701fe655db125852c1ffielding <div class="example"><p><code>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh AcceptFilter http httpready <br />
2d2eda71267231c2526be701fe655db125852c1ffielding AcceptFilter https dataready
2d2eda71267231c2526be701fe655db125852c1ffielding </code></p></div>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p>The <code>httpready</code> accept filter buffers entire HTTP requests at
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh the kernel level. Once an entire request is received, the kernel then
2d2eda71267231c2526be701fe655db125852c1ffielding sends it to the server. See the
2d2eda71267231c2526be701fe655db125852c1ffielding <a href="http://www.freebsd.org/cgi/man.cgi?query=accf_http&amp;sektion=9">
2d2eda71267231c2526be701fe655db125852c1ffielding accf_http(9)</a> man page for more details. Since HTTPS requests are
2d2eda71267231c2526be701fe655db125852c1ffielding encrypted only the <a href="http://www.freebsd.org/cgi/man.cgi?query=accf_data&amp;sektion=9">
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh accf_data(9)</a> filter is used.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
dbbf1b4183ae16353011a5269b37899f02b97d81gregames <p>The default values on Linux are:</p>
2d2eda71267231c2526be701fe655db125852c1ffielding <div class="example"><p><code>
2d2eda71267231c2526be701fe655db125852c1ffielding AcceptFilter http data <br />
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh AcceptFilter https data
2d2eda71267231c2526be701fe655db125852c1ffielding </code></p></div>
e44e11f9fece12c783f18d033923bfc0d6b4289aake
2d2eda71267231c2526be701fe655db125852c1ffielding <p>Linux's <code>TCP_DEFER_ACCEPT</code> does not support buffering http
2d2eda71267231c2526be701fe655db125852c1ffielding requests. Any value besides <code>none</code> will enable
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <code>TCP_DEFER_ACCEPT</code> on that listener. For more details
2d2eda71267231c2526be701fe655db125852c1ffielding see the Linux
ee1af2aeb57527f33baa4737aa431e4aef997855rbowen <a href="http://homepages.cwi.nl/~aeb/linux/man2html/man7/tcp.7.html">
2d2eda71267231c2526be701fe655db125852c1ffielding tcp(7)</a> man page.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <p>The default values on Windows are:</p>
2d2eda71267231c2526be701fe655db125852c1ffielding <div class="example"><p><code>
2d2eda71267231c2526be701fe655db125852c1ffielding AcceptFilter http data <br />
2d2eda71267231c2526be701fe655db125852c1ffielding AcceptFilter https data
2d2eda71267231c2526be701fe655db125852c1ffielding </code></p></div>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <p>Window's mpm_winnt interprets the AcceptFilter to toggle the AcceptEx()
2d2eda71267231c2526be701fe655db125852c1ffielding API, and does not support http protocol buffering. There are two values
2d2eda71267231c2526be701fe655db125852c1ffielding which utilize the Windows AcceptEx() API and will recycle network
2d2eda71267231c2526be701fe655db125852c1ffielding sockets between connections. <code>data</code> waits until data has
2d2eda71267231c2526be701fe655db125852c1ffielding been transmitted as documented above, and the initial data buffer and
2d2eda71267231c2526be701fe655db125852c1ffielding network endpoint addresses are all retrieved from the single AcceptEx()
2d2eda71267231c2526be701fe655db125852c1ffielding invocation. <code>connect</code> will use the AcceptEx() API, also
2d2eda71267231c2526be701fe655db125852c1ffielding retrieve the network endpoint addresses, but like <code>none</code>
2d2eda71267231c2526be701fe655db125852c1ffielding the <code>connect</code> option does not wait for the initial data
2d2eda71267231c2526be701fe655db125852c1ffielding transmission.</p>
ee7882748b83255e50ea6bc3b3fdc8ee0949e2e3jorton
2d2eda71267231c2526be701fe655db125852c1ffielding <p>On Windows, <code>none</code> uses accept() rather than AcceptEx()
2d2eda71267231c2526be701fe655db125852c1ffielding and will not recycle sockets between connections. This is useful for
2d2eda71267231c2526be701fe655db125852c1ffielding network adapters with broken driver support, as well as some virtual
2d2eda71267231c2526be701fe655db125852c1ffielding network providers such as vpn drivers, or spam, virus or spyware
2d2eda71267231c2526be701fe655db125852c1ffielding filters.</p>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
2d2eda71267231c2526be701fe655db125852c1ffielding<h3>See also</h3>
2d2eda71267231c2526be701fe655db125852c1ffielding<ul>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<li><code class="directive">Protocol</code></li>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh</ul>
2d2eda71267231c2526be701fe655db125852c1ffielding</div>
2d2eda71267231c2526be701fe655db125852c1ffielding<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<div class="directive-section"><h2><a name="AcceptPathInfo" id="AcceptPathInfo">AcceptPathInfo</a> <a name="acceptpathinfo" id="acceptpathinfo">Directive</a></h2>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<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>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AcceptPathInfo Default</code></td></tr>
2efb935ae8fe12d5192a3bf2c52c28461b6c68afdgaudet<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
2efb935ae8fe12d5192a3bf2c52c28461b6c68afdgaudet<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2efb935ae8fe12d5192a3bf2c52c28461b6c68afdgaudet<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2efb935ae8fe12d5192a3bf2c52c28461b6c68afdgaudet<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache httpd 2.0.30 and later</td></tr>
2efb935ae8fe12d5192a3bf2c52c28461b6c68afdgaudet</table>
2efb935ae8fe12d5192a3bf2c52c28461b6c68afdgaudet
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <p>This directive controls whether requests that contain trailing
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb pathname information that follows an actual filename (or
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb non-existent file in an existing directory) will be accepted or
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb rejected. The trailing pathname information can be made
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb available to scripts in the <code>PATH_INFO</code> environment
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb variable.</p>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh
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
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <code>/test/nothere.html/more</code> both collect
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <code>/more</code> as <code>PATH_INFO</code>.</p>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <p>The three possible arguments for the
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <code class="directive">AcceptPathInfo</code> directive are:</p>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <dl>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <dt><code>Off</code></dt><dd>A request will only be accepted if it
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb maps to a literal path that exists. Therefore a request with
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh trailing pathname information after the true filename such as
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <code>/test/here.html/more</code> in the above example will return
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb a 404 NOT FOUND error.</dd>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <dt><code>On</code></dt><dd>A request will be accepted if a
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb leading path component maps to a file that exists. The above
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh example <code>/test/here.html/more</code> will be accepted if
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <code>/test/here.html</code> maps to a valid file.</dd>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <dt><code>Default</code></dt><dd>The treatment of requests with
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh trailing pathname information is determined by the <a href="/handler.html">handler</a> responsible for the request.
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb The core handler for normal files defaults to rejecting
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <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-handler</a>, generally accept
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <code>PATH_INFO</code> by default.</dd>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh </dl>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <p>The primary purpose of the <code>AcceptPathInfo</code>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb directive is to allow you to override the handler's choice of
99d6d3207e24ba1f8eba77ef903948d738886cf5nd accepting or rejecting <code>PATH_INFO</code>. This override is required,
99d6d3207e24ba1f8eba77ef903948d738886cf5nd for example, when you use a <a href="/filter.html">filter</a>, such
99d6d3207e24ba1f8eba77ef903948d738886cf5nd as <a href="mod_include.html">INCLUDES</a>, to generate content
99d6d3207e24ba1f8eba77ef903948d738886cf5nd based on <code>PATH_INFO</code>. The core handler would usually reject
99d6d3207e24ba1f8eba77ef903948d738886cf5nd the request, so you can use the following configuration to enable
99d6d3207e24ba1f8eba77ef903948d738886cf5nd such a script:</p>
99d6d3207e24ba1f8eba77ef903948d738886cf5nd
99d6d3207e24ba1f8eba77ef903948d738886cf5nd <div class="example"><p><code>
99d6d3207e24ba1f8eba77ef903948d738886cf5nd &lt;Files "mypaths.shtml"&gt;<br />
99d6d3207e24ba1f8eba77ef903948d738886cf5nd <span class="indent">
99d6d3207e24ba1f8eba77ef903948d738886cf5nd Options +Includes<br />
99d6d3207e24ba1f8eba77ef903948d738886cf5nd SetOutputFilter INCLUDES<br />
99d6d3207e24ba1f8eba77ef903948d738886cf5nd AcceptPathInfo On<br />
99d6d3207e24ba1f8eba77ef903948d738886cf5nd </span>
99d6d3207e24ba1f8eba77ef903948d738886cf5nd &lt;/Files&gt;
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb </code></p></div>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh</div>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<div class="directive-section"><h2><a name="AccessFileName" id="AccessFileName">AccessFileName</a> <a name="accessfilename" id="accessfilename">Directive</a></h2>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<table class="directive">
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Name of the distributed configuration file</td></tr>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AccessFileName <var>filename</var> [<var>filename</var>] ...</code></td></tr>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AccessFileName .htaccess</code></td></tr>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<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>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb</table>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <p>While processing a request the server looks for
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben the first existing configuration file from this list of names in
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben every directory of the path to the document, if distributed
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben configuration files are <a href="#allowoverride">enabled for that
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben directory</a>. For example:</p>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <div class="example"><p><code>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben AccessFileName .acl
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben </code></p></div>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <p>before returning the document
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <code>/usr/local/web/index.html</code>, the server will read
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <code>/.acl</code>, <code>/usr/.acl</code>,
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <code>/usr/local/.acl</code> and <code>/usr/local/web/.acl</code>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben for directives, unless they have been disabled with</p>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben
7b6ba9c468f26bdb3492d5e8cb79628a3b04e8c8wrowe <div class="example"><p><code>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb &lt;Directory /&gt;<br />
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <span class="indent">
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb AllowOverride None<br />
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh </span>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh &lt;/Directory&gt;
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb </code></p></div>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<h3>See also</h3>
1374444b4fab1475091e12a81663f379b73005efrbb<ul>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<li><code class="directive"><a href="#allowoverride">AllowOverride</a></code></li>
bbe046d7cbb950ab3e372e4119ae001a5fe52ed4striker<li><a href="/configuring.html">Configuration Files</a></li>
bbe046d7cbb950ab3e372e4119ae001a5fe52ed4striker<li><a href="/howto/htaccess.html">.htaccess Files</a></li>
bbe046d7cbb950ab3e372e4119ae001a5fe52ed4striker</ul>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh</div>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
c8aa00ee0cfc17b5fa08fb8a2b08d30dc9e4f1b1wrowe<div class="directive-section"><h2><a name="AddDefaultCharset" id="AddDefaultCharset">AddDefaultCharset</a> <a name="adddefaultcharset" id="adddefaultcharset">Directive</a></h2>
c8aa00ee0cfc17b5fa08fb8a2b08d30dc9e4f1b1wrowe<table class="directive">
4542d057c4bde23857f31d449fa3108561206139wrowe<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Default charset parameter to be added when a response
c8aa00ee0cfc17b5fa08fb8a2b08d30dc9e4f1b1wrowecontent-type is <code>text/plain</code> or <code>text/html</code></td></tr>
4542d057c4bde23857f31d449fa3108561206139wrowe<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AddDefaultCharset On|Off|<var>charset</var></code></td></tr>
c8aa00ee0cfc17b5fa08fb8a2b08d30dc9e4f1b1wrowe<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AddDefaultCharset Off</code></td></tr>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb</table>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <p>This directive specifies a default value for the media type
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb charset parameter (the name of a character encoding) to be added
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh to a response if and only if the response's content-type is either
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <code>text/plain</code> or <code>text/html</code>. This should override
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh any charset specified in the body of the response via a <code>META</code>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb element, though the exact behavior is often dependent on the user's client
6d74c65f131583f6832b04424c1a9e1e7cc72c8egregames configuration. A setting of <code>AddDefaultCharset Off</code>
6d74c65f131583f6832b04424c1a9e1e7cc72c8egregames disables this functionality. <code>AddDefaultCharset On</code> enables
6d74c65f131583f6832b04424c1a9e1e7cc72c8egregames a default charset of <code>iso-8859-1</code>. Any other value is assumed
6d74c65f131583f6832b04424c1a9e1e7cc72c8egregames to be the <var>charset</var> to be used, which should be one of the
6d74c65f131583f6832b04424c1a9e1e7cc72c8egregames <a href="http://www.iana.org/assignments/character-sets">IANA registered
6d74c65f131583f6832b04424c1a9e1e7cc72c8egregames charset values</a> for use in Internet media types (MIME types).
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh For example:</p>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <div class="example"><p><code>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh AddDefaultCharset utf-8
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh </code></p></div>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb
2e123e8beedc9f921448c113e2d6823a92fd5261fielding <p><code class="directive">AddDefaultCharset</code> should only be used when all
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben of the text resources to which it applies are known to be in that
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben character encoding and it is too inconvenient to label their charset
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben individually. One such example is to add the charset parameter
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben to resources containing generated content, such as legacy CGI
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben scripts, that might be vulnerable to cross-site scripting attacks
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben due to user-provided data being included in the output. Note, however,
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben that a better solution is to just fix (or delete) those scripts, since
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben setting a default charset does not protect users that have enabled
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben the "auto-detect character encoding" feature on their browser.</p>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<h3>See also</h3>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<ul>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<li><code class="directive"><a href="/mod/mod_mime.html#addcharset">AddCharset</a></code></li>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben</ul>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben</div>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<div class="directive-section"><h2><a name="AllowEncodedSlashes" id="AllowEncodedSlashes">AllowEncodedSlashes</a> <a name="allowencodedslashes" id="allowencodedslashes">Directive</a></h2>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<table class="directive">
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Determines whether encoded path separators in URLs are allowed to
64b9fa4bc3e79b0eefb2d93fb56eae40d88e0f06wrowebe passed through</td></tr>
64b9fa4bc3e79b0eefb2d93fb56eae40d88e0f06wrowe<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AllowEncodedSlashes On|Off</code></td></tr>
64b9fa4bc3e79b0eefb2d93fb56eae40d88e0f06wrowe<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AllowEncodedSlashes Off</code></td></tr>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
64b9fa4bc3e79b0eefb2d93fb56eae40d88e0f06wrowe<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
64b9fa4bc3e79b0eefb2d93fb56eae40d88e0f06wrowe<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
64b9fa4bc3e79b0eefb2d93fb56eae40d88e0f06wrowe<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache httpd 2.0.46 and later</td></tr>
64b9fa4bc3e79b0eefb2d93fb56eae40d88e0f06wrowe</table>
64b9fa4bc3e79b0eefb2d93fb56eae40d88e0f06wrowe <p>The <code class="directive">AllowEncodedSlashes</code> directive allows URLs
64b9fa4bc3e79b0eefb2d93fb56eae40d88e0f06wrowe which contain encoded path separators (<code>%2F</code> for <code>/</code>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben and additionally <code>%5C</code> for <code>\</code> on according systems)
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben to be used. Normally such URLs are refused with a 404 (Not found) error.</p>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <p>Turning <code class="directive">AllowEncodedSlashes</code> <code>On</code> is
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh mostly useful when used in conjunction with <code>PATH_INFO</code>.</p>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <div class="note"><h3>Note</h3>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <p>Allowing encoded slashes does <em>not</em> imply <em>decoding</em>.
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben Occurrences of <code>%2F</code> or <code>%5C</code> (<em>only</em> on
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben according systems) will be left as such in the otherwise decoded URL
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben string.</p>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh </div>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<h3>See also</h3>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<ul>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<li><code class="directive"><a href="#acceptpathinfo">AcceptPathInfo</a></code></li>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh</ul>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben</div>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<div class="directive-section"><h2><a name="AllowOverride" id="AllowOverride">AllowOverride</a> <a name="allowoverride" id="allowoverride">Directive</a></h2>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<table class="directive">
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Types of directives that are allowed in
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<code>.htaccess</code> files</td></tr>
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AllowOverride All|None|<var>directive-type</var>
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd[<var>directive-type</var>] ...</code></td></tr>
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AllowOverride None (2.3.9 and later), AllowOverride All (2.3.8 and earlier)</code></td></tr>
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory</td></tr>
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd</table>
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd <p>When the server finds an <code>.htaccess</code> file (as
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd specified by <code class="directive"><a href="#accessfilename">AccessFileName</a></code>)
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd it needs to know which directives declared in that file can override
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd earlier configuration directives.</p>
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd <div class="note"><h3>Only available in &lt;Directory&gt; sections</h3>
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd <code class="directive">AllowOverride</code> is valid only in
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code>
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd sections specified without regular expressions, not in <code class="directive"><a href="#location">&lt;Location&gt;</a></code>, <code class="directive"><a href="#directorymatch">&lt;DirectoryMatch&gt;</a></code> or
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd <code class="directive"><a href="#files">&lt;Files&gt;</a></code> sections.
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb </div>
1ce78cf71b5baaf2c1ab48e818cb1f2397df5010trawick
1ce78cf71b5baaf2c1ab48e818cb1f2397df5010trawick <p>When this directive is set to <code>None</code>, then
1ce78cf71b5baaf2c1ab48e818cb1f2397df5010trawick <a href="#accessfilename">.htaccess</a> files are completely ignored.
1ce78cf71b5baaf2c1ab48e818cb1f2397df5010trawick In this case, the server will not even attempt to read
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb <code>.htaccess</code> files in the filesystem.</p>
1ce78cf71b5baaf2c1ab48e818cb1f2397df5010trawick
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb <p>When this directive is set to <code>All</code>, then any
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb directive which has the .htaccess <a href="directive-dict.html#Context">Context</a> is allowed in
1ce78cf71b5baaf2c1ab48e818cb1f2397df5010trawick <code>.htaccess</code> files.</p>
1ce78cf71b5baaf2c1ab48e818cb1f2397df5010trawick
1ce78cf71b5baaf2c1ab48e818cb1f2397df5010trawick <p>The <var>directive-type</var> can be one of the following
1ce78cf71b5baaf2c1ab48e818cb1f2397df5010trawick groupings of directives.</p>
1ce78cf71b5baaf2c1ab48e818cb1f2397df5010trawick
1ce78cf71b5baaf2c1ab48e818cb1f2397df5010trawick <dl>
1ce78cf71b5baaf2c1ab48e818cb1f2397df5010trawick <dt>AuthConfig</dt>
1ce78cf71b5baaf2c1ab48e818cb1f2397df5010trawick
1ce78cf71b5baaf2c1ab48e818cb1f2397df5010trawick <dd>
1ce78cf71b5baaf2c1ab48e818cb1f2397df5010trawick
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben Allow use of the authorization directives (<code class="directive"><a href="/mod/mod_authn_dbm.html#authdbmgroupfile">AuthDBMGroupFile</a></code>,
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb <code class="directive"><a href="/mod/mod_authn_dbm.html#authdbmuserfile">AuthDBMUserFile</a></code>,
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb <code class="directive"><a href="/mod/mod_authz_groupfile.html#authgroupfile">AuthGroupFile</a></code>,
3d96ee83babeec32482c9082c9426340cee8c44dwrowe <code class="directive"><a href="/mod/mod_authn_core.html#authname">AuthName</a></code>,
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb <code class="directive"><a href="/mod/mod_authn_core.html#authtype">AuthType</a></code>, <code class="directive"><a href="/mod/mod_authn_file.html#authuserfile">AuthUserFile</a></code>, <code class="directive"><a href="/mod/mod_authz_core.html#require">Require</a></code>, <em>etc.</em>).</dd>
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb <dt>FileInfo</dt>
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb <dd>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe Allow use of the directives controlling document types
2d2eda71267231c2526be701fe655db125852c1ffielding (<code class="directive"><a href="#errordocument">ErrorDocument</a></code>,
4e2c23ca8bd7b207f6e9c396759c1e2171370990trawick <code class="directive"><a href="#forcetype">ForceType</a></code>,
ceb14f8ba57a8086c9a68ad264efbe2433134382covener <code class="directive"><a href="/mod/mod_negotiation.html#languagepriority">LanguagePriority</a></code>,
ceb14f8ba57a8086c9a68ad264efbe2433134382covener <code class="directive"><a href="#sethandler">SetHandler</a></code>,
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <code class="directive"><a href="#setinputfilter">SetInputFilter</a></code>,
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <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* directives),
2d2eda71267231c2526be701fe655db125852c1ffielding document meta data (<code class="directive"><a href="/mod/mod_headers.html#header">Header</a></code>, <code class="directive"><a href="/mod/mod_headers.html#requestheader">RequestHeader</a></code>, <code class="directive"><a href="/mod/mod_setenvif.html#setenvif">SetEnvIf</a></code>, <code class="directive"><a href="/mod/mod_setenvif.html#setenvifnocase">SetEnvIfNoCase</a></code>, <code class="directive"><a href="/mod/mod_setenvif.html#browsermatch">BrowserMatch</a></code>, <code class="directive"><a href="/mod/mod_usertrack.html#cookieexpires">CookieExpires</a></code>, <code class="directive"><a href="/mod/mod_usertrack.html#cookiedomain">CookieDomain</a></code>, <code class="directive"><a href="/mod/mod_usertrack.html#cookiestyle">CookieStyle</a></code>, <code class="directive"><a href="/mod/mod_usertrack.html#cookietracking">CookieTracking</a></code>, <code class="directive"><a href="/mod/mod_usertrack.html#cookiename">CookieName</a></code>),
b0d8a6d437db6f4c222173f27ef81c98622fbd02pquerna <code class="module"><a href="/mod/mod_rewrite.html">mod_rewrite</a></code> directives <code class="directive"><a href="/mod/mod_rewrite.html#rewriteengine">RewriteEngine</a></code>, <code class="directive"><a href="/mod/mod_rewrite.html#rewriteoptions">RewriteOptions</a></code>, <code class="directive"><a href="/mod/mod_rewrite.html#rewritebase">RewriteBase</a></code>, <code class="directive"><a href="/mod/mod_rewrite.html#rewritecond">RewriteCond</a></code>, <code class="directive"><a href="/mod/mod_rewrite.html#rewriterule">RewriteRule</a></code>) and
b0d8a6d437db6f4c222173f27ef81c98622fbd02pquerna <code class="directive"><a href="/mod/mod_actions.html#action">Action</a></code> from
2d2eda71267231c2526be701fe655db125852c1ffielding <code class="module"><a href="/mod/mod_actions.html">mod_actions</a></code>.
ceb14f8ba57a8086c9a68ad264efbe2433134382covener </dd>
ceb14f8ba57a8086c9a68ad264efbe2433134382covener
ceb14f8ba57a8086c9a68ad264efbe2433134382covener <dt>Indexes</dt>
ceb14f8ba57a8086c9a68ad264efbe2433134382covener
ceb14f8ba57a8086c9a68ad264efbe2433134382covener <dd>
ceb14f8ba57a8086c9a68ad264efbe2433134382covener Allow use of the directives controlling directory indexing
ceb14f8ba57a8086c9a68ad264efbe2433134382covener (<code class="directive"><a href="/mod/mod_autoindex.html#adddescription">AddDescription</a></code>,
ceb14f8ba57a8086c9a68ad264efbe2433134382covener <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>,
ceb14f8ba57a8086c9a68ad264efbe2433134382covener <code class="directive"><a href="/mod/mod_autoindex.html#addiconbytype">AddIconByType</a></code>,
ceb14f8ba57a8086c9a68ad264efbe2433134382covener <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>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <dt>Limit</dt>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <dd>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh 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>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh
2d2eda71267231c2526be701fe655db125852c1ffielding <dt>Options[=<var>Option</var>,...]</dt>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm
2d2eda71267231c2526be701fe655db125852c1ffielding <dd>
cf35a54aa4b61245bf315cc594f8809c1cf31729geoff 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>).
2d2eda71267231c2526be701fe655db125852c1ffielding An equal sign may be given followed by a comma (but no spaces)
2d2eda71267231c2526be701fe655db125852c1ffielding separated lists of options that may be set using the <code class="directive"><a href="#options">Options</a></code> command.</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 <p>In the example above all directives that are neither in the group
2d2eda71267231c2526be701fe655db125852c1ffielding <code>AuthConfig</code> nor <code>Indexes</code> cause an internal
2d2eda71267231c2526be701fe655db125852c1ffielding server error.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <div class="note"><p>For security and performance reasons, do not set
2d2eda71267231c2526be701fe655db125852c1ffielding <code>AllowOverride</code> to anything other than <code>None</code>
2d2eda71267231c2526be701fe655db125852c1ffielding in your <code>&lt;Directory /&gt;</code> block. Instead, find (or
2d2eda71267231c2526be701fe655db125852c1ffielding create) the <code>&lt;Directory&gt;</code> block that refers to the
2d2eda71267231c2526be701fe655db125852c1ffielding directory where you're actually planning to place a
2d2eda71267231c2526be701fe655db125852c1ffielding <code>.htaccess</code> file.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding </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="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>
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>FileInfo</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4d88cba691cf0cc222161dc403067071eca58751rbb<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>NetWare only</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding</table>
2d2eda71267231c2526be701fe655db125852c1ffielding <p>This directive is used to control how Apache httpd finds the
2d2eda71267231c2526be701fe655db125852c1ffielding interpreter used to run CGI scripts. For example, setting
2d2eda71267231c2526be701fe655db125852c1ffielding <code>CGIMapExtension sys:\foo.nlm .foo</code> will
2d2eda71267231c2526be701fe655db125852c1ffielding cause all CGI script files with a <code>.foo</code> extension to
2d2eda71267231c2526be701fe655db125852c1ffielding be passed to the FOO interpreter.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding</div>
2d2eda71267231c2526be701fe655db125852c1ffielding<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<div class="directive-section"><h2><a name="ContentDigest" id="ContentDigest">ContentDigest</a> <a name="contentdigest" id="contentdigest">Directive</a></h2>
2d2eda71267231c2526be701fe655db125852c1ffielding<table class="directive">
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables the generation of <code>Content-MD5</code> HTTP Response
2d2eda71267231c2526be701fe655db125852c1ffieldingheaders</td></tr>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ContentDigest On|Off</code></td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ContentDigest Off</code></td></tr>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<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>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<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>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh</table>
2d2eda71267231c2526be701fe655db125852c1ffielding <p>This directive enables the generation of
a59f92f67a2c7735469d0ade559f96218627eef0niq <code>Content-MD5</code> headers as defined in RFC1864
a59f92f67a2c7735469d0ade559f96218627eef0niq respectively RFC2616.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <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
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <div class="example"><p><code>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh Content-MD5: AuLb7Dp1rqtRtxz2m9kRpA==
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh </code></p></div>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <p>Note that this can cause performance problems on your server
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh since the message digest is computed on every request (the
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh values are not cached).</p>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <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
763f7b125b6d3dd1e4992a3822005efa2616f983coar do not have this header.</p>
763f7b125b6d3dd1e4992a3822005efa2616f983coar
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh</div>
2d2eda71267231c2526be701fe655db125852c1ffielding<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<div class="directive-section"><h2><a name="DefaultType" id="DefaultType">DefaultType</a> <a name="defaulttype" id="defaulttype">Directive</a></h2>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<table class="directive">
5a9667916c79d8c699b069068e5570aa1c331c80gstein<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>This directive has no effect other than to emit warnings
5a9667916c79d8c699b069068e5570aa1c331c80gsteinif the value is not <code>none</code>. In prior versions, DefaultType
5a9667916c79d8c699b069068e5570aa1c331c80gsteinwould specify a default media type to assign to response content for
5a9667916c79d8c699b069068e5570aa1c331c80gsteinwhich no other media type configuration could be found.
5a9667916c79d8c699b069068e5570aa1c331c80gstein</td></tr>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DefaultType <var>media-type|none</var></code></td></tr>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>DefaultType none</code></td></tr>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
5a9667916c79d8c699b069068e5570aa1c331c80gstein<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
5a9667916c79d8c699b069068e5570aa1c331c80gstein<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
5a9667916c79d8c699b069068e5570aa1c331c80gstein<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
5a9667916c79d8c699b069068e5570aa1c331c80gstein<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>The argument <code>none</code> is available in Apache httpd 2.2.7 and later. All other choices are DISABLED for 2.3.x and later.</td></tr>
5a9667916c79d8c699b069068e5570aa1c331c80gstein</table>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <p>This directive has been disabled. For backwards compatibility
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh of configuration files, it may be specified with the value
5a9667916c79d8c699b069068e5570aa1c331c80gstein <code>none</code>, meaning no default media type. For example:</p>
5a9667916c79d8c699b069068e5570aa1c331c80gstein
5a9667916c79d8c699b069068e5570aa1c331c80gstein <div class="example"><p><code>
5a9667916c79d8c699b069068e5570aa1c331c80gstein DefaultType None
5a9667916c79d8c699b069068e5570aa1c331c80gstein </code></p></div>
5a9667916c79d8c699b069068e5570aa1c331c80gstein
5a9667916c79d8c699b069068e5570aa1c331c80gstein <p><code>DefaultType None</code> is only available in
5a9667916c79d8c699b069068e5570aa1c331c80gstein httpd-2.2.7 and later.</p>
5a9667916c79d8c699b069068e5570aa1c331c80gstein
5a9667916c79d8c699b069068e5570aa1c331c80gstein <p>Use the mime.types configuration file and the
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <code class="directive"><a href="/mod/mod_mime.html#addtype">AddType</a></code> to configure media
2d2eda71267231c2526be701fe655db125852c1ffielding type assignments via file extensions, or the
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <code class="directive"><a href="#forcetype">ForceType</a></code> directive to configure
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh the media type for specific resources. Otherwise, the server will
62db15de4c1f335a64d45821796ae197cff94ef8rbb send the response without a Content-Type header field and the
62db15de4c1f335a64d45821796ae197cff94ef8rbb recipient may attempt to guess the media type.</p>
62db15de4c1f335a64d45821796ae197cff94ef8rbb
2d2eda71267231c2526be701fe655db125852c1ffielding</div>
48d2edbfb84e5559b5da0f8d614ccab805cc67a8rbb<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
48d2edbfb84e5559b5da0f8d614ccab805cc67a8rbb<div class="directive-section"><h2><a name="Define" id="Define">Define</a> <a name="define" id="define">Directive</a></h2>
48d2edbfb84e5559b5da0f8d614ccab805cc67a8rbb<table class="directive">
5a9667916c79d8c699b069068e5570aa1c331c80gstein<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Define the existence of a variable</td></tr>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Define <var>parameter-name</var></code></td></tr>
48d2edbfb84e5559b5da0f8d614ccab805cc67a8rbb<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
48d2edbfb84e5559b5da0f8d614ccab805cc67a8rbb<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh</table>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <p>Equivalent to passing the <code>-D</code> argument to <code class="program"><a href="/programs/httpd.html">httpd</a></code>.</p>
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb <p>This directive can be used to toggle the use of <code class="directive"><a href="#ifdefine">&lt;IfDefine&gt;</a></code> sections without needing to alter
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <code>-D</code> arguments in any startup scripts.</p>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh</div>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<div class="directive-section"><h2><a name="Directory" id="Directory">&lt;Directory&gt;</a> <a name="directory" id="directory">Directive</a></h2>
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar<table class="directive">
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enclose a group of directives that apply only to the
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianhnamed file-system directory, sub-directories, and their contents.</td></tr>
62db15de4c1f335a64d45821796ae197cff94ef8rbb<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;Directory <var>directory-path</var>&gt;
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh... &lt;/Directory&gt;</code></td></tr>
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh</table>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <p><code class="directive">&lt;Directory&gt;</code> and
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <code>&lt;/Directory&gt;</code> are used to enclose a group of
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh directives that will apply only to the named directory,
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh sub-directories of that directory, and the files within the respective
2d2eda71267231c2526be701fe655db125852c1ffielding directories. Any directive that is allowed
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh in a directory context may be used. <var>Directory-path</var> is
2d2eda71267231c2526be701fe655db125852c1ffielding either the full path to a directory, or a wild-card string using
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh Unix shell-style matching. In a wild-card string, <code>?</code> matches
2d2eda71267231c2526be701fe655db125852c1ffielding any single character, and <code>*</code> matches any sequences of
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh characters. You may also use <code>[]</code> character ranges. None
2d2eda71267231c2526be701fe655db125852c1ffielding of the wildcards match a `/' character, so <code>&lt;Directory
2d2eda71267231c2526be701fe655db125852c1ffielding /*/public_html&gt;</code> will not match
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <code>/home/user/public_html</code>, but <code>&lt;Directory
54e94821097724bf413d2d4cc70711760f7494e1trawick /home/*/public_html&gt;</code> will match. Example:</p>
db3fa7db7c7910f2f23c3e3ffe0cf9f41a1899b9trawick
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <div class="example"><p><code>
2d2eda71267231c2526be701fe655db125852c1ffielding &lt;Directory /usr/local/httpd/htdocs&gt;<br />
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <span class="indent">
2d2eda71267231c2526be701fe655db125852c1ffielding Options Indexes FollowSymLinks<br />
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh </span>
54e94821097724bf413d2d4cc70711760f7494e1trawick &lt;/Directory&gt;
db3fa7db7c7910f2f23c3e3ffe0cf9f41a1899b9trawick </code></p></div>
54e94821097724bf413d2d4cc70711760f7494e1trawick
54e94821097724bf413d2d4cc70711760f7494e1trawick <div class="note">
54e94821097724bf413d2d4cc70711760f7494e1trawick <p>Be careful with the <var>directory-path</var> arguments:
54e94821097724bf413d2d4cc70711760f7494e1trawick They have to literally match the filesystem path which Apache httpd uses
54e94821097724bf413d2d4cc70711760f7494e1trawick to access the files. Directives applied to a particular
54e94821097724bf413d2d4cc70711760f7494e1trawick <code>&lt;Directory&gt;</code> will not apply to files accessed from
54e94821097724bf413d2d4cc70711760f7494e1trawick that same directory via a different path, such as via different symbolic
54e94821097724bf413d2d4cc70711760f7494e1trawick links.</p>
54e94821097724bf413d2d4cc70711760f7494e1trawick </div>
db3fa7db7c7910f2f23c3e3ffe0cf9f41a1899b9trawick
c8477d12d1b127ab46dffe4ee526b9d11f71699egregames <p><a class="glossarylink" href="/glossary.html#regex" title="see glossary">Regular
c8477d12d1b127ab46dffe4ee526b9d11f71699egregames expressions</a> can also be used, with the addition of the
2d2eda71267231c2526be701fe655db125852c1ffielding <code>~</code> character. For example:</p>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh
cd9eb79cfbf9bc730ccacc3a3774b1fe1b99ed53wrowe <div class="example"><p><code>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh &lt;Directory ~ "^/www/.*/[0-9]{3}"&gt;
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh </code></p></div>
2d2eda71267231c2526be701fe655db125852c1ffielding
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <p>would match directories in <code>/www/</code> that consisted of
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh three numbers.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <p>If multiple (non-regular expression) <code class="directive">&lt;Directory&gt;</code> sections
2d2eda71267231c2526be701fe655db125852c1ffielding match the directory (or one of its parents) containing a document,
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh then the directives are applied in the order of shortest match
2d2eda71267231c2526be701fe655db125852c1ffielding first, interspersed with the directives from the <a href="#accessfilename">.htaccess</a> files. For example,
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh with</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
cd9eb79cfbf9bc730ccacc3a3774b1fe1b99ed53wrowe <div class="example"><p><code>
cd9eb79cfbf9bc730ccacc3a3774b1fe1b99ed53wrowe &lt;Directory /&gt;<br />
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <span class="indent">
cd9eb79cfbf9bc730ccacc3a3774b1fe1b99ed53wrowe AllowOverride None<br />
cd9eb79cfbf9bc730ccacc3a3774b1fe1b99ed53wrowe </span>
cd9eb79cfbf9bc730ccacc3a3774b1fe1b99ed53wrowe &lt;/Directory&gt;<br />
cd9eb79cfbf9bc730ccacc3a3774b1fe1b99ed53wrowe <br />
e57fd661645dcfdf166e77484b509b248e62a19eaaron &lt;Directory /home&gt;<br />
e57fd661645dcfdf166e77484b509b248e62a19eaaron <span class="indent">
e57fd661645dcfdf166e77484b509b248e62a19eaaron AllowOverride FileInfo<br />
cd9eb79cfbf9bc730ccacc3a3774b1fe1b99ed53wrowe </span>
e57fd661645dcfdf166e77484b509b248e62a19eaaron &lt;/Directory&gt;
cd9eb79cfbf9bc730ccacc3a3774b1fe1b99ed53wrowe </code></p></div>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <p>for access to the document <code>/home/web/dir/doc.html</code>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh the steps are:</p>
cd9eb79cfbf9bc730ccacc3a3774b1fe1b99ed53wrowe
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <ul>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <li>Apply directive <code>AllowOverride None</code>
2d2eda71267231c2526be701fe655db125852c1ffielding (disabling <code>.htaccess</code> files).</li>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <li>Apply directive <code>AllowOverride FileInfo</code> (for
2d2eda71267231c2526be701fe655db125852c1ffielding directory <code>/home</code>).</li>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <li>Apply any <code>FileInfo</code> directives in
2d2eda71267231c2526be701fe655db125852c1ffielding <code>/home/.htaccess</code>, <code>/home/web/.htaccess</code> and
2d2eda71267231c2526be701fe655db125852c1ffielding <code>/home/web/dir/.htaccess</code> in that order.</li>
2d2eda71267231c2526be701fe655db125852c1ffielding </ul>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p>Regular expressions are not considered until after all of the
2d2eda71267231c2526be701fe655db125852c1ffielding normal sections have been applied. Then all of the regular
952908500d5f99f35afc5ed510391b9bdc3833farbb expressions are tested in the order they appeared in the
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh configuration file. For example, with</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <div class="example"><p><code>
2d2eda71267231c2526be701fe655db125852c1ffielding &lt;Directory ~ abc$&gt;<br />
952908500d5f99f35afc5ed510391b9bdc3833farbb <span class="indent">
952908500d5f99f35afc5ed510391b9bdc3833farbb # ... directives here ...<br />
952908500d5f99f35afc5ed510391b9bdc3833farbb </span>
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;/Directory&gt;
103a93c625bcde1a6a7a5155b64dcda36f612180pquerna </code></p></div>
103a93c625bcde1a6a7a5155b64dcda36f612180pquerna
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>the regular expression section won't be considered until after
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein all normal <code class="directive">&lt;Directory&gt;</code>s and
952908500d5f99f35afc5ed510391b9bdc3833farbb <code>.htaccess</code> files have been applied. Then the regular
2d2eda71267231c2526be701fe655db125852c1ffielding expression will match on <code>/home/abc/public_html/abc</code> and
2d2eda71267231c2526be701fe655db125852c1ffielding the corresponding <code class="directive">&lt;Directory&gt;</code> will
2d2eda71267231c2526be701fe655db125852c1ffielding be applied.</p>
3887202241db08986e94b252fbd06a55e55d4b2dbhyde
3887202241db08986e94b252fbd06a55e55d4b2dbhyde <p><strong>Note that the default access for
3887202241db08986e94b252fbd06a55e55d4b2dbhyde <code>&lt;Directory /&gt;</code> is <code>Allow from All</code>.
3887202241db08986e94b252fbd06a55e55d4b2dbhyde This means that Apache httpd will serve any file mapped from an URL. It is
3887202241db08986e94b252fbd06a55e55d4b2dbhyde recommended that you change this with a block such
3887202241db08986e94b252fbd06a55e55d4b2dbhyde as</strong></p>
3887202241db08986e94b252fbd06a55e55d4b2dbhyde
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <div class="example"><p><code>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh &lt;Directory /&gt;<br />
3887202241db08986e94b252fbd06a55e55d4b2dbhyde <span class="indent">
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh Order Deny,Allow<br />
2d2eda71267231c2526be701fe655db125852c1ffielding Deny from All<br />
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh </span>
3887202241db08986e94b252fbd06a55e55d4b2dbhyde &lt;/Directory&gt;
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh </code></p></div>
2d2eda71267231c2526be701fe655db125852c1ffielding
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna <p><strong>and then override this for directories you
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna <em>want</em> accessible. See the <a href="/misc/security_tips.html">Security Tips</a> page for more
2d2eda71267231c2526be701fe655db125852c1ffielding details.</strong></p>
7c7372abe2484e7fcf81937b93496d1246e5b816gstein
7c7372abe2484e7fcf81937b93496d1246e5b816gstein <p>The directory sections occur in the <code>httpd.conf</code> file.
864c5615d55b8ebbde24e72043f6325741335a74fielding <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>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<h3>See also</h3>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<ul>
3887202241db08986e94b252fbd06a55e55d4b2dbhyde<li><a href="/sections.html">How &lt;Directory&gt;,
e57fd661645dcfdf166e77484b509b248e62a19eaaron &lt;Location&gt; and &lt;Files&gt; sections work</a> for an
952908500d5f99f35afc5ed510391b9bdc3833farbb explanation of how these different sections are combined when a
e57fd661645dcfdf166e77484b509b248e62a19eaaron request is received</li>
952908500d5f99f35afc5ed510391b9bdc3833farbb</ul>
952908500d5f99f35afc5ed510391b9bdc3833farbb</div>
3887202241db08986e94b252fbd06a55e55d4b2dbhyde<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf<div class="directive-section"><h2><a name="DirectoryMatch" id="DirectoryMatch">&lt;DirectoryMatch&gt;</a> <a name="directorymatch" id="directorymatch">Directive</a></h2>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf<table class="directive">
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enclose directives that apply to
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sfthe contents of file-system directories matching a regular expression.</td></tr>
3887202241db08986e94b252fbd06a55e55d4b2dbhyde<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;DirectoryMatch <var>regex</var>&gt;
3887202241db08986e94b252fbd06a55e55d4b2dbhyde... &lt;/DirectoryMatch&gt;</code></td></tr>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding</table>
952908500d5f99f35afc5ed510391b9bdc3833farbb <p><code class="directive">&lt;DirectoryMatch&gt;</code> and
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm <code>&lt;/DirectoryMatch&gt;</code> are used to enclose a group
e57fd661645dcfdf166e77484b509b248e62a19eaaron of directives which will apply only to the named directory (and the files within),
2d2eda71267231c2526be701fe655db125852c1ffielding the same as <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code>.
e57fd661645dcfdf166e77484b509b248e62a19eaaron However, it takes as an argument a
2d2eda71267231c2526be701fe655db125852c1ffielding <a class="glossarylink" href="/glossary.html#regex" title="see glossary">regular expression</a>. For example:</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
e57fd661645dcfdf166e77484b509b248e62a19eaaron <div class="example"><p><code>
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;DirectoryMatch "^/www/(.+/)?[0-9]{3}"&gt;
e57fd661645dcfdf166e77484b509b248e62a19eaaron </code></p></div>
952908500d5f99f35afc5ed510391b9bdc3833farbb
2d2eda71267231c2526be701fe655db125852c1ffielding <p>would match directories in <code>/www/</code> that consisted of three
6658f209f08181bd218341770db9f428032dd23ajwoolley numbers.</p>
6658f209f08181bd218341770db9f428032dd23ajwoolley
952908500d5f99f35afc5ed510391b9bdc3833farbb <div class="note"><h3>Compatability</h3>
2d2eda71267231c2526be701fe655db125852c1ffielding Prior to 2.3.9, this directive implicitly applied to sub-directories
2d2eda71267231c2526be701fe655db125852c1ffielding (like <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code>) and
2d2eda71267231c2526be701fe655db125852c1ffielding could not match the end of line symbol ($). In 2.3.9 and later,
2d2eda71267231c2526be701fe655db125852c1ffielding only directories that match the expression are affected by the enclosed
e57fd661645dcfdf166e77484b509b248e62a19eaaron directives.
952908500d5f99f35afc5ed510391b9bdc3833farbb </div>
97ff7bf3f33a3527953d975df5cbf82a5a7dc9a6wrowe
952908500d5f99f35afc5ed510391b9bdc3833farbb <div class="note"><h3>Trailing Slash</h3>
853a0c44563b056e40e9cffe911190f554e63ec3chuck This directive applies to requests for directories that may or may
79c0ed7d839527abd86794a6b1d2df4fd189a2a8jerenkrantz not end in a trailing slash, so expressions that are anchored to the
79c0ed7d839527abd86794a6b1d2df4fd189a2a8jerenkrantz end of line ($) must be written with care.
853a0c44563b056e40e9cffe911190f554e63ec3chuck </div>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb<h3>See also</h3>
952908500d5f99f35afc5ed510391b9bdc3833farbb<ul>
e57fd661645dcfdf166e77484b509b248e62a19eaaron<li><code class="directive"><a href="#directory">&lt;Directory&gt;</a></code> for
952908500d5f99f35afc5ed510391b9bdc3833farbba description of how regular expressions are mixed in with normal
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf<code class="directive">&lt;Directory&gt;</code>s</li>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf<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>
e57fd661645dcfdf166e77484b509b248e62a19eaaron</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="DocumentRoot" id="DocumentRoot">DocumentRoot</a> <a name="documentroot" id="documentroot">Directive</a></h2>
952908500d5f99f35afc5ed510391b9bdc3833farbb<table class="directive">
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Directory that forms the main document tree visible
e57fd661645dcfdf166e77484b509b248e62a19eaaronfrom the web</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<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>
2d2eda71267231c2526be701fe655db125852c1ffielding</table>
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>This directive sets the directory from which <code class="program"><a href="/programs/httpd.html">httpd</a></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
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf path from the requested URL to the document root to make the
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf path to the document. Example:</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
9f9307bbe539dbcf96919715315eb64ce3465f5bben <div class="example"><p><code>
e57fd661645dcfdf166e77484b509b248e62a19eaaron DocumentRoot /usr/web
952908500d5f99f35afc5ed510391b9bdc3833farbb </code></p></div>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>then an access to
952908500d5f99f35afc5ed510391b9bdc3833farbb <code>http://my.example.com/index.html</code> refers to
952908500d5f99f35afc5ed510391b9bdc3833farbb <code>/usr/web/index.html</code>. If the <var>directory-path</var> is
952908500d5f99f35afc5ed510391b9bdc3833farbb not absolute then it is assumed to be relative to the <code class="directive"><a href="#serverroot">ServerRoot</a></code>.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>The <code class="directive">DocumentRoot</code> should be specified without
952908500d5f99f35afc5ed510391b9bdc3833farbb a trailing slash.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb<h3>See also</h3>
952908500d5f99f35afc5ed510391b9bdc3833farbb<ul>
952908500d5f99f35afc5ed510391b9bdc3833farbb<li><a href="/urlmapping.html#documentroot">Mapping URLs to Filesystem
952908500d5f99f35afc5ed510391b9bdc3833farbbLocations</a></li>
952908500d5f99f35afc5ed510391b9bdc3833farbb</ul>
952908500d5f99f35afc5ed510391b9bdc3833farbb</div>
9f9307bbe539dbcf96919715315eb64ce3465f5bben<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
952908500d5f99f35afc5ed510391b9bdc3833farbb<div class="directive-section"><h2><a name="EnableMMAP" id="EnableMMAP">EnableMMAP</a> <a name="enablemmap" id="enablemmap">Directive</a></h2>
62db15de4c1f335a64d45821796ae197cff94ef8rbb<table class="directive">
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Use memory-mapping to read files during delivery</td></tr>
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>EnableMMAP On|Off</code></td></tr>
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>EnableMMAP On</code></td></tr>
a520b923984f45daeaf0741d5c7e3de1f2d24509rbb<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>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
11a7b0dff22d26770b532c174d1cf2e7b56ec244wrowe<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb</table>
11a7b0dff22d26770b532c174d1cf2e7b56ec244wrowe <p>This directive controls whether the <code class="program"><a href="/programs/httpd.html">httpd</a></code> may use
e57fd661645dcfdf166e77484b509b248e62a19eaaron memory-mapping if it needs to read the contents of a file during
952908500d5f99f35afc5ed510391b9bdc3833farbb delivery. By default, when the handling of a request requires
2d2eda71267231c2526be701fe655db125852c1ffielding access to the data within a file -- for example, when delivering a
2d2eda71267231c2526be701fe655db125852c1ffielding server-parsed file using <code class="module"><a href="/mod/mod_include.html">mod_include</a></code> -- Apache httpd
2d2eda71267231c2526be701fe655db125852c1ffielding memory-maps the file if the OS supports it.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>This memory-mapping sometimes yields a performance improvement.
952908500d5f99f35afc5ed510391b9bdc3833farbb But in some environments, it is better to disable the memory-mapping
7bdef86e15d47d16dcbe7a5611683191774bd5fbgstein to prevent operational problems:</p>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf <ul>
952908500d5f99f35afc5ed510391b9bdc3833farbb <li>On some multiprocessor systems, memory-mapping can reduce the
e57fd661645dcfdf166e77484b509b248e62a19eaaron performance of the <code class="program"><a href="/programs/httpd.html">httpd</a></code>.</li>
e57fd661645dcfdf166e77484b509b248e62a19eaaron <li>Deleting or truncating a file while <code class="program"><a href="/programs/httpd.html">httpd</a></code>
e57fd661645dcfdf166e77484b509b248e62a19eaaron has it memory-mapped can cause <code class="program"><a href="/programs/httpd.html">httpd</a></code> to
952908500d5f99f35afc5ed510391b9bdc3833farbb crash with a segmentation fault.
952908500d5f99f35afc5ed510391b9bdc3833farbb </li>
952908500d5f99f35afc5ed510391b9bdc3833farbb </ul>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>For server configurations that are vulnerable to these problems,
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf you should disable memory-mapping of delivered files by specifying:</p>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf <div class="example"><p><code>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf EnableMMAP Off
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf </code></p></div>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf <p>For NFS mounted files, this feature may be disabled explicitly for
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf the offending files by specifying:</p>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf <div class="example"><p><code>
2d2eda71267231c2526be701fe655db125852c1ffielding &lt;Directory "/path-to-nfs-files"&gt;
2d2eda71267231c2526be701fe655db125852c1ffielding <span class="indent">
2d2eda71267231c2526be701fe655db125852c1ffielding EnableMMAP Off
2d2eda71267231c2526be701fe655db125852c1ffielding </span>
2d2eda71267231c2526be701fe655db125852c1ffielding &lt;/Directory&gt;
2d2eda71267231c2526be701fe655db125852c1ffielding </code></p></div>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding</div>
2d2eda71267231c2526be701fe655db125852c1ffielding<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm<div class="directive-section"><h2><a name="EnableSendfile" id="EnableSendfile">EnableSendfile</a> <a name="enablesendfile" id="enablesendfile">Directive</a></h2>
2d2eda71267231c2526be701fe655db125852c1ffielding<table class="directive">
2d2eda71267231c2526be701fe655db125852c1ffielding<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>
2d2eda71267231c2526be701fe655db125852c1ffielding<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 Off</code></td></tr>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm<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>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm<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. Default changed to Off in
1ccd992d37d62c8cb2056126f2234f64ec189bfddougmversion 2.3.9.</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb</table>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm <p>This directive controls whether <code class="program"><a href="/programs/httpd.html">httpd</a></code> may use the
952908500d5f99f35afc5ed510391b9bdc3833farbb sendfile support from the kernel to transmit file contents to the client.
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm By default, when the handling of a request requires no access
2d2eda71267231c2526be701fe655db125852c1ffielding to the data within a file -- for example, when delivering a
44a4ee1140769173da7bc2b42d1a686e3260ad84wrowe static file -- Apache httpd uses sendfile to deliver the file contents
44a4ee1140769173da7bc2b42d1a686e3260ad84wrowe without ever reading the file if the OS supports it.</p>
44a4ee1140769173da7bc2b42d1a686e3260ad84wrowe
2d2eda71267231c2526be701fe655db125852c1ffielding <p>This sendfile mechanism avoids separate read and send operations,
952908500d5f99f35afc5ed510391b9bdc3833farbb and buffer allocations. But on some platforms or within some
2d2eda71267231c2526be701fe655db125852c1ffielding filesystems, it is better to disable this feature to avoid
952908500d5f99f35afc5ed510391b9bdc3833farbb operational problems:</p>
e57fd661645dcfdf166e77484b509b248e62a19eaaron
2d2eda71267231c2526be701fe655db125852c1ffielding <ul>
952908500d5f99f35afc5ed510391b9bdc3833farbb <li>Some platforms may have broken sendfile support that the build
2d2eda71267231c2526be701fe655db125852c1ffielding system did not detect, especially if the binaries were built on
e57fd661645dcfdf166e77484b509b248e62a19eaaron another box and moved to such a machine with broken sendfile
952908500d5f99f35afc5ed510391b9bdc3833farbb support.</li>
2d2eda71267231c2526be701fe655db125852c1ffielding <li>On Linux the use of sendfile triggers TCP-checksum
952908500d5f99f35afc5ed510391b9bdc3833farbb offloading bugs on certain networking cards when using IPv6.</li>
952908500d5f99f35afc5ed510391b9bdc3833farbb <li>On Linux on Itanium, sendfile may be unable to handle files
2e123e8beedc9f921448c113e2d6823a92fd5261fielding over 2GB in size.</li>
952908500d5f99f35afc5ed510391b9bdc3833farbb <li>With a network-mounted <code class="directive"><a href="#documentroot">DocumentRoot</a></code> (e.g., NFS, SMB, CIFS, FUSE),
952908500d5f99f35afc5ed510391b9bdc3833farbb the kernel may be unable to serve the network file through
952908500d5f99f35afc5ed510391b9bdc3833farbb its own cache.</li>
952908500d5f99f35afc5ed510391b9bdc3833farbb </ul>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p>For server configurations that are not vulnerable to these problems,
2d2eda71267231c2526be701fe655db125852c1ffielding you may enable this feature by specifying:</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <div class="example"><p><code>
e57fd661645dcfdf166e77484b509b248e62a19eaaron EnableSendfile On
952908500d5f99f35afc5ed510391b9bdc3833farbb </code></p></div>
f8033d657a57eab45af44368774d8beb3e4f7f35pquerna
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>For network mounted files, this feature may be disabled explicitly
e57fd661645dcfdf166e77484b509b248e62a19eaaron for the offending files by specifying:</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
e57fd661645dcfdf166e77484b509b248e62a19eaaron <div class="example"><p><code>
fa3785601cc3801525bc3fc98cafcea5d82efe99wrowe &lt;Directory "/path-to-nfs-files"&gt;
a18775c154178d6c07aed84bd54ac16f59f89bc9wrowe <span class="indent">
e57fd661645dcfdf166e77484b509b248e62a19eaaron EnableSendfile Off
2d2eda71267231c2526be701fe655db125852c1ffielding </span>
e57fd661645dcfdf166e77484b509b248e62a19eaaron &lt;/Directory&gt;
952908500d5f99f35afc5ed510391b9bdc3833farbb </code></p></div>
2d2eda71267231c2526be701fe655db125852c1ffielding <p>Please note that the per-directory and .htaccess configuration
e57fd661645dcfdf166e77484b509b248e62a19eaaron of <code class="directive">EnableSendfile</code> is not supported by
e57fd661645dcfdf166e77484b509b248e62a19eaaron <code class="module"><a href="/mod/mod_cache_disk.html">mod_cache_disk</a></code>.
e57fd661645dcfdf166e77484b509b248e62a19eaaron Only global definition of <code class="directive">EnableSendfile</code>
e57fd661645dcfdf166e77484b509b248e62a19eaaron is taken into account by the module.
e57fd661645dcfdf166e77484b509b248e62a19eaaron </p>
e57fd661645dcfdf166e77484b509b248e62a19eaaron
e57fd661645dcfdf166e77484b509b248e62a19eaaron</div>
cd9eb79cfbf9bc730ccacc3a3774b1fe1b99ed53wrowe<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
97ff7bf3f33a3527953d975df5cbf82a5a7dc9a6wrowe<div class="directive-section"><h2><a name="Error" id="Error">Error</a> <a name="error" id="error">Directive</a></h2>
97ff7bf3f33a3527953d975df5cbf82a5a7dc9a6wrowe<table class="directive">
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Abort configuration parsing with a custom error message</td></tr>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Error <var>message</var></code></td></tr>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf<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#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>2.3.9 and later</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding</table>
2d2eda71267231c2526be701fe655db125852c1ffielding <p>If an error can be detected within the configuration, this
952908500d5f99f35afc5ed510391b9bdc3833farbb directive can be used to generate a custom error message, and halt
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein configuration parsing. The typical use is for reporting required
952908500d5f99f35afc5ed510391b9bdc3833farbb modules which are missing from the configuration.</p>
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein
2d2eda71267231c2526be701fe655db125852c1ffielding <div class="example"><h3>Example</h3><p><code>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf # ensure that mod_include is loaded<br />
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf &lt;IfModule !include_module&gt;<br />
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf Error mod_include is required by mod_foo. Load it with LoadModule.<br />
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf &lt;/IfModule&gt;<br />
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf <br />
e302f38fd646764ce1a1e1c578d794aef514a9e5sf # ensure that exactly one of SSL,NOSSL is defined<br />
e302f38fd646764ce1a1e1c578d794aef514a9e5sf &lt;IfDefine SSL&gt;<br />
e302f38fd646764ce1a1e1c578d794aef514a9e5sf &lt;IfDefine NOSSL&gt;<br />
e302f38fd646764ce1a1e1c578d794aef514a9e5sf Error Both SSL and NOSSL are defined. Define only one of them.<br />
e302f38fd646764ce1a1e1c578d794aef514a9e5sf &lt;/IfDefine&gt;<br />
e57fd661645dcfdf166e77484b509b248e62a19eaaron &lt;/IfDefine&gt;<br />
e57fd661645dcfdf166e77484b509b248e62a19eaaron &lt;IfDefine !SSL&gt;<br />
e57fd661645dcfdf166e77484b509b248e62a19eaaron &lt;IfDefine !NOSSL&gt;<br />
e57fd661645dcfdf166e77484b509b248e62a19eaaron Error Either SSL or NOSSL must be defined.<br />
e57fd661645dcfdf166e77484b509b248e62a19eaaron &lt;/IfDefine&gt;<br />
e57fd661645dcfdf166e77484b509b248e62a19eaaron &lt;/IfDefine&gt;<br />
2d2eda71267231c2526be701fe655db125852c1ffielding </code></p></div>
2d2eda71267231c2526be701fe655db125852c1ffielding
9f9307bbe539dbcf96919715315eb64ce3465f5bben
a93bda3b944fb92e3850db5621b5a27fc0e44509wrowe</div>
9f9307bbe539dbcf96919715315eb64ce3465f5bben<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
a93bda3b944fb92e3850db5621b5a27fc0e44509wrowe<div class="directive-section"><h2><a name="ErrorDocument" id="ErrorDocument">ErrorDocument</a> <a name="errordocument" id="errordocument">Directive</a></h2>
e57e920838f31508f1418aa4c25ce55b345b2cebrbb<table class="directive">
e57e920838f31508f1418aa4c25ce55b345b2cebrbb<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>What the server will return to the client
e57e920838f31508f1418aa4c25ce55b345b2cebrbbin case of an error</td></tr>
a93bda3b944fb92e3850db5621b5a27fc0e44509wrowe<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ErrorDocument <var>error-code</var> <var>document</var></code></td></tr>
e57e920838f31508f1418aa4c25ce55b345b2cebrbb<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
e57e920838f31508f1418aa4c25ce55b345b2cebrbb<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
a93bda3b944fb92e3850db5621b5a27fc0e44509wrowe<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
e57e920838f31508f1418aa4c25ce55b345b2cebrbb<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf</table>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf <p>In the event of a problem or error, Apache httpd can be configured
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf to do one of four things,</p>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf
439ccf2a084e1da566548931c585cbcc3a9e7f4cminfrin <ol>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf <li>output a simple hardcoded error message</li>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf <li>output a customized message</li>
b0d8a6d437db6f4c222173f27ef81c98622fbd02pquerna
b0d8a6d437db6f4c222173f27ef81c98622fbd02pquerna <li>redirect to a local <var>URL-path</var> to handle the
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf problem/error</li>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf <li>redirect to an external <var>URL</var> to handle the
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf problem/error</li>
2d2eda71267231c2526be701fe655db125852c1ffielding </ol>
2d2eda71267231c2526be701fe655db125852c1ffielding
9f9307bbe539dbcf96919715315eb64ce3465f5bben <p>The first option is the default, while options 2-4 are
9f9307bbe539dbcf96919715315eb64ce3465f5bben configured using the <code class="directive">ErrorDocument</code>
9f9307bbe539dbcf96919715315eb64ce3465f5bben directive, which is followed by the HTTP response code and a URL
9f9307bbe539dbcf96919715315eb64ce3465f5bben or a message. Apache httpd will sometimes offer additional information
853a0c44563b056e40e9cffe911190f554e63ec3chuck regarding the problem/error.</p>
853a0c44563b056e40e9cffe911190f554e63ec3chuck
853a0c44563b056e40e9cffe911190f554e63ec3chuck <p>URLs can begin with a slash (/) for local web-paths (relative
9f9307bbe539dbcf96919715315eb64ce3465f5bben to the <code class="directive"><a href="#documentroot">DocumentRoot</a></code>), or be a
853a0c44563b056e40e9cffe911190f554e63ec3chuck full URL which the client can resolve. Alternatively, a message
853a0c44563b056e40e9cffe911190f554e63ec3chuck can be provided to be displayed by the browser. Examples:</p>
9f9307bbe539dbcf96919715315eb64ce3465f5bben
9f9307bbe539dbcf96919715315eb64ce3465f5bben <div class="example"><p><code>
9f9307bbe539dbcf96919715315eb64ce3465f5bben ErrorDocument 500 http://foo.example.com/cgi-bin/tester<br />
79c0ed7d839527abd86794a6b1d2df4fd189a2a8jerenkrantz ErrorDocument 404 /cgi-bin/bad_urls.pl<br />
9f9307bbe539dbcf96919715315eb64ce3465f5bben ErrorDocument 401 /subscription_info.html<br />
9f9307bbe539dbcf96919715315eb64ce3465f5bben ErrorDocument 403 "Sorry can't allow you access today"
853a0c44563b056e40e9cffe911190f554e63ec3chuck </code></p></div>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <p>Additionally, the special value <code>default</code> can be used
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh to specify Apache httpd's simple hardcoded message. While not required
f9a773d26994c3b267589e404cdb5b760f83e888jerenkrantz under normal circumstances, <code>default</code> will restore
f9a773d26994c3b267589e404cdb5b760f83e888jerenkrantz Apache httpd's simple hardcoded message for configurations that would
f9a773d26994c3b267589e404cdb5b760f83e888jerenkrantz otherwise inherit an existing <code class="directive">ErrorDocument</code>.</p>
f9a773d26994c3b267589e404cdb5b760f83e888jerenkrantz
f9a773d26994c3b267589e404cdb5b760f83e888jerenkrantz <div class="example"><p><code>
2d2eda71267231c2526be701fe655db125852c1ffielding ErrorDocument 404 /cgi-bin/bad_urls.pl<br /><br />
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh &lt;Directory /web/docs&gt;<br />
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <span class="indent">
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh ErrorDocument 404 default<br />
2d2eda71267231c2526be701fe655db125852c1ffielding </span>
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;/Directory&gt;
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm </code></p></div>
be8a31a0afdb2363dbcc98bbbaa94b6184061b5fdreid
952908500d5f99f35afc5ed510391b9bdc3833farbb <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
952908500d5f99f35afc5ed510391b9bdc3833farbb <code>http</code> in front of it), Apache HTTP Server will send a redirect to the
2d2eda71267231c2526be701fe655db125852c1ffielding client to tell it where to find the document, even if the
2d2eda71267231c2526be701fe655db125852c1ffielding document ends up being on the same server. This has several
952908500d5f99f35afc5ed510391b9bdc3833farbb implications, the most important being that the client will not
91644a5f4d3e992dc208304b50e80bbb236fca89trawick receive the original error status code, but instead will
952908500d5f99f35afc5ed510391b9bdc3833farbb receive a redirect status code. This in turn can confuse web
91644a5f4d3e992dc208304b50e80bbb236fca89trawick robots and other clients which try to determine if a URL is
e6cc28a5eb3371ba0c38e941855e71ff0054f50erbb 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 Knowledge Base article <a href="http://support.microsoft.com/default.aspx?scid=kb;en-us;Q294807">Q294807</a>.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>Although most error messages can be overriden, there are certain
952908500d5f99f35afc5ed510391b9bdc3833farbb circumstances where the internal messages are used regardless of the
952908500d5f99f35afc5ed510391b9bdc3833farbb setting of <code class="directive"><a href="#errordocument">ErrorDocument</a></code>. In
952908500d5f99f35afc5ed510391b9bdc3833farbb particular, if a malformed request is detected, normal request processing
eb0fa8f996539c1cd5e5edf34f46e7e9c199641estas will be immediately halted and the internal error message returned.
eb0fa8f996539c1cd5e5edf34f46e7e9c199641estas This is necessary to guard against security problems caused by
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein bad requests.</p>
eb0fa8f996539c1cd5e5edf34f46e7e9c199641estas
eb0fa8f996539c1cd5e5edf34f46e7e9c199641estas <p>If you are using mod_proxy, you may wish to enable
952908500d5f99f35afc5ed510391b9bdc3833farbb <code class="directive"><a href="/mod/mod_proxy.html#proxyerroroverride">ProxyErrorOverride</a></code> so that you can provide
9f9307bbe539dbcf96919715315eb64ce3465f5bben custom error messages on behalf of your Origin servers. If you don't enable ProxyErrorOverride,
a93bda3b944fb92e3850db5621b5a27fc0e44509wrowe Apache httpd will not generate custom error documents for proxied content.</p>
9f9307bbe539dbcf96919715315eb64ce3465f5bben
a93bda3b944fb92e3850db5621b5a27fc0e44509wrowe<h3>See also</h3>
ca47a2b6bcea23e8af185c68f256dcbbfd2a0f9dtrawick<ul>
ca47a2b6bcea23e8af185c68f256dcbbfd2a0f9dtrawick<li><a href="/custom-error.html">documentation of
2fc50921b88defeb7127985dfe4b4130175e069ejwoolley customizable responses</a></li>
2fc50921b88defeb7127985dfe4b4130175e069ejwoolley</ul>
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna</div>
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna<div class="directive-section"><h2><a name="ErrorLog" id="ErrorLog">ErrorLog</a> <a name="errorlog" id="errorlog">Directive</a></h2>
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna<table class="directive">
2f1bb5376c5c4022383bb729679ca751dd75a2eabrianp<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Location where the server will log errors</td></tr>
2f1bb5376c5c4022383bb729679ca751dd75a2eabrianp<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>
ddc593aa9ac8b227d1fd9677a3a2b24539b5d608pquerna<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ErrorLog logs/error_log (Unix) ErrorLog logs/error.log (Windows and OS/2)</code></td></tr>
135402675e89e6df0e17735e48f428a1e1d8eb16pquerna<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
135402675e89e6df0e17735e48f428a1e1d8eb16pquerna<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
135402675e89e6df0e17735e48f428a1e1d8eb16pquerna<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf</table>
cdccf2ac94172d1a4a54bc2e17324e1ef682ccf3pquerna <p>The <code class="directive">ErrorLog</code> directive sets the name of
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf the file to which the server will log any errors it encounters. If
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf the <var>file-path</var> is not absolute then it is assumed to be
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf relative to the <code class="directive"><a href="#serverroot">ServerRoot</a></code>.</p>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf <div class="example"><h3>Example</h3><p><code>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf ErrorLog /var/log/httpd/error_log
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf </code></p></div>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf <p>If the <var>file-path</var>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf begins with a pipe character "<code>|</code>" then it is assumed to be a
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf command to spawn to handle the error log.</p>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf <div class="example"><h3>Example</h3><p><code>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf ErrorLog "|/usr/local/bin/httpd_errors"
efd83d1dd1a25688a3093c5a542ae16bacef62ddsf </code></p></div>
efd83d1dd1a25688a3093c5a542ae16bacef62ddsf
efd83d1dd1a25688a3093c5a542ae16bacef62ddsf <p>See the notes on <a href="/logs.html#piped">piped logs</a> for
efd83d1dd1a25688a3093c5a542ae16bacef62ddsf more information.</p>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf
e302f38fd646764ce1a1e1c578d794aef514a9e5sf <p>Using <code>syslog</code> instead of a filename enables logging
e302f38fd646764ce1a1e1c578d794aef514a9e5sf via syslogd(8) if the system supports it. The default is to use
e302f38fd646764ce1a1e1c578d794aef514a9e5sf syslog facility <code>local7</code>, but you can override this by
e302f38fd646764ce1a1e1c578d794aef514a9e5sf using the <code>syslog:<var>facility</var></code> syntax where
e302f38fd646764ce1a1e1c578d794aef514a9e5sf <var>facility</var> can be one of the names usually documented in
cdccf2ac94172d1a4a54bc2e17324e1ef682ccf3pquerna syslog(1). The facility is effectively global, and if it is changed
cdccf2ac94172d1a4a54bc2e17324e1ef682ccf3pquerna in individual virtual hosts, the final facility specified affects the
cdccf2ac94172d1a4a54bc2e17324e1ef682ccf3pquerna entire server.</p>
cdccf2ac94172d1a4a54bc2e17324e1ef682ccf3pquerna
cdccf2ac94172d1a4a54bc2e17324e1ef682ccf3pquerna <div class="example"><h3>Example</h3><p><code>
cdccf2ac94172d1a4a54bc2e17324e1ef682ccf3pquerna ErrorLog syslog:user
cdccf2ac94172d1a4a54bc2e17324e1ef682ccf3pquerna </code></p></div>
cdccf2ac94172d1a4a54bc2e17324e1ef682ccf3pquerna
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna <p>SECURITY: See the <a href="/misc/security_tips.html#serverroot">security tips</a>
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna document for details on why your security could be compromised
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh if the directory where log files are stored is writable by
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh anyone other than the user that starts the server.</p>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <div class="warning"><h3>Note</h3>
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna <p>When entering a file path on non-Unix platforms, care should be taken
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna to make sure that only forward slashes are used even though the platform
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna may allow the use of back slashes. In general it is a good idea to always
ad862ab5716726a2d72a292ba1dfb29566c86153brianp use forward slashes throughout the configuration files.</p>
ad862ab5716726a2d72a292ba1dfb29566c86153brianp </div>
b0d8a6d437db6f4c222173f27ef81c98622fbd02pquerna
6d866a6eb84421d08d630030c2a7a2f53f248ad9jorton<h3>See also</h3>
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna<ul>
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna<li><code class="directive"><a href="#loglevel">LogLevel</a></code></li>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<li><a href="/logs.html">Apache HTTP Server Log Files</a></li>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh</ul>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh</div>
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<div class="directive-section"><h2><a name="ErrorLogFormat" id="ErrorLogFormat">ErrorLogFormat</a> <a name="errorlogformat" id="errorlogformat">Directive</a></h2>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<table class="directive">
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Format specification for error log entries</td></tr>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code> ErrorLog [connection|request] <var>format</var></code></td></tr>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache httpd 2.3.9 and later</td></tr>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh</table>
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna <p><code class="directive">ErrorLogFormat</code> allows to specify what
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh supplementary information is logged in the error log in addition to the
d9039a9aaeaa1359c1147af66c09aeac56ae3ee0pquerna actual log message.</p>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf <div class="example"><h3>Simple example</h3><p><code>
2d2eda71267231c2526be701fe655db125852c1ffielding ErrorLogFormat "[%t] [%l] [pid %P] %F: %E: [client %a] %M"
2d2eda71267231c2526be701fe655db125852c1ffielding </code></p></div>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p>Specifying <code>connection</code> or <code>request</code> as first
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh paramter allows to specify additional formats, causing additional
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh information to be logged when the first message is logged for a specific
2d2eda71267231c2526be701fe655db125852c1ffielding connection or request, respectivly. This additional information is only
2d2eda71267231c2526be701fe655db125852c1ffielding logged once per connection/request. If a connection or request is processed
2d2eda71267231c2526be701fe655db125852c1ffielding without causing any log message, the additional information is not logged
2d2eda71267231c2526be701fe655db125852c1ffielding either.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <p>It can happen that some format string items do not produce output. For
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh example, the Referer header is only present if the log message is
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh associated to a request and the log message happens at a time when the
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh Referer header has already been read from the client. If no output is
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh produced, the default behaviour is to delete everything from the preceeding
2d2eda71267231c2526be701fe655db125852c1ffielding space character to the next space character. This means the log line is
169f62b04de69074b561b4e6dcf6f82572a5e367trawick implicitly divided into fields on non-whitespace to whitespace transitions.
2d2eda71267231c2526be701fe655db125852c1ffielding If a format string item does not produce output, the whole field is
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf ommitted. For example, if the remote address <code>%a</code> in the log
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf format <code>[%t] [%l] [%a] %M&nbsp;</code> is not available, the surrounding
952908500d5f99f35afc5ed510391b9bdc3833farbb brackets are not logged either. Space characters can be escaped with a
8a261a9f7d18d1e862d63f68e93f288d3e1f0d94trawick backslash to prevent them from delimiting a field. The combination '%&nbsp;'
952908500d5f99f35afc5ed510391b9bdc3833farbb (percent space) is a zero-witdh field delimiter that does not produce any
dad234382d8424e1c5a30af2838e172aec9d6d1bdreid output.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p>The above behaviour can be changed by adding modifiers to the format
efd83d1dd1a25688a3093c5a542ae16bacef62ddsf string item. A <code>-</code> (minus) modifier causes a minus to be logged if the
efd83d1dd1a25688a3093c5a542ae16bacef62ddsf respective item does not produce any output. In once-per-connection/request
e6a8e6527b3b61ab3d4413799e6ef91d4695f3a0sf formats, it is also possible to use the <code>+</code> (plus) modifier. If an
efd83d1dd1a25688a3093c5a542ae16bacef62ddsf item with the plus modifier does not produce any output, the whole line is
efd83d1dd1a25688a3093c5a542ae16bacef62ddsf ommitted.</p>
efd83d1dd1a25688a3093c5a542ae16bacef62ddsf
efd83d1dd1a25688a3093c5a542ae16bacef62ddsf <p>A number as modifier can be used to assign a log severity level to a
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh format item. The item will only be logged if the severity of the log
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh message is not higher than the specified log severity level. The number can
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh range from 1 (alert) over 4 (warn) and 7 (debug) to 15 (trace8).</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>Some format string items accept additional parameters in braces.</p>
3887202241db08986e94b252fbd06a55e55d4b2dbhyde
952908500d5f99f35afc5ed510391b9bdc3833farbb <table class="bordered"><tr class="header"><th>Format&nbsp;String</th> <th>Description</th></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><td><code>%%</code></td>
2d2eda71267231c2526be701fe655db125852c1ffielding <td>The percent sign</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr class="odd"><td><code>%...a</code></td>
2d2eda71267231c2526be701fe655db125852c1ffielding <td>Remote IP-address and port</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><td><code>%...A</code></td>
2d2eda71267231c2526be701fe655db125852c1ffielding <td>Local IP-address and port</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr class="odd"><td><code>%...{name}e</code></td>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm <td>Request environment variable <code>name</code></td></tr>
efd83d1dd1a25688a3093c5a542ae16bacef62ddsf<tr><td><code>%...E</code></td>
efd83d1dd1a25688a3093c5a542ae16bacef62ddsf <td>APR/OS error status code and string</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr class="odd"><td><code>%...F</code></td>
2d2eda71267231c2526be701fe655db125852c1ffielding <td>Source file name and line number of the log call</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><td><code>%...{name}i</code></td>
952908500d5f99f35afc5ed510391b9bdc3833farbb <td>Request header <code>name</code></td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr class="odd"><td><code>%...k</code></td>
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein <td>Number of keep-alive requests on this connection</td></tr>
169f62b04de69074b561b4e6dcf6f82572a5e367trawick<tr><td><code>%...l</code></td>
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein <td>Loglevel of the message</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr class="odd"><td><code>%...L</code></td>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf <td>Log ID of the request</td></tr>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf<tr><td><code>%...{c}L</code></td>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf <td>Log ID of the connection</td></tr>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf<tr class="odd"><td><code>%...{C}L</code></td>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf <td>Log ID of the connection if used in connection scope, empty otherwise</td></tr>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf<tr><td><code>%...m</code></td>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf <td>Name of the module logging the message</td></tr>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf<tr class="odd"><td><code>%M</code></td>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf <td>The actual log message</td></tr>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf<tr><td><code>%...{name}n</code></td>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf <td>Request note <code>name</code></td></tr>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf<tr class="odd"><td><code>%...P</code></td>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf <td>Process ID of current process</td></tr>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf<tr><td><code>%...T</code></td>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf <td>Thread ID of current thread</td></tr>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf<tr class="odd"><td><code>%...t</code></td>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf <td>The current time</td></tr>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf<tr><td><code>%...{u}t</code></td>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf <td>The current time including micro-seconds</td></tr>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf<tr class="odd"><td><code>%...{cu}t</code></td>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf <td>The current time in compact ISO 8601 format, including
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf micro-seconds</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><td><code>%...v</code></td>
2d2eda71267231c2526be701fe655db125852c1ffielding <td>The canonical <code class="directive"><a href="#servername">ServerName</a></code>
952908500d5f99f35afc5ed510391b9bdc3833farbb of the current server.</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr class="odd"><td><code>%...V</code></td>
fa861fc5a880d2c3a5ecc0ec71fa7da556adf5c1wrowe <td>The server name of the server serving the request according to the
fa861fc5a880d2c3a5ecc0ec71fa7da556adf5c1wrowe <code class="directive"><a href="#usecanonicalname">UseCanonicalName</a></code>
fa861fc5a880d2c3a5ecc0ec71fa7da556adf5c1wrowe setting.</td></tr>
fa861fc5a880d2c3a5ecc0ec71fa7da556adf5c1wrowe<tr><td><code>\&nbsp;</code> (backslash space)</td>
952908500d5f99f35afc5ed510391b9bdc3833farbb <td>Non-field delimiting space</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr class="odd"><td><code>%&nbsp;</code> (percent space)</td>
952908500d5f99f35afc5ed510391b9bdc3833farbb <td>Field delimiter (no output)</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb</table>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>The log ID format <code>%L</code> produces a unique id for a connection
952908500d5f99f35afc5ed510391b9bdc3833farbb or request. This can be used to correlate which log lines belong to the
952908500d5f99f35afc5ed510391b9bdc3833farbb same connection or request, which request happens on which connection.
952908500d5f99f35afc5ed510391b9bdc3833farbb A <code>%L</code> format string is also available in
952908500d5f99f35afc5ed510391b9bdc3833farbb <code class="module"><a href="/mod/mod_log_config.html">mod_log_config</a></code>, to allow to correlate access log entries
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf with error log lines. If <code class="module"><a href="/mod/mod_unique_id.html">mod_unique_id</a></code> is loaded, its
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf unique id will be used as log ID for requests.</p>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf <div class="example"><h3>Example (somewhat similar to default format)</h3><p><code>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf ErrorLogFormat "[%{u}t] [%-m:%l] [pid %P] %7F: %E: [client\ %a]
952908500d5f99f35afc5ed510391b9bdc3833farbb %M%&nbsp;,\&nbsp;referer\&nbsp;%{Referer}i"
952908500d5f99f35afc5ed510391b9bdc3833farbb </code></p></div>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <div class="example"><h3>Example (similar to the 2.2.x format)</h3><p><code>
952908500d5f99f35afc5ed510391b9bdc3833farbb ErrorLogFormat "[%t] [%l] %7F: %E: [client\ %a]
952908500d5f99f35afc5ed510391b9bdc3833farbb %M%&nbsp;,\&nbsp;referer\&nbsp;%{Referer}i"
60262a02cfeba50d60d990b56d0e0c1d1fafb672sctemme </code></p></div>
40965c37b2fd320093215de6c3fbd516382077eajim
40965c37b2fd320093215de6c3fbd516382077eajim <div class="example"><h3>Advanced example with request/connection log IDs</h3><p><code>
40965c37b2fd320093215de6c3fbd516382077eajim ErrorLogFormat "[%{uc}t] [%-m:%-l] [R:%L] [C:%{C}L] %7F: %E: %M"<br />
2d2eda71267231c2526be701fe655db125852c1ffielding ErrorLogFormat request "[%{uc}t] [R:%L] Request %k on C:%{c}L pid:%P tid:%T"<br />
2d2eda71267231c2526be701fe655db125852c1ffielding ErrorLogFormat request "[%{uc}t] [R:%L] UA:'%+{User-Agent}i'"<br />
e6cc28a5eb3371ba0c38e941855e71ff0054f50erbb ErrorLogFormat request "[%{uc}t] [R:%L] Referer:'%+{Referer}i'"<br />
2f1bb5376c5c4022383bb729679ca751dd75a2eabrianp ErrorLogFormat connection "[%{uc}t] [C:%{c}L] local\ %a remote\ %A"<br />
1af2b28846e2647963db788b081676884fb7df8crpluem </code></p></div>
4a68d6a5a7d10728f1f4172c595818f65e38f7b5sf
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf<h3>See also</h3>
e6cc28a5eb3371ba0c38e941855e71ff0054f50erbb<ul>
e6cc28a5eb3371ba0c38e941855e71ff0054f50erbb<li><code class="directive"><a href="#errorlog">ErrorLog</a></code></li>
e6cc28a5eb3371ba0c38e941855e71ff0054f50erbb<li><code class="directive"><a href="#loglevel">LogLevel</a></code></li>
e6cc28a5eb3371ba0c38e941855e71ff0054f50erbb<li><a href="/logs.html">Apache HTTP Server Log Files</a></li>
470147d3f2750bfd47b5d8f1d90abab283eaad0dpquerna</ul>
e6cc28a5eb3371ba0c38e941855e71ff0054f50erbb</div>
4fbb89a070c82e489830233bde6bc78ddf179978stoddard<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
4fbb89a070c82e489830233bde6bc78ddf179978stoddard<div class="directive-section"><h2><a name="ExtendedStatus" id="ExtendedStatus">ExtendedStatus</a> <a name="extendedstatus" id="extendedstatus">Directive</a></h2>
4fbb89a070c82e489830233bde6bc78ddf179978stoddard<table class="directive">
4fbb89a070c82e489830233bde6bc78ddf179978stoddard<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Keep track of extended status information for each
4fbb89a070c82e489830233bde6bc78ddf179978stoddardrequest</td></tr>
4fbb89a070c82e489830233bde6bc78ddf179978stoddard<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ExtendedStatus On|Off</code></td></tr>
4fbb89a070c82e489830233bde6bc78ddf179978stoddard<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ExtendedStatus Off[*]</code></td></tr>
4fbb89a070c82e489830233bde6bc78ddf179978stoddard<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
4fbb89a070c82e489830233bde6bc78ddf179978stoddard<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4fbb89a070c82e489830233bde6bc78ddf179978stoddard<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4fbb89a070c82e489830233bde6bc78ddf179978stoddard</table>
e6cc28a5eb3371ba0c38e941855e71ff0054f50erbb <p>This option tracks additional data per worker about the
952908500d5f99f35afc5ed510391b9bdc3833farbb currently executing request, and a utilization summary; you
952908500d5f99f35afc5ed510391b9bdc3833farbb can see these variables during runtime by configuring
952908500d5f99f35afc5ed510391b9bdc3833farbb <code class="module"><a href="/mod/mod_status.html">mod_status</a></code>. Note that other modules may
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben rely on this scoreboard.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <p>This setting applies to the entire server, and cannot be
952908500d5f99f35afc5ed510391b9bdc3833farbb enabled or disabled on a virtualhost-by-virtualhost basis.
3d96ee83babeec32482c9082c9426340cee8c44dwrowe The collection of extended status information can slow down
952908500d5f99f35afc5ed510391b9bdc3833farbb the server. Also note that this setting cannot be changed
952908500d5f99f35afc5ed510391b9bdc3833farbb during a graceful restart.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <div class="note">
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>Note that loading <code class="module"><a href="/mod/mod_status.html">mod_status</a></code> will change
952908500d5f99f35afc5ed510391b9bdc3833farbb the default behavior to ExtendedStatus On, while other
952908500d5f99f35afc5ed510391b9bdc3833farbb third party modules may do the same. Such modules rely on
952908500d5f99f35afc5ed510391b9bdc3833farbb collecting detailed information about the state of all workers.
952908500d5f99f35afc5ed510391b9bdc3833farbb The default is changed by <code class="module"><a href="/mod/mod_status.html">mod_status</a></code> beginning
3d96ee83babeec32482c9082c9426340cee8c44dwrowe with version 2.3.6; the previous default was always Off.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding </div>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding</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="FileETag" id="FileETag">FileETag</a> <a name="fileetag" id="fileetag">Directive</a></h2>
952908500d5f99f35afc5ed510391b9bdc3833farbb<table class="directive">
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File attributes used to create the ETag
952908500d5f99f35afc5ed510391b9bdc3833farbbHTTP response header for static files</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>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<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>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <p>
952908500d5f99f35afc5ed510391b9bdc3833farbb The <code class="directive">FileETag</code> directive configures the file
952908500d5f99f35afc5ed510391b9bdc3833farbb attributes that are used to create the <code>ETag</code> (entity
952908500d5f99f35afc5ed510391b9bdc3833farbb tag) response header field when the document is based on a static file.
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben (The <code>ETag</code> value is used in cache management to save
952908500d5f99f35afc5ed510391b9bdc3833farbb network bandwidth.) The
3d96ee83babeec32482c9082c9426340cee8c44dwrowe <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>
952908500d5f99f35afc5ed510391b9bdc3833farbb <dt><strong>INode</strong></dt>
952908500d5f99f35afc5ed510391b9bdc3833farbb <dd>The file's i-node number will be included in the calculation</dd>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <dt><strong>MTime</strong></dt>
952908500d5f99f35afc5ed510391b9bdc3833farbb <dd>The date and time the file was last modified will be included</dd>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe <dt><strong>Size</strong></dt>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <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>
952908500d5f99f35afc5ed510391b9bdc3833farbb <dd>If a document is file-based, no <code>ETag</code> field will be
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben included in the response</dd>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh </dl>
952908500d5f99f35afc5ed510391b9bdc3833farbb
3d96ee83babeec32482c9082c9426340cee8c44dwrowe <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
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh from a broader scope. Any keyword appearing without such a prefix
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben immediately and completely cancels the inherited setting.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <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
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben any sub-subdirectories that don't override it) will be equivalent to
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <code>FileETag&nbsp;MTime&nbsp;Size</code>.</p>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <div class="warning"><h3>Warning</h3>
952908500d5f99f35afc5ed510391b9bdc3833farbb Do not change the default for directories or locations that have WebDAV
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh enabled and use <code class="module"><a href="/mod/mod_dav_fs.html">mod_dav_fs</a></code> as a storage provider.
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <code class="module"><a href="/mod/mod_dav_fs.html">mod_dav_fs</a></code> uses <code>INode&nbsp;MTime&nbsp;Size</code>
952908500d5f99f35afc5ed510391b9bdc3833farbb as a fixed format for <code>ETag</code> comparisons on conditional requests.
952908500d5f99f35afc5ed510391b9bdc3833farbb These conditional requests will break if the <code>ETag</code> format is
952908500d5f99f35afc5ed510391b9bdc3833farbb changed via <code class="directive">FileETag</code>.
952908500d5f99f35afc5ed510391b9bdc3833farbb </div>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <div class="note"><h3>Server Side Includes</h3>
952908500d5f99f35afc5ed510391b9bdc3833farbb An ETag is not generated for responses parsed by <code class="module"><a href="/mod/mod_include.html">mod_include</a></code>,
3d96ee83babeec32482c9082c9426340cee8c44dwrowe since the response entity can change without a change of the INode, MTime, or Size
952908500d5f99f35afc5ed510391b9bdc3833farbb of the static file with embedded SSI directives.
952908500d5f99f35afc5ed510391b9bdc3833farbb </div>
952908500d5f99f35afc5ed510391b9bdc3833farbb
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben
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>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe<table class="directive">
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<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>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<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>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb</table>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe <p>The <code class="directive">&lt;Files&gt;</code> directive
952908500d5f99f35afc5ed510391b9bdc3833farbb limits the scope of the enclosed directives by filename. It is comparable
952908500d5f99f35afc5ed510391b9bdc3833farbb to the <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code>
bf507cc1e6ad55303c3d436c6ca153f46c788be6sf and <code class="directive"><a href="#location">&lt;Location&gt;</a></code>
bf507cc1e6ad55303c3d436c6ca153f46c788be6sf directives. It should be matched with a <code>&lt;/Files&gt;</code>
bf507cc1e6ad55303c3d436c6ca153f46c788be6sf directive. The directives given within this section will be applied to
bf507cc1e6ad55303c3d436c6ca153f46c788be6sf any object with a basename (last component of filename) matching the
bf507cc1e6ad55303c3d436c6ca153f46c788be6sf specified filename. <code class="directive">&lt;Files&gt;</code>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben 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
3d96ee83babeec32482c9082c9426340cee8c44dwrowe inside <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code> sections to restrict the
2d2eda71267231c2526be701fe655db125852c1ffielding 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.
952908500d5f99f35afc5ed510391b9bdc3833farbb <a class="glossarylink" href="/glossary.html#regex" title="see glossary">Regular expressions</a>
952908500d5f99f35afc5ed510391b9bdc3833farbb can also be used, with the addition of the
952908500d5f99f35afc5ed510391b9bdc3833farbb <code>~</code> character. For example:</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <div class="example"><p><code>
aecb17a45c6d3ee4729ed5f68dc4270f211ee7a8fielding &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
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <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>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb<h3>See also</h3>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe<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>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben</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">
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Contains directives that apply to regular-expression matched
3d96ee83babeec32482c9082c9426340cee8c44dwrowefilenames</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<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>
971ced4989415d939afba8d70c82a9ce0113bceend<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>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb</table>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <p>The <code class="directive">&lt;FilesMatch&gt;</code> directive
971ced4989415d939afba8d70c82a9ce0113bceend 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
971ced4989415d939afba8d70c82a9ce0113bceend does. However, it accepts a <a class="glossarylink" href="/glossary.html#regex" title="see glossary">regular
952908500d5f99f35afc5ed510391b9bdc3833farbb expression</a>. For example:</p>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe
952908500d5f99f35afc5ed510391b9bdc3833farbb <div class="example"><p><code>
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;FilesMatch "\.(gif|jpe?g|png)$"&gt;
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben </code></p></div>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>would match most common Internet graphics formats.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb<h3>See also</h3>
952908500d5f99f35afc5ed510391b9bdc3833farbb<ul>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe<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>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben</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
3d96ee83babeec32482c9082c9426340cee8c44dwrowemedia type in the HTTP Content-Type header field</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ForceType <var>media-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>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Moved to the core in Apache httpd 2.0</td></tr>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe</table>
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>When placed into an <code>.htaccess</code> file or a
fb8ee8b7a3a2503b95bf47685f9083e0b9834e6fminfrin <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code>, or
fb8ee8b7a3a2503b95bf47685f9083e0b9834e6fminfrin <code class="directive"><a href="#location">&lt;Location&gt;</a></code> or
fb8ee8b7a3a2503b95bf47685f9083e0b9834e6fminfrin <code class="directive"><a href="#files">&lt;Files&gt;</a></code>
fb8ee8b7a3a2503b95bf47685f9083e0b9834e6fminfrin section, this directive forces all matching files to be served
fb8ee8b7a3a2503b95bf47685f9083e0b9834e6fminfrin with the content type identification given by
fb8ee8b7a3a2503b95bf47685f9083e0b9834e6fminfrin <var>media-type</var>. For example, if you had a directory full of
fb8ee8b7a3a2503b95bf47685f9083e0b9834e6fminfrin GIF files, but did not want to label them all with <code>.gif</code>,
952908500d5f99f35afc5ed510391b9bdc3833farbb you might want to use:</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
8419e6f8bff1a3617933f3ba760d2bdec7442f44coar <div class="example"><p><code>
952908500d5f99f35afc5ed510391b9bdc3833farbb ForceType image/gif
952908500d5f99f35afc5ed510391b9bdc3833farbb </code></p></div>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <p>Note that this directive overrides other indirect media type
8419e6f8bff1a3617933f3ba760d2bdec7442f44coar associations defined in mime.types or via the
8419e6f8bff1a3617933f3ba760d2bdec7442f44coar <code class="directive"><a href="/mod/mod_mime.html#addtype">AddType</a></code>.</p>
8419e6f8bff1a3617933f3ba760d2bdec7442f44coar
8419e6f8bff1a3617933f3ba760d2bdec7442f44coar <p>You can also override more general
8419e6f8bff1a3617933f3ba760d2bdec7442f44coar <code class="directive">ForceType</code> settings
8419e6f8bff1a3617933f3ba760d2bdec7442f44coar by using the value of <code>None</code>:</p>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
952908500d5f99f35afc5ed510391b9bdc3833farbb <div class="example"><p><code>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben # force all files to be image/gif:<br />
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben &lt;Location /images&gt;<br />
952908500d5f99f35afc5ed510391b9bdc3833farbb <span class="indent">
3d96ee83babeec32482c9082c9426340cee8c44dwrowe ForceType image/gif<br />
952908500d5f99f35afc5ed510391b9bdc3833farbb </span>
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;/Location&gt;<br />
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <br />
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben # but normal mime-type associations here:<br />
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;Location /images/mixed&gt;<br />
952908500d5f99f35afc5ed510391b9bdc3833farbb <span class="indent">
3d96ee83babeec32482c9082c9426340cee8c44dwrowe ForceType None<br />
952908500d5f99f35afc5ed510391b9bdc3833farbb </span>
952908500d5f99f35afc5ed510391b9bdc3833farbb &lt;/Location&gt;
952908500d5f99f35afc5ed510391b9bdc3833farbb </code></p></div>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>This directive primarily overrides the content types generated for
952908500d5f99f35afc5ed510391b9bdc3833farbb static files served out of the filesystem. For resources other than
952908500d5f99f35afc5ed510391b9bdc3833farbb static files, where the generator of the response typically specifies
3d96ee83babeec32482c9082c9426340cee8c44dwrowe a Content-Type, this directive has no effect.</p>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
fb8ee8b7a3a2503b95bf47685f9083e0b9834e6fminfrin
fb8ee8b7a3a2503b95bf47685f9083e0b9834e6fminfrin</div>
fb8ee8b7a3a2503b95bf47685f9083e0b9834e6fminfrin<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
fb8ee8b7a3a2503b95bf47685f9083e0b9834e6fminfrin<div class="directive-section"><h2><a name="GprofDir" id="GprofDir">GprofDir</a> <a name="gprofdir" id="gprofdir">Directive</a></h2>
fb8ee8b7a3a2503b95bf47685f9083e0b9834e6fminfrin<table class="directive">
fb8ee8b7a3a2503b95bf47685f9083e0b9834e6fminfrin<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Directory to write gmon.out profiling data to. </td></tr>
a5f529db7a87e3ac2e3c67b4ae009c1c094235d9minfrin<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>GprofDir <var>/tmp/gprof/</var>|<var>/tmp/gprof/</var>%</code></td></tr>
fb8ee8b7a3a2503b95bf47685f9083e0b9834e6fminfrin<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>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben</table>
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>When the server has been compiled with gprof profiling suppport,
952908500d5f99f35afc5ed510391b9bdc3833farbb <code class="directive">GprofDir</code> causes <code>gmon.out</code> files to
952908500d5f99f35afc5ed510391b9bdc3833farbb be written to the specified directory when the process exits. If the
952908500d5f99f35afc5ed510391b9bdc3833farbb argument ends with a percent symbol ('%'), subdirectories are created
952908500d5f99f35afc5ed510391b9bdc3833farbb for each process id.</p>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <p>This directive currently only works with the <code class="module"><a href="/mod/prefork.html">prefork</a></code>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh MPM.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
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="HostnameLookups" id="HostnameLookups">HostnameLookups</a> <a name="hostnamelookups" id="hostnamelookups">Directive</a></h2>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<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>
8c3667cd1d0db08647793137c0d1aa7f6526bebfniq<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
8c3667cd1d0db08647793137c0d1aa7f6526bebfniq<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
8c3667cd1d0db08647793137c0d1aa7f6526bebfniq<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
8c3667cd1d0db08647793137c0d1aa7f6526bebfniq</table>
8c3667cd1d0db08647793137c0d1aa7f6526bebfniq <p>This directive enables DNS lookups so that host names can be
c779aea0c9b7c47c2e4fd258e3f54835a849625dpoirier logged (and passed to CGIs/SSIs in <code>REMOTE_HOST</code>).
8c3667cd1d0db08647793137c0d1aa7f6526bebfniq The value <code>Double</code> refers to doing double-reverse
8c3667cd1d0db08647793137c0d1aa7f6526bebfniq DNS lookup. That is, after a reverse lookup is performed, a forward
8c3667cd1d0db08647793137c0d1aa7f6526bebfniq lookup is then performed on that result. At least one of the IP
952908500d5f99f35afc5ed510391b9bdc3833farbb addresses in the forward lookup must match the original
3de8d8649277a02f53aa4f06121420985e8eee08nd address. (In "tcpwrappers" terminology this is called
3de8d8649277a02f53aa4f06121420985e8eee08nd <code>PARANOID</code>.)</p>
3de8d8649277a02f53aa4f06121420985e8eee08nd
82acfa3f57607ae78326104c420a317260554a47nd <p>Regardless of the setting, when <code class="module"><a href="/mod/mod_authz_host.html">mod_authz_host</a></code> is
3de8d8649277a02f53aa4f06121420985e8eee08nd used for controlling access by hostname, a double reverse lookup
3de8d8649277a02f53aa4f06121420985e8eee08nd will be performed. This is necessary for security. Note that the
3de8d8649277a02f53aa4f06121420985e8eee08nd result of this double-reverse isn't generally available unless you
3de8d8649277a02f53aa4f06121420985e8eee08nd set <code>HostnameLookups Double</code>. For example, if only
82acfa3f57607ae78326104c420a317260554a47nd <code>HostnameLookups On</code> and a request is made to an object
82acfa3f57607ae78326104c420a317260554a47nd that is protected by hostname restrictions, regardless of whether
82acfa3f57607ae78326104c420a317260554a47nd the double-reverse fails or not, CGIs will still be passed the
82acfa3f57607ae78326104c420a317260554a47nd single-reverse result in <code>REMOTE_HOST</code>.</p>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
82acfa3f57607ae78326104c420a317260554a47nd <p>The default is <code>Off</code> in order to save the network
82acfa3f57607ae78326104c420a317260554a47nd traffic for those sites that don't truly need the reverse
82acfa3f57607ae78326104c420a317260554a47nd lookups done. It is also better for the end users because they
82acfa3f57607ae78326104c420a317260554a47nd don't have to suffer the extra latency that a lookup entails.
82acfa3f57607ae78326104c420a317260554a47nd Heavily loaded sites should leave this directive
952908500d5f99f35afc5ed510391b9bdc3833farbb <code>Off</code>, since DNS lookups can take considerable
952908500d5f99f35afc5ed510391b9bdc3833farbb amounts of time. The utility <code class="program"><a href="/programs/logresolve.html">logresolve</a></code>, compiled by
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben default to the <code>bin</code> subdirectory of your installation
952908500d5f99f35afc5ed510391b9bdc3833farbb directory, can be used to look up host names from logged IP addresses
952908500d5f99f35afc5ed510391b9bdc3833farbb offline.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb</div>
952908500d5f99f35afc5ed510391b9bdc3833farbb<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe<div class="directive-section"><h2><a name="If" id="If">&lt;If&gt;</a> <a name="if" id="if">Directive</a></h2>
dad234382d8424e1c5a30af2838e172aec9d6d1bdreid<table class="directive">
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Contains directives that apply only if a condition is
952908500d5f99f35afc5ed510391b9bdc3833farbbsatisfied by a request at runtime</td></tr>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;If <var>expression</var>&gt; ... &lt;/If&gt;</code></td></tr>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<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>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<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>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe</table>
2d2eda71267231c2526be701fe655db125852c1ffielding <p>The <code class="directive">&lt;If&gt;</code> directive
952908500d5f99f35afc5ed510391b9bdc3833farbb evaluates an expression at runtime, and applies the enclosed
952908500d5f99f35afc5ed510391b9bdc3833farbb directives if and only if the expression evaluates to true.
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben For example:</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
952908500d5f99f35afc5ed510391b9bdc3833farbb <div class="example"><p><code>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe &lt;If "$req{Host} = ''"&gt;
7c7372abe2484e7fcf81937b93496d1246e5b816gstein </code></p></div>
952908500d5f99f35afc5ed510391b9bdc3833farbb
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <p>would match HTTP/1.0 requests without a <var>Host:</var> header.</p>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <p>You may compare the value of any variable in the request headers
952908500d5f99f35afc5ed510391b9bdc3833farbb ($req), response headers ($resp) or environment ($env) in your
952908500d5f99f35afc5ed510391b9bdc3833farbb expression.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <p>Apart from <code>=</code>, <code>If</code> can use the <code>IN</code>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben operator to compare if the expression is in a given range:</p>
59ae852bea7d507f61999f982ded8219d2c0ec15wrowe
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <div class="example"><p><code>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe &lt;If %{REQUEST_METHOD} IN GET,HEAD,OPTIONS&gt;
7c7372abe2484e7fcf81937b93496d1246e5b816gstein </code></p></div>
952908500d5f99f35afc5ed510391b9bdc3833farbb
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<h3>See also</h3>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<ul>
952908500d5f99f35afc5ed510391b9bdc3833farbb<li><a href="/expr.html">Expressions in Apache HTTP Server</a>,
952908500d5f99f35afc5ed510391b9bdc3833farbbfor a complete reference and more examples.</li>
952908500d5f99f35afc5ed510391b9bdc3833farbb<li><a href="/sections.html">How &lt;Directory&gt;, &lt;Location&gt;,
3d96ee83babeec32482c9082c9426340cee8c44dwrowe &lt;Files&gt; sections work</a> for an explanation of how these
58619148951981bcfa5c506ad8ce745aa8831980rbb different sections are combined when a request is received.
58619148951981bcfa5c506ad8ce745aa8831980rbb <code class="directive">&lt;If&gt;</code> has the same precedence
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben and usage as <code class="directive">&lt;Files&gt;</code></li>
58619148951981bcfa5c506ad8ce745aa8831980rbb</ul>
58619148951981bcfa5c506ad8ce745aa8831980rbb</div>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
58619148951981bcfa5c506ad8ce745aa8831980rbb<div class="directive-section"><h2><a name="IfDefine" id="IfDefine">&lt;IfDefine&gt;</a> <a name="ifdefine" id="ifdefine">Directive</a></h2>
58619148951981bcfa5c506ad8ce745aa8831980rbb<table class="directive">
58619148951981bcfa5c506ad8ce745aa8831980rbb<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Encloses directives that will be processed only
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianhif a test is true at startup</td></tr>
3d72602d1d9e6f0d49d20f0d0a71831c160ef589wrowe<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;IfDefine [!]<var>parameter-name</var>&gt; ...
3d72602d1d9e6f0d49d20f0d0a71831c160ef589wrowe &lt;/IfDefine&gt;</code></td></tr>
58619148951981bcfa5c506ad8ce745aa8831980rbb<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe<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>
3d72602d1d9e6f0d49d20f0d0a71831c160ef589wrowe<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
3d72602d1d9e6f0d49d20f0d0a71831c160ef589wrowe</table>
3d72602d1d9e6f0d49d20f0d0a71831c160ef589wrowe <p>The <code>&lt;IfDefine <var>test</var>&gt;...&lt;/IfDefine&gt;
3d72602d1d9e6f0d49d20f0d0a71831c160ef589wrowe </code> section is used to mark directives that are conditional. The
4a13940dc2990df0a798718d3a3f9cf1566c2217bjh directives within an <code class="directive">&lt;IfDefine&gt;</code>
3d72602d1d9e6f0d49d20f0d0a71831c160ef589wrowe section are only processed if the <var>test</var> is true. If <var>
3d72602d1d9e6f0d49d20f0d0a71831c160ef589wrowe test</var> is false, everything between the start and end markers is
3d72602d1d9e6f0d49d20f0d0a71831c160ef589wrowe ignored.</p>
3d72602d1d9e6f0d49d20f0d0a71831c160ef589wrowe
3d72602d1d9e6f0d49d20f0d0a71831c160ef589wrowe <p>The <var>test</var> in the <code class="directive">&lt;IfDefine&gt;</code> section directive can be one of two forms:</p>
58619148951981bcfa5c506ad8ce745aa8831980rbb
58619148951981bcfa5c506ad8ce745aa8831980rbb <ul>
58619148951981bcfa5c506ad8ce745aa8831980rbb <li><var>parameter-name</var></li>
58619148951981bcfa5c506ad8ce745aa8831980rbb
58619148951981bcfa5c506ad8ce745aa8831980rbb <li><code>!</code><var>parameter-name</var></li>
58619148951981bcfa5c506ad8ce745aa8831980rbb </ul>
58619148951981bcfa5c506ad8ce745aa8831980rbb
3d96ee83babeec32482c9082c9426340cee8c44dwrowe <p>In the former case, the directives between the start and end
58619148951981bcfa5c506ad8ce745aa8831980rbb markers are only processed if the parameter named
58619148951981bcfa5c506ad8ce745aa8831980rbb <var>parameter-name</var> is defined. The second format reverses
58619148951981bcfa5c506ad8ce745aa8831980rbb the test, and only processes the directives if
58619148951981bcfa5c506ad8ce745aa8831980rbb <var>parameter-name</var> is <strong>not</strong> defined.</p>
92d6e181c597b97647d750c43a7bc3626e056b59gstein
58619148951981bcfa5c506ad8ce745aa8831980rbb <p>The <var>parameter-name</var> argument is a define as given on the
58619148951981bcfa5c506ad8ce745aa8831980rbb <code class="program"><a href="/programs/httpd.html">httpd</a></code> command line via <code>-D<var>parameter</var>
92d6e181c597b97647d750c43a7bc3626e056b59gstein </code> at the time the server was started or by the <code class="directive"><a href="#define">Define</a></code> directive.</p>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
58619148951981bcfa5c506ad8ce745aa8831980rbb <p><code class="directive">&lt;IfDefine&gt;</code> sections are
58619148951981bcfa5c506ad8ce745aa8831980rbb nest-able, which can be used to implement simple
58619148951981bcfa5c506ad8ce745aa8831980rbb multiple-parameter tests. Example:</p>
58619148951981bcfa5c506ad8ce745aa8831980rbb
92d6e181c597b97647d750c43a7bc3626e056b59gstein <div class="example"><p><code>
58619148951981bcfa5c506ad8ce745aa8831980rbb httpd -DReverseProxy -DUseCache -DMemCache ...<br />
58619148951981bcfa5c506ad8ce745aa8831980rbb <br />
92d6e181c597b97647d750c43a7bc3626e056b59gstein # httpd.conf<br />
58619148951981bcfa5c506ad8ce745aa8831980rbb &lt;IfDefine ReverseProxy&gt;<br />
58619148951981bcfa5c506ad8ce745aa8831980rbb <span class="indent">
58619148951981bcfa5c506ad8ce745aa8831980rbb LoadModule proxy_module modules/mod_proxy.so<br />
58619148951981bcfa5c506ad8ce745aa8831980rbb LoadModule proxy_http_module modules/mod_proxy_http.so<br />
58619148951981bcfa5c506ad8ce745aa8831980rbb &lt;IfDefine UseCache&gt;<br />
58619148951981bcfa5c506ad8ce745aa8831980rbb <span class="indent">
3e0494829cf6e8ac61e80fd82b1133111a52614cbrianp LoadModule cache_module modules/mod_cache.so<br />
58619148951981bcfa5c506ad8ce745aa8831980rbb &lt;IfDefine MemCache&gt;<br />
3d96ee83babeec32482c9082c9426340cee8c44dwrowe <span class="indent">
58619148951981bcfa5c506ad8ce745aa8831980rbb LoadModule mem_cache_module modules/mod_mem_cache.so<br />
30c095035b1d5910cc239a1384c816aef228beb5jim </span>
30c095035b1d5910cc239a1384c816aef228beb5jim &lt;/IfDefine&gt;<br />
30c095035b1d5910cc239a1384c816aef228beb5jim &lt;IfDefine !MemCache&gt;<br />
30c095035b1d5910cc239a1384c816aef228beb5jim <span class="indent">
30c095035b1d5910cc239a1384c816aef228beb5jim LoadModule cache_disk_module modules/mod_cache_disk.so<br />
30c095035b1d5910cc239a1384c816aef228beb5jim </span>
bdadc326446cae4a51bf75811fbe01a3a362df64gstein &lt;/IfDefine&gt;
bdadc326446cae4a51bf75811fbe01a3a362df64gstein </span>
30c095035b1d5910cc239a1384c816aef228beb5jim &lt;/IfDefine&gt;
58619148951981bcfa5c506ad8ce745aa8831980rbb </span>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben &lt;/IfDefine&gt;
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben </code></p></div>
58619148951981bcfa5c506ad8ce745aa8831980rbb
58619148951981bcfa5c506ad8ce745aa8831980rbb</div>
58619148951981bcfa5c506ad8ce745aa8831980rbb<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe<div class="directive-section"><h2><a name="IfModule" id="IfModule">&lt;IfModule&gt;</a> <a name="ifmodule" id="ifmodule">Directive</a></h2>
58619148951981bcfa5c506ad8ce745aa8831980rbb<table class="directive">
58619148951981bcfa5c506ad8ce745aa8831980rbb<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Encloses directives that are processed conditional on the
759f4a24d09e28c4eaca9f97311b497fc15cb5c7benpresence or absence of a specific module</td></tr>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;IfModule [!]<var>module-file</var>|<var>module-identifier</var>&gt; ...
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh &lt;/IfModule&gt;</code></td></tr>
58619148951981bcfa5c506ad8ce745aa8831980rbb<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
58619148951981bcfa5c506ad8ce745aa8831980rbb<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
58619148951981bcfa5c506ad8ce745aa8831980rbb<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
58619148951981bcfa5c506ad8ce745aa8831980rbb<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Module identifiers are available in version 2.1 and
e0cb33839fe1b103e960da9538156de474d290e2sflater.</td></tr>
e0cb33839fe1b103e960da9538156de474d290e2sf</table>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <p>The <code>&lt;IfModule <var>test</var>&gt;...&lt;/IfModule&gt;</code>
58619148951981bcfa5c506ad8ce745aa8831980rbb section is used to mark directives that are conditional on the presence of
58619148951981bcfa5c506ad8ce745aa8831980rbb a specific module. The directives within an <code class="directive">&lt;IfModule&gt;</code> section are only processed if the <var>test</var>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh is true. If <var>test</var> is false, everything between the start and
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh end markers is ignored.</p>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <p>The <var>test</var> in the <code class="directive">&lt;IfModule&gt;</code> section directive can be one of two forms:</p>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
58619148951981bcfa5c506ad8ce745aa8831980rbb <ul>
58619148951981bcfa5c506ad8ce745aa8831980rbb <li><var>module</var></li>
ef5650b61a8e35f3cc93ec07e73efc17ea329894jorton
ef5650b61a8e35f3cc93ec07e73efc17ea329894jorton <li>!<var>module</var></li>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh </ul>
58619148951981bcfa5c506ad8ce745aa8831980rbb
58619148951981bcfa5c506ad8ce745aa8831980rbb <p>In the former case, the directives between the start and end
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben markers are only processed if the module named <var>module</var>
58619148951981bcfa5c506ad8ce745aa8831980rbb is included in Apache httpd -- either compiled in or
e0cb33839fe1b103e960da9538156de474d290e2sf dynamically loaded using <code class="directive"><a href="/mod/mod_so.html#loadmodule">LoadModule</a></code>. The second format reverses the test,
e0cb33839fe1b103e960da9538156de474d290e2sf and only processes the directives if <var>module</var> is
58619148951981bcfa5c506ad8ce745aa8831980rbb <strong>not</strong> included.</p>
ef5650b61a8e35f3cc93ec07e73efc17ea329894jorton
58619148951981bcfa5c506ad8ce745aa8831980rbb <p>The <var>module</var> argument can be either the module identifier or
58619148951981bcfa5c506ad8ce745aa8831980rbb the file name of the module, at the time it was compiled. For example,
58619148951981bcfa5c506ad8ce745aa8831980rbb <code>rewrite_module</code> is the identifier and
58619148951981bcfa5c506ad8ce745aa8831980rbb <code>mod_rewrite.c</code> is the file name. If a module consists of
58619148951981bcfa5c506ad8ce745aa8831980rbb several source files, use the name of the file containing the string
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <code>STANDARD20_MODULE_STUFF</code>.</p>
58619148951981bcfa5c506ad8ce745aa8831980rbb
58619148951981bcfa5c506ad8ce745aa8831980rbb <p><code class="directive">&lt;IfModule&gt;</code> sections are
58619148951981bcfa5c506ad8ce745aa8831980rbb nest-able, which can be used to implement simple multiple-module
58619148951981bcfa5c506ad8ce745aa8831980rbb tests.</p>
58619148951981bcfa5c506ad8ce745aa8831980rbb
975bdabd8564af8a8bc075b5e70eb77af84793b6sf <div class="note">This section should only be used if you need to have one
58619148951981bcfa5c506ad8ce745aa8831980rbb configuration file that works whether or not a specific module
3d96ee83babeec32482c9082c9426340cee8c44dwrowe is available. In normal operation, directives need not be
ef5650b61a8e35f3cc93ec07e73efc17ea329894jorton placed in <code class="directive">&lt;IfModule&gt;</code>
2d2eda71267231c2526be701fe655db125852c1ffielding sections.</div>
58619148951981bcfa5c506ad8ce745aa8831980rbb
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben</div>
58619148951981bcfa5c506ad8ce745aa8831980rbb<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
58619148951981bcfa5c506ad8ce745aa8831980rbb<div class="directive-section"><h2><a name="Include" id="Include">Include</a> <a name="include" id="include">Directive</a></h2>
58619148951981bcfa5c506ad8ce745aa8831980rbb<table class="directive">
3d96ee83babeec32482c9082c9426340cee8c44dwrowe<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Includes other configuration files from within
7c7372abe2484e7fcf81937b93496d1246e5b816gsteinthe server configuration files</td></tr>
58619148951981bcfa5c506ad8ce745aa8831980rbb<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Include [<var>optional</var>|<var>strict</var>] <var>file-path</var>|<var>directory-path</var>|<var>wildcard</var></code></td></tr>
58619148951981bcfa5c506ad8ce745aa8831980rbb<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
58619148951981bcfa5c506ad8ce745aa8831980rbb<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
58619148951981bcfa5c506ad8ce745aa8831980rbb<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Wildcard matching available in 2.0.41 and later, directory
58619148951981bcfa5c506ad8ce745aa8831980rbbwildcard matching available in 2.3.6 and later</td></tr>
58619148951981bcfa5c506ad8ce745aa8831980rbb</table>
58619148951981bcfa5c506ad8ce745aa8831980rbb <p>This directive allows inclusion of other configuration files
58619148951981bcfa5c506ad8ce745aa8831980rbb from within the server configuration files.</p>
58619148951981bcfa5c506ad8ce745aa8831980rbb
58619148951981bcfa5c506ad8ce745aa8831980rbb <p>Shell-style (<code>fnmatch()</code>) wildcard characters can be used
58619148951981bcfa5c506ad8ce745aa8831980rbb in the filename or directory parts of the path to include several files
58619148951981bcfa5c506ad8ce745aa8831980rbb at once, in alphabetical order. In addition, if
aecb17a45c6d3ee4729ed5f68dc4270f211ee7a8fielding <code class="directive">Include</code> points to a directory, rather than a file,
58619148951981bcfa5c506ad8ce745aa8831980rbb Apache httpd will read all files in that directory and any subdirectory.
58619148951981bcfa5c506ad8ce745aa8831980rbb However, including entire directories is not recommended, because it is
58619148951981bcfa5c506ad8ce745aa8831980rbb easy to accidentally leave temporary files in a directory that can cause
58619148951981bcfa5c506ad8ce745aa8831980rbb <code class="program"><a href="/programs/httpd.html">httpd</a></code> to fail. Instead, we encourage you to use the
58619148951981bcfa5c506ad8ce745aa8831980rbb wildcard syntax shown below, to include files that match a particular
58619148951981bcfa5c506ad8ce745aa8831980rbb pattern, such as *.conf, for example.</p>
58619148951981bcfa5c506ad8ce745aa8831980rbb
58619148951981bcfa5c506ad8ce745aa8831980rbb <p>When a wildcard is specified for a <strong>file</strong> component of
aecb17a45c6d3ee4729ed5f68dc4270f211ee7a8fielding the path, and no file matches the wildcard, the
2d2eda71267231c2526be701fe655db125852c1ffielding <code class="directive"><a href="#include">Include</a></code>
58619148951981bcfa5c506ad8ce745aa8831980rbb directive will be <strong>silently ignored</strong>. When a wildcard is
c779aea0c9b7c47c2e4fd258e3f54835a849625dpoirier specified for a <strong>directory</strong> component of the path, and
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben no directory matches the wildcard, the
c779aea0c9b7c47c2e4fd258e3f54835a849625dpoirier <code class="directive"><a href="#include">Include</a></code> directive will
58619148951981bcfa5c506ad8ce745aa8831980rbb <strong>fail with an error</strong> saying the directory cannot be found.
58619148951981bcfa5c506ad8ce745aa8831980rbb </p>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe
2d2eda71267231c2526be701fe655db125852c1ffielding <p>For further control over the behaviour of the server when no files or
783334f576bfb7ef44623faf7af44a65cf13b9b4jim directories match, prefix the path with the modifiers <var>optional</var>
783334f576bfb7ef44623faf7af44a65cf13b9b4jim or <var>strict</var>. If <var>optional</var> is specified, any wildcard
783334f576bfb7ef44623faf7af44a65cf13b9b4jim file or directory that does not match will be silently ignored. If
783334f576bfb7ef44623faf7af44a65cf13b9b4jim <var>strict</var> is specified, any wildcard file or directory that does
783334f576bfb7ef44623faf7af44a65cf13b9b4jim not match at least one file will cause server startup to fail.</p>
783334f576bfb7ef44623faf7af44a65cf13b9b4jim
783334f576bfb7ef44623faf7af44a65cf13b9b4jim <p>When a directory or file component of the path is
783334f576bfb7ef44623faf7af44a65cf13b9b4jim specified exactly, and that directory or file does not exist,
783334f576bfb7ef44623faf7af44a65cf13b9b4jim <code class="directive"><a href="#include">Include</a></code> directive will fail with an
783334f576bfb7ef44623faf7af44a65cf13b9b4jim error saying the file or directory cannot be found.</p>
783334f576bfb7ef44623faf7af44a65cf13b9b4jim
783334f576bfb7ef44623faf7af44a65cf13b9b4jim <p>The file path specified may be an absolute path, or may be relative
783334f576bfb7ef44623faf7af44a65cf13b9b4jim to the <code class="directive"><a href="#serverroot">ServerRoot</a></code> directory.</p>
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem <p>Examples:</p>
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem <div class="example"><p><code>
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem Include /usr/local/apache2/conf/ssl.conf<br />
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem Include /usr/local/apache2/conf/vhosts/*.conf
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem </code></p></div>
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem <p>Or, providing paths relative to your <code class="directive"><a href="#serverroot">ServerRoot</a></code> directory:</p>
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem <div class="example"><p><code>
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem Include conf/ssl.conf<br />
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem Include conf/vhosts/*.conf
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem </code></p></div>
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem <p>Wildcards may be included in the directory or file portion of the
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem path. In the following example, the server will fail to load if no
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem directories match conf/vhosts/*, but will load successfully if no
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem files match *.conf.</p>
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem <div class="example"><p><code>
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem Include conf/vhosts/*/vhost.conf<br />
9257af3c6aaeaf201fccb3e3c87cf8c41783fdb7rpluem Include conf/vhosts/*/*.conf
7c66a25db06001672e6ec5485b69bc7f3c342753jim </code></p></div>
7c66a25db06001672e6ec5485b69bc7f3c342753jim
7c66a25db06001672e6ec5485b69bc7f3c342753jim <p>In this example, the server will fail to load if either
7c66a25db06001672e6ec5485b69bc7f3c342753jim conf/vhosts/* matches no directories, or if *.conf matches no files:</p>
7c66a25db06001672e6ec5485b69bc7f3c342753jim
7c66a25db06001672e6ec5485b69bc7f3c342753jim <div class="example"><p><code>
7c66a25db06001672e6ec5485b69bc7f3c342753jim Include strict conf/vhosts/*/*.conf
7c66a25db06001672e6ec5485b69bc7f3c342753jim </code></p></div>
b8055f3cb7e560830169cd1117a47b86abae41b4jim
dac0f846350698d2a3e65c814daf82721bafc502jim <p>In this example, the server load successfully if either conf/vhosts/*
dac0f846350698d2a3e65c814daf82721bafc502jim matches no directories, or if *.conf matches no files:</p>
b8055f3cb7e560830169cd1117a47b86abae41b4jim
b8055f3cb7e560830169cd1117a47b86abae41b4jim <div class="example"><p><code>
b8055f3cb7e560830169cd1117a47b86abae41b4jim Include optional conf/vhosts/*/*.conf
b8055f3cb7e560830169cd1117a47b86abae41b4jim </code></p></div>
b8055f3cb7e560830169cd1117a47b86abae41b4jim
b8055f3cb7e560830169cd1117a47b86abae41b4jim
b8055f3cb7e560830169cd1117a47b86abae41b4jim<h3>See also</h3>
dac0f846350698d2a3e65c814daf82721bafc502jim<ul>
b8055f3cb7e560830169cd1117a47b86abae41b4jim<li><code class="program"><a href="/programs/apachectl.html">apachectl</a></code></li>
b8055f3cb7e560830169cd1117a47b86abae41b4jim</ul>
dac0f846350698d2a3e65c814daf82721bafc502jim</div>
dac0f846350698d2a3e65c814daf82721bafc502jim<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
b8055f3cb7e560830169cd1117a47b86abae41b4jim<div class="directive-section"><h2><a name="KeepAlive" id="KeepAlive">KeepAlive</a> <a name="keepalive" id="keepalive">Directive</a></h2>
b8055f3cb7e560830169cd1117a47b86abae41b4jim<table class="directive">
b8055f3cb7e560830169cd1117a47b86abae41b4jim<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables HTTP persistent connections</td></tr>
b8055f3cb7e560830169cd1117a47b86abae41b4jim<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>KeepAlive On|Off</code></td></tr>
b8055f3cb7e560830169cd1117a47b86abae41b4jim<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>KeepAlive On</code></td></tr>
b8055f3cb7e560830169cd1117a47b86abae41b4jim<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
dac0f846350698d2a3e65c814daf82721bafc502jim<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
b8055f3cb7e560830169cd1117a47b86abae41b4jim<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding</table>
58619148951981bcfa5c506ad8ce745aa8831980rbb <p>The Keep-Alive extension to HTTP/1.0 and the persistent
58619148951981bcfa5c506ad8ce745aa8831980rbb connection feature of HTTP/1.1 provide long-lived HTTP sessions
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben which allow multiple requests to be sent over the same TCP
58619148951981bcfa5c506ad8ce745aa8831980rbb connection. In some cases this has been shown to result in an
58619148951981bcfa5c506ad8ce745aa8831980rbb almost 50% speedup in latency times for HTML documents with
30c095035b1d5910cc239a1384c816aef228beb5jim many images. To enable Keep-Alive connections, set
47ab8dcf8ad581569376f2e04ef16bc785bb122aake <code>KeepAlive On</code>.</p>
7c7372abe2484e7fcf81937b93496d1246e5b816gstein
30c095035b1d5910cc239a1384c816aef228beb5jim <p>For HTTP/1.0 clients, Keep-Alive connections will only be
30c095035b1d5910cc239a1384c816aef228beb5jim used if they are specifically requested by a client. In
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben addition, a Keep-Alive connection with an HTTP/1.0 client can
30c095035b1d5910cc239a1384c816aef228beb5jim only be used when the length of the content is known in
30c095035b1d5910cc239a1384c816aef228beb5jim advance. This implies that dynamic content such as CGI output,
58619148951981bcfa5c506ad8ce745aa8831980rbb SSI pages, and server-generated directory listings will
47ab8dcf8ad581569376f2e04ef16bc785bb122aake generally not use Keep-Alive connections to HTTP/1.0 clients.
2d2eda71267231c2526be701fe655db125852c1ffielding For HTTP/1.1 clients, persistent connections are the default
2d2eda71267231c2526be701fe655db125852c1ffielding unless otherwise specified. If the client requests it, chunked
2d2eda71267231c2526be701fe655db125852c1ffielding encoding will be used in order to send content of unknown
2d2eda71267231c2526be701fe655db125852c1ffielding length over persistent connections.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding
58619148951981bcfa5c506ad8ce745aa8831980rbb <p>When a client uses a Keep-Alive connection it will be counted
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben as a single "request" for the <code class="directive"><a href="/mod/mpm_common.html#maxconnectionsperchild">MaxConnectionsPerChild</a></code> directive, regardless
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben of how many requests are sent using the connection.</p>
58619148951981bcfa5c506ad8ce745aa8831980rbb
c861a36fe9c9a78c4fcb97e29fc1099a5ea81173rbb<h3>See also</h3>
58619148951981bcfa5c506ad8ce745aa8831980rbb<ul>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><code class="directive"><a href="#maxkeepaliverequests">MaxKeepAliveRequests</a></code></li>
58619148951981bcfa5c506ad8ce745aa8831980rbb</ul>
58619148951981bcfa5c506ad8ce745aa8831980rbb</div>
58619148951981bcfa5c506ad8ce745aa8831980rbb<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
58619148951981bcfa5c506ad8ce745aa8831980rbb<div class="directive-section"><h2><a name="KeepAliveTimeout" id="KeepAliveTimeout">KeepAliveTimeout</a> <a name="keepalivetimeout" id="keepalivetimeout">Directive</a></h2>
58619148951981bcfa5c506ad8ce745aa8831980rbb<table class="directive">
58619148951981bcfa5c506ad8ce745aa8831980rbb<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Amount of time the server will wait for subsequent
3d96ee83babeec32482c9082c9426340cee8c44dwrowerequests on a persistent connection</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>KeepAliveTimeout <var>num</var>[ms]</code></td></tr>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>KeepAliveTimeout 5</code></td></tr>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<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>Specifying a value in milliseconds is available in
2d2eda71267231c2526be701fe655db125852c1ffieldingApache httpd 2.3.2 and later</td></tr>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh</table>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <p>The number of seconds Apache httpd will wait for a subsequent
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh request before closing the connection. By adding a postfix of ms the
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh timeout can be also set in milliseconds. Once a request has been
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh received, the timeout value specified by the
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <code class="directive"><a href="#timeout">Timeout</a></code> directive applies.</p>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh
0186cb43574836fc95a0506456210c94cfc3ea6ftrawick <p>Setting <code class="directive">KeepAliveTimeout</code> to a high value
6e70165f24ec2e664764a9402e358eb0f6e99a3dtrawick may cause performance problems in heavily loaded servers. The
0186cb43574836fc95a0506456210c94cfc3ea6ftrawick higher the timeout, the more server processes will be kept
6e70165f24ec2e664764a9402e358eb0f6e99a3dtrawick occupied waiting on connections with idle clients.</p>
0186cb43574836fc95a0506456210c94cfc3ea6ftrawick
0186cb43574836fc95a0506456210c94cfc3ea6ftrawick <p>In a name-based virtual host context, the value of the first
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh defined virtual host best matching the local IP and port will be used.</p>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh</div>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
2d2eda71267231c2526be701fe655db125852c1ffielding<div class="directive-section"><h2><a name="Limit" id="Limit">&lt;Limit&gt;</a> <a name="limit" id="limit">Directive</a></h2>
2d2eda71267231c2526be701fe655db125852c1ffielding<table class="directive">
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Restrict enclosed access controls to only certain HTTP
2d2eda71267231c2526be701fe655db125852c1ffieldingmethods</td></tr>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;Limit <var>method</var> [<var>method</var>] ... &gt; ...
2d2eda71267231c2526be701fe655db125852c1ffielding &lt;/Limit&gt;</code></td></tr>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<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, Limit</td></tr>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<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>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh</table>
2d2eda71267231c2526be701fe655db125852c1ffielding <p>Access controls are normally effective for
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <strong>all</strong> access methods, and this is the usual
2d2eda71267231c2526be701fe655db125852c1ffielding desired behavior. <strong>In the general case, access control
2d2eda71267231c2526be701fe655db125852c1ffielding directives should not be placed within a
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <code class="directive">&lt;Limit&gt;</code> section.</strong></p>
2d2eda71267231c2526be701fe655db125852c1ffielding
2d2eda71267231c2526be701fe655db125852c1ffielding <p>The purpose of the <code class="directive">&lt;Limit&gt;</code>
2d2eda71267231c2526be701fe655db125852c1ffielding directive is to restrict the effect of the access controls to the
2d2eda71267231c2526be701fe655db125852c1ffielding nominated HTTP methods. For all other methods, the access
2d2eda71267231c2526be701fe655db125852c1ffielding restrictions that are enclosed in the <code class="directive">&lt;Limit&gt;</code> bracket <strong>will have no
2d2eda71267231c2526be701fe655db125852c1ffielding effect</strong>. The following example applies the access control
2d2eda71267231c2526be701fe655db125852c1ffielding only to the methods <code>POST</code>, <code>PUT</code>, and
2d2eda71267231c2526be701fe655db125852c1ffielding <code>DELETE</code>, leaving all other methods unprotected:</p>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh
9f9307bbe539dbcf96919715315eb64ce3465f5bben <div class="example"><p><code>
9f9307bbe539dbcf96919715315eb64ce3465f5bben &lt;Limit POST PUT DELETE&gt;<br />
9f9307bbe539dbcf96919715315eb64ce3465f5bben <span class="indent">
9f9307bbe539dbcf96919715315eb64ce3465f5bben Require valid-user<br />
9f9307bbe539dbcf96919715315eb64ce3465f5bben </span>
9f9307bbe539dbcf96919715315eb64ce3465f5bben &lt;/Limit&gt;
6a2bd1d848ec0984e2e675b8bb88cef8768d4a32bjh </code></p></div>
2d2eda71267231c2526be701fe655db125852c1ffielding
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <p>The method names listed can be one or more of: <code>GET</code>,
2d2eda71267231c2526be701fe655db125852c1ffielding <code>POST</code>, <code>PUT</code>, <code>DELETE</code>,
2d2eda71267231c2526be701fe655db125852c1ffielding <code>CONNECT</code>, <code>OPTIONS</code>,
2d2eda71267231c2526be701fe655db125852c1ffielding <code>PATCH</code>, <code>PROPFIND</code>, <code>PROPPATCH</code>,
2d2eda71267231c2526be701fe655db125852c1ffielding <code>MKCOL</code>, <code>COPY</code>, <code>MOVE</code>,
2d2eda71267231c2526be701fe655db125852c1ffielding <code>LOCK</code>, and <code>UNLOCK</code>. <strong>The method name is
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben case-sensitive.</strong> If <code>GET</code> is used it will also
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben restrict <code>HEAD</code> requests. The <code>TRACE</code> method
9521cafc02c2caafc8f9594006994ed1f62540a4dreid cannot be limited (see <code class="directive"><a href="#traceenable">TraceEnable</a></code>).</p>
18173b5033350759b5aa4f6d9a4fd9e12d440135trawick
18173b5033350759b5aa4f6d9a4fd9e12d440135trawick <div class="warning">A <code class="directive"><a href="#limitexcept">&lt;LimitExcept&gt;</a></code> section should always be
18173b5033350759b5aa4f6d9a4fd9e12d440135trawick used in preference to a <code class="directive">&lt;Limit&gt;</code>
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben section when restricting access, since a <code class="directive"><a href="#limitexcept">&lt;LimitExcept&gt;</a></code> section provides protection
18173b5033350759b5aa4f6d9a4fd9e12d440135trawick against arbitrary methods.</div>
18173b5033350759b5aa4f6d9a4fd9e12d440135trawick
84ba82304285b4bb1aafd5c6cdada5ce74c29973striker <p>The <code class="directive">&lt;Limit&gt;</code> and
84ba82304285b4bb1aafd5c6cdada5ce74c29973striker <code class="directive"><a href="#limitexcept">&lt;LimitExcept&gt;</a></code>
84ba82304285b4bb1aafd5c6cdada5ce74c29973striker directives may be nested. In this case, each successive level of
84ba82304285b4bb1aafd5c6cdada5ce74c29973striker <code class="directive">&lt;Limit&gt;</code> or <code class="directive"><a href="#limitexcept">&lt;LimitExcept&gt;</a></code> directives must
84ba82304285b4bb1aafd5c6cdada5ce74c29973striker further restrict the set of methods to which access controls apply.</p>
84ba82304285b4bb1aafd5c6cdada5ce74c29973striker
84ba82304285b4bb1aafd5c6cdada5ce74c29973striker <div class="warning">When using
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben <code class="directive">&lt;Limit&gt;</code> or
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben <code class="directive">&lt;LimitExcept&gt;</code> directives with
5f7c351eb2a69d8cef6c3e98e27ce6158a0b1780rbb the <code class="directive"><a href="/mod/mod_authz_core.html#require">Require</a></code> directive,
66d349e02d1a5a599a01c977d2c5b0009181f7deben note that the first <code class="directive"><a href="/mod/mod_authz_core.html#require">Require</a></code>
5f7c351eb2a69d8cef6c3e98e27ce6158a0b1780rbb to succeed authorizes the request, regardless of the presence of other
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben <code class="directive"><a href="/mod/mod_authz_core.html#require">Require</a></code> directives.</div>
dca927eafb338b9de9d0214818136c16d436e3fdrbb
dca927eafb338b9de9d0214818136c16d436e3fdrbb <p>For example, given the following configuration, all users will
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben be authorized for <code>POST</code> requests, and the
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben <code>Require group editors</code> directive will be ignored
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben in all cases:</p>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh
66d349e02d1a5a599a01c977d2c5b0009181f7deben <div class="example"><p><code>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh &lt;LimitExcept GET&gt;
66d349e02d1a5a599a01c977d2c5b0009181f7deben <span class="indent">
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh Require valid-user
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben </span>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh &lt;/LimitExcept&gt;<br />
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben &lt;Limit POST&gt;
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <span class="indent">
dca927eafb338b9de9d0214818136c16d436e3fdrbb Require group editors
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh </span>
dca927eafb338b9de9d0214818136c16d436e3fdrbb &lt;/Limit&gt;
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben </code></p></div>
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben
0a09a4a642f7c0d367598394411dbdd4a6d8cd09fielding</div>
55d986c77300fd39420b41f765b08c15b4c6418drbb<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
55d986c77300fd39420b41f765b08c15b4c6418drbb<div class="directive-section"><h2><a name="LimitExcept" id="LimitExcept">&lt;LimitExcept&gt;</a> <a name="limitexcept" id="limitexcept">Directive</a></h2>
2d2eda71267231c2526be701fe655db125852c1ffielding<table class="directive">
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Restrict access controls to all HTTP methods
2d2eda71267231c2526be701fe655db125852c1ffieldingexcept the named ones</td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;LimitExcept <var>method</var> [<var>method</var>] ... &gt; ...
2d2eda71267231c2526be701fe655db125852c1ffielding &lt;/LimitExcept&gt;</code></td></tr>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig, Limit</td></tr>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh</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 httpd 2.0.47 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 httpd'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. See the note below for the limited applicability
to proxy requests.</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 class="note"><p>For a full description of how this directive is interpreted by
proxy requests, see the <code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code> documentation.</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, 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><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 class="warning"><h3>Warning</h3>
<p> When name-based virtual hosting is used, the value for this
directive is taken from the default (first-listed) virtual host for the
local IP and port combination</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, 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>This directive specifies the number of <var>bytes</var>
that will be allowed in an HTTP request header.</p>
<p>The <code class="directive">LimitRequestFieldSize</code> directive
allows the server administrator to reduce or increase the limit
on the allowed size of an HTTP request header field. 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. SPNEGO
authentication headers can be up to 12392 bytes.</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 class="warning"><h3>Warning</h3>
<p> When name-based virtual hosting is used, the value for this
directive is taken from the default (first-listed) virtual host best
matching the current IP address and port combination.</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="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, 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>This directive sets the number of <var>bytes</var> that will be
allowed on the HTTP request-line.</p>
<p>The <code class="directive">LimitRequestLine</code> directive allows
the server administrator to reduce or increase the limit on the allowed size
of a client's HTTP request-line. 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 class="warning"><h3>Warning</h3>
<p> When name-based virtual hosting is used, the value for this
directive is taken from the default (first-listed) virtual host best
matching the current IP address and port combination.</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="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>
<p>The enclosed directives will be applied to the request if the path component
of the URL meets <em>any</em> of the following criteria:
</p>
<ul>
<li>The specified location matches exactly the path component of the URL.
</li>
<li>The specified location, which ends in a forward slash, is a prefix
of the path component of the URL (treated as a context root).
</li>
<li>The specified location, with the addition of a trailing slash, is a
prefix of the path component of the URL (also treated as a context root).
</li>
</ul>
<p>
In the example below, where no trailing slash is used, requests to
/private1, /private1/ and /private1/file.txt will have the enclosed
directives applied, but /private1other would not.
</p>
<div class="example"><p><code>
&lt;Location /private1&gt;
...
</code></p></div>
<p>
In the example below, where a trailing slash is used, requests to
/private2/ and /private2/file.txt will have the enclosed
directives applied, but /private2 and /private2other would not.
</p>
<div class="example"><p><code>
&lt;Location /private2<em>/</em>&gt;
...
</code></p></div>
<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>. <em>No scheme, hostname,
port, or query string may be included.</em> 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. Neither wildcard character matches a / in the URL-path.</p>
<p><a class="glossarylink" href="/glossary.html#regex" title="see glossary">Regular expressions</a>
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>, and is preferred, for the
simple reason that <code>~</code> is hard to distinguish from
<code>-</code> in many fonts.</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>example.com</code>, you might use:</p>
<div class="example"><p><code>
&lt;Location /status&gt;<br />
<span class="indent">
SetHandler server-status<br />
Require host example.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>
<li><code class="directive"><a href="#locationmatch">LocationMatch</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="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 <a class="glossarylink" href="/glossary.html#regex" title="see glossary">regular expression</a>
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>module</var>:]<var>level</var>
[<var>module</var>:<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, 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>
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Per-module and per-directory configuration is available in
Apache HTTP Server 2.3.6 and later</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>
<tr>
<td><code>trace1</code> </td>
<td>Trace messages</td>
<td>"proxy: FTP: control connection complete"</td>
</tr>
<tr>
<td><code>trace2</code> </td>
<td>Trace messages</td>
<td>"proxy: CONNECT: sending the CONNECT request to the remote proxy"</td>
</tr>
<tr>
<td><code>trace3</code> </td>
<td>Trace messages</td>
<td>"openssl: Handshake: start"</td>
</tr>
<tr>
<td><code>trace4</code> </td>
<td>Trace messages</td>
<td>"read from buffered SSL brigade, mode 0, 17 bytes"</td>
</tr>
<tr>
<td><code>trace5</code> </td>
<td>Trace messages</td>
<td>"map lookup FAILED: map=rewritemap key=keyname"</td>
</tr>
<tr>
<td><code>trace6</code> </td>
<td>Trace messages</td>
<td>"cache lookup FAILED, forcing new map lookup"</td>
</tr>
<tr>
<td><code>trace7</code> </td>
<td>Trace messages, dumping large amounts of data</td>
<td>"| 0000: 02 23 44 30 13 40 ac 34 df 3d bf 9a 19 49 39 15 |"</td>
</tr>
<tr>
<td><code>trace8</code> </td>
<td>Trace messages, dumping large amounts of data</td>
<td>"| 0000: 02 23 44 30 13 40 ac 34 df 3d bf 9a 19 49 39 15 |"</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 class="note"><h3>Note</h3>
<p>When logging to a regular file messages of the level
<code>notice</code> cannot be suppressed and thus are always
logged. However, this doesn't apply when logging is done
using <code>syslog</code>.</p>
</div>
<p>Specifying a level without a module name will reset the level
for all modules to that level. Specifying a level with a module
name will set the level for that module only. It is possible to
use the module source file name, the module identifier, or the
module identifier with the trailing <code>_module</code> omitted
as module specification. This means the following three specifications
are equivalent:</p>
<div class="example"><p><code>
LogLevel info ssl:warn<br />
LogLevel info mod_ssl.c:warn<br />
LogLevel info ssl_module:warn<br />
</code></p></div>
<p>It is also possible to change the level per directory:</p>
<div class="example"><p><code>
LogLevel info<br />
&lt;Directory /usr/local/apache/htdocs/app&gt;<br />
&nbsp; LogLevel debug<br />
&lt;/Files&gt;
</code></p></div>
<div class="note">
Per directory loglevel configuration only affects messages that are
logged after the request has been parsed and that are associated with
the request. Log messages which are associated with the connection or
the server are not affected.
</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="Mutex" id="Mutex">Mutex</a> <a name="mutex" id="mutex">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures mutex mechanism and lock file directory for all
or specified mutexes</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Mutex <var>mechanism</var> [default|<var>mutex-name</var>] ... [OmitPID]</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Mutex default</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>
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache HTTP Server 2.3.4 and later</td></tr>
</table>
<p>The <code class="directive">Mutex</code> directive sets the mechanism,
and optionally the lock file location, that httpd and modules use
to serialize access to resources. Specify <code>default</code> as
the first argument to change the settings for all mutexes; specify
a mutex name (see table below) as the first argument to override
defaults only for that mutex.</p>
<p>The <code class="directive">Mutex</code> directive is typically used in
the following exceptional situations:</p>
<ul>
<li>change the mutex mechanism when the default mechanism selected
by <a class="glossarylink" href="/glossary.html#apr" title="see glossary">APR</a> has a functional or performance
problem</li>
<li>change the directory used by file-based mutexes when the
default directory does not support locking</li>
</ul>
<div class="note"><h3>Supported modules</h3>
<p>This directive only configures mutexes which have been registered
with the core server using the <code>ap_mutex_register()</code> API.
All modules bundled with httpd support the <code class="directive">Mutex</code>
directive, but third-party modules may not. Consult the documentation
of the third-party module, which must indicate the mutex name(s) which
can be configured if this directive is supported.</p>
</div>
<p>The following mutex <em>mechanisms</em> are available:</p>
<ul>
<li><code>default | yes</code>
<p>This selects the default locking implementation, as determined by
<a class="glossarylink" href="/glossary.html#apr" title="see glossary">APR</a>. The default locking implementation can
be displayed by running <code class="program"><a href="/programs/httpd.html">httpd</a></code> with the
<code>-V</code> option.</p></li>
<li><code>none | no</code>
<p>This effectively disables the mutex, and is only allowed for a
mutex if the module indicates that it is a valid choice. Consult the
module documentation for more information.</p></li>
<li><code>posixsem</code>
<p>This is a mutex variant based on a Posix semaphore.</p>
<div class="warning"><h3>Warning</h3>
<p>The semaphore ownership is not recovered if a thread in the process
holding the mutex segfaults, resulting in a hang of the web server.</p>
</div>
</li>
<li><code>sysvsem</code>
<p>This is a mutex variant based on a SystemV IPC semaphore.</p>
<div class="warning"><h3>Warning</h3>
<p>It is possible to "leak" SysV semaphores if processes crash
before the semaphore is removed.</p>
</div>
<div class="warning"><h3>Security</h3>
<p>The semaphore API allows for a denial of service attack by any
CGIs running under the same uid as the webserver (<em>i.e.</em>,
all CGIs, unless you use something like <code class="program"><a href="/programs/suexec.html">suexec</a></code>
or <code>cgiwrapper</code>).</p>
</div>
</li>
<li><code>sem</code>
<p>This selects the "best" available semaphore implementation, choosing
between Posix and SystemV IPC semaphores, in that order.</p></li>
<li><code>pthread</code>
<p>This is a mutex variant based on cross-process Posix thread
mutexes.</p>
<div class="warning"><h3>Warning</h3>
<p>On most systems, if a child process terminates abnormally while
holding a mutex that uses this implementation, the server will deadlock
and stop responding to requests. When this occurs, the server will
require a manual restart to recover.</p>
<p>Solaris is a notable exception as it provides a mechanism which
usually allows the mutex to be recovered after a child process
terminates abnormally while holding a mutex.</p>
<p>If your system implements the
<code>pthread_mutexattr_setrobust_np()</code> function, you may be able
to use the <code>pthread</code> option safely.</p>
</div>
</li>
<li><code>fcntl:/path/to/mutex</code>
<p>This is a mutex variant where a physical (lock-)file and the
<code>fcntl()</code> function are used as the mutex.</p>
<div class="warning"><h3>Warning</h3>
<p>When multiple mutexes based on this mechanism are used within
multi-threaded, multi-process environments, deadlock errors (EDEADLK)
can be reported for valid mutex operations if <code>fcntl()</code>
is not thread-aware, such as on Solaris.</p>
</div>
</li>
<li><code>flock:/path/to/mutex</code>
<p>This is similar to the <code>fcntl:/path/to/mutex</code> method
with the exception that the <code>flock()</code> function is used to
provide file locking.</p></li>
<li><code>file:/path/to/mutex</code>
<p>This selects the "best" available file locking implementation,
choosing between <code>fcntl</code> and <code>flock</code>, in that
order.</p></li>
</ul>
<p>Most mechanisms are only available on selected platforms, where the
underlying platform and <a class="glossarylink" href="/glossary.html#apr" title="see glossary">APR</a> support it. Mechanisms
which aren't available on all platforms are <em>posixsem</em>,
<em>sysvsem</em>, <em>sem</em>, <em>pthread</em>, <em>fcntl</em>,
<em>flock</em>, and <em>file</em>.</p>
<p>With the file-based mechanisms <em>fcntl</em> and <em>flock</em>,
the path, if provided, is a directory where the lock file will be created.
The default directory is httpd's run-time file directory relative to
<code class="directive"><a href="#serverroot">ServerRoot</a></code>. Always use a local disk
filesystem for <code>/path/to/mutex</code> and never a directory residing
on a NFS- or AFS-filesystem. The basename of the file will be the mutex
type, an optional instance string provided by the module, and unless the
<code>OmitPID</code> keyword is specified, the process id of the httpd
parent process will be appended to to make the file name unique, avoiding
conflicts when multiple httpd instances share a lock file directory. For
example, if the mutex name is <code>mpm-accept</code> and the lock file
directory is <code>/var/httpd/locks</code>, the lock file name for the
httpd instance with parent process id 12345 would be
<code>/var/httpd/locks/mpm-accept.12345</code>.</p>
<div class="warning"><h3>Security</h3>
<p>It is best to <em>avoid</em> putting mutex files in a world-writable
directory such as <code>/var/tmp</code> because someone could create
a denial of service attack and prevent the server from starting by
creating a lockfile with the same name as the one the server will try
to create.</p>
</div>
<p>The following table documents the names of mutexes used by httpd
and bundled modules.</p>
<table class="bordered"><tr class="header">
<th>Mutex name</th>
<th>Module(s)</th>
<th>Protected resource</th>
</tr>
<tr>
<td><code>mpm-accept</code></td>
<td><code class="module"><a href="/mod/prefork.html">prefork</a></code> and <code class="module"><a href="/mod/worker.html">worker</a></code> MPMs</td>
<td>incoming connections, to avoid the thundering herd problem;
for more information, refer to the
<a href="/misc/perf-tuning.html">performance tuning</a>
documentation</td>
</tr>
<tr class="odd">
<td><code>authdigest-client</code></td>
<td><code class="module"><a href="/mod/mod_auth_digest.html">mod_auth_digest</a></code></td>
<td>client list in shared memory</td>
</tr>
<tr>
<td><code>authdigest-opaque</code></td>
<td><code class="module"><a href="/mod/mod_auth_digest.html">mod_auth_digest</a></code></td>
<td>counter in shared memory</td>
</tr>
<tr class="odd">
<td><code>ldap-cache</code></td>
<td><code class="module"><a href="/mod/mod_ldap.html">mod_ldap</a></code></td>
<td>LDAP result cache</td>
</tr>
<tr>
<td><code>rewrite-map</code></td>
<td><code class="module"><a href="/mod/mod_rewrite.html">mod_rewrite</a></code></td>
<td>communication with external mapping programs, to avoid
intermixed I/O from multiple requests</td>
</tr>
<tr class="odd">
<td><code>ssl-cache</code></td>
<td><code class="module"><a href="/mod/mod_ssl.html">mod_ssl</a></code></td>
<td>SSL session cache</td>
</tr>
<tr>
<td><code>ssl-stapling</code></td>
<td><code class="module"><a href="/mod/mod_ssl.html">mod_ssl</a></code></td>
<td>OCSP stapling response cache</td>
</tr>
<tr class="odd">
<td><code>watchdog-callback</code></td>
<td><code class="module"><a href="/mod/mod_watchdog.html">mod_watchdog</a></code></td>
<td>callback function of a particular client module</td>
</tr>
</table>
<p>The <code>OmitPID</code> keyword suppresses the addition of the httpd
parent process id from the lock file name.</p>
<p>In the following example, the mutex mechanism for the MPM accept
mutex will be changed from the compiled-in default to <code>fcntl</code>,
with the associated lock file created in directory
<code>/var/httpd/locks</code>. The mutex mechanism for all other mutexes
will be changed from the compiled-in default to <code>sysvsem</code>.</p>
<div class="example"><p><code>
Mutex default sysvsem<br />
Mutex mpm-accept fcntl:/var/httpd/locks
</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>Prior to 2.3.11, <code class="directive">NameVirtualHost</code> was required
to instruct the server that a particular IP address and port combination
was usable as a name-based virtual host. In 2.3.11 and later,
any time an IP address and port combination is used in multiple virtual
hosts, name-based virtual hosting is automatically enabled for that address.</p>
<p>This directive currently has no effect.</p>
<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 FollowSymlinks</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>
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>The default was changed from All to FollowSymlinks in 2.3.11</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>.</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. This is
the default setting.
<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>
<p>Omitting this option should not be considered a security restriction,
since symlink testing is subject to race conditions that make it
circumventable.</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_alias.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 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>.
<div class="note"><h3>Note</h3> <p>This option gets ignored if set
anywhere other than <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code>, as <code class="module"><a href="/mod/mod_negotiation.html">mod_negotiation</a></code>
needs real resources to compare against and evaluate from.</p></div>
</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> <p>This option gets ignored if
set inside a <code class="directive"><a href="#location">&lt;Location&gt;</a></code> section.</p>
<p>This option should not be considered a security restriction,
since symlink testing is subject to race conditions that make it
circumventable.</p></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>
<div class="note"><h3>Note</h3>
<p>Mixing <code class="directive">Options</code> with a <code>+</code> or
<code>-</code> with those without is not valid syntax, and will be
rejected during server startup by the syntax check with an abort.</p>
</div>
<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>FollowSymlinks</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="Protocol" id="Protocol">Protocol</a> <a name="protocol" id="protocol">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Protocol for a listening socket</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Protocol <var>protocol</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>Available in Apache 2.1.5 and later.
On Windows from Apache 2.3.3 and later.</td></tr>
</table>
<p>This directive specifies the protocol used for a specific listening socket.
The protocol is used to determine which module should handle a request, and
to apply protocol specific optimizations with the <code class="directive">AcceptFilter</code>
directive.</p>
<p>You only need to set the protocol if you are running on non-standard ports, otherwise <code>http</code> is assumed for port 80 and <code>https</code> for port 443.</p>
<p>For example, if you are running <code>https</code> on a non-standard port, specify the protocol explicitly:</p>
<div class="example"><p><code>
Protocol https
</code></p></div>
<p>You can also specify the protocol using the <code class="directive"><a href="/mod/mpm_common.html#listen">Listen</a></code> directive.</p>
<h3>See also</h3>
<ul>
<li><code class="directive">AcceptFilter</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="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 httpd 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 httpd children
servicing requests, not the Apache httpd children themselves. This
includes CGI scripts and SSI exec commands, but not any
processes forked off from the Apache httpd 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 httpd 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 httpd children
servicing requests, not the Apache httpd children themselves. This
includes CGI scripts and SSI exec commands, but not any
processes forked off from the Apache httpd 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 httpd 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 httpd children
servicing requests, not the Apache httpd children themselves. This
includes CGI scripts and SSI exec commands, but not any
processes forked off from the Apache httpd 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 user ids other than the web server user id, 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="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;
option <code>Registry-Strict</code> is available in Apache HTTP Server 2.0 and
later</td></tr>
</table>
<p>This directive is used to control how Apache httpd finds the
interpreter used to run CGI scripts. The default setting is
<code>Script</code>. This causes Apache httpd to use the interpreter pointed to
by the shebang line (first line, starting with <code>#!</code>) in the
script. On Win32 systems this line usually looks like:</p>
<div class="example"><p><code>
#!C:/Perl/bin/perl.exe
</code></p></div>
<p>or, if <code>perl</code> is in the <code>PATH</code>, simply:</p>
<div class="example"><p><code>
#!perl
</code></p></div>
<p>Setting <code>ScriptInterpreterSource Registry</code> will
cause the Windows Registry tree <code>HKEY_CLASSES_ROOT</code> to be
searched using the script file extension (e.g., <code>.pl</code>) as a
search key. The command defined by the registry subkey
<code>Shell\ExecCGI\Command</code> or, if it does not exist, by the subkey
<code>Shell\Open\Command</code> is used to open the script file. If the
registry keys cannot be found, Apache httpd falls back to the behavior of the
<code>Script</code> option.</p>
<div class="warning"><h3>Security</h3>
<p>Be careful when using <code>ScriptInterpreterSource
Registry</code> with <code class="directive"><a href="/mod/mod_alias.html#scriptalias">ScriptAlias</a></code>'ed directories, because
Apache httpd will try to execute <strong>every</strong> file within this
directory. The <code>Registry</code> setting may cause undesired
program calls on files which are typically not executed. For
example, the default open command on <code>.htm</code> files on
most Windows systems will execute Microsoft Internet Explorer, so
any HTTP request for an <code>.htm</code> file existing within the
script directory would start the browser in the background on the
server. This is a good way to crash your system within a minute or
so.</p>
</div>
<p>The option <code>Registry-Strict</code> which is new in Apache HTTP Server
2.0 does the same thing as <code>Registry</code> but uses only the
subkey <code>Shell\ExecCGI\Command</code>. The
<code>ExecCGI</code> key is not a common one. It must be
configured manually in the windows registry and hence prevents
accidental program calls on your system.</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="SeeRequestTail" id="SeeRequestTail">SeeRequestTail</a> <a name="seerequesttail" id="seerequesttail">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Determine if mod_status displays the first 63 characters
of a request or the last 63, assuming the request itself is greater than
63 chars.</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SeeRequestTail On|Off</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SeeRequestTail Off</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>
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache httpd 2.2.7 and later.</td></tr>
</table>
<p>mod_status with <code>ExtendedStatus On</code>
displays the actual request being handled.
For historical purposes, only 63 characters of the request
are actually stored for display purposes. This directive
controls whether the 1st 63 characters are stored (the previous
behavior and the default) or if the last 63 characters are. This
is only applicable, of course, if the length of the request is
64 characters or greater.</p>
<p>If Apache httpd is handling <code>GET&nbsp;/disk1/storage/apache/htdocs/images/imagestore1/food/apples.jpg&nbsp;HTTP/1.1</code> mod_status displays as follows:
</p>
<table class="bordered">
<tr>
<th>Off (default)</th>
<td>GET&nbsp;/disk1/storage/apache/htdocs/images/imagestore1/food/apples</td>
</tr>
<tr>
<th>On</th>
<td>orage/apache/htdocs/images/imagestore1/food/apples.jpg&nbsp;HTTP/1.1</td>
</tr>
</table>
</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>|<var>URL</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 contact address
that the server includes in any error messages it returns to the
client. If the <code>httpd</code> doesn't recognize the supplied argument
as an URL, it
assumes, that it's an <var>email-address</var> and prepends it with
<code>mailto:</code> in hyperlink targets. However, it's recommended to
actually use an email address, since there are a lot of CGI scripts that
make that assumption. If you want to use an URL, it should point to another
server under your control. Otherwise users may not be able to contact you in
case of errors.</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>. The
<code class="directive">ServerAlias</code> may include wildcards, if appropriate.</p>
<div class="example"><p><code>
&lt;VirtualHost *:80&gt;<br />
ServerName server.example.com<br />
ServerAlias server server2.example.com server2<br />
ServerAlias *.example.com<br />
UseCanonicalName Off<br />
# ...<br />
&lt;/VirtualHost&gt;
</code></p></div>
<h3>See also</h3>
<ul>
<li><code class="directive"><a href="#usecanonicalname">UseCanonicalName</a></code></li>
<li><a href="/vhosts/">Apache HTTP Server 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>scheme</var>://]<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>
</table>
<p>The <code class="directive">ServerName</code> directive sets the
request scheme, hostname and
port that the server uses to identify itself. This is used when
creating redirection URLs.</p>
<p>Additionally, <code class="directive">ServerName</code> is used (possibly
in conjunction with <code class="directive">ServerAlias</code>) to uniquely
identify a virtual host, when using <a href="/vhosts/name-based.html">name-based virtual hosts</a>.</p>
<p>For example, if the name of the
machine hosting the web server is <code>simple.example.com</code>,
but the machine also has the DNS alias <code>www.example.com</code>
and you wish the web server to be so identified, the following
directive should be used:</p>
<div class="example"><p><code>
ServerName www.example.com
</code></p></div>
<p>The <code class="directive">ServerName</code> directive
may appear anywhere within the definition of a server. However,
each appearance overrides the previous appearance (within that
server).</p>
<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
<code class="directive">ServerName</code>, 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>Sometimes, the server runs behind a device that processes SSL,
such as a reverse proxy, load balancer or SSL offload
appliance. When this is the case, specify the
<code>https://</code> scheme and the port number to which the
clients connect in the <code class="directive">ServerName</code> directive
to make sure that the server generates the correct
self-referential URLs.
</p>
<p>See the description of the
<code class="directive"><a href="#usecanonicalname">UseCanonicalName</a></code> and
<code class="directive"><a href="#usecanonicalphysicalport">UseCanonicalPhysicalPort</a></code> directives for
settings which determine whether self-referential URLs (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>
<div class="warning">
<p>Failure to set <code class="directive">ServerName</code> to a name that
your server can resolve to an IP address will result in a startup
warning. <code>httpd</code> will then use whatever hostname it can
determine, using the system's <code>hostname</code> command. This
will almost never be the hostname you actually want.</p>
<div class="example"><p><code>
httpd: Could not reliably determine the server's fully qualified domain name, using rocinante.local for ServerName
</code></p></div>
</div>
<h3>See also</h3>
<ul>
<li><a href="/dns-caveats.html">Issues Regarding DNS and
Apache HTTP Server</a></li>
<li><a href="/vhosts/">Apache HTTP Server virtual host
documentation</a></li>
<li><code class="directive"><a href="#usecanonicalname">UseCanonicalName</a></code></li>
<li><code class="directive"><a href="#usecanonicalphysicalport">UseCanonicalPhysicalPort</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 HTTP Server 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 in other configuration directives (such as <code class="directive"><a href="#include">Include</a></code> or <code class="directive"><a href="/mod/mod_so.html#loadmodule">LoadModule</a></code>, for example) 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 <code>Server</code> 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 Full</code> (or not specified)</dt>
<dd>Server sends (<em>e.g.</em>): <code>Server: Apache/2.4.1
(Unix) PHP/4.2.2 MyMod/1.2</code></dd>
<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.4</code></dd>
<dt><code>ServerTokens Min[imal]</code></dt>
<dd>Server sends (<em>e.g.</em>): <code>Server:
Apache/2.4.1</code></dd>
<dt><code>ServerTokens OS</code></dt>
<dd>Server sends (<em>e.g.</em>): <code>Server: Apache/2.4.1
(Unix)</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>
<div class="note">Setting <code class="directive">ServerTokens</code> to less than
<code>minimal</code> is not recommended because it makes it more
difficult to debug interoperational problems. Also note that
disabling the Server: header does nothing at all to make your
server more secure; the idea of "security through obscurity"
is a myth and leads to a false sense of safety.</div>
<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 httpd 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>
<p><strong>Note:</strong> because SetHandler overrides default handlers,
normal behaviour such as handling of URLs ending in a slash (/) as
directories or index files is suppressed.</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, 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">TimeOut</code> directive defines the length
of time Apache httpd will wait for I/O in various circumstances:</p>
<ol>
<li>When reading data from the client, the length of time to
wait for a TCP packet to arrive if the read buffer is
empty.</li>
<li>When writing data to the client, the length of time to wait
for an acknowledgement of a packet if the send buffer is
full.</li>
<li>In <code class="module"><a href="/mod/mod_cgi.html">mod_cgi</a></code>, the length of time to wait for
output from a CGI script.</li>
<li>In <code class="module"><a href="/mod/mod_ext_filter.html">mod_ext_filter</a></code>, the length of time to
wait for output from a filtering process.</li>
<li>In <code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code>, the default timeout value if
<code class="directive"><a href="/mod/mod_proxy.html#proxytimeout">ProxyTimeout</a></code> is not
configured.</li>
</ol>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="TraceEnable" id="TraceEnable">TraceEnable</a> <a name="traceenable" id="traceenable">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Determines the behaviour on <code>TRACE</code> requests</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>TraceEnable <var>[on|off|extended]</var></code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>TraceEnable on</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>
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache HTTP Server 1.3.34, 2.0.55 and later</td></tr>
</table>
<p>This directive overrides the behavior of <code>TRACE</code> for both
the core server and <code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code>. The default
<code>TraceEnable on</code> permits <code>TRACE</code> requests per
RFC 2616, which disallows any request body to accompany the request.
<code>TraceEnable off</code> causes the core server and
<code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code> to return a <code>405</code> (Method not
allowed) error to the client.</p>
<p>Finally, for testing and diagnostic purposes only, request
bodies may be allowed using the non-compliant <code>TraceEnable
extended</code> directive. The core (as an origin server) will
restrict the request body to 64k (plus 8k for chunk headers if
<code>Transfer-Encoding: chunked</code> is used). The core will
reflect the full headers and all chunk headers with the response
body. As a proxy server, the request body is not restricted to 64k.</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="UnDefine" id="UnDefine">UnDefine</a> <a name="undefine" id="undefine">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Undefine the existence of a variable</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>UnDefine <var>parameter-name</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>Undoes the effect of a <code class="directive"><a href="#define">Define</a></code> or
of passing a <code>-D</code> argument to <code class="program"><a href="/programs/httpd.html">httpd</a></code>.</p>
<p>This directive can be used to toggle the use of <code class="directive"><a href="#ifdefine">&lt;IfDefine&gt;</a></code> sections without needing to alter
<code>-D</code> arguments in any startup scripts.</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 Off</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 httpd 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 httpd 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 httpd 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 httpd will redirect them to
<code>http://www.example.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.example.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 httpd 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 httpd 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="#usecanonicalphysicalport">UseCanonicalPhysicalPort</a></code></li>
<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="UseCanonicalPhysicalPort" id="UseCanonicalPhysicalPort">UseCanonicalPhysicalPort</a> <a name="usecanonicalphysicalport" id="usecanonicalphysicalport">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>UseCanonicalPhysicalPort On|Off</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>UseCanonicalPhysicalPort Off</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 httpd must construct a <em>self-referential</em>
URL -- that is, a URL that refers back to the same server. With
<code>UseCanonicalPhysicalPort On</code> Apache httpd will, when
constructing the canonical port for the server to honor
the <code class="directive"><a href="#usecanonicalname">UseCanonicalName</a></code> directive,
provide the actual physical port number being used by this request
as a potential port. With <code>UseCanonicalPhysicalPort Off</code>
Apache httpd will not ever use the actual physical port number, instead
relying on all configured information to construct a valid port number.</p>
<div class="note"><h3>Note</h3>
<p>The ordering of when the physical port is used is as follows:<br /><br />
<code>UseCanonicalName On</code></p>
<ul>
<li>Port provided in <code>Servername</code></li>
<li>Physical port</li>
<li>Default port</li>
</ul>
<code>UseCanonicalName Off | DNS</code>
<ul>
<li>Parsed port from <code>Host:</code> header</li>
<li>Physical port</li>
<li>Port provided in <code>Servername</code></li>
<li>Default port</li>
</ul>
<p>With <code>UseCanonicalPhysicalPort Off</code>, the
physical ports are removed from the ordering.</p>
</div>
<h3>See also</h3>
<ul>
<li><code class="directive"><a href="#usecanonicalname">UseCanonicalName</a></code></li>
<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 any of the following, optionally followed by
a colon and a port number (or *):</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 (not recommended);</li>
<li>The character <code>*</code>, which acts as a wildcard and matches
any IP address.</li>
<li>The string <code>_default_</code>, which is an alias for <code>*</code></li>
</ul>
<div class="example"><h3>Example</h3><p><code>
&lt;VirtualHost 10.1.2.3:80&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>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 [2001:db8::a00:20ff:fea7:ccea]:80&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 httpd listens on. You
may need to ensure that Apache httpd is listening on the correct addresses
using <code class="directive"><a href="/mod/mpm_common.html#listen">Listen</a></code>.</p>
</div>
<p>A <code class="directive"><a href="#servername">ServerName</a></code> should be
specified inside each <code class="directive">&lt;VirtualHost&gt;</code> block. If it is absent, the
<code class="directive"><a href="#servername">ServerName</a></code> from the "main"
server configuration will be inherited.</p>
<p>When a request is received, the server first maps it to the best matching
<code class="directive">&lt;VirtualHost&gt;</code> based on the local
IP address and port combination only. Non-wildcards have a higher
precedence. if no match based on IP and port occurs at all, the
"main" server configuration is used.</p>
<p>If multiple virtual hosts contain the best matching IP address and port,
the server selects from these virtual hosts the best match based on the
requested hostname. If no matching name-based virtual host is found,
then the first listed virtual host that matched the IP address will be
used. As a consequence, the first listed virtual for a given IP address
and port combination is default virtual host for that IP and port
combination.</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 log files 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 HTTP Server Virtual Host documentation</a></li>
<li><a href="/dns-caveats.html">Issues Regarding DNS and
Apache HTTP Server</a></li>
<li><a href="/bind.html">Setting
which addresses and ports Apache HTTP Server 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" rel="alternate" title="Deutsch">&nbsp;de&nbsp;</a> |
<a href="/en/mod/core.html" title="English">&nbsp;en&nbsp;</a> |
<a href="/es/mod/core.html" hreflang="es" rel="alternate" title="Espa�ol">&nbsp;es&nbsp;</a> |
<a href="/fr/mod/core.html" hreflang="fr" rel="alternate" title="Fran�ais">&nbsp;fr&nbsp;</a> |
<a href="/ja/mod/core.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
<a href="/tr/mod/core.html" hreflang="tr" rel="alternate" title="T�rk�e">&nbsp;tr&nbsp;</a></p>
</div><div id="footer">
<p class="apache">Copyright 2010 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/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>