core.xml revision fec106c7688e279dfde4403bc3c935fec97c1d62
530eba85dbd41b8a0fa5255d3648d1440199a661slive<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">
e942c741056732f50da2074b36fe59805d370650slive<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>
5f5d1b4cc970b7f06ff8ef6526128e9a27303d88nd<!-- $LastChangedRevision$ -->
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding Licensed to the Apache Software Foundation (ASF) under one or more
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding contributor license agreements. See the NOTICE file distributed with
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding this work for additional information regarding copyright ownership.
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding The ASF licenses this file to You under the Apache License, Version 2.0
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding (the "License"); you may not use this file except in compliance with
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding the License. You may obtain a copy of the License at
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd Unless required by applicable law or agreed to in writing, software
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd distributed under the License is distributed on an "AS IS" BASIS,
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd See the License for the specific language governing permissions and
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd limitations under the License.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Core Apache HTTP Server features that are always
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveavailable</description>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna<directivesynopsis>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna<description>Configures optimizations for a Protocol's Listener Sockets</description>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna<syntax>AcceptFilter <var>protocol</var> <var>accept_filter</var></syntax>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna<contextlist><context>server config</context></contextlist>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen<compatibility>Available in Apache httpd 2.1.5 and later.
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowenOn Windows from Apache httpd 2.3.3 and later.</compatibility>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna <p>This directive enables operating system specific optimizations for a
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna listening socket by the <directive>Protocol</directive>type.
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna The basic premise is for the kernel to not send a socket to the server
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna process until either data is received or an entire HTTP Request is buffered.
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna Only <a href="http://www.freebsd.org/cgi/man.cgi?query=accept_filter&sektion=9">
5ae609a8a09239d20f48a4a95c4f21b713995babwrowe FreeBSD's Accept Filters</a>, Linux's more primitive
5ae609a8a09239d20f48a4a95c4f21b713995babwrowe <code>TCP_DEFER_ACCEPT</code>, and Windows' optimized AcceptEx()
5ae609a8a09239d20f48a4a95c4f21b713995babwrowe are currently supported.</p>
5ae609a8a09239d20f48a4a95c4f21b713995babwrowe <p>Using <code>none</code> for an argument will disable any accept filters
5ae609a8a09239d20f48a4a95c4f21b713995babwrowe for that protocol. This is useful for protocols that require a server
5ae609a8a09239d20f48a4a95c4f21b713995babwrowe send data first, such as <code>ftp:</code> or <code>nntp</code>:</p>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna <p>The default protocol names are <code>https</code> for port 443
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna and <code>http</code> for all other ports. To specify another protocol
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna is being used with a listening port, add the <var>protocol</var>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna argument to the <directive module="mpm_common">Listen</directive>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna directive.</p>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna AcceptFilter http httpready <br/>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna AcceptFilter https dataready
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna <p>The <code>httpready</code> accept filter buffers entire HTTP requests at
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna the kernel level. Once an entire request is received, the kernel then
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna sends it to the server. See the
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna <a href="http://www.freebsd.org/cgi/man.cgi?query=accf_http&sektion=9">
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna accf_http(9)</a> man page for more details. Since HTTPS requests are
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna encrypted only the <a href="http://www.freebsd.org/cgi/man.cgi?query=accf_data&sektion=9">
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna AcceptFilter http data <br/>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna AcceptFilter https data
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna <p>Linux's <code>TCP_DEFER_ACCEPT</code> does not support buffering http
5ae609a8a09239d20f48a4a95c4f21b713995babwrowe requests. Any value besides <code>none</code> will enable
5ae609a8a09239d20f48a4a95c4f21b713995babwrowe <code>TCP_DEFER_ACCEPT</code> on that listener. For more details
5ae609a8a09239d20f48a4a95c4f21b713995babwrowe see the Linux
5ae609a8a09239d20f48a4a95c4f21b713995babwrowe <a href="http://homepages.cwi.nl/~aeb/linux/man2html/man7/tcp.7.html">
5ae609a8a09239d20f48a4a95c4f21b713995babwrowe AcceptFilter http data <br/>
5ae609a8a09239d20f48a4a95c4f21b713995babwrowe AcceptFilter https data
5ae609a8a09239d20f48a4a95c4f21b713995babwrowe <p>Window's mpm_winnt interprets the AcceptFilter to toggle the AcceptEx()
5ae609a8a09239d20f48a4a95c4f21b713995babwrowe API, and does not support http protocol buffering. There are two values
5ae609a8a09239d20f48a4a95c4f21b713995babwrowe which utilize the Windows AcceptEx() API and will recycle network
5ae609a8a09239d20f48a4a95c4f21b713995babwrowe sockets between connections. <code>data</code> waits until data has
5ae609a8a09239d20f48a4a95c4f21b713995babwrowe been transmitted as documented above, and the initial data buffer and
5ae609a8a09239d20f48a4a95c4f21b713995babwrowe network endpoint addresses are all retrieved from the single AcceptEx()
5ae609a8a09239d20f48a4a95c4f21b713995babwrowe invocation. <code>connect</code> will use the AcceptEx() API, also
5ae609a8a09239d20f48a4a95c4f21b713995babwrowe retrieve the network endpoint addresses, but like <code>none</code>
5ae609a8a09239d20f48a4a95c4f21b713995babwrowe the <code>connect</code> option does not wait for the initial data
5ae609a8a09239d20f48a4a95c4f21b713995babwrowe transmission.</p>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna <p>On Windows, <code>none</code> uses accept() rather than AcceptEx()
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna and will not recycle sockets between connections. This is useful for
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna network adapters with broken driver support, as well as some virtual
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive network providers such as vpn drivers, or spam, virus or spyware
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive filters.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen<description>Resources accept trailing pathname information</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<context>virtual host</context><context>directory</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<compatibility>Available in Apache httpd 2.0.30 and later</compatibility>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This directive controls whether requests that contain trailing
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive pathname information that follows an actual filename (or
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive non-existent file in an existing directory) will be accepted or
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive rejected. The trailing pathname information can be made
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive available to scripts in the <code>PATH_INFO</code> environment
fb77c505254b6e9c925e23e734463e87574f8f40kess variable.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>For example, assume the location <code>/test/</code> points to
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive a directory that contains only the single file
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The three possible arguments for the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive>AcceptPathInfo</directive> directive are:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <dt><code>Off</code></dt><dd>A request will only be accepted if it
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive maps to a literal path that exists. Therefore a request with
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive trailing pathname information after the true filename such as
fb77c505254b6e9c925e23e734463e87574f8f40kess <code>/test/here.html/more</code> in the above example will return
fb77c505254b6e9c925e23e734463e87574f8f40kess a 404 NOT FOUND error.</dd>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <dt><code>On</code></dt><dd>A request will be accepted if a
fb77c505254b6e9c925e23e734463e87574f8f40kess leading path component maps to a file that exists. The above
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess example <code>/test/here.html/more</code> will be accepted if
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>/test/here.html</code> maps to a valid file.</dd>
fb77c505254b6e9c925e23e734463e87574f8f40kess <dt><code>Default</code></dt><dd>The treatment of requests with
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive trailing pathname information is determined by the <a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive href="/handler.html">handler</a> responsible for the request.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive The core handler for normal files defaults to rejecting
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>PATH_INFO</code> requests. Handlers that serve scripts, such as <a
fb77c505254b6e9c925e23e734463e87574f8f40kess href="mod_isapi.html">isapi-handler</a>, generally accept
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The primary purpose of the <code>AcceptPathInfo</code>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd directive is to allow you to override the handler's choice of
130d299c4b2b15be45532a176604c71fdc7bea5bnd accepting or rejecting <code>PATH_INFO</code>. This override is required,
130d299c4b2b15be45532a176604c71fdc7bea5bnd for example, when you use a <a href="/filter.html">filter</a>, such
130d299c4b2b15be45532a176604c71fdc7bea5bnd as <a href="mod_include.html">INCLUDES</a>, to generate content
130d299c4b2b15be45532a176604c71fdc7bea5bnd based on <code>PATH_INFO</code>. The core handler would usually reject
130d299c4b2b15be45532a176604c71fdc7bea5bnd the request, so you can use the following configuration to enable
ef8e89e090461194ecadd31e8796a2c51e0531a2kess such a script:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Options +Includes<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive SetOutputFilter INCLUDES<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive AcceptPathInfo On<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </Files>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<description>Name of the distributed configuration file</description>
003f0c9fda6664daf5092a0e42f65ede20098153slive<syntax>AccessFileName <var>filename</var> [<var>filename</var>] ...</syntax>
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess<contextlist><context>server config</context><context>virtual host</context>
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess</contextlist>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>While processing a request the server looks for
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd the first existing configuration file from this list of names in
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive every directory of the path to the document, if distributed
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive configuration files are <a href="#allowoverride">enabled for that
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive AccessFileName .acl
130d299c4b2b15be45532a176604c71fdc7bea5bnd <p>before returning the document
130d299c4b2b15be45532a176604c71fdc7bea5bnd <code>/usr/local/web/index.html</code>, the server will read
130d299c4b2b15be45532a176604c71fdc7bea5bnd <code>/usr/local/.acl</code> and <code>/usr/local/web/.acl</code>
130d299c4b2b15be45532a176604c71fdc7bea5bnd for directives, unless they have been disabled with</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <Directory /><br />
1a3f62ca37273a15a06bb94a61d3c6fcf4bf38c9rbowen AllowOverride None<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </Directory>
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding<seealso><directive module="core">AllowOverride</directive></seealso>
684f2a9a422185adda0692a1203c5ad6687fc5c5nd<seealso><a href="/configuring.html">Configuration Files</a></seealso>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<seealso><a href="/howto/htaccess.html">.htaccess Files</a></seealso>
530eba85dbd41b8a0fa5255d3648d1440199a661slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
003f0c9fda6664daf5092a0e42f65ede20098153slive<description>Default charset parameter to be added when a response
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivecontent-type is <code>text/plain</code> or <code>text/html</code></description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>AddDefaultCharset On|Off|<var>charset</var></syntax>
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding<context>virtual host</context><context>directory</context>
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding <p>This directive specifies a default value for the media type
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding charset parameter (the name of a character encoding) to be added
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding to a response if and only if the response's content-type is either
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding <code>text/plain</code> or <code>text/html</code>. This should override
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding any charset specified in the body of the response via a <code>META</code>
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding element, though the exact behavior is often dependent on the user's client
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive configuration. A setting of <code>AddDefaultCharset Off</code>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd disables this functionality. <code>AddDefaultCharset On</code> enables
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd a default charset of <code>iso-8859-1</code>. Any other value is assumed
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd to be the <var>charset</var> to be used, which should be one of the
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding <a href="http://www.iana.org/assignments/character-sets">IANA registered
684f2a9a422185adda0692a1203c5ad6687fc5c5nd charset values</a> for use in Internet media types (MIME types).
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding For example:</p>
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding AddDefaultCharset utf-8
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding <p><directive>AddDefaultCharset</directive> should only be used when all
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding of the text resources to which it applies are known to be in that
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding character encoding and it is too inconvenient to label their charset
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive individually. One such example is to add the charset parameter
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding to resources containing generated content, such as legacy CGI
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive scripts, that might be vulnerable to cross-site scripting attacks
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive due to user-provided data being included in the output. Note, however,
77ead9e0262e4f08ec336d1a65b2edef7705c839nd that a better solution is to just fix (or delete) those scripts, since
77ead9e0262e4f08ec336d1a65b2edef7705c839nd setting a default charset does not protect users that have enabled
9583adab6bc4b3758e41963c905d9dad9f067131nd the "auto-detect character encoding" feature on their browser.</p>
77ead9e0262e4f08ec336d1a65b2edef7705c839nd<seealso><directive module="mod_mime">AddCharset</directive></seealso>
77ead9e0262e4f08ec336d1a65b2edef7705c839nd</directivesynopsis>
77ead9e0262e4f08ec336d1a65b2edef7705c839nd<directivesynopsis>
77ead9e0262e4f08ec336d1a65b2edef7705c839nd<description>Determines whether encoded path separators in URLs are allowed to
77ead9e0262e4f08ec336d1a65b2edef7705c839ndbe passed through</description>
77ead9e0262e4f08ec336d1a65b2edef7705c839nd<contextlist><context>server config</context><context>virtual host</context>
77ead9e0262e4f08ec336d1a65b2edef7705c839nd</contextlist>
77ead9e0262e4f08ec336d1a65b2edef7705c839nd<compatibility>Available in Apache httpd 2.0.46 and later.
77ead9e0262e4f08ec336d1a65b2edef7705c839ndNoDecode option available in 2.3.12 and later.</compatibility>
77ead9e0262e4f08ec336d1a65b2edef7705c839nd <p>The <directive>AllowEncodedSlashes</directive> directive allows URLs
77ead9e0262e4f08ec336d1a65b2edef7705c839nd which contain encoded path separators (<code>%2F</code> for <code>/</code>
9b5e2c5e769dc678a1aca06df75c32022b2f1492trawick and additionally <code>%5C</code> for <code>\</code> on according systems)
77ead9e0262e4f08ec336d1a65b2edef7705c839nd to be used in the path info.</p>
77ead9e0262e4f08ec336d1a65b2edef7705c839nd <p>With the default value, <code>Off</code>, such URLs are refused
77ead9e0262e4f08ec336d1a65b2edef7705c839nd with a 404 (Not found) error.</p>
77ead9e0262e4f08ec336d1a65b2edef7705c839nd <p>With the value <code>On</code>, such URLs are accepted, and encoded
77ead9e0262e4f08ec336d1a65b2edef7705c839nd slashes are decoded like all other encoded characters.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>With the value <code>NoDecode</code>, such URLs are accepted, but
003f0c9fda6664daf5092a0e42f65ede20098153slive encoded slashes are not decoded but left in their encoded state.</p>
fb77c505254b6e9c925e23e734463e87574f8f40kess <p>Turning <directive>AllowEncodedSlashes</directive> <code>On</code> is
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd mostly useful when used in conjunction with <code>PATH_INFO</code>.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>If encoded slashes are needed in path info, use of <code>NoDecode</code> is
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive strongly recommended as a security measure. Allowing slashes
fb77c505254b6e9c925e23e734463e87574f8f40kess to be decoded could potentially allow unsafe paths.</p>
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess<seealso><directive module="core">AcceptPathInfo</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
10673857794a4b3d9568ca2d983722a87ed352f1rbowen<directivesynopsis>
b12b918ae6baf9c5762ed61b7393d0e2198378c0nd<description>Types of directives that are allowed in
10673857794a4b3d9568ca2d983722a87ed352f1rbowen<default>AllowOverride None (2.3.9 and later), AllowOverride All (2.3.8 and earlier)</default>
10673857794a4b3d9568ca2d983722a87ed352f1rbowen<contextlist><context>directory</context></contextlist>
fb77c505254b6e9c925e23e734463e87574f8f40kess <p>When the server finds an <code>.htaccess</code> file (as
fb77c505254b6e9c925e23e734463e87574f8f40kess specified by <directive module="core">AccessFileName</directive>)
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive it needs to know which directives declared in that file can override
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive earlier configuration directives.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <note><title>Only available in <Directory> sections</title>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive type="section" module="core">Directory</directive>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd sections specified without regular expressions, not in <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive type="section" module="core">Location</directive>, <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="core" type="section">DirectoryMatch</directive> or
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive type="section" module="core">Files</directive> sections.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>When this directive is set to <code>None</code> and <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>None</code> <a href="#accessfilename">.htaccess</a> files are
1f53e295ebd19aed1767d12da7abfab9936c148cjerenkrantz completely ignored. In this case, the server will not even attempt
1f53e295ebd19aed1767d12da7abfab9936c148cjerenkrantz to read <code>.htaccess</code> files in the filesystem.</p>
9cd3b05d7b70f07a742bbaf548fa4fa2bdbe5ce6noodl <p>When this directive is set to <code>All</code>, then any
9cd3b05d7b70f07a742bbaf548fa4fa2bdbe5ce6noodl directive which has the .htaccess <a
1f53e295ebd19aed1767d12da7abfab9936c148cjerenkrantz href="directive-dict.html#Context">Context</a> is allowed in
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <var>directive-type</var> can be one of the following
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive groupings of directives.</p>
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding Allow use of the authorization directives (<directive
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding module="mod_authn_dbm">AuthDBMGroupFile</directive>,
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding <directive module="mod_authn_dbm">AuthDBMUserFile</directive>,
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding <directive module="mod_authz_groupfile">AuthGroupFile</directive>,
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem <directive module="mod_authn_core">AuthName</directive>,
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem <directive module="mod_authn_core">AuthType</directive>, <directive
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem module="mod_authn_file">AuthUserFile</directive>, <directive
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem module="mod_authz_core">Require</directive>, <em>etc.</em>).</dd>
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem Allow use of the directives controlling document types
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem <directive module="mod_negotiation">LanguagePriority</directive>,
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem <directive module="core">SetOutputFilter</directive>, and
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem <module>mod_mime</module> Add* and Remove* directives),
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem document meta data (<directive
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem module="mod_headers">RequestHeader</directive>, <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="mod_setenvif">SetEnvIf</directive>, <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="mod_setenvif">SetEnvIfNoCase</directive>, <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="mod_setenvif">BrowserMatch</directive>, <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="mod_usertrack">CookieExpires</directive>, <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="mod_usertrack">CookieDomain</directive>, <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="mod_usertrack">CookieStyle</directive>, <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="mod_usertrack">CookieTracking</directive>, <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="mod_rewrite">RewriteEngine</directive>, <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="mod_rewrite">RewriteOptions</directive>, <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="mod_rewrite">RewriteBase</directive>, <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="mod_rewrite">RewriteCond</directive>, <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive module="mod_actions">Action</directive> from
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Allow use of the directives controlling directory indexing
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive (<directive
9ed9eaf871c58d281af02e76125ceadb5060afa5nd <directive module="mod_autoindex">AddIcon</directive>, <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive module="mod_autoindex">AddIconByType</directive>,
103a93c625bcde1a6a7a5155b64dcda36f612180pquerna <directive module="mod_autoindex">DefaultIcon</directive>, <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="mod_dir">DirectoryIndex</directive>, <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="mod_autoindex">FancyIndexing</directive>, <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="mod_autoindex">HeaderName</directive>, <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="mod_autoindex">IndexIgnore</directive>, <directive
103a93c625bcde1a6a7a5155b64dcda36f612180pquerna module="mod_autoindex">IndexOptions</directive>, <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Allow use of the directives controlling host access (<directive
da637bcae7b6e150470e701af29da5604a34a17erbowen Allow use of the directives controlling specific directory
da637bcae7b6e150470e701af29da5604a34a17erbowen features (<directive module="core">Options</directive> and
da637bcae7b6e150470e701af29da5604a34a17erbowen <directive module="mod_include">XBitHack</directive>).
da637bcae7b6e150470e701af29da5604a34a17erbowen An equal sign may be given followed by a comma (but no spaces)
da637bcae7b6e150470e701af29da5604a34a17erbowen separated lists of options that may be set using the <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Even though the list of options that may be used in .htaccess files
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive can be limited with this directive, as long as any <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="core">Options</directive> directive is allowed any
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive other inherited option can be disabled by using the non-relative
54bcd0e21a5c79158afd3b78bf707a493a5fb33crbowen syntax. In other words, this mechanism cannot force a specific option
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive to remain <em>set</em> while allowing any others to be set.
4c7bdb15764021d39e486adb7bc2166d3f683773bnicholes AllowOverride AuthConfig Indexes
4c7bdb15764021d39e486adb7bc2166d3f683773bnicholes <p>In the example above all directives that are neither in the group
4c7bdb15764021d39e486adb7bc2166d3f683773bnicholes <code>AuthConfig</code> nor <code>Indexes</code> cause an internal
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen server error.</p>
fb77c505254b6e9c925e23e734463e87574f8f40kess <note><p>For security and performance reasons, do not set
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <code>AllowOverride</code> to anything other than <code>None</code>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess in your <code><Directory /></code> block. Instead, find (or
4c7bdb15764021d39e486adb7bc2166d3f683773bnicholes create) the <code><Directory></code> block that refers to the
4c7bdb15764021d39e486adb7bc2166d3f683773bnicholes directory where you're actually planning to place a
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<seealso><directive module="core">AccessFileName</directive></seealso>
fb77c505254b6e9c925e23e734463e87574f8f40kess<seealso><directive module="core">AllowOverrideList</directive></seealso>
fb77c505254b6e9c925e23e734463e87574f8f40kess<seealso><a href="/configuring.html">Configuration Files</a></seealso>
fb77c505254b6e9c925e23e734463e87574f8f40kess<seealso><a href="/howto/htaccess.html">.htaccess Files</a></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Individual directives that are allowed in
5bb5fba250bf526bc51d13b25378d54acb93c1cbnoodl<contextlist><context>directory</context></contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>When the server finds an <code>.htaccess</code> file (as
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive specified by <directive module="core">AccessFileName</directive>)
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive it needs to know which directives declared in that file can override
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive earlier configuration directives.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <note><title>Only available in <Directory> sections</title>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive>AllowOverrideList</directive> is valid only in
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive type="section" module="core">Directory</directive>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd sections specified without regular expressions, not in <directive
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd type="section" module="core">Location</directive>, <directive
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd module="core" type="section">DirectoryMatch</directive> or
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <directive type="section" module="core">Files</directive> sections.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>When this directive is set to <code>None</code> and <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="core">AllowOverride</directive> is set to <code>None</code>,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive then <a href="#accessfilename">.htaccess</a> files are completely
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive ignored. In this case, the server will not even attempt to read
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive AllowOverride None<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive AllowOverrideList Redirect RedirectMatch
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding <p>In the example above only the <code>Redirect</code> and
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding <code>RedirectMatch</code> directives are allowed. All others will
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding cause an internal server error.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive AllowOverride AuthConfig<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive AllowOverrideList CookieTracking CookieName
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>In the example above <directive module="core">AllowOverride
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </directive> grants permission to the <code>AuthConfig</code>
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding directive grouping and <directive>AllowOverrideList</directive> grants
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding permission to only two directves from the <code>FileInfo</code> directive
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding grouping. All others will cause an internal server error.</p>
e4881891552e185a7408318dfc7f62ebabe73cf6niq<seealso><directive module="core">AccessFileName</directive></seealso>
e4881891552e185a7408318dfc7f62ebabe73cf6niq<seealso><directive module="core">AllowOverride</directive></seealso>
e4881891552e185a7408318dfc7f62ebabe73cf6niq<seealso><a href="/configuring.html">Configuration Files</a></seealso>
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding<seealso><a href="/howto/htaccess.html">.htaccess Files</a></seealso>
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding</directivesynopsis>
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding<directivesynopsis>
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding<description>Technique for locating the interpreter for CGI
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fieldingscripts</description>
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding<syntax>CGIMapExtension <var>cgi-path</var> <var>.extension</var></syntax>
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding<contextlist><context>directory</context><context>.htaccess</context>
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding</contextlist>
6e483e0b8aa3fa574288a7452221392a03e2b9a3noodl <p>This directive is used to control how Apache httpd finds the
20b0f809c3823eda58808be053ffc305dfa9c785sf interpreter used to run CGI scripts. For example, setting
6e483e0b8aa3fa574288a7452221392a03e2b9a3noodl cause all CGI script files with a <code>.foo</code> extension to
6e483e0b8aa3fa574288a7452221392a03e2b9a3noodl be passed to the FOO interpreter.</p>
ccf2a600dd72cc3c3c44f5d4126d9bb60fa83894takashi</directivesynopsis>
6e483e0b8aa3fa574288a7452221392a03e2b9a3noodl<directivesynopsis>
6e483e0b8aa3fa574288a7452221392a03e2b9a3noodl<description>Enables the generation of <code>Content-MD5</code> HTTP Response
6e483e0b8aa3fa574288a7452221392a03e2b9a3noodlheaders</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<context>directory</context><context>.htaccess</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This directive enables the generation of
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>Content-MD5</code> headers as defined in RFC1864
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive respectively RFC2616.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>MD5 is an algorithm for computing a "message digest"
003f0c9fda6664daf5092a0e42f65ede20098153slive (sometimes called "fingerprint") of arbitrary-length data, with
003f0c9fda6664daf5092a0e42f65ede20098153slive a high degree of confidence that any alterations in the data
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd will be reflected in alterations in the message digest.</p>
fb77c505254b6e9c925e23e734463e87574f8f40kess <p>The <code>Content-MD5</code> header provides an end-to-end
fb77c505254b6e9c925e23e734463e87574f8f40kess message integrity check (MIC) of the entity-body. A proxy or
fb77c505254b6e9c925e23e734463e87574f8f40kess client may check this header for detecting accidental
fb77c505254b6e9c925e23e734463e87574f8f40kess modification of the entity-body in transit. Example header:</p>
003f0c9fda6664daf5092a0e42f65ede20098153slive Content-MD5: AuLb7Dp1rqtRtxz2m9kRpA==
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <p>Note that this can cause performance problems on your server
130d299c4b2b15be45532a176604c71fdc7bea5bnd since the message digest is computed on every request (the
130d299c4b2b15be45532a176604c71fdc7bea5bnd values are not cached).</p>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <p><code>Content-MD5</code> is only sent for documents served
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd by the <module>core</module>, and not by any module. For example,
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd SSI documents, output from CGI scripts, and byte range responses
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd do not have this header.</p>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen</directivesynopsis>
fb77c505254b6e9c925e23e734463e87574f8f40kess<directivesynopsis>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<description>This directive has no effect other than to emit warnings
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cndif the value is not <code>none</code>. In prior versions, DefaultType
b06660a3ed3d885e15d99c0209a46c4657df33fbrbowenwould specify a default media type to assign to response content for
030108b1816bcda3d925df65357feabdce83bc94slivewhich no other media type configuration could be found.
030108b1816bcda3d925df65357feabdce83bc94slive</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>DefaultType <var>media-type|none</var></syntax>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<contextlist><context>server config</context><context>virtual host</context>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd</contextlist>
fb77c505254b6e9c925e23e734463e87574f8f40kess<compatibility>The argument <code>none</code> is available in Apache httpd 2.2.7 and later. All other choices are DISABLED for 2.3.x and later.</compatibility>
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess <p>This directive has been disabled. For backwards compatibility
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess of configuration files, it may be specified with the value
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess <code>none</code>, meaning no default media type. For example:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive DefaultType None
130d299c4b2b15be45532a176604c71fdc7bea5bnd httpd-2.2.7 and later.</p>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <directive module="mod_mime">AddType</directive> to configure media
130d299c4b2b15be45532a176604c71fdc7bea5bnd type assignments via file extensions, or the
130d299c4b2b15be45532a176604c71fdc7bea5bnd <directive module="core">ForceType</directive> directive to configure
130d299c4b2b15be45532a176604c71fdc7bea5bnd the media type for specific resources. Otherwise, the server will
130d299c4b2b15be45532a176604c71fdc7bea5bnd send the response without a Content-Type header field and the
130d299c4b2b15be45532a176604c71fdc7bea5bnd recipient may attempt to guess the media type.</p>
130d299c4b2b15be45532a176604c71fdc7bea5bnd</directivesynopsis>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>Define <var>parameter-name</var> [<var>parameter-value</var>]</syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>In its one parameter form, <directive>Define</directive> is equivalent
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess to passing the <code>-D</code> argument to <program>httpd</program>. It
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive can be used to toggle the use of
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <directive module="core" type="section">IfDefine</directive> sections
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess without needing to alter <code>-D</code> arguments in any startup
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess scripts.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>In addition to that, if the second parameter is given, a config variable
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive is set to this value. The variable can be used in the configuration using
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the <code>${VAR}</code> syntax. The variable is always globally defined
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive and not limited to the scope of the surrounding config section.</p>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <IfDefine TEST><br/>
130d299c4b2b15be45532a176604c71fdc7bea5bnd </IfDefine><br/>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <IfDefine !TEST><br/>
130d299c4b2b15be45532a176604c71fdc7bea5bnd Define SSL<br/>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </IfDefine><br/>
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess <p>Variable names may not contain colon ":" characters, to avoid clashes
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess with <directive module="mod_rewrite">RewriteMap</directive>'s syntax.</p>
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess</directivesynopsis>
fb77c505254b6e9c925e23e734463e87574f8f40kess<description>Enclose a group of directives that apply only to the
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowennamed file-system directory, sub-directories, and their contents.</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive... </Directory></syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
130d299c4b2b15be45532a176604c71fdc7bea5bnd</contextlist>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <code></Directory></code> are used to enclose a group of
130d299c4b2b15be45532a176604c71fdc7bea5bnd directives that will apply only to the named directory,
130d299c4b2b15be45532a176604c71fdc7bea5bnd sub-directories of that directory, and the files within the respective
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd directories. Any directive that is allowed
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive in a directory context may be used. <var>Directory-path</var> is
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive either the full path to a directory, or a wild-card string using
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Unix shell-style matching. In a wild-card string, <code>?</code> matches
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive any single character, and <code>*</code> matches any sequences of
fb77c505254b6e9c925e23e734463e87574f8f40kess characters. You may also use <code>[]</code> character ranges. None
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive of the wildcards match a `/' character, so <code><Directory
fb77c505254b6e9c925e23e734463e87574f8f40kess /*/public_html></code> will not match
fb77c505254b6e9c925e23e734463e87574f8f40kess <code>/home/user/public_html</code>, but <code><Directory
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive /home/*/public_html></code> will match. Example:</p>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess Options Indexes FollowSymLinks<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </Directory>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Be careful with the <var>directory-path</var> arguments:
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess They have to literally match the filesystem path which Apache httpd uses
15ba1801088da1aad6d20609cf3f7b0b1eefce8aslive to access the files. Directives applied to a particular
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code><Directory></code> will not apply to files accessed from
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd that same directory via a different path, such as via different symbolic
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive expressions</glossary> can also be used, with the addition of the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <Directory ~ "^/www/.*/[0-9]{3}">
030108b1816bcda3d925df65357feabdce83bc94slive <p>would match directories in <code>/www/</code> that consisted of
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd three numbers.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive match the directory (or one of its parents) containing a document,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive then the directives are applied in the order of shortest match
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive first, interspersed with the directives from the <a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive href="#accessfilename">.htaccess</a> files. For example,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <Directory /><br />
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess AllowOverride None<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </Directory><br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <Directory /home><br />
003f0c9fda6664daf5092a0e42f65ede20098153slive AllowOverride FileInfo<br />
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </Directory>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>for access to the document <code>/home/web/dir/doc.html</code>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the steps are:</p>
fb77c505254b6e9c925e23e734463e87574f8f40kess <li>Apply directive <code>AllowOverride FileInfo</code> (for
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <code>/home/.htaccess</code>, <code>/home/web/.htaccess</code> and
c68acc9d712af079afa2bd1a5a4aeef9a3ea573ckess <p>Regular expressions are not considered until after all of the
c68acc9d712af079afa2bd1a5a4aeef9a3ea573ckess normal sections have been applied. Then all of the regular
c68acc9d712af079afa2bd1a5a4aeef9a3ea573ckess expressions are tested in the order they appeared in the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive configuration file. For example, with</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <Directory ~ abc$><br />
1b01d1ee11c612226cb3141eed4581dc179266c1rbowen # ... directives here ...<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </Directory>
003f0c9fda6664daf5092a0e42f65ede20098153slive <p>the regular expression section won't be considered until after
fb77c505254b6e9c925e23e734463e87574f8f40kess all normal <directive type="section">Directory</directive>s and
fb77c505254b6e9c925e23e734463e87574f8f40kess <code>.htaccess</code> files have been applied. Then the regular
af18698b10b429b270551ca3a5d51a75e1c9db22brianp expression will match on <code>/home/abc/public_html/abc</code> and
af18698b10b429b270551ca3a5d51a75e1c9db22brianp the corresponding <directive type="section">Directory</directive> will
af18698b10b429b270551ca3a5d51a75e1c9db22brianp be applied.</p>
af18698b10b429b270551ca3a5d51a75e1c9db22brianp <code><Directory /></code> is to permit all access.
a1ef40892ffa2b44fc249423c5b6c42a74a84c68nd This means that Apache httpd will serve any file mapped from an URL. It is
003f0c9fda6664daf5092a0e42f65ede20098153slive recommended that you change this with a block such
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <Directory /><br />
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd Require all denied<br />
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </Directory>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
af18698b10b429b270551ca3a5d51a75e1c9db22brianp <p><strong>and then override this for directories you
13cbe1d8f52c8097cb581e7eb259693b64d41d10poirier href="/misc/security_tips.html">Security Tips</a> page for more
13cbe1d8f52c8097cb581e7eb259693b64d41d10poirier <p>The directory sections occur in the <code>httpd.conf</code> file.
af18698b10b429b270551ca3a5d51a75e1c9db22brianp <directive type="section">Directory</directive> directives
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd cannot nest, and cannot appear in a <directive module="core"
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd type="section">Limit</directive> or <directive module="core"
fb77c505254b6e9c925e23e734463e87574f8f40kess <Location> and <Files> sections work</a> for an
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd explanation of how these different sections are combined when a
41ef8b3051855b802104193ee0a587515af60a37wrowe request is received</seealso>
41ef8b3051855b802104193ee0a587515af60a37wrowe</directivesynopsis>
41ef8b3051855b802104193ee0a587515af60a37wrowe<description>Enclose directives that apply to
313bb560bc5c323cfd40c9cad7335b4b8e060aedkessthe contents of file-system directories matching a regular expression.</description>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess... </DirectoryMatch></syntax>
41ef8b3051855b802104193ee0a587515af60a37wrowe<contextlist><context>server config</context><context>virtual host</context>
41ef8b3051855b802104193ee0a587515af60a37wrowe</contextlist>
41ef8b3051855b802104193ee0a587515af60a37wrowe <p><directive type="section">DirectoryMatch</directive> and
41ef8b3051855b802104193ee0a587515af60a37wrowe <code></DirectoryMatch></code> are used to enclose a group
41ef8b3051855b802104193ee0a587515af60a37wrowe of directives which will apply only to the named directory (and the files within),
41ef8b3051855b802104193ee0a587515af60a37wrowe the same as <directive module="core" type="section">Directory</directive>.
fb77c505254b6e9c925e23e734463e87574f8f40kess However, it takes as an argument a
fb77c505254b6e9c925e23e734463e87574f8f40kess <glossary ref="regex">regular expression</glossary>. For example:</p>
41ef8b3051855b802104193ee0a587515af60a37wrowe <DirectoryMatch "^/www/(.+/)?[0-9]{3}">
41ef8b3051855b802104193ee0a587515af60a37wrowe <p>would match directories in <code>/www/</code> that consisted of three
41ef8b3051855b802104193ee0a587515af60a37wrowe numbers.</p>
41ef8b3051855b802104193ee0a587515af60a37wrowe Prior to 2.3.9, this directive implicitly applied to sub-directories
41ef8b3051855b802104193ee0a587515af60a37wrowe (like <directive module="core" type="section">Directory</directive>) and
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen could not match the end of line symbol ($). In 2.3.9 and later,
41ef8b3051855b802104193ee0a587515af60a37wrowe only directories that match the expression are affected by the enclosed
41ef8b3051855b802104193ee0a587515af60a37wrowe directives.
41ef8b3051855b802104193ee0a587515af60a37wrowe This directive applies to requests for directories that may or may
41ef8b3051855b802104193ee0a587515af60a37wrowe not end in a trailing slash, so expressions that are anchored to the
41ef8b3051855b802104193ee0a587515af60a37wrowe end of line ($) must be written with care.
9fb925624300c864fe3969a264e52aa83f3c2dd0slive<seealso><directive type="section" module="core">Directory</directive> for
313bb560bc5c323cfd40c9cad7335b4b8e060aedkessa description of how regular expressions are mixed in with normal
78f4d313fd5edf76dc5cfb8725e082a08cd29740jwoolley<directive type="section">Directory</directive>s</seealso>
9d00e5d0f270651f1f1cc1abea03bf53e5656fcecolmhref="/sections.html">How <Directory>, <Location> and
9d00e5d0f270651f1f1cc1abea03bf53e5656fcecolm<Files> sections work</a> for an explanation of how these different
9fb925624300c864fe3969a264e52aa83f3c2dd0slivesections are combined when a request is received</seealso>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess</directivesynopsis>
9fb925624300c864fe3969a264e52aa83f3c2dd0slive<directivesynopsis>
41ef8b3051855b802104193ee0a587515af60a37wrowe<description>Directory that forms the main document tree visible
41ef8b3051855b802104193ee0a587515af60a37wrowefrom the web</description>
05201775eaa6b363b8a119c8aea5db246b967591yoshiki<syntax>DocumentRoot <var>directory-path</var></syntax>
41ef8b3051855b802104193ee0a587515af60a37wrowe<default>DocumentRoot /usr/local/apache/htdocs</default>
41ef8b3051855b802104193ee0a587515af60a37wrowe<contextlist><context>server config</context><context>virtual host</context>
fb77c505254b6e9c925e23e734463e87574f8f40kess</contextlist>
fb77c505254b6e9c925e23e734463e87574f8f40kess <p>This directive sets the directory from which <program>httpd</program>
9fb925624300c864fe3969a264e52aa83f3c2dd0slive will serve files. Unless matched by a directive like <directive
41ef8b3051855b802104193ee0a587515af60a37wrowe module="mod_alias">Alias</directive>, the server appends the
41ef8b3051855b802104193ee0a587515af60a37wrowe path from the requested URL to the document root to make the
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess path to the document. Example:</p>
832853bb93c1831daf24e4727c5ca0e1b1786e83lars <p>then an access to
832853bb93c1831daf24e4727c5ca0e1b1786e83lars <code>http://my.example.com/index.html</code> refers to
832853bb93c1831daf24e4727c5ca0e1b1786e83lars <code>/usr/web/index.html</code>. If the <var>directory-path</var> is
832853bb93c1831daf24e4727c5ca0e1b1786e83lars not absolute then it is assumed to be relative to the <directive
af18698b10b429b270551ca3a5d51a75e1c9db22brianp <p>The <directive>DocumentRoot</directive> should be specified without
af18698b10b429b270551ca3a5d51a75e1c9db22brianp a trailing slash.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><a href="/urlmapping.html#documentroot">Mapping URLs to Filesystem
003f0c9fda6664daf5092a0e42f65ede20098153slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Contains directives that apply only if the condition of a
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveprevious <directive type="section" module="core">If</directive> or
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directive type="section" module="core">ElseIf</directive> section is not
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowensatisfied by a request at runtime</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<context>directory</context><context>.htaccess</context>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <directive type="section">Else</directive> applies the enclosed
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directives if and only if the most recent
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd in the same scope has not been applied.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive For example: In </p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <If "-z req('Host')"><br/>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </If><br/>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <Else><br/>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </Else><br/>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p> The <directive type="section">If</directive> would match HTTP/1.0
69fba5b8aa0b0dc408f649cfdaab064ce120b05bslive <directive type="section">Else</directive> would match requests
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<seealso><directive type="section" module="core">If</directive></seealso>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<seealso><directive type="section" module="core">ElseIf</directive></seealso>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<seealso><a href="/sections.html">How <Directory>, <Location>,
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <Files> sections work</a> for an explanation of how these
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd different sections are combined when a request is received.
f7fe99050600166042c04b8e595fb75499eed7f0geoff <directive type="section">Else</directive> are applied last.</seealso>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen</directivesynopsis>
f7fe99050600166042c04b8e595fb75499eed7f0geoff<description>Contains directives that apply only if a condition is satisfied
f7fe99050600166042c04b8e595fb75499eed7f0geoffby a request at runtime while the condition of a previous
f7fe99050600166042c04b8e595fb75499eed7f0geoff<directive type="section" module="core">If</directive> or
f7fe99050600166042c04b8e595fb75499eed7f0geoff<directive type="section">ElseIf</directive> section is not
f7fe99050600166042c04b8e595fb75499eed7f0geoffsatisfied</description>
f7fe99050600166042c04b8e595fb75499eed7f0geoff<syntax><ElseIf <var>expression</var>> ... </ElseIf></syntax>
f7fe99050600166042c04b8e595fb75499eed7f0geoff<contextlist><context>server config</context><context>virtual host</context>
f7fe99050600166042c04b8e595fb75499eed7f0geoff<context>directory</context><context>.htaccess</context>
f7fe99050600166042c04b8e595fb75499eed7f0geoff</contextlist>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen <p>The <directive type="section">ElseIf</directive> applies the enclosed
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directives if and only if both the given condition evaluates to true and
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the most recent <directive type="section">If</directive> or
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive type="section">ElseIf</directive> section in the same scope has
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive not been applied. For example: In </p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </If><br/>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <ElseIf "-R '10.0.0.0/8'"><br/>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </ElseIf><br/>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <Else><br/>
fb77c505254b6e9c925e23e734463e87574f8f40kess </Else><br/>
fb77c505254b6e9c925e23e734463e87574f8f40kess </example>
4f854c24127e28f7ad72ce9a39d4448aaf910fc1slive <p>The <directive type="section">ElseIf</directive> would match if
4f854c24127e28f7ad72ce9a39d4448aaf910fc1slive the remote address of a request belongs to the subnet 10.0.0.0/8 but
4f854c24127e28f7ad72ce9a39d4448aaf910fc1slive<seealso><a href="/expr.html">Expressions in Apache HTTP Server</a>,
69fba5b8aa0b0dc408f649cfdaab064ce120b05bslivefor a complete reference and more examples.</seealso>
69fba5b8aa0b0dc408f649cfdaab064ce120b05bslive<seealso><directive type="section" module="core">If</directive></seealso>
69fba5b8aa0b0dc408f649cfdaab064ce120b05bslive<seealso><directive type="section" module="core">Else</directive></seealso>
69fba5b8aa0b0dc408f649cfdaab064ce120b05bslive<seealso><a href="/sections.html">How <Directory>, <Location>,
69fba5b8aa0b0dc408f649cfdaab064ce120b05bslive <Files> sections work</a> for an explanation of how these
69fba5b8aa0b0dc408f649cfdaab064ce120b05bslive different sections are combined when a request is received.
b5d3d68a9f683722eac7a3ca507c3e571908dfc0rbowen <directive type="section">Else</directive> are applied last.</seealso>
b5d3d68a9f683722eac7a3ca507c3e571908dfc0rbowen</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Use memory-mapping to read files during delivery</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<context>directory</context><context>.htaccess</context>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This directive controls whether the <program>httpd</program> may use
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive memory-mapping if it needs to read the contents of a file during
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive delivery. By default, when the handling of a request requires
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive access to the data within a file -- for example, when delivering a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive server-parsed file using <module>mod_include</module> -- Apache httpd
c68acc9d712af079afa2bd1a5a4aeef9a3ea573ckess memory-maps the file if the OS supports it.</p>
fb109b84906e3ee61680aa289953c2f9e859354erbowen <p>This memory-mapping sometimes yields a performance improvement.
fb109b84906e3ee61680aa289953c2f9e859354erbowen But in some environments, it is better to disable the memory-mapping
fb109b84906e3ee61680aa289953c2f9e859354erbowen to prevent operational problems:</p>
fb109b84906e3ee61680aa289953c2f9e859354erbowen <li>On some multiprocessor systems, memory-mapping can reduce the
960188481b7025ac8ef7221b67af83dd27e46cd0rjung <li>Deleting or truncating a file while <program>httpd</program>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive has it memory-mapped can cause <program>httpd</program> to
fb109b84906e3ee61680aa289953c2f9e859354erbowen crash with a segmentation fault.
960188481b7025ac8ef7221b67af83dd27e46cd0rjung <p>For server configurations that are vulnerable to these problems,
960188481b7025ac8ef7221b67af83dd27e46cd0rjung you should disable memory-mapping of delivered files by specifying:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive EnableMMAP Off
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>For NFS mounted files, this feature may be disabled explicitly for
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the offending files by specifying:</p>
fb109b84906e3ee61680aa289953c2f9e859354erbowen <Directory "/path-to-nfs-files">
fb109b84906e3ee61680aa289953c2f9e859354erbowen EnableMMAP Off
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </Directory>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
2bac697634d965d9d9a921a99a68b2c454c8a95dbnicholes<directivesynopsis>
2bac697634d965d9d9a921a99a68b2c454c8a95dbnicholes<description>Use the kernel sendfile support to deliver files to the client</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<context>directory</context><context>.htaccess</context>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<compatibility>Available in version 2.0.44 and later. Default changed to Off in
a8ee031b2224ce5473826c9d4f603681589245fawroweversion 2.3.9.</compatibility>
a8ee031b2224ce5473826c9d4f603681589245fawrowe <p>This directive controls whether <program>httpd</program> may use the
a8ee031b2224ce5473826c9d4f603681589245fawrowe sendfile support from the kernel to transmit file contents to the client.
a8ee031b2224ce5473826c9d4f603681589245fawrowe By default, when the handling of a request requires no access
a8ee031b2224ce5473826c9d4f603681589245fawrowe to the data within a file -- for example, when delivering a
a8ee031b2224ce5473826c9d4f603681589245fawrowe static file -- Apache httpd uses sendfile to deliver the file contents
a8ee031b2224ce5473826c9d4f603681589245fawrowe without ever reading the file if the OS supports it.</p>
a8ee031b2224ce5473826c9d4f603681589245fawrowe <p>This sendfile mechanism avoids separate read and send operations,
a8ee031b2224ce5473826c9d4f603681589245fawrowe and buffer allocations. But on some platforms or within some
a8ee031b2224ce5473826c9d4f603681589245fawrowe filesystems, it is better to disable this feature to avoid
a8ee031b2224ce5473826c9d4f603681589245fawrowe operational problems:</p>
a8ee031b2224ce5473826c9d4f603681589245fawrowe <li>Some platforms may have broken sendfile support that the build
a8ee031b2224ce5473826c9d4f603681589245fawrowe system did not detect, especially if the binaries were built on
a8ee031b2224ce5473826c9d4f603681589245fawrowe another box and moved to such a machine with broken sendfile
a8ee031b2224ce5473826c9d4f603681589245fawrowe support.</li>
a8ee031b2224ce5473826c9d4f603681589245fawrowe <li>On Linux the use of sendfile triggers TCP-checksum
34b157732214cedcd129cd9fe7c4290757505d60minfrin offloading bugs on certain networking cards when using IPv6.</li>
a8ee031b2224ce5473826c9d4f603681589245fawrowe <li>On Linux on Itanium, <code>sendfile</code> may be unable to handle
a8ee031b2224ce5473826c9d4f603681589245fawrowe files over 2GB in size.</li>
a8ee031b2224ce5473826c9d4f603681589245fawrowe module="core">DocumentRoot</directive> (e.g., NFS, SMB, CIFS, FUSE),
a8ee031b2224ce5473826c9d4f603681589245fawrowe the kernel may be unable to serve the network file through
02c86afa991026c4146423dc84bc126e57d28df6wrowe its own cache.</li>
34b157732214cedcd129cd9fe7c4290757505d60minfrin <p>For server configurations that are not vulnerable to these problems,
34b157732214cedcd129cd9fe7c4290757505d60minfrin you may enable this feature by specifying:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive EnableSendfile On
a5f060e0c74a44cb8896ae794c08f94f7c9a46a7covener <p>For network mounted files, this feature may be disabled explicitly
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd for the offending files by specifying:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <Directory "/path-to-nfs-files">
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive EnableSendfile Off
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </Directory>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Please note that the per-directory and .htaccess configuration
fb77c505254b6e9c925e23e734463e87574f8f40kess of <directive>EnableSendfile</directive> is not supported by
fb77c505254b6e9c925e23e734463e87574f8f40kess Only global definition of <directive>EnableSendfile</directive>
c976a7c7d20f2be319b128dd7d0b1568da224c0arbowen is taken into account by the module.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
530eba85dbd41b8a0fa5255d3648d1440199a661slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Abort configuration parsing with a custom error message</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
530eba85dbd41b8a0fa5255d3648d1440199a661slive<context>directory</context><context>.htaccess</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
530eba85dbd41b8a0fa5255d3648d1440199a661slive <p>If an error can be detected within the configuration, this
fb77c505254b6e9c925e23e734463e87574f8f40kess directive can be used to generate a custom error message, and halt
fb77c505254b6e9c925e23e734463e87574f8f40kess configuration parsing. The typical use is for reporting required
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive modules which are missing from the configuration.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd # ensure that mod_include is loaded<br />
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <IfModule !include_module><br />
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd Error mod_include is required by mod_foo. Load it with LoadModule.<br />
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </IfModule><br />
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd # ensure that exactly one of SSL,NOSSL is defined<br />
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <IfDefine SSL><br />
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <IfDefine NOSSL><br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Error Both SSL and NOSSL are defined. Define only one of them.<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </IfDefine><br />
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </IfDefine><br />
0db981f8fdfb62c5149efa079f0369b73d472d04rpluem <IfDefine !SSL><br />
0db981f8fdfb62c5149efa079f0369b73d472d04rpluem <IfDefine !NOSSL><br />
0db981f8fdfb62c5149efa079f0369b73d472d04rpluem Error Either SSL or NOSSL must be defined.<br />
0db981f8fdfb62c5149efa079f0369b73d472d04rpluem </IfDefine><br />
0db981f8fdfb62c5149efa079f0369b73d472d04rpluem </IfDefine><br />
a5f060e0c74a44cb8896ae794c08f94f7c9a46a7covener</directivesynopsis>
a5f060e0c74a44cb8896ae794c08f94f7c9a46a7covener<directivesynopsis>
a5f060e0c74a44cb8896ae794c08f94f7c9a46a7covener<description>What the server will return to the client
a5f060e0c74a44cb8896ae794c08f94f7c9a46a7covenerin case of an error</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>ErrorDocument <var>error-code</var> <var>document</var></syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<context>directory</context><context>.htaccess</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>In the event of a problem or error, Apache httpd can be configured
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive to do one of four things,</p>
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess <li>redirect to a local <var>URL-path</var> to handle the
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess <li>redirect to an external <var>URL</var> to handle the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The first option is the default, while options 2-4 are
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive configured using the <directive>ErrorDocument</directive>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directive, which is followed by the HTTP response code and a URL
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive or a message. Apache httpd will sometimes offer additional information
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>URLs can begin with a slash (/) for local web-paths (relative
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive to the <directive module="core">DocumentRoot</directive>), or be a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive full URL which the client can resolve. Alternatively, a message
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive can be provided to be displayed by the browser. Examples:</p>
030108b1816bcda3d925df65357feabdce83bc94slive ErrorDocument 500 http://foo.example.com/cgi-bin/tester<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive ErrorDocument 403 "Sorry can't allow you access today"<br />
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd ErrorDocument 403 Forbidden!
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>Additionally, the special value <code>default</code> can be used
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd to specify Apache httpd's simple hardcoded message. While not required
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess under normal circumstances, <code>default</code> will restore
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess Apache httpd's simple hardcoded message for configurations that would
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess otherwise inherit an existing <directive>ErrorDocument</directive>.</p>
fb77c505254b6e9c925e23e734463e87574f8f40kess ErrorDocument 404 default<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </Directory>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <p>Note that when you specify an <directive>ErrorDocument</directive>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess that points to a remote URL (ie. anything with a method such as
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>http</code> in front of it), Apache HTTP Server will send a redirect to the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive client to tell it where to find the document, even if the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive document ends up being on the same server. This has several
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive implications, the most important being that the client will not
003f0c9fda6664daf5092a0e42f65ede20098153slive receive the original error status code, but instead will
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive receive a redirect status code. This in turn can confuse web
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd robots and other clients which try to determine if a URL is
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive valid using the status code. In addition, if you use a remote
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive URL in an <code>ErrorDocument 401</code>, the client will not
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive know to prompt the user for a password since it will not
003f0c9fda6664daf5092a0e42f65ede20098153slive receive the 401 status code. Therefore, <strong>if you use an
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>ErrorDocument 401</code> directive then it must refer to a local
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess <p>Microsoft Internet Explorer (MSIE) will by default ignore
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess server-generated error messages when they are "too small" and substitute
030108b1816bcda3d925df65357feabdce83bc94slive its own "friendly" error messages. The size threshold varies depending on
030108b1816bcda3d925df65357feabdce83bc94slive the type of error, but in general, if you make your error document
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd greater than 512 bytes, then MSIE will show the server-generated
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd error rather than masking it. More information is available in
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd Microsoft Knowledge Base article <a
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd href="http://support.microsoft.com/default.aspx?scid=kb;en-us;Q294807"
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Although most error messages can be overriden, there are certain
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess circumstances where the internal messages are used regardless of the
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess setting of <directive module="core">ErrorDocument</directive>. In
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess particular, if a malformed request is detected, normal request processing
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess will be immediately halted and the internal error message returned.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive This is necessary to guard against security problems caused by
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive bad requests.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>If you are using mod_proxy, you may wish to enable
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive module="mod_proxy">ProxyErrorOverride</directive> so that you can provide
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding custom error messages on behalf of your Origin servers. If you don't enable ProxyErrorOverride,
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding Apache httpd will not generate custom error documents for proxied content.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
fb77c505254b6e9c925e23e734463e87574f8f40kess<description>Location where the server will log errors</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax> ErrorLog <var>file-path</var>|syslog[:<var>facility</var>]</syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<default>ErrorLog logs/error_log (Unix) ErrorLog logs/error.log (Windows and OS/2)</default>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding</contextlist>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>The <directive>ErrorLog</directive> directive sets the name of
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd the file to which the server will log any errors it encounters. If
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd the <var>file-path</var> is not absolute then it is assumed to be
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd relative to the <directive module="core">ServerRoot</directive>.</p>
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding begins with a pipe character "<code>|</code>" then it is assumed to be a
c97e8972ab1f4dd167e3dc4db87daf91114009fbnd command to spawn to handle the error log.</p>
7654193c1faf603feec999850322ad79e6c551bcnd </example>
7654193c1faf603feec999850322ad79e6c551bcnd <p>See the notes on <a href="/logs.html#piped">piped logs</a> for
7654193c1faf603feec999850322ad79e6c551bcnd more information.</p>
7654193c1faf603feec999850322ad79e6c551bcnd <p>Using <code>syslog</code> instead of a filename enables logging
7654193c1faf603feec999850322ad79e6c551bcnd via syslogd(8) if the system supports it. The default is to use
7654193c1faf603feec999850322ad79e6c551bcnd syslog facility <code>local7</code>, but you can override this by
7654193c1faf603feec999850322ad79e6c551bcnd using the <code>syslog:<var>facility</var></code> syntax where
c97e8972ab1f4dd167e3dc4db87daf91114009fbnd <var>facility</var> can be one of the names usually documented in
7654193c1faf603feec999850322ad79e6c551bcnd syslog(1). The facility is effectively global, and if it is changed
7654193c1faf603feec999850322ad79e6c551bcnd in individual virtual hosts, the final facility specified affects the
7654193c1faf603feec999850322ad79e6c551bcnd entire server.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive ErrorLog syslog:user
fb77c505254b6e9c925e23e734463e87574f8f40kess href="/misc/security_tips.html#serverroot">security tips</a>
fb77c505254b6e9c925e23e734463e87574f8f40kess document for details on why your security could be compromised
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive if the directory where log files are stored is writable by
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive anyone other than the user that starts the server.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>When entering a file path on non-Unix platforms, care should be taken
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive to make sure that only forward slashes are used even though the platform
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive may allow the use of back slashes. In general it is a good idea to always
fb77c505254b6e9c925e23e734463e87574f8f40kess use forward slashes throughout the configuration files.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive module="core">LogLevel</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><a href="/logs.html">Apache HTTP Server Log Files</a></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
9ed9eaf871c58d281af02e76125ceadb5060afa5nd<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Format specification for error log entries</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax> ErrorLogFormat [connection|request] <var>format</var></syntax>
fb77c505254b6e9c925e23e734463e87574f8f40kess<contextlist><context>server config</context><context>virtual host</context>
fb77c505254b6e9c925e23e734463e87574f8f40kess</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<compatibility>Available in Apache httpd 2.3.9 and later</compatibility>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p><directive>ErrorLogFormat</directive> allows to specify what
fb77c505254b6e9c925e23e734463e87574f8f40kess supplementary information is logged in the error log in addition to the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive actual log message.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive ErrorLogFormat "[%t] [%l] [pid %P] %F: %E: [client %a] %M"
fb77c505254b6e9c925e23e734463e87574f8f40kess </example>
a1ef40892ffa2b44fc249423c5b6c42a74a84c68nd <p>Specifying <code>connection</code> or <code>request</code> as first
a1ef40892ffa2b44fc249423c5b6c42a74a84c68nd parameter allows to specify additional formats, causing additional
a1ef40892ffa2b44fc249423c5b6c42a74a84c68nd information to be logged when the first message is logged for a specific
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive connection or request, respectively. This additional information is only
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive logged once per connection/request. If a connection or request is processed
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive without causing any log message, the additional information is not logged
750d12c59545dbbac70390988de94f7e901b08f2niq either.</p>
750d12c59545dbbac70390988de94f7e901b08f2niq <p>It can happen that some format string items do not produce output. For
750d12c59545dbbac70390988de94f7e901b08f2niq example, the Referer header is only present if the log message is
750d12c59545dbbac70390988de94f7e901b08f2niq associated to a request and the log message happens at a time when the
750d12c59545dbbac70390988de94f7e901b08f2niq Referer header has already been read from the client. If no output is
750d12c59545dbbac70390988de94f7e901b08f2niq produced, the default behavior is to delete everything from the preceeding
750d12c59545dbbac70390988de94f7e901b08f2niq space character to the next space character. This means the log line is
750d12c59545dbbac70390988de94f7e901b08f2niq implicitly divided into fields on non-whitespace to whitespace transitions.
750d12c59545dbbac70390988de94f7e901b08f2niq If a format string item does not produce output, the whole field is
750d12c59545dbbac70390988de94f7e901b08f2niq ommitted. For example, if the remote address <code>%a</code> in the log
750d12c59545dbbac70390988de94f7e901b08f2niq format <code>[%t] [%l] [%a] %M </code> is not available, the surrounding
750d12c59545dbbac70390988de94f7e901b08f2niq brackets are not logged either. Space characters can be escaped with a
750d12c59545dbbac70390988de94f7e901b08f2niq backslash to prevent them from delimiting a field. The combination '% '
750d12c59545dbbac70390988de94f7e901b08f2niq (percent space) is a zero-witdh field delimiter that does not produce any
750d12c59545dbbac70390988de94f7e901b08f2niq output.</p>
750d12c59545dbbac70390988de94f7e901b08f2niq <p>The above behavior can be changed by adding modifiers to the format
750d12c59545dbbac70390988de94f7e901b08f2niq string item. A <code>-</code> (minus) modifier causes a minus to be logged if the
750d12c59545dbbac70390988de94f7e901b08f2niq respective item does not produce any output. In once-per-connection/request
750d12c59545dbbac70390988de94f7e901b08f2niq formats, it is also possible to use the <code>+</code> (plus) modifier. If an
13fa73dcc1b52bc8b86ac7008ce81e8c94c1c7f2rbowen item with the plus modifier does not produce any output, the whole line is
13fa73dcc1b52bc8b86ac7008ce81e8c94c1c7f2rbowen ommitted.</p>
13fa73dcc1b52bc8b86ac7008ce81e8c94c1c7f2rbowen <p>A number as modifier can be used to assign a log severity level to a
750d12c59545dbbac70390988de94f7e901b08f2niq format item. The item will only be logged if the severity of the log
750d12c59545dbbac70390988de94f7e901b08f2niq message is not higher than the specified log severity level. The number can
750d12c59545dbbac70390988de94f7e901b08f2niq range from 1 (alert) over 4 (warn) and 7 (debug) to 15 (trace8).</p>
750d12c59545dbbac70390988de94f7e901b08f2niq <p>For example, here's what would happen if you added modifiers to
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <columnspec><column width=".3"/><column width=".7"/></columnspec>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <td>Logs a <code>-</code> if <code>Referer</code> is not set.</td>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <td>Omits the entire line if <code>Referer</code> is not set.</td>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <td>Logs the <code>Referer</code> only if the log message severity
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd is higher than 4.</td>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Some format string items accept additional parameters in braces.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <columnspec><column width=".2"/><column width=".8"/></columnspec>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <tr><th>Format String</th> <th>Description</th></tr>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <td>Request environment variable <em>name</em></td></tr>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <td>Source file name and line number of the log call</td></tr>
955d7fc3e7adb6463b7243e15c04e858718e799etakashi <td>Number of keep-alive requests on this connection</td></tr>
955d7fc3e7adb6463b7243e15c04e858718e799etakashi <td>Log ID of the connection if used in connection scope, empty otherwise</td></tr>
003f0c9fda6664daf5092a0e42f65ede20098153slive <td>System unique thread ID of current thread (the same ID as
55d36f9b61520c2374ab463e77e8a62daa416398nd displayed by e.g. <code>top</code>; currently Linux only)</td></tr>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <td>The current time in compact ISO 8601 format, including
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <td>The canonical <directive module="core">ServerName</directive>
55d36f9b61520c2374ab463e77e8a62daa416398nd <td>The server name of the server serving the request according to the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive module="core" >UseCanonicalName</directive>
55d36f9b61520c2374ab463e77e8a62daa416398nd <p>The log ID format <code>%L</code> produces a unique id for a connection
55d36f9b61520c2374ab463e77e8a62daa416398nd or request. This can be used to correlate which log lines belong to the
55d36f9b61520c2374ab463e77e8a62daa416398nd same connection or request, which request happens on which connection.
55d36f9b61520c2374ab463e77e8a62daa416398nd <module>mod_log_config</module>, to allow to correlate access log entries
bea526116133aa3d7dabd1924bfc580b37fbf22aslive with error log lines. If <module>mod_unique_id</module> is loaded, its
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive unique id will be used as log ID for requests.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive ErrorLogFormat "[%{u}t] [%-m:%l] [pid %P:tid %T] %7F: %E: [client\ %a]
bea526116133aa3d7dabd1924bfc580b37fbf22aslive %M% ,\ referer\ %{Referer}i"
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive [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
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Notice that, as discussed above, some fields are ommitted
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive entirely because they are not defined.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <example><title>Example (similar to the 2.2.x format)</title>
3621f3acee323a877639a96d84891095eb07933aminfrin ErrorLogFormat "[%t] [%l] %7F: %E: [client\ %a]
003f0c9fda6664daf5092a0e42f65ede20098153slive %M% ,\ referer\ %{Referer}i"
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin <example><title>Advanced example with request/connection log IDs</title>
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin ErrorLogFormat "[%{uc}t] [%-m:%-l] [R:%L] [C:%{C}L] %7F: %E: %M"<br/>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive ErrorLogFormat request "[%{uc}t] [R:%L] Request %k on C:%{c}L pid:%P tid:%T"<br/>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive ErrorLogFormat request "[%{uc}t] [R:%L] UA:'%+{User-Agent}i'"<br/>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive ErrorLogFormat request "[%{uc}t] [R:%L] Referer:'%+{Referer}i'"<br/>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive ErrorLogFormat connection "[%{uc}t] [C:%{c}L] local\ %a remote\ %A"<br/>
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin<seealso><directive module="core">ErrorLog</directive></seealso>
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin<seealso><directive module="core">LogLevel</directive></seealso>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen<seealso><a href="/logs.html">Apache HTTP Server Log Files</a></seealso>
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin</directivesynopsis>
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin<directivesynopsis>
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin<description>Keep track of extended status information for each
cf8a8738330694e60bad421fcc8361d80b0e9124minfrinrequest</description>
3621f3acee323a877639a96d84891095eb07933aminfrin<contextlist><context>server config</context></contextlist>
3621f3acee323a877639a96d84891095eb07933aminfrin <p>This option tracks additional data per worker about the
3621f3acee323a877639a96d84891095eb07933aminfrin currently executing request, and a utilization summary; you
3621f3acee323a877639a96d84891095eb07933aminfrin can see these variables during runtime by configuring
3621f3acee323a877639a96d84891095eb07933aminfrin <module>mod_status</module>. Note that other modules may
3621f3acee323a877639a96d84891095eb07933aminfrin rely on this scoreboard.</p>
3621f3acee323a877639a96d84891095eb07933aminfrin <p>This setting applies to the entire server, and cannot be
3621f3acee323a877639a96d84891095eb07933aminfrin enabled or disabled on a virtualhost-by-virtualhost basis.
3621f3acee323a877639a96d84891095eb07933aminfrin The collection of extended status information can slow down
3621f3acee323a877639a96d84891095eb07933aminfrin the server. Also note that this setting cannot be changed
3621f3acee323a877639a96d84891095eb07933aminfrin during a graceful restart.</p>
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin <p>Note that loading <module>mod_status</module> will change
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin the default behavior to ExtendedStatus On, while other
3621f3acee323a877639a96d84891095eb07933aminfrin third party modules may do the same. Such modules rely on
03aa31ad82759363ba1a55589e517b16308ef635minfrin collecting detailed information about the state of all workers.
c68acc9d712af079afa2bd1a5a4aeef9a3ea573ckess The default is changed by <module>mod_status</module> beginning
c68acc9d712af079afa2bd1a5a4aeef9a3ea573ckess with version 2.3.6; the previous default was always Off.</p>
7b5535ed88e0f561b3bfb3330137bd804846afd4slive</directivesynopsis>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<directivesynopsis>
7b5535ed88e0f561b3bfb3330137bd804846afd4slive<description>File attributes used to create the ETag
7b5535ed88e0f561b3bfb3330137bd804846afd4sliveHTTP response header for static files</description>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<contextlist><context>server config</context><context>virtual host</context>
7b5535ed88e0f561b3bfb3330137bd804846afd4slive<context>directory</context><context>.htaccess</context>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd</contextlist>
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin<compatibility>The default used to be "INode MTime Size" in 2.3.14 and
3621f3acee323a877639a96d84891095eb07933aminfrinearlier.</compatibility>
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin The <directive>FileETag</directive> directive configures the file
3621f3acee323a877639a96d84891095eb07933aminfrin attributes that are used to create the <code>ETag</code> (entity
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin tag) response header field when the document is based on a static file.
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin (The <code>ETag</code> value is used in cache management to save
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin network bandwidth.) The
3621f3acee323a877639a96d84891095eb07933aminfrin <directive>FileETag</directive> directive allows you to choose
3621f3acee323a877639a96d84891095eb07933aminfrin which of these -- if any -- should be used. The recognized keywords are:
3621f3acee323a877639a96d84891095eb07933aminfrin <dd>The file's i-node number will be included in the calculation</dd>
3621f3acee323a877639a96d84891095eb07933aminfrin <dd>The date and time the file was last modified will be included</dd>
3621f3acee323a877639a96d84891095eb07933aminfrin <dd>The number of bytes in the file will be included</dd>
3621f3acee323a877639a96d84891095eb07933aminfrin <dd>All available fields will be used. This is equivalent to:
03aa31ad82759363ba1a55589e517b16308ef635minfrin <dd>If a document is file-based, no <code>ETag</code> field will be
03aa31ad82759363ba1a55589e517b16308ef635minfrin included in the response</dd>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <code>INode</code>, <code>MTime</code>, and <code>Size</code>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive keywords may be prefixed with either <code>+</code> or <code>-</code>,
003f0c9fda6664daf5092a0e42f65ede20098153slive which allow changes to be made to the default setting inherited
fb77c505254b6e9c925e23e734463e87574f8f40kess from a broader scope. Any keyword appearing without such a prefix
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive immediately and completely cancels the inherited setting.</p>
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele <p>If a directory's configuration includes
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>FileETag INode MTime Size</code>, and a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive subdirectory's includes <code>FileETag -INode</code>,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the setting for that subdirectory (which will be inherited by
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive any sub-subdirectories that don't override it) will be equivalent to
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Do not change the default for directories or locations that have WebDAV
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess enabled and use <module>mod_dav_fs</module> as a storage provider.
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <module>mod_dav_fs</module> uses <code>MTime Size</code>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive as a fixed format for <code>ETag</code> comparisons on conditional requests.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive These conditional requests will break if the <code>ETag</code> format is
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive An ETag is not generated for responses parsed by <module>mod_include</module>,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive since the response entity can change without a change of the INode, MTime, or Size
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive of the static file with embedded SSI directives.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
59368b594c9b09b59ae58c7de26d2d5ce1c99a29takashi<description>Contains directives that apply to matched
891df99fdfa41fc8a486568f4d31ddf4a571258adreidfilenames</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax><Files <var>filename</var>> ... </Files></syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<context>directory</context><context>.htaccess</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
98f5034c8cbf2ef025b317b3e01acae82e143b11trawick <p>The <directive type="section">Files</directive> directive
98f5034c8cbf2ef025b317b3e01acae82e143b11trawick limits the scope of the enclosed directives by filename. It is comparable
9f38f3ec3e8087985d108a24ae796962fef83644takashi to the <directive module="core" type="section">Directory</directive>
98f5034c8cbf2ef025b317b3e01acae82e143b11trawick and <directive module="core" type="section">Location</directive>
98f5034c8cbf2ef025b317b3e01acae82e143b11trawick directives. It should be matched with a <code></Files></code>
98f5034c8cbf2ef025b317b3e01acae82e143b11trawick directive. The directives given within this section will be applied to
9f38f3ec3e8087985d108a24ae796962fef83644takashi any object with a basename (last component of filename) matching the
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen specified filename. <directive type="section">Files</directive>
98f5034c8cbf2ef025b317b3e01acae82e143b11trawick sections are processed in the order they appear in the
98f5034c8cbf2ef025b317b3e01acae82e143b11trawick configuration file, after the <directive module="core"
9f38f3ec3e8087985d108a24ae796962fef83644takashi <code>.htaccess</code> files are read, but before <directive
9f38f3ec3e8087985d108a24ae796962fef83644takashi type="section" module="core">Location</directive> sections. Note
98f5034c8cbf2ef025b317b3e01acae82e143b11trawick that <directive type="section">Files</directive> can be nested
98f5034c8cbf2ef025b317b3e01acae82e143b11trawick module="core">Directory</directive> sections to restrict the
98f5034c8cbf2ef025b317b3e01acae82e143b11trawick portion of the filesystem they apply to.</p>
98f5034c8cbf2ef025b317b3e01acae82e143b11trawick <p>The <var>filename</var> argument should include a filename, or
98f5034c8cbf2ef025b317b3e01acae82e143b11trawick a wild-card string, where <code>?</code> matches any single character,
c6f90ef0e93c077924fd0c3c0200dba0cb1777c6takashi and <code>*</code> matches any sequences of characters.
85349f40d98fb3fc7a18ef25dc40eaaae6eead1ctakashi <glossary ref="regex">Regular expressions</glossary>
85349f40d98fb3fc7a18ef25dc40eaaae6eead1ctakashi can also be used, with the addition of the
98f5034c8cbf2ef025b317b3e01acae82e143b11trawick <Files ~ "\.(gif|jpe?g|png)$">
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>would match most common Internet graphics formats. <directive
003f0c9fda6664daf5092a0e42f65ede20098153slive module="core" type="section">FilesMatch</directive> is preferred,
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess however.</p>
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd module="core">Directory</directive> and <directive type="section"
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="core">Location</directive> sections, <directive
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd type="section">Files</directive> sections can be used inside
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>.htaccess</code> files. This allows users to control access to
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive their own files, at a file-by-file level.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><a href="/sections.html">How <Directory>, <Location>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive and <Files> sections work</a> for an explanation of how these
130d299c4b2b15be45532a176604c71fdc7bea5bnd different sections are combined when a request is received</seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<description>Contains directives that apply to regular-expression matched
313bb560bc5c323cfd40c9cad7335b4b8e060aedkessfilenames</description>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<syntax><FilesMatch <var>regex</var>> ... </FilesMatch></syntax>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<contextlist><context>server config</context><context>virtual host</context>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<context>directory</context><context>.htaccess</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <p>The <directive type="section">FilesMatch</directive> directive
130d299c4b2b15be45532a176604c71fdc7bea5bnd limits the scope of the enclosed directives by filename, just as the
130d299c4b2b15be45532a176604c71fdc7bea5bnd <directive module="core" type="section">Files</directive> directive
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd does. However, it accepts a <glossary ref="regex">regular
6c5c651b0b97607b8c8b4965c1385c67699f217fnd <FilesMatch "\.(gif|jpe?g|png)$">
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>would match most common Internet graphics formats.</p>
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd<seealso><a href="/sections.html">How <Directory>, <Location>
750d12c59545dbbac70390988de94f7e901b08f2niq and <Files> sections work</a> for an explanation of how these
4bb78e7cdd53f50240cff4ad7a97c7ed36483797slive different sections are combined when a request is received</seealso>
4bb78e7cdd53f50240cff4ad7a97c7ed36483797slive</directivesynopsis>
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd<directivesynopsis>
4bb78e7cdd53f50240cff4ad7a97c7ed36483797slive<description>Forces all matching files to be served with the specified
4bb78e7cdd53f50240cff4ad7a97c7ed36483797slivemedia type in the HTTP Content-Type header field</description>
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd<contextlist><context>directory</context><context>.htaccess</context>
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd</contextlist>
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd<compatibility>Moved to the core in Apache httpd 2.0</compatibility>
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd <p>When placed into an <code>.htaccess</code> file or a
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd <directive type="section" module="core">Directory</directive>, or
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd <directive type="section" module="core">Location</directive> or
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd <directive type="section" module="core">Files</directive>
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd section, this directive forces all matching files to be served
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd with the content type identification given by
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd <var>media-type</var>. For example, if you had a directory full of
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd GIF files, but did not want to label them all with <code>.gif</code>,
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd you might want to use:</p>
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd <p>Note that this directive overrides other indirect media type
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd associations defined in mime.types or via the
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd <directive module="mod_mime">AddType</directive>.</p>
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd <p>You can also override more general
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd <Location /images><br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </Location><br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive # but normal mime-type associations here:<br />
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd ForceType None<br />
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd </Location>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This directive primarily overrides the content types generated for
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive static files served out of the filesystem. For resources other than
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive static files, where the generator of the response typically specifies
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen a Content-Type, this directive has no effect.</p>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Directory to write gmon.out profiling data to. </description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>GprofDir <var>/tmp/gprof/</var>|<var>/tmp/gprof/</var>%</syntax>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen<contextlist><context>server config</context><context>virtual host</context>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen</contextlist>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <p>When the server has been compiled with gprof profiling suppport,
130d299c4b2b15be45532a176604c71fdc7bea5bnd <directive>GprofDir</directive> causes <code>gmon.out</code> files to
130d299c4b2b15be45532a176604c71fdc7bea5bnd be written to the specified directory when the process exits. If the
130d299c4b2b15be45532a176604c71fdc7bea5bnd argument ends with a percent symbol ('%'), subdirectories are created
7ef9b6763ad87846cf83c3f71467f43e349d080aerikabele for each process id.</p>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen <p>This directive currently only works with the <module>prefork</module>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
03e0a375c2435102fb2b51e34cccff52acbfddcdnd<directivesynopsis>
03e0a375c2435102fb2b51e34cccff52acbfddcdnd<description>Enables DNS lookups on client IP addresses</description>
03e0a375c2435102fb2b51e34cccff52acbfddcdnd<contextlist><context>server config</context><context>virtual host</context>
03e0a375c2435102fb2b51e34cccff52acbfddcdnd <p>This directive enables DNS lookups so that host names can be
03e0a375c2435102fb2b51e34cccff52acbfddcdnd logged (and passed to CGIs/SSIs in <code>REMOTE_HOST</code>).
03e0a375c2435102fb2b51e34cccff52acbfddcdnd The value <code>Double</code> refers to doing double-reverse
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen DNS lookup. That is, after a reverse lookup is performed, a forward
03e0a375c2435102fb2b51e34cccff52acbfddcdnd lookup is then performed on that result. At least one of the IP
03e0a375c2435102fb2b51e34cccff52acbfddcdnd addresses in the forward lookup must match the original
03e0a375c2435102fb2b51e34cccff52acbfddcdnd address. (In "tcpwrappers" terminology this is called
03e0a375c2435102fb2b51e34cccff52acbfddcdnd <p>Regardless of the setting, when <module>mod_authz_host</module> is
03e0a375c2435102fb2b51e34cccff52acbfddcdnd used for controlling access by hostname, a double reverse lookup
03e0a375c2435102fb2b51e34cccff52acbfddcdnd will be performed. This is necessary for security. Note that the
03e0a375c2435102fb2b51e34cccff52acbfddcdnd result of this double-reverse isn't generally available unless you
03e0a375c2435102fb2b51e34cccff52acbfddcdnd set <code>HostnameLookups Double</code>. For example, if only
03e0a375c2435102fb2b51e34cccff52acbfddcdnd <code>HostnameLookups On</code> and a request is made to an object
03e0a375c2435102fb2b51e34cccff52acbfddcdnd that is protected by hostname restrictions, regardless of whether
03e0a375c2435102fb2b51e34cccff52acbfddcdnd the double-reverse fails or not, CGIs will still be passed the
03e0a375c2435102fb2b51e34cccff52acbfddcdnd <p>The default is <code>Off</code> in order to save the network
03e0a375c2435102fb2b51e34cccff52acbfddcdnd traffic for those sites that don't truly need the reverse
03e0a375c2435102fb2b51e34cccff52acbfddcdnd lookups done. It is also better for the end users because they
03e0a375c2435102fb2b51e34cccff52acbfddcdnd don't have to suffer the extra latency that a lookup entails.
03e0a375c2435102fb2b51e34cccff52acbfddcdnd Heavily loaded sites should leave this directive
03e0a375c2435102fb2b51e34cccff52acbfddcdnd <code>Off</code>, since DNS lookups can take considerable
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive amounts of time. The utility <program>logresolve</program>, compiled by
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive default to the <code>bin</code> subdirectory of your installation
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directory, can be used to look up host names from logged IP addresses
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive offline.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive href="mod_authz_host.html#reqhost">hostname-based Require
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directives</a>, a hostname lookup will be performed regardless of
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
89ea3e2b9591820407538ac250ec49a0f4f056d2nd<description>Contains directives that apply only if a condition is
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivesatisfied by a request at runtime</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax><If <var>expression</var>> ... </If></syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<context>directory</context><context>.htaccess</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <directive type="section">If</directive> directive
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess evaluates an expression at runtime, and applies the enclosed
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess directives if and only if the expression evaluates to true.
fb77c505254b6e9c925e23e734463e87574f8f40kess For example:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <If "-z req('Host')">
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>would match HTTP/1.0 requests without a <var>Host:</var> header.
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen Expressions may contain various shell-like operators for string
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen comparison (<code>=</code>, <code>!=</code>, <code><</code>, ...),
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess integer comparison (<code>-eq</code>, <code>-ne</code>, ...),
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen and others (<code>-n</code>, <code>-z</code>, <code>-f</code>, ...).
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen It is also possible to use regular expressions, </p>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen <If "%{QUERY_STRING} =~ /(delete|commit)=.*?elem/">
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>shell-like pattern matches and many other operations. These operations
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive can be done on request headers (<code>req</code>), environment variables
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive (<code>env</code>), and a large number of other properties. The full
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive documentation is available in <a href="/expr.html">Expressions in
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><a href="/expr.html">Expressions in Apache HTTP Server</a>,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivefor a complete reference and more examples.</seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive type="section" module="core">ElseIf</directive></seealso>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<seealso><directive type="section" module="core">Else</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><a href="/sections.html">How <Directory>, <Location>,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <Files> sections work</a> for an explanation of how these
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive different sections are combined when a request is received.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive type="section">Else</directive> are applied last.</seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Encloses directives that will be processed only
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveif a test is true at startup</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax><IfDefine [!]<var>parameter-name</var>> ...
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </IfDefine></syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<context>directory</context><context>.htaccess</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <code><IfDefine <var>test</var>>...</IfDefine>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen </code> section is used to mark directives that are conditional. The
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen directives within an <directive type="section">IfDefine</directive>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen section are only processed if the <var>test</var> is true. If <var>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen test</var> is false, everything between the start and end markers is
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd ignored.</p>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen <p>The <var>test</var> in the <directive type="section"
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive >IfDefine</directive> section directive can be one of two forms:</p>
ae134ecc8faf4e6a8eb68e1c3724506771442a46rbowen <p>In the former case, the directives between the start and end
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive markers are only processed if the parameter named
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <var>parameter-name</var> is defined. The second format reverses
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the test, and only processes the directives if
72580dbc2a55511f13f377063725b9f143b20826stoddard <var>parameter-name</var> is <strong>not</strong> defined.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <var>parameter-name</var> argument is a define as given on the
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <program>httpd</program> command line via <code>-D<var>parameter</var>
72580dbc2a55511f13f377063725b9f143b20826stoddard </code> at the time the server was started or by the <directive
72580dbc2a55511f13f377063725b9f143b20826stoddard <p><directive type="section">IfDefine</directive> sections are
72580dbc2a55511f13f377063725b9f143b20826stoddard nest-able, which can be used to implement simple
72580dbc2a55511f13f377063725b9f143b20826stoddard multiple-parameter tests. Example:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive httpd -DReverseProxy -DUseCache -DMemCache ...<br />
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen <IfDefine ReverseProxy><br />
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen LoadModule proxy_http_module modules/mod_proxy_http.so<br />
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen <IfDefine UseCache><br />
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen <IfDefine MemCache><br />
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen LoadModule mem_cache_module modules/mod_mem_cache.so<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </IfDefine><br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <IfDefine !MemCache><br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive LoadModule cache_disk_module modules/mod_cache_disk.so<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </IfDefine>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </IfDefine>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </IfDefine>
72580dbc2a55511f13f377063725b9f143b20826stoddard</directivesynopsis>
72580dbc2a55511f13f377063725b9f143b20826stoddard<description>Encloses directives that are processed conditional on the
72580dbc2a55511f13f377063725b9f143b20826stoddardpresence or absence of a specific module</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax><IfModule [!]<var>module-file</var>|<var>module-identifier</var>> ...
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </IfModule></syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<context>directory</context><context>.htaccess</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<compatibility>Module identifiers are available in version 2.1 and
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivelater.</compatibility>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen <p>The <code><IfModule <var>test</var>>...</IfModule></code>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen section is used to mark directives that are conditional on the presence of
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen a specific module. The directives within an <directive type="section"
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen >IfModule</directive> section are only processed if the <var>test</var>
ef8e89e090461194ecadd31e8796a2c51e0531a2kess is true. If <var>test</var> is false, everything between the start and
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen end markers is ignored.</p>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen <p>The <var>test</var> in the <directive type="section"
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen >IfModule</directive> section directive can be one of two forms:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>In the former case, the directives between the start and end
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele markers are only processed if the module named <var>module</var>
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele is included in Apache httpd -- either compiled in or
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele dynamically loaded using <directive module="mod_so"
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive >LoadModule</directive>. The second format reverses the test,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive and only processes the directives if <var>module</var> is
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen <p>The <var>module</var> argument can be either the module identifier or
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen the file name of the module, at the time it was compiled. For example,
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen <code>mod_rewrite.c</code> is the file name. If a module consists of
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd several source files, use the name of the file containing the string
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p><directive type="section">IfModule</directive> sections are
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive nest-able, which can be used to implement simple multiple-module
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <note>This section should only be used if you need to have one
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive configuration file that works whether or not a specific module
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive is available. In normal operation, directives need not be
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive placed in <directive type="section">IfModule</directive>
fb77c505254b6e9c925e23e734463e87574f8f40kess sections.</note>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess<description>Includes other configuration files from within
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivethe server configuration files</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>Include [<var>optional</var>|<var>strict</var>] <var>file-path</var>|<var>directory-path</var>|<var>wildcard</var></syntax>
7852e17fb37b2a02ccdcab107f2c7f5fd41fd201nd<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<compatibility>Wildcard matching available in 2.0.41 and later, directory
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivewildcard matching available in 2.3.6 and later</compatibility>
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive <p>This directive allows inclusion of other configuration files
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive from within the server configuration files.</p>
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive <p>Shell-style (<code>fnmatch()</code>) wildcard characters can be used
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive in the filename or directory parts of the path to include several files
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive at once, in alphabetical order. In addition, if
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive <directive>Include</directive> points to a directory, rather than a file,
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive Apache httpd will read all files in that directory and any subdirectory.
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive However, including entire directories is not recommended, because it is
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive easy to accidentally leave temporary files in a directory that can cause
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive <program>httpd</program> to fail. Instead, we encourage you to use the
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive wildcard syntax shown below, to include files that match a particular
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive pattern, such as *.conf, for example.</p>
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive <p>When a wildcard is specified for a <strong>file</strong> component of
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive the path, and no file matches the wildcard, the
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive directive will be <strong>silently ignored</strong>. When a wildcard is
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive specified for a <strong>directory</strong> component of the path, and
dc223428958ad9ff05011545bcdda000887b93e5slive no directory matches the wildcard, the
beb923bec9bff2b49ce5027df2fe944e2b74e28brederpj <directive module="core">Include</directive> directive will
beb923bec9bff2b49ce5027df2fe944e2b74e28brederpj <strong>fail with an error</strong> saying the directory cannot be found.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>For further control over the behavior of the server when no files or
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directories match, prefix the path with the modifiers <var>optional</var>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess or <var>strict</var>. If <var>optional</var> is specified, any wildcard
fb77c505254b6e9c925e23e734463e87574f8f40kess file or directory that does not match will be silently ignored. If
d8c44cd75cf575fe51319280c12445109e878523noodl <var>strict</var> is specified, any wildcard file or directory that does
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive not match at least one file will cause server startup to fail.</p>
37742b630743e470b94618ecb3560fbd82e50b59rbowen <p>When a directory or file component of the path is
37742b630743e470b94618ecb3560fbd82e50b59rbowen specified exactly, and that directory or file does not exist,
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <directive module="core">Include</directive> directive will fail with an
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd error saying the file or directory cannot be found.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>The file path specified may be an absolute path, or may be relative
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive to the <directive module="core">ServerRoot</directive> directory.</p>
130d299c4b2b15be45532a176604c71fdc7bea5bnd </example>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <p>Wildcards may be included in the directory or file portion of the
130d299c4b2b15be45532a176604c71fdc7bea5bnd path. In the following example, the server will fail to load if no
130d299c4b2b15be45532a176604c71fdc7bea5bnd directories match conf/vhosts/*, but will load successfully if no
130d299c4b2b15be45532a176604c71fdc7bea5bnd files match *.conf.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>In this example, the server will fail to load if either
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd conf/vhosts/* matches no directories, or if *.conf matches no files:</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>In this example, the server load successfully if either conf/vhosts/*
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd matches no directories, or if *.conf matches no files:</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd</directivesynopsis>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<directivesynopsis>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<description>Enables HTTP persistent connections</description>
37742b630743e470b94618ecb3560fbd82e50b59rbowen<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The Keep-Alive extension to HTTP/1.0 and the persistent
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess connection feature of HTTP/1.1 provide long-lived HTTP sessions
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive which allow multiple requests to be sent over the same TCP
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive connection. In some cases this has been shown to result in an
8490b2f9f6469d5089163f6dd303d9a81f8e908ctrawick almost 50% speedup in latency times for HTML documents with
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive many images. To enable Keep-Alive connections, set
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>For HTTP/1.0 clients, Keep-Alive connections will only be
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive used if they are specifically requested by a client. In
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess addition, a Keep-Alive connection with an HTTP/1.0 client can
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess only be used when the length of the content is known in
030108b1816bcda3d925df65357feabdce83bc94slive advance. This implies that dynamic content such as CGI output,
030108b1816bcda3d925df65357feabdce83bc94slive SSI pages, and server-generated directory listings will
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive generally not use Keep-Alive connections to HTTP/1.0 clients.
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd For HTTP/1.1 clients, persistent connections are the default
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd unless otherwise specified. If the client requests it, chunked
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd encoding will be used in order to send content of unknown
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd length over persistent connections.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>When a client uses a Keep-Alive connection it will be counted
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive as a single "request" for the <directive module="mpm_common"
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive >MaxConnectionsPerChild</directive> directive, regardless
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess of how many requests are sent using the connection.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive module="core">MaxKeepAliveRequests</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
7fbd7281d06cec1918aa370214df77c572f871a9sf<description>Amount of time the server will wait for subsequent
7fbd7281d06cec1918aa370214df77c572f871a9sfrequests on a persistent connection</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
7fbd7281d06cec1918aa370214df77c572f871a9sf</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<compatibility>Specifying a value in milliseconds is available in
7fbd7281d06cec1918aa370214df77c572f871a9sfApache httpd 2.3.2 and later</compatibility>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The number of seconds Apache httpd will wait for a subsequent
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive request before closing the connection. By adding a postfix of ms the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive timeout can be also set in milliseconds. Once a request has been
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive received, the timeout value specified by the
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <directive module="core">Timeout</directive> directive applies.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Setting <directive>KeepAliveTimeout</directive> to a high value
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen may cause performance problems in heavily loaded servers. The
1597043cec6ad37fa4154bf09b0fccdabed1a239slive higher the timeout, the more server processes will be kept
1597043cec6ad37fa4154bf09b0fccdabed1a239slive occupied waiting on connections with idle clients.</p>
530eba85dbd41b8a0fa5255d3648d1440199a661slive <p>In a name-based virtual host context, the value of the first
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive defined virtual host best matching the local IP and port will be used.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Restrict enclosed access controls to only certain HTTP
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivemethods</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax><Limit <var>method</var> [<var>method</var>] ... > ...
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </Limit></syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>directory</context><context>.htaccess</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Access controls are normally effective for
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <strong>all</strong> access methods, and this is the usual
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive desired behavior. <strong>In the general case, access control
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directives should not be placed within a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive type="section">Limit</directive> section.</strong></p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The purpose of the <directive type="section">Limit</directive>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directive is to restrict the effect of the access controls to the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive nominated HTTP methods. For all other methods, the access
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive restrictions that are enclosed in the <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive type="section">Limit</directive> bracket <strong>will have no
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive effect</strong>. The following example applies the access control
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive only to the methods <code>POST</code>, <code>PUT</code>, and
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>DELETE</code>, leaving all other methods unprotected:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <Limit POST PUT DELETE><br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Require valid-user<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </Limit>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The method names listed can be one or more of: <code>GET</code>,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>POST</code>, <code>PUT</code>, <code>DELETE</code>,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>PATCH</code>, <code>PROPFIND</code>, <code>PROPPATCH</code>,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>MKCOL</code>, <code>COPY</code>, <code>MOVE</code>,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>LOCK</code>, and <code>UNLOCK</code>. <strong>The method name is
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive case-sensitive.</strong> If <code>GET</code> is used it will also
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive restrict <code>HEAD</code> requests. The <code>TRACE</code> method
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="core">LimitExcept</directive> section should always be
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive used in preference to a <directive type="section">Limit</directive>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive section when restricting access, since a <directive type="section"
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="core">LimitExcept</directive> section provides protection
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive against arbitrary methods.</note>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <directive type="section">Limit</directive> and
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive type="section" module="core">LimitExcept</directive>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directives may be nested. In this case, each successive level of
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive type="section">Limit</directive> or <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive type="section" module="core">LimitExcept</directive> directives must
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive further restrict the set of methods to which access controls apply.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive type="section">LimitExcept</directive> directives with
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the <directive module="mod_authz_core">Require</directive> directive,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive note that the first <directive module="mod_authz_core">Require</directive>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive to succeed authorizes the request, regardless of the presence of other
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive module="mod_authz_core">Require</directive> directives.</note>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>For example, given the following configuration, all users will
7fbd7281d06cec1918aa370214df77c572f871a9sf <code>Require group editors</code> directive will be ignored
7fbd7281d06cec1918aa370214df77c572f871a9sf in all cases:</p>
7fbd7281d06cec1918aa370214df77c572f871a9sf <LimitExcept GET>
7fbd7281d06cec1918aa370214df77c572f871a9sf Require valid-user
7fbd7281d06cec1918aa370214df77c572f871a9sf </LimitExcept><br />
7fbd7281d06cec1918aa370214df77c572f871a9sf <Limit POST>
7fbd7281d06cec1918aa370214df77c572f871a9sf Require group editors
7fbd7281d06cec1918aa370214df77c572f871a9sf </Limit>
7fbd7281d06cec1918aa370214df77c572f871a9sf </example>
7fbd7281d06cec1918aa370214df77c572f871a9sf</directivesynopsis>
7fbd7281d06cec1918aa370214df77c572f871a9sf<description>Restrict access controls to all HTTP methods
7fbd7281d06cec1918aa370214df77c572f871a9sfexcept the named ones</description>
7fbd7281d06cec1918aa370214df77c572f871a9sf<syntax><LimitExcept <var>method</var> [<var>method</var>] ... > ...
7fbd7281d06cec1918aa370214df77c572f871a9sf </LimitExcept></syntax>
7fbd7281d06cec1918aa370214df77c572f871a9sf<contextlist><context>directory</context><context>.htaccess</context>
7fbd7281d06cec1918aa370214df77c572f871a9sf</contextlist>
7fbd7281d06cec1918aa370214df77c572f871a9sf a group of access control directives which will then apply to any
7fbd7281d06cec1918aa370214df77c572f871a9sf HTTP access method <strong>not</strong> listed in the arguments;
7fbd7281d06cec1918aa370214df77c572f871a9sf module="core">Limit</directive> section and can be used to control
7fbd7281d06cec1918aa370214df77c572f871a9sf both standard and nonstandard/unrecognized methods. See the
7fbd7281d06cec1918aa370214df77c572f871a9sf <LimitExcept POST GET><br />
7fbd7281d06cec1918aa370214df77c572f871a9sf Require valid-user<br />
7fbd7281d06cec1918aa370214df77c572f871a9sf </LimitExcept>
7fbd7281d06cec1918aa370214df77c572f871a9sf </example>
7fbd7281d06cec1918aa370214df77c572f871a9sf</directivesynopsis>
7fbd7281d06cec1918aa370214df77c572f871a9sf<directivesynopsis>
7fbd7281d06cec1918aa370214df77c572f871a9sf<description>Determine maximum number of internal redirects and nested
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivesubrequests</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>LimitInternalRecursion <var>number</var> [<var>number</var>]</syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<compatibility>Available in Apache httpd 2.0.47 and later</compatibility>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>An internal redirect happens, for example, when using the <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="mod_actions">Action</directive> directive, which internally
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen redirects the original request to a CGI script. A subrequest is Apache httpd's
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen mechanism to find out what would happen for some URI if it were requested.
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen For example, <module>mod_dir</module> uses subrequests to look for the
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd files listed in the <directive module="mod_dir">DirectoryIndex</directive>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd directive.</p>
8b052d682204371decc64f942aede5ef1da98955erikabele <p><directive>LimitInternalRecursion</directive> prevents the server
8b052d682204371decc64f942aede5ef1da98955erikabele from crashing when entering an infinite loop of internal redirects or
8b052d682204371decc64f942aede5ef1da98955erikabele subrequests. Such loops are usually caused by misconfigurations.</p>
8b052d682204371decc64f942aede5ef1da98955erikabele <p>The directive stores two different limits, which are evaluated on
8b052d682204371decc64f942aede5ef1da98955erikabele per-request basis. The first <var>number</var> is the maximum number of
8b052d682204371decc64f942aede5ef1da98955erikabele internal redirects, that may follow each other. The second <var>number</var>
7fbd7281d06cec1918aa370214df77c572f871a9sf determines, how deep subrequests may be nested. If you specify only one
7fbd7281d06cec1918aa370214df77c572f871a9sf <var>number</var>, it will be assigned to both limits.</p>
7fbd7281d06cec1918aa370214df77c572f871a9sf LimitInternalRecursion 5
7fbd7281d06cec1918aa370214df77c572f871a9sf</directivesynopsis>
7fbd7281d06cec1918aa370214df77c572f871a9sf<directivesynopsis>
7fbd7281d06cec1918aa370214df77c572f871a9sf<description>Restricts the total size of the HTTP request body sent
7fbd7281d06cec1918aa370214df77c572f871a9sffrom the client</description>
7fbd7281d06cec1918aa370214df77c572f871a9sf<contextlist><context>server config</context><context>virtual host</context>
7fbd7281d06cec1918aa370214df77c572f871a9sf</contextlist>
7fbd7281d06cec1918aa370214df77c572f871a9sf <p>This directive specifies the number of <var>bytes</var> from 0
7fbd7281d06cec1918aa370214df77c572f871a9sf (meaning unlimited) to 2147483647 (2GB) that are allowed in a
7fbd7281d06cec1918aa370214df77c572f871a9sf request body. See the note below for the limited applicability
7fbd7281d06cec1918aa370214df77c572f871a9sf to proxy requests.</p>
7fbd7281d06cec1918aa370214df77c572f871a9sf <p>The <directive>LimitRequestBody</directive> directive allows
7fbd7281d06cec1918aa370214df77c572f871a9sf the user to set a limit on the allowed size of an HTTP request
7fbd7281d06cec1918aa370214df77c572f871a9sf message body within the context in which the directive is given
7fbd7281d06cec1918aa370214df77c572f871a9sf (server, per-directory, per-file or per-location). If the client
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive request exceeds that limit, the server will return an error
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive response instead of servicing the request. The size of a normal
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive request message body will vary greatly depending on the nature of
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the resource and the methods allowed on that resource. CGI scripts
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive typically use the message body for retrieving form information.
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess Implementations of the <code>PUT</code> method will require
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive a value at least as large as any representation that the server
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd wishes to accept for that resource.</p>
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele <p>This directive gives the server administrator greater
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele control over abnormal client request behavior, which may be
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive useful for avoiding some forms of denial-of-service
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive attacks.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>If, for example, you are permitting file upload to a particular
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive location, and wish to limit the size of the uploaded file to 100K,
fb77c505254b6e9c925e23e734463e87574f8f40kess you might use the following directive:</p>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen LimitRequestBody 102400
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <note><p>For a full description of how this directive is interpreted by
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd proxy requests, see the <module>mod_proxy</module> documentation.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick<directivesynopsis>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick<description>Limits the number of HTTP request header fields that
2b6c7b8eb5fbc43564898aedac730df7e91da475trawickwill be accepted from the client</description>
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick<syntax>LimitRequestFields <var>number</var></syntax>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen<contextlist><context>server config</context><context>virtual host</context></contextlist>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <p><var>Number</var> is an integer from 0 (meaning unlimited) to
a0fed3e26656887c8458aa1081d516d08ced3c84trawick 32767. The default value is defined by the compile-time
a0fed3e26656887c8458aa1081d516d08ced3c84trawick constant <code>DEFAULT_LIMIT_REQUEST_FIELDS</code> (100 as
a0fed3e26656887c8458aa1081d516d08ced3c84trawick distributed).</p>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <p>The <directive>LimitRequestFields</directive> directive allows
a0fed3e26656887c8458aa1081d516d08ced3c84trawick the server administrator to modify the limit on the number of
a0fed3e26656887c8458aa1081d516d08ced3c84trawick request header fields allowed in an HTTP request. A server needs
a0fed3e26656887c8458aa1081d516d08ced3c84trawick this value to be larger than the number of fields that a normal
a0fed3e26656887c8458aa1081d516d08ced3c84trawick client request might include. The number of request header fields
a0fed3e26656887c8458aa1081d516d08ced3c84trawick used by a client rarely exceeds 20, but this may vary among
a0fed3e26656887c8458aa1081d516d08ced3c84trawick different client implementations, often depending upon the extent
a0fed3e26656887c8458aa1081d516d08ced3c84trawick to which a user has configured their browser to support detailed
a0fed3e26656887c8458aa1081d516d08ced3c84trawick content negotiation. Optional HTTP extensions are often expressed
a0fed3e26656887c8458aa1081d516d08ced3c84trawick using request header fields.</p>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <p>This directive gives the server administrator greater
a0fed3e26656887c8458aa1081d516d08ced3c84trawick control over abnormal client request behavior, which may be
a0fed3e26656887c8458aa1081d516d08ced3c84trawick useful for avoiding some forms of denial-of-service attacks.
a0fed3e26656887c8458aa1081d516d08ced3c84trawick The value should be increased if normal clients see an error
a0fed3e26656887c8458aa1081d516d08ced3c84trawick response from the server that indicates too many fields were
a0fed3e26656887c8458aa1081d516d08ced3c84trawick sent in the request.</p>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick LimitRequestFields 50
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <p> When name-based virtual hosting is used, the value for this
a0fed3e26656887c8458aa1081d516d08ced3c84trawick directive is taken from the default (first-listed) virtual host for the
a0fed3e26656887c8458aa1081d516d08ced3c84trawick local IP and port combination</p>.
a0fed3e26656887c8458aa1081d516d08ced3c84trawick</directivesynopsis>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick<directivesynopsis>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick<description>Limits the size of the HTTP request header allowed from the
a0fed3e26656887c8458aa1081d516d08ced3c84trawickclient</description>
bf0e7f6393e91c0a7c15cb0d889a4238c973dc2etrawick<syntax>LimitRequestFieldSize <var>bytes</var></syntax>
bf0e7f6393e91c0a7c15cb0d889a4238c973dc2etrawick<contextlist><context>server config</context><context>virtual host</context></contextlist>
bf0e7f6393e91c0a7c15cb0d889a4238c973dc2etrawick <p>This directive specifies the number of <var>bytes</var>
bf0e7f6393e91c0a7c15cb0d889a4238c973dc2etrawick that will be allowed in an HTTP request header.</p>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <p>The <directive>LimitRequestFieldSize</directive> directive
a0fed3e26656887c8458aa1081d516d08ced3c84trawick allows the server administrator to reduce or increase the limit
a0fed3e26656887c8458aa1081d516d08ced3c84trawick on the allowed size of an HTTP request header field. A server
a0fed3e26656887c8458aa1081d516d08ced3c84trawick needs this value to be large enough to hold any one header field
a0fed3e26656887c8458aa1081d516d08ced3c84trawick from a normal client request. The size of a normal request header
a0fed3e26656887c8458aa1081d516d08ced3c84trawick field will vary greatly among different client implementations,
a0fed3e26656887c8458aa1081d516d08ced3c84trawick often depending upon the extent to which a user has configured
bf0e7f6393e91c0a7c15cb0d889a4238c973dc2etrawick their browser to support detailed content negotiation. SPNEGO
bf0e7f6393e91c0a7c15cb0d889a4238c973dc2etrawick authentication headers can be up to 12392 bytes.</p>
bf0e7f6393e91c0a7c15cb0d889a4238c973dc2etrawick <p>This directive gives the server administrator greater
bf0e7f6393e91c0a7c15cb0d889a4238c973dc2etrawick control over abnormal client request behavior, which may be
bf0e7f6393e91c0a7c15cb0d889a4238c973dc2etrawick useful for avoiding some forms of denial-of-service attacks.</p>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick LimitRequestFieldSize 4094
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <note>Under normal conditions, the value should not be changed from
a0fed3e26656887c8458aa1081d516d08ced3c84trawick the default.</note>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <p> When name-based virtual hosting is used, the value for this
a0fed3e26656887c8458aa1081d516d08ced3c84trawick directive is taken from the default (first-listed) virtual host best
a0fed3e26656887c8458aa1081d516d08ced3c84trawick matching the current IP address and port combination.</p>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick</directivesynopsis>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick<directivesynopsis>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick<description>Limit the size of the HTTP request line that will be accepted
a0fed3e26656887c8458aa1081d516d08ced3c84trawickfrom the client</description>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick<contextlist><context>server config</context><context>virtual host</context></contextlist>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <p>This directive sets the number of <var>bytes</var> that will be
a0fed3e26656887c8458aa1081d516d08ced3c84trawick allowed on the HTTP request-line.</p>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <p>The <directive>LimitRequestLine</directive> directive allows
a0fed3e26656887c8458aa1081d516d08ced3c84trawick the server administrator to reduce or increase the limit on the allowed size
a0fed3e26656887c8458aa1081d516d08ced3c84trawick of a client's HTTP request-line. Since the request-line consists of the
a0fed3e26656887c8458aa1081d516d08ced3c84trawick HTTP method, URI, and protocol version, the
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <directive>LimitRequestLine</directive> directive places a
a0fed3e26656887c8458aa1081d516d08ced3c84trawick restriction on the length of a request-URI allowed for a request
a0fed3e26656887c8458aa1081d516d08ced3c84trawick on the server. A server needs this value to be large enough to
a0fed3e26656887c8458aa1081d516d08ced3c84trawick hold any of its resource names, including any information that
a0fed3e26656887c8458aa1081d516d08ced3c84trawick might be passed in the query part of a <code>GET</code> request.</p>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <p>This directive gives the server administrator greater
a0fed3e26656887c8458aa1081d516d08ced3c84trawick control over abnormal client request behavior, which may be
a0fed3e26656887c8458aa1081d516d08ced3c84trawick useful for avoiding some forms of denial-of-service attacks.</p>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick LimitRequestLine 4094
215694531f7d868b906df96e22a80e6a1d2326a6lgentis <note>Under normal conditions, the value should not be changed from
a0fed3e26656887c8458aa1081d516d08ced3c84trawick the default.</note>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <p> When name-based virtual hosting is used, the value for this
a0fed3e26656887c8458aa1081d516d08ced3c84trawick directive is taken from the default (first-listed) virtual host best
a0fed3e26656887c8458aa1081d516d08ced3c84trawick matching the current IP address and port combination.</p>
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick</directivesynopsis>
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick<directivesynopsis>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick<description>Limits the size of an XML-based request body</description>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick<syntax>LimitXMLRequestBody <var>bytes</var></syntax>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick<contextlist><context>server config</context><context>virtual host</context>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick<context>directory</context><context>.htaccess</context></contextlist>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <p>Limit (in bytes) on maximum size of an XML-based request
a0fed3e26656887c8458aa1081d516d08ced3c84trawick body. A value of <code>0</code> will disable any checking.</p>
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick LimitXMLRequestBody 0
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick</directivesynopsis>
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick<description>Applies the enclosed directives only to matching
2b6c7b8eb5fbc43564898aedac730df7e91da475trawickURLs</description>
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick<syntax><Location
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick <var>URL-path</var>|<var>URL</var>> ... </Location></syntax>
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick<contextlist><context>server config</context><context>virtual host</context>
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick</contextlist>
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick <p>The <directive type="section">Location</directive> directive
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick limits the scope of the enclosed directives by URL. It is similar to the
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick <directive type="section" module="core">Directory</directive>
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick directive, and starts a subsection which is terminated with a
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick <code></Location></code> directive. <directive
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick type="section">Location</directive> sections are processed in the
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick order they appear in the configuration file, after the <directive
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick type="section" module="core">Directory</directive> sections and
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick <code>.htaccess</code> files are read, and after the <directive
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick type="section" module="core">Files</directive> sections.</p>
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick <p><directive type="section">Location</directive> sections operate
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick completely outside the filesystem. This has several consequences.
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick Most importantly, <directive type="section">Location</directive>
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick directives should not be used to control access to filesystem
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick locations. Since several different URLs may map to the same
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick filesystem location, such access controls may by circumvented.</p>
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick <p>The enclosed directives will be applied to the request if the path component
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick of the URL meets <em>any</em> of the following criteria:
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick <li>The specified location matches exactly the path component of the URL.
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick <li>The specified location, which ends in a forward slash, is a prefix
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick of the path component of the URL (treated as a context root).
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick <li>The specified location, with the addition of a trailing slash, is a
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick prefix of the path component of the URL (also treated as a context root).
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick In the example below, where no trailing slash is used, requests to
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick /private1, /private1/ and /private1/file.txt will have the enclosed
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick directives applied, but /private1other would not.
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick <Location /private1>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick In the example below, where a trailing slash is used, requests to
a0fed3e26656887c8458aa1081d516d08ced3c84trawick /private2/ and /private2/file.txt will have the enclosed
a0fed3e26656887c8458aa1081d516d08ced3c84trawick directives applied, but /private2 and /private2other would not.
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <p>Use <directive type="section">Location</directive> to apply
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directives to content that lives outside the filesystem. For
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive content that lives in the filesystem, use <directive
003f0c9fda6664daf5092a0e42f65ede20098153slive type="section" module="core">Directory</directive> and <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive type="section" module="core">Files</directive>. An exception is
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive apply a configuration to the entire server.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>For all origin (non-proxy) requests, the URL to be matched is a
4025ef5b9785f4cc9e6456a1c0177383a8503361covener URL-path of the form <code>/path/</code>. <em>No scheme, hostname,
4025ef5b9785f4cc9e6456a1c0177383a8503361covener port, or query string may be included.</em> For proxy requests, the
4025ef5b9785f4cc9e6456a1c0177383a8503361covener URL to be matched is of the form
5f4e50966b2b9b58436a1651cbe588d1b595657ewrowe <code>scheme://servername/path</code>, and you must include the
4025ef5b9785f4cc9e6456a1c0177383a8503361covener prefix.</p>
4025ef5b9785f4cc9e6456a1c0177383a8503361covener <p>The URL may use wildcards. In a wild-card string, <code>?</code> matches
4025ef5b9785f4cc9e6456a1c0177383a8503361covener any single character, and <code>*</code> matches any sequences of
4025ef5b9785f4cc9e6456a1c0177383a8503361covener characters. Neither wildcard character matches a / in the URL-path.</p>
4025ef5b9785f4cc9e6456a1c0177383a8503361covener <p><glossary ref="regex">Regular expressions</glossary>
4025ef5b9785f4cc9e6456a1c0177383a8503361covener can also be used, with the addition of the <code>~</code>
4025ef5b9785f4cc9e6456a1c0177383a8503361covener character. For example:</p>
4025ef5b9785f4cc9e6456a1c0177383a8503361covener <Location ~ "/(extra|special)/data">
4025ef5b9785f4cc9e6456a1c0177383a8503361covener <p>would match URLs that contained the substring <code>/extra/data</code>
4025ef5b9785f4cc9e6456a1c0177383a8503361covener or <code>/special/data</code>. The directive <directive
4025ef5b9785f4cc9e6456a1c0177383a8503361covener type="section" module="core">LocationMatch</directive> behaves
4025ef5b9785f4cc9e6456a1c0177383a8503361covener identical to the regex version of <directive
4025ef5b9785f4cc9e6456a1c0177383a8503361covener type="section">Location</directive>, and is preferred, for the
4025ef5b9785f4cc9e6456a1c0177383a8503361covener simple reason that <code>~</code> is hard to distinguish from
4025ef5b9785f4cc9e6456a1c0177383a8503361covener <p>The <directive type="section">Location</directive>
4025ef5b9785f4cc9e6456a1c0177383a8503361covener functionality is especially useful when combined with the
4025ef5b9785f4cc9e6456a1c0177383a8503361covener directive. For example, to enable status requests, but allow them
4025ef5b9785f4cc9e6456a1c0177383a8503361covener only from browsers at <code>example.com</code>, you might use:</p>
4025ef5b9785f4cc9e6456a1c0177383a8503361covener <Location /status><br />
4025ef5b9785f4cc9e6456a1c0177383a8503361covener SetHandler server-status<br />
4025ef5b9785f4cc9e6456a1c0177383a8503361covener </Location>
4025ef5b9785f4cc9e6456a1c0177383a8503361covener <p>The slash character has special meaning depending on where in a
4025ef5b9785f4cc9e6456a1c0177383a8503361covener URL it appears. People may be used to its behavior in the filesystem
4025ef5b9785f4cc9e6456a1c0177383a8503361covener where multiple adjacent slashes are frequently collapsed to a single
4025ef5b9785f4cc9e6456a1c0177383a8503361covener slash (<em>i.e.</em>, <code>/home///foo</code> is the same as
4025ef5b9785f4cc9e6456a1c0177383a8503361covener <code>/home/foo</code>). In URL-space this is not necessarily true.
4025ef5b9785f4cc9e6456a1c0177383a8503361covener The <directive type="section" module="core">LocationMatch</directive>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directive and the regex version of <directive type="section"
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd >Location</directive> require you to explicitly specify multiple
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive slashes if that is your intention.</p>
e6ab342447cf6b4c22bbe66169718d0e9b78819apoirier <p>For example, <code><LocationMatch ^/abc></code> would match
e6ab342447cf6b4c22bbe66169718d0e9b78819apoirier the request URL <code>/abc</code> but not the request URL <code>
e6ab342447cf6b4c22bbe66169718d0e9b78819apoirier //abc</code>. The (non-regex) <directive type="section"
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd >Location</directive> directive behaves similarly when used for
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd proxy requests. But when (non-regex) <directive type="section"
fb77c505254b6e9c925e23e734463e87574f8f40kess >Location</directive> is used for non-proxy requests it will
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd implicitly match multiple slashes with a single slash. For example,
cf02129aebf73dd0bdf369b172eb481ff76ac5f6colm if you specify <code><Location /abc/def></code> and the
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd request is to <code>/abc//def</code> then it will match.</p>
fb77c505254b6e9c925e23e734463e87574f8f40kess<seealso><a href="/sections.html">How <Directory>, <Location>
fb77c505254b6e9c925e23e734463e87574f8f40kess and <Files> sections work</a> for an explanation of how these
27303c8bb552a8a5fc859feb735d686fc59f59a1yoshiki different sections are combined when a request is received.</seealso>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<seealso><directive module="core">LocationMatch</directive></seealso>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd</directivesynopsis>
4025ef5b9785f4cc9e6456a1c0177383a8503361covener<description>Applies the enclosed directives only to regular-expression
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cndmatching URLs</description>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<syntax><LocationMatch
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<contextlist><context>server config</context><context>virtual host</context>
3386d67e54f92fdf6a3ffc5f7f8081eed6c44badslive</contextlist>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen <p>The <directive type="section">LocationMatch</directive> directive
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen limits the scope of the enclosed directives by URL, in an identical manner
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive to <directive module="core" type="section">Location</directive>. However,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive it takes a <glossary ref="regex">regular expression</glossary>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive as an argument instead of a simple string. For example:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <LocationMatch "/(extra|special)/data">
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>would match URLs that contained the substring <code>/extra/data</code>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><a href="/sections.html">How <Directory>, <Location>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive and <Files> sections work</a> for an explanation of how these
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive different sections are combined when a request is received</seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Controls the verbosity of the ErrorLog</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<compatibility>Per-module and per-directory configuration is available in
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess Apache HTTP Server 2.3.6 and later</compatibility>
13e5182a0c199ecc7a73db97b6448a544e940868slive <p><directive>LogLevel</directive> adjusts the verbosity of the
13e5182a0c199ecc7a73db97b6448a544e940868slive messages recorded in the error logs (see <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="core">ErrorLog</directive> directive). The following
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <var>level</var>s are available, in order of decreasing
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive significance:</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <columnspec><column width=".2"/><column width=".3"/><column width=".5"/>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </columnspec>
13e5182a0c199ecc7a73db97b6448a544e940868slive <td>"getpwuid: couldn't determine user name from uid"</td>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <td>"socket: Failed to get a socket, exiting child"</td>
13e5182a0c199ecc7a73db97b6448a544e940868slive <td>"child process 1234 did not exit, sending another
13e5182a0c199ecc7a73db97b6448a544e940868slive SIGHUP"</td>
1c5fe3e61f0f3202ae0f853740d53f3aff4c4afbslive <td>"httpd: caught SIGBUS, attempting to dump core in
13e5182a0c199ecc7a73db97b6448a544e940868slive <td>"Server seems busy, (you may need to increase
130d299c4b2b15be45532a176604c71fdc7bea5bnd <td>"proxy: CONNECT: sending the CONNECT request to the remote proxy"</td>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <td>"read from buffered SSL brigade, mode 0, 17 bytes"</td>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <td>"| 0000: 02 23 44 30 13 40 ac 34 df 3d bf 9a 19 49 39 15 |"</td>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <td>Trace messages, dumping large amounts of data</td>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <td>"| 0000: 02 23 44 30 13 40 ac 34 df 3d bf 9a 19 49 39 15 |"</td>
530eba85dbd41b8a0fa5255d3648d1440199a661slive <p>When a particular level is specified, messages from all
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele other levels of higher significance will be reported as well.
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele <em>E.g.</em>, when <code>LogLevel info</code> is specified,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive then messages with log levels of <code>notice</code> and
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive recommended.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive LogLevel notice
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>When logging to a regular file messages of the level
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen <code>notice</code> cannot be suppressed and thus are always
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive logged. However, this doesn't apply when logging is done
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Specifying a level without a module name will reset the level
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive for all modules to that level. Specifying a level with a module
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive name will set the level for that module only. It is possible to
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive use the module source file name, the module identifier, or the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module identifier with the trailing <code>_module</code> omitted
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive as module specification. This means the following three specifications
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive are equivalent:</p>
ef8e89e090461194ecadd31e8796a2c51e0531a2kess LogLevel info ssl:warn<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive LogLevel info ssl_module:warn<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>It is also possible to change the level per directory:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive LogLevel info<br />
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd LogLevel debug<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </Files>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Per directory loglevel configuration only affects messages that are
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen logged after the request has been parsed and that are associated with
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen the request. Log messages which are associated with the connection or
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the server are not affected.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Number of requests allowed on a persistent
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveconnection</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>MaxKeepAliveRequests <var>number</var></syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>The <directive>MaxKeepAliveRequests</directive> directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive limits the number of requests allowed per connection when
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive module="core" >KeepAlive</directive> is on. If it is
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele set to <code>0</code>, unlimited requests will be allowed. We
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele recommend that this setting be kept to a high value for maximum
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive server performance.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive MaxKeepAliveRequests 500
ef8e89e090461194ecadd31e8796a2c51e0531a2kess</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen<description>Number of ranges allowed before returning the complete
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveresource </description>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen<syntax>MaxRanges default | unlimited | none | <var>number-of-ranges</var></syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<compatibility>Available in Apache HTTP Server 2.3.15 and later</compatibility>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess limits the number of HTTP ranges the server is willing to
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess return to the client. If more ranges then permitted are requested,
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess the complete resource is returned instead.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <dd>Limits the number of ranges to a compile-time default of 200.</dd>
003f0c9fda6664daf5092a0e42f65ede20098153slive <dd>The server does not limit the number of ranges it is
fb77c505254b6e9c925e23e734463e87574f8f40kess willing to satisfy.</dd>
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele <dd>A positive number representing the maximum number of ranges the
003f0c9fda6664daf5092a0e42f65ede20098153slive server is willing to satisfy.</dd>
ef8e89e090461194ecadd31e8796a2c51e0531a2kess</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
4cafc94e99922f00654e1779d30c2cccf5278c4fkess <description>Number of overlapping ranges (eg: <code>100-200,150-300</code>) allowed before returning the complete
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen resource </description>
4cafc94e99922f00654e1779d30c2cccf5278c4fkess <syntax>MaxRangeOverlaps default | unlimited | none | <var>number-of-ranges</var></syntax>
4cafc94e99922f00654e1779d30c2cccf5278c4fkess <contextlist><context>server config</context><context>virtual host</context>
4cafc94e99922f00654e1779d30c2cccf5278c4fkess </contextlist>
4cafc94e99922f00654e1779d30c2cccf5278c4fkess <compatibility>Available in Apache HTTP Server 2.3.15 and later</compatibility>
4cafc94e99922f00654e1779d30c2cccf5278c4fkess <p>The <directive>MaxRangeOverlaps</directive> directive
4cafc94e99922f00654e1779d30c2cccf5278c4fkess limits the number of overlapping HTTP ranges the server is willing to
4cafc94e99922f00654e1779d30c2cccf5278c4fkess return to the client. If more overlapping ranges then permitted are requested,
4cafc94e99922f00654e1779d30c2cccf5278c4fkess the complete resource is returned instead.</p>
4cafc94e99922f00654e1779d30c2cccf5278c4fkess <dd>Limits the number of overlapping ranges to a compile-time default of 20.</dd>
4cafc94e99922f00654e1779d30c2cccf5278c4fkess <dd>The server does not limit the number of overlapping ranges it is
27303c8bb552a8a5fc859feb735d686fc59f59a1yoshiki willing to satisfy.</dd>
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive <dd>A positive number representing the maximum number of overlapping ranges the
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen server is willing to satisfy.</dd>
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive</directivesynopsis>
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive<directivesynopsis>
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive <description>Number of range reversals (eg: <code>100-200,50-70</code>) allowed before returning the complete
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive resource </description>
4cafc94e99922f00654e1779d30c2cccf5278c4fkess <syntax>MaxRangeReversals default | unlimited | none | <var>number-of-ranges</var></syntax>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen <contextlist><context>server config</context><context>virtual host</context>
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive </contextlist>
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive <compatibility>Available in Apache HTTP Server 2.3.15 and later</compatibility>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <directive>MaxRangeReversals</directive> directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive limits the number of HTTP Range reversals the server is willing to
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive return to the client. If more ranges reversals then permitted are requested,
a8ee031b2224ce5473826c9d4f603681589245fawrowe the complete resource is returned instead.</p>
a8ee031b2224ce5473826c9d4f603681589245fawrowe <dd>Limits the number of range reversals to a compile-time default of 20.</dd>
a8ee031b2224ce5473826c9d4f603681589245fawrowe <dd>The server does not limit the number of range reversals it is
a8ee031b2224ce5473826c9d4f603681589245fawrowe willing to satisfy.</dd>
a8ee031b2224ce5473826c9d4f603681589245fawrowe <dd>A positive number representing the maximum number of range reversals the
a8ee031b2224ce5473826c9d4f603681589245fawrowe server is willing to satisfy.</dd>
a8ee031b2224ce5473826c9d4f603681589245fawrowe</directivesynopsis>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen<directivesynopsis>
a8ee031b2224ce5473826c9d4f603681589245fawrowe<description>Configures mutex mechanism and lock file directory for all
a8ee031b2224ce5473826c9d4f603681589245fawroweor specified mutexes</description>
a8ee031b2224ce5473826c9d4f603681589245fawrowe<syntax>Mutex <var>mechanism</var> [default|<var>mutex-name</var>] ... [OmitPID]</syntax>
a8ee031b2224ce5473826c9d4f603681589245fawrowe<contextlist><context>server config</context></contextlist>
a8ee031b2224ce5473826c9d4f603681589245fawrowe<compatibility>Available in Apache HTTP Server 2.3.4 and later</compatibility>
a8ee031b2224ce5473826c9d4f603681589245fawrowe <p>The <directive>Mutex</directive> directive sets the mechanism,
a8ee031b2224ce5473826c9d4f603681589245fawrowe and optionally the lock file location, that httpd and modules use
a8ee031b2224ce5473826c9d4f603681589245fawrowe to serialize access to resources. Specify <code>default</code> as
a8ee031b2224ce5473826c9d4f603681589245fawrowe the first argument to change the settings for all mutexes; specify
a8ee031b2224ce5473826c9d4f603681589245fawrowe a mutex name (see table below) as the first argument to override
a8ee031b2224ce5473826c9d4f603681589245fawrowe defaults only for that mutex.</p>
a8ee031b2224ce5473826c9d4f603681589245fawrowe <p>The <directive>Mutex</directive> directive is typically used in
a8ee031b2224ce5473826c9d4f603681589245fawrowe the following exceptional situations:</p>
003f0c9fda6664daf5092a0e42f65ede20098153slive <li>change the mutex mechanism when the default mechanism selected
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive by <glossary>APR</glossary> has a functional or performance
2e5e2673cb64d3e4d445d911c6f61ac171020725nd problem</li>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <li>change the directory used by file-based mutexes when the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive default directory does not support locking</li>
733738e83a9b0113476e3f67992c2278d61ee4dakess <p>This directive only configures mutexes which have been registered
733738e83a9b0113476e3f67992c2278d61ee4dakess with the core server using the <code>ap_mutex_register()</code> API.
2e5e2673cb64d3e4d445d911c6f61ac171020725nd All modules bundled with httpd support the <directive>Mutex</directive>
2e5e2673cb64d3e4d445d911c6f61ac171020725nd directive, but third-party modules may not. Consult the documentation
2e5e2673cb64d3e4d445d911c6f61ac171020725nd of the third-party module, which must indicate the mutex name(s) which
2e5e2673cb64d3e4d445d911c6f61ac171020725nd can be configured if this directive is supported.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The following mutex <em>mechanisms</em> are available:</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>This selects the default locking implementation, as determined by
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <glossary>APR</glossary>. The default locking implementation can
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd be displayed by running <program>httpd</program> with the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This effectively disables the mutex, and is only allowed for a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive mutex if the module indicates that it is a valid choice. Consult the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This is a mutex variant based on a Posix semaphore.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The semaphore ownership is not recovered if a thread in the process
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive holding the mutex segfaults, resulting in a hang of the web server.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This is a mutex variant based on a SystemV IPC semaphore.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>It is possible to "leak" SysV semaphores if processes crash
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd before the semaphore is removed.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>The semaphore API allows for a denial of service attack by any
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd CGIs running under the same uid as the webserver (<em>i.e.</em>,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive all CGIs, unless you use something like <program>suexec</program>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This selects the "best" available semaphore implementation, choosing
003f0c9fda6664daf5092a0e42f65ede20098153slive between Posix and SystemV IPC semaphores, in that order.</p></li>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This is a mutex variant based on cross-process Posix thread
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive mutexes.</p>
e08ad1a326852610a7930269638a43657fc50d06sctemme <p>On most systems, if a child process terminates abnormally while
e08ad1a326852610a7930269638a43657fc50d06sctemme holding a mutex that uses this implementation, the server will deadlock
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive and stop responding to requests. When this occurs, the server will
fb77c505254b6e9c925e23e734463e87574f8f40kess require a manual restart to recover.</p>
9b5e2c5e769dc678a1aca06df75c32022b2f1492trawick <p>Solaris is a notable exception as it provides a mechanism which
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive usually allows the mutex to be recovered after a child process
9b5e2c5e769dc678a1aca06df75c32022b2f1492trawick terminates abnormally while holding a mutex.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>If your system implements the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>pthread_mutexattr_setrobust_np()</code> function, you may be able
e6ab342447cf6b4c22bbe66169718d0e9b78819apoirier <p>This is a mutex variant where a physical (lock-)file and the
e6ab342447cf6b4c22bbe66169718d0e9b78819apoirier <code>fcntl()</code> function are used as the mutex.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>When multiple mutexes based on this mechanism are used within
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive multi-threaded, multi-process environments, deadlock errors (EDEADLK)
fb77c505254b6e9c925e23e734463e87574f8f40kess can be reported for valid mutex operations if <code>fcntl()</code>
e08ad1a326852610a7930269638a43657fc50d06sctemme is not thread-aware, such as on Solaris.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This is similar to the <code>fcntl:/path/to/mutex</code> method
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive with the exception that the <code>flock()</code> function is used to
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This selects the "best" available file locking implementation,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive choosing between <code>fcntl</code> and <code>flock</code>, in that
e08ad1a326852610a7930269638a43657fc50d06sctemme <p>Most mechanisms are only available on selected platforms, where the
e08ad1a326852610a7930269638a43657fc50d06sctemme underlying platform and <glossary>APR</glossary> support it. Mechanisms
e08ad1a326852610a7930269638a43657fc50d06sctemme which aren't available on all platforms are <em>posixsem</em>,
e08ad1a326852610a7930269638a43657fc50d06sctemme <em>sysvsem</em>, <em>sem</em>, <em>pthread</em>, <em>fcntl</em>,
e08ad1a326852610a7930269638a43657fc50d06sctemme <p>With the file-based mechanisms <em>fcntl</em> and <em>flock</em>,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the path, if provided, is a directory where the lock file will be created.
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim The default directory is httpd's run-time file directory relative to
29edaaeea24c41820e486944635348cd7fae1d11rbowen <directive module="core">ServerRoot</directive>. Always use a local disk
e08ad1a326852610a7930269638a43657fc50d06sctemme filesystem for <code>/path/to/mutex</code> and never a directory residing
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive on a NFS- or AFS-filesystem. The basename of the file will be the mutex
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive type, an optional instance string provided by the module, and unless the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>OmitPID</code> keyword is specified, the process id of the httpd
e08ad1a326852610a7930269638a43657fc50d06sctemme parent process will be appended to to make the file name unique, avoiding
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive conflicts when multiple httpd instances share a lock file directory. For
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive example, if the mutex name is <code>mpm-accept</code> and the lock file
ef8e89e090461194ecadd31e8796a2c51e0531a2kess directory is <code>/var/httpd/locks</code>, the lock file name for the
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen httpd instance with parent process id 12345 would be
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim <p>It is best to <em>avoid</em> putting mutex files in a world-writable
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directory such as <code>/var/tmp</code> because someone could create
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive a denial of service attack and prevent the server from starting by
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive creating a lockfile with the same name as the one the server will try
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive to create.</p>
fb77c505254b6e9c925e23e734463e87574f8f40kess <p>The following table documents the names of mutexes used by httpd
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive and bundled modules.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <td><module>prefork</module> and <module>worker</module> MPMs</td>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <td>incoming connections, to avoid the thundering herd problem;
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive for more information, refer to the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <a href="/misc/perf-tuning.html">performance tuning</a>
003f0c9fda6664daf5092a0e42f65ede20098153slive documentation</td>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <td>communication with external mapping programs, to avoid
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive intermixed I/O from multiple requests</td>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <td>callback function of a particular client module</td>
fb77c505254b6e9c925e23e734463e87574f8f40kess <p>The <code>OmitPID</code> keyword suppresses the addition of the httpd
fb77c505254b6e9c925e23e734463e87574f8f40kess parent process id from the lock file name.</p>
ef8e89e090461194ecadd31e8796a2c51e0531a2kess <p>In the following example, the mutex mechanism for the MPM accept
ef8e89e090461194ecadd31e8796a2c51e0531a2kess mutex will be changed from the compiled-in default to <code>fcntl</code>,
ef8e89e090461194ecadd31e8796a2c51e0531a2kess with the associated lock file created in directory
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <code>/var/httpd/locks</code>. The mutex mechanism for all other mutexes
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive will be changed from the compiled-in default to <code>sysvsem</code>.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Mutex default sysvsem<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
23b36269d124e7a6aaa5221891f7ae2ef3eeb158jerenkrantz<directivesynopsis>
7b5535ed88e0f561b3bfb3330137bd804846afd4slive<description>DEPRECATED: Designates an IP address for name-virtual
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivehosting</description>
f35c904c3b359610a46e94fbb4ba8495b2338521slive<syntax>NameVirtualHost <var>addr</var>[:<var>port</var>]</syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context></contextlist>
ef8e89e090461194ecadd31e8796a2c51e0531a2kess<p>Prior to 2.3.11, <directive>NameVirtualHost</directive> was required
ef8e89e090461194ecadd31e8796a2c51e0531a2kessto instruct the server that a particular IP address and port combination
dc111bcea580da3da174c25be0fd7a8f22c86fe1jimwas usable as a name-based virtual host. In 2.3.11 and later,
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveany time an IP address and port combination is used in multiple virtual
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivehosts, name-based virtual hosting is automatically enabled for that address.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
2eb5346b17b3b69767cfe87d0f632efd6d15500djim<directivesynopsis>
a21fb2799923b1c25a351f09e690bd46806f2fa2jim<description>Configures what features are available in a particular
2eb5346b17b3b69767cfe87d0f632efd6d15500djimdirectory</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>Options
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive [+|-]<var>option</var> [[+|-]<var>option</var>] ...</syntax>
530eba85dbd41b8a0fa5255d3648d1440199a661slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<context>directory</context><context>.htaccess</context>
cf1595220a90759be0a39ab8b11c8cb834b698a9ianh</contextlist>
cf1595220a90759be0a39ab8b11c8cb834b698a9ianh<compatibility>The default was changed from All to FollowSymlinks in 2.3.11</compatibility>
cf1595220a90759be0a39ab8b11c8cb834b698a9ianh <p>The <directive>Options</directive> directive controls which
1a1cf0ee9229ee29e5750b25dd94dbb9b04072cfianh server features are available in a particular directory.</p>
9e59849752ebadf803f76453fe3b64e2cee8d190rbowen <p><var>option</var> can be set to <code>None</code>, in which
1a1cf0ee9229ee29e5750b25dd94dbb9b04072cfianh case none of the extra features are enabled, or one or more of
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the following:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <dd>All options except for <code>MultiViews</code>.</dd>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Execution of CGI scripts using <module>mod_cgi</module>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive is permitted.</dd>
7b5535ed88e0f561b3bfb3330137bd804846afd4slive The server will follow symbolic links in this directory. This is
7b5535ed88e0f561b3bfb3330137bd804846afd4slive the default setting.
a21fb2799923b1c25a351f09e690bd46806f2fa2jim <p>Even though the server follows the symlink it does <em>not</em>
a21fb2799923b1c25a351f09e690bd46806f2fa2jim change the pathname used to match against <directive type="section"
a21fb2799923b1c25a351f09e690bd46806f2fa2jim <p>Note also, that this option <strong>gets ignored</strong> if set
a21fb2799923b1c25a351f09e690bd46806f2fa2jim inside a <directive type="section" module="core">Location</directive>
a21fb2799923b1c25a351f09e690bd46806f2fa2jim section.</p>
a21fb2799923b1c25a351f09e690bd46806f2fa2jim <p>Omitting this option should not be considered a security restriction,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive since symlink testing is subject to race conditions that make it
f35c904c3b359610a46e94fbb4ba8495b2338521slive circumventable.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Server-side includes provided by <module>mod_include</module>
fb77c505254b6e9c925e23e734463e87574f8f40kess are permitted.</dd>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Server-side includes are permitted, but the <code>#exec
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive cmd</code> and <code>#exec cgi</code> are disabled. It is still
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive possible to <code>#include virtual</code> CGI scripts from
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <directive module="mod_alias">ScriptAlias</directive>ed
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directories.</dd>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive If a URL which maps to a directory is requested, and there
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive is no <directive module="mod_dir">DirectoryIndex</directive>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd (<em>e.g.</em>, <code>index.html</code>) in that directory, then
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <module>mod_autoindex</module> will return a formatted listing
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd of the directory.</dd>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <a href="/content-negotiation.html">Content negotiated</a>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess "MultiViews" are allowed using
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <note><title>Note</title> <p>This option gets ignored if set
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd anywhere other than <directive module="core" type="section"
130d299c4b2b15be45532a176604c71fdc7bea5bnd >Directory</directive>, as <module>mod_negotiation</module>
130d299c4b2b15be45532a176604c71fdc7bea5bnd needs real resources to compare against and evaluate from.</p></note>
c97e8972ab1f4dd167e3dc4db87daf91114009fbnd <dd>The server will only follow symbolic links for which the
c97e8972ab1f4dd167e3dc4db87daf91114009fbnd target file or directory is owned by the same user id as the
9f1dd1339447bf4b291682cd94bf9f28bc2685e0niq <note><title>Note</title> <p>This option gets ignored if
db1b819ff8966e3c6a5ca03c59a8ae06c2cecc9frbowen <p>This option should not be considered a security restriction,
db1b819ff8966e3c6a5ca03c59a8ae06c2cecc9frbowen since symlink testing is subject to race conditions that make it
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Normally, if multiple <directive>Options</directive> could
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive apply to a directory, then the most specific one is used and
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd others are ignored; the options are not merged. (See <a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive href="/sections.html#mergin">how sections are merged</a>.)
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive>Options</directive> directive are preceded by a
003f0c9fda6664daf5092a0e42f65ede20098153slive <code>+</code> or <code>-</code> symbol, the options are
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive merged. Any options preceded by a <code>+</code> are added to the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive options currently in force, and any options preceded by a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>-</code> are removed from the options currently in
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive force. </p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Mixing <directive>Options</directive> with a <code>+</code> or
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>-</code> with those without is not valid syntax, and will be
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive rejected during server startup by the syntax check with an abort.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>For example, without any <code>+</code> and <code>-</code> symbols:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Options Indexes FollowSymLinks<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </Directory><br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Options Includes<br />
003f0c9fda6664daf5092a0e42f65ede20098153slive </Directory>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>then only <code>Includes</code> will be set for the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>/web/docs/spec</code> directory. However if the second
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive>Options</directive> directive uses the <code>+</code> and
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Options Indexes FollowSymLinks<br />
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </Directory><br />
130d299c4b2b15be45532a176604c71fdc7bea5bnd Options +Includes -Indexes<br />
130d299c4b2b15be45532a176604c71fdc7bea5bnd </Directory>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>Includes</code> are set for the <code>/web/docs/spec</code>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directory.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>-Includes</code> disables server-side includes completely
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive regardless of the previous setting.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The default in the absence of any other settings is
fa71303e53e7ef460728446b8290d05ed0895136trawick</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen<description>Protocol for a listening socket</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context></contextlist>
b91096bcdd71fcbb37c9905f6cf79e930ae349b1jorton<compatibility>Available in Apache 2.1.5 and later.
b91096bcdd71fcbb37c9905f6cf79e930ae349b1jortonOn Windows from Apache 2.3.3 and later.</compatibility>
b91096bcdd71fcbb37c9905f6cf79e930ae349b1jorton <p>This directive specifies the protocol used for a specific listening socket.
b91096bcdd71fcbb37c9905f6cf79e930ae349b1jorton The protocol is used to determine which module should handle a request, and
b91096bcdd71fcbb37c9905f6cf79e930ae349b1jorton to apply protocol specific optimizations with the <directive>AcceptFilter</directive>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directive.</p>
b91096bcdd71fcbb37c9905f6cf79e930ae349b1jorton <p>You only need to set the protocol if you are running on non-standard ports, otherwise <code>http</code> is assumed for port 80 and <code>https</code> for port 443.</p>
b91096bcdd71fcbb37c9905f6cf79e930ae349b1jorton <p>For example, if you are running <code>https</code> on a non-standard port, specify the protocol explicitly:</p>
b91096bcdd71fcbb37c9905f6cf79e930ae349b1jorton Protocol https
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>You can also specify the protocol using the <directive module="mpm_common">Listen</directive> directive.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive module="mpm_common">Listen</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
12099dff89f3135d53929f4f1bdb42c7d044d928nd<directivesynopsis>
b00fe3c3354db01001b8eddfd9b88441380f837dwrowe<description>Limits the CPU consumption of processes launched
b00fe3c3354db01001b8eddfd9b88441380f837dwroweby Apache httpd children</description>
12099dff89f3135d53929f4f1bdb42c7d044d928nd<syntax>RLimitCPU <var>seconds</var>|max [<var>seconds</var>|max]</syntax>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen<default>Unset; uses operating system defaults</default>
b00fe3c3354db01001b8eddfd9b88441380f837dwrowe<contextlist><context>server config</context><context>virtual host</context>
b00fe3c3354db01001b8eddfd9b88441380f837dwrowe<context>directory</context><context>.htaccess</context></contextlist>
12099dff89f3135d53929f4f1bdb42c7d044d928nd <p>Takes 1 or 2 parameters. The first parameter sets the soft
12099dff89f3135d53929f4f1bdb42c7d044d928nd resource limit for all processes and the second parameter sets
12099dff89f3135d53929f4f1bdb42c7d044d928nd the maximum resource limit. Either parameter can be a number,
12099dff89f3135d53929f4f1bdb42c7d044d928nd or <code>max</code> to indicate to the server that the limit should
b00fe3c3354db01001b8eddfd9b88441380f837dwrowe be set to the maximum allowed by the operating system
b00fe3c3354db01001b8eddfd9b88441380f837dwrowe configuration. Raising the maximum resource limit requires that
b00fe3c3354db01001b8eddfd9b88441380f837dwrowe the server is running as <code>root</code>, or in the initial startup
12099dff89f3135d53929f4f1bdb42c7d044d928nd <p>This applies to processes forked off from Apache httpd children
12099dff89f3135d53929f4f1bdb42c7d044d928nd servicing requests, not the Apache httpd children themselves. This
12099dff89f3135d53929f4f1bdb42c7d044d928nd includes CGI scripts and SSI exec commands, but not any
b00fe3c3354db01001b8eddfd9b88441380f837dwrowe processes forked off from the Apache httpd parent such as piped
20b0f809c3823eda58808be053ffc305dfa9c785sf <p>CPU resource limits are expressed in seconds per
20b0f809c3823eda58808be053ffc305dfa9c785sf process.</p>
20b0f809c3823eda58808be053ffc305dfa9c785sf<seealso><directive module="core">RLimitMEM</directive></seealso>
20b0f809c3823eda58808be053ffc305dfa9c785sf<seealso><directive module="core">RLimitNPROC</directive></seealso>
20b0f809c3823eda58808be053ffc305dfa9c785sf</directivesynopsis>
20b0f809c3823eda58808be053ffc305dfa9c785sf<directivesynopsis>
20b0f809c3823eda58808be053ffc305dfa9c785sf<description>Limits the memory consumption of processes launched
20b0f809c3823eda58808be053ffc305dfa9c785sfby Apache httpd children</description>
20b0f809c3823eda58808be053ffc305dfa9c785sf<syntax>RLimitMEM <var>bytes</var>|max [<var>bytes</var>|max]</syntax>
20b0f809c3823eda58808be053ffc305dfa9c785sf<contextlist><context>server config</context><context>virtual host</context>
b00fe3c3354db01001b8eddfd9b88441380f837dwrowe<context>directory</context><context>.htaccess</context></contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Takes 1 or 2 parameters. The first parameter sets the soft
fb77c505254b6e9c925e23e734463e87574f8f40kess resource limit for all processes and the second parameter sets
fb294b146e7ceb48e3983ee3684ba6c6506241c0jim the maximum resource limit. Either parameter can be a number,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive or <code>max</code> to indicate to the server that the limit should
003f0c9fda6664daf5092a0e42f65ede20098153slive be set to the maximum allowed by the operating system
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive configuration. Raising the maximum resource limit requires that
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the server is running as <code>root</code>, or in the initial startup
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen <p>This applies to processes forked off from Apache httpd children
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd servicing requests, not the Apache httpd children themselves. This
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd includes CGI scripts and SSI exec commands, but not any
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd processes forked off from the Apache httpd parent such as piped
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen <p>Memory resource limits are expressed in bytes per
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive process.</p>
3c6c63407f1855ddfc45ac69b69a2a9bf15135e6rbowen<seealso><directive module="core">RLimitCPU</directive></seealso>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<seealso><directive module="core">RLimitNPROC</directive></seealso>
1fd5131d5732e639b0b4225ca0afea717c41bc11trawick</directivesynopsis>
3c6c63407f1855ddfc45ac69b69a2a9bf15135e6rbowen<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Limits the number of processes that can be launched by
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveprocesses launched by Apache httpd children</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>RLimitNPROC <var>number</var>|max [<var>number</var>|max]</syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<default>Unset; uses operating system defaults</default>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<context>directory</context><context>.htaccess</context></contextlist>
3c6c63407f1855ddfc45ac69b69a2a9bf15135e6rbowen <p>Takes 1 or 2 parameters. The first parameter sets the soft
3c6c63407f1855ddfc45ac69b69a2a9bf15135e6rbowen resource limit for all processes and the second parameter sets
3c6c63407f1855ddfc45ac69b69a2a9bf15135e6rbowen the maximum resource limit. Either parameter can be a number,
3c6c63407f1855ddfc45ac69b69a2a9bf15135e6rbowen or <code>max</code> to indicate to the server that the limit
fb77c505254b6e9c925e23e734463e87574f8f40kess should be set to the maximum allowed by the operating system
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen configuration. Raising the maximum resource limit requires that
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the server is running as <code>root</code>, or in the initial startup
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This applies to processes forked off from Apache httpd children
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen servicing requests, not the Apache httpd children themselves. This
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive includes CGI scripts and SSI exec commands, but not any
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive processes forked off from the Apache httpd parent such as piped
130d299c4b2b15be45532a176604c71fdc7bea5bnd <p>Process limits control the number of processes per user.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive under user ids other than the web server user id, this directive
130d299c4b2b15be45532a176604c71fdc7bea5bnd will limit the number of processes that the server itself can
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive create. Evidence of this situation will be indicated by
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim <strong><code>cannot fork</code></strong> messages in the
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim<seealso><directive module="core">RLimitMEM</directive></seealso>
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim<seealso><directive module="core">RLimitCPU</directive></seealso>
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim</directivesynopsis>
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim<directivesynopsis>
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim<description>Technique for locating the interpreter for CGI
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jimscripts</description>
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim<syntax>ScriptInterpreterSource Registry|Registry-Strict|Script</syntax>
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim<contextlist><context>server config</context><context>virtual host</context>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen<context>directory</context><context>.htaccess</context></contextlist>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen<compatibility>Win32 only;
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jimoption <code>Registry-Strict</code> is available in Apache HTTP Server 2.0 and
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jimlater</compatibility>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen <p>This directive is used to control how Apache httpd finds the
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim interpreter used to run CGI scripts. The default setting is
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim <code>Script</code>. This causes Apache httpd to use the interpreter pointed to
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim by the shebang line (first line, starting with <code>#!</code>) in the
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim script. On Win32 systems this line usually looks like:</p>
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim </example>
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim <p>or, if <code>perl</code> is in the <code>PATH</code>, simply:</p>
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim </example>
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim <p>Setting <code>ScriptInterpreterSource Registry</code> will
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim cause the Windows Registry tree <code>HKEY_CLASSES_ROOT</code> to be
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim searched using the script file extension (e.g., <code>.pl</code>) as a
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim search key. The command defined by the registry subkey
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim <code>Shell\ExecCGI\Command</code> or, if it does not exist, by the subkey
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim <code>Shell\Open\Command</code> is used to open the script file. If the
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim registry keys cannot be found, Apache httpd falls back to the behavior of the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Be careful when using <code>ScriptInterpreterSource
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="mod_alias">ScriptAlias</directive>'ed directories, because
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Apache httpd will try to execute <strong>every</strong> file within this
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directory. The <code>Registry</code> setting may cause undesired
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive program calls on files which are typically not executed. For
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess example, the default open command on <code>.htm</code> files on
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive most Windows systems will execute Microsoft Internet Explorer, so
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd any HTTP request for an <code>.htm</code> file existing within the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive script directory would start the browser in the background on the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive server. This is a good way to crash your system within a minute or
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The option <code>Registry-Strict</code> which is new in Apache HTTP Server
a23acbbd61b9565caecea9931b6bcdf0b6228cbbslive 2.0 does the same thing as <code>Registry</code> but uses only the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>ExecCGI</code> key is not a common one. It must be
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive configured manually in the windows registry and hence prevents
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive accidental program calls on your system.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
a23acbbd61b9565caecea9931b6bcdf0b6228cbbslive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Determine if mod_status displays the first 63 characters
01710fa5f312f3a9cd1969d1809cf6c19a7f3d31niqof a request or the last 63, assuming the request itself is greater than
a23acbbd61b9565caecea9931b6bcdf0b6228cbbslive63 chars.</description>
a23acbbd61b9565caecea9931b6bcdf0b6228cbbslive<contextlist><context>server config</context></contextlist>
a23acbbd61b9565caecea9931b6bcdf0b6228cbbslive<compatibility>Available in Apache httpd 2.2.7 and later.</compatibility>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd displays the actual request being handled.
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd For historical purposes, only 63 characters of the request
130d299c4b2b15be45532a176604c71fdc7bea5bnd are actually stored for display purposes. This directive
e8811b6d38f756b325446ded5d96857d13856511takashi controls whether the 1st 63 characters are stored (the previous
e8811b6d38f756b325446ded5d96857d13856511takashi behavior and the default) or if the last 63 characters are. This
e8811b6d38f756b325446ded5d96857d13856511takashi is only applicable, of course, if the length of the request is
e8811b6d38f756b325446ded5d96857d13856511takashi 64 characters or greater.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd >GET /disk1/storage/apache/htdocs/images/imagestore1/food/apples.jpg HTTP/1.1</code
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd > mod_status displays as follows:
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <td>GET /disk1/storage/apache/htdocs/images/imagestore1/food/apples</td>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <td>orage/apache/htdocs/images/imagestore1/food/apples.jpg HTTP/1.1</td>
130d299c4b2b15be45532a176604c71fdc7bea5bnd</directivesynopsis>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Email address that the server includes in error
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivemessages sent to the client</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>ServerAdmin <var>email-address</var>|<var>URL</var></syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <directive>ServerAdmin</directive> sets the contact address
130d299c4b2b15be45532a176604c71fdc7bea5bnd that the server includes in any error messages it returns to the
130d299c4b2b15be45532a176604c71fdc7bea5bnd client. If the <code>httpd</code> doesn't recognize the supplied argument
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen as an URL, it
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen assumes, that it's an <var>email-address</var> and prepends it with
130d299c4b2b15be45532a176604c71fdc7bea5bnd <code>mailto:</code> in hyperlink targets. However, it's recommended to
130d299c4b2b15be45532a176604c71fdc7bea5bnd actually use an email address, since there are a lot of CGI scripts that
130d299c4b2b15be45532a176604c71fdc7bea5bnd make that assumption. If you want to use an URL, it should point to another
a23acbbd61b9565caecea9931b6bcdf0b6228cbbslive server under your control. Otherwise users may not be able to contact you in
a23acbbd61b9565caecea9931b6bcdf0b6228cbbslive case of errors.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>It may be worth setting up a dedicated address for this, e.g.</p>
4025ef5b9785f4cc9e6456a1c0177383a8503361covener ServerAdmin www-admin@foo.example.com
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>as users do not always mention that they are talking about the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive server!</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
4cf1c07a88ef51e11570c775507cd7d2c3e35a97slive<description>Alternate names for a host used when matching requests
4cf1c07a88ef51e11570c775507cd7d2c3e35a97sliveto name-virtual hosts</description>
4cf1c07a88ef51e11570c775507cd7d2c3e35a97slive<syntax>ServerAlias <var>hostname</var> [<var>hostname</var>] ...</syntax>
4cf1c07a88ef51e11570c775507cd7d2c3e35a97slive<contextlist><context>virtual host</context></contextlist>
e6ab342447cf6b4c22bbe66169718d0e9b78819apoirier <p>The <directive>ServerAlias</directive> directive sets the
e6ab342447cf6b4c22bbe66169718d0e9b78819apoirier alternate names for a host, for use with <a
e6ab342447cf6b4c22bbe66169718d0e9b78819apoirier href="/vhosts/name-based.html">name-based virtual hosts</a>. The
e6ab342447cf6b4c22bbe66169718d0e9b78819apoirier <directive>ServerAlias</directive> may include wildcards, if appropriate.</p>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <VirtualHost *:80><br />
9b5e2c5e769dc678a1aca06df75c32022b2f1492trawick ServerAlias server server2.example.com server2<br />
130d299c4b2b15be45532a176604c71fdc7bea5bnd UseCanonicalName Off<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive # ...<br />
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen </VirtualHost>
ef8e89e090461194ecadd31e8796a2c51e0531a2kess </example>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive module="core">UseCanonicalName</directive></seealso>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen<seealso><a href="/vhosts/">Apache HTTP Server Virtual Host documentation</a></seealso>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess</directivesynopsis>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Hostname and port that the server uses to identify
7db9f691a00ead175b03335457ca296a33ddf31bnditself</description>
<syntax>ServerName [<var>scheme</var>://]<var>fully-qualified-domain-name</var>[:<var>port</var>]</syntax>
ServerName www.example.com
settings which determine whether self-referential URLs (e.g., by the
httpd: Could not reliably determine the server's fully qualified domain name, using rocinante.local for ServerName
href="http://httpd.apache.org/docs/misc/FAQ.html#prompted-twice">the