core.xml revision 221a06bb836af6024708190895834af79c90d1c8
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">
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor FreeBSD's Accept Filters</a>, Linux's more primitive
5ae609a8a09239d20f48a4a95c4f21b713995babwrowe <code>TCP_DEFER_ACCEPT</code>, and Windows' optimized AcceptEx()
5ae609a8a09239d20f48a4a95c4f21b713995babwrowe are currently supported.</p>
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor <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
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor the kernel level. Once an entire request is received, the kernel then
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor sends it to the server. See the
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna <a href="http://www.freebsd.org/cgi/man.cgi?query=accf_http&sektion=9">
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor 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
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor requests. Any value besides <code>none</code> will enable
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna <code>TCP_DEFER_ACCEPT</code> on that listener. For more details
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor 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
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor 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>
3770ed746d69c7a4111cba9966169bd5d7a509a6poirier<compatibility>Available in Apache httpd 2.0.46 and later.
3770ed746d69c7a4111cba9966169bd5d7a509a6poirierNoDecode 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)
3770ed746d69c7a4111cba9966169bd5d7a509a6poirier to be used in the path info.</p>
3770ed746d69c7a4111cba9966169bd5d7a509a6poirier <p>With the default value, <code>Off</code>, such URLs are refused
3770ed746d69c7a4111cba9966169bd5d7a509a6poirier with a 404 (Not found) error.</p>
3770ed746d69c7a4111cba9966169bd5d7a509a6poirier <p>With the value <code>On</code>, such URLs are accepted, and encoded
3770ed746d69c7a4111cba9966169bd5d7a509a6poirier slashes are decoded like all other encoded characters.</p>
3770ed746d69c7a4111cba9966169bd5d7a509a6poirier <p>With the value <code>NoDecode</code>, such URLs are accepted, but
3770ed746d69c7a4111cba9966169bd5d7a509a6poirier 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>
3770ed746d69c7a4111cba9966169bd5d7a509a6poirier <p>If encoded slashes are needed in path info, use of <code>NoDecode</code> is
3770ed746d69c7a4111cba9966169bd5d7a509a6poirier strongly recommended as a security measure. Allowing slashes
3770ed746d69c7a4111cba9966169bd5d7a509a6poirier to be decoded could potentially allow unsafe paths.</p>
77ead9e0262e4f08ec336d1a65b2edef7705c839nd<seealso><directive module="core">AcceptPathInfo</directive></seealso>
77ead9e0262e4f08ec336d1a65b2edef7705c839nd</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
003f0c9fda6664daf5092a0e42f65ede20098153slive<description>Types of directives that are allowed in
fb77c505254b6e9c925e23e734463e87574f8f40kess<syntax>AllowOverride All|None|<var>directive-type</var>
4ea161d94782fa56f4b36d496f35ff8577c43065covener<default>AllowOverride None (2.3.9 and later), AllowOverride All (2.3.8 and earlier)</default>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>directory</context></contextlist>
fb77c505254b6e9c925e23e734463e87574f8f40kess <p>When the server finds an <code>.htaccess</code> file (as
fb77c505254b6e9c925e23e734463e87574f8f40kess specified by <directive module="core">AccessFileName</directive>)
fb77c505254b6e9c925e23e734463e87574f8f40kess it needs to know which directives declared in that file can override
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess earlier configuration directives.</p>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <note><title>Only available in <Directory> sections</title>
10673857794a4b3d9568ca2d983722a87ed352f1rbowen <directive>AllowOverride</directive> is valid only in
fb77c505254b6e9c925e23e734463e87574f8f40kess <directive type="section" module="core">Directory</directive>
b12b918ae6baf9c5762ed61b7393d0e2198378c0nd sections specified without regular expressions, not in <directive
b12b918ae6baf9c5762ed61b7393d0e2198378c0nd type="section" module="core">Location</directive>, <directive
b12b918ae6baf9c5762ed61b7393d0e2198378c0nd module="core" type="section">DirectoryMatch</directive> or
b12b918ae6baf9c5762ed61b7393d0e2198378c0nd <directive type="section" module="core">Files</directive> sections.
113961f0559eb026ea0d379cb7350f82bc09d710druggeri <p>When this directive is set to <code>None</code> and <directive
113961f0559eb026ea0d379cb7350f82bc09d710druggeri module="core">AllowOverrideList</directive> is set to
113961f0559eb026ea0d379cb7350f82bc09d710druggeri <code>None</code> <a href="#accessfilename">.htaccess</a> files are
113961f0559eb026ea0d379cb7350f82bc09d710druggeri completely ignored. In this case, the server will not even attempt
113961f0559eb026ea0d379cb7350f82bc09d710druggeri 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
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>The <var>directive-type</var> can be one of the following
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive groupings of directives.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Allow use of the authorization directives (<directive
1f53e295ebd19aed1767d12da7abfab9936c148cjerenkrantz module="mod_authn_dbm">AuthDBMGroupFile</directive>,
1f53e295ebd19aed1767d12da7abfab9936c148cjerenkrantz <directive module="mod_authn_dbm">AuthDBMUserFile</directive>,
9ed9eaf871c58d281af02e76125ceadb5060afa5nd <directive module="mod_authz_groupfile">AuthGroupFile</directive>,
9cd3b05d7b70f07a742bbaf548fa4fa2bdbe5ce6noodl <directive module="mod_authn_core">AuthName</directive>,
9cd3b05d7b70f07a742bbaf548fa4fa2bdbe5ce6noodl <directive module="mod_authn_core">AuthType</directive>, <directive
1f53e295ebd19aed1767d12da7abfab9936c148cjerenkrantz module="mod_authn_file">AuthUserFile</directive>, <directive
9cd3b05d7b70f07a742bbaf548fa4fa2bdbe5ce6noodl module="mod_authz_core">Require</directive>, <em>etc.</em>).</dd>
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding Allow use of the directives controlling document types
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding (<directive module="core">ErrorDocument</directive>,
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding <directive module="mod_negotiation">LanguagePriority</directive>,
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding <directive module="core">SetInputFilter</directive>,
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding <directive module="core">SetOutputFilter</directive>, and
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding <module>mod_mime</module> Add* and Remove* directives),
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding 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
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem module="mod_rewrite">RewriteEngine</directive>, <directive
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem module="mod_rewrite">RewriteOptions</directive>, <directive
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem module="mod_rewrite">RewriteBase</directive>, <directive
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem module="mod_rewrite">RewriteCond</directive>, <directive
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem <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
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="mod_autoindex">HeaderName</directive>, <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="mod_autoindex">IndexIgnore</directive>, <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="mod_autoindex">IndexOptions</directive>, <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Allow use of the directives controlling host access (<directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Allow use of the directives controlling specific directory
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive features (<directive module="core">Options</directive> and
103a93c625bcde1a6a7a5155b64dcda36f612180pquerna <directive module="mod_include">XBitHack</directive>).
103a93c625bcde1a6a7a5155b64dcda36f612180pquerna An equal sign may be given followed by a comma (but no spaces)
f23fb63b05f89f47d7a3099491f2c68dcce432e9kess separated lists of options that may be set using the <directive
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim <p>Even though the list of options that may be used in .htaccess files
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim can be limited with this directive, as long as any <directive
9970ad80054f477c708284a0d030a5bd26e412a9covener module="core">Options</directive> directive is allowed any
9970ad80054f477c708284a0d030a5bd26e412a9covener other inherited option can be disabled by using the non-relative
9970ad80054f477c708284a0d030a5bd26e412a9covener syntax. In other words, this mechanism cannot force a specific option
9970ad80054f477c708284a0d030a5bd26e412a9covener to remain <em>set</em> while allowing any others to be set.
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd AllowOverride AuthConfig Indexes
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
b12b918ae6baf9c5762ed61b7393d0e2198378c0nd <p>In the example above all directives that are neither in the group
b12b918ae6baf9c5762ed61b7393d0e2198378c0nd <code>AuthConfig</code> nor <code>Indexes</code> cause an internal
b12b918ae6baf9c5762ed61b7393d0e2198378c0nd server error.</p>
da637bcae7b6e150470e701af29da5604a34a17erbowen <note><p>For security and performance reasons, do not set
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor <code>AllowOverride</code> to anything other than <code>None</code>
da637bcae7b6e150470e701af29da5604a34a17erbowen in your <code><Directory /></code> block. Instead, find (or
da637bcae7b6e150470e701af29da5604a34a17erbowen create) the <code><Directory></code> block that refers to the
da637bcae7b6e150470e701af29da5604a34a17erbowen directory where you're actually planning to place a
7802d43d20007fa575e43b6ae77d5177ceffdb71sf<seealso><directive module="core">AccessFileName</directive></seealso>
7802d43d20007fa575e43b6ae77d5177ceffdb71sf<seealso><directive module="core">AllowOverrideList</directive></seealso>
7802d43d20007fa575e43b6ae77d5177ceffdb71sf<seealso><a href="/configuring.html">Configuration Files</a></seealso>
7802d43d20007fa575e43b6ae77d5177ceffdb71sf<seealso><a href="/howto/htaccess.html">.htaccess Files</a></seealso>
86120957a14f91da0a1a103eaf4d7710b1dd9e2asf</directivesynopsis>
113961f0559eb026ea0d379cb7350f82bc09d710druggeri<directivesynopsis>
113961f0559eb026ea0d379cb7350f82bc09d710druggeri<description>Individual directives that are allowed in
113961f0559eb026ea0d379cb7350f82bc09d710druggeri<contextlist><context>directory</context></contextlist>
113961f0559eb026ea0d379cb7350f82bc09d710druggeri <p>When the server finds an <code>.htaccess</code> file (as
113961f0559eb026ea0d379cb7350f82bc09d710druggeri specified by <directive module="core">AccessFileName</directive>)
113961f0559eb026ea0d379cb7350f82bc09d710druggeri it needs to know which directives declared in that file can override
113961f0559eb026ea0d379cb7350f82bc09d710druggeri earlier configuration directives.</p>
113961f0559eb026ea0d379cb7350f82bc09d710druggeri <note><title>Only available in <Directory> sections</title>
113961f0559eb026ea0d379cb7350f82bc09d710druggeri <directive>AllowOverrideList</directive> is valid only in
113961f0559eb026ea0d379cb7350f82bc09d710druggeri <directive type="section" module="core">Directory</directive>
113961f0559eb026ea0d379cb7350f82bc09d710druggeri sections specified without regular expressions, not in <directive
113961f0559eb026ea0d379cb7350f82bc09d710druggeri type="section" module="core">Location</directive>, <directive
113961f0559eb026ea0d379cb7350f82bc09d710druggeri module="core" type="section">DirectoryMatch</directive> or
113961f0559eb026ea0d379cb7350f82bc09d710druggeri <directive type="section" module="core">Files</directive> sections.
113961f0559eb026ea0d379cb7350f82bc09d710druggeri <p>When this directive is set to <code>None</code> and <directive
113961f0559eb026ea0d379cb7350f82bc09d710druggeri module="core">AllowOverride</directive> is set to <code>None</code>,
113961f0559eb026ea0d379cb7350f82bc09d710druggeri then <a href="#accessfilename">.htaccess</a> files are completely
113961f0559eb026ea0d379cb7350f82bc09d710druggeri ignored. In this case, the server will not even attempt to read
113961f0559eb026ea0d379cb7350f82bc09d710druggeri <code>.htaccess</code> files in the filesystem.</p>
113961f0559eb026ea0d379cb7350f82bc09d710druggeri AllowOverride None
113961f0559eb026ea0d379cb7350f82bc09d710druggeri AllowOverrideList Redirect RedirectMatch
113961f0559eb026ea0d379cb7350f82bc09d710druggeri <p>In the example above only the <code>Redirect</code> and
113961f0559eb026ea0d379cb7350f82bc09d710druggeri <code>RedirectMatch</code> directives are allowed. All others will
113961f0559eb026ea0d379cb7350f82bc09d710druggeri cause an internal server error.</p>
113961f0559eb026ea0d379cb7350f82bc09d710druggeri AllowOverride AuthConfig
113961f0559eb026ea0d379cb7350f82bc09d710druggeri AllowOverrideList CookieTracking CookieName
113961f0559eb026ea0d379cb7350f82bc09d710druggeri <p>In the example above <directive module="core">AllowOverride
113961f0559eb026ea0d379cb7350f82bc09d710druggeri </directive> grants permission to the <code>AuthConfig</code>
113961f0559eb026ea0d379cb7350f82bc09d710druggeri directive grouping and <directive>AllowOverrideList</directive> grants
113961f0559eb026ea0d379cb7350f82bc09d710druggeri permission to only two directves from the <code>FileInfo</code> directive
113961f0559eb026ea0d379cb7350f82bc09d710druggeri grouping. All others will cause an internal server error.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive module="core">AccessFileName</directive></seealso>
113961f0559eb026ea0d379cb7350f82bc09d710druggeri<seealso><directive module="core">AllowOverride</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><a href="/configuring.html">Configuration Files</a></seealso>
54bcd0e21a5c79158afd3b78bf707a493a5fb33crbowen<seealso><a href="/howto/htaccess.html">.htaccess Files</a></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
4c7bdb15764021d39e486adb7bc2166d3f683773bnicholes<directivesynopsis>
fb77c505254b6e9c925e23e734463e87574f8f40kess<description>Technique for locating the interpreter for CGI
4c7bdb15764021d39e486adb7bc2166d3f683773bnicholesscripts</description>
fb77c505254b6e9c925e23e734463e87574f8f40kess<syntax>CGIMapExtension <var>cgi-path</var> <var>.extension</var></syntax>
4c7bdb15764021d39e486adb7bc2166d3f683773bnicholes<contextlist><context>directory</context><context>.htaccess</context>
4c7bdb15764021d39e486adb7bc2166d3f683773bnicholes</contextlist>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen <p>This directive is used to control how Apache httpd finds the
fb77c505254b6e9c925e23e734463e87574f8f40kess interpreter used to run CGI scripts. For example, setting
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess cause all CGI script files with a <code>.foo</code> extension to
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess be passed to the FOO interpreter.</p>
4c7bdb15764021d39e486adb7bc2166d3f683773bnicholes</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<description>Enables the generation of <code>Content-MD5</code> HTTP Response
fb77c505254b6e9c925e23e734463e87574f8f40kessheaders</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<context>directory</context><context>.htaccess</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This directive enables the generation of
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>Content-MD5</code> headers as defined in RFC1864
5bb5fba250bf526bc51d13b25378d54acb93c1cbnoodl respectively RFC2616.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>MD5 is an algorithm for computing a "message digest"
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive (sometimes called "fingerprint") of arbitrary-length data, with
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive a high degree of confidence that any alterations in the data
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive will be reflected in alterations in the message digest.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <code>Content-MD5</code> header provides an end-to-end
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive message integrity check (MIC) of the entity-body. A proxy or
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive client may check this header for detecting accidental
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive modification of the entity-body in transit. Example header:</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd Content-MD5: AuLb7Dp1rqtRtxz2m9kRpA==
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Note that this can cause performance problems on your server
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive since the message digest is computed on every request (the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive values are not cached).</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p><code>Content-MD5</code> is only sent for documents served
fb77c505254b6e9c925e23e734463e87574f8f40kess by the <module>core</module>, and not by any module. For example,
fb77c505254b6e9c925e23e734463e87574f8f40kess SSI documents, output from CGI scripts, and byte range responses
fb77c505254b6e9c925e23e734463e87574f8f40kess do not have this header.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding<description>This directive has no effect other than to emit warnings
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fieldingif the value is not <code>none</code>. In prior versions, DefaultType
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fieldingwould specify a default media type to assign to response content for
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fieldingwhich no other media type configuration could be found.
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding</description>
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding<syntax>DefaultType <var>media-type|none</var></syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<context>directory</context><context>.htaccess</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen<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>
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding <p>This directive has been disabled. For backwards compatibility
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding of configuration files, it may be specified with the value
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding <code>none</code>, meaning no default media type. For example:</p>
e4881891552e185a7408318dfc7f62ebabe73cf6niq DefaultType None
e4881891552e185a7408318dfc7f62ebabe73cf6niq </example>
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding <p><code>DefaultType None</code> is only available in
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding httpd-2.2.7 and later.</p>
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding <directive module="mod_mime">AddType</directive> to configure media
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding type assignments via file extensions, or the
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding <directive module="core">ForceType</directive> directive to configure
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding the media type for specific resources. Otherwise, the server will
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding send the response without a Content-Type header field and the
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding recipient may attempt to guess the media type.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
6e483e0b8aa3fa574288a7452221392a03e2b9a3noodl<directivesynopsis>
141fd59714368d3bbe3a3d8f5b8dc8a516c48f9fsf<syntax>Define <var>parameter-name</var> [<var>parameter-value</var>]</syntax>
141fd59714368d3bbe3a3d8f5b8dc8a516c48f9fsf<contextlist><context>server config</context><context>virtual host</context>
141fd59714368d3bbe3a3d8f5b8dc8a516c48f9fsf <p>In its one parameter form, <directive>Define</directive> is equivalent
141fd59714368d3bbe3a3d8f5b8dc8a516c48f9fsf to passing the <code>-D</code> argument to <program>httpd</program>. It
141fd59714368d3bbe3a3d8f5b8dc8a516c48f9fsf can be used to toggle the use of
141fd59714368d3bbe3a3d8f5b8dc8a516c48f9fsf <directive module="core" type="section">IfDefine</directive> sections
141fd59714368d3bbe3a3d8f5b8dc8a516c48f9fsf without needing to alter <code>-D</code> arguments in any startup
141fd59714368d3bbe3a3d8f5b8dc8a516c48f9fsf scripts.</p>
141fd59714368d3bbe3a3d8f5b8dc8a516c48f9fsf <p>In addition to that, if the second parameter is given, a config variable
141fd59714368d3bbe3a3d8f5b8dc8a516c48f9fsf is set to this value. The variable can be used in the configuration using
141fd59714368d3bbe3a3d8f5b8dc8a516c48f9fsf the <code>${VAR}</code> syntax. The variable is always globally defined
141fd59714368d3bbe3a3d8f5b8dc8a516c48f9fsf and not limited to the scope of the surrounding config section.</p>
141fd59714368d3bbe3a3d8f5b8dc8a516c48f9fsf <IfDefine TEST><br/>
141fd59714368d3bbe3a3d8f5b8dc8a516c48f9fsf </IfDefine><br/>
141fd59714368d3bbe3a3d8f5b8dc8a516c48f9fsf <IfDefine !TEST><br/>
141fd59714368d3bbe3a3d8f5b8dc8a516c48f9fsf Define SSL<br/>
141fd59714368d3bbe3a3d8f5b8dc8a516c48f9fsf </IfDefine><br/>
141fd59714368d3bbe3a3d8f5b8dc8a516c48f9fsf </example>
cba8c0896ba04d42cf9a9e50df5040fd6bae14a4sf <p>Variable names may not contain colon ":" characters, to avoid clashes
cba8c0896ba04d42cf9a9e50df5040fd6bae14a4sf with <directive module="mod_rewrite">RewriteMap</directive>'s syntax.</p>
6e483e0b8aa3fa574288a7452221392a03e2b9a3noodl</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Enclose a group of directives that apply only to the
898475b582dd849de5915df0f2089b72ed8b2e2bcovenernamed file-system directory, sub-directories, and their contents.</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive... </Directory></syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p><directive type="section">Directory</directive> and
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code></Directory></code> are used to enclose a group of
898475b582dd849de5915df0f2089b72ed8b2e2bcovener directives that will apply only to the named directory,
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor sub-directories of that directory, and the files within the respective
898475b582dd849de5915df0f2089b72ed8b2e2bcovener directories. Any directive that is allowed
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd in a directory context may be used. <var>Directory-path</var> is
003f0c9fda6664daf5092a0e42f65ede20098153slive either the full path to a directory, or a wild-card string using
fb77c505254b6e9c925e23e734463e87574f8f40kess Unix shell-style matching. In a wild-card string, <code>?</code> matches
fb77c505254b6e9c925e23e734463e87574f8f40kess any single character, and <code>*</code> matches any sequences of
fb77c505254b6e9c925e23e734463e87574f8f40kess characters. You may also use <code>[]</code> character ranges. None
fb77c505254b6e9c925e23e734463e87574f8f40kess of the wildcards match a `/' character, so <code><Directory
003f0c9fda6664daf5092a0e42f65ede20098153slive /*/public_html></code> will not match
003f0c9fda6664daf5092a0e42f65ede20098153slive <code>/home/user/public_html</code>, but <code><Directory
003f0c9fda6664daf5092a0e42f65ede20098153slive /home/*/public_html></code> will match. Example:</p>
130d299c4b2b15be45532a176604c71fdc7bea5bnd Options Indexes FollowSymLinks<br />
130d299c4b2b15be45532a176604c71fdc7bea5bnd </Directory>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>Be careful with the <var>directory-path</var> arguments:
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen They have to literally match the filesystem path which Apache httpd uses
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd to access the files. Directives applied to a particular
fb77c505254b6e9c925e23e734463e87574f8f40kess <code><Directory></code> will not apply to files accessed from
fb77c505254b6e9c925e23e734463e87574f8f40kess that same directory via a different path, such as via different symbolic
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd links.</p>
030108b1816bcda3d925df65357feabdce83bc94slive expressions</glossary> can also be used, with the addition of the
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <Directory ~ "^/www/.*/[0-9]{3}">
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
fb77c505254b6e9c925e23e734463e87574f8f40kess <p>would match directories in <code>/www/</code> that consisted of
fb77c505254b6e9c925e23e734463e87574f8f40kess three numbers.</p>
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess match the directory (or one of its parents) containing a document,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive then the directives are applied in the order of shortest match
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive first, interspersed with the directives from the <a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive href="#accessfilename">.htaccess</a> files. For example,
130d299c4b2b15be45532a176604c71fdc7bea5bnd <Directory /><br />
130d299c4b2b15be45532a176604c71fdc7bea5bnd AllowOverride None<br />
130d299c4b2b15be45532a176604c71fdc7bea5bnd </Directory><br />
cdffd1263801c18587cefdebc4510df486d5906brbowen <Directory /home><br />
130d299c4b2b15be45532a176604c71fdc7bea5bnd AllowOverride FileInfo<br />
130d299c4b2b15be45532a176604c71fdc7bea5bnd </Directory>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>for access to the document <code>/home/web/dir/doc.html</code>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the steps are:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <li>Apply directive <code>AllowOverride FileInfo</code> (for
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess <code>/home/.htaccess</code>, <code>/home/web/.htaccess</code> and
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess <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
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive configuration file. For example, with</p>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <Directory ~ abc$><br />
130d299c4b2b15be45532a176604c71fdc7bea5bnd # ... directives here ...<br />
130d299c4b2b15be45532a176604c71fdc7bea5bnd </Directory>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <p>the regular expression section won't be considered until after
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess all normal <directive type="section">Directory</directive>s and
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess <code>.htaccess</code> files have been applied. Then the regular
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess expression will match on <code>/home/abc/public_html/abc</code> and
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess the corresponding <directive type="section">Directory</directive> will
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess be applied.</p>
4e10c61d7f924071cad435df940a8f325015b2d3rbowen <code><Directory /></code> is to permit all access.
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen This means that Apache httpd will serve any file mapped from an URL. It is
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive recommended that you change this with a block such
130d299c4b2b15be45532a176604c71fdc7bea5bnd <Directory /><br />
4e10c61d7f924071cad435df940a8f325015b2d3rbowen Require all denied<br />
130d299c4b2b15be45532a176604c71fdc7bea5bnd </Directory>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive href="/misc/security_tips.html">Security Tips</a> page for more
fb77c505254b6e9c925e23e734463e87574f8f40kess <p>The directory sections occur in the <code>httpd.conf</code> file.
fb77c505254b6e9c925e23e734463e87574f8f40kess <directive type="section">Directory</directive> directives
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive cannot nest, and cannot appear in a <directive module="core"
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive type="section">Limit</directive> or <directive module="core"
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<seealso><a href="/sections.html">How <Directory>,
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <Location> and <Files> sections work</a> for an
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive explanation of how these different sections are combined when a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive request is received</seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<description>Enclose directives that apply to
898475b582dd849de5915df0f2089b72ed8b2e2bcovenerthe contents of file-system directories matching a regular expression.</description>
7b5535ed88e0f561b3bfb3330137bd804846afd4slive... </DirectoryMatch></syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p><directive type="section">DirectoryMatch</directive> and
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code></DirectoryMatch></code> are used to enclose a group
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor of directives which will apply only to the named directory (and the files within),
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor the same as <directive module="core" type="section">Directory</directive>.
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor However, it takes as an argument a
fa1c7ce09927decc1eecd1e9a35cc5331078a052covener <glossary ref="regex">regular expression</glossary>. For example:</p>
6954edc623ca2c179eb5b33e97e4304d06fd649frbowen <DirectoryMatch "^/www/(.+/)?[0-9]{3}">
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>would match directories in <code>/www/</code> that consisted of three
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive numbers.</p>
fa1c7ce09927decc1eecd1e9a35cc5331078a052covener Prior to 2.3.9, this directive implicitly applied to sub-directories
fa1c7ce09927decc1eecd1e9a35cc5331078a052covener (like <directive module="core" type="section">Directory</directive>) and
fa1c7ce09927decc1eecd1e9a35cc5331078a052covener could not match the end of line symbol ($). In 2.3.9 and later,
fa1c7ce09927decc1eecd1e9a35cc5331078a052covener only directories that match the expression are affected by the enclosed
fa1c7ce09927decc1eecd1e9a35cc5331078a052covener directives.
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor This directive applies to requests for directories that may or may
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor not end in a trailing slash, so expressions that are anchored to the
fa1c7ce09927decc1eecd1e9a35cc5331078a052covener end of line ($) must be written with care.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive type="section" module="core">Directory</directive> for
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivea description of how regular expressions are mixed in with normal
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<directive type="section">Directory</directive>s</seealso>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkesshref="/sections.html">How <Directory>, <Location> and
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<Files> sections work</a> for an explanation of how these different
313bb560bc5c323cfd40c9cad7335b4b8e060aedkesssections are combined when a request is received</seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
003f0c9fda6664daf5092a0e42f65ede20098153slive<description>Directory that forms the main document tree visible
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivefrom the web</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<default>DocumentRoot /usr/local/apache/htdocs</default>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
a1ef40892ffa2b44fc249423c5b6c42a74a84c68nd <p>This directive sets the directory from which <program>httpd</program>
fb77c505254b6e9c925e23e734463e87574f8f40kess will serve files. Unless matched by a directive like <directive
fb77c505254b6e9c925e23e734463e87574f8f40kess module="mod_alias">Alias</directive>, the server appends the
fb77c505254b6e9c925e23e734463e87574f8f40kess path from the requested URL to the document root to make the
fb77c505254b6e9c925e23e734463e87574f8f40kess path to the document. Example:</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>then an access to
ffe8ed2cd88be2c415ddef11f50394c52df9190ctrawick <code>http://my.example.com/index.html</code> refers to
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor <code>/usr/web/index.html</code>. If the <var>directory-path</var> is
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor not absolute then it is assumed to be relative to the <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <directive>DocumentRoot</directive> should be specified without
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive a trailing slash.</p>
1b01d1ee11c612226cb3141eed4581dc179266c1rbowen<seealso><a href="/urlmapping.html#documentroot">Mapping URLs to Filesystem
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
6b15044d54a096e6323ff1540f1a491e8de7622dsf<description>Contains directives that apply only if the condition of a
6b15044d54a096e6323ff1540f1a491e8de7622dsfprevious <directive type="section" module="core">If</directive> or
6b15044d54a096e6323ff1540f1a491e8de7622dsf<directive type="section" module="core">ElseIf</directive> section is not
6b15044d54a096e6323ff1540f1a491e8de7622dsfsatisfied by a request at runtime</description>
6b15044d54a096e6323ff1540f1a491e8de7622dsf<contextlist><context>server config</context><context>virtual host</context>
6b15044d54a096e6323ff1540f1a491e8de7622dsf</contextlist>
6b15044d54a096e6323ff1540f1a491e8de7622dsf <p>The <directive type="section">Else</directive> applies the enclosed
6b15044d54a096e6323ff1540f1a491e8de7622dsf directives if and only if the most recent
6b15044d54a096e6323ff1540f1a491e8de7622dsf in the same scope has not been applied.
6b15044d54a096e6323ff1540f1a491e8de7622dsf For example: In </p>
6b15044d54a096e6323ff1540f1a491e8de7622dsf <If "-z req('Host')"><br/>
6b15044d54a096e6323ff1540f1a491e8de7622dsf </If><br/>
6b15044d54a096e6323ff1540f1a491e8de7622dsf <Else><br/>
6b15044d54a096e6323ff1540f1a491e8de7622dsf </Else><br/>
6b15044d54a096e6323ff1540f1a491e8de7622dsf </example>
6b15044d54a096e6323ff1540f1a491e8de7622dsf <p> The <directive type="section">If</directive> would match HTTP/1.0
6b15044d54a096e6323ff1540f1a491e8de7622dsf <directive type="section">Else</directive> would match requests
6b15044d54a096e6323ff1540f1a491e8de7622dsf<seealso><directive type="section" module="core">If</directive></seealso>
6b15044d54a096e6323ff1540f1a491e8de7622dsf<seealso><directive type="section" module="core">ElseIf</directive></seealso>
6b15044d54a096e6323ff1540f1a491e8de7622dsf<seealso><a href="/sections.html">How <Directory>, <Location>,
6b15044d54a096e6323ff1540f1a491e8de7622dsf <Files> sections work</a> for an explanation of how these
6b15044d54a096e6323ff1540f1a491e8de7622dsf different sections are combined when a request is received.
6b15044d54a096e6323ff1540f1a491e8de7622dsf <directive type="section">Else</directive> are applied last.</seealso>
6b15044d54a096e6323ff1540f1a491e8de7622dsf</directivesynopsis>
6b15044d54a096e6323ff1540f1a491e8de7622dsf<description>Contains directives that apply only if a condition is satisfied
6b15044d54a096e6323ff1540f1a491e8de7622dsfby a request at runtime while the condition of a previous
6b15044d54a096e6323ff1540f1a491e8de7622dsf<directive type="section">ElseIf</directive> section is not
6b15044d54a096e6323ff1540f1a491e8de7622dsfsatisfied</description>
6b15044d54a096e6323ff1540f1a491e8de7622dsf<syntax><ElseIf <var>expression</var>> ... </ElseIf></syntax>
6b15044d54a096e6323ff1540f1a491e8de7622dsf<contextlist><context>server config</context><context>virtual host</context>
6b15044d54a096e6323ff1540f1a491e8de7622dsf</contextlist>
6b15044d54a096e6323ff1540f1a491e8de7622dsf <p>The <directive type="section">ElseIf</directive> applies the enclosed
6b15044d54a096e6323ff1540f1a491e8de7622dsf directives if and only if both the given condition evaluates to true and
6b15044d54a096e6323ff1540f1a491e8de7622dsf the most recent <directive type="section">If</directive> or
6b15044d54a096e6323ff1540f1a491e8de7622dsf <directive type="section">ElseIf</directive> section in the same scope has
6b15044d54a096e6323ff1540f1a491e8de7622dsf not been applied. For example: In </p>
6b15044d54a096e6323ff1540f1a491e8de7622dsf </If><br/>
6b15044d54a096e6323ff1540f1a491e8de7622dsf <ElseIf "-R '10.0.0.0/8'"><br/>
6b15044d54a096e6323ff1540f1a491e8de7622dsf </ElseIf><br/>
6b15044d54a096e6323ff1540f1a491e8de7622dsf <Else><br/>
6b15044d54a096e6323ff1540f1a491e8de7622dsf </Else><br/>
6b15044d54a096e6323ff1540f1a491e8de7622dsf </example>
6b15044d54a096e6323ff1540f1a491e8de7622dsf <p>The <directive type="section">ElseIf</directive> would match if
6b15044d54a096e6323ff1540f1a491e8de7622dsf the remote address of a request belongs to the subnet 10.0.0.0/8 but
6b15044d54a096e6323ff1540f1a491e8de7622dsf<seealso><a href="/expr.html">Expressions in Apache HTTP Server</a>,
6b15044d54a096e6323ff1540f1a491e8de7622dsffor a complete reference and more examples.</seealso>
6b15044d54a096e6323ff1540f1a491e8de7622dsf<seealso><directive type="section" module="core">If</directive></seealso>
6b15044d54a096e6323ff1540f1a491e8de7622dsf<seealso><directive type="section" module="core">Else</directive></seealso>
6b15044d54a096e6323ff1540f1a491e8de7622dsf<seealso><a href="/sections.html">How <Directory>, <Location>,
6b15044d54a096e6323ff1540f1a491e8de7622dsf <Files> sections work</a> for an explanation of how these
6b15044d54a096e6323ff1540f1a491e8de7622dsf different sections are combined when a request is received.
6b15044d54a096e6323ff1540f1a491e8de7622dsf <directive type="section">Else</directive> are applied last.</seealso>
6b15044d54a096e6323ff1540f1a491e8de7622dsf</directivesynopsis>
af18698b10b429b270551ca3a5d51a75e1c9db22brianp<directivesynopsis>
003f0c9fda6664daf5092a0e42f65ede20098153slive<description>Use memory-mapping to read files during delivery</description>
af18698b10b429b270551ca3a5d51a75e1c9db22brianp<contextlist><context>server config</context><context>virtual host</context>
af18698b10b429b270551ca3a5d51a75e1c9db22brianp<context>directory</context><context>.htaccess</context>
af18698b10b429b270551ca3a5d51a75e1c9db22brianp</contextlist>
a1ef40892ffa2b44fc249423c5b6c42a74a84c68nd <p>This directive controls whether the <program>httpd</program> may use
003f0c9fda6664daf5092a0e42f65ede20098153slive memory-mapping if it needs to read the contents of a file during
003f0c9fda6664daf5092a0e42f65ede20098153slive delivery. By default, when the handling of a request requires
fb77c505254b6e9c925e23e734463e87574f8f40kess access to the data within a file -- for example, when delivering a
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen server-parsed file using <module>mod_include</module> -- Apache httpd
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd memory-maps the file if the OS supports it.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>This memory-mapping sometimes yields a performance improvement.
af18698b10b429b270551ca3a5d51a75e1c9db22brianp But in some environments, it is better to disable the memory-mapping
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd to prevent operational problems:</p>
af18698b10b429b270551ca3a5d51a75e1c9db22brianp <li>On some multiprocessor systems, memory-mapping can reduce the
13cbe1d8f52c8097cb581e7eb259693b64d41d10poirier <li>Deleting or truncating a file while <program>httpd</program>
13cbe1d8f52c8097cb581e7eb259693b64d41d10poirier has it memory-mapped can cause <program>httpd</program> to
13cbe1d8f52c8097cb581e7eb259693b64d41d10poirier crash with a segmentation fault.
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>For server configurations that are vulnerable to these problems,
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd you should disable memory-mapping of delivered files by specifying:</p>
fb77c505254b6e9c925e23e734463e87574f8f40kess EnableMMAP Off
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
41ef8b3051855b802104193ee0a587515af60a37wrowe <p>For NFS mounted files, this feature may be disabled explicitly for
41ef8b3051855b802104193ee0a587515af60a37wrowe the offending files by specifying:</p>
41ef8b3051855b802104193ee0a587515af60a37wrowe <Directory "/path-to-nfs-files">
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess EnableMMAP Off
41ef8b3051855b802104193ee0a587515af60a37wrowe </Directory>
41ef8b3051855b802104193ee0a587515af60a37wrowe</directivesynopsis>
41ef8b3051855b802104193ee0a587515af60a37wrowe<directivesynopsis>
41ef8b3051855b802104193ee0a587515af60a37wrowe<description>Use the kernel sendfile support to deliver files to the client</description>
41ef8b3051855b802104193ee0a587515af60a37wrowe<contextlist><context>server config</context><context>virtual host</context>
41ef8b3051855b802104193ee0a587515af60a37wrowe<context>directory</context><context>.htaccess</context>
41ef8b3051855b802104193ee0a587515af60a37wrowe</contextlist>
9c233808c898095865fcc0a2dc1cf594d0d8faf3sf<compatibility>Available in version 2.0.44 and later. Default changed to Off in
9c233808c898095865fcc0a2dc1cf594d0d8faf3sfversion 2.3.9.</compatibility>
a1ef40892ffa2b44fc249423c5b6c42a74a84c68nd <p>This directive controls whether <program>httpd</program> may use the
a1ef40892ffa2b44fc249423c5b6c42a74a84c68nd sendfile support from the kernel to transmit file contents to the client.
41ef8b3051855b802104193ee0a587515af60a37wrowe By default, when the handling of a request requires no access
41ef8b3051855b802104193ee0a587515af60a37wrowe to the data within a file -- for example, when delivering a
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen static file -- Apache httpd uses sendfile to deliver the file contents
41ef8b3051855b802104193ee0a587515af60a37wrowe without ever reading the file if the OS supports it.</p>
9b5e2c5e769dc678a1aca06df75c32022b2f1492trawick <p>This sendfile mechanism avoids separate read and send operations,
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess and buffer allocations. But on some platforms or within some
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess filesystems, it is better to disable this feature to avoid
41ef8b3051855b802104193ee0a587515af60a37wrowe operational problems:</p>
41ef8b3051855b802104193ee0a587515af60a37wrowe <li>Some platforms may have broken sendfile support that the build
41ef8b3051855b802104193ee0a587515af60a37wrowe system did not detect, especially if the binaries were built on
9fb925624300c864fe3969a264e52aa83f3c2dd0slive another box and moved to such a machine with broken sendfile
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess support.</li>
78f4d313fd5edf76dc5cfb8725e082a08cd29740jwoolley <li>On Linux the use of sendfile triggers TCP-checksum
78f4d313fd5edf76dc5cfb8725e082a08cd29740jwoolley offloading bugs on certain networking cards when using IPv6.</li>
2025fe01de41805f6148851335693aa5ebe2faffnd <li>On Linux on Itanium, <code>sendfile</code> may be unable to handle
2025fe01de41805f6148851335693aa5ebe2faffnd files over 2GB in size.</li>
9c233808c898095865fcc0a2dc1cf594d0d8faf3sf module="core">DocumentRoot</directive> (e.g., NFS, SMB, CIFS, FUSE),
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess the kernel may be unable to serve the network file through
9fb925624300c864fe3969a264e52aa83f3c2dd0slive its own cache.</li>
9c233808c898095865fcc0a2dc1cf594d0d8faf3sf <p>For server configurations that are not vulnerable to these problems,
9c233808c898095865fcc0a2dc1cf594d0d8faf3sf you may enable this feature by specifying:</p>
9c233808c898095865fcc0a2dc1cf594d0d8faf3sf EnableSendfile On
9c233808c898095865fcc0a2dc1cf594d0d8faf3sf <p>For network mounted files, this feature may be disabled explicitly
9fb925624300c864fe3969a264e52aa83f3c2dd0slive for the offending files by specifying:</p>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <Directory "/path-to-nfs-files">
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess EnableSendfile Off
41ef8b3051855b802104193ee0a587515af60a37wrowe </Directory>
832853bb93c1831daf24e4727c5ca0e1b1786e83lars <p>Please note that the per-directory and .htaccess configuration
832853bb93c1831daf24e4727c5ca0e1b1786e83lars of <directive>EnableSendfile</directive> is not supported by
832853bb93c1831daf24e4727c5ca0e1b1786e83lars Only global definition of <directive>EnableSendfile</directive>
832853bb93c1831daf24e4727c5ca0e1b1786e83lars is taken into account by the module.
af18698b10b429b270551ca3a5d51a75e1c9db22brianp</directivesynopsis>
79c754eb51681c3389cd966753e902c429f78939trawick<directivesynopsis>
79c754eb51681c3389cd966753e902c429f78939trawick<description>Abort configuration parsing with a custom error message</description>
79c754eb51681c3389cd966753e902c429f78939trawick<contextlist><context>server config</context><context>virtual host</context>
79c754eb51681c3389cd966753e902c429f78939trawick<context>directory</context><context>.htaccess</context>
79c754eb51681c3389cd966753e902c429f78939trawick</contextlist>
79c754eb51681c3389cd966753e902c429f78939trawick <p>If an error can be detected within the configuration, this
79c754eb51681c3389cd966753e902c429f78939trawick directive can be used to generate a custom error message, and halt
79c754eb51681c3389cd966753e902c429f78939trawick configuration parsing. The typical use is for reporting required
79c754eb51681c3389cd966753e902c429f78939trawick modules which are missing from the configuration.</p>
79c754eb51681c3389cd966753e902c429f78939trawick # ensure that mod_include is loaded<br />
79c754eb51681c3389cd966753e902c429f78939trawick <IfModule !include_module><br />
79c754eb51681c3389cd966753e902c429f78939trawick Error mod_include is required by mod_foo. Load it with LoadModule.<br />
79c754eb51681c3389cd966753e902c429f78939trawick </IfModule><br />
79c754eb51681c3389cd966753e902c429f78939trawick # ensure that exactly one of SSL,NOSSL is defined<br />
79c754eb51681c3389cd966753e902c429f78939trawick <IfDefine SSL><br />
79c754eb51681c3389cd966753e902c429f78939trawick <IfDefine NOSSL><br />
79c754eb51681c3389cd966753e902c429f78939trawick Error Both SSL and NOSSL are defined. Define only one of them.<br />
79c754eb51681c3389cd966753e902c429f78939trawick </IfDefine><br />
79c754eb51681c3389cd966753e902c429f78939trawick </IfDefine><br />
79c754eb51681c3389cd966753e902c429f78939trawick <IfDefine !SSL><br />
79c754eb51681c3389cd966753e902c429f78939trawick <IfDefine !NOSSL><br />
79c754eb51681c3389cd966753e902c429f78939trawick Error Either SSL or NOSSL must be defined.<br />
79c754eb51681c3389cd966753e902c429f78939trawick </IfDefine><br />
79c754eb51681c3389cd966753e902c429f78939trawick </IfDefine><br />
79c754eb51681c3389cd966753e902c429f78939trawick</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
003f0c9fda6664daf5092a0e42f65ede20098153slive<description>What the server will return to the client
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivein case of an error</description>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<syntax>ErrorDocument <var>error-code</var> <var>document</var></syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<context>directory</context><context>.htaccess</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen <p>In the event of a problem or error, Apache httpd can be configured
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive to do one of four things,</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <li>redirect to a local <var>URL-path</var> to handle the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The first option is the default, while options 2-4 are
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive configured using the <directive>ErrorDocument</directive>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directive, which is followed by the HTTP response code and a URL
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen or a message. Apache httpd will sometimes offer additional information
69fba5b8aa0b0dc408f649cfdaab064ce120b05bslive <p>URLs can begin with a slash (/) for local web-paths (relative
69fba5b8aa0b0dc408f649cfdaab064ce120b05bslive to the <directive module="core">DocumentRoot</directive>), or be a
69fba5b8aa0b0dc408f649cfdaab064ce120b05bslive full URL which the client can resolve. Alternatively, a message
69fba5b8aa0b0dc408f649cfdaab064ce120b05bslive can be provided to be displayed by the browser. Examples:</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd ErrorDocument 500 http://foo.example.com/cgi-bin/tester<br />
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd ErrorDocument 403 "Sorry can't allow you access today"
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
f7fe99050600166042c04b8e595fb75499eed7f0geoff <p>Additionally, the special value <code>default</code> can be used
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen to specify Apache httpd's simple hardcoded message. While not required
f7fe99050600166042c04b8e595fb75499eed7f0geoff under normal circumstances, <code>default</code> will restore
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen Apache httpd's simple hardcoded message for configurations that would
f7fe99050600166042c04b8e595fb75499eed7f0geoff otherwise inherit an existing <directive>ErrorDocument</directive>.</p>
f7fe99050600166042c04b8e595fb75499eed7f0geoff ErrorDocument 404 default<br />
f7fe99050600166042c04b8e595fb75499eed7f0geoff </Directory>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Note that when you specify an <directive>ErrorDocument</directive>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive that points to a remote URL (ie. anything with a method such as
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen <code>http</code> in front of it), Apache HTTP Server will send a redirect to the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive client to tell it where to find the document, even if the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive document ends up being on the same server. This has several
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive implications, the most important being that the client will not
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive receive the original error status code, but instead will
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive receive a redirect status code. This in turn can confuse web
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive robots and other clients which try to determine if a URL is
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive valid using the status code. In addition, if you use a remote
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive URL in an <code>ErrorDocument 401</code>, the client will not
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive know to prompt the user for a password since it will not
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive receive the 401 status code. Therefore, <strong>if you use an
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <code>ErrorDocument 401</code> directive then it must refer to a local
fb77c505254b6e9c925e23e734463e87574f8f40kess <p>Microsoft Internet Explorer (MSIE) will by default ignore
fb77c505254b6e9c925e23e734463e87574f8f40kess server-generated error messages when they are "too small" and substitute
fb77c505254b6e9c925e23e734463e87574f8f40kess its own "friendly" error messages. The size threshold varies depending on
4f854c24127e28f7ad72ce9a39d4448aaf910fc1slive the type of error, but in general, if you make your error document
4f854c24127e28f7ad72ce9a39d4448aaf910fc1slive greater than 512 bytes, then MSIE will show the server-generated
4f854c24127e28f7ad72ce9a39d4448aaf910fc1slive error rather than masking it. More information is available in
9b5e2c5e769dc678a1aca06df75c32022b2f1492trawick Microsoft Knowledge Base article <a
fb77c505254b6e9c925e23e734463e87574f8f40kess href="http://support.microsoft.com/default.aspx?scid=kb;en-us;Q294807"
69fba5b8aa0b0dc408f649cfdaab064ce120b05bslive <p>Although most error messages can be overriden, there are certain
69fba5b8aa0b0dc408f649cfdaab064ce120b05bslive circumstances where the internal messages are used regardless of the
69fba5b8aa0b0dc408f649cfdaab064ce120b05bslive setting of <directive module="core">ErrorDocument</directive>. In
69fba5b8aa0b0dc408f649cfdaab064ce120b05bslive particular, if a malformed request is detected, normal request processing
69fba5b8aa0b0dc408f649cfdaab064ce120b05bslive will be immediately halted and the internal error message returned.
69fba5b8aa0b0dc408f649cfdaab064ce120b05bslive This is necessary to guard against security problems caused by
69fba5b8aa0b0dc408f649cfdaab064ce120b05bslive bad requests.</p>
b5d3d68a9f683722eac7a3ca507c3e571908dfc0rbowen <p>If you are using mod_proxy, you may wish to enable
b5d3d68a9f683722eac7a3ca507c3e571908dfc0rbowen <directive module="mod_proxy">ProxyErrorOverride</directive> so that you can provide
b5d3d68a9f683722eac7a3ca507c3e571908dfc0rbowen custom error messages on behalf of your Origin servers. If you don't enable ProxyErrorOverride,
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen Apache httpd will not generate custom error documents for proxied content.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<description>Location where the server will log errors</description>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<syntax> ErrorLog <var>file-path</var>|syslog[:<var>facility</var>]</syntax>
4a13940dc2990df0a798718d3a3f9cf1566c2217bjh<default>ErrorLog logs/error_log (Unix) ErrorLog logs/error.log (Windows and OS/2)</default>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <directive>ErrorLog</directive> directive sets the name of
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the file to which the server will log any errors it encounters. If
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor the <var>file-path</var> is not absolute then it is assumed to be
c68acc9d712af079afa2bd1a5a4aeef9a3ea573ckess relative to the <directive module="core">ServerRoot</directive>.</p>
960188481b7025ac8ef7221b67af83dd27e46cd0rjung begins with a pipe character "<code>|</code>" then it is assumed to be a
960188481b7025ac8ef7221b67af83dd27e46cd0rjung command to spawn to handle the error log.</p>
960188481b7025ac8ef7221b67af83dd27e46cd0rjung <p>See the notes on <a href="/logs.html#piped">piped logs</a> for
960188481b7025ac8ef7221b67af83dd27e46cd0rjung more information.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Using <code>syslog</code> instead of a filename enables logging
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive via syslogd(8) if the system supports it. The default is to use
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive syslog facility <code>local7</code>, but you can override this by
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd using the <code>syslog:<var>facility</var></code> syntax where
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <var>facility</var> can be one of the names usually documented in
5155e92c6100b47513159eee1b2b9914ab204a5acovener syslog(1). The facility is effectively global, and if it is changed
5155e92c6100b47513159eee1b2b9914ab204a5acovener in individual virtual hosts, the final facility specified affects the
5155e92c6100b47513159eee1b2b9914ab204a5acovener entire server.</p>
fb109b84906e3ee61680aa289953c2f9e859354erbowen ErrorLog syslog:user
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive href="/misc/security_tips.html#serverroot">security tips</a>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive document for details on why your security could be compromised
9b5e2c5e769dc678a1aca06df75c32022b2f1492trawick if the directory where log files are stored is writable by
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive anyone other than the user that starts the server.</p>
2bac697634d965d9d9a921a99a68b2c454c8a95dbnicholes <p>When entering a file path on non-Unix platforms, care should be taken
d950cf9262224a223e2ff5c51393708071e14b94covener to make sure that only forward slashes are used even though the platform
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor may allow the use of back slashes. In general it is a good idea to always
2bac697634d965d9d9a921a99a68b2c454c8a95dbnicholes use forward slashes throughout the configuration files.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive module="core">LogLevel</directive></seealso>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen<seealso><a href="/logs.html">Apache HTTP Server Log Files</a></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf<directivesynopsis>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf<description>Format specification for error log entries</description>
2851546ce44280e54301016a7e92b00a87745509sf<syntax> ErrorLogFormat [connection|request] <var>format</var></syntax>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf<contextlist><context>server config</context><context>virtual host</context>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf</contextlist>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf<compatibility>Available in Apache httpd 2.3.9 and later</compatibility>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf <p><directive>ErrorLogFormat</directive> allows to specify what
e302f38fd646764ce1a1e1c578d794aef514a9e5sf supplementary information is logged in the error log in addition to the
e302f38fd646764ce1a1e1c578d794aef514a9e5sf actual log message.</p>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf ErrorLogFormat "[%t] [%l] [pid %P] %F: %E: [client %a] %M"
e302f38fd646764ce1a1e1c578d794aef514a9e5sf </example>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf <p>Specifying <code>connection</code> or <code>request</code> as first
18ee8bb3db5cc3b04291f89301bd5d14dc271066lgentis parameter allows to specify additional formats, causing additional
e302f38fd646764ce1a1e1c578d794aef514a9e5sf information to be logged when the first message is logged for a specific
b89fea36d9c12cec3344576824f4e6798da90ad4rbowen connection or request, respectively. This additional information is only
e302f38fd646764ce1a1e1c578d794aef514a9e5sf logged once per connection/request. If a connection or request is processed
e302f38fd646764ce1a1e1c578d794aef514a9e5sf without causing any log message, the additional information is not logged
e302f38fd646764ce1a1e1c578d794aef514a9e5sf either.</p>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf <p>It can happen that some format string items do not produce output. For
e302f38fd646764ce1a1e1c578d794aef514a9e5sf example, the Referer header is only present if the log message is
e302f38fd646764ce1a1e1c578d794aef514a9e5sf associated to a request and the log message happens at a time when the
e302f38fd646764ce1a1e1c578d794aef514a9e5sf Referer header has already been read from the client. If no output is
b89fea36d9c12cec3344576824f4e6798da90ad4rbowen produced, the default behavior is to delete everything from the preceeding
e302f38fd646764ce1a1e1c578d794aef514a9e5sf space character to the next space character. This means the log line is
e302f38fd646764ce1a1e1c578d794aef514a9e5sf implicitly divided into fields on non-whitespace to whitespace transitions.
e302f38fd646764ce1a1e1c578d794aef514a9e5sf If a format string item does not produce output, the whole field is
e302f38fd646764ce1a1e1c578d794aef514a9e5sf ommitted. For example, if the remote address <code>%a</code> in the log
e302f38fd646764ce1a1e1c578d794aef514a9e5sf format <code>[%t] [%l] [%a] %M </code> is not available, the surrounding
e302f38fd646764ce1a1e1c578d794aef514a9e5sf brackets are not logged either. Space characters can be escaped with a
e302f38fd646764ce1a1e1c578d794aef514a9e5sf backslash to prevent them from delimiting a field. The combination '% '
e302f38fd646764ce1a1e1c578d794aef514a9e5sf (percent space) is a zero-witdh field delimiter that does not produce any
e302f38fd646764ce1a1e1c578d794aef514a9e5sf output.</p>
b89fea36d9c12cec3344576824f4e6798da90ad4rbowen <p>The above behavior can be changed by adding modifiers to the format
b5c4b00201fdc3ed11c6cc05cf3f9a7912ac0cfbsf string item. A <code>-</code> (minus) modifier causes a minus to be logged if the
e302f38fd646764ce1a1e1c578d794aef514a9e5sf respective item does not produce any output. In once-per-connection/request
b5c4b00201fdc3ed11c6cc05cf3f9a7912ac0cfbsf formats, it is also possible to use the <code>+</code> (plus) modifier. If an
b5c4b00201fdc3ed11c6cc05cf3f9a7912ac0cfbsf item with the plus modifier does not produce any output, the whole line is
e302f38fd646764ce1a1e1c578d794aef514a9e5sf ommitted.</p>
b5c4b00201fdc3ed11c6cc05cf3f9a7912ac0cfbsf <p>A number as modifier can be used to assign a log severity level to a
b5c4b00201fdc3ed11c6cc05cf3f9a7912ac0cfbsf format item. The item will only be logged if the severity of the log
b5c4b00201fdc3ed11c6cc05cf3f9a7912ac0cfbsf message is not higher than the specified log severity level. The number can
b5c4b00201fdc3ed11c6cc05cf3f9a7912ac0cfbsf range from 1 (alert) over 4 (warn) and 7 (debug) to 15 (trace8).</p>
221a06bb836af6024708190895834af79c90d1c8rbowen <p>For example, here's what would happen if you added modifiers to
b89fea36d9c12cec3344576824f4e6798da90ad4rbowen <columnspec><column width=".3"/><column width=".7"/></columnspec>
b89fea36d9c12cec3344576824f4e6798da90ad4rbowen <td>Logs a <code>-</code> if <code>Referer</code> is not set.</td>
b89fea36d9c12cec3344576824f4e6798da90ad4rbowen <td>Omits the entire line if <code>Referer</code> is not set.</td>
b89fea36d9c12cec3344576824f4e6798da90ad4rbowen <td>Logs the <code>Referer</code> only if the log message severity
b89fea36d9c12cec3344576824f4e6798da90ad4rbowen is higher than 4.</td>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf <p>Some format string items accept additional parameters in braces.</p>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf <columnspec><column width=".2"/><column width=".8"/></columnspec>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf <tr><th>Format String</th> <th>Description</th></tr>
0b5f11662dee7135ff8dd04311a4ee6df7fe2b1crbowen <td>Request environment variable <em>name</em></td></tr>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf <td>Source file name and line number of the log call</td></tr>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf <td>Number of keep-alive requests on this connection</td></tr>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf <td>Log ID of the connection if used in connection scope, empty otherwise</td></tr>
b08558bf6a64f9501ad3eca34eaf4d978bd928cfsf <td>System unique thread ID of current thread (the same ID as
b08558bf6a64f9501ad3eca34eaf4d978bd928cfsf displayed by e.g. <code>top</code>; currently Linux only)</td></tr>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf <td>The current time in compact ISO 8601 format, including
9228509ac5da8374df4a5d50b7da139e7b31f8a3sf <td>The canonical <directive module="core">ServerName</directive>
9228509ac5da8374df4a5d50b7da139e7b31f8a3sf <td>The server name of the server serving the request according to the
e302f38fd646764ce1a1e1c578d794aef514a9e5sf <p>The log ID format <code>%L</code> produces a unique id for a connection
e302f38fd646764ce1a1e1c578d794aef514a9e5sf or request. This can be used to correlate which log lines belong to the
e302f38fd646764ce1a1e1c578d794aef514a9e5sf same connection or request, which request happens on which connection.
e302f38fd646764ce1a1e1c578d794aef514a9e5sf <module>mod_log_config</module>, to allow to correlate access log entries
ce4dc40a4e87991087488f70d96d3447d7557294sf with error log lines. If <module>mod_unique_id</module> is loaded, its
ce4dc40a4e87991087488f70d96d3447d7557294sf unique id will be used as log ID for requests.</p>
abdaaa23d72ef7e7ff91eab9c5581d40130680c1rbowen ErrorLogFormat "[%{u}t] [%-m:%l] [pid %P:tid %T] %7F: %E: [client\ %a]
e302f38fd646764ce1a1e1c578d794aef514a9e5sf %M% ,\ referer\ %{Referer}i"
e302f38fd646764ce1a1e1c578d794aef514a9e5sf </example>
abdaaa23d72ef7e7ff91eab9c5581d40130680c1rbowen [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
abdaaa23d72ef7e7ff91eab9c5581d40130680c1rbowen <p>Notice that, as discussed above, some fields are ommitted
abdaaa23d72ef7e7ff91eab9c5581d40130680c1rbowen entirely because they are not defined.</p>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf <example><title>Example (similar to the 2.2.x format)</title>
b5c4b00201fdc3ed11c6cc05cf3f9a7912ac0cfbsf ErrorLogFormat "[%t] [%l] %7F: %E: [client\ %a]
e302f38fd646764ce1a1e1c578d794aef514a9e5sf %M% ,\ referer\ %{Referer}i"
e302f38fd646764ce1a1e1c578d794aef514a9e5sf </example>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf <example><title>Advanced example with request/connection log IDs</title>
b5c4b00201fdc3ed11c6cc05cf3f9a7912ac0cfbsf ErrorLogFormat "[%{uc}t] [%-m:%-l] [R:%L] [C:%{C}L] %7F: %E: %M"<br/>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf ErrorLogFormat request "[%{uc}t] [R:%L] Request %k on C:%{c}L pid:%P tid:%T"<br/>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf ErrorLogFormat request "[%{uc}t] [R:%L] UA:'%+{User-Agent}i'"<br/>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf ErrorLogFormat request "[%{uc}t] [R:%L] Referer:'%+{Referer}i'"<br/>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf ErrorLogFormat connection "[%{uc}t] [C:%{c}L] local\ %a remote\ %A"<br/>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf </example>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf<seealso><directive module="core">ErrorLog</directive></seealso>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf<seealso><directive module="core">LogLevel</directive></seealso>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf<seealso><a href="/logs.html">Apache HTTP Server Log Files</a></seealso>
e302f38fd646764ce1a1e1c578d794aef514a9e5sf</directivesynopsis>
a8ee031b2224ce5473826c9d4f603681589245fawrowe<directivesynopsis>
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor<description>Keep track of extended status information for each
a8ee031b2224ce5473826c9d4f603681589245fawrowerequest</description>
a8ee031b2224ce5473826c9d4f603681589245fawrowe<contextlist><context>server config</context></contextlist>
a8ee031b2224ce5473826c9d4f603681589245fawrowe <p>This option tracks additional data per worker about the
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor currently executing request, and a utilization summary; you
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor can see these variables during runtime by configuring
a8ee031b2224ce5473826c9d4f603681589245fawrowe <module>mod_status</module>. Note that other modules may
a8ee031b2224ce5473826c9d4f603681589245fawrowe rely on this scoreboard.</p>
a8ee031b2224ce5473826c9d4f603681589245fawrowe <p>This setting applies to the entire server, and cannot be
a8ee031b2224ce5473826c9d4f603681589245fawrowe enabled or disabled on a virtualhost-by-virtualhost basis.
a8ee031b2224ce5473826c9d4f603681589245fawrowe The collection of extended status information can slow down
a8ee031b2224ce5473826c9d4f603681589245fawrowe the server. Also note that this setting cannot be changed
a8ee031b2224ce5473826c9d4f603681589245fawrowe during a graceful restart.</p>
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor <p>Note that loading <module>mod_status</module> will change
a8ee031b2224ce5473826c9d4f603681589245fawrowe the default behavior to ExtendedStatus On, while other
a8ee031b2224ce5473826c9d4f603681589245fawrowe third party modules may do the same. Such modules rely on
a8ee031b2224ce5473826c9d4f603681589245fawrowe collecting detailed information about the state of all workers.
a8ee031b2224ce5473826c9d4f603681589245fawrowe The default is changed by <module>mod_status</module> beginning
02c86afa991026c4146423dc84bc126e57d28df6wrowe with version 2.3.6; the previous default was always Off.</p>
a8ee031b2224ce5473826c9d4f603681589245fawrowe</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
003f0c9fda6664daf5092a0e42f65ede20098153slive<description>File attributes used to create the ETag
a5f060e0c74a44cb8896ae794c08f94f7c9a46a7covenerHTTP response header for static files</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<context>directory</context><context>.htaccess</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive The <directive>FileETag</directive> directive configures the file
fb77c505254b6e9c925e23e734463e87574f8f40kess attributes that are used to create the <code>ETag</code> (entity
a5f060e0c74a44cb8896ae794c08f94f7c9a46a7covener tag) response header field when the document is based on a static file.
fb77c505254b6e9c925e23e734463e87574f8f40kess (The <code>ETag</code> value is used in cache management to save
c976a7c7d20f2be319b128dd7d0b1568da224c0arbowen network bandwidth.) The
fb77c505254b6e9c925e23e734463e87574f8f40kess <directive>FileETag</directive> directive allows you to choose
fb77c505254b6e9c925e23e734463e87574f8f40kess which of these -- if any -- should be used. The recognized keywords are:
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <dd>The file's i-node number will be included in the calculation</dd>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <dd>The date and time the file was last modified will be included</dd>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <dd>The number of bytes in the file will be included</dd>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <dd>All available fields will be used. This is equivalent to:
fb77c505254b6e9c925e23e734463e87574f8f40kess <dd>If a document is file-based, no <code>ETag</code> field will be
fb77c505254b6e9c925e23e734463e87574f8f40kess included in the response</dd>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>The <code>INode</code>, <code>MTime</code>, and <code>Size</code>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd keywords may be prefixed with either <code>+</code> or <code>-</code>,
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd which allow changes to be made to the default setting inherited
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd from a broader scope. Any keyword appearing without such a prefix
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd immediately and completely cancels the inherited setting.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>If a directory's configuration includes
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <code>FileETag INode MTime Size</code>, and a
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd subdirectory's includes <code>FileETag -INode</code>,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the setting for that subdirectory (which will be inherited by
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive any sub-subdirectories that don't override it) will be equivalent to
0db981f8fdfb62c5149efa079f0369b73d472d04rpluem Do not change the default for directories or locations that have WebDAV
0db981f8fdfb62c5149efa079f0369b73d472d04rpluem enabled and use <module>mod_dav_fs</module> as a storage provider.
0db981f8fdfb62c5149efa079f0369b73d472d04rpluem <module>mod_dav_fs</module> uses <code>INode MTime Size</code>
0db981f8fdfb62c5149efa079f0369b73d472d04rpluem as a fixed format for <code>ETag</code> comparisons on conditional requests.
0db981f8fdfb62c5149efa079f0369b73d472d04rpluem These conditional requests will break if the <code>ETag</code> format is
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor An ETag is not generated for responses parsed by <module>mod_include</module>,
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor since the response entity can change without a change of the INode, MTime, or Size
a5f060e0c74a44cb8896ae794c08f94f7c9a46a7covener of the static file with embedded SSI directives.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
003f0c9fda6664daf5092a0e42f65ede20098153slive<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<context>directory</context><context>.htaccess</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <directive type="section">Files</directive> directive
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess limits the scope of the enclosed directives by filename. It is comparable
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess to the <directive module="core" type="section">Directory</directive>
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess and <directive module="core" type="section">Location</directive>
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess directives. It should be matched with a <code></Files></code>
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess directive. The directives given within this section will be applied to
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess any object with a basename (last component of filename) matching the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive 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
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive that <directive type="section">Files</directive> can be nested
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="core">Directory</directive> sections to restrict the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive portion of the filesystem they apply to.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>The <var>filename</var> argument should include a filename, or
fb77c505254b6e9c925e23e734463e87574f8f40kess a wild-card string, where <code>?</code> matches any single character,
030108b1816bcda3d925df65357feabdce83bc94slive and <code>*</code> matches any sequences of characters.
030108b1816bcda3d925df65357feabdce83bc94slive can also be used, with the addition of the
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <Files ~ "\.(gif|jpe?g|png)$">
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <p>would match most common Internet graphics formats. <directive
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess module="core" type="section">FilesMatch</directive> is preferred,
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess however.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="core">Directory</directive> and <directive type="section"
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="core">Location</directive> sections, <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive type="section">Files</directive> sections can be used inside
fb77c505254b6e9c925e23e734463e87574f8f40kess <code>.htaccess</code> files. This allows users to control access to
fb77c505254b6e9c925e23e734463e87574f8f40kess their own files, at a file-by-file level.</p>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<seealso><a href="/sections.html">How <Directory>, <Location>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess and <Files> sections work</a> for an explanation of how these
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess different sections are combined when a request is received</seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
003f0c9fda6664daf5092a0e42f65ede20098153slive<description>Contains directives that apply to regular-expression matched
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivefilenames</description>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<syntax><FilesMatch <var>regex</var>> ... </FilesMatch></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">FilesMatch</directive> directive
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess limits the scope of the enclosed directives by filename, just as the
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess <directive module="core" type="section">Files</directive> directive
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor does. However, it accepts a <glossary ref="regex">regular
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <FilesMatch "\.(gif|jpe?g|png)$">
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>would match most common Internet graphics formats.</p>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<seealso><a href="/sections.html">How <Directory>, <Location>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess and <Files> sections work</a> for an explanation of how these
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess different sections are combined when a request is received</seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Forces all matching files to be served with the specified
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fieldingmedia type in the HTTP Content-Type header field</description>
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding<syntax>ForceType <var>media-type</var>|None</syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>directory</context><context>.htaccess</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen<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
fb77c505254b6e9c925e23e734463e87574f8f40kess <directive type="section" module="core">Location</directive> or
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive type="section" module="core">Files</directive>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive section, this directive forces all matching files to be served
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive with the content type identification given by
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding <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>,
fb77c505254b6e9c925e23e734463e87574f8f40kess you might want to use:</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding <p>Note that this directive overrides other indirect media type
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding associations defined in mime.types or via the
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding <directive module="mod_mime">AddType</directive>.</p>
b24c77ceb4cea5ffa92536e19f0aa83608960dc4fielding <p>You can also override more general
7654193c1faf603feec999850322ad79e6c551bcnd <Location /images><br />
7654193c1faf603feec999850322ad79e6c551bcnd </Location><br />
7654193c1faf603feec999850322ad79e6c551bcnd # but normal mime-type associations here:<br />
c97e8972ab1f4dd167e3dc4db87daf91114009fbnd ForceType None<br />
7654193c1faf603feec999850322ad79e6c551bcnd </Location>
7654193c1faf603feec999850322ad79e6c551bcnd </example>
439acee10571861c670c438038a62f90a08bf137covener <p>This directive primarily overrides the content types generated for
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor static files served out of the filesystem. For resources other than
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor static files, where the generator of the response typically specifies
439acee10571861c670c438038a62f90a08bf137covener a Content-Type, this directive has no effect.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
c3e2e664a67b1adb9b6a6b91ff161f4f562cecf6covener<directivesynopsis>
c3e2e664a67b1adb9b6a6b91ff161f4f562cecf6covener<description>Directory to write gmon.out profiling data to. </description>
c3e2e664a67b1adb9b6a6b91ff161f4f562cecf6covener<syntax>GprofDir <var>/tmp/gprof/</var>|<var>/tmp/gprof/</var>%</syntax>
c3e2e664a67b1adb9b6a6b91ff161f4f562cecf6covener<contextlist><context>server config</context><context>virtual host</context>
c3e2e664a67b1adb9b6a6b91ff161f4f562cecf6covener</contextlist>
c3e2e664a67b1adb9b6a6b91ff161f4f562cecf6covener <p>When the server has been compiled with gprof profiling suppport,
c3e2e664a67b1adb9b6a6b91ff161f4f562cecf6covener <directive>GprofDir</directive> causes <code>gmon.out</code> files to
c3e2e664a67b1adb9b6a6b91ff161f4f562cecf6covener be written to the specified directory when the process exits. If the
c3e2e664a67b1adb9b6a6b91ff161f4f562cecf6covener argument ends with a percent symbol ('%'), subdirectories are created
c3e2e664a67b1adb9b6a6b91ff161f4f562cecf6covener for each process id.</p>
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor <p>This directive currently only works with the <module>prefork</module>
c3e2e664a67b1adb9b6a6b91ff161f4f562cecf6covener</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Enables DNS lookups on client IP addresses</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This directive enables DNS lookups so that host names can be
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive logged (and passed to CGIs/SSIs in <code>REMOTE_HOST</code>).
fb77c505254b6e9c925e23e734463e87574f8f40kess The value <code>Double</code> refers to doing double-reverse
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess DNS lookup. That is, after a reverse lookup is performed, a forward
9b5e2c5e769dc678a1aca06df75c32022b2f1492trawick lookup is then performed on that result. At least one of the IP
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive addresses in the forward lookup must match the original
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive address. (In "tcpwrappers" terminology this is called
9ed9eaf871c58d281af02e76125ceadb5060afa5nd <p>Regardless of the setting, when <module>mod_authz_host</module> is
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive used for controlling access by hostname, a double reverse lookup
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive will be performed. This is necessary for security. Note that the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive result of this double-reverse isn't generally available unless you
fb77c505254b6e9c925e23e734463e87574f8f40kess set <code>HostnameLookups Double</code>. For example, if only
fb77c505254b6e9c925e23e734463e87574f8f40kess <code>HostnameLookups On</code> and a request is made to an object
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive that is protected by hostname restrictions, regardless of whether
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the double-reverse fails or not, CGIs will still be passed the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive single-reverse result in <code>REMOTE_HOST</code>.</p>
fb77c505254b6e9c925e23e734463e87574f8f40kess <p>The default is <code>Off</code> in order to save the network
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive traffic for those sites that don't truly need the reverse
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive lookups done. It is also better for the end users because they
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive don't have to suffer the extra latency that a lookup entails.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Heavily loaded sites should leave this directive
fb77c505254b6e9c925e23e734463e87574f8f40kess <code>Off</code>, since DNS lookups can take considerable
a1ef40892ffa2b44fc249423c5b6c42a74a84c68nd amounts of time. The utility <program>logresolve</program>, compiled by
a1ef40892ffa2b44fc249423c5b6c42a74a84c68nd default to the <code>bin</code> subdirectory of your installation
a1ef40892ffa2b44fc249423c5b6c42a74a84c68nd directory, can be used to look up host names from logged IP addresses
a1ef40892ffa2b44fc249423c5b6c42a74a84c68nd offline.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
750d12c59545dbbac70390988de94f7e901b08f2niq<description>Contains directives that apply only if a condition is
750d12c59545dbbac70390988de94f7e901b08f2niqsatisfied by a request at runtime</description>
750d12c59545dbbac70390988de94f7e901b08f2niq<syntax><If <var>expression</var>> ... </If></syntax>
750d12c59545dbbac70390988de94f7e901b08f2niq<contextlist><context>server config</context><context>virtual host</context>
750d12c59545dbbac70390988de94f7e901b08f2niq</contextlist>
750d12c59545dbbac70390988de94f7e901b08f2niq <p>The <directive type="section">If</directive> directive
750d12c59545dbbac70390988de94f7e901b08f2niq evaluates an expression at runtime, and applies the enclosed
750d12c59545dbbac70390988de94f7e901b08f2niq directives if and only if the expression evaluates to true.
750d12c59545dbbac70390988de94f7e901b08f2niq For example:</p>
6b15044d54a096e6323ff1540f1a491e8de7622dsf <If "-z req('Host')">
750d12c59545dbbac70390988de94f7e901b08f2niq </example>
6b15044d54a096e6323ff1540f1a491e8de7622dsf <p>would match HTTP/1.0 requests without a <var>Host:</var> header.
6b15044d54a096e6323ff1540f1a491e8de7622dsf Expressions may contain various shell-like operators for string
6b15044d54a096e6323ff1540f1a491e8de7622dsf comparison (<code>=</code>, <code>!=</code>, <code><</code>, ...),
6b15044d54a096e6323ff1540f1a491e8de7622dsf integer comparison (<code>-eq</code>, <code>-ne</code>, ...),
6b15044d54a096e6323ff1540f1a491e8de7622dsf and others (<code>-n</code>, <code>-z</code>, <code>-f</code>, ...).
6b15044d54a096e6323ff1540f1a491e8de7622dsf It is also possible to use regular expressions, </p>
011e567af90fe9d72bbabf8cc5e373b4436b9d08rbowen <If "%{QUERY_STRING} =~ /(delete|commit)=.*?elem/">
6b15044d54a096e6323ff1540f1a491e8de7622dsf <p>shell-like pattern matches and many other operations. These operations
6b15044d54a096e6323ff1540f1a491e8de7622dsf can be done on request headers (<code>req</code>), environment variables
6b15044d54a096e6323ff1540f1a491e8de7622dsf (<code>env</code>), and a large number of other properties. The full
6b15044d54a096e6323ff1540f1a491e8de7622dsf documentation is available in <a href="/expr.html">Expressions in
94aba9caa9b2f7a0e95a55f51264c908b69470e2igalic<seealso><a href="/expr.html">Expressions in Apache HTTP Server</a>,
94aba9caa9b2f7a0e95a55f51264c908b69470e2igalicfor a complete reference and more examples.</seealso>
6b15044d54a096e6323ff1540f1a491e8de7622dsf<seealso><directive type="section" module="core">ElseIf</directive></seealso>
6b15044d54a096e6323ff1540f1a491e8de7622dsf<seealso><directive type="section" module="core">Else</directive></seealso>
750d12c59545dbbac70390988de94f7e901b08f2niq<seealso><a href="/sections.html">How <Directory>, <Location>,
750d12c59545dbbac70390988de94f7e901b08f2niq <Files> sections work</a> for an explanation of how these
750d12c59545dbbac70390988de94f7e901b08f2niq different sections are combined when a request is received.
6b15044d54a096e6323ff1540f1a491e8de7622dsf <directive type="section">Else</directive> are applied last.</seealso>
750d12c59545dbbac70390988de94f7e901b08f2niq</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Encloses directives that will be processed only
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveif a test is true at startup</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </IfDefine></syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<context>directory</context><context>.htaccess</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>The <code><IfDefine <var>test</var>>...</IfDefine>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </code> section is used to mark directives that are conditional. The
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd directives within an <directive type="section">IfDefine</directive>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd section are only processed if the <var>test</var> is true. If <var>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd test</var> is false, everything between the start and end markers is
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd ignored.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd >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
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <var>parameter-name</var> is defined. The second format reverses
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the test, and only processes the directives if
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <var>parameter-name</var> is <strong>not</strong> defined.</p>
6e483e0b8aa3fa574288a7452221392a03e2b9a3noodl <p>The <var>parameter-name</var> argument is a define as given on the
6e483e0b8aa3fa574288a7452221392a03e2b9a3noodl <program>httpd</program> command line via <code>-D<var>parameter</var>
6e483e0b8aa3fa574288a7452221392a03e2b9a3noodl </code> at the time the server was started or by the <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p><directive type="section">IfDefine</directive> sections are
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive nest-able, which can be used to implement simple
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive multiple-parameter tests. Example:</p>
a00429a6b3b4dbb113b6dc67cfc0507f610276e9takashi httpd -DReverseProxy -DUseCache -DMemCache ...<br />
130d299c4b2b15be45532a176604c71fdc7bea5bnd <IfDefine ReverseProxy><br />
a00429a6b3b4dbb113b6dc67cfc0507f610276e9takashi LoadModule proxy_http_module modules/mod_proxy_http.so<br />
955d7fc3e7adb6463b7243e15c04e858718e799etakashi <IfDefine UseCache><br />
955d7fc3e7adb6463b7243e15c04e858718e799etakashi <IfDefine MemCache><br />
955d7fc3e7adb6463b7243e15c04e858718e799etakashi LoadModule mem_cache_module modules/mod_mem_cache.so<br />
955d7fc3e7adb6463b7243e15c04e858718e799etakashi </IfDefine><br />
955d7fc3e7adb6463b7243e15c04e858718e799etakashi <IfDefine !MemCache><br />
78f97ce162b66a0dbfd7af4dcd9984f162569b04minfrin LoadModule cache_disk_module modules/mod_cache_disk.so<br />
955d7fc3e7adb6463b7243e15c04e858718e799etakashi </IfDefine>
955d7fc3e7adb6463b7243e15c04e858718e799etakashi </IfDefine>
130d299c4b2b15be45532a176604c71fdc7bea5bnd </IfDefine>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Encloses directives that are processed conditional on the
a04a96aae08a62f2d9d5833b3313a9751fa3f680yoshikipresence or absence of a specific module</description>
55d36f9b61520c2374ab463e77e8a62daa416398nd<syntax><IfModule [!]<var>module-file</var>|<var>module-identifier</var>> ...
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess </IfModule></syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<context>directory</context><context>.htaccess</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
55d36f9b61520c2374ab463e77e8a62daa416398nd<compatibility>Module identifiers are available in version 2.1 and
55d36f9b61520c2374ab463e77e8a62daa416398ndlater.</compatibility>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>The <code><IfModule <var>test</var>>...</IfModule></code>
fb77c505254b6e9c925e23e734463e87574f8f40kess section is used to mark directives that are conditional on the presence of
fb77c505254b6e9c925e23e734463e87574f8f40kess a specific module. The directives within an <directive type="section"
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd >IfModule</directive> section are only processed if the <var>test</var>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd is true. If <var>test</var> is false, everything between the start and
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd end markers is ignored.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd >IfModule</directive> section directive can be one of two forms:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>In the former case, the directives between the start and end
55d36f9b61520c2374ab463e77e8a62daa416398nd markers are only processed if the module named <var>module</var>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen is included in Apache httpd -- either compiled in or
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd >LoadModule</directive>. The second format reverses the test,
55d36f9b61520c2374ab463e77e8a62daa416398nd and only processes the directives if <var>module</var> is
55d36f9b61520c2374ab463e77e8a62daa416398nd <p>The <var>module</var> argument can be either the module identifier or
55d36f9b61520c2374ab463e77e8a62daa416398nd the file name of the module, at the time it was compiled. For example,
55d36f9b61520c2374ab463e77e8a62daa416398nd <code>mod_rewrite.c</code> is the file name. If a module consists of
55d36f9b61520c2374ab463e77e8a62daa416398nd several source files, use the name of the file containing the string
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p><directive type="section">IfModule</directive> sections are
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive nest-able, which can be used to implement simple multiple-module
bea526116133aa3d7dabd1924bfc580b37fbf22aslive <note>This section should only be used if you need to have one
bea526116133aa3d7dabd1924bfc580b37fbf22aslive configuration file that works whether or not a specific module
fb77c505254b6e9c925e23e734463e87574f8f40kess is available. In normal operation, directives need not be
bea526116133aa3d7dabd1924bfc580b37fbf22aslive placed in <directive type="section">IfModule</directive>
bea526116133aa3d7dabd1924bfc580b37fbf22aslive sections.</note>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Includes other configuration files from within
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivethe server configuration files</description>
3621f3acee323a877639a96d84891095eb07933aminfrin<syntax>Include [<var>optional</var>|<var>strict</var>] <var>file-path</var>|<var>directory-path</var>|<var>wildcard</var></syntax>
003f0c9fda6664daf5092a0e42f65ede20098153slive<contextlist><context>server config</context><context>virtual host</context>
003f0c9fda6664daf5092a0e42f65ede20098153slive</contextlist>
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin<compatibility>Wildcard matching available in 2.0.41 and later, directory
cf8a8738330694e60bad421fcc8361d80b0e9124minfrinwildcard matching available in 2.3.6 and later</compatibility>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This directive allows inclusion of other configuration files
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive from within the server configuration files.</p>
5b258a8d58679c6587757189339bb3c2d0488f93poirier <p>Shell-style (<code>fnmatch()</code>) wildcard characters can be used
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin in the filename or directory parts of the path to include several files
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin at once, in alphabetical order. In addition, if
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin <directive>Include</directive> points to a directory, rather than a file,
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen Apache httpd will read all files in that directory and any subdirectory.
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin However, including entire directories is not recommended, because it is
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin easy to accidentally leave temporary files in a directory that can cause
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin <program>httpd</program> to fail. Instead, we encourage you to use the
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin wildcard syntax shown below, to include files that match a particular
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin pattern, such as *.conf, for example.</p>
3621f3acee323a877639a96d84891095eb07933aminfrin <p>When a wildcard is specified for a <strong>file</strong> component of
3621f3acee323a877639a96d84891095eb07933aminfrin the path, and no file matches the wildcard, the
3621f3acee323a877639a96d84891095eb07933aminfrin directive will be <strong>silently ignored</strong>. When a wildcard is
3621f3acee323a877639a96d84891095eb07933aminfrin specified for a <strong>directory</strong> component of the path, and
3621f3acee323a877639a96d84891095eb07933aminfrin no directory matches the wildcard, the
3621f3acee323a877639a96d84891095eb07933aminfrin <directive module="core">Include</directive> directive will
3621f3acee323a877639a96d84891095eb07933aminfrin <strong>fail with an error</strong> saying the directory cannot be found.
b89fea36d9c12cec3344576824f4e6798da90ad4rbowen <p>For further control over the behavior of the server when no files or
3621f3acee323a877639a96d84891095eb07933aminfrin directories match, prefix the path with the modifiers <var>optional</var>
3621f3acee323a877639a96d84891095eb07933aminfrin or <var>strict</var>. If <var>optional</var> is specified, any wildcard
3621f3acee323a877639a96d84891095eb07933aminfrin file or directory that does not match will be silently ignored. If
3621f3acee323a877639a96d84891095eb07933aminfrin <var>strict</var> is specified, any wildcard file or directory that does
3621f3acee323a877639a96d84891095eb07933aminfrin not match at least one file will cause server startup to fail.</p>
3621f3acee323a877639a96d84891095eb07933aminfrin <p>When a directory or file component of the path is
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin specified exactly, and that directory or file does not exist,
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin <directive module="core">Include</directive> directive will fail with an
3621f3acee323a877639a96d84891095eb07933aminfrin error saying the file or directory cannot be found.</p>
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor <p>The file path specified may be an absolute path, or may be relative
c68acc9d712af079afa2bd1a5a4aeef9a3ea573ckess to the <directive module="core">ServerRoot</directive> directory.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
cf8a8738330694e60bad421fcc8361d80b0e9124minfrin <p>Wildcards may be included in the directory or file portion of the
3621f3acee323a877639a96d84891095eb07933aminfrin path. In the following example, the server will fail to load if no
3621f3acee323a877639a96d84891095eb07933aminfrin directories match conf/vhosts/*, but will load successfully if no
3621f3acee323a877639a96d84891095eb07933aminfrin files match *.conf.</p>
3621f3acee323a877639a96d84891095eb07933aminfrin <p>In this example, the server will fail to load if either
3621f3acee323a877639a96d84891095eb07933aminfrin conf/vhosts/* matches no directories, or if *.conf matches no files:</p>
3621f3acee323a877639a96d84891095eb07933aminfrin <p>In this example, the server load successfully if either conf/vhosts/*
3621f3acee323a877639a96d84891095eb07933aminfrin matches no directories, or if *.conf matches no files:</p>
03aa31ad82759363ba1a55589e517b16308ef635minfrin</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
003f0c9fda6664daf5092a0e42f65ede20098153slive<description>Enables HTTP persistent connections</description>
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele<contextlist><context>server config</context><context>virtual host</context>
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele</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
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess 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>
891df99fdfa41fc8a486568f4d31ddf4a571258adreid <p>When a client uses a Keep-Alive connection it will be counted
59368b594c9b09b59ae58c7de26d2d5ce1c99a29takashi as a single "request" for the <directive module="mpm_common"
be192cefa381d5bae6868034687471754cb43175sf >MaxConnectionsPerChild</directive> directive, regardless
891df99fdfa41fc8a486568f4d31ddf4a571258adreid of how many requests are sent using the connection.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive module="core">MaxKeepAliveRequests</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
98f5034c8cbf2ef025b317b3e01acae82e143b11trawick<directivesynopsis>
98f5034c8cbf2ef025b317b3e01acae82e143b11trawick<description>Amount of time the server will wait for subsequent
98f5034c8cbf2ef025b317b3e01acae82e143b11trawickrequests on a persistent connection</description>
98f5034c8cbf2ef025b317b3e01acae82e143b11trawick<contextlist><context>server config</context><context>virtual host</context>
98f5034c8cbf2ef025b317b3e01acae82e143b11trawick</contextlist>
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor<compatibility>Specifying a value in milliseconds is available in
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowenApache httpd 2.3.2 and later</compatibility>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen <p>The number of seconds Apache httpd will wait for a subsequent
9f38f3ec3e8087985d108a24ae796962fef83644takashi request before closing the connection. By adding a postfix of ms the
9f38f3ec3e8087985d108a24ae796962fef83644takashi timeout can be also set in milliseconds. Once a request has been
98f5034c8cbf2ef025b317b3e01acae82e143b11trawick received, the timeout value specified by the
98f5034c8cbf2ef025b317b3e01acae82e143b11trawick <directive module="core">Timeout</directive> directive applies.</p>
98f5034c8cbf2ef025b317b3e01acae82e143b11trawick <p>Setting <directive>KeepAliveTimeout</directive> to a high value
98f5034c8cbf2ef025b317b3e01acae82e143b11trawick may cause performance problems in heavily loaded servers. The
98f5034c8cbf2ef025b317b3e01acae82e143b11trawick higher the timeout, the more server processes will be kept
98f5034c8cbf2ef025b317b3e01acae82e143b11trawick occupied waiting on connections with idle clients.</p>
85349f40d98fb3fc7a18ef25dc40eaaae6eead1ctakashi <p>In a name-based virtual host context, the value of the first
ffec3e56ff5331a2d732ec07e9d107303fed43f4covener defined virtual host best matching the local IP and port will be used.</p>
98f5034c8cbf2ef025b317b3e01acae82e143b11trawick</directivesynopsis>
003f0c9fda6664daf5092a0e42f65ede20098153slive<description>Restrict enclosed access controls to only certain HTTP
313bb560bc5c323cfd40c9cad7335b4b8e060aedkessmethods</description>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<syntax><Limit <var>method</var> [<var>method</var>] ... > ...
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </Limit></syntax>
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd<contextlist><context>directory</context><context>.htaccess</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Access controls are normally effective for
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <strong>all</strong> access methods, and this is the usual
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive desired behavior. <strong>In the general case, access control
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directives should not be placed within a
130d299c4b2b15be45532a176604c71fdc7bea5bnd <directive type="section">Limit</directive> section.</strong></p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The purpose of the <directive type="section">Limit</directive>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directive is to restrict the effect of the access controls to the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive nominated HTTP methods. For all other methods, the access
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess restrictions that are enclosed in the <directive
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess type="section">Limit</directive> bracket <strong>will have no
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess effect</strong>. The following example applies the access control
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess only to the methods <code>POST</code>, <code>PUT</code>, and
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <code>DELETE</code>, leaving all other methods unprotected:</p>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <Limit POST PUT DELETE><br />
130d299c4b2b15be45532a176604c71fdc7bea5bnd Require valid-user<br />
130d299c4b2b15be45532a176604c71fdc7bea5bnd </Limit>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>The method names listed can be one or more of: <code>GET</code>,
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <code>POST</code>, <code>PUT</code>, <code>DELETE</code>,
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <code>PATCH</code>, <code>PROPFIND</code>, <code>PROPPATCH</code>,
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <code>MKCOL</code>, <code>COPY</code>, <code>MOVE</code>,
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <code>LOCK</code>, and <code>UNLOCK</code>. <strong>The method name is
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd case-sensitive.</strong> If <code>GET</code> is used it will also
6c5c651b0b97607b8c8b4965c1385c67699f217fnd restrict <code>HEAD</code> requests. The <code>TRACE</code> method
4bb78e7cdd53f50240cff4ad7a97c7ed36483797slive module="core">LimitExcept</directive> section should always be
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd used in preference to a <directive type="section">Limit</directive>
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd section when restricting access, since a <directive type="section"
4bb78e7cdd53f50240cff4ad7a97c7ed36483797slive module="core">LimitExcept</directive> section provides protection
4bb78e7cdd53f50240cff4ad7a97c7ed36483797slive against arbitrary methods.</note>
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd <p>The <directive type="section">Limit</directive> and
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd <directive type="section" module="core">LimitExcept</directive>
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd directives may be nested. In this case, each successive level of
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd <directive type="section">Limit</directive> or <directive
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd type="section" module="core">LimitExcept</directive> directives must
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd further restrict the set of methods to which access controls apply.</p>
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd <directive type="section">LimitExcept</directive> directives with
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd the <directive module="mod_authz_core">Require</directive> directive,
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd note that the first <directive module="mod_authz_core">Require</directive>
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd to succeed authorizes the request, regardless of the presence of other
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd <directive module="mod_authz_core">Require</directive> directives.</note>
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd <p>For example, given the following configuration, all users will
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd be authorized for <code>POST</code> requests, and the
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd <code>Require group editors</code> directive will be ignored
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd in all cases:</p>
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd <LimitExcept GET>
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd Require valid-user
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd </LimitExcept><br />
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd <Limit POST>
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd Require group editors
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd </Limit>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Restrict access controls to all HTTP methods
313bb560bc5c323cfd40c9cad7335b4b8e060aedkessexcept the named ones</description>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<syntax><LimitExcept <var>method</var> [<var>method</var>] ... > ...
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </LimitExcept></syntax>
7245e9b991db85d9d9a587fe5f4051f642ebdc3cchrisd<contextlist><context>directory</context><context>.htaccess</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p><directive type="section">LimitExcept</directive> and
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen <code></LimitExcept></code> are used to enclose
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen a group of access control directives which will then apply to any
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess HTTP access method <strong>not</strong> listed in the arguments;
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen i.e., it is the opposite of a <directive type="section"
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="core">Limit</directive> section and can be used to control
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive both standard and nonstandard/unrecognized methods. See the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive type="section">Limit</directive> for more details.</p>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <LimitExcept POST GET><br />
130d299c4b2b15be45532a176604c71fdc7bea5bnd Require valid-user<br />
7ef9b6763ad87846cf83c3f71467f43e349d080aerikabele </LimitExcept>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
03e0a375c2435102fb2b51e34cccff52acbfddcdnd<directivesynopsis>
03e0a375c2435102fb2b51e34cccff52acbfddcdnd<description>Determine maximum number of internal redirects and nested
03e0a375c2435102fb2b51e34cccff52acbfddcdndsubrequests</description>
03e0a375c2435102fb2b51e34cccff52acbfddcdnd<syntax>LimitInternalRecursion <var>number</var> [<var>number</var>]</syntax>
03e0a375c2435102fb2b51e34cccff52acbfddcdnd<contextlist><context>server config</context><context>virtual host</context>
03e0a375c2435102fb2b51e34cccff52acbfddcdnd</contextlist>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen<compatibility>Available in Apache httpd 2.0.47 and later</compatibility>
03e0a375c2435102fb2b51e34cccff52acbfddcdnd <p>An internal redirect happens, for example, when using the <directive
03e0a375c2435102fb2b51e34cccff52acbfddcdnd module="mod_actions">Action</directive> directive, which internally
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen redirects the original request to a CGI script. A subrequest is Apache httpd's
03e0a375c2435102fb2b51e34cccff52acbfddcdnd mechanism to find out what would happen for some URI if it were requested.
03e0a375c2435102fb2b51e34cccff52acbfddcdnd For example, <module>mod_dir</module> uses subrequests to look for the
03e0a375c2435102fb2b51e34cccff52acbfddcdnd files listed in the <directive module="mod_dir">DirectoryIndex</directive>
03e0a375c2435102fb2b51e34cccff52acbfddcdnd directive.</p>
03e0a375c2435102fb2b51e34cccff52acbfddcdnd <p><directive>LimitInternalRecursion</directive> prevents the server
03e0a375c2435102fb2b51e34cccff52acbfddcdnd from crashing when entering an infinite loop of internal redirects or
03e0a375c2435102fb2b51e34cccff52acbfddcdnd subrequests. Such loops are usually caused by misconfigurations.</p>
03e0a375c2435102fb2b51e34cccff52acbfddcdnd <p>The directive stores two different limits, which are evaluated on
03e0a375c2435102fb2b51e34cccff52acbfddcdnd per-request basis. The first <var>number</var> is the maximum number of
03e0a375c2435102fb2b51e34cccff52acbfddcdnd internal redirects, that may follow each other. The second <var>number</var>
03e0a375c2435102fb2b51e34cccff52acbfddcdnd determines, how deep subrequests may be nested. If you specify only one
03e0a375c2435102fb2b51e34cccff52acbfddcdnd <var>number</var>, it will be assigned to both limits.</p>
03e0a375c2435102fb2b51e34cccff52acbfddcdnd LimitInternalRecursion 5
03e0a375c2435102fb2b51e34cccff52acbfddcdnd </example>
03e0a375c2435102fb2b51e34cccff52acbfddcdnd</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Restricts the total size of the HTTP request body sent
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivefrom the client</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<context>directory</context><context>.htaccess</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>This directive specifies the number of <var>bytes</var> from 0
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive (meaning unlimited) to 2147483647 (2GB) that are allowed in a
6fad623c3cc52b4a84d4d36538f6eed886f49f98covener request body. See the note below for the limited applicability
6fad623c3cc52b4a84d4d36538f6eed886f49f98covener to proxy requests.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <directive>LimitRequestBody</directive> directive allows
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the user to set a limit on the allowed size of an HTTP request
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive message body within the context in which the directive is given
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive (server, per-directory, per-file or per-location). If the client
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive request exceeds that limit, the server will return an error
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive response instead of servicing the request. The size of a normal
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive request message body will vary greatly depending on the nature of
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the resource and the methods allowed on that resource. CGI scripts
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess typically use the message body for retrieving form information.
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess Implementations of the <code>PUT</code> method will require
fb77c505254b6e9c925e23e734463e87574f8f40kess a value at least as large as any representation that the server
fb77c505254b6e9c925e23e734463e87574f8f40kess wishes to accept for that resource.</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
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive attacks.</p>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen <p>If, for example, you are permitting file upload to a particular
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess location, and wish to limit the size of the uploaded file to 100K,
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen you might use the following directive:</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd LimitRequestBody 102400
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor <note><p>For a full description of how this directive is interpreted by
6fad623c3cc52b4a84d4d36538f6eed886f49f98covener proxy requests, see the <module>mod_proxy</module> documentation.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<description>Limits the number of HTTP request header fields that
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivewill be accepted from the client</description>
e0ef044feba0082771091af42798cada5bb1f4fcrbowen<contextlist><context>server config</context><context>virtual host</context></contextlist>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p><var>Number</var> is an integer from 0 (meaning unlimited) to
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive 32767. The default value is defined by the compile-time
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive constant <code>DEFAULT_LIMIT_REQUEST_FIELDS</code> (100 as
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive distributed).</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <directive>LimitRequestFields</directive> directive allows
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the server administrator to modify the limit on the number of
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive request header fields allowed in an HTTP request. A server needs
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive this value to be larger than the number of fields that a normal
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive client request might include. The number of request header fields
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive used by a client rarely exceeds 20, but this may vary among
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive different client implementations, often depending upon the extent
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive to which a user has configured their browser to support detailed
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive content negotiation. Optional HTTP extensions are often expressed
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive 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.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive 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>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd LimitRequestFields 50
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor <p> When name-based virtual hosting is used, the value for this
611f7fd8a0a5ee4a29eeed79dfd8bf6faaa3c613covener directive is taken from the default (first-listed) virtual host for the
ffec3e56ff5331a2d732ec07e9d107303fed43f4covener local IP and port combination</p>.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Limits the size of the HTTP request header allowed from the
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveclient</description>
ae134ecc8faf4e6a8eb68e1c3724506771442a46rbowen<syntax>LimitRequestFieldSize <var>bytes</var></syntax>
e0ef044feba0082771091af42798cada5bb1f4fcrbowen<contextlist><context>server config</context><context>virtual host</context></contextlist>
72580dbc2a55511f13f377063725b9f143b20826stoddard <p>This directive specifies the number of <var>bytes</var>
72580dbc2a55511f13f377063725b9f143b20826stoddard that will be allowed in an HTTP request header.</p>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <p>The <directive>LimitRequestFieldSize</directive> directive
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor allows the server administrator to reduce or increase the limit
72580dbc2a55511f13f377063725b9f143b20826stoddard on the allowed size of an HTTP request header field. A server
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor needs this value to be large enough to hold any one header field
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor from a normal client request. The size of a normal request header
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor field will vary greatly among different client implementations,
72580dbc2a55511f13f377063725b9f143b20826stoddard often depending upon the extent to which a user has configured
56d7eed7205462540aec7202cd82d9f5516fc537kess their browser to support detailed content negotiation. SPNEGO
72580dbc2a55511f13f377063725b9f143b20826stoddard 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
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen useful for avoiding some forms of denial-of-service attacks.</p>
ef8e89e090461194ecadd31e8796a2c51e0531a2kess LimitRequestFieldSize 4094
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen <note>Under normal conditions, the value should not be changed from
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen the default.</note>
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor <p> When name-based virtual hosting is used, the value for this
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim directive is taken from the default (first-listed) virtual host best
ffec3e56ff5331a2d732ec07e9d107303fed43f4covener 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>
e0ef044feba0082771091af42798cada5bb1f4fcrbowen<contextlist><context>server config</context><context>virtual host</context></contextlist>
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor <p>This directive sets the number of <var>bytes</var> that will be
72580dbc2a55511f13f377063725b9f143b20826stoddard allowed on the HTTP request-line.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <directive>LimitRequestLine</directive> directive allows
72580dbc2a55511f13f377063725b9f143b20826stoddard the server administrator to reduce or increase the limit on the allowed size
72580dbc2a55511f13f377063725b9f143b20826stoddard 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
fb77c505254b6e9c925e23e734463e87574f8f40kess 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
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen useful for avoiding some forms of denial-of-service attacks.</p>
ef8e89e090461194ecadd31e8796a2c51e0531a2kess LimitRequestLine 4094
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen <note>Under normal conditions, the value should not be changed from
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen the default.</note>
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor <p> When name-based virtual hosting is used, the value for this
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim directive is taken from the default (first-listed) virtual host best
ffec3e56ff5331a2d732ec07e9d107303fed43f4covener 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>
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele<contextlist><context>server config</context><context>virtual host</context>
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele<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>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd LimitXMLRequestBody 0
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Applies the enclosed directives only to matching
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveURLs</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax><Location
fb77c505254b6e9c925e23e734463e87574f8f40kess <var>URL-path</var>|<var>URL</var>> ... </Location></syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <directive type="section">Location</directive> directive
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess limits the scope of the enclosed directives by URL. It is similar to the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive type="section" module="core">Directory</directive>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directive, and starts a subsection which is terminated with a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive type="section">Location</directive> sections are processed in the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive order they appear in the configuration file, after the <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive type="section" module="core">Directory</directive> sections and
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>.htaccess</code> files are read, and after the <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive type="section" module="core">Files</directive> sections.</p>
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive <p><directive type="section">Location</directive> sections operate
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive completely outside the filesystem. This has several consequences.
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive Most importantly, <directive type="section">Location</directive>
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive directives should not be used to control access to filesystem
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive locations. Since several different URLs may map to the same
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive filesystem location, such access controls may by circumvented.</p>
d950cf9262224a223e2ff5c51393708071e14b94covener <p>The enclosed directives will be applied to the request if the path component
d950cf9262224a223e2ff5c51393708071e14b94covener of the URL meets <em>any</em> of the following criteria:
d950cf9262224a223e2ff5c51393708071e14b94covener <li>The specified location matches exactly the path component of the URL.
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor <li>The specified location, which ends in a forward slash, is a prefix
d950cf9262224a223e2ff5c51393708071e14b94covener of the path component of the URL (treated as a context root).
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor <li>The specified location, with the addition of a trailing slash, is a
d950cf9262224a223e2ff5c51393708071e14b94covener prefix of the path component of the URL (also treated as a context root).
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor In the example below, where no trailing slash is used, requests to
d950cf9262224a223e2ff5c51393708071e14b94covener /private1, /private1/ and /private1/file.txt will have the enclosed
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor directives applied, but /private1other would not.
d950cf9262224a223e2ff5c51393708071e14b94covener <Location /private1>
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor In the example below, where a trailing slash is used, requests to
d950cf9262224a223e2ff5c51393708071e14b94covener /private2/ and /private2/file.txt will have the enclosed
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor directives applied, but /private2 and /private2other would not.
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive <p>Use <directive type="section">Location</directive> to apply
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive directives to content that lives outside the filesystem. For
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive content that lives in the filesystem, use <directive
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive type="section" module="core">Directory</directive> and <directive
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive type="section" module="core">Files</directive>. An exception is
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor <code><Location /></code>, which is an easy way to
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive apply a configuration to the entire server.</p>
dc223428958ad9ff05011545bcdda000887b93e5slive <p>For all origin (non-proxy) requests, the URL to be matched is a
beb923bec9bff2b49ce5027df2fe944e2b74e28brederpj URL-path of the form <code>/path/</code>. <em>No scheme, hostname,
beb923bec9bff2b49ce5027df2fe944e2b74e28brederpj port, or query string may be included.</em> For proxy requests, the
dc223428958ad9ff05011545bcdda000887b93e5slive URL to be matched is of the form
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>scheme://servername/path</code>, and you must include the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive prefix.</p>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <p>The URL may use wildcards. In a wild-card string, <code>?</code> matches
fb77c505254b6e9c925e23e734463e87574f8f40kess any single character, and <code>*</code> matches any sequences of
d8c44cd75cf575fe51319280c12445109e878523noodl characters. Neither wildcard character matches a / in the URL-path.</p>
030108b1816bcda3d925df65357feabdce83bc94slive <p><glossary ref="regex">Regular expressions</glossary>
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor can also be used, with the addition of the <code>~</code>
37742b630743e470b94618ecb3560fbd82e50b59rbowen character. For example:</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <Location ~ "/(extra|special)/data">
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
fb77c505254b6e9c925e23e734463e87574f8f40kess <p>would match URLs that contained the substring <code>/extra/data</code>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess or <code>/special/data</code>. The directive <directive
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess type="section" module="core">LocationMatch</directive> behaves
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess identical to the regex version of <directive
37742b630743e470b94618ecb3560fbd82e50b59rbowen type="section">Location</directive>, and is preferred, for the
37742b630743e470b94618ecb3560fbd82e50b59rbowen simple reason that <code>~</code> is hard to distinguish from
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive functionality is especially useful when combined with the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directive. For example, to enable status requests, but allow them
e8811b6d38f756b325446ded5d96857d13856511takashi only from browsers at <code>example.com</code>, you might use:</p>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <Location /status><br />
130d299c4b2b15be45532a176604c71fdc7bea5bnd SetHandler server-status<br />
130d299c4b2b15be45532a176604c71fdc7bea5bnd </Location>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>The slash character has special meaning depending on where in a
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd URL it appears. People may be used to its behavior in the filesystem
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd where multiple adjacent slashes are frequently collapsed to a single
05201775eaa6b363b8a119c8aea5db246b967591yoshiki slash (<em>i.e.</em>, <code>/home///foo</code> is the same as
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <code>/home/foo</code>). In URL-space this is not necessarily true.
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd The <directive type="section" module="core">LocationMatch</directive>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd directive and the regex version of <directive type="section"
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd >Location</directive> require you to explicitly specify multiple
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd 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>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd >Location</directive> directive behaves similarly when used for
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd proxy requests. But when (non-regex) <directive type="section"
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd >Location</directive> is used for non-proxy requests it will
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd implicitly match multiple slashes with a single slash. For example,
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd if you specify <code><Location /abc/def></code> and the
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd request is to <code>/abc//def</code> then it will match.</p>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<seealso><a href="/sections.html">How <Directory>, <Location>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess and <Files> sections work</a> for an explanation of how these
37742b630743e470b94618ecb3560fbd82e50b59rbowen different sections are combined when a request is received.</seealso>
37742b630743e470b94618ecb3560fbd82e50b59rbowen<seealso><directive module="core">LocationMatch</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<description>Applies the enclosed directives only to regular-expression
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivematching URLs</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax><LocationMatch
8490b2f9f6469d5089163f6dd303d9a81f8e908ctrawick <var>regex</var>> ... </LocationMatch></syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <directive type="section">LocationMatch</directive> directive
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess limits the scope of the enclosed directives by URL, in an identical manner
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess to <directive module="core" type="section">Location</directive>. However,
030108b1816bcda3d925df65357feabdce83bc94slive it takes a <glossary ref="regex">regular expression</glossary>
030108b1816bcda3d925df65357feabdce83bc94slive as an argument instead of a simple string. For example:</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <LocationMatch "/(extra|special)/data">
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>would match URLs that contained the substring <code>/extra/data</code>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<seealso><a href="/sections.html">How <Directory>, <Location>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess and <Files> sections work</a> for an explanation of how these
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess different sections are combined when a request is received</seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Controls the verbosity of the ErrorLog</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
7fbd7281d06cec1918aa370214df77c572f871a9sf<compatibility>Per-module and per-directory configuration is available in
7fbd7281d06cec1918aa370214df77c572f871a9sf Apache HTTP Server 2.3.6 and later</compatibility>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p><directive>LogLevel</directive> adjusts the verbosity of the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive messages recorded in the error logs (see <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="core">ErrorLog</directive> directive). The following
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive significance:</p>
1597043cec6ad37fa4154bf09b0fccdabed1a239slive <columnspec><column width=".2"/><column width=".3"/><column width=".5"/>
1597043cec6ad37fa4154bf09b0fccdabed1a239slive </columnspec>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <td>"getpwuid: couldn't determine user name from uid"</td>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <td>"socket: Failed to get a socket, exiting child"</td>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <td>"child process 1234 did not exit, sending another
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive SIGHUP"</td>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <td>"httpd: caught SIGBUS, attempting to dump core in
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <td>"Server seems busy, (you may need to increase
7fbd7281d06cec1918aa370214df77c572f871a9sf <td>"proxy: CONNECT: sending the CONNECT request to the remote proxy"</td>
7fbd7281d06cec1918aa370214df77c572f871a9sf <td>"read from buffered SSL brigade, mode 0, 17 bytes"</td>
7fbd7281d06cec1918aa370214df77c572f871a9sf <td>"| 0000: 02 23 44 30 13 40 ac 34 df 3d bf 9a 19 49 39 15 |"</td>
7fbd7281d06cec1918aa370214df77c572f871a9sf <td>"| 0000: 02 23 44 30 13 40 ac 34 df 3d bf 9a 19 49 39 15 |"</td>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>When a particular level is specified, messages from all
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive other levels of higher significance will be reported as well.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <em>E.g.</em>, when <code>LogLevel info</code> is specified,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive then messages with log levels of <code>notice</code> and
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive recommended.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd LogLevel notice
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
8b052d682204371decc64f942aede5ef1da98955erikabele <p>When logging to a regular file messages of the level
8b052d682204371decc64f942aede5ef1da98955erikabele <code>notice</code> cannot be suppressed and thus are always
8b052d682204371decc64f942aede5ef1da98955erikabele logged. However, this doesn't apply when logging is done
7fbd7281d06cec1918aa370214df77c572f871a9sf <p>Specifying a level without a module name will reset the level
7fbd7281d06cec1918aa370214df77c572f871a9sf for all modules to that level. Specifying a level with a module
7fbd7281d06cec1918aa370214df77c572f871a9sf name will set the level for that module only. It is possible to
7fbd7281d06cec1918aa370214df77c572f871a9sf use the module source file name, the module identifier, or the
fd410ae1fa431e734e6d0cd3c006002d4904466apoirier module identifier with the trailing <code>_module</code> omitted
7fbd7281d06cec1918aa370214df77c572f871a9sf as module specification. This means the following three specifications
7fbd7281d06cec1918aa370214df77c572f871a9sf are equivalent:</p>
7fbd7281d06cec1918aa370214df77c572f871a9sf LogLevel info ssl:warn<br />
7fbd7281d06cec1918aa370214df77c572f871a9sf LogLevel info ssl_module:warn<br />
7fbd7281d06cec1918aa370214df77c572f871a9sf </example>
7fbd7281d06cec1918aa370214df77c572f871a9sf <p>It is also possible to change the level per directory:</p>
7fbd7281d06cec1918aa370214df77c572f871a9sf LogLevel info<br />
7fbd7281d06cec1918aa370214df77c572f871a9sf LogLevel debug<br />
7fbd7281d06cec1918aa370214df77c572f871a9sf </Files>
7fbd7281d06cec1918aa370214df77c572f871a9sf </example>
7fbd7281d06cec1918aa370214df77c572f871a9sf Per directory loglevel configuration only affects messages that are
7fbd7281d06cec1918aa370214df77c572f871a9sf logged after the request has been parsed and that are associated with
7fbd7281d06cec1918aa370214df77c572f871a9sf the request. Log messages which are associated with the connection or
7fbd7281d06cec1918aa370214df77c572f871a9sf the server are not affected.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<description>Number of requests allowed on a persistent
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveconnection</description>
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele<contextlist><context>server config</context><context>virtual host</context>
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <directive>MaxKeepAliveRequests</directive> directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive limits the number of requests allowed per connection when
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive module="core" >KeepAlive</directive> is on. If it is
fb77c505254b6e9c925e23e734463e87574f8f40kess set to <code>0</code>, unlimited requests will be allowed. We
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive recommend that this setting be kept to a high value for maximum
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive server performance.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd MaxKeepAliveRequests 500
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
6beba165aeced2ca77a6f1593ee08c47a32099efcovener<directivesynopsis>
6beba165aeced2ca77a6f1593ee08c47a32099efcovener<description>Number of ranges allowed before returning the complete
6beba165aeced2ca77a6f1593ee08c47a32099efcovenerresource </description>
7a975d0413ba303546b7619e4785cb641f7f09fdcovener<syntax>MaxRanges default | unlimited | none | <var>number-of-ranges</var></syntax>
6beba165aeced2ca77a6f1593ee08c47a32099efcovener<contextlist><context>server config</context><context>virtual host</context>
6beba165aeced2ca77a6f1593ee08c47a32099efcovener</contextlist>
6beba165aeced2ca77a6f1593ee08c47a32099efcovener<compatibility>Available in Apache HTTP Server 2.3.15 and later</compatibility>
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim limits the number of HTTP ranges the server is willing to
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim return to the client. If more ranges then permitted are requested,
6beba165aeced2ca77a6f1593ee08c47a32099efcovener the complete resource is returned instead.</p>
7a975d0413ba303546b7619e4785cb641f7f09fdcovener <dd>Limits the number of ranges to a compile-time default of 200.</dd>
7a975d0413ba303546b7619e4785cb641f7f09fdcovener <dd>The server does not limit the number of ranges it is
7a975d0413ba303546b7619e4785cb641f7f09fdcovener willing to satisfy.</dd>
7a975d0413ba303546b7619e4785cb641f7f09fdcovener <dd>A positive number representing the maximum number of ranges the
7a975d0413ba303546b7619e4785cb641f7f09fdcovener server is willing to satisfy.</dd>
6beba165aeced2ca77a6f1593ee08c47a32099efcovener</directivesynopsis>
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim<directivesynopsis>
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim <description>Number of overlapping ranges (eg: <code>100-200,150-300</code>) allowed before returning the complete
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim resource </description>
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim <syntax>MaxRangeOverlaps default | unlimited | none | <var>number-of-ranges</var></syntax>
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim <contextlist><context>server config</context><context>virtual host</context>
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim </contextlist>
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim <compatibility>Available in Apache HTTP Server 2.3.15 and later</compatibility>
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim <p>The <directive>MaxRangeOverlaps</directive> directive
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim limits the number of overlapping HTTP ranges the server is willing to
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim return to the client. If more overlapping ranges then permitted are requested,
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim the complete resource is returned instead.</p>
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim <dd>Limits the number of overlapping ranges to a compile-time default of 20.</dd>
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim <dd>The server does not limit the number of overlapping ranges it is
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim willing to satisfy.</dd>
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim <dd>A positive number representing the maximum number of overlapping ranges the
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim server is willing to satisfy.</dd>
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim</directivesynopsis>
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim<directivesynopsis>
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim <description>Number of range reversals (eg: <code>100-200,50-70</code>) allowed before returning the complete
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim resource </description>
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim <syntax>MaxRangeReversals default | unlimited | none | <var>number-of-ranges</var></syntax>
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim <contextlist><context>server config</context><context>virtual host</context>
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim </contextlist>
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim <compatibility>Available in Apache HTTP Server 2.3.15 and later</compatibility>
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim <p>The <directive>MaxRangeReversals</directive> directive
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim limits the number of HTTP Range reversals the server is willing to
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim return to the client. If more ranges reversals then permitted are requested,
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim the complete resource is returned instead.</p>
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim <dd>Limits the number of range reversals to a compile-time default of 20.</dd>
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim <dd>The server does not limit the number of range reversals it is
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim willing to satisfy.</dd>
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim <dd>A positive number representing the maximum number of range reversals the
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim server is willing to satisfy.</dd>
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim</directivesynopsis>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick<directivesynopsis>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick<description>Configures mutex mechanism and lock file directory for all
a0fed3e26656887c8458aa1081d516d08ced3c84trawickor specified mutexes</description>
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick<syntax>Mutex <var>mechanism</var> [default|<var>mutex-name</var>] ... [OmitPID]</syntax>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick<contextlist><context>server config</context></contextlist>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen<compatibility>Available in Apache HTTP Server 2.3.4 and later</compatibility>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <p>The <directive>Mutex</directive> directive sets the mechanism,
a0fed3e26656887c8458aa1081d516d08ced3c84trawick and optionally the lock file location, that httpd and modules use
a0fed3e26656887c8458aa1081d516d08ced3c84trawick to serialize access to resources. Specify <code>default</code> as
a0fed3e26656887c8458aa1081d516d08ced3c84trawick the first argument to change the settings for all mutexes; specify
a0fed3e26656887c8458aa1081d516d08ced3c84trawick a mutex name (see table below) as the first argument to override
a0fed3e26656887c8458aa1081d516d08ced3c84trawick defaults only for that mutex.</p>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <p>The <directive>Mutex</directive> directive is typically used in
a0fed3e26656887c8458aa1081d516d08ced3c84trawick the following exceptional situations:</p>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <li>change the mutex mechanism when the default mechanism selected
a0fed3e26656887c8458aa1081d516d08ced3c84trawick by <glossary>APR</glossary> has a functional or performance
a0fed3e26656887c8458aa1081d516d08ced3c84trawick problem</li>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <li>change the directory used by file-based mutexes when the
a0fed3e26656887c8458aa1081d516d08ced3c84trawick default directory does not support locking</li>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <p>This directive only configures mutexes which have been registered
a0fed3e26656887c8458aa1081d516d08ced3c84trawick with the core server using the <code>ap_mutex_register()</code> API.
a0fed3e26656887c8458aa1081d516d08ced3c84trawick All modules bundled with httpd support the <directive>Mutex</directive>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick directive, but third-party modules may not. Consult the documentation
a0fed3e26656887c8458aa1081d516d08ced3c84trawick of the third-party module, which must indicate the mutex name(s) which
a0fed3e26656887c8458aa1081d516d08ced3c84trawick can be configured if this directive is supported.</p>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <p>The following mutex <em>mechanisms</em> are available:</p>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <p>This selects the default locking implementation, as determined by
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <glossary>APR</glossary>. The default locking implementation can
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor be displayed by running <program>httpd</program> with the
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <p>This effectively disables the mutex, and is only allowed for a
a0fed3e26656887c8458aa1081d516d08ced3c84trawick mutex if the module indicates that it is a valid choice. Consult the
bf0e7f6393e91c0a7c15cb0d889a4238c973dc2etrawick <p>This is a mutex variant based on a Posix semaphore.</p>
bf0e7f6393e91c0a7c15cb0d889a4238c973dc2etrawick <p>The semaphore ownership is not recovered if a thread in the process
bf0e7f6393e91c0a7c15cb0d889a4238c973dc2etrawick holding the mutex segfaults, resulting in a hang of the web server.</p>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <p>This is a mutex variant based on a SystemV IPC semaphore.</p>
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor <p>It is possible to "leak" SysV semaphores if processes crash
a0fed3e26656887c8458aa1081d516d08ced3c84trawick before the semaphore is removed.</p>
bf0e7f6393e91c0a7c15cb0d889a4238c973dc2etrawick <p>The semaphore API allows for a denial of service attack by any
bf0e7f6393e91c0a7c15cb0d889a4238c973dc2etrawick CGIs running under the same uid as the webserver (<em>i.e.</em>,
bf0e7f6393e91c0a7c15cb0d889a4238c973dc2etrawick all CGIs, unless you use something like <program>suexec</program>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <p>This selects the "best" available semaphore implementation, choosing
a0fed3e26656887c8458aa1081d516d08ced3c84trawick between Posix and SystemV IPC semaphores, in that order.</p></li>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <p>This is a mutex variant based on cross-process Posix thread
a0fed3e26656887c8458aa1081d516d08ced3c84trawick mutexes.</p>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <p>On most systems, if a child process terminates abnormally while
a0fed3e26656887c8458aa1081d516d08ced3c84trawick holding a mutex that uses this implementation, the server will deadlock
a0fed3e26656887c8458aa1081d516d08ced3c84trawick and stop responding to requests. When this occurs, the server will
a0fed3e26656887c8458aa1081d516d08ced3c84trawick require a manual restart to recover.</p>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <p>Solaris is a notable exception as it provides a mechanism which
a0fed3e26656887c8458aa1081d516d08ced3c84trawick usually allows the mutex to be recovered after a child process
a0fed3e26656887c8458aa1081d516d08ced3c84trawick terminates abnormally while holding a mutex.</p>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <p>If your system implements the
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <code>pthread_mutexattr_setrobust_np()</code> function, you may be able
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor <p>This is a mutex variant where a physical (lock-)file and the
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <code>fcntl()</code> function are used as the mutex.</p>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <p>When multiple mutexes based on this mechanism are used within
a0fed3e26656887c8458aa1081d516d08ced3c84trawick multi-threaded, multi-process environments, deadlock errors (EDEADLK)
a0fed3e26656887c8458aa1081d516d08ced3c84trawick can be reported for valid mutex operations if <code>fcntl()</code>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick is not thread-aware, such as on Solaris.</p>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <p>This is similar to the <code>fcntl:/path/to/mutex</code> method
a0fed3e26656887c8458aa1081d516d08ced3c84trawick with the exception that the <code>flock()</code> function is used to
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <p>This selects the "best" available file locking implementation,
a0fed3e26656887c8458aa1081d516d08ced3c84trawick choosing between <code>fcntl</code> and <code>flock</code>, in that
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor <p>Most mechanisms are only available on selected platforms, where the
a0fed3e26656887c8458aa1081d516d08ced3c84trawick underlying platform and <glossary>APR</glossary> support it. Mechanisms
215694531f7d868b906df96e22a80e6a1d2326a6lgentis which aren't available on all platforms are <em>posixsem</em>,
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor <em>sysvsem</em>, <em>sem</em>, <em>pthread</em>, <em>fcntl</em>,
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <p>With the file-based mechanisms <em>fcntl</em> and <em>flock</em>,
a0fed3e26656887c8458aa1081d516d08ced3c84trawick the path, if provided, is a directory where the lock file will be created.
a0fed3e26656887c8458aa1081d516d08ced3c84trawick The default directory is httpd's run-time file directory relative to
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <directive module="core">ServerRoot</directive>. Always use a local disk
a0fed3e26656887c8458aa1081d516d08ced3c84trawick filesystem for <code>/path/to/mutex</code> and never a directory residing
a0fed3e26656887c8458aa1081d516d08ced3c84trawick on a NFS- or AFS-filesystem. The basename of the file will be the mutex
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick type, an optional instance string provided by the module, and unless the
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor <code>OmitPID</code> keyword is specified, the process id of the httpd
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick parent process will be appended to to make the file name unique, avoiding
a0fed3e26656887c8458aa1081d516d08ced3c84trawick conflicts when multiple httpd instances share a lock file directory. For
a0fed3e26656887c8458aa1081d516d08ced3c84trawick example, if the mutex name is <code>mpm-accept</code> and the lock file
a0fed3e26656887c8458aa1081d516d08ced3c84trawick directory is <code>/var/httpd/locks</code>, the lock file name for the
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor httpd instance with parent process id 12345 would be
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <p>It is best to <em>avoid</em> putting mutex files in a world-writable
a0fed3e26656887c8458aa1081d516d08ced3c84trawick directory such as <code>/var/tmp</code> because someone could create
a0fed3e26656887c8458aa1081d516d08ced3c84trawick a denial of service attack and prevent the server from starting by
a0fed3e26656887c8458aa1081d516d08ced3c84trawick creating a lockfile with the same name as the one the server will try
a0fed3e26656887c8458aa1081d516d08ced3c84trawick to create.</p>
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick <p>The following table documents the names of mutexes used by httpd
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick and bundled modules.</p>
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick <td><module>prefork</module> and <module>worker</module> MPMs</td>
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick <td>incoming connections, to avoid the thundering herd problem;
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick for more information, refer to the
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick <a href="/misc/perf-tuning.html">performance tuning</a>
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick documentation</td>
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick <td>communication with external mapping programs, to avoid
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick intermixed I/O from multiple requests</td>
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick <td>callback function of a particular client module</td>
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick <p>The <code>OmitPID</code> keyword suppresses the addition of the httpd
2b6c7b8eb5fbc43564898aedac730df7e91da475trawick parent process id from the lock file name.</p>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <p>In the following example, the mutex mechanism for the MPM accept
a0fed3e26656887c8458aa1081d516d08ced3c84trawick mutex will be changed from the compiled-in default to <code>fcntl</code>,
a0fed3e26656887c8458aa1081d516d08ced3c84trawick with the associated lock file created in directory
a0fed3e26656887c8458aa1081d516d08ced3c84trawick <code>/var/httpd/locks</code>. The mutex mechanism for all other mutexes
a0fed3e26656887c8458aa1081d516d08ced3c84trawick will be changed from the compiled-in default to <code>sysvsem</code>.</p>
a0fed3e26656887c8458aa1081d516d08ced3c84trawick Mutex default sysvsem<br />
a0fed3e26656887c8458aa1081d516d08ced3c84trawick</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
4f127f38c6400931b17c1ce235aa84a046ab7310jim<description>DEPRECATED: Designates an IP address for name-virtual
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivehosting</description>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<syntax>NameVirtualHost <var>addr</var>[:<var>port</var>]</syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context></contextlist>
ffec3e56ff5331a2d732ec07e9d107303fed43f4covener<p>Prior to 2.3.11, <directive>NameVirtualHost</directive> was required
ffec3e56ff5331a2d732ec07e9d107303fed43f4covenerto instruct the server that a particular IP address and port combination
ffec3e56ff5331a2d732ec07e9d107303fed43f4covenerwas usable as a name-based virtual host. In 2.3.11 and later,
ffec3e56ff5331a2d732ec07e9d107303fed43f4covenerany time an IP address and port combination is used in multiple virtual
ffec3e56ff5331a2d732ec07e9d107303fed43f4covenerhosts, name-based virtual hosting is automatically enabled for that address.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Configures what features are available in a particular
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivedirectory</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>Options
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd [+|-]<var>option</var> [[+|-]<var>option</var>] ...</syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<context>directory</context><context>.htaccess</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
9e0536cd66a389bdaa758a825b8bbd8fea665a3eigalic<compatibility>The default was changed from All to FollowSymlinks in 2.3.11</compatibility>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <directive>Options</directive> directive controls which
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive server features are available in a particular directory.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p><var>option</var> can be set to <code>None</code>, in which
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive case none of the extra features are enabled, or one or more of
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the following:</p>
9e0536cd66a389bdaa758a825b8bbd8fea665a3eigalic <dd>All options except for <code>MultiViews</code>.</dd>
13e5182a0c199ecc7a73db97b6448a544e940868slive Execution of CGI scripts using <module>mod_cgi</module>
13e5182a0c199ecc7a73db97b6448a544e940868slive is permitted.</dd>
9e0536cd66a389bdaa758a825b8bbd8fea665a3eigalic The server will follow symbolic links in this directory. This is
9e0536cd66a389bdaa758a825b8bbd8fea665a3eigalic the default setting.
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>Even though the server follows the symlink it does <em>not</em>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd change the pathname used to match against <directive type="section"
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>Note also, that this option <strong>gets ignored</strong> if set
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd inside a <directive type="section" module="core">Location</directive>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd section.</p>
1c5fe3e61f0f3202ae0f853740d53f3aff4c4afbslive <p>Omitting this option should not be considered a security restriction,
1c5fe3e61f0f3202ae0f853740d53f3aff4c4afbslive since symlink testing is subject to race conditions that make it
1c5fe3e61f0f3202ae0f853740d53f3aff4c4afbslive circumventable.</p>
13e5182a0c199ecc7a73db97b6448a544e940868slive Server-side includes provided by <module>mod_include</module>
13e5182a0c199ecc7a73db97b6448a544e940868slive are permitted.</dd>
13e5182a0c199ecc7a73db97b6448a544e940868slive Server-side includes are permitted, but the <code>#exec
13e5182a0c199ecc7a73db97b6448a544e940868slive cmd</code> and <code>#exec cgi</code> are disabled. It is still
13e5182a0c199ecc7a73db97b6448a544e940868slive possible to <code>#include virtual</code> CGI scripts from
b00583f8e126bbb00b06dcf06af06c9d07978701kess <directive module="mod_alias">ScriptAlias</directive>ed
13e5182a0c199ecc7a73db97b6448a544e940868slive directories.</dd>
0d5b778ac63bc803c0dd1a4fdef371fe7a0f4b57kess If a URL which maps to a directory is requested, and there
13e5182a0c199ecc7a73db97b6448a544e940868slive is no <directive module="mod_dir">DirectoryIndex</directive>
13e5182a0c199ecc7a73db97b6448a544e940868slive (<em>e.g.</em>, <code>index.html</code>) in that directory, then
13e5182a0c199ecc7a73db97b6448a544e940868slive <module>mod_autoindex</module> will return a formatted listing
13e5182a0c199ecc7a73db97b6448a544e940868slive of the directory.</dd>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <a href="/content-negotiation.html">Content negotiated</a>
13e5182a0c199ecc7a73db97b6448a544e940868slive "MultiViews" are allowed using
96969ed53a757bd9e0a4d7f2f499c9db5ef7899eigalic <note><title>Note</title> <p>This option gets ignored if set
96969ed53a757bd9e0a4d7f2f499c9db5ef7899eigalic anywhere other than <directive module="core" type="section"
96969ed53a757bd9e0a4d7f2f499c9db5ef7899eigalic >Directory</directive>, as <module>mod_negotiation</module>
96969ed53a757bd9e0a4d7f2f499c9db5ef7899eigalic needs real resources to compare against and evaluate from.</p></note>
13e5182a0c199ecc7a73db97b6448a544e940868slive <dd>The server will only follow symbolic links for which the
13e5182a0c199ecc7a73db97b6448a544e940868slive target file or directory is owned by the same user id as the
1c5fe3e61f0f3202ae0f853740d53f3aff4c4afbslive <note><title>Note</title> <p>This option gets ignored if
1c5fe3e61f0f3202ae0f853740d53f3aff4c4afbslive <p>This option should not be considered a security restriction,
1c5fe3e61f0f3202ae0f853740d53f3aff4c4afbslive since symlink testing is subject to race conditions that make it
13e5182a0c199ecc7a73db97b6448a544e940868slive <p>Normally, if multiple <directive>Options</directive> could
13e5182a0c199ecc7a73db97b6448a544e940868slive apply to a directory, then the most specific one is used and
13e5182a0c199ecc7a73db97b6448a544e940868slive others are ignored; the options are not merged. (See <a
13e5182a0c199ecc7a73db97b6448a544e940868slive href="/sections.html#mergin">how sections are merged</a>.)
13e5182a0c199ecc7a73db97b6448a544e940868slive <directive>Options</directive> directive are preceded by a
13e5182a0c199ecc7a73db97b6448a544e940868slive <code>+</code> or <code>-</code> symbol, the options are
13e5182a0c199ecc7a73db97b6448a544e940868slive merged. Any options preceded by a <code>+</code> are added to the
13e5182a0c199ecc7a73db97b6448a544e940868slive options currently in force, and any options preceded by a
13e5182a0c199ecc7a73db97b6448a544e940868slive <code>-</code> are removed from the options currently in
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive force. </p>
3b9c7ec844aa240622a33735d1b9cbac4232e268rbowen <p>Mixing <directive>Options</directive> with a <code>+</code> or
2cef7e294acb5d8b8b5dcb21a55438da0b73f63figalic <code>-</code> with those without is not valid syntax, and will be
2cef7e294acb5d8b8b5dcb21a55438da0b73f63figalic rejected during server startup by the syntax check with an abort.</p>
fb77c505254b6e9c925e23e734463e87574f8f40kess <p>For example, without any <code>+</code> and <code>-</code> symbols:</p>
130d299c4b2b15be45532a176604c71fdc7bea5bnd Options Indexes FollowSymLinks<br />
130d299c4b2b15be45532a176604c71fdc7bea5bnd </Directory><br />
130d299c4b2b15be45532a176604c71fdc7bea5bnd Options Includes<br />
130d299c4b2b15be45532a176604c71fdc7bea5bnd </Directory>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>then only <code>Includes</code> will be set for the
fb77c505254b6e9c925e23e734463e87574f8f40kess <code>/web/docs/spec</code> directory. However if the second
fb77c505254b6e9c925e23e734463e87574f8f40kess <directive>Options</directive> directive uses the <code>+</code> and
130d299c4b2b15be45532a176604c71fdc7bea5bnd Options Indexes FollowSymLinks<br />
130d299c4b2b15be45532a176604c71fdc7bea5bnd </Directory><br />
130d299c4b2b15be45532a176604c71fdc7bea5bnd Options +Includes -Indexes<br />
130d299c4b2b15be45532a176604c71fdc7bea5bnd </Directory>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
fb77c505254b6e9c925e23e734463e87574f8f40kess <code>Includes</code> are set for the <code>/web/docs/spec</code>
fb77c505254b6e9c925e23e734463e87574f8f40kess directory.</p>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <code>-Includes</code> disables server-side includes completely
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess regardless of the previous setting.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The default in the absence of any other settings is
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
9f19223e8fb7b99f5f1cc02c8c3c2c6567793262rbowen<directivesynopsis>
9f19223e8fb7b99f5f1cc02c8c3c2c6567793262rbowen<description>Protocol for a listening socket</description>
9f19223e8fb7b99f5f1cc02c8c3c2c6567793262rbowen<contextlist><context>server config</context><context>virtual host</context></contextlist>
9f19223e8fb7b99f5f1cc02c8c3c2c6567793262rbowen<compatibility>Available in Apache 2.1.5 and later.
9f19223e8fb7b99f5f1cc02c8c3c2c6567793262rbowenOn Windows from Apache 2.3.3 and later.</compatibility>
9f19223e8fb7b99f5f1cc02c8c3c2c6567793262rbowen <p>This directive specifies the protocol used for a specific listening socket.
9f19223e8fb7b99f5f1cc02c8c3c2c6567793262rbowen The protocol is used to determine which module should handle a request, and
9f19223e8fb7b99f5f1cc02c8c3c2c6567793262rbowen to apply protocol specific optimizations with the <directive>AcceptFilter</directive>
9f19223e8fb7b99f5f1cc02c8c3c2c6567793262rbowen directive.</p>
9f19223e8fb7b99f5f1cc02c8c3c2c6567793262rbowen <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>
9f19223e8fb7b99f5f1cc02c8c3c2c6567793262rbowen <p>For example, if you are running <code>https</code> on a non-standard port, specify the protocol explicitly:</p>
9f19223e8fb7b99f5f1cc02c8c3c2c6567793262rbowen Protocol https
9f19223e8fb7b99f5f1cc02c8c3c2c6567793262rbowen <p>You can also specify the protocol using the <directive module="mpm_common">Listen</directive> directive.</p>
9f19223e8fb7b99f5f1cc02c8c3c2c6567793262rbowen<seealso><directive>AcceptFilter</directive></seealso>
9f19223e8fb7b99f5f1cc02c8c3c2c6567793262rbowen<seealso><directive module="mpm_common">Listen</directive></seealso>
9f19223e8fb7b99f5f1cc02c8c3c2c6567793262rbowen</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Limits the CPU consumption of processes launched
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowenby Apache httpd children</description>
ef8e89e090461194ecadd31e8796a2c51e0531a2kess<syntax>RLimitCPU <var>seconds</var>|max [<var>seconds</var>|max]</syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<default>Unset; uses operating system defaults</default>
530eba85dbd41b8a0fa5255d3648d1440199a661slive<contextlist><context>server config</context><context>virtual host</context>
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele<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,
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd or <code>max</code> to indicate to the server that the limit should
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive be set to the maximum allowed by the operating system
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive configuration. Raising the maximum resource limit requires that
ef8e89e090461194ecadd31e8796a2c51e0531a2kess the server is running as <code>root</code>, or in the initial startup
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen <p>This applies to processes forked off from Apache httpd children
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen servicing requests, not the Apache httpd children themselves. This
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive includes CGI scripts and SSI exec commands, but not any
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen processes forked off from the Apache httpd parent such as piped
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>CPU resource limits are expressed in seconds per
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive process.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive module="core">RLimitMEM</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive module="core">RLimitNPROC</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Limits the memory consumption of processes launched
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowenby Apache httpd children</description>
ef8e89e090461194ecadd31e8796a2c51e0531a2kess<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>
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele<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,
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd or <code>max</code> to indicate to the server that the limit should
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive be set to the maximum allowed by the operating system
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive configuration. Raising the maximum resource limit requires that
ef8e89e090461194ecadd31e8796a2c51e0531a2kess the server is running as <code>root</code>, or in the initial startup
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen <p>This applies to processes forked off from Apache httpd children
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen servicing requests, not the Apache httpd children themselves. This
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive includes CGI scripts and SSI exec commands, but not any
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen processes forked off from the Apache httpd parent such as piped
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Memory resource limits are expressed in bytes per
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive process.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive module="core">RLimitCPU</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive module="core">RLimitNPROC</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<description>Limits the number of processes that can be launched by
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowenprocesses launched by Apache httpd children</description>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<syntax>RLimitNPROC <var>number</var>|max [<var>number</var>|max]</syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<default>Unset; uses operating system defaults</default>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele<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,
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
ef8e89e090461194ecadd31e8796a2c51e0531a2kess the server is running as <code>root</code>, or in the initial startup
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen <p>This applies to processes forked off from Apache httpd children
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen servicing requests, not the Apache httpd children themselves. This
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive includes CGI scripts and SSI exec commands, but not any
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen processes forked off from the Apache httpd parent such as piped
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Process limits control the number of processes per user.</p>
9b5e2c5e769dc678a1aca06df75c32022b2f1492trawick under user ids other than the web server user id, this directive
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess will limit the number of processes that the server itself can
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess create. Evidence of this situation will be indicated by
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <strong><code>cannot fork</code></strong> messages in the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive module="core">RLimitMEM</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive module="core">RLimitCPU</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
fb77c505254b6e9c925e23e734463e87574f8f40kess<description>Technique for locating the interpreter for CGI
003f0c9fda6664daf5092a0e42f65ede20098153slivescripts</description>
fb77c505254b6e9c925e23e734463e87574f8f40kess<syntax>ScriptInterpreterSource Registry|Registry-Strict|Script</syntax>
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele<contextlist><context>server config</context><context>virtual host</context>
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele<context>directory</context><context>.htaccess</context></contextlist>
18831446030f4eda7e0563c92a896ccfdb6eb1d7slive<compatibility>Win32 only;
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowenoption <code>Registry-Strict</code> is available in Apache HTTP Server 2.0 and
ef8e89e090461194ecadd31e8796a2c51e0531a2kesslater</compatibility>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen <p>This directive is used to control how Apache httpd finds the
4cafc94e99922f00654e1779d30c2cccf5278c4fkess interpreter used to run CGI scripts. The default setting is
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen <code>Script</code>. This causes Apache httpd to use the interpreter pointed to
4cafc94e99922f00654e1779d30c2cccf5278c4fkess by the shebang line (first line, starting with <code>#!</code>) in the
4cafc94e99922f00654e1779d30c2cccf5278c4fkess script. On Win32 systems this line usually looks like:</p>
4cafc94e99922f00654e1779d30c2cccf5278c4fkess </example>
27303c8bb552a8a5fc859feb735d686fc59f59a1yoshiki <p>or, if <code>perl</code> is in the <code>PATH</code>, simply:</p>
4cafc94e99922f00654e1779d30c2cccf5278c4fkess </example>
fb77c505254b6e9c925e23e734463e87574f8f40kess <p>Setting <code>ScriptInterpreterSource Registry</code> will
4cafc94e99922f00654e1779d30c2cccf5278c4fkess cause the Windows Registry tree <code>HKEY_CLASSES_ROOT</code> to be
4cafc94e99922f00654e1779d30c2cccf5278c4fkess searched using the script file extension (e.g., <code>.pl</code>) as a
4cafc94e99922f00654e1779d30c2cccf5278c4fkess search key. The command defined by the registry subkey
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive <code>Shell\ExecCGI\Command</code> or, if it does not exist, by the subkey
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive <code>Shell\Open\Command</code> is used to open the script file. If the
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen registry keys cannot be found, Apache httpd falls back to the behavior of the
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive <p>Be careful when using <code>ScriptInterpreterSource
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive module="mod_alias">ScriptAlias</directive>'ed directories, because
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen Apache httpd will try to execute <strong>every</strong> file within this
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive directory. The <code>Registry</code> setting may cause undesired
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive program calls on files which are typically not executed. For
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive example, the default open command on <code>.htm</code> files on
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive most Windows systems will execute Microsoft Internet Explorer, so
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive any HTTP request for an <code>.htm</code> file existing within the
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive script directory would start the browser in the background on the
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive server. This is a good way to crash your system within a minute or
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen <p>The option <code>Registry-Strict</code> which is new in Apache HTTP Server
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive 2.0 does the same thing as <code>Registry</code> but uses only the
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive <code>ExecCGI</code> key is not a common one. It must be
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive configured manually in the windows registry and hence prevents
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive accidental program calls on your system.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
a8ee031b2224ce5473826c9d4f603681589245fawrowe<directivesynopsis>
a8ee031b2224ce5473826c9d4f603681589245fawrowe<description>Determine if mod_status displays the first 63 characters
a8ee031b2224ce5473826c9d4f603681589245fawroweof a request or the last 63, assuming the request itself is greater than
a8ee031b2224ce5473826c9d4f603681589245fawrowe63 chars.</description>
a8ee031b2224ce5473826c9d4f603681589245fawrowe<contextlist><context>server config</context></contextlist>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen<compatibility>Available in Apache httpd 2.2.7 and later.</compatibility>
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor displays the actual request being handled.
a8ee031b2224ce5473826c9d4f603681589245fawrowe For historical purposes, only 63 characters of the request
a8ee031b2224ce5473826c9d4f603681589245fawrowe are actually stored for display purposes. This directive
a8ee031b2224ce5473826c9d4f603681589245fawrowe controls whether the 1st 63 characters are stored (the previous
a8ee031b2224ce5473826c9d4f603681589245fawrowe behavior and the default) or if the last 63 characters are. This
a8ee031b2224ce5473826c9d4f603681589245fawrowe is only applicable, of course, if the length of the request is
a8ee031b2224ce5473826c9d4f603681589245fawrowe 64 characters or greater.</p>
a8ee031b2224ce5473826c9d4f603681589245fawrowe >GET /disk1/storage/apache/htdocs/images/imagestore1/food/apples.jpg HTTP/1.1</code
a8ee031b2224ce5473826c9d4f603681589245fawrowe > mod_status displays as follows:
a8ee031b2224ce5473826c9d4f603681589245fawrowe <td>GET /disk1/storage/apache/htdocs/images/imagestore1/food/apples</td>
a8ee031b2224ce5473826c9d4f603681589245fawrowe <td>orage/apache/htdocs/images/imagestore1/food/apples.jpg HTTP/1.1</td>
a8ee031b2224ce5473826c9d4f603681589245fawrowe</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
003f0c9fda6664daf5092a0e42f65ede20098153slive<description>Email address that the server includes in error
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivemessages sent to the client</description>
2e5e2673cb64d3e4d445d911c6f61ac171020725nd<syntax>ServerAdmin <var>email-address</var>|<var>URL</var></syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
2e5e2673cb64d3e4d445d911c6f61ac171020725nd <p>The <directive>ServerAdmin</directive> sets the contact address
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive that the server includes in any error messages it returns to the
733738e83a9b0113476e3f67992c2278d61ee4dakess client. If the <code>httpd</code> doesn't recognize the supplied argument
733738e83a9b0113476e3f67992c2278d61ee4dakess as an URL, it
2e5e2673cb64d3e4d445d911c6f61ac171020725nd assumes, that it's an <var>email-address</var> and prepends it with
2e5e2673cb64d3e4d445d911c6f61ac171020725nd <code>mailto:</code> in hyperlink targets. However, it's recommended to
2e5e2673cb64d3e4d445d911c6f61ac171020725nd actually use an email address, since there are a lot of CGI scripts that
2e5e2673cb64d3e4d445d911c6f61ac171020725nd make that assumption. If you want to use an URL, it should point to another
2e5e2673cb64d3e4d445d911c6f61ac171020725nd server under your control. Otherwise users may not be able to contact you in
2e5e2673cb64d3e4d445d911c6f61ac171020725nd case of errors.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>It may be worth setting up a dedicated address for this, e.g.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd ServerAdmin www-admin@foo.example.com
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>as users do not always mention that they are talking about the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive server!</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
003f0c9fda6664daf5092a0e42f65ede20098153slive<description>Alternate names for a host used when matching requests
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveto name-virtual hosts</description>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<syntax>ServerAlias <var>hostname</var> [<var>hostname</var>] ...</syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>virtual host</context></contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <directive>ServerAlias</directive> directive sets the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive alternate names for a host, for use with <a
206b5dce9e48924aa9f12ce87f14856a4cd3fb68takashi href="/vhosts/name-based.html">name-based virtual hosts</a>. The
0e4c8b384f21029c01f06824ec522bb2cbec1d0enoirin <directive>ServerAlias</directive> may include wildcards, if appropriate.</p>
b6ab9bfd820e424c2e9544d629ae67af24e90dcerbowen <VirtualHost *:80><br />
ffe8ed2cd88be2c415ddef11f50394c52df9190ctrawick ServerAlias server server2.example.com server2<br />
fff1d314f760fc17a49215e8818b3e57691efa43niq UseCanonicalName Off<br />
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd # ...<br />
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </VirtualHost>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
fff1d314f760fc17a49215e8818b3e57691efa43niq<seealso><directive module="core">UseCanonicalName</directive></seealso>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen<seealso><a href="/vhosts/">Apache HTTP Server Virtual Host documentation</a></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
003f0c9fda6664daf5092a0e42f65ede20098153slive<description>Hostname and port that the server uses to identify
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveitself</description>
e08ad1a326852610a7930269638a43657fc50d06sctemme<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>
e08ad1a326852610a7930269638a43657fc50d06sctemme <p>The <directive>ServerName</directive> directive sets the
e08ad1a326852610a7930269638a43657fc50d06sctemme request scheme, hostname and
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive port that the server uses to identify itself. This is used when
06fcf16883e133e49db046945cbcf728d4cc6e37rbowen creating redirection URLs.</p>
06fcf16883e133e49db046945cbcf728d4cc6e37rbowen <p>Additionally, <directive>ServerName</directive> is used (possibly
06fcf16883e133e49db046945cbcf728d4cc6e37rbowen in conjunction with <directive>ServerAlias</directive>) to uniquely
06fcf16883e133e49db046945cbcf728d4cc6e37rbowen identify a virtual host, when using <a
06fcf16883e133e49db046945cbcf728d4cc6e37rbowen href="/vhosts/name-based.html">name-based virtual hosts</a>.</p>
06fcf16883e133e49db046945cbcf728d4cc6e37rbowen <p>For example, if the name of the
9b5e2c5e769dc678a1aca06df75c32022b2f1492trawick machine hosting the web server is <code>simple.example.com</code>,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive but the machine also has the DNS alias <code>www.example.com</code>
9b5e2c5e769dc678a1aca06df75c32022b2f1492trawick and you wish the web server to be so identified, the following
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directive should be used:</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
e6ab342447cf6b4c22bbe66169718d0e9b78819apoirier may appear anywhere within the definition of a server. However,
e6ab342447cf6b4c22bbe66169718d0e9b78819apoirier each appearance overrides the previous appearance (within that
e6ab342447cf6b4c22bbe66169718d0e9b78819apoirier server).</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>If no <directive>ServerName</directive> is specified, then the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive server attempts to deduce the hostname by performing a reverse
fb77c505254b6e9c925e23e734463e87574f8f40kess lookup on the IP address. If no port is specified in the
e08ad1a326852610a7930269638a43657fc50d06sctemme <directive>ServerName</directive>, then the server will use the
e08ad1a326852610a7930269638a43657fc50d06sctemme port from the incoming request. For optimal reliability and
e08ad1a326852610a7930269638a43657fc50d06sctemme predictability, you should specify an explicit hostname and port
e08ad1a326852610a7930269638a43657fc50d06sctemme using the <directive>ServerName</directive> directive.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive href="/vhosts/name-based.html">name-based virtual hosts</a>,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive type="section" module="core">VirtualHost</directive>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive section specifies what hostname must appear in the request's
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>Host:</code> header to match this virtual host.</p>
e08ad1a326852610a7930269638a43657fc50d06sctemme <p>Sometimes, the server runs behind a device that processes SSL,
e08ad1a326852610a7930269638a43657fc50d06sctemme such as a reverse proxy, load balancer or SSL offload
e08ad1a326852610a7930269638a43657fc50d06sctemme appliance. When this is the case, specify the
e08ad1a326852610a7930269638a43657fc50d06sctemme <code>https://</code> scheme and the port number to which the
e08ad1a326852610a7930269638a43657fc50d06sctemme clients connect in the <directive>ServerName</directive> directive
e08ad1a326852610a7930269638a43657fc50d06sctemme to make sure that the server generates the correct
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor self-referential URLs.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>See the description of the
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim <directive module="core">UseCanonicalName</directive> and
29edaaeea24c41820e486944635348cd7fae1d11rbowen <directive module="core">UseCanonicalPhysicalPort</directive> directives for
e08ad1a326852610a7930269638a43657fc50d06sctemme settings which determine whether self-referential URLs (e.g., by the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive specified port, or to the port number given in the client's request.
226aaa3e29f938600cd1b9dfb6774588d831d036rbowen <p>Failure to set <directive>ServerName</directive> to a name that
226aaa3e29f938600cd1b9dfb6774588d831d036rbowen your server can resolve to an IP address will result in a startup
226aaa3e29f938600cd1b9dfb6774588d831d036rbowen warning. <code>httpd</code> will then use whatever hostname it can
226aaa3e29f938600cd1b9dfb6774588d831d036rbowen determine, using the system's <code>hostname</code> command. This
226aaa3e29f938600cd1b9dfb6774588d831d036rbowen will almost never be the hostname you actually want.</p>
226aaa3e29f938600cd1b9dfb6774588d831d036rbowen httpd: Could not reliably determine the server's fully qualified domain name, using rocinante.local for ServerName
ef8e89e090461194ecadd31e8796a2c51e0531a2kess<seealso><a href="/dns-caveats.html">Issues Regarding DNS and
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen<seealso><a href="/vhosts/">Apache HTTP Server virtual host
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive module="core">UseCanonicalName</directive></seealso>
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim<seealso><directive module="core">UseCanonicalPhysicalPort</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive module="core">ServerAlias</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
fb77c505254b6e9c925e23e734463e87574f8f40kess<description>Legacy URL pathname for a name-based virtual host that
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveis accessed by an incompatible browser</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>virtual host</context></contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <directive>ServerPath</directive> directive sets the legacy
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive URL pathname for a host, for use with <a
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen<seealso><a href="/vhosts/">Apache HTTP Server Virtual Host documentation</a></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
003f0c9fda6664daf5092a0e42f65ede20098153slive<description>Base directory for the server installation</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context></contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <directive>ServerRoot</directive> directive sets the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directory in which the server lives. Typically it will contain the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive subdirectories <code>conf/</code> and <code>logs/</code>. Relative
7228d3b2eebddc214348190bcc62d80b5e7087e2rbowen paths in other configuration directives (such as <directive
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor module="mod_so">LoadModule</directive>, for example) are taken as
7228d3b2eebddc214348190bcc62d80b5e7087e2rbowen relative to this directory.</p>
fe9f851e55506793276ffaac89106433572868a8rbowen <p>The default location of <directive>ServerRoot</directive> may be
fe9f851e55506793276ffaac89106433572868a8rbowen modified by using the <code>--prefix</code> argument to
fe9f851e55506793276ffaac89106433572868a8rbowen <a href="/programs/configure.html"><code>configure</code></a>, and
fe9f851e55506793276ffaac89106433572868a8rbowen most third-party distributions of the server have a different
fe9f851e55506793276ffaac89106433572868a8rbowen 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
ef8e89e090461194ecadd31e8796a2c51e0531a2kess permissions on the <directive>ServerRoot</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<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
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive configuration of a trailing footer line under server-generated
fb77c505254b6e9c925e23e734463e87574f8f40kess documents (error messages, <module>mod_proxy</module> ftp directory
fb77c505254b6e9c925e23e734463e87574f8f40kess listings, <module>mod_info</module> output, ...). The reason why you
fb77c505254b6e9c925e23e734463e87574f8f40kess 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
ef8e89e090461194ecadd31e8796a2c51e0531a2kess actually produced a returned error message.</p>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess setting, which is the default, suppresses the footer line (and is
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive therefore compatible with the behavior of Apache-1.2 and
530eba85dbd41b8a0fa5255d3648d1440199a661slive 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,
530eba85dbd41b8a0fa5255d3648d1440199a661slive and the <code>EMail</code> setting additionally creates a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive "mailto:" reference to the <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="core">ServerAdmin</directive> of the referenced
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive document.</p>
23b36269d124e7a6aaa5221891f7ae2ef3eeb158jerenkrantz <p>After version 2.0.44, the details of the server version number
7b5535ed88e0f561b3bfb3330137bd804846afd4slive presented are controlled by the <directive
f35c904c3b359610a46e94fbb4ba8495b2338521slive<seealso><directive module="core">ServerTokens</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
ef8e89e090461194ecadd31e8796a2c51e0531a2kess<description>Configures the <code>Server</code> HTTP response
ef8e89e090461194ecadd31e8796a2c51e0531a2kessheader</description>
dc111bcea580da3da174c25be0fd7a8f22c86fe1jim<syntax>ServerTokens Major|Minor|Min[imal]|Prod[uctOnly]|OS|Full</syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context></contextlist>
530eba85dbd41b8a0fa5255d3648d1440199a661slive <p>This directive controls whether <code>Server</code> response
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive header field which is sent back to clients includes a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive description of the generic OS-type of the server as well as
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive information about compiled-in modules.</p>
a21fb2799923b1c25a351f09e690bd46806f2fa2jim <dt><code>ServerTokens Full</code> (or not specified)</dt>
9e59849752ebadf803f76453fe3b64e2cee8d190rbowen <dd>Server sends (<em>e.g.</em>): <code>Server: Apache/2.4.1
9e59849752ebadf803f76453fe3b64e2cee8d190rbowen <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>
23b36269d124e7a6aaa5221891f7ae2ef3eeb158jerenkrantz <p>After version 2.0.44, this directive also controls the
7b5535ed88e0f561b3bfb3330137bd804846afd4slive information presented by the <directive
7b5535ed88e0f561b3bfb3330137bd804846afd4slive module="core">ServerSignature</directive> directive.</p>
a21fb2799923b1c25a351f09e690bd46806f2fa2jim <note>Setting <directive>ServerTokens</directive> to less than
a21fb2799923b1c25a351f09e690bd46806f2fa2jim <code>minimal</code> is not recommended because it makes it more
a21fb2799923b1c25a351f09e690bd46806f2fa2jim difficult to debug interoperational problems. Also note that
a21fb2799923b1c25a351f09e690bd46806f2fa2jim disabling the Server: header does nothing at all to make your
a21fb2799923b1c25a351f09e690bd46806f2fa2jim server more secure; the idea of "security through obscurity"
a21fb2799923b1c25a351f09e690bd46806f2fa2jim is a myth and leads to a false sense of safety.</note>
f35c904c3b359610a46e94fbb4ba8495b2338521slive<seealso><directive module="core">ServerSignature</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Forces all matching files to be processed by a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivehandler</description>
fb77c505254b6e9c925e23e734463e87574f8f40kess<syntax>SetHandler <var>handler-name</var>|None</syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<context>directory</context><context>.htaccess</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen<compatibility>Moved into the core in Apache httpd 2.0</compatibility>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>When placed into an <code>.htaccess</code> file or a
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <directive type="section" module="core">Directory</directive> or
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive type="section" module="core">Location</directive>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive section, this directive forces all matching files to be parsed
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive through the <a href="/handler.html">handler</a> given by
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <var>handler-name</var>. For example, if you had a directory you
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive wanted to be parsed entirely as imagemap rule files, regardless
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive of extension, you might put the following into an
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd SetHandler imap-file
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Another example: if you wanted to have the server display a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive status report whenever a URL of
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>http://servername/status</code> was called, you might put
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <Location /status><br />
130d299c4b2b15be45532a176604c71fdc7bea5bnd SetHandler server-status<br />
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </Location>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
c97e8972ab1f4dd167e3dc4db87daf91114009fbnd <p>You can override an earlier defined <directive>SetHandler</directive>
91d09a9328c13761516ce2fedeeb23f525d4ec75nd <p>Because <directive>SetHandler</directive> overrides default handlers,
b89fea36d9c12cec3344576824f4e6798da90ad4rbowen normal behavior such as handling of URLs ending in a slash (/) as
db1b819ff8966e3c6a5ca03c59a8ae06c2cecc9frbowen<seealso><directive module="mod_mime">AddHandler</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Sets the filters that will process client requests and POST
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveinput</description>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<syntax>SetInputFilter <var>filter</var>[;<var>filter</var>...]</syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<context>directory</context><context>.htaccess</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <directive>SetInputFilter</directive> directive sets the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive filter or filters which will process client requests and POST
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive 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>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><a href="/filter.html">Filters</a> documentation</seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Sets the filters that will process responses from the
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveserver</description>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<syntax>SetOutputFilter <var>filter</var>[;<var>filter</var>...]</syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<context>directory</context><context>.htaccess</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <directive>SetOutputFilter</directive> directive sets the filters
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive which will process responses from the server before they are
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive sent to the client. This is in addition to any filters defined
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive elsewhere, including the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive module="mod_mime">AddOutputFilter</directive>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directive.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>For example, the following configuration will process all files
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive in the <code>/www/data/</code> directory for server-side
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive includes.</p>
130d299c4b2b15be45532a176604c71fdc7bea5bnd SetOutputFilter INCLUDES<br />
130d299c4b2b15be45532a176604c71fdc7bea5bnd </Directory>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
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>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><a href="/filter.html">Filters</a> documentation</seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
003f0c9fda6664daf5092a0e42f65ede20098153slive<description>Amount of time the server will wait for
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivecertain events before failing a request</description>
fa71303e53e7ef460728446b8290d05ed0895136trawick<contextlist><context>server config</context><context>virtual host</context></contextlist>
b91096bcdd71fcbb37c9905f6cf79e930ae349b1jorton <p>The <directive>TimeOut</directive> directive defines the length
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen of time Apache httpd will wait for I/O in various circumstances:</p>
b91096bcdd71fcbb37c9905f6cf79e930ae349b1jorton <li>When reading data from the client, the length of time to
b91096bcdd71fcbb37c9905f6cf79e930ae349b1jorton wait for a TCP packet to arrive if the read buffer is
b91096bcdd71fcbb37c9905f6cf79e930ae349b1jorton empty.</li>
b91096bcdd71fcbb37c9905f6cf79e930ae349b1jorton <li>When writing data to the client, the length of time to wait
b91096bcdd71fcbb37c9905f6cf79e930ae349b1jorton for an acknowledgement of a packet if the send buffer is
b91096bcdd71fcbb37c9905f6cf79e930ae349b1jorton <li>In <module>mod_cgi</module>, the length of time to wait for
b91096bcdd71fcbb37c9905f6cf79e930ae349b1jorton output from a CGI script.</li>
b91096bcdd71fcbb37c9905f6cf79e930ae349b1jorton <li>In <module>mod_ext_filter</module>, the length of time to
b91096bcdd71fcbb37c9905f6cf79e930ae349b1jorton wait for output from a filtering process.</li>
b91096bcdd71fcbb37c9905f6cf79e930ae349b1jorton <li>In <module>mod_proxy</module>, the default timeout value if
b91096bcdd71fcbb37c9905f6cf79e930ae349b1jorton <directive module="mod_proxy">ProxyTimeout</directive> is not
b91096bcdd71fcbb37c9905f6cf79e930ae349b1jorton configured.</li>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
b00fe3c3354db01001b8eddfd9b88441380f837dwrowe<directivesynopsis>
b89fea36d9c12cec3344576824f4e6798da90ad4rbowen<description>Determines the behavior on <code>TRACE</code> requests</description>
b00fe3c3354db01001b8eddfd9b88441380f837dwrowe<syntax>TraceEnable <var>[on|off|extended]</var></syntax>
2bb4320391b88748dc6e851deca941b058231664rbowen<contextlist><context>server config</context><context>virtual host</context></contextlist>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen<compatibility>Available in Apache HTTP Server 1.3.34, 2.0.55 and later</compatibility>
12099dff89f3135d53929f4f1bdb42c7d044d928nd <p>This directive overrides the behavior of <code>TRACE</code> for both
12099dff89f3135d53929f4f1bdb42c7d044d928nd the core server and <module>mod_proxy</module>. The default
12099dff89f3135d53929f4f1bdb42c7d044d928nd <code>TraceEnable on</code> permits <code>TRACE</code> requests per
12099dff89f3135d53929f4f1bdb42c7d044d928nd RFC 2616, which disallows any request body to accompany the request.
12099dff89f3135d53929f4f1bdb42c7d044d928nd <module>mod_proxy</module> to return a <code>405</code> (Method not
12099dff89f3135d53929f4f1bdb42c7d044d928nd allowed) error to the client.</p>
b00fe3c3354db01001b8eddfd9b88441380f837dwrowe <p>Finally, for testing and diagnostic purposes only, request
031bbbc0d1189b07330e38d0c126820a9ab7795egryzor bodies may be allowed using the non-compliant <code>TraceEnable
b00fe3c3354db01001b8eddfd9b88441380f837dwrowe extended</code> directive. The core (as an origin server) will
b00fe3c3354db01001b8eddfd9b88441380f837dwrowe restrict the request body to 64k (plus 8k for chunk headers if
12099dff89f3135d53929f4f1bdb42c7d044d928nd <code>Transfer-Encoding: chunked</code> is used). The core will
12099dff89f3135d53929f4f1bdb42c7d044d928nd reflect the full headers and all chunk headers with the response
12099dff89f3135d53929f4f1bdb42c7d044d928nd body. As a proxy server, the request body is not restricted to 64k.</p>
b00fe3c3354db01001b8eddfd9b88441380f837dwrowe</directivesynopsis>
20b0f809c3823eda58808be053ffc305dfa9c785sf<directivesynopsis>
20b0f809c3823eda58808be053ffc305dfa9c785sf<description>Undefine the existence of a variable</description>
20b0f809c3823eda58808be053ffc305dfa9c785sf<contextlist><context>server config</context></contextlist>
20b0f809c3823eda58808be053ffc305dfa9c785sf <p>Undoes the effect of a <directive module="core">Define</directive> or
20b0f809c3823eda58808be053ffc305dfa9c785sf of passing a <code>-D</code> argument to <program>httpd</program>.</p>
20b0f809c3823eda58808be053ffc305dfa9c785sf <p>This directive can be used to toggle the use of <directive module="core"
20b0f809c3823eda58808be053ffc305dfa9c785sf type="section">IfDefine</directive> sections without needing to alter
20b0f809c3823eda58808be053ffc305dfa9c785sf</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Configures how the server determines its own name and
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveport</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen <p>In many situations Apache httpd must construct a <em>self-referential</em>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd URL -- that is, a URL that refers back to the same server. With
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen <code>UseCanonicalName On</code> Apache httpd will use the hostname and port
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd specified in the <directive module="core">ServerName</directive>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd directive to construct the canonical name for the server. This name
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd is used in all self-referential URLs, and for the values of
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <code>SERVER_NAME</code> and <code>SERVER_PORT</code> in CGIs.</p>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen <p>With <code>UseCanonicalName Off</code> Apache httpd will form
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive self-referential URLs using the hostname and port supplied by
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the client if any are supplied (otherwise it will use the
3c6c63407f1855ddfc45ac69b69a2a9bf15135e6rbowen canonical name, as defined above). These values are the same
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess that are used to implement <a
1fd5131d5732e639b0b4225ca0afea717c41bc11trawick href="/vhosts/name-based.html">name-based virtual hosts</a>,
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess and are available with the same clients. The CGI variables
3c6c63407f1855ddfc45ac69b69a2a9bf15135e6rbowen <code>SERVER_NAME</code> and <code>SERVER_PORT</code> will be
3c6c63407f1855ddfc45ac69b69a2a9bf15135e6rbowen constructed from the client supplied values as well.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>An example where this may be useful is on an intranet server
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive where you have users connecting to the machine using short
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive names such as <code>www</code>. You'll notice that if the users
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive type a shortname, and a URL which is a directory, such as
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>http://www/splat</code>, <em>without the trailing
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen slash</em> then Apache httpd will redirect them to
ffe8ed2cd88be2c415ddef11f50394c52df9190ctrawick <code>http://www.example.com/splat/</code>. If you have
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive authentication enabled, this will cause the user to have to
3c6c63407f1855ddfc45ac69b69a2a9bf15135e6rbowen authenticate twice (once for <code>www</code> and once again
3c6c63407f1855ddfc45ac69b69a2a9bf15135e6rbowen href="http://httpd.apache.org/docs/misc/FAQ.html#prompted-twice">the
3c6c63407f1855ddfc45ac69b69a2a9bf15135e6rbowen FAQ on this subject for more information</a>). But if
fb77c505254b6e9c925e23e734463e87574f8f40kess <directive>UseCanonicalName</directive> is set <code>Off</code>, then
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen Apache httpd will redirect to <code>http://www/splat/</code>.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>There is a third option, <code>UseCanonicalName DNS</code>,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive which is intended for use with mass IP-based virtual hosting to
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive support ancient clients that do not provide a
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen <code>Host:</code> header. With this option Apache httpd does a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive reverse DNS lookup on the server IP address that the client
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive connected to in order to work out self-referential URLs.</p>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <p>If CGIs make assumptions about the values of <code>SERVER_NAME</code>
130d299c4b2b15be45532a176604c71fdc7bea5bnd they may be broken by this option. The client is essentially free
130d299c4b2b15be45532a176604c71fdc7bea5bnd to give whatever value they want as a hostname. But if the CGI is
130d299c4b2b15be45532a176604c71fdc7bea5bnd only using <code>SERVER_NAME</code> to construct self-referential URLs
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive then it should be just fine.</p>
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim<seealso><directive module="core">UseCanonicalPhysicalPort</directive></seealso>
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim<seealso><directive module="core">ServerName</directive></seealso>
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim<seealso><directive module="mpm_common">Listen</directive></seealso>
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim</directivesynopsis>
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim<directivesynopsis>
d56970df0a3d627ea0bc8867a9d336cfe67da7b2nd<description>Configures how the server determines its own port</description>
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim<contextlist><context>server config</context><context>virtual host</context>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen <p>In many situations Apache httpd must construct a <em>self-referential</em>
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim URL -- that is, a URL that refers back to the same server. With
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen <code>UseCanonicalPhysicalPort On</code> Apache httpd will, when
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim constructing the canonical port for the server to honor
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim the <directive module="core">UseCanonicalName</directive> directive,
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim provide the actual physical port number being used by this request
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim as a potential port. With <code>UseCanonicalPhysicalPort Off</code>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen Apache httpd will not ever use the actual physical port number, instead
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim relying on all configured information to construct a valid port number.</p>
9cfaf3cf0b6a838ae98bb174660c6220734855f0nd <p>The ordering of the lookup when the physical port is used is as
9cfaf3cf0b6a838ae98bb174660c6220734855f0nd follows:</p>
4e8794dab6bbd15eb0bb016c7a4efb8b0572d558nd <li>Port provided in <directive module="core">Servername</directive></li>
4e8794dab6bbd15eb0bb016c7a4efb8b0572d558nd <li>Port provided in <directive module="core">Servername</directive></li>
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim physical ports are removed from the ordering.</p>
a38b5f73e7f0f3b8726fb47d27b145f37036ead0jim<seealso><directive module="core">UseCanonicalName</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive module="core">ServerName</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive module="mpm_common">Listen</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Contains directives that apply only to a specific
313bb560bc5c323cfd40c9cad7335b4b8e060aedkesshostname or IP address</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax><VirtualHost
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <var>addr</var>[:<var>port</var>] [<var>addr</var>[:<var>port</var>]]
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive ...> ... </VirtualHost></syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context></contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p><directive type="section">VirtualHost</directive> and
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code></VirtualHost></code> are used to enclose a group of
a23acbbd61b9565caecea9931b6bcdf0b6228cbbslive directives that will apply only to a particular virtual host. Any
a23acbbd61b9565caecea9931b6bcdf0b6228cbbslive directive that is allowed in a virtual host context may be
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive used. When the server receives a request for a document on a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive particular virtual host, it uses the configuration directives
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive enclosed in the <directive type="section">VirtualHost</directive>
ffec3e56ff5331a2d732ec07e9d107303fed43f4covener section. <var>Addr</var> can be any of the following, optionally followed by
ffec3e56ff5331a2d732ec07e9d107303fed43f4covener a colon and a port number (or *):</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <li>A fully qualified domain name for the IP address of the
01710fa5f312f3a9cd1969d1809cf6c19a7f3d31niq virtual host (not recommended);</li>
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim <li>The character <code>*</code>, which acts as a wildcard and matches
ffec3e56ff5331a2d732ec07e9d107303fed43f4covener any IP address.</li>
ffec3e56ff5331a2d732ec07e9d107303fed43f4covener <li>The string <code>_default_</code>, which is an alias for <code>*</code></li>
ffec3e56ff5331a2d732ec07e9d107303fed43f4covener <VirtualHost 10.1.2.3:80><br />
e8811b6d38f756b325446ded5d96857d13856511takashi ServerAdmin webmaster@host.example.com<br />
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </VirtualHost>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>IPv6 addresses must be specified in square brackets because
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd the optional port number could not be determined otherwise. An
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd IPv6 example is shown below:</p>
ffec3e56ff5331a2d732ec07e9d107303fed43f4covener <VirtualHost [2001:db8::a00:20ff:fea7:ccea]:80><br />
130d299c4b2b15be45532a176604c71fdc7bea5bnd ServerAdmin webmaster@host.example.com<br />
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </VirtualHost>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess </example>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Each Virtual Host must correspond to a different IP address,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive different port number or a different host name for the server,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive in the former case the server machine must be configured to
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive accept IP packets for multiple addresses. (If the machine does
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive not have multiple network interfaces, then this can be
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess accomplished with the <code>ifconfig alias</code> command -- if
a23acbbd61b9565caecea9931b6bcdf0b6228cbbslive your OS supports it).</p>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <p>The use of <directive type="section">VirtualHost</directive> does
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen <strong>not</strong> affect what addresses Apache httpd listens on. You
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen may need to ensure that Apache httpd is listening on the correct addresses
130d299c4b2b15be45532a176604c71fdc7bea5bnd using <directive module="mpm_common">Listen</directive>.</p>
4cf1c07a88ef51e11570c775507cd7d2c3e35a97slive <p>A <directive module="core">ServerName</directive> should be
4cf1c07a88ef51e11570c775507cd7d2c3e35a97slive specified inside each <directive
4cf1c07a88ef51e11570c775507cd7d2c3e35a97slive type="section">VirtualHost</directive> block. If it is absent, the
4cf1c07a88ef51e11570c775507cd7d2c3e35a97slive <directive module="core">ServerName</directive> from the "main"
4cf1c07a88ef51e11570c775507cd7d2c3e35a97slive server configuration will be inherited.</p>
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim <p>When a request is received, the server first maps it to the best matching
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim <directive type="section">VirtualHost</directive> based on the local
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim IP address and port combination only. Non-wildcards have a higher
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim precedence. If no match based on IP and port occurs at all, the
ffec3e56ff5331a2d732ec07e9d107303fed43f4covener "main" server configuration is used.</p>
ffec3e56ff5331a2d732ec07e9d107303fed43f4covener <p>If multiple virtual hosts contain the best matching IP address and port,
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim the server selects from these virtual hosts the best match based on the
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim requested hostname. If no matching name-based virtual host is found,
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim then the first listed virtual host that matched the IP address will be
18ee8bb3db5cc3b04291f89301bd5d14dc271066lgentis used. As a consequence, the first listed virtual host for a given IP address
f7acc4b00a8bf92fea10fce6ac09aa57eafec0ecjim and port combination is default virtual host for that IP and port
ffec3e56ff5331a2d732ec07e9d107303fed43f4covener combination.</p>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <p>See the <a href="/misc/security_tips.html">security tips</a>
130d299c4b2b15be45532a176604c71fdc7bea5bnd document for details on why your security could be compromised if the
9b5e2c5e769dc678a1aca06df75c32022b2f1492trawick directory where log files are stored is writable by anyone other
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive than the user that starts the server.</p>
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen<seealso><a href="/vhosts/">Apache HTTP Server Virtual Host documentation</a></seealso>
ef8e89e090461194ecadd31e8796a2c51e0531a2kess<seealso><a href="/dns-caveats.html">Issues Regarding DNS and
88d86cfadffe2275a3dfb67a4d7bdc018630b661rbowen which addresses and ports Apache HTTP Server uses</a></seealso>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<seealso><a href="/sections.html">How <Directory>, <Location>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess and <Files> sections work</a> for an explanation of how these
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess different sections are combined when a request is received</seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
7db9f691a00ead175b03335457ca296a33ddf31bnd</modulesynopsis>