core.html.en revision 8cc194918514dea341631244ef48442b44175bde
083eacf86f9327835b824f9e6be987d56cd96e82slive<?xml version="1.0" encoding="ISO-8859-1"?>
530eba85dbd41b8a0fa5255d3648d1440199a661slive<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
e942c741056732f50da2074b36fe59805d370650slive<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
5f5d1b4cc970b7f06ff8ef6526128e9a27303d88nd XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd This file is generated from xml source: DO NOT EDIT
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding -->
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding<title>core - Apache HTTP Server</title>
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding<link href="/style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding<link href="/images/favicon.ico" rel="shortcut icon" /></head>
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd<body>
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd<div id="page-header">
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd<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>
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd<p class="apache">Apache HTTP Server Version 2.3</p>
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd<img alt="" src="/images/feather.gif" /></div>
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd<div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="/images/left.gif" /></a></div>
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd<div id="path">
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd<a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.3</a> &gt; <a href="./">Modules</a></div>
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd<div id="page-content">
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd<div id="preamble"><h1>Apache Core Features</h1>
7db9f691a00ead175b03335457ca296a33ddf31bnd<div class="toplang">
083eacf86f9327835b824f9e6be987d56cd96e82slive<p><span>Available Languages: </span><a href="/de/mod/core.html" hreflang="de" rel="alternate" title="Deutsch">&nbsp;de&nbsp;</a> |
083eacf86f9327835b824f9e6be987d56cd96e82slive<a href="/en/mod/core.html" title="English">&nbsp;en&nbsp;</a> |
083eacf86f9327835b824f9e6be987d56cd96e82slive<a href="/fr/mod/core.html" hreflang="fr" rel="alternate" title="Fran�ais">&nbsp;fr&nbsp;</a> |
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<a href="/ja/mod/core.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<a href="/tr/mod/core.html" hreflang="tr" rel="alternate" title="T�rk�e">&nbsp;tr&nbsp;</a></p>
083eacf86f9327835b824f9e6be987d56cd96e82slive</div>
083eacf86f9327835b824f9e6be987d56cd96e82slive<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Core Apache HTTP Server features that are always
083eacf86f9327835b824f9e6be987d56cd96e82sliveavailable</td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Core</td></tr></table>
0625cd06f863f3c751b1e3853851424726c49e0anilgun</div>
083eacf86f9327835b824f9e6be987d56cd96e82slive<div id="quickview"><h3 class="directives">Directives</h3>
083eacf86f9327835b824f9e6be987d56cd96e82slive<ul id="toc">
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#acceptfilter">AcceptFilter</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#acceptpathinfo">AcceptPathInfo</a></li>
61d29dac384de8b27485e54e53f1386549c578e1rbowen<li><img alt="" src="/images/down.gif" /> <a href="#accessfilename">AccessFileName</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#adddefaultcharset">AddDefaultCharset</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#addoutputfilterbytype">AddOutputFilterByType</a></li>
61d29dac384de8b27485e54e53f1386549c578e1rbowen<li><img alt="" src="/images/down.gif" /> <a href="#allowencodedslashes">AllowEncodedSlashes</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#allowoverride">AllowOverride</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#cgimapextension">CGIMapExtension</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#contentdigest">ContentDigest</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#defaulttype">DefaultType</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#define">Define</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#directory">&lt;Directory&gt;</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#directorymatch">&lt;DirectoryMatch&gt;</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#documentroot">DocumentRoot</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#enablemmap">EnableMMAP</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#enablesendfile">EnableSendfile</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#errordocument">ErrorDocument</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#errorlog">ErrorLog</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#fileetag">FileETag</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#files">&lt;Files&gt;</a></li>
0625cd06f863f3c751b1e3853851424726c49e0anilgun<li><img alt="" src="/images/down.gif" /> <a href="#filesmatch">&lt;FilesMatch&gt;</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#forcetype">ForceType</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#hostnamelookups">HostnameLookups</a></li>
0625cd06f863f3c751b1e3853851424726c49e0anilgun<li><img alt="" src="/images/down.gif" /> <a href="#if">&lt;If&gt;</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#ifdefine">&lt;IfDefine&gt;</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#ifmodule">&lt;IfModule&gt;</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#include">Include</a></li>
98dd94f575d903951ad09b81f8f6d529e4770f94nd<li><img alt="" src="/images/down.gif" /> <a href="#keepalive">KeepAlive</a></li>
199a8ee5984e3708982fab1ba6ebb0a5feaea90cnd<li><img alt="" src="/images/down.gif" /> <a href="#keepalivetimeout">KeepAliveTimeout</a></li>
199a8ee5984e3708982fab1ba6ebb0a5feaea90cnd<li><img alt="" src="/images/down.gif" /> <a href="#limit">&lt;Limit&gt;</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#limitexcept">&lt;LimitExcept&gt;</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#limitinternalrecursion">LimitInternalRecursion</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#limitrequestbody">LimitRequestBody</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#limitrequestfields">LimitRequestFields</a></li>
5a72056ec99a47ca99cc57824103472ed7a91792pepper<li><img alt="" src="/images/down.gif" /> <a href="#limitrequestfieldsize">LimitRequestFieldSize</a></li>
199a8ee5984e3708982fab1ba6ebb0a5feaea90cnd<li><img alt="" src="/images/down.gif" /> <a href="#limitrequestline">LimitRequestLine</a></li>
5d01f40ffd657dd2ac567aacd93cabd162ddfa79coar<li><img alt="" src="/images/down.gif" /> <a href="#limitxmlrequestbody">LimitXMLRequestBody</a></li>
3d348301759d78df6958c1d9e600255d139b97abrbowen<li><img alt="" src="/images/down.gif" /> <a href="#location">&lt;Location&gt;</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#locationmatch">&lt;LocationMatch&gt;</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#loglevel">LogLevel</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#maxkeepaliverequests">MaxKeepAliveRequests</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#namevirtualhost">NameVirtualHost</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#options">Options</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#rlimitcpu">RLimitCPU</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#rlimitmem">RLimitMEM</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#rlimitnproc">RLimitNPROC</a></li>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<li><img alt="" src="/images/down.gif" /> <a href="#scriptinterpretersource">ScriptInterpreterSource</a></li>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<li><img alt="" src="/images/down.gif" /> <a href="#serveradmin">ServerAdmin</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#serveralias">ServerAlias</a></li>
61d29dac384de8b27485e54e53f1386549c578e1rbowen<li><img alt="" src="/images/down.gif" /> <a href="#servername">ServerName</a></li>
61d29dac384de8b27485e54e53f1386549c578e1rbowen<li><img alt="" src="/images/down.gif" /> <a href="#serverpath">ServerPath</a></li>
61d29dac384de8b27485e54e53f1386549c578e1rbowen<li><img alt="" src="/images/down.gif" /> <a href="#serverroot">ServerRoot</a></li>
61d29dac384de8b27485e54e53f1386549c578e1rbowen<li><img alt="" src="/images/down.gif" /> <a href="#serversignature">ServerSignature</a></li>
61d29dac384de8b27485e54e53f1386549c578e1rbowen<li><img alt="" src="/images/down.gif" /> <a href="#servertokens">ServerTokens</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#sethandler">SetHandler</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#setinputfilter">SetInputFilter</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#setoutputfilter">SetOutputFilter</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#timeout">TimeOut</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#traceenable">TraceEnable</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#usecanonicalname">UseCanonicalName</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><img alt="" src="/images/down.gif" /> <a href="#usecanonicalphysicalport">UseCanonicalPhysicalPort</a></li>
530eba85dbd41b8a0fa5255d3648d1440199a661slive<li><img alt="" src="/images/down.gif" /> <a href="#virtualhost">&lt;VirtualHost&gt;</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive</ul>
530eba85dbd41b8a0fa5255d3648d1440199a661slive</div>
083eacf86f9327835b824f9e6be987d56cd96e82slive
083eacf86f9327835b824f9e6be987d56cd96e82slive<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
530eba85dbd41b8a0fa5255d3648d1440199a661slive<div class="directive-section"><h2><a name="AcceptFilter" id="AcceptFilter">AcceptFilter</a> <a name="acceptfilter" id="acceptfilter">Directive</a></h2>
083eacf86f9327835b824f9e6be987d56cd96e82slive<table class="directive">
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures optimizations for a Protocol's Listener Sockets</td></tr>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AcceptFilter <var>protocol</var> <var>accept_filter</var></code></td></tr>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
530eba85dbd41b8a0fa5255d3648d1440199a661slive<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.1.5 and later.
083eacf86f9327835b824f9e6be987d56cd96e82sliveOn Windows from Apache 2.3.3 and later.</td></tr>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd</table>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <p>This directive enables operating system specific optimizations for a
083eacf86f9327835b824f9e6be987d56cd96e82slive listening socket by the Protocol type. The basic premise is for the
530eba85dbd41b8a0fa5255d3648d1440199a661slive kernel to not send a socket to the server process until either data
083eacf86f9327835b824f9e6be987d56cd96e82slive is received or an entire HTTP Request is buffered. Only
083eacf86f9327835b824f9e6be987d56cd96e82slive <a href="http://www.freebsd.org/cgi/man.cgi?query=accept_filter&amp;sektion=9">
530eba85dbd41b8a0fa5255d3648d1440199a661slive FreeBSD's Accept Filters</a>, Linux's more primitive
083eacf86f9327835b824f9e6be987d56cd96e82slive <code>TCP_DEFER_ACCEPT</code>, and Windows' optimized AcceptEx()
083eacf86f9327835b824f9e6be987d56cd96e82slive are currently supported.</p>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <p>Using <code>none</code> for an argument will disable any accept filters
083eacf86f9327835b824f9e6be987d56cd96e82slive for that protocol. This is useful for protocols that require a server
530eba85dbd41b8a0fa5255d3648d1440199a661slive send data first, such as <code>ftp:</code> or <code>nntp</code>:</p>
083eacf86f9327835b824f9e6be987d56cd96e82slive <div class="example"><p><code>AcceptFilter nntp none</code></p></div>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd
083eacf86f9327835b824f9e6be987d56cd96e82slive <p>The default values on FreeBSD are:</p>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <div class="example"><p><code>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd AcceptFilter http httpready <br />
083eacf86f9327835b824f9e6be987d56cd96e82slive AcceptFilter https dataready
083eacf86f9327835b824f9e6be987d56cd96e82slive </code></p></div>
083eacf86f9327835b824f9e6be987d56cd96e82slive
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <p>The <code>httpready</code> accept filter buffers entire HTTP requests at
439ebfd112c7216b5dbab8161a04fcf78a882e57nd the kernel level. Once an entire request is received, the kernel then
083eacf86f9327835b824f9e6be987d56cd96e82slive sends it to the server. See the
083eacf86f9327835b824f9e6be987d56cd96e82slive <a href="http://www.freebsd.org/cgi/man.cgi?query=accf_http&amp;sektion=9">
439ebfd112c7216b5dbab8161a04fcf78a882e57nd accf_http(9)</a> man page for more details. Since HTTPS requests are
439ebfd112c7216b5dbab8161a04fcf78a882e57nd encrypted only the <a href="http://www.freebsd.org/cgi/man.cgi?query=accf_data&amp;sektion=9">
439ebfd112c7216b5dbab8161a04fcf78a882e57nd accf_data(9)</a> filter is used.</p>
083eacf86f9327835b824f9e6be987d56cd96e82slive
083eacf86f9327835b824f9e6be987d56cd96e82slive <p>The default values on Linux are:</p>
083eacf86f9327835b824f9e6be987d56cd96e82slive <div class="example"><p><code>
083eacf86f9327835b824f9e6be987d56cd96e82slive AcceptFilter http data <br />
083eacf86f9327835b824f9e6be987d56cd96e82slive AcceptFilter https data
083eacf86f9327835b824f9e6be987d56cd96e82slive </code></p></div>
083eacf86f9327835b824f9e6be987d56cd96e82slive
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <p>Linux's <code>TCP_DEFER_ACCEPT</code> does not support buffering http
439ebfd112c7216b5dbab8161a04fcf78a882e57nd requests. Any value besides <code>none</code> will enable
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <code>TCP_DEFER_ACCEPT</code> on that listener. For more details
439ebfd112c7216b5dbab8161a04fcf78a882e57nd see the Linux
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <a href="http://homepages.cwi.nl/~aeb/linux/man2html/man7/tcp.7.html">
439ebfd112c7216b5dbab8161a04fcf78a882e57nd tcp(7)</a> man page.</p>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <p>The default values on Windows are:</p>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <div class="example"><p><code>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd AcceptFilter http data <br />
439ebfd112c7216b5dbab8161a04fcf78a882e57nd AcceptFilter https data
439ebfd112c7216b5dbab8161a04fcf78a882e57nd </code></p></div>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <p>Window's mpm_winnt interprets the AcceptFilter to toggle the AcceptEx()
439ebfd112c7216b5dbab8161a04fcf78a882e57nd API, and does not support http protocol buffering. There are two values
439ebfd112c7216b5dbab8161a04fcf78a882e57nd which utilize the Windows AcceptEx() API and will recycle network
439ebfd112c7216b5dbab8161a04fcf78a882e57nd sockets between connections. <code>data</code> waits until data has
439ebfd112c7216b5dbab8161a04fcf78a882e57nd been transmitted as documented above, and the initial data buffer and
439ebfd112c7216b5dbab8161a04fcf78a882e57nd network endpoint addresses are all retrieved from the single AcceptEx()
439ebfd112c7216b5dbab8161a04fcf78a882e57nd invocation. <code>connect</code> will use the AcceptEx() API, also
439ebfd112c7216b5dbab8161a04fcf78a882e57nd retrieve the network endpoint addresses, but like <code>none</code>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd the <code>connect</code> option does not wait for the initial data
439ebfd112c7216b5dbab8161a04fcf78a882e57nd transmission.</p>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <p>On Windows, <code>none</code> uses accept() rather than than AcceptEx()
439ebfd112c7216b5dbab8161a04fcf78a882e57nd and will not recycle sockets between connections. This is useful for
439ebfd112c7216b5dbab8161a04fcf78a882e57nd network adapters with broken driver support, as well as some virtual
439ebfd112c7216b5dbab8161a04fcf78a882e57nd network providers such as vpn drivers, or spam, virus or spyware
439ebfd112c7216b5dbab8161a04fcf78a882e57nd filters.</p>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd
439ebfd112c7216b5dbab8161a04fcf78a882e57nd
439ebfd112c7216b5dbab8161a04fcf78a882e57nd</div>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<div class="directive-section"><h2><a name="AcceptPathInfo" id="AcceptPathInfo">AcceptPathInfo</a> <a name="acceptpathinfo" id="acceptpathinfo">Directive</a></h2>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<table class="directive">
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Resources accept trailing pathname information</td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AcceptPathInfo On|Off|Default</code></td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AcceptPathInfo Default</code></td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.0.30 and later</td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive</table>
083eacf86f9327835b824f9e6be987d56cd96e82slive
083eacf86f9327835b824f9e6be987d56cd96e82slive <p>This directive controls whether requests that contain trailing
083eacf86f9327835b824f9e6be987d56cd96e82slive pathname information that follows an actual filename (or
083eacf86f9327835b824f9e6be987d56cd96e82slive non-existent file in an existing directory) will be accepted or
083eacf86f9327835b824f9e6be987d56cd96e82slive rejected. The trailing pathname information can be made
083eacf86f9327835b824f9e6be987d56cd96e82slive available to scripts in the <code>PATH_INFO</code> environment
083eacf86f9327835b824f9e6be987d56cd96e82slive variable.</p>
98dd94f575d903951ad09b81f8f6d529e4770f94nd
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <p>For example, assume the location <code>/test/</code> points to
083eacf86f9327835b824f9e6be987d56cd96e82slive a directory that contains only the single file
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <code>here.html</code>. Then requests for
9f57d601ce42feab067a08a9827da30d39c1fd41nd <code>/test/here.html/more</code> and
9f57d601ce42feab067a08a9827da30d39c1fd41nd <code>/test/nothere.html/more</code> both collect
9f57d601ce42feab067a08a9827da30d39c1fd41nd <code>/more</code> as <code>PATH_INFO</code>.</p>
083eacf86f9327835b824f9e6be987d56cd96e82slive
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh <p>The three possible arguments for the
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh <code class="directive">AcceptPathInfo</code> directive are:</p>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh <dl>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh <dt><code>Off</code></dt><dd>A request will only be accepted if it
083eacf86f9327835b824f9e6be987d56cd96e82slive maps to a literal path that exists. Therefore a request with
083eacf86f9327835b824f9e6be987d56cd96e82slive trailing pathname information after the true filename such as
083eacf86f9327835b824f9e6be987d56cd96e82slive <code>/test/here.html/more</code> in the above example will return
083eacf86f9327835b824f9e6be987d56cd96e82slive a 404 NOT FOUND error.</dd>
083eacf86f9327835b824f9e6be987d56cd96e82slive
083eacf86f9327835b824f9e6be987d56cd96e82slive <dt><code>On</code></dt><dd>A request will be accepted if a
083eacf86f9327835b824f9e6be987d56cd96e82slive leading path component maps to a file that exists. The above
439ebfd112c7216b5dbab8161a04fcf78a882e57nd example <code>/test/here.html/more</code> will be accepted if
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <code>/test/here.html</code> maps to a valid file.</dd>
083eacf86f9327835b824f9e6be987d56cd96e82slive
083eacf86f9327835b824f9e6be987d56cd96e82slive <dt><code>Default</code></dt><dd>The treatment of requests with
083eacf86f9327835b824f9e6be987d56cd96e82slive trailing pathname information is determined by the <a href="/handler.html">handler</a> responsible for the request.
083eacf86f9327835b824f9e6be987d56cd96e82slive The core handler for normal files defaults to rejecting
083eacf86f9327835b824f9e6be987d56cd96e82slive <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
083eacf86f9327835b824f9e6be987d56cd96e82slive <code>PATH_INFO</code> by default.</dd>
083eacf86f9327835b824f9e6be987d56cd96e82slive </dl>
083eacf86f9327835b824f9e6be987d56cd96e82slive
98dd94f575d903951ad09b81f8f6d529e4770f94nd <p>The primary purpose of the <code>AcceptPathInfo</code>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd directive is to allow you to override the handler's choice of
439ebfd112c7216b5dbab8161a04fcf78a882e57nd accepting or rejecting <code>PATH_INFO</code>. This override is required,
9f57d601ce42feab067a08a9827da30d39c1fd41nd for example, when you use a <a href="/filter.html">filter</a>, such
9f57d601ce42feab067a08a9827da30d39c1fd41nd as <a href="mod_include.html">INCLUDES</a>, to generate content
9f57d601ce42feab067a08a9827da30d39c1fd41nd based on <code>PATH_INFO</code>. The core handler would usually reject
083eacf86f9327835b824f9e6be987d56cd96e82slive the request, so you can use the following configuration to enable
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh such a script:</p>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh <div class="example"><p><code>
083eacf86f9327835b824f9e6be987d56cd96e82slive &lt;Files "mypaths.shtml"&gt;<br />
083eacf86f9327835b824f9e6be987d56cd96e82slive <span class="indent">
083eacf86f9327835b824f9e6be987d56cd96e82slive Options +Includes<br />
083eacf86f9327835b824f9e6be987d56cd96e82slive SetOutputFilter INCLUDES<br />
083eacf86f9327835b824f9e6be987d56cd96e82slive AcceptPathInfo On<br />
083eacf86f9327835b824f9e6be987d56cd96e82slive </span>
083eacf86f9327835b824f9e6be987d56cd96e82slive &lt;/Files&gt;
439ebfd112c7216b5dbab8161a04fcf78a882e57nd </code></p></div>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd
083eacf86f9327835b824f9e6be987d56cd96e82slive
083eacf86f9327835b824f9e6be987d56cd96e82slive</div>
083eacf86f9327835b824f9e6be987d56cd96e82slive<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
083eacf86f9327835b824f9e6be987d56cd96e82slive<div class="directive-section"><h2><a name="AccessFileName" id="AccessFileName">AccessFileName</a> <a name="accessfilename" id="accessfilename">Directive</a></h2>
083eacf86f9327835b824f9e6be987d56cd96e82slive<table class="directive">
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Name of the distributed configuration file</td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AccessFileName <var>filename</var> [<var>filename</var>] ...</code></td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AccessFileName .htaccess</code></td></tr>
98dd94f575d903951ad09b81f8f6d529e4770f94nd<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
9f57d601ce42feab067a08a9827da30d39c1fd41nd</table>
9f57d601ce42feab067a08a9827da30d39c1fd41nd <p>While processing a request the server looks for
9f57d601ce42feab067a08a9827da30d39c1fd41nd the first existing configuration file from this list of names in
083eacf86f9327835b824f9e6be987d56cd96e82slive every directory of the path to the document, if distributed
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh configuration files are <a href="#allowoverride">enabled for that
439ebfd112c7216b5dbab8161a04fcf78a882e57nd directory</a>. For example:</p>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh
083eacf86f9327835b824f9e6be987d56cd96e82slive <div class="example"><p><code>
083eacf86f9327835b824f9e6be987d56cd96e82slive AccessFileName .acl
083eacf86f9327835b824f9e6be987d56cd96e82slive </code></p></div>
083eacf86f9327835b824f9e6be987d56cd96e82slive
083eacf86f9327835b824f9e6be987d56cd96e82slive <p>before returning the document
41821e8b989f24bed173216698f0c0c597f81afeyoshiki <code>/usr/local/web/index.html</code>, the server will read
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <code>/.acl</code>, <code>/usr/.acl</code>,
083eacf86f9327835b824f9e6be987d56cd96e82slive <code>/usr/local/.acl</code> and <code>/usr/local/web/.acl</code>
083eacf86f9327835b824f9e6be987d56cd96e82slive for directives, unless they have been disabled with</p>
083eacf86f9327835b824f9e6be987d56cd96e82slive
083eacf86f9327835b824f9e6be987d56cd96e82slive <div class="example"><p><code>
083eacf86f9327835b824f9e6be987d56cd96e82slive &lt;Directory /&gt;<br />
083eacf86f9327835b824f9e6be987d56cd96e82slive <span class="indent">
083eacf86f9327835b824f9e6be987d56cd96e82slive AllowOverride None<br />
98dd94f575d903951ad09b81f8f6d529e4770f94nd </span>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd &lt;/Directory&gt;
439ebfd112c7216b5dbab8161a04fcf78a882e57nd </code></p></div>
083eacf86f9327835b824f9e6be987d56cd96e82slive
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<h3>See also</h3>
083eacf86f9327835b824f9e6be987d56cd96e82slive<ul>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh<li><code class="directive"><a href="#allowoverride">AllowOverride</a></code></li>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh<li><a href="/configuring.html">Configuration Files</a></li>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh<li><a href="/howto/htaccess.html">.htaccess Files</a></li>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh</ul>
083eacf86f9327835b824f9e6be987d56cd96e82slive</div>
083eacf86f9327835b824f9e6be987d56cd96e82slive<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
98dd94f575d903951ad09b81f8f6d529e4770f94nd<div class="directive-section"><h2><a name="AddDefaultCharset" id="AddDefaultCharset">AddDefaultCharset</a> <a name="adddefaultcharset" id="adddefaultcharset">Directive</a></h2>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<table class="directive">
98dd94f575d903951ad09b81f8f6d529e4770f94nd<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Default charset parameter to be added when a response
439ebfd112c7216b5dbab8161a04fcf78a882e57ndcontent-type is <code>text/plain</code> or <code>text/html</code></td></tr>
98dd94f575d903951ad09b81f8f6d529e4770f94nd<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AddDefaultCharset On|Off|<var>charset</var></code></td></tr>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AddDefaultCharset Off</code></td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
751d950b189a39828f91fc0eefff4340f82d4010rbowen<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
751d950b189a39828f91fc0eefff4340f82d4010rbowen</table>
751d950b189a39828f91fc0eefff4340f82d4010rbowen <p>This directive specifies a default value for the media type
751d950b189a39828f91fc0eefff4340f82d4010rbowen charset parameter (the name of a character encoding) to be added
751d950b189a39828f91fc0eefff4340f82d4010rbowen to a response if and only if the response's content-type is either
751d950b189a39828f91fc0eefff4340f82d4010rbowen <code>text/plain</code> or <code>text/html</code>. This should override
751d950b189a39828f91fc0eefff4340f82d4010rbowen any charset specified in the body of the response via a <code>META</code>
751d950b189a39828f91fc0eefff4340f82d4010rbowen element, though the exact behavior is often dependent on the user's client
751d950b189a39828f91fc0eefff4340f82d4010rbowen configuration. A setting of <code>AddDefaultCharset Off</code>
98dd94f575d903951ad09b81f8f6d529e4770f94nd disables this functionality. <code>AddDefaultCharset On</code> enables
439ebfd112c7216b5dbab8161a04fcf78a882e57nd a default charset of <code>iso-8859-1</code>. Any other value is assumed
439ebfd112c7216b5dbab8161a04fcf78a882e57nd to be the <var>charset</var> to be used, which should be one of the
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <a href="http://www.iana.org/assignments/character-sets">IANA registered
439ebfd112c7216b5dbab8161a04fcf78a882e57nd charset values</a> for use in Internet media types (MIME types).
439ebfd112c7216b5dbab8161a04fcf78a882e57nd For example:</p>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <div class="example"><p><code>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd AddDefaultCharset utf-8
439ebfd112c7216b5dbab8161a04fcf78a882e57nd </code></p></div>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <p><code class="directive">AddDefaultCharset</code> should only be used when all
0fdabb7c68f90ef30772c791d2f97ad9c8bb4701covener of the text resources to which it applies are known to be in that
0fdabb7c68f90ef30772c791d2f97ad9c8bb4701covener character encoding and it is too inconvenient to label their charset
0fdabb7c68f90ef30772c791d2f97ad9c8bb4701covener individually. One such example is to add the charset parameter
0fdabb7c68f90ef30772c791d2f97ad9c8bb4701covener to resources containing generated content, such as legacy CGI
5d01f40ffd657dd2ac567aacd93cabd162ddfa79coar scripts, that might be vulnerable to cross-site scripting attacks
0fdabb7c68f90ef30772c791d2f97ad9c8bb4701covener due to user-provided data being included in the output. Note, however,
0fdabb7c68f90ef30772c791d2f97ad9c8bb4701covener that a better solution is to just fix (or delete) those scripts, since
0fdabb7c68f90ef30772c791d2f97ad9c8bb4701covener setting a default charset does not protect users that have enabled
083eacf86f9327835b824f9e6be987d56cd96e82slive the "auto-detect character encoding" feature on their browser.</p>
083eacf86f9327835b824f9e6be987d56cd96e82slive
083eacf86f9327835b824f9e6be987d56cd96e82slive<h3>See also</h3>
083eacf86f9327835b824f9e6be987d56cd96e82slive<ul>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><code class="directive"><a href="/mod/mod_mime.html#addcharset">AddCharset</a></code></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive</ul>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd</div>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
083eacf86f9327835b824f9e6be987d56cd96e82slive<div class="directive-section"><h2><a name="AddOutputFilterByType" id="AddOutputFilterByType">AddOutputFilterByType</a> <a name="addoutputfilterbytype" id="addoutputfilterbytype">Directive</a></h2>
083eacf86f9327835b824f9e6be987d56cd96e82slive<table class="directive">
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>assigns an output filter to a particular media-type</td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AddOutputFilterByType <var>filter</var>[;<var>filter</var>...]
083eacf86f9327835b824f9e6be987d56cd96e82slive<var>media-type</var> [<var>media-type</var>] ...</code></td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
98dd94f575d903951ad09b81f8f6d529e4770f94nd<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2d0030b59f0da82db9a98be85f3946c4abe69d81rbowen<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.0.33 and later; deprecated in Apache 2.1 and later</td></tr>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd</table>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <p>This directive activates a particular output <a href="/filter.html">filter</a> for a request depending on the
439ebfd112c7216b5dbab8161a04fcf78a882e57nd response <a class="glossarylink" href="/glossary.html#media-type" title="see glossary">media-type</a>. Because of certain
439ebfd112c7216b5dbab8161a04fcf78a882e57nd problems discussed below, this directive is deprecated. The same
439ebfd112c7216b5dbab8161a04fcf78a882e57nd functionality is available using <code class="module"><a href="/mod/mod_filter.html">mod_filter</a></code>.</p>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <p>The following example uses the <code>DEFLATE</code> filter, which
439ebfd112c7216b5dbab8161a04fcf78a882e57nd is provided by <code class="module"><a href="/mod/mod_deflate.html">mod_deflate</a></code>. It will compress all
c5985d98499b4e398e8b666ecc570569c4f28173rbowen output (either static or dynamic) which is labeled as
c5985d98499b4e398e8b666ecc570569c4f28173rbowen <code>text/html</code> or <code>text/plain</code> before it is sent
c5985d98499b4e398e8b666ecc570569c4f28173rbowen to the client.</p>
c5985d98499b4e398e8b666ecc570569c4f28173rbowen
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh <div class="example"><p><code>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh AddOutputFilterByType DEFLATE text/html text/plain
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh </code></p></div>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh <p>If you want the content to be processed by more than one filter, their
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh names have to be separated by semicolons. It's also possible to use one
0625cd06f863f3c751b1e3853851424726c49e0anilgun <code class="directive">AddOutputFilterByType</code> directive for each of
083eacf86f9327835b824f9e6be987d56cd96e82slive these filters.</p>
083eacf86f9327835b824f9e6be987d56cd96e82slive
083eacf86f9327835b824f9e6be987d56cd96e82slive <p>The configuration below causes all script output labeled as
083eacf86f9327835b824f9e6be987d56cd96e82slive <code>text/html</code> to be processed at first by the
083eacf86f9327835b824f9e6be987d56cd96e82slive <code>INCLUDES</code> filter and then by the <code>DEFLATE</code>
083eacf86f9327835b824f9e6be987d56cd96e82slive filter.</p>
083eacf86f9327835b824f9e6be987d56cd96e82slive
083eacf86f9327835b824f9e6be987d56cd96e82slive <div class="example"><p><code>
0625cd06f863f3c751b1e3853851424726c49e0anilgun &lt;Location /cgi-bin/&gt;<br />
083eacf86f9327835b824f9e6be987d56cd96e82slive <span class="indent">
6ff644bec71595a66d3515894b4ccfef25e492bfnd Options Includes<br />
439ebfd112c7216b5dbab8161a04fcf78a882e57nd AddOutputFilterByType INCLUDES;DEFLATE text/html<br />
083eacf86f9327835b824f9e6be987d56cd96e82slive </span>
083eacf86f9327835b824f9e6be987d56cd96e82slive &lt;/Location&gt;
083eacf86f9327835b824f9e6be987d56cd96e82slive </code></p></div>
083eacf86f9327835b824f9e6be987d56cd96e82slive
083eacf86f9327835b824f9e6be987d56cd96e82slive <div class="warning"><h3>Note</h3>
083eacf86f9327835b824f9e6be987d56cd96e82slive <p>Enabling filters with <code class="directive">AddOutputFilterByType</code>
083eacf86f9327835b824f9e6be987d56cd96e82slive may fail partially or completely in some cases. For example, no
98dd94f575d903951ad09b81f8f6d529e4770f94nd filters are applied if the <a class="glossarylink" href="/glossary.html#media-type" title="see glossary">media-type</a> could not
439ebfd112c7216b5dbab8161a04fcf78a882e57nd be determined. If you want to make sure that the filters will be
2d0030b59f0da82db9a98be85f3946c4abe69d81rbowen applied, assign the content type to a resource explicitly; for
439ebfd112c7216b5dbab8161a04fcf78a882e57nd example, with <code class="directive"><a href="/mod/mod_mime.html#addtype">AddType</a></code> or
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <code class="directive"><a href="#forcetype">ForceType</a></code>. Setting the
083eacf86f9327835b824f9e6be987d56cd96e82slive content type within a (non-nph) CGI script is also safe.</p>
083eacf86f9327835b824f9e6be987d56cd96e82slive
0625cd06f863f3c751b1e3853851424726c49e0anilgun </div>
0625cd06f863f3c751b1e3853851424726c49e0anilgun
083eacf86f9327835b824f9e6be987d56cd96e82slive<h3>See also</h3>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh<ul>
cfbc6b1bf12004f1b8c2f0fc016b1ec05630dc8brbowen<li><code class="directive"><a href="/mod/mod_mime.html#addoutputfilter">AddOutputFilter</a></code></li>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh<li><code class="directive"><a href="#setoutputfilter">SetOutputFilter</a></code></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><a href="/filter.html">filters</a></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive</ul>
083eacf86f9327835b824f9e6be987d56cd96e82slive</div>
083eacf86f9327835b824f9e6be987d56cd96e82slive<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
083eacf86f9327835b824f9e6be987d56cd96e82slive<div class="directive-section"><h2><a name="AllowEncodedSlashes" id="AllowEncodedSlashes">AllowEncodedSlashes</a> <a name="allowencodedslashes" id="allowencodedslashes">Directive</a></h2>
0625cd06f863f3c751b1e3853851424726c49e0anilgun<table class="directive">
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Determines whether encoded path separators in URLs are allowed to
439ebfd112c7216b5dbab8161a04fcf78a882e57ndbe passed through</td></tr>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AllowEncodedSlashes On|Off</code></td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AllowEncodedSlashes Off</code></td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.0.46 and later</td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive</table>
083eacf86f9327835b824f9e6be987d56cd96e82slive <p>The <code class="directive">AllowEncodedSlashes</code> directive allows URLs
439ebfd112c7216b5dbab8161a04fcf78a882e57nd which contain encoded path separators (<code>%2F</code> for <code>/</code>
98dd94f575d903951ad09b81f8f6d529e4770f94nd and additionally <code>%5C</code> for <code>\</code> on according systems)
439ebfd112c7216b5dbab8161a04fcf78a882e57nd to be used. Normally such URLs are refused with a 404 (Not found) error.</p>
2d0030b59f0da82db9a98be85f3946c4abe69d81rbowen
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <p>Turning <code class="directive">AllowEncodedSlashes</code> <code>On</code> is
439ebfd112c7216b5dbab8161a04fcf78a882e57nd mostly useful when used in conjunction with <code>PATH_INFO</code>.</p>
083eacf86f9327835b824f9e6be987d56cd96e82slive
083eacf86f9327835b824f9e6be987d56cd96e82slive <div class="note"><h3>Note</h3>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <p>Allowing encoded slashes does <em>not</em> imply <em>decoding</em>.
439ebfd112c7216b5dbab8161a04fcf78a882e57nd Occurrences of <code>%2F</code> or <code>%5C</code> (<em>only</em> on
083eacf86f9327835b824f9e6be987d56cd96e82slive according systems) will be left as such in the otherwise decoded URL
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh string.</p>
cfbc6b1bf12004f1b8c2f0fc016b1ec05630dc8brbowen </div>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh
083eacf86f9327835b824f9e6be987d56cd96e82slive<h3>See also</h3>
083eacf86f9327835b824f9e6be987d56cd96e82slive<ul>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><code class="directive"><a href="#acceptpathinfo">AcceptPathInfo</a></code></li>
083eacf86f9327835b824f9e6be987d56cd96e82slive</ul>
083eacf86f9327835b824f9e6be987d56cd96e82slive</div>
083eacf86f9327835b824f9e6be987d56cd96e82slive<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
083eacf86f9327835b824f9e6be987d56cd96e82slive<div class="directive-section"><h2><a name="AllowOverride" id="AllowOverride">AllowOverride</a> <a name="allowoverride" id="allowoverride">Directive</a></h2>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<table class="directive">
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Types of directives that are allowed in
083eacf86f9327835b824f9e6be987d56cd96e82slive<code>.htaccess</code> files</td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AllowOverride All|None|<var>directive-type</var>
083eacf86f9327835b824f9e6be987d56cd96e82slive[<var>directive-type</var>] ...</code></td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AllowOverride All</code></td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory</td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
98dd94f575d903951ad09b81f8f6d529e4770f94nd</table>
2d0030b59f0da82db9a98be85f3946c4abe69d81rbowen <p>When the server finds an <code>.htaccess</code> file (as
2d0030b59f0da82db9a98be85f3946c4abe69d81rbowen specified by <code class="directive"><a href="#accessfilename">AccessFileName</a></code>)
439ebfd112c7216b5dbab8161a04fcf78a882e57nd it needs to know which directives declared in that file can override
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh earlier configuration directives.</p>
cfbc6b1bf12004f1b8c2f0fc016b1ec05630dc8brbowen
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh <div class="note"><h3>Only available in &lt;Directory&gt; sections</h3>
083eacf86f9327835b824f9e6be987d56cd96e82slive <code class="directive">AllowOverride</code> is valid only in
083eacf86f9327835b824f9e6be987d56cd96e82slive <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code>
083eacf86f9327835b824f9e6be987d56cd96e82slive sections specified without regular expressions, not in <code class="directive"><a href="#location">&lt;Location&gt;</a></code>, <code class="directive"><a href="#directorymatch">&lt;DirectoryMatch&gt;</a></code> or
083eacf86f9327835b824f9e6be987d56cd96e82slive <code class="directive"><a href="#files">&lt;Files&gt;</a></code> sections.
083eacf86f9327835b824f9e6be987d56cd96e82slive </div>
083eacf86f9327835b824f9e6be987d56cd96e82slive
083eacf86f9327835b824f9e6be987d56cd96e82slive <p>When this directive is set to <code>None</code>, then
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <a href="#accessfilename">.htaccess</a> files are completely ignored.
083eacf86f9327835b824f9e6be987d56cd96e82slive In this case, the server will not even attempt to read
083eacf86f9327835b824f9e6be987d56cd96e82slive <code>.htaccess</code> files in the filesystem.</p>
083eacf86f9327835b824f9e6be987d56cd96e82slive
083eacf86f9327835b824f9e6be987d56cd96e82slive <p>When this directive is set to <code>All</code>, then any
083eacf86f9327835b824f9e6be987d56cd96e82slive directive which has the .htaccess <a href="directive-dict.html#Context">Context</a> is allowed in
083eacf86f9327835b824f9e6be987d56cd96e82slive <code>.htaccess</code> files.</p>
083eacf86f9327835b824f9e6be987d56cd96e82slive
083eacf86f9327835b824f9e6be987d56cd96e82slive <p>The <var>directive-type</var> can be one of the following
439ebfd112c7216b5dbab8161a04fcf78a882e57nd groupings of directives.</p>
083eacf86f9327835b824f9e6be987d56cd96e82slive
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh <dl>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <dt>AuthConfig</dt>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh
8842df23d0075c8139043c5fb8197058683fb183rbowen <dd>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd
083eacf86f9327835b824f9e6be987d56cd96e82slive Allow use of the authorization directives (<code class="directive"><a href="/mod/mod_authn_dbm.html#authdbmgroupfile">AuthDBMGroupFile</a></code>,
083eacf86f9327835b824f9e6be987d56cd96e82slive <code class="directive"><a href="/mod/mod_authn_dbm.html#authdbmuserfile">AuthDBMUserFile</a></code>,
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <code class="directive"><a href="/mod/mod_authz_groupfile.html#authgroupfile">AuthGroupFile</a></code>,
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <code class="directive"><a href="/mod/mod_authn_core.html#authname">AuthName</a></code>,
37f0d5a24f4107130805cbe65cb798ce3946df7brbowen <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>
37f0d5a24f4107130805cbe65cb798ce3946df7brbowen
37f0d5a24f4107130805cbe65cb798ce3946df7brbowen <dt>FileInfo</dt>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <dd>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh Allow use of the directives controlling document types
0625cd06f863f3c751b1e3853851424726c49e0anilgun (<code class="directive"><a href="#errordocument">ErrorDocument</a></code>,
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <code class="directive"><a href="#forcetype">ForceType</a></code>,
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <code class="directive"><a href="/mod/mod_negotiation.html#languagepriority">LanguagePriority</a></code>,
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <code class="directive"><a href="#sethandler">SetHandler</a></code>,
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <code class="directive"><a href="#setinputfilter">SetInputFilter</a></code>,
083eacf86f9327835b824f9e6be987d56cd96e82slive <code class="directive"><a href="#setoutputfilter">SetOutputFilter</a></code>, and
083eacf86f9327835b824f9e6be987d56cd96e82slive <code class="module"><a href="/mod/mod_mime.html">mod_mime</a></code> Add* and Remove* directives),
439ebfd112c7216b5dbab8161a04fcf78a882e57nd 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>),
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh <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
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <code class="directive"><a href="/mod/mod_actions.html#action">Action</a></code> from
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh <code class="module"><a href="/mod/mod_actions.html">mod_actions</a></code>.
439ebfd112c7216b5dbab8161a04fcf78a882e57nd </dd>
083eacf86f9327835b824f9e6be987d56cd96e82slive
9f57d601ce42feab067a08a9827da30d39c1fd41nd <dt>Indexes</dt>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd
9f57d601ce42feab067a08a9827da30d39c1fd41nd <dd>
9f57d601ce42feab067a08a9827da30d39c1fd41nd Allow use of the directives controlling directory indexing
9f57d601ce42feab067a08a9827da30d39c1fd41nd (<code class="directive"><a href="/mod/mod_autoindex.html#adddescription">AddDescription</a></code>,
9f57d601ce42feab067a08a9827da30d39c1fd41nd <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>,
083eacf86f9327835b824f9e6be987d56cd96e82slive <code class="directive"><a href="/mod/mod_autoindex.html#addiconbytype">AddIconByType</a></code>,
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <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>,
083eacf86f9327835b824f9e6be987d56cd96e82slive <em>etc.</em>).</dd>
083eacf86f9327835b824f9e6be987d56cd96e82slive
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <dt>Limit</dt>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd
98dd94f575d903951ad09b81f8f6d529e4770f94nd <dd>
083eacf86f9327835b824f9e6be987d56cd96e82slive 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>
083eacf86f9327835b824f9e6be987d56cd96e82slive
083eacf86f9327835b824f9e6be987d56cd96e82slive <dt>Options[=<var>Option</var>,...]</dt>
61d29dac384de8b27485e54e53f1386549c578e1rbowen
d312425a41a3b2decfcd893f3b34e87da33cf956humbedooh <dd>
083eacf86f9327835b824f9e6be987d56cd96e82slive Allow use of the directives controlling specific directory
083eacf86f9327835b824f9e6be987d56cd96e82slive features (<code class="directive"><a href="#options">Options</a></code> and
083eacf86f9327835b824f9e6be987d56cd96e82slive <code class="directive"><a href="/mod/mod_include.html#xbithack">XBitHack</a></code>).
083eacf86f9327835b824f9e6be987d56cd96e82slive An equal sign may be given followed by a comma (but no spaces)
0625cd06f863f3c751b1e3853851424726c49e0anilgun separated lists of options that may be set using the <code class="directive"><a href="#options">Options</a></code> command.</dd>
083eacf86f9327835b824f9e6be987d56cd96e82slive </dl>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd
82361795d39893e6627e006b41ab5caa5c522d3frbowen <p>Example:</p>
083eacf86f9327835b824f9e6be987d56cd96e82slive
083eacf86f9327835b824f9e6be987d56cd96e82slive <div class="example"><p><code>
083eacf86f9327835b824f9e6be987d56cd96e82slive AllowOverride AuthConfig Indexes
083eacf86f9327835b824f9e6be987d56cd96e82slive </code></p></div>
083eacf86f9327835b824f9e6be987d56cd96e82slive
083eacf86f9327835b824f9e6be987d56cd96e82slive <p>In the example above all directives that are neither in the group
083eacf86f9327835b824f9e6be987d56cd96e82slive <code>AuthConfig</code> nor <code>Indexes</code> cause an internal
439ebfd112c7216b5dbab8161a04fcf78a882e57nd server error.</p>
2972c7cfbfad14dec221c6dd11c784f64f6eea26slive
2972c7cfbfad14dec221c6dd11c784f64f6eea26slive <div class="note"><p>For security and performance reasons, do not set
8dfd093f5df2436bd7a9f738832667f889e6d3b2jailletc <code>AllowOverride</code> to anything other than <code>None</code>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd in your <code>&lt;Directory /&gt;</code> block. Instead, find (or
439ebfd112c7216b5dbab8161a04fcf78a882e57nd create) the <code>&lt;Directory&gt;</code> block that refers to the
083eacf86f9327835b824f9e6be987d56cd96e82slive directory where you're actually planning to place a
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh <code>.htaccess</code> file.</p>
f3402c61b8577dcbf54283db51f4b621ec6a020drbowen </div>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh
c49c842267a87cac2bfaa124167d72cd14620729covener<h3>See also</h3>
c49c842267a87cac2bfaa124167d72cd14620729covener<ul>
c49c842267a87cac2bfaa124167d72cd14620729covener<li><code class="directive"><a href="#accessfilename">AccessFileName</a></code></li>
c49c842267a87cac2bfaa124167d72cd14620729covener<li><a href="/configuring.html">Configuration Files</a></li>
c49c842267a87cac2bfaa124167d72cd14620729covener<li><a href="/howto/htaccess.html">.htaccess Files</a></li>
c49c842267a87cac2bfaa124167d72cd14620729covener</ul>
c49c842267a87cac2bfaa124167d72cd14620729covener</div>
083eacf86f9327835b824f9e6be987d56cd96e82slive<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
61d29dac384de8b27485e54e53f1386549c578e1rbowen<div class="directive-section"><h2><a name="CGIMapExtension" id="CGIMapExtension">CGIMapExtension</a> <a name="cgimapextension" id="cgimapextension">Directive</a></h2>
083eacf86f9327835b824f9e6be987d56cd96e82slive<table class="directive">
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Technique for locating the interpreter for CGI
9e7c7a8fa19c33d1e90f8f7ffab69beacbe72566covenerscripts</td></tr>
9e7c7a8fa19c33d1e90f8f7ffab69beacbe72566covener<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CGIMapExtension <var>cgi-path</var> <var>.extension</var></code></td></tr>
9e7c7a8fa19c33d1e90f8f7ffab69beacbe72566covener<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
9e7c7a8fa19c33d1e90f8f7ffab69beacbe72566covener<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
9e7c7a8fa19c33d1e90f8f7ffab69beacbe72566covener<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
9e7c7a8fa19c33d1e90f8f7ffab69beacbe72566covener<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
9e7c7a8fa19c33d1e90f8f7ffab69beacbe72566covener<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>NetWare only</td></tr>
9e7c7a8fa19c33d1e90f8f7ffab69beacbe72566covener</table>
9e7c7a8fa19c33d1e90f8f7ffab69beacbe72566covener <p>This directive is used to control how Apache finds the
a38c7ee7f80149f0e0ee064f252e8efbaf3582b9nd interpreter used to run CGI scripts. For example, setting
9e7c7a8fa19c33d1e90f8f7ffab69beacbe72566covener <code>CGIMapExtension sys:\foo.nlm .foo</code> will
9e7c7a8fa19c33d1e90f8f7ffab69beacbe72566covener cause all CGI script files with a <code>.foo</code> extension to
9e7c7a8fa19c33d1e90f8f7ffab69beacbe72566covener be passed to the FOO interpreter.</p>
9e7c7a8fa19c33d1e90f8f7ffab69beacbe72566covener
9e7c7a8fa19c33d1e90f8f7ffab69beacbe72566covener</div>
9e7c7a8fa19c33d1e90f8f7ffab69beacbe72566covener<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh<div class="directive-section"><h2><a name="ContentDigest" id="ContentDigest">ContentDigest</a> <a name="contentdigest" id="contentdigest">Directive</a></h2>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar<table class="directive">
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables the generation of <code>Content-MD5</code> HTTP Response
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedoohheaders</td></tr>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ContentDigest On|Off</code></td></tr>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ContentDigest Off</code></td></tr>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Options</td></tr>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
9e7c7a8fa19c33d1e90f8f7ffab69beacbe72566covener<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
9e7c7a8fa19c33d1e90f8f7ffab69beacbe72566covener</table>
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim <p>This directive enables the generation of
9e7c7a8fa19c33d1e90f8f7ffab69beacbe72566covener <code>Content-MD5</code> headers as defined in RFC1864
9e7c7a8fa19c33d1e90f8f7ffab69beacbe72566covener respectively RFC2616.</p>
9e7c7a8fa19c33d1e90f8f7ffab69beacbe72566covener
9e7c7a8fa19c33d1e90f8f7ffab69beacbe72566covener <p>MD5 is an algorithm for computing a "message digest"
083eacf86f9327835b824f9e6be987d56cd96e82slive (sometimes called "fingerprint") of arbitrary-length data, with
083eacf86f9327835b824f9e6be987d56cd96e82slive a high degree of confidence that any alterations in the data
0625cd06f863f3c751b1e3853851424726c49e0anilgun will be reflected in alterations in the message digest.</p>
083eacf86f9327835b824f9e6be987d56cd96e82slive
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <p>The <code>Content-MD5</code> header provides an end-to-end
439ebfd112c7216b5dbab8161a04fcf78a882e57nd message integrity check (MIC) of the entity-body. A proxy or
82361795d39893e6627e006b41ab5caa5c522d3frbowen client may check this header for detecting accidental
083eacf86f9327835b824f9e6be987d56cd96e82slive modification of the entity-body in transit. Example header:</p>
083eacf86f9327835b824f9e6be987d56cd96e82slive
083eacf86f9327835b824f9e6be987d56cd96e82slive <div class="example"><p><code>
083eacf86f9327835b824f9e6be987d56cd96e82slive Content-MD5: AuLb7Dp1rqtRtxz2m9kRpA==
083eacf86f9327835b824f9e6be987d56cd96e82slive </code></p></div>
083eacf86f9327835b824f9e6be987d56cd96e82slive
083eacf86f9327835b824f9e6be987d56cd96e82slive <p>Note that this can cause performance problems on your server
439ebfd112c7216b5dbab8161a04fcf78a882e57nd since the message digest is computed on every request (the
083eacf86f9327835b824f9e6be987d56cd96e82slive values are not cached).</p>
083eacf86f9327835b824f9e6be987d56cd96e82slive
083eacf86f9327835b824f9e6be987d56cd96e82slive <p><code>Content-MD5</code> is only sent for documents served
15a94ca0ea54ceb8979eead34bde3bc9410a03farbowen by the <code class="module"><a href="/mod/core.html">core</a></code>, and not by any module. For example,
15a94ca0ea54ceb8979eead34bde3bc9410a03farbowen SSI documents, output from CGI scripts, and byte range responses
15a94ca0ea54ceb8979eead34bde3bc9410a03farbowen do not have this header.</p>
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim
15a94ca0ea54ceb8979eead34bde3bc9410a03farbowen</div>
15a94ca0ea54ceb8979eead34bde3bc9410a03farbowen<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
15a94ca0ea54ceb8979eead34bde3bc9410a03farbowen<div class="directive-section"><h2><a name="DefaultType" id="DefaultType">DefaultType</a> <a name="defaulttype" id="defaulttype">Directive</a></h2>
15a94ca0ea54ceb8979eead34bde3bc9410a03farbowen<table class="directive">
15a94ca0ea54ceb8979eead34bde3bc9410a03farbowen<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>This directive has no effect other than to emit warnings
020366f830905b6b5dfccfa03373379ae6a13e7blgentisif the value is not <code>none</code>. In prior versions, DefaultType
15a94ca0ea54ceb8979eead34bde3bc9410a03farbowenwould specify a default media type to assign to response content for
15a94ca0ea54ceb8979eead34bde3bc9410a03farbowenwhich no other media type configuration could be found.
15a94ca0ea54ceb8979eead34bde3bc9410a03farbowen</td></tr>
15a94ca0ea54ceb8979eead34bde3bc9410a03farbowen<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DefaultType <var>media-type|none</var></code></td></tr>
3a0ea65fa7273630004ec61af9eb036c64738380jim<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>DefaultType none</code></td></tr>
3a0ea65fa7273630004ec61af9eb036c64738380jim<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
aa0c9ba3adef6e0e98c6f38d2bf690283b609aacrbowen<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
3a0ea65fa7273630004ec61af9eb036c64738380jim<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
3a0ea65fa7273630004ec61af9eb036c64738380jim<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
3a0ea65fa7273630004ec61af9eb036c64738380jim<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>The argument <code>none</code> is available in Apache 2.2.7 and later. All other choices are DISABLED for 2.3.x and later.</td></tr>
3a0ea65fa7273630004ec61af9eb036c64738380jim</table>
a492af8c8261d9c85cec48a2bd6cd42f488a0028poirier <p>This directive has been disabled. For backwards compatibility
a492af8c8261d9c85cec48a2bd6cd42f488a0028poirier of configuration files, it may be specified with the value
a492af8c8261d9c85cec48a2bd6cd42f488a0028poirier <code>none</code>, meaning no default media type. For example:</p>
a492af8c8261d9c85cec48a2bd6cd42f488a0028poirier
3a0ea65fa7273630004ec61af9eb036c64738380jim <div class="example"><p><code>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh DefaultType None
3a0ea65fa7273630004ec61af9eb036c64738380jim </code></p></div>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh
3a0ea65fa7273630004ec61af9eb036c64738380jim <p><code>DefaultType None</code> is only available in
0625cd06f863f3c751b1e3853851424726c49e0anilgun httpd-2.2.7 and later.</p>
98dd94f575d903951ad09b81f8f6d529e4770f94nd
98dd94f575d903951ad09b81f8f6d529e4770f94nd <p>Use the mime.types configuration file and the
61d29dac384de8b27485e54e53f1386549c578e1rbowen <code class="directive"><a href="/mod/mod_mime.html#addtype">AddType</a></code> to configure media
083eacf86f9327835b824f9e6be987d56cd96e82slive type assignments via file extensions, or the
083eacf86f9327835b824f9e6be987d56cd96e82slive <code class="directive"><a href="#forcetype">ForceType</a></code> directive to configure
083eacf86f9327835b824f9e6be987d56cd96e82slive the media type for specific resources. Otherwise, the server will
083eacf86f9327835b824f9e6be987d56cd96e82slive send the response without a Content-Type header field and the
083eacf86f9327835b824f9e6be987d56cd96e82slive recipient may attempt to guess the media type.</p>
10972f918d8060e3c6a90400a1d5befcea34368crbowen
10972f918d8060e3c6a90400a1d5befcea34368crbowen</div>
083eacf86f9327835b824f9e6be987d56cd96e82slive<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<div class="directive-section"><h2><a name="Define" id="Define">Define</a> <a name="define" id="define">Directive</a></h2>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<table class="directive">
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Define the existence of a variable</td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Define <var>parameter-name</var></code></td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
10972f918d8060e3c6a90400a1d5befcea34368crbowen<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
10972f918d8060e3c6a90400a1d5befcea34368crbowen</table>
083eacf86f9327835b824f9e6be987d56cd96e82slive <p>Equivalent to passing the <code>-D</code> argument to <code class="program"><a href="/programs/httpd.html">httpd</a></code>.</p>
530eba85dbd41b8a0fa5255d3648d1440199a661slive <p>This directive can be used to toggle the use of <code class="directive"><a href="#ifdefine">&lt;IfDefine&gt;</a></code> sections without needing to alter
083eacf86f9327835b824f9e6be987d56cd96e82slive <code>-D</code> arguments in any startup scripts.</p>
98dd94f575d903951ad09b81f8f6d529e4770f94nd
98dd94f575d903951ad09b81f8f6d529e4770f94nd</div>
083eacf86f9327835b824f9e6be987d56cd96e82slive<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<div class="directive-section"><h2><a name="Directory" id="Directory">&lt;Directory&gt;</a> <a name="directory" id="directory">Directive</a></h2>
083eacf86f9327835b824f9e6be987d56cd96e82slive<table class="directive">
98dd94f575d903951ad09b81f8f6d529e4770f94nd<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enclose a group of directives that apply only to the
61d29dac384de8b27485e54e53f1386549c578e1rbowennamed file-system directory and sub-directories</td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;Directory <var>directory-path</var>&gt;
083eacf86f9327835b824f9e6be987d56cd96e82slive... &lt;/Directory&gt;</code></td></tr>
530eba85dbd41b8a0fa5255d3648d1440199a661slive<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive</table>
083eacf86f9327835b824f9e6be987d56cd96e82slive <p><code class="directive">&lt;Directory&gt;</code> and
083eacf86f9327835b824f9e6be987d56cd96e82slive <code>&lt;/Directory&gt;</code> are used to enclose a group of
083eacf86f9327835b824f9e6be987d56cd96e82slive directives that will apply only to the named directory and
083eacf86f9327835b824f9e6be987d56cd96e82slive sub-directories of that directory. Any directive that is allowed
5d01f40ffd657dd2ac567aacd93cabd162ddfa79coar in a directory context may be used. <var>Directory-path</var> is
5d01f40ffd657dd2ac567aacd93cabd162ddfa79coar either the full path to a directory, or a wild-card string using
10972f918d8060e3c6a90400a1d5befcea34368crbowen Unix shell-style matching. In a wild-card string, <code>?</code> matches
10972f918d8060e3c6a90400a1d5befcea34368crbowen any single character, and <code>*</code> matches any sequences of
10972f918d8060e3c6a90400a1d5befcea34368crbowen characters. You may also use <code>[]</code> character ranges. None
083eacf86f9327835b824f9e6be987d56cd96e82slive of the wildcards match a `/' character, so <code>&lt;Directory
98dd94f575d903951ad09b81f8f6d529e4770f94nd /*/public_html&gt;</code> will not match
61d29dac384de8b27485e54e53f1386549c578e1rbowen <code>/home/user/public_html</code>, but <code>&lt;Directory
083eacf86f9327835b824f9e6be987d56cd96e82slive /home/*/public_html&gt;</code> will match. Example:</p>
5ffbccf9c29985c1f9d249d1c1f658f661df752bsf
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim <div class="example"><p><code>
5ffbccf9c29985c1f9d249d1c1f658f661df752bsf &lt;Directory /usr/local/httpd/htdocs&gt;<br />
083eacf86f9327835b824f9e6be987d56cd96e82slive <span class="indent">
5ffbccf9c29985c1f9d249d1c1f658f661df752bsf Options Indexes FollowSymLinks<br />
083eacf86f9327835b824f9e6be987d56cd96e82slive </span>
98dd94f575d903951ad09b81f8f6d529e4770f94nd &lt;/Directory&gt;
98dd94f575d903951ad09b81f8f6d529e4770f94nd </code></p></div>
083eacf86f9327835b824f9e6be987d56cd96e82slive
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <div class="note">
083eacf86f9327835b824f9e6be987d56cd96e82slive <p>Be careful with the <var>directory-path</var> arguments:
083eacf86f9327835b824f9e6be987d56cd96e82slive They have to literally match the filesystem path which Apache uses
98dd94f575d903951ad09b81f8f6d529e4770f94nd to access the files. Directives applied to a particular
98dd94f575d903951ad09b81f8f6d529e4770f94nd <code>&lt;Directory&gt;</code> will not apply to files accessed from
439ebfd112c7216b5dbab8161a04fcf78a882e57nd that same directory via a different path, such as via different symbolic
083eacf86f9327835b824f9e6be987d56cd96e82slive links.</p>
0625cd06f863f3c751b1e3853851424726c49e0anilgun </div>
0625cd06f863f3c751b1e3853851424726c49e0anilgun
0625cd06f863f3c751b1e3853851424726c49e0anilgun <p><a class="glossarylink" href="/glossary.html#regex" title="see glossary">Regular
0625cd06f863f3c751b1e3853851424726c49e0anilgun expressions</a> can also be used, with the addition of the
0625cd06f863f3c751b1e3853851424726c49e0anilgun <code>~</code> character. For example:</p>
0625cd06f863f3c751b1e3853851424726c49e0anilgun
10972f918d8060e3c6a90400a1d5befcea34368crbowen <div class="example"><p><code>
5d01f40ffd657dd2ac567aacd93cabd162ddfa79coar &lt;Directory ~ "^/www/.*/[0-9]{3}"&gt;
10972f918d8060e3c6a90400a1d5befcea34368crbowen </code></p></div>
10972f918d8060e3c6a90400a1d5befcea34368crbowen
10972f918d8060e3c6a90400a1d5befcea34368crbowen <p>would match directories in <code>/www/</code> that consisted of
10972f918d8060e3c6a90400a1d5befcea34368crbowen three numbers.</p>
10972f918d8060e3c6a90400a1d5befcea34368crbowen
083eacf86f9327835b824f9e6be987d56cd96e82slive <p>If multiple (non-regular expression) <code class="directive">&lt;Directory&gt;</code> sections
98dd94f575d903951ad09b81f8f6d529e4770f94nd match the directory (or one of its parents) containing a document,
98dd94f575d903951ad09b81f8f6d529e4770f94nd then the directives are applied in the order of shortest match
439ebfd112c7216b5dbab8161a04fcf78a882e57nd first, interspersed with the directives from the <a href="#accessfilename">.htaccess</a> files. For example,
083eacf86f9327835b824f9e6be987d56cd96e82slive with</p>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <div class="example"><p><code>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd &lt;Directory /&gt;<br />
083eacf86f9327835b824f9e6be987d56cd96e82slive <span class="indent">
083eacf86f9327835b824f9e6be987d56cd96e82slive AllowOverride None<br />
083eacf86f9327835b824f9e6be987d56cd96e82slive </span>
aa0c9ba3adef6e0e98c6f38d2bf690283b609aacrbowen &lt;/Directory&gt;<br />
083eacf86f9327835b824f9e6be987d56cd96e82slive <br />
083eacf86f9327835b824f9e6be987d56cd96e82slive &lt;Directory /home/&gt;<br />
98dd94f575d903951ad09b81f8f6d529e4770f94nd <span class="indent">
98dd94f575d903951ad09b81f8f6d529e4770f94nd AllowOverride FileInfo<br />
fb68d6d0b139441b677add149ebbca8e3b2daab1dpejesh </span>
0625cd06f863f3c751b1e3853851424726c49e0anilgun &lt;/Directory&gt;
0625cd06f863f3c751b1e3853851424726c49e0anilgun </code></p></div>
0625cd06f863f3c751b1e3853851424726c49e0anilgun
0625cd06f863f3c751b1e3853851424726c49e0anilgun <p>for access to the document <code>/home/web/dir/doc.html</code>
0625cd06f863f3c751b1e3853851424726c49e0anilgun the steps are:</p>
fb68d6d0b139441b677add149ebbca8e3b2daab1dpejesh
98dd94f575d903951ad09b81f8f6d529e4770f94nd <ul>
98dd94f575d903951ad09b81f8f6d529e4770f94nd <li>Apply directive <code>AllowOverride None</code>
083eacf86f9327835b824f9e6be987d56cd96e82slive (disabling <code>.htaccess</code> files).</li>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <li>Apply directive <code>AllowOverride FileInfo</code> (for
98dd94f575d903951ad09b81f8f6d529e4770f94nd directory <code>/home</code>).</li>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd
083eacf86f9327835b824f9e6be987d56cd96e82slive <li>Apply any <code>FileInfo</code> directives in
98dd94f575d903951ad09b81f8f6d529e4770f94nd <code>/home/.htaccess</code>, <code>/home/web/.htaccess</code> and
98dd94f575d903951ad09b81f8f6d529e4770f94nd <code>/home/web/dir/.htaccess</code> in that order.</li>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd </ul>
083eacf86f9327835b824f9e6be987d56cd96e82slive
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <p>Regular expressions are not considered until after all of the
439ebfd112c7216b5dbab8161a04fcf78a882e57nd normal sections have been applied. Then all of the regular
083eacf86f9327835b824f9e6be987d56cd96e82slive expressions are tested in the order they appeared in the
439ebfd112c7216b5dbab8161a04fcf78a882e57nd configuration file. For example, with</p>
f27212a57263d925fe40e3f48a255502b98f4eecrbowen
f27212a57263d925fe40e3f48a255502b98f4eecrbowen <div class="example"><p><code>
083eacf86f9327835b824f9e6be987d56cd96e82slive &lt;Directory ~ abc$&gt;<br />
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <span class="indent">
439ebfd112c7216b5dbab8161a04fcf78a882e57nd # ... directives here ...<br />
083eacf86f9327835b824f9e6be987d56cd96e82slive </span>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd &lt;/Directory&gt;
439ebfd112c7216b5dbab8161a04fcf78a882e57nd </code></p></div>
083eacf86f9327835b824f9e6be987d56cd96e82slive
98dd94f575d903951ad09b81f8f6d529e4770f94nd <p>the regular expression section won't be considered until after
98dd94f575d903951ad09b81f8f6d529e4770f94nd all normal <code class="directive">&lt;Directory&gt;</code>s and
083eacf86f9327835b824f9e6be987d56cd96e82slive <code>.htaccess</code> files have been applied. Then the regular
439ebfd112c7216b5dbab8161a04fcf78a882e57nd expression will match on <code>/home/abc/public_html/abc</code> and
083eacf86f9327835b824f9e6be987d56cd96e82slive the corresponding <code class="directive">&lt;Directory&gt;</code> will
439ebfd112c7216b5dbab8161a04fcf78a882e57nd be applied.</p>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <p><strong>Note that the default Apache access for
083eacf86f9327835b824f9e6be987d56cd96e82slive <code>&lt;Directory /&gt;</code> is <code>Allow from All</code>.
752ec04fdfa6e936047811b9e506cf829d7a69f7pquerna This means that Apache will serve any file mapped from an URL. It is
752ec04fdfa6e936047811b9e506cf829d7a69f7pquerna recommended that you change this with a block such
752ec04fdfa6e936047811b9e506cf829d7a69f7pquerna as</strong></p>
aa0c9ba3adef6e0e98c6f38d2bf690283b609aacrbowen
0625cd06f863f3c751b1e3853851424726c49e0anilgun <div class="example"><p><code>
0625cd06f863f3c751b1e3853851424726c49e0anilgun &lt;Directory /&gt;<br />
752ec04fdfa6e936047811b9e506cf829d7a69f7pquerna <span class="indent">
98dd94f575d903951ad09b81f8f6d529e4770f94nd Order Deny,Allow<br />
98dd94f575d903951ad09b81f8f6d529e4770f94nd Deny from All<br />
439ebfd112c7216b5dbab8161a04fcf78a882e57nd </span>
083eacf86f9327835b824f9e6be987d56cd96e82slive &lt;/Directory&gt;
aa0c9ba3adef6e0e98c6f38d2bf690283b609aacrbowen </code></p></div>
083eacf86f9327835b824f9e6be987d56cd96e82slive
083eacf86f9327835b824f9e6be987d56cd96e82slive <p><strong>and then override this for directories you
083eacf86f9327835b824f9e6be987d56cd96e82slive <em>want</em> accessible. See the <a href="/misc/security_tips.html">Security Tips</a> page for more
61d29dac384de8b27485e54e53f1386549c578e1rbowen details.</strong></p>
61d29dac384de8b27485e54e53f1386549c578e1rbowen
0625cd06f863f3c751b1e3853851424726c49e0anilgun <p>The directory sections occur in the <code>httpd.conf</code> file.
61d29dac384de8b27485e54e53f1386549c578e1rbowen <code class="directive">&lt;Directory&gt;</code> directives
083eacf86f9327835b824f9e6be987d56cd96e82slive cannot nest, and cannot appear in a <code class="directive"><a href="#limit">&lt;Limit&gt;</a></code> or <code class="directive"><a href="#limitexcept">&lt;LimitExcept&gt;</a></code> section.</p>
98dd94f575d903951ad09b81f8f6d529e4770f94nd
98dd94f575d903951ad09b81f8f6d529e4770f94nd<h3>See also</h3>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<ul>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><a href="/sections.html">How &lt;Directory&gt;,
439ebfd112c7216b5dbab8161a04fcf78a882e57nd &lt;Location&gt; and &lt;Files&gt; sections work</a> for an
083eacf86f9327835b824f9e6be987d56cd96e82slive explanation of how these different sections are combined when a
083eacf86f9327835b824f9e6be987d56cd96e82slive request is received</li>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd</ul>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd</div>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
98dd94f575d903951ad09b81f8f6d529e4770f94nd<div class="directive-section"><h2><a name="DirectoryMatch" id="DirectoryMatch">&lt;DirectoryMatch&gt;</a> <a name="directorymatch" id="directorymatch">Directive</a></h2>
10972f918d8060e3c6a90400a1d5befcea34368crbowen<table class="directive">
5d01f40ffd657dd2ac567aacd93cabd162ddfa79coar<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enclose directives that apply to
10972f918d8060e3c6a90400a1d5befcea34368crbowenfile-system directories matching a regular expression and their
10972f918d8060e3c6a90400a1d5befcea34368crbowensubdirectories</td></tr>
10972f918d8060e3c6a90400a1d5befcea34368crbowen<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;DirectoryMatch <var>regex</var>&gt;
10972f918d8060e3c6a90400a1d5befcea34368crbowen... &lt;/DirectoryMatch&gt;</code></td></tr>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
98dd94f575d903951ad09b81f8f6d529e4770f94nd<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
98dd94f575d903951ad09b81f8f6d529e4770f94nd<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd</table>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <p><code class="directive">&lt;DirectoryMatch&gt;</code> and
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <code>&lt;/DirectoryMatch&gt;</code> are used to enclose a group
083eacf86f9327835b824f9e6be987d56cd96e82slive of directives which will apply only to the named directory and
083eacf86f9327835b824f9e6be987d56cd96e82slive sub-directories of that directory, the same as <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code>. However, it
439ebfd112c7216b5dbab8161a04fcf78a882e57nd takes as an argument a <a class="glossarylink" href="/glossary.html#regex" title="see glossary">regular
439ebfd112c7216b5dbab8161a04fcf78a882e57nd expression</a>. For example:</p>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <div class="example"><p><code>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd &lt;DirectoryMatch "^/www/(.+/)?[0-9]{3}"&gt;
439ebfd112c7216b5dbab8161a04fcf78a882e57nd </code></p></div>
4c21c56ab34e9e74961a78539ce4760a5f0384cfrbowen
4c21c56ab34e9e74961a78539ce4760a5f0384cfrbowen <p>would match directories in <code>/www/</code> that consisted of three
4c21c56ab34e9e74961a78539ce4760a5f0384cfrbowen numbers.</p>
422185cd9dfebf3fb5abf263c529acacfce221cfrbowen
4c21c56ab34e9e74961a78539ce4760a5f0384cfrbowen<h3>See also</h3>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<ul>
98dd94f575d903951ad09b81f8f6d529e4770f94nd<li><code class="directive"><a href="#directory">&lt;Directory&gt;</a></code> for
61d29dac384de8b27485e54e53f1386549c578e1rbowena description of how regular expressions are mixed in with normal
083eacf86f9327835b824f9e6be987d56cd96e82slive<code class="directive">&lt;Directory&gt;</code>s</li>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<li><a href="/sections.html">How &lt;Directory&gt;, &lt;Location&gt; and
439ebfd112c7216b5dbab8161a04fcf78a882e57nd&lt;Files&gt; sections work</a> for an explanation of how these different
439ebfd112c7216b5dbab8161a04fcf78a882e57ndsections are combined when a request is received</li>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd</ul>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd</div>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
083eacf86f9327835b824f9e6be987d56cd96e82slive<div class="directive-section"><h2><a name="DocumentRoot" id="DocumentRoot">DocumentRoot</a> <a name="documentroot" id="documentroot">Directive</a></h2>
98dd94f575d903951ad09b81f8f6d529e4770f94nd<table class="directive">
98dd94f575d903951ad09b81f8f6d529e4770f94nd<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Directory that forms the main document tree visible
439ebfd112c7216b5dbab8161a04fcf78a882e57ndfrom the web</td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DocumentRoot <var>directory-path</var></code></td></tr>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>DocumentRoot /usr/local/apache/htdocs</code></td></tr>
10972f918d8060e3c6a90400a1d5befcea34368crbowen<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
5d01f40ffd657dd2ac567aacd93cabd162ddfa79coar<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
10972f918d8060e3c6a90400a1d5befcea34368crbowen<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
10972f918d8060e3c6a90400a1d5befcea34368crbowen</table>
10972f918d8060e3c6a90400a1d5befcea34368crbowen <p>This directive sets the directory from which <code class="program"><a href="/programs/httpd.html">httpd</a></code>
10972f918d8060e3c6a90400a1d5befcea34368crbowen 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
083eacf86f9327835b824f9e6be987d56cd96e82slive path from the requested URL to the document root to make the
98dd94f575d903951ad09b81f8f6d529e4770f94nd path to the document. Example:</p>
98dd94f575d903951ad09b81f8f6d529e4770f94nd
61d29dac384de8b27485e54e53f1386549c578e1rbowen <div class="example"><p><code>
083eacf86f9327835b824f9e6be987d56cd96e82slive DocumentRoot /usr/web
439ebfd112c7216b5dbab8161a04fcf78a882e57nd </code></p></div>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <p>then an access to
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <code>http://www.my.host.com/index.html</code> refers to
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <code>/usr/web/index.html</code>. If the <var>directory-path</var> is
10972f918d8060e3c6a90400a1d5befcea34368crbowen not absolute then it is assumed to be relative to the <code class="directive"><a href="#serverroot">ServerRoot</a></code>.</p>
5d01f40ffd657dd2ac567aacd93cabd162ddfa79coar
10972f918d8060e3c6a90400a1d5befcea34368crbowen <p>The <code class="directive">DocumentRoot</code> should be specified without
10972f918d8060e3c6a90400a1d5befcea34368crbowen a trailing slash.</p>
10972f918d8060e3c6a90400a1d5befcea34368crbowen
10972f918d8060e3c6a90400a1d5befcea34368crbowen<h3>See also</h3>
10972f918d8060e3c6a90400a1d5befcea34368crbowen<ul>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><a href="/urlmapping.html#documentroot">Mapping URLs to Filesystem
98dd94f575d903951ad09b81f8f6d529e4770f94ndLocations</a></li>
98dd94f575d903951ad09b81f8f6d529e4770f94nd</ul>
083eacf86f9327835b824f9e6be987d56cd96e82slive</div>
10972f918d8060e3c6a90400a1d5befcea34368crbowen<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
5d01f40ffd657dd2ac567aacd93cabd162ddfa79coar<div class="directive-section"><h2><a name="EnableMMAP" id="EnableMMAP">EnableMMAP</a> <a name="enablemmap" id="enablemmap">Directive</a></h2>
10972f918d8060e3c6a90400a1d5befcea34368crbowen<table class="directive">
10972f918d8060e3c6a90400a1d5befcea34368crbowen<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Use memory-mapping to read files during delivery</td></tr>
10972f918d8060e3c6a90400a1d5befcea34368crbowen<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>EnableMMAP On|Off</code></td></tr>
10972f918d8060e3c6a90400a1d5befcea34368crbowen<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>EnableMMAP On</code></td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
98dd94f575d903951ad09b81f8f6d529e4770f94nd<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
61d29dac384de8b27485e54e53f1386549c578e1rbowen<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
0625cd06f863f3c751b1e3853851424726c49e0anilgun</table>
0625cd06f863f3c751b1e3853851424726c49e0anilgun <p>This directive controls whether the <code class="program"><a href="/programs/httpd.html">httpd</a></code> may use
0625cd06f863f3c751b1e3853851424726c49e0anilgun memory-mapping if it needs to read the contents of a file during
4a13940dc2990df0a798718d3a3f9cf1566c2217bjh delivery. By default, when the handling of a request requires
4a13940dc2990df0a798718d3a3f9cf1566c2217bjh access to the data within a file -- for example, when delivering a
083eacf86f9327835b824f9e6be987d56cd96e82slive server-parsed file using <code class="module"><a href="/mod/mod_include.html">mod_include</a></code> -- Apache
439ebfd112c7216b5dbab8161a04fcf78a882e57nd memory-maps the file if the OS supports it.</p>
083eacf86f9327835b824f9e6be987d56cd96e82slive
083eacf86f9327835b824f9e6be987d56cd96e82slive <p>This memory-mapping sometimes yields a performance improvement.
083eacf86f9327835b824f9e6be987d56cd96e82slive But in some environments, it is better to disable the memory-mapping
083eacf86f9327835b824f9e6be987d56cd96e82slive to prevent operational problems:</p>
0625cd06f863f3c751b1e3853851424726c49e0anilgun
0625cd06f863f3c751b1e3853851424726c49e0anilgun <ul>
083eacf86f9327835b824f9e6be987d56cd96e82slive <li>On some multiprocessor systems, memory-mapping can reduce the
15a94ca0ea54ceb8979eead34bde3bc9410a03farbowen performance of the <code class="program"><a href="/programs/httpd.html">httpd</a></code>.</li>
15a94ca0ea54ceb8979eead34bde3bc9410a03farbowen <li>Deleting or truncating a file while <code class="program"><a href="/programs/httpd.html">httpd</a></code>
aa0c9ba3adef6e0e98c6f38d2bf690283b609aacrbowen has it memory-mapped can cause <code class="program"><a href="/programs/httpd.html">httpd</a></code> to
15a94ca0ea54ceb8979eead34bde3bc9410a03farbowen crash with a segmentation fault.
15a94ca0ea54ceb8979eead34bde3bc9410a03farbowen </li>
15a94ca0ea54ceb8979eead34bde3bc9410a03farbowen </ul>
15a94ca0ea54ceb8979eead34bde3bc9410a03farbowen
15a94ca0ea54ceb8979eead34bde3bc9410a03farbowen <p>For server configurations that are vulnerable to these problems,
15a94ca0ea54ceb8979eead34bde3bc9410a03farbowen you should disable memory-mapping of delivered files by specifying:</p>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh
15a94ca0ea54ceb8979eead34bde3bc9410a03farbowen <div class="example"><p><code>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh EnableMMAP Off
15a94ca0ea54ceb8979eead34bde3bc9410a03farbowen </code></p></div>
15a94ca0ea54ceb8979eead34bde3bc9410a03farbowen
98dd94f575d903951ad09b81f8f6d529e4770f94nd <p>For NFS mounted files, this feature may be disabled explicitly for
98dd94f575d903951ad09b81f8f6d529e4770f94nd the offending files by specifying:</p>
aa0c9ba3adef6e0e98c6f38d2bf690283b609aacrbowen
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <div class="example"><p><code>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd &lt;Directory "/path-to-nfs-files"&gt;
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <span class="indent">
439ebfd112c7216b5dbab8161a04fcf78a882e57nd EnableMMAP Off
439ebfd112c7216b5dbab8161a04fcf78a882e57nd </span>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd &lt;/Directory&gt;
439ebfd112c7216b5dbab8161a04fcf78a882e57nd </code></p></div>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd
439ebfd112c7216b5dbab8161a04fcf78a882e57nd</div>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<div class="directive-section"><h2><a name="EnableSendfile" id="EnableSendfile">EnableSendfile</a> <a name="enablesendfile" id="enablesendfile">Directive</a></h2>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<table class="directive">
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<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>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>EnableSendfile On|Off</code></td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>EnableSendfile On</code></td></tr>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
083eacf86f9327835b824f9e6be987d56cd96e82slive<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.0.44 and later</td></tr>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd</table>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <p>This directive controls whether <code class="program"><a href="/programs/httpd.html">httpd</a></code> may use the
439ebfd112c7216b5dbab8161a04fcf78a882e57nd sendfile support from the kernel to transmit file contents to the client.
439ebfd112c7216b5dbab8161a04fcf78a882e57nd By default, when the handling of a request requires no access
083eacf86f9327835b824f9e6be987d56cd96e82slive to the data within a file -- for example, when delivering a
4dd6ef6e77f6c1a873769eb851a535c312219c34nd static file -- Apache uses sendfile to deliver the file contents
4dd6ef6e77f6c1a873769eb851a535c312219c34nd without ever reading the file if the OS supports it.</p>
4dd6ef6e77f6c1a873769eb851a535c312219c34nd
aa0c9ba3adef6e0e98c6f38d2bf690283b609aacrbowen <p>This sendfile mechanism avoids separate read and send operations,
4dd6ef6e77f6c1a873769eb851a535c312219c34nd and buffer allocations. But on some platforms or within some
4dd6ef6e77f6c1a873769eb851a535c312219c34nd filesystems, it is better to disable this feature to avoid
10972f918d8060e3c6a90400a1d5befcea34368crbowen operational problems:</p>
10972f918d8060e3c6a90400a1d5befcea34368crbowen
10972f918d8060e3c6a90400a1d5befcea34368crbowen <ul>
10972f918d8060e3c6a90400a1d5befcea34368crbowen <li>Some platforms may have broken sendfile support that the build
10972f918d8060e3c6a90400a1d5befcea34368crbowen system did not detect, especially if the binaries were built on
adaf7aabd73142c431c754a98b80ebcda749ffdcrbowen another box and moved to such a machine with broken sendfile
083eacf86f9327835b824f9e6be987d56cd96e82slive support.</li>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <li>On Linux the use of sendfile triggers TCP-checksum
10972f918d8060e3c6a90400a1d5befcea34368crbowen offloading bugs on certain networking cards when using IPv6.</li>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <li>On Linux on Itanium, sendfile may be unable to handle files
0625cd06f863f3c751b1e3853851424726c49e0anilgun over 2GB in size.</li>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <li>With a network-mounted <code class="directive"><a href="#documentroot">DocumentRoot</a></code> (e.g., NFS or SMB),
439ebfd112c7216b5dbab8161a04fcf78a882e57nd the kernel may be unable to serve the network file through
439ebfd112c7216b5dbab8161a04fcf78a882e57nd its own cache.</li>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd </ul>
d88842a4a8ab8ea4580c32da7a962e6e4cf4d9farbowen
d88842a4a8ab8ea4580c32da7a962e6e4cf4d9farbowen <p>For server configurations that are vulnerable to these problems,
439ebfd112c7216b5dbab8161a04fcf78a882e57nd you should disable this feature by specifying:</p>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <div class="example"><p><code>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd EnableSendfile Off
439ebfd112c7216b5dbab8161a04fcf78a882e57nd </code></p></div>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar <p>For NFS or SMB mounted files, this feature may be disabled explicitly
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh for the offending files by specifying:</p>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh <div class="example"><p><code>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh &lt;Directory "/path-to-nfs-files"&gt;
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <span class="indent">
439ebfd112c7216b5dbab8161a04fcf78a882e57nd EnableSendfile Off
439ebfd112c7216b5dbab8161a04fcf78a882e57nd </span>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh &lt;/Directory&gt;
439ebfd112c7216b5dbab8161a04fcf78a882e57nd </code></p></div>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh <p>Please note that the per-directory and .htaccess configuration
439ebfd112c7216b5dbab8161a04fcf78a882e57nd of <code class="directive">EnableSendfile</code> is not supported by
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <code class="module"><a href="/mod/mod_disk_cache.html">mod_disk_cache</a></code>.
439ebfd112c7216b5dbab8161a04fcf78a882e57nd Only global definition of <code class="directive">EnableSendfile</code>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd is taken into account by the module.
439ebfd112c7216b5dbab8161a04fcf78a882e57nd </p>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd
439ebfd112c7216b5dbab8161a04fcf78a882e57nd</div>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<div class="directive-section"><h2><a name="ErrorDocument" id="ErrorDocument">ErrorDocument</a> <a name="errordocument" id="errordocument">Directive</a></h2>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<table class="directive">
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>What the server will return to the client
439ebfd112c7216b5dbab8161a04fcf78a882e57ndin case of an error</td></tr>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ErrorDocument <var>error-code</var> <var>document</var></code></td></tr>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Quoting syntax for text messages is different in Apache
439ebfd112c7216b5dbab8161a04fcf78a882e57nd2.0</td></tr>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd</table>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <p>In the event of a problem or error, Apache can be configured
439ebfd112c7216b5dbab8161a04fcf78a882e57nd to do one of four things,</p>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <ol>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <li>output a simple hardcoded error message</li>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <li>output a customized message</li>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd
083eacf86f9327835b824f9e6be987d56cd96e82slive <li>redirect to a local <var>URL-path</var> to handle the
083eacf86f9327835b824f9e6be987d56cd96e82slive problem/error</li>
083eacf86f9327835b824f9e6be987d56cd96e82slive
083eacf86f9327835b824f9e6be987d56cd96e82slive <li>redirect to an external <var>URL</var> to handle the
083eacf86f9327835b824f9e6be987d56cd96e82slive problem/error</li>
083eacf86f9327835b824f9e6be987d56cd96e82slive </ol>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <p>The first option is the default, while options 2-4 are
1b4a19b547a5fa7f991706a7f4702c58b9e632b7nd configured using the <code class="directive">ErrorDocument</code>
083eacf86f9327835b824f9e6be987d56cd96e82slive directive, which is followed by the HTTP response code and a URL
083eacf86f9327835b824f9e6be987d56cd96e82slive or a message. Apache will sometimes offer additional information
083eacf86f9327835b824f9e6be987d56cd96e82slive regarding the problem/error.</p>
083eacf86f9327835b824f9e6be987d56cd96e82slive
083eacf86f9327835b824f9e6be987d56cd96e82slive <p>URLs can begin with a slash (/) for local web-paths (relative
083eacf86f9327835b824f9e6be987d56cd96e82slive to the <code class="directive"><a href="#documentroot">DocumentRoot</a></code>), or be a
083eacf86f9327835b824f9e6be987d56cd96e82slive full URL which the client can resolve. Alternatively, a message
98dd94f575d903951ad09b81f8f6d529e4770f94nd can be provided to be displayed by the browser. Examples:</p>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd
439ebfd112c7216b5dbab8161a04fcf78a882e57nd <div class="example"><p><code>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd ErrorDocument 500 http://foo.example.com/cgi-bin/tester<br />
439ebfd112c7216b5dbab8161a04fcf78a882e57nd ErrorDocument 404 /cgi-bin/bad_urls.pl<br />
083eacf86f9327835b824f9e6be987d56cd96e82slive ErrorDocument 401 /subscription_info.html<br />
083eacf86f9327835b824f9e6be987d56cd96e82slive ErrorDocument 403 "Sorry can't allow you access today"
083eacf86f9327835b824f9e6be987d56cd96e82slive </code></p></div>
083eacf86f9327835b824f9e6be987d56cd96e82slive
083eacf86f9327835b824f9e6be987d56cd96e82slive <p>Additionally, the special value <code>default</code> can be used
083eacf86f9327835b824f9e6be987d56cd96e82slive to specify Apache's simple hardcoded message. While not required
083eacf86f9327835b824f9e6be987d56cd96e82slive under normal circumstances, <code>default</code> will restore
083eacf86f9327835b824f9e6be987d56cd96e82slive Apache's simple hardcoded message for configurations that would
083eacf86f9327835b824f9e6be987d56cd96e82slive otherwise inherit an existing <code class="directive">ErrorDocument</code>.</p>
f6ece164c2e1055a3d02b10928e1623d18b1d625rbowen
f6ece164c2e1055a3d02b10928e1623d18b1d625rbowen <div class="example"><p><code>
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim ErrorDocument 404 /cgi-bin/bad_urls.pl<br /><br />
f6ece164c2e1055a3d02b10928e1623d18b1d625rbowen &lt;Directory /web/docs&gt;<br />
f6ece164c2e1055a3d02b10928e1623d18b1d625rbowen <span class="indent">
f6ece164c2e1055a3d02b10928e1623d18b1d625rbowen ErrorDocument 404 default<br />
f6ece164c2e1055a3d02b10928e1623d18b1d625rbowen </span>
f6ece164c2e1055a3d02b10928e1623d18b1d625rbowen &lt;/Directory&gt;
083eacf86f9327835b824f9e6be987d56cd96e82slive </code></p></div>
083eacf86f9327835b824f9e6be987d56cd96e82slive
e0be1183e544de306aa3cc887dc06522a23c3ed3dpejesh <p>Note that when you specify an <code class="directive">ErrorDocument</code>
7ed5992392d5babab20be4ce4029ad17ae062b5aianh that points to a remote URL (ie. anything with a method such as
7ed5992392d5babab20be4ce4029ad17ae062b5aianh <code>http</code> in front of it), Apache will send a redirect to the
e0be1183e544de306aa3cc887dc06522a23c3ed3dpejesh client to tell it where to find the document, even if the
e0be1183e544de306aa3cc887dc06522a23c3ed3dpejesh document ends up being on the same server. This has several
7ed5992392d5babab20be4ce4029ad17ae062b5aianh implications, the most important being that the client will not
7ed5992392d5babab20be4ce4029ad17ae062b5aianh receive the original error status code, but instead will
7ed5992392d5babab20be4ce4029ad17ae062b5aianh receive a redirect status code. This in turn can confuse web
7ed5992392d5babab20be4ce4029ad17ae062b5aianh robots and other clients which try to determine if a URL is
7ed5992392d5babab20be4ce4029ad17ae062b5aianh valid using the status code. In addition, if you use a remote
7ed5992392d5babab20be4ce4029ad17ae062b5aianh URL in an <code>ErrorDocument 401</code>, the client will not
e0be1183e544de306aa3cc887dc06522a23c3ed3dpejesh know to prompt the user for a password since it will not
e0be1183e544de306aa3cc887dc06522a23c3ed3dpejesh receive the 401 status code. Therefore, <strong>if you use an
7ed5992392d5babab20be4ce4029ad17ae062b5aianh <code>ErrorDocument 401</code> directive then it must refer to a local
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh document.</strong></p>
7ed5992392d5babab20be4ce4029ad17ae062b5aianh
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh <p>Microsoft Internet Explorer (MSIE) will by default ignore
f8e0184c566c9a69a710e9c2f2e6a0392e383945rbowen server-generated error messages when they are "too small" and substitute
f8e0184c566c9a69a710e9c2f2e6a0392e383945rbowen its own "friendly" error messages. The size threshold varies depending on
adaf7aabd73142c431c754a98b80ebcda749ffdcrbowen the type of error, but in general, if you make your error document
adaf7aabd73142c431c754a98b80ebcda749ffdcrbowen greater than 512 bytes, then MSIE will show the server-generated
adaf7aabd73142c431c754a98b80ebcda749ffdcrbowen error rather than masking it. More information is available in
adaf7aabd73142c431c754a98b80ebcda749ffdcrbowen Microsoft Knowledge Base article <a href="http://support.microsoft.com/default.aspx?scid=kb;en-us;Q294807">Q294807</a>.</p>
adaf7aabd73142c431c754a98b80ebcda749ffdcrbowen
5d01f40ffd657dd2ac567aacd93cabd162ddfa79coar <p>Although most error messages can be overriden, there are certain
adaf7aabd73142c431c754a98b80ebcda749ffdcrbowen circumstances where the internal messages are used regardless of the
adaf7aabd73142c431c754a98b80ebcda749ffdcrbowen setting of <code class="directive"><a href="#errordocument">ErrorDocument</a></code>. In
adaf7aabd73142c431c754a98b80ebcda749ffdcrbowen particular, if a malformed request is detected, normal request processing
adaf7aabd73142c431c754a98b80ebcda749ffdcrbowen will be immediately halted and the internal error message returned.
adaf7aabd73142c431c754a98b80ebcda749ffdcrbowen This is necessary to guard against security problems caused by
adaf7aabd73142c431c754a98b80ebcda749ffdcrbowen bad requests.</p>
adaf7aabd73142c431c754a98b80ebcda749ffdcrbowen
adaf7aabd73142c431c754a98b80ebcda749ffdcrbowen <p>Prior to version 2.0, messages were indicated by prefixing
adaf7aabd73142c431c754a98b80ebcda749ffdcrbowen them with a single unmatched double quote character.</p>
adaf7aabd73142c431c754a98b80ebcda749ffdcrbowen
adaf7aabd73142c431c754a98b80ebcda749ffdcrbowen<h3>See also</h3>
7ed5992392d5babab20be4ce4029ad17ae062b5aianh<ul>
7ed5992392d5babab20be4ce4029ad17ae062b5aianh<li><a href="/custom-error.html">documentation of
083eacf86f9327835b824f9e6be987d56cd96e82slive customizable responses</a></li>
fffe2d3830e52ed28703d042c5049b5e8fa047e2niq</ul>
fffe2d3830e52ed28703d042c5049b5e8fa047e2niq</div>
fffe2d3830e52ed28703d042c5049b5e8fa047e2niq<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
fffe2d3830e52ed28703d042c5049b5e8fa047e2niq<div class="directive-section"><h2><a name="ErrorLog" id="ErrorLog">ErrorLog</a> <a name="errorlog" id="errorlog">Directive</a></h2>
fffe2d3830e52ed28703d042c5049b5e8fa047e2niq<table class="directive">
fffe2d3830e52ed28703d042c5049b5e8fa047e2niq<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Location where the server will log errors</td></tr>
fffe2d3830e52ed28703d042c5049b5e8fa047e2niq<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>
fffe2d3830e52ed28703d042c5049b5e8fa047e2niq<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>
fffe2d3830e52ed28703d042c5049b5e8fa047e2niq<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
fffe2d3830e52ed28703d042c5049b5e8fa047e2niq<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
fffe2d3830e52ed28703d042c5049b5e8fa047e2niq<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
fffe2d3830e52ed28703d042c5049b5e8fa047e2niq</table>
fffe2d3830e52ed28703d042c5049b5e8fa047e2niq <p>The <code class="directive">ErrorLog</code> directive sets the name of
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh the file to which the server will log any errors it encounters. If
fffe2d3830e52ed28703d042c5049b5e8fa047e2niq the <var>file-path</var> is not absolute then it is assumed to be
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh relative to the <code class="directive"><a href="#serverroot">ServerRoot</a></code>.</p>
fffe2d3830e52ed28703d042c5049b5e8fa047e2niq
fffe2d3830e52ed28703d042c5049b5e8fa047e2niq <div class="example"><h3>Example</h3><p><code>
fffe2d3830e52ed28703d042c5049b5e8fa047e2niq ErrorLog /var/log/httpd/error_log
083eacf86f9327835b824f9e6be987d56cd96e82slive </code></p></div>
083eacf86f9327835b824f9e6be987d56cd96e82slive
342e56f7247f87d5294fca662ba97efa2237ff35yoshiki <p>If the <var>file-path</var>
342e56f7247f87d5294fca662ba97efa2237ff35yoshiki begins with a pipe (|) then it is assumed to be a command to spawn
439ebfd112c7216b5dbab8161a04fcf78a882e57nd to handle the error log.</p>
083eacf86f9327835b824f9e6be987d56cd96e82slive
083eacf86f9327835b824f9e6be987d56cd96e82slive <div class="example"><h3>Example</h3><p><code>
083eacf86f9327835b824f9e6be987d56cd96e82slive ErrorLog "|/usr/local/bin/httpd_errors"
083eacf86f9327835b824f9e6be987d56cd96e82slive </code></p></div>
083eacf86f9327835b824f9e6be987d56cd96e82slive
083eacf86f9327835b824f9e6be987d56cd96e82slive <p>Using <code>syslog</code> instead of a filename enables logging
083eacf86f9327835b824f9e6be987d56cd96e82slive via syslogd(8) if the system supports it. The default is to use
083eacf86f9327835b824f9e6be987d56cd96e82slive syslog facility <code>local7</code>, but you can override this by
439ebfd112c7216b5dbab8161a04fcf78a882e57nd using the <code>syslog:<var>facility</var></code> syntax where
37f0d5a24f4107130805cbe65cb798ce3946df7brbowen <var>facility</var> can be one of the names usually documented in
61d29dac384de8b27485e54e53f1386549c578e1rbowen syslog(1).</p>
37f0d5a24f4107130805cbe65cb798ce3946df7brbowen
37f0d5a24f4107130805cbe65cb798ce3946df7brbowen <div class="example"><h3>Example</h3><p><code>
083eacf86f9327835b824f9e6be987d56cd96e82slive ErrorLog syslog:user
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh </code></p></div>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh <p>SECURITY: See the <a href="/misc/security_tips.html#serverroot">security tips</a>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh document for details on why your security could be compromised
8842df23d0075c8139043c5fb8197058683fb183rbowen if the directory where log files are stored is writable by
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh anyone other than the user that starts the server.</p>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh <div class="warning"><h3>Note</h3>
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh <p>When entering a file path on non-Unix platforms, care should be taken
6f10385908fbdfd4849e4bc50e690ee54c62f2cdhumbedooh to make sure that only forward slashed are used even though the platform
37f0d5a24f4107130805cbe65cb798ce3946df7brbowen may allow the use of back slashes. In general it is a good idea to always
439ebfd112c7216b5dbab8161a04fcf78a882e57nd use forward slashes throughout the configuration files.</p>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd </div>
439ebfd112c7216b5dbab8161a04fcf78a882e57nd
083eacf86f9327835b824f9e6be987d56cd96e82slive<h3>See also</h3>
083eacf86f9327835b824f9e6be987d56cd96e82slive<ul>
083eacf86f9327835b824f9e6be987d56cd96e82slive<li><code class="directive"><a href="#loglevel">LogLevel</a></code></li>
342e56f7247f87d5294fca662ba97efa2237ff35yoshiki<li><a href="/logs.html">Apache Log Files</a></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="FileETag" id="FileETag">FileETag</a> <a name="fileetag" id="fileetag">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File attributes used to create the ETag
HTTP response header</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>FileETag <var>component</var> ...</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>FileETag INode MTime Size</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>
The <code class="directive">FileETag</code> directive configures the file
attributes that are used to create the <code>ETag</code> (entity
tag) response header field when the document is based on a file.
(The <code>ETag</code> value is used in cache management to save
network bandwidth.) In Apache 1.3.22 and earlier, the
<code>ETag</code> value was <em>always</em> formed
from the file's inode, size, and last-modified time (mtime). The
<code class="directive">FileETag</code> directive allows you to choose
which of these -- if any -- should be used. The recognized keywords are:
</p>
<dl>
<dt><strong>INode</strong></dt>
<dd>The file's i-node number will be included in the calculation</dd>
<dt><strong>MTime</strong></dt>
<dd>The date and time the file was last modified will be included</dd>
<dt><strong>Size</strong></dt>
<dd>The number of bytes in the file will be included</dd>
<dt><strong>All</strong></dt>
<dd>All available fields will be used. This is equivalent to:
<div class="example"><p><code>FileETag INode MTime Size</code></p></div></dd>
<dt><strong>None</strong></dt>
<dd>If a document is file-based, no <code>ETag</code> field will be
included in the response</dd>
</dl>
<p>The <code>INode</code>, <code>MTime</code>, and <code>Size</code>
keywords may be prefixed with either <code>+</code> or <code>-</code>,
which allow changes to be made to the default setting inherited
from a broader scope. Any keyword appearing without such a prefix
immediately and completely cancels the inherited setting.</p>
<p>If a directory's configuration includes
<code>FileETag&nbsp;INode&nbsp;MTime&nbsp;Size</code>, and a
subdirectory's includes <code>FileETag&nbsp;-INode</code>,
the setting for that subdirectory (which will be inherited by
any sub-subdirectories that don't override it) will be equivalent to
<code>FileETag&nbsp;MTime&nbsp;Size</code>.</p>
<div class="warning"><h3>Warning</h3>
Do not change the default for directories or locations that have WebDAV
enabled and use <code class="module"><a href="/mod/mod_dav_fs.html">mod_dav_fs</a></code> as a storage provider.
<code class="module"><a href="/mod/mod_dav_fs.html">mod_dav_fs</a></code> uses <code>INode&nbsp;MTime&nbsp;Size</code>
as a fixed format for <code>ETag</code> comparisons on conditional requests.
These conditional requests will break if the <code>ETag</code> format is
changed via <code class="directive">FileETag</code>.
</div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="Files" id="Files">&lt;Files&gt;</a> <a name="files" id="files">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Contains directives that apply to matched
filenames</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;Files <var>filename</var>&gt; ... &lt;/Files&gt;</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>The <code class="directive">&lt;Files&gt;</code> directive
limits the scope of the enclosed directives by filename. It is comparable
to the <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code>
and <code class="directive"><a href="#location">&lt;Location&gt;</a></code>
directives. It should be matched with a <code>&lt;/Files&gt;</code>
directive. The directives given within this section will be applied to
any object with a basename (last component of filename) matching the
specified filename. <code class="directive">&lt;Files&gt;</code>
sections are processed in the order they appear in the
configuration file, after the <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code> sections and
<code>.htaccess</code> files are read, but before <code class="directive"><a href="#location">&lt;Location&gt;</a></code> sections. Note
that <code class="directive">&lt;Files&gt;</code> can be nested
inside <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code> sections to restrict the
portion of the filesystem they apply to.</p>
<p>The <var>filename</var> argument should include a filename, or
a wild-card string, where <code>?</code> matches any single character,
and <code>*</code> matches any sequences of characters.
<a class="glossarylink" href="/glossary.html#regex" title="see glossary">Regular expressions</a>
can also be used, with the addition of the
<code>~</code> character. For example:</p>
<div class="example"><p><code>
&lt;Files ~ "\.(gif|jpe?g|png)$"&gt;
</code></p></div>
<p>would match most common Internet graphics formats. <code class="directive"><a href="#filesmatch">&lt;FilesMatch&gt;</a></code> is preferred,
however.</p>
<p>Note that unlike <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code> and <code class="directive"><a href="#location">&lt;Location&gt;</a></code> sections, <code class="directive">&lt;Files&gt;</code> sections can be used inside
<code>.htaccess</code> files. This allows users to control access to
their own files, at a file-by-file level.</p>
<h3>See also</h3>
<ul>
<li><a href="/sections.html">How &lt;Directory&gt;, &lt;Location&gt;
and &lt;Files&gt; sections work</a> for an explanation of how these
different sections are combined when a request is received</li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="FilesMatch" id="FilesMatch">&lt;FilesMatch&gt;</a> <a name="filesmatch" id="filesmatch">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Contains directives that apply to regular-expression matched
filenames</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;FilesMatch <var>regex</var>&gt; ... &lt;/FilesMatch&gt;</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>The <code class="directive">&lt;FilesMatch&gt;</code> directive
limits the scope of the enclosed directives by filename, just as the
<code class="directive"><a href="#files">&lt;Files&gt;</a></code> directive
does. However, it accepts a <a class="glossarylink" href="/glossary.html#regex" title="see glossary">regular
expression</a>. For example:</p>
<div class="example"><p><code>
&lt;FilesMatch "\.(gif|jpe?g|png)$"&gt;
</code></p></div>
<p>would match most common Internet graphics formats.</p>
<h3>See also</h3>
<ul>
<li><a href="/sections.html">How &lt;Directory&gt;, &lt;Location&gt;
and &lt;Files&gt; sections work</a> for an explanation of how these
different sections are combined when a request is received</li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="ForceType" id="ForceType">ForceType</a> <a name="forcetype" id="forcetype">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Forces all matching files to be served with the specified
media type in the HTTP Content-Type header field</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ForceType <var>media-type</var>|None</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Moved to the core in Apache 2.0</td></tr>
</table>
<p>When placed into an <code>.htaccess</code> file or a
<code class="directive"><a href="#directory">&lt;Directory&gt;</a></code>, or
<code class="directive"><a href="#location">&lt;Location&gt;</a></code> or
<code class="directive"><a href="#files">&lt;Files&gt;</a></code>
section, this directive forces all matching files to be served
with the content type identification given by
<var>media-type</var>. For example, if you had a directory full of
GIF files, but did not want to label them all with <code>.gif</code>,
you might want to use:</p>
<div class="example"><p><code>
ForceType image/gif
</code></p></div>
<p>Note that this directive overrides other indirect media type
associations defined in mime.types or via the
<code class="directive"><a href="/mod/mod_mime.html#addtype">AddType</a></code>.</p>
<p>You can also override more general
<code class="directive">ForceType</code> settings
by using the value of <code>None</code>:</p>
<div class="example"><p><code>
# force all files to be image/gif:<br />
&lt;Location /images&gt;<br />
<span class="indent">
ForceType image/gif<br />
</span>
&lt;/Location&gt;<br />
<br />
# but normal mime-type associations here:<br />
&lt;Location /images/mixed&gt;<br />
<span class="indent">
ForceType None<br />
</span>
&lt;/Location&gt;
</code></p></div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="HostnameLookups" id="HostnameLookups">HostnameLookups</a> <a name="hostnamelookups" id="hostnamelookups">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables DNS lookups on client IP addresses</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>HostnameLookups On|Off|Double</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>HostnameLookups Off</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>This directive enables DNS lookups so that host names can be
logged (and passed to CGIs/SSIs in <code>REMOTE_HOST</code>).
The value <code>Double</code> refers to doing double-reverse
DNS lookup. That is, after a reverse lookup is performed, a forward
lookup is then performed on that result. At least one of the IP
addresses in the forward lookup must match the original
address. (In "tcpwrappers" terminology this is called
<code>PARANOID</code>.)</p>
<p>Regardless of the setting, when <code class="module"><a href="/mod/mod_authz_host.html">mod_authz_host</a></code> is
used for controlling access by hostname, a double reverse lookup
will be performed. This is necessary for security. Note that the
result of this double-reverse isn't generally available unless you
set <code>HostnameLookups Double</code>. For example, if only
<code>HostnameLookups On</code> and a request is made to an object
that is protected by hostname restrictions, regardless of whether
the double-reverse fails or not, CGIs will still be passed the
single-reverse result in <code>REMOTE_HOST</code>.</p>
<p>The default is <code>Off</code> in order to save the network
traffic for those sites that don't truly need the reverse
lookups done. It is also better for the end users because they
don't have to suffer the extra latency that a lookup entails.
Heavily loaded sites should leave this directive
<code>Off</code>, since DNS lookups can take considerable
amounts of time. The utility <code class="program"><a href="/programs/logresolve.html">logresolve</a></code>, compiled by
default to the <code>bin</code> subdirectory of your installation
directory, can be used to look up host names from logged IP addresses
offline.</p>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="If" id="If">&lt;If&gt;</a> <a name="if" id="if">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Contains directives that apply only if a condition is
satisfied by a request at runtime</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;If <var>expression</var>&gt; ... &lt;/If&gt;</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>The <code class="directive">&lt;If&gt;</code> directive
evaluates an expression at runtime, and applies the enclosed
directives if and only if the expression evaluates to true.
For example:</p>
<div class="example"><p><code>
&lt;If "$req{Host} = ''"&gt;
</code></p></div>
<p>would match HTTP/1.0 requests without a <var>Host:</var> header.</p>
<p>You may compare the value of any variable in the request headers
($req), response headers ($resp) or environment ($env) in your
expression.</p>
<h3>See also</h3>
<ul>
<li><a href="/sections.html">How &lt;Directory&gt;, &lt;Location&gt;,
&lt;Files&gt; sections work</a> for an explanation of how these
different sections are combined when a request is received.
<code class="directive">&lt;If&gt;</code> has the same precedence
and usage as <code class="directive">&lt;Files&gt;</code></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="IfDefine" id="IfDefine">&lt;IfDefine&gt;</a> <a name="ifdefine" id="ifdefine">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Encloses directives that will be processed only
if a test is true at startup</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;IfDefine [!]<var>parameter-name</var>&gt; ...
&lt;/IfDefine&gt;</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>The <code>&lt;IfDefine <var>test</var>&gt;...&lt;/IfDefine&gt;
</code> section is used to mark directives that are conditional. The
directives within an <code class="directive">&lt;IfDefine&gt;</code>
section are only processed if the <var>test</var> is true. If <var>
test</var> is false, everything between the start and end markers is
ignored.</p>
<p>The <var>test</var> in the <code class="directive">&lt;IfDefine&gt;</code> section directive can be one of two forms:</p>
<ul>
<li><var>parameter-name</var></li>
<li><code>!</code><var>parameter-name</var></li>
</ul>
<p>In the former case, the directives between the start and end
markers are only processed if the parameter named
<var>parameter-name</var> is defined. The second format reverses
the test, and only processes the directives if
<var>parameter-name</var> is <strong>not</strong> defined.</p>
<p>The <var>parameter-name</var> argument is a define as given on the
<code class="program"><a href="/programs/httpd.html">httpd</a></code> command line via <code>-D<var>parameter</var>
</code> at the time the server was started or by the <code class="directive"><a href="#define">Define</a></code> directive.</p>
<p><code class="directive">&lt;IfDefine&gt;</code> sections are
nest-able, which can be used to implement simple
multiple-parameter tests. Example:</p>
<div class="example"><p><code>
httpd -DReverseProxy -DUseCache -DMemCache ...<br />
<br />
# httpd.conf<br />
&lt;IfDefine ReverseProxy&gt;<br />
<span class="indent">
LoadModule proxy_module modules/mod_proxy.so<br />
LoadModule proxy_http_module modules/mod_proxy_http.so<br />
&lt;IfDefine UseCache&gt;<br />
<span class="indent">
LoadModule cache_module modules/mod_cache.so<br />
&lt;IfDefine MemCache&gt;<br />
<span class="indent">
LoadModule mem_cache_module modules/mod_mem_cache.so<br />
</span>
&lt;/IfDefine&gt;<br />
&lt;IfDefine !MemCache&gt;<br />
<span class="indent">
LoadModule disk_cache_module modules/mod_disk_cache.so<br />
</span>
&lt;/IfDefine&gt;
</span>
&lt;/IfDefine&gt;
</span>
&lt;/IfDefine&gt;
</code></p></div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="IfModule" id="IfModule">&lt;IfModule&gt;</a> <a name="ifmodule" id="ifmodule">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Encloses directives that are processed conditional on the
presence or absence of a specific module</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;IfModule [!]<var>module-file</var>|<var>module-identifier</var>&gt; ...
&lt;/IfModule&gt;</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Module identifiers are available in version 2.1 and
later.</td></tr>
</table>
<p>The <code>&lt;IfModule <var>test</var>&gt;...&lt;/IfModule&gt;</code>
section is used to mark directives that are conditional on the presence of
a specific module. The directives within an <code class="directive">&lt;IfModule&gt;</code> section are only processed if the <var>test</var>
is true. If <var>test</var> is false, everything between the start and
end markers is ignored.</p>
<p>The <var>test</var> in the <code class="directive">&lt;IfModule&gt;</code> section directive can be one of two forms:</p>
<ul>
<li><var>module</var></li>
<li>!<var>module</var></li>
</ul>
<p>In the former case, the directives between the start and end
markers are only processed if the module named <var>module</var>
is included in Apache -- either compiled in or
dynamically loaded using <code class="directive"><a href="/mod/mod_so.html#loadmodule">LoadModule</a></code>. The second format reverses the test,
and only processes the directives if <var>module</var> is
<strong>not</strong> included.</p>
<p>The <var>module</var> argument can be either the module identifier or
the file name of the module, at the time it was compiled. For example,
<code>rewrite_module</code> is the identifier and
<code>mod_rewrite.c</code> is the file name. If a module consists of
several source files, use the name of the file containing the string
<code>STANDARD20_MODULE_STUFF</code>.</p>
<p><code class="directive">&lt;IfModule&gt;</code> sections are
nest-able, which can be used to implement simple multiple-module
tests.</p>
<div class="note">This section should only be used if you need to have one
configuration file that works whether or not a specific module
is available. In normal operation, directives need not be
placed in <code class="directive">&lt;IfModule&gt;</code>
sections.</div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="Include" id="Include">Include</a> <a name="include" id="include">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Includes other configuration files from within
the server configuration files</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Include <var>file-path</var>|<var>directory-path</var></code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Wildcard matching available in 2.0.41 and later</td></tr>
</table>
<p>This directive allows inclusion of other configuration files
from within the server configuration files.</p>
<p>Shell-style (<code>fnmatch()</code>) wildcard characters can be used to
include several files at once, in alphabetical order. In
addition, if <code class="directive">Include</code> points to a directory,
rather than a file, Apache will read all files in that directory
and any subdirectory. However, including entire directories is not
recommended, because it is easy to accidentally leave temporary
files in a directory that can cause <code class="program"><a href="/programs/httpd.html">httpd</a></code> to
fail. Instead, we encourage you to use the wildcard syntax shown
below, to include files that match a particular pattern, such as
*.conf, for example.</p>
<p>The file path specified may be an absolute path, or may be relative
to the <code class="directive"><a href="#serverroot">ServerRoot</a></code> directory.</p>
<p>Examples:</p>
<div class="example"><p><code>
Include /usr/local/apache2/conf/ssl.conf<br />
Include /usr/local/apache2/conf/vhosts/*.conf
</code></p></div>
<p>Or, providing paths relative to your <code class="directive"><a href="#serverroot">ServerRoot</a></code> directory:</p>
<div class="example"><p><code>
Include conf/ssl.conf<br />
Include conf/vhosts/*.conf
</code></p></div>
<h3>See also</h3>
<ul>
<li><code class="program"><a href="/programs/apachectl.html">apachectl</a></code></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="KeepAlive" id="KeepAlive">KeepAlive</a> <a name="keepalive" id="keepalive">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables HTTP persistent connections</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>KeepAlive On|Off</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>KeepAlive On</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>The Keep-Alive extension to HTTP/1.0 and the persistent
connection feature of HTTP/1.1 provide long-lived HTTP sessions
which allow multiple requests to be sent over the same TCP
connection. In some cases this has been shown to result in an
almost 50% speedup in latency times for HTML documents with
many images. To enable Keep-Alive connections, set
<code>KeepAlive On</code>.</p>
<p>For HTTP/1.0 clients, Keep-Alive connections will only be
used if they are specifically requested by a client. In
addition, a Keep-Alive connection with an HTTP/1.0 client can
only be used when the length of the content is known in
advance. This implies that dynamic content such as CGI output,
SSI pages, and server-generated directory listings will
generally not use Keep-Alive connections to HTTP/1.0 clients.
For HTTP/1.1 clients, persistent connections are the default
unless otherwise specified. If the client requests it, chunked
encoding will be used in order to send content of unknown
length over persistent connections.</p>
<p>When a client uses a Keep-Alive connection it will be counted
as a single "request" for the <code class="directive"><a href="/mod/mpm_common.html#maxrequestsperchild">MaxRequestsPerChild</a></code> directive, regardless
of how many requests are sent using the connection.</p>
<h3>See also</h3>
<ul>
<li><code class="directive"><a href="#maxkeepaliverequests">MaxKeepAliveRequests</a></code></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="KeepAliveTimeout" id="KeepAliveTimeout">KeepAliveTimeout</a> <a name="keepalivetimeout" id="keepalivetimeout">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Amount of time the server will wait for subsequent
requests on a persistent connection</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>KeepAliveTimeout <var>num</var>[ms]</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>KeepAliveTimeout 5</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Specifying a value in milliseconds is available in
Apache 2.3.2 and later</td></tr>
</table>
<p>The number of seconds Apache will wait for a subsequent
request before closing the connection. By adding a postfix of ms the
timeout can be also set in milliseconds. Once a request has been
received, the timeout value specified by the
<code class="directive"><a href="#timeout">Timeout</a></code> directive applies.</p>
<p>Setting <code class="directive">KeepAliveTimeout</code> to a high value
may cause performance problems in heavily loaded servers. The
higher the timeout, the more server processes will be kept
occupied waiting on connections with idle clients.</p>
<p>In a name-based virtual host context, the value of the first
defined virtual host (the default host) in a set of <code class="directive"><a href="#namevirtualhost">NameVirtualHost</a></code> will be used.
The other values will be ignored.</p>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="Limit" id="Limit">&lt;Limit&gt;</a> <a name="limit" id="limit">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Restrict enclosed access controls to only certain HTTP
methods</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;Limit <var>method</var> [<var>method</var>] ... &gt; ...
&lt;/Limit&gt;</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig, Limit</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>Access controls are normally effective for
<strong>all</strong> access methods, and this is the usual
desired behavior. <strong>In the general case, access control
directives should not be placed within a
<code class="directive">&lt;Limit&gt;</code> section.</strong></p>
<p>The purpose of the <code class="directive">&lt;Limit&gt;</code>
directive is to restrict the effect of the access controls to the
nominated HTTP methods. For all other methods, the access
restrictions that are enclosed in the <code class="directive">&lt;Limit&gt;</code> bracket <strong>will have no
effect</strong>. The following example applies the access control
only to the methods <code>POST</code>, <code>PUT</code>, and
<code>DELETE</code>, leaving all other methods unprotected:</p>
<div class="example"><p><code>
&lt;Limit POST PUT DELETE&gt;<br />
<span class="indent">
Require valid-user<br />
</span>
&lt;/Limit&gt;
</code></p></div>
<p>The method names listed can be one or more of: <code>GET</code>,
<code>POST</code>, <code>PUT</code>, <code>DELETE</code>,
<code>CONNECT</code>, <code>OPTIONS</code>,
<code>PATCH</code>, <code>PROPFIND</code>, <code>PROPPATCH</code>,
<code>MKCOL</code>, <code>COPY</code>, <code>MOVE</code>,
<code>LOCK</code>, and <code>UNLOCK</code>. <strong>The method name is
case-sensitive.</strong> If <code>GET</code> is used it will also
restrict <code>HEAD</code> requests. The <code>TRACE</code> method
cannot be limited (see <code class="directive"><a href="#traceenable">TraceEnable</a></code>).</p>
<div class="warning">A <code class="directive"><a href="#limitexcept">&lt;LimitExcept&gt;</a></code> section should always be
used in preference to a <code class="directive">&lt;Limit&gt;</code>
section when restricting access, since a <code class="directive"><a href="#limitexcept">&lt;LimitExcept&gt;</a></code> section provides protection
against arbitrary methods.</div>
<p>The <code class="directive">&lt;Limit&gt;</code> and
<code class="directive"><a href="#limitexcept">&lt;LimitExcept&gt;</a></code>
directives may be nested. In this case, each successive level of
<code class="directive">&lt;Limit&gt;</code> or <code class="directive"><a href="#limitexcept">&lt;LimitExcept&gt;</a></code> directives must
further restrict the set of methods to which access controls apply.</p>
<div class="warning">When using
<code class="directive">&lt;Limit&gt;</code> or
<code class="directive">&lt;LimitExcept&gt;</code> directives with
the <code class="directive"><a href="/mod/mod_authz_core.html#require">Require</a></code> directive,
note that the first <code class="directive"><a href="/mod/mod_authz_core.html#require">Require</a></code>
to succeed authorizes the request, regardless of the presence of other
<code class="directive"><a href="/mod/mod_authz_core.html#require">Require</a></code> directives.</div>
<p>For example, given the following configuration, all users will
be authorized for <code>POST</code> requests, and the
<code>Require group editors</code> directive will be ignored
in all cases:</p>
<div class="example"><p><code>
&lt;LimitExcept GET&gt;
<span class="indent">
Require valid-user
</span>
&lt;/LimitExcept&gt;<br />
&lt;Limit POST&gt;
<span class="indent">
Require group editors
</span>
&lt;/Limit&gt;
</code></p></div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="LimitExcept" id="LimitExcept">&lt;LimitExcept&gt;</a> <a name="limitexcept" id="limitexcept">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Restrict access controls to all HTTP methods
except the named ones</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;LimitExcept <var>method</var> [<var>method</var>] ... &gt; ...
&lt;/LimitExcept&gt;</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig, Limit</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p><code class="directive">&lt;LimitExcept&gt;</code> and
<code>&lt;/LimitExcept&gt;</code> are used to enclose
a group of access control directives which will then apply to any
HTTP access method <strong>not</strong> listed in the arguments;
i.e., it is the opposite of a <code class="directive"><a href="#limit">&lt;Limit&gt;</a></code> section and can be used to control
both standard and nonstandard/unrecognized methods. See the
documentation for <code class="directive"><a href="#limit">&lt;Limit&gt;</a></code> for more details.</p>
<p>For example:</p>
<div class="example"><p><code>
&lt;LimitExcept POST GET&gt;<br />
<span class="indent">
Require valid-user<br />
</span>
&lt;/LimitExcept&gt;
</code></p></div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="LimitInternalRecursion" id="LimitInternalRecursion">LimitInternalRecursion</a> <a name="limitinternalrecursion" id="limitinternalrecursion">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Determine maximum number of internal redirects and nested
subrequests</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LimitInternalRecursion <var>number</var> [<var>number</var>]</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LimitInternalRecursion 10</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.0.47 and later</td></tr>
</table>
<p>An internal redirect happens, for example, when using the <code class="directive"><a href="/mod/mod_actions.html#action">Action</a></code> directive, which internally
redirects the original request to a CGI script. A subrequest is Apache's
mechanism to find out what would happen for some URI if it were requested.
For example, <code class="module"><a href="/mod/mod_dir.html">mod_dir</a></code> uses subrequests to look for the
files listed in the <code class="directive"><a href="/mod/mod_dir.html#directoryindex">DirectoryIndex</a></code>
directive.</p>
<p><code class="directive">LimitInternalRecursion</code> prevents the server
from crashing when entering an infinite loop of internal redirects or
subrequests. Such loops are usually caused by misconfigurations.</p>
<p>The directive stores two different limits, which are evaluated on
per-request basis. The first <var>number</var> is the maximum number of
internal redirects, that may follow each other. The second <var>number</var>
determines, how deep subrequests may be nested. If you specify only one
<var>number</var>, it will be assigned to both limits.</p>
<div class="example"><h3>Example</h3><p><code>
LimitInternalRecursion 5
</code></p></div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="LimitRequestBody" id="LimitRequestBody">LimitRequestBody</a> <a name="limitrequestbody" id="limitrequestbody">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Restricts the total size of the HTTP request body sent
from the client</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LimitRequestBody <var>bytes</var></code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LimitRequestBody 0</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>This directive specifies the number of <var>bytes</var> from 0
(meaning unlimited) to 2147483647 (2GB) that are allowed in a
request body.</p>
<p>The <code class="directive">LimitRequestBody</code> directive allows
the user to set a limit on the allowed size of an HTTP request
message body within the context in which the directive is given
(server, per-directory, per-file or per-location). If the client
request exceeds that limit, the server will return an error
response instead of servicing the request. The size of a normal
request message body will vary greatly depending on the nature of
the resource and the methods allowed on that resource. CGI scripts
typically use the message body for retrieving form information.
Implementations of the <code>PUT</code> method will require
a value at least as large as any representation that the server
wishes to accept for that resource.</p>
<p>This directive gives the server administrator greater
control over abnormal client request behavior, which may be
useful for avoiding some forms of denial-of-service
attacks.</p>
<p>If, for example, you are permitting file upload to a particular
location, and wish to limit the size of the uploaded file to 100K,
you might use the following directive:</p>
<div class="example"><p><code>
LimitRequestBody 102400
</code></p></div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="LimitRequestFields" id="LimitRequestFields">LimitRequestFields</a> <a name="limitrequestfields" id="limitrequestfields">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limits the number of HTTP request header fields that
will be accepted from the client</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LimitRequestFields <var>number</var></code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LimitRequestFields 100</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p><var>Number</var> is an integer from 0 (meaning unlimited) to
32767. The default value is defined by the compile-time
constant <code>DEFAULT_LIMIT_REQUEST_FIELDS</code> (100 as
distributed).</p>
<p>The <code class="directive">LimitRequestFields</code> directive allows
the server administrator to modify the limit on the number of
request header fields allowed in an HTTP request. A server needs
this value to be larger than the number of fields that a normal
client request might include. The number of request header fields
used by a client rarely exceeds 20, but this may vary among
different client implementations, often depending upon the extent
to which a user has configured their browser to support detailed
content negotiation. Optional HTTP extensions are often expressed
using request header fields.</p>
<p>This directive gives the server administrator greater
control over abnormal client request behavior, which may be
useful for avoiding some forms of denial-of-service attacks.
The value should be increased if normal clients see an error
response from the server that indicates too many fields were
sent in the request.</p>
<p>For example:</p>
<div class="example"><p><code>
LimitRequestFields 50
</code></p></div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="LimitRequestFieldSize" id="LimitRequestFieldSize">LimitRequestFieldSize</a> <a name="limitrequestfieldsize" id="limitrequestfieldsize">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limits the size of the HTTP request header allowed from the
client</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LimitRequestFieldSize <var>bytes</var></code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LimitRequestFieldSize 8190</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>This directive specifies the number of <var>bytes</var>
that will be allowed in an HTTP request header.</p>
<p>The <code class="directive">LimitRequestFieldSize</code> directive
allows the server administrator to reduce or increase the limit
on the allowed size of an HTTP request header field. A server
needs this value to be large enough to hold any one header field
from a normal client request. The size of a normal request header
field will vary greatly among different client implementations,
often depending upon the extent to which a user has configured
their browser to support detailed content negotiation. SPNEGO
authentication headers can be up to 12392 bytes.</p>
<p>This directive gives the server administrator greater
control over abnormal client request behavior, which may be
useful for avoiding some forms of denial-of-service attacks.</p>
<p>For example:</p>
<div class="example"><p><code>
LimitRequestFieldSize 4094
</code></p></div>
<div class="note">Under normal conditions, the value should not be changed from
the default.</div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="LimitRequestLine" id="LimitRequestLine">LimitRequestLine</a> <a name="limitrequestline" id="limitrequestline">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limit the size of the HTTP request line that will be accepted
from the client</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LimitRequestLine <var>bytes</var></code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LimitRequestLine 8190</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>This directive sets the number of <var>bytes</var> that will be
allowed on the HTTP request-line.</p>
<p>The <code class="directive">LimitRequestLine</code> directive allows
the server administrator to reduce or increase the limit on the allowed size
of a client's HTTP request-line. Since the request-line consists of the
HTTP method, URI, and protocol version, the
<code class="directive">LimitRequestLine</code> directive places a
restriction on the length of a request-URI allowed for a request
on the server. A server needs this value to be large enough to
hold any of its resource names, including any information that
might be passed in the query part of a <code>GET</code> request.</p>
<p>This directive gives the server administrator greater
control over abnormal client request behavior, which may be
useful for avoiding some forms of denial-of-service attacks.</p>
<p>For example:</p>
<div class="example"><p><code>
LimitRequestLine 4094
</code></p></div>
<div class="note">Under normal conditions, the value should not be changed from
the default.</div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="LimitXMLRequestBody" id="LimitXMLRequestBody">LimitXMLRequestBody</a> <a name="limitxmlrequestbody" id="limitxmlrequestbody">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limits the size of an XML-based request body</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LimitXMLRequestBody <var>bytes</var></code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LimitXMLRequestBody 1000000</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>Limit (in bytes) on maximum size of an XML-based request
body. A value of <code>0</code> will disable any checking.</p>
<p>Example:</p>
<div class="example"><p><code>
LimitXMLRequestBody 0
</code></p></div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="Location" id="Location">&lt;Location&gt;</a> <a name="location" id="location">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Applies the enclosed directives only to matching
URLs</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;Location
<var>URL-path</var>|<var>URL</var>&gt; ... &lt;/Location&gt;</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>The <code class="directive">&lt;Location&gt;</code> directive
limits the scope of the enclosed directives by URL. It is similar to the
<code class="directive"><a href="#directory">&lt;Directory&gt;</a></code>
directive, and starts a subsection which is terminated with a
<code>&lt;/Location&gt;</code> directive. <code class="directive">&lt;Location&gt;</code> sections are processed in the
order they appear in the configuration file, after the <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code> sections and
<code>.htaccess</code> files are read, and after the <code class="directive"><a href="#files">&lt;Files&gt;</a></code> sections.</p>
<p><code class="directive">&lt;Location&gt;</code> sections operate
completely outside the filesystem. This has several consequences.
Most importantly, <code class="directive">&lt;Location&gt;</code>
directives should not be used to control access to filesystem
locations. Since several different URLs may map to the same
filesystem location, such access controls may by circumvented.</p>
<div class="note"><h3>When to use <code class="directive">&lt;Location&gt;</code></h3>
<p>Use <code class="directive">&lt;Location&gt;</code> to apply
directives to content that lives outside the filesystem. For
content that lives in the filesystem, use <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code> and <code class="directive"><a href="#files">&lt;Files&gt;</a></code>. An exception is
<code>&lt;Location /&gt;</code>, which is an easy way to
apply a configuration to the entire server.</p>
</div>
<p>For all origin (non-proxy) requests, the URL to be matched is a
URL-path of the form <code>/path/</code>. <em>No scheme, hostname,
port, or query string may be included.</em> For proxy requests, the
URL to be matched is of the form
<code>scheme://servername/path</code>, and you must include the
prefix.</p>
<p>The URL may use wildcards. In a wild-card string, <code>?</code> matches
any single character, and <code>*</code> matches any sequences of
characters. Neither wildcard character matches a / in the URL-path.</p>
<p><a class="glossarylink" href="/glossary.html#regex" title="see glossary">Regular expressions</a>
can also be used, with the addition of the <code>~</code>
character. For example:</p>
<div class="example"><p><code>
&lt;Location ~ "/(extra|special)/data"&gt;
</code></p></div>
<p>would match URLs that contained the substring <code>/extra/data</code>
or <code>/special/data</code>. The directive <code class="directive"><a href="#locationmatch">&lt;LocationMatch&gt;</a></code> behaves
identical to the regex version of <code class="directive">&lt;Location&gt;</code>, and is preferred, for the
simple reason that <code>~</code> is hard to distinguish from
<code>-</code> in many fonts.</p>
<p>The <code class="directive">&lt;Location&gt;</code>
functionality is especially useful when combined with the
<code class="directive"><a href="#sethandler">SetHandler</a></code>
directive. For example, to enable status requests, but allow them
only from browsers at <code>example.com</code>, you might use:</p>
<div class="example"><p><code>
&lt;Location /status&gt;<br />
<span class="indent">
SetHandler server-status<br />
Order Deny,Allow<br />
Deny from all<br />
Allow from .example.com<br />
</span>
&lt;/Location&gt;
</code></p></div>
<div class="note"><h3>Note about / (slash)</h3>
<p>The slash character has special meaning depending on where in a
URL it appears. People may be used to its behavior in the filesystem
where multiple adjacent slashes are frequently collapsed to a single
slash (<em>i.e.</em>, <code>/home///foo</code> is the same as
<code>/home/foo</code>). In URL-space this is not necessarily true.
The <code class="directive"><a href="#locationmatch">&lt;LocationMatch&gt;</a></code>
directive and the regex version of <code class="directive">&lt;Location&gt;</code> require you to explicitly specify multiple
slashes if that is your intention.</p>
<p>For example, <code>&lt;LocationMatch ^/abc&gt;</code> would match
the request URL <code>/abc</code> but not the request URL <code>
//abc</code>. The (non-regex) <code class="directive">&lt;Location&gt;</code> directive behaves similarly when used for
proxy requests. But when (non-regex) <code class="directive">&lt;Location&gt;</code> is used for non-proxy requests it will
implicitly match multiple slashes with a single slash. For example,
if you specify <code>&lt;Location /abc/def&gt;</code> and the
request is to <code>/abc//def</code> then it will match.</p>
</div>
<h3>See also</h3>
<ul>
<li><a href="/sections.html">How &lt;Directory&gt;, &lt;Location&gt;
and &lt;Files&gt; sections work</a> for an explanation of how these
different sections are combined when a request is received.</li>
<li><code class="directive"><a href="#locationmatch">LocationMatch</a></code></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="LocationMatch" id="LocationMatch">&lt;LocationMatch&gt;</a> <a name="locationmatch" id="locationmatch">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Applies the enclosed directives only to regular-expression
matching URLs</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;LocationMatch
<var>regex</var>&gt; ... &lt;/LocationMatch&gt;</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>The <code class="directive">&lt;LocationMatch&gt;</code> directive
limits the scope of the enclosed directives by URL, in an identical manner
to <code class="directive"><a href="#location">&lt;Location&gt;</a></code>. However,
it takes a <a class="glossarylink" href="/glossary.html#regex" title="see glossary">regular expression</a>
as an argument instead of a simple string. For example:</p>
<div class="example"><p><code>
&lt;LocationMatch "/(extra|special)/data"&gt;
</code></p></div>
<p>would match URLs that contained the substring <code>/extra/data</code>
or <code>/special/data</code>.</p>
<h3>See also</h3>
<ul>
<li><a href="/sections.html">How &lt;Directory&gt;, &lt;Location&gt;
and &lt;Files&gt; sections work</a> for an explanation of how these
different sections are combined when a request is received</li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="LogLevel" id="LogLevel">LogLevel</a> <a name="loglevel" id="loglevel">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Controls the verbosity of the ErrorLog</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LogLevel <var>level</var></code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LogLevel warn</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p><code class="directive">LogLevel</code> adjusts the verbosity of the
messages recorded in the error logs (see <code class="directive"><a href="#errorlog">ErrorLog</a></code> directive). The following
<var>level</var>s are available, in order of decreasing
significance:</p>
<table class="bordered">
<tr>
<th><strong>Level</strong> </th>
<th><strong>Description</strong> </th>
<th><strong>Example</strong> </th>
</tr>
<tr>
<td><code>emerg</code> </td>
<td>Emergencies - system is unusable.</td>
<td>"Child cannot open lock file. Exiting"</td>
</tr>
<tr>
<td><code>alert</code> </td>
<td>Action must be taken immediately.</td>
<td>"getpwuid: couldn't determine user name from uid"</td>
</tr>
<tr>
<td><code>crit</code> </td>
<td>Critical Conditions.</td>
<td>"socket: Failed to get a socket, exiting child"</td>
</tr>
<tr>
<td><code>error</code> </td>
<td>Error conditions.</td>
<td>"Premature end of script headers"</td>
</tr>
<tr>
<td><code>warn</code> </td>
<td>Warning conditions.</td>
<td>"child process 1234 did not exit, sending another
SIGHUP"</td>
</tr>
<tr>
<td><code>notice</code> </td>
<td>Normal but significant condition.</td>
<td>"httpd: caught SIGBUS, attempting to dump core in
..."</td>
</tr>
<tr>
<td><code>info</code> </td>
<td>Informational.</td>
<td>"Server seems busy, (you may need to increase
StartServers, or Min/MaxSpareServers)..."</td>
</tr>
<tr>
<td><code>debug</code> </td>
<td>Debug-level messages</td>
<td>"Opening config file ..."</td>
</tr>
</table>
<p>When a particular level is specified, messages from all
other levels of higher significance will be reported as well.
<em>E.g.</em>, when <code>LogLevel info</code> is specified,
then messages with log levels of <code>notice</code> and
<code>warn</code> will also be posted.</p>
<p>Using a level of at least <code>crit</code> is
recommended.</p>
<p>For example:</p>
<div class="example"><p><code>
LogLevel notice
</code></p></div>
<div class="note"><h3>Note</h3>
<p>When logging to a regular file messages of the level
<code>notice</code> cannot be suppressed and thus are always
logged. However, this doesn't apply when logging is done
using <code>syslog</code>.</p>
</div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="MaxKeepAliveRequests" id="MaxKeepAliveRequests">MaxKeepAliveRequests</a> <a name="maxkeepaliverequests" id="maxkeepaliverequests">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Number of requests allowed on a persistent
connection</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>MaxKeepAliveRequests <var>number</var></code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>MaxKeepAliveRequests 100</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>The <code class="directive">MaxKeepAliveRequests</code> directive
limits the number of requests allowed per connection when
<code class="directive"><a href="#keepalive">KeepAlive</a></code> is on. If it is
set to <code>0</code>, unlimited requests will be allowed. We
recommend that this setting be kept to a high value for maximum
server performance.</p>
<p>For example:</p>
<div class="example"><p><code>
MaxKeepAliveRequests 500
</code></p></div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="NameVirtualHost" id="NameVirtualHost">NameVirtualHost</a> <a name="namevirtualhost" id="namevirtualhost">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Designates an IP address for name-virtual
hosting</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>NameVirtualHost <var>addr</var>[:<var>port</var>]</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>A single <code class="directive">NameVirtualHost</code> directive
identifies a set of identical virtual hosts on which the server will
further select from on the basis of the <em>hostname</em>
requested by the client. The <code class="directive">NameVirtualHost</code>
directive is a required directive if you want to configure
<a href="/vhosts/">name-based virtual hosts</a>.</p>
<p>This directive, and the corresponding <code class="directive">VirtualHost</code>,
<em>must</em> be qualified with a port number if the server supports both HTTP
and HTTPS connections.</p>
<p>Although <var>addr</var> can be a hostname, it is recommended
that you always use an IP address or a wildcard. A wildcard
NameVirtualHost matches only virtualhosts that also have a literal wildcard
as their argument.</p>
<p>In cases where a firewall or other proxy receives the requests and
forwards them on a different IP address to the server, you must specify the
IP address of the physical interface on the machine which will be
servicing the requests. </p>
<p> In the example below, requests received on interface 192.0.2.1 and port 80
will only select among the first two virtual hosts. Requests received on
port 80 on any other interface will only select among the third and fourth
virtual hosts. In the common case where the interface isn't important
to the mapping, only the "*:80" NameVirtualHost and VirtualHost directives
are necessary.</p>
<div class="example"><p><code>
NameVirtualHost 192.0.2.1:80<br />
NameVirtualHost *:80<br /><br />
&lt;VirtualHost 192.0.2.1:80&gt;<br />
&nbsp; ServerName namebased-a.example.com<br />
&lt;/VirtualHost&gt;<br />
<br />
&lt;VirtualHost 192.0.2.1:80&gt;<br />
&nbsp; Servername namebased-b.example.com<br />
&lt;/VirtualHost&gt;<br />
<br />
&lt;VirtualHost *:80&gt;<br />
&nbsp; ServerName namebased-c.example.com <br />
&lt;/VirtualHost&gt;<br />
<br />
&lt;VirtualHost *:80&gt;<br />
&nbsp; ServerName namebased-d.example.com <br />
&lt;/VirtualHost&gt;<br />
<br />
</code></p></div>
<p>IPv6 addresses must be enclosed in square brackets, as shown
in the following example:</p>
<div class="example"><p><code>
NameVirtualHost [2001:db8::a00:20ff:fea7:ccea]:8080
</code></p></div>
<div class="note"><h3>Argument to <code class="directive">&lt;VirtualHost&gt;</code>
directive</h3>
<p>Note that the argument to the <code class="directive">&lt;VirtualHost&gt;</code> directive must
exactly match the argument to the <code class="directive">NameVirtualHost</code> directive.</p>
<div class="example"><p><code>
NameVirtualHost 192.0.2.2:80<br />
&lt;VirtualHost 192.0.2.2:80&gt;<br />
# ...<br />
&lt;/VirtualHost&gt;<br />
</code></p></div>
</div>
<h3>See also</h3>
<ul>
<li><a href="/vhosts/">Virtual Hosts
documentation</a></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="Options" id="Options">Options</a> <a name="options" id="options">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures what features are available in a particular
directory</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Options
[+|-]<var>option</var> [[+|-]<var>option</var>] ...</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Options All</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Options</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>The <code class="directive">Options</code> directive controls which
server features are available in a particular directory.</p>
<p><var>option</var> can be set to <code>None</code>, in which
case none of the extra features are enabled, or one or more of
the following:</p>
<dl>
<dt><code>All</code></dt>
<dd>All options except for <code>MultiViews</code>. This is the default
setting.</dd>
<dt><code>ExecCGI</code></dt>
<dd>
Execution of CGI scripts using <code class="module"><a href="/mod/mod_cgi.html">mod_cgi</a></code>
is permitted.</dd>
<dt><code>FollowSymLinks</code></dt>
<dd>
The server will follow symbolic links in this directory.
<div class="note">
<p>Even though the server follows the symlink it does <em>not</em>
change the pathname used to match against <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code> sections.</p>
<p>Note also, that this option <strong>gets ignored</strong> if set
inside a <code class="directive"><a href="#location">&lt;Location&gt;</a></code>
section.</p>
<p>Omitting this option should not be considered a security restriction,
since symlink testing is subject to race conditions that make it
circumventable.</p>
</div></dd>
<dt><code>Includes</code></dt>
<dd>
Server-side includes provided by <code class="module"><a href="/mod/mod_include.html">mod_include</a></code>
are permitted.</dd>
<dt><code>IncludesNOEXEC</code></dt>
<dd>
Server-side includes are permitted, but the <code>#exec
cmd</code> and <code>#exec cgi</code> are disabled. It is still
possible to <code>#include virtual</code> CGI scripts from
<code class="directive"><a href="/mod/mod_alias.html#scriptalias">ScriptAlias</a></code>ed
directories.</dd>
<dt><code>Indexes</code></dt>
<dd>
If a URL which maps to a directory is requested, and there
is no <code class="directive"><a href="/mod/mod_dir.html#directoryindex">DirectoryIndex</a></code>
(<em>e.g.</em>, <code>index.html</code>) in that directory, then
<code class="module"><a href="/mod/mod_autoindex.html">mod_autoindex</a></code> will return a formatted listing
of the directory.</dd>
<dt><code>MultiViews</code></dt>
<dd>
<a href="/content-negotiation.html">Content negotiated</a>
"MultiViews" are allowed using
<code class="module"><a href="/mod/mod_negotiation.html">mod_negotiation</a></code>.</dd>
<dt><code>SymLinksIfOwnerMatch</code></dt>
<dd>The server will only follow symbolic links for which the
target file or directory is owned by the same user id as the
link.
<div class="note"><h3>Note</h3> <p>This option gets ignored if
set inside a <code class="directive"><a href="#location">&lt;Location&gt;</a></code> section.</p>
<p>This option should not be considered a security restriction,
since symlink testing is subject to race conditions that make it
circumventable.</p></div>
</dd>
</dl>
<p>Normally, if multiple <code class="directive">Options</code> could
apply to a directory, then the most specific one is used and
others are ignored; the options are not merged. (See <a href="/sections.html#mergin">how sections are merged</a>.)
However if <em>all</em> the options on the
<code class="directive">Options</code> directive are preceded by a
<code>+</code> or <code>-</code> symbol, the options are
merged. Any options preceded by a <code>+</code> are added to the
options currently in force, and any options preceded by a
<code>-</code> are removed from the options currently in
force. </p>
<div class="warning"><h3>Warning</h3>
<p>Mixing <code class="directive">Options</code> with a <code>+</code> or
<code>-</code> with those without is not valid syntax, and is likely
to cause unexpected results.</p>
</div>
<p>For example, without any <code>+</code> and <code>-</code> symbols:</p>
<div class="example"><p><code>
&lt;Directory /web/docs&gt;<br />
<span class="indent">
Options Indexes FollowSymLinks<br />
</span>
&lt;/Directory&gt;<br />
<br />
&lt;Directory /web/docs/spec&gt;<br />
<span class="indent">
Options Includes<br />
</span>
&lt;/Directory&gt;
</code></p></div>
<p>then only <code>Includes</code> will be set for the
<code>/web/docs/spec</code> directory. However if the second
<code class="directive">Options</code> directive uses the <code>+</code> and
<code>-</code> symbols:</p>
<div class="example"><p><code>
&lt;Directory /web/docs&gt;<br />
<span class="indent">
Options Indexes FollowSymLinks<br />
</span>
&lt;/Directory&gt;<br />
<br />
&lt;Directory /web/docs/spec&gt;<br />
<span class="indent">
Options +Includes -Indexes<br />
</span>
&lt;/Directory&gt;
</code></p></div>
<p>then the options <code>FollowSymLinks</code> and
<code>Includes</code> are set for the <code>/web/docs/spec</code>
directory.</p>
<div class="note"><h3>Note</h3>
<p>Using <code>-IncludesNOEXEC</code> or
<code>-Includes</code> disables server-side includes completely
regardless of the previous setting.</p>
</div>
<p>The default in the absence of any other settings is
<code>All</code>.</p>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="RLimitCPU" id="RLimitCPU">RLimitCPU</a> <a name="rlimitcpu" id="rlimitcpu">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limits the CPU consumption of processes launched
by Apache children</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RLimitCPU <var>seconds</var>|max [<var>seconds</var>|max]</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Unset; uses operating system defaults</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>Takes 1 or 2 parameters. The first parameter sets the soft
resource limit for all processes and the second parameter sets
the maximum resource limit. Either parameter can be a number,
or <code>max</code> to indicate to the server that the limit should
be set to the maximum allowed by the operating system
configuration. Raising the maximum resource limit requires that
the server is running as <code>root</code>, or in the initial startup
phase.</p>
<p>This applies to processes forked off from Apache children
servicing requests, not the Apache children themselves. This
includes CGI scripts and SSI exec commands, but not any
processes forked off from the Apache parent such as piped
logs.</p>
<p>CPU resource limits are expressed in seconds per
process.</p>
<h3>See also</h3>
<ul>
<li><code class="directive"><a href="#rlimitmem">RLimitMEM</a></code></li>
<li><code class="directive"><a href="#rlimitnproc">RLimitNPROC</a></code></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="RLimitMEM" id="RLimitMEM">RLimitMEM</a> <a name="rlimitmem" id="rlimitmem">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limits the memory consumption of processes launched
by Apache children</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RLimitMEM <var>bytes</var>|max [<var>bytes</var>|max]</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Unset; uses operating system defaults</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>Takes 1 or 2 parameters. The first parameter sets the soft
resource limit for all processes and the second parameter sets
the maximum resource limit. Either parameter can be a number,
or <code>max</code> to indicate to the server that the limit should
be set to the maximum allowed by the operating system
configuration. Raising the maximum resource limit requires that
the server is running as <code>root</code>, or in the initial startup
phase.</p>
<p>This applies to processes forked off from Apache children
servicing requests, not the Apache children themselves. This
includes CGI scripts and SSI exec commands, but not any
processes forked off from the Apache parent such as piped
logs.</p>
<p>Memory resource limits are expressed in bytes per
process.</p>
<h3>See also</h3>
<ul>
<li><code class="directive"><a href="#rlimitcpu">RLimitCPU</a></code></li>
<li><code class="directive"><a href="#rlimitnproc">RLimitNPROC</a></code></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="RLimitNPROC" id="RLimitNPROC">RLimitNPROC</a> <a name="rlimitnproc" id="rlimitnproc">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limits the number of processes that can be launched by
processes launched by Apache children</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RLimitNPROC <var>number</var>|max [<var>number</var>|max]</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Unset; uses operating system defaults</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>Takes 1 or 2 parameters. The first parameter sets the soft
resource limit for all processes and the second parameter sets
the maximum resource limit. Either parameter can be a number,
or <code>max</code> to indicate to the server that the limit
should be set to the maximum allowed by the operating system
configuration. Raising the maximum resource limit requires that
the server is running as <code>root</code>, or in the initial startup
phase.</p>
<p>This applies to processes forked off from Apache children
servicing requests, not the Apache children themselves. This
includes CGI scripts and SSI exec commands, but not any
processes forked off from the Apache parent such as piped
logs.</p>
<p>Process limits control the number of processes per user.</p>
<div class="note"><h3>Note</h3>
<p>If CGI processes are <strong>not</strong> running
under user ids other than the web server user id, this directive
will limit the number of processes that the server itself can
create. Evidence of this situation will be indicated by
<strong><code>cannot fork</code></strong> messages in the
<code>error_log</code>.</p>
</div>
<h3>See also</h3>
<ul>
<li><code class="directive"><a href="#rlimitmem">RLimitMEM</a></code></li>
<li><code class="directive"><a href="#rlimitcpu">RLimitCPU</a></code></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="ScriptInterpreterSource" id="ScriptInterpreterSource">ScriptInterpreterSource</a> <a name="scriptinterpretersource" id="scriptinterpretersource">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Technique for locating the interpreter for CGI
scripts</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ScriptInterpreterSource Registry|Registry-Strict|Script</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ScriptInterpreterSource Script</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Win32 only;
option <code>Registry-Strict</code> is available in Apache 2.0 and
later</td></tr>
</table>
<p>This directive is used to control how Apache finds the
interpreter used to run CGI scripts. The default setting is
<code>Script</code>. This causes Apache to use the interpreter pointed to
by the shebang line (first line, starting with <code>#!</code>) in the
script. On Win32 systems this line usually looks like:</p>
<div class="example"><p><code>
#!C:/Perl/bin/perl.exe
</code></p></div>
<p>or, if <code>perl</code> is in the <code>PATH</code>, simply:</p>
<div class="example"><p><code>
#!perl
</code></p></div>
<p>Setting <code>ScriptInterpreterSource Registry</code> will
cause the Windows Registry tree <code>HKEY_CLASSES_ROOT</code> to be
searched using the script file extension (e.g., <code>.pl</code>) as a
search key. The command defined by the registry subkey
<code>Shell\ExecCGI\Command</code> or, if it does not exist, by the subkey
<code>Shell\Open\Command</code> is used to open the script file. If the
registry keys cannot be found, Apache falls back to the behavior of the
<code>Script</code> option.</p>
<div class="warning"><h3>Security</h3>
<p>Be careful when using <code>ScriptInterpreterSource
Registry</code> with <code class="directive"><a href="/mod/mod_alias.html#scriptalias">ScriptAlias</a></code>'ed directories, because
Apache will try to execute <strong>every</strong> file within this
directory. The <code>Registry</code> setting may cause undesired
program calls on files which are typically not executed. For
example, the default open command on <code>.htm</code> files on
most Windows systems will execute Microsoft Internet Explorer, so
any HTTP request for an <code>.htm</code> file existing within the
script directory would start the browser in the background on the
server. This is a good way to crash your system within a minute or
so.</p>
</div>
<p>The option <code>Registry-Strict</code> which is new in Apache
2.0 does the same thing as <code>Registry</code> but uses only the
subkey <code>Shell\ExecCGI\Command</code>. The
<code>ExecCGI</code> key is not a common one. It must be
configured manually in the windows registry and hence prevents
accidental program calls on your system.</p>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="ServerAdmin" id="ServerAdmin">ServerAdmin</a> <a name="serveradmin" id="serveradmin">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Email address that the server includes in error
messages sent to the client</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ServerAdmin <var>email-address</var>|<var>URL</var></code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>The <code class="directive">ServerAdmin</code> sets the contact address
that the server includes in any error messages it returns to the
client. If the <code>httpd</code> doesn't recognize the supplied argument
as an URL, it
assumes, that it's an <var>email-address</var> and prepends it with
<code>mailto:</code> in hyperlink targets. However, it's recommended to
actually use an email address, since there are a lot of CGI scripts that
make that assumption. If you want to use an URL, it should point to another
server under your control. Otherwise users may not be able to contact you in
case of errors.</p>
<p>It may be worth setting up a dedicated address for this, e.g.</p>
<div class="example"><p><code>
ServerAdmin www-admin@foo.example.com
</code></p></div>
<p>as users do not always mention that they are talking about the
server!</p>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="ServerAlias" id="ServerAlias">ServerAlias</a> <a name="serveralias" id="serveralias">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Alternate names for a host used when matching requests
to name-virtual hosts</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ServerAlias <var>hostname</var> [<var>hostname</var>] ...</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>The <code class="directive">ServerAlias</code> directive sets the
alternate names for a host, for use with <a href="/vhosts/name-based.html">name-based virtual hosts</a>. The
<code class="directive">ServerAlias</code> may include wildcards, if appropriate.</p>
<div class="example"><p><code>
&lt;VirtualHost *:80&gt;<br />
ServerName server.domain.com<br />
ServerAlias server server2.domain.com server2<br />
ServerAlias *.example.com<br />
# ...<br />
&lt;/VirtualHost&gt;
</code></p></div>
<h3>See also</h3>
<ul>
<li><a href="/vhosts/">Apache Virtual Host documentation</a></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="ServerName" id="ServerName">ServerName</a> <a name="servername" id="servername">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Hostname and port that the server uses to identify
itself</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ServerName [<var>scheme</var>://]<var>fully-qualified-domain-name</var>[:<var>port</var>]</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>In version 2.0, this
directive supersedes the functionality of the <code class="directive">Port</code>
directive from version 1.3.</td></tr>
</table>
<p>The <code class="directive">ServerName</code> directive sets the
request scheme, hostname and
port that the server uses to identify itself. This is used when
creating redirection URLs. For example, if the name of the
machine hosting the web server is <code>simple.example.com</code>,
but the machine also has the DNS alias <code>www.example.com</code>
and you wish the web server to be so identified, the following
directive should be used:</p>
<div class="example"><p><code>
ServerName www.example.com:80
</code></p></div>
<p>If no <code class="directive">ServerName</code> is specified, then the
server attempts to deduce the hostname by performing a reverse
lookup on the IP address. If no port is specified in the
<code class="directive">ServerName</code>, then the server will use the
port from the incoming request. For optimal reliability and
predictability, you should specify an explicit hostname and port
using the <code class="directive">ServerName</code> directive.</p>
<p>If you are using <a href="/vhosts/name-based.html">name-based virtual hosts</a>,
the <code class="directive">ServerName</code> inside a
<code class="directive"><a href="#virtualhost">&lt;VirtualHost&gt;</a></code>
section specifies what hostname must appear in the request's
<code>Host:</code> header to match this virtual host.</p>
<p>Sometimes, the server runs behind a device that processes SSL,
such as a reverse proxy, load balancer or SSL offload
appliance. When this is the case, specify the
<code>https://</code> scheme and the port number to which the
clients connect in the <code class="directive">ServerName</code> directive
to make sure that the server generates the correct
self-referential URLs.
</p>
<p>See the description of the
<code class="directive"><a href="#usecanonicalname">UseCanonicalName</a></code> and
<code class="directive"><a href="#usecanonicalphysicalport">UseCanonicalPhysicalPort</a></code> directives for
settings which determine whether self-referential URLs (e.g., by the
<code class="module"><a href="/mod/mod_dir.html">mod_dir</a></code> module) will refer to the
specified port, or to the port number given in the client's request.
</p>
<h3>See also</h3>
<ul>
<li><a href="/dns-caveats.html">Issues Regarding DNS and
Apache</a></li>
<li><a href="/vhosts/">Apache virtual host
documentation</a></li>
<li><code class="directive"><a href="#usecanonicalname">UseCanonicalName</a></code></li>
<li><code class="directive"><a href="#usecanonicalphysicalport">UseCanonicalPhysicalPort</a></code></li>
<li><code class="directive"><a href="#namevirtualhost">NameVirtualHost</a></code></li>
<li><code class="directive"><a href="#serveralias">ServerAlias</a></code></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="ServerPath" id="ServerPath">ServerPath</a> <a name="serverpath" id="serverpath">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Legacy URL pathname for a name-based virtual host that
is accessed by an incompatible browser</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ServerPath <var>URL-path</var></code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>The <code class="directive">ServerPath</code> directive sets the legacy
URL pathname for a host, for use with <a href="/vhosts/">name-based virtual hosts</a>.</p>
<h3>See also</h3>
<ul>
<li><a href="/vhosts/">Apache Virtual Host documentation</a></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="ServerRoot" id="ServerRoot">ServerRoot</a> <a name="serverroot" id="serverroot">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Base directory for the server installation</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ServerRoot <var>directory-path</var></code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ServerRoot /usr/local/apache</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>The <code class="directive">ServerRoot</code> directive sets the
directory in which the server lives. Typically it will contain the
subdirectories <code>conf/</code> and <code>logs/</code>. Relative
paths in other configuration directives (such as <code class="directive"><a href="#include">Include</a></code> or <code class="directive"><a href="/mod/mod_so.html#loadmodule">LoadModule</a></code>, for example) are taken as
relative to this directory.</p>
<div class="example"><h3>Example</h3><p><code>
ServerRoot /home/httpd
</code></p></div>
<h3>See also</h3>
<ul>
<li><a href="/invoking.html">the <code>-d</code>
option to <code>httpd</code></a></li>
<li><a href="/misc/security_tips.html#serverroot">the
security tips</a> for information on how to properly set
permissions on the <code class="directive">ServerRoot</code></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="ServerSignature" id="ServerSignature">ServerSignature</a> <a name="serversignature" id="serversignature">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures the footer on server-generated documents</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ServerSignature On|Off|EMail</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ServerSignature Off</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>The <code class="directive">ServerSignature</code> directive allows the
configuration of a trailing footer line under server-generated
documents (error messages, <code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code> ftp directory
listings, <code class="module"><a href="/mod/mod_info.html">mod_info</a></code> output, ...). The reason why you
would want to enable such a footer line is that in a chain of proxies,
the user often has no possibility to tell which of the chained servers
actually produced a returned error message.</p>
<p>The <code>Off</code>
setting, which is the default, suppresses the footer line (and is
therefore compatible with the behavior of Apache-1.2 and
below). The <code>On</code> setting simply adds a line with the
server version number and <code class="directive"><a href="#servername">ServerName</a></code> of the serving virtual host,
and the <code>EMail</code> setting additionally creates a
"mailto:" reference to the <code class="directive"><a href="#serveradmin">ServerAdmin</a></code> of the referenced
document.</p>
<p>After version 2.0.44, the details of the server version number
presented are controlled by the <code class="directive"><a href="#servertokens">ServerTokens</a></code> directive.</p>
<h3>See also</h3>
<ul>
<li><code class="directive"><a href="#servertokens">ServerTokens</a></code></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="ServerTokens" id="ServerTokens">ServerTokens</a> <a name="servertokens" id="servertokens">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures the <code>Server</code> HTTP response
header</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ServerTokens Major|Minor|Min[imal]|Prod[uctOnly]|OS|Full</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ServerTokens Full</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>This directive controls whether <code>Server</code> response
header field which is sent back to clients includes a
description of the generic OS-type of the server as well as
information about compiled-in modules.</p>
<dl>
<dt><code>ServerTokens Full</code> (or not specified)</dt>
<dd>Server sends (<em>e.g.</em>): <code>Server: Apache/2.0.41
(Unix) PHP/4.2.2 MyMod/1.2</code></dd>
<dt><code>ServerTokens Prod[uctOnly]</code></dt>
<dd>Server sends (<em>e.g.</em>): <code>Server:
Apache</code></dd>
<dt><code>ServerTokens Major</code></dt>
<dd>Server sends (<em>e.g.</em>): <code>Server:
Apache/2</code></dd>
<dt><code>ServerTokens Minor</code></dt>
<dd>Server sends (<em>e.g.</em>): <code>Server:
Apache/2.0</code></dd>
<dt><code>ServerTokens Min[imal]</code></dt>
<dd>Server sends (<em>e.g.</em>): <code>Server:
Apache/2.0.41</code></dd>
<dt><code>ServerTokens OS</code></dt>
<dd>Server sends (<em>e.g.</em>): <code>Server: Apache/2.0.41
(Unix)</code></dd>
</dl>
<p>This setting applies to the entire server, and cannot be
enabled or disabled on a virtualhost-by-virtualhost basis.</p>
<p>After version 2.0.44, this directive also controls the
information presented by the <code class="directive"><a href="#serversignature">ServerSignature</a></code> directive.</p>
<div class="note">Setting <code class="directive">ServerTokens</code> to less than
<code>minimal</code> is not recommended because it makes it more
difficult to debug interoperational problems. Also note that
disabling the Server: header does nothing at all to make your
server more secure; the idea of "security through obscurity"
is a myth and leads to a false sense of safety.</div>
<h3>See also</h3>
<ul>
<li><code class="directive"><a href="#serversignature">ServerSignature</a></code></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="SetHandler" id="SetHandler">SetHandler</a> <a name="sethandler" id="sethandler">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Forces all matching files to be processed by a
handler</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SetHandler <var>handler-name</var>|None</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Moved into the core in Apache 2.0</td></tr>
</table>
<p>When placed into an <code>.htaccess</code> file or a
<code class="directive"><a href="#directory">&lt;Directory&gt;</a></code> or
<code class="directive"><a href="#location">&lt;Location&gt;</a></code>
section, this directive forces all matching files to be parsed
through the <a href="/handler.html">handler</a> given by
<var>handler-name</var>. For example, if you had a directory you
wanted to be parsed entirely as imagemap rule files, regardless
of extension, you might put the following into an
<code>.htaccess</code> file in that directory:</p>
<div class="example"><p><code>
SetHandler imap-file
</code></p></div>
<p>Another example: if you wanted to have the server display a
status report whenever a URL of
<code>http://servername/status</code> was called, you might put
the following into <code>httpd.conf</code>:</p>
<div class="example"><p><code>
&lt;Location /status&gt;<br />
<span class="indent">
SetHandler server-status<br />
</span>
&lt;/Location&gt;
</code></p></div>
<p>You can override an earlier defined <code class="directive">SetHandler</code>
directive by using the value <code>None</code>.</p>
<p><strong>Note:</strong> because SetHandler overrides default handlers,
normal behaviour such as handling of URLs ending in a slash (/) as
directories or index files is suppressed.</p>
<h3>See also</h3>
<ul>
<li><code class="directive"><a href="/mod/mod_mime.html#addhandler">AddHandler</a></code></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="SetInputFilter" id="SetInputFilter">SetInputFilter</a> <a name="setinputfilter" id="setinputfilter">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the filters that will process client requests and POST
input</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SetInputFilter <var>filter</var>[;<var>filter</var>...]</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>The <code class="directive">SetInputFilter</code> directive sets the
filter or filters which will process client requests and POST
input when they are received by the server. This is in addition to
any filters defined elsewhere, including the
<code class="directive"><a href="/mod/mod_mime.html#addinputfilter">AddInputFilter</a></code>
directive.</p>
<p>If more than one filter is specified, they must be separated
by semicolons in the order in which they should process the
content.</p>
<h3>See also</h3>
<ul>
<li><a href="/filter.html">Filters</a> documentation</li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="SetOutputFilter" id="SetOutputFilter">SetOutputFilter</a> <a name="setoutputfilter" id="setoutputfilter">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the filters that will process responses from the
server</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SetOutputFilter <var>filter</var>[;<var>filter</var>...]</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>The <code class="directive">SetOutputFilter</code> directive sets the filters
which will process responses from the server before they are
sent to the client. This is in addition to any filters defined
elsewhere, including the
<code class="directive"><a href="/mod/mod_mime.html#addoutputfilter">AddOutputFilter</a></code>
directive.</p>
<p>For example, the following configuration will process all files
in the <code>/www/data/</code> directory for server-side
includes.</p>
<div class="example"><p><code>
&lt;Directory /www/data/&gt;<br />
<span class="indent">
SetOutputFilter INCLUDES<br />
</span>
&lt;/Directory&gt;
</code></p></div>
<p>If more than one filter is specified, they must be separated
by semicolons in the order in which they should process the
content.</p>
<h3>See also</h3>
<ul>
<li><a href="/filter.html">Filters</a> documentation</li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="TimeOut" id="TimeOut">TimeOut</a> <a name="timeout" id="timeout">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Amount of time the server will wait for
certain events before failing a request</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>TimeOut <var>seconds</var></code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>TimeOut 300</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>The <code class="directive">TimeOut</code> directive defines the length
of time Apache will wait for I/O in various circumstances:</p>
<ol>
<li>When reading data from the client, the length of time to
wait for a TCP packet to arrive if the read buffer is
empty.</li>
<li>When writing data to the client, the length of time to wait
for an acknowledgement of a packet if the send buffer is
full.</li>
<li>In <code class="module"><a href="/mod/mod_cgi.html">mod_cgi</a></code>, the length of time to wait for
output from a CGI script.</li>
<li>In <code class="module"><a href="/mod/mod_ext_filter.html">mod_ext_filter</a></code>, the length of time to
wait for output from a filtering process.</li>
<li>In <code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code>, the default timeout value if
<code class="directive"><a href="/mod/mod_proxy.html#proxytimeout">ProxyTimeout</a></code> is not
configured.</li>
</ol>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="TraceEnable" id="TraceEnable">TraceEnable</a> <a name="traceenable" id="traceenable">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Determines the behaviour on <code>TRACE</code>
requests</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>TraceEnable <var>[on|off|extended]</var></code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>TraceEnable on</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 1.3.34, 2.0.55 and later</td></tr>
</table>
<p>This directive overrides the behavior of <code>TRACE</code> for both
the core server and <code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code>. The default
<code>TraceEnable on</code> permits <code>TRACE</code> requests per
RFC 2616, which disallows any request body to accompany the request.
<code>TraceEnable off</code> causes the core server and
<code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code> to return a <code>405</code> (Method not
allowed) error to the client.</p>
<p>Finally, for testing and diagnostic purposes only, request
bodies may be allowed using the non-compliant <code>TraceEnable
extended</code> directive. The core (as an origin server) will
restrict the request body to 64k (plus 8k for chunk headers if
<code>Transfer-Encoding: chunked</code> is used). The core will
reflect the full headers and all chunk headers with the response
body. As a proxy server, the request body is not restricted to 64k.</p>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="UseCanonicalName" id="UseCanonicalName">UseCanonicalName</a> <a name="usecanonicalname" id="usecanonicalname">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures how the server determines its own name and
port</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>UseCanonicalName On|Off|DNS</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>UseCanonicalName Off</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>In many situations Apache must construct a <em>self-referential</em>
URL -- that is, a URL that refers back to the same server. With
<code>UseCanonicalName On</code> Apache will use the hostname and port
specified in the <code class="directive"><a href="#servername">ServerName</a></code>
directive to construct the canonical name for the server. This name
is used in all self-referential URLs, and for the values of
<code>SERVER_NAME</code> and <code>SERVER_PORT</code> in CGIs.</p>
<p>With <code>UseCanonicalName Off</code> Apache will form
self-referential URLs using the hostname and port supplied by
the client if any are supplied (otherwise it will use the
canonical name, as defined above). These values are the same
that are used to implement <a href="/vhosts/name-based.html">name based virtual hosts</a>,
and are available with the same clients. The CGI variables
<code>SERVER_NAME</code> and <code>SERVER_PORT</code> will be
constructed from the client supplied values as well.</p>
<p>An example where this may be useful is on an intranet server
where you have users connecting to the machine using short
names such as <code>www</code>. You'll notice that if the users
type a shortname, and a URL which is a directory, such as
<code>http://www/splat</code>, <em>without the trailing
slash</em> then Apache will redirect them to
<code>http://www.domain.com/splat/</code>. If you have
authentication enabled, this will cause the user to have to
authenticate twice (once for <code>www</code> and once again
for <code>www.domain.com</code> -- see <a href="http://httpd.apache.org/docs/misc/FAQ.html#prompted-twice">the
FAQ on this subject for more information</a>). But if
<code class="directive">UseCanonicalName</code> is set <code>Off</code>, then
Apache will redirect to <code>http://www/splat/</code>.</p>
<p>There is a third option, <code>UseCanonicalName DNS</code>,
which is intended for use with mass IP-based virtual hosting to
support ancient clients that do not provide a
<code>Host:</code> header. With this option Apache does a
reverse DNS lookup on the server IP address that the client
connected to in order to work out self-referential URLs.</p>
<div class="warning"><h3>Warning</h3>
<p>If CGIs make assumptions about the values of <code>SERVER_NAME</code>
they may be broken by this option. The client is essentially free
to give whatever value they want as a hostname. But if the CGI is
only using <code>SERVER_NAME</code> to construct self-referential URLs
then it should be just fine.</p>
</div>
<h3>See also</h3>
<ul>
<li><code class="directive"><a href="#usecanonicalphysicalport">UseCanonicalPhysicalPort</a></code></li>
<li><code class="directive"><a href="#servername">ServerName</a></code></li>
<li><code class="directive"><a href="/mod/mpm_common.html#listen">Listen</a></code></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="UseCanonicalPhysicalPort" id="UseCanonicalPhysicalPort">UseCanonicalPhysicalPort</a> <a name="usecanonicalphysicalport" id="usecanonicalphysicalport">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures how the server determines its own name and
port</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>UseCanonicalPhysicalPort On|Off</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>UseCanonicalPhysicalPort Off</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p>In many situations Apache must construct a <em>self-referential</em>
URL -- that is, a URL that refers back to the same server. With
<code>UseCanonicalPhysicalPort On</code> Apache will, when
constructing the canonical port for the server to honor
the <code class="directive"><a href="#usecanonicalname">UseCanonicalName</a></code> directive,
provide the actual physical port number being used by this request
as a potential port. With <code>UseCanonicalPhysicalPort Off</code>
Apache will not ever use the actual physical port number, instead
relying on all configured information to construct a valid port number.</p>
<div class="note"><h3>Note</h3>
<p>The ordering of when the physical port is used is as follows:<br /><br />
<code>UseCanonicalName On</code></p>
<ul>
<li>Port provided in <code>Servername</code></li>
<li>Physical port</li>
<li>Default port</li>
</ul>
<code>UseCanonicalName Off | DNS</code>
<ul>
<li>Parsed port from <code>Host:</code> header</li>
<li>Physical port</li>
<li>Port provided in <code>Servername</code></li>
<li>Default port</li>
</ul>
<p>With <code>UseCanonicalPhysicalPort Off</code>, the
physical ports are removed from the ordering.</p>
</div>
<h3>See also</h3>
<ul>
<li><code class="directive"><a href="#usecanonicalname">UseCanonicalName</a></code></li>
<li><code class="directive"><a href="#servername">ServerName</a></code></li>
<li><code class="directive"><a href="/mod/mpm_common.html#listen">Listen</a></code></li>
</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="VirtualHost" id="VirtualHost">&lt;VirtualHost&gt;</a> <a name="virtualhost" id="virtualhost">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Contains directives that apply only to a specific
hostname or IP address</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;VirtualHost
<var>addr</var>[:<var>port</var>] [<var>addr</var>[:<var>port</var>]]
...&gt; ... &lt;/VirtualHost&gt;</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
</table>
<p><code class="directive">&lt;VirtualHost&gt;</code> and
<code>&lt;/VirtualHost&gt;</code> are used to enclose a group of
directives that will apply only to a particular virtual host. Any
directive that is allowed in a virtual host context may be
used. When the server receives a request for a document on a
particular virtual host, it uses the configuration directives
enclosed in the <code class="directive">&lt;VirtualHost&gt;</code>
section. <var>Addr</var> can be:</p>
<ul>
<li>The IP address of the virtual host;</li>
<li>A fully qualified domain name for the IP address of the
virtual host (not recommended);</li>
<li>The character <code>*</code>, which is used only in combination with
<code>NameVirtualHost *</code> to match all IP addresses; or</li>
<li>The string <code>_default_</code>, which is used only
with IP virtual hosting to catch unmatched IP addresses.</li>
</ul>
<div class="example"><h3>Example</h3><p><code>
&lt;VirtualHost 10.1.2.3&gt;<br />
<span class="indent">
ServerAdmin webmaster@host.example.com<br />
DocumentRoot /www/docs/host.example.com<br />
ServerName host.example.com<br />
ErrorLog logs/host.example.com-error_log<br />
TransferLog logs/host.example.com-access_log<br />
</span>
&lt;/VirtualHost&gt;
</code></p></div>
<p>IPv6 addresses must be specified in square brackets because
the optional port number could not be determined otherwise. An
IPv6 example is shown below:</p>
<div class="example"><p><code>
&lt;VirtualHost [2001:db8::a00:20ff:fea7:ccea]&gt;<br />
<span class="indent">
ServerAdmin webmaster@host.example.com<br />
DocumentRoot /www/docs/host.example.com<br />
ServerName host.example.com<br />
ErrorLog logs/host.example.com-error_log<br />
TransferLog logs/host.example.com-access_log<br />
</span>
&lt;/VirtualHost&gt;
</code></p></div>
<p>Each Virtual Host must correspond to a different IP address,
different port number or a different host name for the server,
in the former case the server machine must be configured to
accept IP packets for multiple addresses. (If the machine does
not have multiple network interfaces, then this can be
accomplished with the <code>ifconfig alias</code> command -- if
your OS supports it).</p>
<div class="note"><h3>Note</h3>
<p>The use of <code class="directive">&lt;VirtualHost&gt;</code> does
<strong>not</strong> affect what addresses Apache listens on. You
may need to ensure that Apache is listening on the correct addresses
using <code class="directive"><a href="/mod/mpm_common.html#listen">Listen</a></code>.</p>
</div>
<p>When using IP-based virtual hosting, the special name
<code>_default_</code> can be specified in
which case this virtual host will match any IP address that is
not explicitly listed in another virtual host. In the absence
of any <code>_default_</code> virtual host the "main" server config,
consisting of all those definitions outside any VirtualHost
section, is used when no IP-match occurs.</p>
<p>You can specify a <code>:port</code> to change the port that is
matched. If unspecified then it defaults to the same port as the
most recent <code class="directive"><a href="/mod/mpm_common.html#listen">Listen</a></code>
statement of the main server. You may also specify <code>:*</code>
to match all ports on that address. (This is recommended when used
with <code>_default_</code>.)</p>
<p>A <code class="directive"><a href="#servername">ServerName</a></code> should be
specified inside each <code class="directive">&lt;VirtualHost&gt;</code> block. If it is absent, the
<code class="directive"><a href="#servername">ServerName</a></code> from the "main"
server configuration will be inherited.</p>
<div class="warning"><h3>Security</h3>
<p>See the <a href="/misc/security_tips.html">security tips</a>
document for details on why your security could be compromised if the
directory where log files are stored is writable by anyone other
than the user that starts the server.</p>
</div>
<h3>See also</h3>
<ul>
<li><a href="/vhosts/">Apache Virtual Host documentation</a></li>
<li><a href="/dns-caveats.html">Issues Regarding DNS and
Apache</a></li>
<li><a href="/bind.html">Setting
which addresses and ports Apache uses</a></li>
<li><a href="/sections.html">How &lt;Directory&gt;, &lt;Location&gt;
and &lt;Files&gt; sections work</a> for an explanation of how these
different sections are combined when a request is received</li>
</ul>
</div>
</div>
<div class="bottomlang">
<p><span>Available Languages: </span><a href="/de/mod/core.html" hreflang="de" rel="alternate" title="Deutsch">&nbsp;de&nbsp;</a> |
<a href="/en/mod/core.html" title="English">&nbsp;en&nbsp;</a> |
<a href="/fr/mod/core.html" hreflang="fr" rel="alternate" title="Fran�ais">&nbsp;fr&nbsp;</a> |
<a href="/ja/mod/core.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
<a href="/tr/mod/core.html" hreflang="tr" rel="alternate" title="T�rk�e">&nbsp;tr&nbsp;</a></p>
</div><div id="footer">
<p class="apache">Copyright 2009 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="/faq/">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p></div>
</body></html>