core.xml revision eb73941bd697cd7e8226ceaf04183ade6c66934d
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>
e4e60c2f7ba8f12b687f588b89e413842e9f2d76igalic <p>This directive enables operating system specific optimizations for a
e4e60c2f7ba8f12b687f588b89e413842e9f2d76igalic listening socket by the <directive>Protocol</directive>type.
e4e60c2f7ba8f12b687f588b89e413842e9f2d76igalic The basic premise is for the kernel to not send a socket to the server
e4e60c2f7ba8f12b687f588b89e413842e9f2d76igalic process until either data is received or an entire HTTP Request is buffered.
e4e60c2f7ba8f12b687f588b89e413842e9f2d76igalic 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>
4e9f8c5414e5fe39b5393641533edca65f6e8b91poirier <p>The default protocol names are <code>https</code> for port 443
4e9f8c5414e5fe39b5393641533edca65f6e8b91poirier and <code>http</code> for all other ports. To specify another protocol
4e9f8c5414e5fe39b5393641533edca65f6e8b91poirier is being used with a listening port, add the <var>protocol</var>
4e9f8c5414e5fe39b5393641533edca65f6e8b91poirier argument to the <directive module="mpm_common">Listen</directive>
4e9f8c5414e5fe39b5393641533edca65f6e8b91poirier directive.</p>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna AcceptFilter http httpready <br/>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna AcceptFilter https dataready
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna <p>The <code>httpready</code> accept filter buffers entire HTTP requests at
90efa9f1730742d874edb5a7803adce11c9f08eanoodl 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
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna requests. Any value besides <code>none</code> will enable
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna <code>TCP_DEFER_ACCEPT</code> on that listener. For more details
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna see the Linux
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna <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>
e4e60c2f7ba8f12b687f588b89e413842e9f2d76igalic <p>On Windows, <code>none</code> uses accept() rather than AcceptEx()
5ae609a8a09239d20f48a4a95c4f21b713995babwrowe and will not recycle sockets between connections. This is useful for
5ae609a8a09239d20f48a4a95c4f21b713995babwrowe network adapters with broken driver support, as well as some virtual
5ae609a8a09239d20f48a4a95c4f21b713995babwrowe network providers such as vpn drivers, or spam, virus or spyware
5ae609a8a09239d20f48a4a95c4f21b713995babwrowe filters.</p>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<description>Resources accept trailing pathname information</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<context>virtual host</context><context>directory</context>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen<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
fb77c505254b6e9c925e23e734463e87574f8f40kess 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>
fb77c505254b6e9c925e23e734463e87574f8f40kess <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
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>/test/here.html/more</code> in the above example will return
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive a 404 NOT FOUND error.</dd>
fb77c505254b6e9c925e23e734463e87574f8f40kess <dt><code>On</code></dt><dd>A request will be accepted if a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive leading path component maps to a file that exists. The above
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive 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.
fb77c505254b6e9c925e23e734463e87574f8f40kess The core handler for normal files defaults to rejecting
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess <code>PATH_INFO</code> requests. Handlers that serve scripts, such as <a
bc4b55ec8f31569d606d5680d50189a355bcd7a6rbowen href="mod_isapi.html">isapi-handler</a>, generally accept
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The primary purpose of the <code>AcceptPathInfo</code>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directive is to allow you to override the handler's choice of
fb77c505254b6e9c925e23e734463e87574f8f40kess accepting or rejecting <code>PATH_INFO</code>. This override is required,
fb77c505254b6e9c925e23e734463e87574f8f40kess for example, when you use a <a href="/filter.html">filter</a>, such
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive as <a href="mod_include.html">INCLUDES</a>, to generate content
fb77c505254b6e9c925e23e734463e87574f8f40kess based on <code>PATH_INFO</code>. The core handler would usually reject
fb77c505254b6e9c925e23e734463e87574f8f40kess the request, so you can use the following configuration to enable
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive such a script:</p>
130d299c4b2b15be45532a176604c71fdc7bea5bnd Options +Includes<br />
130d299c4b2b15be45532a176604c71fdc7bea5bnd SetOutputFilter INCLUDES<br />
ef8e89e090461194ecadd31e8796a2c51e0531a2kess AcceptPathInfo On<br />
130d299c4b2b15be45532a176604c71fdc7bea5bnd </Files>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
003f0c9fda6664daf5092a0e42f65ede20098153slive<description>Name of the distributed configuration file</description>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<syntax>AccessFileName <var>filename</var> [<var>filename</var>] ...</syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <p>While processing a request the server looks for
003f0c9fda6664daf5092a0e42f65ede20098153slive the first existing configuration file from this list of names in
003f0c9fda6664daf5092a0e42f65ede20098153slive every directory of the path to the document, if distributed
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess configuration files are <a href="#allowoverride">enabled for that
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd AccessFileName .acl
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>before returning the document
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>/usr/local/web/index.html</code>, the server will read
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>/usr/local/.acl</code> and <code>/usr/local/web/.acl</code>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive for directives, unless they have been disabled with</p>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <Directory /><br />
130d299c4b2b15be45532a176604c71fdc7bea5bnd AllowOverride None<br />
130d299c4b2b15be45532a176604c71fdc7bea5bnd </Directory>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive module="core">AllowOverride</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><a href="/configuring.html">Configuration Files</a></seealso>
1a3f62ca37273a15a06bb94a61d3c6fcf4bf38c9rbowen<seealso><a href="/howto/htaccess.html">.htaccess Files</a></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding<description>Default charset parameter to be added when a response
684f2a9a422185adda0692a1203c5ad6687fc5c5ndcontent-type is <code>text/plain</code> or <code>text/html</code></description>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<syntax>AddDefaultCharset On|Off|<var>charset</var></syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<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
684f2a9a422185adda0692a1203c5ad6687fc5c5nd <code>text/plain</code> or <code>text/html</code>. This should override
a8ce9095d102e43fecb81093a132b90b9a227f78kess any charset specified in the body of the response via a <code>META</code>
684f2a9a422185adda0692a1203c5ad6687fc5c5nd element, though the exact behavior is often dependent on the user's client
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding configuration. A setting of <code>AddDefaultCharset Off</code>
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding disables this functionality. <code>AddDefaultCharset On</code> enables
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding a default charset of <code>iso-8859-1</code>. Any other value is assumed
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding 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
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding charset values</a> for use in Internet media types (MIME types).
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding For example:</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd AddDefaultCharset utf-8
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
684f2a9a422185adda0692a1203c5ad6687fc5c5nd <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
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding individually. One such example is to add the charset parameter
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding to resources containing generated content, such as legacy CGI
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding scripts, that might be vulnerable to cross-site scripting attacks
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding due to user-provided data being included in the output. Note, however,
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding that a better solution is to just fix (or delete) those scripts, since
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding setting a default charset does not protect users that have enabled
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding the "auto-detect character encoding" feature on their browser.</p>
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding<seealso><directive module="mod_mime">AddCharset</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
77ead9e0262e4f08ec336d1a65b2edef7705c839nd<directivesynopsis>
9583adab6bc4b3758e41963c905d9dad9f067131nd<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>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen<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>
77ead9e0262e4f08ec336d1a65b2edef7705c839nd 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
9b5e2c5e769dc678a1aca06df75c32022b2f1492trawick slashes are decoded like all other encoded characters.</p>
77ead9e0262e4f08ec336d1a65b2edef7705c839nd <p>With the value <code>NoDecode</code>, such URLs are accepted, but
77ead9e0262e4f08ec336d1a65b2edef7705c839nd encoded slashes are not decoded but left in their encoded state.</p>
77ead9e0262e4f08ec336d1a65b2edef7705c839nd <p>Turning <directive>AllowEncodedSlashes</directive> <code>On</code> is
77ead9e0262e4f08ec336d1a65b2edef7705c839nd 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
003f0c9fda6664daf5092a0e42f65ede20098153slive strongly recommended as a security measure. Allowing slashes
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess to be decoded could potentially allow unsafe paths.</p>
4ea161d94782fa56f4b36d496f35ff8577c43065covener<seealso><directive module="core">AcceptPathInfo</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
fb77c505254b6e9c925e23e734463e87574f8f40kess<description>Types of directives that are allowed in
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess<syntax>AllowOverride All|None|<var>directive-type</var>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<default>AllowOverride None (2.3.9 and later), AllowOverride All (2.3.8 and earlier)</default>
10673857794a4b3d9568ca2d983722a87ed352f1rbowen<contextlist><context>directory</context></contextlist>
b12b918ae6baf9c5762ed61b7393d0e2198378c0nd <p>When the server finds an <code>.htaccess</code> file (as
b12b918ae6baf9c5762ed61b7393d0e2198378c0nd specified by <directive module="core">AccessFileName</directive>)
b12b918ae6baf9c5762ed61b7393d0e2198378c0nd it needs to know which directives declared in that file can override
10673857794a4b3d9568ca2d983722a87ed352f1rbowen earlier configuration directives.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <note><title>Only available in <Directory> sections</title>
fb77c505254b6e9c925e23e734463e87574f8f40kess <directive type="section" module="core">Directory</directive>
fb77c505254b6e9c925e23e734463e87574f8f40kess 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
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive completely ignored. In this case, the server will not even attempt
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive to read <code>.htaccess</code> files in the filesystem.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>When this directive is set to <code>All</code>, then any
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directive which has the .htaccess <a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive href="directive-dict.html#Context">Context</a> is allowed in
1f53e295ebd19aed1767d12da7abfab9936c148cjerenkrantz <p>The <var>directive-type</var> can be one of the following
9ed9eaf871c58d281af02e76125ceadb5060afa5nd groupings of directives.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Allow use of the authorization directives (<directive
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding <directive module="mod_authn_dbm">AuthDBMUserFile</directive>,
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding <directive module="mod_authz_groupfile">AuthGroupFile</directive>,
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding <directive module="mod_authn_core">AuthName</directive>,
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding <directive module="mod_authn_core">AuthType</directive>, <directive
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding module="mod_authn_file">AuthUserFile</directive>, <directive
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding 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
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem module="mod_setenvif">SetEnvIf</directive>, <directive
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem module="mod_setenvif">SetEnvIfNoCase</directive>, <directive
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem module="mod_setenvif">BrowserMatch</directive>, <directive
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem module="mod_usertrack">CookieExpires</directive>, <directive
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem module="mod_usertrack">CookieDomain</directive>, <directive
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem module="mod_usertrack">CookieStyle</directive>, <directive
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem 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
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive module="mod_autoindex">AddIcon</directive>, <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive module="mod_autoindex">AddIconByType</directive>,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive module="mod_autoindex">DefaultIcon</directive>, <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="mod_dir">DirectoryIndex</directive>, <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="mod_autoindex">FancyIndexing</directive>, <directive
9ed9eaf871c58d281af02e76125ceadb5060afa5nd module="mod_autoindex">HeaderName</directive>, <directive
9ed9eaf871c58d281af02e76125ceadb5060afa5nd module="mod_autoindex">IndexIgnore</directive>, <directive
9ed9eaf871c58d281af02e76125ceadb5060afa5nd module="mod_autoindex">IndexOptions</directive>, <directive
103a93c625bcde1a6a7a5155b64dcda36f612180pquerna Allow use of the directives controlling host access (<directive
103a93c625bcde1a6a7a5155b64dcda36f612180pquerna module="mod_authz_host">Allow</directive>, <directive
f23fb63b05f89f47d7a3099491f2c68dcce432e9kess module="mod_authz_host">Deny</directive> and <directive
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd Allow use of AllowOverride option to treat syntax errors in
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd .htaccess as non-fatal: instead of causing an Internal Server
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd Error, disallowed or unrecognised directives will be ignored
b12b918ae6baf9c5762ed61b7393d0e2198378c0nd and a warning logged:
b12b918ae6baf9c5762ed61b7393d0e2198378c0nd forbidden by AllowOverride as non-fatal.</li>
da637bcae7b6e150470e701af29da5604a34a17erbowen <li><strong>Nonfatal=Unknown</strong> treats unknown directives
da637bcae7b6e150470e701af29da5604a34a17erbowen as non-fatal. This covers typos and directives implemented
da637bcae7b6e150470e701af29da5604a34a17erbowen by a module that's not present.</li>
da637bcae7b6e150470e701af29da5604a34a17erbowen <li><strong>Nonfatal=All</strong> treats both the above as non-fatal.</li>
da637bcae7b6e150470e701af29da5604a34a17erbowen <p>Note that a syntax error in a valid directive will still cause
da637bcae7b6e150470e701af29da5604a34a17erbowen an internal server error.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Nonfatal errors may have security implications for .htaccess users.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive For example, if AllowOverride disallows AuthConfig, users'
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive configuration designed to restrict access to a site will be disabled.
fb77c505254b6e9c925e23e734463e87574f8f40kess Allow use of the directives controlling specific directory
4c7bdb15764021d39e486adb7bc2166d3f683773bnicholes features (<directive module="core">Options</directive> and
4c7bdb15764021d39e486adb7bc2166d3f683773bnicholes An equal sign may be given followed by a comma (but no spaces)
4c7bdb15764021d39e486adb7bc2166d3f683773bnicholes separated lists of options that may be set using the <directive
4c7bdb15764021d39e486adb7bc2166d3f683773bnicholes <note><title>Implicit disabling of Options</title>
4c7bdb15764021d39e486adb7bc2166d3f683773bnicholes <p>Even though the list of options that may be used in .htaccess files
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen can be limited with this directive, as long as any <directive
fb77c505254b6e9c925e23e734463e87574f8f40kess module="core">Options</directive> directive is allowed any
fb77c505254b6e9c925e23e734463e87574f8f40kess other inherited option can be disabled by using the non-relative
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess syntax. In other words, this mechanism cannot force a specific option
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess to remain <em>set</em> while allowing any others to be set.
fb77c505254b6e9c925e23e734463e87574f8f40kess AllowOverride AuthConfig Indexes
fb77c505254b6e9c925e23e734463e87574f8f40kess </example>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>In the example above all directives that are neither in the group
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>AuthConfig</code> nor <code>Indexes</code> cause an internal
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive server error.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <note><p>For security and performance reasons, do not set
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>AllowOverride</code> to anything other than <code>None</code>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive in your <code><Directory /></code> block. Instead, find (or
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive create) the <code><Directory></code> block that refers to the
5bb5fba250bf526bc51d13b25378d54acb93c1cbnoodl directory where you're actually planning to place a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive module="core">AccessFileName</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive module="core">AllowOverrideList</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><a href="/configuring.html">Configuration Files</a></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><a href="/howto/htaccess.html">.htaccess Files</a></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<description>Individual directives that are allowed in
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>directory</context></contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>When the server finds an <code>.htaccess</code> file (as
fb77c505254b6e9c925e23e734463e87574f8f40kess specified by <directive module="core">AccessFileName</directive>)
fb77c505254b6e9c925e23e734463e87574f8f40kess it needs to know which directives declared in that file can override
fb77c505254b6e9c925e23e734463e87574f8f40kess 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>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive sections specified without regular expressions, not in <directive
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding type="section" module="core">Location</directive>, <directive
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding module="core" type="section">DirectoryMatch</directive> or
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding <directive type="section" module="core">Files</directive> sections.
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding <p>When this directive is set to <code>None</code> and <directive
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding 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
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding AllowOverride None<br />
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding AllowOverrideList Redirect RedirectMatch
e4881891552e185a7408318dfc7f62ebabe73cf6niq <p>In the example above only the <code>Redirect</code> and
e4881891552e185a7408318dfc7f62ebabe73cf6niq <code>RedirectMatch</code> directives are allowed. All others will
e4881891552e185a7408318dfc7f62ebabe73cf6niq cause an internal server error.</p>
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding AllowOverride AuthConfig<br />
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding AllowOverrideList CookieTracking CookieName
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding <p>In the example above <directive module="core">AllowOverride
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding </directive> grants permission to the <code>AuthConfig</code>
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding directive grouping and <directive>AllowOverrideList</directive> grants
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive permission to only two directves from the <code>FileInfo</code> directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive grouping. All others will cause an internal server error.</p>
6e483e0b8aa3fa574288a7452221392a03e2b9a3noodl<seealso><directive module="core">AccessFileName</directive></seealso>
20b0f809c3823eda58808be053ffc305dfa9c785sf<seealso><directive module="core">AllowOverride</directive></seealso>
20b0f809c3823eda58808be053ffc305dfa9c785sf<seealso><a href="/configuring.html">Configuration Files</a></seealso>
6e483e0b8aa3fa574288a7452221392a03e2b9a3noodl<seealso><a href="/howto/htaccess.html">.htaccess Files</a></seealso>
6e483e0b8aa3fa574288a7452221392a03e2b9a3noodl</directivesynopsis>
ccf2a600dd72cc3c3c44f5d4126d9bb60fa83894takashi<directivesynopsis>
6e483e0b8aa3fa574288a7452221392a03e2b9a3noodl<description>Technique for locating the interpreter for CGI
6e483e0b8aa3fa574288a7452221392a03e2b9a3noodlscripts</description>
6e483e0b8aa3fa574288a7452221392a03e2b9a3noodl<syntax>CGIMapExtension <var>cgi-path</var> <var>.extension</var></syntax>
6e483e0b8aa3fa574288a7452221392a03e2b9a3noodl<contextlist><context>directory</context><context>.htaccess</context>
6e483e0b8aa3fa574288a7452221392a03e2b9a3noodl</contextlist>
898475b582dd849de5915df0f2089b72ed8b2e2bcovener <p>This directive is used to control how Apache httpd finds the
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd interpreter used to run CGI scripts. For example, setting
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive cause all CGI script files with a <code>.foo</code> extension to
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive be passed to the FOO interpreter.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
898475b582dd849de5915df0f2089b72ed8b2e2bcovener<description>Enables the generation of <code>Content-MD5</code> HTTP Response
898475b582dd849de5915df0f2089b72ed8b2e2bcovenerheaders</description>
fb77c505254b6e9c925e23e734463e87574f8f40kess<contextlist><context>server config</context><context>virtual host</context>
fb77c505254b6e9c925e23e734463e87574f8f40kess<context>directory</context><context>.htaccess</context>
fb77c505254b6e9c925e23e734463e87574f8f40kess</contextlist>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>This directive enables the generation of
130d299c4b2b15be45532a176604c71fdc7bea5bnd respectively RFC2616.</p>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <p>MD5 is an algorithm for computing a "message digest"
130d299c4b2b15be45532a176604c71fdc7bea5bnd (sometimes called "fingerprint") of arbitrary-length data, with
130d299c4b2b15be45532a176604c71fdc7bea5bnd a high degree of confidence that any alterations in the data
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd will be reflected in alterations in the message digest.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>The <code>Content-MD5</code> header provides an end-to-end
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd message integrity check (MIC) of the entity-body. A proxy or
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen client may check this header for detecting accidental
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd modification of the entity-body in transit. Example header:</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd Content-MD5: AuLb7Dp1rqtRtxz2m9kRpA==
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
030108b1816bcda3d925df65357feabdce83bc94slive <p>Note that this can cause performance problems on your server
030108b1816bcda3d925df65357feabdce83bc94slive since the message digest is computed on every request (the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive values are not cached).</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <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>
fb77c505254b6e9c925e23e734463e87574f8f40kess</directivesynopsis>
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess<directivesynopsis>
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess<description>This directive has no effect other than to emit warnings
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveif the value is not <code>none</code>. In prior versions, DefaultType
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivewould specify a default media type to assign to response content for
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivewhich no other media type configuration could be found.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>DefaultType <var>media-type|none</var></syntax>
130d299c4b2b15be45532a176604c71fdc7bea5bnd<contextlist><context>server config</context><context>virtual host</context>
130d299c4b2b15be45532a176604c71fdc7bea5bnd</contextlist>
130d299c4b2b15be45532a176604c71fdc7bea5bnd<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>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <p>This directive has been disabled. For backwards compatibility
130d299c4b2b15be45532a176604c71fdc7bea5bnd of configuration files, it may be specified with the value
130d299c4b2b15be45532a176604c71fdc7bea5bnd <code>none</code>, meaning no default media type. For example:</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd DefaultType None
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive httpd-2.2.7 and later.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive module="mod_mime">AddType</directive> to configure media
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive type assignments via file extensions, or the
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess <directive module="core">ForceType</directive> directive to configure
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the media type for specific resources. Otherwise, the server will
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess send the response without a Content-Type header field and the
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess recipient may attempt to guess the media type.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>Define <var>parameter-name</var> [<var>parameter-value</var>]</syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <p>In its one parameter form, <directive>Define</directive> is equivalent
130d299c4b2b15be45532a176604c71fdc7bea5bnd to passing the <code>-D</code> argument to <program>httpd</program>. It
130d299c4b2b15be45532a176604c71fdc7bea5bnd can be used to toggle the use of
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <directive module="core" type="section">IfDefine</directive> sections
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive without needing to alter <code>-D</code> arguments in any startup
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess scripts.</p>
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess <p>In addition to that, if the second parameter is given, a config variable
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess is set to this value. The variable can be used in the configuration using
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess the <code>${VAR}</code> syntax. The variable is always globally defined
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess and not limited to the scope of the surrounding config section.</p>
fb77c505254b6e9c925e23e734463e87574f8f40kess <IfDefine TEST><br/>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </IfDefine><br/>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <IfDefine !TEST><br/>
130d299c4b2b15be45532a176604c71fdc7bea5bnd Define SSL<br/>
130d299c4b2b15be45532a176604c71fdc7bea5bnd </IfDefine><br/>
130d299c4b2b15be45532a176604c71fdc7bea5bnd </example>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <p>Variable names may not contain colon ":" characters, to avoid clashes
130d299c4b2b15be45532a176604c71fdc7bea5bnd with <directive module="mod_rewrite">RewriteMap</directive>'s syntax.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Enclose a group of directives that apply only to the
fb77c505254b6e9c925e23e734463e87574f8f40kessnamed file-system directory, sub-directories, and their contents.</description>
fb77c505254b6e9c925e23e734463e87574f8f40kess... </Directory></syntax>
fb77c505254b6e9c925e23e734463e87574f8f40kess<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p><directive type="section">Directory</directive> and
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <code></Directory></code> are used to enclose a group of
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess directives that will apply only to the named directory,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive sub-directories of that directory, and the files within the respective
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive 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
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess characters. You may also use <code>[]</code> character ranges. None
898475b582dd849de5915df0f2089b72ed8b2e2bcovener of the wildcards match a `/' character, so <code><Directory
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd /*/public_html></code> will not match
7b5535ed88e0f561b3bfb3330137bd804846afd4slive <code>/home/user/public_html</code>, but <code><Directory
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive /home/*/public_html></code> will match. Example:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Options Indexes FollowSymLinks<br />
fa1c7ce09927decc1eecd1e9a35cc5331078a052covener </Directory>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>Be careful with the <var>directory-path</var> arguments:
6954edc623ca2c179eb5b33e97e4304d06fd649frbowen They have to literally match the filesystem path which Apache httpd uses
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd to access the files. Directives applied to a particular
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code><Directory></code> will not apply to files accessed from
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive that same directory via a different path, such as via different symbolic
fa1c7ce09927decc1eecd1e9a35cc5331078a052covener expressions</glossary> can also be used, with the addition of the
fa1c7ce09927decc1eecd1e9a35cc5331078a052covener <Directory ~ "^/www/.*/[0-9]{3}">
fa1c7ce09927decc1eecd1e9a35cc5331078a052covener <p>would match directories in <code>/www/</code> that consisted of
fa1c7ce09927decc1eecd1e9a35cc5331078a052covener 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
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess first, interspersed with the directives from the <a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive href="#accessfilename">.htaccess</a> files. For example,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <Directory /><br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive AllowOverride None<br />
003f0c9fda6664daf5092a0e42f65ede20098153slive </Directory><br />
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <Directory /home><br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive AllowOverride FileInfo<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </Directory>
fb77c505254b6e9c925e23e734463e87574f8f40kess <p>for access to the document <code>/home/web/dir/doc.html</code>
fb77c505254b6e9c925e23e734463e87574f8f40kess the steps are:</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <li>Apply directive <code>AllowOverride FileInfo</code> (for
c68acc9d712af079afa2bd1a5a4aeef9a3ea573ckess <code>/home/.htaccess</code>, <code>/home/web/.htaccess</code> and
c68acc9d712af079afa2bd1a5a4aeef9a3ea573ckess <code>/home/web/dir/.htaccess</code> in that order.</li>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Regular expressions are not considered until after all of the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive normal sections have been applied. Then all of the regular
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive expressions are tested in the order they appeared in the
1b01d1ee11c612226cb3141eed4581dc179266c1rbowen configuration file. For example, with</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <Directory ~ abc$><br />
af18698b10b429b270551ca3a5d51a75e1c9db22brianp # ... directives here ...<br />
fb77c505254b6e9c925e23e734463e87574f8f40kess </Directory>
fb77c505254b6e9c925e23e734463e87574f8f40kess </example>
af18698b10b429b270551ca3a5d51a75e1c9db22brianp <p>the regular expression section won't be considered until after
af18698b10b429b270551ca3a5d51a75e1c9db22brianp all normal <directive type="section">Directory</directive>s and
003f0c9fda6664daf5092a0e42f65ede20098153slive <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
a1ef40892ffa2b44fc249423c5b6c42a74a84c68nd be applied.</p>
fb77c505254b6e9c925e23e734463e87574f8f40kess <code><Directory /></code> is to permit all access.
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen This means that Apache httpd will serve any file mapped from an URL. It is
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd recommended that you change this with a block such
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <Directory /><br />
af18698b10b429b270551ca3a5d51a75e1c9db22brianp Require all denied<br />
a1ef40892ffa2b44fc249423c5b6c42a74a84c68nd </Directory>
13cbe1d8f52c8097cb581e7eb259693b64d41d10poirier <p><strong>and then override this for directories you
af18698b10b429b270551ca3a5d51a75e1c9db22brianp href="/misc/security_tips.html">Security Tips</a> page for more
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>The directory sections occur in the <code>httpd.conf</code> file.
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <directive type="section">Directory</directive> directives
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd cannot nest, and cannot appear in a <directive module="core"
fb77c505254b6e9c925e23e734463e87574f8f40kess type="section">Limit</directive> or <directive module="core"
41ef8b3051855b802104193ee0a587515af60a37wrowe<seealso><a href="/sections.html">How <Directory>,
41ef8b3051855b802104193ee0a587515af60a37wrowe <Location> and <Files> sections work</a> for an
41ef8b3051855b802104193ee0a587515af60a37wrowe explanation of how these different sections are combined when a
41ef8b3051855b802104193ee0a587515af60a37wrowe request is received</seealso>
41ef8b3051855b802104193ee0a587515af60a37wrowe</directivesynopsis>
41ef8b3051855b802104193ee0a587515af60a37wrowe<description>Enclose directives that apply to
41ef8b3051855b802104193ee0a587515af60a37wrowethe contents of file-system directories matching a regular expression.</description>
41ef8b3051855b802104193ee0a587515af60a37wrowe... </DirectoryMatch></syntax>
41ef8b3051855b802104193ee0a587515af60a37wrowe<contextlist><context>server config</context><context>virtual host</context>
41ef8b3051855b802104193ee0a587515af60a37wrowe</contextlist>
fb77c505254b6e9c925e23e734463e87574f8f40kess <p><directive type="section">DirectoryMatch</directive> and
9c233808c898095865fcc0a2dc1cf594d0d8faf3sf <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>.
41ef8b3051855b802104193ee0a587515af60a37wrowe However, it takes as an argument a
41ef8b3051855b802104193ee0a587515af60a37wrowe <glossary ref="regex">regular expression</glossary>. For example:</p>
41ef8b3051855b802104193ee0a587515af60a37wrowe <DirectoryMatch "^/www/(.+/)?[0-9]{3}">
a1ef40892ffa2b44fc249423c5b6c42a74a84c68nd <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
9b5e2c5e769dc678a1aca06df75c32022b2f1492trawick could not match the end of line symbol ($). In 2.3.9 and later,
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess only directories that match the expression are affected by the enclosed
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess 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
9fb925624300c864fe3969a264e52aa83f3c2dd0slive end of line ($) must be written with care.
78f4d313fd5edf76dc5cfb8725e082a08cd29740jwoolley<seealso><directive type="section" module="core">Directory</directive> for
9d00e5d0f270651f1f1cc1abea03bf53e5656fcecolma description of how regular expressions are mixed in with normal
9d00e5d0f270651f1f1cc1abea03bf53e5656fcecolm<directive type="section">Directory</directive>s</seealso>
9c233808c898095865fcc0a2dc1cf594d0d8faf3sfhref="/sections.html">How <Directory>, <Location> and
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<Files> sections work</a> for an explanation of how these different
9fb925624300c864fe3969a264e52aa83f3c2dd0slivesections are combined when a request is received</seealso>
41ef8b3051855b802104193ee0a587515af60a37wrowe</directivesynopsis>
9c233808c898095865fcc0a2dc1cf594d0d8faf3sf<directivesynopsis>
41ef8b3051855b802104193ee0a587515af60a37wrowe<description>Directory that forms the main document tree visible
41ef8b3051855b802104193ee0a587515af60a37wrowefrom the web</description>
41ef8b3051855b802104193ee0a587515af60a37wrowe<default>DocumentRoot /usr/local/apache/htdocs</default>
41ef8b3051855b802104193ee0a587515af60a37wrowe<contextlist><context>server config</context><context>virtual host</context>
9c233808c898095865fcc0a2dc1cf594d0d8faf3sf</contextlist>
41ef8b3051855b802104193ee0a587515af60a37wrowe <p>This directive sets the directory from which <program>httpd</program>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess will serve files. Unless matched by a directive like <directive
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess module="mod_alias">Alias</directive>, the server appends the
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess path from the requested URL to the document root to make the
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess path to the document. Example:</p>
832853bb93c1831daf24e4727c5ca0e1b1786e83lars </example>
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
af18698b10b429b270551ca3a5d51a75e1c9db22brianp not absolute then it is assumed to be relative to the <directive
79c754eb51681c3389cd966753e902c429f78939trawick <p>The <directive>DocumentRoot</directive> should be specified without
79c754eb51681c3389cd966753e902c429f78939trawick a trailing slash.</p>
79c754eb51681c3389cd966753e902c429f78939trawick<seealso><a href="/urlmapping.html#documentroot">Mapping URLs to Filesystem
79c754eb51681c3389cd966753e902c429f78939trawick</directivesynopsis>
79c754eb51681c3389cd966753e902c429f78939trawick<description>Contains directives that apply only if the condition of a
79c754eb51681c3389cd966753e902c429f78939trawickprevious <directive type="section" module="core">If</directive> or
79c754eb51681c3389cd966753e902c429f78939trawick<directive type="section" module="core">ElseIf</directive> section is not
79c754eb51681c3389cd966753e902c429f78939trawicksatisfied by a request at runtime</description>
79c754eb51681c3389cd966753e902c429f78939trawick<contextlist><context>server config</context><context>virtual host</context>
79c754eb51681c3389cd966753e902c429f78939trawick<context>directory</context><context>.htaccess</context>
79c754eb51681c3389cd966753e902c429f78939trawick</contextlist>
79c754eb51681c3389cd966753e902c429f78939trawick <p>The <directive type="section">Else</directive> applies the enclosed
79c754eb51681c3389cd966753e902c429f78939trawick directives if and only if the most recent
79c754eb51681c3389cd966753e902c429f78939trawick <directive type="section">ElseIf</directive> section
79c754eb51681c3389cd966753e902c429f78939trawick in the same scope has not been applied.
79c754eb51681c3389cd966753e902c429f78939trawick For example: In </p>
79c754eb51681c3389cd966753e902c429f78939trawick <If "-z req('Host')"><br/>
79c754eb51681c3389cd966753e902c429f78939trawick </If><br/>
79c754eb51681c3389cd966753e902c429f78939trawick <Else><br/>
79c754eb51681c3389cd966753e902c429f78939trawick </Else><br/>
79c754eb51681c3389cd966753e902c429f78939trawick <p> The <directive type="section">If</directive> would match HTTP/1.0
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive type="section">Else</directive> would match requests
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive type="section" module="core">If</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive type="section" module="core">ElseIf</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><a href="/sections.html">How <Directory>, <Location>,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <Files> sections work</a> for an explanation of how these
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen different sections are combined when a request is received.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive type="section">Else</directive> are applied last.</seealso>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Contains directives that apply only if a condition is satisfied
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveby a request at runtime while the condition of a previous
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directive type="section" module="core">If</directive> or
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directive type="section">ElseIf</directive> section is not
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cndsatisfied</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax><ElseIf <var>expression</var>> ... </ElseIf></syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <directive type="section">ElseIf</directive> applies the enclosed
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directives if and only if both the given condition evaluates to true and
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen 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/>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <ElseIf "-R '10.0.0.0/8'"><br/>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </ElseIf><br/>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <Else><br/>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </Else><br/>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen <p>The <directive type="section">ElseIf</directive> would match if
f7fe99050600166042c04b8e595fb75499eed7f0geoff the remote address of a request belongs to the subnet 10.0.0.0/8 but
f7fe99050600166042c04b8e595fb75499eed7f0geoff<seealso><a href="/expr.html">Expressions in Apache HTTP Server</a>,
f7fe99050600166042c04b8e595fb75499eed7f0geofffor a complete reference and more examples.</seealso>
f7fe99050600166042c04b8e595fb75499eed7f0geoff<seealso><directive type="section" module="core">If</directive></seealso>
f7fe99050600166042c04b8e595fb75499eed7f0geoff<seealso><directive type="section" module="core">Else</directive></seealso>
f7fe99050600166042c04b8e595fb75499eed7f0geoff<seealso><a href="/sections.html">How <Directory>, <Location>,
f7fe99050600166042c04b8e595fb75499eed7f0geoff <Files> sections work</a> for an explanation of how these
f7fe99050600166042c04b8e595fb75499eed7f0geoff different sections are combined when a request is received.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive type="section">Else</directive> are applied last.</seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</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>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
fb77c505254b6e9c925e23e734463e87574f8f40kess <p>This directive controls whether the <program>httpd</program> may use
fb77c505254b6e9c925e23e734463e87574f8f40kess memory-mapping if it needs to read the contents of a file during
fb77c505254b6e9c925e23e734463e87574f8f40kess delivery. By default, when the handling of a request requires
4f854c24127e28f7ad72ce9a39d4448aaf910fc1slive access to the data within a file -- for example, when delivering a
4f854c24127e28f7ad72ce9a39d4448aaf910fc1slive server-parsed file using <module>mod_include</module> -- Apache httpd
4f854c24127e28f7ad72ce9a39d4448aaf910fc1slive memory-maps the file if the OS supports it.</p>
fb77c505254b6e9c925e23e734463e87574f8f40kess <p>This memory-mapping sometimes yields a performance improvement.
fb77c505254b6e9c925e23e734463e87574f8f40kess But in some environments, it is better to disable the memory-mapping
4f854c24127e28f7ad72ce9a39d4448aaf910fc1slive to prevent operational problems:</p>
69fba5b8aa0b0dc408f649cfdaab064ce120b05bslive <li>On some multiprocessor systems, memory-mapping can reduce the
69fba5b8aa0b0dc408f649cfdaab064ce120b05bslive <li>Deleting or truncating a file while <program>httpd</program>
69fba5b8aa0b0dc408f649cfdaab064ce120b05bslive has it memory-mapped can cause <program>httpd</program> to
69fba5b8aa0b0dc408f649cfdaab064ce120b05bslive crash with a segmentation fault.
b5d3d68a9f683722eac7a3ca507c3e571908dfc0rbowen <p>For server configurations that are vulnerable to these problems,
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen you should disable memory-mapping of delivered files by specifying:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive EnableMMAP Off
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>For NFS mounted files, this feature may be disabled explicitly for
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the offending files by specifying:</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <Directory "/path-to-nfs-files">
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive EnableMMAP Off
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </Directory>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
c68acc9d712af079afa2bd1a5a4aeef9a3ea573ckess<directivesynopsis>
fb109b84906e3ee61680aa289953c2f9e859354erbowen<description>Use the kernel sendfile support to deliver files to the client</description>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<contextlist><context>server config</context><context>virtual host</context>
fb109b84906e3ee61680aa289953c2f9e859354erbowen<context>directory</context><context>.htaccess</context>
960188481b7025ac8ef7221b67af83dd27e46cd0rjung</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<compatibility>Available in version 2.0.44 and later. Default changed to Off in
fb109b84906e3ee61680aa289953c2f9e859354erbowenversion 2.3.9.</compatibility>
fb109b84906e3ee61680aa289953c2f9e859354erbowen <p>This directive controls whether <program>httpd</program> may use the
960188481b7025ac8ef7221b67af83dd27e46cd0rjung sendfile support from the kernel to transmit file contents to the client.
960188481b7025ac8ef7221b67af83dd27e46cd0rjung By default, when the handling of a request requires no access
960188481b7025ac8ef7221b67af83dd27e46cd0rjung to the data within a file -- for example, when delivering a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive static file -- Apache httpd uses sendfile to deliver the file contents
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive without ever reading the file if the OS supports it.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>This sendfile mechanism avoids separate read and send operations,
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd and buffer allocations. But on some platforms or within some
5155e92c6100b47513159eee1b2b9914ab204a5acovener filesystems, it is better to disable this feature to avoid
5155e92c6100b47513159eee1b2b9914ab204a5acovener operational problems:</p>
fb109b84906e3ee61680aa289953c2f9e859354erbowen <li>Some platforms may have broken sendfile support that the build
fb109b84906e3ee61680aa289953c2f9e859354erbowen system did not detect, especially if the binaries were built on
fb109b84906e3ee61680aa289953c2f9e859354erbowen another box and moved to such a machine with broken sendfile
fb109b84906e3ee61680aa289953c2f9e859354erbowen support.</li>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <li>On Linux the use of sendfile triggers TCP-checksum
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive offloading bugs on certain networking cards when using IPv6.</li>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <li>On Linux on Itanium, <code>sendfile</code> may be unable to handle
9b5e2c5e769dc678a1aca06df75c32022b2f1492trawick files over 2GB in size.</li>
2bac697634d965d9d9a921a99a68b2c454c8a95dbnicholes module="core">DocumentRoot</directive> (e.g., NFS, SMB, CIFS, FUSE),
2bac697634d965d9d9a921a99a68b2c454c8a95dbnicholes the kernel may be unable to serve the network file through
d950cf9262224a223e2ff5c51393708071e14b94covener its own cache.</li>
2bac697634d965d9d9a921a99a68b2c454c8a95dbnicholes <p>For server configurations that are not vulnerable to these problems,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive you may enable this feature by specifying:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive EnableSendfile On
e302f38fd646764ce1a1e1c578d794aef514a9e5sf <p>For network mounted files, this feature may be disabled explicitly
e302f38fd646764ce1a1e1c578d794aef514a9e5sf for the offending files by specifying:</p>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf <Directory "/path-to-nfs-files">
e302f38fd646764ce1a1e1c578d794aef514a9e5sf EnableSendfile Off
e302f38fd646764ce1a1e1c578d794aef514a9e5sf </Directory>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf </example>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf <p>Please note that the per-directory and .htaccess configuration
e302f38fd646764ce1a1e1c578d794aef514a9e5sf of <directive>EnableSendfile</directive> is not supported by
e302f38fd646764ce1a1e1c578d794aef514a9e5sf Only global definition of <directive>EnableSendfile</directive>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf is taken into account by the module.
e302f38fd646764ce1a1e1c578d794aef514a9e5sf</directivesynopsis>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf<directivesynopsis>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf<description>Abort configuration parsing with a custom error message</description>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf<contextlist><context>server config</context><context>virtual host</context>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf</contextlist>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf <p>If an error can be detected within the configuration, this
e302f38fd646764ce1a1e1c578d794aef514a9e5sf directive can be used to generate a custom error message, and halt
e302f38fd646764ce1a1e1c578d794aef514a9e5sf configuration parsing. The typical use is for reporting required
e302f38fd646764ce1a1e1c578d794aef514a9e5sf modules which are missing from the configuration.</p>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf # ensure that mod_include is loaded<br />
e302f38fd646764ce1a1e1c578d794aef514a9e5sf <IfModule !include_module><br />
e302f38fd646764ce1a1e1c578d794aef514a9e5sf Error mod_include is required by mod_foo. Load it with LoadModule.<br />
e302f38fd646764ce1a1e1c578d794aef514a9e5sf </IfModule><br />
b5c4b00201fdc3ed11c6cc05cf3f9a7912ac0cfbsf # ensure that exactly one of SSL,NOSSL is defined<br />
e302f38fd646764ce1a1e1c578d794aef514a9e5sf <IfDefine SSL><br />
b5c4b00201fdc3ed11c6cc05cf3f9a7912ac0cfbsf <IfDefine NOSSL><br />
b5c4b00201fdc3ed11c6cc05cf3f9a7912ac0cfbsf Error Both SSL and NOSSL are defined. Define only one of them.<br />
e302f38fd646764ce1a1e1c578d794aef514a9e5sf </IfDefine><br />
e302f38fd646764ce1a1e1c578d794aef514a9e5sf </IfDefine><br />
b5c4b00201fdc3ed11c6cc05cf3f9a7912ac0cfbsf <IfDefine !SSL><br />
b5c4b00201fdc3ed11c6cc05cf3f9a7912ac0cfbsf <IfDefine !NOSSL><br />
b5c4b00201fdc3ed11c6cc05cf3f9a7912ac0cfbsf Error Either SSL or NOSSL must be defined.<br />
b5c4b00201fdc3ed11c6cc05cf3f9a7912ac0cfbsf </IfDefine><br />
b5c4b00201fdc3ed11c6cc05cf3f9a7912ac0cfbsf </IfDefine><br />
e302f38fd646764ce1a1e1c578d794aef514a9e5sf </example>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf</directivesynopsis>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf<directivesynopsis>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf<description>What the server will return to the client
e302f38fd646764ce1a1e1c578d794aef514a9e5sfin case of an error</description>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf<syntax>ErrorDocument <var>error-code</var> <var>document</var></syntax>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf<contextlist><context>server config</context><context>virtual host</context>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf</contextlist>
4497075b5e08b0c8ee89425a1758258ae80550fcsf <p>In the event of a problem or error, Apache httpd can be configured
4497075b5e08b0c8ee89425a1758258ae80550fcsf to do one of four things,</p>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf <li>redirect to a local <var>URL-path</var> to handle the
e302f38fd646764ce1a1e1c578d794aef514a9e5sf <p>The first option is the default, while options 2-4 are
e302f38fd646764ce1a1e1c578d794aef514a9e5sf configured using the <directive>ErrorDocument</directive>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf directive, which is followed by the HTTP response code and a URL
e302f38fd646764ce1a1e1c578d794aef514a9e5sf or a message. Apache httpd will sometimes offer additional information
e302f38fd646764ce1a1e1c578d794aef514a9e5sf <p>URLs can begin with a slash (/) for local web-paths (relative
e302f38fd646764ce1a1e1c578d794aef514a9e5sf to the <directive module="core">DocumentRoot</directive>), or be a
e302f38fd646764ce1a1e1c578d794aef514a9e5sf full URL which the client can resolve. Alternatively, a message
e302f38fd646764ce1a1e1c578d794aef514a9e5sf can be provided to be displayed by the browser. Examples:</p>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf ErrorDocument 500 http://foo.example.com/cgi-bin/tester<br />
e302f38fd646764ce1a1e1c578d794aef514a9e5sf ErrorDocument 403 "Sorry can't allow you access today"<br />
e302f38fd646764ce1a1e1c578d794aef514a9e5sf ErrorDocument 403 Forbidden!
e302f38fd646764ce1a1e1c578d794aef514a9e5sf </example>
4497075b5e08b0c8ee89425a1758258ae80550fcsf <p>Additionally, the special value <code>default</code> can be used
4497075b5e08b0c8ee89425a1758258ae80550fcsf to specify Apache httpd's simple hardcoded message. While not required
e302f38fd646764ce1a1e1c578d794aef514a9e5sf under normal circumstances, <code>default</code> will restore
e302f38fd646764ce1a1e1c578d794aef514a9e5sf Apache httpd's simple hardcoded message for configurations that would
e302f38fd646764ce1a1e1c578d794aef514a9e5sf otherwise inherit an existing <directive>ErrorDocument</directive>.</p>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf ErrorDocument 404 default<br />
e302f38fd646764ce1a1e1c578d794aef514a9e5sf </Directory>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf </example>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf <p>Note that when you specify an <directive>ErrorDocument</directive>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf that points to a remote URL (ie. anything with a method such as
e302f38fd646764ce1a1e1c578d794aef514a9e5sf <code>http</code> in front of it), Apache HTTP Server will send a redirect to the
9228509ac5da8374df4a5d50b7da139e7b31f8a3sf client to tell it where to find the document, even if the
9228509ac5da8374df4a5d50b7da139e7b31f8a3sf document ends up being on the same server. This has several
9228509ac5da8374df4a5d50b7da139e7b31f8a3sf implications, the most important being that the client will not
9228509ac5da8374df4a5d50b7da139e7b31f8a3sf receive the original error status code, but instead will
9228509ac5da8374df4a5d50b7da139e7b31f8a3sf receive a redirect status code. This in turn can confuse web
9228509ac5da8374df4a5d50b7da139e7b31f8a3sf robots and other clients which try to determine if a URL is
9228509ac5da8374df4a5d50b7da139e7b31f8a3sf valid using the status code. In addition, if you use a remote
9228509ac5da8374df4a5d50b7da139e7b31f8a3sf URL in an <code>ErrorDocument 401</code>, the client will not
9228509ac5da8374df4a5d50b7da139e7b31f8a3sf know to prompt the user for a password since it will not
e302f38fd646764ce1a1e1c578d794aef514a9e5sf receive the 401 status code. Therefore, <strong>if you use an
e302f38fd646764ce1a1e1c578d794aef514a9e5sf <code>ErrorDocument 401</code> directive then it must refer to a local
e302f38fd646764ce1a1e1c578d794aef514a9e5sf <p>Microsoft Internet Explorer (MSIE) will by default ignore
e302f38fd646764ce1a1e1c578d794aef514a9e5sf server-generated error messages when they are "too small" and substitute
e302f38fd646764ce1a1e1c578d794aef514a9e5sf its own "friendly" error messages. The size threshold varies depending on
e302f38fd646764ce1a1e1c578d794aef514a9e5sf the type of error, but in general, if you make your error document
e302f38fd646764ce1a1e1c578d794aef514a9e5sf greater than 512 bytes, then MSIE will show the server-generated
e302f38fd646764ce1a1e1c578d794aef514a9e5sf error rather than masking it. More information is available in
e302f38fd646764ce1a1e1c578d794aef514a9e5sf Microsoft Knowledge Base article <a
e302f38fd646764ce1a1e1c578d794aef514a9e5sf href="http://support.microsoft.com/default.aspx?scid=kb;en-us;Q294807"
e302f38fd646764ce1a1e1c578d794aef514a9e5sf <p>Although most error messages can be overriden, there are certain
e302f38fd646764ce1a1e1c578d794aef514a9e5sf circumstances where the internal messages are used regardless of the
b5c4b00201fdc3ed11c6cc05cf3f9a7912ac0cfbsf setting of <directive module="core">ErrorDocument</directive>. In
e302f38fd646764ce1a1e1c578d794aef514a9e5sf particular, if a malformed request is detected, normal request processing
e302f38fd646764ce1a1e1c578d794aef514a9e5sf will be immediately halted and the internal error message returned.
e302f38fd646764ce1a1e1c578d794aef514a9e5sf This is necessary to guard against security problems caused by
e302f38fd646764ce1a1e1c578d794aef514a9e5sf bad requests.</p>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf <p>If you are using mod_proxy, you may wish to enable
e302f38fd646764ce1a1e1c578d794aef514a9e5sf <directive module="mod_proxy">ProxyErrorOverride</directive> so that you can provide
e302f38fd646764ce1a1e1c578d794aef514a9e5sf custom error messages on behalf of your Origin servers. If you don't enable ProxyErrorOverride,
e302f38fd646764ce1a1e1c578d794aef514a9e5sf Apache httpd will not generate custom error documents for proxied content.</p>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf</directivesynopsis>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf<directivesynopsis>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf<description>Location where the server will log errors</description>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf<syntax> ErrorLog <var>file-path</var>|syslog[:<var>facility</var>]</syntax>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf<default>ErrorLog logs/error_log (Unix) ErrorLog logs/error.log (Windows and OS/2)</default>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf<contextlist><context>server config</context><context>virtual host</context>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf</contextlist>
a8ee031b2224ce5473826c9d4f603681589245fawrowe <p>The <directive>ErrorLog</directive> directive sets the name of
a8ee031b2224ce5473826c9d4f603681589245fawrowe the file to which the server will log any errors it encounters. If
a8ee031b2224ce5473826c9d4f603681589245fawrowe the <var>file-path</var> is not absolute then it is assumed to be
a8ee031b2224ce5473826c9d4f603681589245fawrowe relative to the <directive module="core">ServerRoot</directive>.</p>
a8ee031b2224ce5473826c9d4f603681589245fawrowe begins with a pipe character "<code>|</code>" then it is assumed to be a
a8ee031b2224ce5473826c9d4f603681589245fawrowe command to spawn to handle the error log.</p>
a8ee031b2224ce5473826c9d4f603681589245fawrowe <p>See the notes on <a href="/logs.html#piped">piped logs</a> for
a8ee031b2224ce5473826c9d4f603681589245fawrowe more information.</p>
a8ee031b2224ce5473826c9d4f603681589245fawrowe <p>Using <code>syslog</code> instead of a filename enables logging
a8ee031b2224ce5473826c9d4f603681589245fawrowe via syslogd(8) if the system supports it. The default is to use
a8ee031b2224ce5473826c9d4f603681589245fawrowe syslog facility <code>local7</code>, but you can override this by
a8ee031b2224ce5473826c9d4f603681589245fawrowe using the <code>syslog:<var>facility</var></code> syntax where
a8ee031b2224ce5473826c9d4f603681589245fawrowe <var>facility</var> can be one of the names usually documented in
02c86afa991026c4146423dc84bc126e57d28df6wrowe syslog(1). The facility is effectively global, and if it is changed
34b157732214cedcd129cd9fe7c4290757505d60minfrin in individual virtual hosts, the final facility specified affects the
34b157732214cedcd129cd9fe7c4290757505d60minfrin entire server.</p>
a8ee031b2224ce5473826c9d4f603681589245fawrowe ErrorLog syslog:user
003f0c9fda6664daf5092a0e42f65ede20098153slive href="/misc/security_tips.html#serverroot">security tips</a>
a5f060e0c74a44cb8896ae794c08f94f7c9a46a7covener document for details on why your security could be compromised
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd if the directory where log files are stored is writable by
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele 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
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive use forward slashes throughout the configuration files.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive module="core">LogLevel</directive></seealso>
fb77c505254b6e9c925e23e734463e87574f8f40kess<seealso><a href="/logs.html">Apache HTTP Server Log Files</a></seealso>
a5f060e0c74a44cb8896ae794c08f94f7c9a46a7covener</directivesynopsis>
c976a7c7d20f2be319b128dd7d0b1568da224c0arbowen<directivesynopsis>
fb77c505254b6e9c925e23e734463e87574f8f40kess<description>Format specification for error log entries</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax> ErrorLogFormat [connection|request] <var>format</var></syntax>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<contextlist><context>server config</context><context>virtual host</context>
530eba85dbd41b8a0fa5255d3648d1440199a661slive</contextlist>
530eba85dbd41b8a0fa5255d3648d1440199a661slive<compatibility>Available in Apache httpd 2.3.9 and later</compatibility>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p><directive>ErrorLogFormat</directive> allows to specify what
530eba85dbd41b8a0fa5255d3648d1440199a661slive supplementary information is logged in the error log in addition to the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive actual log message.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd ErrorLogFormat "[%t] [%l] [pid %P] %F: %E: [client %a] %M"
fb77c505254b6e9c925e23e734463e87574f8f40kess <p>Specifying <code>connection</code> or <code>request</code> as first
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive parameter allows to specify additional formats, causing additional
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd information to be logged when the first message is logged for a specific
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd connection or request, respectively. This additional information is only
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd logged once per connection/request. If a connection or request is processed
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd without causing any log message, the additional information is not logged
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd either.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>It can happen that some format string items do not produce output. For
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd example, the Referer header is only present if the log message is
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd associated to a request and the log message happens at a time when the
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd Referer header has already been read from the client. If no output is
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive produced, the default behavior is to delete everything from the preceeding
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive space character to the next space character. This means the log line is
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd implicitly divided into fields on non-whitespace to whitespace transitions.
0db981f8fdfb62c5149efa079f0369b73d472d04rpluem If a format string item does not produce output, the whole field is
0db981f8fdfb62c5149efa079f0369b73d472d04rpluem ommitted. For example, if the remote address <code>%a</code> in the log
0db981f8fdfb62c5149efa079f0369b73d472d04rpluem format <code>[%t] [%l] [%a] %M </code> is not available, the surrounding
0db981f8fdfb62c5149efa079f0369b73d472d04rpluem brackets are not logged either. Space characters can be escaped with a
0db981f8fdfb62c5149efa079f0369b73d472d04rpluem backslash to prevent them from delimiting a field. The combination '% '
0db981f8fdfb62c5149efa079f0369b73d472d04rpluem (percent space) is a zero-witdh field delimiter that does not produce any
0db981f8fdfb62c5149efa079f0369b73d472d04rpluem output.</p>
a5f060e0c74a44cb8896ae794c08f94f7c9a46a7covener <p>The above behavior can be changed by adding modifiers to the format
a5f060e0c74a44cb8896ae794c08f94f7c9a46a7covener string item. A <code>-</code> (minus) modifier causes a minus to be logged if the
a5f060e0c74a44cb8896ae794c08f94f7c9a46a7covener respective item does not produce any output. In once-per-connection/request
a5f060e0c74a44cb8896ae794c08f94f7c9a46a7covener formats, it is also possible to use the <code>+</code> (plus) modifier. If an
a5f060e0c74a44cb8896ae794c08f94f7c9a46a7covener item with the plus modifier does not produce any output, the whole line is
a5f060e0c74a44cb8896ae794c08f94f7c9a46a7covener ommitted.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>A number as modifier can be used to assign a log severity level to a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive format item. The item will only be logged if the severity of the log
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive message is not higher than the specified log severity level. The number can
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive range from 1 (alert) over 4 (warn) and 7 (debug) to 15 (trace8).</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>For example, here's what would happen if you added modifiers to
003f0c9fda6664daf5092a0e42f65ede20098153slive <columnspec><column width=".3"/><column width=".7"/></columnspec>
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess <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>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <td>Logs the <code>Referer</code> only if the log message severity
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive is higher than 4.</td>
fb77c505254b6e9c925e23e734463e87574f8f40kess <p>Some format string items accept additional parameters in braces.</p>
030108b1816bcda3d925df65357feabdce83bc94slive <columnspec><column width=".2"/><column width=".8"/></columnspec>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <tr><th>Format String</th> <th>Description</th></tr>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <td>Client IP address and port of the request</td></tr>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <td>Underlying peer IP address and port of the connection (see the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <td>Request environment variable <em>name</em></td></tr>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <td>Source file name and line number of the log call</td></tr>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <td>Number of keep-alive requests on this connection</td></tr>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <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
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen displayed by e.g. <code>top</code>; currently Linux only)</td></tr>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <td>The current time including micro-seconds</td></tr>
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding <td>The current time in compact ISO 8601 format, including
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <td>The canonical <directive module="core">ServerName</directive>
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding <td>The server name of the server serving the request according to the
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding <directive module="core" >UseCanonicalName</directive>
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding <tr><td><code>\ </code> (backslash space)</td>
7654193c1faf603feec999850322ad79e6c551bcnd <p>The log ID format <code>%L</code> produces a unique id for a connection
7654193c1faf603feec999850322ad79e6c551bcnd or request. This can be used to correlate which log lines belong to the
7654193c1faf603feec999850322ad79e6c551bcnd same connection or request, which request happens on which connection.
7654193c1faf603feec999850322ad79e6c551bcnd <module>mod_log_config</module>, to allow to correlate access log entries
7654193c1faf603feec999850322ad79e6c551bcnd with error log lines. If <module>mod_unique_id</module> is loaded, its
7654193c1faf603feec999850322ad79e6c551bcnd unique id will be used as log ID for requests.</p>
7654193c1faf603feec999850322ad79e6c551bcnd ErrorLogFormat "[%{u}t] [%-m:%l] [pid %P:tid %T] %7F: %E: [client\ %a]
7654193c1faf603feec999850322ad79e6c551bcnd %M% ,\ referer\ %{Referer}i"
7654193c1faf603feec999850322ad79e6c551bcnd </example>
439acee10571861c670c438038a62f90a08bf137covener [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
c3e2e664a67b1adb9b6a6b91ff161f4f562cecf6covener entirely because they are not defined.</p>
c3e2e664a67b1adb9b6a6b91ff161f4f562cecf6covener <example><title>Example (similar to the 2.2.x format)</title>
c3e2e664a67b1adb9b6a6b91ff161f4f562cecf6covener ErrorLogFormat "[%t] [%l] %7F: %E: [client\ %a]
c3e2e664a67b1adb9b6a6b91ff161f4f562cecf6covener %M% ,\ referer\ %{Referer}i"
c3e2e664a67b1adb9b6a6b91ff161f4f562cecf6covener <example><title>Advanced example with request/connection log IDs</title>
c3e2e664a67b1adb9b6a6b91ff161f4f562cecf6covener ErrorLogFormat "[%{uc}t] [%-m:%-l] [R:%L] [C:%{C}L] %7F: %E: %M"<br/>
c3e2e664a67b1adb9b6a6b91ff161f4f562cecf6covener ErrorLogFormat request "[%{uc}t] [R:%L] Request %k on C:%{c}L pid:%P tid:%T"<br/>
c3e2e664a67b1adb9b6a6b91ff161f4f562cecf6covener ErrorLogFormat request "[%{uc}t] [R:%L] UA:'%+{User-Agent}i'"<br/>
c3e2e664a67b1adb9b6a6b91ff161f4f562cecf6covener ErrorLogFormat request "[%{uc}t] [R:%L] Referer:'%+{Referer}i'"<br/>
c3e2e664a67b1adb9b6a6b91ff161f4f562cecf6covener ErrorLogFormat connection "[%{uc}t] [C:%{c}L] local\ %a remote\ %A"<br/>
c3e2e664a67b1adb9b6a6b91ff161f4f562cecf6covener<seealso><directive module="core">ErrorLog</directive></seealso>
c3e2e664a67b1adb9b6a6b91ff161f4f562cecf6covener<seealso><directive module="core">LogLevel</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><a href="/logs.html">Apache HTTP Server Log Files</a></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
fb77c505254b6e9c925e23e734463e87574f8f40kess<description>Keep track of extended status information for each
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliverequest</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context></contextlist>
fb77c505254b6e9c925e23e734463e87574f8f40kess <p>This option tracks additional data per worker about the
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess currently executing request, and a utilization summary; you
9b5e2c5e769dc678a1aca06df75c32022b2f1492trawick can see these variables during runtime by configuring
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <module>mod_status</module>. Note that other modules may
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive rely on this scoreboard.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This setting applies to the entire server, and cannot be
9ed9eaf871c58d281af02e76125ceadb5060afa5nd enabled or disabled on a virtualhost-by-virtualhost basis.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive The collection of extended status information can slow down
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the server. Also note that this setting cannot be changed
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive during a graceful restart.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Note that loading <module>mod_status</module> will change
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the default behavior to ExtendedStatus On, while other
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive third party modules may do the same. Such modules rely on
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive collecting detailed information about the state of all workers.
fb77c505254b6e9c925e23e734463e87574f8f40kess The default is changed by <module>mod_status</module> beginning
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive with version 2.3.6; the previous default was always Off.</p>
a1ef40892ffa2b44fc249423c5b6c42a74a84c68nd</directivesynopsis>
a1ef40892ffa2b44fc249423c5b6c42a74a84c68nd<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>File attributes used to create the ETag
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveHTTP response header for static files</description>
750d12c59545dbbac70390988de94f7e901b08f2niq<contextlist><context>server config</context><context>virtual host</context>
750d12c59545dbbac70390988de94f7e901b08f2niq</contextlist>
750d12c59545dbbac70390988de94f7e901b08f2niq<compatibility>The default used to be "INode MTime Size" in 2.3.14 and
750d12c59545dbbac70390988de94f7e901b08f2niqearlier.</compatibility>
750d12c59545dbbac70390988de94f7e901b08f2niq The <directive>FileETag</directive> directive configures the file
750d12c59545dbbac70390988de94f7e901b08f2niq attributes that are used to create the <code>ETag</code> (entity
750d12c59545dbbac70390988de94f7e901b08f2niq tag) response header field when the document is based on a static file.
750d12c59545dbbac70390988de94f7e901b08f2niq (The <code>ETag</code> value is used in cache management to save
750d12c59545dbbac70390988de94f7e901b08f2niq network bandwidth.) The
750d12c59545dbbac70390988de94f7e901b08f2niq <directive>FileETag</directive> directive allows you to choose
750d12c59545dbbac70390988de94f7e901b08f2niq which of these -- if any -- should be used. The recognized keywords are:
13fa73dcc1b52bc8b86ac7008ce81e8c94c1c7f2rbowen <dd>The file's i-node number will be included in the calculation</dd>
13fa73dcc1b52bc8b86ac7008ce81e8c94c1c7f2rbowen <dd>The date and time the file was last modified will be included</dd>
1a0ca5f6b566a5eb77d63f466fcf78fb388a4182igalic <dd>The number of bytes in the file will be included</dd>
1a0ca5f6b566a5eb77d63f466fcf78fb388a4182igalic <dd>All available fields will be used. This is equivalent to:
1a0ca5f6b566a5eb77d63f466fcf78fb388a4182igalic <dd>If a document is file-based, no <code>ETag</code> field will be
1a0ca5f6b566a5eb77d63f466fcf78fb388a4182igalic included in the response</dd>
750d12c59545dbbac70390988de94f7e901b08f2niq <p>The <code>INode</code>, <code>MTime</code>, and <code>Size</code>
94aba9caa9b2f7a0e95a55f51264c908b69470e2igalic keywords may be prefixed with either <code>+</code> or <code>-</code>,
94aba9caa9b2f7a0e95a55f51264c908b69470e2igalic which allow changes to be made to the default setting inherited
750d12c59545dbbac70390988de94f7e901b08f2niq from a broader scope. Any keyword appearing without such a prefix
750d12c59545dbbac70390988de94f7e901b08f2niq immediately and completely cancels the inherited setting.</p>
750d12c59545dbbac70390988de94f7e901b08f2niq <p>If a directory's configuration includes
750d12c59545dbbac70390988de94f7e901b08f2niq <code>FileETag INode MTime Size</code>, and a
750d12c59545dbbac70390988de94f7e901b08f2niq subdirectory's includes <code>FileETag -INode</code>,
750d12c59545dbbac70390988de94f7e901b08f2niq 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
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd enabled and use <module>mod_dav_fs</module> as a storage provider.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <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>,
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd since the response entity can change without a change of the INode, MTime, or Size
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd of the static file with embedded SSI directives.
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Contains directives that apply to matched
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivefilenames</description>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<syntax><Files <var>filename</var>> ... </Files></syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>The <directive type="section">Files</directive> directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive limits the scope of the enclosed directives by filename. It is comparable
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd to the <directive module="core" type="section">Directory</directive>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive and <directive module="core" type="section">Location</directive>
6e483e0b8aa3fa574288a7452221392a03e2b9a3noodl directives. It should be matched with a <code></Files></code>
6e483e0b8aa3fa574288a7452221392a03e2b9a3noodl directive. The directives given within this section will be applied to
6e483e0b8aa3fa574288a7452221392a03e2b9a3noodl any object with a basename (last component of filename) matching the
6e483e0b8aa3fa574288a7452221392a03e2b9a3noodl specified filename. <directive type="section">Files</directive>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive sections are processed in the order they appear in the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive configuration file, after the <directive module="core"
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>.htaccess</code> files are read, but before <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive type="section" module="core">Location</directive> sections. Note
130d299c4b2b15be45532a176604c71fdc7bea5bnd that <directive type="section">Files</directive> can be nested
130d299c4b2b15be45532a176604c71fdc7bea5bnd module="core">Directory</directive> sections to restrict the
130d299c4b2b15be45532a176604c71fdc7bea5bnd portion of the filesystem they apply to.</p>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <p>The <var>filename</var> argument should include a filename, or
a00429a6b3b4dbb113b6dc67cfc0507f610276e9takashi a wild-card string, where <code>?</code> matches any single character,
a00429a6b3b4dbb113b6dc67cfc0507f610276e9takashi and <code>*</code> matches any sequences of characters.
955d7fc3e7adb6463b7243e15c04e858718e799etakashi <glossary ref="regex">Regular expressions</glossary>
955d7fc3e7adb6463b7243e15c04e858718e799etakashi can also be used, with the addition of the
955d7fc3e7adb6463b7243e15c04e858718e799etakashi <Files ~ "\.(gif|jpe?g|png)$">
955d7fc3e7adb6463b7243e15c04e858718e799etakashi <p>would match most common Internet graphics formats. <directive
955d7fc3e7adb6463b7243e15c04e858718e799etakashi module="core" type="section">FilesMatch</directive> is preferred,
78f97ce162b66a0dbfd7af4dcd9984f162569b04minfrin however.</p>
955d7fc3e7adb6463b7243e15c04e858718e799etakashi module="core">Directory</directive> and <directive type="section"
955d7fc3e7adb6463b7243e15c04e858718e799etakashi module="core">Location</directive> sections, <directive
130d299c4b2b15be45532a176604c71fdc7bea5bnd type="section">Files</directive> sections can be used inside
130d299c4b2b15be45532a176604c71fdc7bea5bnd <code>.htaccess</code> files. This allows users to control access to
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd 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
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive different sections are combined when a request is received</seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Contains directives that apply to regular-expression matched
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivefilenames</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax><FilesMatch <var>regex</var>> ... </FilesMatch></syntax>
003f0c9fda6664daf5092a0e42f65ede20098153slive<contextlist><context>server config</context><context>virtual host</context>
55d36f9b61520c2374ab463e77e8a62daa416398nd</contextlist>
fb77c505254b6e9c925e23e734463e87574f8f40kess <p>The <directive type="section">FilesMatch</directive> directive
fb77c505254b6e9c925e23e734463e87574f8f40kess limits the scope of the enclosed directives by filename, just as the
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <directive module="core" type="section">Files</directive> directive
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd does. However, it accepts a <glossary ref="regex">regular
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <FilesMatch "\.(gif|jpe?g|png)$">
55d36f9b61520c2374ab463e77e8a62daa416398nd <p>would match most common Internet graphics formats.</p>
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>
55d36f9b61520c2374ab463e77e8a62daa416398nd</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
55d36f9b61520c2374ab463e77e8a62daa416398nd<description>Forces all matching files to be served with the specified
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cndmedia type in the HTTP Content-Type header field</description>
55d36f9b61520c2374ab463e77e8a62daa416398nd<contextlist><context>directory</context><context>.htaccess</context>
55d36f9b61520c2374ab463e77e8a62daa416398nd</contextlist>
55d36f9b61520c2374ab463e77e8a62daa416398nd<compatibility>Moved to the core in Apache httpd 2.0</compatibility>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>When placed into an <code>.htaccess</code> file or a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive type="section" module="core">Directory</directive>, or
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive type="section" module="core">Location</directive> or
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive type="section" module="core">Files</directive>
bea526116133aa3d7dabd1924bfc580b37fbf22aslive section, this directive forces all matching files to be served
bea526116133aa3d7dabd1924bfc580b37fbf22aslive with the content type identification given by
bea526116133aa3d7dabd1924bfc580b37fbf22aslive <var>media-type</var>. For example, if you had a directory full of
fb77c505254b6e9c925e23e734463e87574f8f40kess GIF files, but did not want to label them all with <code>.gif</code>,
bea526116133aa3d7dabd1924bfc580b37fbf22aslive you might want to use:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Note that this directive overrides other indirect media type
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive associations defined in mime.types or via the
003f0c9fda6664daf5092a0e42f65ede20098153slive <p>You can also override more general
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <Location /images><br />
5b258a8d58679c6587757189339bb3c2d0488f93poirier </Location><br />
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin # but normal mime-type associations here:<br />
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin ForceType None<br />
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin </Location>
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin <p>This directive primarily overrides the content types generated for
3621f3acee323a877639a96d84891095eb07933aminfrin static files served out of the filesystem. For resources other than
3621f3acee323a877639a96d84891095eb07933aminfrin static files, where the generator of the response typically specifies
3621f3acee323a877639a96d84891095eb07933aminfrin a Content-Type, this directive has no effect.</p>
3621f3acee323a877639a96d84891095eb07933aminfrin</directivesynopsis>
3621f3acee323a877639a96d84891095eb07933aminfrin<directivesynopsis>
3621f3acee323a877639a96d84891095eb07933aminfrin<description>Directory to write gmon.out profiling data to. </description>
3621f3acee323a877639a96d84891095eb07933aminfrin<syntax>GprofDir <var>/tmp/gprof/</var>|<var>/tmp/gprof/</var>%</syntax>
3621f3acee323a877639a96d84891095eb07933aminfrin<contextlist><context>server config</context><context>virtual host</context>
3621f3acee323a877639a96d84891095eb07933aminfrin</contextlist>
3621f3acee323a877639a96d84891095eb07933aminfrin <p>When the server has been compiled with gprof profiling suppport,
3621f3acee323a877639a96d84891095eb07933aminfrin <directive>GprofDir</directive> causes <code>gmon.out</code> files to
3621f3acee323a877639a96d84891095eb07933aminfrin be written to the specified directory when the process exits. If the
3621f3acee323a877639a96d84891095eb07933aminfrin argument ends with a percent symbol ('%'), subdirectories are created
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin for each process id.</p>
3621f3acee323a877639a96d84891095eb07933aminfrin <p>This directive currently only works with the <module>prefork</module>
c68acc9d712af079afa2bd1a5a4aeef9a3ea573ckess</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<description>Enables DNS lookups on client IP addresses</description>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<contextlist><context>server config</context><context>virtual host</context>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>This directive enables DNS lookups so that host names can be
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd logged (and passed to CGIs/SSIs in <code>REMOTE_HOST</code>).
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd The value <code>Double</code> refers to doing double-reverse
7b5535ed88e0f561b3bfb3330137bd804846afd4slive DNS lookup. That is, after a reverse lookup is performed, a forward
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd lookup is then performed on that result. At least one of the IP
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin addresses in the forward lookup must match the original
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin address. (In "tcpwrappers" terminology this is called
3621f3acee323a877639a96d84891095eb07933aminfrin <p>Regardless of the setting, when <module>mod_authz_host</module> is
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin used for controlling access by hostname, a double reverse lookup
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin will be performed. This is necessary for security. Note that the
3621f3acee323a877639a96d84891095eb07933aminfrin result of this double-reverse isn't generally available unless you
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin set <code>HostnameLookups Double</code>. For example, if only
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin <code>HostnameLookups On</code> and a request is made to an object
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin that is protected by hostname restrictions, regardless of whether
3621f3acee323a877639a96d84891095eb07933aminfrin the double-reverse fails or not, CGIs will still be passed the
3621f3acee323a877639a96d84891095eb07933aminfrin single-reverse result in <code>REMOTE_HOST</code>.</p>
3621f3acee323a877639a96d84891095eb07933aminfrin <p>The default is <code>Off</code> in order to save the network
3621f3acee323a877639a96d84891095eb07933aminfrin traffic for those sites that don't truly need the reverse
3621f3acee323a877639a96d84891095eb07933aminfrin lookups done. It is also better for the end users because they
3621f3acee323a877639a96d84891095eb07933aminfrin don't have to suffer the extra latency that a lookup entails.
3621f3acee323a877639a96d84891095eb07933aminfrin Heavily loaded sites should leave this directive
3621f3acee323a877639a96d84891095eb07933aminfrin <code>Off</code>, since DNS lookups can take considerable
03aa31ad82759363ba1a55589e517b16308ef635minfrin amounts of time. The utility <program>logresolve</program>, compiled by
3621f3acee323a877639a96d84891095eb07933aminfrin default to the <code>bin</code> subdirectory of your installation
3621f3acee323a877639a96d84891095eb07933aminfrin directory, can be used to look up host names from logged IP addresses
3621f3acee323a877639a96d84891095eb07933aminfrin offline.</p>
03aa31ad82759363ba1a55589e517b16308ef635minfrin href="mod_authz_host.html#reqhost">hostname-based Require
03aa31ad82759363ba1a55589e517b16308ef635minfrin directives</a>, a hostname lookup will be performed regardless of
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Contains directives that apply only if a condition is
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabelesatisfied by a request at runtime</description>
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele<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.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive For example:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <If "-z req('Host')">
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>would match HTTP/1.0 requests without a <var>Host:</var> header.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Expressions may contain various shell-like operators for string
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive comparison (<code>=</code>, <code>!=</code>, <code><</code>, ...),
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive integer comparison (<code>-eq</code>, <code>-ne</code>, ...),
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive and others (<code>-n</code>, <code>-z</code>, <code>-f</code>, ...).
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive It is also possible to use regular expressions, </p>
59368b594c9b09b59ae58c7de26d2d5ce1c99a29takashi <If "%{QUERY_STRING} =~ /(delete|commit)=.*?elem/">
be192cefa381d5bae6868034687471754cb43175sf </example>
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
98f5034c8cbf2ef025b317b3e01acae82e143b11trawick<seealso><a href="/expr.html">Expressions in Apache HTTP Server</a>,
9f38f3ec3e8087985d108a24ae796962fef83644takashifor a complete reference and more examples.</seealso>
98f5034c8cbf2ef025b317b3e01acae82e143b11trawick<seealso><directive type="section" module="core">ElseIf</directive></seealso>
98f5034c8cbf2ef025b317b3e01acae82e143b11trawick<seealso><directive type="section" module="core">Else</directive></seealso>
98f5034c8cbf2ef025b317b3e01acae82e143b11trawick<seealso><a href="/sections.html">How <Directory>, <Location>,
9f38f3ec3e8087985d108a24ae796962fef83644takashi <Files> sections work</a> for an explanation of how these
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen different sections are combined when a request is received.
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen <directive type="section">Else</directive> are applied last.</seealso>
9f38f3ec3e8087985d108a24ae796962fef83644takashi</directivesynopsis>
98f5034c8cbf2ef025b317b3e01acae82e143b11trawick<description>Encloses directives that will be processed only
98f5034c8cbf2ef025b317b3e01acae82e143b11trawickif a test is true at startup</description>
98f5034c8cbf2ef025b317b3e01acae82e143b11trawick<syntax><IfDefine [!]<var>parameter-name</var>> ...
98f5034c8cbf2ef025b317b3e01acae82e143b11trawick </IfDefine></syntax>
98f5034c8cbf2ef025b317b3e01acae82e143b11trawick<contextlist><context>server config</context><context>virtual host</context>
c6f90ef0e93c077924fd0c3c0200dba0cb1777c6takashi<context>directory</context><context>.htaccess</context>
85349f40d98fb3fc7a18ef25dc40eaaae6eead1ctakashi</contextlist>
98f5034c8cbf2ef025b317b3e01acae82e143b11trawick <p>The <code><IfDefine <var>test</var>>...</IfDefine>
98f5034c8cbf2ef025b317b3e01acae82e143b11trawick </code> section is used to mark directives that are conditional. The
98f5034c8cbf2ef025b317b3e01acae82e143b11trawick directives within an <directive type="section">IfDefine</directive>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive section are only processed if the <var>test</var> is true. If <var>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive test</var> is false, everything between the start and end markers is
003f0c9fda6664daf5092a0e42f65ede20098153slive ignored.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive >IfDefine</directive> section directive can be one of two forms:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>In the former case, the directives between the start and end
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive markers are only processed if the parameter named
130d299c4b2b15be45532a176604c71fdc7bea5bnd <var>parameter-name</var> is defined. The second format reverses
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the test, and only processes the directives if
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <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>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess </code> at the time the server was started or by the <directive
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <p><directive type="section">IfDefine</directive> sections are
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive nest-able, which can be used to implement simple
130d299c4b2b15be45532a176604c71fdc7bea5bnd multiple-parameter tests. Example:</p>
130d299c4b2b15be45532a176604c71fdc7bea5bnd httpd -DReverseProxy -DUseCache -DMemCache ...<br />
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <IfDefine ReverseProxy><br />
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd LoadModule proxy_http_module modules/mod_proxy_http.so<br />
6c5c651b0b97607b8c8b4965c1385c67699f217fnd <IfDefine UseCache><br />
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <IfDefine MemCache><br />
6c5c651b0b97607b8c8b4965c1385c67699f217fnd LoadModule mem_cache_module modules/mod_mem_cache.so<br />
750d12c59545dbbac70390988de94f7e901b08f2niq </IfDefine><br />
4bb78e7cdd53f50240cff4ad7a97c7ed36483797slive <IfDefine !MemCache><br />
4bb78e7cdd53f50240cff4ad7a97c7ed36483797slive LoadModule cache_disk_module modules/mod_cache_disk.so<br />
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd </IfDefine>
4bb78e7cdd53f50240cff4ad7a97c7ed36483797slive </IfDefine>
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd </IfDefine>
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd</directivesynopsis>
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd<description>Encloses directives that are processed conditional on the
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisdpresence or absence of a specific module</description>
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd<syntax><IfModule [!]<var>module-file</var>|<var>module-identifier</var>> ...
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd </IfModule></syntax>
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd<contextlist><context>server config</context><context>virtual host</context>
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd<context>directory</context><context>.htaccess</context>
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd</contextlist>
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd<compatibility>Module identifiers are available in version 2.1 and
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisdlater.</compatibility>
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd <p>The <code><IfModule <var>test</var>>...</IfModule></code>
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd section is used to mark directives that are conditional on the presence of
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd a specific module. The directives within an <directive type="section"
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd >IfModule</directive> section are only processed if the <var>test</var>
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd is true. If <var>test</var> is false, everything between the start and
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd end markers is ignored.</p>
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd <p>The <var>test</var> in the <directive type="section"
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd >IfModule</directive> section directive can be one of two forms:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>In the former case, the directives between the start and end
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive markers are only processed if the module named <var>module</var>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive is included in Apache httpd -- either compiled in or
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd >LoadModule</directive>. The second format reverses the test,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive and only processes the directives if <var>module</var> is
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd <p>The <var>module</var> argument can be either the module identifier or
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the file name of the module, at the time it was compiled. For example,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>mod_rewrite.c</code> is the file name. If a module consists of
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen several source files, use the name of the file containing the string
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen <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
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen configuration file that works whether or not a specific module
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen is available. In normal operation, directives need not be
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen placed in <directive type="section">IfModule</directive>
130d299c4b2b15be45532a176604c71fdc7bea5bnd sections.</note>
130d299c4b2b15be45532a176604c71fdc7bea5bnd</directivesynopsis>
130d299c4b2b15be45532a176604c71fdc7bea5bnd<directivesynopsis>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen<description>Includes other configuration files from within
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowenthe server configuration files</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>Include <var>file-path</var>|<var>directory-path</var>|<var>wildcard</var></syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
03e0a375c2435102fb2b51e34cccff52acbfddcdnd</contextlist>
03e0a375c2435102fb2b51e34cccff52acbfddcdnd<compatibility>Wildcard matching available in 2.0.41 and later, directory
03e0a375c2435102fb2b51e34cccff52acbfddcdndwildcard matching available in 2.3.6 and later</compatibility>
03e0a375c2435102fb2b51e34cccff52acbfddcdnd <p>This directive allows inclusion of other configuration files
03e0a375c2435102fb2b51e34cccff52acbfddcdnd from within the server configuration files.</p>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen <p>Shell-style (<code>fnmatch()</code>) wildcard characters can be used
03e0a375c2435102fb2b51e34cccff52acbfddcdnd in the filename or directory parts of the path to include several files
03e0a375c2435102fb2b51e34cccff52acbfddcdnd at once, in alphabetical order. In addition, if
03e0a375c2435102fb2b51e34cccff52acbfddcdnd <directive>Include</directive> points to a directory, rather than a file,
03e0a375c2435102fb2b51e34cccff52acbfddcdnd Apache httpd will read all files in that directory and any subdirectory.
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen However, including entire directories is not recommended, because it is
03e0a375c2435102fb2b51e34cccff52acbfddcdnd easy to accidentally leave temporary files in a directory that can cause
03e0a375c2435102fb2b51e34cccff52acbfddcdnd <program>httpd</program> to fail. Instead, we encourage you to use the
03e0a375c2435102fb2b51e34cccff52acbfddcdnd wildcard syntax shown below, to include files that match a particular
03e0a375c2435102fb2b51e34cccff52acbfddcdnd pattern, such as *.conf, for example.</p>
03e0a375c2435102fb2b51e34cccff52acbfddcdnd <p>The <directive module="core">Include</directive> directive will
03e0a375c2435102fb2b51e34cccff52acbfddcdnd <strong>fail with an error</strong> if a wildcard expression does not
03e0a375c2435102fb2b51e34cccff52acbfddcdnd match any file. The <directive module="core">IncludeOptional</directive>
03e0a375c2435102fb2b51e34cccff52acbfddcdnd directive can be used if non-matching wildcards should be ignored.</p>
03e0a375c2435102fb2b51e34cccff52acbfddcdnd <p>The file path specified may be an absolute path, or may be relative
03e0a375c2435102fb2b51e34cccff52acbfddcdnd to the <directive module="core">ServerRoot</directive> directory.</p>
03e0a375c2435102fb2b51e34cccff52acbfddcdnd </example>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Wildcards may be included in the directory or file portion of the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive path. This example will fail if there is no subdirectory in conf/vhosts
003f0c9fda6664daf5092a0e42f65ede20098153slive that contains at least one *.conf file:</p>
6fad623c3cc52b4a84d4d36538f6eed886f49f98covener <p>Alternatively, the following command will just be ignored in case of
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive missing files or directories:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive module="core">IncludeOptional</directive></seealso>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess</directivesynopsis>
fb77c505254b6e9c925e23e734463e87574f8f40kess<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Includes other configuration files from within
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivethe server configuration files</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>IncludeOptional <var>file-path</var>|<var>directory-path</var>|<var>wildcard</var></syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen</contextlist>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<compatibility>Available in 2.3.6 and later</compatibility>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen <p>This directive allows inclusion of other configuration files
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd from within the server configuration files. It works identically to the
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen <directive module="core">Include</directive> directive, with the
6fad623c3cc52b4a84d4d36538f6eed886f49f98covener exception that if wildcards do not match any file or directory, the
6fad623c3cc52b4a84d4d36538f6eed886f49f98covener <directive module="core">IncludeOptional</directive> directive will be
6fad623c3cc52b4a84d4d36538f6eed886f49f98covener silently ignored instead of causing an error.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive module="core">Include</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Enables HTTP persistent connections</description>
e0ef044feba0082771091af42798cada5bb1f4fcrbowen<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The Keep-Alive extension to HTTP/1.0 and the persistent
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive 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
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive 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
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive addition, a Keep-Alive connection with an HTTP/1.0 client can
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive only be used when the length of the content is known in
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive advance. This implies that dynamic content such as CGI output,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive SSI pages, and server-generated directory listings will
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive generally not use Keep-Alive connections to HTTP/1.0 clients.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive For HTTP/1.1 clients, persistent connections are the default
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive unless otherwise specified. If the client requests it, chunked
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive encoding will be used in order to send content of unknown
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive length over persistent connections.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>When a client uses a Keep-Alive connection it will be counted
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen as a single "request" for the <directive module="mpm_common"
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen >MaxConnectionsPerChild</directive> directive, regardless
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen of how many requests are sent using the connection.</p>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen<seealso><directive module="core">MaxKeepAliveRequests</directive></seealso>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen</directivesynopsis>
2f505ba07f89ba6a175d6ceae67fb273c4eb0993covener<directivesynopsis>
611f7fd8a0a5ee4a29eeed79dfd8bf6faaa3c613covener<description>Amount of time the server will wait for subsequent
611f7fd8a0a5ee4a29eeed79dfd8bf6faaa3c613covenerrequests on a persistent connection</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<compatibility>Specifying a value in milliseconds is available in
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveApache httpd 2.3.2 and later</compatibility>
ae134ecc8faf4e6a8eb68e1c3724506771442a46rbowen <p>The number of seconds Apache httpd will wait for a subsequent
ae134ecc8faf4e6a8eb68e1c3724506771442a46rbowen request before closing the connection. By adding a postfix of ms the
e0ef044feba0082771091af42798cada5bb1f4fcrbowen timeout can be also set in milliseconds. Once a request has been
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive received, the timeout value specified by the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive module="core">Timeout</directive> directive applies.</p>
72580dbc2a55511f13f377063725b9f143b20826stoddard <p>Setting <directive>KeepAliveTimeout</directive> to a high value
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive may cause performance problems in heavily loaded servers. The
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess higher the timeout, the more server processes will be kept
72580dbc2a55511f13f377063725b9f143b20826stoddard occupied waiting on connections with idle clients.</p>
72580dbc2a55511f13f377063725b9f143b20826stoddard <p>In a name-based virtual host context, the value of the first
72580dbc2a55511f13f377063725b9f143b20826stoddard defined virtual host best matching the local IP and port will be used.</p>
72580dbc2a55511f13f377063725b9f143b20826stoddard</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Restrict enclosed access controls to only certain HTTP
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivemethods</description>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen<syntax><Limit <var>method</var> [<var>method</var>] ... > ...
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen </Limit></syntax>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen<contextlist><context>directory</context><context>.htaccess</context>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen</contextlist>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen <p>Access controls are normally effective for
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen <strong>all</strong> access methods, and this is the usual
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen desired behavior. <strong>In the general case, access control
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen directives should not be placed within a
2f505ba07f89ba6a175d6ceae67fb273c4eb0993covener <directive type="section">Limit</directive> section.</strong></p>
611f7fd8a0a5ee4a29eeed79dfd8bf6faaa3c613covener <p>The purpose of the <directive type="section">Limit</directive>
611f7fd8a0a5ee4a29eeed79dfd8bf6faaa3c613covener directive is to restrict the effect of the access controls to the
611f7fd8a0a5ee4a29eeed79dfd8bf6faaa3c613covener nominated HTTP methods. For all other methods, the access
611f7fd8a0a5ee4a29eeed79dfd8bf6faaa3c613covener 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>
72580dbc2a55511f13f377063725b9f143b20826stoddard <p>The method names listed can be one or more of: <code>GET</code>,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>POST</code>, <code>PUT</code>, <code>DELETE</code>,
72580dbc2a55511f13f377063725b9f143b20826stoddard <code>PATCH</code>, <code>PROPFIND</code>, <code>PROPPATCH</code>,
72580dbc2a55511f13f377063725b9f143b20826stoddard <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>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen section when restricting access, since a <directive type="section"
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen module="core">LimitExcept</directive> section provides protection
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen against arbitrary methods.</note>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen <p>The <directive type="section">Limit</directive> and
ef8e89e090461194ecadd31e8796a2c51e0531a2kess <directive type="section" module="core">LimitExcept</directive>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen directives may be nested. In this case, each successive level of
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen <directive type="section">Limit</directive> or <directive
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen type="section" module="core">LimitExcept</directive> directives must
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen further restrict the set of methods to which access controls apply.</p>
611f7fd8a0a5ee4a29eeed79dfd8bf6faaa3c613covener <directive type="section">LimitExcept</directive> directives with
611f7fd8a0a5ee4a29eeed79dfd8bf6faaa3c613covener the <directive module="mod_authz_core">Require</directive> directive,
611f7fd8a0a5ee4a29eeed79dfd8bf6faaa3c613covener note that the first <directive module="mod_authz_core">Require</directive>
611f7fd8a0a5ee4a29eeed79dfd8bf6faaa3c613covener 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
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>Require group editors</code> directive will be ignored
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive in all cases:</p>
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele <LimitExcept GET>
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele Require valid-user
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </LimitExcept><br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <Limit POST>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen Require group editors
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen </Limit>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Restrict access controls to all HTTP methods
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveexcept the named ones</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax><LimitExcept <var>method</var> [<var>method</var>] ... > ...
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </LimitExcept></syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>directory</context><context>.htaccess</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p><directive type="section">LimitExcept</directive> and
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive a group of access control directives which will then apply to any
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess HTTP access method <strong>not</strong> listed in the arguments;
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive i.e., it is the opposite of a <directive type="section"
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="core">Limit</directive> section and can be used to control
7852e17fb37b2a02ccdcab107f2c7f5fd41fd201nd both standard and nonstandard/unrecognized methods. See the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive type="section">Limit</directive> for more details.</p>
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive <LimitExcept POST GET><br />
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive Require valid-user<br />
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive </LimitExcept>
d950cf9262224a223e2ff5c51393708071e14b94covener</directivesynopsis>
d950cf9262224a223e2ff5c51393708071e14b94covener<directivesynopsis>
d950cf9262224a223e2ff5c51393708071e14b94covener<description>Determine maximum number of internal redirects and nested
d950cf9262224a223e2ff5c51393708071e14b94covenersubrequests</description>
d950cf9262224a223e2ff5c51393708071e14b94covener<syntax>LimitInternalRecursion <var>number</var> [<var>number</var>]</syntax>
d950cf9262224a223e2ff5c51393708071e14b94covener<contextlist><context>server config</context><context>virtual host</context>
d950cf9262224a223e2ff5c51393708071e14b94covener</contextlist>
d950cf9262224a223e2ff5c51393708071e14b94covener<compatibility>Available in Apache httpd 2.0.47 and later</compatibility>
d950cf9262224a223e2ff5c51393708071e14b94covener <p>An internal redirect happens, for example, when using the <directive
d950cf9262224a223e2ff5c51393708071e14b94covener module="mod_actions">Action</directive> directive, which internally
d950cf9262224a223e2ff5c51393708071e14b94covener redirects the original request to a CGI script. A subrequest is Apache httpd's
e4e60c2f7ba8f12b687f588b89e413842e9f2d76igalic mechanism to find out what would happen for some URI if it were requested.
d950cf9262224a223e2ff5c51393708071e14b94covener For example, <module>mod_dir</module> uses subrequests to look for the
d950cf9262224a223e2ff5c51393708071e14b94covener files listed in the <directive module="mod_dir">DirectoryIndex</directive>
d950cf9262224a223e2ff5c51393708071e14b94covener directive.</p>
e4e60c2f7ba8f12b687f588b89e413842e9f2d76igalic <p><directive>LimitInternalRecursion</directive> prevents the server
d950cf9262224a223e2ff5c51393708071e14b94covener from crashing when entering an infinite loop of internal redirects or
d950cf9262224a223e2ff5c51393708071e14b94covener subrequests. Such loops are usually caused by misconfigurations.</p>
e4e60c2f7ba8f12b687f588b89e413842e9f2d76igalic <p>The directive stores two different limits, which are evaluated on
d950cf9262224a223e2ff5c51393708071e14b94covener per-request basis. The first <var>number</var> is the maximum number of
d950cf9262224a223e2ff5c51393708071e14b94covener internal redirects, that may follow each other. The second <var>number</var>
d950cf9262224a223e2ff5c51393708071e14b94covener determines, how deep subrequests may be nested. If you specify only one
d950cf9262224a223e2ff5c51393708071e14b94covener <var>number</var>, it will be assigned to both limits.</p>
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive LimitInternalRecursion 5
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive</directivesynopsis>
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive<directivesynopsis>
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive<description>Restricts the total size of the HTTP request body sent
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slivefrom the client</description>
dc223428958ad9ff05011545bcdda000887b93e5slive<contextlist><context>server config</context><context>virtual host</context>
beb923bec9bff2b49ce5027df2fe944e2b74e28brederpj<context>directory</context><context>.htaccess</context>
beb923bec9bff2b49ce5027df2fe944e2b74e28brederpj</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This directive specifies the number of <var>bytes</var> from 0
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess (meaning unlimited) to 2147483647 (2GB) that are allowed in a
fb77c505254b6e9c925e23e734463e87574f8f40kess request body. See the note below for the limited applicability
d8c44cd75cf575fe51319280c12445109e878523noodl to proxy requests.</p>
030108b1816bcda3d925df65357feabdce83bc94slive <p>The <directive>LimitRequestBody</directive> directive allows
37742b630743e470b94618ecb3560fbd82e50b59rbowen the user to set a limit on the allowed size of an HTTP request
37742b630743e470b94618ecb3560fbd82e50b59rbowen message body within the context in which the directive is given
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd (server, per-directory, per-file or per-location). If the client
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd request exceeds that limit, the server will return an error
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd response instead of servicing the request. The size of a normal
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd request message body will vary greatly depending on the nature of
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the resource and the methods allowed on that resource. CGI scripts
fb77c505254b6e9c925e23e734463e87574f8f40kess typically use the message body for retrieving form information.
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess Implementations of the <code>PUT</code> method will require
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess a value at least as large as any representation that the server
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess wishes to accept for that resource.</p>
37742b630743e470b94618ecb3560fbd82e50b59rbowen <p>This directive gives the server administrator greater
37742b630743e470b94618ecb3560fbd82e50b59rbowen 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,
e8811b6d38f756b325446ded5d96857d13856511takashi you might use the following directive:</p>
130d299c4b2b15be45532a176604c71fdc7bea5bnd LimitRequestBody 102400
130d299c4b2b15be45532a176604c71fdc7bea5bnd </example>
ca908c21f63a71c5efa7d32bd2cfafe9a42ba1fbrbowen <note><p>For a full description of how this directive is interpreted by
130d299c4b2b15be45532a176604c71fdc7bea5bnd proxy requests, see the <module>mod_proxy</module> documentation.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd</directivesynopsis>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<directivesynopsis>
05201775eaa6b363b8a119c8aea5db246b967591yoshiki<description>Limits the number of HTTP request header fields that
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cndwill be accepted from the client</description>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<contextlist><context>server config</context><context>virtual host</context></contextlist>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p><var>Number</var> is an integer from 0 (meaning unlimited) to
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd 32767. The default value is defined by the compile-time
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd constant <code>DEFAULT_LIMIT_REQUEST_FIELDS</code> (100 as
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd distributed).</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>The <directive>LimitRequestFields</directive> directive allows
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd the server administrator to modify the limit on the number of
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd request header fields allowed in an HTTP request. A server needs
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd this value to be larger than the number of fields that a normal
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd client request might include. The number of request header fields
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive used by a client rarely exceeds 20, but this may vary among
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess different client implementations, often depending upon the extent
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess to which a user has configured their browser to support detailed
37742b630743e470b94618ecb3560fbd82e50b59rbowen content negotiation. Optional HTTP extensions are often expressed
37742b630743e470b94618ecb3560fbd82e50b59rbowen using request header fields.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This directive gives the server administrator greater
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive control over abnormal client request behavior, which may be
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive useful for avoiding some forms of denial-of-service attacks.
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess The value should be increased if normal clients see an error
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive response from the server that indicates too many fields were
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive sent in the request.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive LimitRequestFields 50
030108b1816bcda3d925df65357feabdce83bc94slive <p> When name-based virtual hosting is used, the value for this
030108b1816bcda3d925df65357feabdce83bc94slive directive is taken from the default (first-listed) virtual host for the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive local IP and port combination</p>.
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd</directivesynopsis>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Limits the size of the HTTP request header allowed from the
313bb560bc5c323cfd40c9cad7335b4b8e060aedkessclient</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context></contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This directive specifies the number of <var>bytes</var>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive that will be allowed in an HTTP request header.</p>
7fbd7281d06cec1918aa370214df77c572f871a9sf <p>The <directive>LimitRequestFieldSize</directive> directive
7fbd7281d06cec1918aa370214df77c572f871a9sf allows the server administrator to set the limit
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive on the allowed size of an HTTP request header field. A server
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive needs this value to be large enough to hold any one header field
7fbd7281d06cec1918aa370214df77c572f871a9sf from a normal client request. The size of a normal request header
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive field will vary greatly among different client implementations,
7fbd7281d06cec1918aa370214df77c572f871a9sf often depending upon the extent to which a user has configured
7fbd7281d06cec1918aa370214df77c572f871a9sf their browser to support detailed content negotiation. SPNEGO
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive authentication headers can be up to 12392 bytes.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This directive gives the server administrator greater
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive control over abnormal client request behavior, which may be
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive useful for avoiding some forms of denial-of-service attacks.</p>
1597043cec6ad37fa4154bf09b0fccdabed1a239slive LimitRequestFieldSize 4094
530eba85dbd41b8a0fa5255d3648d1440199a661slive <note>Under normal conditions, the value should not be changed from
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the default. Also, you can't set this higher than 8190 without
530eba85dbd41b8a0fa5255d3648d1440199a661slive modifying the source code and rebuilding.</note>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p> When name-based virtual hosting is used, the value for this
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directive is taken from the default (first-listed) virtual host best
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive matching the current IP address and port combination.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Limit the size of the HTTP request line that will be accepted
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivefrom the client</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context></contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This directive sets the number of <var>bytes</var> that will be
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive allowed on the HTTP request-line.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <directive>LimitRequestLine</directive> directive allows
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the server administrator to set the limit on the allowed size
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive of a client's HTTP request-line. Since the request-line consists of the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive HTTP method, URI, and protocol version, the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive>LimitRequestLine</directive> directive places a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive restriction on the length of a request-URI allowed for a request
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive on the server. A server needs this value to be large enough to
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive hold any of its resource names, including any information that
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive might be passed in the query part of a <code>GET</code> request.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This directive gives the server administrator greater
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive control over abnormal client request behavior, which may be
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive useful for avoiding some forms of denial-of-service attacks.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive LimitRequestLine 4094
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <note>Under normal conditions, the value should not be changed from
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the default. Also, you can't set this higher than 8190 without
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive modifying the source and rebuilding.</note>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p> When name-based virtual hosting is used, the value for this
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directive is taken from the default (first-listed) virtual host best
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive matching the current IP address and port combination.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Limits the size of an XML-based request body</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<context>directory</context><context>.htaccess</context></contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Limit (in bytes) on maximum size of an XML-based request
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive body. A value of <code>0</code> will disable any checking.</p>
7fbd7281d06cec1918aa370214df77c572f871a9sf LimitXMLRequestBody 0
7fbd7281d06cec1918aa370214df77c572f871a9sf </example>
7fbd7281d06cec1918aa370214df77c572f871a9sf</directivesynopsis>
7fbd7281d06cec1918aa370214df77c572f871a9sf<description>Applies the enclosed directives only to matching
7fbd7281d06cec1918aa370214df77c572f871a9sfURLs</description>
7fbd7281d06cec1918aa370214df77c572f871a9sf<syntax><Location
7fbd7281d06cec1918aa370214df77c572f871a9sf <var>URL-path</var>|<var>URL</var>> ... </Location></syntax>
7fbd7281d06cec1918aa370214df77c572f871a9sf<contextlist><context>server config</context><context>virtual host</context>
7fbd7281d06cec1918aa370214df77c572f871a9sf</contextlist>
7fbd7281d06cec1918aa370214df77c572f871a9sf <p>The <directive type="section">Location</directive> directive
7fbd7281d06cec1918aa370214df77c572f871a9sf limits the scope of the enclosed directives by URL. It is similar to the
7fbd7281d06cec1918aa370214df77c572f871a9sf <directive type="section" module="core">Directory</directive>
7fbd7281d06cec1918aa370214df77c572f871a9sf directive, and starts a subsection which is terminated with a
7fbd7281d06cec1918aa370214df77c572f871a9sf type="section">Location</directive> sections are processed in the
7fbd7281d06cec1918aa370214df77c572f871a9sf order they appear in the configuration file, after the <directive
7fbd7281d06cec1918aa370214df77c572f871a9sf type="section" module="core">Directory</directive> sections and
7fbd7281d06cec1918aa370214df77c572f871a9sf <code>.htaccess</code> files are read, and after the <directive
7fbd7281d06cec1918aa370214df77c572f871a9sf type="section" module="core">Files</directive> sections.</p>
7fbd7281d06cec1918aa370214df77c572f871a9sf <p><directive type="section">Location</directive> sections operate
7fbd7281d06cec1918aa370214df77c572f871a9sf completely outside the filesystem. This has several consequences.
7fbd7281d06cec1918aa370214df77c572f871a9sf Most importantly, <directive type="section">Location</directive>
7fbd7281d06cec1918aa370214df77c572f871a9sf directives should not be used to control access to filesystem
7fbd7281d06cec1918aa370214df77c572f871a9sf locations. Since several different URLs may map to the same
7fbd7281d06cec1918aa370214df77c572f871a9sf filesystem location, such access controls may by circumvented.</p>
7fbd7281d06cec1918aa370214df77c572f871a9sf <p>The enclosed directives will be applied to the request if the path component
7fbd7281d06cec1918aa370214df77c572f871a9sf <li>The specified location matches exactly the path component of the URL.
7fbd7281d06cec1918aa370214df77c572f871a9sf <li>The specified location, which ends in a forward slash, is a prefix
7fbd7281d06cec1918aa370214df77c572f871a9sf of the path component of the URL (treated as a context root).
7fbd7281d06cec1918aa370214df77c572f871a9sf <li>The specified location, with the addition of a trailing slash, is a
7fbd7281d06cec1918aa370214df77c572f871a9sf prefix of the path component of the URL (also treated as a context root).
7fbd7281d06cec1918aa370214df77c572f871a9sf In the example below, where no trailing slash is used, requests to
7fbd7281d06cec1918aa370214df77c572f871a9sf /private1, /private1/ and /private1/file.txt will have the enclosed
7fbd7281d06cec1918aa370214df77c572f871a9sf directives applied, but /private1other would not.
7fbd7281d06cec1918aa370214df77c572f871a9sf <Location /private1>
7fbd7281d06cec1918aa370214df77c572f871a9sf </example>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive In the example below, where a trailing slash is used, requests to
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive /private2/ and /private2/file.txt will have the enclosed
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directives applied, but /private2 and /private2other would not.
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>Use <directive type="section">Location</directive> to apply
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd directives to content that lives outside the filesystem. For
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd content that lives in the filesystem, use <directive
8b052d682204371decc64f942aede5ef1da98955erikabele type="section" module="core">Directory</directive> and <directive
8b052d682204371decc64f942aede5ef1da98955erikabele type="section" module="core">Files</directive>. An exception is
8b052d682204371decc64f942aede5ef1da98955erikabele <code><Location /></code>, which is an easy way to
8b052d682204371decc64f942aede5ef1da98955erikabele apply a configuration to the entire server.</p>
8b052d682204371decc64f942aede5ef1da98955erikabele <p>For all origin (non-proxy) requests, the URL to be matched is a
7fbd7281d06cec1918aa370214df77c572f871a9sf URL-path of the form <code>/path/</code>. <em>No scheme, hostname,
7fbd7281d06cec1918aa370214df77c572f871a9sf port, or query string may be included.</em> For proxy requests, the
7fbd7281d06cec1918aa370214df77c572f871a9sf URL to be matched is of the form
7fbd7281d06cec1918aa370214df77c572f871a9sf <code>scheme://servername/path</code>, and you must include the
7fbd7281d06cec1918aa370214df77c572f871a9sf prefix.</p>
7fbd7281d06cec1918aa370214df77c572f871a9sf <p>The URL may use wildcards. In a wild-card string, <code>?</code> matches
7fbd7281d06cec1918aa370214df77c572f871a9sf any single character, and <code>*</code> matches any sequences of
7fbd7281d06cec1918aa370214df77c572f871a9sf characters. Neither wildcard character matches a / in the URL-path.</p>
7fbd7281d06cec1918aa370214df77c572f871a9sf can also be used, with the addition of the <code>~</code>
7fbd7281d06cec1918aa370214df77c572f871a9sf character. For example:</p>
7fbd7281d06cec1918aa370214df77c572f871a9sf <Location ~ "/(extra|special)/data">
7fbd7281d06cec1918aa370214df77c572f871a9sf </example>
7fbd7281d06cec1918aa370214df77c572f871a9sf <p>would match URLs that contained the substring <code>/extra/data</code>
7fbd7281d06cec1918aa370214df77c572f871a9sf type="section" module="core">LocationMatch</directive> behaves
7fbd7281d06cec1918aa370214df77c572f871a9sf identical to the regex version of <directive
7fbd7281d06cec1918aa370214df77c572f871a9sf type="section">Location</directive>, and is preferred, for the
7fbd7281d06cec1918aa370214df77c572f871a9sf simple reason that <code>~</code> is hard to distinguish from
7fbd7281d06cec1918aa370214df77c572f871a9sf functionality is especially useful when combined with the
7fbd7281d06cec1918aa370214df77c572f871a9sf directive. For example, to enable status requests, but allow them
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive only from browsers at <code>example.com</code>, you might use:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <Location /status><br />
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess SetHandler server-status<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </Location>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The slash character has special meaning depending on where in a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive URL it appears. People may be used to its behavior in the filesystem
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive where multiple adjacent slashes are frequently collapsed to a single
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive slash (<em>i.e.</em>, <code>/home///foo</code> is the same as
fb77c505254b6e9c925e23e734463e87574f8f40kess <code>/home/foo</code>). In URL-space this is not necessarily true.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive The <directive type="section" module="core">LocationMatch</directive>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directive and the regex version of <directive type="section"
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen >Location</directive> require you to explicitly specify multiple
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen slashes if that is your intention.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>For example, <code><LocationMatch ^/abc></code> would match
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd the request URL <code>/abc</code> but not the request URL <code>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive >Location</directive> directive behaves similarly when used for
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive proxy requests. But when (non-regex) <directive type="section"
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive >Location</directive> is used for non-proxy requests it will
a0fed3e26656887c8458aa1081d516d08ced3c84trawick implicitly match multiple slashes with a single slash. For example,
a0fed3e26656887c8458aa1081d516d08ced3c84trawick if you specify <code><Location /abc/def></code> and the
a0fed3e26656887c8458aa1081d516d08ced3c84trawick request is to <code>/abc//def</code> then it will match.</p>
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick<seealso><a href="/sections.html">How <Directory>, <Location>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick and <Files> sections work</a> for an explanation of how these
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen different sections are combined when a request is received.</seealso>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick<seealso><directive module="core">LocationMatch</directive></seealso>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick</directivesynopsis>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick<description>Applies the enclosed directives only to regular-expression
a0fed3e26656887c8458aa1081d516d08ced3c84trawickmatching URLs</description>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick<syntax><LocationMatch
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <var>regex</var>> ... </LocationMatch></syntax>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick<contextlist><context>server config</context><context>virtual host</context>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick</contextlist>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <p>The <directive type="section">LocationMatch</directive> directive
a0fed3e26656887c8458aa1081d516d08ced3c84trawick limits the scope of the enclosed directives by URL, in an identical manner
a0fed3e26656887c8458aa1081d516d08ced3c84trawick to <directive module="core" type="section">Location</directive>. However,
a0fed3e26656887c8458aa1081d516d08ced3c84trawick it takes a <glossary ref="regex">regular expression</glossary>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick as an argument instead of a simple string. For example:</p>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <LocationMatch "/(extra|special)/data">
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <p>would match URLs that contained the substring <code>/extra/data</code>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick<seealso><a href="/sections.html">How <Directory>, <Location>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick and <Files> sections work</a> for an explanation of how these
a0fed3e26656887c8458aa1081d516d08ced3c84trawick different sections are combined when a request is received</seealso>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick</directivesynopsis>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick<directivesynopsis>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick<description>Controls the verbosity of the ErrorLog</description>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick<syntax>LogLevel [<var>module</var>:]<var>level</var>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick<contextlist><context>server config</context><context>virtual host</context>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick</contextlist>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick<compatibility>Per-module and per-directory configuration is available in
a0fed3e26656887c8458aa1081d516d08ced3c84trawick Apache HTTP Server 2.3.6 and later</compatibility>
bf0e7f6393e91c0a7c15cb0d889a4238c973dc2etrawick <p><directive>LogLevel</directive> adjusts the verbosity of the
bf0e7f6393e91c0a7c15cb0d889a4238c973dc2etrawick messages recorded in the error logs (see <directive
bf0e7f6393e91c0a7c15cb0d889a4238c973dc2etrawick module="core">ErrorLog</directive> directive). The following
bf0e7f6393e91c0a7c15cb0d889a4238c973dc2etrawick <var>level</var>s are available, in order of decreasing
bf0e7f6393e91c0a7c15cb0d889a4238c973dc2etrawick significance:</p>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <columnspec><column width=".2"/><column width=".3"/><column width=".5"/>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick </columnspec>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <td>"getpwuid: couldn't determine user name from uid"</td>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <td>"socket: Failed to get a socket, exiting child"</td>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <td>"child process 1234 did not exit, sending another
a0fed3e26656887c8458aa1081d516d08ced3c84trawick SIGHUP"</td>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <td>"httpd: caught SIGBUS, attempting to dump core in
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <td>"Server seems busy, (you may need to increase
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <td>"proxy: CONNECT: sending the CONNECT request to the remote proxy"</td>
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick <td>"read from buffered SSL brigade, mode 0, 17 bytes"</td>
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick <td>"map lookup FAILED: map=rewritemap key=keyname"</td>
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick <td>"cache lookup FAILED, forcing new map lookup"</td>
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick <td>Trace messages, dumping large amounts of data</td>
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick <td>"| 0000: 02 23 44 30 13 40 ac 34 df 3d bf 9a 19 49 39 15 |"</td>
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick <td>Trace messages, dumping large amounts of data</td>
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick <td>"| 0000: 02 23 44 30 13 40 ac 34 df 3d bf 9a 19 49 39 15 |"</td>
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick <p>When a particular level is specified, messages from all
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick other levels of higher significance will be reported as well.
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick <em>E.g.</em>, when <code>LogLevel info</code> is specified,
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick then messages with log levels of <code>notice</code> and
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick recommended.</p>
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick LogLevel notice
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <p>When logging to a regular file messages of the level
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <code>notice</code> cannot be suppressed and thus are always
a0fed3e26656887c8458aa1081d516d08ced3c84trawick logged. However, this doesn't apply when logging is done
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <p>Specifying a level without a module name will reset the level
a0fed3e26656887c8458aa1081d516d08ced3c84trawick for all modules to that level. Specifying a level with a module
a0fed3e26656887c8458aa1081d516d08ced3c84trawick name will set the level for that module only. It is possible to
a0fed3e26656887c8458aa1081d516d08ced3c84trawick 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
003f0c9fda6664daf5092a0e42f65ede20098153slive are equivalent:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive LogLevel info ssl:warn<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive LogLevel info ssl_module:warn<br />
4025ef5b9785f4cc9e6456a1c0177383a8503361covener <p>It is also possible to change the level per directory:</p>
4025ef5b9785f4cc9e6456a1c0177383a8503361covener LogLevel info<br />
4025ef5b9785f4cc9e6456a1c0177383a8503361covener <Directory /usr/local/apache/htdocs/app><br />
4025ef5b9785f4cc9e6456a1c0177383a8503361covener LogLevel debug<br />
4025ef5b9785f4cc9e6456a1c0177383a8503361covener </Files>
4025ef5b9785f4cc9e6456a1c0177383a8503361covener Per directory loglevel configuration only affects messages that are
4025ef5b9785f4cc9e6456a1c0177383a8503361covener logged after the request has been parsed and that are associated with
4025ef5b9785f4cc9e6456a1c0177383a8503361covener the request. Log messages which are associated with the connection or
4025ef5b9785f4cc9e6456a1c0177383a8503361covener the server are not affected.
4025ef5b9785f4cc9e6456a1c0177383a8503361covener</directivesynopsis>
4025ef5b9785f4cc9e6456a1c0177383a8503361covener<directivesynopsis>
4025ef5b9785f4cc9e6456a1c0177383a8503361covener<description>Number of requests allowed on a persistent
4025ef5b9785f4cc9e6456a1c0177383a8503361covenerconnection</description>
4025ef5b9785f4cc9e6456a1c0177383a8503361covener<syntax>MaxKeepAliveRequests <var>number</var></syntax>
4025ef5b9785f4cc9e6456a1c0177383a8503361covener<contextlist><context>server config</context><context>virtual host</context>
4025ef5b9785f4cc9e6456a1c0177383a8503361covener</contextlist>
4025ef5b9785f4cc9e6456a1c0177383a8503361covener <p>The <directive>MaxKeepAliveRequests</directive> directive
4025ef5b9785f4cc9e6456a1c0177383a8503361covener limits the number of requests allowed per connection when
4025ef5b9785f4cc9e6456a1c0177383a8503361covener <directive module="core" >KeepAlive</directive> is on. If it is
4025ef5b9785f4cc9e6456a1c0177383a8503361covener set to <code>0</code>, unlimited requests will be allowed. We
4025ef5b9785f4cc9e6456a1c0177383a8503361covener recommend that this setting be kept to a high value for maximum
4025ef5b9785f4cc9e6456a1c0177383a8503361covener server performance.</p>
4025ef5b9785f4cc9e6456a1c0177383a8503361covener MaxKeepAliveRequests 500
4025ef5b9785f4cc9e6456a1c0177383a8503361covener</directivesynopsis>
4025ef5b9785f4cc9e6456a1c0177383a8503361covener<directivesynopsis>
4025ef5b9785f4cc9e6456a1c0177383a8503361covener<description>Number of ranges allowed before returning the complete
4025ef5b9785f4cc9e6456a1c0177383a8503361covenerresource </description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>MaxRanges default | unlimited | none | <var>number-of-ranges</var></syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
e6ab342447cf6b4c22bbe66169718d0e9b78819apoirier</contextlist>
e6ab342447cf6b4c22bbe66169718d0e9b78819apoirier<compatibility>Available in Apache HTTP Server 2.3.15 and later</compatibility>
fb77c505254b6e9c925e23e734463e87574f8f40kess limits the number of HTTP ranges the server is willing to
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd return to the client. If more ranges then permitted are requested,
cf02129aebf73dd0bdf369b172eb481ff76ac5f6colm the complete resource is returned instead.</p>
fb77c505254b6e9c925e23e734463e87574f8f40kess <dd>Limits the number of ranges to a compile-time default of 200.</dd>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <dd>The server does not limit the number of ranges it is
4025ef5b9785f4cc9e6456a1c0177383a8503361covener willing to satisfy.</dd>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <dd>A positive number representing the maximum number of ranges the
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd server is willing to satisfy.</dd>
3386d67e54f92fdf6a3ffc5f7f8081eed6c44badslive</directivesynopsis>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <description>Number of overlapping ranges (eg: <code>100-200,150-300</code>) allowed before returning the complete
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive resource </description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <syntax>MaxRangeOverlaps default | unlimited | none | <var>number-of-ranges</var></syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </contextlist>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <compatibility>Available in Apache HTTP Server 2.3.15 and later</compatibility>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <directive>MaxRangeOverlaps</directive> directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive limits the number of overlapping HTTP ranges the server is willing to
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive return to the client. If more overlapping ranges then permitted are requested,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the complete resource is returned instead.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <dd>Limits the number of overlapping ranges to a compile-time default of 20.</dd>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <dd>The server does not limit the number of overlapping ranges it is
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive willing to satisfy.</dd>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <dd>A positive number representing the maximum number of overlapping ranges the
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess server is willing to satisfy.</dd>
13e5182a0c199ecc7a73db97b6448a544e940868slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <description>Number of range reversals (eg: <code>100-200,50-70</code>) allowed before returning the complete
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive resource </description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <syntax>MaxRangeReversals default | unlimited | none | <var>number-of-ranges</var></syntax>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <contextlist><context>server config</context><context>virtual host</context>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </contextlist>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <compatibility>Available in Apache HTTP Server 2.3.15 and later</compatibility>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>The <directive>MaxRangeReversals</directive> directive
1c5fe3e61f0f3202ae0f853740d53f3aff4c4afbslive limits the number of HTTP Range reversals the server is willing to
1c5fe3e61f0f3202ae0f853740d53f3aff4c4afbslive return to the client. If more ranges reversals then permitted are requested,
1c5fe3e61f0f3202ae0f853740d53f3aff4c4afbslive the complete resource is returned instead.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <dd>Limits the number of range reversals to a compile-time default of 20.</dd>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <dd>The server does not limit the number of range reversals it is
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive willing to satisfy.</dd>
13e5182a0c199ecc7a73db97b6448a544e940868slive <dd>A positive number representing the maximum number of range reversals the
13e5182a0c199ecc7a73db97b6448a544e940868slive server is willing to satisfy.</dd>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
0d5b778ac63bc803c0dd1a4fdef371fe7a0f4b57kess<description>Configures mutex mechanism and lock file directory for all
13e5182a0c199ecc7a73db97b6448a544e940868sliveor specified mutexes</description>
13e5182a0c199ecc7a73db97b6448a544e940868slive<syntax>Mutex <var>mechanism</var> [default|<var>mutex-name</var>] ... [OmitPID]</syntax>
13e5182a0c199ecc7a73db97b6448a544e940868slive<contextlist><context>server config</context></contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<compatibility>Available in Apache HTTP Server 2.3.4 and later</compatibility>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <directive>Mutex</directive> directive sets the mechanism,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive and optionally the lock file location, that httpd and modules use
13e5182a0c199ecc7a73db97b6448a544e940868slive to serialize access to resources. Specify <code>default</code> as
96969ed53a757bd9e0a4d7f2f499c9db5ef7899eigalic the first argument to change the settings for all mutexes; specify
96969ed53a757bd9e0a4d7f2f499c9db5ef7899eigalic a mutex name (see table below) as the first argument to override
96969ed53a757bd9e0a4d7f2f499c9db5ef7899eigalic defaults only for that mutex.</p>
96969ed53a757bd9e0a4d7f2f499c9db5ef7899eigalic <p>The <directive>Mutex</directive> directive is typically used in
96969ed53a757bd9e0a4d7f2f499c9db5ef7899eigalic the following exceptional situations:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <li>change the mutex mechanism when the default mechanism selected
13e5182a0c199ecc7a73db97b6448a544e940868slive by <glossary>APR</glossary> has a functional or performance
13e5182a0c199ecc7a73db97b6448a544e940868slive problem</li>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <li>change the directory used by file-based mutexes when the
1c5fe3e61f0f3202ae0f853740d53f3aff4c4afbslive default directory does not support locking</li>
1c5fe3e61f0f3202ae0f853740d53f3aff4c4afbslive <p>This directive only configures mutexes which have been registered
1c5fe3e61f0f3202ae0f853740d53f3aff4c4afbslive with the core server using the <code>ap_mutex_register()</code> API.
13e5182a0c199ecc7a73db97b6448a544e940868slive All modules bundled with httpd support the <directive>Mutex</directive>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directive, but third-party modules may not. Consult the documentation
13e5182a0c199ecc7a73db97b6448a544e940868slive of the third-party module, which must indicate the mutex name(s) which
13e5182a0c199ecc7a73db97b6448a544e940868slive can be configured if this directive is supported.</p>
13e5182a0c199ecc7a73db97b6448a544e940868slive <p>The following mutex <em>mechanisms</em> are available:</p>
13e5182a0c199ecc7a73db97b6448a544e940868slive <p>This selects the default locking implementation, as determined by
13e5182a0c199ecc7a73db97b6448a544e940868slive <glossary>APR</glossary>. The default locking implementation can
13e5182a0c199ecc7a73db97b6448a544e940868slive be displayed by running <program>httpd</program> with the
3b9c7ec844aa240622a33735d1b9cbac4232e268rbowen <p>This effectively disables the mutex, and is only allowed for a
3b9c7ec844aa240622a33735d1b9cbac4232e268rbowen mutex if the module indicates that it is a valid choice. Consult the
3b9c7ec844aa240622a33735d1b9cbac4232e268rbowen <p>This is a mutex variant based on a Posix semaphore.</p>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <p>The semaphore ownership is not recovered if a thread in the process
130d299c4b2b15be45532a176604c71fdc7bea5bnd holding the mutex segfaults, resulting in a hang of the web server.</p>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <p>This is a mutex variant based on a SystemV IPC semaphore.</p>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <p>It is possible to "leak" SysV semaphores if processes crash
130d299c4b2b15be45532a176604c71fdc7bea5bnd before the semaphore is removed.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The semaphore API allows for a denial of service attack by any
fb77c505254b6e9c925e23e734463e87574f8f40kess CGIs running under the same uid as the webserver (<em>i.e.</em>,
fb77c505254b6e9c925e23e734463e87574f8f40kess all CGIs, unless you use something like <program>suexec</program>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <p>This selects the "best" available semaphore implementation, choosing
130d299c4b2b15be45532a176604c71fdc7bea5bnd between Posix and SystemV IPC semaphores, in that order.</p></li>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <p>This is a mutex variant based on cross-process Posix thread
130d299c4b2b15be45532a176604c71fdc7bea5bnd mutexes.</p>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <p>On most systems, if a child process terminates abnormally while
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd holding a mutex that uses this implementation, the server will deadlock
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd and stop responding to requests. When this occurs, the server will
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive require a manual restart to recover.</p>
fb77c505254b6e9c925e23e734463e87574f8f40kess <p>Solaris is a notable exception as it provides a mechanism which
fb77c505254b6e9c925e23e734463e87574f8f40kess usually allows the mutex to be recovered after a child process
fb77c505254b6e9c925e23e734463e87574f8f40kess terminates abnormally while holding a mutex.</p>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <p>If your system implements the
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <code>pthread_mutexattr_setrobust_np()</code> function, you may be able
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This is a mutex variant where a physical (lock-)file and the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>fcntl()</code> function are used as the mutex.</p>
9f19223e8fb7b99f5f1cc02c8c3c2c6567793262rbowen <p>When multiple mutexes based on this mechanism are used within
9f19223e8fb7b99f5f1cc02c8c3c2c6567793262rbowen multi-threaded, multi-process environments, deadlock errors (EDEADLK)
9f19223e8fb7b99f5f1cc02c8c3c2c6567793262rbowen can be reported for valid mutex operations if <code>fcntl()</code>
9f19223e8fb7b99f5f1cc02c8c3c2c6567793262rbowen is not thread-aware, such as on Solaris.</p>
9f19223e8fb7b99f5f1cc02c8c3c2c6567793262rbowen <p>This is similar to the <code>fcntl:/path/to/mutex</code> method
9f19223e8fb7b99f5f1cc02c8c3c2c6567793262rbowen with the exception that the <code>flock()</code> function is used to
9f19223e8fb7b99f5f1cc02c8c3c2c6567793262rbowen <p>This selects the "best" available file locking implementation,
9f19223e8fb7b99f5f1cc02c8c3c2c6567793262rbowen choosing between <code>fcntl</code> and <code>flock</code>, in that
9f19223e8fb7b99f5f1cc02c8c3c2c6567793262rbowen <p>Most mechanisms are only available on selected platforms, where the
9f19223e8fb7b99f5f1cc02c8c3c2c6567793262rbowen underlying platform and <glossary>APR</glossary> support it. Mechanisms
9f19223e8fb7b99f5f1cc02c8c3c2c6567793262rbowen which aren't available on all platforms are <em>posixsem</em>,
9f19223e8fb7b99f5f1cc02c8c3c2c6567793262rbowen <em>sysvsem</em>, <em>sem</em>, <em>pthread</em>, <em>fcntl</em>,
9f19223e8fb7b99f5f1cc02c8c3c2c6567793262rbowen <p>With the file-based mechanisms <em>fcntl</em> and <em>flock</em>,
9f19223e8fb7b99f5f1cc02c8c3c2c6567793262rbowen the path, if provided, is a directory where the lock file will be created.
9f19223e8fb7b99f5f1cc02c8c3c2c6567793262rbowen The default directory is httpd's run-time file directory relative to
9f19223e8fb7b99f5f1cc02c8c3c2c6567793262rbowen <directive module="core">ServerRoot</directive>. Always use a local disk
9f19223e8fb7b99f5f1cc02c8c3c2c6567793262rbowen 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
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen parent process will be appended to to make the file name unique, avoiding
ef8e89e090461194ecadd31e8796a2c51e0531a2kess 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
530eba85dbd41b8a0fa5255d3648d1440199a661slive directory is <code>/var/httpd/locks</code>, the lock file name for the
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele httpd instance with parent process id 12345 would be
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele <code>/var/httpd/locks/mpm-accept.12345</code>.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <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
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd creating a lockfile with the same name as the one the server will try
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive to create.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <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>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive documentation</td>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen <td>communication with external mapping programs, to avoid
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen intermixed I/O from multiple requests</td>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen <td>callback function of a particular client module</td>
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele <p>The <code>OmitPID</code> keyword suppresses the addition of the httpd
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele parent process id from the lock file name.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>In the following example, the mutex mechanism for the MPM accept
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive mutex will be changed from the compiled-in default to <code>fcntl</code>,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive with the associated lock file created in directory
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <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>
ef8e89e090461194ecadd31e8796a2c51e0531a2kess Mutex sysvsem default<br />
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen</directivesynopsis>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>DEPRECATED: Designates an IP address for name-virtual
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivehosting</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>NameVirtualHost <var>addr</var>[:<var>port</var>]</syntax>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<contextlist><context>server config</context></contextlist>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<p>Prior to 2.3.11, <directive>NameVirtualHost</directive> was required
313bb560bc5c323cfd40c9cad7335b4b8e060aedkessto instruct the server that a particular IP address and port combination
313bb560bc5c323cfd40c9cad7335b4b8e060aedkesswas usable as a name-based virtual host. In 2.3.11 and later,
313bb560bc5c323cfd40c9cad7335b4b8e060aedkessany time an IP address and port combination is used in multiple virtual
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivehosts, name-based virtual hosting is automatically enabled for that address.</p>
003f0c9fda6664daf5092a0e42f65ede20098153slive</directivesynopsis>
fb77c505254b6e9c925e23e734463e87574f8f40kess<directivesynopsis>
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele<description>Configures what features are available in a particular
003f0c9fda6664daf5092a0e42f65ede20098153slivedirectory</description>
18831446030f4eda7e0563c92a896ccfdb6eb1d7slive<syntax>Options
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen [+|-]<var>option</var> [[+|-]<var>option</var>] ...</syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<context>directory</context><context>.htaccess</context>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen</contextlist>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen<compatibility>The default was changed from All to FollowSymlinks in 2.3.11</compatibility>
4cafc94e99922f00654e1779d30c2cccf5278c4fkess <p>The <directive>Options</directive> directive controls which
4cafc94e99922f00654e1779d30c2cccf5278c4fkess server features are available in a particular directory.</p>
4cafc94e99922f00654e1779d30c2cccf5278c4fkess <p><var>option</var> can be set to <code>None</code>, in which
4cafc94e99922f00654e1779d30c2cccf5278c4fkess case none of the extra features are enabled, or one or more of
27303c8bb552a8a5fc859feb735d686fc59f59a1yoshiki the following:</p>
fb77c505254b6e9c925e23e734463e87574f8f40kess <dd>All options except for <code>MultiViews</code>.</dd>
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive Execution of CGI scripts using <module>mod_cgi</module>
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive is permitted.</dd>
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive The server will follow symbolic links in this directory. This is
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive the default setting.
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen <p>Even though the server follows the symlink it does <em>not</em>
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive change the pathname used to match against <directive type="section"
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive <p>Note also, that this option <strong>gets ignored</strong> if set
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive inside a <directive type="section" module="core">Location</directive>
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive section.</p>
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive <p>Omitting this option should not be considered a security restriction,
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive since symlink testing is subject to race conditions that make it
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive circumventable.</p>
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive Server-side includes provided by <module>mod_include</module>
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive are permitted.</dd>
a8ee031b2224ce5473826c9d4f603681589245fawrowe Server-side includes are permitted, but the <code>#exec
a8ee031b2224ce5473826c9d4f603681589245fawrowe cmd</code> and <code>#exec cgi</code> are disabled. It is still
a8ee031b2224ce5473826c9d4f603681589245fawrowe possible to <code>#include virtual</code> CGI scripts from
a8ee031b2224ce5473826c9d4f603681589245fawrowe <directive module="mod_alias">ScriptAlias</directive>ed
a8ee031b2224ce5473826c9d4f603681589245fawrowe directories.</dd>
a8ee031b2224ce5473826c9d4f603681589245fawrowe If a URL which maps to a directory is requested, and there
a8ee031b2224ce5473826c9d4f603681589245fawrowe is no <directive module="mod_dir">DirectoryIndex</directive>
a8ee031b2224ce5473826c9d4f603681589245fawrowe (<em>e.g.</em>, <code>index.html</code>) in that directory, then
a8ee031b2224ce5473826c9d4f603681589245fawrowe <module>mod_autoindex</module> will return a formatted listing
a8ee031b2224ce5473826c9d4f603681589245fawrowe of the directory.</dd>
a8ee031b2224ce5473826c9d4f603681589245fawrowe <a href="/content-negotiation.html">Content negotiated</a>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen "MultiViews" are allowed using
a8ee031b2224ce5473826c9d4f603681589245fawrowe <note><title>Note</title> <p>This option gets ignored if set
a8ee031b2224ce5473826c9d4f603681589245fawrowe anywhere other than <directive module="core" type="section"
a8ee031b2224ce5473826c9d4f603681589245fawrowe >Directory</directive>, as <module>mod_negotiation</module>
a8ee031b2224ce5473826c9d4f603681589245fawrowe needs real resources to compare against and evaluate from.</p></note>
a8ee031b2224ce5473826c9d4f603681589245fawrowe <dd>The server will only follow symbolic links for which the
a8ee031b2224ce5473826c9d4f603681589245fawrowe target file or directory is owned by the same user id as the
a8ee031b2224ce5473826c9d4f603681589245fawrowe <note><title>Note</title> <p>This option gets ignored if
a8ee031b2224ce5473826c9d4f603681589245fawrowe <p>This option should not be considered a security restriction,
a8ee031b2224ce5473826c9d4f603681589245fawrowe since symlink testing is subject to race conditions that make it
2e5e2673cb64d3e4d445d911c6f61ac171020725nd <p>Normally, if multiple <directive>Options</directive> could
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive apply to a directory, then the most specific one is used and
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive others are ignored; the options are not merged. (See <a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive href="/sections.html#mergin">how sections are merged</a>.)
2e5e2673cb64d3e4d445d911c6f61ac171020725nd <directive>Options</directive> directive are preceded by a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>+</code> or <code>-</code> symbol, the options are
733738e83a9b0113476e3f67992c2278d61ee4dakess merged. Any options preceded by a <code>+</code> are added to the
733738e83a9b0113476e3f67992c2278d61ee4dakess options currently in force, and any options preceded by a
2e5e2673cb64d3e4d445d911c6f61ac171020725nd force. </p>
2e5e2673cb64d3e4d445d911c6f61ac171020725nd <p>Mixing <directive>Options</directive> with a <code>+</code> or
2e5e2673cb64d3e4d445d911c6f61ac171020725nd <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>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>For example, without any <code>+</code> and <code>-</code> symbols:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Options Indexes FollowSymLinks<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </Directory><br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Options Includes<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </Directory>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>then only <code>Includes</code> will be set for the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>/web/docs/spec</code> directory. However if the second
206b5dce9e48924aa9f12ce87f14856a4cd3fb68takashi <directive>Options</directive> directive uses the <code>+</code> and
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd Options Indexes FollowSymLinks<br />
fff1d314f760fc17a49215e8818b3e57691efa43niq </Directory><br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Options +Includes -Indexes<br />
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen </Directory>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>Includes</code> are set for the <code>/web/docs/spec</code>
003f0c9fda6664daf5092a0e42f65ede20098153slive directory.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>-Includes</code> disables server-side includes completely
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive regardless of the previous setting.</p>
e08ad1a326852610a7930269638a43657fc50d06sctemme <p>The default in the absence of any other settings is
06fcf16883e133e49db046945cbcf728d4cc6e37rbowen</directivesynopsis>
06fcf16883e133e49db046945cbcf728d4cc6e37rbowen<directivesynopsis>
06fcf16883e133e49db046945cbcf728d4cc6e37rbowen<description>Protocol for a listening socket</description>
06fcf16883e133e49db046945cbcf728d4cc6e37rbowen<contextlist><context>server config</context><context>virtual host</context></contextlist>
9b5e2c5e769dc678a1aca06df75c32022b2f1492trawick<compatibility>Available in Apache 2.1.5 and later.
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveOn Windows from Apache 2.3.3 and later.</compatibility>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This directive specifies the protocol used for a specific listening socket.
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd The protocol is used to determine which module should handle a request, and
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd to apply protocol specific optimizations with the <directive>AcceptFilter</directive>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd directive.</p>
e6ab342447cf6b4c22bbe66169718d0e9b78819apoirier <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>
e6ab342447cf6b4c22bbe66169718d0e9b78819apoirier <p>For example, if you are running <code>https</code> on a non-standard port, specify the protocol explicitly:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Protocol https
e08ad1a326852610a7930269638a43657fc50d06sctemme <p>You can also specify the protocol using the <directive module="mpm_common">Listen</directive> directive.</p>
e08ad1a326852610a7930269638a43657fc50d06sctemme<seealso><directive>AcceptFilter</directive></seealso>
e08ad1a326852610a7930269638a43657fc50d06sctemme<seealso><directive module="mpm_common">Listen</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Limits the CPU consumption of processes launched
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveby Apache httpd children</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>RLimitCPU <var>seconds</var>|max [<var>seconds</var>|max]</syntax>
e08ad1a326852610a7930269638a43657fc50d06sctemme<default>Unset; uses operating system defaults</default>
e08ad1a326852610a7930269638a43657fc50d06sctemme<contextlist><context>server config</context><context>virtual host</context>
e08ad1a326852610a7930269638a43657fc50d06sctemme<context>directory</context><context>.htaccess</context></contextlist>
e08ad1a326852610a7930269638a43657fc50d06sctemme <p>Takes 1 or 2 parameters. The first parameter sets the soft
e08ad1a326852610a7930269638a43657fc50d06sctemme resource limit for all processes and the second parameter sets
e08ad1a326852610a7930269638a43657fc50d06sctemme the maximum resource limit. Either parameter can be a number,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive or <code>max</code> to indicate to the server that the limit should
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim be set to the maximum allowed by the operating system
29edaaeea24c41820e486944635348cd7fae1d11rbowen configuration. Raising the maximum resource limit requires that
e08ad1a326852610a7930269638a43657fc50d06sctemme 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
e08ad1a326852610a7930269638a43657fc50d06sctemme servicing requests, not the Apache httpd children themselves. This
226aaa3e29f938600cd1b9dfb6774588d831d036rbowen includes CGI scripts and SSI exec commands, but not any
226aaa3e29f938600cd1b9dfb6774588d831d036rbowen processes forked off from the Apache httpd parent such as piped
226aaa3e29f938600cd1b9dfb6774588d831d036rbowen <p>CPU resource limits are expressed in seconds per
226aaa3e29f938600cd1b9dfb6774588d831d036rbowen process.</p>
226aaa3e29f938600cd1b9dfb6774588d831d036rbowen<seealso><directive module="core">RLimitMEM</directive></seealso>
226aaa3e29f938600cd1b9dfb6774588d831d036rbowen<seealso><directive module="core">RLimitNPROC</directive></seealso>
226aaa3e29f938600cd1b9dfb6774588d831d036rbowen</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
ef8e89e090461194ecadd31e8796a2c51e0531a2kess<description>Limits the memory consumption of processes launched
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowenby Apache httpd children</description>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen<syntax>RLimitMEM <var>bytes</var>|max [<var>bytes</var>|max]</syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<default>Unset; uses operating system defaults</default>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim<context>directory</context><context>.htaccess</context></contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Takes 1 or 2 parameters. The first parameter sets the soft
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive resource limit for all processes and the second parameter sets
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the maximum resource limit. Either parameter can be a number,
fb77c505254b6e9c925e23e734463e87574f8f40kess or <code>max</code> to indicate to the server that the limit should
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive be set to the maximum allowed by the operating system
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd 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
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive 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
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Memory resource limits are expressed in bytes per
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive process.</p>
003f0c9fda6664daf5092a0e42f65ede20098153slive<seealso><directive module="core">RLimitCPU</directive></seealso>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<seealso><directive module="core">RLimitNPROC</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<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>
7228d3b2eebddc214348190bcc62d80b5e7087e2rbowen<default>Unset; uses operating system defaults</default>
7228d3b2eebddc214348190bcc62d80b5e7087e2rbowen<contextlist><context>server config</context><context>virtual host</context>
fcc04773f0f2cc73650485facef9cd77f2d5bd65nd<context>directory</context><context>.htaccess</context></contextlist>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>Takes 1 or 2 parameters. The first parameter sets the soft
58e56a1d61ae176cc5ecb7c4863881736947d8b8rbowen resource limit for all processes and the second parameter sets
58e56a1d61ae176cc5ecb7c4863881736947d8b8rbowen the maximum resource limit. Either parameter can be a number,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive or <code>max</code> to indicate to the server that the limit
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive should 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
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This applies to processes forked off from Apache httpd children
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive 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
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Process limits control the number of processes per user.</p>
003f0c9fda6664daf5092a0e42f65ede20098153slive under user ids other than the web server user id, this directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive will limit the number of processes that the server itself can
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive create. Evidence of this situation will be indicated by
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <strong><code>cannot fork</code></strong> messages in the
fb77c505254b6e9c925e23e734463e87574f8f40kess<seealso><directive module="core">RLimitMEM</directive></seealso>
fb77c505254b6e9c925e23e734463e87574f8f40kess<seealso><directive module="core">RLimitCPU</directive></seealso>
ef8e89e090461194ecadd31e8796a2c51e0531a2kess</directivesynopsis>
ef8e89e090461194ecadd31e8796a2c51e0531a2kess<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Technique for locating the interpreter for CGI
530eba85dbd41b8a0fa5255d3648d1440199a661slivescripts</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>ScriptInterpreterSource Registry|Registry-Strict|Script</syntax>
530eba85dbd41b8a0fa5255d3648d1440199a661slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<context>directory</context><context>.htaccess</context></contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<compatibility>Win32 only;
23b36269d124e7a6aaa5221891f7ae2ef3eeb158jerenkrantzoption <code>Registry-Strict</code> is available in Apache HTTP Server 2.0 and
23b36269d124e7a6aaa5221891f7ae2ef3eeb158jerenkrantzlater</compatibility>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This directive is used to control how Apache httpd finds the
f35c904c3b359610a46e94fbb4ba8495b2338521slive interpreter used to run CGI scripts. The default setting is
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>Script</code>. This causes Apache httpd to use the interpreter pointed to
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive by the shebang line (first line, starting with <code>#!</code>) in the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive script. On Win32 systems this line usually looks like:</p>
dc111bcea580da3da174c25be0fd7a8f22c86fe1jim </example>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>or, if <code>perl</code> is in the <code>PATH</code>, simply:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Setting <code>ScriptInterpreterSource Registry</code> will
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive cause the Windows Registry tree <code>HKEY_CLASSES_ROOT</code> to be
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive searched using the script file extension (e.g., <code>.pl</code>) as a
a21fb2799923b1c25a351f09e690bd46806f2fa2jim search key. The command defined by the registry subkey
2eb5346b17b3b69767cfe87d0f632efd6d15500djim <code>Shell\ExecCGI\Command</code> or, if it does not exist, by the subkey
9e59849752ebadf803f76453fe3b64e2cee8d190rbowen <code>Shell\Open\Command</code> is used to open the script file. If the
a21fb2799923b1c25a351f09e690bd46806f2fa2jim registry keys cannot be found, Apache httpd falls back to the behavior of the
530eba85dbd41b8a0fa5255d3648d1440199a661slive <p>Be careful when using <code>ScriptInterpreterSource
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="mod_alias">ScriptAlias</directive>'ed directories, because
cf1595220a90759be0a39ab8b11c8cb834b698a9ianh Apache httpd will try to execute <strong>every</strong> file within this
cf1595220a90759be0a39ab8b11c8cb834b698a9ianh directory. The <code>Registry</code> setting may cause undesired
cf1595220a90759be0a39ab8b11c8cb834b698a9ianh program calls on files which are typically not executed. For
cf1595220a90759be0a39ab8b11c8cb834b698a9ianh example, the default open command on <code>.htm</code> files on
cf1595220a90759be0a39ab8b11c8cb834b698a9ianh most Windows systems will execute Microsoft Internet Explorer, so
cf1595220a90759be0a39ab8b11c8cb834b698a9ianh any HTTP request for an <code>.htm</code> file existing within the
1a1cf0ee9229ee29e5750b25dd94dbb9b04072cfianh script directory would start the browser in the background on the
1a1cf0ee9229ee29e5750b25dd94dbb9b04072cfianh 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
530eba85dbd41b8a0fa5255d3648d1440199a661slive 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>
530eba85dbd41b8a0fa5255d3648d1440199a661slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Determine if mod_status displays the first 63 characters
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveof a request or the last 63, assuming the request itself is greater than
23b36269d124e7a6aaa5221891f7ae2ef3eeb158jerenkrantz63 chars.</description>
7b5535ed88e0f561b3bfb3330137bd804846afd4slive<contextlist><context>server config</context></contextlist>
a21fb2799923b1c25a351f09e690bd46806f2fa2jim<compatibility>Available in Apache httpd 2.2.7 and later.</compatibility>
a21fb2799923b1c25a351f09e690bd46806f2fa2jim displays the actual request being handled.
a21fb2799923b1c25a351f09e690bd46806f2fa2jim For historical purposes, only 63 characters of the request
a21fb2799923b1c25a351f09e690bd46806f2fa2jim are actually stored for display purposes. This directive
a21fb2799923b1c25a351f09e690bd46806f2fa2jim controls whether the 1st 63 characters are stored (the previous
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive behavior and the default) or if the last 63 characters are. This
f35c904c3b359610a46e94fbb4ba8495b2338521slive is only applicable, of course, if the length of the request is
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive 64 characters or greater.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive >GET /disk1/storage/apache/htdocs/images/imagestore1/food/apples.jpg HTTP/1.1</code
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive > mod_status displays as follows:
003f0c9fda6664daf5092a0e42f65ede20098153slive <td>GET /disk1/storage/apache/htdocs/images/imagestore1/food/apples</td>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <td>orage/apache/htdocs/images/imagestore1/food/apples.jpg HTTP/1.1</td>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<description>Email address that the server includes in error
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cndmessages sent to the client</description>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<syntax>ServerAdmin <var>email-address</var>|<var>URL</var></syntax>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <directive>ServerAdmin</directive> sets the contact address
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess that the server includes in any error messages it returns to the
db1b819ff8966e3c6a5ca03c59a8ae06c2cecc9frbowen client. If the <code>httpd</code> doesn't recognize the supplied argument
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd as an URL, it
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd 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
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd server under your control. Otherwise users may not be able to contact you in
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd case of errors.</p>
c97e8972ab1f4dd167e3dc4db87daf91114009fbnd <p>It may be worth setting up a dedicated address for this, e.g.</p>
9f1dd1339447bf4b291682cd94bf9f28bc2685e0niq ServerAdmin www-admin@foo.example.com
9f1dd1339447bf4b291682cd94bf9f28bc2685e0niq </example>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>as users do not always mention that they are talking about the
db1b819ff8966e3c6a5ca03c59a8ae06c2cecc9frbowen server!</p>
db1b819ff8966e3c6a5ca03c59a8ae06c2cecc9frbowen</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Alternate names for a host used when matching requests
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveto name-virtual hosts</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>ServerAlias <var>hostname</var> [<var>hostname</var>] ...</syntax>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<contextlist><context>virtual host</context></contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <directive>ServerAlias</directive> directive sets the
003f0c9fda6664daf5092a0e42f65ede20098153slive alternate names for a host, for use with <a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive href="/vhosts/name-based.html">name-based virtual hosts</a>. The
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive>ServerAlias</directive> may include wildcards, if appropriate.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <VirtualHost *:80><br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive UseCanonicalName Off<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive # ...<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </VirtualHost>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive module="core">UseCanonicalName</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><a href="/vhosts/">Apache HTTP Server Virtual Host documentation</a></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Hostname and port that the server uses to identify
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnditself</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>ServerName [<var>scheme</var>://]<var>fully-qualified-domain-name</var>[:<var>port</var>]</syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <directive>ServerName</directive> directive sets the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive request scheme, hostname and
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive port that the server uses to identify itself. This is used when
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive creating redirection URLs.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Additionally, <directive>ServerName</directive> is used (possibly
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive in conjunction with <directive>ServerAlias</directive>) to uniquely
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive identify a virtual host, when using <a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive href="/vhosts/name-based.html">name-based virtual hosts</a>.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>For example, if the name of the
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd machine hosting the web server is <code>simple.example.com</code>,
130d299c4b2b15be45532a176604c71fdc7bea5bnd but the machine also has the DNS alias <code>www.example.com</code>
130d299c4b2b15be45532a176604c71fdc7bea5bnd and you wish the web server to be so identified, the following
130d299c4b2b15be45532a176604c71fdc7bea5bnd directive should be used:</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive may appear anywhere within the definition of a server. However,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive each appearance overrides the previous appearance (within that
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive server).</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>If no <directive>ServerName</directive> is specified, then the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive server attempts to deduce the hostname by performing a reverse
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive lookup on the IP address. If no port is specified in the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive>ServerName</directive>, then the server will use the
003f0c9fda6664daf5092a0e42f65ede20098153slive port from the incoming request. For optimal reliability and
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive predictability, you should specify an explicit hostname and port
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess using the <directive>ServerName</directive> directive.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive href="/vhosts/name-based.html">name-based virtual hosts</a>,
b91096bcdd71fcbb37c9905f6cf79e930ae349b1jorton <directive type="section" module="core">VirtualHost</directive>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen section specifies what hostname must appear in the request's
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>Host:</code> header to match this virtual host.</p>
b91096bcdd71fcbb37c9905f6cf79e930ae349b1jorton <p>Sometimes, the server runs behind a device that processes SSL,
b91096bcdd71fcbb37c9905f6cf79e930ae349b1jorton such as a reverse proxy, load balancer or SSL offload
b91096bcdd71fcbb37c9905f6cf79e930ae349b1jorton appliance. When this is the case, specify the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>https://</code> scheme and the port number to which the
b91096bcdd71fcbb37c9905f6cf79e930ae349b1jorton clients connect in the <directive>ServerName</directive> directive
b91096bcdd71fcbb37c9905f6cf79e930ae349b1jorton to make sure that the server generates the correct
b91096bcdd71fcbb37c9905f6cf79e930ae349b1jorton self-referential URLs.
b91096bcdd71fcbb37c9905f6cf79e930ae349b1jorton <p>See the description of the
b91096bcdd71fcbb37c9905f6cf79e930ae349b1jorton <directive module="core">UseCanonicalName</directive> and
b91096bcdd71fcbb37c9905f6cf79e930ae349b1jorton <directive module="core">UseCanonicalPhysicalPort</directive> directives for
b91096bcdd71fcbb37c9905f6cf79e930ae349b1jorton settings which determine whether self-referential URLs (e.g., by the
b91096bcdd71fcbb37c9905f6cf79e930ae349b1jorton specified port, or to the port number given in the client's request.
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <p>Failure to set <directive>ServerName</directive> to a name that
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive your server can resolve to an IP address will result in a startup
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive warning. <code>httpd</code> will then use whatever hostname it can
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive determine, using the system's <code>hostname</code> command. This
b00fe3c3354db01001b8eddfd9b88441380f837dwrowe will almost never be the hostname you actually want.</p>
f59a2b72270d63d121d6a1a01d85fb87d8a8bb45rbowen httpd: Could not reliably determine the server's fully qualified domain name, using rocinante.local for ServerName
b00fe3c3354db01001b8eddfd9b88441380f837dwrowe<seealso><a href="/dns-caveats.html">Issues Regarding DNS and
12099dff89f3135d53929f4f1bdb42c7d044d928nd<seealso><a href="/vhosts/">Apache HTTP Server virtual host
12099dff89f3135d53929f4f1bdb42c7d044d928nd<seealso><directive module="core">UseCanonicalName</directive></seealso>
12099dff89f3135d53929f4f1bdb42c7d044d928nd<seealso><directive module="core">UseCanonicalPhysicalPort</directive></seealso>
12099dff89f3135d53929f4f1bdb42c7d044d928nd<seealso><directive module="core">ServerAlias</directive></seealso>
12099dff89f3135d53929f4f1bdb42c7d044d928nd</directivesynopsis>
b00fe3c3354db01001b8eddfd9b88441380f837dwrowe<directivesynopsis>
b00fe3c3354db01001b8eddfd9b88441380f837dwrowe<description>Legacy URL pathname for a name-based virtual host that
b00fe3c3354db01001b8eddfd9b88441380f837dwroweis accessed by an incompatible browser</description>
12099dff89f3135d53929f4f1bdb42c7d044d928nd<contextlist><context>virtual host</context></contextlist>
b00fe3c3354db01001b8eddfd9b88441380f837dwrowe <p>The <directive>ServerPath</directive> directive sets the legacy
20b0f809c3823eda58808be053ffc305dfa9c785sf URL pathname for a host, for use with <a
20b0f809c3823eda58808be053ffc305dfa9c785sf<seealso><a href="/vhosts/">Apache HTTP Server Virtual Host documentation</a></seealso>
20b0f809c3823eda58808be053ffc305dfa9c785sf</directivesynopsis>
20b0f809c3823eda58808be053ffc305dfa9c785sf<directivesynopsis>
20b0f809c3823eda58808be053ffc305dfa9c785sf<description>Base directory for the server installation</description>
20b0f809c3823eda58808be053ffc305dfa9c785sf<contextlist><context>server config</context></contextlist>
20b0f809c3823eda58808be053ffc305dfa9c785sf <p>The <directive>ServerRoot</directive> directive sets the
b00fe3c3354db01001b8eddfd9b88441380f837dwrowe directory in which the server lives. Typically it will contain the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive subdirectories <code>conf/</code> and <code>logs/</code>. Relative
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive paths in other configuration directives (such as <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="mod_so">LoadModule</directive>, for example) are taken as
fb77c505254b6e9c925e23e734463e87574f8f40kess relative to this directory.</p>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen <p>The default location of <directive>ServerRoot</directive> may be
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen <a href="/programs/configure.html"><code>configure</code></a>, and
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd most third-party distributions of the server have a different
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd default location from the one listed above.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><a href="/misc/security_tips.html#serverroot">the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive security tips</a> for information on how to properly set
3c6c63407f1855ddfc45ac69b69a2a9bf15135e6rbowen permissions on the <directive>ServerRoot</directive></seealso>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess</directivesynopsis>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<directivesynopsis>
3c6c63407f1855ddfc45ac69b69a2a9bf15135e6rbowen<description>Configures the footer on server-generated documents</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<context>directory</context><context>.htaccess</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <directive>ServerSignature</directive> directive allows the
3c6c63407f1855ddfc45ac69b69a2a9bf15135e6rbowen configuration of a trailing footer line under server-generated
3c6c63407f1855ddfc45ac69b69a2a9bf15135e6rbowen documents (error messages, <module>mod_proxy</module> ftp directory
3c6c63407f1855ddfc45ac69b69a2a9bf15135e6rbowen listings, <module>mod_info</module> output, ...). The reason why you
3c6c63407f1855ddfc45ac69b69a2a9bf15135e6rbowen would want to enable such a footer line is that in a chain of proxies,
fb77c505254b6e9c925e23e734463e87574f8f40kess the user often has no possibility to tell which of the chained servers
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen actually produced a returned error message.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive setting, which is the default, suppresses the footer line (and is
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive therefore compatible with the behavior of Apache-1.2 and
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen below). The <code>On</code> setting simply adds a line with the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive server version number and <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="core">ServerName</directive> of the serving virtual host,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive and the <code>EMail</code> setting additionally creates a
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess "mailto:" reference to the <directive
130d299c4b2b15be45532a176604c71fdc7bea5bnd document.</p>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <p>After version 2.0.44, the details of the server version number
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive presented are controlled by the <directive
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim<seealso><directive module="core">ServerTokens</directive></seealso>
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim</directivesynopsis>
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim<directivesynopsis>
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim<description>Configures the <code>Server</code> HTTP response
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jimheader</description>
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim<syntax>ServerTokens Major|Minor|Min[imal]|Prod[uctOnly]|OS|Full</syntax>
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim<contextlist><context>server config</context></contextlist>
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim <p>This directive controls whether <code>Server</code> response
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim header field which is sent back to clients includes a
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim description of the generic OS-type of the server as well as
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen information about compiled-in modules.</p>
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim <dt><code>ServerTokens Full</code> (or not specified)</dt>
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim <dd>Server sends (<em>e.g.</em>): <code>Server: Apache/2.4.1
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim <dd>Server sends (<em>e.g.</em>): <code>Server: Apache/2.4.1
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This setting applies to the entire server, and cannot be
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive enabled or disabled on a virtualhost-by-virtualhost basis.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>After version 2.0.44, this directive also controls the
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess information presented by the <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="core">ServerSignature</directive> directive.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <note>Setting <directive>ServerTokens</directive> to less than
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>minimal</code> is not recommended because it makes it more
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive difficult to debug interoperational problems. Also note that
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive disabling the Server: header does nothing at all to make your
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive server more secure; the idea of "security through obscurity"
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive is a myth and leads to a false sense of safety.</note>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive module="core">ServerSignature</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Forces all matching files to be processed by a
a23acbbd61b9565caecea9931b6bcdf0b6228cbbslivehandler</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>SetHandler <var>handler-name</var>|None</syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
a23acbbd61b9565caecea9931b6bcdf0b6228cbbslive</contextlist>
a23acbbd61b9565caecea9931b6bcdf0b6228cbbslive<compatibility>Moved into the core in Apache httpd 2.0</compatibility>
a23acbbd61b9565caecea9931b6bcdf0b6228cbbslive <p>When placed into an <code>.htaccess</code> file or a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive type="section" module="core">Directory</directive> or
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <directive type="section" module="core">Location</directive>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd section, this directive forces all matching files to be parsed
130d299c4b2b15be45532a176604c71fdc7bea5bnd <var>handler-name</var>. For example, if you had a directory you
e8811b6d38f756b325446ded5d96857d13856511takashi wanted to be parsed entirely as imagemap rule files, regardless
e8811b6d38f756b325446ded5d96857d13856511takashi of extension, you might put the following into an
130d299c4b2b15be45532a176604c71fdc7bea5bnd SetHandler imap-file
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Another example: if you wanted to have the server display a
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess status report whenever a URL of
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <code>http://servername/status</code> was called, you might put
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <Location /status><br />
130d299c4b2b15be45532a176604c71fdc7bea5bnd SetHandler server-status<br />
130d299c4b2b15be45532a176604c71fdc7bea5bnd </Location>
130d299c4b2b15be45532a176604c71fdc7bea5bnd </example>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <p>You can override an earlier defined <directive>SetHandler</directive>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Because <directive>SetHandler</directive> overrides default handlers,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive normal behavior such as handling of URLs ending in a slash (/) as
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive module="mod_mime">AddHandler</directive></seealso>
a23acbbd61b9565caecea9931b6bcdf0b6228cbbslive</directivesynopsis>
130d299c4b2b15be45532a176604c71fdc7bea5bnd<directivesynopsis>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen<description>Sets the filters that will process client requests and POST
88d86cfadffe2275a3dfb67a4d7bdc018630b661rboweninput</description>
130d299c4b2b15be45532a176604c71fdc7bea5bnd<syntax>SetInputFilter <var>filter</var>[;<var>filter</var>...]</syntax>
130d299c4b2b15be45532a176604c71fdc7bea5bnd<contextlist><context>server config</context><context>virtual host</context>
a23acbbd61b9565caecea9931b6bcdf0b6228cbbslive</contextlist>
fb77c505254b6e9c925e23e734463e87574f8f40kess <p>The <directive>SetInputFilter</directive> directive sets the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive filter or filters which will process client requests and POST
4025ef5b9785f4cc9e6456a1c0177383a8503361covener input when they are received by the server. This is in addition to
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive any filters defined elsewhere, including the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive module="mod_mime">AddInputFilter</directive>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directive.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>If more than one filter is specified, they must be separated
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive by semicolons in the order in which they should process the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive content.</p>
4cf1c07a88ef51e11570c775507cd7d2c3e35a97slive<seealso><a href="/filter.html">Filters</a> documentation</seealso>
4cf1c07a88ef51e11570c775507cd7d2c3e35a97slive</directivesynopsis>
4cf1c07a88ef51e11570c775507cd7d2c3e35a97slive<directivesynopsis>
4cf1c07a88ef51e11570c775507cd7d2c3e35a97slive<description>Sets the filters that will process responses from the
e6ab342447cf6b4c22bbe66169718d0e9b78819apoirierserver</description>
e6ab342447cf6b4c22bbe66169718d0e9b78819apoirier<syntax>SetOutputFilter <var>filter</var>[;<var>filter</var>...]</syntax>
e6ab342447cf6b4c22bbe66169718d0e9b78819apoirier<contextlist><context>server config</context><context>virtual host</context>
e6ab342447cf6b4c22bbe66169718d0e9b78819apoirier<context>directory</context><context>.htaccess</context>
e6ab342447cf6b4c22bbe66169718d0e9b78819apoirier</contextlist>
9b5e2c5e769dc678a1aca06df75c32022b2f1492trawick <p>The <directive>SetOutputFilter</directive> directive sets the filters
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive which will process responses from the server before they are
130d299c4b2b15be45532a176604c71fdc7bea5bnd sent to the client. This is in addition to any filters defined
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive elsewhere, including the
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen <directive module="mod_mime">AddOutputFilter</directive>
ef8e89e090461194ecadd31e8796a2c51e0531a2kess directive.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>For example, the following configuration will process all files
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen in the <code>/www/data/</code> directory for server-side
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess includes.</p>
7db9f691a00ead175b03335457ca296a33ddf31bnd SetOutputFilter INCLUDES<br />
href="http://httpd.apache.org/docs/misc/FAQ.html#prompted-twice">the