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