core.html.en revision db682a46f5cc4672f043df7dcdadb5b165749f77
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<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>
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>
0432a26b69eedfb9ca5f34fba590236378a24851ben<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.3</a> > <a href="./">Modules</a></div>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<p><span>Available Languages: </span><a href="/de/mod/core.html" hreflang="de" rel="alternate" title="Deutsch"> de </a> |
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<a href="/en/mod/core.html" title="English"> en </a> |
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<a href="/es/mod/core.html" hreflang="es" rel="alternate" title="Espa�ol"> es </a> |
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<a href="/fr/mod/core.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a> |
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<a href="/ja/mod/core.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<a href="/tr/mod/core.html" hreflang="tr" rel="alternate" title="T�rk�e"> tr </a></p>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Core Apache HTTP Server features that are always
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Core</td></tr></table>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<div id="quickview"><h3 class="directives">Directives</h3>
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"><Directory></a></li>
a261b81a1044c0e2ea3f21cf9b7019297bad16aajorton<li><img alt="" src="/images/down.gif" /> <a href="#directorymatch"><DirectoryMatch></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"><Files></a></li>
9cfc48b742c224c1fbc2c26a4119a3266192c7d2wrowe<li><img alt="" src="/images/down.gif" /> <a href="#filesmatch"><FilesMatch></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"><If></a></li>
a261b81a1044c0e2ea3f21cf9b7019297bad16aajorton<li><img alt="" src="/images/down.gif" /> <a href="#ifdefine"><IfDefine></a></li>
a261b81a1044c0e2ea3f21cf9b7019297bad16aajorton<li><img alt="" src="/images/down.gif" /> <a href="#ifmodule"><IfModule></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"><Limit></a></li>
7c7372abe2484e7fcf81937b93496d1246e5b816gstein<li><img alt="" src="/images/down.gif" /> <a href="#limitexcept"><LimitExcept></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"><Location></a></li>
4a13940dc2990df0a798718d3a3f9cf1566c2217bjh<li><img alt="" src="/images/down.gif" /> <a href="#locationmatch"><LocationMatch></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"><VirtualHost></a></li>
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>
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>
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&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 <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>
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>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh AcceptFilter http httpready <br />
2d2eda71267231c2526be701fe655db125852c1ffielding AcceptFilter https dataready
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&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&sektion=9">
2d2eda71267231c2526be701fe655db125852c1ffielding AcceptFilter http data <br />
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh AcceptFilter https data
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 AcceptFilter http data <br />
2d2eda71267231c2526be701fe655db125852c1ffielding AcceptFilter https data
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>
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>
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>
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>
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>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <p>For example, assume the location <code>/test/</code> points to
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb a directory that contains only the single file
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <p>The three possible arguments for the
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <code class="directive">AcceptPathInfo</code> directive are:</p>
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>
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 <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 <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 Options +Includes<br />
99d6d3207e24ba1f8eba77ef903948d738886cf5nd SetOutputFilter INCLUDES<br />
99d6d3207e24ba1f8eba77ef903948d738886cf5nd AcceptPathInfo On<br />
99d6d3207e24ba1f8eba77ef903948d738886cf5nd </Files>
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<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>
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 AccessFileName .acl
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <p>before returning the document
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <code>/usr/local/web/index.html</code>, the server will read
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <code>/usr/local/.acl</code> and <code>/usr/local/web/.acl</code>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben for directives, unless they have been disabled with</p>
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb <Directory /><br />
b0f20a4a26bcfa85724b1c2e5ec6a077f12ef44crbb AllowOverride None<br />
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh </Directory>
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>
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>
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>
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 AddDefaultCharset utf-8
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<li><code class="directive"><a href="/mod/mod_mime.html#addcharset">AddCharset</a></code></li>
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<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Determines whether encoded path separators in URLs are allowed to
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 <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 <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 <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>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<li><code class="directive"><a href="#acceptpathinfo">AcceptPathInfo</a></code></li>
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>
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Types of directives that are allowed in
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AllowOverride All|None|<var>directive-type</var>
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 <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 <div class="note"><h3>Only available in <Directory> sections</h3>
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd <code class="directive">AllowOverride</code> is valid only in
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd <code class="directive"><a href="#directory"><Directory></a></code>
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd sections specified without regular expressions, not in <code class="directive"><a href="#location"><Location></a></code>, <code class="directive"><a href="#directorymatch"><DirectoryMatch></a></code> or
d11bf78168abbb07d8ed9f54d7ea0953d46aad83nd <code class="directive"><a href="#files"><Files></a></code> sections.
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 <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 <p>The <var>directive-type</var> can be one of the following
1ce78cf71b5baaf2c1ab48e818cb1f2397df5010trawick groupings of directives.</p>
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>
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 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>,
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>
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 AllowOverride AuthConfig Indexes
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 <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><Directory /></code> block. Instead, find (or
2d2eda71267231c2526be701fe655db125852c1ffielding create) the <code><Directory></code> block that refers to the
2d2eda71267231c2526be701fe655db125852c1ffielding directory where you're actually planning to place a
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<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<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Technique for locating the interpreter for CGI
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 <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<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>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables the generation of <code>Content-MD5</code> HTTP Response
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>
2d2eda71267231c2526be701fe655db125852c1ffielding <p>This directive enables the generation of
a59f92f67a2c7735469d0ade559f96218627eef0niq respectively RFC2616.</p>
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 <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>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh Content-MD5: AuLb7Dp1rqtRtxz2m9kRpA==
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 <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>
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>
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.
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>
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 DefaultType None
5a9667916c79d8c699b069068e5570aa1c331c80gstein <p><code>DefaultType None</code> is only available in
5a9667916c79d8c699b069068e5570aa1c331c80gstein httpd-2.2.7 and later.</p>
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>
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>
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 <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"><IfDefine></a></code> sections without needing to alter
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"><Directory></a> <a name="directory" id="directory">Directive</a></h2>
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><Directory <var>directory-path</var>>
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 <p><code class="directive"><Directory></code> and
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <code></Directory></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><Directory
2d2eda71267231c2526be701fe655db125852c1ffielding /*/public_html></code> will not match
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <code>/home/user/public_html</code>, but <code><Directory
54e94821097724bf413d2d4cc70711760f7494e1trawick /home/*/public_html></code> will match. Example:</p>
2d2eda71267231c2526be701fe655db125852c1ffielding Options Indexes FollowSymLinks<br />
54e94821097724bf413d2d4cc70711760f7494e1trawick </Directory>
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><Directory></code> will not apply to files accessed from
54e94821097724bf413d2d4cc70711760f7494e1trawick that same directory via a different path, such as via different symbolic
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
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <Directory ~ "^/www/.*/[0-9]{3}">
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <p>would match directories in <code>/www/</code> that consisted of
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh three numbers.</p>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <p>If multiple (non-regular expression) <code class="directive"><Directory></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,
cd9eb79cfbf9bc730ccacc3a3774b1fe1b99ed53wrowe <Directory /><br />
cd9eb79cfbf9bc730ccacc3a3774b1fe1b99ed53wrowe AllowOverride None<br />
cd9eb79cfbf9bc730ccacc3a3774b1fe1b99ed53wrowe </Directory><br />
e57fd661645dcfdf166e77484b509b248e62a19eaaron <Directory /home><br />
e57fd661645dcfdf166e77484b509b248e62a19eaaron AllowOverride FileInfo<br />
e57fd661645dcfdf166e77484b509b248e62a19eaaron </Directory>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <p>for access to the document <code>/home/web/dir/doc.html</code>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh the steps are:</p>
2d2eda71267231c2526be701fe655db125852c1ffielding <li>Apply directive <code>AllowOverride FileInfo</code> (for
2d2eda71267231c2526be701fe655db125852c1ffielding <code>/home/.htaccess</code>, <code>/home/web/.htaccess</code> and
2d2eda71267231c2526be701fe655db125852c1ffielding <code>/home/web/dir/.htaccess</code> in that order.</li>
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 <Directory ~ abc$><br />
952908500d5f99f35afc5ed510391b9bdc3833farbb # ... directives here ...<br />
952908500d5f99f35afc5ed510391b9bdc3833farbb </Directory>
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>the regular expression section won't be considered until after
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein all normal <code class="directive"><Directory></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"><Directory></code> will
2d2eda71267231c2526be701fe655db125852c1ffielding be applied.</p>
3887202241db08986e94b252fbd06a55e55d4b2dbhyde <code><Directory /></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
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <Directory /><br />
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh Order Deny,Allow<br />
2d2eda71267231c2526be701fe655db125852c1ffielding Deny from All<br />
3887202241db08986e94b252fbd06a55e55d4b2dbhyde </Directory>
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
7c7372abe2484e7fcf81937b93496d1246e5b816gstein <p>The directory sections occur in the <code>httpd.conf</code> file.
864c5615d55b8ebbde24e72043f6325741335a74fielding <code class="directive"><Directory></code> directives
2d2eda71267231c2526be701fe655db125852c1ffielding cannot nest, and cannot appear in a <code class="directive"><a href="#limit"><Limit></a></code> or <code class="directive"><a href="#limitexcept"><LimitExcept></a></code> section.</p>
e57fd661645dcfdf166e77484b509b248e62a19eaaron <Location> and <Files> sections work</a> for an
952908500d5f99f35afc5ed510391b9bdc3833farbb explanation of how these different sections are combined when a
e57fd661645dcfdf166e77484b509b248e62a19eaaron request is received</li>
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"><DirectoryMatch></a> <a name="directorymatch" id="directorymatch">Directive</a></h2>
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><DirectoryMatch <var>regex</var>>
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>
952908500d5f99f35afc5ed510391b9bdc3833farbb <p><code class="directive"><DirectoryMatch></code> and
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm <code></DirectoryMatch></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"><Directory></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>
952908500d5f99f35afc5ed510391b9bdc3833farbb <DirectoryMatch "^/www/(.+/)?[0-9]{3}">
2d2eda71267231c2526be701fe655db125852c1ffielding <p>would match directories in <code>/www/</code> that consisted of three
6658f209f08181bd218341770db9f428032dd23ajwoolley numbers.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding Prior to 2.3.9, this directive implicitly applied to sub-directories
2d2eda71267231c2526be701fe655db125852c1ffielding (like <code class="directive"><a href="#directory"><Directory></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.
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.
e57fd661645dcfdf166e77484b509b248e62a19eaaron<li><code class="directive"><a href="#directory"><Directory></a></code> for
952908500d5f99f35afc5ed510391b9bdc3833farbba description of how regular expressions are mixed in with normal
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf<li><a href="/sections.html">How <Directory>, <Location> and
952908500d5f99f35afc5ed510391b9bdc3833farbb<Files> sections work</a> for an explanation of how these different
952908500d5f99f35afc5ed510391b9bdc3833farbbsections are combined when a request is received</li>
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<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Directory that forms the main document tree visible
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>
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 <p>then an access 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 <p>The <code class="directive">DocumentRoot</code> should be specified without
952908500d5f99f35afc5ed510391b9bdc3833farbb a trailing slash.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb<li><a href="/urlmapping.html#documentroot">Mapping URLs to Filesystem
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>
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>
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 <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>
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 <p>For server configurations that are vulnerable to these problems,
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf you should disable memory-mapping of delivered files by specifying:</p>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf EnableMMAP Off
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf <p>For NFS mounted files, this feature may be disabled explicitly for
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf the offending files by specifying:</p>
2d2eda71267231c2526be701fe655db125852c1ffielding <Directory "/path-to-nfs-files">
2d2eda71267231c2526be701fe655db125852c1ffielding EnableMMAP Off
2d2eda71267231c2526be701fe655db125852c1ffielding </Directory>
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<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
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>
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>
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>
2d2eda71267231c2526be701fe655db125852c1ffielding <p>For server configurations that are not vulnerable to these problems,
2d2eda71267231c2526be701fe655db125852c1ffielding you may enable this feature by specifying:</p>
e57fd661645dcfdf166e77484b509b248e62a19eaaron EnableSendfile On
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>For network mounted files, this feature may be disabled explicitly
e57fd661645dcfdf166e77484b509b248e62a19eaaron for the offending files by specifying:</p>
fa3785601cc3801525bc3fc98cafcea5d82efe99wrowe <Directory "/path-to-nfs-files">
e57fd661645dcfdf166e77484b509b248e62a19eaaron EnableSendfile Off
e57fd661645dcfdf166e77484b509b248e62a19eaaron </Directory>
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.
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>
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 <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>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf # ensure that mod_include is loaded<br />
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf <IfModule !include_module><br />
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf Error mod_include is required by mod_foo. Load it with LoadModule.<br />
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf </IfModule><br />
e302f38fd646764ce1a1e1c578d794aef514a9e5sf # ensure that exactly one of SSL,NOSSL is defined<br />
e302f38fd646764ce1a1e1c578d794aef514a9e5sf <IfDefine SSL><br />
e302f38fd646764ce1a1e1c578d794aef514a9e5sf <IfDefine NOSSL><br />
e302f38fd646764ce1a1e1c578d794aef514a9e5sf Error Both SSL and NOSSL are defined. Define only one of them.<br />
e302f38fd646764ce1a1e1c578d794aef514a9e5sf </IfDefine><br />
e57fd661645dcfdf166e77484b509b248e62a19eaaron </IfDefine><br />
e57fd661645dcfdf166e77484b509b248e62a19eaaron <IfDefine !SSL><br />
e57fd661645dcfdf166e77484b509b248e62a19eaaron <IfDefine !NOSSL><br />
e57fd661645dcfdf166e77484b509b248e62a19eaaron Error Either SSL or NOSSL must be defined.<br />
e57fd661645dcfdf166e77484b509b248e62a19eaaron </IfDefine><br />
e57fd661645dcfdf166e77484b509b248e62a19eaaron </IfDefine><br />
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<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>What the server will return to the client
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 <p>In the event of a problem or error, Apache httpd can be configured
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf to do one of four things,</p>
b0d8a6d437db6f4c222173f27ef81c98622fbd02pquerna <li>redirect to a local <var>URL-path</var> to handle the
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 <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 ErrorDocument 500 http://foo.example.com/cgi-bin/tester<br />
9f9307bbe539dbcf96919715315eb64ce3465f5bben ErrorDocument 403 "Sorry can't allow you access today"
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>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh ErrorDocument 404 default<br />
952908500d5f99f35afc5ed510391b9bdc3833farbb </Directory>
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 <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 <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 <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>
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>
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>
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 begins with a pipe character "<code>|</code>" then it is assumed to be a
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf command to spawn to handle the error log.</p>
efd83d1dd1a25688a3093c5a542ae16bacef62ddsf <p>See the notes on <a href="/logs.html#piped">piped logs</a> for
efd83d1dd1a25688a3093c5a542ae16bacef62ddsf more information.</p>
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 ErrorLog syslog:user
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>
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>
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>
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<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>
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>
2d2eda71267231c2526be701fe655db125852c1ffielding ErrorLogFormat "[%t] [%l] [pid %P] %F: %E: [client %a] %M"
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>
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 </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 '% '
952908500d5f99f35afc5ed510391b9bdc3833farbb (percent space) is a zero-witdh field delimiter that does not produce any
dad234382d8424e1c5a30af2838e172aec9d6d1bdreid output.</p>
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 <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>
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>Some format string items accept additional parameters in braces.</p>
952908500d5f99f35afc5ed510391b9bdc3833farbb <table class="bordered"><tr class="header"><th>Format String</th> <th>Description</th></tr>
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm <td>Request environment variable <code>name</code></td></tr>
2d2eda71267231c2526be701fe655db125852c1ffielding <td>Source file name and line number of the log call</td></tr>
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein <td>Number of keep-alive requests on this connection</td></tr>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf <td>Log ID of the connection if used in connection scope, empty otherwise</td></tr>
78b8e4dd910f03af0a602bc4b63ad7bc69868ee3sf <td>The current time in compact ISO 8601 format, including
2d2eda71267231c2526be701fe655db125852c1ffielding <td>The canonical <code class="directive"><a href="#servername">ServerName</a></code>
fa861fc5a880d2c3a5ecc0ec71fa7da556adf5c1wrowe <td>The server name of the server serving the request according to the
fa861fc5a880d2c3a5ecc0ec71fa7da556adf5c1wrowe <code class="directive"><a href="#usecanonicalname">UseCanonicalName</a></code>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr class="odd"><td><code>% </code> (percent space)</td>
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 <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 <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% ,\ referer\ %{Referer}i"
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% ,\ referer\ %{Referer}i"
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 />
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>
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<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Keep track of extended status information for each
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>
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>
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 <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 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>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File attributes used to create the ETag
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 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 <dd>The file's i-node number will be included in the calculation</dd>
952908500d5f99f35afc5ed510391b9bdc3833farbb <dd>The date and time the file was last modified will be included</dd>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <dd>The number of bytes in the file will be included</dd>
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 <dd>If a document is file-based, no <code>ETag</code> field will be
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben included in the response</dd>
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 <p>If a directory's configuration includes
952908500d5f99f35afc5ed510391b9bdc3833farbb <code>FileETag INode MTime Size</code>, and a
952908500d5f99f35afc5ed510391b9bdc3833farbb subdirectory's includes <code>FileETag -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
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 MTime 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 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 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"><Files></a> <a name="files" id="files">Directive</a></h2>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Contains directives that apply to matched
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code><Files <var>filename</var>> ... </Files></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>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe <p>The <code class="directive"><Files></code> directive
952908500d5f99f35afc5ed510391b9bdc3833farbb limits the scope of the enclosed directives by filename. It is comparable
952908500d5f99f35afc5ed510391b9bdc3833farbb to the <code class="directive"><a href="#directory"><Directory></a></code>
bf507cc1e6ad55303c3d436c6ca153f46c788be6sf and <code class="directive"><a href="#location"><Location></a></code>
bf507cc1e6ad55303c3d436c6ca153f46c788be6sf directives. It should be matched with a <code></Files></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"><Files></code>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben sections are processed in the order they appear in the
952908500d5f99f35afc5ed510391b9bdc3833farbb configuration file, after the <code class="directive"><a href="#directory"><Directory></a></code> sections and
952908500d5f99f35afc5ed510391b9bdc3833farbb <code>.htaccess</code> files are read, but before <code class="directive"><a href="#location"><Location></a></code> sections. Note
952908500d5f99f35afc5ed510391b9bdc3833farbb that <code class="directive"><Files></code> can be nested
3d96ee83babeec32482c9082c9426340cee8c44dwrowe inside <code class="directive"><a href="#directory"><Directory></a></code> sections to restrict the
2d2eda71267231c2526be701fe655db125852c1ffielding portion of the filesystem they apply to.</p>
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 <a class="glossarylink" href="/glossary.html#regex" title="see glossary">Regular expressions</a>
952908500d5f99f35afc5ed510391b9bdc3833farbb can also be used, with the addition of the
aecb17a45c6d3ee4729ed5f68dc4270f211ee7a8fielding <Files ~ "\.(gif|jpe?g|png)$">
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>would match most common Internet graphics formats. <code class="directive"><a href="#filesmatch"><FilesMatch></a></code> is preferred,
952908500d5f99f35afc5ed510391b9bdc3833farbb however.</p>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <p>Note that unlike <code class="directive"><a href="#directory"><Directory></a></code> and <code class="directive"><a href="#location"><Location></a></code> sections, <code class="directive"><Files></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<li><a href="/sections.html">How <Directory>, <Location>
952908500d5f99f35afc5ed510391b9bdc3833farbb and <Files> sections work</a> for an explanation of how these
952908500d5f99f35afc5ed510391b9bdc3833farbb different sections are combined when a request is received</li>
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"><FilesMatch></a> <a name="filesmatch" id="filesmatch">Directive</a></h2>
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Contains directives that apply to regular-expression matched
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code><FilesMatch <var>regex</var>> ... </FilesMatch></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>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <p>The <code class="directive"><FilesMatch></code> directive
971ced4989415d939afba8d70c82a9ce0113bceend limits the scope of the enclosed directives by filename, just as the
952908500d5f99f35afc5ed510391b9bdc3833farbb <code class="directive"><a href="#files"><Files></a></code> directive
971ced4989415d939afba8d70c82a9ce0113bceend does. However, it accepts a <a class="glossarylink" href="/glossary.html#regex" title="see glossary">regular
952908500d5f99f35afc5ed510391b9bdc3833farbb <FilesMatch "\.(gif|jpe?g|png)$">
952908500d5f99f35afc5ed510391b9bdc3833farbb <p>would match most common Internet graphics formats.</p>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe<li><a href="/sections.html">How <Directory>, <Location>
952908500d5f99f35afc5ed510391b9bdc3833farbb and <Files> sections work</a> for an explanation of how these
952908500d5f99f35afc5ed510391b9bdc3833farbb different sections are combined when a request is received</li>
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<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>
fb8ee8b7a3a2503b95bf47685f9083e0b9834e6fminfrin <code class="directive"><a href="#directory"><Directory></a></code>, or
fb8ee8b7a3a2503b95bf47685f9083e0b9834e6fminfrin <code class="directive"><a href="#location"><Location></a></code> or
fb8ee8b7a3a2503b95bf47685f9083e0b9834e6fminfrin <code class="directive"><a href="#files"><Files></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>
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 <p>You can also override more general
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <Location /images><br />
952908500d5f99f35afc5ed510391b9bdc3833farbb </Location><br />
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben # but normal mime-type associations here:<br />
3d96ee83babeec32482c9082c9426340cee8c44dwrowe ForceType None<br />
952908500d5f99f35afc5ed510391b9bdc3833farbb </Location>
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>
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<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>
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>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh <p>This directive currently only works with the <code class="module"><a href="/mod/prefork.html">prefork</a></code>
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>
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 <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
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 <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<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"><If></a> <a name="if" id="if">Directive</a></h2>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Contains directives that apply only if a condition is
952908500d5f99f35afc5ed510391b9bdc3833farbb<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code><If <var>expression</var>> ... </If></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>
2d2eda71267231c2526be701fe655db125852c1ffielding <p>The <code class="directive"><If></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>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe <If "$req{Host} = ''">
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <p>would match HTTP/1.0 requests without a <var>Host:</var> header.</p>
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>
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>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe <If %{REQUEST_METHOD} IN GET,HEAD,OPTIONS>
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 <Directory>, <Location>,
3d96ee83babeec32482c9082c9426340cee8c44dwrowe <Files> sections work</a> for an explanation of how these
58619148951981bcfa5c506ad8ce745aa8831980rbb different sections are combined when a request is received.
58619148951981bcfa5c506ad8ce745aa8831980rbb <code class="directive"><If></code> has the same precedence
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben and usage as <code class="directive"><Files></code></li>
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"><IfDefine></a> <a name="ifdefine" id="ifdefine">Directive</a></h2>
58619148951981bcfa5c506ad8ce745aa8831980rbb<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Encloses directives that will be processed only
3d72602d1d9e6f0d49d20f0d0a71831c160ef589wrowe<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code><IfDefine [!]<var>parameter-name</var>> ...
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 <p>The <code><IfDefine <var>test</var>>...</IfDefine>
3d72602d1d9e6f0d49d20f0d0a71831c160ef589wrowe </code> section is used to mark directives that are conditional. The
4a13940dc2990df0a798718d3a3f9cf1566c2217bjh directives within an <code class="directive"><IfDefine></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 <p>The <var>test</var> in the <code class="directive"><IfDefine></code> section directive can be one of two forms:</p>
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>
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>
58619148951981bcfa5c506ad8ce745aa8831980rbb <p><code class="directive"><IfDefine></code> sections are
58619148951981bcfa5c506ad8ce745aa8831980rbb nest-able, which can be used to implement simple
58619148951981bcfa5c506ad8ce745aa8831980rbb multiple-parameter tests. Example:</p>
58619148951981bcfa5c506ad8ce745aa8831980rbb httpd -DReverseProxy -DUseCache -DMemCache ...<br />
58619148951981bcfa5c506ad8ce745aa8831980rbb <IfDefine ReverseProxy><br />
58619148951981bcfa5c506ad8ce745aa8831980rbb LoadModule proxy_http_module modules/mod_proxy_http.so<br />
58619148951981bcfa5c506ad8ce745aa8831980rbb <IfDefine UseCache><br />
58619148951981bcfa5c506ad8ce745aa8831980rbb <IfDefine MemCache><br />
58619148951981bcfa5c506ad8ce745aa8831980rbb LoadModule mem_cache_module modules/mod_mem_cache.so<br />
30c095035b1d5910cc239a1384c816aef228beb5jim </IfDefine><br />
30c095035b1d5910cc239a1384c816aef228beb5jim <IfDefine !MemCache><br />
30c095035b1d5910cc239a1384c816aef228beb5jim LoadModule cache_disk_module modules/mod_cache_disk.so<br />
bdadc326446cae4a51bf75811fbe01a3a362df64gstein </IfDefine>
30c095035b1d5910cc239a1384c816aef228beb5jim </IfDefine>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben </IfDefine>
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"><IfModule></a> <a name="ifmodule" id="ifmodule">Directive</a></h2>
58619148951981bcfa5c506ad8ce745aa8831980rbb<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Encloses directives that are processed conditional on the
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code><IfModule [!]<var>module-file</var>|<var>module-identifier</var>> ...
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
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <p>The <code><IfModule <var>test</var>>...</IfModule></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"><IfModule></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>
759f4a24d09e28c4eaca9f97311b497fc15cb5c7ben <p>The <var>test</var> in the <code class="directive"><IfModule></code> section directive can be one of two forms:</p>
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 <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>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
58619148951981bcfa5c506ad8ce745aa8831980rbb <p><code class="directive"><IfModule></code> sections are
58619148951981bcfa5c506ad8ce745aa8831980rbb nest-able, which can be used to implement simple multiple-module
58619148951981bcfa5c506ad8ce745aa8831980rbb tests.</p>
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"><IfModule></code>
2d2eda71267231c2526be701fe655db125852c1ffielding sections.</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>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Includes other configuration files from within
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
58619148951981bcfa5c506ad8ce745aa8831980rbb <p>This directive allows inclusion of other configuration files
58619148951981bcfa5c506ad8ce745aa8831980rbb from within the server configuration files.</p>
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 <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.
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 <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 <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 <p>Or, providing paths relative to your <code class="directive"><a href="#serverroot">ServerRoot</a></code> directory:</p>
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>
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>
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<li><code class="program"><a href="/programs/apachectl.html">apachectl</a></code></li>
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<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>
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
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>
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>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><code class="directive"><a href="#maxkeepaliverequests">MaxKeepAliveRequests</a></code></li>
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<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Amount of time the server will wait for subsequent
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
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>
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 <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>
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"><Limit></a> <a name="limit" id="limit">Directive</a></h2>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Restrict enclosed access controls to only certain HTTP
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code><Limit <var>method</var> [<var>method</var>] ... > ...
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>
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"><Limit></code> section.</strong></p>
2d2eda71267231c2526be701fe655db125852c1ffielding <p>The purpose of the <code class="directive"><Limit></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"><Limit></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>
9f9307bbe539dbcf96919715315eb64ce3465f5bben <Limit POST PUT DELETE><br />
9f9307bbe539dbcf96919715315eb64ce3465f5bben Require valid-user<br />
9f9307bbe539dbcf96919715315eb64ce3465f5bben </Limit>
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>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 <div class="warning">A <code class="directive"><a href="#limitexcept"><LimitExcept></a></code> section should always be
18173b5033350759b5aa4f6d9a4fd9e12d440135trawick used in preference to a <code class="directive"><Limit></code>
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben section when restricting access, since a <code class="directive"><a href="#limitexcept"><LimitExcept></a></code> section provides protection
18173b5033350759b5aa4f6d9a4fd9e12d440135trawick against arbitrary methods.</div>
84ba82304285b4bb1aafd5c6cdada5ce74c29973striker <p>The <code class="directive"><Limit></code> and
84ba82304285b4bb1aafd5c6cdada5ce74c29973striker <code class="directive"><a href="#limitexcept"><LimitExcept></a></code>
84ba82304285b4bb1aafd5c6cdada5ce74c29973striker directives may be nested. In this case, each successive level of
84ba82304285b4bb1aafd5c6cdada5ce74c29973striker <code class="directive"><Limit></code> or <code class="directive"><a href="#limitexcept"><LimitExcept></a></code> directives must
84ba82304285b4bb1aafd5c6cdada5ce74c29973striker further restrict the set of methods to which access controls apply.</p>
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben <code class="directive"><LimitExcept></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 <p>For example, given the following configuration, all users will
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben <code>Require group editors</code> directive will be ignored
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben in all cases:</p>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh <LimitExcept GET>
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh Require valid-user
3d0bdf16bc410722e6c42aa2ceb0677b0ae29b90ianh </LimitExcept><br />
0e6e93183d91142d7cf9ffbf502114ff77bd9e19ben <Limit POST>
dca927eafb338b9de9d0214818136c16d436e3fdrbb Require group editors
dca927eafb338b9de9d0214818136c16d436e3fdrbb </Limit>
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"><LimitExcept></a> <a name="limitexcept" id="limitexcept">Directive</a></h2>
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Restrict access controls to all HTTP methods
2d2eda71267231c2526be701fe655db125852c1ffielding<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code><LimitExcept <var>method</var> [<var>method</var>] ... > ...
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>
i.e., it is the opposite of a <code class="directive"><a href="#limit"><Limit></a></code> section and can be used to control
documentation for <code class="directive"><a href="#limit"><Limit></a></code> for more details.</p>
<div class="directive-section"><h2><a name="LimitInternalRecursion" id="LimitInternalRecursion">LimitInternalRecursion</a> <a name="limitinternalrecursion" id="limitinternalrecursion">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Determine maximum number of internal redirects and nested
<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#Compatibility">Compatibility:</a></th><td>Available in Apache httpd 2.0.47 and later</td></tr>
<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
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>
<div class="directive-section"><h2><a name="LimitRequestBody" id="LimitRequestBody">LimitRequestBody</a> <a name="limitrequestbody" id="limitrequestbody">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Restricts the total size of the HTTP request body sent
<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>
proxy requests, see the <code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code> documentation.</p>
<div class="directive-section"><h2><a name="LimitRequestFields" id="LimitRequestFields">LimitRequestFields</a> <a name="limitrequestfields" id="limitrequestfields">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limits the number of HTTP request header fields that
<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>
<div class="directive-section"><h2><a name="LimitRequestFieldSize" id="LimitRequestFieldSize">LimitRequestFieldSize</a> <a name="limitrequestfieldsize" id="limitrequestfieldsize">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limits the size of the HTTP request header allowed from the
<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>
<div class="directive-section"><h2><a name="LimitRequestLine" id="LimitRequestLine">LimitRequestLine</a> <a name="limitrequestline" id="limitrequestline">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limit the size of the HTTP request line that will be accepted
<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>
<div class="directive-section"><h2><a name="LimitXMLRequestBody" id="LimitXMLRequestBody">LimitXMLRequestBody</a> <a name="limitxmlrequestbody" id="limitxmlrequestbody">Directive</a></h2>
<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>
<div class="directive-section"><h2><a name="Location" id="Location"><Location></a> <a name="location" id="location">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Applies the enclosed directives only to matching
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<code></Location></code> directive. <code class="directive"><Location></code> sections are processed in the
order they appear in the configuration file, after the <code class="directive"><a href="#directory"><Directory></a></code> sections and
<code>.htaccess</code> files are read, and after the <code class="directive"><a href="#files"><Files></a></code> sections.</p>
content that lives in the filesystem, use <code class="directive"><a href="#directory"><Directory></a></code> and <code class="directive"><a href="#files"><Files></a></code>. An exception is
or <code>/special/data</code>. The directive <code class="directive"><a href="#locationmatch"><LocationMatch></a></code> behaves
identical to the regex version of <code class="directive"><Location></code>, and is preferred, for the
directive and the regex version of <code class="directive"><Location></code> require you to explicitly specify multiple
//abc</code>. The (non-regex) <code class="directive"><Location></code> directive behaves similarly when used for
proxy requests. But when (non-regex) <code class="directive"><Location></code> is used for non-proxy requests it will
<div class="directive-section"><h2><a name="LocationMatch" id="LocationMatch"><LocationMatch></a> <a name="locationmatch" id="locationmatch">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Applies the enclosed directives only to regular-expression
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
it takes a <a class="glossarylink" href="/glossary.html#regex" title="see glossary">regular expression</a>
<div class="directive-section"><h2><a name="LogLevel" id="LogLevel">LogLevel</a> <a name="loglevel" id="loglevel">Directive</a></h2>
<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>
<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#Compatibility">Compatibility:</a></th><td>Per-module and per-directory configuration is available in
messages recorded in the error logs (see <code class="directive"><a href="#errorlog">ErrorLog</a></code> directive). The following
<div class="directive-section"><h2><a name="MaxKeepAliveRequests" id="MaxKeepAliveRequests">MaxKeepAliveRequests</a> <a name="maxkeepaliverequests" id="maxkeepaliverequests">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Number of requests allowed on a persistent
<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>
<div class="directive-section"><h2><a name="Mutex" id="Mutex">Mutex</a> <a name="mutex" id="mutex">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures mutex mechanism and lock file directory for all
<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#Compatibility">Compatibility:</a></th><td>Available in Apache HTTP Server 2.3.4 and later</td></tr>
by <a class="glossarylink" href="/glossary.html#apr" title="see glossary">APR</a> has a functional or performance
<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
all CGIs, unless you use something like <code class="program"><a href="/programs/suexec.html">suexec</a></code>
underlying platform and <a class="glossarylink" href="/glossary.html#apr" title="see glossary">APR</a> support it. Mechanisms
<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>
<div class="directive-section"><h2><a name="NameVirtualHost" id="NameVirtualHost">NameVirtualHost</a> <a name="namevirtualhost" id="namevirtualhost">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Designates an IP address for name-virtual
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>NameVirtualHost <var>addr</var>[:<var>port</var>]</code></td></tr>
<div class="directive-section"><h2><a name="Options" id="Options">Options</a> <a name="options" id="options">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures what features are available in a particular
<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#Compatibility">Compatibility:</a></th><td>The default was changed from All to FollowSymlinks in 2.3.11</td></tr>
change the pathname used to match against <code class="directive"><a href="#directory"><Directory></a></code> sections.</p>
Server-side includes provided by <code class="module"><a href="/mod/mod_include.html">mod_include</a></code>
<code class="module"><a href="/mod/mod_autoindex.html">mod_autoindex</a></code> will return a formatted listing
anywhere other than <code class="directive"><a href="#directory"><Directory></a></code>, as <code class="module"><a href="/mod/mod_negotiation.html">mod_negotiation</a></code>
others are ignored; the options are not merged. (See <a href="/sections.html#mergin">how sections are merged</a>.)
<div class="directive-section"><h2><a name="Protocol" id="Protocol">Protocol</a> <a name="protocol" id="protocol">Directive</a></h2>
<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#Compatibility">Compatibility:</a></th><td>Available in Apache 2.1.5 and later.
<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>
<p>You can also specify the protocol using the <code class="directive"><a href="/mod/mpm_common.html#listen">Listen</a></code> directive.</p>
<div class="directive-section"><h2><a name="RLimitCPU" id="RLimitCPU">RLimitCPU</a> <a name="rlimitcpu" id="rlimitcpu">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limits the CPU consumption of processes launched
<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>
<div class="directive-section"><h2><a name="RLimitMEM" id="RLimitMEM">RLimitMEM</a> <a name="rlimitmem" id="rlimitmem">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limits the memory consumption of processes launched
<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>
<div class="directive-section"><h2><a name="RLimitNPROC" id="RLimitNPROC">RLimitNPROC</a> <a name="rlimitnproc" id="rlimitnproc">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limits the number of processes that can be launched by
<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>
<div class="directive-section"><h2><a name="ScriptInterpreterSource" id="ScriptInterpreterSource">ScriptInterpreterSource</a> <a name="scriptinterpretersource" id="scriptinterpretersource">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Technique for locating the interpreter for CGI
<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>
Registry</code> with <code class="directive"><a href="/mod/mod_alias.html#scriptalias">ScriptAlias</a></code>'ed directories, because
<div class="directive-section"><h2><a name="SeeRequestTail" id="SeeRequestTail">SeeRequestTail</a> <a name="seerequesttail" id="seerequesttail">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Determine if mod_status displays the first 63 characters
<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#Compatibility">Compatibility:</a></th><td>Available in Apache httpd 2.2.7 and later.</td></tr>
<p>If Apache httpd is handling <code>GET /disk1/storage/apache/htdocs/images/imagestore1/food/apples.jpg HTTP/1.1</code> mod_status displays as follows:
<div class="directive-section"><h2><a name="ServerAdmin" id="ServerAdmin">ServerAdmin</a> <a name="serveradmin" id="serveradmin">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Email address that the server includes in error
<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>
<div class="directive-section"><h2><a name="ServerAlias" id="ServerAlias">ServerAlias</a> <a name="serveralias" id="serveralias">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Alternate names for a host used when matching requests
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ServerAlias <var>hostname</var> [<var>hostname</var>] ...</code></td></tr>
alternate names for a host, for use with <a href="/vhosts/name-based.html">name-based virtual hosts</a>. The
<div class="directive-section"><h2><a name="ServerName" id="ServerName">ServerName</a> <a name="servername" id="servername">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Hostname and port that the server uses to identify
<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>
identify a virtual host, when using <a href="/vhosts/name-based.html">name-based virtual hosts</a>.</p>
ServerName www.example.com
<code class="directive"><a href="#usecanonicalphysicalport">UseCanonicalPhysicalPort</a></code> directives for
settings which determine whether self-referential URLs (e.g., by the
httpd: Could not reliably determine the server's fully qualified domain name, using rocinante.local for ServerName
<li><code class="directive"><a href="#usecanonicalphysicalport">UseCanonicalPhysicalPort</a></code></li>
<div class="directive-section"><h2><a name="ServerPath" id="ServerPath">ServerPath</a> <a name="serverpath" id="serverpath">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Legacy URL pathname for a name-based virtual host that
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ServerPath <var>URL-path</var></code></td></tr>
<div class="directive-section"><h2><a name="ServerRoot" id="ServerRoot">ServerRoot</a> <a name="serverroot" id="serverroot">Directive</a></h2>
<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>
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
<div class="directive-section"><h2><a name="ServerSignature" id="ServerSignature">ServerSignature</a> <a name="serversignature" id="serversignature">Directive</a></h2>
<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>
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
server version number and <code class="directive"><a href="#servername">ServerName</a></code> of the serving virtual host,
"mailto:" reference to the <code class="directive"><a href="#serveradmin">ServerAdmin</a></code> of the referenced
presented are controlled by the <code class="directive"><a href="#servertokens">ServerTokens</a></code> directive.</p>
<div class="directive-section"><h2><a name="ServerTokens" id="ServerTokens">ServerTokens</a> <a name="servertokens" id="servertokens">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures the <code>Server</code> HTTP response
<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>
information presented by the <code class="directive"><a href="#serversignature">ServerSignature</a></code> directive.</p>
<div class="directive-section"><h2><a name="SetHandler" id="SetHandler">SetHandler</a> <a name="sethandler" id="sethandler">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Forces all matching files to be processed by a
<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#Compatibility">Compatibility:</a></th><td>Moved into the core in Apache httpd 2.0</td></tr>
<div class="directive-section"><h2><a name="SetInputFilter" id="SetInputFilter">SetInputFilter</a> <a name="setinputfilter" id="setinputfilter">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the filters that will process client requests and POST
<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>
<div class="directive-section"><h2><a name="SetOutputFilter" id="SetOutputFilter">SetOutputFilter</a> <a name="setoutputfilter" id="setoutputfilter">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the filters that will process responses from the
<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>
<div class="directive-section"><h2><a name="TimeOut" id="TimeOut">TimeOut</a> <a name="timeout" id="timeout">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Amount of time the server will wait for
<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>
<li>In <code class="module"><a href="/mod/mod_cgi.html">mod_cgi</a></code>, the length of time to wait for
<li>In <code class="module"><a href="/mod/mod_ext_filter.html">mod_ext_filter</a></code>, the length of time to
<li>In <code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code>, the default timeout value if
<div class="directive-section"><h2><a name="TraceEnable" id="TraceEnable">TraceEnable</a> <a name="traceenable" id="traceenable">Directive</a></h2>
<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#Compatibility">Compatibility:</a></th><td>Available in Apache HTTP Server 1.3.34, 2.0.55 and later</td></tr>
the core server and <code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code>. The default
<code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code> to return a <code>405</code> (Method not
<div class="directive-section"><h2><a name="UnDefine" id="UnDefine">UnDefine</a> <a name="undefine" id="undefine">Directive</a></h2>
<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>
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"><IfDefine></a></code> sections without needing to alter
<div class="directive-section"><h2><a name="UseCanonicalName" id="UseCanonicalName">UseCanonicalName</a> <a name="usecanonicalname" id="usecanonicalname">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures how the server determines its own name and
<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>
for <code>www.example.com</code> -- see <a href="http://httpd.apache.org/docs/misc/FAQ.html#prompted-twice">the
<li><code class="directive"><a href="#usecanonicalphysicalport">UseCanonicalPhysicalPort</a></code></li>
<div class="directive-section"><h2><a name="UseCanonicalPhysicalPort" id="UseCanonicalPhysicalPort">UseCanonicalPhysicalPort</a> <a name="usecanonicalphysicalport" id="usecanonicalphysicalport">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures how the server determines its own name and
<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>
<div class="directive-section"><h2><a name="VirtualHost" id="VirtualHost"><VirtualHost></a> <a name="virtualhost" id="virtualhost">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Contains directives that apply only to a specific
specified inside each <code class="directive"><VirtualHost></code> block. If it is absent, the
<p><span>Available Languages: </span><a href="/de/mod/core.html" hreflang="de" rel="alternate" title="Deutsch"> de </a> |
<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>