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