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="#iffile">&lt;IfFile&gt;</a></li>
  79 <li><img alt="" src="../images/down.gif" /> <a href="#ifmodule">&lt;IfModule&gt;</a></li>
  80 <li><img alt="" src="../images/down.gif" /> <a href="#include">Include</a></li>
  81 <li><img alt="" src="../images/down.gif" /> <a href="#includeoptional">IncludeOptional</a></li>
  82 <li><img alt="" src="../images/down.gif" /> <a href="#keepalive">KeepAlive</a></li>
  83 <li><img alt="" src="../images/down.gif" /> <a href="#keepalivetimeout">KeepAliveTimeout</a></li>
  84 <li><img alt="" src="../images/down.gif" /> <a href="#limit">&lt;Limit&gt;</a></li>
  85 <li><img alt="" src="../images/down.gif" /> <a href="#limitexcept">&lt;LimitExcept&gt;</a></li>
  86 <li><img alt="" src="../images/down.gif" /> <a href="#limitinternalrecursion">LimitInternalRecursion</a></li>
  87 <li><img alt="" src="../images/down.gif" /> <a href="#limitrequestbody">LimitRequestBody</a></li>
  88 <li><img alt="" src="../images/down.gif" /> <a href="#limitrequestfields">LimitRequestFields</a></li>
  89 <li><img alt="" src="../images/down.gif" /> <a href="#limitrequestfieldsize">LimitRequestFieldSize</a></li>
  90 <li><img alt="" src="../images/down.gif" /> <a href="#limitrequestline">LimitRequestLine</a></li>
  91 <li><img alt="" src="../images/down.gif" /> <a href="#limitxmlrequestbody">LimitXMLRequestBody</a></li>
  92 <li><img alt="" src="../images/down.gif" /> <a href="#location">&lt;Location&gt;</a></li>
  93 <li><img alt="" src="../images/down.gif" /> <a href="#locationmatch">&lt;LocationMatch&gt;</a></li>
  94 <li><img alt="" src="../images/down.gif" /> <a href="#loglevel">LogLevel</a></li>
  95 <li><img alt="" src="../images/down.gif" /> <a href="#logleveloverride">LogLevelOverride</a></li>
  96 <li><img alt="" src="../images/down.gif" /> <a href="#maxkeepaliverequests">MaxKeepAliveRequests</a></li>
  97 <li><img alt="" src="../images/down.gif" /> <a href="#maxrangeoverlaps">MaxRangeOverlaps</a></li>
  98 <li><img alt="" src="../images/down.gif" /> <a href="#maxrangereversals">MaxRangeReversals</a></li>
  99 <li><img alt="" src="../images/down.gif" /> <a href="#maxranges">MaxRanges</a></li>
 100 <li><img alt="" src="../images/down.gif" /> <a href="#mergetrailers">MergeTrailers</a></li>
 101 <li><img alt="" src="../images/down.gif" /> <a href="#mutex">Mutex</a></li>
 102 <li><img alt="" src="../images/down.gif" /> <a href="#namevirtualhost">NameVirtualHost</a></li>
 103 <li><img alt="" src="../images/down.gif" /> <a href="#options">Options</a></li>
 104 <li><img alt="" src="../images/down.gif" /> <a href="#protocol">Protocol</a></li>
 105 <li><img alt="" src="../images/down.gif" /> <a href="#protocols">Protocols</a></li>
 106 <li><img alt="" src="../images/down.gif" /> <a href="#protocolshonororder">ProtocolsHonorOrder</a></li>
 107 <li><img alt="" src="../images/down.gif" /> <a href="#qualifyredirecturl">QualifyRedirectURL</a></li>
 108 <li><img alt="" src="../images/down.gif" /> <a href="#registerhttpmethod">RegisterHttpMethod</a></li>
 109 <li><img alt="" src="../images/down.gif" /> <a href="#rlimitcpu">RLimitCPU</a></li>
 110 <li><img alt="" src="../images/down.gif" /> <a href="#rlimitmem">RLimitMEM</a></li>
 111 <li><img alt="" src="../images/down.gif" /> <a href="#rlimitnproc">RLimitNPROC</a></li>
 112 <li><img alt="" src="../images/down.gif" /> <a href="#scriptinterpretersource">ScriptInterpreterSource</a></li>
 113 <li><img alt="" src="../images/down.gif" /> <a href="#seerequesttail">SeeRequestTail</a></li>
 114 <li><img alt="" src="../images/down.gif" /> <a href="#serveradmin">ServerAdmin</a></li>
 115 <li><img alt="" src="../images/down.gif" /> <a href="#serveralias">ServerAlias</a></li>
 116 <li><img alt="" src="../images/down.gif" /> <a href="#servername">ServerName</a></li>
 117 <li><img alt="" src="../images/down.gif" /> <a href="#serverpath">ServerPath</a></li>
 118 <li><img alt="" src="../images/down.gif" /> <a href="#serverroot">ServerRoot</a></li>
 119 <li><img alt="" src="../images/down.gif" /> <a href="#serversignature">ServerSignature</a></li>
 120 <li><img alt="" src="../images/down.gif" /> <a href="#servertokens">ServerTokens</a></li>
 121 <li><img alt="" src="../images/down.gif" /> <a href="#sethandler">SetHandler</a></li>
 122 <li><img alt="" src="../images/down.gif" /> <a href="#setinputfilter">SetInputFilter</a></li>
 123 <li><img alt="" src="../images/down.gif" /> <a href="#setoutputfilter">SetOutputFilter</a></li>
 124 <li><img alt="" src="../images/down.gif" /> <a href="#timeout">TimeOut</a></li>
 125 <li><img alt="" src="../images/down.gif" /> <a href="#traceenable">TraceEnable</a></li>
 126 <li><img alt="" src="../images/down.gif" /> <a href="#undefine">UnDefine</a></li>
 127 <li><img alt="" src="../images/down.gif" /> <a href="#usecanonicalname">UseCanonicalName</a></li>
 128 <li><img alt="" src="../images/down.gif" /> <a href="#usecanonicalphysicalport">UseCanonicalPhysicalPort</a></li>
 129 <li><img alt="" src="../images/down.gif" /> <a href="#virtualhost">&lt;VirtualHost&gt;</a></li>
 130 <li><img alt="" src="../images/down.gif" /> <a href="#warning">Warning</a></li>
 131 </ul>
 132 <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>
 133 <ul class="seealso">
 134 <li><a href="#comments_section">Comments</a></li></ul></div>
 135
 136 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 137 <div class="directive-section"><h2><a name="AcceptFilter" id="AcceptFilter">AcceptFilter</a> <a name="acceptfilter" id="acceptfilter">Directive</a></h2>
 138 <table class="directive">
 139 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures optimizations for a Protocol's Listener Sockets</td></tr>
 140 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AcceptFilter <var>protocol</var> <var>accept_filter</var></code></td></tr>
 141 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 142 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
 143 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
 144 </table>
 145     <p>This directive enables operating system specific optimizations for a
 146        listening socket by the <code class="directive">Protocol</code> type.
 147        The basic premise is for the kernel to not send a socket to the server
 148        process until either data is received or an entire HTTP Request is buffered.
 149        Only <a href="http://www.freebsd.org/cgi/man.cgi?query=accept_filter&amp;sektion=9">
 150        FreeBSD's Accept Filters</a>, Linux's more primitive
 151        <code>TCP_DEFER_ACCEPT</code>, and Windows' optimized AcceptEx()
 152        are currently supported.</p>
 153
 154     <p>Using <code>none</code> for an argument will disable any accept filters
 155        for that protocol.  This is useful for protocols that require a server
 156        send data first, such as <code>ftp:</code> or <code>nntp</code>:</p>
 157     <pre class="prettyprint lang-config">AcceptFilter nntp none</pre>
 158
 159
 160     <p>The default protocol names are <code>https</code> for port 443
 161        and <code>http</code> for all other ports.  To specify that another
 162        protocol is being used with a listening port, add the <var>protocol</var>
 163        argument to the <code class="directive"><a href="../mod/mpm_common.html#listen">Listen</a></code>
 164        directive.</p>
 165
 166     <p>The default values on FreeBSD are:</p>
 167     <pre class="prettyprint lang-config">AcceptFilter http httpready
 168 AcceptFilter https dataready</pre>
 169
 170
 171     <p>The <code>httpready</code> accept filter buffers entire HTTP requests at
 172        the kernel level.  Once an entire request is received, the kernel then
 173        sends it to the server. See the
 174        <a href="http://www.freebsd.org/cgi/man.cgi?query=accf_http&amp;sektion=9">
 175        accf_http(9)</a> man page for more details.  Since HTTPS requests are
 176        encrypted, only the <a href="http://www.freebsd.org/cgi/man.cgi?query=accf_data&amp;sektion=9">
 177        accf_data(9)</a> filter is used.</p>
 178
 179     <p>The default values on Linux are:</p>
 180     <pre class="prettyprint lang-config">AcceptFilter http data
 181 AcceptFilter https data</pre>
 182
 183
 184     <p>Linux's <code>TCP_DEFER_ACCEPT</code> does not support buffering http
 185        requests.  Any value besides <code>none</code> will enable
 186        <code>TCP_DEFER_ACCEPT</code> on that listener. For more details
 187        see the Linux
 188        <a href="http://man7.org/linux/man-pages/man7/tcp.7.html">
 189        tcp(7)</a> man page.</p>
 190
 191     <p>The default values on Windows are:</p>
 192     <pre class="prettyprint lang-config">AcceptFilter http connect
 193 AcceptFilter https connect</pre>
 194
 195
 196     <p>Window's mpm_winnt interprets the AcceptFilter to toggle the AcceptEx()
 197        API, and does not support http protocol buffering. <code>connect</code>
 198        will use the AcceptEx() API, also retrieve the network endpoint
 199        addresses, but like <code>none</code> the <code>connect</code> option
 200        does not wait for the initial data transmission.</p>
 201
 202     <p>On Windows, <code>none</code> uses accept() rather than AcceptEx()
 203        and will not recycle sockets between connections.  This is useful for
 204        network adapters with broken driver support, as well as some virtual
 205        network providers such as vpn drivers, or spam, virus or spyware
 206        filters.</p>
 207
 208     <div class="warning">
 209       <h3>The <code>data</code> AcceptFilter (Windows)</h3>
 210
 211       <p>For versions 2.4.23 and prior, the Windows <code>data</code> accept
 212          filter waited until data had been transmitted and the initial data
 213          buffer and network endpoint addresses had been retrieved from the
 214          single AcceptEx() invocation. This implementation was subject to a
 215          denial of service attack and has been disabled.</p>
 216
 217       <p>Current releases of httpd default to the <code>connect</code> filter
 218          on Windows, and will fall back to <code>connect</code> if
 219          <code>data</code> is specified. Users of prior releases are encouraged
 220          to add an explicit setting of <code>connect</code> for their
 221          AcceptFilter, as shown above.</p>
 222     </div>
 223
 224
 225 <h3>See also</h3>
 226 <ul>
 227 <li><code class="directive"><a href="#protocol">Protocol</a></code></li>
 228 </ul>
 229 </div>
 230 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 231 <div class="directive-section"><h2><a name="AcceptPathInfo" id="AcceptPathInfo">AcceptPathInfo</a> <a name="acceptpathinfo" id="acceptpathinfo">Directive</a></h2>
 232 <table class="directive">
 233 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Resources accept trailing pathname information</td></tr>
 234 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AcceptPathInfo On|Off|Default</code></td></tr>
 235 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AcceptPathInfo Default</code></td></tr>
 236 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 237 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
 238 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
 239 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
 240 </table>
 241
 242     <p>This directive controls whether requests that contain trailing
 243     pathname information that follows an actual filename (or
 244     non-existent file in an existing directory) will be accepted or
 245     rejected.  The trailing pathname information can be made
 246     available to scripts in the <code>PATH_INFO</code> environment
 247     variable.</p>
 248
 249     <p>For example, assume the location <code>/test/</code> points to
 250     a directory that contains only the single file
 251     <code>here.html</code>.  Then requests for
 252     <code>/test/here.html/more</code> and
 253     <code>/test/nothere.html/more</code> both collect
 254     <code>/more</code> as <code>PATH_INFO</code>.</p>
 255
 256     <p>The three possible arguments for the
 257     <code class="directive">AcceptPathInfo</code> directive are:</p>
 258     <dl>
 259     <dt><code>Off</code></dt><dd>A request will only be accepted if it
 260     maps to a literal path that exists.  Therefore a request with
 261     trailing pathname information after the true filename such as
 262     <code>/test/here.html/more</code> in the above example will return
 263     a 404 NOT FOUND error.</dd>
 264
 265     <dt><code>On</code></dt><dd>A request will be accepted if a
 266     leading path component maps to a file that exists.  The above
 267     example <code>/test/here.html/more</code> will be accepted if
 268     <code>/test/here.html</code> maps to a valid file.</dd>
 269
 270     <dt><code>Default</code></dt><dd>The treatment of requests with
 271     trailing pathname information is determined by the <a href="../handler.html">handler</a> responsible for the request.
 272     The core handler for normal files defaults to rejecting
 273     <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
 274     <code>PATH_INFO</code> by default.</dd>
 275     </dl>
 276
 277     <p>The primary purpose of the <code>AcceptPathInfo</code>
 278     directive is to allow you to override the handler's choice of
 279     accepting or rejecting <code>PATH_INFO</code>. This override is required,
 280     for example, when you use a <a href="../filter.html">filter</a>, such
 281     as <a href="mod_include.html">INCLUDES</a>, to generate content
 282     based on <code>PATH_INFO</code>.  The core handler would usually reject
 283     the request, so you can use the following configuration to enable
 284     such a script:</p>
 285
 286     <pre class="prettyprint lang-config">&lt;Files "mypaths.shtml"&gt;
 287   Options +Includes
 288   SetOutputFilter INCLUDES
 289   AcceptPathInfo On
 290 &lt;/Files&gt;</pre>
 291
 292
 293
 294 </div>
 295 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 296 <div class="directive-section"><h2><a name="AccessFileName" id="AccessFileName">AccessFileName</a> <a name="accessfilename" id="accessfilename">Directive</a></h2>
 297 <table class="directive">
 298 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Name of the distributed configuration file</td></tr>
 299 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AccessFileName <var>filename</var> [<var>filename</var>] ...</code></td></tr>
 300 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AccessFileName .htaccess</code></td></tr>
 301 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 302 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
 303 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
 304 </table>
 305     <p>While processing a request, the server looks for
 306     the first existing configuration file from this list of names in
 307     every directory of the path to the document, if distributed
 308     configuration files are <a href="#allowoverride">enabled for that
 309     directory</a>. For example:</p>
 310
 311     <pre class="prettyprint lang-config">AccessFileName .acl</pre>
 312
 313
 314     <p>Before returning the document
 315     <code>/usr/local/web/index.html</code>, the server will read
 316     <code>/.acl</code>, <code>/usr/.acl</code>,
 317     <code>/usr/local/.acl</code> and <code>/usr/local/web/.acl</code>
 318     for directives unless they have been disabled with:</p>
 319
 320     <pre class="prettyprint lang-config">&lt;Directory "/"&gt;
 321     AllowOverride None
 322 &lt;/Directory&gt;</pre>
 323
 324
 325 <h3>See also</h3>
 326 <ul>
 327 <li><code class="directive"><a href="#allowoverride">AllowOverride</a></code></li>
 328 <li><a href="../configuring.html">Configuration Files</a></li>
 329 <li><a href="../howto/htaccess.html">.htaccess Files</a></li>
 330 </ul>
 331 </div>
 332 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 333 <div class="directive-section"><h2><a name="AddDefaultCharset" id="AddDefaultCharset">AddDefaultCharset</a> <a name="adddefaultcharset" id="adddefaultcharset">Directive</a></h2>
 334 <table class="directive">
 335 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Default charset parameter to be added when a response
 336 content-type is <code>text/plain</code> or <code>text/html</code></td></tr>
 337 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AddDefaultCharset On|Off|<var>charset</var></code></td></tr>
 338 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AddDefaultCharset Off</code></td></tr>
 339 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 340 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
 341 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
 342 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
 343 </table>
 344     <p>This directive specifies a default value for the media type
 345     charset parameter (the name of a character encoding) to be added
 346     to a response if and only if the response's content-type is either
 347     <code>text/plain</code> or <code>text/html</code>.  This should override
 348     any charset specified in the body of the response via a <code>META</code>
 349     element, though the exact behavior is often dependent on the user's client
 350     configuration. A setting of <code>AddDefaultCharset Off</code>
 351     disables this functionality. <code>AddDefaultCharset On</code> enables
 352     a default charset of <code>iso-8859-1</code>. Any other value is assumed
 353     to be the <var>charset</var> to be used, which should be one of the
 354     <a href="http://www.iana.org/assignments/character-sets">IANA registered
 355     charset values</a> for use in Internet media types (MIME types).
 356     For example:</p>
 357
 358     <pre class="prettyprint lang-config">AddDefaultCharset utf-8</pre>
 359
 360
 361     <p><code class="directive">AddDefaultCharset</code> should only be used when all
 362     of the text resources to which it applies are known to be in that
 363     character encoding and it is too inconvenient to label their charset
 364     individually. One such example is to add the charset parameter
 365     to resources containing generated content, such as legacy CGI
 366     scripts, that might be vulnerable to cross-site scripting attacks
 367     due to user-provided data being included in the output.  Note, however,
 368     that a better solution is to just fix (or delete) those scripts, since
 369     setting a default charset does not protect users that have enabled
 370     the "auto-detect character encoding" feature on their browser.</p>
 371
 372 <h3>See also</h3>
 373 <ul>
 374 <li><code class="directive"><a href="../mod/mod_mime.html#addcharset">AddCharset</a></code></li>
 375 </ul>
 376 </div>
 377 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 378 <div class="directive-section"><h2><a name="AllowEncodedSlashes" id="AllowEncodedSlashes">AllowEncodedSlashes</a> <a name="allowencodedslashes" id="allowencodedslashes">Directive</a></h2>
 379 <table class="directive">
 380 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Determines whether encoded path separators in URLs are allowed to
 381 be passed through</td></tr>
 382 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AllowEncodedSlashes On|Off|NoDecode</code></td></tr>
 383 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AllowEncodedSlashes Off</code></td></tr>
 384 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 385 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
 386 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
 387 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>
 388 NoDecode option available in 2.3.12 and later.</td></tr>
 389 </table>
 390     <p>The <code class="directive">AllowEncodedSlashes</code> directive allows URLs
 391     which contain encoded path separators (<code>%2F</code> for <code>/</code>
 392     and additionally <code>%5C</code> for <code>\</code> on accordant systems)
 393     to be used in the path info.</p>
 394
 395     <p>With the default value, <code>Off</code>, such URLs are refused
 396     with a 404 (Not found) error.</p>
 397
 398     <p>With the value <code>On</code>, such URLs are accepted, and encoded
 399       slashes are decoded like all other encoded characters.</p>
 400
 401     <p>With the value <code>NoDecode</code>, such URLs are accepted, but
 402       encoded slashes are not decoded but left in their encoded state.</p>
 403
 404     <p>Turning <code class="directive">AllowEncodedSlashes</code> <code>On</code> is
 405     mostly useful when used in conjunction with <code>PATH_INFO</code>.</p>
 406
 407     <div class="note"><h3>Note</h3>
 408       <p>If encoded slashes are needed in path info, use of <code>NoDecode</code> is
 409       strongly recommended as a security measure.  Allowing slashes
 410       to be decoded could potentially allow unsafe paths.</p>
 411     </div>
 412
 413 <h3>See also</h3>
 414 <ul>
 415 <li><code class="directive"><a href="#acceptpathinfo">AcceptPathInfo</a></code></li>
 416 </ul>
 417 </div>
 418 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 419 <div class="directive-section"><h2><a name="AllowOverride" id="AllowOverride">AllowOverride</a> <a name="allowoverride" id="allowoverride">Directive</a></h2>
 420 <table class="directive">
 421 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Types of directives that are allowed in
 422 <code>.htaccess</code> files</td></tr>
 423 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AllowOverride All|None|<var>directive-type</var>
 424 [<var>directive-type</var>] ...</code></td></tr>
 425 <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>
 426 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory</td></tr>
 427 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
 428 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
 429 </table>
 430     <p>When the server finds an <code>.htaccess</code> file (as
 431     specified by <code class="directive"><a href="#accessfilename">AccessFileName</a></code>),
 432     it needs to know which directives declared in that file can override
 433     earlier configuration directives.</p>
 434
 435     <div class="note"><h3>Only available in &lt;Directory&gt; sections</h3>
 436     <code class="directive">AllowOverride</code> is valid only in
 437     <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code>
 438     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
 439     <code class="directive"><a href="#files">&lt;Files&gt;</a></code> sections.
 440     </div>
 441
 442     <p>When this directive is set to <code>None</code> and <code class="directive"><a href="#allowoverridelist">AllowOverrideList</a></code> is set to
 443     <code>None</code>, <a href="#accessfilename">.htaccess</a> files are
 444     completely ignored. In this case, the server will not even attempt
 445     to read <code>.htaccess</code> files in the filesystem.</p>
 446
 447     <p>When this directive is set to <code>All</code>, then any
 448     directive which has the .htaccess <a href="directive-dict.html#Context">Context</a> is allowed in
 449     <code>.htaccess</code> files.</p>
 450
 451     <p>The <var>directive-type</var> can be one of the following
 452     groupings of directives.</p>
 453
 454     <dl>
 455       <dt>AuthConfig</dt>
 456
 457       <dd>
 458
 459       Allow use of the authorization directives (<code class="directive"><a href="../mod/mod_authz_dbm.html#authdbmgroupfile">AuthDBMGroupFile</a></code>,
 460       <code class="directive"><a href="../mod/mod_authn_dbm.html#authdbmuserfile">AuthDBMUserFile</a></code>,
 461       <code class="directive"><a href="../mod/mod_authz_groupfile.html#authgroupfile">AuthGroupFile</a></code>,
 462       <code class="directive"><a href="../mod/mod_authn_core.html#authname">AuthName</a></code>,
 463       <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>
 464
 465       <dt>FileInfo</dt>
 466
 467       <dd>
 468       Allow use of the directives controlling document types
 469      (<code class="directive"><a href="#errordocument">ErrorDocument</a></code>,
 470       <code class="directive"><a href="#forcetype">ForceType</a></code>,
 471       <code class="directive"><a href="../mod/mod_negotiation.html#languagepriority">LanguagePriority</a></code>,
 472       <code class="directive"><a href="#sethandler">SetHandler</a></code>,
 473       <code class="directive"><a href="#setinputfilter">SetInputFilter</a></code>,
 474       <code class="directive"><a href="#setoutputfilter">SetOutputFilter</a></code>, and
 475       <code class="module"><a href="../mod/mod_mime.html">mod_mime</a></code> Add* and Remove* directives),
 476       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>),
 477       <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>),
 478       <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
 479       <code class="directive"><a href="../mod/mod_actions.html#action">Action</a></code> from
 480       <code class="module"><a href="../mod/mod_actions.html">mod_actions</a></code>.
 481       </dd>
 482
 483       <dt>Indexes</dt>
 484
 485       <dd>
 486       Allow use of the directives controlling directory indexing
 487       (<code class="directive"><a href="../mod/mod_autoindex.html#adddescription">AddDescription</a></code>,
 488       <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>,
 489       <code class="directive"><a href="../mod/mod_autoindex.html#addiconbytype">AddIconByType</a></code>,
 490       <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>,
 491       <em>etc.</em>).</dd>
 492
 493       <dt>Limit</dt>
 494
 495       <dd>
 496       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>
 497
 498
 499
 500
 501       <dt>Nonfatal=[Override|Unknown|All]</dt>
 502
 503       <dd>
 504       Allow use of AllowOverride option to treat invalid (unrecognized
 505       or disallowed) directives in
 506       .htaccess as nonfatal. Instead of causing an Internal Server
 507       Error, disallowed or unrecognised directives will be ignored
 508       and a warning logged:
 509       <ul>
 510           <li><strong>Nonfatal=Override</strong> treats directives
 511               forbidden by AllowOverride as nonfatal.</li>
 512           <li><strong>Nonfatal=Unknown</strong> treats unknown directives
 513               as nonfatal.  This covers typos and directives implemented
 514               by a module that's not present.</li>
 515           <li><strong>Nonfatal=All</strong> treats both the above as nonfatal.</li>
 516       </ul>
 517       <p>Note that a syntax error in a valid directive will still cause
 518       an Internal Server Error.</p>
 519       <div class="warning"><h3>Security</h3>
 520           Nonfatal errors may have security implications for .htaccess users.
 521           For example, if AllowOverride disallows AuthConfig, users'
 522           configuration designed to restrict access to a site will be disabled.
 523       </div>
 524       </dd>
 525
 526       <dt>Options[=<var>Option</var>,...]</dt>
 527
 528       <dd>
 529       Allow use of the directives controlling specific directory
 530       features (<code class="directive"><a href="#options">Options</a></code> and
 531       <code class="directive"><a href="../mod/mod_include.html#xbithack">XBitHack</a></code>).
 532       An equal sign may be given followed by a comma-separated list, without
 533       spaces, of options that may be set using the <code class="directive"><a href="#options">Options</a></code> command.
 534
 535       <div class="note"><h3>Implicit disabling of Options</h3>
 536       <p>Even though the list of options that may be used in .htaccess files
 537          can be limited with this directive, as long as any <code class="directive"><a href="#options">Options</a></code> directive is allowed any
 538          other inherited option can be disabled by using the non-relative
 539          syntax.  In other words, this mechanism cannot force a specific option
 540          to remain <em>set</em> while allowing any others to be set.
 541       </p></div>
 542
 543       <div class="example"><p><code>
 544       AllowOverride Options=Indexes,MultiViews
 545       </code></p></div>
 546       </dd>
 547     </dl>
 548
 549     <p>Example:</p>
 550
 551     <pre class="prettyprint lang-config">AllowOverride AuthConfig Indexes</pre>
 552
 553
 554     <p>In the example above, all directives that are neither in the group
 555     <code>AuthConfig</code> nor <code>Indexes</code> cause an internal
 556     server error.</p>
 557
 558     <div class="note"><p>For security and performance reasons, do not set
 559     <code>AllowOverride</code> to anything other than <code>None</code>
 560     in your <code>&lt;Directory "/"&gt;</code> block. Instead, find (or
 561     create) the <code>&lt;Directory&gt;</code> block that refers to the
 562     directory where you're actually planning to place a
 563     <code>.htaccess</code> file.</p>
 564     </div>
 565
 566 <h3>See also</h3>
 567 <ul>
 568 <li><code class="directive"><a href="#accessfilename">AccessFileName</a></code></li>
 569 <li><code class="directive"><a href="#allowoverridelist">AllowOverrideList</a></code></li>
 570 <li><a href="../configuring.html">Configuration Files</a></li>
 571 <li><a href="../howto/htaccess.html">.htaccess Files</a></li>
 572 </ul>
 573 </div>
 574 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 575 <div class="directive-section"><h2><a name="AllowOverrideList" id="AllowOverrideList">AllowOverrideList</a> <a name="allowoverridelist" id="allowoverridelist">Directive</a></h2>
 576 <table class="directive">
 577 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Individual directives that are allowed in
 578 <code>.htaccess</code> files</td></tr>
 579 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AllowOverrideList None|<var>directive</var>
 580 [<var>directive-type</var>] ...</code></td></tr>
 581 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AllowOverrideList None</code></td></tr>
 582 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory</td></tr>
 583 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
 584 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
 585 </table>
 586     <p>When the server finds an <code>.htaccess</code> file (as
 587     specified by <code class="directive"><a href="#accessfilename">AccessFileName</a></code>),
 588     it needs to know which directives declared in that file can override
 589     earlier configuration directives.</p>
 590
 591     <div class="note"><h3>Only available in &lt;Directory&gt; sections</h3>
 592     <code class="directive">AllowOverrideList</code> is valid only in
 593     <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code>
 594     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
 595     <code class="directive"><a href="#files">&lt;Files&gt;</a></code> sections.
 596     </div>
 597
 598     <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>,
 599     then <a href="#accessfilename">.htaccess</a> files are completely
 600     ignored.  In this case, the server will not even attempt to read
 601     <code>.htaccess</code> files in the filesystem.</p>
 602
 603     <p>Example:</p>
 604
 605     <pre class="prettyprint lang-config">AllowOverride None
 606 AllowOverrideList Redirect RedirectMatch</pre>
 607
 608
 609     <p>In the example above, only the <code>Redirect</code> and
 610     <code>RedirectMatch</code> directives are allowed. All others will
 611     cause an Internal Server Error.</p>
 612
 613     <p>Example:</p>
 614
 615     <pre class="prettyprint lang-config">AllowOverride AuthConfig
 616 AllowOverrideList CookieTracking CookieName</pre>
 617
 618
 619     <p>In the example above, <code class="directive"><a href="#allowoverride">AllowOverride
 620     </a></code> grants permission to the <code>AuthConfig</code>
 621     directive grouping and <code class="directive">AllowOverrideList</code> grants
 622     permission to only two directives from the <code>FileInfo</code> directive
 623     grouping. All others will cause an Internal Server Error.</p>
 624
 625 <h3>See also</h3>
 626 <ul>
 627 <li><code class="directive"><a href="#accessfilename">AccessFileName</a></code></li>
 628 <li><code class="directive"><a href="#allowoverride">AllowOverride</a></code></li>
 629 <li><a href="../configuring.html">Configuration Files</a></li>
 630 <li><a href="../howto/htaccess.html">.htaccess Files</a></li>
 631 </ul>
 632 </div>
 633 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 634 <div class="directive-section"><h2><a name="AsyncFilter" id="AsyncFilter">AsyncFilter</a> <a name="asyncfilter" id="asyncfilter">Directive</a></h2>
 635 <table class="directive">
 636 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set the minimum filter type eligible for asynchronous handling</td></tr>
 637 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AsyncFilter request|connection|network</code></td></tr>
 638 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AsyncFilter request</code></td></tr>
 639 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 640 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
 641 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
 642 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Only available from Apache 2.5.0 and later.</td></tr>
 643 </table>
 644         <p>This directive controls the minimum filter levels that are eligible
 645         for asynchronous handling. This may be necessary to support legacy external
 646         filters that did not handle meta buckets correctly.</p>
 647
 648         <p>If set to "network", asynchronous handling will be limited to the network
 649         filter only. If set to "connection", all connection and network filters
 650         will be eligible for asynchronous handling, including <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code>.
 651         If set to "request", all filters will be eligible for asynchronous handling.</p>
 652
 653 </div>
 654 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 655 <div class="directive-section"><h2><a name="CGIMapExtension" id="CGIMapExtension">CGIMapExtension</a> <a name="cgimapextension" id="cgimapextension">Directive</a></h2>
 656 <table class="directive">
 657 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Technique for locating the interpreter for CGI
 658 scripts</td></tr>
 659 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CGIMapExtension <var>cgi-path</var> <var>.extension</var></code></td></tr>
 660 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
 661 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
 662 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
 663 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
 664 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>NetWare only</td></tr>
 665 </table>
 666     <p>This directive is used to control how Apache httpd finds the
 667     interpreter used to run CGI scripts. For example, setting
 668     <code>CGIMapExtension sys:\foo.nlm .foo</code> will
 669     cause all CGI script files with a <code>.foo</code> extension to
 670     be passed to the FOO interpreter.</p>
 671
 672 </div>
 673 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 674 <div class="directive-section"><h2><a name="CGIPassAuth" id="CGIPassAuth">CGIPassAuth</a> <a name="cgipassauth" id="cgipassauth">Directive</a></h2>
 675 <table class="directive">
 676 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables passing HTTP authorization headers to scripts as CGI
 677 variables</td></tr>
 678 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CGIPassAuth On|Off</code></td></tr>
 679 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CGIPassAuth Off</code></td></tr>
 680 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
 681 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
 682 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
 683 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
 684 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache HTTP Server 2.4.13 and later</td></tr>
 685 </table>
 686     <p><code class="directive">CGIPassAuth</code> allows scripts access to HTTP
 687     authorization headers such as <code>Authorization</code>, which is
 688     required for scripts that implement HTTP Basic authentication.
 689     Normally these HTTP headers are hidden from scripts. This is to disallow
 690     scripts from seeing user ids and passwords used to access the server when
 691     HTTP Basic authentication is enabled in the web server.  This directive
 692     should be used when scripts are allowed to implement HTTP Basic
 693     authentication.</p>
 694
 695     <p>This directive can be used instead of the compile-time setting
 696     <code>SECURITY_HOLE_PASS_AUTHORIZATION</code> which has been available
 697     in previous versions of Apache HTTP Server.</p>
 698
 699     <p>The setting is respected by any modules which use
 700     <code>ap_add_common_vars()</code>, such as <code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code>,
 701     <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>,
 702     <code class="module"><a href="../mod/mod_proxy_scgi.html">mod_proxy_scgi</a></code>, and so on.  Notably, it affects
 703     modules which don't handle the request in the usual sense but
 704     still use this API; examples of this are <code class="module"><a href="../mod/mod_include.html">mod_include</a></code>
 705     and <code class="module"><a href="../mod/mod_ext_filter.html">mod_ext_filter</a></code>.  Third-party modules that don't
 706     use <code>ap_add_common_vars()</code> may choose to respect the setting
 707     as well.</p>
 708
 709 </div>
 710 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 711 <div class="directive-section"><h2><a name="CGIVar" id="CGIVar">CGIVar</a> <a name="cgivar" id="cgivar">Directive</a></h2>
 712 <table class="directive">
 713 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Controls how some CGI variables are set</td></tr>
 714 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CGIVar <var>variable</var> <var>rule</var></code></td></tr>
 715 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
 716 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
 717 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
 718 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
 719 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache HTTP Server 2.4.21 and later</td></tr>
 720 </table>
 721   <p>This directive controls how some CGI variables are set.</p>
 722
 723   <p><strong>REQUEST_URI</strong> rules:</p>
 724   <dl>
 725     <dt><code>original-uri</code> (default)</dt>
 726     <dd>The value is taken from the original request line, and will not
 727     reflect internal redirects or subrequests which change the requested
 728     resource.</dd>
 729     <dt><code>current-uri</code></dt>
 730     <dd>The value reflects the resource currently being processed,
 731     which may be different than the original request from the client
 732     due to internal redirects or subrequests.</dd>
 733   </dl>
 734
 735 </div>
 736 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 737 <div class="directive-section"><h2><a name="ContentDigest" id="ContentDigest">ContentDigest</a> <a name="contentdigest" id="contentdigest">Directive</a></h2>
 738 <table class="directive">
 739 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables the generation of <code>Content-MD5</code> HTTP Response
 740 headers</td></tr>
 741 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ContentDigest On|Off</code></td></tr>
 742 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ContentDigest Off</code></td></tr>
 743 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 744 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Options</td></tr>
 745 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
 746 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
 747 </table>
 748     <p>This directive enables the generation of
 749     <code>Content-MD5</code> headers as defined in RFC1864
 750     respectively RFC2616.</p>
 751
 752     <p>MD5 is an algorithm for computing a "message digest"
 753     (sometimes called "fingerprint") of arbitrary-length data, with
 754     a high degree of confidence that any alterations in the data
 755     will be reflected in alterations in the message digest.</p>
 756
 757     <p>The <code>Content-MD5</code> header provides an end-to-end
 758     message integrity check (MIC) of the entity-body. A proxy or
 759     client may check this header for detecting accidental
 760     modification of the entity-body in transit. Example header:</p>
 761
 762     <div class="example"><p><code>
 763       Content-MD5: AuLb7Dp1rqtRtxz2m9kRpA==
 764     </code></p></div>
 765
 766     <p>Note that this can cause performance problems on your server
 767     since the message digest is computed on every request (the
 768     values are not cached).</p>
 769
 770     <p><code>Content-MD5</code> is only sent for documents served
 771     by the <code class="module"><a href="../mod/core.html">core</a></code>, and not by any module. For example,
 772     SSI documents, output from CGI scripts, and byte range responses
 773     do not have this header.</p>
 774
 775 </div>
 776 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 777 <div class="directive-section"><h2><a name="DefaultRuntimeDir" id="DefaultRuntimeDir">DefaultRuntimeDir</a> <a name="defaultruntimedir" id="defaultruntimedir">Directive</a></h2>
 778 <table class="directive">
 779 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Base directory for the server run-time files</td></tr>
 780 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DefaultRuntimeDir <var>directory-path</var></code></td></tr>
 781 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>DefaultRuntimeDir DEFAULT_REL_RUNTIMEDIR (logs/)</code></td></tr>
 782 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 783 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
 784 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
 785 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.4.2 and later</td></tr>
 786 </table>
 787     <p>The <code class="directive">DefaultRuntimeDir</code> directive sets the
 788     directory in which the server will create various run-time files
 789     (shared memory, locks, etc.). If set as a relative path, the full path
 790     will be relative to <code class="directive">ServerRoot</code>.</p>
 791
 792     <p><strong>Example</strong></p>
 793    <pre class="prettyprint lang-config">DefaultRuntimeDir scratch/</pre>
 794
 795
 796     <p>The default location of <code class="directive">DefaultRuntimeDir</code> may be
 797     modified by changing the <code>DEFAULT_REL_RUNTIMEDIR</code> #define
 798     at build time.</p>
 799
 800    <p>Note: <code class="directive">ServerRoot</code> should be specified before this
 801    directive is used. Otherwise, the default value of <code class="directive">ServerRoot</code>
 802    would be used to set the base directory.</p>
 803
 804
 805 <h3>See also</h3>
 806 <ul>
 807 <li><a href="../misc/security_tips.html#serverroot">the
 808     security tips</a> for information on how to properly set
 809     permissions on the <code class="directive">ServerRoot</code></li>
 810 </ul>
 811 </div>
 812 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 813 <div class="directive-section"><h2><a name="DefaultType" id="DefaultType">DefaultType</a> <a name="defaulttype" id="defaulttype">Directive</a></h2>
 814 <table class="directive">
 815 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>This directive has no effect other than to emit warnings
 816 if the value is not <code>none</code>. In prior versions, DefaultType
 817 would specify a default media type to assign to response content for
 818 which no other media type configuration could be found.
 819 </td></tr>
 820 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DefaultType <var>media-type|none</var></code></td></tr>
 821 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>DefaultType none</code></td></tr>
 822 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 823 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
 824 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
 825 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
 826 <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.
 827 </td></tr>
 828 </table>
 829     <p>This directive has been disabled.  For backwards compatibility
 830     of configuration files, it may be specified with the value
 831     <code>none</code>, meaning no default media type. For example:</p>
 832
 833     <pre class="prettyprint lang-config">DefaultType None</pre>
 834
 835
 836     <p><code>DefaultType None</code> is only available in
 837     httpd-2.2.7 and later.</p>
 838
 839     <p>Use the mime.types configuration file and the
 840     <code class="directive"><a href="../mod/mod_mime.html#addtype">AddType</a></code> to configure media
 841     type assignments via file extensions, or the
 842     <code class="directive"><a href="#forcetype">ForceType</a></code> directive to configure
 843     the media type for specific resources. Otherwise, the server will
 844     send the response without a Content-Type header field and the
 845     recipient may attempt to guess the media type.</p>
 846
 847 <h3>See also</h3>
 848 <ul>
 849 <li><code class="directive"><a href="#undefine">UnDefine</a></code></li>
 850 <li><code class="directive"><a href="#ifdefine">IfDefine</a></code></li>
 851 </ul>
 852 </div>
 853 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 854 <div class="directive-section"><h2><a name="Define" id="Define">Define</a> <a name="define" id="define">Directive</a></h2>
 855 <table class="directive">
 856 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Define a variable</td></tr>
 857 <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>
 858 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 859 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
 860 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
 861 </table>
 862     <p>In its one parameter form, <code class="directive">Define</code> is equivalent
 863     to passing the <code>-D</code> argument to <code class="program"><a href="../programs/httpd.html">httpd</a></code>. It
 864     can be used to toggle the use of
 865     <code class="directive"><a href="#ifdefine">&lt;IfDefine&gt;</a></code> sections
 866     without needing to alter <code>-D</code> arguments in any startup
 867     scripts.</p>
 868
 869     <p>In addition to that, if the second parameter is given, a config variable
 870     is set to this value. The variable can be used in the configuration using
 871     the <code>${VAR}</code> syntax. The variable is always globally defined
 872     and not limited to the scope of the surrounding config section.</p>
 873
 874     <pre class="prettyprint lang-config">&lt;IfDefine TEST&gt;
 875   Define servername test.example.com
 876 &lt;/IfDefine&gt;
 877 &lt;IfDefine !TEST&gt;
 878   Define servername www.example.com
 879   Define SSL
 880 &lt;/IfDefine&gt;
 881
 882 DocumentRoot "/var/www/${servername}/htdocs"</pre>
 883
 884
 885     <p>Variable names may not contain colon ":" characters, to avoid clashes
 886     with <code class="directive"><a href="../mod/mod_rewrite.html#rewritemap">RewriteMap</a></code>'s syntax.</p>
 887
 888     <p>While this directive is supported in virtual host context,
 889        the changes it makes are visible to any later configuration
 890        directives, beyond any enclosing virtual host.</p>
 891
 892 </div>
 893 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 894 <div class="directive-section"><h2><a name="Directory" id="Directory">&lt;Directory&gt;</a> <a name="directory" id="directory">Directive</a></h2>
 895 <table class="directive">
 896 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enclose a group of directives that apply only to the
 897 named file-system directory, sub-directories, and their contents.</td></tr>
 898 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;Directory <var>directory-path</var>&gt;
 899 ... &lt;/Directory&gt;</code></td></tr>
 900 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 901 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
 902 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
 903 </table>
 904     <p><code class="directive">&lt;Directory&gt;</code> and
 905     <code>&lt;/Directory&gt;</code> are used to enclose a group of
 906     directives that will apply only to the named directory,
 907     sub-directories of that directory, and the files within the respective
 908     directories.  Any directive that is allowed
 909     in a directory context may be used. <var>Directory-path</var> is
 910     either the full path to a directory, or a wild-card string using
 911     Unix shell-style matching. In a wild-card string, <code>?</code> matches
 912     any single character, and <code>*</code> matches any sequences of
 913     characters. You may also use <code>[]</code> character ranges. None
 914     of the wildcards match a `/' character, so <code>&lt;Directory
 915     "/*/public_html"&gt;</code> will not match
 916     <code>/home/user/public_html</code>, but <code>&lt;Directory
 917     "/home/*/public_html"&gt;</code> will match. Example:</p>
 918
 919     <pre class="prettyprint lang-config">&lt;Directory "/usr/local/httpd/htdocs"&gt;
 920   Options Indexes FollowSymLinks
 921 &lt;/Directory&gt;</pre>
 922
 923
 924     <p>Directory paths <em>may</em> be quoted, if you like, however, it
 925     <em>must</em> be quoted if the path contains spaces. This is because a
 926     space would otherwise indicate the end of an argument.</p>
 927
 928     <div class="note">
 929       <p>Be careful with the <var>directory-path</var> arguments:
 930       They have to literally match the filesystem path which Apache httpd uses
 931       to access the files. Directives applied to a particular
 932       <code>&lt;Directory&gt;</code> will not apply to files accessed from
 933       that same directory via a different path, such as via different symbolic
 934       links.</p>
 935     </div>
 936
 937     <p><a class="glossarylink" href="../glossary.html#regex" title="see glossary">Regular
 938     expressions</a> can also be used, with the addition of the
 939     <code>~</code> character. For example:</p>
 940
 941     <pre class="prettyprint lang-config">&lt;Directory ~ "^/www/[0-9]{3}"&gt;
 942
 943 &lt;/Directory&gt;</pre>
 944
 945
 946     <p>would match directories in <code>/www/</code> that consisted of
 947     three numbers.</p>
 948
 949     <p>If multiple (non-regular expression) <code class="directive">&lt;Directory&gt;</code> sections
 950     match the directory (or one of its parents) containing a document,
 951     then the directives are applied in the order of shortest match
 952     first, interspersed with the directives from the <a href="#accessfilename">.htaccess</a> files. For example,
 953     with</p>
 954
 955     <pre class="prettyprint lang-config">&lt;Directory "/"&gt;
 956   AllowOverride None
 957 &lt;/Directory&gt;
 958
 959 &lt;Directory "/home"&gt;
 960   AllowOverride FileInfo
 961 &lt;/Directory&gt;</pre>
 962
 963
 964     <p>for access to the document <code>/home/web/dir/doc.html</code>
 965     the steps are:</p>
 966
 967     <ul>
 968       <li>Apply directive <code>AllowOverride None</code>
 969       (disabling <code>.htaccess</code> files).</li>
 970
 971       <li>Apply directive <code>AllowOverride FileInfo</code> (for
 972       directory <code>/home</code>).</li>
 973
 974       <li>Apply any <code>FileInfo</code> directives in
 975       <code>/home/.htaccess</code>, <code>/home/web/.htaccess</code> and
 976       <code>/home/web/dir/.htaccess</code> in that order.</li>
 977     </ul>
 978
 979     <p>Regular expressions are not considered until after all of the
 980     normal sections have been applied. Then all of the regular
 981     expressions are tested in the order they appeared in the
 982     configuration file. For example, with</p>
 983
 984     <pre class="prettyprint lang-config">&lt;Directory ~ "abc$"&gt;
 985   # ... directives here ...
 986 &lt;/Directory&gt;</pre>
 987
 988
 989     <p>the regular expression section won't be considered until after
 990     all normal <code class="directive">&lt;Directory&gt;</code>s and
 991     <code>.htaccess</code> files have been applied. Then the regular
 992     expression will match on <code>/home/abc/public_html/abc</code> and
 993     the corresponding <code class="directive">&lt;Directory&gt;</code> will
 994     be applied.</p>
 995
 996    <p><strong>Note that the default access for
 997     <code>&lt;Directory "/"&gt;</code> is to permit all access.
 998     This means that Apache httpd will serve any file mapped from an URL. It is
 999     recommended that you change this with a block such
1000     as</strong></p>
1001
1002     <pre class="prettyprint lang-config">&lt;Directory "/"&gt;
1003   Require all denied
1004 &lt;/Directory&gt;</pre>
1005
1006
1007     <p><strong>and then override this for directories you
1008     <em>want</em> accessible. See the <a href="../misc/security_tips.html">Security Tips</a> page for more
1009     details.</strong></p>
1010
1011     <p>The directory sections occur in the <code>httpd.conf</code> file.
1012     <code class="directive">&lt;Directory&gt;</code> directives
1013     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>
1014
1015 <h3>See also</h3>
1016 <ul>
1017 <li><a href="../sections.html">How &lt;Directory&gt;,
1018     &lt;Location&gt; and &lt;Files&gt; sections work</a> for an
1019     explanation of how these different sections are combined when a
1020     request is received</li>
1021 </ul>
1022 </div>
1023 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1024 <div class="directive-section"><h2><a name="DirectoryMatch" id="DirectoryMatch">&lt;DirectoryMatch&gt;</a> <a name="directorymatch" id="directorymatch">Directive</a></h2>
1025 <table class="directive">
1026 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enclose directives that apply to
1027 the contents of file-system directories matching a regular expression.</td></tr>
1028 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;DirectoryMatch <var>regex</var>&gt;
1029 ... &lt;/DirectoryMatch&gt;</code></td></tr>
1030 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1031 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
1032 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
1033 </table>
1034     <p><code class="directive">&lt;DirectoryMatch&gt;</code> and
1035     <code>&lt;/DirectoryMatch&gt;</code> are used to enclose a group
1036     of directives which will apply only to the named directory (and the files within),
1037     the same as <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code>.
1038     However, it takes as an argument a
1039     <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular expression</a>.  For example:</p>
1040
1041     <pre class="prettyprint lang-config">&lt;DirectoryMatch "^/www/(.+/)?[0-9]{3}/"&gt;
1042     # ...
1043 &lt;/DirectoryMatch&gt;</pre>
1044
1045
1046     <p>matches directories in <code>/www/</code> (or any subdirectory thereof)
1047     that consist of three numbers.</p>
1048
1049    <div class="note"><h3>Compatibility</h3>
1050       Prior to 2.3.9, this directive implicitly applied to sub-directories
1051       (like <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code>) and
1052       could not match the end of line symbol ($).  In 2.3.9 and later,
1053       only directories that match the expression are affected by the enclosed
1054       directives.
1055     </div>
1056
1057     <div class="note"><h3>Trailing Slash</h3>
1058       This directive applies to requests for directories that may or may
1059       not end in a trailing slash, so expressions that are anchored to the
1060       end of line ($) must be written with care.
1061     </div>
1062
1063     <p>From 2.4.8 onwards, named groups and backreferences are captured and
1064     written to the environment with the corresponding name prefixed with
1065     "MATCH_" and in upper case. This allows elements of paths to be referenced
1066     from within <a href="../expr.html">expressions</a> and modules like
1067     <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>. In order to prevent confusion, numbered
1068     (unnamed) backreferences are ignored. Use named groups instead.</p>
1069
1070     <pre class="prettyprint lang-config">&lt;DirectoryMatch "^/var/www/combined/(?&lt;sitename&gt;[^/]+)"&gt;
1071     Require ldap-group cn=%{env:MATCH_SITENAME},ou=combined,o=Example
1072 &lt;/DirectoryMatch&gt;</pre>
1073
1074
1075 <h3>See also</h3>
1076 <ul>
1077 <li><code class="directive"><a href="#directory">&lt;Directory&gt;</a></code> for
1078 a description of how regular expressions are mixed in with normal
1079 <code class="directive">&lt;Directory&gt;</code>s</li>
1080 <li><a href="../sections.html">How &lt;Directory&gt;, &lt;Location&gt; and
1081 &lt;Files&gt; sections work</a> for an explanation of how these different
1082 sections are combined when a request is received</li>
1083 </ul>
1084 </div>
1085 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1086 <div class="directive-section"><h2><a name="DocumentRoot" id="DocumentRoot">DocumentRoot</a> <a name="documentroot" id="documentroot">Directive</a></h2>
1087 <table class="directive">
1088 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Directory that forms the main document tree visible
1089 from the web</td></tr>
1090 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DocumentRoot <var>directory-path</var></code></td></tr>
1091 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>DocumentRoot "/usr/local/apache/htdocs"</code></td></tr>
1092 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1093 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
1094 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
1095 </table>
1096     <p>This directive sets the directory from which <code class="program"><a href="../programs/httpd.html">httpd</a></code>
1097     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
1098     path from the requested URL to the document root to make the
1099     path to the document. Example:</p>
1100
1101     <pre class="prettyprint lang-config">DocumentRoot "/usr/web"</pre>
1102
1103
1104     <p>then an access to
1105     <code>http://my.example.com/index.html</code> refers to
1106     <code>/usr/web/index.html</code>. If the <var>directory-path</var> is
1107     not absolute then it is assumed to be relative to the <code class="directive"><a href="#serverroot">ServerRoot</a></code>.</p>
1108
1109     <p>The <code class="directive">DocumentRoot</code> should be specified without
1110     a trailing slash.</p>
1111
1112 <h3>See also</h3>
1113 <ul>
1114 <li><a href="../urlmapping.html#documentroot">Mapping URLs to Filesystem
1115 Locations</a></li>
1116 </ul>
1117 </div>
1118 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1119 <div class="directive-section"><h2><a name="Else" id="Else">&lt;Else&gt;</a> <a name="else" id="else">Directive</a></h2>
1120 <table class="directive">
1121 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Contains directives that apply only if the condition of a
1122 previous <code class="directive"><a href="#if">&lt;If&gt;</a></code> or
1123 <code class="directive"><a href="#elseif">&lt;ElseIf&gt;</a></code> section is not
1124 satisfied by a request at runtime</td></tr>
1125 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;Else&gt; ... &lt;/Else&gt;</code></td></tr>
1126 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1127 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1128 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
1129 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
1130 </table>
1131     <p>The <code class="directive">&lt;Else&gt;</code> applies the enclosed
1132     directives if and only if the most recent
1133     <code class="directive">&lt;If&gt;</code> or
1134     <code class="directive">&lt;ElseIf&gt;</code> section
1135     in the same scope has not been applied.
1136     For example: In </p>
1137
1138     <pre class="prettyprint lang-config">&lt;If "-z req('Host')"&gt;
1139   # ...
1140 &lt;/If&gt;
1141 &lt;Else&gt;
1142   # ...
1143 &lt;/Else&gt;</pre>
1144
1145
1146     <p> The <code class="directive">&lt;If&gt;</code> would match HTTP/1.0
1147         requests without a <var>Host:</var> header and the
1148         <code class="directive">&lt;Else&gt;</code> would match requests
1149         with a <var>Host:</var> header.</p>
1150
1151
1152 <h3>See also</h3>
1153 <ul>
1154 <li><code class="directive"><a href="#if">&lt;If&gt;</a></code></li>
1155 <li><code class="directive"><a href="#elseif">&lt;ElseIf&gt;</a></code></li>
1156 <li><a href="../sections.html">How &lt;Directory&gt;, &lt;Location&gt;,
1157     &lt;Files&gt; sections work</a> for an explanation of how these
1158     different sections are combined when a request is received.
1159     <code class="directive">&lt;If&gt;</code>,
1160     <code class="directive">&lt;ElseIf&gt;</code>, and
1161     <code class="directive">&lt;Else&gt;</code> are applied last.</li>
1162 </ul>
1163 </div>
1164 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1165 <div class="directive-section"><h2><a name="ElseIf" id="ElseIf">&lt;ElseIf&gt;</a> <a name="elseif" id="elseif">Directive</a></h2>
1166 <table class="directive">
1167 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Contains directives that apply only if a condition is satisfied
1168 by a request at runtime while the condition of a previous
1169 <code class="directive"><a href="#if">&lt;If&gt;</a></code> or
1170 <code class="directive">&lt;ElseIf&gt;</code> section is not
1171 satisfied</td></tr>
1172 <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>
1173 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1174 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1175 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
1176 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
1177 </table>
1178     <p>The <code class="directive">&lt;ElseIf&gt;</code> applies the enclosed
1179     directives if and only if both the given condition evaluates to true and
1180     the most recent <code class="directive">&lt;If&gt;</code> or
1181     <code class="directive">&lt;ElseIf&gt;</code> section in the same scope has
1182     not been applied.  For example: In </p>
1183
1184     <pre class="prettyprint lang-config">&lt;If "-R '10.1.0.0/16'"&gt;
1185   #...
1186 &lt;/If&gt;
1187 &lt;ElseIf "-R '10.0.0.0/8'"&gt;
1188   #...
1189 &lt;/ElseIf&gt;
1190 &lt;Else&gt;
1191   #...
1192 &lt;/Else&gt;</pre>
1193
1194
1195     <p>The <code class="directive">&lt;ElseIf&gt;</code> would match if
1196     the remote address of a request belongs to the subnet 10.0.0.0/8 but
1197     not to the subnet 10.1.0.0/16.</p>
1198
1199
1200 <h3>See also</h3>
1201 <ul>
1202 <li><a href="../expr.html">Expressions in Apache HTTP Server</a>,
1203 for a complete reference and more examples.</li>
1204 <li><code class="directive"><a href="#if">&lt;If&gt;</a></code></li>
1205 <li><code class="directive"><a href="#else">&lt;Else&gt;</a></code></li>
1206 <li><a href="../sections.html">How &lt;Directory&gt;, &lt;Location&gt;,
1207     &lt;Files&gt; sections work</a> for an explanation of how these
1208     different sections are combined when a request is received.
1209     <code class="directive">&lt;If&gt;</code>,
1210     <code class="directive">&lt;ElseIf&gt;</code>, and
1211     <code class="directive">&lt;Else&gt;</code> are applied last.</li>
1212 </ul>
1213 </div>
1214 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1215 <div class="directive-section"><h2><a name="EnableMMAP" id="EnableMMAP">EnableMMAP</a> <a name="enablemmap" id="enablemmap">Directive</a></h2>
1216 <table class="directive">
1217 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Use memory-mapping to read files during delivery</td></tr>
1218 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>EnableMMAP On|Off</code></td></tr>
1219 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>EnableMMAP On</code></td></tr>
1220 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1221 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
1222 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
1223 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
1224 </table>
1225     <p>This directive controls whether the <code class="program"><a href="../programs/httpd.html">httpd</a></code> may use
1226     memory-mapping if it needs to read the contents of a file during
1227     delivery.  By default, when the handling of a request requires
1228     access to the data within a file -- for example, when delivering a
1229     server-parsed file using <code class="module"><a href="../mod/mod_include.html">mod_include</a></code> -- Apache httpd
1230     memory-maps the file if the OS supports it.</p>
1231
1232     <p>This memory-mapping sometimes yields a performance improvement.
1233     But in some environments, it is better to disable the memory-mapping
1234     to prevent operational problems:</p>
1235
1236     <ul>
1237     <li>On some multiprocessor systems, memory-mapping can reduce the
1238     performance of the <code class="program"><a href="../programs/httpd.html">httpd</a></code>.</li>
1239     <li>Deleting or truncating a file while <code class="program"><a href="../programs/httpd.html">httpd</a></code>
1240       has it memory-mapped can cause <code class="program"><a href="../programs/httpd.html">httpd</a></code> to
1241       crash with a segmentation fault.
1242     </li>
1243     </ul>
1244
1245     <p>For server configurations that are vulnerable to these problems,
1246     you should disable memory-mapping of delivered files by specifying:</p>
1247
1248     <pre class="prettyprint lang-config">EnableMMAP Off</pre>
1249
1250
1251     <p>For NFS mounted files, this feature may be disabled explicitly for
1252     the offending files by specifying:</p>
1253
1254     <pre class="prettyprint lang-config">&lt;Directory "/path-to-nfs-files"&gt;
1255   EnableMMAP Off
1256 &lt;/Directory&gt;</pre>
1257
1258
1259 </div>
1260 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1261 <div class="directive-section"><h2><a name="EnableSendfile" id="EnableSendfile">EnableSendfile</a> <a name="enablesendfile" id="enablesendfile">Directive</a></h2>
1262 <table class="directive">
1263 <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>
1264 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>EnableSendfile On|Off</code></td></tr>
1265 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>EnableSendfile Off</code></td></tr>
1266 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1267 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
1268 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
1269 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
1270 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Default changed to Off in
1271 version 2.3.9.</td></tr>
1272 </table>
1273     <p>This directive controls whether <code class="program"><a href="../programs/httpd.html">httpd</a></code> may use the
1274     sendfile support from the kernel to transmit file contents to the client.
1275     By default, when the handling of a request requires no access
1276     to the data within a file -- for example, when delivering a
1277     static file -- Apache httpd uses sendfile to deliver the file contents
1278     without ever reading the file if the OS supports it.</p>
1279
1280     <p>This sendfile mechanism avoids separate read and send operations,
1281     and buffer allocations. But on some platforms or within some
1282     filesystems, it is better to disable this feature to avoid
1283     operational problems:</p>
1284
1285     <ul>
1286     <li>Some platforms may have broken sendfile support that the build
1287     system did not detect, especially if the binaries were built on
1288     another box and moved to such a machine with broken sendfile
1289     support.</li>
1290     <li>On Linux the use of sendfile triggers TCP-checksum
1291     offloading bugs on certain networking cards when using IPv6.</li>
1292     <li>On Linux on Itanium, <code>sendfile</code> may be unable to handle
1293     files over 2GB in size.</li>
1294     <li>With a network-mounted <code class="directive"><a href="#documentroot">DocumentRoot</a></code> (e.g., NFS, SMB, CIFS, FUSE),
1295     the kernel may be unable to serve the network file through
1296     its own cache.</li>
1297     </ul>
1298
1299     <p>For server configurations that are not vulnerable to these problems,
1300     you may enable this feature by specifying:</p>
1301
1302     <pre class="prettyprint lang-config">EnableSendfile On</pre>
1303
1304
1305     <p>For network mounted files, this feature may be disabled explicitly
1306     for the offending files by specifying:</p>
1307
1308     <pre class="prettyprint lang-config">&lt;Directory "/path-to-nfs-files"&gt;
1309   EnableSendfile Off
1310 &lt;/Directory&gt;</pre>
1311
1312     <p>Please note that the per-directory and .htaccess configuration
1313        of <code class="directive">EnableSendfile</code> is not supported by
1314        <code class="module"><a href="../mod/mod_cache_disk.html">mod_cache_disk</a></code>.
1315        Only global definition of <code class="directive">EnableSendfile</code>
1316        is taken into account by the module.
1317     </p>
1318
1319 </div>
1320 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1321 <div class="directive-section"><h2><a name="Error" id="Error">Error</a> <a name="error" id="error">Directive</a></h2>
1322 <table class="directive">
1323 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Abort configuration parsing with a custom error message</td></tr>
1324 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Error <var>message</var></code></td></tr>
1325 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1326 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
1327 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
1328 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>2.3.9 and later</td></tr>
1329 </table>
1330     <p>If an error can be detected within the configuration, this
1331     directive can be used to generate a custom error message, and halt
1332     configuration parsing.  The typical use is for reporting required
1333     modules which are missing from the configuration.</p>
1334
1335     <pre class="prettyprint lang-config"># Example
1336 # ensure that mod_include is loaded
1337 &lt;IfModule !include_module&gt;
1338   Error "mod_include is required by mod_foo.  Load it with LoadModule."
1339 &lt;/IfModule&gt;
1340
1341 # ensure that exactly one of SSL,NOSSL is defined
1342 &lt;IfDefine SSL&gt;
1343 &lt;IfDefine NOSSL&gt;
1344   Error "Both SSL and NOSSL are defined.  Define only one of them."
1345 &lt;/IfDefine&gt;
1346 &lt;/IfDefine&gt;
1347 &lt;IfDefine !SSL&gt;
1348 &lt;IfDefine !NOSSL&gt;
1349   Error "Either SSL or NOSSL must be defined."
1350 &lt;/IfDefine&gt;
1351 &lt;/IfDefine&gt;</pre>
1352
1353
1354
1355 </div>
1356 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1357 <div class="directive-section"><h2><a name="ErrorDocument" id="ErrorDocument">ErrorDocument</a> <a name="errordocument" id="errordocument">Directive</a></h2>
1358 <table class="directive">
1359 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>What the server will return to the client
1360 in case of an error</td></tr>
1361 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ErrorDocument <var>error-code</var> <var>document</var></code></td></tr>
1362 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1363 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
1364 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
1365 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
1366 </table>
1367     <p>In the event of a problem or error, Apache httpd can be configured
1368     to do one of four things,</p>
1369
1370     <ol>
1371       <li>output a simple hardcoded error message</li>
1372
1373       <li>output a customized message</li>
1374
1375       <li>internally redirect to a local <var>URL-path</var> to handle the
1376       problem/error</li>
1377
1378       <li>redirect to an external <var>URL</var> to handle the
1379       problem/error</li>
1380     </ol>
1381
1382     <p>The first option is the default, while options 2-4 are
1383     configured using the <code class="directive">ErrorDocument</code>
1384     directive, which is followed by the HTTP response code and a URL
1385     or a message. Apache httpd will sometimes offer additional information
1386     regarding the problem/error.</p>
1387
1388     <p>From 2.4.13, <a href="../expr.html">expression syntax</a> can be
1389     used inside the directive to produce dynamic strings and URLs.</p>
1390
1391     <p>URLs can begin with a slash (/) for local web-paths (relative
1392     to the <code class="directive"><a href="#documentroot">DocumentRoot</a></code>), or be a
1393     full URL which the client can resolve. Alternatively, a message
1394     can be provided to be displayed by the browser. Note that deciding
1395     whether the parameter is an URL, a path or a message is performed
1396     before any expression is parsed. Examples:</p>
1397
1398     <pre class="prettyprint lang-config">ErrorDocument 500 http://example.com/cgi-bin/server-error.cgi
1399 ErrorDocument 404 /errors/bad_urls.php
1400 ErrorDocument 401 /subscription_info.html
1401 ErrorDocument 403 "Sorry, can't allow you access today"
1402 ErrorDocument 403 Forbidden!
1403 ErrorDocument 403 /errors/forbidden.py?referrer=%{escape:%{HTTP_REFERER}}</pre>
1404
1405
1406     <p>Additionally, the special value <code>default</code> can be used
1407     to specify Apache httpd's simple hardcoded message.  While not required
1408     under normal circumstances, <code>default</code> will restore
1409     Apache httpd's simple hardcoded message for configurations that would
1410     otherwise inherit an existing <code class="directive">ErrorDocument</code>.</p>
1411
1412     <pre class="prettyprint lang-config">ErrorDocument 404 /cgi-bin/bad_urls.pl
1413
1414 &lt;Directory "/web/docs"&gt;
1415   ErrorDocument 404 default
1416 &lt;/Directory&gt;</pre>
1417
1418
1419     <p>Note that when you specify an <code class="directive">ErrorDocument</code>
1420     that points to a remote URL (ie. anything with a method such as
1421     <code>http</code> in front of it), Apache HTTP Server will send a redirect to the
1422     client to tell it where to find the document, even if the
1423     document ends up being on the same server. This has several
1424     implications, the most important being that the client will not
1425     receive the original error status code, but instead will
1426     receive a redirect status code. This in turn can confuse web
1427     robots and other clients which try to determine if a URL is
1428     valid using the status code. In addition, if you use a remote
1429     URL in an <code>ErrorDocument 401</code>, the client will not
1430     know to prompt the user for a password since it will not
1431     receive the 401 status code. Therefore, <strong>if you use an
1432     <code>ErrorDocument 401</code> directive, then it must refer to a local
1433     document.</strong></p>
1434
1435     <p>Microsoft Internet Explorer (MSIE) will by default ignore
1436     server-generated error messages when they are "too small" and substitute
1437     its own "friendly" error messages. The size threshold varies depending on
1438     the type of error, but in general, if you make your error document
1439     greater than 512 bytes, then MSIE will show the server-generated
1440     error rather than masking it.  More information is available in
1441     Microsoft Knowledge Base article <a href="http://support.microsoft.com/default.aspx?scid=kb;en-us;Q294807">Q294807</a>.</p>
1442
1443     <p>Although most error messages can be overridden, there are certain
1444     circumstances where the internal messages are used regardless of the
1445     setting of <code class="directive"><a href="#errordocument">ErrorDocument</a></code>.  In
1446     particular, if a malformed request is detected, normal request processing
1447     will be immediately halted and the internal error message returned.
1448     This is necessary to guard against security problems caused by
1449     bad requests.</p>
1450
1451     <p>If you are using mod_proxy, you may wish to enable
1452     <code class="directive"><a href="../mod/mod_proxy.html#proxyerroroverride">ProxyErrorOverride</a></code> so that you can provide
1453     custom error messages on behalf of your Origin servers. If you don't enable ProxyErrorOverride,
1454     Apache httpd will not generate custom error documents for proxied content.</p>
1455
1456 <h3>See also</h3>
1457 <ul>
1458 <li><a href="../custom-error.html">documentation of
1459     customizable responses</a></li>
1460 </ul>
1461 </div>
1462 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1463 <div class="directive-section"><h2><a name="ErrorLog" id="ErrorLog">ErrorLog</a> <a name="errorlog" id="errorlog">Directive</a></h2>
1464 <table class="directive">
1465 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Location where the server will log errors</td></tr>
1466 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code> ErrorLog <var>file-path</var>|syslog[:<var>facility</var>]</code></td></tr>
1467 <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>
1468 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1469 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
1470 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
1471 </table>
1472     <p>The <code class="directive">ErrorLog</code> directive sets the name of
1473     the file to which the server will log any errors it encounters. If
1474     the <var>file-path</var> is not absolute then it is assumed to be
1475     relative to the <code class="directive"><a href="#serverroot">ServerRoot</a></code>.</p>
1476
1477     <pre class="prettyprint lang-config">ErrorLog "/var/log/httpd/error_log"</pre>
1478
1479
1480     <p>If the <var>file-path</var>
1481     begins with a pipe character "<code>|</code>" then it is assumed to be a
1482     command to spawn to handle the error log.</p>
1483
1484     <pre class="prettyprint lang-config">ErrorLog "|/usr/local/bin/httpd_errors"</pre>
1485
1486
1487     <p>See the notes on <a href="../logs.html#piped">piped logs</a> for
1488     more information.</p>
1489
1490     <p>Using <code>syslog</code> instead of a filename enables logging
1491     via syslogd(8) if the system supports it and if <code class="module"><a href="../mod/mod_syslog.html">mod_syslog</a></code>
1492     is loaded. The default is to use syslog facility <code>local7</code>,
1493     but you can override this by using the <code>syslog:<var>facility</var></code>
1494     syntax where <var>facility</var> can be one of the names usually documented in
1495     syslog(1).  The facility is effectively global, and if it is changed
1496     in individual virtual hosts, the final facility specified affects the
1497     entire server.</p>
1498
1499     <pre class="prettyprint lang-config">ErrorLog syslog:user</pre>
1500
1501
1502     <p>Additional modules can provide their own ErrorLog providers. The syntax
1503     is similar to the <code>syslog</code> example above.</p>
1504
1505     <p>SECURITY: See the <a href="../misc/security_tips.html#serverroot">security tips</a>
1506     document for details on why your security could be compromised
1507     if the directory where log files are stored is writable by
1508     anyone other than the user that starts the server.</p>
1509     <div class="warning"><h3>Note</h3>
1510       <p>When entering a file path on non-Unix platforms, care should be taken
1511       to make sure that only forward slashes are used even though the platform
1512       may allow the use of back slashes. In general it is a good idea to always
1513       use forward slashes throughout the configuration files.</p>
1514     </div>
1515
1516 <h3>See also</h3>
1517 <ul>
1518 <li><code class="directive"><a href="#loglevel">LogLevel</a></code></li>
1519 <li><a href="../logs.html">Apache HTTP Server Log Files</a></li>
1520 </ul>
1521 </div>
1522 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1523 <div class="directive-section"><h2><a name="ErrorLogFormat" id="ErrorLogFormat">ErrorLogFormat</a> <a name="errorlogformat" id="errorlogformat">Directive</a></h2>
1524 <table class="directive">
1525 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Format specification for error log entries</td></tr>
1526 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code> ErrorLogFormat [connection|request] <var>format</var></code></td></tr>
1527 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1528 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
1529 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
1530 </table>
1531     <p><code class="directive">ErrorLogFormat</code> allows to specify what
1532     supplementary information is logged in the error log in addition to the
1533     actual log message.</p>
1534
1535     <pre class="prettyprint lang-config">#Simple example
1536 ErrorLogFormat "[%t] [%l] [pid %P] %F: %E: [client %a] %M"</pre>
1537
1538
1539     <p>Specifying <code>connection</code> or <code>request</code> as first
1540     parameter allows to specify additional formats, causing additional
1541     information to be logged when the first message is logged for a specific
1542     connection or request, respectively. This additional information is only
1543     logged once per connection/request. If a connection or request is processed
1544     without causing any log message, the additional information is not logged
1545     either.</p>
1546
1547     <p>It can happen that some format string items do not produce output.  For
1548     example, the Referer header is only present if the log message is
1549     associated to a request and the log message happens at a time when the
1550     Referer header has already been read from the client.  If no output is
1551     produced, the default behavior is to delete everything from the preceding
1552     space character to the next space character.  This means the log line is
1553     implicitly divided into fields on non-whitespace to whitespace transitions.
1554     If a format string item does not produce output, the whole field is
1555     omitted.  For example, if the remote address <code>%a</code> in the log
1556     format <code>[%t] [%l] [%a] %M&nbsp;</code> is not available, the surrounding
1557     brackets are not logged either.  Space characters can be escaped with a
1558     backslash to prevent them from delimiting a field.  The combination '%&nbsp;'
1559     (percent space) is a zero-width field delimiter that does not produce any
1560     output.</p>
1561
1562     <p>The above behavior can be changed by adding modifiers to the format
1563     string item. A <code>-</code> (minus) modifier causes a minus to be logged if the
1564     respective item does not produce any output. In once-per-connection/request
1565     formats, it is also possible to use the <code>+</code> (plus) modifier. If an
1566     item with the plus modifier does not produce any output, the whole line is
1567     omitted.</p>
1568
1569     <p>A number as modifier can be used to assign a log severity level to a
1570     format item. The item will only be logged if the severity of the log
1571     message is not higher than the specified log severity level. The number can
1572     range from 1 (alert) over 4 (warn) and 7 (debug) to 15 (trace8).</p>
1573
1574     <p>For example, here's what would happen if you added modifiers to
1575     the <code>%{Referer}i</code> token, which logs the
1576     <code>Referer</code> request header.</p>
1577
1578     <table class="bordered"><tr class="header"><th>Modified Token</th><th>Meaning</th></tr>
1579 <tr>
1580     <td><code>%-{Referer}i</code></td>
1581     <td>Logs a <code>-</code> if <code>Referer</code> is not set.</td>
1582     </tr>
1583 <tr class="odd">
1584     <td><code>%+{Referer}i</code></td>
1585     <td>Omits the entire line if <code>Referer</code> is not set.</td>
1586     </tr>
1587 <tr>
1588     <td><code>%4{Referer}i</code></td>
1589     <td>Logs the <code>Referer</code> only if the log message severity
1590     is higher than 4.</td>
1591     </tr>
1592 </table>
1593
1594     <p>Some format string items accept additional parameters in braces.</p>
1595
1596     <table class="bordered"><tr class="header"><th>Format&nbsp;String</th> <th>Description</th></tr>
1597 <tr><td><code>%%</code></td>
1598         <td>The percent sign</td></tr>
1599 <tr class="odd"><td><code>%a</code></td>
1600         <td>Client IP address and port of the request</td></tr>
1601 <tr><td><code>%{c}a</code></td>
1602         <td>Underlying peer IP address and port of the connection (see the
1603             <code class="module"><a href="../mod/mod_remoteip.html">mod_remoteip</a></code> module)</td></tr>
1604 <tr class="odd"><td><code>%A</code></td>
1605         <td>Local IP-address and port</td></tr>
1606 <tr><td><code>%{<em>name</em>}e</code></td>
1607         <td>Request environment variable <em>name</em></td></tr>
1608 <tr class="odd"><td><code>%E</code></td>
1609         <td>APR/OS error status code and string</td></tr>
1610 <tr><td><code>%F</code></td>
1611         <td>Source file name and line number of the log call</td></tr>
1612 <tr class="odd"><td><code>%{<em>name</em>}i</code></td>
1613         <td>Request header <em>name</em></td></tr>
1614 <tr><td><code>%k</code></td>
1615         <td>Number of keep-alive requests on this connection</td></tr>
1616 <tr class="odd"><td><code>%l</code></td>
1617         <td>Loglevel of the message</td></tr>
1618 <tr><td><code>%L</code></td>
1619         <td>Log ID of the request</td></tr>
1620 <tr class="odd"><td><code>%{c}L</code></td>
1621         <td>Log ID of the connection</td></tr>
1622 <tr><td><code>%{C}L</code></td>
1623         <td>Log ID of the connection if used in connection scope, empty otherwise</td></tr>
1624 <tr class="odd"><td><code>%m</code></td>
1625         <td>Name of the module logging the message</td></tr>
1626 <tr><td><code>%M</code></td>
1627         <td>The actual log message</td></tr>
1628 <tr class="odd"><td><code>%{<em>name</em>}n</code></td>
1629         <td>Request note <em>name</em></td></tr>
1630 <tr><td><code>%P</code></td>
1631         <td>Process ID of current process</td></tr>
1632 <tr class="odd"><td><code>%T</code></td>
1633         <td>Thread ID of current thread</td></tr>
1634 <tr><td><code>%{g}T</code></td>
1635         <td>System unique thread ID of current thread (the same ID as
1636             displayed by e.g. <code>top</code>; currently Linux only)</td></tr>
1637 <tr class="odd"><td><code>%t</code></td>
1638         <td>The current time</td></tr>
1639 <tr><td><code>%{u}t</code></td>
1640         <td>The current time including micro-seconds</td></tr>
1641 <tr class="odd"><td><code>%{cu}t</code></td>
1642         <td>The current time in compact ISO 8601 format, including
1643             micro-seconds</td></tr>
1644 <tr><td><code>%v</code></td>
1645         <td>The canonical <code class="directive"><a href="#servername">ServerName</a></code>
1646             of the current server.</td></tr>
1647 <tr class="odd"><td><code>%V</code></td>
1648         <td>The server name of the server serving the request according to the
1649             <code class="directive"><a href="#usecanonicalname">UseCanonicalName</a></code>
1650             setting.</td></tr>
1651 <tr><td><code>\&nbsp;</code> (backslash space)</td>
1652         <td>Non-field delimiting space</td></tr>
1653 <tr class="odd"><td><code>%&nbsp;</code> (percent space)</td>
1654         <td>Field delimiter (no output)</td></tr>
1655 </table>
1656
1657     <p>The log ID format <code>%L</code> produces a unique id for a connection
1658     or request. This can be used to correlate which log lines belong to the
1659     same connection or request, which request happens on which connection.
1660     A <code>%L</code> format string is also available in
1661     <code class="module"><a href="../mod/mod_log_config.html">mod_log_config</a></code> to allow to correlate access log entries
1662     with error log lines. If <code class="module"><a href="../mod/mod_unique_id.html">mod_unique_id</a></code> is loaded, its
1663     unique id will be used as log ID for requests.</p>
1664
1665     <pre class="prettyprint lang-config">#Example (default format for threaded MPMs)
1666 ErrorLogFormat "[%{u}t] [%-m:%l] [pid %P:tid %T] %7F: %E: [client\ %a] %M% ,\ referer\ %{Referer}i"</pre>
1667
1668
1669     <p>This would result in error messages such as:</p>
1670
1671     <div class="example"><p><code>
1672     [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
1673     </code></p></div>
1674
1675     <p>Notice that, as discussed above, some fields are omitted
1676     entirely because they are not defined.</p>
1677
1678     <pre class="prettyprint lang-config">#Example (similar to the 2.2.x format)
1679 ErrorLogFormat "[%t] [%l] %7F: %E: [client\ %a] %M% ,\ referer\ %{Referer}i"</pre>
1680
1681
1682     <pre class="prettyprint lang-config">#Advanced example with request/connection log IDs
1683 ErrorLogFormat "[%{uc}t] [%-m:%-l] [R:%L] [C:%{C}L] %7F: %E: %M"
1684 ErrorLogFormat request "[%{uc}t] [R:%L] Request %k on C:%{c}L pid:%P tid:%T"
1685 ErrorLogFormat request "[%{uc}t] [R:%L] UA:'%+{User-Agent}i'"
1686 ErrorLogFormat request "[%{uc}t] [R:%L] Referer:'%+{Referer}i'"
1687 ErrorLogFormat connection "[%{uc}t] [C:%{c}L] local\ %a remote\ %A"</pre>
1688
1689
1690
1691 <h3>See also</h3>
1692 <ul>
1693 <li><code class="directive"><a href="#errorlog">ErrorLog</a></code></li>
1694 <li><code class="directive"><a href="#loglevel">LogLevel</a></code></li>
1695 <li><a href="../logs.html">Apache HTTP Server Log Files</a></li>
1696 </ul>
1697 </div>
1698 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1699 <div class="directive-section"><h2><a name="ExtendedStatus" id="ExtendedStatus">ExtendedStatus</a> <a name="extendedstatus" id="extendedstatus">Directive</a></h2>
1700 <table class="directive">
1701 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Keep track of extended status information for each
1702 request</td></tr>
1703 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ExtendedStatus On|Off</code></td></tr>
1704 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ExtendedStatus Off[*]</code></td></tr>
1705 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
1706 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
1707 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
1708 </table>
1709     <p>This option tracks additional data per worker about the
1710     currently executing request and creates a utilization summary.
1711     You can see these variables during runtime by configuring
1712     <code class="module"><a href="../mod/mod_status.html">mod_status</a></code>.  Note that other modules may
1713     rely on this scoreboard.</p>
1714
1715     <p>This setting applies to the entire server and cannot be
1716     enabled or disabled on a virtualhost-by-virtualhost basis.
1717     The collection of extended status information can slow down
1718     the server.  Also note that this setting cannot be changed
1719     during a graceful restart.</p>
1720
1721     <div class="note">
1722     <p>Note that loading <code class="module"><a href="../mod/mod_status.html">mod_status</a></code> will change
1723     the default behavior to ExtendedStatus On, while other
1724     third party modules may do the same.  Such modules rely on
1725     collecting detailed information about the state of all workers.
1726     The default is changed by <code class="module"><a href="../mod/mod_status.html">mod_status</a></code> beginning
1727     with version 2.3.6. The previous default was always Off.</p>
1728     </div>
1729
1730
1731 </div>
1732 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1733 <div class="directive-section"><h2><a name="FileETag" id="FileETag">FileETag</a> <a name="fileetag" id="fileetag">Directive</a></h2>
1734 <table class="directive">
1735 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File attributes used to create the ETag
1736 HTTP response header for static files</td></tr>
1737 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>FileETag <var>component</var> ...</code></td></tr>
1738 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>FileETag MTime Size</code></td></tr>
1739 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1740 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
1741 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
1742 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
1743 <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
1744 earlier.</td></tr>
1745 </table>
1746     <p>
1747     The <code class="directive">FileETag</code> directive configures the file
1748     attributes that are used to create the <code>ETag</code> (entity
1749     tag) response header field when the document is based on a static file.
1750     (The <code>ETag</code> value is used in cache management to save
1751     network bandwidth.) The
1752     <code class="directive">FileETag</code> directive allows you to choose
1753     which of these -- if any -- should be used. The recognized keywords are:
1754     </p>
1755
1756     <dl>
1757      <dt><strong>INode</strong></dt>
1758      <dd>The file's i-node number will be included in the calculation</dd>
1759      <dt><strong>MTime</strong></dt>
1760      <dd>The date and time the file was last modified will be included</dd>
1761      <dt><strong>Size</strong></dt>
1762      <dd>The number of bytes in the file will be included</dd>
1763      <dt><strong>All</strong></dt>
1764      <dd>All available fields will be used. This is equivalent to:
1765          <pre class="prettyprint lang-config">FileETag INode MTime Size</pre>
1766 </dd>
1767      <dt><strong>None</strong></dt>
1768      <dd>If a document is file-based, no <code>ETag</code> field will be
1769        included in the response</dd>
1770     </dl>
1771
1772     <p>The <code>INode</code>, <code>MTime</code>, and <code>Size</code>
1773     keywords may be prefixed with either <code>+</code> or <code>-</code>,
1774     which allow changes to be made to the default setting inherited
1775     from a broader scope. Any keyword appearing without such a prefix
1776     immediately and completely cancels the inherited setting.</p>
1777
1778     <p>If a directory's configuration includes
1779     <code>FileETag&nbsp;INode&nbsp;MTime&nbsp;Size</code>, and a
1780     subdirectory's includes <code>FileETag&nbsp;-INode</code>,
1781     the setting for that subdirectory (which will be inherited by
1782     any sub-subdirectories that don't override it) will be equivalent to
1783     <code>FileETag&nbsp;MTime&nbsp;Size</code>.</p>
1784     <div class="warning"><h3>Warning</h3>
1785     Do not change the default for directories or locations that have WebDAV
1786     enabled and use <code class="module"><a href="../mod/mod_dav_fs.html">mod_dav_fs</a></code> as a storage provider.
1787     <code class="module"><a href="../mod/mod_dav_fs.html">mod_dav_fs</a></code> uses <code>MTime&nbsp;Size</code>
1788     as a fixed format for <code>ETag</code> comparisons on conditional requests.
1789     These conditional requests will break if the <code>ETag</code> format is
1790     changed via <code class="directive">FileETag</code>.
1791     </div>
1792     <div class="note"><h3>Server Side Includes</h3>
1793     An ETag is not generated for responses parsed by <code class="module"><a href="../mod/mod_include.html">mod_include</a></code>
1794     since the response entity can change without a change of the INode, MTime, or Size
1795     of the static file with embedded SSI directives.
1796     </div>
1797
1798
1799 </div>
1800 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1801 <div class="directive-section"><h2><a name="Files" id="Files">&lt;Files&gt;</a> <a name="files" id="files">Directive</a></h2>
1802 <table class="directive">
1803 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Contains directives that apply to matched
1804 filenames</td></tr>
1805 <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>
1806 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1807 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1808 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
1809 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
1810 </table>
1811     <p>The <code class="directive">&lt;Files&gt;</code> directive
1812     limits the scope of the enclosed directives by filename. It is comparable
1813     to the <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code>
1814     and <code class="directive"><a href="#location">&lt;Location&gt;</a></code>
1815     directives. It should be matched with a <code>&lt;/Files&gt;</code>
1816     directive. The directives given within this section will be applied to
1817     any object with a basename (last component of filename) matching the
1818     specified filename. <code class="directive">&lt;Files&gt;</code>
1819     sections are processed in the order they appear in the
1820     configuration file, after the <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code> sections and
1821     <code>.htaccess</code> files are read, but before <code class="directive"><a href="#location">&lt;Location&gt;</a></code> sections. Note
1822     that <code class="directive">&lt;Files&gt;</code> can be nested
1823     inside <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code> sections to restrict the
1824     portion of the filesystem they apply to.</p>
1825
1826     <p>The <var>filename</var> argument should include a filename, or
1827     a wild-card string, where <code>?</code> matches any single character,
1828     and <code>*</code> matches any sequences of characters.</p>
1829     <pre class="prettyprint lang-config">&lt;Files "cat.html"&gt;
1830     # Insert stuff that applies to cat.html here
1831 &lt;/Files&gt;
1832
1833 &lt;Files "?at.*"&gt;
1834     # This would apply to cat.html, bat.html, hat.php and so on.
1835 &lt;/Files&gt;</pre>
1836
1837     <p><a class="glossarylink" href="../glossary.html#regex" title="see glossary">Regular expressions</a>
1838     can also be used, with the addition of the
1839     <code>~</code> character. For example:</p>
1840
1841     <pre class="prettyprint lang-config">&lt;Files ~ "\.(gif|jpe?g|png)$"&gt;
1842     #...
1843 &lt;/Files&gt;</pre>
1844
1845
1846     <p>would match most common Internet graphics formats. <code class="directive"><a href="#filesmatch">&lt;FilesMatch&gt;</a></code> is preferred,
1847     however.</p>
1848
1849     <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
1850     <code>.htaccess</code> files. This allows users to control access to
1851     their own files, at a file-by-file level.</p>
1852
1853
1854 <h3>See also</h3>
1855 <ul>
1856 <li><a href="../sections.html">How &lt;Directory&gt;, &lt;Location&gt;
1857     and &lt;Files&gt; sections work</a> for an explanation of how these
1858     different sections are combined when a request is received</li>
1859 </ul>
1860 </div>
1861 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1862 <div class="directive-section"><h2><a name="FilesMatch" id="FilesMatch">&lt;FilesMatch&gt;</a> <a name="filesmatch" id="filesmatch">Directive</a></h2>
1863 <table class="directive">
1864 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Contains directives that apply to regular-expression matched
1865 filenames</td></tr>
1866 <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>
1867 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1868 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1869 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
1870 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
1871 </table>
1872     <p>The <code class="directive">&lt;FilesMatch&gt;</code> directive
1873     limits the scope of the enclosed directives by filename, just as the
1874     <code class="directive"><a href="#files">&lt;Files&gt;</a></code> directive
1875     does. However, it accepts a <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular
1876     expression</a>. For example:</p>
1877
1878     <pre class="prettyprint lang-config">&lt;FilesMatch ".+\.(gif|jpe?g|png)$"&gt;
1879     # ...
1880 &lt;/FilesMatch&gt;</pre>
1881
1882
1883     <p>would match most common Internet graphics formats.</p>
1884
1885     <div class="note">The <code>.+</code> at the start of the regex ensures that
1886     files named <code>.png</code>, or <code>.gif</code>, for example,
1887     are not matched.</div>
1888
1889     <p>From 2.4.8 onwards, named groups and backreferences are captured and
1890     written to the environment with the corresponding name prefixed with
1891     "MATCH_" and in upper case. This allows elements of files to be referenced
1892     from within <a href="../expr.html">expressions</a> and modules like
1893     <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>. In order to prevent confusion, numbered
1894     (unnamed) backreferences are ignored. Use named groups instead.</p>
1895
1896     <pre class="prettyprint lang-config">&lt;FilesMatch "^(?&lt;sitename&gt;[^/]+)"&gt;
1897     require ldap-group cn=%{env:MATCH_SITENAME},ou=combined,o=Example
1898 &lt;/FilesMatch&gt;</pre>
1899
1900
1901 <h3>See also</h3>
1902 <ul>
1903 <li><a href="../sections.html">How &lt;Directory&gt;, &lt;Location&gt;
1904     and &lt;Files&gt; sections work</a> for an explanation of how these
1905     different sections are combined when a request is received</li>
1906 </ul>
1907 </div>
1908 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1909 <div class="directive-section"><h2><a name="ForceType" id="ForceType">ForceType</a> <a name="forcetype" id="forcetype">Directive</a></h2>
1910 <table class="directive">
1911 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Forces all matching files to be served with the specified
1912 media type in the HTTP Content-Type header field</td></tr>
1913 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ForceType <var>media-type</var>|None</code></td></tr>
1914 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
1915 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
1916 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
1917 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
1918 </table>
1919     <p>When placed into an <code>.htaccess</code> file or a
1920     <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code>, or
1921     <code class="directive"><a href="#location">&lt;Location&gt;</a></code> or
1922     <code class="directive"><a href="#files">&lt;Files&gt;</a></code>
1923     section, this directive forces all matching files to be served
1924     with the content type identification given by
1925     <var>media-type</var>. For example, if you had a directory full of
1926     GIF files, but did not want to label them all with <code>.gif</code>,
1927     you might want to use:</p>
1928
1929     <pre class="prettyprint lang-config">ForceType image/gif</pre>
1930
1931
1932     <p>Note that this directive overrides other indirect media type
1933     associations defined in mime.types or via the
1934     <code class="directive"><a href="../mod/mod_mime.html#addtype">AddType</a></code>.</p>
1935
1936     <p>You can also override more general
1937     <code class="directive">ForceType</code> settings
1938     by using the value of <code>None</code>:</p>
1939
1940     <pre class="prettyprint lang-config"># force all files to be image/gif:
1941 &lt;Location "/images"&gt;
1942   ForceType image/gif
1943 &lt;/Location&gt;
1944
1945 # but normal mime-type associations here:
1946 &lt;Location "/images/mixed"&gt;
1947   ForceType None
1948 &lt;/Location&gt;</pre>
1949
1950
1951     <p>This directive primarily overrides the content types generated for
1952     static files served out of the filesystem.  For resources other than
1953     static files, where the generator of the response typically specifies
1954     a Content-Type, this directive has no effect.</p>
1955
1956
1957     <div class="note"><h3>Note</h3>
1958     <p>If no handler is explicitly set for a request, the specified content
1959     type will also be used as the handler name. </p>
1960
1961     <p>When explicit directives such as
1962     <code class="directive"><a href="#sethandler">SetHandler</a></code> or
1963     <code class="directive"><a href="../mod/mod_mime.html#addhandler">AddHandler</a></code> do not apply
1964     to the current request, the internal handler name normally set by those
1965     directives is instead set to the content type specified by this directive.
1966     </p>
1967     <p>
1968     This is a historical behavior that some third-party modules
1969     (such as mod_php) may look for a "synthetic" content type used only to
1970     signal the module to take responsibility for the matching request.
1971     </p>
1972
1973     <p>Configurations that rely on such "synthetic" types should be avoided.
1974     Additionally, configurations that restrict access to
1975     <code class="directive"><a href="#sethandler">SetHandler</a></code> or
1976     <code class="directive"><a href="../mod/mod_mime.html#addhandler">AddHandler</a></code> should
1977     restrict access to this directive as well.</p>
1978     </div>
1979
1980
1981 </div>
1982 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1983 <div class="directive-section"><h2><a name="GprofDir" id="GprofDir">GprofDir</a> <a name="gprofdir" id="gprofdir">Directive</a></h2>
1984 <table class="directive">
1985 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Directory to write gmon.out profiling data to.  </td></tr>
1986 <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>
1987 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1988 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
1989 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
1990 </table>
1991     <p>When the server has been compiled with gprof profiling support,
1992     <code class="directive">GprofDir</code> causes <code>gmon.out</code> files to
1993     be written to the specified directory when the process exits.  If the
1994     argument ends with a percent symbol ('%'), subdirectories are created
1995     for each process id.</p>
1996
1997     <p>This directive currently only works with the <code class="module"><a href="../mod/prefork.html">prefork</a></code>
1998     MPM.</p>
1999
2000 </div>
2001 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2002 <div class="directive-section"><h2><a name="HostnameLookups" id="HostnameLookups">HostnameLookups</a> <a name="hostnamelookups" id="hostnamelookups">Directive</a></h2>
2003 <table class="directive">
2004 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables DNS lookups on client IP addresses</td></tr>
2005 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>HostnameLookups On|Off|Double</code></td></tr>
2006 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>HostnameLookups Off</code></td></tr>
2007 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
2008 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2009 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2010 </table>
2011     <p>This directive enables DNS lookups so that host names can be
2012     logged (and passed to CGIs/SSIs in <code>REMOTE_HOST</code>).
2013     The value <code>Double</code> refers to doing double-reverse
2014     DNS lookup. That is, after a reverse lookup is performed, a forward
2015     lookup is then performed on that result. At least one of the IP
2016     addresses in the forward lookup must match the original
2017     address. (In "tcpwrappers" terminology this is called
2018     <code>PARANOID</code>.)</p>
2019
2020     <p>Regardless of the setting, when <code class="module"><a href="../mod/mod_authz_host.html">mod_authz_host</a></code> is
2021     used for controlling access by hostname, a double reverse lookup
2022     will be performed.  This is necessary for security. Note that the
2023     result of this double-reverse isn't generally available unless you
2024     set <code>HostnameLookups Double</code>. For example, if only
2025     <code>HostnameLookups On</code> and a request is made to an object
2026     that is protected by hostname restrictions, regardless of whether
2027     the double-reverse fails or not, CGIs will still be passed the
2028     single-reverse result in <code>REMOTE_HOST</code>.</p>
2029
2030     <p>The default is <code>Off</code> in order to save the network
2031     traffic for those sites that don't truly need the reverse
2032     lookups done. It is also better for the end users because they
2033     don't have to suffer the extra latency that a lookup entails.
2034     Heavily loaded sites should leave this directive
2035     <code>Off</code>, since DNS lookups can take considerable
2036     amounts of time. The utility <code class="program"><a href="../programs/logresolve.html">logresolve</a></code>, compiled by
2037     default to the <code>bin</code> subdirectory of your installation
2038     directory, can be used to look up host names from logged IP addresses
2039     offline.</p>
2040
2041     <p>Finally, if you have <a href="mod_authz_host.html#reqhost">hostname-based Require
2042     directives</a>, a hostname lookup will be performed regardless of
2043     the setting of <code>HostnameLookups</code>.</p>
2044
2045 </div>
2046 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2047 <div class="directive-section"><h2><a name="HttpProtocolOptions" id="HttpProtocolOptions">HttpProtocolOptions</a> <a name="httpprotocoloptions" id="httpprotocoloptions">Directive</a></h2>
2048 <table class="directive">
2049 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Modify restrictions on HTTP Request Messages</td></tr>
2050 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>HttpProtocolOptions [Strict|Unsafe] [RegisteredMethods|LenientMethods]
2051  [Allow0.9|Require1.0]</code></td></tr>
2052 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>HttpProtocolOptions Strict LenientMethods Allow0.9</code></td></tr>
2053 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2054 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2055 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2056 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>2.2.32 or 2.4.24 and later</td></tr>
2057 </table>
2058     <p>This directive changes the rules applied to the HTTP Request Line
2059     (<a href="https://tools.ietf.org/html/rfc7230#section-3.1.1">RFC 7230 §3.1.1</a>) and the HTTP Request Header Fields
2060     (<a href="https://tools.ietf.org/html/rfc7230#section-3.2">RFC 7230 §3.2</a>), which are now applied by default or using
2061     the <code>Strict</code> option. Due to legacy modules, applications or
2062     custom user-agents which must be deprecated the <code>Unsafe</code>
2063     option has been added to revert to the legacy behaviors.</p>
2064
2065     <p>These rules are applied prior to request processing,
2066     so must be configured at the global or default (first) matching
2067     virtual host section, by IP/port interface (and not by name)
2068     to be honored.</p>
2069
2070     <p>The directive accepts three parameters from the following list
2071        of choices, applying the default to the ones not specified:</p>
2072
2073     <dl>
2074     <dt>Strict|Unsafe</dt>
2075     <dd>
2076       <p>Prior to the introduction of this directive, the Apache HTTP Server
2077       request message parsers were tolerant of a number of forms of input
2078       which did not conform to the protocol.
2079       <a href="https://tools.ietf.org/html/rfc7230#section-9.4">RFC 7230 §9.4 Request Splitting</a> and
2080       <a href="https://tools.ietf.org/html/rfc7230#section-9.5">§9.5 Response Smuggling</a> call out only two of the potential
2081       risks of accepting non-conformant request messages, while
2082       <a href="https://tools.ietf.org/html/rfc7230#section-3.5">RFC 7230 §3.5</a> "Message Parsing Robustness" identify the
2083       risks of accepting obscure whitespace and request message formatting.
2084       As of the introduction of this directive, all grammar rules of the
2085       specification are enforced in the default <code>Strict</code> operating
2086       mode, and the strict whitespace suggested by section 3.5 is enforced
2087       and cannot be relaxed.</p>
2088
2089       <div class="warning"><h3>Security risks of Unsafe</h3>
2090         <p>Users are strongly cautioned against toggling the <code>Unsafe</code>
2091         mode of operation, particularly on outward-facing, publicly accessible
2092         server deployments.  If an interface is required for faulty monitoring
2093         or other custom service consumers running on an intranet, users should
2094         toggle the Unsafe option only on a specific virtual host configured
2095         to service their internal private network.</p>
2096       </div>
2097
2098       <div class="example"><h3>Example of a request leading to HTTP 400 with Strict mode</h3><p><code>
2099
2100         # Missing CRLF<br />
2101         GET / HTTP/1.0\n\n
2102       </code></p></div>
2103     </dd>
2104     <dt>RegisteredMethods|LenientMethods</dt>
2105     <dd>
2106       <p><a href="https://tools.ietf.org/html/rfc7231#section-4.1">RFC 7231 §4.1</a> "Request Methods" "Overview" requires that
2107       origin servers shall respond with a HTTP 501 status code when an
2108       unsupported method is encountered in the request line.
2109       This already happens when the <code>LenientMethods</code> option is used,
2110       but administrators may wish to toggle the <code>RegisteredMethods</code>
2111       option and register any non-standard methods using the
2112       <code class="directive"><a href="#registerhttpmethod">RegisterHttpMethod</a></code>
2113       directive, particularly if the <code>Unsafe</code>
2114       option has been toggled.</p>
2115
2116       <div class="warning"><h3>Forward Proxy compatibility</h3>
2117         <p>The <code>RegisteredMethods</code> option should <strong>not</strong>
2118         be toggled for forward proxy hosts, as the methods supported by the
2119         origin servers are unknown to the proxy server.</p>
2120       </div>
2121
2122       <div class="example"><h3>Example of a request leading to HTTP 501 with LenientMethods mode</h3><p><code>
2123
2124         # Unknown HTTP method<br />
2125         WOW / HTTP/1.0\r\n\r\n<br /><br />
2126         # Lowercase HTTP method<br />
2127         get / HTTP/1.0\r\n\r\n<br />
2128       </code></p></div>
2129       </dd>
2130       <dt>Allow0.9|Require1.0</dt>
2131       <dd>
2132       <p><a href="https://tools.ietf.org/html/rfc2616#section-19.6">RFC 2616 §19.6</a> "Compatibility With Previous Versions" had
2133       encouraged HTTP servers to support legacy HTTP/0.9 requests. RFC 7230
2134       supersedes this with "The expectation to support HTTP/0.9 requests has
2135       been removed" and offers additional comments in
2136       <a href="https://tools.ietf.org/html/rfc7230#appendix-A">RFC 7230 Appendix A</a>. The <code>Require1.0</code> option allows
2137       the user to remove support of the default <code>Allow0.9</code> option's
2138       behavior.</p>
2139
2140       <div class="example"><h3>Example of a request leading to HTTP 400 with Require1.0 mode</h3><p><code>
2141
2142         # Unsupported HTTP version<br />
2143         GET /\r\n\r\n
2144       </code></p></div>
2145     </dd>
2146     </dl>
2147     <p>Reviewing the messages logged to the
2148     <code class="directive"><a href="#errorlog">ErrorLog</a></code>, configured with
2149     <code class="directive"><a href="#loglevel">LogLevel</a></code> <code>debug</code> level,
2150     can help identify such faulty requests along with their origin.
2151     Users should pay particular attention to the 400 responses in the access
2152     log for invalid requests which were unexpectedly rejected.</p>
2153
2154 </div>
2155 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2156 <div class="directive-section"><h2><a name="If" id="If">&lt;If&gt;</a> <a name="if" id="if">Directive</a></h2>
2157 <table class="directive">
2158 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Contains directives that apply only if a condition is
2159 satisfied by a request at runtime</td></tr>
2160 <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>
2161 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
2162 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
2163 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2164 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2165 </table>
2166     <p>The <code class="directive">&lt;If&gt;</code> directive
2167     evaluates an expression at runtime, and applies the enclosed
2168     directives if and only if the expression evaluates to true.
2169     For example:</p>
2170
2171     <pre class="prettyprint lang-config">&lt;If "-z req('Host')"&gt;</pre>
2172
2173
2174     <p>would match HTTP/1.0 requests without a <var>Host:</var> header.
2175     Expressions may contain various shell-like operators for string
2176     comparison (<code>==</code>, <code>!=</code>, <code>&lt;</code>, ...),
2177     integer comparison (<code>-eq</code>, <code>-ne</code>, ...),
2178     and others (<code>-n</code>, <code>-z</code>, <code>-f</code>, ...).
2179     It is also possible to use regular expressions, </p>
2180
2181     <pre class="prettyprint lang-config">&lt;If "%{QUERY_STRING} =~ /(delete|commit)=.*?elem/"&gt;</pre>
2182
2183
2184     <p>shell-like pattern matches and many other operations. These operations
2185     can be done on request headers (<code>req</code>), environment variables
2186     (<code>env</code>), and a large number of other properties. The full
2187     documentation is available in <a href="../expr.html">Expressions in
2188     Apache HTTP Server</a>.</p>
2189
2190     <p>Only directives that support the <a href="directive-dict.html#Context">directory context</a> can be used within this configuration section.</p>
2191
2192     <div class="warning">
2193     Certain variables, such as <code>CONTENT_TYPE</code> and other
2194     response headers, are set after &lt;If&gt; conditions have already
2195     been evaluated, and so will not be available to use in this
2196     directive.
2197     </div>
2198
2199
2200 <h3>See also</h3>
2201 <ul>
2202 <li><a href="../expr.html">Expressions in Apache HTTP Server</a>,
2203 for a complete reference and more examples.</li>
2204 <li><code class="directive"><a href="#elseif">&lt;ElseIf&gt;</a></code></li>
2205 <li><code class="directive"><a href="#else">&lt;Else&gt;</a></code></li>
2206 <li><a href="../sections.html">How &lt;Directory&gt;, &lt;Location&gt;,
2207     &lt;Files&gt; sections work</a> for an explanation of how these
2208     different sections are combined when a request is received.
2209     <code class="directive">&lt;If&gt;</code>,
2210     <code class="directive">&lt;ElseIf&gt;</code>, and
2211     <code class="directive">&lt;Else&gt;</code> are applied last.</li>
2212 </ul>
2213 </div>
2214 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2215 <div class="directive-section"><h2><a name="IfDefine" id="IfDefine">&lt;IfDefine&gt;</a> <a name="ifdefine" id="ifdefine">Directive</a></h2>
2216 <table class="directive">
2217 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Encloses directives that will be processed only
2218 if a test is true at startup</td></tr>
2219 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;IfDefine [!]<var>parameter-name</var>&gt; ...
2220     &lt;/IfDefine&gt;</code></td></tr>
2221 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
2222 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
2223 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2224 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2225 </table>
2226     <p>The <code>&lt;IfDefine <var>test</var>&gt;...&lt;/IfDefine&gt;
2227     </code> section is used to mark directives that are conditional. The
2228     directives within an <code class="directive">&lt;IfDefine&gt;</code>
2229     section are only processed if the <var>test</var> is true. If <var>
2230     test</var> is false, everything between the start and end markers is
2231     ignored.</p>
2232
2233     <p>The <var>test</var> in the <code class="directive">&lt;IfDefine&gt;</code> section directive can be one of two forms:</p>
2234
2235     <ul>
2236       <li><var>parameter-name</var></li>
2237
2238       <li><code>!</code><var>parameter-name</var></li>
2239     </ul>
2240
2241     <p>In the former case, the directives between the start and end
2242     markers are only processed if the parameter named
2243     <var>parameter-name</var> is defined. The second format reverses
2244     the test, and only processes the directives if
2245     <var>parameter-name</var> is <strong>not</strong> defined.</p>
2246
2247     <p>The <var>parameter-name</var> argument is a define as given on the
2248     <code class="program"><a href="../programs/httpd.html">httpd</a></code> command line via <code>-D<var>parameter</var>
2249     </code> at the time the server was started or by the <code class="directive"><a href="#define">Define</a></code> directive.</p>
2250
2251     <p><code class="directive">&lt;IfDefine&gt;</code> sections are
2252     nest-able, which can be used to implement simple
2253     multiple-parameter tests. Example:</p>
2254
2255     <div class="example"><p><code>httpd -DReverseProxy -DUseCache -DMemCache ...</code></p></div>
2256     <pre class="prettyprint lang-config">&lt;IfDefine ReverseProxy&gt;
2257   LoadModule proxy_module   modules/mod_proxy.so
2258   LoadModule proxy_http_module   modules/mod_proxy_http.so
2259   &lt;IfDefine UseCache&gt;
2260     LoadModule cache_module   modules/mod_cache.so
2261     &lt;IfDefine MemCache&gt;
2262       LoadModule mem_cache_module   modules/mod_mem_cache.so
2263     &lt;/IfDefine&gt;
2264     &lt;IfDefine !MemCache&gt;
2265       LoadModule cache_disk_module   modules/mod_cache_disk.so
2266     &lt;/IfDefine&gt;
2267   &lt;/IfDefine&gt;
2268 &lt;/IfDefine&gt;</pre>
2269
2270
2271 </div>
2272 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2273 <div class="directive-section"><h2><a name="IfFile" id="IfFile">&lt;IfFile&gt;</a> <a name="iffile" id="iffile">Directive</a></h2>
2274 <table class="directive">
2275 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Encloses directives that will be processed only
2276 if file exists at startup</td></tr>
2277 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;IfFile [!]<var>parameter-name</var>&gt; ...
2278     &lt;/IfFile&gt;</code></td></tr>
2279 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
2280 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2281 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2282 </table>
2283     <p>The <code>&lt;IfFile <var>filename</var>&gt;...&lt;/IfFile&gt;
2284     </code> section is used to mark directives that are conditional on
2285     the existence of a file on disk. The directives within an
2286     <code class="directive">&lt;IfFile&gt;</code> section are only
2287     processed if the <var>filename</var> exists. If <var> filename</var>
2288     doesn't exist, everything between the start and end markers is
2289     ignored. <var>filename</var> can be an absolute path or a path
2290     relative to the server root.</p>
2291
2292     <p>The <var>filename</var> in the <code class="directive">&lt;IfFile
2293     &gt;</code> section directive can take the same forms as the
2294     <var>test</var> variable in the <code class="directive">&lt;IfDefine
2295     &gt;</code> section, i.e. the test can be negated if the <code>
2296     !</code> character is placed directly before <var>filename</var>.
2297     </p>
2298
2299     <p>If a relative <var>filename</var> is supplied, the check is
2300     <code class="directive">ServerRoot</code> relative.  In the  case where
2301     this directive occurs before the <code class="directive">ServerRoot</code>,
2302     the path will be checked relative to the compiled-in server root or
2303     the server root passed in on the command line via the <code>-d</code>
2304     parameter.</p>
2305
2306
2307 </div>
2308 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2309 <div class="directive-section"><h2><a name="IfModule" id="IfModule">&lt;IfModule&gt;</a> <a name="ifmodule" id="ifmodule">Directive</a></h2>
2310 <table class="directive">
2311 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Encloses directives that are processed conditional on the
2312 presence or absence of a specific module</td></tr>
2313 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;IfModule [!]<var>module-file</var>|<var>module-identifier</var>&gt; ...
2314     &lt;/IfModule&gt;</code></td></tr>
2315 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
2316 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
2317 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2318 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2319 </table>
2320     <p>The <code>&lt;IfModule <var>test</var>&gt;...&lt;/IfModule&gt;</code>
2321     section is used to mark directives that are conditional on the presence of
2322     a specific module. The directives within an <code class="directive">&lt;IfModule&gt;</code> section are only processed if the <var>test</var>
2323     is true. If <var>test</var> is false, everything between the start and
2324     end markers is ignored.</p>
2325
2326     <p>The <var>test</var> in the <code class="directive">&lt;IfModule&gt;</code> section directive can be one of two forms:</p>
2327
2328     <ul>
2329       <li><var>module</var></li>
2330
2331       <li>!<var>module</var></li>
2332     </ul>
2333
2334     <p>In the former case, the directives between the start and end
2335     markers are only processed if the module named <var>module</var>
2336     is included in Apache httpd -- either compiled in or
2337     dynamically loaded using <code class="directive"><a href="../mod/mod_so.html#loadmodule">LoadModule</a></code>. The second format reverses the test,
2338     and only processes the directives if <var>module</var> is
2339     <strong>not</strong> included.</p>
2340
2341     <p>The <var>module</var> argument can be either the module identifier or
2342     the file name of the module, at the time it was compiled.  For example,
2343     <code>rewrite_module</code> is the identifier and
2344     <code>mod_rewrite.c</code> is the file name. If a module consists of
2345     several source files, use the name of the file containing the string
2346     <code>STANDARD20_MODULE_STUFF</code>.</p>
2347
2348     <p><code class="directive">&lt;IfModule&gt;</code> sections are
2349     nest-able, which can be used to implement simple multiple-module
2350     tests.</p>
2351
2352     <div class="note">This section should only be used if you need to have one
2353     configuration file that works whether or not a specific module
2354     is available. In normal operation, directives need not be
2355     placed in <code class="directive">&lt;IfModule&gt;</code>
2356     sections.</div>
2357
2358 </div>
2359 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2360 <div class="directive-section"><h2><a name="Include" id="Include">Include</a> <a name="include" id="include">Directive</a></h2>
2361 <table class="directive">
2362 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Includes other configuration files from within
2363 the server configuration files</td></tr>
2364 <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>
2365 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
2366 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2367 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2368 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Directory
2369 wildcard matching available in 2.3.6 and later</td></tr>
2370 </table>
2371     <p>This directive allows inclusion of other configuration files
2372     from within the server configuration files.</p>
2373
2374     <p>Shell-style (<code>fnmatch()</code>) wildcard characters can be used
2375     in the filename or directory parts of the path to include several files
2376     at once, in alphabetical order. In addition, if
2377     <code class="directive">Include</code> points to a directory, rather than a file,
2378     Apache httpd will read all files in that directory and any subdirectory.
2379     However, including entire directories is not recommended, because it is
2380     easy to accidentally leave temporary files in a directory that can cause
2381     <code class="program"><a href="../programs/httpd.html">httpd</a></code> to fail. Instead, we encourage you to use the
2382     wildcard syntax shown below, to include files that match a particular
2383     pattern, such as *.conf, for example.</p>
2384
2385     <p>The <code class="directive"><a href="#include">Include</a></code> directive will
2386     <strong>fail with an error</strong> if a wildcard expression does not
2387     match any file. The <code class="directive"><a href="#includeoptional">IncludeOptional</a></code>
2388     directive can be used if non-matching wildcards should be ignored.</p>
2389
2390     <p>The file path specified may be an absolute path, or may be relative
2391     to the <code class="directive"><a href="#serverroot">ServerRoot</a></code> directory.</p>
2392
2393     <p>Examples:</p>
2394
2395     <pre class="prettyprint lang-config">Include /usr/local/apache2/conf/ssl.conf
2396 Include /usr/local/apache2/conf/vhosts/*.conf</pre>
2397
2398
2399     <p>Or, providing paths relative to your <code class="directive"><a href="#serverroot">ServerRoot</a></code> directory:</p>
2400
2401     <pre class="prettyprint lang-config">Include conf/ssl.conf
2402 Include conf/vhosts/*.conf</pre>
2403
2404
2405     <p>Wildcards may be included in the directory or file portion of the
2406     path. This example will fail if there is no subdirectory in conf/vhosts
2407     that contains at least one *.conf file:</p>
2408
2409     <pre class="prettyprint lang-config">Include conf/vhosts/*/*.conf</pre>
2410
2411
2412     <p>Alternatively, the following command will just be ignored in case of
2413     missing files or directories:</p>
2414
2415     <pre class="prettyprint lang-config">IncludeOptional conf/vhosts/*/*.conf</pre>
2416
2417
2418
2419 <h3>See also</h3>
2420 <ul>
2421 <li><code class="directive"><a href="#includeoptional">IncludeOptional</a></code></li>
2422 <li><code class="program"><a href="../programs/apachectl.html">apachectl</a></code></li>
2423 </ul>
2424 </div>
2425 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2426 <div class="directive-section"><h2><a name="IncludeOptional" id="IncludeOptional">IncludeOptional</a> <a name="includeoptional" id="includeoptional">Directive</a></h2>
2427 <table class="directive">
2428 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Includes other configuration files from within
2429 the server configuration files</td></tr>
2430 <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>
2431 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
2432 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2433 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2434 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in 2.3.6 and later</td></tr>
2435 </table>
2436     <p>This directive allows inclusion of other configuration files
2437     from within the server configuration files. It works identically to the
2438     <code class="directive"><a href="#include">Include</a></code> directive, with the
2439     exception that if wildcards do not match any file or directory, the
2440     <code class="directive"><a href="#includeoptional">IncludeOptional</a></code> directive will be
2441     silently ignored instead of causing an error.</p>
2442
2443 <h3>See also</h3>
2444 <ul>
2445 <li><code class="directive"><a href="#include">Include</a></code></li>
2446 <li><code class="program"><a href="../programs/apachectl.html">apachectl</a></code></li>
2447 </ul>
2448 </div>
2449 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2450 <div class="directive-section"><h2><a name="KeepAlive" id="KeepAlive">KeepAlive</a> <a name="keepalive" id="keepalive">Directive</a></h2>
2451 <table class="directive">
2452 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables HTTP persistent connections</td></tr>
2453 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>KeepAlive On|Off</code></td></tr>
2454 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>KeepAlive On</code></td></tr>
2455 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2456 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2457 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2458 </table>
2459     <p>The Keep-Alive extension to HTTP/1.0 and the persistent
2460     connection feature of HTTP/1.1 provide long-lived HTTP sessions
2461     which allow multiple requests to be sent over the same TCP
2462     connection. In some cases this has been shown to result in an
2463     almost 50% speedup in latency times for HTML documents with
2464     many images. To enable Keep-Alive connections, set
2465     <code>KeepAlive On</code>.</p>
2466
2467     <p>For HTTP/1.0 clients, Keep-Alive connections will only be
2468     used if they are specifically requested by a client. In
2469     addition, a Keep-Alive connection with an HTTP/1.0 client can
2470     only be used when the length of the content is known in
2471     advance. This implies that dynamic content such as CGI output,
2472     SSI pages, and server-generated directory listings will
2473     generally not use Keep-Alive connections to HTTP/1.0 clients.
2474     For HTTP/1.1 clients, persistent connections are the default
2475     unless otherwise specified. If the client requests it, chunked
2476     encoding will be used in order to send content of unknown
2477     length over persistent connections.</p>
2478
2479     <p>When a client uses a Keep-Alive connection, it will be counted
2480     as a single "request" for the <code class="directive"><a href="../mod/mpm_common.html#maxconnectionsperchild">MaxConnectionsPerChild</a></code> directive, regardless
2481     of how many requests are sent using the connection.</p>
2482
2483 <h3>See also</h3>
2484 <ul>
2485 <li><code class="directive"><a href="#maxkeepaliverequests">MaxKeepAliveRequests</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="KeepAliveTimeout" id="KeepAliveTimeout">KeepAliveTimeout</a> <a name="keepalivetimeout" id="keepalivetimeout">Directive</a></h2>
2490 <table class="directive">
2491 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Amount of time the server will wait for subsequent
2492 requests on a persistent connection</td></tr>
2493 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>KeepAliveTimeout <var>num</var>[ms]</code></td></tr>
2494 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>KeepAliveTimeout 5</code></td></tr>
2495 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2496 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2497 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2498 </table>
2499     <p>The number of seconds Apache httpd will wait for a subsequent
2500     request before closing the connection. By adding a postfix of ms the
2501     timeout can be also set in milliseconds. Once a request has been
2502     received, the timeout value specified by the
2503     <code class="directive"><a href="#timeout">Timeout</a></code> directive applies.</p>
2504
2505     <p>Setting <code class="directive">KeepAliveTimeout</code> to a high value
2506     may cause performance problems in heavily loaded servers. The
2507     higher the timeout, the more server processes will be kept
2508     occupied waiting on connections with idle clients.</p>
2509
2510     <p>If <code class="directive">KeepAliveTimeout</code> is <strong>not</strong>
2511     set for a name-based virtual host, the value of the first defined
2512     virtual host best matching the local IP and port will be used.</p>
2513
2514 </div>
2515 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2516 <div class="directive-section"><h2><a name="Limit" id="Limit">&lt;Limit&gt;</a> <a name="limit" id="limit">Directive</a></h2>
2517 <table class="directive">
2518 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Restrict enclosed access controls to only certain HTTP
2519 methods</td></tr>
2520 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;Limit <var>method</var> [<var>method</var>] ... &gt; ...
2521     &lt;/Limit&gt;</code></td></tr>
2522 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
2523 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig, Limit</td></tr>
2524 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2525 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2526 </table>
2527     <p>Access controls are normally effective for
2528     <strong>all</strong> access methods, and this is the usual
2529     desired behavior. <strong>In the general case, access control
2530     directives should not be placed within a
2531     <code class="directive">&lt;Limit&gt;</code> section.</strong></p>
2532
2533     <p>The purpose of the <code class="directive">&lt;Limit&gt;</code>
2534     directive is to restrict the effect of the access controls to the
2535     nominated HTTP methods. For all other methods, the access
2536     restrictions that are enclosed in the <code class="directive">&lt;Limit&gt;</code> bracket <strong>will have no
2537     effect</strong>. The following example applies the access control
2538     only to the methods <code>POST</code>, <code>PUT</code>, and
2539     <code>DELETE</code>, leaving all other methods unprotected:</p>
2540
2541     <pre class="prettyprint lang-config">&lt;Limit POST PUT DELETE&gt;
2542   Require valid-user
2543 &lt;/Limit&gt;</pre>
2544
2545
2546     <p>The method names listed can be one or more of: <code>GET</code>,
2547     <code>POST</code>, <code>PUT</code>, <code>DELETE</code>,
2548     <code>CONNECT</code>, <code>OPTIONS</code>,
2549     <code>PATCH</code>, <code>PROPFIND</code>, <code>PROPPATCH</code>,
2550     <code>MKCOL</code>, <code>COPY</code>, <code>MOVE</code>,
2551     <code>LOCK</code>, and <code>UNLOCK</code>. <strong>The method name is
2552     case-sensitive.</strong> If <code>GET</code> is used, it will also
2553     restrict <code>HEAD</code> requests. The <code>TRACE</code> method
2554     cannot be limited (see <code class="directive"><a href="#traceenable">TraceEnable</a></code>).</p>
2555
2556     <div class="warning">A <code class="directive"><a href="#limitexcept">&lt;LimitExcept&gt;</a></code> section should always be
2557     used in preference to a <code class="directive">&lt;Limit&gt;</code>
2558     section when restricting access, since a <code class="directive"><a href="#limitexcept">&lt;LimitExcept&gt;</a></code> section provides protection
2559     against arbitrary methods.</div>
2560
2561     <p>The <code class="directive">&lt;Limit&gt;</code> and
2562     <code class="directive"><a href="#limitexcept">&lt;LimitExcept&gt;</a></code>
2563     directives may be nested.  In this case, each successive level of
2564     <code class="directive">&lt;Limit&gt;</code> or <code class="directive"><a href="#limitexcept">&lt;LimitExcept&gt;</a></code> directives must
2565     further restrict the set of methods to which access controls apply.</p>
2566
2567     <div class="warning">When using
2568     <code class="directive">&lt;Limit&gt;</code> or
2569     <code class="directive">&lt;LimitExcept&gt;</code> directives with
2570     the <code class="directive"><a href="../mod/mod_authz_core.html#require">Require</a></code> directive,
2571     note that the first <code class="directive"><a href="../mod/mod_authz_core.html#require">Require</a></code>
2572     to succeed authorizes the request, regardless of the presence of other
2573     <code class="directive"><a href="../mod/mod_authz_core.html#require">Require</a></code> directives.</div>
2574
2575     <p>For example, given the following configuration, all users will
2576     be authorized for <code>POST</code> requests, and the
2577     <code>Require group editors</code> directive will be ignored
2578     in all cases:</p>
2579
2580     <pre class="prettyprint lang-config">&lt;LimitExcept GET&gt;
2581   Require valid-user
2582 &lt;/LimitExcept&gt;
2583 &lt;Limit POST&gt;
2584   Require group editors
2585 &lt;/Limit&gt;</pre>
2586
2587
2588 </div>
2589 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2590 <div class="directive-section"><h2><a name="LimitExcept" id="LimitExcept">&lt;LimitExcept&gt;</a> <a name="limitexcept" id="limitexcept">Directive</a></h2>
2591 <table class="directive">
2592 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Restrict access controls to all HTTP methods
2593 except the named ones</td></tr>
2594 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;LimitExcept <var>method</var> [<var>method</var>] ... &gt; ...
2595     &lt;/LimitExcept&gt;</code></td></tr>
2596 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
2597 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig, Limit</td></tr>
2598 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2599 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2600 </table>
2601     <p><code class="directive">&lt;LimitExcept&gt;</code> and
2602     <code>&lt;/LimitExcept&gt;</code> are used to enclose
2603     a group of access control directives which will then apply to any
2604     HTTP access method <strong>not</strong> listed in the arguments;
2605     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
2606     both standard and nonstandard/unrecognized methods. See the
2607     documentation for <code class="directive"><a href="#limit">&lt;Limit&gt;</a></code> for more details.</p>
2608
2609     <p>For example:</p>
2610
2611     <pre class="prettyprint lang-config">&lt;LimitExcept POST GET&gt;
2612   Require valid-user
2613 &lt;/LimitExcept&gt;</pre>
2614
2615
2616
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="LimitInternalRecursion" id="LimitInternalRecursion">LimitInternalRecursion</a> <a name="limitinternalrecursion" id="limitinternalrecursion">Directive</a></h2>
2620 <table class="directive">
2621 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Determine maximum number of internal redirects and nested
2622 subrequests</td></tr>
2623 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LimitInternalRecursion <var>number</var> [<var>number</var>]</code></td></tr>
2624 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LimitInternalRecursion 10</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>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
2630     redirects the original request to a CGI script. A subrequest is Apache httpd's
2631     mechanism to find out what would happen for some URI if it were requested.
2632     For example, <code class="module"><a href="../mod/mod_dir.html">mod_dir</a></code> uses subrequests to look for the
2633     files listed in the <code class="directive"><a href="../mod/mod_dir.html#directoryindex">DirectoryIndex</a></code>
2634     directive.</p>
2635
2636     <p><code class="directive">LimitInternalRecursion</code> prevents the server
2637     from crashing when entering an infinite loop of internal redirects or
2638     subrequests. Such loops are usually caused by misconfigurations.</p>
2639
2640     <p>The directive stores two different limits, which are evaluated on
2641     per-request basis. The first <var>number</var> is the maximum number of
2642     internal redirects that may follow each other. The second <var>number</var>
2643     determines how deeply subrequests may be nested. If you specify only one
2644     <var>number</var>, it will be assigned to both limits.</p>
2645
2646     <pre class="prettyprint lang-config">LimitInternalRecursion 5</pre>
2647
2648
2649 </div>
2650 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2651 <div class="directive-section"><h2><a name="LimitRequestBody" id="LimitRequestBody">LimitRequestBody</a> <a name="limitrequestbody" id="limitrequestbody">Directive</a></h2>
2652 <table class="directive">
2653 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Restricts the total size of the HTTP request body sent
2654 from the client</td></tr>
2655 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LimitRequestBody <var>bytes</var></code></td></tr>
2656 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LimitRequestBody 0</code></td></tr>
2657 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
2658 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
2659 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2660 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2661 </table>
2662     <p>This directive specifies the number of <var>bytes</var> from 0
2663     (meaning unlimited) to 2147483647 (2GB) that are allowed in a
2664     request body. See the note below for the limited applicability
2665     to proxy requests.</p>
2666
2667     <p>The <code class="directive">LimitRequestBody</code> directive allows
2668     the user to set a limit on the allowed size of an HTTP request
2669     message body within the context in which the directive is given
2670     (server, per-directory, per-file or per-location). If the client
2671     request exceeds that limit, the server will return an error
2672     response instead of servicing the request. The size of a normal
2673     request message body will vary greatly depending on the nature of
2674     the resource and the methods allowed on that resource. CGI scripts
2675     typically use the message body for retrieving form information.
2676     Implementations of the <code>PUT</code> method will require
2677     a value at least as large as any representation that the server
2678     wishes to accept for that resource.</p>
2679
2680     <p>This directive gives the server administrator greater
2681     control over abnormal client request behavior, which may be
2682     useful for avoiding some forms of denial-of-service
2683     attacks.</p>
2684
2685     <p>If, for example, you are permitting file upload to a particular
2686     location and wish to limit the size of the uploaded file to 100K,
2687     you might use the following directive:</p>
2688
2689     <pre class="prettyprint lang-config">LimitRequestBody 102400</pre>
2690
2691
2692     <div class="note"><p>For a full description of how this directive is interpreted by
2693     proxy requests, see the <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> documentation.</p>
2694     </div>
2695
2696
2697 </div>
2698 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2699 <div class="directive-section"><h2><a name="LimitRequestFields" id="LimitRequestFields">LimitRequestFields</a> <a name="limitrequestfields" id="limitrequestfields">Directive</a></h2>
2700 <table class="directive">
2701 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limits the number of HTTP request header fields that
2702 will be accepted from the client</td></tr>
2703 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LimitRequestFields <var>number</var></code></td></tr>
2704 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LimitRequestFields 100</code></td></tr>
2705 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2706 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2707 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2708 </table>
2709     <p><var>Number</var> is an integer from 0 (meaning unlimited) to
2710     32767. The default value is defined by the compile-time
2711     constant <code>DEFAULT_LIMIT_REQUEST_FIELDS</code> (100 as
2712     distributed).</p>
2713
2714     <p>The <code class="directive">LimitRequestFields</code> directive allows
2715     the server administrator to modify the limit on the number of
2716     request header fields allowed in an HTTP request. A server needs
2717     this value to be larger than the number of fields that a normal
2718     client request might include. The number of request header fields
2719     used by a client rarely exceeds 20, but this may vary among
2720     different client implementations, often depending upon the extent
2721     to which a user has configured their browser to support detailed
2722     content negotiation. Optional HTTP extensions are often expressed
2723     using request header fields.</p>
2724
2725     <p>This directive gives the server administrator greater
2726     control over abnormal client request behavior, which may be
2727     useful for avoiding some forms of denial-of-service attacks.
2728     The value should be increased if normal clients see an error
2729     response from the server that indicates too many fields were
2730     sent in the request.</p>
2731
2732     <p>For example:</p>
2733
2734     <pre class="prettyprint lang-config">LimitRequestFields 50</pre>
2735
2736
2737      <div class="warning"><h3>Warning</h3>
2738      <p> When name-based virtual hosting is used, the value for this
2739      directive is taken from the default (first-listed) virtual host for the
2740      local IP and port combination.</p>
2741      </div>
2742
2743
2744 </div>
2745 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2746 <div class="directive-section"><h2><a name="LimitRequestFieldSize" id="LimitRequestFieldSize">LimitRequestFieldSize</a> <a name="limitrequestfieldsize" id="limitrequestfieldsize">Directive</a></h2>
2747 <table class="directive">
2748 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limits the size of the HTTP request header allowed from the
2749 client</td></tr>
2750 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LimitRequestFieldSize <var>bytes</var></code></td></tr>
2751 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LimitRequestFieldSize 8190</code></td></tr>
2752 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2753 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2754 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2755 </table>
2756     <p>This directive specifies the number of <var>bytes</var>
2757     that will be allowed in an HTTP request header.</p>
2758
2759     <p>The <code class="directive">LimitRequestFieldSize</code> directive
2760     allows the server administrator to set the limit
2761     on the allowed size of an HTTP request header field. A server
2762     needs this value to be large enough to hold any one header field
2763     from a normal client request. The size of a normal request header
2764     field will vary greatly among different client implementations,
2765     often depending upon the extent to which a user has configured
2766     their browser to support detailed content negotiation. SPNEGO
2767     authentication headers can be up to 12392 bytes.</p>
2768
2769     <p>This directive gives the server administrator greater
2770     control over abnormal client request behavior, which may be
2771     useful for avoiding some forms of denial-of-service attacks.</p>
2772
2773     <p>For example:</p>
2774
2775     <pre class="prettyprint lang-config">LimitRequestFieldSize 4094</pre>
2776
2777
2778     <div class="note">Under normal conditions, the value should not be changed from
2779     the default.</div>
2780
2781     <div class="warning"><h3>Warning</h3>
2782     <p> When name-based virtual hosting is used, the value for this
2783     directive is taken from the default (first-listed) virtual host best
2784     matching the current IP address and port combination.</p>
2785     </div>
2786
2787 </div>
2788 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2789 <div class="directive-section"><h2><a name="LimitRequestLine" id="LimitRequestLine">LimitRequestLine</a> <a name="limitrequestline" id="limitrequestline">Directive</a></h2>
2790 <table class="directive">
2791 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limit the size of the HTTP request line that will be accepted
2792 from the client</td></tr>
2793 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LimitRequestLine <var>bytes</var></code></td></tr>
2794 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LimitRequestLine 8190</code></td></tr>
2795 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2796 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2797 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2798 </table>
2799     <p>This directive sets the number of <var>bytes</var> that will be
2800     allowed on the HTTP request-line.</p>
2801
2802     <p>The <code class="directive">LimitRequestLine</code> directive allows
2803     the server administrator to set the limit on the allowed size
2804     of a client's HTTP request-line. Since the request-line consists of the
2805     HTTP method, URI, and protocol version, the
2806     <code class="directive">LimitRequestLine</code> directive places a
2807     restriction on the length of a request-URI allowed for a request
2808     on the server. A server needs this value to be large enough to
2809     hold any of its resource names, including any information that
2810     might be passed in the query part of a <code>GET</code> request.</p>
2811
2812     <p>This directive gives the server administrator greater
2813     control over abnormal client request behavior, which may be
2814     useful for avoiding some forms of denial-of-service attacks.</p>
2815
2816     <p>For example:</p>
2817
2818     <pre class="prettyprint lang-config">LimitRequestLine 4094</pre>
2819
2820
2821     <div class="note">Under normal conditions, the value should not be changed from
2822     the default.</div>
2823
2824     <div class="warning"><h3>Warning</h3>
2825     <p> When name-based virtual hosting is used, the value for this
2826     directive is taken from the default (first-listed) virtual host best
2827     matching the current IP address and port combination.</p>
2828     </div>
2829
2830
2831 </div>
2832 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2833 <div class="directive-section"><h2><a name="LimitXMLRequestBody" id="LimitXMLRequestBody">LimitXMLRequestBody</a> <a name="limitxmlrequestbody" id="limitxmlrequestbody">Directive</a></h2>
2834 <table class="directive">
2835 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limits the size of an XML-based request body</td></tr>
2836 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LimitXMLRequestBody <var>bytes</var></code></td></tr>
2837 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LimitXMLRequestBody 1000000</code></td></tr>
2838 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
2839 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
2840 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2841 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2842 </table>
2843     <p>Limit (in bytes) on maximum size of an XML-based request
2844     body. A value of <code>0</code> will disable any checking.</p>
2845
2846     <p>Example:</p>
2847
2848     <pre class="prettyprint lang-config">LimitXMLRequestBody 0</pre>
2849
2850
2851
2852 </div>
2853 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2854 <div class="directive-section"><h2><a name="Location" id="Location">&lt;Location&gt;</a> <a name="location" id="location">Directive</a></h2>
2855 <table class="directive">
2856 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Applies the enclosed directives only to matching
2857 URLs</td></tr>
2858 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;Location
2859     <var>URL-path</var>|<var>URL</var>&gt; ... &lt;/Location&gt;</code></td></tr>
2860 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2861 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2862 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2863 </table>
2864     <p>The <code class="directive">&lt;Location&gt;</code> directive
2865     limits the scope of the enclosed directives by URL. It is similar to the
2866     <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code>
2867     directive, and starts a subsection which is terminated with a
2868     <code>&lt;/Location&gt;</code> directive. <code class="directive">&lt;Location&gt;</code> sections are processed in the
2869     order they appear in the configuration file, after the <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code> sections and
2870     <code>.htaccess</code> files are read, and after the <code class="directive"><a href="#files">&lt;Files&gt;</a></code> sections.</p>
2871
2872     <p><code class="directive">&lt;Location&gt;</code> sections operate
2873     completely outside the filesystem.  This has several consequences.
2874     Most importantly, <code class="directive">&lt;Location&gt;</code>
2875     directives should not be used to control access to filesystem
2876     locations.  Since several different URLs may map to the same
2877     filesystem location, such access controls may by circumvented.</p>
2878
2879     <p>The enclosed directives will be applied to the request if the path component
2880     of the URL meets <em>any</em> of the following criteria:
2881     </p>
2882     <ul>
2883       <li>The specified location matches exactly the path component of the URL.
2884       </li>
2885       <li>The specified location, which ends in a forward slash, is a prefix
2886       of the path component of the URL (treated as a context root).
2887       </li>
2888       <li>The specified location, with the addition of a trailing slash, is a
2889       prefix of the path component of the URL (also treated as a context root).
2890       </li>
2891     </ul>
2892     <p>
2893     In the example below, where no trailing slash is used, requests to
2894     /private1, /private1/ and /private1/file.txt will have the enclosed
2895     directives applied, but /private1other would not.
2896     </p>
2897     <pre class="prettyprint lang-config">&lt;Location "/private1"&gt;
2898     #  ...
2899 &lt;/Location&gt;</pre>
2900
2901     <p>
2902     In the example below, where a trailing slash is used, requests to
2903     /private2/ and /private2/file.txt will have the enclosed
2904     directives applied, but /private2 and /private2other would not.
2905     </p>
2906     <pre class="prettyprint lang-config">&lt;Location "/private2<em>/</em>"&gt;
2907     # ...
2908 &lt;/Location&gt;</pre>
2909
2910
2911     <div class="note"><h3>When to use <code class="directive">&lt;Location&gt;</code></h3>
2912
2913     <p>Use <code class="directive">&lt;Location&gt;</code> to apply
2914     directives to content that lives outside the filesystem.  For
2915     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
2916     <code>&lt;Location "/"&gt;</code>, which is an easy way to
2917     apply a configuration to the entire server.</p>
2918     </div>
2919
2920     <p>For all origin (non-proxy) requests, the URL to be matched is a
2921     URL-path of the form <code>/path/</code>.  <em>No scheme, hostname,
2922     port, or query string may be included.</em>  For proxy requests, the
2923     URL to be matched is of the form
2924     <code>scheme://servername/path</code>, and you must include the
2925     prefix.</p>
2926
2927     <p>The URL may use wildcards. In a wild-card string, <code>?</code> matches
2928     any single character, and <code>*</code> matches any sequences of
2929     characters. Neither wildcard character matches a / in the URL-path.</p>
2930
2931     <p><a class="glossarylink" href="../glossary.html#regex" title="see glossary">Regular expressions</a>
2932     can also be used, with the addition of the <code>~</code>
2933     character. For example:</p>
2934
2935     <pre class="prettyprint lang-config">&lt;Location ~ "/(extra|special)/data"&gt;
2936     #...
2937 &lt;/Location&gt;</pre>
2938
2939
2940     <p>would match URLs that contained the substring <code>/extra/data</code>
2941     or <code>/special/data</code>. The directive <code class="directive"><a href="#locationmatch">&lt;LocationMatch&gt;</a></code> behaves
2942     identical to the regex version of <code class="directive">&lt;Location&gt;</code>, and is preferred, for the
2943     simple reason that <code>~</code> is hard to distinguish from
2944     <code>-</code> in many fonts.</p>
2945
2946     <p>The <code class="directive">&lt;Location&gt;</code>
2947     functionality is especially useful when combined with the
2948     <code class="directive"><a href="#sethandler">SetHandler</a></code>
2949     directive. For example, to enable status requests but allow them
2950     only from browsers at <code>example.com</code>, you might use:</p>
2951
2952     <pre class="prettyprint lang-config">&lt;Location "/status"&gt;
2953   SetHandler server-status
2954   Require host example.com
2955 &lt;/Location&gt;</pre>
2956
2957
2958     <div class="note"><h3>Note about / (slash)</h3>
2959       <p>The slash character has special meaning depending on where in a
2960       URL it appears. People may be used to its behavior in the filesystem
2961       where multiple adjacent slashes are frequently collapsed to a single
2962       slash (<em>i.e.</em>, <code>/home///foo</code> is the same as
2963       <code>/home/foo</code>). In URL-space this is not necessarily true.
2964       The <code class="directive"><a href="#locationmatch">&lt;LocationMatch&gt;</a></code>
2965       directive and the regex version of <code class="directive">&lt;Location&gt;</code> require you to explicitly specify multiple
2966       slashes if that is your intention.</p>
2967
2968       <p>For example, <code>&lt;LocationMatch "^/abc"&gt;</code> would match
2969       the request URL <code>/abc</code> but not the request URL <code>
2970       //abc</code>. The (non-regex) <code class="directive">&lt;Location&gt;</code> directive behaves similarly when used for
2971       proxy requests. But when (non-regex) <code class="directive">&lt;Location&gt;</code> is used for non-proxy requests it will
2972       implicitly match multiple slashes with a single slash. For example,
2973       if you specify <code>&lt;Location "/abc/def"&gt;</code> and the
2974       request is to <code>/abc//def</code> then it will match.</p>
2975     </div>
2976
2977 <h3>See also</h3>
2978 <ul>
2979 <li><a href="../sections.html">How &lt;Directory&gt;, &lt;Location&gt;
2980     and &lt;Files&gt; sections work</a> for an explanation of how these
2981     different sections are combined when a request is received.</li>
2982 <li><code class="directive"><a href="#locationmatch">LocationMatch</a></code></li>
2983 </ul>
2984 </div>
2985 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
2986 <div class="directive-section"><h2><a name="LocationMatch" id="LocationMatch">&lt;LocationMatch&gt;</a> <a name="locationmatch" id="locationmatch">Directive</a></h2>
2987 <table class="directive">
2988 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Applies the enclosed directives only to regular-expression
2989 matching URLs</td></tr>
2990 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;LocationMatch
2991     <var>regex</var>&gt; ... &lt;/LocationMatch&gt;</code></td></tr>
2992 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
2993 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
2994 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
2995 </table>
2996     <p>The <code class="directive">&lt;LocationMatch&gt;</code> directive
2997     limits the scope of the enclosed directives by URL, in an identical manner
2998     to <code class="directive"><a href="#location">&lt;Location&gt;</a></code>. However,
2999     it takes a <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular expression</a>
3000     as an argument instead of a simple string. For example:</p>
3001
3002     <pre class="prettyprint lang-config">&lt;LocationMatch "/(extra|special)/data"&gt;
3003     # ...
3004 &lt;/LocationMatch&gt;</pre>
3005
3006
3007     <p>would match URLs that contained the substring <code>/extra/data</code>
3008     or <code>/special/data</code>.</p>
3009
3010     <div class="note"><p>If the intent is that a URL <strong>starts with</strong>
3011     <code>/extra/data</code>, rather than merely
3012     <strong>contains</strong> <code>/extra/data</code>, prefix the
3013     regular expression with a <code>^</code> to require this.</p>
3014
3015     <pre class="prettyprint lang-config">&lt;LocationMatch "^/(extra|special)/data"&gt;</pre>
3016
3017     </div>
3018
3019     <p>From 2.4.8 onwards, named groups and backreferences are captured and
3020     written to the environment with the corresponding name prefixed with
3021     "MATCH_" and in upper case. This allows elements of URLs to be referenced
3022     from within <a href="../expr.html">expressions</a> and modules like
3023     <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>. In order to prevent confusion, numbered
3024     (unnamed) backreferences are ignored. Use named groups instead.</p>
3025
3026     <pre class="prettyprint lang-config">&lt;LocationMatch "^/combined/(?&lt;sitename&gt;[^/]+)"&gt;
3027     require ldap-group cn=%{env:MATCH_SITENAME},ou=combined,o=Example
3028 &lt;/LocationMatch&gt;</pre>
3029
3030
3031 <h3>See also</h3>
3032 <ul>
3033 <li><a href="../sections.html">How &lt;Directory&gt;, &lt;Location&gt;
3034     and &lt;Files&gt; sections work</a> for an explanation of how these
3035     different sections are combined when a request is received</li>
3036 </ul>
3037 </div>
3038 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
3039 <div class="directive-section"><h2><a name="LogLevel" id="LogLevel">LogLevel</a> <a name="loglevel" id="loglevel">Directive</a></h2>
3040 <table class="directive">
3041 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Controls the verbosity of the ErrorLog</td></tr>
3042 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LogLevel [<var>module</var>:]<var>level</var>
3043     [<var>module</var>:<var>level</var>] ...
3044 </code></td></tr>
3045 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LogLevel warn</code></td></tr>
3046 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
3047 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
3048 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
3049 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Per-module and per-directory configuration is available in
3050     Apache HTTP Server 2.3.6 and later</td></tr>
3051 </table>
3052     <p><code class="directive">LogLevel</code> adjusts the verbosity of the
3053     messages recorded in the error logs (see <code class="directive"><a href="#errorlog">ErrorLog</a></code> directive). The following
3054     <var>level</var>s are available, in order of decreasing
3055     significance:</p>
3056
3057     <table class="bordered">
3058
3059       <tr>
3060         <th><strong>Level</strong> </th>
3061
3062         <th><strong>Description</strong> </th>
3063
3064         <th><strong>Example</strong> </th>
3065       </tr>
3066
3067       <tr>
3068         <td><code>emerg</code> </td>
3069
3070         <td>Emergencies - system is unusable.</td>
3071
3072         <td>"Child cannot open lock file. Exiting"</td>
3073       </tr>
3074
3075       <tr>
3076         <td><code>alert</code> </td>
3077
3078         <td>Action must be taken immediately.</td>
3079
3080         <td>"getpwuid: couldn't determine user name from uid"</td>
3081       </tr>
3082
3083       <tr>
3084         <td><code>crit</code> </td>
3085
3086         <td>Critical Conditions.</td>
3087
3088         <td>"socket: Failed to get a socket, exiting child"</td>
3089       </tr>
3090
3091       <tr>
3092         <td><code>error</code> </td>
3093
3094         <td>Error conditions.</td>
3095
3096         <td>"Premature end of script headers"</td>
3097       </tr>
3098
3099       <tr>
3100         <td><code>warn</code> </td>
3101
3102         <td>Warning conditions.</td>
3103
3104         <td>"child process 1234 did not exit, sending another
3105         SIGHUP"</td>
3106       </tr>
3107
3108       <tr>
3109         <td><code>notice</code> </td>
3110
3111         <td>Normal but significant condition.</td>
3112
3113         <td>"httpd: caught SIGBUS, attempting to dump core in
3114         ..."</td>
3115       </tr>
3116
3117       <tr>
3118         <td><code>info</code> </td>
3119
3120         <td>Informational.</td>
3121
3122         <td>"Server seems busy, (you may need to increase
3123         StartServers, or Min/MaxSpareServers)..."</td>
3124       </tr>
3125
3126       <tr>
3127         <td><code>debug</code> </td>
3128
3129         <td>Debug-level messages</td>
3130
3131         <td>"Opening config file ..."</td>
3132       </tr>
3133       <tr>
3134         <td><code>trace1</code> </td>
3135
3136         <td>Trace messages</td>
3137
3138         <td>"proxy: FTP: control connection complete"</td>
3139       </tr>
3140       <tr>
3141         <td><code>trace2</code> </td>
3142
3143         <td>Trace messages</td>
3144
3145         <td>"proxy: CONNECT: sending the CONNECT request to the remote proxy"</td>
3146       </tr>
3147       <tr>
3148         <td><code>trace3</code> </td>
3149
3150         <td>Trace messages</td>
3151
3152         <td>"openssl: Handshake: start"</td>
3153       </tr>
3154       <tr>
3155         <td><code>trace4</code> </td>
3156
3157         <td>Trace messages</td>
3158
3159         <td>"read from buffered SSL brigade, mode 0, 17 bytes"</td>
3160       </tr>
3161       <tr>
3162         <td><code>trace5</code> </td>
3163
3164         <td>Trace messages</td>
3165
3166         <td>"map lookup FAILED: map=rewritemap key=keyname"</td>
3167       </tr>
3168       <tr>
3169         <td><code>trace6</code> </td>
3170
3171         <td>Trace messages</td>
3172
3173         <td>"cache lookup FAILED, forcing new map lookup"</td>
3174       </tr>
3175       <tr>
3176         <td><code>trace7</code> </td>
3177
3178         <td>Trace messages, dumping large amounts of data</td>
3179
3180         <td>"| 0000: 02 23 44 30 13 40 ac 34 df 3d bf 9a 19 49 39 15 |"</td>
3181       </tr>
3182       <tr>
3183         <td><code>trace8</code> </td>
3184
3185         <td>Trace messages, dumping large amounts of data</td>
3186
3187         <td>"| 0000: 02 23 44 30 13 40 ac 34 df 3d bf 9a 19 49 39 15 |"</td>
3188       </tr>
3189     </table>
3190
3191     <p>When a particular level is specified, messages from all
3192     other levels of higher significance will be reported as well.
3193     <em>E.g.</em>, when <code>LogLevel info</code> is specified,
3194     then messages with log levels of <code>notice</code> and
3195     <code>warn</code> will also be posted.</p>
3196
3197     <p>Using a level of at least <code>crit</code> is
3198     recommended.</p>
3199
3200     <p>For example:</p>
3201
3202     <pre class="prettyprint lang-config">LogLevel notice</pre>
3203
3204
3205     <div class="note"><h3>Note</h3>
3206       <p>When logging to a regular file, messages of the level
3207       <code>notice</code> cannot be suppressed and thus are always
3208       logged. However, this doesn't apply when logging is done
3209       using <code>syslog</code>.</p>
3210     </div>
3211
3212     <p>Specifying a level without a module name will reset the level
3213     for all modules to that level.  Specifying a level with a module
3214     name will set the level for that module only. It is possible to
3215     use the module source file name, the module identifier, or the
3216     module identifier with the trailing <code>_module</code> omitted
3217     as module specification. This means the following three specifications
3218     are equivalent:</p>
3219
3220     <pre class="prettyprint lang-config">LogLevel info ssl:warn
3221 LogLevel info mod_ssl.c:warn
3222 LogLevel info ssl_module:warn</pre>
3223
3224
3225     <p>It is also possible to change the level per directory:</p>
3226
3227     <pre class="prettyprint lang-config">LogLevel info
3228 &lt;Directory "/usr/local/apache/htdocs/app"&gt;
3229   LogLevel debug
3230 &lt;/Directory&gt;</pre>
3231
3232
3233     <div class="note">
3234         Per directory loglevel configuration only affects messages that are
3235         logged after the request has been parsed and that are associated with
3236         the request. Log messages which are associated with the server or
3237         the connection are not affected. The latter can be influenced by the
3238         <code class="directive"><a href="#logleveloverride">LogLevelOverride</a></code> directive,
3239         though.
3240     </div>
3241
3242 <h3>See also</h3>
3243 <ul>
3244 <li><code class="directive"><a href="#errorlog">ErrorLog</a></code></li>
3245 <li><code class="directive"><a href="#errorlogformat">ErrorLogFormat</a></code></li>
3246 <li><code class="directive"><a href="#logleveloverride">LogLevelOverride</a></code></li>
3247 <li><a href="../logs.html">Apache HTTP Server Log Files</a></li>
3248 </ul>
3249 </div>
3250 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
3251 <div class="directive-section"><h2><a name="LogLevelOverride" id="LogLevelOverride">LogLevelOverride</a> <a name="logleveloverride" id="logleveloverride">Directive</a></h2>
3252 <table class="directive">
3253 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Override the verbosity of the ErrorLog for certain clients</td></tr>
3254 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LogLevel <var>ipaddress</var>[/<var>prefixlen</var>]
3255     [<var>module</var>:]<var>level</var> [<var>module</var>:<var>level</var>] ...
3256 </code></td></tr>
3257 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>unset</code></td></tr>
3258 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
3259 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
3260 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
3261 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache HTTP Server 2.5.0 and later</td></tr>
3262 </table>
3263     <p><code class="directive">LogLevelOverride</code> adjusts the
3264     <code class="directive"><a href="#loglevel">LogLevel</a></code> for requests coming from
3265     certain client IP addresses.
3266     This allows to enable verbose logging only for certain test clients.
3267     The IP address is checked at a very early state in the connection
3268     processing.  Therefore, <code class="directive">LogLevelOverride</code> allows to
3269     change the log level for things like the SSL handshake which happen before
3270     a <code class="directive"><a href="#loglevel">LogLevel</a></code> directive in an
3271     <code class="directive"><a href="#if">&lt;If&gt;</a></code> container would
3272     be evaluated.</p>
3273
3274     <p><code class="directive">LogLevelOverride</code> accepts either a single
3275     IP-address or a CIDR IP-address/len subnet specification.
3276     For the syntax of the loglevel specification, see the
3277     <code class="directive"><a href="#loglevel">LogLevel</a></code> directive.</p>
3278
3279     <p>For requests that match a <code class="directive">LogLevelOverride</code>
3280     directive, per-directory specifications of
3281     <code class="directive"><a href="#loglevel">LogLevel</a></code> are ignored.</p>
3282
3283     <p>Examples:</p>
3284
3285     <pre class="prettyprint lang-config">    LogLevelOverride 192.0.2.0/24 ssl:trace6
3286     LogLevelOverride 192.0.2.7 ssl:trace8</pre>
3287
3288
3289     <div class="note">
3290         <code class="directive">LogLevelOverride</code> only affects
3291         log messages that are associated with the request or the connection.
3292         Log messages which are associated with the server are not affected.
3293     </div>
3294
3295
3296 <h3>See also</h3>
3297 <ul>
3298 <li><code class="directive"><a href="#loglevel">LogLevel</a></code></li>
3299 </ul>
3300 </div>
3301 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
3302 <div class="directive-section"><h2><a name="MaxKeepAliveRequests" id="MaxKeepAliveRequests">MaxKeepAliveRequests</a> <a name="maxkeepaliverequests" id="maxkeepaliverequests">Directive</a></h2>
3303 <table class="directive">
3304 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Number of requests allowed on a persistent
3305 connection</td></tr>
3306 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>MaxKeepAliveRequests <var>number</var></code></td></tr>
3307 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>MaxKeepAliveRequests 100</code></td></tr>
3308 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
3309 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
3310 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
3311 </table>
3312     <p>The <code class="directive">MaxKeepAliveRequests</code> directive
3313     limits the number of requests allowed per connection when
3314     <code class="directive"><a href="#keepalive">KeepAlive</a></code> is on. If it is
3315     set to <code>0</code>, unlimited requests will be allowed. We
3316     recommend that this setting be kept to a high value for maximum
3317     server performance.</p>
3318
3319     <p>For example:</p>
3320
3321     <pre class="prettyprint lang-config">MaxKeepAliveRequests 500</pre>
3322
3323
3324 </div>
3325 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
3326 <div class="directive-section"><h2><a name="MaxRangeOverlaps" id="MaxRangeOverlaps">MaxRangeOverlaps</a> <a name="maxrangeoverlaps" id="maxrangeoverlaps">Directive</a></h2>
3327 <table class="directive">
3328 <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
3329         resource </td></tr>
3330 <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>
3331 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>MaxRangeOverlaps 20</code></td></tr>
3332 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
3333 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
3334 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
3335 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache HTTP Server 2.3.15 and later</td></tr>
3336 </table>
3337         <p>The <code class="directive">MaxRangeOverlaps</code> directive
3338             limits the number of overlapping HTTP ranges the server is willing to
3339             return to the client. If more overlapping ranges than permitted are requested,
3340             the complete resource is returned instead.</p>
3341
3342         <dl>
3343             <dt><strong>default</strong></dt>
3344             <dd>Limits the number of overlapping ranges to a compile-time default of 20.</dd>
3345
3346             <dt><strong>none</strong></dt>
3347             <dd>No overlapping Range headers are allowed.</dd>
3348
3349             <dt><strong>unlimited</strong></dt>
3350             <dd>The server does not limit the number of overlapping ranges it is
3351                 willing to satisfy.</dd>
3352
3353             <dt><var>number-of-ranges</var></dt>
3354             <dd>A positive number representing the maximum number of overlapping ranges the
3355                 server is willing to satisfy.</dd>
3356         </dl>
3357
3358 </div>
3359 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
3360 <div class="directive-section"><h2><a name="MaxRangeReversals" id="MaxRangeReversals">MaxRangeReversals</a> <a name="maxrangereversals" id="maxrangereversals">Directive</a></h2>
3361 <table class="directive">
3362 <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
3363         resource </td></tr>
3364 <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>
3365 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>MaxRangeReversals 20</code></td></tr>
3366 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
3367 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
3368 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
3369 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache HTTP Server 2.3.15 and later</td></tr>
3370 </table>
3371         <p>The <code class="directive">MaxRangeReversals</code> directive
3372             limits the number of HTTP Range reversals the server is willing to
3373             return to the client. If more ranges reversals than permitted are requested,
3374             the complete resource is returned instead.</p>
3375
3376         <dl>
3377             <dt><strong>default</strong></dt>
3378             <dd>Limits the number of range reversals to a compile-time default of 20.</dd>
3379
3380             <dt><strong>none</strong></dt>
3381             <dd>No Range reversals headers are allowed.</dd>
3382
3383             <dt><strong>unlimited</strong></dt>
3384             <dd>The server does not limit the number of range reversals it is
3385                 willing to satisfy.</dd>
3386
3387             <dt><var>number-of-ranges</var></dt>
3388             <dd>A positive number representing the maximum number of range reversals the
3389                 server is willing to satisfy.</dd>
3390         </dl>
3391
3392 </div>
3393 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
3394 <div class="directive-section"><h2><a name="MaxRanges" id="MaxRanges">MaxRanges</a> <a name="maxranges" id="maxranges">Directive</a></h2>
3395 <table class="directive">
3396 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Number of ranges allowed before returning the complete
3397 resource </td></tr>
3398 <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>
3399 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>MaxRanges 200</code></td></tr>
3400 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
3401 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
3402 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
3403 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache HTTP Server 2.3.15 and later</td></tr>
3404 </table>
3405     <p>The <code class="directive">MaxRanges</code> directive
3406     limits the number of HTTP ranges the server is willing to
3407     return to the client. If more ranges than permitted are requested,
3408     the complete resource is returned instead.</p>
3409
3410     <dl>
3411       <dt><strong>default</strong></dt>
3412       <dd>Limits the number of ranges to a compile-time default of 200.</dd>
3413
3414       <dt><strong>none</strong></dt>
3415       <dd>Range headers are ignored.</dd>
3416
3417       <dt><strong>unlimited</strong></dt>
3418       <dd>The server does not limit the number of ranges it is
3419           willing to satisfy.</dd>
3420
3421       <dt><var>number-of-ranges</var></dt>
3422       <dd>A positive number representing the maximum number of ranges the
3423       server is willing to satisfy.</dd>
3424     </dl>
3425
3426 </div>
3427 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
3428 <div class="directive-section"><h2><a name="MergeTrailers" id="MergeTrailers">MergeTrailers</a> <a name="mergetrailers" id="mergetrailers">Directive</a></h2>
3429 <table class="directive">
3430 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Determines whether trailers are merged into headers</td></tr>
3431 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>MergeTrailers [on|off]</code></td></tr>
3432 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>MergeTrailers off</code></td></tr>
3433 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
3434 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
3435 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
3436 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>2.4.11 and later</td></tr>
3437 </table>
3438     <p>This directive controls whether HTTP trailers are copied into the
3439     internal representation of HTTP headers. This merging occurs when the
3440     request body has been completely consumed, long after most header
3441     processing would have a chance to examine or modify request headers.</p>
3442     <p>This option is provided for compatibility with releases prior to 2.4.11,
3443     where trailers were always merged.</p>
3444
3445 </div>
3446 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
3447 <div class="directive-section"><h2><a name="Mutex" id="Mutex">Mutex</a> <a name="mutex" id="mutex">Directive</a></h2>
3448 <table class="directive">
3449 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures mutex mechanism and lock file directory for all
3450 or specified mutexes</td></tr>
3451 <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>
3452 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Mutex default</code></td></tr>
3453 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
3454 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
3455 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
3456 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache HTTP Server 2.3.4 and later</td></tr>
3457 </table>
3458     <p>The <code class="directive">Mutex</code> directive sets the mechanism,
3459     and optionally the lock file location, that httpd and modules use
3460     to serialize access to resources.  Specify <code>default</code> as
3461     the second argument to change the settings for all mutexes; specify
3462     a mutex name (see table below) as the second argument to override
3463     defaults only for that mutex.</p>
3464
3465     <p>The <code class="directive">Mutex</code> directive is typically used in
3466     the following exceptional situations:</p>
3467
3468     <ul>
3469         <li>change the mutex mechanism when the default mechanism selected
3470         by <a class="glossarylink" href="../glossary.html#apr" title="see glossary">APR</a> has a functional or performance
3471         problem</li>
3472
3473         <li>change the directory used by file-based mutexes when the
3474         default directory does not support locking</li>
3475     </ul>
3476
3477     <div class="note"><h3>Supported modules</h3>
3478     <p>This directive only configures mutexes which have been registered
3479     with the core server using the <code>ap_mutex_register()</code> API.
3480     All modules bundled with httpd support the <code class="directive">Mutex</code>
3481     directive, but third-party modules may not.  Consult the documentation
3482     of the third-party module, which must indicate the mutex name(s) which
3483     can be configured if this directive is supported.</p>
3484     </div>
3485
3486     <p>The following mutex <em>mechanisms</em> are available:</p>
3487     <ul>
3488         <li><code>default | yes</code>
3489         <p>This selects the default locking implementation, as determined by
3490         <a class="glossarylink" href="../glossary.html#apr" title="see glossary">APR</a>.  The default locking implementation can
3491         be displayed by running <code class="program"><a href="../programs/httpd.html">httpd</a></code> with the
3492         <code>-V</code> option.</p></li>
3493
3494         <li><code>none | no</code>
3495         <p>This effectively disables the mutex, and is only allowed for a
3496         mutex if the module indicates that it is a valid choice.  Consult the
3497         module documentation for more information.</p></li>
3498
3499         <li><code>posixsem</code>
3500         <p>This is a mutex variant based on a Posix semaphore.</p>
3501
3502         <div class="warning"><h3>Warning</h3>
3503         <p>The semaphore ownership is not recovered if a thread in the process
3504         holding the mutex segfaults, resulting in a hang of the web server.</p>
3505         </div>
3506         </li>
3507
3508         <li><code>sysvsem</code>
3509         <p>This is a mutex variant based on a SystemV IPC semaphore.</p>
3510
3511         <div class="warning"><h3>Warning</h3>
3512         <p>It is possible to "leak" SysV semaphores if processes crash
3513         before the semaphore is removed.</p>
3514         </div>
3515
3516         <div class="warning"><h3>Security</h3>
3517         <p>The semaphore API allows for a denial of service attack by any
3518         CGIs running under the same uid as the webserver (<em>i.e.</em>,
3519         all CGIs, unless you use something like <code class="program"><a href="../programs/suexec.html">suexec</a></code>
3520         or <code>cgiwrapper</code>).</p>
3521         </div>
3522         </li>
3523
3524         <li><code>sem</code>
3525         <p>This selects the "best" available semaphore implementation, choosing
3526         between Posix and SystemV IPC semaphores, in that order.</p></li>
3527
3528         <li><code>pthread</code>
3529         <p>This is a mutex variant based on cross-process Posix thread
3530         mutexes.</p>
3531
3532         <div class="warning"><h3>Warning</h3>
3533         <p>On most systems, if a child process terminates abnormally while
3534         holding a mutex that uses this implementation, the server will deadlock
3535         and stop responding to requests.  When this occurs, the server will
3536         require a manual restart to recover.</p>
3537         <p>Solaris and Linux are notable exceptions as they provide a mechanism which
3538         usually allows the mutex to be recovered after a child process
3539         terminates abnormally while holding a mutex.</p>
3540         <p>If your system is POSIX compliant or if it implements the
3541         <code>pthread_mutexattr_setrobust_np()</code> function, you may be able
3542         to use the <code>pthread</code> option safely.</p>
3543         </div>
3544         </li>
3545
3546         <li><code>fcntl:/path/to/mutex</code>
3547         <p>This is a mutex variant where a physical (lock-)file and the
3548         <code>fcntl()</code> function are used as the mutex.</p>
3549
3550         <div class="warning"><h3>Warning</h3>
3551         <p>When multiple mutexes based on this mechanism are used within
3552         multi-threaded, multi-process environments, deadlock errors (EDEADLK)
3553         can be reported for valid mutex operations if <code>fcntl()</code>
3554         is not thread-aware, such as on Solaris.</p>
3555         </div>
3556         </li>
3557
3558         <li><code>flock:/path/to/mutex</code>
3559         <p>This is similar to the <code>fcntl:/path/to/mutex</code> method
3560         with the exception that the <code>flock()</code> function is used to
3561         provide file locking.</p></li>
3562
3563         <li><code>file:/path/to/mutex</code>
3564         <p>This selects the "best" available file locking implementation,
3565         choosing between <code>fcntl</code> and <code>flock</code>, in that
3566         order.</p></li>
3567     </ul>
3568
3569     <p>Most mechanisms are only available on selected platforms, where the
3570     underlying platform and <a class="glossarylink" href="../glossary.html#apr" title="see glossary">APR</a> support it.  Mechanisms
3571     which aren't available on all platforms are <em>posixsem</em>,
3572     <em>sysvsem</em>, <em>sem</em>, <em>pthread</em>, <em>fcntl</em>,
3573     <em>flock</em>, and <em>file</em>.</p>
3574
3575     <p>With the file-based mechanisms <em>fcntl</em> and <em>flock</em>,
3576     the path, if provided, is a directory where the lock file will be created.
3577     The default directory is httpd's run-time file directory,
3578     <code class="directive"><a href="#defaultruntimedir">DefaultRuntimeDir</a></code>.  If a relative
3579     path is provided, it is relative to
3580     <code class="directive"><a href="#defaultruntimedir">DefaultRuntimeDir</a></code>.  Always use a local
3581     disk filesystem for <code>/path/to/mutex</code> and never a directory residing
3582     on a NFS- or AFS-filesystem.  The basename of the file will be the mutex
3583     type, an optional instance string provided by the module, and unless the
3584     <code>OmitPID</code> keyword is specified, the process id of the httpd
3585     parent process will be appended to make the file name unique, avoiding
3586     conflicts when multiple httpd instances share a lock file directory.  For
3587     example, if the mutex name is <code>mpm-accept</code> and the lock file
3588     directory is <code>/var/httpd/locks</code>, the lock file name for the
3589     httpd instance with parent process id 12345 would be
3590     <code>/var/httpd/locks/mpm-accept.12345</code>.</p>
3591
3592     <div class="warning"><h3>Security</h3>
3593     <p>It is best to <em>avoid</em> putting mutex files in a world-writable
3594     directory such as <code>/var/tmp</code> because someone could create
3595     a denial of service attack and prevent the server from starting by
3596     creating a lockfile with the same name as the one the server will try
3597     to create.</p>
3598     </div>
3599
3600     <p>The following table documents the names of mutexes used by httpd
3601     and bundled modules.</p>
3602
3603     <table class="bordered"><tr class="header">
3604             <th>Mutex name</th>
3605             <th>Module(s)</th>
3606             <th>Protected resource</th>
3607         </tr>
3608 <tr>
3609             <td><code>mpm-accept</code></td>
3610             <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>
3611             <td>incoming connections, to avoid the thundering herd problem;
3612             for more information, refer to the
3613             <a href="../misc/perf-tuning.html">performance tuning</a>
3614             documentation</td>
3615         </tr>
3616 <tr class="odd">
3617             <td><code>authdigest-client</code></td>
3618             <td><code class="module"><a href="../mod/mod_auth_digest.html">mod_auth_digest</a></code></td>
3619             <td>client list in shared memory</td>
3620         </tr>
3621 <tr>
3622             <td><code>authdigest-opaque</code></td>
3623             <td><code class="module"><a href="../mod/mod_auth_digest.html">mod_auth_digest</a></code></td>
3624             <td>counter in shared memory</td>
3625         </tr>
3626 <tr class="odd">
3627             <td><code>ldap-cache</code></td>
3628             <td><code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code></td>
3629             <td>LDAP result cache</td>
3630         </tr>
3631 <tr>
3632             <td><code>rewrite-map</code></td>
3633             <td><code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code></td>
3634             <td>communication with external mapping programs, to avoid
3635             intermixed I/O from multiple requests</td>
3636         </tr>
3637 <tr class="odd">
3638             <td><code>ssl-cache</code></td>
3639             <td><code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code></td>
3640             <td>SSL session cache</td>
3641         </tr>
3642 <tr>
3643             <td><code>ssl-stapling</code></td>
3644             <td><code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code></td>
3645             <td>OCSP stapling response cache</td>
3646         </tr>
3647 <tr class="odd">
3648             <td><code>watchdog-callback</code></td>
3649             <td><code class="module"><a href="../mod/mod_watchdog.html">mod_watchdog</a></code></td>
3650             <td>callback function of a particular client module</td>
3651         </tr>
3652 </table>
3653
3654     <p>The <code>OmitPID</code> keyword suppresses the addition of the httpd
3655     parent process id from the lock file name.</p>
3656
3657     <p>In the following example, the mutex mechanism for the MPM accept
3658     mutex will be changed from the compiled-in default to <code>fcntl</code>,
3659     with the associated lock file created in directory
3660     <code>/var/httpd/locks</code>.  The mutex mechanism for all other mutexes
3661     will be changed from the compiled-in default to <code>sysvsem</code>.</p>
3662
3663     <pre class="prettyprint lang-config">Mutex sysvsem default
3664 Mutex fcntl:/var/httpd/locks mpm-accept</pre>
3665
3666
3667 </div>
3668 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
3669 <div class="directive-section"><h2><a name="NameVirtualHost" id="NameVirtualHost">NameVirtualHost</a> <a name="namevirtualhost" id="namevirtualhost">Directive</a></h2>
3670 <table class="directive">
3671 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>DEPRECATED: Designates an IP address for name-virtual
3672 hosting</td></tr>
3673 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>NameVirtualHost <var>addr</var>[:<var>port</var>]</code></td></tr>
3674 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
3675 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
3676 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
3677 </table>
3678
3679 <p>Prior to 2.3.11, <code class="directive">NameVirtualHost</code> was required
3680 to instruct the server that a particular IP address and port combination
3681 was usable as a name-based virtual host.  In 2.3.11 and later,
3682 any time an IP address and port combination is used in multiple virtual
3683 hosts, name-based virtual hosting is automatically enabled for that address.</p>
3684
3685 <p>This directive currently has no effect.</p>
3686
3687 <h3>See also</h3>
3688 <ul>
3689 <li><a href="../vhosts/">Virtual Hosts
3690 documentation</a></li>
3691 </ul>
3692 </div>
3693 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
3694 <div class="directive-section"><h2><a name="Options" id="Options">Options</a> <a name="options" id="options">Directive</a></h2>
3695 <table class="directive">
3696 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures what features are available in a particular
3697 directory</td></tr>
3698 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Options
3699     [+|-]<var>option</var> [[+|-]<var>option</var>] ...</code></td></tr>
3700 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Options FollowSymlinks</code></td></tr>
3701 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
3702 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Options</td></tr>
3703 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
3704 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
3705 <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>
3706 </table>
3707     <p>The <code class="directive">Options</code> directive controls which
3708     server features are available in a particular directory.</p>
3709
3710     <p><var>option</var> can be set to <code>None</code>, in which
3711     case none of the extra features are enabled, or one or more of
3712     the following:</p>
3713
3714     <dl>
3715       <dt><code>All</code></dt>
3716
3717       <dd>All options except for <code>MultiViews</code>.</dd>
3718
3719       <dt><code>ExecCGI</code></dt>
3720
3721       <dd>
3722       Execution of CGI scripts using <code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code>
3723       is permitted.</dd>
3724
3725       <dt><code>FollowSymLinks</code></dt>
3726
3727       <dd>
3728       The server will follow symbolic links in this directory. This is
3729       the default setting.
3730       <div class="note">
3731       <p>Even though the server follows the symlink it does <em>not</em>
3732       change the pathname used to match against <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code> sections.</p>
3733
3734       <p>The <code>FollowSymLinks</code> and
3735       <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
3736       <code>.htaccess</code> files.</p>
3737
3738       <p>Omitting this option should not be considered a security restriction,
3739       since symlink testing is subject to race conditions that make it
3740       circumventable.</p>
3741       </div></dd>
3742
3743       <dt><code>Includes</code></dt>
3744
3745       <dd>
3746       Server-side includes provided by <code class="module"><a href="../mod/mod_include.html">mod_include</a></code>
3747       are permitted.</dd>
3748
3749       <dt><code>IncludesNOEXEC</code></dt>
3750
3751       <dd>
3752
3753       Server-side includes are permitted, but the <code>#exec
3754       cmd</code> and <code>#exec cgi</code> are disabled. It is still
3755       possible to <code>#include virtual</code> CGI scripts from
3756       <code class="directive"><a href="../mod/mod_alias.html#scriptalias">ScriptAlias</a></code>ed
3757       directories.</dd>
3758
3759       <dt><code>Indexes</code></dt>
3760
3761       <dd>
3762       If a URL which maps to a directory is requested and there
3763       is no <code class="directive"><a href="../mod/mod_dir.html#directoryindex">DirectoryIndex</a></code>
3764       (<em>e.g.</em>, <code>index.html</code>) in that directory, then
3765       <code class="module"><a href="../mod/mod_autoindex.html">mod_autoindex</a></code> will return a formatted listing
3766       of the directory.</dd>
3767
3768       <dt><code>MultiViews</code></dt>
3769
3770       <dd>
3771       <a href="../content-negotiation.html">Content negotiated</a>
3772       "MultiViews" are allowed using
3773       <code class="module"><a href="../mod/mod_negotiation.html">mod_negotiation</a></code>.
3774       <div class="note"><h3>Note</h3> <p>This option gets ignored if set
3775       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>
3776       needs real resources to compare against and evaluate from.</p></div>
3777       </dd>
3778
3779       <dt><code>SymLinksIfOwnerMatch</code></dt>
3780
3781       <dd>The server will only follow symbolic links for which the
3782       target file or directory is owned by the same user id as the
3783       link.
3784
3785       <div class="note"><h3>Note</h3>
3786       <p>The <code>FollowSymLinks</code> and
3787       <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
3788       <code>.htaccess</code> files.</p>
3789
3790       <p>This option should not be considered a security restriction,
3791       since symlink testing is subject to race conditions that make it
3792       circumventable.</p>
3793       </div> </dd>
3794     </dl>
3795
3796     <p>Normally, if multiple <code class="directive">Options</code> could
3797     apply to a directory, then the most specific one is used and
3798     others are ignored; the options are not merged. (See <a href="../sections.html#merging">how sections are merged</a>.)
3799     However if <em>all</em> the options on the
3800     <code class="directive">Options</code> directive are preceded by a
3801     <code>+</code> or <code>-</code> symbol, the options are
3802     merged. Any options preceded by a <code>+</code> are added to the
3803     options currently in force, and any options preceded by a
3804     <code>-</code> are removed from the options currently in
3805     force. </p>
3806
3807     <div class="note"><h3>Note</h3>
3808     <p>Mixing <code class="directive">Options</code> with a <code>+</code> or
3809     <code>-</code> with those without is not valid syntax and will be
3810     rejected during server startup by the syntax check with an abort.</p>
3811     </div>
3812
3813     <p>For example, without any <code>+</code> and <code>-</code> symbols:</p>
3814
3815     <pre class="prettyprint lang-config">&lt;Directory "/web/docs"&gt;
3816   Options Indexes FollowSymLinks
3817 &lt;/Directory&gt;
3818
3819 &lt;Directory "/web/docs/spec"&gt;
3820   Options Includes
3821 &lt;/Directory&gt;</pre>
3822
3823
3824     <p>then only <code>Includes</code> will be set for the
3825     <code>/web/docs/spec</code> directory. However if the second
3826     <code class="directive">Options</code> directive uses the <code>+</code> and
3827     <code>-</code> symbols:</p>
3828
3829     <pre class="prettyprint lang-config">&lt;Directory "/web/docs"&gt;
3830   Options Indexes FollowSymLinks
3831 &lt;/Directory&gt;
3832
3833 &lt;Directory "/web/docs/spec"&gt;
3834   Options +Includes -Indexes
3835 &lt;/Directory&gt;</pre>
3836
3837
3838     <p>then the options <code>FollowSymLinks</code> and
3839     <code>Includes</code> are set for the <code>/web/docs/spec</code>
3840     directory.</p>
3841
3842     <div class="note"><h3>Note</h3>
3843       <p>Using <code>-IncludesNOEXEC</code> or
3844       <code>-Includes</code> disables server-side includes completely
3845       regardless of the previous setting.</p>
3846     </div>
3847
3848     <p>The default in the absence of any other settings is
3849     <code>FollowSymlinks</code>.</p>
3850
3851 </div>
3852 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
3853 <div class="directive-section"><h2><a name="Protocol" id="Protocol">Protocol</a> <a name="protocol" id="protocol">Directive</a></h2>
3854 <table class="directive">
3855 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Protocol for a listening socket</td></tr>
3856 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Protocol <var>protocol</var></code></td></tr>
3857 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
3858 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
3859 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
3860 <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>
3861 </table>
3862     <p>This directive specifies the protocol used for a specific listening socket.
3863        The protocol is used to determine which module should handle a request and
3864        to apply protocol specific optimizations with the <code class="directive">AcceptFilter</code>
3865        directive.</p>
3866
3867     <p>You only need to set the protocol if you are running on non-standard ports;
3868        otherwise, <code>http</code> is assumed for port 80 and <code>https</code>
3869        for port 443.</p>
3870
3871     <p>For example, if you are running <code>https</code> on a non-standard port,
3872        specify the protocol explicitly:</p>
3873
3874     <pre class="prettyprint lang-config">Protocol https</pre>
3875
3876
3877     <p>You can also specify the protocol using the <code class="directive"><a href="../mod/mpm_common.html#listen">Listen</a></code> directive.</p>
3878
3879 <h3>See also</h3>
3880 <ul>
3881 <li><code class="directive"><a href="#acceptfilter">AcceptFilter</a></code></li>
3882 <li><code class="directive"><a href="../mod/mpm_common.html#listen">Listen</a></code></li>
3883 </ul>
3884 </div>
3885 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
3886 <div class="directive-section"><h2><a name="Protocols" id="Protocols">Protocols</a> <a name="protocols" id="protocols">Directive</a></h2>
3887 <table class="directive">
3888 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Protocols available for a server/virtual host</td></tr>
3889 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Protocols <var>protocol</var> ...</code></td></tr>
3890 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Protocols http/1.1</code></td></tr>
3891 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
3892 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
3893 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
3894 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Only available from Apache 2.4.17 and later.</td></tr>
3895 </table>
3896         <p>This directive specifies the list of protocols supported for a
3897             server/virtual host. The list determines the allowed protocols
3898             a client may negotiate for this server/host.</p>
3899
3900         <p>You need to set protocols if you want to extend the available
3901             protocols for a server/host. By default, only the http/1.1 protocol
3902             (which includes the compatibility with 1.0 and 0.9 clients) is
3903             allowed.</p>
3904
3905         <p>For example, if you want to support HTTP/2 for a server with TLS,
3906             specify:</p>
3907
3908         <pre class="prettyprint lang-config">Protocols h2 http/1.1</pre>
3909
3910
3911         <p>Valid protocols are <code>http/1.1</code> for http and https connections,
3912             <code>h2</code> on https connections and <code>h2c</code> for http
3913             connections. Modules may enable more protocols.</p>
3914
3915         <p>It is safe to specify protocols that are unavailable/disabled. Such
3916         protocol names will simply be ignored.</p>
3917
3918         <p>Protocols specified in base servers are inherited for virtual hosts
3919             only if the virtual host has no own Protocols directive. Or, the other
3920             way around, Protocols directives in virtual hosts replace any
3921             such directive in the base server.
3922         </p>
3923
3924
3925 <h3>See also</h3>
3926 <ul>
3927 <li><code class="directive"><a href="#protocolshonororder">ProtocolsHonorOrder</a></code></li>
3928 </ul>
3929 </div>
3930 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
3931 <div class="directive-section"><h2><a name="ProtocolsHonorOrder" id="ProtocolsHonorOrder">ProtocolsHonorOrder</a> <a name="protocolshonororder" id="protocolshonororder">Directive</a></h2>
3932 <table class="directive">
3933 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Determines if order of Protocols determines precedence during negotiation</td></tr>
3934 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProtocolsHonorOrder On|Off</code></td></tr>
3935 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProtocolsHonorOrder On</code></td></tr>
3936 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
3937 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
3938 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
3939 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Only available from Apache 2.4.17 and later.</td></tr>
3940 </table>
3941         <p>This directive specifies if the server should honor the order in which
3942         the <code class="directive">Protocols</code> directive lists protocols.</p>
3943
3944         <p>If configured Off, the client supplied list order of protocols has
3945             precedence over the order in the server configuration.</p>
3946
3947         <p>With <code class="directive">ProtocolsHonorOrder</code> set to <code>on</code>
3948             (default), the client ordering does not matter and only the ordering
3949             in the server settings influences the outcome of the protocol
3950             negotiation.</p>
3951
3952
3953 <h3>See also</h3>
3954 <ul>
3955 <li><code class="directive"><a href="#protocols">Protocols</a></code></li>
3956 </ul>
3957 </div>
3958 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
3959 <div class="directive-section"><h2><a name="QualifyRedirectURL" id="QualifyRedirectURL">QualifyRedirectURL</a> <a name="qualifyredirecturl" id="qualifyredirecturl">Directive</a></h2>
3960 <table class="directive">
3961 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Controls whether the REDIRECT_URL environment variable is
3962              fully qualified</td></tr>
3963 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>QualifyRedirectURL ON|OFF</code></td></tr>
3964 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>QualifyRedirectURL OFF</code></td></tr>
3965 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
3966 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
3967 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
3968 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
3969 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Directive supported in 2.4.18 and later. 2.4.17 acted
3970 as if 'QualifyRedirectURL ON' was configured.</td></tr>
3971 </table>
3972     <p>This directive controls whether the server will ensure that the
3973     REDIRECT_URL environment variable is fully qualified.  By default,
3974     the variable contains the verbatim URL requested by the client,
3975     such as "/index.html".  With <code class="directive"><a href="#qualifyredirecturl on">QualifyRedirectURL ON</a></code>, the same request would result in a
3976     value such as "http://www.example.com/index.html".</p>
3977     <p>Even without this directive set, when a request is issued against a
3978     fully qualified URL, REDIRECT_URL will remain fully qualified.
3979     </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="RegisterHttpMethod" id="RegisterHttpMethod">RegisterHttpMethod</a> <a name="registerhttpmethod" id="registerhttpmethod">Directive</a></h2>
3984 <table class="directive">
3985 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Register non-standard HTTP methods</td></tr>
3986 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RegisterHttpMethod <var>method</var> [<var>method</var> [...]]</code></td></tr>
3987 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</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 </table>
3991 <p>HTTP Methods that are not conforming to the relevant RFCs are normally
3992 rejected by request processing in Apache HTTPD. To avoid this, modules
3993 can register non-standard HTTP methods they support.
3994 The <code class="directive">RegisterHttpMethod</code> allows to register such
3995 methods manually. This can be useful if such methods are forwarded
3996 for external processing, e.g. to a CGI script.</p>
3997
3998 </div>
3999 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4000 <div class="directive-section"><h2><a name="RLimitCPU" id="RLimitCPU">RLimitCPU</a> <a name="rlimitcpu" id="rlimitcpu">Directive</a></h2>
4001 <table class="directive">
4002 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limits the CPU consumption of processes launched
4003 by Apache httpd children</td></tr>
4004 <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>
4005 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Unset; uses operating system defaults</code></td></tr>
4006 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
4007 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
4008 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4009 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4010 </table>
4011     <p>Takes 1 or 2 parameters. The first parameter sets the soft
4012     resource limit for all processes and the second parameter sets
4013     the maximum resource limit. Either parameter can be a number,
4014     or <code>max</code> to indicate to the server that the limit should
4015     be set to the maximum allowed by the operating system
4016     configuration. Raising the maximum resource limit requires that
4017     the server is running as <code>root</code> or in the initial startup
4018     phase.</p>
4019
4020     <p>This applies to processes forked from Apache httpd children
4021     servicing requests, not the Apache httpd children themselves. This
4022     includes CGI scripts and SSI exec commands, but not any
4023     processes forked from the Apache httpd parent, such as piped
4024     logs.</p>
4025
4026     <p>CPU resource limits are expressed in seconds per
4027     process.</p>
4028
4029 <h3>See also</h3>
4030 <ul>
4031 <li><code class="directive"><a href="#rlimitmem">RLimitMEM</a></code></li>
4032 <li><code class="directive"><a href="#rlimitnproc">RLimitNPROC</a></code></li>
4033 </ul>
4034 </div>
4035 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4036 <div class="directive-section"><h2><a name="RLimitMEM" id="RLimitMEM">RLimitMEM</a> <a name="rlimitmem" id="rlimitmem">Directive</a></h2>
4037 <table class="directive">
4038 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limits the memory consumption of processes launched
4039 by Apache httpd children</td></tr>
4040 <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>
4041 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Unset; uses operating system defaults</code></td></tr>
4042 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
4043 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
4044 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4045 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4046 </table>
4047     <p>Takes 1 or 2 parameters. The first parameter sets the soft
4048     resource limit for all processes and the second parameter sets
4049     the maximum resource limit. Either parameter can be a number,
4050     or <code>max</code> to indicate to the server that the limit should
4051     be set to the maximum allowed by the operating system
4052     configuration. Raising the maximum resource limit requires that
4053     the server is running as <code>root</code> or in the initial startup
4054     phase.</p>
4055
4056     <p>This applies to processes forked from Apache httpd children
4057     servicing requests, not the Apache httpd children themselves. This
4058     includes CGI scripts and SSI exec commands, but not any
4059     processes forked from the Apache httpd parent, such as piped
4060     logs.</p>
4061
4062     <p>Memory resource limits are expressed in bytes per
4063     process.</p>
4064
4065 <h3>See also</h3>
4066 <ul>
4067 <li><code class="directive"><a href="#rlimitcpu">RLimitCPU</a></code></li>
4068 <li><code class="directive"><a href="#rlimitnproc">RLimitNPROC</a></code></li>
4069 </ul>
4070 </div>
4071 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4072 <div class="directive-section"><h2><a name="RLimitNPROC" id="RLimitNPROC">RLimitNPROC</a> <a name="rlimitnproc" id="rlimitnproc">Directive</a></h2>
4073 <table class="directive">
4074 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limits the number of processes that can be launched by
4075 processes launched by Apache httpd children</td></tr>
4076 <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>
4077 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Unset; uses operating system defaults</code></td></tr>
4078 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
4079 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
4080 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4081 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4082 </table>
4083     <p>Takes 1 or 2 parameters. The first parameter sets the soft
4084     resource limit for all processes, and the second parameter sets
4085     the maximum resource limit. Either parameter can be a number,
4086     or <code>max</code> to indicate to the server that the limit
4087     should be set to the maximum allowed by the operating system
4088     configuration. Raising the maximum resource limit requires that
4089     the server is running as <code>root</code> or in the initial startup
4090     phase.</p>
4091
4092     <p>This applies to processes forked from Apache httpd children
4093     servicing requests, not the Apache httpd children themselves. This
4094     includes CGI scripts and SSI exec commands, but not any
4095     processes forked from the Apache httpd parent, such as piped
4096     logs.</p>
4097
4098     <p>Process limits control the number of processes per user.</p>
4099
4100     <div class="note"><h3>Note</h3>
4101       <p>If CGI processes are <strong>not</strong> running
4102       under user ids other than the web server user id, this directive
4103       will limit the number of processes that the server itself can
4104       create. Evidence of this situation will be indicated by
4105       <strong><code>cannot fork</code></strong> messages in the
4106       <code>error_log</code>.</p>
4107     </div>
4108
4109 <h3>See also</h3>
4110 <ul>
4111 <li><code class="directive"><a href="#rlimitmem">RLimitMEM</a></code></li>
4112 <li><code class="directive"><a href="#rlimitcpu">RLimitCPU</a></code></li>
4113 </ul>
4114 </div>
4115 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4116 <div class="directive-section"><h2><a name="ScriptInterpreterSource" id="ScriptInterpreterSource">ScriptInterpreterSource</a> <a name="scriptinterpretersource" id="scriptinterpretersource">Directive</a></h2>
4117 <table class="directive">
4118 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Technique for locating the interpreter for CGI
4119 scripts</td></tr>
4120 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ScriptInterpreterSource Registry|Registry-Strict|Script</code></td></tr>
4121 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ScriptInterpreterSource Script</code></td></tr>
4122 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
4123 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
4124 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4125 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4126 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Win32 only.</td></tr>
4127 </table>
4128     <p>This directive is used to control how Apache httpd finds the
4129     interpreter used to run CGI scripts. The default setting is
4130     <code>Script</code>. This causes Apache httpd to use the interpreter pointed to
4131     by the shebang line (first line, starting with <code>#!</code>) in the
4132     script. On Win32 systems this line usually looks like:</p>
4133
4134     <pre class="prettyprint lang-perl">#!C:/Perl/bin/perl.exe</pre>
4135
4136
4137     <p>or, if <code>perl</code> is in the <code>PATH</code>, simply:</p>
4138
4139     <pre class="prettyprint lang-perl">#!perl</pre>
4140
4141
4142     <p>Setting <code>ScriptInterpreterSource Registry</code> will
4143     cause the Windows Registry tree <code>HKEY_CLASSES_ROOT</code> to be
4144     searched using the script file extension (e.g., <code>.pl</code>) as a
4145     search key. The command defined by the registry subkey
4146     <code>Shell\ExecCGI\Command</code> or, if it does not exist, by the subkey
4147     <code>Shell\Open\Command</code> is used to open the script file. If the
4148     registry keys cannot be found, Apache httpd falls back to the behavior of the
4149     <code>Script</code> option.</p>
4150
4151     <div class="warning"><h3>Security</h3>
4152     <p>Be careful when using <code>ScriptInterpreterSource
4153     Registry</code> with <code class="directive"><a href="../mod/mod_alias.html#scriptalias">ScriptAlias</a></code>'ed directories, because
4154     Apache httpd will try to execute <strong>every</strong> file within this
4155     directory. The <code>Registry</code> setting may cause undesired
4156     program calls on files which are typically not executed. For
4157     example, the default open command on <code>.htm</code> files on
4158     most Windows systems will execute Microsoft Internet Explorer, so
4159     any HTTP request for an <code>.htm</code> file existing within the
4160     script directory would start the browser in the background on the
4161     server. This is a good way to crash your system within a minute or
4162     so.</p>
4163     </div>
4164
4165     <p>The option <code>Registry-Strict</code> which is new in Apache HTTP Server
4166     2.0 does the same thing as <code>Registry</code> but uses only the
4167     subkey <code>Shell\ExecCGI\Command</code>. The
4168     <code>ExecCGI</code> key is not a common one. It must be
4169     configured manually in the windows registry and hence prevents
4170     accidental program calls on your system.</p>
4171
4172 </div>
4173 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4174 <div class="directive-section"><h2><a name="SeeRequestTail" id="SeeRequestTail">SeeRequestTail</a> <a name="seerequesttail" id="seerequesttail">Directive</a></h2>
4175 <table class="directive">
4176 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Determine if mod_status displays the first 63 characters
4177 of a request or the last 63, assuming the request itself is greater than
4178 63 chars.</td></tr>
4179 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SeeRequestTail On|Off</code></td></tr>
4180 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SeeRequestTail Off</code></td></tr>
4181 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
4182 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4183 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4184 </table>
4185     <p>mod_status with <code>ExtendedStatus On</code>
4186     displays the actual request being handled.
4187     For historical purposes, only 63 characters of the request
4188     are actually stored for display purposes. This directive
4189     controls whether the 1st 63 characters are stored (the previous
4190     behavior and the default) or if the last 63 characters are. This
4191     is only applicable, of course, if the length of the request is
4192     64 characters or greater.</p>
4193
4194     <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:
4195     </p>
4196
4197     <table class="bordered">
4198       <tr>
4199         <th>Off (default)</th>
4200         <td>GET&nbsp;/disk1/storage/apache/htdocs/images/imagestore1/food/apples</td>
4201       </tr>
4202       <tr>
4203         <th>On</th>
4204         <td>orage/apache/htdocs/images/imagestore1/food/apples.jpg&nbsp;HTTP/1.1</td>
4205       </tr>
4206     </table>
4207
4208
4209 </div>
4210 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4211 <div class="directive-section"><h2><a name="ServerAdmin" id="ServerAdmin">ServerAdmin</a> <a name="serveradmin" id="serveradmin">Directive</a></h2>
4212 <table class="directive">
4213 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Email address that the server includes in error
4214 messages sent to the client</td></tr>
4215 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ServerAdmin <var>email-address</var>|<var>URL</var></code></td></tr>
4216 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
4217 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4218 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4219 </table>
4220     <p>The <code class="directive">ServerAdmin</code> sets the contact address
4221     that the server includes in any error messages it returns to the
4222     client. If the <code>httpd</code> doesn't recognize the supplied argument
4223     as an URL, it
4224     assumes, that it's an <var>email-address</var> and prepends it with
4225     <code>mailto:</code> in hyperlink targets. However, it's recommended to
4226     actually use an email address, since there are a lot of CGI scripts that
4227     make that assumption. If you want to use an URL, it should point to another
4228     server under your control. Otherwise users may not be able to contact you in
4229     case of errors.</p>
4230
4231     <p>It may be worth setting up a dedicated address for this, e.g.</p>
4232
4233     <pre class="prettyprint lang-config">ServerAdmin www-admin@foo.example.com</pre>
4234
4235     <p>as users do not always mention that they are talking about the
4236     server!</p>
4237
4238 </div>
4239 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4240 <div class="directive-section"><h2><a name="ServerAlias" id="ServerAlias">ServerAlias</a> <a name="serveralias" id="serveralias">Directive</a></h2>
4241 <table class="directive">
4242 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Alternate names for a host used when matching requests
4243 to name-virtual hosts</td></tr>
4244 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ServerAlias <var>hostname</var> [<var>hostname</var>] ...</code></td></tr>
4245 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>virtual host</td></tr>
4246 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4247 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4248 </table>
4249     <p>The <code class="directive">ServerAlias</code> directive sets the
4250     alternate names for a host, for use with <a href="../vhosts/name-based.html">name-based virtual hosts</a>. The
4251     <code class="directive">ServerAlias</code> may include wildcards, if appropriate.</p>
4252
4253     <pre class="prettyprint lang-config">&lt;VirtualHost *:80&gt;
4254   ServerName server.example.com
4255   ServerAlias server server2.example.com server2
4256   ServerAlias *.example.com
4257   UseCanonicalName Off
4258   # ...
4259 &lt;/VirtualHost&gt;</pre>
4260
4261
4262     <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
4263     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
4264     (nor for ServerName vs. ServerAlias).  </p>
4265
4266     <p>The complete list of names in the <code class="directive"><a href="#virtualhost">&lt;VirtualHost&gt;</a></code>
4267     directive are treated just like a (non wildcard)
4268     <code class="directive">ServerAlias</code>.</p>
4269
4270
4271 <h3>See also</h3>
4272 <ul>
4273 <li><code class="directive"><a href="#usecanonicalname">UseCanonicalName</a></code></li>
4274 <li><a href="../vhosts/">Apache HTTP Server Virtual Host documentation</a></li>
4275 </ul>
4276 </div>
4277 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4278 <div class="directive-section"><h2><a name="ServerName" id="ServerName">ServerName</a> <a name="servername" id="servername">Directive</a></h2>
4279 <table class="directive">
4280 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Hostname and port that the server uses to identify
4281 itself</td></tr>
4282 <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>
4283 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
4284 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4285 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4286 </table>
4287     <p>The <code class="directive">ServerName</code> directive sets the
4288     request scheme, hostname and port that the server uses to identify itself.
4289     </p>
4290
4291     <p><code class="directive">ServerName</code> is used (possibly
4292     in conjunction with <code class="directive"><a href="#serveralias">ServerAlias</a></code>) to uniquely
4293     identify a virtual host, when using <a href="../vhosts/name-based.html">name-based virtual hosts</a>.</p>
4294
4295     <p>Additionally, this is used when
4296     creating self-referential redirection URLs when
4297     <code class="directive"><a href="#usecanonicalname">UseCanonicalName</a></code> is set to a non-default
4298     value.</p>
4299
4300     <p>For example, if the name of the
4301     machine hosting the web server is <code>simple.example.com</code>,
4302     but the machine also has the DNS alias <code>www.example.com</code>
4303     and you wish the web server to be so identified, the following
4304     directive should be used:</p>
4305
4306     <pre class="prettyprint lang-config">ServerName www.example.com</pre>
4307
4308
4309     <p>The <code class="directive">ServerName</code> directive
4310     may appear anywhere within the definition of a server. However,
4311     each appearance overrides the previous appearance (within that
4312     server).</p>
4313
4314     <p>If no <code class="directive">ServerName</code> is specified, the
4315     server attempts to deduce the client visible hostname by first asking
4316     the operating system for the system hostname, and if that fails,
4317     performing a reverse lookup on an IP address present on the system.</p>
4318
4319     <p>If no port is specified in the
4320     <code class="directive">ServerName</code>, then the server will use the
4321     port from the incoming request. For optimal reliability and
4322     predictability, you should specify an explicit hostname and port
4323     using the <code class="directive">ServerName</code> directive.</p>
4324
4325     <p>If you are using <a href="../vhosts/name-based.html">name-based virtual hosts</a>,
4326     the <code class="directive">ServerName</code> inside a
4327     <code class="directive"><a href="#virtualhost">&lt;VirtualHost&gt;</a></code>
4328     section specifies what hostname must appear in the request's
4329     <code>Host:</code> header to match this virtual host.</p>
4330
4331     <p>Sometimes, the server runs behind a device that processes SSL,
4332     such as a reverse proxy, load balancer or SSL offload
4333     appliance. When this is the case, specify the
4334     <code>https://</code> scheme and the port number to which the
4335     clients connect in the <code class="directive">ServerName</code> directive
4336     to make sure that the server generates the correct
4337     self-referential URLs.
4338     </p>
4339
4340     <p>See the description of the
4341     <code class="directive"><a href="#usecanonicalname">UseCanonicalName</a></code> and
4342     <code class="directive"><a href="#usecanonicalphysicalport">UseCanonicalPhysicalPort</a></code> directives for
4343     settings which determine whether self-referential URLs (e.g., by the
4344     <code class="module"><a href="../mod/mod_dir.html">mod_dir</a></code> module) will refer to the
4345     specified port, or to the port number given in the client's request.
4346     </p>
4347
4348     <div class="warning">
4349     <p>Failure to set <code class="directive">ServerName</code> to a name that
4350     your server can resolve to an IP address will result in a startup
4351     warning. <code>httpd</code> will then use whatever hostname it can
4352     determine, using the system's <code>hostname</code> command. This
4353     will almost never be the hostname you actually want.</p>
4354     <div class="example"><p><code>
4355     httpd: Could not reliably determine the server's fully qualified domain name, using rocinante.local for ServerName
4356     </code></p></div>
4357     </div>
4358
4359
4360 <h3>See also</h3>
4361 <ul>
4362 <li><a href="../dns-caveats.html">Issues Regarding DNS and
4363     Apache HTTP Server</a></li>
4364 <li><a href="../vhosts/">Apache HTTP Server virtual host
4365     documentation</a></li>
4366 <li><code class="directive"><a href="#usecanonicalname">UseCanonicalName</a></code></li>
4367 <li><code class="directive"><a href="#usecanonicalphysicalport">UseCanonicalPhysicalPort</a></code></li>
4368 <li><code class="directive"><a href="#serveralias">ServerAlias</a></code></li>
4369 </ul>
4370 </div>
4371 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4372 <div class="directive-section"><h2><a name="ServerPath" id="ServerPath">ServerPath</a> <a name="serverpath" id="serverpath">Directive</a></h2>
4373 <table class="directive">
4374 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Legacy URL pathname for a name-based virtual host that
4375 is accessed by an incompatible browser</td></tr>
4376 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ServerPath <var>URL-path</var></code></td></tr>
4377 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>virtual host</td></tr>
4378 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4379 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4380 </table>
4381     <p>The <code class="directive">ServerPath</code> directive sets the legacy
4382     URL pathname for a host, for use with <a href="../vhosts/">name-based virtual hosts</a>.</p>
4383
4384 <h3>See also</h3>
4385 <ul>
4386 <li><a href="../vhosts/">Apache HTTP Server Virtual Host documentation</a></li>
4387 </ul>
4388 </div>
4389 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4390 <div class="directive-section"><h2><a name="ServerRoot" id="ServerRoot">ServerRoot</a> <a name="serverroot" id="serverroot">Directive</a></h2>
4391 <table class="directive">
4392 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Base directory for the server installation</td></tr>
4393 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ServerRoot <var>directory-path</var></code></td></tr>
4394 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ServerRoot /usr/local/apache</code></td></tr>
4395 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
4396 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4397 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4398 </table>
4399     <p>The <code class="directive">ServerRoot</code> directive sets the
4400     directory in which the server lives. Typically it will contain the
4401     subdirectories <code>conf/</code> and <code>logs/</code>. Relative
4402     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
4403     relative to this directory.</p>
4404
4405     <pre class="prettyprint lang-config">ServerRoot "/home/httpd"</pre>
4406
4407
4408     <p>The default location of <code class="directive">ServerRoot</code> may be
4409     modified by using the <code>--prefix</code> argument to
4410     <a href="../programs/configure.html"><code>configure</code></a>, and
4411     most third-party distributions of the server have a different
4412     default location from the one listed above.</p>
4413
4414
4415 <h3>See also</h3>
4416 <ul>
4417 <li><a href="../invoking.html">the <code>-d</code>
4418     option to <code>httpd</code></a></li>
4419 <li><a href="../misc/security_tips.html#serverroot">the
4420     security tips</a> for information on how to properly set
4421     permissions on the <code class="directive">ServerRoot</code></li>
4422 </ul>
4423 </div>
4424 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4425 <div class="directive-section"><h2><a name="ServerSignature" id="ServerSignature">ServerSignature</a> <a name="serversignature" id="serversignature">Directive</a></h2>
4426 <table class="directive">
4427 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures the footer on server-generated documents</td></tr>
4428 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ServerSignature On|Off|EMail</code></td></tr>
4429 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ServerSignature Off</code></td></tr>
4430 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
4431 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
4432 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4433 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4434 </table>
4435     <p>The <code class="directive">ServerSignature</code> directive allows the
4436     configuration of a trailing footer line under server-generated
4437     documents (error messages, <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> ftp directory
4438     listings, <code class="module"><a href="../mod/mod_info.html">mod_info</a></code> output, ...). The reason why you
4439     would want to enable such a footer line is that in a chain of proxies,
4440     the user often has no possibility to tell which of the chained servers
4441     actually produced a returned error message.</p>
4442
4443     <p>The <code>Off</code>
4444     setting, which is the default, suppresses the footer line (and is
4445     therefore compatible with the behavior of Apache-1.2 and
4446     below). The <code>On</code> setting simply adds a line with the
4447     server version number and <code class="directive"><a href="#servername">ServerName</a></code> of the serving virtual host,
4448     and the <code>EMail</code> setting additionally creates a
4449     "mailto:" reference to the <code class="directive"><a href="#serveradmin">ServerAdmin</a></code> of the referenced
4450     document.</p>
4451
4452     <p>After version 2.0.44, the details of the server version number
4453     presented are controlled by the <code class="directive"><a href="#servertokens">ServerTokens</a></code> directive.</p>
4454
4455 <h3>See also</h3>
4456 <ul>
4457 <li><code class="directive"><a href="#servertokens">ServerTokens</a></code></li>
4458 </ul>
4459 </div>
4460 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4461 <div class="directive-section"><h2><a name="ServerTokens" id="ServerTokens">ServerTokens</a> <a name="servertokens" id="servertokens">Directive</a></h2>
4462 <table class="directive">
4463 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures the <code>Server</code> HTTP response
4464 header</td></tr>
4465 <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>
4466 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ServerTokens Full</code></td></tr>
4467 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
4468 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4469 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4470 </table>
4471     <p>This directive controls whether <code>Server</code> response
4472     header field which is sent back to clients includes a
4473     description of the generic OS-type of the server as well as
4474     information about compiled-in modules.</p>
4475
4476     <dl>
4477       <dt><code>ServerTokens Full</code> (or not specified)</dt>
4478
4479       <dd>Server sends (<em>e.g.</em>): <code>Server: Apache/2.4.2
4480       (Unix) PHP/4.2.2 MyMod/1.2</code></dd>
4481
4482       <dt><code>ServerTokens Prod[uctOnly]</code></dt>
4483
4484       <dd>Server sends (<em>e.g.</em>): <code>Server:
4485       Apache</code></dd>
4486
4487       <dt><code>ServerTokens Major</code></dt>
4488
4489       <dd>Server sends (<em>e.g.</em>): <code>Server:
4490       Apache/2</code></dd>
4491
4492       <dt><code>ServerTokens Minor</code></dt>
4493
4494       <dd>Server sends (<em>e.g.</em>): <code>Server:
4495       Apache/2.4</code></dd>
4496
4497       <dt><code>ServerTokens Min[imal]</code></dt>
4498
4499       <dd>Server sends (<em>e.g.</em>): <code>Server:
4500       Apache/2.4.2</code></dd>
4501
4502       <dt><code>ServerTokens OS</code></dt>
4503
4504       <dd>Server sends (<em>e.g.</em>): <code>Server: Apache/2.4.2
4505       (Unix)</code></dd>
4506
4507     </dl>
4508
4509     <p>This setting applies to the entire server, and cannot be
4510     enabled or disabled on a virtualhost-by-virtualhost basis.</p>
4511
4512     <p>After version 2.0.44, this directive also controls the
4513     information presented by the <code class="directive"><a href="#serversignature">ServerSignature</a></code> directive.</p>
4514
4515     <div class="note">Setting <code class="directive">ServerTokens</code> to less than
4516     <code>minimal</code> is not recommended because it makes it more
4517     difficult to debug interoperational problems. Also note that
4518     disabling the Server: header does nothing at all to make your
4519     server more secure. The idea of "security through obscurity"
4520     is a myth and leads to a false sense of safety.</div>
4521
4522 <h3>See also</h3>
4523 <ul>
4524 <li><code class="directive"><a href="#serversignature">ServerSignature</a></code></li>
4525 </ul>
4526 </div>
4527 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4528 <div class="directive-section"><h2><a name="SetHandler" id="SetHandler">SetHandler</a> <a name="sethandler" id="sethandler">Directive</a></h2>
4529 <table class="directive">
4530 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Forces all matching files to be processed by a
4531 handler</td></tr>
4532 <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>
4533 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
4534 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
4535 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4536 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4537 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>2.5 and later</td></tr>
4538 </table>
4539     <p>When placed into an <code>.htaccess</code> file or a
4540     <code class="directive"><a href="#directory">&lt;Directory&gt;</a></code> or
4541     <code class="directive"><a href="#location">&lt;Location&gt;</a></code>
4542     section, this directive forces all matching files to be parsed
4543     through the <a href="../handler.html">handler</a> given by
4544     <var>handler-name</var>. For example, if you had a directory you
4545     wanted to be parsed entirely as imagemap rule files, regardless
4546     of extension, you might put the following into an
4547     <code>.htaccess</code> file in that directory:</p>
4548
4549     <pre class="prettyprint lang-config">SetHandler imap-file</pre>
4550
4551
4552     <p>Another example: if you wanted to have the server display a
4553     status report whenever a URL of
4554     <code>http://servername/status</code> was called, you might put
4555     the following into <code>httpd.conf</code>:</p>
4556
4557     <pre class="prettyprint lang-config">&lt;Location "/status"&gt;
4558   SetHandler server-status
4559 &lt;/Location&gt;</pre>
4560
4561
4562     <p>You could also use this directive to configure a particular
4563     handler for files with a particular file extension. For example:</p>
4564
4565     <pre class="prettyprint lang-config">&lt;FilesMatch "\.php$"&gt;
4566     SetHandler application/x-httpd-php
4567 &lt;/FilesMatch&gt;</pre>
4568
4569
4570     <p>String-valued expressions can be used to reference per-request
4571     variables, including backreferences to named regular expressions:</p>
4572
4573     <pre class="prettyprint lang-config">&lt;LocationMatch ^/app/(?&lt;sub&gt;[^/]+)/&gt;
4574      SetHandler "proxy:unix:/var/run/app_%{env:MATCH_sub}.sock|fcgi://localhost:8080"
4575 &lt;/LocationMatch&gt;</pre>
4576
4577
4578     <p>You can override an earlier defined <code class="directive">SetHandler</code>
4579     directive by using the value <code>None</code>.</p>
4580
4581     <div class="note"><h3>Note</h3>
4582     <p>Because <code class="directive">SetHandler</code> overrides default handlers,
4583     normal behavior such as handling of URLs ending in a slash (/) as
4584     directories or index files is suppressed.</p></div>
4585
4586 <h3>See also</h3>
4587 <ul>
4588 <li><code class="directive"><a href="../mod/mod_mime.html#addhandler">AddHandler</a></code></li>
4589 </ul>
4590 </div>
4591 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4592 <div class="directive-section"><h2><a name="SetInputFilter" id="SetInputFilter">SetInputFilter</a> <a name="setinputfilter" id="setinputfilter">Directive</a></h2>
4593 <table class="directive">
4594 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the filters that will process client requests and POST
4595 input</td></tr>
4596 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SetInputFilter <var>filter</var>[;<var>filter</var>...]</code></td></tr>
4597 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
4598 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
4599 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4600 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4601 </table>
4602     <p>The <code class="directive">SetInputFilter</code> directive sets the
4603     filter or filters which will process client requests and POST
4604     input when they are received by the server. This is in addition to
4605     any filters defined elsewhere, including the
4606     <code class="directive"><a href="../mod/mod_mime.html#addinputfilter">AddInputFilter</a></code>
4607     directive.</p>
4608
4609     <p>If more than one filter is specified, they must be separated
4610     by semicolons in the order in which they should process the
4611     content.</p>
4612
4613 <h3>See also</h3>
4614 <ul>
4615 <li><a href="../filter.html">Filters</a> documentation</li>
4616 </ul>
4617 </div>
4618 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4619 <div class="directive-section"><h2><a name="SetOutputFilter" id="SetOutputFilter">SetOutputFilter</a> <a name="setoutputfilter" id="setoutputfilter">Directive</a></h2>
4620 <table class="directive">
4621 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the filters that will process responses from the
4622 server</td></tr>
4623 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SetOutputFilter <var>filter</var>[;<var>filter</var>...]</code></td></tr>
4624 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
4625 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
4626 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4627 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4628 </table>
4629     <p>The <code class="directive">SetOutputFilter</code> directive sets the filters
4630     which will process responses from the server before they are
4631     sent to the client. This is in addition to any filters defined
4632     elsewhere, including the
4633     <code class="directive"><a href="../mod/mod_mime.html#addoutputfilter">AddOutputFilter</a></code>
4634     directive.</p>
4635
4636     <p>For example, the following configuration will process all files
4637     in the <code>/www/data/</code> directory for server-side
4638     includes.</p>
4639
4640     <pre class="prettyprint lang-config">&lt;Directory "/www/data/"&gt;
4641   SetOutputFilter INCLUDES
4642 &lt;/Directory&gt;</pre>
4643
4644
4645     <p>If more than one filter is specified, they must be separated
4646     by semicolons in the order in which they should process the
4647     content.</p>
4648
4649 <h3>See also</h3>
4650 <ul>
4651 <li><a href="../filter.html">Filters</a> documentation</li>
4652 </ul>
4653 </div>
4654 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4655 <div class="directive-section"><h2><a name="TimeOut" id="TimeOut">TimeOut</a> <a name="timeout" id="timeout">Directive</a></h2>
4656 <table class="directive">
4657 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Amount of time the server will wait for
4658 certain events before failing a request</td></tr>
4659 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>TimeOut <var>seconds</var></code></td></tr>
4660 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>TimeOut 60</code></td></tr>
4661 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
4662 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4663 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4664 </table>
4665     <p>The <code class="directive">TimeOut</code> directive defines the length
4666     of time Apache httpd will wait for I/O in various circumstances:</p>
4667
4668     <ul>
4669       <li><p>When reading data from the client, the length of time to
4670       wait for a TCP packet to arrive if the read buffer is
4671       empty.</p>
4672       <p> For initial data on a new connection, this directive doesn't
4673       take effect until after any configured <code class="directive"><a href="#acceptfilter">
4674       AcceptFilter</a></code> has passed the new connection to the server.</p>
4675       </li>
4676
4677       <li>When writing data to the client, the length of time to wait
4678       for an acknowledgement of a packet if the send buffer is
4679       full.</li>
4680
4681       <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>,
4682       the length of time to wait for output from a CGI script.</li>
4683
4684       <li>In <code class="module"><a href="../mod/mod_ext_filter.html">mod_ext_filter</a></code>, the length of time to
4685       wait for output from a filtering process.</li>
4686
4687       <li>In <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>, the default timeout value if
4688       <code class="directive"><a href="../mod/mod_proxy.html#proxytimeout">ProxyTimeout</a></code> is not
4689       configured.</li>
4690     </ul>
4691
4692
4693 </div>
4694 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4695 <div class="directive-section"><h2><a name="TraceEnable" id="TraceEnable">TraceEnable</a> <a name="traceenable" id="traceenable">Directive</a></h2>
4696 <table class="directive">
4697 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Determines the behavior on <code>TRACE</code> requests</td></tr>
4698 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>TraceEnable <var>[on|off|extended]</var></code></td></tr>
4699 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>TraceEnable on</code></td></tr>
4700 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
4701 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4702 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4703 </table>
4704     <p>This directive overrides the behavior of <code>TRACE</code> for both
4705     the core server and <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>.  The default
4706     <code>TraceEnable on</code> permits <code>TRACE</code> requests per
4707     RFC 2616, which disallows any request body to accompany the request.
4708     <code>TraceEnable off</code> causes the core server and
4709     <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> to return a <code>405</code> (Method not
4710     allowed) error to the client.</p>
4711
4712     <p>Finally, for testing and diagnostic purposes only, request
4713     bodies may be allowed using the non-compliant <code>TraceEnable
4714     extended</code> directive.  The core (as an origin server) will
4715     restrict the request body to 64Kb (plus 8Kb for chunk headers if
4716     <code>Transfer-Encoding: chunked</code> is used).  The core will
4717     reflect the full headers and all chunk headers with the response
4718     body.  As a proxy server, the request body is not restricted to 64Kb.</p>
4719
4720     <div class="note"><h3>Note</h3>
4721
4722     <p>Despite claims to the contrary, enabling the <code>TRACE</code>
4723     method does not expose any security vulnerability in Apache httpd.
4724     The <code>TRACE</code> method is defined by the HTTP/1.1
4725     specification and implementations are expected to support it.</p>
4726
4727     </div>
4728
4729 </div>
4730 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4731 <div class="directive-section"><h2><a name="UnDefine" id="UnDefine">UnDefine</a> <a name="undefine" id="undefine">Directive</a></h2>
4732 <table class="directive">
4733 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Undefine the existence of a variable</td></tr>
4734 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>UnDefine <var>parameter-name</var></code></td></tr>
4735 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
4736 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4737 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4738 </table>
4739     <p>Undoes the effect of a <code class="directive"><a href="#define">Define</a></code> or
4740     of passing a <code>-D</code> argument to <code class="program"><a href="../programs/httpd.html">httpd</a></code>.</p>
4741     <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
4742     <code>-D</code> arguments in any startup scripts.</p>
4743     <p>While this directive is supported in virtual host context,
4744        the changes it makes are visible to any later configuration
4745        directives, beyond any enclosing virtual host.</p>
4746
4747 <h3>See also</h3>
4748 <ul>
4749 <li><code class="directive"><a href="#define">Define</a></code></li>
4750 <li><code class="directive"><a href="#ifdefine">IfDefine</a></code></li>
4751 </ul>
4752 </div>
4753 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4754 <div class="directive-section"><h2><a name="UseCanonicalName" id="UseCanonicalName">UseCanonicalName</a> <a name="usecanonicalname" id="usecanonicalname">Directive</a></h2>
4755 <table class="directive">
4756 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures how the server determines its own name and
4757 port</td></tr>
4758 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>UseCanonicalName On|Off|DNS</code></td></tr>
4759 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>UseCanonicalName Off</code></td></tr>
4760 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
4761 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4762 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4763 </table>
4764     <p>In many situations Apache httpd must construct a <em>self-referential</em>
4765     URL -- that is, a URL that refers back to the same server. With
4766     <code>UseCanonicalName On</code> Apache httpd will use the hostname and port
4767     specified in the <code class="directive"><a href="#servername">ServerName</a></code>
4768     directive to construct the canonical name for the server. This name
4769     is used in all self-referential URLs, and for the values of
4770     <code>SERVER_NAME</code> and <code>SERVER_PORT</code> in CGIs.</p>
4771
4772     <p>With <code>UseCanonicalName Off</code> Apache httpd will form
4773     self-referential URLs using the hostname and port supplied by
4774     the client if any are supplied (otherwise it will use the
4775     canonical name, as defined above). These values are the same
4776     that are used to implement <a href="../vhosts/name-based.html">name-based virtual hosts</a>
4777     and are available with the same clients. The CGI variables
4778     <code>SERVER_NAME</code> and <code>SERVER_PORT</code> will be
4779     constructed from the client supplied values as well.</p>
4780
4781     <p>An example where this may be useful is on an intranet server
4782     where you have users connecting to the machine using short
4783     names such as <code>www</code>. You'll notice that if the users
4784     type a shortname and a URL which is a directory, such as
4785     <code>http://www/splat</code>, <em>without the trailing
4786     slash</em>, then Apache httpd will redirect them to
4787     <code>http://www.example.com/splat/</code>. If you have
4788     authentication enabled, this will cause the user to have to
4789     authenticate twice (once for <code>www</code> and once again
4790     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">
4791     the FAQ on this subject for more information</a>). But if
4792     <code class="directive">UseCanonicalName</code> is set <code>Off</code>, then
4793     Apache httpd will redirect to <code>http://www/splat/</code>.</p>
4794
4795     <p>There is a third option, <code>UseCanonicalName DNS</code>,
4796     which is intended for use with mass IP-based virtual hosting to
4797     support ancient clients that do not provide a
4798     <code>Host:</code> header. With this option, Apache httpd does a
4799     reverse DNS lookup on the server IP address that the client
4800     connected to in order to work out self-referential URLs.</p>
4801
4802     <div class="warning"><h3>Warning</h3>
4803     <p>If CGIs make assumptions about the values of <code>SERVER_NAME</code>,
4804     they may be broken by this option. The client is essentially free
4805     to give whatever value they want as a hostname. But if the CGI is
4806     only using <code>SERVER_NAME</code> to construct self-referential URLs,
4807     then it should be just fine.</p>
4808     </div>
4809
4810 <h3>See also</h3>
4811 <ul>
4812 <li><code class="directive"><a href="#usecanonicalphysicalport">UseCanonicalPhysicalPort</a></code></li>
4813 <li><code class="directive"><a href="#servername">ServerName</a></code></li>
4814 <li><code class="directive"><a href="../mod/mpm_common.html#listen">Listen</a></code></li>
4815 </ul>
4816 </div>
4817 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4818 <div class="directive-section"><h2><a name="UseCanonicalPhysicalPort" id="UseCanonicalPhysicalPort">UseCanonicalPhysicalPort</a> <a name="usecanonicalphysicalport" id="usecanonicalphysicalport">Directive</a></h2>
4819 <table class="directive">
4820 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures how the server determines its own port</td></tr>
4821 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>UseCanonicalPhysicalPort On|Off</code></td></tr>
4822 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>UseCanonicalPhysicalPort Off</code></td></tr>
4823 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
4824 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4825 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4826 </table>
4827     <p>In many situations Apache httpd must construct a <em>self-referential</em>
4828     URL -- that is, a URL that refers back to the same server. With
4829     <code>UseCanonicalPhysicalPort On</code>, Apache httpd will, when
4830     constructing the canonical port for the server to honor
4831     the <code class="directive"><a href="#usecanonicalname">UseCanonicalName</a></code> directive,
4832     provide the actual physical port number being used by this request
4833     as a potential port. With <code>UseCanonicalPhysicalPort Off</code>,
4834     Apache httpd will not ever use the actual physical port number, instead
4835     relying on all configured information to construct a valid port number.</p>
4836
4837     <div class="note"><h3>Note</h3>
4838     <p>The ordering of the lookup when the physical port is used is as
4839     follows:</p>
4840      <dl>
4841      <dt><code>UseCanonicalName On</code></dt>
4842      <dd>
4843      <ol>
4844       <li>Port provided in <code class="directive"><a href="#servername">Servername</a></code></li>
4845       <li>Physical port</li>
4846       <li>Default port</li>
4847      </ol>
4848      </dd>
4849      <dt><code>UseCanonicalName Off | DNS</code></dt>
4850      <dd>
4851      <ol>
4852       <li>Parsed port from <code>Host:</code> header</li>
4853       <li>Physical port</li>
4854       <li>Port provided in <code class="directive"><a href="#servername">Servername</a></code></li>
4855       <li>Default port</li>
4856      </ol>
4857      </dd>
4858      </dl>
4859
4860     <p>With <code>UseCanonicalPhysicalPort Off</code>, the
4861     physical ports are removed from the ordering.</p>
4862     </div>
4863
4864
4865 <h3>See also</h3>
4866 <ul>
4867 <li><code class="directive"><a href="#usecanonicalname">UseCanonicalName</a></code></li>
4868 <li><code class="directive"><a href="#servername">ServerName</a></code></li>
4869 <li><code class="directive"><a href="../mod/mpm_common.html#listen">Listen</a></code></li>
4870 </ul>
4871 </div>
4872 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4873 <div class="directive-section"><h2><a name="VirtualHost" id="VirtualHost">&lt;VirtualHost&gt;</a> <a name="virtualhost" id="virtualhost">Directive</a></h2>
4874 <table class="directive">
4875 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Contains directives that apply only to a specific
4876 hostname or IP address</td></tr>
4877 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>&lt;VirtualHost
4878     <var>addr</var>[:<var>port</var>] [<var>addr</var>[:<var>port</var>]]
4879     ...&gt; ... &lt;/VirtualHost&gt;</code></td></tr>
4880 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
4881 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4882 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4883 </table>
4884     <p><code class="directive">&lt;VirtualHost&gt;</code> and
4885     <code>&lt;/VirtualHost&gt;</code> are used to enclose a group of
4886     directives that will apply only to a particular virtual host. Any
4887     directive that is allowed in a virtual host context may be
4888     used. When the server receives a request for a document on a
4889     particular virtual host, it uses the configuration directives
4890     enclosed in the <code class="directive">&lt;VirtualHost&gt;</code>
4891     section. <var>Addr</var> can be any of the following, optionally followed by
4892     a colon and a port number (or *):</p>
4893
4894     <ul>
4895       <li>The IP address of the virtual host;</li>
4896
4897       <li>A fully qualified domain name for the IP address of the
4898       virtual host (not recommended);</li>
4899
4900       <li>The character <code>*</code>, which acts as a wildcard and matches
4901       any IP address.</li>
4902
4903       <li>The string <code>_default_</code>, which is an alias for <code>*</code></li>
4904
4905     </ul>
4906
4907     <pre class="prettyprint lang-config">&lt;VirtualHost 10.1.2.3:80&gt;
4908   ServerAdmin webmaster@host.example.com
4909   DocumentRoot "/www/docs/host.example.com"
4910   ServerName host.example.com
4911   ErrorLog "logs/host.example.com-error_log"
4912   TransferLog "logs/host.example.com-access_log"
4913 &lt;/VirtualHost&gt;</pre>
4914
4915
4916
4917     <p>IPv6 addresses must be specified in square brackets because
4918     the optional port number could not be determined otherwise.  An
4919     IPv6 example is shown below:</p>
4920
4921     <pre class="prettyprint lang-config">&lt;VirtualHost [2001:db8::a00:20ff:fea7:ccea]:80&gt;
4922   ServerAdmin webmaster@host.example.com
4923   DocumentRoot "/www/docs/host.example.com"
4924   ServerName host.example.com
4925   ErrorLog "logs/host.example.com-error_log"
4926   TransferLog "logs/host.example.com-access_log"
4927 &lt;/VirtualHost&gt;</pre>
4928
4929
4930     <p>Each Virtual Host must correspond to a different IP address,
4931     different port number, or a different host name for the server,
4932     in the former case the server machine must be configured to
4933     accept IP packets for multiple addresses. (If the machine does
4934     not have multiple network interfaces, then this can be
4935     accomplished with the <code>ifconfig alias</code> command -- if
4936     your OS supports it).</p>
4937
4938     <div class="note"><h3>Note</h3>
4939     <p>The use of <code class="directive">&lt;VirtualHost&gt;</code> does
4940     <strong>not</strong> affect what addresses Apache httpd listens on. You
4941     may need to ensure that Apache httpd is listening on the correct addresses
4942     using <code class="directive"><a href="../mod/mpm_common.html#listen">Listen</a></code>.</p>
4943     </div>
4944
4945     <p>A <code class="directive"><a href="#servername">ServerName</a></code> should be
4946     specified inside each <code class="directive">&lt;VirtualHost&gt;</code> block. If it is absent, the
4947     <code class="directive"><a href="#servername">ServerName</a></code> from the "main"
4948     server configuration will be inherited.</p>
4949
4950     <p>When a request is received, the server first maps it to the best matching
4951     <code class="directive">&lt;VirtualHost&gt;</code> based on the local
4952     IP address and port combination only.  Non-wildcards have a higher
4953     precedence. If no match based on IP and port occurs at all, the
4954     "main" server configuration is used.</p>
4955
4956     <p>If multiple virtual hosts contain the best matching IP address and port,
4957     the server selects from these virtual hosts the best match based on the
4958     requested hostname.  If no matching name-based virtual host is found,
4959     then the first listed virtual host that matched the IP address will be
4960     used.  As a consequence, the first listed virtual host for a given IP address
4961     and port combination is the default virtual host for that IP and port
4962     combination.</p>
4963
4964     <div class="warning"><h3>Security</h3>
4965     <p>See the <a href="../misc/security_tips.html">security tips</a>
4966     document for details on why your security could be compromised if the
4967     directory where log files are stored is writable by anyone other
4968     than the user that starts the server.</p>
4969     </div>
4970
4971 <h3>See also</h3>
4972 <ul>
4973 <li><a href="../vhosts/">Apache HTTP Server Virtual Host documentation</a></li>
4974 <li><a href="../dns-caveats.html">Issues Regarding DNS and
4975     Apache HTTP Server</a></li>
4976 <li><a href="../bind.html">Setting
4977     which addresses and ports Apache HTTP Server uses</a></li>
4978 <li><a href="../sections.html">How &lt;Directory&gt;, &lt;Location&gt;
4979     and &lt;Files&gt; sections work</a> for an explanation of how these
4980     different sections are combined when a request is received</li>
4981 </ul>
4982 </div>
4983 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
4984 <div class="directive-section"><h2><a name="Warning" id="Warning">Warning</a> <a name="warning" id="warning">Directive</a></h2>
4985 <table class="directive">
4986 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Warn from configuration parsing with a custom message</td></tr>
4987 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Warning <var>message</var></code></td></tr>
4988 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
4989 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>
4990 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>
4991 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>2.5 and later</td></tr>
4992 </table>
4993     <p>If an issue can be detected from within the configuration, this
4994     directive can be used to generate a custom warning message. The
4995     configuration parsing is not halted. The typical use is to check
4996     whether some user define options are set, and warn if not.</p>
4997
4998     <pre class="prettyprint lang-config"># Example
4999 # tell when ReverseProxy is not set
5000 &lt;IfDefine !ReverseProxy&gt;
5001   Warning "reverse proxy is not started, hope this is okay!"
5002 &lt;/IfDefine&gt;
5003
5004 &lt;IfDefine ReverseProxy&gt;
5005   # define custom proxy configuration
5006 &lt;/IfDefine&gt;</pre>
5007
5008
5009
5010 </div>
5011 </div>
5012 <div class="bottomlang">
5013 <p><span>Available Languages: </span><a href="../de/mod/core.html" hreflang="de" rel="alternate" title="Deutsch">&nbsp;de&nbsp;</a> |
5014 <a href="../en/mod/core.html" title="English">&nbsp;en&nbsp;</a> |
5015 <a href="../es/mod/core.html" hreflang="es" rel="alternate" title="Español">&nbsp;es&nbsp;</a> |
5016 <a href="../fr/mod/core.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
5017 <a href="../ja/mod/core.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
5018 <a href="../tr/mod/core.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
5019 </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>
5020 <script type="text/javascript"><!--//--><![CDATA[//><!--
5021 var comments_shortname = 'httpd';
5022 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/core.html';
5023 (function(w, d) {
5024     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
5025         d.write('<div id="comments_thread"><\/div>');
5026         var s = d.createElement('script');
5027         s.type = 'text/javascript';
5028         s.async = true;
5029         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
5030         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
5031     }
5032     else {
5033         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
5034     }
5035 })(window, document);
5036 //--><!]]></script></div><div id="footer">
5037 <p class="apache">Copyright 2017 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>
5038 <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[//><!--
5039 if (typeof(prettyPrint) !== 'undefined') {
5040     prettyPrint();
5041 }
5042 //--><!]]></script>
5043 </body></html>