granicus.if.org Git - apache/blob - docs/manual/mod/core.html.en

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
   4 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
   5 <!--
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7               This file is generated from xml source: DO NOT EDIT
   8         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   9       -->
  10 <title>core - Apache HTTP Server Version 2.5</title>
  11 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  12 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  13 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
  14 <script src="../style/scripts/prettify.min.js" type="text/javascript">
  15 </script>
  16
  17 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  18 <body>
  19 <div id="page-header">
  20 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  21 <p class="apache">Apache HTTP Server Version 2.5</p>
  22 <img alt="" src="../images/feather.png" /></div>
  23 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  24 <div id="path">
  25 <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.5</a> &gt; <a href="./">Modules</a></div>
  26 <div id="page-content">
  27 <div id="preamble"><h1>Apache Core Features</h1>
  28 <div class="toplang">
  29 <p><span>Available Languages: </span><a href="../de/mod/core.html" hreflang="de" rel="alternate" title="Deutsch">&nbsp;de&nbsp;</a> |
  30 <a href="../en/mod/core.html" title="English">&nbsp;en&nbsp;</a> |
  31 <a href="../es/mod/core.html" hreflang="es" rel="alternate" title="Español">&nbsp;es&nbsp;</a> |
  32 <a href="../fr/mod/core.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
  33 <a href="../ja/mod/core.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
  34 <a href="../tr/mod/core.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
  35 </div>
  36 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Core Apache HTTP Server features that are always
  37 available</td></tr>
  38 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Core</td></tr></table>
  39 </div>
  40 <div id="quickview"><h3 class="directives">Directives</h3>
  41 <ul id="toc">
  42 <li><img alt="" src="../images/down.gif" /> <a href="#acceptfilter">AcceptFilter</a></li>
  43 <li><img alt="" src="../images/down.gif" /> <a href="#acceptpathinfo">AcceptPathInfo</a></li>
  44 <li><img alt="" src="../images/down.gif" /> <a href="#accessfilename">AccessFileName</a></li>
  45 <li><img alt="" src="../images/down.gif" /> <a href="#adddefaultcharset">AddDefaultCharset</a></li>
  46 <li><img alt="" src="../images/down.gif" /> <a href="#allowencodedslashes">AllowEncodedSlashes</a></li>
  47 <li><img alt="" src="../images/down.gif" /> <a href="#allowoverride">AllowOverride</a></li>
  48 <li><img alt="" src="../images/down.gif" /> <a href="#allowoverridelist">AllowOverrideList</a></li>
  49 <li><img alt="" src="../images/down.gif" /> <a href="#asyncfilter">AsyncFilter</a></li>
  50 <li><img alt="" src="../images/down.gif" /> <a href="#cgimapextension">CGIMapExtension</a></li>
  51 <li><img alt="" src="../images/down.gif" /> <a href="#cgipassauth">CGIPassAuth</a></li>
  52 <li><img alt="" src="../images/down.gif" /> <a href="#cgivar">CGIVar</a></li>
  53 <li><img alt="" src="../images/down.gif" /> <a href="#contentdigest">ContentDigest</a></li>
  54 <li><img alt="" src="../images/down.gif" /> <a href="#defaultruntimedir">DefaultRuntimeDir</a></li>
  55 <li><img alt="" src="../images/down.gif" /> <a href="#defaulttype">DefaultType</a></li>
  56 <li><img alt="" src="../images/down.gif" /> <a href="#define">Define</a></li>
  57 <li><img alt="" src="../images/down.gif" /> <a href="#directory">&lt;Directory&gt;</a></li>
  58 <li><img alt="" src="../images/down.gif" /> <a href="#directorymatch">&lt;DirectoryMatch&gt;</a></li>
  59 <li><img alt="" src="../images/down.gif" /> <a href="#documentroot">DocumentRoot</a></li>
  60 <li><img alt="" src="../images/down.gif" /> <a href="#else">&lt;Else&gt;</a></li>
  61 <li><img alt="" src="../images/down.gif" /> <a href="#elseif">&lt;ElseIf&gt;</a></li>
  62 <li><img alt="" src="../images/down.gif" /> <a href="#enablemmap">EnableMMAP</a></li>
  63 <li><img alt="" src="../images/down.gif" /> <a href="#enablesendfile">EnableSendfile</a></li>
  64 <li><img alt="" src="../images/down.gif" /> <a href="#error">Error</a></li>
  65 <li><img alt="" src="../images/down.gif" /> <a href="#errordocument">ErrorDocument</a></li>
  66 <li><img alt="" src="../images/down.gif" /> <a href="#errorlog">ErrorLog</a></li>
  67 <li><img alt="" src="../images/down.gif" /> <a href="#errorlogformat">ErrorLogFormat</a></li>
  68 <li><img alt="" src="../images/down.gif" /> <a href="#extendedstatus">ExtendedStatus</a></li>
  69 <li><img alt="" src="../images/down.gif" /> <a href="#fileetag">FileETag</a></li>
  70 <li><img alt="" src="../images/down.gif" /> <a href="#files">&lt;Files&gt;</a></li>
  71 <li><img alt="" src="../images/down.gif" /> <a href="#filesmatch">&lt;FilesMatch&gt;</a></li>
  72 <li><img alt="" src="../images/down.gif" /> <a href="#forcetype">ForceType</a></li>
  73 <li><img alt="" src="../images/down.gif" /> <a href="#gprofdir">GprofDir</a></li>
  74 <li><img alt="" src="../images/down.gif" /> <a href="#hostnamelookups">HostnameLookups</a></li>
  75 <li><img alt="" src="../images/down.gif" /> <a href="#httpprotocoloptions">HttpProtocolOptions</a></li>
  76 <li><img alt="" src="../images/down.gif" /> <a href="#if">&lt;If&gt;</a></li>
  77 <li><img alt="" src="../images/down.gif" /> <a href="#ifdefine">&lt;IfDefine&gt;</a></li>
  78 <li><img alt="" src="../images/down.gif" /> <a href="#ifdirective">&lt;IfDirective&gt;</a></li>
  79 <li><img alt="" src="../images/down.gif" /> <a href="#iffile">&lt;IfFile&gt;</a></li>
  80 <li><img alt="" src="../images/down.gif" /> <a href="#ifmodule">&lt;IfModule&gt;</a></li>
  81 <li><img alt="" src="../images/down.gif" /> <a href="#ifsection">&lt;IfSection&gt;</a></li>
  82 <li><img alt="" src="../images/down.gif" /> <a href="#include">Include</a></li>
  83 <li><img alt="" src="../images/down.gif" /> <a href="#includeoptional">IncludeOptional</a></li>
  84 <li><img alt="" src="../images/down.gif" /> <a href="#keepalive">KeepAlive</a></li>
  85 <li><img alt="" src="../images/down.gif" /> <a href="#keepalivetimeout">KeepAliveTimeout</a></li>
  86 <li><img alt="" src="../images/down.gif" /> <a href="#limit">&lt;Limit&gt;</a></li>
  87 <li><img alt="" src="../images/down.gif" /> <a href="#limitexcept">&lt;LimitExcept&gt;</a></li>
  88 <li><img alt="" src="../images/down.gif" /> <a href="#limitinternalrecursion">LimitInternalRecursion</a></li>
  89 <li><img alt="" src="../images/down.gif" /> <a href="#limitrequestbody">LimitRequestBody</a></li>
  90 <li><img alt="" src="../images/down.gif" /> <a href="#limitrequestfields">LimitRequestFields</a></li>
  91 <li><img alt="" src="../images/down.gif" /> <a href="#limitrequestfieldsize">LimitRequestFieldSize</a></li>
  92 <li><img alt="" src="../images/down.gif" /> <a href="#limitrequestline">LimitRequestLine</a></li>
  93 <li><img alt="" src="../images/down.gif" /> <a href="#limitxmlrequestbody">LimitXMLRequestBody</a></li>
  94 <li><img alt="" src="../images/down.gif" /> <a href="#location">&lt;Location&gt;</a></li>
  95 <li><img alt="" src="../images/down.gif" /> <a href="#locationmatch">&lt;LocationMatch&gt;</a></li>
  96 <li><img alt="" src="../images/down.gif" /> <a href="#loglevel">LogLevel</a></li>
  97 <li><img alt="" src="../images/down.gif" /> <a href="#logleveloverride">LogLevelOverride</a></li>
  98 <li><img alt="" src="../images/down.gif" /> <a href="#maxkeepaliverequests">MaxKeepAliveRequests</a></li>
  99 <li><img alt="" src="../images/down.gif" /> <a href="#maxrangeoverlaps">MaxRangeOverlaps</a></li>
 100 <li><img alt="" src="../images/down.gif" /> <a href="#maxrangereversals">MaxRangeReversals</a></li>
 101 <li><img alt="" src="../images/down.gif" /> <a href="#maxranges">MaxRanges</a></li>
 102 <li><img alt="" src="../images/down.gif" /> <a href="#mergetrailers">MergeTrailers</a></li>
 103 <li><img alt="" src="../images/down.gif" /> <a href="#mutex">Mutex</a></li>
 104 <li><img alt="" src="../images/down.gif" /> <a href="#namevirtualhost">NameVirtualHost</a></li>
 105 <li><img alt="" src="../images/down.gif" /> <a href="#options">Options</a></li>
 106 <li><img alt="" src="../images/down.gif" /> <a href="#protocol">Protocol</a></li>
 107 <li><img alt="" src="../images/down.gif" /> <a href="#protocols">Protocols</a></li>
 108 <li><img alt="" src="../images/down.gif" /> <a href="#protocolshonororder">ProtocolsHonorOrder</a></li>
 109 <li><img alt="" src="../images/down.gif" /> <a href="#qualifyredirecturl">QualifyRedirectURL</a></li>
 110 <li><img alt="" src="../images/down.gif" /> <a href="#registerhttpmethod">RegisterHttpMethod</a></li>
 111 <li><img alt="" src="../images/down.gif" /> <a href="#rlimitcpu">RLimitCPU</a></li>
 112 <li><img alt="" src="../images/down.gif" /> <a href="#rlimitmem">RLimitMEM</a></li>
 113 <li><img alt="" src="../images/down.gif" /> <a href="#rlimitnproc">RLimitNPROC</a></li>
 114 <li><img alt="" src="../images/down.gif" /> <a href="#scriptinterpretersource">ScriptInterpreterSource</a></li>
 115 <li><img alt="" src="../images/down.gif" /> <a href="#seerequesttail">SeeRequestTail</a></li>
 116 <li><img alt="" src="../images/down.gif" /> <a href="#serveradmin">ServerAdmin</a></li>
 117 <li><img alt="" src="../images/down.gif" /> <a href="#serveralias">ServerAlias</a></li>
 118 <li><img alt="" src="../images/down.gif" /> <a href="#servername">ServerName</a></li>
 119 <li><img alt="" src="../images/down.gif" /> <a href="#serverpath">ServerPath</a></li>
 120 <li><img alt="" src="../images/down.gif" /> <a href="#serverroot">ServerRoot</a></li>
 121 <li><img alt="" src="../images/down.gif" /> <a href="#serversignature">ServerSignature</a></li>
 122 <li><img alt="" src="../images/down.gif" /> <a href="#servertokens">ServerTokens</a></li>
 123 <li><img alt="" src="../images/down.gif" /> <a href="#sethandler">SetHandler</a></li>
 124 <li><img alt="" src="../images/down.gif" /> <a href="#setinputfilter">SetInputFilter</a></li>
 125 <li><img alt="" src="../images/down.gif" /> <a href="#setoutputfilter">SetOutputFilter</a></li>
 126 <li><img alt="" src="../images/down.gif" /> <a href="#timeout">TimeOut</a></li>
 127 <li><img alt="" src="../images/down.gif" /> <a href="#traceenable">TraceEnable</a></li>
 128 <li><img alt="" src="../images/down.gif" /> <a href="#undefine">UnDefine</a></li>
 129 <li><img alt="" src="../images/down.gif" /> <a href="#usecanonicalname">UseCanonicalName</a></li>
 130 <li><img alt="" src="../images/down.gif" /> <a href="#usecanonicalphysicalport">UseCanonicalPhysicalPort</a></li>
 131 <li><img alt="" src="../images/down.gif" /> <a href="#virtualhost">&lt;VirtualHost&gt;</a></li>
 132 <li><img alt="" src="../images/down.gif" /> <a href="#warning">Warning</a></li>
 133 </ul>
 134 <h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&amp;list_id=144532&amp;product=Apache%20httpd-2&amp;query_format=specific&amp;order=changeddate%20DESC%2Cpriority%2Cbug_severity&amp;component=core">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&amp;component=core">Report a bug</a></li></ul><h3>See also</h3>
 135 <ul class="seealso">
 136 <li><a href="#comments_section">Comments</a></li></ul></div>
 137
 138 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 139 <div class="directive-section"><h2><a name="AcceptFilter" id="AcceptFilter">AcceptFilter</a> <a name="acceptfilter" id="acceptfilter">Directive</a></h2>
 140 <table class="directive">
 141 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures optimizations for a Protocol's Listener Sockets</td></tr>
 142 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AcceptFilter <var>protocol</var> <var>accept_filter</var></code></td></tr>
 143 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 144 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
 145 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
 146 </table>
 147     <p>This directive enables operating system specific optimizations for a
 148        listening socket by the <code class="directive">Protocol</code> type.
 149        The basic premise is for the kernel to not send a socket to the server
 150        process until either data is received or an entire HTTP Request is buffered.
 151        Only <a href="http://www.freebsd.org/cgi/man.cgi?query=accept_filter&amp;sektion=9">
 152        FreeBSD's Accept Filters</a>, Linux's more primitive
 153        <code>TCP_DEFER_ACCEPT</code>, and Windows' optimized AcceptEx()
 154        are currently supported.</p>
 155
 156     <p>Using <code>none</code> for an argument will disable any accept filters
 157        for that protocol.  This is useful for protocols that require a server
 158        send data first, such as <code>ftp:</code> or <code>nntp</code>:</p>
 159     <pre class="prettyprint lang-config">AcceptFilter nntp none</pre>
 160
 161
 162     <p>The default protocol names are <code>https</code> for port 443
 163        and <code>http</code> for all other ports.  To specify that another
 164        protocol is being used with a listening port, add the <var>protocol</var>
 165        argument to the <code class="directive"><a href="../mod/mpm_common.html#listen">Listen</a></code>
 166        directive.</p>
 167
 168     <p>The default values on FreeBSD are:</p>
 169     <pre class="prettyprint lang-config">AcceptFilter http httpready
 170 AcceptFilter https dataready</pre>
 171
 172
 173     <p>The <code>httpready</code> accept filter buffers entire HTTP requests at
 174        the kernel level.  Once an entire request is received, the kernel then
 175        sends it to the server. See the
 176        <a href="http://www.freebsd.org/cgi/man.cgi?query=accf_http&amp;sektion=9">
 177        accf_http(9)</a> man page for more details.  Since HTTPS requests are
 178        encrypted, only the <a href="http://www.freebsd.org/cgi/man.cgi?query=accf_data&amp;sektion=9">
 179        accf_data(9)</a> filter is used.</p>
 180
 181     <p>The default values on Linux are:</p>
 182     <pre class="prettyprint lang-config">AcceptFilter http data
 183 AcceptFilter https data</pre>
 184
 185
 186     <p>Linux's <code>TCP_DEFER_ACCEPT</code> does not support buffering http
 187        requests.  Any value besides <code>none</code> will enable
 188        <code>TCP_DEFER_ACCEPT</code> on that listener. For more details
 189        see the Linux
 190        <a href="http://man7.org/linux/man-pages/man7/tcp.7.html">
 191        tcp(7)</a> man page.</p>
 192
 193     <p>The default values on Windows are:</p>
 194     <pre class="prettyprint lang-config">AcceptFilter http connect
 195 AcceptFilter https connect</pre>
 196
 197
 198     <p>Window's mpm_winnt interprets the AcceptFilter to toggle the AcceptEx()
 199        API, and does not support http protocol buffering. <code>connect</code>
 200        will use the AcceptEx() API, also retrieve the network endpoint
 201        addresses, but like <code>none</code> the <code>connect</code> option
 202        does not wait for the initial data transmission.</p>
 203
 204     <p>On Windows, <code>none</code> uses accept() rather than AcceptEx()
 205        and will not recycle sockets between connections.  This is useful for
 206        network adapters with broken driver support, as well as some virtual
 207        network providers such as vpn drivers, or spam, virus or spyware
 208        filters.</p>
 209
 210     <div class="warning">
 211       <h3>The <code>data</code> AcceptFilter (Windows)</h3>
 212
 213       <p>For versions 2.4.23 and prior, the Windows <code>data</code> accept
 214          filter waited until data had been transmitted and the initial data
 215          buffer and network endpoint addresses had been retrieved from the
 216          single AcceptEx() invocation. This implementation was subject to a
 217          denial of service attack and has been disabled.</p>
 218
 219       <p>Current releases of httpd default to the <code>connect</code> filter
 220          on Windows, and will fall back to <code>connect</code> if
 221          <code>data</code> is specified. Users of prior releases are encouraged
 222          to add an explicit setting of <code>connect</code> for their
 223          AcceptFilter, as shown above.</p>
 224     </div>
 225
 226
 227 <h3>See also</h3>
 228 <ul>
 229 <li><code class="directive"><a href="#protocol">Protocol</a></code></li>
 230 </ul>
 231 </div>
 232 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 233 <div class="directive-section"><h2><a name="AcceptPathInfo" id="AcceptPathInfo">AcceptPathInfo</a> <a name="acceptpathinfo" id="acceptpathinfo">Directive</a></h2>
 234 <table class="directive">
 235 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Resources accept trailing pathname information</td></tr>
 236 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AcceptPathInfo On|Off|Default</code></td></tr>
 237 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AcceptPathInfo Default</code></td></tr>
 238 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 239 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
 240 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
 241 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
 242 </table>
 243
 244     <p>This directive controls whether requests that contain trailing
 245     pathname information that follows an actual filename (or
 246     non-existent file in an existing directory) will be accepted or
 247     rejected.  The trailing pathname information can be made
 248     available to scripts in the <code>PATH_INFO</code> environment
 249     variable.</p>
 250
 251     <p>For example, assume the location <code>/test/</code> points to
 252     a directory that contains only the single file
 253     <code>here.html</code>.  Then requests for
 254     <code>/test/here.html/more</code> and
 255     <code>/test/nothere.html/more</code> both collect
 256     <code>/more</code> as <code>PATH_INFO</code>.</p>
 257
 258     <p>The three possible arguments for the
 259     <code class="directive">AcceptPathInfo</code> directive are:</p>
 260     <dl>
 261     <dt><code>Off</code></dt><dd>A request will only be accepted if it
 262     maps to a literal path that exists.  Therefore a request with
 263     trailing pathname information after the true filename such as
 264     <code>/test/here.html/more</code> in the above example will return
 265     a 404 NOT FOUND error.</dd>
 266
 267     <dt><code>On</code></dt><dd>A request will be accepted if a
 268     leading path component maps to a file that exists.  The above
 269     example <code>/test/here.html/more</code> will be accepted if
 270     <code>/test/here.html</code> maps to a valid file.</dd>
 271
 272     <dt><code>Default</code></dt><dd>The treatment of requests with
 273     trailing pathname information is determined by the <a href="../handler.html">handler</a> responsible for the request.
 274     The core handler for normal files defaults to rejecting
 275     <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
 276     <code>PATH_INFO</code> by default.</dd>
 277     </dl>
 278
 279     <p>The primary purpose of the <code>AcceptPathInfo</code>
 280     directive is to allow you to override the handler's choice of
 281     accepting or rejecting <code>PATH_INFO</code>. This override is required,
 282     for example, when you use a <a href="../filter.html">filter</a>, such
 283     as <a href="mod_include.html">INCLUDES</a>, to generate content
 284     based on <code>PATH_INFO</code>.  The core handler would usually reject
 285     the request, so you can use the following configuration to enable
 286     such a script:</p>
 287
 288     <pre class="prettyprint lang-config">&lt;Files "mypaths.shtml"&gt;
 289   Options +Includes
 290   SetOutputFilter INCLUDES
 291   AcceptPathInfo On
 292 &lt;/Files&gt;</pre>
 293
 294
 295
 296 </div>
 297 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 298 <div class="directive-section"><h2><a name="AccessFileName" id="AccessFileName">AccessFileName</a> <a name="accessfilename" id="accessfilename">Directive</a></h2>
 299 <table class="directive">
 300 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Name of the distributed configuration file</td></tr>
 301 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AccessFileName <var>filename</var> [<var>filename</var>] ...</code></td></tr>
 302 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AccessFileName .htaccess</code></td></tr>
 303 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 304 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
 305 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
 306 </table>
 307     <p>While processing a request, the server looks for
 308     the first existing configuration file from this list of names in
 309     every directory of the path to the document, if distributed
 310     configuration files are <a href="#allowoverride">enabled for that
 311     directory</a>. For example:</p>
 312
 313     <pre class="prettyprint lang-config">AccessFileName .acl</pre>
 314
 315
 316     <p>Before returning the document
 317     <code>/usr/local/web/index.html</code>, the server will read
 318     <code>/.acl</code>, <code>/usr/.acl</code>,
 319     <code>/usr/local/.acl</code> and <code>/usr/local/web/.acl</code>
 320     for directives unless they have been disabled with:</p>
 321
 322     <pre class="prettyprint lang-config">&lt;Directory "/"&gt;
 323     AllowOverride None
 324 &lt;/Directory&gt;</pre>
 325
 326
 327 <h3>See also</h3>
 328 <ul>
 329 <li><code class="directive"><a href="#allowoverride">AllowOverride</a></code></li>
 330 <li><a href="../configuring.html">Configuration Files</a></li>
 331 <li><a href="../howto/htaccess.html">.htaccess Files</a></li>
 332 </ul>
 333 </div>
 334 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 335 <div class="directive-section"><h2><a name="AddDefaultCharset" id="AddDefaultCharset">AddDefaultCharset</a> <a name="adddefaultcharset" id="adddefaultcharset">Directive</a></h2>
 336 <table class="directive">
 337 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Default charset parameter to be added when a response
 338 content-type is <code>text/plain</code> or <code>text/html</code></td></tr>
 339 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AddDefaultCharset On|Off|<var>charset</var></code></td></tr>
 340 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AddDefaultCharset Off</code></td></tr>
 341 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 342 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
 343 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
 344 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
 345 </table>
 346     <p>This directive specifies a default value for the media type
 347     charset parameter (the name of a character encoding) to be added
 348     to a response if and only if the response's content-type is either
 349     <code>text/plain</code> or <code>text/html</code>.  This should override
 350     any charset specified in the body of the response via a <code>META</code>
 351     element, though the exact behavior is often dependent on the user's client
 352     configuration. A setting of <code>AddDefaultCharset Off</code>
 353     disables this functionality. <code>AddDefaultCharset On</code> enables
 354     a default charset of <code>iso-8859-1</code>. Any other value is assumed
 355     to be the <var>charset</var> to be used, which should be one of the
 356     <a href="http://www.iana.org/assignments/character-sets">IANA registered
 357     charset values</a> for use in Internet media types (MIME types).
 358     For example:</p>
 359
 360     <pre class="prettyprint lang-config">AddDefaultCharset utf-8</pre>
 361
 362
 363     <p><code class="directive">AddDefaultCharset</code> should only be used when all
 364     of the text resources to which it applies are known to be in that
 365     character encoding and it is too inconvenient to label their charset
 366     individually. One such example is to add the charset parameter
 367     to resources containing generated content, such as legacy CGI
 368     scripts, that might be vulnerable to cross-site scripting attacks
 369     due to user-provided data being included in the output.  Note, however,
 370     that a better solution is to just fix (or delete) those scripts, since
 371     setting a default charset does not protect users that have enabled
 372     the "auto-detect character encoding" feature on their browser.</p>
 373
 374 <h3>See also</h3>
 375 <ul>
 376 <li><code class="directive"><a href="../mod/mod_mime.html#addcharset">AddCharset</a></code></li>
 377 </ul>
 378 </div>
 379 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 380 <div class="directive-section"><h2><a name="AllowEncodedSlashes" id="AllowEncodedSlashes">AllowEncodedSlashes</a> <a name="allowencodedslashes" id="allowencodedslashes">Directive</a></h2>
 381 <table class="directive">
 382 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Determines whether encoded path separators in URLs are allowed to
 383 be passed through</td></tr>
 384 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AllowEncodedSlashes On|Off|NoDecode</code></td></tr>
 385 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AllowEncodedSlashes Off</code></td></tr>
 386 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 387 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
 388 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
 389 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>
 390 NoDecode option available in 2.3.12 and later.</td></tr>
 391 </table>
 392     <p>The <code class="directive">AllowEncodedSlashes</code> directive allows URLs
 393     which contain encoded path separators (<code>%2F</code> for <code>/</code>
 394     and additionally <code>%5C</code> for <code>\</code> on accordant systems)
 395     to be used in the path info.</p>
 396
 397     <p>With the default value, <code>Off</code>, such URLs are refused
 398     with a 404 (Not found) error.</p>
 399
 400     <p>With the value <code>On</code>, such URLs are accepted, and encoded
 401       slashes are decoded like all other encoded characters.</p>
 402
 403     <p>With the value <code>NoDecode</code>, such URLs are accepted, but
 404       encoded slashes are not decoded but left in their encoded state.</p>
 405
 406     <p>Turning <code class="directive">AllowEncodedSlashes</code> <code>On</code> is
 407     mostly useful when used in conjunction with <code>PATH_INFO</code>.</p>
 408
 409     <div class="note"><h3>Note</h3>
 410       <p>If encoded slashes are needed in path info, use of <code>NoDecode</code> is
 411       strongly recommended as a security measure.  Allowing slashes
 412       to be decoded could potentially allow unsafe paths.</p>
 413     </div>
 414
 415 <h3>See also</h3>
 416 <ul>
 417 <li><code class="directive"><a href="#acceptpathinfo">AcceptPathInfo</a></code></li>
 418 </ul>
 419 </div>
 420 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 421 <div class="directive-section"><h2><a name="AllowOverride" id="AllowOverride">AllowOverride</a> <a name="allowoverride" id="allowoverride">Directive</a></h2>
 422 <table class="directive">
 423 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Types of directives that are allowed in
 424 <code>.htaccess</code> files</td></tr>
 425 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AllowOverride All|None|<var>directive-type</var>
 426 [<var>directive-type</var>] ...</code></td></tr>
 427 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AllowOverride None (2.3.9 and later), AllowOverride All (2.3.8 and earlier)</code></td></tr>
 428 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory</td></tr>
 429 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
 430 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
 431 </table>
 432     <p>When the server finds an <code>.htaccess</code> file (as
 433     specified by <code class="directive"><a href="#accessfilename">AccessFileName</a></code>),
 434     it needs to know which directives declared in that file can override
 435     earlier configuration directives.</p>
 436
 437     <div class="note"><h3>Only available in &lt;Directory&gt; sections</h3>
 438     <code class="directive">AllowOverride</code> is valid only in
 439     <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code>
 440     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
 441     <code class="directive"><a href="#files">&lt;Files&gt;</a></code> sections.
 442     </div>
 443
 444     <p>When this directive is set to <code>None</code> and <code class="directive"><a href="#allowoverridelist">AllowOverrideList</a></code> is set to
 445     <code>None</code>, <a href="#accessfilename">.htaccess</a> files are
 446     completely ignored. In this case, the server will not even attempt
 447     to read <code>.htaccess</code> files in the filesystem.</p>
 448
 449     <p>When this directive is set to <code>All</code>, then any
 450     directive which has the .htaccess <a href="directive-dict.html#Context">Context</a> is allowed in
 451     <code>.htaccess</code> files.</p>
 452
 453     <p>The <var>directive-type</var> can be one of the following
 454     groupings of directives. (See the <a href="overrides.html">override class
 455     index</a> for an up-to-date listing of which directives are enabled by each
 456     <var>directive-type</var>.)</p>
 457
 458     <dl>
 459       <dt><a href="overrides.html#override-authconfig">AuthConfig</a></dt>
 460
 461       <dd>
 462
 463       Allow use of the authorization directives (<code class="directive"><a href="../mod/mod_authz_dbm.html#authdbmgroupfile">AuthDBMGroupFile</a></code>,
 464       <code class="directive"><a href="../mod/mod_authn_dbm.html#authdbmuserfile">AuthDBMUserFile</a></code>,
 465       <code class="directive"><a href="../mod/mod_authz_groupfile.html#authgroupfile">AuthGroupFile</a></code>,
 466       <code class="directive"><a href="../mod/mod_authn_core.html#authname">AuthName</a></code>,
 467       <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>
 468
 469       <dt><a href="overrides.html#override-fileinfo">FileInfo</a></dt>
 470
 471       <dd>
 472       Allow use of the directives controlling document types
 473      (<code class="directive"><a href="#errordocument">ErrorDocument</a></code>,
 474       <code class="directive"><a href="#forcetype">ForceType</a></code>,
 475       <code class="directive"><a href="../mod/mod_negotiation.html#languagepriority">LanguagePriority</a></code>,
 476       <code class="directive"><a href="#sethandler">SetHandler</a></code>,
 477       <code class="directive"><a href="#setinputfilter">SetInputFilter</a></code>,
 478       <code class="directive"><a href="#setoutputfilter">SetOutputFilter</a></code>, and
 479       <code class="module"><a href="../mod/mod_mime.html">mod_mime</a></code> Add* and Remove* directives),
 480       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>),
 481       <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>),
 482       <code class="module"><a href="../mod/mod_alias.html">mod_alias</a></code> directives (<code class="directive"><a href="../mod/mod_alias.html#redirect">Redirect</a></code>, <code class="directive"><a href="../mod/mod_alias.html#redirecttemp">RedirectTemp</a></code>, <code class="directive"><a href="../mod/mod_alias.html#redirectpermanent">RedirectPermanent</a></code>, <code class="directive"><a href="../mod/mod_alias.html#redirectmatch">RedirectMatch</a></code>), and
 483       <code class="directive"><a href="../mod/mod_actions.html#action">Action</a></code> from
 484       <code class="module"><a href="../mod/mod_actions.html">mod_actions</a></code>.
 485       </dd>
 486
 487       <dt><a href="overrides.html#override-indexes">Indexes</a></dt>
 488
 489       <dd>
 490       Allow use of the directives controlling directory indexing
 491       (<code class="directive"><a href="../mod/mod_autoindex.html#adddescription">AddDescription</a></code>,
 492       <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>,
 493       <code class="directive"><a href="../mod/mod_autoindex.html#addiconbytype">AddIconByType</a></code>,
 494       <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_dir.html#fallbackresource">FallbackResource</a></code>, <a href="mod_autoindex.html#indexoptions.fancyindexing"><code>FancyIndexing</code></a>, <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>,
 495       <em>etc.</em>).</dd>
 496
 497       <dt><a href="overrides.html#override-limit">Limit</a></dt>
 498
 499       <dd>
 500       Allow use of the directives controlling host access (<code class="directive"><a href="../mod/mod_access_compat.html#allow">Allow</a></code>, <code class="directive"><a href="../mod/mod_access_compat.html#deny">Deny</a></code> and <code class="directive"><a href="../mod/mod_access_compat.html#order">Order</a></code>).</dd>
 501
 502
 503
 504
 505       <dt>Nonfatal=[Override|Unknown|All]</dt>
 506
 507       <dd>
 508       Allow use of AllowOverride option to treat invalid (unrecognized
 509       or disallowed) directives in
 510       .htaccess as nonfatal. Instead of causing an Internal Server
 511       Error, disallowed or unrecognised directives will be ignored
 512       and a warning logged:
 513       <ul>
 514           <li><strong>Nonfatal=Override</strong> treats directives
 515               forbidden by AllowOverride as nonfatal.</li>
 516           <li><strong>Nonfatal=Unknown</strong> treats unknown directives
 517               as nonfatal.  This covers typos and directives implemented
 518               by a module that's not present.</li>
 519           <li><strong>Nonfatal=All</strong> treats both the above as nonfatal.</li>
 520       </ul>
 521       <p>Note that a syntax error in a valid directive will still cause
 522       an Internal Server Error.</p>
 523       <div class="warning"><h3>Security</h3>
 524           Nonfatal errors may have security implications for .htaccess users.
 525           For example, if AllowOverride disallows AuthConfig, users'
 526           configuration designed to restrict access to a site will be disabled.
 527       </div>
 528       </dd>
 529
 530       <dt><a href="overrides.html#override-options">Options</a>[=<var>Option</var>,...]</dt>
 531
 532       <dd>
 533       Allow use of the directives controlling specific directory
 534       features (<code class="directive"><a href="#options">Options</a></code> and
 535       <code class="directive"><a href="../mod/mod_include.html#xbithack">XBitHack</a></code>).
 536       An equal sign may be given followed by a comma-separated list, without
 537       spaces, of options that may be set using the <code class="directive"><a href="#options">Options</a></code> command.
 538
 539       <div class="note"><h3>Implicit disabling of Options</h3>
 540       <p>Even though the list of options that may be used in .htaccess files
 541          can be limited with this directive, as long as any <code class="directive"><a href="#options">Options</a></code> directive is allowed any
 542          other inherited option can be disabled by using the non-relative
 543          syntax.  In other words, this mechanism cannot force a specific option
 544          to remain <em>set</em> while allowing any others to be set.
 545       </p></div>
 546
 547       <div class="example"><p><code>
 548       AllowOverride Options=Indexes,MultiViews
 549       </code></p></div>
 550       </dd>
 551     </dl>
 552
 553     <p>Example:</p>
 554
 555     <pre class="prettyprint lang-config">AllowOverride AuthConfig Indexes</pre>
 556
 557
 558     <p>In the example above, all directives that are neither in the group
 559     <code>AuthConfig</code> nor <code>Indexes</code> cause an internal
 560     server error.</p>
 561
 562     <div class="note"><p>For security and performance reasons, do not set
 563     <code>AllowOverride</code> to anything other than <code>None</code>
 564     in your <code>&lt;Directory "/"&gt;</code> block. Instead, find (or
 565     create) the <code>&lt;Directory&gt;</code> block that refers to the
 566     directory where you're actually planning to place a
 567     <code>.htaccess</code> file.</p>
 568     </div>
 569
 570 <h3>See also</h3>
 571 <ul>
 572 <li><code class="directive"><a href="#accessfilename">AccessFileName</a></code></li>
 573 <li><code class="directive"><a href="#allowoverridelist">AllowOverrideList</a></code></li>
 574 <li><a href="../configuring.html">Configuration Files</a></li>
 575 <li><a href="../howto/htaccess.html">.htaccess Files</a></li>
 576 <li><a href="overrides.html">Override Class Index for .htaccess</a></li>
 577 </ul>
 578 </div>
 579 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 580 <div class="directive-section"><h2><a name="AllowOverrideList" id="AllowOverrideList">AllowOverrideList</a> <a name="allowoverridelist" id="allowoverridelist">Directive</a></h2>
 581 <table class="directive">
 582 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Individual directives that are allowed in
 583 <code>.htaccess</code> files</td></tr>
 584 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AllowOverrideList None|<var>directive</var>
 585 [<var>directive-type</var>] ...</code></td></tr>
 586 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AllowOverrideList None</code></td></tr>
 587 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory</td></tr>
 588 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
 589 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
 590 </table>
 591     <p>When the server finds an <code>.htaccess</code> file (as
 592     specified by <code class="directive"><a href="#accessfilename">AccessFileName</a></code>),
 593     it needs to know which directives declared in that file can override
 594     earlier configuration directives.</p>
 595
 596     <div class="note"><h3>Only available in &lt;Directory&gt; sections</h3>
 597     <code class="directive">AllowOverrideList</code> is valid only in
 598     <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code>
 599     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
 600     <code class="directive"><a href="#files">&lt;Files&gt;</a></code> sections.
 601     </div>
 602
 603     <p>When this directive is set to <code>None</code> and <code class="directive"><a href="#allowoverride">AllowOverride</a></code> is set to <code>None</code>,
 604     then <a href="#accessfilename">.htaccess</a> files are completely
 605     ignored.  In this case, the server will not even attempt to read
 606     <code>.htaccess</code> files in the filesystem.</p>
 607
 608     <p>Example:</p>
 609
 610     <pre class="prettyprint lang-config">AllowOverride None
 611 AllowOverrideList Redirect RedirectMatch</pre>
 612
 613
 614     <p>In the example above, only the <code>Redirect</code> and
 615     <code>RedirectMatch</code> directives are allowed. All others will
 616     cause an Internal Server Error.</p>
 617
 618     <p>Example:</p>
 619
 620     <pre class="prettyprint lang-config">AllowOverride AuthConfig
 621 AllowOverrideList CookieTracking CookieName</pre>
 622
 623
 624     <p>In the example above, <code class="directive"><a href="#allowoverride">AllowOverride</a></code>
 625     grants permission to the <code>AuthConfig</code>
 626     directive grouping and <code class="directive">AllowOverrideList</code> grants
 627     permission to only two directives from the <code>FileInfo</code> directive
 628     grouping. All others will cause an Internal Server Error.</p>
 629
 630 <h3>See also</h3>
 631 <ul>
 632 <li><code class="directive"><a href="#accessfilename">AccessFileName</a></code></li>
 633 <li><code class="directive"><a href="#allowoverride">AllowOverride</a></code></li>
 634 <li><a href="../configuring.html">Configuration Files</a></li>
 635 <li><a href="../howto/htaccess.html">.htaccess Files</a></li>
 636 </ul>
 637 </div>
 638 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 639 <div class="directive-section"><h2><a name="AsyncFilter" id="AsyncFilter">AsyncFilter</a> <a name="asyncfilter" id="asyncfilter">Directive</a></h2>
 640 <table class="directive">
 641 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set the minimum filter type eligible for asynchronous handling</td></tr>
 642 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AsyncFilter request|connection|network</code></td></tr>
 643 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AsyncFilter request</code></td></tr>
 644 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 645 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
 646 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
 647 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Only available from Apache 2.5.0 and later.</td></tr>
 648 </table>
 649         <p>This directive controls the minimum filter levels that are eligible
 650         for asynchronous handling. This may be necessary to support legacy external
 651         filters that did not handle meta buckets correctly.</p>
 652
 653         <p>If set to "network", asynchronous handling will be limited to the network
 654         filter only. If set to "connection", all connection and network filters
 655         will be eligible for asynchronous handling, including <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code>.
 656         If set to "request", all filters will be eligible for asynchronous handling.</p>
 657
 658 </div>
 659 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 660 <div class="directive-section"><h2><a name="CGIMapExtension" id="CGIMapExtension">CGIMapExtension</a> <a name="cgimapextension" id="cgimapextension">Directive</a></h2>
 661 <table class="directive">
 662 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Technique for locating the interpreter for CGI
 663 scripts</td></tr>
 664 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CGIMapExtension <var>cgi-path</var> <var>.extension</var></code></td></tr>
 665 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
 666 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
 667 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
 668 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
 669 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>NetWare only</td></tr>
 670 </table>
 671     <p>This directive is used to control how Apache httpd finds the
 672     interpreter used to run CGI scripts. For example, setting
 673     <code>CGIMapExtension sys:\foo.nlm .foo</code> will
 674     cause all CGI script files with a <code>.foo</code> extension to
 675     be passed to the FOO interpreter.</p>
 676
 677 </div>
 678 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 679 <div class="directive-section"><h2><a name="CGIPassAuth" id="CGIPassAuth">CGIPassAuth</a> <a name="cgipassauth" id="cgipassauth">Directive</a></h2>
 680 <table class="directive">
 681 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables passing HTTP authorization headers to scripts as CGI
 682 variables</td></tr>
 683 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CGIPassAuth On|Off</code></td></tr>
 684 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CGIPassAuth Off</code></td></tr>
 685 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
 686 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
 687 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
 688 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
 689 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache HTTP Server 2.4.13 and later</td></tr>
 690 </table>
 691     <p><code class="directive">CGIPassAuth</code> allows scripts access to HTTP
 692     authorization headers such as <code>Authorization</code>, which is
 693     required for scripts that implement HTTP Basic authentication.
 694     Normally these HTTP headers are hidden from scripts. This is to disallow
 695     scripts from seeing user ids and passwords used to access the server when
 696     HTTP Basic authentication is enabled in the web server.  This directive
 697     should be used when scripts are allowed to implement HTTP Basic
 698     authentication.</p>
 699
 700     <p>This directive can be used instead of the compile-time setting
 701     <code>SECURITY_HOLE_PASS_AUTHORIZATION</code> which has been available
 702     in previous versions of Apache HTTP Server.</p>
 703
 704     <p>The setting is respected by any modules which use
 705     <code>ap_add_common_vars()</code>, such as <code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code>,
 706     <code class="module"><a href="../mod/mod_cgid.html">mod_cgid</a></code>, <code class="module"><a href="../mod/mod_proxy_fcgi.html">mod_proxy_fcgi</a></code>,
 707     <code class="module"><a href="../mod/mod_proxy_scgi.html">mod_proxy_scgi</a></code>, and so on.  Notably, it affects
 708     modules which don't handle the request in the usual sense but
 709     still use this API; examples of this are <code class="module"><a href="../mod/mod_include.html">mod_include</a></code>
 710     and <code class="module"><a href="../mod/mod_ext_filter.html">mod_ext_filter</a></code>.  Third-party modules that don't
 711     use <code>ap_add_common_vars()</code> may choose to respect the setting
 712     as well.</p>
 713
 714 </div>
 715 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 716 <div class="directive-section"><h2><a name="CGIVar" id="CGIVar">CGIVar</a> <a name="cgivar" id="cgivar">Directive</a></h2>
 717 <table class="directive">
 718 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Controls how some CGI variables are set</td></tr>
 719 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CGIVar <var>variable</var> <var>rule</var></code></td></tr>
 720 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
 721 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
 722 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
 723 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
 724 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache HTTP Server 2.4.21 and later</td></tr>
 725 </table>
 726   <p>This directive controls how some CGI variables are set.</p>
 727
 728   <p><strong>REQUEST_URI</strong> rules:</p>
 729   <dl>
 730     <dt><code>original-uri</code> (default)</dt>
 731     <dd>The value is taken from the original request line, and will not
 732     reflect internal redirects or subrequests which change the requested
 733     resource.</dd>
 734     <dt><code>current-uri</code></dt>
 735     <dd>The value reflects the resource currently being processed,
 736     which may be different than the original request from the client
 737     due to internal redirects or subrequests.</dd>
 738   </dl>
 739
 740 </div>
 741 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 742 <div class="directive-section"><h2><a name="ContentDigest" id="ContentDigest">ContentDigest</a> <a name="contentdigest" id="contentdigest">Directive</a></h2>
 743 <table class="directive">
 744 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables the generation of <code>Content-MD5</code> HTTP Response
 745 headers</td></tr>
 746 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ContentDigest On|Off</code></td></tr>
 747 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ContentDigest Off</code></td></tr>
 748 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 749 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Options</td></tr>
 750 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
 751 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
 752 </table>
 753     <p>This directive enables the generation of
 754     <code>Content-MD5</code> headers as defined in RFC1864
 755     respectively RFC2616.</p>
 756
 757     <p>MD5 is an algorithm for computing a "message digest"
 758     (sometimes called "fingerprint") of arbitrary-length data, with
 759     a high degree of confidence that any alterations in the data
 760     will be reflected in alterations in the message digest.</p>
 761
 762     <p>The <code>Content-MD5</code> header provides an end-to-end
 763     message integrity check (MIC) of the entity-body. A proxy or
 764     client may check this header for detecting accidental
 765     modification of the entity-body in transit. Example header:</p>
 766
 767     <div class="example"><p><code>
 768       Content-MD5: AuLb7Dp1rqtRtxz2m9kRpA==
 769     </code></p></div>
 770
 771     <p>Note that this can cause performance problems on your server
 772     since the message digest is computed on every request (the
 773     values are not cached).</p>
 774
 775     <p><code>Content-MD5</code> is only sent for documents served
 776     by the <code class="module"><a href="../mod/core.html">core</a></code>, and not by any module. For example,
 777     SSI documents, output from CGI scripts, and byte range responses
 778     do not have this header.</p>
 779
 780 </div>
 781 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 782 <div class="directive-section"><h2><a name="DefaultRuntimeDir" id="DefaultRuntimeDir">DefaultRuntimeDir</a> <a name="defaultruntimedir" id="defaultruntimedir">Directive</a></h2>
 783 <table class="directive">
 784 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Base directory for the server run-time files</td></tr>
 785 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DefaultRuntimeDir <var>directory-path</var></code></td></tr>
 786 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>DefaultRuntimeDir DEFAULT_REL_RUNTIMEDIR (logs/)</code></td></tr>
 787 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 788 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
 789 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
 790 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.4.2 and later</td></tr>
 791 </table>
 792     <p>The <code class="directive">DefaultRuntimeDir</code> directive sets the
 793     directory in which the server will create various run-time files
 794     (shared memory, locks, etc.). If set as a relative path, the full path
 795     will be relative to <code class="directive">ServerRoot</code>.</p>
 796
 797     <p><strong>Example</strong></p>
 798    <pre class="prettyprint lang-config">DefaultRuntimeDir scratch/</pre>
 799
 800
 801     <p>The default location of <code class="directive">DefaultRuntimeDir</code> may be
 802     modified by changing the <code>DEFAULT_REL_RUNTIMEDIR</code> #define
 803     at build time.</p>
 804
 805    <p>Note: <code class="directive">ServerRoot</code> should be specified before this
 806    directive is used. Otherwise, the default value of <code class="directive">ServerRoot</code>
 807    would be used to set the base directory.</p>
 808
 809
 810 <h3>See also</h3>
 811 <ul>
 812 <li><a href="../misc/security_tips.html#serverroot">the
 813     security tips</a> for information on how to properly set
 814     permissions on the <code class="directive">ServerRoot</code></li>
 815 </ul>
 816 </div>
 817 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 818 <div class="directive-section"><h2><a name="DefaultType" id="DefaultType">DefaultType</a> <a name="defaulttype" id="defaulttype">Directive</a></h2>
 819 <table class="directive">
 820 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>This directive has no effect other than to emit warnings
 821 if the value is not <code>none</code>. In prior versions, DefaultType
 822 would specify a default media type to assign to response content for
 823 which no other media type configuration could be found.
 824 </td></tr>
 825 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DefaultType <var>media-type|none</var></code></td></tr>
 826 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>DefaultType none</code></td></tr>
 827 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 828 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
 829 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
 830 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
 831 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>All choices except <code>none</code> are DISABLED for 2.3.x and later.
 832 </td></tr>
 833 </table>
 834     <p>This directive has been disabled.  For backwards compatibility
 835     of configuration files, it may be specified with the value
 836     <code>none</code>, meaning no default media type. For example:</p>
 837
 838     <pre class="prettyprint lang-config">DefaultType None</pre>
 839
 840
 841     <p><code>DefaultType None</code> is only available in
 842     httpd-2.2.7 and later.</p>
 843
 844     <p>Use the mime.types configuration file and the
 845     <code class="directive"><a href="../mod/mod_mime.html#addtype">AddType</a></code> to configure media
 846     type assignments via file extensions, or the
 847     <code class="directive"><a href="#forcetype">ForceType</a></code> directive to configure
 848     the media type for specific resources. Otherwise, the server will
 849     send the response without a Content-Type header field and the
 850     recipient may attempt to guess the media type.</p>
 851
 852 <h3>See also</h3>
 853 <ul>
 854 <li><code class="directive"><a href="#undefine">UnDefine</a></code></li>
 855 <li><code class="directive"><a href="#ifdefine">IfDefine</a></code></li>
 856 </ul>
 857 </div>
 858 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 859 <div class="directive-section"><h2><a name="Define" id="Define">Define</a> <a name="define" id="define">Directive</a></h2>
 860 <table class="directive">
 861 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Define a variable</td></tr>
 862 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Define <var>parameter-name</var> [<var>parameter-value</var>]</code></td></tr>
 863 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 864 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
 865 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
 866 </table>
 867     <p>In its one parameter form, <code class="directive">Define</code> is
 868     equivalent to passing the <code>-D</code> argument to
 869     <code class="program"><a href="../programs/httpd.html">httpd</a></code>. It can be used to toggle the use of
 870     <code class="directive"><a href="#ifdefine">&lt;IfDefine&gt;</a></code>
 871     sections without needing to alter <code>-D</code> arguments in any
 872     startup scripts.</p>
 873
 874     <p>In addition to that, if the second parameter is given, a config variable
 875     is set to this value. The variable can be used in the configuration using
 876     the <code>${VAR}</code> syntax. The variable is always globally defined
 877     and not limited to the scope of the surrounding config section.</p>
 878
 879     <pre class="prettyprint lang-config">&lt;IfDefine TEST&gt;
 880   Define servername test.example.com
 881 &lt;/IfDefine&gt;
 882 &lt;IfDefine !TEST&gt;
 883   Define servername www.example.com
 884   Define SSL
 885 &lt;/IfDefine&gt;
 886
 887 DocumentRoot "/var/www/${servername}/htdocs"</pre>
 888
 889
 890     <p>Variable names may not contain colon ":" characters, to avoid clashes
 891     with <code class="directive"><a href="../mod/mod_rewrite.html#rewritemap">RewriteMap</a></code>'s syntax.</p>
 892
 893     <div class="note"><h3>Virtual Host scope and pitfalls</h3>
 894       <p>While this directive is supported in virtual host context,
 895          the changes it makes are visible to any later configuration
 896          directives, beyond any enclosing virtual host.</p>
 897     </div>
 898
 899 </div>
 900 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 901 <div class="directive-section"><h2><a name="Directory" id="Directory">&lt;Directory&gt;</a> <a name="directory" id="directory">Directive</a></h2>
 902 <table class="directive">
 903 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enclose a group of directives that apply only to the
 904 named file-system directory, sub-directories, and their contents.</td></tr>
 905 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;Directory <var>directory-path</var>&gt;
 906 ... &lt;/Directory&gt;</code></td></tr>
 907 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 908 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
 909 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
 910 </table>
 911     <p><code class="directive">&lt;Directory&gt;</code> and
 912     <code>&lt;/Directory&gt;</code> are used to enclose a group of
 913     directives that will apply only to the named directory,
 914     sub-directories of that directory, and the files within the respective
 915     directories.  Any directive that is allowed
 916     in a directory context may be used. <var>Directory-path</var> is
 917     either the full path to a directory, or a wild-card string using
 918     Unix shell-style matching. In a wild-card string, <code>?</code> matches
 919     any single character, and <code>*</code> matches any sequences of
 920     characters. You may also use <code>[]</code> character ranges. None
 921     of the wildcards match a `/' character, so <code>&lt;Directory
 922     "/*/public_html"&gt;</code> will not match
 923     <code>/home/user/public_html</code>, but <code>&lt;Directory
 924     "/home/*/public_html"&gt;</code> will match. Example:</p>
 925
 926     <pre class="prettyprint lang-config">&lt;Directory "/usr/local/httpd/htdocs"&gt;
 927   Options Indexes FollowSymLinks
 928 &lt;/Directory&gt;</pre>
 929
 930
 931     <p>Directory paths <em>may</em> be quoted, if you like, however, it
 932     <em>must</em> be quoted if the path contains spaces. This is because a
 933     space would otherwise indicate the end of an argument.</p>
 934
 935     <div class="note">
 936       <p>Be careful with the <var>directory-path</var> arguments:
 937       They have to literally match the filesystem path which Apache httpd uses
 938       to access the files. Directives applied to a particular
 939       <code>&lt;Directory&gt;</code> will not apply to files accessed from
 940       that same directory via a different path, such as via different symbolic
 941       links.</p>
 942     </div>
 943
 944     <p><a class="glossarylink" href="../glossary.html#regex" title="see glossary">Regular
 945     expressions</a> can also be used, with the addition of the
 946     <code>~</code> character. For example:</p>
 947
 948     <pre class="prettyprint lang-config">&lt;Directory ~ "^/www/[0-9]{3}"&gt;
 949
 950 &lt;/Directory&gt;</pre>
 951
 952
 953     <p>would match directories in <code>/www/</code> that consisted of
 954     three numbers.</p>
 955
 956     <p>If multiple (non-regular expression) <code class="directive">&lt;Directory&gt;</code> sections
 957     match the directory (or one of its parents) containing a document,
 958     then the directives are applied in the order of shortest match
 959     first, interspersed with the directives from the <a href="#accessfilename">.htaccess</a> files. For example,
 960     with</p>
 961
 962     <pre class="prettyprint lang-config">&lt;Directory "/"&gt;
 963   AllowOverride None
 964 &lt;/Directory&gt;
 965
 966 &lt;Directory "/home"&gt;
 967   AllowOverride FileInfo
 968 &lt;/Directory&gt;</pre>
 969
 970
 971     <p>for access to the document <code>/home/web/dir/doc.html</code>
 972     the steps are:</p>
 973
 974     <ul>
 975       <li>Apply directive <code>AllowOverride None</code>
 976       (disabling <code>.htaccess</code> files).</li>
 977
 978       <li>Apply directive <code>AllowOverride FileInfo</code> (for
 979       directory <code>/home</code>).</li>
 980
 981       <li>Apply any <code>FileInfo</code> directives in
 982       <code>/home/.htaccess</code>, <code>/home/web/.htaccess</code> and
 983       <code>/home/web/dir/.htaccess</code> in that order.</li>
 984     </ul>
 985
 986     <p>Regular expressions are not considered until after all of the
 987     normal sections have been applied. Then all of the regular
 988     expressions are tested in the order they appeared in the
 989     configuration file. For example, with</p>
 990
 991     <pre class="prettyprint lang-config">&lt;Directory ~ "abc$"&gt;
 992   # ... directives here ...
 993 &lt;/Directory&gt;</pre>
 994
 995
 996     <p>the regular expression section won't be considered until after
 997     all normal <code class="directive">&lt;Directory&gt;</code>s and
 998     <code>.htaccess</code> files have been applied. Then the regular
 999     expression will match on <code>/home/abc/public_html/abc</code> and
1000     the corresponding <code class="directive">&lt;Directory&gt;</code> will
1001     be applied.</p>
1002
1003    <p><strong>Note that the default access for
1004     <code>&lt;Directory "/"&gt;</code> is to permit all access.
1005     This means that Apache httpd will serve any file mapped from an URL. It is
1006     recommended that you change this with a block such
1007     as</strong></p>
1008
1009     <pre class="prettyprint lang-config">&lt;Directory "/"&gt;
1010   Require all denied
1011 &lt;/Directory&gt;</pre>
1012
1013
1014     <p><strong>and then override this for directories you
1015     <em>want</em> accessible. See the <a href="../misc/security_tips.html">Security Tips</a> page for more
1016     details.</strong></p>
1017
1018     <p>The directory sections occur in the <code>httpd.conf</code> file.
1019     <code class="directive">&lt;Directory&gt;</code> directives
1020     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>
1021
1022 <h3>See also</h3>
1023 <ul>
1024 <li><a href="../sections.html">How &lt;Directory&gt;,
1025     &lt;Location&gt; and &lt;Files&gt; sections work</a> for an
1026     explanation of how these different sections are combined when a
1027     request is received</li>
1028 </ul>
1029 </div>
1030 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1031 <div class="directive-section"><h2><a name="DirectoryMatch" id="DirectoryMatch">&lt;DirectoryMatch&gt;</a> <a name="directorymatch" id="directorymatch">Directive</a></h2>
1032 <table class="directive">
1033 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enclose directives that apply to
1034 the contents of file-system directories matching a regular expression.</td></tr>
1035 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;DirectoryMatch <var>regex</var>&gt;
1036 ... &lt;/DirectoryMatch&gt;</code></td></tr>
1037 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1038 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
1039 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
1040 </table>
1041     <p><code class="directive">&lt;DirectoryMatch&gt;</code> and
1042     <code>&lt;/DirectoryMatch&gt;</code> are used to enclose a group
1043     of directives which will apply only to the named directory (and the files within),
1044     the same as <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code>.
1045     However, it takes as an argument a
1046     <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular expression</a>.  For example:</p>
1047
1048     <pre class="prettyprint lang-config">&lt;DirectoryMatch "^/www/(.+/)?[0-9]{3}/"&gt;
1049     # ...
1050 &lt;/DirectoryMatch&gt;</pre>
1051
1052
1053     <p>matches directories in <code>/www/</code> (or any subdirectory thereof)
1054     that consist of three numbers.</p>
1055
1056    <div class="note"><h3>Compatibility</h3>
1057       Prior to 2.3.9, this directive implicitly applied to sub-directories
1058       (like <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code>) and
1059       could not match the end of line symbol ($).  In 2.3.9 and later,
1060       only directories that match the expression are affected by the enclosed
1061       directives.
1062     </div>
1063
1064     <div class="note"><h3>Trailing Slash</h3>
1065       This directive applies to requests for directories that may or may
1066       not end in a trailing slash, so expressions that are anchored to the
1067       end of line ($) must be written with care.
1068     </div>
1069
1070     <p>From 2.4.8 onwards, named groups and backreferences are captured and
1071     written to the environment with the corresponding name prefixed with
1072     "MATCH_" and in upper case. This allows elements of paths to be referenced
1073     from within <a href="../expr.html">expressions</a> and modules like
1074     <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>. In order to prevent confusion, numbered
1075     (unnamed) backreferences are ignored. Use named groups instead.</p>
1076
1077     <pre class="prettyprint lang-config">&lt;DirectoryMatch "^/var/www/combined/(?&lt;sitename&gt;[^/]+)"&gt;
1078     Require ldap-group cn=%{env:MATCH_SITENAME},ou=combined,o=Example
1079 &lt;/DirectoryMatch&gt;</pre>
1080
1081
1082 <h3>See also</h3>
1083 <ul>
1084 <li><code class="directive"><a href="#directory">&lt;Directory&gt;</a></code> for
1085 a description of how regular expressions are mixed in with normal
1086 <code class="directive">&lt;Directory&gt;</code>s</li>
1087 <li><a href="../sections.html">How &lt;Directory&gt;, &lt;Location&gt; and
1088 &lt;Files&gt; sections work</a> for an explanation of how these different
1089 sections are combined when a request is received</li>
1090 </ul>
1091 </div>
1092 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1093 <div class="directive-section"><h2><a name="DocumentRoot" id="DocumentRoot">DocumentRoot</a> <a name="documentroot" id="documentroot">Directive</a></h2>
1094 <table class="directive">
1095 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Directory that forms the main document tree visible
1096 from the web</td></tr>
1097 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DocumentRoot <var>directory-path</var></code></td></tr>
1098 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>DocumentRoot "/usr/local/apache/htdocs"</code></td></tr>
1099 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1100 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
1101 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
1102 </table>
1103     <p>This directive sets the directory from which <code class="program"><a href="../programs/httpd.html">httpd</a></code>
1104     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
1105     path from the requested URL to the document root to make the
1106     path to the document. Example:</p>
1107
1108     <pre class="prettyprint lang-config">DocumentRoot "/usr/web"</pre>
1109
1110
1111     <p>then an access to
1112     <code>http://my.example.com/index.html</code> refers to
1113     <code>/usr/web/index.html</code>. If the <var>directory-path</var> is
1114     not absolute then it is assumed to be relative to the <code class="directive"><a href="#serverroot">ServerRoot</a></code>.</p>
1115
1116     <p>The <code class="directive">DocumentRoot</code> should be specified without
1117     a trailing slash.</p>
1118
1119 <h3>See also</h3>
1120 <ul>
1121 <li><a href="../urlmapping.html#documentroot">Mapping URLs to Filesystem
1122 Locations</a></li>
1123 </ul>
1124 </div>
1125 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1126 <div class="directive-section"><h2><a name="Else" id="Else">&lt;Else&gt;</a> <a name="else" id="else">Directive</a></h2>
1127 <table class="directive">
1128 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Contains directives that apply only if the condition of a
1129 previous <code class="directive"><a href="#if">&lt;If&gt;</a></code> or
1130 <code class="directive"><a href="#elseif">&lt;ElseIf&gt;</a></code> section is not
1131 satisfied by a request at runtime</td></tr>
1132 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;Else&gt; ... &lt;/Else&gt;</code></td></tr>
1133 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1134 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1135 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
1136 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
1137 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Nested conditions are evaluated in 2.4.26 and later</td></tr>
1138 </table>
1139     <p>The <code class="directive">&lt;Else&gt;</code> applies the enclosed
1140     directives if and only if the most recent
1141     <code class="directive">&lt;If&gt;</code> or
1142     <code class="directive">&lt;ElseIf&gt;</code> section
1143     in the same scope has not been applied.
1144     For example: In </p>
1145
1146     <pre class="prettyprint lang-config">&lt;If "-z req('Host')"&gt;
1147   # ...
1148 &lt;/If&gt;
1149 &lt;Else&gt;
1150   # ...
1151 &lt;/Else&gt;</pre>
1152
1153
1154     <p> The <code class="directive">&lt;If&gt;</code> would match HTTP/1.0
1155         requests without a <var>Host:</var> header and the
1156         <code class="directive">&lt;Else&gt;</code> would match requests
1157         with a <var>Host:</var> header.</p>
1158
1159
1160 <h3>See also</h3>
1161 <ul>
1162 <li><code class="directive"><a href="#if">&lt;If&gt;</a></code></li>
1163 <li><code class="directive"><a href="#elseif">&lt;ElseIf&gt;</a></code></li>
1164 <li><a href="../sections.html">How &lt;Directory&gt;, &lt;Location&gt;,
1165     &lt;Files&gt; sections work</a> for an explanation of how these
1166     different sections are combined when a request is received.
1167     <code class="directive">&lt;If&gt;</code>,
1168     <code class="directive">&lt;ElseIf&gt;</code>, and
1169     <code class="directive">&lt;Else&gt;</code> are applied last.</li>
1170 </ul>
1171 </div>
1172 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1173 <div class="directive-section"><h2><a name="ElseIf" id="ElseIf">&lt;ElseIf&gt;</a> <a name="elseif" id="elseif">Directive</a></h2>
1174 <table class="directive">
1175 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Contains directives that apply only if a condition is satisfied
1176 by a request at runtime while the condition of a previous
1177 <code class="directive"><a href="#if">&lt;If&gt;</a></code> or
1178 <code class="directive">&lt;ElseIf&gt;</code> section is not
1179 satisfied</td></tr>
1180 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;ElseIf <var>expression</var>&gt; ... &lt;/ElseIf&gt;</code></td></tr>
1181 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1182 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1183 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
1184 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
1185 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Nested conditions are evaluated in 2.4.26 and later</td></tr>
1186 </table>
1187     <p>The <code class="directive">&lt;ElseIf&gt;</code> applies the enclosed
1188     directives if and only if both the given condition evaluates to true and
1189     the most recent <code class="directive">&lt;If&gt;</code> or
1190     <code class="directive">&lt;ElseIf&gt;</code> section in the same scope has
1191     not been applied.  For example: In </p>
1192
1193     <pre class="prettyprint lang-config">&lt;If "-R '10.1.0.0/16'"&gt;
1194   #...
1195 &lt;/If&gt;
1196 &lt;ElseIf "-R '10.0.0.0/8'"&gt;
1197   #...
1198 &lt;/ElseIf&gt;
1199 &lt;Else&gt;
1200   #...
1201 &lt;/Else&gt;</pre>
1202
1203
1204     <p>The <code class="directive">&lt;ElseIf&gt;</code> would match if
1205     the remote address of a request belongs to the subnet 10.0.0.0/8 but
1206     not to the subnet 10.1.0.0/16.</p>
1207
1208
1209 <h3>See also</h3>
1210 <ul>
1211 <li><a href="../expr.html">Expressions in Apache HTTP Server</a>,
1212 for a complete reference and more examples.</li>
1213 <li><code class="directive"><a href="#if">&lt;If&gt;</a></code></li>
1214 <li><code class="directive"><a href="#else">&lt;Else&gt;</a></code></li>
1215 <li><a href="../sections.html">How &lt;Directory&gt;, &lt;Location&gt;,
1216     &lt;Files&gt; sections work</a> for an explanation of how these
1217     different sections are combined when a request is received.
1218     <code class="directive">&lt;If&gt;</code>,
1219     <code class="directive">&lt;ElseIf&gt;</code>, and
1220     <code class="directive">&lt;Else&gt;</code> are applied last.</li>
1221 </ul>
1222 </div>
1223 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1224 <div class="directive-section"><h2><a name="EnableMMAP" id="EnableMMAP">EnableMMAP</a> <a name="enablemmap" id="enablemmap">Directive</a></h2>
1225 <table class="directive">
1226 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Use memory-mapping to read files during delivery</td></tr>
1227 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>EnableMMAP On|Off</code></td></tr>
1228 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>EnableMMAP On</code></td></tr>
1229 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1230 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
1231 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
1232 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
1233 </table>
1234     <p>This directive controls whether the <code class="program"><a href="../programs/httpd.html">httpd</a></code> may use
1235     memory-mapping if it needs to read the contents of a file during
1236     delivery.  By default, when the handling of a request requires
1237     access to the data within a file -- for example, when delivering a
1238     server-parsed file using <code class="module"><a href="../mod/mod_include.html">mod_include</a></code> -- Apache httpd
1239     memory-maps the file if the OS supports it.</p>
1240
1241     <p>This memory-mapping sometimes yields a performance improvement.
1242     But in some environments, it is better to disable the memory-mapping
1243     to prevent operational problems:</p>
1244
1245     <ul>
1246     <li>On some multiprocessor systems, memory-mapping can reduce the
1247     performance of the <code class="program"><a href="../programs/httpd.html">httpd</a></code>.</li>
1248     <li>Deleting or truncating a file while <code class="program"><a href="../programs/httpd.html">httpd</a></code>
1249       has it memory-mapped can cause <code class="program"><a href="../programs/httpd.html">httpd</a></code> to
1250       crash with a segmentation fault.
1251     </li>
1252     </ul>
1253
1254     <p>For server configurations that are vulnerable to these problems,
1255     you should disable memory-mapping of delivered files by specifying:</p>
1256
1257     <pre class="prettyprint lang-config">EnableMMAP Off</pre>
1258
1259
1260     <p>For NFS mounted files, this feature may be disabled explicitly for
1261     the offending files by specifying:</p>
1262
1263     <pre class="prettyprint lang-config">&lt;Directory "/path-to-nfs-files"&gt;
1264   EnableMMAP Off
1265 &lt;/Directory&gt;</pre>
1266
1267
1268 </div>
1269 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1270 <div class="directive-section"><h2><a name="EnableSendfile" id="EnableSendfile">EnableSendfile</a> <a name="enablesendfile" id="enablesendfile">Directive</a></h2>
1271 <table class="directive">
1272 <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>
1273 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>EnableSendfile On|Off</code></td></tr>
1274 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>EnableSendfile Off</code></td></tr>
1275 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1276 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
1277 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
1278 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
1279 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Default changed to Off in
1280 version 2.3.9.</td></tr>
1281 </table>
1282     <p>This directive controls whether <code class="program"><a href="../programs/httpd.html">httpd</a></code> may use the
1283     sendfile support from the kernel to transmit file contents to the client.
1284     By default, when the handling of a request requires no access
1285     to the data within a file -- for example, when delivering a
1286     static file -- Apache httpd uses sendfile to deliver the file contents
1287     without ever reading the file if the OS supports it.</p>
1288
1289     <p>This sendfile mechanism avoids separate read and send operations,
1290     and buffer allocations. But on some platforms or within some
1291     filesystems, it is better to disable this feature to avoid
1292     operational problems:</p>
1293
1294     <ul>
1295     <li>Some platforms may have broken sendfile support that the build
1296     system did not detect, especially if the binaries were built on
1297     another box and moved to such a machine with broken sendfile
1298     support.</li>
1299     <li>On Linux the use of sendfile triggers TCP-checksum
1300     offloading bugs on certain networking cards when using IPv6.</li>
1301     <li>On Linux on Itanium, <code>sendfile</code> may be unable to handle
1302     files over 2GB in size.</li>
1303     <li>With a network-mounted <code class="directive"><a href="#documentroot">DocumentRoot</a></code> (e.g., NFS, SMB, CIFS, FUSE),
1304     the kernel may be unable to serve the network file through
1305     its own cache.</li>
1306     </ul>
1307
1308     <p>For server configurations that are not vulnerable to these problems,
1309     you may enable this feature by specifying:</p>
1310
1311     <pre class="prettyprint lang-config">EnableSendfile On</pre>
1312
1313
1314     <p>For network mounted files, this feature may be disabled explicitly
1315     for the offending files by specifying:</p>
1316
1317     <pre class="prettyprint lang-config">&lt;Directory "/path-to-nfs-files"&gt;
1318   EnableSendfile Off
1319 &lt;/Directory&gt;</pre>
1320
1321     <p>Please note that the per-directory and .htaccess configuration
1322        of <code class="directive">EnableSendfile</code> is not supported by
1323        <code class="module"><a href="../mod/mod_cache_disk.html">mod_cache_disk</a></code>.
1324        Only global definition of <code class="directive">EnableSendfile</code>
1325        is taken into account by the module.
1326     </p>
1327
1328 </div>
1329 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1330 <div class="directive-section"><h2><a name="Error" id="Error">Error</a> <a name="error" id="error">Directive</a></h2>
1331 <table class="directive">
1332 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Abort configuration parsing with a custom error message</td></tr>
1333 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Error <var>message</var></code></td></tr>
1334 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1335 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1336 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
1337 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
1338 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>2.3.9 and later</td></tr>
1339 </table>
1340     <p>If an error can be detected within the configuration, this
1341     directive can be used to generate a custom error message, and halt
1342     configuration parsing.  The typical use is for reporting required
1343     modules which are missing from the configuration.</p>
1344
1345     <pre class="prettyprint lang-config"># Example
1346 # ensure that mod_include is loaded
1347 &lt;IfModule !include_module&gt;
1348   Error "mod_include is required by mod_foo.  Load it with LoadModule."
1349 &lt;/IfModule&gt;
1350
1351 # ensure that exactly one of SSL,NOSSL is defined
1352 &lt;IfDefine SSL&gt;
1353 &lt;IfDefine NOSSL&gt;
1354   Error "Both SSL and NOSSL are defined.  Define only one of them."
1355 &lt;/IfDefine&gt;
1356 &lt;/IfDefine&gt;
1357 &lt;IfDefine !SSL&gt;
1358 &lt;IfDefine !NOSSL&gt;
1359   Error "Either SSL or NOSSL must be defined."
1360 &lt;/IfDefine&gt;
1361 &lt;/IfDefine&gt;</pre>
1362
1363
1364
1365 </div>
1366 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1367 <div class="directive-section"><h2><a name="ErrorDocument" id="ErrorDocument">ErrorDocument</a> <a name="errordocument" id="errordocument">Directive</a></h2>
1368 <table class="directive">
1369 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>What the server will return to the client
1370 in case of an error</td></tr>
1371 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ErrorDocument <var>error-code</var> <var>document</var></code></td></tr>
1372 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1373 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
1374 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
1375 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
1376 </table>
1377     <p>In the event of a problem or error, Apache httpd can be configured
1378     to do one of four things,</p>
1379
1380     <ol>
1381       <li>output a simple hardcoded error message</li>
1382
1383       <li>output a customized message</li>
1384
1385       <li>internally redirect to a local <var>URL-path</var> to handle the
1386       problem/error</li>
1387
1388       <li>redirect to an external <var>URL</var> to handle the
1389       problem/error</li>
1390     </ol>
1391
1392     <p>The first option is the default, while options 2-4 are
1393     configured using the <code class="directive">ErrorDocument</code>
1394     directive, which is followed by the HTTP response code and a URL
1395     or a message. Apache httpd will sometimes offer additional information
1396     regarding the problem/error.</p>
1397
1398     <p>From 2.4.13, <a href="../expr.html">expression syntax</a> can be
1399     used inside the directive to produce dynamic strings and URLs.</p>
1400
1401     <p>URLs can begin with a slash (/) for local web-paths (relative
1402     to the <code class="directive"><a href="#documentroot">DocumentRoot</a></code>), or be a
1403     full URL which the client can resolve. Alternatively, a message
1404     can be provided to be displayed by the browser. Note that deciding
1405     whether the parameter is an URL, a path or a message is performed
1406     before any expression is parsed. Examples:</p>
1407
1408     <pre class="prettyprint lang-config">ErrorDocument 500 http://example.com/cgi-bin/server-error.cgi
1409 ErrorDocument 404 /errors/bad_urls.php
1410 ErrorDocument 401 /subscription_info.html
1411 ErrorDocument 403 "Sorry, can't allow you access today"
1412 ErrorDocument 403 Forbidden!
1413 ErrorDocument 403 /errors/forbidden.py?referrer=%{escape:%{HTTP_REFERER}}</pre>
1414
1415
1416     <p>Additionally, the special value <code>default</code> can be used
1417     to specify Apache httpd's simple hardcoded message.  While not required
1418     under normal circumstances, <code>default</code> will restore
1419     Apache httpd's simple hardcoded message for configurations that would
1420     otherwise inherit an existing <code class="directive">ErrorDocument</code>.</p>
1421
1422     <pre class="prettyprint lang-config">ErrorDocument 404 /cgi-bin/bad_urls.pl
1423
1424 &lt;Directory "/web/docs"&gt;
1425   ErrorDocument 404 default
1426 &lt;/Directory&gt;</pre>
1427
1428
1429     <p>Note that when you specify an <code class="directive">ErrorDocument</code>
1430     that points to a remote URL (ie. anything with a method such as
1431     <code>http</code> in front of it), Apache HTTP Server will send a redirect to the
1432     client to tell it where to find the document, even if the
1433     document ends up being on the same server. This has several
1434     implications, the most important being that the client will not
1435     receive the original error status code, but instead will
1436     receive a redirect status code. This in turn can confuse web
1437     robots and other clients which try to determine if a URL is
1438     valid using the status code. In addition, if you use a remote
1439     URL in an <code>ErrorDocument 401</code>, the client will not
1440     know to prompt the user for a password since it will not
1441     receive the 401 status code. Therefore, <strong>if you use an
1442     <code>ErrorDocument 401</code> directive, then it must refer to a local
1443     document.</strong></p>
1444
1445     <p>Microsoft Internet Explorer (MSIE) will by default ignore
1446     server-generated error messages when they are "too small" and substitute
1447     its own "friendly" error messages. The size threshold varies depending on
1448     the type of error, but in general, if you make your error document
1449     greater than 512 bytes, then MSIE will show the server-generated
1450     error rather than masking it.  More information is available in
1451     Microsoft Knowledge Base article <a href="http://support.microsoft.com/default.aspx?scid=kb;en-us;Q294807">Q294807</a>.</p>
1452
1453     <p>Although most error messages can be overridden, there are certain
1454     circumstances where the internal messages are used regardless of the
1455     setting of <code class="directive"><a href="#errordocument">ErrorDocument</a></code>.  In
1456     particular, if a malformed request is detected, normal request processing
1457     will be immediately halted and the internal error message returned.
1458     This is necessary to guard against security problems caused by
1459     bad requests.</p>
1460
1461     <p>If you are using mod_proxy, you may wish to enable
1462     <code class="directive"><a href="../mod/mod_proxy.html#proxyerroroverride">ProxyErrorOverride</a></code> so that you can provide
1463     custom error messages on behalf of your Origin servers. If you don't enable ProxyErrorOverride,
1464     Apache httpd will not generate custom error documents for proxied content.</p>
1465
1466 <h3>See also</h3>
1467 <ul>
1468 <li><a href="../custom-error.html">documentation of
1469     customizable responses</a></li>
1470 </ul>
1471 </div>
1472 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1473 <div class="directive-section"><h2><a name="ErrorLog" id="ErrorLog">ErrorLog</a> <a name="errorlog" id="errorlog">Directive</a></h2>
1474 <table class="directive">
1475 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Location where the server will log errors</td></tr>
1476 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code> ErrorLog <var>file-path</var>|syslog[:[<var>facility</var>][:<var>tag</var>]]</code></td></tr>
1477 <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>
1478 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1479 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
1480 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
1481 </table>
1482     <p>The <code class="directive">ErrorLog</code> directive sets the name of
1483     the file to which the server will log any errors it encounters. If
1484     the <var>file-path</var> is not absolute then it is assumed to be
1485     relative to the <code class="directive"><a href="#serverroot">ServerRoot</a></code>.</p>
1486
1487     <pre class="prettyprint lang-config">ErrorLog "/var/log/httpd/error_log"</pre>
1488
1489
1490     <p>If the <var>file-path</var>
1491     begins with a pipe character "<code>|</code>" then it is assumed to be a
1492     command to spawn to handle the error log.</p>
1493
1494     <pre class="prettyprint lang-config">ErrorLog "|/usr/local/bin/httpd_errors"</pre>
1495
1496
1497     <p>See the notes on <a href="../logs.html#piped">piped logs</a> for
1498     more information.</p>
1499
1500     <p>Using <code>syslog</code> instead of a filename enables logging
1501     via syslogd(8) if the system supports it and if <code class="module"><a href="../mod/mod_syslog.html">mod_syslog</a></code>
1502     is loaded. The default is to use syslog facility <code>local7</code>,
1503     but you can override this by using the <code>syslog:<var>facility</var></code>
1504     syntax where <var>facility</var> can be one of the names usually documented in
1505     syslog(1).  The facility is effectively global, and if it is changed
1506     in individual virtual hosts, the final facility specified affects the
1507     entire server. Same rules apply for the syslog tag, which by default
1508     uses the Apache binary name, <code>httpd</code> in most cases. You can
1509     also override this by using the <code>syslog::<var>tag</var></code>
1510     syntax.</p>
1511
1512     <pre class="prettyprint lang-config">ErrorLog syslog:user
1513 ErrorLog syslog:user:httpd.srv1
1514 ErrorLog syslog::httpd.srv2</pre>
1515
1516
1517     <p>Additional modules can provide their own ErrorLog providers. The syntax
1518     is similar to the <code>syslog</code> example above.</p>
1519
1520     <p>SECURITY: See the <a href="../misc/security_tips.html#serverroot">security tips</a>
1521     document for details on why your security could be compromised
1522     if the directory where log files are stored is writable by
1523     anyone other than the user that starts the server.</p>
1524     <div class="warning"><h3>Note</h3>
1525       <p>When entering a file path on non-Unix platforms, care should be taken
1526       to make sure that only forward slashes are used even though the platform
1527       may allow the use of back slashes. In general it is a good idea to always
1528       use forward slashes throughout the configuration files.</p>
1529     </div>
1530
1531 <h3>See also</h3>
1532 <ul>
1533 <li><code class="directive"><a href="#loglevel">LogLevel</a></code></li>
1534 <li><a href="../logs.html">Apache HTTP Server Log Files</a></li>
1535 </ul>
1536 </div>
1537 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1538 <div class="directive-section"><h2><a name="ErrorLogFormat" id="ErrorLogFormat">ErrorLogFormat</a> <a name="errorlogformat" id="errorlogformat">Directive</a></h2>
1539 <table class="directive">
1540 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Format specification for error log entries</td></tr>
1541 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code> ErrorLogFormat [connection|request] <var>format</var></code></td></tr>
1542 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1543 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
1544 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
1545 </table>
1546     <p><code class="directive">ErrorLogFormat</code> allows to specify what
1547     supplementary information is logged in the error log in addition to the
1548     actual log message.</p>
1549
1550     <pre class="prettyprint lang-config">#Simple example
1551 ErrorLogFormat "[%t] [%l] [pid %P] %F: %E: [client %a] %M"</pre>
1552
1553
1554     <p>Specifying <code>connection</code> or <code>request</code> as first
1555     parameter allows to specify additional formats, causing additional
1556     information to be logged when the first message is logged for a specific
1557     connection or request, respectively. This additional information is only
1558     logged once per connection/request. If a connection or request is processed
1559     without causing any log message, the additional information is not logged
1560     either.</p>
1561
1562     <p>It can happen that some format string items do not produce output.  For
1563     example, the Referer header is only present if the log message is
1564     associated to a request and the log message happens at a time when the
1565     Referer header has already been read from the client.  If no output is
1566     produced, the default behavior is to delete everything from the preceding
1567     space character to the next space character.  This means the log line is
1568     implicitly divided into fields on non-whitespace to whitespace transitions.
1569     If a format string item does not produce output, the whole field is
1570     omitted.  For example, if the remote address <code>%a</code> in the log
1571     format <code>[%t] [%l] [%a] %M&nbsp;</code> is not available, the surrounding
1572     brackets are not logged either.  Space characters can be escaped with a
1573     backslash to prevent them from delimiting a field.  The combination '%&nbsp;'
1574     (percent space) is a zero-width field delimiter that does not produce any
1575     output.</p>
1576
1577     <p>The above behavior can be changed by adding modifiers to the format
1578     string item. A <code>-</code> (minus) modifier causes a minus to be logged if the
1579     respective item does not produce any output. In once-per-connection/request
1580     formats, it is also possible to use the <code>+</code> (plus) modifier. If an
1581     item with the plus modifier does not produce any output, the whole line is
1582     omitted.</p>
1583
1584     <p>A number as modifier can be used to assign a log severity level to a
1585     format item. The item will only be logged if the severity of the log
1586     message is not higher than the specified log severity level. The number can
1587     range from 1 (alert) over 4 (warn) and 7 (debug) to 15 (trace8).</p>
1588
1589     <p>For example, here's what would happen if you added modifiers to
1590     the <code>%{Referer}i</code> token, which logs the
1591     <code>Referer</code> request header.</p>
1592
1593     <table class="bordered"><tr class="header"><th>Modified Token</th><th>Meaning</th></tr>
1594 <tr>
1595     <td><code>%-{Referer}i</code></td>
1596     <td>Logs a <code>-</code> if <code>Referer</code> is not set.</td>
1597     </tr>
1598 <tr class="odd">
1599     <td><code>%+{Referer}i</code></td>
1600     <td>Omits the entire line if <code>Referer</code> is not set.</td>
1601     </tr>
1602 <tr>
1603     <td><code>%4{Referer}i</code></td>
1604     <td>Logs the <code>Referer</code> only if the log message severity
1605     is higher than 4.</td>
1606     </tr>
1607 </table>
1608
1609     <p>Some format string items accept additional parameters in braces.</p>
1610
1611     <table class="bordered"><tr class="header"><th>Format&nbsp;String</th> <th>Description</th></tr>
1612 <tr><td><code>%%</code></td>
1613         <td>The percent sign</td></tr>
1614 <tr class="odd"><td><code>%a</code></td>
1615         <td>Client IP address and port of the request</td></tr>
1616 <tr><td><code>%{c}a</code></td>
1617         <td>Underlying peer IP address and port of the connection (see the
1618             <code class="module"><a href="../mod/mod_remoteip.html">mod_remoteip</a></code> module)</td></tr>
1619 <tr class="odd"><td><code>%A</code></td>
1620         <td>Local IP-address and port</td></tr>
1621 <tr><td><code>%{<em>name</em>}e</code></td>
1622         <td>Request environment variable <em>name</em></td></tr>
1623 <tr class="odd"><td><code>%E</code></td>
1624         <td>APR/OS error status code and string</td></tr>
1625 <tr><td><code>%F</code></td>
1626         <td>Source file name and line number of the log call</td></tr>
1627 <tr class="odd"><td><code>%{<em>name</em>}i</code></td>
1628         <td>Request header <em>name</em></td></tr>
1629 <tr><td><code>%k</code></td>
1630         <td>Number of keep-alive requests on this connection</td></tr>
1631 <tr class="odd"><td><code>%l</code></td>
1632         <td>Loglevel of the message</td></tr>
1633 <tr><td><code>%L</code></td>
1634         <td>Log ID of the request</td></tr>
1635 <tr class="odd"><td><code>%{c}L</code></td>
1636         <td>Log ID of the connection</td></tr>
1637 <tr><td><code>%{C}L</code></td>
1638         <td>Log ID of the connection if used in connection scope, empty otherwise</td></tr>
1639 <tr class="odd"><td><code>%m</code></td>
1640         <td>Name of the module logging the message</td></tr>
1641 <tr><td><code>%M</code></td>
1642         <td>The actual log message</td></tr>
1643 <tr class="odd"><td><code>%{<em>name</em>}n</code></td>
1644         <td>Request note <em>name</em></td></tr>
1645 <tr><td><code>%P</code></td>
1646         <td>Process ID of current process</td></tr>
1647 <tr class="odd"><td><code>%T</code></td>
1648         <td>Thread ID of current thread</td></tr>
1649 <tr><td><code>%{g}T</code></td>
1650         <td>System unique thread ID of current thread (the same ID as
1651             displayed by e.g. <code>top</code>; currently Linux only)</td></tr>
1652 <tr class="odd"><td><code>%t</code></td>
1653         <td>The current time</td></tr>
1654 <tr><td><code>%{u}t</code></td>
1655         <td>The current time including micro-seconds</td></tr>
1656 <tr class="odd"><td><code>%{cu}t</code></td>
1657         <td>The current time in compact ISO 8601 format, including
1658             micro-seconds</td></tr>
1659 <tr><td><code>%v</code></td>
1660         <td>The canonical <code class="directive"><a href="#servername">ServerName</a></code>
1661             of the current server.</td></tr>
1662 <tr class="odd"><td><code>%V</code></td>
1663         <td>The server name of the server serving the request according to the
1664             <code class="directive"><a href="#usecanonicalname">UseCanonicalName</a></code>
1665             setting.</td></tr>
1666 <tr><td><code>\&nbsp;</code> (backslash space)</td>
1667         <td>Non-field delimiting space</td></tr>
1668 <tr class="odd"><td><code>%&nbsp;</code> (percent space)</td>
1669         <td>Field delimiter (no output)</td></tr>
1670 </table>
1671
1672     <p>The log ID format <code>%L</code> produces a unique id for a connection
1673     or request. This can be used to correlate which log lines belong to the
1674     same connection or request, which request happens on which connection.
1675     A <code>%L</code> format string is also available in
1676     <code class="module"><a href="../mod/mod_log_config.html">mod_log_config</a></code> to allow to correlate access log entries
1677     with error log lines. If <code class="module"><a href="../mod/mod_unique_id.html">mod_unique_id</a></code> is loaded, its
1678     unique id will be used as log ID for requests.</p>
1679
1680     <pre class="prettyprint lang-config">#Example (default format for threaded MPMs)
1681 ErrorLogFormat "[%{u}t] [%-m:%l] [pid %P:tid %T] %7F: %E: [client\ %a] %M% ,\ referer\ %{Referer}i"</pre>
1682
1683
1684     <p>This would result in error messages such as:</p>
1685
1686     <div class="example"><p><code>
1687     [Thu May 12 08:28:57.652118 2011] [core:error] [pid 8777:tid 4326490112] [client ::1:58619] File does not exist: /usr/local/apache2/htdocs/favicon.ico
1688     </code></p></div>
1689
1690     <p>Notice that, as discussed above, some fields are omitted
1691     entirely because they are not defined.</p>
1692
1693     <pre class="prettyprint lang-config">#Example (similar to the 2.2.x format)
1694 ErrorLogFormat "[%t] [%l] %7F: %E: [client\ %a] %M% ,\ referer\ %{Referer}i"</pre>
1695
1696
1697     <pre class="prettyprint lang-config">#Advanced example with request/connection log IDs
1698 ErrorLogFormat "[%{uc}t] [%-m:%-l] [R:%L] [C:%{C}L] %7F: %E: %M"
1699 ErrorLogFormat request "[%{uc}t] [R:%L] Request %k on C:%{c}L pid:%P tid:%T"
1700 ErrorLogFormat request "[%{uc}t] [R:%L] UA:'%+{User-Agent}i'"
1701 ErrorLogFormat request "[%{uc}t] [R:%L] Referer:'%+{Referer}i'"
1702 ErrorLogFormat connection "[%{uc}t] [C:%{c}L] local\ %a remote\ %A"</pre>
1703
1704
1705
1706 <h3>See also</h3>
1707 <ul>
1708 <li><code class="directive"><a href="#errorlog">ErrorLog</a></code></li>
1709 <li><code class="directive"><a href="#loglevel">LogLevel</a></code></li>
1710 <li><a href="../logs.html">Apache HTTP Server Log Files</a></li>
1711 </ul>
1712 </div>
1713 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1714 <div class="directive-section"><h2><a name="ExtendedStatus" id="ExtendedStatus">ExtendedStatus</a> <a name="extendedstatus" id="extendedstatus">Directive</a></h2>
1715 <table class="directive">
1716 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Keep track of extended status information for each
1717 request</td></tr>
1718 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ExtendedStatus On|Off</code></td></tr>
1719 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ExtendedStatus Off[*]</code></td></tr>
1720 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
1721 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
1722 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
1723 </table>
1724     <p>This option tracks additional data per worker about the
1725     currently executing request and creates a utilization summary.
1726     You can see these variables during runtime by configuring
1727     <code class="module"><a href="../mod/mod_status.html">mod_status</a></code>.  Note that other modules may
1728     rely on this scoreboard.</p>
1729
1730     <p>This setting applies to the entire server and cannot be
1731     enabled or disabled on a virtualhost-by-virtualhost basis.
1732     The collection of extended status information can slow down
1733     the server.  Also note that this setting cannot be changed
1734     during a graceful restart.</p>
1735
1736     <div class="note">
1737     <p>Note that loading <code class="module"><a href="../mod/mod_status.html">mod_status</a></code> will change
1738     the default behavior to ExtendedStatus On, while other
1739     third party modules may do the same.  Such modules rely on
1740     collecting detailed information about the state of all workers.
1741     The default is changed by <code class="module"><a href="../mod/mod_status.html">mod_status</a></code> beginning
1742     with version 2.3.6. The previous default was always Off.</p>
1743     </div>
1744
1745
1746 </div>
1747 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1748 <div class="directive-section"><h2><a name="FileETag" id="FileETag">FileETag</a> <a name="fileetag" id="fileetag">Directive</a></h2>
1749 <table class="directive">
1750 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File attributes used to create the ETag
1751 HTTP response header for static files</td></tr>
1752 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>FileETag <var>component</var> ...</code></td></tr>
1753 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>FileETag MTime Size</code></td></tr>
1754 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1755 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
1756 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
1757 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
1758 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>The default used to be "INode&nbsp;MTime&nbsp;Size" in 2.3.14 and
1759 earlier.</td></tr>
1760 </table>
1761     <p>
1762     The <code class="directive">FileETag</code> directive configures the file
1763     attributes that are used to create the <code>ETag</code> (entity
1764     tag) response header field when the document is based on a static file.
1765     (The <code>ETag</code> value is used in cache management to save
1766     network bandwidth.) The
1767     <code class="directive">FileETag</code> directive allows you to choose
1768     which of these -- if any -- should be used. The recognized keywords are:
1769     </p>
1770
1771     <dl>
1772      <dt><strong>INode</strong></dt>
1773      <dd>The file's i-node number will be included in the calculation</dd>
1774      <dt><strong>MTime</strong></dt>
1775      <dd>The date and time the file was last modified will be included</dd>
1776      <dt><strong>Size</strong></dt>
1777      <dd>The number of bytes in the file will be included</dd>
1778      <dt><strong>All</strong></dt>
1779      <dd>All available fields will be used. This is equivalent to:
1780          <pre class="prettyprint lang-config">FileETag INode MTime Size</pre>
1781 </dd>
1782      <dt><strong>None</strong></dt>
1783      <dd>If a document is file-based, no <code>ETag</code> field will be
1784        included in the response</dd>
1785     </dl>
1786
1787     <p>The <code>INode</code>, <code>MTime</code>, and <code>Size</code>
1788     keywords may be prefixed with either <code>+</code> or <code>-</code>,
1789     which allow changes to be made to the default setting inherited
1790     from a broader scope. Any keyword appearing without such a prefix
1791     immediately and completely cancels the inherited setting.</p>
1792
1793     <p>If a directory's configuration includes
1794     <code>FileETag&nbsp;INode&nbsp;MTime&nbsp;Size</code>, and a
1795     subdirectory's includes <code>FileETag&nbsp;-INode</code>,
1796     the setting for that subdirectory (which will be inherited by
1797     any sub-subdirectories that don't override it) will be equivalent to
1798     <code>FileETag&nbsp;MTime&nbsp;Size</code>.</p>
1799     <div class="warning"><h3>Warning</h3>
1800     Do not change the default for directories or locations that have WebDAV
1801     enabled and use <code class="module"><a href="../mod/mod_dav_fs.html">mod_dav_fs</a></code> as a storage provider.
1802     <code class="module"><a href="../mod/mod_dav_fs.html">mod_dav_fs</a></code> uses <code>MTime&nbsp;Size</code>
1803     as a fixed format for <code>ETag</code> comparisons on conditional requests.
1804     These conditional requests will break if the <code>ETag</code> format is
1805     changed via <code class="directive">FileETag</code>.
1806     </div>
1807     <div class="note"><h3>Server Side Includes</h3>
1808     An ETag is not generated for responses parsed by <code class="module"><a href="../mod/mod_include.html">mod_include</a></code>
1809     since the response entity can change without a change of the INode, MTime, or Size
1810     of the static file with embedded SSI directives.
1811     </div>
1812
1813
1814 </div>
1815 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1816 <div class="directive-section"><h2><a name="Files" id="Files">&lt;Files&gt;</a> <a name="files" id="files">Directive</a></h2>
1817 <table class="directive">
1818 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Contains directives that apply to matched
1819 filenames</td></tr>
1820 <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>
1821 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1822 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1823 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
1824 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
1825 </table>
1826     <p>The <code class="directive">&lt;Files&gt;</code> directive
1827     limits the scope of the enclosed directives by filename. It is comparable
1828     to the <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code>
1829     and <code class="directive"><a href="#location">&lt;Location&gt;</a></code>
1830     directives. It should be matched with a <code>&lt;/Files&gt;</code>
1831     directive. The directives given within this section will be applied to
1832     any object with a basename (last component of filename) matching the
1833     specified filename. <code class="directive">&lt;Files&gt;</code>
1834     sections are processed in the order they appear in the
1835     configuration file, after the <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code> sections and
1836     <code>.htaccess</code> files are read, but before <code class="directive"><a href="#location">&lt;Location&gt;</a></code> sections. Note
1837     that <code class="directive">&lt;Files&gt;</code> can be nested
1838     inside <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code> sections to restrict the
1839     portion of the filesystem they apply to.</p>
1840
1841     <p>The <var>filename</var> argument should include a filename, or
1842     a wild-card string, where <code>?</code> matches any single character,
1843     and <code>*</code> matches any sequences of characters.</p>
1844     <pre class="prettyprint lang-config">&lt;Files "cat.html"&gt;
1845     # Insert stuff that applies to cat.html here
1846 &lt;/Files&gt;
1847
1848 &lt;Files "?at.*"&gt;
1849     # This would apply to cat.html, bat.html, hat.php and so on.
1850 &lt;/Files&gt;</pre>
1851
1852     <p><a class="glossarylink" href="../glossary.html#regex" title="see glossary">Regular expressions</a>
1853     can also be used, with the addition of the
1854     <code>~</code> character. For example:</p>
1855
1856     <pre class="prettyprint lang-config">&lt;Files ~ "\.(gif|jpe?g|png)$"&gt;
1857     #...
1858 &lt;/Files&gt;</pre>
1859
1860
1861     <p>would match most common Internet graphics formats. <code class="directive"><a href="#filesmatch">&lt;FilesMatch&gt;</a></code> is preferred,
1862     however.</p>
1863
1864     <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
1865     <code>.htaccess</code> files. This allows users to control access to
1866     their own files, at a file-by-file level.</p>
1867
1868
1869 <h3>See also</h3>
1870 <ul>
1871 <li><a href="../sections.html">How &lt;Directory&gt;, &lt;Location&gt;
1872     and &lt;Files&gt; sections work</a> for an explanation of how these
1873     different sections are combined when a request is received</li>
1874 </ul>
1875 </div>
1876 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1877 <div class="directive-section"><h2><a name="FilesMatch" id="FilesMatch">&lt;FilesMatch&gt;</a> <a name="filesmatch" id="filesmatch">Directive</a></h2>
1878 <table class="directive">
1879 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Contains directives that apply to regular-expression matched
1880 filenames</td></tr>
1881 <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>
1882 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1883 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1884 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
1885 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
1886 </table>
1887     <p>The <code class="directive">&lt;FilesMatch&gt;</code> directive
1888     limits the scope of the enclosed directives by filename, just as the
1889     <code class="directive"><a href="#files">&lt;Files&gt;</a></code> directive
1890     does. However, it accepts a <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular
1891     expression</a>. For example:</p>
1892
1893     <pre class="prettyprint lang-config">&lt;FilesMatch ".+\.(gif|jpe?g|png)$"&gt;
1894     # ...
1895 &lt;/FilesMatch&gt;</pre>
1896
1897
1898     <p>would match most common Internet graphics formats.</p>
1899
1900     <div class="note">The <code>.+</code> at the start of the regex ensures that
1901     files named <code>.png</code>, or <code>.gif</code>, for example,
1902     are not matched.</div>
1903
1904     <p>From 2.4.8 onwards, named groups and backreferences are captured and
1905     written to the environment with the corresponding name prefixed with
1906     "MATCH_" and in upper case. This allows elements of files to be referenced
1907     from within <a href="../expr.html">expressions</a> and modules like
1908     <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>. In order to prevent confusion, numbered
1909     (unnamed) backreferences are ignored. Use named groups instead.</p>
1910
1911     <pre class="prettyprint lang-config">&lt;FilesMatch "^(?&lt;sitename&gt;[^/]+)"&gt;
1912     require ldap-group cn=%{env:MATCH_SITENAME},ou=combined,o=Example
1913 &lt;/FilesMatch&gt;</pre>
1914
1915
1916 <h3>See also</h3>
1917 <ul>
1918 <li><a href="../sections.html">How &lt;Directory&gt;, &lt;Location&gt;
1919     and &lt;Files&gt; sections work</a> for an explanation of how these
1920     different sections are combined when a request is received</li>
1921 </ul>
1922 </div>
1923 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1924 <div class="directive-section"><h2><a name="ForceType" id="ForceType">ForceType</a> <a name="forcetype" id="forcetype">Directive</a></h2>
1925 <table class="directive">
1926 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Forces all matching files to be served with the specified
1927 media type in the HTTP Content-Type header field</td></tr>
1928 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ForceType <var>media-type</var>|None</code></td></tr>
1929 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
1930 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
1931 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
1932 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
1933 </table>
1934     <p>When placed into an <code>.htaccess</code> file or a
1935     <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code>, or
1936     <code class="directive"><a href="#location">&lt;Location&gt;</a></code> or
1937     <code class="directive"><a href="#files">&lt;Files&gt;</a></code>
1938     section, this directive forces all matching files to be served
1939     with the content type identification given by
1940     <var>media-type</var>. For example, if you had a directory full of
1941     GIF files, but did not want to label them all with <code>.gif</code>,
1942     you might want to use:</p>
1943
1944     <pre class="prettyprint lang-config">ForceType image/gif</pre>
1945
1946
1947     <p>Note that this directive overrides other indirect media type
1948     associations defined in mime.types or via the
1949     <code class="directive"><a href="../mod/mod_mime.html#addtype">AddType</a></code>.</p>
1950
1951     <p>You can also override more general
1952     <code class="directive">ForceType</code> settings
1953     by using the value of <code>None</code>:</p>
1954
1955     <pre class="prettyprint lang-config"># force all files to be image/gif:
1956 &lt;Location "/images"&gt;
1957   ForceType image/gif
1958 &lt;/Location&gt;
1959
1960 # but normal mime-type associations here:
1961 &lt;Location "/images/mixed"&gt;
1962   ForceType None
1963 &lt;/Location&gt;</pre>
1964
1965
1966     <p>This directive primarily overrides the content types generated for
1967     static files served out of the filesystem.  For resources other than
1968     static files, where the generator of the response typically specifies
1969     a Content-Type, this directive has no effect.</p>
1970
1971
1972     <div class="note"><h3>Note</h3>
1973     <p>If no handler is explicitly set for a request, the specified content
1974     type will also be used as the handler name. </p>
1975
1976     <p>When explicit directives such as
1977     <code class="directive"><a href="#sethandler">SetHandler</a></code> or
1978     <code class="directive"><a href="../mod/mod_mime.html#addhandler">AddHandler</a></code> do not apply
1979     to the current request, the internal handler name normally set by those
1980     directives is instead set to the content type specified by this directive.
1981     </p>
1982     <p>
1983     This is a historical behavior that some third-party modules
1984     (such as mod_php) may look for a "synthetic" content type used only to
1985     signal the module to take responsibility for the matching request.
1986     </p>
1987
1988     <p>Configurations that rely on such "synthetic" types should be avoided.
1989     Additionally, configurations that restrict access to
1990     <code class="directive"><a href="#sethandler">SetHandler</a></code> or
1991     <code class="directive"><a href="../mod/mod_mime.html#addhandler">AddHandler</a></code> should
1992     restrict access to this directive as well.</p>
1993     </div>
1994
1995
1996 </div>
1997 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1998 <div class="directive-section"><h2><a name="GprofDir" id="GprofDir">GprofDir</a> <a name="gprofdir" id="gprofdir">Directive</a></h2>
1999 <table class="directive">
2000 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Directory to write gmon.out profiling data to.  </td></tr>
2001 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>GprofDir <var>/tmp/gprof/</var>|<var>/tmp/gprof/</var>%</code></td></tr>
2002 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2003 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2004 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2005 </table>
2006     <p>When the server has been compiled with gprof profiling support,
2007     <code class="directive">GprofDir</code> causes <code>gmon.out</code> files to
2008     be written to the specified directory when the process exits.  If the
2009     argument ends with a percent symbol ('%'), subdirectories are created
2010     for each process id.</p>
2011
2012     <p>This directive currently only works with the <code class="module"><a href="../mod/prefork.html">prefork</a></code>
2013     MPM.</p>
2014
2015 </div>
2016 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2017 <div class="directive-section"><h2><a name="HostnameLookups" id="HostnameLookups">HostnameLookups</a> <a name="hostnamelookups" id="hostnamelookups">Directive</a></h2>
2018 <table class="directive">
2019 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables DNS lookups on client IP addresses</td></tr>
2020 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>HostnameLookups On|Off|Double</code></td></tr>
2021 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>HostnameLookups Off</code></td></tr>
2022 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
2023 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2024 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2025 </table>
2026     <p>This directive enables DNS lookups so that host names can be
2027     logged (and passed to CGIs/SSIs in <code>REMOTE_HOST</code>).
2028     The value <code>Double</code> refers to doing double-reverse
2029     DNS lookup. That is, after a reverse lookup is performed, a forward
2030     lookup is then performed on that result. At least one of the IP
2031     addresses in the forward lookup must match the original
2032     address. (In "tcpwrappers" terminology this is called
2033     <code>PARANOID</code>.)</p>
2034
2035     <p>Regardless of the setting, when <code class="module"><a href="../mod/mod_authz_host.html">mod_authz_host</a></code> is
2036     used for controlling access by hostname, a double reverse lookup
2037     will be performed.  This is necessary for security. Note that the
2038     result of this double-reverse isn't generally available unless you
2039     set <code>HostnameLookups Double</code>. For example, if only
2040     <code>HostnameLookups On</code> and a request is made to an object
2041     that is protected by hostname restrictions, regardless of whether
2042     the double-reverse fails or not, CGIs will still be passed the
2043     single-reverse result in <code>REMOTE_HOST</code>.</p>
2044
2045     <p>The default is <code>Off</code> in order to save the network
2046     traffic for those sites that don't truly need the reverse
2047     lookups done. It is also better for the end users because they
2048     don't have to suffer the extra latency that a lookup entails.
2049     Heavily loaded sites should leave this directive
2050     <code>Off</code>, since DNS lookups can take considerable
2051     amounts of time. The utility <code class="program"><a href="../programs/logresolve.html">logresolve</a></code>, compiled by
2052     default to the <code>bin</code> subdirectory of your installation
2053     directory, can be used to look up host names from logged IP addresses
2054     offline.</p>
2055
2056     <p>Finally, if you have <a href="mod_authz_host.html#reqhost">hostname-based Require
2057     directives</a>, a hostname lookup will be performed regardless of
2058     the setting of <code>HostnameLookups</code>.</p>
2059
2060 </div>
2061 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2062 <div class="directive-section"><h2><a name="HttpProtocolOptions" id="HttpProtocolOptions">HttpProtocolOptions</a> <a name="httpprotocoloptions" id="httpprotocoloptions">Directive</a></h2>
2063 <table class="directive">
2064 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Modify restrictions on HTTP Request Messages</td></tr>
2065 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>HttpProtocolOptions [Strict|Unsafe] [RegisteredMethods|LenientMethods]
2066  [Allow0.9|Require1.0]</code></td></tr>
2067 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>HttpProtocolOptions Strict LenientMethods Allow0.9</code></td></tr>
2068 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2069 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2070 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2071 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>2.2.32 or 2.4.24 and later</td></tr>
2072 </table>
2073     <p>This directive changes the rules applied to the HTTP Request Line
2074     (<a href="https://tools.ietf.org/html/rfc7230#section-3.1.1">RFC 7230 §3.1.1</a>) and the HTTP Request Header Fields
2075     (<a href="https://tools.ietf.org/html/rfc7230#section-3.2">RFC 7230 §3.2</a>), which are now applied by default or using
2076     the <code>Strict</code> option. Due to legacy modules, applications or
2077     custom user-agents which must be deprecated the <code>Unsafe</code>
2078     option has been added to revert to the legacy behaviors.</p>
2079
2080     <p>These rules are applied prior to request processing,
2081     so must be configured at the global or default (first) matching
2082     virtual host section, by IP/port interface (and not by name)
2083     to be honored.</p>
2084
2085     <p>The directive accepts three parameters from the following list
2086        of choices, applying the default to the ones not specified:</p>
2087
2088     <dl>
2089     <dt>Strict|Unsafe</dt>
2090     <dd>
2091       <p>Prior to the introduction of this directive, the Apache HTTP Server
2092       request message parsers were tolerant of a number of forms of input
2093       which did not conform to the protocol.
2094       <a href="https://tools.ietf.org/html/rfc7230#section-9.4">RFC 7230 §9.4 Request Splitting</a> and
2095       <a href="https://tools.ietf.org/html/rfc7230#section-9.5">§9.5 Response Smuggling</a> call out only two of the potential
2096       risks of accepting non-conformant request messages, while
2097       <a href="https://tools.ietf.org/html/rfc7230#section-3.5">RFC 7230 §3.5</a> "Message Parsing Robustness" identify the
2098       risks of accepting obscure whitespace and request message formatting.
2099       As of the introduction of this directive, all grammar rules of the
2100       specification are enforced in the default <code>Strict</code> operating
2101       mode, and the strict whitespace suggested by section 3.5 is enforced
2102       and cannot be relaxed.</p>
2103
2104       <div class="warning"><h3>Security risks of Unsafe</h3>
2105         <p>Users are strongly cautioned against toggling the <code>Unsafe</code>
2106         mode of operation, particularly on outward-facing, publicly accessible
2107         server deployments.  If an interface is required for faulty monitoring
2108         or other custom service consumers running on an intranet, users should
2109         toggle the Unsafe option only on a specific virtual host configured
2110         to service their internal private network.</p>
2111       </div>
2112
2113       <div class="example"><h3>Example of a request leading to HTTP 400 with Strict mode</h3><p><code>
2114
2115         # Missing CRLF<br />
2116         GET / HTTP/1.0\n\n
2117       </code></p></div>
2118       <div class="warning"><h3>Command line tools and CRLF</h3>
2119         <p>Some tools need to be forced to use CRLF, otherwise httpd will return
2120         a HTTP 400 response like described in the above use case. For example,
2121         the <strong>OpenSSL s_client needs the -crlf parameter to work
2122         properly</strong>.</p>
2123         <p>The <code class="directive"><a href="../mod/mod_dumpio.html#dumpioinput">DumpIOInput</a></code> directive
2124         can help while reviewing the HTTP request to identify issues like the
2125         absence of CRLF.</p>
2126       </div>
2127     </dd>
2128     <dt>RegisteredMethods|LenientMethods</dt>
2129     <dd>
2130       <p><a href="https://tools.ietf.org/html/rfc7231#section-4.1">RFC 7231 §4.1</a> "Request Methods" "Overview" requires that
2131       origin servers shall respond with a HTTP 501 status code when an
2132       unsupported method is encountered in the request line.
2133       This already happens when the <code>LenientMethods</code> option is used,
2134       but administrators may wish to toggle the <code>RegisteredMethods</code>
2135       option and register any non-standard methods using the
2136       <code class="directive"><a href="#registerhttpmethod">RegisterHttpMethod</a></code>
2137       directive, particularly if the <code>Unsafe</code>
2138       option has been toggled.</p>
2139
2140       <div class="warning"><h3>Forward Proxy compatibility</h3>
2141         <p>The <code>RegisteredMethods</code> option should <strong>not</strong>
2142         be toggled for forward proxy hosts, as the methods supported by the
2143         origin servers are unknown to the proxy server.</p>
2144       </div>
2145
2146       <div class="example"><h3>Example of a request leading to HTTP 501 with LenientMethods mode</h3><p><code>
2147
2148         # Unknown HTTP method<br />
2149         WOW / HTTP/1.0\r\n\r\n<br /><br />
2150         # Lowercase HTTP method<br />
2151         get / HTTP/1.0\r\n\r\n<br />
2152       </code></p></div>
2153       </dd>
2154       <dt>Allow0.9|Require1.0</dt>
2155       <dd>
2156       <p><a href="https://tools.ietf.org/html/rfc2616#section-19.6">RFC 2616 §19.6</a> "Compatibility With Previous Versions" had
2157       encouraged HTTP servers to support legacy HTTP/0.9 requests. RFC 7230
2158       supersedes this with "The expectation to support HTTP/0.9 requests has
2159       been removed" and offers additional comments in
2160       <a href="https://tools.ietf.org/html/rfc7230#appendix-A">RFC 7230 Appendix A</a>. The <code>Require1.0</code> option allows
2161       the user to remove support of the default <code>Allow0.9</code> option's
2162       behavior.</p>
2163
2164       <div class="example"><h3>Example of a request leading to HTTP 400 with Require1.0 mode</h3><p><code>
2165
2166         # Unsupported HTTP version<br />
2167         GET /\r\n\r\n
2168       </code></p></div>
2169     </dd>
2170     </dl>
2171     <p>Reviewing the messages logged to the
2172     <code class="directive"><a href="#errorlog">ErrorLog</a></code>, configured with
2173     <code class="directive"><a href="#loglevel">LogLevel</a></code> <code>debug</code> level,
2174     can help identify such faulty requests along with their origin.
2175     Users should pay particular attention to the 400 responses in the access
2176     log for invalid requests which were unexpectedly rejected.</p>
2177
2178 </div>
2179 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2180 <div class="directive-section"><h2><a name="If" id="If">&lt;If&gt;</a> <a name="if" id="if">Directive</a></h2>
2181 <table class="directive">
2182 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Contains directives that apply only if a condition is
2183 satisfied by a request at runtime</td></tr>
2184 <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>
2185 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
2186 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
2187 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2188 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2189 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Nested conditions are evaluated in 2.4.26 and later</td></tr>
2190 </table>
2191     <p>The <code class="directive">&lt;If&gt;</code> directive
2192     evaluates an expression at runtime, and applies the enclosed
2193     directives if and only if the expression evaluates to true.
2194     For example:</p>
2195
2196     <pre class="prettyprint lang-config">&lt;If "-z req('Host')"&gt;</pre>
2197
2198
2199     <p>would match HTTP/1.0 requests without a <var>Host:</var> header.
2200     Expressions may contain various shell-like operators for string
2201     comparison (<code>==</code>, <code>!=</code>, <code>&lt;</code>, ...),
2202     integer comparison (<code>-eq</code>, <code>-ne</code>, ...),
2203     and others (<code>-n</code>, <code>-z</code>, <code>-f</code>, ...).
2204     It is also possible to use regular expressions, </p>
2205
2206     <pre class="prettyprint lang-config">&lt;If "%{QUERY_STRING} =~ /(delete|commit)=.*?elem/"&gt;</pre>
2207
2208
2209     <p>shell-like pattern matches and many other operations. These operations
2210     can be done on request headers (<code>req</code>), environment variables
2211     (<code>env</code>), and a large number of other properties. The full
2212     documentation is available in <a href="../expr.html">Expressions in
2213     Apache HTTP Server</a>.</p>
2214
2215     <p>Only directives that support the <a href="directive-dict.html#Context">directory context</a> can be used within this configuration section.</p>
2216
2217     <div class="warning">
2218     Certain variables, such as <code>CONTENT_TYPE</code> and other
2219     response headers, are set after &lt;If&gt; conditions have already
2220     been evaluated, and so will not be available to use in this
2221     directive.
2222     </div>
2223
2224
2225 <h3>See also</h3>
2226 <ul>
2227 <li><a href="../expr.html">Expressions in Apache HTTP Server</a>,
2228 for a complete reference and more examples.</li>
2229 <li><code class="directive"><a href="#elseif">&lt;ElseIf&gt;</a></code></li>
2230 <li><code class="directive"><a href="#else">&lt;Else&gt;</a></code></li>
2231 <li><a href="../sections.html">How &lt;Directory&gt;, &lt;Location&gt;,
2232     &lt;Files&gt; sections work</a> for an explanation of how these
2233     different sections are combined when a request is received.
2234     <code class="directive">&lt;If&gt;</code>,
2235     <code class="directive">&lt;ElseIf&gt;</code>, and
2236     <code class="directive">&lt;Else&gt;</code> are applied last.</li>
2237 </ul>
2238 </div>
2239 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2240 <div class="directive-section"><h2><a name="IfDefine" id="IfDefine">&lt;IfDefine&gt;</a> <a name="ifdefine" id="ifdefine">Directive</a></h2>
2241 <table class="directive">
2242 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Encloses directives that will be processed only
2243 if a test is true at startup</td></tr>
2244 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;IfDefine [!]<var>parameter-name</var>&gt; ...
2245     &lt;/IfDefine&gt;</code></td></tr>
2246 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
2247 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
2248 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2249 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2250 </table>
2251     <p>The <code>&lt;IfDefine <var>test</var>&gt;...&lt;/IfDefine&gt;
2252     </code> section is used to mark directives that are conditional. The
2253     directives within an <code class="directive">&lt;IfDefine&gt;</code>
2254     section are only processed if the <var>test</var> is true. If <var>
2255     test</var> is false, everything between the start and end markers is
2256     ignored.</p>
2257
2258     <p>The <var>test</var> in the <code class="directive">&lt;IfDefine&gt;</code> section directive can be one of two forms:</p>
2259
2260     <ul>
2261       <li><var>parameter-name</var></li>
2262
2263       <li><code>!</code><var>parameter-name</var></li>
2264     </ul>
2265
2266     <p>In the former case, the directives between the start and end
2267     markers are only processed if the parameter named
2268     <var>parameter-name</var> is defined. The second format reverses
2269     the test, and only processes the directives if
2270     <var>parameter-name</var> is <strong>not</strong> defined.</p>
2271
2272     <p>The <var>parameter-name</var> argument is a define as given on the
2273     <code class="program"><a href="../programs/httpd.html">httpd</a></code> command line via <code>-D<var>parameter</var>
2274     </code> at the time the server was started or by the <code class="directive"><a href="#define">Define</a></code> directive.</p>
2275
2276     <p><code class="directive">&lt;IfDefine&gt;</code> sections are
2277     nest-able, which can be used to implement simple
2278     multiple-parameter tests. Example:</p>
2279
2280     <div class="example"><p><code>httpd -DReverseProxy -DUseCache -DMemCache ...</code></p></div>
2281     <pre class="prettyprint lang-config">&lt;IfDefine ReverseProxy&gt;
2282   LoadModule proxy_module   modules/mod_proxy.so
2283   LoadModule proxy_http_module   modules/mod_proxy_http.so
2284   &lt;IfDefine UseCache&gt;
2285     LoadModule cache_module   modules/mod_cache.so
2286     &lt;IfDefine MemCache&gt;
2287       LoadModule mem_cache_module   modules/mod_mem_cache.so
2288     &lt;/IfDefine&gt;
2289     &lt;IfDefine !MemCache&gt;
2290       LoadModule cache_disk_module   modules/mod_cache_disk.so
2291     &lt;/IfDefine&gt;
2292   &lt;/IfDefine&gt;
2293 &lt;/IfDefine&gt;</pre>
2294
2295
2296 </div>
2297 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2298 <div class="directive-section"><h2><a name="IfDirective" id="IfDirective">&lt;IfDirective&gt;</a> <a name="ifdirective" id="ifdirective">Directive</a></h2>
2299 <table class="directive">
2300 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Encloses directives that are processed conditional on the
2301 presence or absence of a specific directive</td></tr>
2302 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;IfDirective [!]<var>directive-name</var>&gt; ...
2303     &lt;/IfDirective&gt;</code></td></tr>
2304 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
2305 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
2306 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2307 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2308 </table>
2309     <p>The <code>&lt;IfDirective <var>test</var>&gt;...&lt;/IfDirective&gt;</code>
2310     section is used to mark directives that are conditional on the presence of
2311     a specific directive. The directives within an <code class="directive">&lt;IfDirective&gt;</code> section are only processed if the <var>test</var>
2312     is true. If <var>test</var> is false, everything between the start and
2313     end markers is ignored.</p>
2314
2315     <p>The <var>test</var> in the <code class="directive">&lt;IfDirective&gt;</code> section can be one of two forms:</p>
2316
2317     <ul>
2318       <li><var>directive-name</var></li>
2319
2320       <li>!<var>directive-name</var></li>
2321     </ul>
2322
2323     <p>In the former case, the directives between the start and end
2324     markers are only processed if a directive of the given name is
2325     available at the time of processing.  The second format reverses the test,
2326     and only processes the directives if <var>directive-name</var> is
2327     <strong>not</strong> available.</p>
2328
2329     <div class="note">This section should only be used if you need to have one
2330     configuration file that works across multiple versions of
2331     <code class="program"><a href="../programs/httpd.html">httpd</a></code>, regardless of whether a particular
2332     directive is available. In normal operation, directives need not
2333     be placed in <code class="directive">&lt;IfDirective&gt;</code>
2334     sections.</div>
2335
2336 <h3>See also</h3>
2337 <ul>
2338 <li><code class="directive"><a href="#ifsection">&lt;IfSection&gt;</a></code></li>
2339 </ul>
2340 </div>
2341 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2342 <div class="directive-section"><h2><a name="IfFile" id="IfFile">&lt;IfFile&gt;</a> <a name="iffile" id="iffile">Directive</a></h2>
2343 <table class="directive">
2344 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Encloses directives that will be processed only
2345 if file exists at startup</td></tr>
2346 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;IfFile [!]<var>parameter-name</var>&gt; ...
2347     &lt;/IfFile&gt;</code></td></tr>
2348 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
2349 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
2350 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2351 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2352 </table>
2353     <p>The <code>&lt;IfFile <var>filename</var>&gt;...&lt;/IfFile&gt;
2354     </code> section is used to mark directives that are conditional on
2355     the existence of a file on disk. The directives within an
2356     <code class="directive">&lt;IfFile&gt;</code> section are only
2357     processed if the <var>filename</var> exists. If <var> filename</var>
2358     doesn't exist, everything between the start and end markers is
2359     ignored. <var>filename</var> can be an absolute path or a path
2360     relative to the server root.</p>
2361
2362     <p>The <var>filename</var> in the <code class="directive">&lt;IfFile
2363     &gt;</code> section directive can take the same forms as the
2364     <var>test</var> variable in the <code class="directive">&lt;IfDefine
2365     &gt;</code> section, i.e. the test can be negated if the <code>
2366     !</code> character is placed directly before <var>filename</var>.
2367     </p>
2368
2369     <p>If a relative <var>filename</var> is supplied, the check is
2370     <code class="directive">ServerRoot</code> relative.  In the  case where
2371     this directive occurs before the <code class="directive">ServerRoot</code>,
2372     the path will be checked relative to the compiled-in server root or
2373     the server root passed in on the command line via the <code>-d</code>
2374     parameter.</p>
2375
2376
2377 </div>
2378 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2379 <div class="directive-section"><h2><a name="IfModule" id="IfModule">&lt;IfModule&gt;</a> <a name="ifmodule" id="ifmodule">Directive</a></h2>
2380 <table class="directive">
2381 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Encloses directives that are processed conditional on the
2382 presence or absence of a specific module</td></tr>
2383 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;IfModule [!]<var>module-file</var>|<var>module-identifier</var>&gt; ...
2384     &lt;/IfModule&gt;</code></td></tr>
2385 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
2386 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
2387 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2388 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2389 </table>
2390     <p>The <code>&lt;IfModule <var>test</var>&gt;...&lt;/IfModule&gt;</code>
2391     section is used to mark directives that are conditional on the presence of
2392     a specific module. The directives within an <code class="directive">&lt;IfModule&gt;</code> section are only processed if the <var>test</var>
2393     is true. If <var>test</var> is false, everything between the start and
2394     end markers is ignored.</p>
2395
2396     <p>The <var>test</var> in the <code class="directive">&lt;IfModule&gt;</code> section directive can be one of two forms:</p>
2397
2398     <ul>
2399       <li><var>module</var></li>
2400
2401       <li>!<var>module</var></li>
2402     </ul>
2403
2404     <p>In the former case, the directives between the start and end
2405     markers are only processed if the module named <var>module</var>
2406     is included in Apache httpd -- either compiled in or
2407     dynamically loaded using <code class="directive"><a href="../mod/mod_so.html#loadmodule">LoadModule</a></code>. The second format reverses the test,
2408     and only processes the directives if <var>module</var> is
2409     <strong>not</strong> included.</p>
2410
2411     <p>The <var>module</var> argument can be either the module identifier or
2412     the file name of the module, at the time it was compiled.  For example,
2413     <code>rewrite_module</code> is the identifier and
2414     <code>mod_rewrite.c</code> is the file name. If a module consists of
2415     several source files, use the name of the file containing the string
2416     <code>STANDARD20_MODULE_STUFF</code>.</p>
2417
2418     <p><code class="directive">&lt;IfModule&gt;</code> sections are
2419     nest-able, which can be used to implement simple multiple-module
2420     tests.</p>
2421
2422     <div class="note">This section should only be used if you need to have one
2423     configuration file that works whether or not a specific module
2424     is available. In normal operation, directives need not be
2425     placed in <code class="directive">&lt;IfModule&gt;</code>
2426     sections.</div>
2427
2428 </div>
2429 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2430 <div class="directive-section"><h2><a name="IfSection" id="IfSection">&lt;IfSection&gt;</a> <a name="ifsection" id="ifsection">Directive</a></h2>
2431 <table class="directive">
2432 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Encloses directives that are processed conditional on the
2433 presence or absence of a specific section directive</td></tr>
2434 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;IfSection [!]<var>section-name</var>&gt; ...
2435     &lt;/IfSection&gt;</code></td></tr>
2436 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
2437 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
2438 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2439 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2440 </table>
2441     <p>The <code>&lt;IfSection
2442     <var>test</var>&gt;...&lt;/IfSection&gt;</code> section is used
2443     to mark directives that are conditional on the presence of a
2444     specific section directive.  A section directive is any directive
2445     such as <code class="directive">&lt;VirtualHost&gt;</code> which
2446     encloses other directives, and has a directive name with a leading
2447     "&lt;".</p>
2448
2449     <p>The directives within an <code class="directive">&lt;IfSection&gt;</code> section are only processed if the <var>test</var>
2450     is true. If <var>test</var> is false, everything between the start and
2451     end markers is ignored.</p>
2452
2453     <p>The <var>section-name</var> must be specified without either
2454     the leading "&lt;" or closing "&gt;".  The <var>test</var> in the
2455     <code class="directive">&lt;IfSection&gt;</code> section can be one
2456     of two forms:</p>
2457
2458     <ul>
2459       <li><var>section-name</var></li>
2460       <li>!<var>section-name</var></li>
2461     </ul>
2462
2463     <p>In the former case, the directives between the start and end
2464     markers are only processed if a section directive of the given
2465     name is available at the time of processing.  The second format
2466     reverses the test, and only processes the directives if
2467     <var>section-name</var> is <strong>not</strong> an available
2468     section directive.</p>
2469
2470     <p>For example:</p>
2471
2472     <pre class="prettyprint lang-config">&lt;IfSection VirtualHost&gt;
2473    ...
2474 &lt;/IfSection&gt;</pre>
2475
2476
2477     <div class="note">This section should only be used if you need to have one
2478     configuration file that works across multiple versions of <code class="program"><a href="../programs/httpd.html">httpd</a></code>,
2479     regardless of whether a particular section directive is
2480     available. In normal operation, directives need not be placed in
2481     <code class="directive">&lt;IfSection&gt;</code> sections.</div>
2482
2483 <h3>See also</h3>
2484 <ul>
2485 <li><code class="directive"><a href="#ifdirective">&lt;IfDirective&gt;</a></code></li>
2486 </ul>
2487 </div>
2488 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2489 <div class="directive-section"><h2><a name="Include" id="Include">Include</a> <a name="include" id="include">Directive</a></h2>
2490 <table class="directive">
2491 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Includes other configuration files from within
2492 the server configuration files</td></tr>
2493 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Include <var>file-path</var>|<var>directory-path</var>|<var>wildcard</var></code></td></tr>
2494 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
2495 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2496 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2497 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Directory
2498 wildcard matching available in 2.3.6 and later</td></tr>
2499 </table>
2500     <p>This directive allows inclusion of other configuration files
2501     from within the server configuration files.</p>
2502
2503     <p>Shell-style (<code>fnmatch()</code>) wildcard characters can be used
2504     in the filename or directory parts of the path to include several files
2505     at once, in alphabetical order. In addition, if
2506     <code class="directive">Include</code> points to a directory, rather than a file,
2507     Apache httpd will read all files in that directory and any subdirectory.
2508     However, including entire directories is not recommended, because it is
2509     easy to accidentally leave temporary files in a directory that can cause
2510     <code class="program"><a href="../programs/httpd.html">httpd</a></code> to fail. Instead, we encourage you to use the
2511     wildcard syntax shown below, to include files that match a particular
2512     pattern, such as *.conf, for example.</p>
2513
2514     <p>The <code class="directive"><a href="#include">Include</a></code> directive will
2515     <strong>fail with an error</strong> if a wildcard expression does not
2516     match any file. The <code class="directive"><a href="#includeoptional">IncludeOptional</a></code>
2517     directive can be used if non-matching wildcards should be ignored.</p>
2518
2519     <p>The file path specified may be an absolute path, or may be relative
2520     to the <code class="directive"><a href="#serverroot">ServerRoot</a></code> directory.</p>
2521
2522     <p>Examples:</p>
2523
2524     <pre class="prettyprint lang-config">Include /usr/local/apache2/conf/ssl.conf
2525 Include /usr/local/apache2/conf/vhosts/*.conf</pre>
2526
2527
2528     <p>Or, providing paths relative to your <code class="directive"><a href="#serverroot">ServerRoot</a></code> directory:</p>
2529
2530     <pre class="prettyprint lang-config">Include conf/ssl.conf
2531 Include conf/vhosts/*.conf</pre>
2532
2533
2534     <p>Wildcards may be included in the directory or file portion of the
2535     path. This example will fail if there is no subdirectory in conf/vhosts
2536     that contains at least one *.conf file:</p>
2537
2538     <pre class="prettyprint lang-config">Include conf/vhosts/*/*.conf</pre>
2539
2540
2541     <p>Alternatively, the following command will just be ignored in case of
2542     missing files or directories:</p>
2543
2544     <pre class="prettyprint lang-config">IncludeOptional conf/vhosts/*/*.conf</pre>
2545
2546
2547
2548 <h3>See also</h3>
2549 <ul>
2550 <li><code class="directive"><a href="#includeoptional">IncludeOptional</a></code></li>
2551 <li><code class="program"><a href="../programs/apachectl.html">apachectl</a></code></li>
2552 </ul>
2553 </div>
2554 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2555 <div class="directive-section"><h2><a name="IncludeOptional" id="IncludeOptional">IncludeOptional</a> <a name="includeoptional" id="includeoptional">Directive</a></h2>
2556 <table class="directive">
2557 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Includes other configuration files from within
2558 the server configuration files</td></tr>
2559 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>IncludeOptional <var>file-path</var>|<var>directory-path</var>|<var>wildcard</var></code></td></tr>
2560 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
2561 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2562 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2563 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in 2.3.6 and later. Not existent file paths without wildcards
2564                do not cause SyntaxError after 2.4.30</td></tr>
2565 </table>
2566     <p>This directive allows inclusion of other configuration files
2567     from within the server configuration files. It works identically to the
2568     <code class="directive"><a href="#include">Include</a></code> directive, but it will be
2569     silently ignored (instead of causing an error) if wildcards are used and
2570     they do not match any file or directory or if a file path does not exist
2571     on the file system.</p>
2572
2573 <h3>See also</h3>
2574 <ul>
2575 <li><code class="directive"><a href="#include">Include</a></code></li>
2576 <li><code class="program"><a href="../programs/apachectl.html">apachectl</a></code></li>
2577 </ul>
2578 </div>
2579 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2580 <div class="directive-section"><h2><a name="KeepAlive" id="KeepAlive">KeepAlive</a> <a name="keepalive" id="keepalive">Directive</a></h2>
2581 <table class="directive">
2582 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables HTTP persistent connections</td></tr>
2583 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>KeepAlive On|Off</code></td></tr>
2584 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>KeepAlive On</code></td></tr>
2585 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2586 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2587 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2588 </table>
2589     <p>The Keep-Alive extension to HTTP/1.0 and the persistent
2590     connection feature of HTTP/1.1 provide long-lived HTTP sessions
2591     which allow multiple requests to be sent over the same TCP
2592     connection. In some cases this has been shown to result in an
2593     almost 50% speedup in latency times for HTML documents with
2594     many images. To enable Keep-Alive connections, set
2595     <code>KeepAlive On</code>.</p>
2596
2597     <p>For HTTP/1.0 clients, Keep-Alive connections will only be
2598     used if they are specifically requested by a client. In
2599     addition, a Keep-Alive connection with an HTTP/1.0 client can
2600     only be used when the length of the content is known in
2601     advance. This implies that dynamic content such as CGI output,
2602     SSI pages, and server-generated directory listings will
2603     generally not use Keep-Alive connections to HTTP/1.0 clients.
2604     For HTTP/1.1 clients, persistent connections are the default
2605     unless otherwise specified. If the client requests it, chunked
2606     encoding will be used in order to send content of unknown
2607     length over persistent connections.</p>
2608
2609     <p>When a client uses a Keep-Alive connection, it will be counted
2610     as a single "request" for the <code class="directive"><a href="../mod/mpm_common.html#maxconnectionsperchild">MaxConnectionsPerChild</a></code> directive, regardless
2611     of how many requests are sent using the connection.</p>
2612
2613 <h3>See also</h3>
2614 <ul>
2615 <li><code class="directive"><a href="#maxkeepaliverequests">MaxKeepAliveRequests</a></code></li>
2616 </ul>
2617 </div>
2618 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2619 <div class="directive-section"><h2><a name="KeepAliveTimeout" id="KeepAliveTimeout">KeepAliveTimeout</a> <a name="keepalivetimeout" id="keepalivetimeout">Directive</a></h2>
2620 <table class="directive">
2621 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Amount of time the server will wait for subsequent
2622 requests on a persistent connection</td></tr>
2623 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>KeepAliveTimeout <var>time-interval</var>[s]</code></td></tr>
2624 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>KeepAliveTimeout 5</code></td></tr>
2625 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2626 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2627 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2628 </table>
2629     <p>The number of seconds Apache httpd will wait for a subsequent
2630     request before closing the connection. By adding a postfix of ms the
2631     timeout can be also set in milliseconds. Once a request has been
2632     received, the timeout value specified by the
2633     <code class="directive"><a href="#timeout">Timeout</a></code> directive applies.</p>
2634
2635     <p>Setting <code class="directive">KeepAliveTimeout</code> to a high value
2636     may cause performance problems in heavily loaded servers. The
2637     higher the timeout, the more server processes will be kept
2638     occupied waiting on connections with idle clients.</p>
2639
2640     <p>If <code class="directive">KeepAliveTimeout</code> is <strong>not</strong>
2641     set for a name-based virtual host, the value of the first defined
2642     virtual host best matching the local IP and port will be used.</p>
2643
2644 </div>
2645 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2646 <div class="directive-section"><h2><a name="Limit" id="Limit">&lt;Limit&gt;</a> <a name="limit" id="limit">Directive</a></h2>
2647 <table class="directive">
2648 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Restrict enclosed access controls to only certain HTTP
2649 methods</td></tr>
2650 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;Limit <var>method</var> [<var>method</var>] ... &gt; ...
2651     &lt;/Limit&gt;</code></td></tr>
2652 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
2653 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig, Limit</td></tr>
2654 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2655 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2656 </table>
2657     <p>Access controls are normally effective for
2658     <strong>all</strong> access methods, and this is the usual
2659     desired behavior. <strong>In the general case, access control
2660     directives should not be placed within a
2661     <code class="directive">&lt;Limit&gt;</code> section.</strong></p>
2662
2663     <p>The purpose of the <code class="directive">&lt;Limit&gt;</code>
2664     directive is to restrict the effect of the access controls to the
2665     nominated HTTP methods. For all other methods, the access
2666     restrictions that are enclosed in the <code class="directive">&lt;Limit&gt;</code> bracket <strong>will have no
2667     effect</strong>. The following example applies the access control
2668     only to the methods <code>POST</code>, <code>PUT</code>, and
2669     <code>DELETE</code>, leaving all other methods unprotected:</p>
2670
2671     <pre class="prettyprint lang-config">&lt;Limit POST PUT DELETE&gt;
2672   Require valid-user
2673 &lt;/Limit&gt;</pre>
2674
2675
2676     <p>The method names listed can be one or more of: <code>GET</code>,
2677     <code>POST</code>, <code>PUT</code>, <code>DELETE</code>,
2678     <code>CONNECT</code>, <code>OPTIONS</code>,
2679     <code>PATCH</code>, <code>PROPFIND</code>, <code>PROPPATCH</code>,
2680     <code>MKCOL</code>, <code>COPY</code>, <code>MOVE</code>,
2681     <code>LOCK</code>, and <code>UNLOCK</code>. <strong>The method name is
2682     case-sensitive.</strong> If <code>GET</code> is used, it will also
2683     restrict <code>HEAD</code> requests. The <code>TRACE</code> method
2684     cannot be limited (see <code class="directive"><a href="#traceenable">TraceEnable</a></code>).</p>
2685
2686     <div class="warning">A <code class="directive"><a href="#limitexcept">&lt;LimitExcept&gt;</a></code> section should always be
2687     used in preference to a <code class="directive">&lt;Limit&gt;</code>
2688     section when restricting access, since a <code class="directive"><a href="#limitexcept">&lt;LimitExcept&gt;</a></code> section provides protection
2689     against arbitrary methods.</div>
2690
2691     <p>The <code class="directive">&lt;Limit&gt;</code> and
2692     <code class="directive"><a href="#limitexcept">&lt;LimitExcept&gt;</a></code>
2693     directives may be nested.  In this case, each successive level of
2694     <code class="directive">&lt;Limit&gt;</code> or <code class="directive"><a href="#limitexcept">&lt;LimitExcept&gt;</a></code> directives must
2695     further restrict the set of methods to which access controls apply.</p>
2696
2697     <div class="warning">When using
2698     <code class="directive">&lt;Limit&gt;</code> or
2699     <code class="directive">&lt;LimitExcept&gt;</code> directives with
2700     the <code class="directive"><a href="../mod/mod_authz_core.html#require">Require</a></code> directive,
2701     note that the first <code class="directive"><a href="../mod/mod_authz_core.html#require">Require</a></code>
2702     to succeed authorizes the request, regardless of the presence of other
2703     <code class="directive"><a href="../mod/mod_authz_core.html#require">Require</a></code> directives.</div>
2704
2705     <p>For example, given the following configuration, all users will
2706     be authorized for <code>POST</code> requests, and the
2707     <code>Require group editors</code> directive will be ignored
2708     in all cases:</p>
2709
2710     <pre class="prettyprint lang-config">&lt;LimitExcept GET&gt;
2711   Require valid-user
2712 &lt;/LimitExcept&gt;
2713 &lt;Limit POST&gt;
2714   Require group editors
2715 &lt;/Limit&gt;</pre>
2716
2717
2718 </div>
2719 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2720 <div class="directive-section"><h2><a name="LimitExcept" id="LimitExcept">&lt;LimitExcept&gt;</a> <a name="limitexcept" id="limitexcept">Directive</a></h2>
2721 <table class="directive">
2722 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Restrict access controls to all HTTP methods
2723 except the named ones</td></tr>
2724 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;LimitExcept <var>method</var> [<var>method</var>] ... &gt; ...
2725     &lt;/LimitExcept&gt;</code></td></tr>
2726 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
2727 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig, Limit</td></tr>
2728 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2729 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2730 </table>
2731     <p><code class="directive">&lt;LimitExcept&gt;</code> and
2732     <code>&lt;/LimitExcept&gt;</code> are used to enclose
2733     a group of access control directives which will then apply to any
2734     HTTP access method <strong>not</strong> listed in the arguments;
2735     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
2736     both standard and nonstandard/unrecognized methods. See the
2737     documentation for <code class="directive"><a href="#limit">&lt;Limit&gt;</a></code> for more details.</p>
2738
2739     <p>For example:</p>
2740
2741     <pre class="prettyprint lang-config">&lt;LimitExcept POST GET&gt;
2742   Require valid-user
2743 &lt;/LimitExcept&gt;</pre>
2744
2745
2746
2747 </div>
2748 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2749 <div class="directive-section"><h2><a name="LimitInternalRecursion" id="LimitInternalRecursion">LimitInternalRecursion</a> <a name="limitinternalrecursion" id="limitinternalrecursion">Directive</a></h2>
2750 <table class="directive">
2751 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Determine maximum number of internal redirects and nested
2752 subrequests</td></tr>
2753 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LimitInternalRecursion <var>number</var> [<var>number</var>]</code></td></tr>
2754 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LimitInternalRecursion 10</code></td></tr>
2755 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2756 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2757 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2758 </table>
2759     <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
2760     redirects the original request to a CGI script. A subrequest is Apache httpd's
2761     mechanism to find out what would happen for some URI if it were requested.
2762     For example, <code class="module"><a href="../mod/mod_dir.html">mod_dir</a></code> uses subrequests to look for the
2763     files listed in the <code class="directive"><a href="../mod/mod_dir.html#directoryindex">DirectoryIndex</a></code>
2764     directive.</p>
2765
2766     <p><code class="directive">LimitInternalRecursion</code> prevents the server
2767     from crashing when entering an infinite loop of internal redirects or
2768     subrequests. Such loops are usually caused by misconfigurations.</p>
2769
2770     <p>The directive stores two different limits, which are evaluated on
2771     per-request basis. The first <var>number</var> is the maximum number of
2772     internal redirects that may follow each other. The second <var>number</var>
2773     determines how deeply subrequests may be nested. If you specify only one
2774     <var>number</var>, it will be assigned to both limits.</p>
2775
2776     <pre class="prettyprint lang-config">LimitInternalRecursion 5</pre>
2777
2778
2779 </div>
2780 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2781 <div class="directive-section"><h2><a name="LimitRequestBody" id="LimitRequestBody">LimitRequestBody</a> <a name="limitrequestbody" id="limitrequestbody">Directive</a></h2>
2782 <table class="directive">
2783 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Restricts the total size of the HTTP request body sent
2784 from the client</td></tr>
2785 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LimitRequestBody <var>bytes</var></code></td></tr>
2786 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LimitRequestBody 0</code></td></tr>
2787 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
2788 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
2789 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2790 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2791 </table>
2792     <p>This directive specifies the number of <var>bytes</var> from 0
2793     (meaning unlimited) to 2147483647 (2GB) that are allowed in a
2794     request body. See the note below for the limited applicability
2795     to proxy requests.</p>
2796
2797     <p>The <code class="directive">LimitRequestBody</code> directive allows
2798     the user to set a limit on the allowed size of an HTTP request
2799     message body within the context in which the directive is given
2800     (server, per-directory, per-file or per-location). If the client
2801     request exceeds that limit, the server will return an error
2802     response instead of servicing the request. The size of a normal
2803     request message body will vary greatly depending on the nature of
2804     the resource and the methods allowed on that resource. CGI scripts
2805     typically use the message body for retrieving form information.
2806     Implementations of the <code>PUT</code> method will require
2807     a value at least as large as any representation that the server
2808     wishes to accept for that resource.</p>
2809
2810     <p>This directive gives the server administrator greater
2811     control over abnormal client request behavior, which may be
2812     useful for avoiding some forms of denial-of-service
2813     attacks.</p>
2814
2815     <p>If, for example, you are permitting file upload to a particular
2816     location and wish to limit the size of the uploaded file to 100K,
2817     you might use the following directive:</p>
2818
2819     <pre class="prettyprint lang-config">LimitRequestBody 102400</pre>
2820
2821
2822     <div class="note"><p>For a full description of how this directive is interpreted by
2823     proxy requests, see the <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> documentation.</p>
2824     </div>
2825
2826
2827 </div>
2828 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2829 <div class="directive-section"><h2><a name="LimitRequestFields" id="LimitRequestFields">LimitRequestFields</a> <a name="limitrequestfields" id="limitrequestfields">Directive</a></h2>
2830 <table class="directive">
2831 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limits the number of HTTP request header fields that
2832 will be accepted from the client</td></tr>
2833 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LimitRequestFields <var>number</var></code></td></tr>
2834 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LimitRequestFields 100</code></td></tr>
2835 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2836 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2837 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2838 </table>
2839     <p><var>Number</var> is an integer from 0 (meaning unlimited) to
2840     32767. The default value is defined by the compile-time
2841     constant <code>DEFAULT_LIMIT_REQUEST_FIELDS</code> (100 as
2842     distributed).</p>
2843
2844     <p>The <code class="directive">LimitRequestFields</code> directive allows
2845     the server administrator to modify the limit on the number of
2846     request header fields allowed in an HTTP request. A server needs
2847     this value to be larger than the number of fields that a normal
2848     client request might include. The number of request header fields
2849     used by a client rarely exceeds 20, but this may vary among
2850     different client implementations, often depending upon the extent
2851     to which a user has configured their browser to support detailed
2852     content negotiation. Optional HTTP extensions are often expressed
2853     using request header fields.</p>
2854
2855     <p>This directive gives the server administrator greater
2856     control over abnormal client request behavior, which may be
2857     useful for avoiding some forms of denial-of-service attacks.
2858     The value should be increased if normal clients see an error
2859     response from the server that indicates too many fields were
2860     sent in the request.</p>
2861
2862     <p>For example:</p>
2863
2864     <pre class="prettyprint lang-config">LimitRequestFields 50</pre>
2865
2866
2867      <div class="warning"><h3>Warning</h3>
2868      <p> When name-based virtual hosting is used, the value for this
2869      directive is taken from the default (first-listed) virtual host for the
2870      local IP and port combination.</p>
2871      </div>
2872
2873
2874 </div>
2875 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2876 <div class="directive-section"><h2><a name="LimitRequestFieldSize" id="LimitRequestFieldSize">LimitRequestFieldSize</a> <a name="limitrequestfieldsize" id="limitrequestfieldsize">Directive</a></h2>
2877 <table class="directive">
2878 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limits the size of the HTTP request header allowed from the
2879 client</td></tr>
2880 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LimitRequestFieldSize <var>bytes</var></code></td></tr>
2881 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LimitRequestFieldSize 8190</code></td></tr>
2882 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2883 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2884 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2885 </table>
2886     <p>This directive specifies the number of <var>bytes</var>
2887     that will be allowed in an HTTP request header.</p>
2888
2889     <p>The <code class="directive">LimitRequestFieldSize</code> directive
2890     allows the server administrator to set the limit
2891     on the allowed size of an HTTP request header field. A server
2892     needs this value to be large enough to hold any one header field
2893     from a normal client request. The size of a normal request header
2894     field will vary greatly among different client implementations,
2895     often depending upon the extent to which a user has configured
2896     their browser to support detailed content negotiation. SPNEGO
2897     authentication headers can be up to 12392 bytes.</p>
2898
2899     <p>This directive gives the server administrator greater
2900     control over abnormal client request behavior, which may be
2901     useful for avoiding some forms of denial-of-service attacks.</p>
2902
2903     <p>For example:</p>
2904
2905     <pre class="prettyprint lang-config">LimitRequestFieldSize 4094</pre>
2906
2907
2908     <div class="note">Under normal conditions, the value should not be changed from
2909     the default.</div>
2910
2911     <div class="warning"><h3>Warning</h3>
2912     <p> When name-based virtual hosting is used, the value for this
2913     directive is taken from the default (first-listed) virtual host best
2914     matching the current IP address and port combination.</p>
2915     </div>
2916
2917 </div>
2918 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2919 <div class="directive-section"><h2><a name="LimitRequestLine" id="LimitRequestLine">LimitRequestLine</a> <a name="limitrequestline" id="limitrequestline">Directive</a></h2>
2920 <table class="directive">
2921 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limit the size of the HTTP request line that will be accepted
2922 from the client</td></tr>
2923 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LimitRequestLine <var>bytes</var></code></td></tr>
2924 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LimitRequestLine 8190</code></td></tr>
2925 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2926 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2927 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2928 </table>
2929     <p>This directive sets the number of <var>bytes</var> that will be
2930     allowed on the HTTP request-line.</p>
2931
2932     <p>The <code class="directive">LimitRequestLine</code> directive allows
2933     the server administrator to set the limit on the allowed size
2934     of a client's HTTP request-line. Since the request-line consists of the
2935     HTTP method, URI, and protocol version, the
2936     <code class="directive">LimitRequestLine</code> directive places a
2937     restriction on the length of a request-URI allowed for a request
2938     on the server. A server needs this value to be large enough to
2939     hold any of its resource names, including any information that
2940     might be passed in the query part of a <code>GET</code> request.</p>
2941
2942     <p>This directive gives the server administrator greater
2943     control over abnormal client request behavior, which may be
2944     useful for avoiding some forms of denial-of-service attacks.</p>
2945
2946     <p>For example:</p>
2947
2948     <pre class="prettyprint lang-config">LimitRequestLine 4094</pre>
2949
2950
2951     <div class="note">Under normal conditions, the value should not be changed from
2952     the default.</div>
2953
2954     <div class="warning"><h3>Warning</h3>
2955     <p> When name-based virtual hosting is used, the value for this
2956     directive is taken from the default (first-listed) virtual host best
2957     matching the current IP address and port combination.</p>
2958     </div>
2959
2960
2961 </div>
2962 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2963 <div class="directive-section"><h2><a name="LimitXMLRequestBody" id="LimitXMLRequestBody">LimitXMLRequestBody</a> <a name="limitxmlrequestbody" id="limitxmlrequestbody">Directive</a></h2>
2964 <table class="directive">
2965 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limits the size of an XML-based request body</td></tr>
2966 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LimitXMLRequestBody <var>bytes</var></code></td></tr>
2967 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LimitXMLRequestBody 1000000</code></td></tr>
2968 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
2969 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
2970 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2971 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2972 </table>
2973     <p>Limit (in bytes) on maximum size of an XML-based request
2974     body. A value of <code>0</code> will disable any checking.</p>
2975
2976     <p>Example:</p>
2977
2978     <pre class="prettyprint lang-config">LimitXMLRequestBody 0</pre>
2979
2980
2981
2982 </div>
2983 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2984 <div class="directive-section"><h2><a name="Location" id="Location">&lt;Location&gt;</a> <a name="location" id="location">Directive</a></h2>
2985 <table class="directive">
2986 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Applies the enclosed directives only to matching
2987 URLs</td></tr>
2988 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;Location
2989     <var>URL-path</var>|<var>URL</var>&gt; ... &lt;/Location&gt;</code></td></tr>
2990 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2991 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2992 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2993 </table>
2994     <p>The <code class="directive">&lt;Location&gt;</code> directive
2995     limits the scope of the enclosed directives by URL. It is similar to the
2996     <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code>
2997     directive, and starts a subsection which is terminated with a
2998     <code>&lt;/Location&gt;</code> directive. <code class="directive">&lt;Location&gt;</code> sections are processed in the
2999     order they appear in the configuration file, after the <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code> sections and
3000     <code>.htaccess</code> files are read, and after the <code class="directive"><a href="#files">&lt;Files&gt;</a></code> sections.</p>
3001
3002     <p><code class="directive">&lt;Location&gt;</code> sections operate
3003     completely outside the filesystem.  This has several consequences.
3004     Most importantly, <code class="directive">&lt;Location&gt;</code>
3005     directives should not be used to control access to filesystem
3006     locations.  Since several different URLs may map to the same
3007     filesystem location, such access controls may by circumvented.</p>
3008
3009     <p>The enclosed directives will be applied to the request if the path component
3010     of the URL meets <em>any</em> of the following criteria:
3011     </p>
3012     <ul>
3013       <li>The specified location matches exactly the path component of the URL.
3014       </li>
3015       <li>The specified location, which ends in a forward slash, is a prefix
3016       of the path component of the URL (treated as a context root).
3017       </li>
3018       <li>The specified location, with the addition of a trailing slash, is a
3019       prefix of the path component of the URL (also treated as a context root).
3020       </li>
3021     </ul>
3022     <p>
3023     In the example below, where no trailing slash is used, requests to
3024     /private1, /private1/ and /private1/file.txt will have the enclosed
3025     directives applied, but /private1other would not.
3026     </p>
3027     <pre class="prettyprint lang-config">&lt;Location "/private1"&gt;
3028     #  ...
3029 &lt;/Location&gt;</pre>
3030
3031     <p>
3032     In the example below, where a trailing slash is used, requests to
3033     /private2/ and /private2/file.txt will have the enclosed
3034     directives applied, but /private2 and /private2other would not.
3035     </p>
3036     <pre class="prettyprint lang-config">&lt;Location "/private2<em>/</em>"&gt;
3037     # ...
3038 &lt;/Location&gt;</pre>
3039
3040
3041     <div class="note"><h3>When to use <code class="directive">&lt;Location&gt;</code></h3>
3042
3043     <p>Use <code class="directive">&lt;Location&gt;</code> to apply
3044     directives to content that lives outside the filesystem.  For
3045     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
3046     <code>&lt;Location "/"&gt;</code>, which is an easy way to
3047     apply a configuration to the entire server.</p>
3048     </div>
3049
3050     <p>For all origin (non-proxy) requests, the URL to be matched is a
3051     URL-path of the form <code>/path/</code>.  <em>No scheme, hostname,
3052     port, or query string may be included.</em>  For proxy requests, the
3053     URL to be matched is of the form
3054     <code>scheme://servername/path</code>, and you must include the
3055     prefix.</p>
3056
3057     <p>The URL may use wildcards. In a wild-card string, <code>?</code> matches
3058     any single character, and <code>*</code> matches any sequences of
3059     characters. Neither wildcard character matches a / in the URL-path.</p>
3060
3061     <p><a class="glossarylink" href="../glossary.html#regex" title="see glossary">Regular expressions</a>
3062     can also be used, with the addition of the <code>~</code>
3063     character. For example:</p>
3064
3065     <pre class="prettyprint lang-config">&lt;Location ~ "/(extra|special)/data"&gt;
3066     #...
3067 &lt;/Location&gt;</pre>
3068
3069
3070     <p>would match URLs that contained the substring <code>/extra/data</code>
3071     or <code>/special/data</code>. The directive <code class="directive"><a href="#locationmatch">&lt;LocationMatch&gt;</a></code> behaves
3072     identical to the regex version of <code class="directive">&lt;Location&gt;</code>, and is preferred, for the
3073     simple reason that <code>~</code> is hard to distinguish from
3074     <code>-</code> in many fonts.</p>
3075
3076     <p>The <code class="directive">&lt;Location&gt;</code>
3077     functionality is especially useful when combined with the
3078     <code class="directive"><a href="#sethandler">SetHandler</a></code>
3079     directive. For example, to enable status requests but allow them
3080     only from browsers at <code>example.com</code>, you might use:</p>
3081
3082     <pre class="prettyprint lang-config">&lt;Location "/status"&gt;
3083   SetHandler server-status
3084   Require host example.com
3085 &lt;/Location&gt;</pre>
3086
3087
3088     <div class="note"><h3>Note about / (slash)</h3>
3089       <p>The slash character has special meaning depending on where in a
3090       URL it appears. People may be used to its behavior in the filesystem
3091       where multiple adjacent slashes are frequently collapsed to a single
3092       slash (<em>i.e.</em>, <code>/home///foo</code> is the same as
3093       <code>/home/foo</code>). In URL-space this is not necessarily true.
3094       The <code class="directive"><a href="#locationmatch">&lt;LocationMatch&gt;</a></code>
3095       directive and the regex version of <code class="directive">&lt;Location&gt;</code> require you to explicitly specify multiple
3096       slashes if that is your intention.</p>
3097
3098       <p>For example, <code>&lt;LocationMatch "^/abc"&gt;</code> would match
3099       the request URL <code>/abc</code> but not the request URL <code>
3100       //abc</code>. The (non-regex) <code class="directive">&lt;Location&gt;</code> directive behaves similarly when used for
3101       proxy requests. But when (non-regex) <code class="directive">&lt;Location&gt;</code> is used for non-proxy requests it will
3102       implicitly match multiple slashes with a single slash. For example,
3103       if you specify <code>&lt;Location "/abc/def"&gt;</code> and the
3104       request is to <code>/abc//def</code> then it will match.</p>
3105     </div>
3106
3107 <h3>See also</h3>
3108 <ul>
3109 <li><a href="../sections.html">How &lt;Directory&gt;, &lt;Location&gt;
3110     and &lt;Files&gt; sections work</a> for an explanation of how these
3111     different sections are combined when a request is received.</li>
3112 <li><code class="directive"><a href="#locationmatch">LocationMatch</a></code></li>
3113 </ul>
3114 </div>
3115 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
3116 <div class="directive-section"><h2><a name="LocationMatch" id="LocationMatch">&lt;LocationMatch&gt;</a> <a name="locationmatch" id="locationmatch">Directive</a></h2>
3117 <table class="directive">
3118 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Applies the enclosed directives only to regular-expression
3119 matching URLs</td></tr>
3120 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;LocationMatch
3121     <var>regex</var>&gt; ... &lt;/LocationMatch&gt;</code></td></tr>
3122 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
3123 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
3124 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
3125 </table>
3126     <p>The <code class="directive">&lt;LocationMatch&gt;</code> directive
3127     limits the scope of the enclosed directives by URL, in an identical manner
3128     to <code class="directive"><a href="#location">&lt;Location&gt;</a></code>. However,
3129     it takes a <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular expression</a>
3130     as an argument instead of a simple string. For example:</p>
3131
3132     <pre class="prettyprint lang-config">&lt;LocationMatch "/(extra|special)/data"&gt;
3133     # ...
3134 &lt;/LocationMatch&gt;</pre>
3135
3136
3137     <p>would match URLs that contained the substring <code>/extra/data</code>
3138     or <code>/special/data</code>.</p>
3139
3140     <div class="note"><p>If the intent is that a URL <strong>starts with</strong>
3141     <code>/extra/data</code>, rather than merely
3142     <strong>contains</strong> <code>/extra/data</code>, prefix the
3143     regular expression with a <code>^</code> to require this.</p>
3144
3145     <pre class="prettyprint lang-config">&lt;LocationMatch "^/(extra|special)/data"&gt;</pre>
3146
3147     </div>
3148
3149     <p>From 2.4.8 onwards, named groups and backreferences are captured and
3150     written to the environment with the corresponding name prefixed with
3151     "MATCH_" and in upper case. This allows elements of URLs to be referenced
3152     from within <a href="../expr.html">expressions</a> and modules like
3153     <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>. In order to prevent confusion, numbered
3154     (unnamed) backreferences are ignored. Use named groups instead.</p>
3155
3156     <pre class="prettyprint lang-config">&lt;LocationMatch "^/combined/(?&lt;sitename&gt;[^/]+)"&gt;
3157     require ldap-group cn=%{env:MATCH_SITENAME},ou=combined,o=Example
3158 &lt;/LocationMatch&gt;</pre>
3159
3160
3161 <h3>See also</h3>
3162 <ul>
3163 <li><a href="../sections.html">How &lt;Directory&gt;, &lt;Location&gt;
3164     and &lt;Files&gt; sections work</a> for an explanation of how these
3165     different sections are combined when a request is received</li>
3166 </ul>
3167 </div>
3168 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
3169 <div class="directive-section"><h2><a name="LogLevel" id="LogLevel">LogLevel</a> <a name="loglevel" id="loglevel">Directive</a></h2>
3170 <table class="directive">
3171 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Controls the verbosity of the ErrorLog</td></tr>
3172 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LogLevel [<var>module</var>:]<var>level</var>
3173     [<var>module</var>:<var>level</var>] ...
3174 </code></td></tr>
3175 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LogLevel warn</code></td></tr>
3176 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
3177 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
3178 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
3179 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Per-module and per-directory configuration is available in
3180     Apache HTTP Server 2.3.6 and later</td></tr>
3181 </table>
3182     <p><code class="directive">LogLevel</code> adjusts the verbosity of the
3183     messages recorded in the error logs (see <code class="directive"><a href="#errorlog">ErrorLog</a></code> directive). The following
3184     <var>level</var>s are available, in order of decreasing
3185     significance:</p>
3186
3187     <table class="bordered">
3188
3189       <tr>
3190         <th><strong>Level</strong> </th>
3191
3192         <th><strong>Description</strong> </th>
3193
3194         <th><strong>Example</strong> </th>
3195       </tr>
3196
3197       <tr>
3198         <td><code>emerg</code> </td>
3199
3200         <td>Emergencies - system is unusable.</td>
3201
3202         <td>"Child cannot open lock file. Exiting"</td>
3203       </tr>
3204
3205       <tr>
3206         <td><code>alert</code> </td>
3207
3208         <td>Action must be taken immediately.</td>
3209
3210         <td>"getpwuid: couldn't determine user name from uid"</td>
3211       </tr>
3212
3213       <tr>
3214         <td><code>crit</code> </td>
3215
3216         <td>Critical Conditions.</td>
3217
3218         <td>"socket: Failed to get a socket, exiting child"</td>
3219       </tr>
3220
3221       <tr>
3222         <td><code>error</code> </td>
3223
3224         <td>Error conditions.</td>
3225
3226         <td>"Premature end of script headers"</td>
3227       </tr>
3228
3229       <tr>
3230         <td><code>warn</code> </td>
3231
3232         <td>Warning conditions.</td>
3233
3234         <td>"child process 1234 did not exit, sending another
3235         SIGHUP"</td>
3236       </tr>
3237
3238       <tr>
3239         <td><code>notice</code> </td>
3240
3241         <td>Normal but significant condition.</td>
3242
3243         <td>"httpd: caught SIGBUS, attempting to dump core in
3244         ..."</td>
3245       </tr>
3246
3247       <tr>
3248         <td><code>info</code> </td>
3249
3250         <td>Informational.</td>
3251
3252         <td>"Server seems busy, (you may need to increase
3253         StartServers, or Min/MaxSpareServers)..."</td>
3254       </tr>
3255
3256       <tr>
3257         <td><code>debug</code> </td>
3258
3259         <td>Debug-level messages</td>
3260
3261         <td>"Opening config file ..."</td>
3262       </tr>
3263       <tr>
3264         <td><code>trace1</code> </td>
3265
3266         <td>Trace messages</td>
3267
3268         <td>"proxy: FTP: control connection complete"</td>
3269       </tr>
3270       <tr>
3271         <td><code>trace2</code> </td>
3272
3273         <td>Trace messages</td>
3274
3275         <td>"proxy: CONNECT: sending the CONNECT request to the remote proxy"</td>
3276       </tr>
3277       <tr>
3278         <td><code>trace3</code> </td>
3279
3280         <td>Trace messages</td>
3281
3282         <td>"openssl: Handshake: start"</td>
3283       </tr>
3284       <tr>
3285         <td><code>trace4</code> </td>
3286
3287         <td>Trace messages</td>
3288
3289         <td>"read from buffered SSL brigade, mode 0, 17 bytes"</td>
3290       </tr>
3291       <tr>
3292         <td><code>trace5</code> </td>
3293
3294         <td>Trace messages</td>
3295
3296         <td>"map lookup FAILED: map=rewritemap key=keyname"</td>
3297       </tr>
3298       <tr>
3299         <td><code>trace6</code> </td>
3300
3301         <td>Trace messages</td>
3302
3303         <td>"cache lookup FAILED, forcing new map lookup"</td>
3304       </tr>
3305       <tr>
3306         <td><code>trace7</code> </td>
3307
3308         <td>Trace messages, dumping large amounts of data</td>
3309
3310         <td>"| 0000: 02 23 44 30 13 40 ac 34 df 3d bf 9a 19 49 39 15 |"</td>
3311       </tr>
3312       <tr>
3313         <td><code>trace8</code> </td>
3314
3315         <td>Trace messages, dumping large amounts of data</td>
3316
3317         <td>"| 0000: 02 23 44 30 13 40 ac 34 df 3d bf 9a 19 49 39 15 |"</td>
3318       </tr>
3319     </table>
3320
3321     <p>When a particular level is specified, messages from all
3322     other levels of higher significance will be reported as well.
3323     <em>E.g.</em>, when <code>LogLevel info</code> is specified,
3324     then messages with log levels of <code>notice</code> and
3325     <code>warn</code> will also be posted.</p>
3326
3327     <p>Using a level of at least <code>crit</code> is
3328     recommended.</p>
3329
3330     <p>For example:</p>
3331
3332     <pre class="prettyprint lang-config">LogLevel notice</pre>
3333
3334
3335     <div class="note"><h3>Note</h3>
3336       <p>When logging to a regular file, messages of the level
3337       <code>notice</code> cannot be suppressed and thus are always
3338       logged. However, this doesn't apply when logging is done
3339       using <code>syslog</code>.</p>
3340     </div>
3341
3342     <p>Specifying a level without a module name will reset the level
3343     for all modules to that level.  Specifying a level with a module
3344     name will set the level for that module only. It is possible to
3345     use the module source file name, the module identifier, or the
3346     module identifier with the trailing <code>_module</code> omitted
3347     as module specification. This means the following three specifications
3348     are equivalent:</p>
3349
3350     <pre class="prettyprint lang-config">LogLevel info ssl:warn
3351 LogLevel info mod_ssl.c:warn
3352 LogLevel info ssl_module:warn</pre>
3353
3354
3355     <p>It is also possible to change the level per directory:</p>
3356
3357     <pre class="prettyprint lang-config">LogLevel info
3358 &lt;Directory "/usr/local/apache/htdocs/app"&gt;
3359   LogLevel debug
3360 &lt;/Directory&gt;</pre>
3361
3362
3363     <div class="note">
3364         Per directory loglevel configuration only affects messages that are
3365         logged after the request has been parsed and that are associated with
3366         the request. Log messages which are associated with the server or
3367         the connection are not affected. The latter can be influenced by the
3368         <code class="directive"><a href="#logleveloverride">LogLevelOverride</a></code> directive,
3369         though.
3370     </div>
3371
3372 <h3>See also</h3>
3373 <ul>
3374 <li><code class="directive"><a href="#errorlog">ErrorLog</a></code></li>
3375 <li><code class="directive"><a href="#errorlogformat">ErrorLogFormat</a></code></li>
3376 <li><code class="directive"><a href="#logleveloverride">LogLevelOverride</a></code></li>
3377 <li><a href="../logs.html">Apache HTTP Server Log Files</a></li>
3378 </ul>
3379 </div>
3380 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
3381 <div class="directive-section"><h2><a name="LogLevelOverride" id="LogLevelOverride">LogLevelOverride</a> <a name="logleveloverride" id="logleveloverride">Directive</a></h2>
3382 <table class="directive">
3383 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Override the verbosity of the ErrorLog for certain clients</td></tr>
3384 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LogLevel <var>ipaddress</var>[/<var>prefixlen</var>]
3385     [<var>module</var>:]<var>level</var> [<var>module</var>:<var>level</var>] ...
3386 </code></td></tr>
3387 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>unset</code></td></tr>
3388 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
3389 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
3390 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
3391 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache HTTP Server 2.5.0 and later</td></tr>
3392 </table>
3393     <p><code class="directive">LogLevelOverride</code> adjusts the
3394     <code class="directive"><a href="#loglevel">LogLevel</a></code> for requests coming from
3395     certain client IP addresses.
3396     This allows to enable verbose logging only for certain test clients.
3397     The IP address is checked at a very early state in the connection
3398     processing.  Therefore, <code class="directive">LogLevelOverride</code> allows to
3399     change the log level for things like the SSL handshake which happen before
3400     a <code class="directive"><a href="#loglevel">LogLevel</a></code> directive in an
3401     <code class="directive"><a href="#if">&lt;If&gt;</a></code> container would
3402     be evaluated.</p>
3403
3404     <p><code class="directive">LogLevelOverride</code> accepts either a single
3405     IP-address or a CIDR IP-address/len subnet specification.
3406     For the syntax of the loglevel specification, see the
3407     <code class="directive"><a href="#loglevel">LogLevel</a></code> directive.</p>
3408
3409     <p>For requests that match a <code class="directive">LogLevelOverride</code>
3410     directive, per-directory specifications of
3411     <code class="directive"><a href="#loglevel">LogLevel</a></code> are ignored.</p>
3412
3413     <p>Examples:</p>
3414
3415     <pre class="prettyprint lang-config">    LogLevelOverride 192.0.2.0/24 ssl:trace6
3416     LogLevelOverride 192.0.2.7 ssl:trace8</pre>
3417
3418
3419     <div class="note">
3420         <code class="directive">LogLevelOverride</code> only affects
3421         log messages that are associated with the request or the connection.
3422         Log messages which are associated with the server are not affected.
3423     </div>
3424
3425
3426 <h3>See also</h3>
3427 <ul>
3428 <li><code class="directive"><a href="#loglevel">LogLevel</a></code></li>
3429 </ul>
3430 </div>
3431 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
3432 <div class="directive-section"><h2><a name="MaxKeepAliveRequests" id="MaxKeepAliveRequests">MaxKeepAliveRequests</a> <a name="maxkeepaliverequests" id="maxkeepaliverequests">Directive</a></h2>
3433 <table class="directive">
3434 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Number of requests allowed on a persistent
3435 connection</td></tr>
3436 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>MaxKeepAliveRequests <var>number</var></code></td></tr>
3437 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>MaxKeepAliveRequests 100</code></td></tr>
3438 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
3439 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
3440 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
3441 </table>
3442     <p>The <code class="directive">MaxKeepAliveRequests</code> directive
3443     limits the number of requests allowed per connection when
3444     <code class="directive"><a href="#keepalive">KeepAlive</a></code> is on. If it is
3445     set to <code>0</code>, unlimited requests will be allowed. We
3446     recommend that this setting be kept to a high value for maximum
3447     server performance.</p>
3448
3449     <p>For example:</p>
3450
3451     <pre class="prettyprint lang-config">MaxKeepAliveRequests 500</pre>
3452
3453
3454 </div>
3455 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
3456 <div class="directive-section"><h2><a name="MaxRangeOverlaps" id="MaxRangeOverlaps">MaxRangeOverlaps</a> <a name="maxrangeoverlaps" id="maxrangeoverlaps">Directive</a></h2>
3457 <table class="directive">
3458 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Number of overlapping ranges (eg: <code>100-200,150-300</code>) allowed before returning the complete
3459         resource </td></tr>
3460 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>MaxRangeOverlaps default | unlimited | none | <var>number-of-ranges</var></code></td></tr>
3461 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>MaxRangeOverlaps 20</code></td></tr>
3462 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
3463 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
3464 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
3465 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache HTTP Server 2.3.15 and later</td></tr>
3466 </table>
3467         <p>The <code class="directive">MaxRangeOverlaps</code> directive
3468             limits the number of overlapping HTTP ranges the server is willing to
3469             return to the client. If more overlapping ranges than permitted are requested,
3470             the complete resource is returned instead.</p>
3471
3472         <dl>
3473             <dt><strong>default</strong></dt>
3474             <dd>Limits the number of overlapping ranges to a compile-time default of 20.</dd>
3475
3476             <dt><strong>none</strong></dt>
3477             <dd>No overlapping Range headers are allowed.</dd>
3478
3479             <dt><strong>unlimited</strong></dt>
3480             <dd>The server does not limit the number of overlapping ranges it is
3481                 willing to satisfy.</dd>
3482
3483             <dt><var>number-of-ranges</var></dt>
3484             <dd>A positive number representing the maximum number of overlapping ranges the
3485                 server is willing to satisfy.</dd>
3486         </dl>
3487
3488 </div>
3489 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
3490 <div class="directive-section"><h2><a name="MaxRangeReversals" id="MaxRangeReversals">MaxRangeReversals</a> <a name="maxrangereversals" id="maxrangereversals">Directive</a></h2>
3491 <table class="directive">
3492 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Number of range reversals (eg: <code>100-200,50-70</code>) allowed before returning the complete
3493         resource </td></tr>
3494 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>MaxRangeReversals default | unlimited | none | <var>number-of-ranges</var></code></td></tr>
3495 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>MaxRangeReversals 20</code></td></tr>
3496 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
3497 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
3498 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
3499 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache HTTP Server 2.3.15 and later</td></tr>
3500 </table>
3501         <p>The <code class="directive">MaxRangeReversals</code> directive
3502             limits the number of HTTP Range reversals the server is willing to
3503             return to the client. If more ranges reversals than permitted are requested,
3504             the complete resource is returned instead.</p>
3505
3506         <dl>
3507             <dt><strong>default</strong></dt>
3508             <dd>Limits the number of range reversals to a compile-time default of 20.</dd>
3509
3510             <dt><strong>none</strong></dt>
3511             <dd>No Range reversals headers are allowed.</dd>
3512
3513             <dt><strong>unlimited</strong></dt>
3514             <dd>The server does not limit the number of range reversals it is
3515                 willing to satisfy.</dd>
3516
3517             <dt><var>number-of-ranges</var></dt>
3518             <dd>A positive number representing the maximum number of range reversals the
3519                 server is willing to satisfy.</dd>
3520         </dl>
3521
3522 </div>
3523 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
3524 <div class="directive-section"><h2><a name="MaxRanges" id="MaxRanges">MaxRanges</a> <a name="maxranges" id="maxranges">Directive</a></h2>
3525 <table class="directive">
3526 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Number of ranges allowed before returning the complete
3527 resource </td></tr>
3528 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>MaxRanges default | unlimited | none | <var>number-of-ranges</var></code></td></tr>
3529 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>MaxRanges 200</code></td></tr>
3530 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
3531 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
3532 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
3533 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache HTTP Server 2.3.15 and later</td></tr>
3534 </table>
3535     <p>The <code class="directive">MaxRanges</code> directive
3536     limits the number of HTTP ranges the server is willing to
3537     return to the client. If more ranges than permitted are requested,
3538     the complete resource is returned instead.</p>
3539
3540     <dl>
3541       <dt><strong>default</strong></dt>
3542       <dd>Limits the number of ranges to a compile-time default of 200.</dd>
3543
3544       <dt><strong>none</strong></dt>
3545       <dd>Range headers are ignored.</dd>
3546
3547       <dt><strong>unlimited</strong></dt>
3548       <dd>The server does not limit the number of ranges it is
3549           willing to satisfy.</dd>
3550
3551       <dt><var>number-of-ranges</var></dt>
3552       <dd>A positive number representing the maximum number of ranges the
3553       server is willing to satisfy.</dd>
3554     </dl>
3555
3556 </div>
3557 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
3558 <div class="directive-section"><h2><a name="MergeTrailers" id="MergeTrailers">MergeTrailers</a> <a name="mergetrailers" id="mergetrailers">Directive</a></h2>
3559 <table class="directive">
3560 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Determines whether trailers are merged into headers</td></tr>
3561 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>MergeTrailers [on|off]</code></td></tr>
3562 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>MergeTrailers off</code></td></tr>
3563 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
3564 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
3565 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
3566 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>2.4.11 and later</td></tr>
3567 </table>
3568     <p>This directive controls whether HTTP trailers are copied into the
3569     internal representation of HTTP headers. This merging occurs when the
3570     request body has been completely consumed, long after most header
3571     processing would have a chance to examine or modify request headers.</p>
3572     <p>This option is provided for compatibility with releases prior to 2.4.11,
3573     where trailers were always merged.</p>
3574
3575 </div>
3576 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
3577 <div class="directive-section"><h2><a name="Mutex" id="Mutex">Mutex</a> <a name="mutex" id="mutex">Directive</a></h2>
3578 <table class="directive">
3579 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures mutex mechanism and lock file directory for all
3580 or specified mutexes</td></tr>
3581 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Mutex <var>mechanism</var> [default|<var>mutex-name</var>] ... [OmitPID]</code></td></tr>
3582 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Mutex default</code></td></tr>
3583 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
3584 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
3585 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
3586 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache HTTP Server 2.3.4 and later</td></tr>
3587 </table>
3588     <p>The <code class="directive">Mutex</code> directive sets the mechanism,
3589     and optionally the lock file location, that httpd and modules use
3590     to serialize access to resources.  Specify <code>default</code> as
3591     the second argument to change the settings for all mutexes; specify
3592     a mutex name (see table below) as the second argument to override
3593     defaults only for that mutex.</p>
3594
3595     <p>The <code class="directive">Mutex</code> directive is typically used in
3596     the following exceptional situations:</p>
3597
3598     <ul>
3599         <li>change the mutex mechanism when the default mechanism selected
3600         by <a class="glossarylink" href="../glossary.html#apr" title="see glossary">APR</a> has a functional or performance
3601         problem</li>
3602
3603         <li>change the directory used by file-based mutexes when the
3604         default directory does not support locking</li>
3605     </ul>
3606
3607     <div class="note"><h3>Supported modules</h3>
3608     <p>This directive only configures mutexes which have been registered
3609     with the core server using the <code>ap_mutex_register()</code> API.
3610     All modules bundled with httpd support the <code class="directive">Mutex</code>
3611     directive, but third-party modules may not.  Consult the documentation
3612     of the third-party module, which must indicate the mutex name(s) which
3613     can be configured if this directive is supported.</p>
3614     </div>
3615
3616     <p>The following mutex <em>mechanisms</em> are available:</p>
3617     <ul>
3618         <li><code>default | yes</code>
3619         <p>This selects the default locking implementation, as determined by
3620         <a class="glossarylink" href="../glossary.html#apr" title="see glossary">APR</a>.  The default locking implementation can
3621         be displayed by running <code class="program"><a href="../programs/httpd.html">httpd</a></code> with the
3622         <code>-V</code> option.</p></li>
3623
3624         <li><code>none | no</code>
3625         <p>This effectively disables the mutex, and is only allowed for a
3626         mutex if the module indicates that it is a valid choice.  Consult the
3627         module documentation for more information.</p></li>
3628
3629         <li><code>posixsem</code>
3630         <p>This is a mutex variant based on a Posix semaphore.</p>
3631
3632         <div class="warning"><h3>Warning</h3>
3633         <p>The semaphore ownership is not recovered if a thread in the process
3634         holding the mutex segfaults, resulting in a hang of the web server.</p>
3635         </div>
3636         </li>
3637
3638         <li><code>sysvsem</code>
3639         <p>This is a mutex variant based on a SystemV IPC semaphore.</p>
3640
3641         <div class="warning"><h3>Warning</h3>
3642         <p>It is possible to "leak" SysV semaphores if processes crash
3643         before the semaphore is removed.</p>
3644         </div>
3645
3646         <div class="warning"><h3>Security</h3>
3647         <p>The semaphore API allows for a denial of service attack by any
3648         CGIs running under the same uid as the webserver (<em>i.e.</em>,
3649         all CGIs, unless you use something like <code class="program"><a href="../programs/suexec.html">suexec</a></code>
3650         or <code>cgiwrapper</code>).</p>
3651         </div>
3652         </li>
3653
3654         <li><code>sem</code>
3655         <p>This selects the "best" available semaphore implementation, choosing
3656         between Posix and SystemV IPC semaphores, in that order.</p></li>
3657
3658         <li><code>pthread</code>
3659         <p>This is a mutex variant based on cross-process Posix thread
3660         mutexes.</p>
3661
3662         <div class="warning"><h3>Warning</h3>
3663         <p>On most systems, if a child process terminates abnormally while
3664         holding a mutex that uses this implementation, the server will deadlock
3665         and stop responding to requests.  When this occurs, the server will
3666         require a manual restart to recover.</p>
3667         <p>Solaris and Linux are notable exceptions as they provide a mechanism which
3668         usually allows the mutex to be recovered after a child process
3669         terminates abnormally while holding a mutex.</p>
3670         <p>If your system is POSIX compliant or if it implements the
3671         <code>pthread_mutexattr_setrobust_np()</code> function, you may be able
3672         to use the <code>pthread</code> option safely.</p>
3673         </div>
3674         </li>
3675
3676         <li><code>fcntl:/path/to/mutex</code>
3677         <p>This is a mutex variant where a physical (lock-)file and the
3678         <code>fcntl()</code> function are used as the mutex.</p>
3679
3680         <div class="warning"><h3>Warning</h3>
3681         <p>When multiple mutexes based on this mechanism are used within
3682         multi-threaded, multi-process environments, deadlock errors (EDEADLK)
3683         can be reported for valid mutex operations if <code>fcntl()</code>
3684         is not thread-aware, such as on Solaris.</p>
3685         </div>
3686         </li>
3687
3688         <li><code>flock:/path/to/mutex</code>
3689         <p>This is similar to the <code>fcntl:/path/to/mutex</code> method
3690         with the exception that the <code>flock()</code> function is used to
3691         provide file locking.</p></li>
3692
3693         <li><code>file:/path/to/mutex</code>
3694         <p>This selects the "best" available file locking implementation,
3695         choosing between <code>fcntl</code> and <code>flock</code>, in that
3696         order.</p></li>
3697     </ul>
3698
3699     <p>Most mechanisms are only available on selected platforms, where the
3700     underlying platform and <a class="glossarylink" href="../glossary.html#apr" title="see glossary">APR</a> support it.  Mechanisms
3701     which aren't available on all platforms are <em>posixsem</em>,
3702     <em>sysvsem</em>, <em>sem</em>, <em>pthread</em>, <em>fcntl</em>,
3703     <em>flock</em>, and <em>file</em>.</p>
3704
3705     <p>With the file-based mechanisms <em>fcntl</em> and <em>flock</em>,
3706     the path, if provided, is a directory where the lock file will be created.
3707     The default directory is httpd's run-time file directory,
3708     <code class="directive"><a href="#defaultruntimedir">DefaultRuntimeDir</a></code>.  If a relative
3709     path is provided, it is relative to
3710     <code class="directive"><a href="#defaultruntimedir">DefaultRuntimeDir</a></code>.  Always use a local
3711     disk filesystem for <code>/path/to/mutex</code> and never a directory residing
3712     on a NFS- or AFS-filesystem.  The basename of the file will be the mutex
3713     type, an optional instance string provided by the module, and unless the
3714     <code>OmitPID</code> keyword is specified, the process id of the httpd
3715     parent process will be appended to make the file name unique, avoiding
3716     conflicts when multiple httpd instances share a lock file directory.  For
3717     example, if the mutex name is <code>mpm-accept</code> and the lock file
3718     directory is <code>/var/httpd/locks</code>, the lock file name for the
3719     httpd instance with parent process id 12345 would be
3720     <code>/var/httpd/locks/mpm-accept.12345</code>.</p>
3721
3722     <div class="warning"><h3>Security</h3>
3723     <p>It is best to <em>avoid</em> putting mutex files in a world-writable
3724     directory such as <code>/var/tmp</code> because someone could create
3725     a denial of service attack and prevent the server from starting by
3726     creating a lockfile with the same name as the one the server will try
3727     to create.</p>
3728     </div>
3729
3730     <p>The following table documents the names of mutexes used by httpd
3731     and bundled modules.</p>
3732
3733     <table class="bordered"><tr class="header">
3734             <th>Mutex name</th>
3735             <th>Module(s)</th>
3736             <th>Protected resource</th>
3737         </tr>
3738 <tr>
3739             <td><code>mpm-accept</code></td>
3740             <td><code class="module"><a href="../mod/prefork.html">prefork</a></code> and <code class="module"><a href="../mod/worker.html">worker</a></code> MPMs</td>
3741             <td>incoming connections, to avoid the thundering herd problem;
3742             for more information, refer to the
3743             <a href="../misc/perf-tuning.html">performance tuning</a>
3744             documentation</td>
3745         </tr>
3746 <tr class="odd">
3747             <td><code>authdigest-client</code></td>
3748             <td><code class="module"><a href="../mod/mod_auth_digest.html">mod_auth_digest</a></code></td>
3749             <td>client list in shared memory</td>
3750         </tr>
3751 <tr>
3752             <td><code>authdigest-opaque</code></td>
3753             <td><code class="module"><a href="../mod/mod_auth_digest.html">mod_auth_digest</a></code></td>
3754             <td>counter in shared memory</td>
3755         </tr>
3756 <tr class="odd">
3757             <td><code>ldap-cache</code></td>
3758             <td><code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code></td>
3759             <td>LDAP result cache</td>
3760         </tr>
3761 <tr>
3762             <td><code>rewrite-map</code></td>
3763             <td><code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code></td>
3764             <td>communication with external mapping programs, to avoid
3765             intermixed I/O from multiple requests</td>
3766         </tr>
3767 <tr class="odd">
3768             <td><code>ssl-cache</code></td>
3769             <td><code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code></td>
3770             <td>SSL session cache</td>
3771         </tr>
3772 <tr>
3773             <td><code>ssl-stapling</code></td>
3774             <td><code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code></td>
3775             <td>OCSP stapling response cache</td>
3776         </tr>
3777 <tr class="odd">
3778             <td><code>watchdog-callback</code></td>
3779             <td><code class="module"><a href="../mod/mod_watchdog.html">mod_watchdog</a></code></td>
3780             <td>callback function of a particular client module</td>
3781         </tr>
3782 </table>
3783
3784     <p>The <code>OmitPID</code> keyword suppresses the addition of the httpd
3785     parent process id from the lock file name.</p>
3786
3787     <p>In the following example, the mutex mechanism for the MPM accept
3788     mutex will be changed from the compiled-in default to <code>fcntl</code>,
3789     with the associated lock file created in directory
3790     <code>/var/httpd/locks</code>.  The mutex mechanism for all other mutexes
3791     will be changed from the compiled-in default to <code>sysvsem</code>.</p>
3792
3793     <pre class="prettyprint lang-config">Mutex sysvsem default
3794 Mutex fcntl:/var/httpd/locks mpm-accept</pre>
3795
3796
3797 </div>
3798 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
3799 <div class="directive-section"><h2><a name="NameVirtualHost" id="NameVirtualHost">NameVirtualHost</a> <a name="namevirtualhost" id="namevirtualhost">Directive</a></h2>
3800 <table class="directive">
3801 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>DEPRECATED: Designates an IP address for name-virtual
3802 hosting</td></tr>
3803 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>NameVirtualHost <var>addr</var>[:<var>port</var>]</code></td></tr>
3804 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
3805 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
3806 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
3807 </table>
3808
3809 <p>Prior to 2.3.11, <code class="directive">NameVirtualHost</code> was required
3810 to instruct the server that a particular IP address and port combination
3811 was usable as a name-based virtual host.  In 2.3.11 and later,
3812 any time an IP address and port combination is used in multiple virtual
3813 hosts, name-based virtual hosting is automatically enabled for that address.</p>
3814
3815 <p>This directive currently has no effect.</p>
3816
3817 <h3>See also</h3>
3818 <ul>
3819 <li><a href="../vhosts/">Virtual Hosts
3820 documentation</a></li>
3821 </ul>
3822 </div>
3823 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
3824 <div class="directive-section"><h2><a name="Options" id="Options">Options</a> <a name="options" id="options">Directive</a></h2>
3825 <table class="directive">
3826 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures what features are available in a particular
3827 directory</td></tr>
3828 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Options
3829     [+|-]<var>option</var> [[+|-]<var>option</var>] ...</code></td></tr>
3830 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Options FollowSymlinks</code></td></tr>
3831 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
3832 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Options</td></tr>
3833 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
3834 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
3835 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>The default was changed from All to FollowSymlinks in 2.3.11</td></tr>
3836 </table>
3837     <p>The <code class="directive">Options</code> directive controls which
3838     server features are available in a particular directory.</p>
3839
3840     <p><var>option</var> can be set to <code>None</code>, in which
3841     case none of the extra features are enabled, or one or more of
3842     the following:</p>
3843
3844     <dl>
3845       <dt><code>All</code></dt>
3846
3847       <dd>All options except for <code>MultiViews</code>.</dd>
3848
3849       <dt><code>ExecCGI</code></dt>
3850
3851       <dd>
3852       Execution of CGI scripts using <code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code>
3853       is permitted.</dd>
3854
3855       <dt><code>FollowSymLinks</code></dt>
3856
3857       <dd>
3858       The server will follow symbolic links in this directory. This is
3859       the default setting.
3860       <div class="note">
3861       <p>Even though the server follows the symlink it does <em>not</em>
3862       change the pathname used to match against <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code> sections.</p>
3863
3864       <p>The <code>FollowSymLinks</code> and
3865       <code>SymLinksIfOwnerMatch</code> <code class="directive"><a href="#options">Options</a></code> work only in <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code> sections or
3866       <code>.htaccess</code> files.</p>
3867
3868       <p>Omitting this option should not be considered a security restriction,
3869       since symlink testing is subject to race conditions that make it
3870       circumventable.</p>
3871       </div></dd>
3872
3873       <dt><code>Includes</code></dt>
3874
3875       <dd>
3876       Server-side includes provided by <code class="module"><a href="../mod/mod_include.html">mod_include</a></code>
3877       are permitted.</dd>
3878
3879       <dt><code>IncludesNOEXEC</code></dt>
3880
3881       <dd>
3882
3883       Server-side includes are permitted, but the <code>#exec
3884       cmd</code> and <code>#exec cgi</code> are disabled. It is still
3885       possible to <code>#include virtual</code> CGI scripts from
3886       <code class="directive"><a href="../mod/mod_alias.html#scriptalias">ScriptAlias</a></code>ed
3887       directories.</dd>
3888
3889       <dt><code>Indexes</code></dt>
3890
3891       <dd>
3892       If a URL which maps to a directory is requested and there
3893       is no <code class="directive"><a href="../mod/mod_dir.html#directoryindex">DirectoryIndex</a></code>
3894       (<em>e.g.</em>, <code>index.html</code>) in that directory, then
3895       <code class="module"><a href="../mod/mod_autoindex.html">mod_autoindex</a></code> will return a formatted listing
3896       of the directory.</dd>
3897
3898       <dt><code>MultiViews</code></dt>
3899
3900       <dd>
3901       <a href="../content-negotiation.html">Content negotiated</a>
3902       "MultiViews" are allowed using
3903       <code class="module"><a href="../mod/mod_negotiation.html">mod_negotiation</a></code>.
3904       <div class="note"><h3>Note</h3> <p>This option gets ignored if set
3905       anywhere other than <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code>, as <code class="module"><a href="../mod/mod_negotiation.html">mod_negotiation</a></code>
3906       needs real resources to compare against and evaluate from.</p></div>
3907       </dd>
3908
3909       <dt><code>SymLinksIfOwnerMatch</code></dt>
3910
3911       <dd>The server will only follow symbolic links for which the
3912       target file or directory is owned by the same user id as the
3913       link.
3914
3915       <div class="note"><h3>Note</h3>
3916       <p>The <code>FollowSymLinks</code> and
3917       <code>SymLinksIfOwnerMatch</code> <code class="directive"><a href="#options">Options</a></code> work only in <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code> sections or
3918       <code>.htaccess</code> files.</p>
3919
3920       <p>This option should not be considered a security restriction,
3921       since symlink testing is subject to race conditions that make it
3922       circumventable.</p>
3923       </div> </dd>
3924     </dl>
3925
3926     <p>Normally, if multiple <code class="directive">Options</code> could
3927     apply to a directory, then the most specific one is used and
3928     others are ignored; the options are not merged. (See <a href="../sections.html#merging">how sections are merged</a>.)
3929     However if <em>all</em> the options on the
3930     <code class="directive">Options</code> directive are preceded by a
3931     <code>+</code> or <code>-</code> symbol, the options are
3932     merged. Any options preceded by a <code>+</code> are added to the
3933     options currently in force, and any options preceded by a
3934     <code>-</code> are removed from the options currently in
3935     force. </p>
3936
3937     <div class="note"><h3>Note</h3>
3938     <p>Mixing <code class="directive">Options</code> with a <code>+</code> or
3939     <code>-</code> with those without is not valid syntax and will be
3940     rejected during server startup by the syntax check with an abort.</p>
3941     </div>
3942
3943     <p>For example, without any <code>+</code> and <code>-</code> symbols:</p>
3944
3945     <pre class="prettyprint lang-config">&lt;Directory "/web/docs"&gt;
3946   Options Indexes FollowSymLinks
3947 &lt;/Directory&gt;
3948
3949 &lt;Directory "/web/docs/spec"&gt;
3950   Options Includes
3951 &lt;/Directory&gt;</pre>
3952
3953
3954     <p>then only <code>Includes</code> will be set for the
3955     <code>/web/docs/spec</code> directory. However if the second
3956     <code class="directive">Options</code> directive uses the <code>+</code> and
3957     <code>-</code> symbols:</p>
3958
3959     <pre class="prettyprint lang-config">&lt;Directory "/web/docs"&gt;
3960   Options Indexes FollowSymLinks
3961 &lt;/Directory&gt;
3962
3963 &lt;Directory "/web/docs/spec"&gt;
3964   Options +Includes -Indexes
3965 &lt;/Directory&gt;</pre>
3966
3967
3968     <p>then the options <code>FollowSymLinks</code> and
3969     <code>Includes</code> are set for the <code>/web/docs/spec</code>
3970     directory.</p>
3971
3972     <div class="note"><h3>Note</h3>
3973       <p>Using <code>-IncludesNOEXEC</code> or
3974       <code>-Includes</code> disables server-side includes completely
3975       regardless of the previous setting.</p>
3976     </div>
3977
3978     <p>The default in the absence of any other settings is
3979     <code>FollowSymlinks</code>.</p>
3980
3981 </div>
3982 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
3983 <div class="directive-section"><h2><a name="Protocol" id="Protocol">Protocol</a> <a name="protocol" id="protocol">Directive</a></h2>
3984 <table class="directive">
3985 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Protocol for a listening socket</td></tr>
3986 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Protocol <var>protocol</var></code></td></tr>
3987 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
3988 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
3989 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
3990 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>On Windows, only available from Apache 2.3.3 and later.</td></tr>
3991 </table>
3992     <p>This directive specifies the protocol used for a specific listening socket.
3993        The protocol is used to determine which module should handle a request and
3994        to apply protocol specific optimizations with the <code class="directive">AcceptFilter</code>
3995        directive.</p>
3996
3997     <p>You only need to set the protocol if you are running on non-standard ports;
3998        otherwise, <code>http</code> is assumed for port 80 and <code>https</code>
3999        for port 443.</p>
4000
4001     <p>For example, if you are running <code>https</code> on a non-standard port,
4002        specify the protocol explicitly:</p>
4003
4004     <pre class="prettyprint lang-config">Protocol https</pre>
4005
4006
4007     <p>You can also specify the protocol using the <code class="directive"><a href="../mod/mpm_common.html#listen">Listen</a></code> directive.</p>
4008
4009 <h3>See also</h3>
4010 <ul>
4011 <li><code class="directive"><a href="#acceptfilter">AcceptFilter</a></code></li>
4012 <li><code class="directive"><a href="../mod/mpm_common.html#listen">Listen</a></code></li>
4013 </ul>
4014 </div>
4015 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4016 <div class="directive-section"><h2><a name="Protocols" id="Protocols">Protocols</a> <a name="protocols" id="protocols">Directive</a></h2>
4017 <table class="directive">
4018 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Protocols available for a server/virtual host</td></tr>
4019 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Protocols <var>protocol</var> ...</code></td></tr>
4020 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Protocols http/1.1</code></td></tr>
4021 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
4022 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4023 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4024 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Only available from Apache 2.4.17 and later.</td></tr>
4025 </table>
4026         <p>This directive specifies the list of protocols supported for a
4027             server/virtual host. The list determines the allowed protocols
4028             a client may negotiate for this server/host.</p>
4029
4030         <p>You need to set protocols if you want to extend the available
4031             protocols for a server/host. By default, only the http/1.1 protocol
4032             (which includes the compatibility with 1.0 and 0.9 clients) is
4033             allowed.</p>
4034
4035         <p>For example, if you want to support HTTP/2 for a server with TLS,
4036             specify:</p>
4037
4038         <pre class="prettyprint lang-config">Protocols h2 http/1.1</pre>
4039
4040
4041         <p>Valid protocols are <code>http/1.1</code> for http and https connections,
4042             <code>h2</code> on https connections and <code>h2c</code> for http
4043             connections. Modules may enable more protocols.</p>
4044
4045         <p>It is safe to specify protocols that are unavailable/disabled. Such
4046         protocol names will simply be ignored.</p>
4047
4048         <p>Protocols specified in base servers are inherited for virtual hosts
4049             only if the virtual host has no own Protocols directive. Or, the other
4050             way around, Protocols directives in virtual hosts replace any
4051             such directive in the base server.
4052         </p>
4053
4054
4055 <h3>See also</h3>
4056 <ul>
4057 <li><code class="directive"><a href="#protocolshonororder">ProtocolsHonorOrder</a></code></li>
4058 </ul>
4059 </div>
4060 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4061 <div class="directive-section"><h2><a name="ProtocolsHonorOrder" id="ProtocolsHonorOrder">ProtocolsHonorOrder</a> <a name="protocolshonororder" id="protocolshonororder">Directive</a></h2>
4062 <table class="directive">
4063 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Determines if order of Protocols determines precedence during negotiation</td></tr>
4064 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProtocolsHonorOrder On|Off</code></td></tr>
4065 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProtocolsHonorOrder On</code></td></tr>
4066 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
4067 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4068 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4069 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Only available from Apache 2.4.17 and later.</td></tr>
4070 </table>
4071         <p>This directive specifies if the server should honor the order in which
4072         the <code class="directive">Protocols</code> directive lists protocols.</p>
4073
4074         <p>If configured Off, the client supplied list order of protocols has
4075             precedence over the order in the server configuration.</p>
4076
4077         <p>With <code class="directive">ProtocolsHonorOrder</code> set to <code>on</code>
4078             (default), the client ordering does not matter and only the ordering
4079             in the server settings influences the outcome of the protocol
4080             negotiation.</p>
4081
4082
4083 <h3>See also</h3>
4084 <ul>
4085 <li><code class="directive"><a href="#protocols">Protocols</a></code></li>
4086 </ul>
4087 </div>
4088 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4089 <div class="directive-section"><h2><a name="QualifyRedirectURL" id="QualifyRedirectURL">QualifyRedirectURL</a> <a name="qualifyredirecturl" id="qualifyredirecturl">Directive</a></h2>
4090 <table class="directive">
4091 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Controls whether the REDIRECT_URL environment variable is
4092              fully qualified</td></tr>
4093 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>QualifyRedirectURL ON|OFF</code></td></tr>
4094 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>QualifyRedirectURL OFF</code></td></tr>
4095 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
4096 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
4097 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4098 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4099 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Directive supported in 2.4.18 and later. 2.4.17 acted
4100 as if 'QualifyRedirectURL ON' was configured.</td></tr>
4101 </table>
4102     <p>This directive controls whether the server will ensure that the
4103     REDIRECT_URL environment variable is fully qualified.  By default,
4104     the variable contains the verbatim URL requested by the client,
4105     such as "/index.html".  With <code class="directive"><a href="#qualifyredirecturl on">QualifyRedirectURL ON</a></code>, the same request would result in a
4106     value such as "http://www.example.com/index.html".</p>
4107     <p>Even without this directive set, when a request is issued against a
4108     fully qualified URL, REDIRECT_URL will remain fully qualified.
4109     </p>
4110
4111 </div>
4112 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4113 <div class="directive-section"><h2><a name="RegisterHttpMethod" id="RegisterHttpMethod">RegisterHttpMethod</a> <a name="registerhttpmethod" id="registerhttpmethod">Directive</a></h2>
4114 <table class="directive">
4115 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Register non-standard HTTP methods</td></tr>
4116 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RegisterHttpMethod <var>method</var> [<var>method</var> [...]]</code></td></tr>
4117 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
4118 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4119 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4120 </table>
4121 <p>This directive may be used to register additional HTTP methods.  This is
4122 necessary if non-standard methods need to be used with directives that accept
4123 method names as parameters, or to allow particular non-standard methods to be
4124 used via proxy or CGI script when the server has been configured to only pass
4125 recognized methods to modules.</p>
4126
4127 <h3>See also</h3>
4128 <ul>
4129 <li><code class="directive"><a href="#httpprotocoloptions">HTTPProtocolOptions</a></code></li>
4130 <li><code class="directive"><a href="../mod/mod_allowmethods.html#allowmethods">AllowMethods</a></code></li>
4131 </ul>
4132 </div>
4133 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4134 <div class="directive-section"><h2><a name="RLimitCPU" id="RLimitCPU">RLimitCPU</a> <a name="rlimitcpu" id="rlimitcpu">Directive</a></h2>
4135 <table class="directive">
4136 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limits the CPU consumption of processes launched
4137 by Apache httpd children</td></tr>
4138 <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>
4139 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Unset; uses operating system defaults</code></td></tr>
4140 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
4141 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
4142 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4143 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4144 </table>
4145     <p>Takes 1 or 2 parameters. The first parameter sets the soft
4146     resource limit for all processes and the second parameter sets
4147     the maximum resource limit. Either parameter can be a number,
4148     or <code>max</code> to indicate to the server that the limit should
4149     be set to the maximum allowed by the operating system
4150     configuration. Raising the maximum resource limit requires that
4151     the server is running as <code>root</code> or in the initial startup
4152     phase.</p>
4153
4154     <p>This applies to processes forked from Apache httpd children
4155     servicing requests, not the Apache httpd children themselves. This
4156     includes CGI scripts and SSI exec commands, but not any
4157     processes forked from the Apache httpd parent, such as piped
4158     logs.</p>
4159
4160     <p>CPU resource limits are expressed in seconds per
4161     process.</p>
4162
4163 <h3>See also</h3>
4164 <ul>
4165 <li><code class="directive"><a href="#rlimitmem">RLimitMEM</a></code></li>
4166 <li><code class="directive"><a href="#rlimitnproc">RLimitNPROC</a></code></li>
4167 </ul>
4168 </div>
4169 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4170 <div class="directive-section"><h2><a name="RLimitMEM" id="RLimitMEM">RLimitMEM</a> <a name="rlimitmem" id="rlimitmem">Directive</a></h2>
4171 <table class="directive">
4172 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limits the memory consumption of processes launched
4173 by Apache httpd children</td></tr>
4174 <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>
4175 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Unset; uses operating system defaults</code></td></tr>
4176 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
4177 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
4178 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4179 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4180 </table>
4181     <p>Takes 1 or 2 parameters. The first parameter sets the soft
4182     resource limit for all processes and the second parameter sets
4183     the maximum resource limit. Either parameter can be a number,
4184     or <code>max</code> to indicate to the server that the limit should
4185     be set to the maximum allowed by the operating system
4186     configuration. Raising the maximum resource limit requires that
4187     the server is running as <code>root</code> or in the initial startup
4188     phase.</p>
4189
4190     <p>This applies to processes forked from Apache httpd children
4191     servicing requests, not the Apache httpd children themselves. This
4192     includes CGI scripts and SSI exec commands, but not any
4193     processes forked from the Apache httpd parent, such as piped
4194     logs.</p>
4195
4196     <p>Memory resource limits are expressed in bytes per
4197     process.</p>
4198
4199 <h3>See also</h3>
4200 <ul>
4201 <li><code class="directive"><a href="#rlimitcpu">RLimitCPU</a></code></li>
4202 <li><code class="directive"><a href="#rlimitnproc">RLimitNPROC</a></code></li>
4203 </ul>
4204 </div>
4205 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4206 <div class="directive-section"><h2><a name="RLimitNPROC" id="RLimitNPROC">RLimitNPROC</a> <a name="rlimitnproc" id="rlimitnproc">Directive</a></h2>
4207 <table class="directive">
4208 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limits the number of processes that can be launched by
4209 processes launched by Apache httpd children</td></tr>
4210 <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>
4211 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Unset; uses operating system defaults</code></td></tr>
4212 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
4213 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
4214 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4215 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4216 </table>
4217     <p>Takes 1 or 2 parameters. The first parameter sets the soft
4218     resource limit for all processes, and the second parameter sets
4219     the maximum resource limit. Either parameter can be a number,
4220     or <code>max</code> to indicate to the server that the limit
4221     should be set to the maximum allowed by the operating system
4222     configuration. Raising the maximum resource limit requires that
4223     the server is running as <code>root</code> or in the initial startup
4224     phase.</p>
4225
4226     <p>This applies to processes forked from Apache httpd children
4227     servicing requests, not the Apache httpd children themselves. This
4228     includes CGI scripts and SSI exec commands, but not any
4229     processes forked from the Apache httpd parent, such as piped
4230     logs.</p>
4231
4232     <p>Process limits control the number of processes per user.</p>
4233
4234     <div class="note"><h3>Note</h3>
4235       <p>If CGI processes are <strong>not</strong> running
4236       under user ids other than the web server user id, this directive
4237       will limit the number of processes that the server itself can
4238       create. Evidence of this situation will be indicated by
4239       <strong><code>cannot fork</code></strong> messages in the
4240       <code>error_log</code>.</p>
4241     </div>
4242
4243 <h3>See also</h3>
4244 <ul>
4245 <li><code class="directive"><a href="#rlimitmem">RLimitMEM</a></code></li>
4246 <li><code class="directive"><a href="#rlimitcpu">RLimitCPU</a></code></li>
4247 </ul>
4248 </div>
4249 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4250 <div class="directive-section"><h2><a name="ScriptInterpreterSource" id="ScriptInterpreterSource">ScriptInterpreterSource</a> <a name="scriptinterpretersource" id="scriptinterpretersource">Directive</a></h2>
4251 <table class="directive">
4252 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Technique for locating the interpreter for CGI
4253 scripts</td></tr>
4254 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ScriptInterpreterSource Registry|Registry-Strict|Script</code></td></tr>
4255 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ScriptInterpreterSource Script</code></td></tr>
4256 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
4257 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
4258 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4259 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4260 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Win32 only.</td></tr>
4261 </table>
4262     <p>This directive is used to control how Apache httpd finds the
4263     interpreter used to run CGI scripts. The default setting is
4264     <code>Script</code>. This causes Apache httpd to use the interpreter pointed to
4265     by the shebang line (first line, starting with <code>#!</code>) in the
4266     script. On Win32 systems this line usually looks like:</p>
4267
4268     <pre class="prettyprint lang-perl">#!C:/Perl/bin/perl.exe</pre>
4269
4270
4271     <p>or, if <code>perl</code> is in the <code>PATH</code>, simply:</p>
4272
4273     <pre class="prettyprint lang-perl">#!perl</pre>
4274
4275
4276     <p>Setting <code>ScriptInterpreterSource Registry</code> will
4277     cause the Windows Registry tree <code>HKEY_CLASSES_ROOT</code> to be
4278     searched using the script file extension (e.g., <code>.pl</code>) as a
4279     search key. The command defined by the registry subkey
4280     <code>Shell\ExecCGI\Command</code> or, if it does not exist, by the subkey
4281     <code>Shell\Open\Command</code> is used to open the script file. If the
4282     registry keys cannot be found, Apache httpd falls back to the behavior of the
4283     <code>Script</code> option.</p>
4284
4285     <div class="warning"><h3>Security</h3>
4286     <p>Be careful when using <code>ScriptInterpreterSource
4287     Registry</code> with <code class="directive"><a href="../mod/mod_alias.html#scriptalias">ScriptAlias</a></code>'ed directories, because
4288     Apache httpd will try to execute <strong>every</strong> file within this
4289     directory. The <code>Registry</code> setting may cause undesired
4290     program calls on files which are typically not executed. For
4291     example, the default open command on <code>.htm</code> files on
4292     most Windows systems will execute Microsoft Internet Explorer, so
4293     any HTTP request for an <code>.htm</code> file existing within the
4294     script directory would start the browser in the background on the
4295     server. This is a good way to crash your system within a minute or
4296     so.</p>
4297     </div>
4298
4299     <p>The option <code>Registry-Strict</code> which is new in Apache HTTP Server
4300     2.0 does the same thing as <code>Registry</code> but uses only the
4301     subkey <code>Shell\ExecCGI\Command</code>. The
4302     <code>ExecCGI</code> key is not a common one. It must be
4303     configured manually in the windows registry and hence prevents
4304     accidental program calls on your system.</p>
4305
4306 </div>
4307 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4308 <div class="directive-section"><h2><a name="SeeRequestTail" id="SeeRequestTail">SeeRequestTail</a> <a name="seerequesttail" id="seerequesttail">Directive</a></h2>
4309 <table class="directive">
4310 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Determine if mod_status displays the first 63 characters
4311 of a request or the last 63, assuming the request itself is greater than
4312 63 chars.</td></tr>
4313 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SeeRequestTail On|Off</code></td></tr>
4314 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SeeRequestTail Off</code></td></tr>
4315 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
4316 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4317 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4318 </table>
4319     <p>mod_status with <code>ExtendedStatus On</code>
4320     displays the actual request being handled.
4321     For historical purposes, only 63 characters of the request
4322     are actually stored for display purposes. This directive
4323     controls whether the 1st 63 characters are stored (the previous
4324     behavior and the default) or if the last 63 characters are. This
4325     is only applicable, of course, if the length of the request is
4326     64 characters or greater.</p>
4327
4328     <p>If Apache httpd is handling <code>GET&nbsp;/disk1/storage/apache/htdocs/images/imagestore1/food/apples.jpg&nbsp;HTTP/1.1</code> mod_status displays as follows:
4329     </p>
4330
4331     <table class="bordered">
4332       <tr>
4333         <th>Off (default)</th>
4334         <td>GET&nbsp;/disk1/storage/apache/htdocs/images/imagestore1/food/apples</td>
4335       </tr>
4336       <tr>
4337         <th>On</th>
4338         <td>orage/apache/htdocs/images/imagestore1/food/apples.jpg&nbsp;HTTP/1.1</td>
4339       </tr>
4340     </table>
4341
4342
4343 </div>
4344 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4345 <div class="directive-section"><h2><a name="ServerAdmin" id="ServerAdmin">ServerAdmin</a> <a name="serveradmin" id="serveradmin">Directive</a></h2>
4346 <table class="directive">
4347 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Email address that the server includes in error
4348 messages sent to the client</td></tr>
4349 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ServerAdmin <var>email-address</var>|<var>URL</var></code></td></tr>
4350 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
4351 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4352 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4353 </table>
4354     <p>The <code class="directive">ServerAdmin</code> sets the contact address
4355     that the server includes in any error messages it returns to the
4356     client. If the <code>httpd</code> doesn't recognize the supplied argument
4357     as an URL, it
4358     assumes, that it's an <var>email-address</var> and prepends it with
4359     <code>mailto:</code> in hyperlink targets. However, it's recommended to
4360     actually use an email address, since there are a lot of CGI scripts that
4361     make that assumption. If you want to use an URL, it should point to another
4362     server under your control. Otherwise users may not be able to contact you in
4363     case of errors.</p>
4364
4365     <p>It may be worth setting up a dedicated address for this, e.g.</p>
4366
4367     <pre class="prettyprint lang-config">ServerAdmin www-admin@foo.example.com</pre>
4368
4369     <p>as users do not always mention that they are talking about the
4370     server!</p>
4371
4372 </div>
4373 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4374 <div class="directive-section"><h2><a name="ServerAlias" id="ServerAlias">ServerAlias</a> <a name="serveralias" id="serveralias">Directive</a></h2>
4375 <table class="directive">
4376 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Alternate names for a host used when matching requests
4377 to name-virtual hosts</td></tr>
4378 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ServerAlias <var>hostname</var> [<var>hostname</var>] ...</code></td></tr>
4379 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>virtual host</td></tr>
4380 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4381 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4382 </table>
4383     <p>The <code class="directive">ServerAlias</code> directive sets the
4384     alternate names for a host, for use with <a href="../vhosts/name-based.html">name-based virtual hosts</a>. The
4385     <code class="directive">ServerAlias</code> may include wildcards, if appropriate.</p>
4386
4387     <pre class="prettyprint lang-config">&lt;VirtualHost *:80&gt;
4388   ServerName server.example.com
4389   ServerAlias server server2.example.com server2
4390   ServerAlias *.example.com
4391   UseCanonicalName Off
4392   # ...
4393 &lt;/VirtualHost&gt;</pre>
4394
4395
4396     <p>Name-based virtual hosts for the best-matching set of  <code class="directive"><a href="#virtualhost">&lt;virtualhost&gt;</a></code>s are processed
4397     in the order they appear in the configuration.  The first matching <code class="directive"><a href="#servername">ServerName</a></code> or <code class="directive"><a href="#serveralias">ServerAlias</a></code> is used, with no different precedence for wildcards
4398     (nor for ServerName vs. ServerAlias).  </p>
4399
4400     <p>The complete list of names in the <code class="directive"><a href="#virtualhost">&lt;VirtualHost&gt;</a></code>
4401     directive are treated just like a (non wildcard)
4402     <code class="directive">ServerAlias</code>.</p>
4403
4404
4405 <h3>See also</h3>
4406 <ul>
4407 <li><code class="directive"><a href="#usecanonicalname">UseCanonicalName</a></code></li>
4408 <li><a href="../vhosts/">Apache HTTP Server Virtual Host documentation</a></li>
4409 </ul>
4410 </div>
4411 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4412 <div class="directive-section"><h2><a name="ServerName" id="ServerName">ServerName</a> <a name="servername" id="servername">Directive</a></h2>
4413 <table class="directive">
4414 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Hostname and port that the server uses to identify
4415 itself</td></tr>
4416 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ServerName [<var>scheme</var>://]<var>domain-name</var>|<var>ip-address</var>[:<var>port</var>]</code></td></tr>
4417 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
4418 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4419 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4420 </table>
4421     <p>The <code class="directive">ServerName</code> directive sets the
4422     request scheme, hostname and port that the server uses to identify itself.
4423     </p>
4424
4425     <p><code class="directive">ServerName</code> is used (possibly
4426     in conjunction with <code class="directive"><a href="#serveralias">ServerAlias</a></code>) to uniquely
4427     identify a virtual host, when using <a href="../vhosts/name-based.html">name-based virtual hosts</a>.</p>
4428
4429     <p>Additionally, this is used when
4430     creating self-referential redirection URLs when
4431     <code class="directive"><a href="#usecanonicalname">UseCanonicalName</a></code> is set to a non-default
4432     value.</p>
4433
4434     <p>For example, if the name of the
4435     machine hosting the web server is <code>simple.example.com</code>,
4436     but the machine also has the DNS alias <code>www.example.com</code>
4437     and you wish the web server to be so identified, the following
4438     directive should be used:</p>
4439
4440     <pre class="prettyprint lang-config">ServerName www.example.com</pre>
4441
4442
4443     <p>The <code class="directive">ServerName</code> directive
4444     may appear anywhere within the definition of a server. However,
4445     each appearance overrides the previous appearance (within that
4446     server).</p>
4447
4448     <p>If no <code class="directive">ServerName</code> is specified, the
4449     server attempts to deduce the client visible hostname by first asking
4450     the operating system for the system hostname, and if that fails,
4451     performing a reverse lookup on an IP address present on the system.</p>
4452
4453     <p>If no port is specified in the
4454     <code class="directive">ServerName</code>, then the server will use the
4455     port from the incoming request. For optimal reliability and
4456     predictability, you should specify an explicit hostname and port
4457     using the <code class="directive">ServerName</code> directive.</p>
4458
4459     <p>If you are using <a href="../vhosts/name-based.html">name-based virtual hosts</a>,
4460     the <code class="directive">ServerName</code> inside a
4461     <code class="directive"><a href="#virtualhost">&lt;VirtualHost&gt;</a></code>
4462     section specifies what hostname must appear in the request's
4463     <code>Host:</code> header to match this virtual host.</p>
4464
4465     <p>Sometimes, the server runs behind a device that processes SSL,
4466     such as a reverse proxy, load balancer or SSL offload
4467     appliance. When this is the case, specify the
4468     <code>https://</code> scheme and the port number to which the
4469     clients connect in the <code class="directive">ServerName</code> directive
4470     to make sure that the server generates the correct
4471     self-referential URLs.
4472     </p>
4473
4474     <p>See the description of the
4475     <code class="directive"><a href="#usecanonicalname">UseCanonicalName</a></code> and
4476     <code class="directive"><a href="#usecanonicalphysicalport">UseCanonicalPhysicalPort</a></code> directives for
4477     settings which determine whether self-referential URLs (e.g., by the
4478     <code class="module"><a href="../mod/mod_dir.html">mod_dir</a></code> module) will refer to the
4479     specified port, or to the port number given in the client's request.
4480     </p>
4481
4482     <div class="warning">
4483     <p>Failure to set <code class="directive">ServerName</code> to a name that
4484     your server can resolve to an IP address will result in a startup
4485     warning. <code>httpd</code> will then use whatever hostname it can
4486     determine, using the system's <code>hostname</code> command. This
4487     will almost never be the hostname you actually want.</p>
4488     <div class="example"><p><code>
4489     httpd: Could not reliably determine the server's fully qualified domain name, using rocinante.local for ServerName
4490     </code></p></div>
4491     </div>
4492
4493
4494 <h3>See also</h3>
4495 <ul>
4496 <li><a href="../dns-caveats.html">Issues Regarding DNS and
4497     Apache HTTP Server</a></li>
4498 <li><a href="../vhosts/">Apache HTTP Server virtual host
4499     documentation</a></li>
4500 <li><code class="directive"><a href="#usecanonicalname">UseCanonicalName</a></code></li>
4501 <li><code class="directive"><a href="#usecanonicalphysicalport">UseCanonicalPhysicalPort</a></code></li>
4502 <li><code class="directive"><a href="#serveralias">ServerAlias</a></code></li>
4503 </ul>
4504 </div>
4505 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4506 <div class="directive-section"><h2><a name="ServerPath" id="ServerPath">ServerPath</a> <a name="serverpath" id="serverpath">Directive</a></h2>
4507 <table class="directive">
4508 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Legacy URL pathname for a name-based virtual host that
4509 is accessed by an incompatible browser</td></tr>
4510 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ServerPath <var>URL-path</var></code></td></tr>
4511 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>virtual host</td></tr>
4512 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4513 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4514 </table>
4515     <p>The <code class="directive">ServerPath</code> directive sets the legacy
4516     URL pathname for a host, for use with <a href="../vhosts/">name-based virtual hosts</a>.</p>
4517
4518 <h3>See also</h3>
4519 <ul>
4520 <li><a href="../vhosts/">Apache HTTP Server Virtual Host documentation</a></li>
4521 </ul>
4522 </div>
4523 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4524 <div class="directive-section"><h2><a name="ServerRoot" id="ServerRoot">ServerRoot</a> <a name="serverroot" id="serverroot">Directive</a></h2>
4525 <table class="directive">
4526 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Base directory for the server installation</td></tr>
4527 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ServerRoot <var>directory-path</var></code></td></tr>
4528 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ServerRoot /usr/local/apache</code></td></tr>
4529 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
4530 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4531 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4532 </table>
4533     <p>The <code class="directive">ServerRoot</code> directive sets the
4534     directory in which the server lives. Typically it will contain the
4535     subdirectories <code>conf/</code> and <code>logs/</code>. Relative
4536     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
4537     relative to this directory.</p>
4538
4539     <pre class="prettyprint lang-config">ServerRoot "/home/httpd"</pre>
4540
4541
4542     <p>The default location of <code class="directive">ServerRoot</code> may be
4543     modified by using the <code>--prefix</code> argument to
4544     <a href="../programs/configure.html"><code>configure</code></a>, and
4545     most third-party distributions of the server have a different
4546     default location from the one listed above.</p>
4547
4548
4549 <h3>See also</h3>
4550 <ul>
4551 <li><a href="../invoking.html">the <code>-d</code>
4552     option to <code>httpd</code></a></li>
4553 <li><a href="../misc/security_tips.html#serverroot">the
4554     security tips</a> for information on how to properly set
4555     permissions on the <code class="directive">ServerRoot</code></li>
4556 </ul>
4557 </div>
4558 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4559 <div class="directive-section"><h2><a name="ServerSignature" id="ServerSignature">ServerSignature</a> <a name="serversignature" id="serversignature">Directive</a></h2>
4560 <table class="directive">
4561 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures the footer on server-generated documents</td></tr>
4562 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ServerSignature On|Off|EMail</code></td></tr>
4563 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ServerSignature Off</code></td></tr>
4564 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
4565 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
4566 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4567 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4568 </table>
4569     <p>The <code class="directive">ServerSignature</code> directive allows the
4570     configuration of a trailing footer line under server-generated
4571     documents (error messages, <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> ftp directory
4572     listings, <code class="module"><a href="../mod/mod_info.html">mod_info</a></code> output, ...). The reason why you
4573     would want to enable such a footer line is that in a chain of proxies,
4574     the user often has no possibility to tell which of the chained servers
4575     actually produced a returned error message.</p>
4576
4577     <p>The <code>Off</code>
4578     setting, which is the default, suppresses the footer line (and is
4579     therefore compatible with the behavior of Apache-1.2 and
4580     below). The <code>On</code> setting simply adds a line with the
4581     server version number and <code class="directive"><a href="#servername">ServerName</a></code> of the serving virtual host,
4582     and the <code>EMail</code> setting additionally creates a
4583     "mailto:" reference to the <code class="directive"><a href="#serveradmin">ServerAdmin</a></code> of the referenced
4584     document.</p>
4585
4586     <p>After version 2.0.44, the details of the server version number
4587     presented are controlled by the <code class="directive"><a href="#servertokens">ServerTokens</a></code> directive.</p>
4588
4589 <h3>See also</h3>
4590 <ul>
4591 <li><code class="directive"><a href="#servertokens">ServerTokens</a></code></li>
4592 </ul>
4593 </div>
4594 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4595 <div class="directive-section"><h2><a name="ServerTokens" id="ServerTokens">ServerTokens</a> <a name="servertokens" id="servertokens">Directive</a></h2>
4596 <table class="directive">
4597 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures the <code>Server</code> HTTP response
4598 header</td></tr>
4599 <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>
4600 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ServerTokens Full</code></td></tr>
4601 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
4602 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4603 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4604 </table>
4605     <p>This directive controls whether <code>Server</code> response
4606     header field which is sent back to clients includes a
4607     description of the generic OS-type of the server as well as
4608     information about compiled-in modules.</p>
4609
4610     <dl>
4611       <dt><code>ServerTokens Full</code> (or not specified)</dt>
4612
4613       <dd>Server sends (<em>e.g.</em>): <code>Server: Apache/2.4.2
4614       (Unix) PHP/4.2.2 MyMod/1.2</code></dd>
4615
4616       <dt><code>ServerTokens Prod[uctOnly]</code></dt>
4617
4618       <dd>Server sends (<em>e.g.</em>): <code>Server:
4619       Apache</code></dd>
4620
4621       <dt><code>ServerTokens Major</code></dt>
4622
4623       <dd>Server sends (<em>e.g.</em>): <code>Server:
4624       Apache/2</code></dd>
4625
4626       <dt><code>ServerTokens Minor</code></dt>
4627
4628       <dd>Server sends (<em>e.g.</em>): <code>Server:
4629       Apache/2.4</code></dd>
4630
4631       <dt><code>ServerTokens Min[imal]</code></dt>
4632
4633       <dd>Server sends (<em>e.g.</em>): <code>Server:
4634       Apache/2.4.2</code></dd>
4635
4636       <dt><code>ServerTokens OS</code></dt>
4637
4638       <dd>Server sends (<em>e.g.</em>): <code>Server: Apache/2.4.2
4639       (Unix)</code></dd>
4640
4641     </dl>
4642
4643     <p>This setting applies to the entire server, and cannot be
4644     enabled or disabled on a virtualhost-by-virtualhost basis.</p>
4645
4646     <p>After version 2.0.44, this directive also controls the
4647     information presented by the <code class="directive"><a href="#serversignature">ServerSignature</a></code> directive.</p>
4648
4649     <div class="note">Setting <code class="directive">ServerTokens</code> to less than
4650     <code>minimal</code> is not recommended because it makes it more
4651     difficult to debug interoperational problems. Also note that
4652     disabling the Server: header does nothing at all to make your
4653     server more secure. The idea of "security through obscurity"
4654     is a myth and leads to a false sense of safety.</div>
4655
4656 <h3>See also</h3>
4657 <ul>
4658 <li><code class="directive"><a href="#serversignature">ServerSignature</a></code></li>
4659 </ul>
4660 </div>
4661 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4662 <div class="directive-section"><h2><a name="SetHandler" id="SetHandler">SetHandler</a> <a name="sethandler" id="sethandler">Directive</a></h2>
4663 <table class="directive">
4664 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Forces all matching files to be processed by a
4665 handler</td></tr>
4666 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SetHandler <var>handler-name</var>|none|<var>expression</var></code></td></tr>
4667 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
4668 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
4669 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4670 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4671 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>2.5 and later</td></tr>
4672 </table>
4673     <p>When placed into an <code>.htaccess</code> file or a
4674     <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code> or
4675     <code class="directive"><a href="#location">&lt;Location&gt;</a></code>
4676     section, this directive forces all matching files to be parsed
4677     through the <a href="../handler.html">handler</a> given by
4678     <var>handler-name</var>. For example, if you had a directory you
4679     wanted to be parsed entirely as imagemap rule files, regardless
4680     of extension, you might put the following into an
4681     <code>.htaccess</code> file in that directory:</p>
4682
4683     <pre class="prettyprint lang-config">SetHandler imap-file</pre>
4684
4685
4686     <p>Another example: if you wanted to have the server display a
4687     status report whenever a URL of
4688     <code>http://servername/status</code> was called, you might put
4689     the following into <code>httpd.conf</code>:</p>
4690
4691     <pre class="prettyprint lang-config">&lt;Location "/status"&gt;
4692   SetHandler server-status
4693 &lt;/Location&gt;</pre>
4694
4695
4696     <p>You could also use this directive to configure a particular
4697     handler for files with a particular file extension. For example:</p>
4698
4699     <pre class="prettyprint lang-config">&lt;FilesMatch "\.php$"&gt;
4700     SetHandler application/x-httpd-php
4701 &lt;/FilesMatch&gt;</pre>
4702
4703
4704     <p>String-valued expressions can be used to reference per-request
4705     variables, including backreferences to named regular expressions:</p>
4706
4707     <pre class="prettyprint lang-config">&lt;LocationMatch ^/app/(?&lt;sub&gt;[^/]+)/&gt;
4708      SetHandler "proxy:unix:/var/run/app_%{env:MATCH_sub}.sock|fcgi://localhost:8080"
4709 &lt;/LocationMatch&gt;</pre>
4710
4711
4712     <p>You can override an earlier defined <code class="directive">SetHandler</code>
4713     directive by using the value <code>None</code>.</p>
4714
4715     <div class="note"><h3>Note</h3>
4716     <p>Because <code class="directive">SetHandler</code> overrides default handlers,
4717     normal behavior such as handling of URLs ending in a slash (/) as
4718     directories or index files is suppressed.</p></div>
4719
4720 <h3>See also</h3>
4721 <ul>
4722 <li><code class="directive"><a href="../mod/mod_mime.html#addhandler">AddHandler</a></code></li>
4723 </ul>
4724 </div>
4725 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4726 <div class="directive-section"><h2><a name="SetInputFilter" id="SetInputFilter">SetInputFilter</a> <a name="setinputfilter" id="setinputfilter">Directive</a></h2>
4727 <table class="directive">
4728 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the filters that will process client requests and POST
4729 input</td></tr>
4730 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SetInputFilter <var>filter</var>[;<var>filter</var>...]</code></td></tr>
4731 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
4732 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
4733 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4734 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4735 </table>
4736     <p>The <code class="directive">SetInputFilter</code> directive sets the
4737     filter or filters which will process client requests and POST
4738     input when they are received by the server. This is in addition to
4739     any filters defined elsewhere, including the
4740     <code class="directive"><a href="../mod/mod_mime.html#addinputfilter">AddInputFilter</a></code>
4741     directive.</p>
4742
4743     <p>If more than one filter is specified, they must be separated
4744     by semicolons in the order in which they should process the
4745     content.</p>
4746
4747 <h3>See also</h3>
4748 <ul>
4749 <li><a href="../filter.html">Filters</a> documentation</li>
4750 </ul>
4751 </div>
4752 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4753 <div class="directive-section"><h2><a name="SetOutputFilter" id="SetOutputFilter">SetOutputFilter</a> <a name="setoutputfilter" id="setoutputfilter">Directive</a></h2>
4754 <table class="directive">
4755 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the filters that will process responses from the
4756 server</td></tr>
4757 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SetOutputFilter <var>filter</var>[;<var>filter</var>...]</code></td></tr>
4758 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
4759 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
4760 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4761 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4762 </table>
4763     <p>The <code class="directive">SetOutputFilter</code> directive sets the filters
4764     which will process responses from the server before they are
4765     sent to the client. This is in addition to any filters defined
4766     elsewhere, including the
4767     <code class="directive"><a href="../mod/mod_mime.html#addoutputfilter">AddOutputFilter</a></code>
4768     directive.</p>
4769
4770     <p>For example, the following configuration will process all files
4771     in the <code>/www/data/</code> directory for server-side
4772     includes.</p>
4773
4774     <pre class="prettyprint lang-config">&lt;Directory "/www/data/"&gt;
4775   SetOutputFilter INCLUDES
4776 &lt;/Directory&gt;</pre>
4777
4778
4779     <p>If more than one filter is specified, they must be separated
4780     by semicolons in the order in which they should process the
4781     content.</p>
4782
4783 <h3>See also</h3>
4784 <ul>
4785 <li><a href="../filter.html">Filters</a> documentation</li>
4786 </ul>
4787 </div>
4788 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4789 <div class="directive-section"><h2><a name="TimeOut" id="TimeOut">TimeOut</a> <a name="timeout" id="timeout">Directive</a></h2>
4790 <table class="directive">
4791 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Amount of time the server will wait for
4792 certain events before failing a request</td></tr>
4793 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>TimeOut <var>time-interval</var>[s]</code></td></tr>
4794 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>TimeOut 60</code></td></tr>
4795 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
4796 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4797 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4798 </table>
4799     <p>The <code class="directive">TimeOut</code> directive defines the length
4800     of time Apache httpd will wait for I/O in various circumstances:</p>
4801
4802     <ul>
4803       <li><p>When reading data from the client, the length of time to
4804       wait for a TCP packet to arrive if the read buffer is
4805       empty.</p>
4806       <p> For initial data on a new connection, this directive doesn't
4807       take effect until after any configured <code class="directive"><a href="#acceptfilter">
4808       AcceptFilter</a></code> has passed the new connection to the server.</p>
4809       </li>
4810
4811       <li>When writing data to the client, the length of time to wait
4812       for an acknowledgement of a packet if the send buffer is
4813       full.</li>
4814
4815       <li>In <code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code> and <code class="module"><a href="../mod/mod_cgid.html">mod_cgid</a></code>,
4816       the length of time to wait for any individual block of output
4817       from a CGI script.</li>
4818
4819       <li>In <code class="module"><a href="../mod/mod_ext_filter.html">mod_ext_filter</a></code>, the length of time to
4820       wait for output from a filtering process.</li>
4821
4822       <li>In <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>, the default timeout value if
4823       <code class="directive"><a href="../mod/mod_proxy.html#proxytimeout">ProxyTimeout</a></code> is not
4824       configured.</li>
4825     </ul>
4826
4827
4828 </div>
4829 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4830 <div class="directive-section"><h2><a name="TraceEnable" id="TraceEnable">TraceEnable</a> <a name="traceenable" id="traceenable">Directive</a></h2>
4831 <table class="directive">
4832 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Determines the behavior on <code>TRACE</code> requests</td></tr>
4833 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>TraceEnable <var>[on|off|extended]</var></code></td></tr>
4834 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>TraceEnable on</code></td></tr>
4835 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
4836 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4837 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4838 </table>
4839     <p>This directive overrides the behavior of <code>TRACE</code> for both
4840     the core server and <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>.  The default
4841     <code>TraceEnable on</code> permits <code>TRACE</code> requests per
4842     RFC 2616, which disallows any request body to accompany the request.
4843     <code>TraceEnable off</code> causes the core server and
4844     <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> to return a <code>405</code> (Method not
4845     allowed) error to the client.</p>
4846
4847     <p>Finally, for testing and diagnostic purposes only, request
4848     bodies may be allowed using the non-compliant <code>TraceEnable
4849     extended</code> directive.  The core (as an origin server) will
4850     restrict the request body to 64Kb (plus 8Kb for chunk headers if
4851     <code>Transfer-Encoding: chunked</code> is used).  The core will
4852     reflect the full headers and all chunk headers with the response
4853     body.  As a proxy server, the request body is not restricted to 64Kb.</p>
4854
4855     <div class="note"><h3>Note</h3>
4856
4857     <p>Despite claims to the contrary, enabling the <code>TRACE</code>
4858     method does not expose any security vulnerability in Apache httpd.
4859     The <code>TRACE</code> method is defined by the HTTP/1.1
4860     specification and implementations are expected to support it.</p>
4861
4862     </div>
4863
4864 </div>
4865 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4866 <div class="directive-section"><h2><a name="UnDefine" id="UnDefine">UnDefine</a> <a name="undefine" id="undefine">Directive</a></h2>
4867 <table class="directive">
4868 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Undefine the existence of a variable</td></tr>
4869 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>UnDefine <var>parameter-name</var></code></td></tr>
4870 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
4871 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4872 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4873 </table>
4874     <p>Undoes the effect of a <code class="directive"><a href="#define">Define</a></code> or
4875     of passing a <code>-D</code> argument to <code class="program"><a href="../programs/httpd.html">httpd</a></code>.</p>
4876     <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
4877     <code>-D</code> arguments in any startup scripts.</p>
4878     <p>While this directive is supported in virtual host context,
4879        the changes it makes are visible to any later configuration
4880        directives, beyond any enclosing virtual host.</p>
4881
4882 <h3>See also</h3>
4883 <ul>
4884 <li><code class="directive"><a href="#define">Define</a></code></li>
4885 <li><code class="directive"><a href="#ifdefine">IfDefine</a></code></li>
4886 </ul>
4887 </div>
4888 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4889 <div class="directive-section"><h2><a name="UseCanonicalName" id="UseCanonicalName">UseCanonicalName</a> <a name="usecanonicalname" id="usecanonicalname">Directive</a></h2>
4890 <table class="directive">
4891 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures how the server determines its own name and
4892 port</td></tr>
4893 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>UseCanonicalName On|Off|DNS</code></td></tr>
4894 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>UseCanonicalName Off</code></td></tr>
4895 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
4896 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4897 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4898 </table>
4899     <p>In many situations Apache httpd must construct a <em>self-referential</em>
4900     URL -- that is, a URL that refers back to the same server. With
4901     <code>UseCanonicalName On</code> Apache httpd will use the hostname and port
4902     specified in the <code class="directive"><a href="#servername">ServerName</a></code>
4903     directive to construct the canonical name for the server. This name
4904     is used in all self-referential URLs, and for the values of
4905     <code>SERVER_NAME</code> and <code>SERVER_PORT</code> in CGIs.</p>
4906
4907     <p>With <code>UseCanonicalName Off</code> Apache httpd will form
4908     self-referential URLs using the hostname and port supplied by
4909     the client if any are supplied (otherwise it will use the
4910     canonical name, as defined above). These values are the same
4911     that are used to implement <a href="../vhosts/name-based.html">name-based virtual hosts</a>
4912     and are available with the same clients. The CGI variables
4913     <code>SERVER_NAME</code> and <code>SERVER_PORT</code> will be
4914     constructed from the client supplied values as well.</p>
4915
4916     <p>An example where this may be useful is on an intranet server
4917     where you have users connecting to the machine using short
4918     names such as <code>www</code>. You'll notice that if the users
4919     type a shortname and a URL which is a directory, such as
4920     <code>http://www/splat</code>, <em>without the trailing
4921     slash</em>, then Apache httpd will redirect them to
4922     <code>http://www.example.com/splat/</code>. If you have
4923     authentication enabled, this will cause the user to have to
4924     authenticate twice (once for <code>www</code> and once again
4925     for <code>www.example.com</code> -- see <a href="http://wiki.apache.org/httpd/FAQ#Why_does_Apache_ask_for_my_password_twice_before_serving_a_file.3F">
4926     the FAQ on this subject for more information</a>). But if
4927     <code class="directive">UseCanonicalName</code> is set <code>Off</code>, then
4928     Apache httpd will redirect to <code>http://www/splat/</code>.</p>
4929
4930     <p>There is a third option, <code>UseCanonicalName DNS</code>,
4931     which is intended for use with mass IP-based virtual hosting to
4932     support ancient clients that do not provide a
4933     <code>Host:</code> header. With this option, Apache httpd does a
4934     reverse DNS lookup on the server IP address that the client
4935     connected to in order to work out self-referential URLs.</p>
4936
4937     <div class="warning"><h3>Warning</h3>
4938     <p>If CGIs make assumptions about the values of <code>SERVER_NAME</code>,
4939     they may be broken by this option. The client is essentially free
4940     to give whatever value they want as a hostname. But if the CGI is
4941     only using <code>SERVER_NAME</code> to construct self-referential URLs,
4942     then it should be just fine.</p>
4943     </div>
4944
4945 <h3>See also</h3>
4946 <ul>
4947 <li><code class="directive"><a href="#usecanonicalphysicalport">UseCanonicalPhysicalPort</a></code></li>
4948 <li><code class="directive"><a href="#servername">ServerName</a></code></li>
4949 <li><code class="directive"><a href="../mod/mpm_common.html#listen">Listen</a></code></li>
4950 </ul>
4951 </div>
4952 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4953 <div class="directive-section"><h2><a name="UseCanonicalPhysicalPort" id="UseCanonicalPhysicalPort">UseCanonicalPhysicalPort</a> <a name="usecanonicalphysicalport" id="usecanonicalphysicalport">Directive</a></h2>
4954 <table class="directive">
4955 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures how the server determines its own port</td></tr>
4956 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>UseCanonicalPhysicalPort On|Off</code></td></tr>
4957 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>UseCanonicalPhysicalPort Off</code></td></tr>
4958 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
4959 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4960 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4961 </table>
4962     <p>In many situations Apache httpd must construct a <em>self-referential</em>
4963     URL -- that is, a URL that refers back to the same server. With
4964     <code>UseCanonicalPhysicalPort On</code>, Apache httpd will, when
4965     constructing the canonical port for the server to honor
4966     the <code class="directive"><a href="#usecanonicalname">UseCanonicalName</a></code> directive,
4967     provide the actual physical port number being used by this request
4968     as a potential port. With <code>UseCanonicalPhysicalPort Off</code>,
4969     Apache httpd will not ever use the actual physical port number, instead
4970     relying on all configured information to construct a valid port number.</p>
4971
4972     <div class="note"><h3>Note</h3>
4973     <p>The ordering of the lookup when the physical port is used is as
4974     follows:</p>
4975      <dl>
4976      <dt><code>UseCanonicalName Off | DNS</code></dt>
4977      <dd>
4978      <ol>
4979       <li>Parsed port from <code>Host:</code> header</li>
4980       <li>Physical port (only with <code class="directive">UseCanonicalPhysicalPort</code> ON)</li>
4981       <li>Port provided in <code class="directive"><a href="#servername">Servername</a></code></li>
4982       <li>Default port</li>
4983      </ol>
4984      </dd>
4985      <dt><code>UseCanonicalName On</code></dt>
4986      <dd>
4987      <ol>
4988       <li>Port provided in <code class="directive"><a href="#servername">Servername</a></code></li>
4989       <li>Physical port (only with <code class="directive">UseCanonicalPhysicalPort</code> ON)</li>
4990       <li>Default port</li>
4991      </ol>
4992      </dd>
4993     </dl>
4994
4995     <p>Only with <code>UseCanonicalPhysicalPort On</code>, the
4996     physical ports are included in the search.</p>
4997     </div>
4998
4999
5000 <h3>See also</h3>
5001 <ul>
5002 <li><code class="directive"><a href="#usecanonicalname">UseCanonicalName</a></code></li>
5003 <li><code class="directive"><a href="#servername">ServerName</a></code></li>
5004 <li><code class="directive"><a href="../mod/mpm_common.html#listen">Listen</a></code></li>
5005 </ul>
5006 </div>
5007 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
5008 <div class="directive-section"><h2><a name="VirtualHost" id="VirtualHost">&lt;VirtualHost&gt;</a> <a name="virtualhost" id="virtualhost">Directive</a></h2>
5009 <table class="directive">
5010 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Contains directives that apply only to a specific
5011 hostname or IP address</td></tr>
5012 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;VirtualHost
5013     <var>addr</var>[:<var>port</var>] [<var>addr</var>[:<var>port</var>]]
5014     ...&gt; ... &lt;/VirtualHost&gt;</code></td></tr>
5015 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
5016 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
5017 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
5018 </table>
5019     <p><code class="directive">&lt;VirtualHost&gt;</code> and
5020     <code>&lt;/VirtualHost&gt;</code> are used to enclose a group of
5021     directives that will apply only to a particular virtual host. Any
5022     directive that is allowed in a virtual host context may be
5023     used. When the server receives a request for a document on a
5024     particular virtual host, it uses the configuration directives
5025     enclosed in the <code class="directive">&lt;VirtualHost&gt;</code>
5026     section. <var>Addr</var> can be any of the following, optionally followed by
5027     a colon and a port number (or *):</p>
5028
5029     <ul>
5030       <li>The IP address of the virtual host;</li>
5031
5032       <li>A fully qualified domain name for the IP address of the
5033       virtual host (not recommended);</li>
5034
5035       <li>The character <code>*</code>, which acts as a wildcard and matches
5036       any IP address.</li>
5037
5038       <li>The string <code>_default_</code>, which is an alias for <code>*</code></li>
5039
5040     </ul>
5041
5042     <pre class="prettyprint lang-config">&lt;VirtualHost 10.1.2.3:80&gt;
5043   ServerAdmin webmaster@host.example.com
5044   DocumentRoot "/www/docs/host.example.com"
5045   ServerName host.example.com
5046   ErrorLog "logs/host.example.com-error_log"
5047   TransferLog "logs/host.example.com-access_log"
5048 &lt;/VirtualHost&gt;</pre>
5049
5050
5051
5052     <p>IPv6 addresses must be specified in square brackets because
5053     the optional port number could not be determined otherwise.  An
5054     IPv6 example is shown below:</p>
5055
5056     <pre class="prettyprint lang-config">&lt;VirtualHost [2001:db8::a00:20ff:fea7:ccea]:80&gt;
5057   ServerAdmin webmaster@host.example.com
5058   DocumentRoot "/www/docs/host.example.com"
5059   ServerName host.example.com
5060   ErrorLog "logs/host.example.com-error_log"
5061   TransferLog "logs/host.example.com-access_log"
5062 &lt;/VirtualHost&gt;</pre>
5063
5064
5065     <p>Each Virtual Host must correspond to a different IP address,
5066     different port number, or a different host name for the server,
5067     in the former case the server machine must be configured to
5068     accept IP packets for multiple addresses. (If the machine does
5069     not have multiple network interfaces, then this can be
5070     accomplished with the <code>ifconfig alias</code> command -- if
5071     your OS supports it).</p>
5072
5073     <div class="note"><h3>Note</h3>
5074     <p>The use of <code class="directive">&lt;VirtualHost&gt;</code> does
5075     <strong>not</strong> affect what addresses Apache httpd listens on. You
5076     may need to ensure that Apache httpd is listening on the correct addresses
5077     using <code class="directive"><a href="../mod/mpm_common.html#listen">Listen</a></code>.</p>
5078     </div>
5079
5080     <p>A <code class="directive"><a href="#servername">ServerName</a></code> should be
5081     specified inside each <code class="directive">&lt;VirtualHost&gt;</code> block. If it is absent, the
5082     <code class="directive"><a href="#servername">ServerName</a></code> from the "main"
5083     server configuration will be inherited.</p>
5084
5085     <p>When a request is received, the server first maps it to the best matching
5086     <code class="directive">&lt;VirtualHost&gt;</code> based on the local
5087     IP address and port combination only.  Non-wildcards have a higher
5088     precedence. If no match based on IP and port occurs at all, the
5089     "main" server configuration is used.</p>
5090
5091     <p>If multiple virtual hosts contain the best matching IP address and port,
5092     the server selects from these virtual hosts the best match based on the
5093     requested hostname.  If no matching name-based virtual host is found,
5094     then the first listed virtual host that matched the IP address will be
5095     used.  As a consequence, the first listed virtual host for a given IP address
5096     and port combination is the default virtual host for that IP and port
5097     combination.</p>
5098
5099     <div class="warning"><h3>Security</h3>
5100     <p>See the <a href="../misc/security_tips.html">security tips</a>
5101     document for details on why your security could be compromised if the
5102     directory where log files are stored is writable by anyone other
5103     than the user that starts the server.</p>
5104     </div>
5105
5106 <h3>See also</h3>
5107 <ul>
5108 <li><a href="../vhosts/">Apache HTTP Server Virtual Host documentation</a></li>
5109 <li><a href="../dns-caveats.html">Issues Regarding DNS and
5110     Apache HTTP Server</a></li>
5111 <li><a href="../bind.html">Setting
5112     which addresses and ports Apache HTTP Server uses</a></li>
5113 <li><a href="../sections.html">How &lt;Directory&gt;, &lt;Location&gt;
5114     and &lt;Files&gt; sections work</a> for an explanation of how these
5115     different sections are combined when a request is received</li>
5116 </ul>
5117 </div>
5118 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
5119 <div class="directive-section"><h2><a name="Warning" id="Warning">Warning</a> <a name="warning" id="warning">Directive</a></h2>
5120 <table class="directive">
5121 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Warn from configuration parsing with a custom message</td></tr>
5122 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Warning <var>message</var></code></td></tr>
5123 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
5124 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
5125 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
5126 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
5127 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>2.5 and later</td></tr>
5128 </table>
5129     <p>If an issue can be detected from within the configuration, this
5130     directive can be used to generate a custom warning message. The
5131     configuration parsing is not halted. The typical use is to check
5132     whether some user define options are set, and warn if not.</p>
5133
5134     <pre class="prettyprint lang-config"># Example
5135 # tell when ReverseProxy is not set
5136 &lt;IfDefine !ReverseProxy&gt;
5137   Warning "reverse proxy is not started, hope this is okay!"
5138 &lt;/IfDefine&gt;
5139
5140 &lt;IfDefine ReverseProxy&gt;
5141   # define custom proxy configuration
5142 &lt;/IfDefine&gt;</pre>
5143
5144
5145
5146 </div>
5147 </div>
5148 <div class="bottomlang">
5149 <p><span>Available Languages: </span><a href="../de/mod/core.html" hreflang="de" rel="alternate" title="Deutsch">&nbsp;de&nbsp;</a> |
5150 <a href="../en/mod/core.html" title="English">&nbsp;en&nbsp;</a> |
5151 <a href="../es/mod/core.html" hreflang="es" rel="alternate" title="Español">&nbsp;es&nbsp;</a> |
5152 <a href="../fr/mod/core.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
5153 <a href="../ja/mod/core.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
5154 <a href="../tr/mod/core.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
5155 </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&amp;A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
5156 <script type="text/javascript"><!--//--><![CDATA[//><!--
5157 var comments_shortname = 'httpd';
5158 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/core.html';
5159 (function(w, d) {
5160     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
5161         d.write('<div id="comments_thread"><\/div>');
5162         var s = d.createElement('script');
5163         s.type = 'text/javascript';
5164         s.async = true;
5165         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
5166         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
5167     }
5168     else {
5169         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
5170     }
5171 })(window, document);
5172 //--><!]]></script></div><div id="footer">
5173 <p class="apache">Copyright 2018 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>
5174 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
5175 if (typeof(prettyPrint) !== 'undefined') {
5176     prettyPrint();
5177 }
5178 //--><!]]></script>
5179 </body></html>