core.xml revision 05201775eaa6b363b8a119c8aea5db246b967591
530eba85dbd41b8a0fa5255d3648d1440199a661slive<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">
e942c741056732f50da2074b36fe59805d370650slive<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>
5f5d1b4cc970b7f06ff8ef6526128e9a27303d88nd<modulesynopsis>
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding<description>Core Apache HTTP Server features that are always
db479b48bd4d75423ed4a45e15b75089d1a8ad72fieldingavailable</description>
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding<directivesynopsis>
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd<description>Resources accept trailing pathname information</description>
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd<context>virtual host</context><context>directory</context>
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd<compatibility>Available in Apache 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
530eba85dbd41b8a0fa5255d3648d1440199a661slive available to scripts in the PATH_INFO environment variable.</p>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna <p>For example, assume the location <code>/test/</code> points to
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna a directory that contains only the single file
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna <p>The three possible arguments for the
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna <directive>AcceptPathInfo</directive> directive are:</p>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna <dt><code>off</code></dt><dd>A request will only be accepted if it
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna maps to a literal path that exists. Therefore a request with
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna trailing pathname information after the true filename such as
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna <code>/test/here.html/more</code> in the above example will return
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna a 404 NOT FOUND error.</dd>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna <dt><code>on</code></dt><dd>A request will be accepted if a
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna leading path component maps to a file that exists. The above
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna example <code>/test/here.html/more</code> will be accepted if
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna <code>/test/here.html</code> maps to a valid file.</dd>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna <dt><code>default</code></dt><dd>The treatment of requests with
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna trailing pathname information is determined by the <a
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna href="/handler.html">handler</a> responsible for the request.
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna The core handler for normal files defaults to rejecting PATH_INFO.
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna Handlers that serve scripts, such as <a
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna href="mod_isapi.html">isapi-isa</a>, generally accept PATH_INFO by
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna default.</dd>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna <p>The primary purpose of the <code>AcceptPathInfo</code>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna directive is to allow you to override the handler's choice of
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna accepting or rejecting PATH_INFO. This override is required, for
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna example, when you use a <a href="/filter.html">filter</a>, such
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna as <a href="mod_include.html">INCLUDES</a>, to generate content
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna based on PATH_INFO. The core handler would usually reject the
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna request, so you can use the following configuration to enable
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna such a script:</p>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna Options +Includes<br />
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna SetOutputFilter INCLUDES<br />
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna AcceptPathInfo on<br />
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna </Files>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Name of the distributed configuration file</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>AccessFileName <var>filename</var> [<var>filename</var>] ...</syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>When returning a document to the client the server looks for
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the first existing configuration file from this list of names in
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive every directory of the path to the document, if distributed
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive configuration files are enabled for that directory. For
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive example:</p>
fb77c505254b6e9c925e23e734463e87574f8f40kess AccessFileName .acl
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>
fb77c505254b6e9c925e23e734463e87574f8f40kess for directives, unless they have been disabled with</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <Directory /><br />
fb77c505254b6e9c925e23e734463e87574f8f40kess AllowOverride None<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </Directory>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive module="core">AllowOverride</directive></seealso>
fb77c505254b6e9c925e23e734463e87574f8f40kess<seealso><a href="/configuring.html">Configuration Files</a></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><a href="/howto/htaccess.html">.htaccess Files</a></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
fb77c505254b6e9c925e23e734463e87574f8f40kess<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Default character set to be added for a
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveresponse without an explicit character set</description>
fb77c505254b6e9c925e23e734463e87574f8f40kess<syntax>AddDefaultCharset On|Off|<var>charset</var></syntax>
bc4b55ec8f31569d606d5680d50189a355bcd7a6rbowen<context>virtual host</context><context>directory</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This directive specifies the name of the character set that
fb77c505254b6e9c925e23e734463e87574f8f40kess will be added to any response that does not have any parameter on
fb77c505254b6e9c925e23e734463e87574f8f40kess the content type in the HTTP headers. This will override any
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive character set specified in the body of the document via a
fb77c505254b6e9c925e23e734463e87574f8f40kess <code>META</code> tag. A setting of <code>AddDefaultCharset
fb77c505254b6e9c925e23e734463e87574f8f40kess Off</code> disables this
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive functionality. <code>AddDefaultCharset On</code> enables
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd Apache's internal default charset of <code>iso-8859-1</code> as
130d299c4b2b15be45532a176604c71fdc7bea5bnd required by the directive. You can also specify an alternate
130d299c4b2b15be45532a176604c71fdc7bea5bnd AddDefaultCharset utf-8
ef8e89e090461194ecadd31e8796a2c51e0531a2kess </example>
130d299c4b2b15be45532a176604c71fdc7bea5bnd</directivesynopsis>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>assigns an output filter to a particular MIME-type</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>AddOutputFilterByType <var>filter</var>[;<var>filter</var>...] <var>MIME-type</var>
003f0c9fda6664daf5092a0e42f65ede20098153slive<context>virtual host</context><context>directory</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<compatibility>Available in Apache 2.0.33 and later</compatibility>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess href="/filter.html">filter</a> for a request depending on the
003f0c9fda6664daf5092a0e42f65ede20098153slive response MIME-type.</p>
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess <p>The following example uses the DEFLATE filter, which is provided by
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess <module>mod_deflate</module>. It will compress all output (either static
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive or dynamic) which is labeled as <code>text/html</code> or
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <code>text/plain</code> before it is sent to the client.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>If you want the content to be processed by more than one filter, they
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive have to be separated by semicolons. It's also possible to use one
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive>AddOutputFilterByType</directive> directive for each of
130d299c4b2b15be45532a176604c71fdc7bea5bnd <p>The configuration below causes all script output labeled as
130d299c4b2b15be45532a176604c71fdc7bea5bnd <code>text/html</code> to be processed at first by the INCLUDES filter
130d299c4b2b15be45532a176604c71fdc7bea5bnd and then by the DEFLATE filter.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <Location /cgi-bin/><br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Options Includes<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive AddOutputFilterByType INCLUDES;DEFLATE text/html<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </Location>
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding <p>The output filters are not applied on proxy requests.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive module="mod_mime">AddOutputFilter</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive module="core">SetOutputFilter</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><a href="/filter.html">The filters documentation</a></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding<directivesynopsis>
684f2a9a422185adda0692a1203c5ad6687fc5c5nd<description>Types of directives that are allowed in
a8ce9095d102e43fecb81093a132b90b9a227f78kess.htaccess files</description>
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding<contextlist><context>directory</context></contextlist>
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding <p>When the server finds an .htaccess file (as specified by <directive
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding module="core">AccessFileName</directive>) it needs to know
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive which directives declared in that file can override earlier
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd access information.</p>
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding .htaccess files are completely ignored. In this case, the
684f2a9a422185adda0692a1203c5ad6687fc5c5nd server will not even attempt to read .htaccess files in the
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding filesystem.</p>
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding <p>When this directive is set to <code>All</code>, then any
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding directive which has the .htaccess <a
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding href="directive-dict.html#Context">Context</a> is allowed in
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding .htaccess files.</p>
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding <p>The <var>directive-type</var> can be one of the following
843a03fe0b138a4c1f64cb90a014e9417ac30691fielding groupings of directives.</p>
58699879a562774640b95e9eedfd891f336e38c2nd Allow use of the authorization directives (<directive
fb77c505254b6e9c925e23e734463e87574f8f40kess <directive module="mod_authn_dbm">AuthDBMUserFile</directive>,
58699879a562774640b95e9eedfd891f336e38c2nd <directive module="mod_authz_groupfile">AuthGroupFile</directive>,
58699879a562774640b95e9eedfd891f336e38c2nd <directive module="core">AuthType</directive>, <directive
58699879a562774640b95e9eedfd891f336e38c2nd module="mod_authn_file">AuthUserFile</directive>, <directive
a2920e90d95fa04c15bdbbc03e7f8636eac92423slive module="core">Require</directive>, <em>etc.</em>).</dd>
a2920e90d95fa04c15bdbbc03e7f8636eac92423slive Allow use of the directives controlling document types (<directive
fb77c505254b6e9c925e23e734463e87574f8f40kess <directive module="core">SetHandler</directive>, <directive
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess Allow use of the directives controlling directory indexing
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess (<directive
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess <directive module="mod_autoindex">AddIcon</directive>, <directive
58699879a562774640b95e9eedfd891f336e38c2nd <directive module="mod_autoindex">AddIconByType</directive>,
fb77c505254b6e9c925e23e734463e87574f8f40kess <directive module="mod_autoindex">DefaultIcon</directive>, <directive
fb77c505254b6e9c925e23e734463e87574f8f40kess module="mod_dir">DirectoryIndex</directive>, <directive
fb77c505254b6e9c925e23e734463e87574f8f40kess module="mod_autoindex">FancyIndexing</directive>, <directive
58699879a562774640b95e9eedfd891f336e38c2nd module="mod_autoindex">HeaderName</directive>, <directive
58699879a562774640b95e9eedfd891f336e38c2nd module="mod_autoindex">IndexIgnore</directive>, <directive
58699879a562774640b95e9eedfd891f336e38c2nd module="mod_autoindex">IndexOptions</directive>, <directive
58699879a562774640b95e9eedfd891f336e38c2nd Allow use of the directives controlling host access (<directive
4a7affccb2f1f5b94cab395e1bf3825aed715ebcnd Allow use of the directives controlling specific directory
4a7affccb2f1f5b94cab395e1bf3825aed715ebcnd features (<directive module="core">Options</directive> and
9b5e2c5e769dc678a1aca06df75c32022b2f1492trawick <directive module="mod_include">XBitHack</directive>).</dd>
58699879a562774640b95e9eedfd891f336e38c2nd AllowOverride AuthConfig Indexes
58699879a562774640b95e9eedfd891f336e38c2nd </example>
58699879a562774640b95e9eedfd891f336e38c2nd<seealso><directive module="core">AccessFileName</directive></seealso>
4a7affccb2f1f5b94cab395e1bf3825aed715ebcnd<seealso><a href="/configuring.html">Configuration Files</a></seealso>
58699879a562774640b95e9eedfd891f336e38c2nd<seealso><a href="/howto/htaccess.html">.htaccess Files</a></seealso>
58699879a562774640b95e9eedfd891f336e38c2nd</directivesynopsis>
77ead9e0262e4f08ec336d1a65b2edef7705c839nd<directivesynopsis>
77ead9e0262e4f08ec336d1a65b2edef7705c839nd<description>Authorization realm for use in HTTP
77ead9e0262e4f08ec336d1a65b2edef7705c839ndauthentication</description>
77ead9e0262e4f08ec336d1a65b2edef7705c839nd<contextlist><context>directory</context><context>.htaccess</context>
77ead9e0262e4f08ec336d1a65b2edef7705c839nd</contextlist>
77ead9e0262e4f08ec336d1a65b2edef7705c839nd <p>This directive sets the name of the authorization realm for a
77ead9e0262e4f08ec336d1a65b2edef7705c839nd directory. This realm is given to the client so that the user
77ead9e0262e4f08ec336d1a65b2edef7705c839nd knows which username and password to send.
77ead9e0262e4f08ec336d1a65b2edef7705c839nd <directive>AuthName</directive> takes a single argument; if the
77ead9e0262e4f08ec336d1a65b2edef7705c839nd realm name contains spaces, it must be enclosed in quotation
77ead9e0262e4f08ec336d1a65b2edef7705c839nd marks. It must be accompanied by <directive
77ead9e0262e4f08ec336d1a65b2edef7705c839nd module="core">Require</directive> directives, and directives such
77ead9e0262e4f08ec336d1a65b2edef7705c839nd as <directive module="mod_authn_file">AuthUserFile</directive> and
77ead9e0262e4f08ec336d1a65b2edef7705c839nd <directive module="mod_authz_groupfile">AuthGroupFile</directive> to
77ead9e0262e4f08ec336d1a65b2edef7705c839nd AuthName "Top Secret"
77ead9e0262e4f08ec336d1a65b2edef7705c839nd </example>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The string provided for the <code>AuthName</code> is what will
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive appear in the password dialog provided by most browsers.</p>
fb77c505254b6e9c925e23e734463e87574f8f40kess href="/howto/auth.html">Authentication, Authorization, and
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
fb77c505254b6e9c925e23e734463e87574f8f40kess<contextlist><context>directory</context><context>.htaccess</context>
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess</contextlist>
fb77c505254b6e9c925e23e734463e87574f8f40kess <p>This directive selects the type of user authentication for a
b12b918ae6baf9c5762ed61b7393d0e2198378c0nd directory. Only <code>Basic</code> and <code>Digest</code> are
b12b918ae6baf9c5762ed61b7393d0e2198378c0nd currently implemented.
b12b918ae6baf9c5762ed61b7393d0e2198378c0nd It must be accompanied by <directive
10673857794a4b3d9568ca2d983722a87ed352f1rbowen module="core">Require</directive> directives, and directives such
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive as <directive module="mod_authn_file">AuthUserFile</directive> and
fb77c505254b6e9c925e23e734463e87574f8f40kess <directive module="mod_authz_groupfile">AuthGroupFile</directive> to
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><a href="/howto/auth.html">Authentication, Authorization,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
fb77c505254b6e9c925e23e734463e87574f8f40kess<directivesynopsis>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<description>Technique for locating the interpreter for CGI
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivescripts</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>directory</context><context>.htaccess</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
1f53e295ebd19aed1767d12da7abfab9936c148cjerenkrantz <p>This directive is used to control how Apache finds the
9ed9eaf871c58d281af02e76125ceadb5060afa5nd interpreter used to run CGI scripts. For example, setting <code>CGIMapExtension sys:\foo.nlm .foo</code> will
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess cause all CGI script files with a .foo extension to be passed to the FOO interpreter.</p>
1f53e295ebd19aed1767d12da7abfab9936c148cjerenkrantz</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Enables the generation of Content-MD5 HTTP Response
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveheaders</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<context>directory</context><context>.htaccess</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem <p>This directive enables the generation of
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem <code>Content-MD5</code> headers as defined in RFC1864
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem respectively RFC2068.</p>
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem <p>MD5 is an algorithm for computing a "message digest"
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem (sometimes called "fingerprint") of arbitrary-length data, with
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem a high degree of confidence that any alterations in the data
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem will be reflected in alterations in the message digest.</p>
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem <p>The <code>Content-MD5</code> header provides an end-to-end
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem message integrity check (MIC) of the entity-body. A proxy or
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem client may check this header for detecting accidental
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem modification of the entity-body in transit. Example header:</p>
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem Content-MD5: AuLb7Dp1rqtRtxz2m9kRpA==
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem <p>Note that this can cause performance problems on your server
5528d1a30ae8560e2d7a96d734ffe31500dc6113rpluem 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
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive by the core, and not by any module. For example, SSI documents,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive output from CGI scripts, and byte range responses do not have
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive this header.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>MIME content-type that will be sent if the
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveserver cannot determine a type in any other way</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<context>directory</context><context>.htaccess</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>There will be times when the server is asked to provide a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive document whose type cannot be determined by its MIME types
9ed9eaf871c58d281af02e76125ceadb5060afa5nd mappings.</p>
9ed9eaf871c58d281af02e76125ceadb5060afa5nd <p>The server must inform the client of the content-type of the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive document, so in the event of an unknown type it uses the
103a93c625bcde1a6a7a5155b64dcda36f612180pquerna <p>would be appropriate for a directory which contained many gif
f23fb63b05f89f47d7a3099491f2c68dcce432e9kess images with filenames missing the .gif extension.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="core">ForceType</directive>, this directive is only
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive provides the default mime-type. All other mime-type definitions,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive including filename extensions, that might identify the media type
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd will override this default.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd</directivesynopsis>
b12b918ae6baf9c5762ed61b7393d0e2198378c0nd<description>Enclose a group of directives that apply only to the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivenamed file-system directory and sub-directories</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive... </Directory></syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
54bcd0e21a5c79158afd3b78bf707a493a5fb33crbowen</contextlist>
4c7bdb15764021d39e486adb7bc2166d3f683773bnicholes <p><directive type="section">Directory</directive> and
4c7bdb15764021d39e486adb7bc2166d3f683773bnicholes <code></Directory></code> are used to enclose a group of
fb77c505254b6e9c925e23e734463e87574f8f40kess directives that will apply only to the named directory and
4c7bdb15764021d39e486adb7bc2166d3f683773bnicholes sub-directories of that directory. Any directive that is allowed
fb77c505254b6e9c925e23e734463e87574f8f40kess in a directory context may be used. <var>Directory-path</var> is
4c7bdb15764021d39e486adb7bc2166d3f683773bnicholes either the full path to a directory, or a wild-card string using
4c7bdb15764021d39e486adb7bc2166d3f683773bnicholes Unix shell-style matching. In a wild-card string, `?' matches any
4c7bdb15764021d39e486adb7bc2166d3f683773bnicholes single character, and `*' matches any sequences of characters.
4c7bdb15764021d39e486adb7bc2166d3f683773bnicholes You may also use `[]' character ranges. None of the wildcards
4c7bdb15764021d39e486adb7bc2166d3f683773bnicholes match a `/' character, so <code><Directory
4c7bdb15764021d39e486adb7bc2166d3f683773bnicholes /*/public_html></code> will not match
4c7bdb15764021d39e486adb7bc2166d3f683773bnicholes <code>/home/user/public_html</code>, but <code><Directory
fb77c505254b6e9c925e23e734463e87574f8f40kess /home/*/public_html></code> will match. Example:</p>
4c7bdb15764021d39e486adb7bc2166d3f683773bnicholes Options Indexes FollowSymLinks<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </Directory>
fb77c505254b6e9c925e23e734463e87574f8f40kess <p>Be careful with the <var>directory-path</var> arguments:
fb77c505254b6e9c925e23e734463e87574f8f40kess They have to literally match the filesystem path which Apache uses
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive to access the files. Directives applied to a particular
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <Directory> will not apply to files accessed from that same
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directory via a different path, such as via different symbolic
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Extended regular
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive expressions can also be used, with the addition of the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <Directory ~ "^/www/.*/[0-9]{3}">
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>would match directories in /www/ that consisted of three
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive numbers.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>If multiple (non-regular expression) directory sections
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive match the directory (or its parents) containing a document,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive then the directives are applied in the order of shortest match
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd first, interspersed with the directives from the <a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <Directory /><br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive AllowOverride None<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </Directory><br />
fb77c505254b6e9c925e23e734463e87574f8f40kess <Directory /home/><br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive AllowOverride FileInfo<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </Directory>
003f0c9fda6664daf5092a0e42f65ede20098153slive <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
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <li>Apply any FileInfo directives in
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>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <Directory ~ abc$><br />
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess # ... directives here ...<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </Directory>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The regular expression section won't be considered until after
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive all normal <Directory>s and <code>.htaccess</code> files
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess have been applied. Then the regular expression will match on
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>/home/abc/public_html/abc</code> and be applied.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <Directory /> is <code>Allow from All</code>. This means
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive that Apache will serve any file mapped from an URL. It is
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive recommended that you change this with a block such
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <Directory /><br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Order Deny,Allow<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Deny from All<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </Directory>
fb77c505254b6e9c925e23e734463e87574f8f40kess href="/misc/security_tips.html">Security Tips</a> page for more
fb77c505254b6e9c925e23e734463e87574f8f40kess <p>The directory sections typically occur in
003f0c9fda6664daf5092a0e42f65ede20098153slive the access.conf file, but they may appear in any configuration
003f0c9fda6664daf5092a0e42f65ede20098153slive file. <directive type="section">Directory</directive> directives
003f0c9fda6664daf5092a0e42f65ede20098153slive cannot nest, and cannot appear in a <directive module="core"
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd type="section">Limit</directive> or <directive module="core"
130d299c4b2b15be45532a176604c71fdc7bea5bnd Directory, Location and Files sections work</a> for an
130d299c4b2b15be45532a176604c71fdc7bea5bnd explanation of how these different sections are combined when a
130d299c4b2b15be45532a176604c71fdc7bea5bnd request is received</seealso>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd</directivesynopsis>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<description>Enclose directives that apply to
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cndfile-system directories matching a regular expression and their
fb77c505254b6e9c925e23e734463e87574f8f40kesssubdirectories</description>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd... </Directory></syntax>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<contextlist><context>server config</context><context>virtual host</context>
b06660a3ed3d885e15d99c0209a46c4657df33fbrbowen</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p><directive type="section">DirectoryMatch</directive> and
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <code></DirectoryMatch></code> are used to enclose a group
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd of directives which will apply only to the named directory and
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd sub-directories of that directory, the same as <directive
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd module="core" type="section">Directory</directive>. However, it
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd takes as an argument a regular expression. For example:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <DirectoryMatch "^/www/.*/[0-9]{3}">
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess </example>
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess <p>would match directories in <code>/www/</code> that consisted of three
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive numbers.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive type="section" module="core">Directory</directive> for
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivea description of how regular expressions are mixed in with normal
130d299c4b2b15be45532a176604c71fdc7bea5bndhref="/sections.html">How Directory, Location and Files sections
130d299c4b2b15be45532a176604c71fdc7bea5bndwork</a> for an explanation of how these different sections are
130d299c4b2b15be45532a176604c71fdc7bea5bndcombined when a request is received</seealso>
130d299c4b2b15be45532a176604c71fdc7bea5bnd</directivesynopsis>
130d299c4b2b15be45532a176604c71fdc7bea5bnd<directivesynopsis>
130d299c4b2b15be45532a176604c71fdc7bea5bnd<description>Directory that forms the main document tree visible
130d299c4b2b15be45532a176604c71fdc7bea5bndfrom the web</description>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<contextlist><context>server config</context><context>virtual host</context>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This directive sets the directory from which httpd will
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive serve files. Unless matched by a directive like Alias, the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive server appends the path from the requested URL to the document
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive root to make the path to the document. Example:</p>
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess <p>then an access to
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess <code>http://www.my.host.com/index.html</code> refers to
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <directive>DocumentRoot</directive> should be specified without
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive a trailing slash.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><a href="/urlmapping.html">Mapping URLs to Filesystem
130d299c4b2b15be45532a176604c71fdc7bea5bnd</directivesynopsis>
130d299c4b2b15be45532a176604c71fdc7bea5bnd<directivesynopsis>
130d299c4b2b15be45532a176604c71fdc7bea5bnd<description>Use memory-mapping to read files during delivery</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<context>directory</context><context>.htaccess</context>
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess</contextlist>
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess <p>This directive controls whether the httpd may use
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive memory-mapping if it needs to read the contents of a file during
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive delivery. By default, when the handling of a request requires
fb77c505254b6e9c925e23e734463e87574f8f40kess access to the data within a file-- for example, when delivering a
fb77c505254b6e9c925e23e734463e87574f8f40kess server-parsed file using <module>mod_include</module>-- Apache
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive memory-maps the file if the OS supports it.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This memory-mapping sometimes yields a performance improvement.
130d299c4b2b15be45532a176604c71fdc7bea5bnd But in some environments, it is better to disable the memory-mapping
130d299c4b2b15be45532a176604c71fdc7bea5bnd to prevent operational problems:</p>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <li>On some multiprocessor systems, memory-mapping can reduce the
130d299c4b2b15be45532a176604c71fdc7bea5bnd performance of the httpd.</li>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <li>With an NFS-mounted <directive module="core">DocumentRoot</directive>,
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd the httpd may crash due to a segmentation fault if a file is deleted
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive or truncated while the httpd has it memory-mapped.</li>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>For server configurations that are vulnerable to these problems,
fb77c505254b6e9c925e23e734463e87574f8f40kess you should disable memory-mapping of delivered files by specifying:</p>
fb77c505254b6e9c925e23e734463e87574f8f40kess EnableMMAP off
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>For NFS mounted files, this feature may be disabled explicitly for
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the offending files by specifying:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <Directory "/path-to-nfs-files">
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive EnableMMAP off
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </Directory>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
15ba1801088da1aad6d20609cf3f7b0b1eefce8aslive<directivesynopsis>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<description>Use the kernel sendfile support to deliver files to the client</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<context>directory</context><context>.htaccess</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This directive controls whether the httpd may use the sendfile
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive support from the kernel to transmit file contents to the client.
030108b1816bcda3d925df65357feabdce83bc94slive By default, when the handling of a request requires no access
030108b1816bcda3d925df65357feabdce83bc94slive to the data within a file -- for example, when delivering a
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd static file -- Apache uses sendfile to deliver the file contents
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd without ever reading the file if the OS supports it.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>This sendfile mechanism avoids seperate read and send operations,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive and buffer allocations. But on some platforms or within some
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive filesystems, it is better to disable this feature to avoid
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive operational problems:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <li>Some platforms may have broken sendfile support that the build
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess system did not detect, especially if the binaries were built on
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive another box and moved to such a machine with broken sendfile support.</li>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <li>With an NFS-mounted <directive module="core">DocumentRoot</directive>,
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess the kernel may be unable to serve the network file through
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess it's own cache.</li>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>For server configurations that are vulnerable to these problems,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive you should disable this feature by specifying:</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd EnableSendfile off
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>For NFS mounted files, this feature may be disabled explicitly for
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the offending files by specifying:</p>
fb77c505254b6e9c925e23e734463e87574f8f40kess <Directory "/path-to-nfs-files">
fb77c505254b6e9c925e23e734463e87574f8f40kess EnableSendfile off
fb77c505254b6e9c925e23e734463e87574f8f40kess </Directory>
fb77c505254b6e9c925e23e734463e87574f8f40kess </example>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd</directivesynopsis>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>What the server will return to the client
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivein case of an error</description>
c68acc9d712af079afa2bd1a5a4aeef9a3ea573ckess<syntax>ErrorDocument <var>error-code</var> <var>document</var></syntax>
c68acc9d712af079afa2bd1a5a4aeef9a3ea573ckess<contextlist><context>server config</context><context>virtual host</context>
c68acc9d712af079afa2bd1a5a4aeef9a3ea573ckess<context>directory</context><context>.htaccess</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<compatibility>Quoting syntax for text messages is different in Apache
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive2.0</compatibility>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>In the event of a problem or error, Apache can be configured
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive to do one of four things,</p>
af18698b10b429b270551ca3a5d51a75e1c9db22brianp <li>redirect to a local <var>URL-path</var> to handle the
af18698b10b429b270551ca3a5d51a75e1c9db22brianp <li>redirect to an external <var>URL</var> to handle the
003f0c9fda6664daf5092a0e42f65ede20098153slive <p>The first option is the default, while options 2-4 are
fb77c505254b6e9c925e23e734463e87574f8f40kess configured using the <directive>ErrorDocument</directive>
fb77c505254b6e9c925e23e734463e87574f8f40kess directive, which is followed by the HTTP response code and a URL
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd or a message. Apache will sometimes offer additional information
af18698b10b429b270551ca3a5d51a75e1c9db22brianp <p>URLs can begin with a slash (/) for local URLs, or be a full
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd URL which the client can resolve. Alternatively, a message can
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd be provided to be displayed by the browser. Examples:</p>
a1ef40892ffa2b44fc249423c5b6c42a74a84c68nd ErrorDocument 500 http://foo.example.com/cgi-bin/tester<br />
a1ef40892ffa2b44fc249423c5b6c42a74a84c68nd ErrorDocument 403 "Sorry can't allow you access today"
fb77c505254b6e9c925e23e734463e87574f8f40kess </example>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>Note that when you specify an <directive>ErrorDocument</directive>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd that points to a remote URL (ie. anything with a method such as
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd "http" in front of it), Apache will send a redirect to the
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd client to tell it where to find the document, even if the
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd document ends up being on the same server. This has several
fb77c505254b6e9c925e23e734463e87574f8f40kess implications, the most important being that the client will not
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd receive the original error status code, but instead will
41ef8b3051855b802104193ee0a587515af60a37wrowe receive a redirect status code. This in turn can confuse web
41ef8b3051855b802104193ee0a587515af60a37wrowe robots and other clients which try to determine if a URL is
41ef8b3051855b802104193ee0a587515af60a37wrowe valid using the status code. In addition, if you use a remote
41ef8b3051855b802104193ee0a587515af60a37wrowe URL in an <code>ErrorDocument 401</code>, the client will not
41ef8b3051855b802104193ee0a587515af60a37wrowe know to prompt the user for a password since it will not
41ef8b3051855b802104193ee0a587515af60a37wrowe receive the 401 status code. Therefore, <strong>if you use an
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess "ErrorDocument 401" directive then it must refer to a local
41ef8b3051855b802104193ee0a587515af60a37wrowe <p>Microsoft Internet Explorer (MSIE) will ignore server-generated
41ef8b3051855b802104193ee0a587515af60a37wrowe error messages when they are "too small" and substitute its own
41ef8b3051855b802104193ee0a587515af60a37wrowe "friendly" error messages. The size threshold varies depending on
41ef8b3051855b802104193ee0a587515af60a37wrowe the type of error, but in general, if you make your error document
41ef8b3051855b802104193ee0a587515af60a37wrowe greater than 512 bytes, then MSIE will show the server-generated
41ef8b3051855b802104193ee0a587515af60a37wrowe error rather than masking it. More information is available in
41ef8b3051855b802104193ee0a587515af60a37wrowe Microsoft Knowledgebase article <a
41ef8b3051855b802104193ee0a587515af60a37wrowe href="http://support.microsoft.com/default.aspx?scid=kb;en-us;Q294807">Q294807</a>.</p>
fb77c505254b6e9c925e23e734463e87574f8f40kess <p>Prior to version 2.0, messages were indicated by prefixing
41ef8b3051855b802104193ee0a587515af60a37wrowe them with a single unmatched double quote character.</p>
41ef8b3051855b802104193ee0a587515af60a37wrowe</directivesynopsis>
a1ef40892ffa2b44fc249423c5b6c42a74a84c68nd<directivesynopsis>
41ef8b3051855b802104193ee0a587515af60a37wrowe<description>Location where the server will log errors</description>
41ef8b3051855b802104193ee0a587515af60a37wrowe<syntax> ErrorLog <var>file-path</var>|syslog[:<var>facility</var>]</syntax>
41ef8b3051855b802104193ee0a587515af60a37wrowe<contextlist><context>server config</context><context>virtual host</context>
9b5e2c5e769dc678a1aca06df75c32022b2f1492trawick</contextlist>
41ef8b3051855b802104193ee0a587515af60a37wrowe <p>The <directive>ErrorLog</directive> directive sets the name of
41ef8b3051855b802104193ee0a587515af60a37wrowe the file to which the server will log any errors it encounters. If
41ef8b3051855b802104193ee0a587515af60a37wrowe the <var>file-path</var> does not begin with a slash (/) then it is
41ef8b3051855b802104193ee0a587515af60a37wrowe assumed to be relative to the <directive
9fb925624300c864fe3969a264e52aa83f3c2dd0slive begins with a pipe (|) then it is assumed to be a command to spawn
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess to handle the error log.</p>
05201775eaa6b363b8a119c8aea5db246b967591yoshiki <p>Using <code>syslog</code> instead of a filename enables logging
41ef8b3051855b802104193ee0a587515af60a37wrowe via syslogd(8) if the system supports it. The default is to use
41ef8b3051855b802104193ee0a587515af60a37wrowe syslog facility <code>local7</code>, but you can override this by
fb77c505254b6e9c925e23e734463e87574f8f40kess using the <code>syslog:<var>facility</var></code> syntax where
41ef8b3051855b802104193ee0a587515af60a37wrowe <var>facility</var> can be one of the names usually documented in
41ef8b3051855b802104193ee0a587515af60a37wrowe syslog(1).</p>
41ef8b3051855b802104193ee0a587515af60a37wrowe ErrorLog syslog:user
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess href="/misc/security_tips.html#serverroot">security tips</a>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess document for details on why your security could be compromised
41ef8b3051855b802104193ee0a587515af60a37wrowe if the directory where logfiles are stored is writable by
41ef8b3051855b802104193ee0a587515af60a37wrowe anyone other than the user that starts the server.</p>
af18698b10b429b270551ca3a5d51a75e1c9db22brianp<seealso><directive module="core">LogLevel</directive></seealso>
af18698b10b429b270551ca3a5d51a75e1c9db22brianp<seealso><a href="/logs.html">Apache Log Files</a></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
003f0c9fda6664daf5092a0e42f65ede20098153slive<directivesynopsis>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<description>File attributes used to create the ETag
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveHTTP response header</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
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive attributes that are used to create the ETag (entity tag) response
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive header field when the document is based on a file. (The ETag
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive value is used in cache management to save network bandwidth.) In
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Apache 1.3.22 and earlier, the ETag value was <em>always</em> formed
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive from the file's inode, size, and last-modified time (mtime). The
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd FileETag directive allows you to choose which of these -- if any
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive -- 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>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <dd>All available fields will be used. This is equivalent to:
69fba5b8aa0b0dc408f649cfdaab064ce120b05bslive <dd>If a document is file-based, no ETag field will be included in the
69fba5b8aa0b0dc408f649cfdaab064ce120b05bslive 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>
f7fe99050600166042c04b8e595fb75499eed7f0geoff <p>If a directory's configuration includes
f7fe99050600166042c04b8e595fb75499eed7f0geoff <code>FileETag INode MTime Size</code>, and a
f7fe99050600166042c04b8e595fb75499eed7f0geoff subdirectory's includes <code>FileETag -INode</code>,
f7fe99050600166042c04b8e595fb75499eed7f0geoff the setting for that subdirectory (which will be inherited by
f7fe99050600166042c04b8e595fb75499eed7f0geoff any sub-subdirectories that don't override it) will be equivalent to
f7fe99050600166042c04b8e595fb75499eed7f0geoff</directivesynopsis>
f7fe99050600166042c04b8e595fb75499eed7f0geoff<description>Contains directives that apply to matched
f7fe99050600166042c04b8e595fb75499eed7f0geofffilenames</description>
f7fe99050600166042c04b8e595fb75499eed7f0geoff<syntax><Files <var>filename</var>> ... </Files></syntax>
f7fe99050600166042c04b8e595fb75499eed7f0geoff<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
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive provides for access control by filename. It is comparable to the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive module="core" type="directive">Directory</directive>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive type="directive">Location</directive> directives. It should be
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive matched with a <code></Files></code> directive. The
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directives given within this section will be applied to any object
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive with a basename (last component of filename) matching the
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess 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"
fb77c505254b6e9c925e23e734463e87574f8f40kess <code>.htaccess</code> files are read, but before <directive
fb77c505254b6e9c925e23e734463e87574f8f40kess type="section" module="core">Location</directive> sections. Note
4f854c24127e28f7ad72ce9a39d4448aaf910fc1slive that <directive type="section">Files</directive> can be nested
4f854c24127e28f7ad72ce9a39d4448aaf910fc1slive module="core">Directory</directive> sections to restrict the
9b5e2c5e769dc678a1aca06df75c32022b2f1492trawick portion of the filesystem they apply to.</p>
fb77c505254b6e9c925e23e734463e87574f8f40kess <p>The <var>filename</var> argument should include a filename, or
4f854c24127e28f7ad72ce9a39d4448aaf910fc1slive a wild-card string, where `?' matches any single character, and
69fba5b8aa0b0dc408f649cfdaab064ce120b05bslive `*' matches any sequences of characters. Extended regular
69fba5b8aa0b0dc408f649cfdaab064ce120b05bslive expressions can also be used, with the addition of the
69fba5b8aa0b0dc408f649cfdaab064ce120b05bslive <Files ~ "\.(gif|jpe?g|png)$">
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>would match most common Internet graphics formats. In Apache 1.3
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive type="section">FilesMatch</directive> is preferred, 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
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive .htaccess files. This allows users to control access to their own
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive files, at a file-by-file level.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Directory, 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>
c68acc9d712af079afa2bd1a5a4aeef9a3ea573ckess<description>Contains directives that apply to regular-expression matched
fb109b84906e3ee61680aa289953c2f9e859354erbowenfilenames</description>
fb109b84906e3ee61680aa289953c2f9e859354erbowen<syntax><FilesMatch <var>regex</var>> ... </FilesMatch></syntax>
fb109b84906e3ee61680aa289953c2f9e859354erbowen<contextlist><context>server config</context><context>virtual host</context>
fb109b84906e3ee61680aa289953c2f9e859354erbowen<context>directory</context><context>.htaccess</context>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <directive type="section">FilesMatch</directive> directive
fb109b84906e3ee61680aa289953c2f9e859354erbowen provides for access control by filename, just as the <directive
fb109b84906e3ee61680aa289953c2f9e859354erbowen module="core" type="section">Files</directive> directive
fb109b84906e3ee61680aa289953c2f9e859354erbowen does. However, it accepts a regular expression. For example:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <FilesMatch "\.(gif|jpe?g|png)$">
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>would match most common Internet graphics formats.</p>
fb109b84906e3ee61680aa289953c2f9e859354erbowen Directory, Location and Files sections work</a> for an
fb109b84906e3ee61680aa289953c2f9e859354erbowen explanation of how these different sections are combined when a
fb109b84906e3ee61680aa289953c2f9e859354erbowen request is received</seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Forces all matching files to be served with the specified
2bac697634d965d9d9a921a99a68b2c454c8a95dbnicholesMIME content-type</description>
2bac697634d965d9d9a921a99a68b2c454c8a95dbnicholes<syntax>ForceType <var>MIME-type</var>|none</syntax>
2bac697634d965d9d9a921a99a68b2c454c8a95dbnicholes<contextlist><context>directory</context><context>.htaccess</context>
2bac697634d965d9d9a921a99a68b2c454c8a95dbnicholes</contextlist>
2bac697634d965d9d9a921a99a68b2c454c8a95dbnicholes<compatibility>Moved to the core in Apache 2.0</compatibility>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>When placed into an <code>.htaccess</code> file or a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive type="section" module="core">Directory</directive>, or
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive type="section" module="core">Location</directive> or
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive type="section" module="core">Files</directive>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive section, this directive forces all matching files to be served
003f0c9fda6664daf5092a0e42f65ede20098153slive with the content type identification given by
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <var>MIME-type</var>. For example, if you had a directory full of
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd GIF files, but did not want to label them all with ".gif", you
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele might want to use:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Note that unlike <directive module="core">DefaultType</directive>,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive this directive overrides all mime-type associations, including
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive filename extensions, that might identify the media type.</p>
fb77c505254b6e9c925e23e734463e87574f8f40kess <p>You can override any <directive>ForceType</directive> setting
fb77c505254b6e9c925e23e734463e87574f8f40kess <Location /images><br />
530eba85dbd41b8a0fa5255d3648d1440199a661slive </Location><br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive # but normal mime-type associations here:<br />
530eba85dbd41b8a0fa5255d3648d1440199a661slive ForceType none<br />
530eba85dbd41b8a0fa5255d3648d1440199a661slive </Location>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
530eba85dbd41b8a0fa5255d3648d1440199a661slive</directivesynopsis>
fb77c505254b6e9c925e23e734463e87574f8f40kess<directivesynopsis>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<description>Enables DNS lookups on client IP addresses</description>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<contextlist><context>server config</context><context>virtual host</context>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>This directive enables DNS lookups so that host names can be
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd logged (and passed to CGIs/SSIs in <code>REMOTE_HOST</code>).
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd The value <code>double</code> refers to doing double-reverse
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive DNS. That is, after a reverse lookup is performed, a forward
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive lookup is then performed on that result. At least one of the ip
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd addresses in the forward lookup must match the original
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive address. (In "tcpwrappers" terminology this is called
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Regardless of the setting, when <module>mod_authz_host</module> is
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive used for controlling access by hostname, a double reverse lookup
003f0c9fda6664daf5092a0e42f65ede20098153slive will be performed. This is necessary for security. Note that the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive result of this double-reverse isn't generally available unless you
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd set <code>HostnameLookups double</code>. For example, if only
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <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
003f0c9fda6664daf5092a0e42f65ede20098153slive single-reverse result in <code>REMOTE_HOST</code>.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The default is off in order to save the network
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive traffic for those sites that don't truly need the reverse
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess lookups done. It is also better for the end users because they
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess don't have to suffer the extra latency that a lookup entails.
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess Heavily loaded sites should leave this directive
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess <code>off</code>, since DNS lookups can take considerable
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess amounts of time. The utility <a
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess href="/programs/logresolve.html">logresolve</a>, provided in
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the <var>/support</var> directory, can be used to look up host
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive names from logged IP addresses offline.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Enables logging of the RFC1413 identity of the remote
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveuser</description>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<contextlist><context>server config</context><context>virtual host</context>
030108b1816bcda3d925df65357feabdce83bc94slive <p>This directive enables RFC1413-compliant logging of the
030108b1816bcda3d925df65357feabdce83bc94slive remote user name for each connection, where the client machine
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive runs identd or something similar. This information is logged in
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd the access log.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>The information should not be trusted in any way except for
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd rudimentary usage tracking.</p>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <p>Note that this can cause serious latency problems accessing
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess your server since every request requires one of these lookups
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess to be performed. When firewalls are involved each lookup might
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive possibly fail and add 30 seconds of latency to each hit. So in
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive general this is not very useful on public servers accessible
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive from the Internet.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Encloses directives that will be processed only
313bb560bc5c323cfd40c9cad7335b4b8e060aedkessif a test is true at startup</description>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<syntax><IfDefine [!]<var>parameter-name</var>> ...
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess </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>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </code> section is used to mark directives that are conditional. The
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directives within an <directive type="section">IfDefine</directive>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive section are only processed if the <var>test</var> is true. If <var>
003f0c9fda6664daf5092a0e42f65ede20098153slive test</var> is false, everything between the start and end markers is
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive ignored.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <var>test</var> in the <directive type="section"
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess >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
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <var>parameter-name</var> is defined. The second format reverses
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess the test, and only processes the directives if
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <var>parameter-name</var> is <strong>not</strong> defined.</p>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <p>The <var>parameter-name</var> argument is a define as given on
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the <code>httpd</code> command line via <code>-D<var>parameter-</var>
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>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive httpd -DReverseProxy ...<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <IfDefine ReverseProxy><br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive LoadModule rewrite_module modules/mod_rewrite.so<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </IfDefine>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd</directivesynopsis>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<description>Encloses directives that are processed conditional on the
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cndpresence or absence of a specific module</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </IfModule></syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<context>directory</context><context>.htaccess</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
7654193c1faf603feec999850322ad79e6c551bcnd <p>The <code><IfModule <var>test</var>>...</IfModule></code>
7654193c1faf603feec999850322ad79e6c551bcnd section is used to mark directives that are conditional on the presence of a
7654193c1faf603feec999850322ad79e6c551bcnd specific module. The directives within an <directive type="section"
7654193c1faf603feec999850322ad79e6c551bcnd >IfModule</directive> section are only processed if the <var>test</var>
7654193c1faf603feec999850322ad79e6c551bcnd is true. If <var>test</var> is false, everything between the start and
7654193c1faf603feec999850322ad79e6c551bcnd end markers is ignored.</p>
7654193c1faf603feec999850322ad79e6c551bcnd >IfModule</directive> section directive can be one of two forms:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>In the former case, the directives between the start and end
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive markers are only processed if the module named <var>module
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive name</var> is included in Apache -- either compiled in or
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive >LoadModule</directive>. The second format reverses the test,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive and only processes the directives if <var>module name</var> is
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <var>module name</var> argument is the file name of the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module, at the time it was compiled. For example,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>mod_rewrite.c</code>. If a module consists of several
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive source files, use the name of the file containing the string
fb77c505254b6e9c925e23e734463e87574f8f40kess <p><directive type="section">IfModule</directive> sections are
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess nest-able, which can be used to implement simple multiple-module
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <note>This section should only be used if you need to have one
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive configuration file that works whether or not a specific module
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive is available. In normal operation, directives need not be
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive sections.</note>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
fb77c505254b6e9c925e23e734463e87574f8f40kess<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Includes other configuration files from within
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivethe server configuration files</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>Include <var>file-path</var>|<var>directory-path</var></syntax>
fb77c505254b6e9c925e23e734463e87574f8f40kess<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
fb77c505254b6e9c925e23e734463e87574f8f40kess <p>This directive allows inclusion of other configuration files
a1ef40892ffa2b44fc249423c5b6c42a74a84c68nd from within the server configuration files.</p>
a1ef40892ffa2b44fc249423c5b6c42a74a84c68nd <p>If <directive>Include</directive> points to a directory, rather than a
a1ef40892ffa2b44fc249423c5b6c42a74a84c68nd file, Apache will read all files in that directory and any
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive subdirectory in alphabetical order, and parse those as configuration
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The file path specified may be a fully qualified path (i.e.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive starting with a slash), or may be relative to the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive module="core">ServerRoot</directive> directory.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Or, providing paths relative to your <code>ServerRoot</code>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd directory:</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>Make sure that an included directory does not contain any stray
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd files, such as editor temporary files, for example, as Apache will
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive attempt to read them in and use the contents as configuration
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directives, which may cause the server to fail on start up.
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd Running <code>apachectl configtest</code> will give you a list of
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the files that are being processed during the configuration
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd check:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive root@host# apachectl configtest<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Processing config directory: /usr/local/apache/conf/vhosts<br />
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd Processing config file: /usr/local/apache/conf/vhosts/vhost1<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Processing config file: /usr/local/apache/conf/vhosts/vhost2<br />
a1ef40892ffa2b44fc249423c5b6c42a74a84c68nd <p>This will help in verifying that you are getting only the files
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd that you intended as part of your configuration.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><a href="/programs/apachectl.html">apachectl</a></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
130d299c4b2b15be45532a176604c71fdc7bea5bnd<directivesynopsis>
130d299c4b2b15be45532a176604c71fdc7bea5bnd<description>Enables HTTP persistent connections</description>
130d299c4b2b15be45532a176604c71fdc7bea5bnd<contextlist><context>server config</context><context>virtual host</context>
130d299c4b2b15be45532a176604c71fdc7bea5bnd</contextlist>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <p>The Keep-Alive extension to HTTP/1.0 and the persistent
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd connection feature of HTTP/1.1 provide long-lived HTTP sessions
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive which allow multiple requests to be sent over the same TCP
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive connection. In some cases this has been shown to result in an
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive almost 50% speedup in latency times for HTML documents with
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive many images. To enable Keep-Alive connections in Apache 1.2 and
a04a96aae08a62f2d9d5833b3313a9751fa3f680yoshiki <p>For HTTP/1.0 clients, Keep-Alive connections will only be
55d36f9b61520c2374ab463e77e8a62daa416398nd used if they are specifically requested by a client. In
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess 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
003f0c9fda6664daf5092a0e42f65ede20098153slive generally not use Keep-Alive connections to HTTP/1.0 clients.
55d36f9b61520c2374ab463e77e8a62daa416398nd For HTTP/1.1 clients, persistent connections are the default
55d36f9b61520c2374ab463e77e8a62daa416398nd 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>
fb77c505254b6e9c925e23e734463e87574f8f40kess<seealso><directive module="core">MaxKeepAliveRequests</directive></seealso>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd</directivesynopsis>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<directivesynopsis>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<description>Amount of time the server will wait for subsequent
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cndrequests on a persistent connection</description>
55d36f9b61520c2374ab463e77e8a62daa416398nd<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The number of seconds Apache will wait for a subsequent
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive request before closing the connection. Once a request has been
55d36f9b61520c2374ab463e77e8a62daa416398nd received, the timeout value specified by the
55d36f9b61520c2374ab463e77e8a62daa416398nd <directive module="core">Timeout</directive> directive applies.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>Setting <directive>KeepAliveTimeout</directive> to a high value
55d36f9b61520c2374ab463e77e8a62daa416398nd may cause performance problems in heavily loaded servers. The
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd higher the timeout, the more server processes will be kept
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive occupied waiting on connections with idle clients.</p>
55d36f9b61520c2374ab463e77e8a62daa416398nd</directivesynopsis>
bea526116133aa3d7dabd1924bfc580b37fbf22aslive<description>Restrict enclosed access controls to only certain HTTP
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivemethods</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax><Limit <var>method</var> [<var>method</var>] ... > ...
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </Limit></syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
bea526116133aa3d7dabd1924bfc580b37fbf22aslive<context>directory</context><context>.htaccess</context>
bea526116133aa3d7dabd1924bfc580b37fbf22aslive</contextlist>
bea526116133aa3d7dabd1924bfc580b37fbf22aslive <p>Access controls are normally effective for
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <strong>all</strong> access methods, and this is the usual
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive desired behavior. <strong>In the general case, access control
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directives should not be placed within a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive type="section">Limit</directive> section.</strong></p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The purpose of the <directive type="section">Limit</directive>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directive is to restrict the effect of the access controls to the
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd nominated HTTP methods. For all other methods, the access
003f0c9fda6664daf5092a0e42f65ede20098153slive restrictions that are enclosed in the <code><Limit></code>
003f0c9fda6664daf5092a0e42f65ede20098153slive bracket <strong>will have no effect</strong>. The following
003f0c9fda6664daf5092a0e42f65ede20098153slive example applies the access control only to the methods POST, PUT,
7b5535ed88e0f561b3bfb3330137bd804846afd4slive and DELETE, leaving all other methods unprotected:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <Limit POST PUT DELETE><br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Require valid-user<br />
fb77c505254b6e9c925e23e734463e87574f8f40kess </Limit>
7b5535ed88e0f561b3bfb3330137bd804846afd4slive <p>The method names listed can be one or more of: <code>GET</code>,
7b5535ed88e0f561b3bfb3330137bd804846afd4slive <code>POST</code>, <code>PUT</code>, <code>DELETE</code>,
a1ef40892ffa2b44fc249423c5b6c42a74a84c68nd <code>CONNECT</code>, <code>OPTIONS</code>, <code>TRACE</code>,
7b5535ed88e0f561b3bfb3330137bd804846afd4slive <code>PATCH</code>, <code>PROPFIND</code>, <code>PROPPATCH</code>,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>MKCOL</code>, <code>COPY</code>, <code>MOVE</code>,
c68acc9d712af079afa2bd1a5a4aeef9a3ea573ckess <code>LOCK</code>, and <code>UNLOCK</code>. <strong>The method name is
c68acc9d712af079afa2bd1a5a4aeef9a3ea573ckess case-sensitive.</strong> If <code>GET</code> is used it will also
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<description>Restrict access controls to all HTTP methods
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cndexcept the named ones</description>
7b5535ed88e0f561b3bfb3330137bd804846afd4slive<syntax><LimitExcept <var>method</var> [<var>method</var>] ... > ...
7b5535ed88e0f561b3bfb3330137bd804846afd4slive </LimitExcept></syntax>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<contextlist><context>server config</context><context>virtual host</context>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd</contextlist>
7b5535ed88e0f561b3bfb3330137bd804846afd4slive <p><directive type="section">LimitExcept</directive> and
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd a group of access control directives which will then apply to any
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd HTTP access method <strong>not</strong> listed in the arguments;
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd module="core">Limit</directive> section and can be used to control
7b5535ed88e0f561b3bfb3330137bd804846afd4slive both standard and nonstandard/unrecognized methods. See the
7b5535ed88e0f561b3bfb3330137bd804846afd4slive type="section">Limit</directive> for more details.</p>
a1ef40892ffa2b44fc249423c5b6c42a74a84c68nd <LimitExcept POST GET><br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Require valid-user<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <LimitExcept>
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele</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>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<context>directory</context><context>.htaccess</context>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This directive specifies the number of <var>bytes</var> from 0
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive (meaning unlimited) to 2147483647 (2GB) that are allowed in a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive request body. The default value is defined by the compile-time
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive constant <code>DEFAULT_LIMIT_REQUEST_BODY</code> (0 as
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive distributed).</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
891df99fdfa41fc8a486568f4d31ddf4a571258adreid (server, per-directory, per-file or per-location). If the client
891df99fdfa41fc8a486568f4d31ddf4a571258adreid request exceeds that limit, the server will return an error
891df99fdfa41fc8a486568f4d31ddf4a571258adreid response instead of servicing the request. The size of a normal
891df99fdfa41fc8a486568f4d31ddf4a571258adreid request message body will vary greatly depending on the nature of
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the resource and the methods allowed on that resource. CGI scripts
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive typically use the message body for passing form information to the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive server. Implementations of the PUT method will require a value at
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive least as large as any representation that the server wishes to
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive accept for that resource.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This directive gives the server administrator greater
003f0c9fda6664daf5092a0e42f65ede20098153slive control over abnormal client request behavior, which may be
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive useful for avoiding some forms of denial-of-service
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd attacks.</p>
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele <p>If, for example, you are permitting file upload to a particular
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele location, and wich to limit the size of the uploaded file to 100K,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive you might use the following directive:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive LimitRequestBody 102400
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Limits the number of HTTP request header fields that
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivewill be accepted from the client</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</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>
003f0c9fda6664daf5092a0e42f65ede20098153slive <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
130d299c4b2b15be45532a176604c71fdc7bea5bnd 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
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess control over abnormal client request behavior, which may be
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess useful for avoiding some forms of denial-of-service attacks.
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess The value should be increased if normal clients see an error
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess response from the server that indicates too many fields were
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess sent in the request.</p>
130d299c4b2b15be45532a176604c71fdc7bea5bnd LimitRequestFields 50
130d299c4b2b15be45532a176604c71fdc7bea5bnd </example>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd</directivesynopsis>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<directivesynopsis>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<description>Limits the size of the HTTP request header allowed from the
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cndclient</description>
6c5c651b0b97607b8c8b4965c1385c67699f217fnd<contextlist><context>server config</context></contextlist>
4bb78e7cdd53f50240cff4ad7a97c7ed36483797slive <p>This directive specifies the number of <var>bytes</var> from 0
4bb78e7cdd53f50240cff4ad7a97c7ed36483797slive to the value of the compile-time constant
4bb78e7cdd53f50240cff4ad7a97c7ed36483797slive distributed) that will be allowed in an HTTP request
4bb78e7cdd53f50240cff4ad7a97c7ed36483797slive header.</p>
4bb78e7cdd53f50240cff4ad7a97c7ed36483797slive <p>The <directive>LimitRequestFieldsize</directive> directive
4bb78e7cdd53f50240cff4ad7a97c7ed36483797slive allows the server administrator to reduce the limit on the allowed
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive size of an HTTP request header field below the normal input buffer
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive size compiled with the server. A server needs this value to be
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive large enough to hold any one header field from a normal client
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive request. The size of a normal request header field will vary
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive greatly among different client implementations, often depending
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive upon the extent to which a user has configured their browser to
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess support detailed content negotiation.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This directive gives the server administrator greater
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive control over abnormal client request behavior, which may be
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive useful for avoiding some forms of denial-of-service attacks.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive LimitRequestFieldSize 16380
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <note>Under normal conditions, the value should not be changed from
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen the default.</note>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen<directivesynopsis>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen<description>Limit the size of the HTTP request line that will be accepted
130d299c4b2b15be45532a176604c71fdc7bea5bndfrom the client</description>
130d299c4b2b15be45532a176604c71fdc7bea5bnd<contextlist><context>server config</context></contextlist>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen <p>This directive sets the number of <var>bytes</var> from 0 to
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen the value of the compile-time constant
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>DEFAULT_LIMIT_REQUEST_LINE</code> (8190 as distributed)
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive that will be allowed on the HTTP request-line.</p>
03e0a375c2435102fb2b51e34cccff52acbfddcdnd <p>The <directive>LimitRequestLine</directive> directive allows
03e0a375c2435102fb2b51e34cccff52acbfddcdnd the server administrator to reduce the limit on the allowed size
03e0a375c2435102fb2b51e34cccff52acbfddcdnd of a client's HTTP request-line below the normal input buffer size
03e0a375c2435102fb2b51e34cccff52acbfddcdnd compiled with the server. Since the request-line consists of the
03e0a375c2435102fb2b51e34cccff52acbfddcdnd HTTP method, URI, and protocol version, the
03e0a375c2435102fb2b51e34cccff52acbfddcdnd <directive>LimitRequestLine</directive> directive places a
03e0a375c2435102fb2b51e34cccff52acbfddcdnd restriction on the length of a request-URI allowed for a request
03e0a375c2435102fb2b51e34cccff52acbfddcdnd on the server. A server needs this value to be large enough to
a51fafd9c1463954daf49f94e76d078c1eb5c9bdnd hold any of its resource names, including any information that
03e0a375c2435102fb2b51e34cccff52acbfddcdnd might be passed in the query part of a GET request.</p>
03e0a375c2435102fb2b51e34cccff52acbfddcdnd <p>This directive gives the server administrator greater
03e0a375c2435102fb2b51e34cccff52acbfddcdnd control over abnormal client request behavior, which may be
03e0a375c2435102fb2b51e34cccff52acbfddcdnd useful for avoiding some forms of denial-of-service attacks.</p>
03e0a375c2435102fb2b51e34cccff52acbfddcdnd LimitRequestLine 16380
03e0a375c2435102fb2b51e34cccff52acbfddcdnd </example>
03e0a375c2435102fb2b51e34cccff52acbfddcdnd <note>Under normal conditions, the value should not be changed from
03e0a375c2435102fb2b51e34cccff52acbfddcdnd the default.</note>
03e0a375c2435102fb2b51e34cccff52acbfddcdnd</directivesynopsis>
03e0a375c2435102fb2b51e34cccff52acbfddcdnd<directivesynopsis>
03e0a375c2435102fb2b51e34cccff52acbfddcdnd<description>Limits the size of an XML-based request body</description>
03e0a375c2435102fb2b51e34cccff52acbfddcdnd<contextlist><context>server config</context><context>virtual host</context>
03e0a375c2435102fb2b51e34cccff52acbfddcdnd<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>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive LimitXMLRequestBody 0
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Applies the enclosed directives only to matching
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveURLs</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax><Location
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive URL-path|URL> ... </Location></syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <directive type="section">Location</directive> directive
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess provides for access control by URL. It is similar to the
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <directive type="section" module="core">Directory</directive>
fb77c505254b6e9c925e23e734463e87574f8f40kess 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>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen <p>Note that URLs do not have to line up with the filesystem at
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess all, it should be emphasized that <Location> operates
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen completely outside the filesystem.</p>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen <p>For all origin (non-proxy) requests, the URL to be matched is a
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd URL-path of the form <code>/path/</code>. No scheme, hostname,
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen port, or query string may be included. For proxy requests, the
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen URL to be matched is of the form
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>scheme://servername/path</code>, and you must include the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive prefix.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The URL may use wildcards In a wild-card string, `?' matches
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive any single character, and `*' matches any sequences of
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess characters.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>Extended regular
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive expressions can also be used, with the addition of the
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <Location ~ "/(extra|special)/data">
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>would match URLs that contained the substring "/extra/data" or
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive "/special/data". In Apache 1.3 and above, a new directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive type="section" module="core">LocationMatch</directive>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive exists which behaves identical to the regex version of
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive functionality is especially useful when combined with the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directive. For example, to enable status requests, but allow them
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <Location /status><br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive SetHandler server-status<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Order Deny,Allow<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Deny from all<br />
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen </Location>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen <p>The slash character has special meaning depending on where in a
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen URL it appears. People may be used to its behavior in the filesystem
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive where multiple adjacent slashes are frequently collapsed to a single
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive slash (<em>i.e.</em>, <code>/home///foo</code> is the same as
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>/home/foo</code>). In URL-space this is not necessarily true.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive The <directive type="section" module="core">LocationMatch</directive>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directive and the regex version of <directive type="section"
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive >Location</directive> require you to explicitly specify multiple
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive slashes if that is your intention.</p>
ae134ecc8faf4e6a8eb68e1c3724506771442a46rbowen <p>For example, <code><LocationMatch ^/abc></code> would match
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the request URL <code>/abc</code> but not the request URL <code>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive //abc</code>. The (non-regex) <directive type="section"
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive >Location</directive> directive behaves similarly when used for
72580dbc2a55511f13f377063725b9f143b20826stoddard proxy requests. But when (non-regex) <directive type="section"
72580dbc2a55511f13f377063725b9f143b20826stoddard >Location</directive> is used for non-proxy requests it will
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive implicitly match multiple slashes with a single slash. For example,
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess if you specify <code><Location /abc/def></code> and the
72580dbc2a55511f13f377063725b9f143b20826stoddard request is to <code>/abc//def</code> then it will match.</p>
72580dbc2a55511f13f377063725b9f143b20826stoddard Directory, Location and Files sections work</a> for an
72580dbc2a55511f13f377063725b9f143b20826stoddard explanation of how these different sections are combined when a
56d7eed7205462540aec7202cd82d9f5516fc537kess request is received</seealso>
72580dbc2a55511f13f377063725b9f143b20826stoddard</directivesynopsis>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen<description>Applies the enclosed directives only to regular-expression
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowenmatching URLs</description>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen<syntax><LocationMatch
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen<contextlist><context>server config</context><context>virtual host</context>
ef8e89e090461194ecadd31e8796a2c51e0531a2kess</contextlist>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen <p>The <directive type="section">LocationMatch</directive> directive
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen provides for access control by URL, in an identical manner to
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen <directive module="core" type="section">Location</directive>. However,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive it takes a regular expression as an argument instead of a simple
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive string. For example:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <LocationMatch "/(extra|special)/data">
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>would match URLs that contained the substring <code>/extra/data</code>
72580dbc2a55511f13f377063725b9f143b20826stoddard Directory, Location and Files sections work</a> for an
72580dbc2a55511f13f377063725b9f143b20826stoddard explanation of how these different sections are combined when a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive request is received</seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
72580dbc2a55511f13f377063725b9f143b20826stoddard<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Controls the verbosity of the ErrorLog</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
fb77c505254b6e9c925e23e734463e87574f8f40kess</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p><directive>LogLevel</directive> adjusts the verbosity of the
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen messages recorded in the error logs (see <directive
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen module="core">ErrorLog</directive> directive). The following
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen <var>level</var>s are available, in order of decreasing
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen significance:</p>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen <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>
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive <td>"httpd: caught SIGBUS, attempting to dump core in
234c8b28171d7e12b3c1f85b60fabd7c908a9c37slive <td>"Server seems busy, (you may need to increase
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <p>When a particular level is specified, messages from all
fb77c505254b6e9c925e23e734463e87574f8f40kess 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
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd recommended.</p>
fb77c505254b6e9c925e23e734463e87574f8f40kess LogLevel notice
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess </example>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Number of requests allowed on a persistent
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveconnection</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>MaxKeepAliveRequests <var>number</var></syntax>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<contextlist><context>server config</context><context>virtual host</context>
130d299c4b2b15be45532a176604c71fdc7bea5bnd</contextlist>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <p>The <directive>MaxKeepAliveRequests</directive> directive
130d299c4b2b15be45532a176604c71fdc7bea5bnd limits the number of requests allowed per connection when
130d299c4b2b15be45532a176604c71fdc7bea5bnd <directive module="core" >KeepAlive</directive> is on. If it is
130d299c4b2b15be45532a176604c71fdc7bea5bnd set to "<code>0</code>", unlimited requests will be allowed. We
130d299c4b2b15be45532a176604c71fdc7bea5bnd recommend that this setting be kept to a high value for maximum
130d299c4b2b15be45532a176604c71fdc7bea5bnd server performance.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd MaxKeepAliveRequests 500
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd</directivesynopsis>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<directivesynopsis>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<description>Designates an IP address for name-virtual
313bb560bc5c323cfd40c9cad7335b4b8e060aedkesshosting</description>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<syntax>NameVirtualHost <var>addr</var>[:<var>port</var>]</syntax>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<contextlist><context>server config</context></contextlist>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>The <directive>NameVirtualHost</directive> directive is a
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd required directive if you want to configure <a
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>Although <var>addr</var> can be hostname it is recommended
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess NameVirtualHost 111.22.33.44
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess </example>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>With the <directive>NameVirtualHost</directive> directive you
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive specify the IP address on which the server will receive requests
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive for the name-based virtual hosts. This will usually be the address
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess to which your name-based virtual host names resolve. In cases
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive where a firewall or other proxy receives the requests and forwards
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive them on a different IP address to the server, you must specify the
8490b2f9f6469d5089163f6dd303d9a81f8e908ctrawick IP address of the physical interface on the machine which will be
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive servicing the requests. If you have multiple name-based hosts on
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive multiple addresses, repeat the directive for each address.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Note: the "main server" and any _default_ servers will
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess <directive>NameVirtualHost</directive> IP Address (unless for some
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess reason you specify <directive>NameVirtualHost</directive> but then
030108b1816bcda3d925df65357feabdce83bc94slive don't define any VirtualHosts for that address).</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Optionally you can specify a port number on which the
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd NameVirtualHost 111.22.33.44:8080
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>IPv6 addresses must be enclosed in square brackets, as shown
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive in the following example:</p>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess NameVirtualHost [fe80::a00:20ff:fea7:ccea]:8080
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>To receive requests on all interfaces, you can use an argument of
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive NameVirtualHost *
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <note><title>Argument to <VirtualHost> directive</title>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Note that the argument to the <VirtualHost> directive must
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive exactly match the argument to the <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive NameVirtualHost 1.2.3.4<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <VirtualHost 1.2.3.4><br />
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen # ...<br />
1597043cec6ad37fa4154bf09b0fccdabed1a239slive </VirtualHost><br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Configures what features are available in a particular
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivedirectory</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>Options
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive [+|-]<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>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <directive>Options</directive> directive controls which
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive server features are available in a particular directory.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <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>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <dd>All options except for MultiViews. This is the default
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive setting.</dd>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Execution of CGI scripts is permitted.</dd>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive The server will follow symbolic links in this directory.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Even though the server follows the symlink it does <em>not</em>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive change the pathname used to match against <directive type="section"
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Note also, that this option <strong>gets ignored</strong> if set
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive inside a <directive type="section" module="core">Location</directive>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive section.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Server-side includes are permitted.</dd>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Server-side includes are permitted, but the #exec command and
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive #exec CGI are disabled. It is still possible to #include
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive virtual CGI scripts from ScriptAliase'd directories.</dd>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive If a URL which maps to a directory is requested, and the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive there is no DirectoryIndex (<em>e.g.</em>, index.html) in
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive that directory, then the server will return a formatted
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive listing of the directory.</dd>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <a href="/content-negotiation.html">Content negotiated</a>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive MultiViews are allowed.</dd>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen The server will only follow symbolic links for which the target
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen file or directory is owned by the same user id as the link.<br
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen /> <strong>Note</strong>: this option gets ignored if set inside
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd a <directive module="core" type="section">Location</directive>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd section.</dd>
8b052d682204371decc64f942aede5ef1da98955erikabele <p>Normally, if multiple <directive>Options</directive> could apply to a
8b052d682204371decc64f942aede5ef1da98955erikabele directory, then the most specific one is taken complete; the
8b052d682204371decc64f942aede5ef1da98955erikabele options are not merged. However if <em>all</em> the options on
8b052d682204371decc64f942aede5ef1da98955erikabele the <directive>Options</directive> directive are preceded by a + or -
8b052d682204371decc64f942aede5ef1da98955erikabele symbol, the options are merged. Any options preceded by a + are
8b052d682204371decc64f942aede5ef1da98955erikabele added to the options currently in force, and any options
8b052d682204371decc64f942aede5ef1da98955erikabele preceded by a - are removed from the options currently in
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive force. </p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd Options Indexes FollowSymLinks<br />
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele </Directory><br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Options Includes<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </Directory>
fb77c505254b6e9c925e23e734463e87574f8f40kess </example>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>then only <code>Includes</code> will be set for the
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen <directive>Options</directive> directive uses the + and - symbols:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Options Indexes FollowSymLinks<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </Directory><br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Options +Includes -Indexes<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </Directory>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>Includes</code> are set for the /web/docs/spec directory.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p><strong>Note:</strong> Using <code>-IncludesNOEXEC</code> or
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <code>-Includes</code> disables server-side includes completely
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive regardless of the previous setting.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>The default in the absence of any other settings is
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Selects which authenticated users can access
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivea resource</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>Require <var>entity-name</var> [<var>entity-name</var>] ...</syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>directory</context><context>.htaccess</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <p>This directive selects which authenticated users can access
9b5e2c5e769dc678a1aca06df75c32022b2f1492trawick a directory. The allowed syntaxes are:</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd Require group <var>group-name</var> [<var>group-name</var>] ...
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>Only users in the named groups can access the
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd directory.</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd Require valid-user
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <directive module="core">AuthName</directive> and <directive
52bb691f8e13e9d0b55fcc214018ee85846fa87frbowen module="core">AuthType</directive> directives, and directives such
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess as <directive module="mod_authn_file">AuthUserFile</directive>
fb77c505254b6e9c925e23e734463e87574f8f40kess and <directive module="mod_authz_groupfile">AuthGroupFile</directive> (to
fb77c505254b6e9c925e23e734463e87574f8f40kess define users and groups) in order to work correctly. Example:</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd AuthType Basic<br />
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd AuthName "Restricted Directory"<br />
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd Require group admin
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>Access controls which are applied in this way are effective for
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <strong>all</strong> methods. <strong>This is what is normally
3386d67e54f92fdf6a3ffc5f7f8081eed6c44badslive desired.</strong> If you wish to apply access controls only to
3386d67e54f92fdf6a3ffc5f7f8081eed6c44badslive specific methods, while leaving other methods unprotected, then
05201775eaa6b363b8a119c8aea5db246b967591yoshiki place the <directive>Require</directive> statement into a
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen <directive module="core" type="section">Limit</directive>
d3f27ec18dfa6283e852aa98253212edafaa0e2brbowen section.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive module="core">Satisfy</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<description>Limits the CPU consumption of processes launched
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveby Apache children</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>RLimitCPU <var>number</var>|max [<var>number</var>|max]</syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<default>Unset; uses operating system defaults</default>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<context>directory</context><context>.htaccess</context></contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Takes 1 or 2 parameters. The first parameter sets the soft
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive resource limit for all processes and the second parameter sets
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd the maximum resource limit. Either parameter can be a number,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive 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
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the server is running as root, or in the initial startup
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess phase.</p>
fb77c505254b6e9c925e23e734463e87574f8f40kess <p>This applies to processes forked off from Apache children
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive servicing requests, not the Apache children themselves. This
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive includes CGI scripts and SSI exec commands, but not any
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess processes forked off from the Apache parent such as piped
13e5182a0c199ecc7a73db97b6448a544e940868slive <p>CPU resource limits are expressed in seconds per
13e5182a0c199ecc7a73db97b6448a544e940868slive process.</p>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<seealso><directive module="core">RLimitMEM</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive module="core">RLimitNPROC</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<directivesynopsis>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<description>Limits the memory consumption of processes launched
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cndby Apache children</description>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<syntax>RLimitMEM <var>number</var>|max [<var>number</var>|max]</syntax>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<contextlist><context>server config</context><context>virtual host</context>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<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
13e5182a0c199ecc7a73db97b6448a544e940868slive the maximum resource limit. Either parameter can be a number,
13e5182a0c199ecc7a73db97b6448a544e940868slive or <code>max</code> to indicate to the server that the limit should
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive be set to the maximum allowed by the operating system
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess configuration. Raising the maximum resource limit requires that
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the server is running as root, or in the initial startup
13e5182a0c199ecc7a73db97b6448a544e940868slive <p>This applies to processes forked off from Apache children
13e5182a0c199ecc7a73db97b6448a544e940868slive servicing requests, not the Apache children themselves. This
13e5182a0c199ecc7a73db97b6448a544e940868slive includes CGI scripts and SSI exec commands, but not any
b00583f8e126bbb00b06dcf06af06c9d07978701kess processes forked off from the Apache parent such as piped
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <p>Memory resource limits are expressed in bytes per
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive process.</p>
0d5b778ac63bc803c0dd1a4fdef371fe7a0f4b57kess<seealso><directive module="core">RLimitCPU</directive></seealso>
13e5182a0c199ecc7a73db97b6448a544e940868slive<seealso><directive module="core">RLimitNPROC</directive></seealso>
13e5182a0c199ecc7a73db97b6448a544e940868slive</directivesynopsis>
13e5182a0c199ecc7a73db97b6448a544e940868slive<directivesynopsis>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<description>Limits the number of processes that can be launched by
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveprocesses launched by Apache children</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>RLimitNPROC <var>number</var>|max [<var>number</var>|max]</syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<default>Unset; uses operating system defaults</default>
13e5182a0c199ecc7a73db97b6448a544e940868slive<contextlist><context>server config</context><context>virtual host</context>
13e5182a0c199ecc7a73db97b6448a544e940868slive<context>directory</context><context>.htaccess</context></contextlist>
13e5182a0c199ecc7a73db97b6448a544e940868slive <p>Takes 1 or 2 parameters. The first parameter sets the soft
13e5182a0c199ecc7a73db97b6448a544e940868slive resource limit for all processes and the second parameter sets
13e5182a0c199ecc7a73db97b6448a544e940868slive the maximum resource limit. Either parameter can be a number,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive or <code>max</code> to indicate to the server that the limit
13e5182a0c199ecc7a73db97b6448a544e940868slive should be set to the maximum allowed by the operating system
13e5182a0c199ecc7a73db97b6448a544e940868slive configuration. Raising the maximum resource limit requires that
13e5182a0c199ecc7a73db97b6448a544e940868slive the server is running as root, or in the initial startup
13e5182a0c199ecc7a73db97b6448a544e940868slive <p>This applies to processes forked off from Apache children
13e5182a0c199ecc7a73db97b6448a544e940868slive servicing requests, not the Apache children themselves. This
13e5182a0c199ecc7a73db97b6448a544e940868slive includes CGI scripts and SSI exec commands, but not any
13e5182a0c199ecc7a73db97b6448a544e940868slive processes forked off from the Apache parent such as piped
13e5182a0c199ecc7a73db97b6448a544e940868slive <p>Process limits control the number of processes per user.</p>
13e5182a0c199ecc7a73db97b6448a544e940868slive <p>Note: If CGI processes are <strong>not</strong> running
13e5182a0c199ecc7a73db97b6448a544e940868slive under userids other than the web server userid, this directive
13e5182a0c199ecc7a73db97b6448a544e940868slive will limit the number of processes that the server itself can
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive create. Evidence of this situation will be indicated by
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <strong><code>cannot fork</code></strong> messages in the
3b9c7ec844aa240622a33735d1b9cbac4232e268rbowen error_log.</p>
3b9c7ec844aa240622a33735d1b9cbac4232e268rbowen<seealso><directive module="core">RLimitMEM</directive></seealso>
3b9c7ec844aa240622a33735d1b9cbac4232e268rbowen<seealso><directive module="core">RLimitCPU</directive></seealso>
3b9c7ec844aa240622a33735d1b9cbac4232e268rbowen</directivesynopsis>
fb77c505254b6e9c925e23e734463e87574f8f40kess<directivesynopsis>
130d299c4b2b15be45532a176604c71fdc7bea5bnd<description>Interaction between host-level access control and
130d299c4b2b15be45532a176604c71fdc7bea5bnduser authentication</description>
130d299c4b2b15be45532a176604c71fdc7bea5bnd<contextlist><context>directory</context><context>.htaccess</context>
130d299c4b2b15be45532a176604c71fdc7bea5bnd</contextlist>
130d299c4b2b15be45532a176604c71fdc7bea5bnd module="core">Require</directive> used. The parameter can be
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd either <var>all</var> or <var>any</var>. This directive is only
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive useful if access to a particular area is being restricted by both
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive username/password <em>and</em> client host address. In this case
fb77c505254b6e9c925e23e734463e87574f8f40kess the default behavior (<var>all</var>) is to require that the client passes
fb77c505254b6e9c925e23e734463e87574f8f40kess the address access restriction <em>and</em> enters a valid
fb77c505254b6e9c925e23e734463e87574f8f40kess username and password. With the "any" option the client will be
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive granted access if they either pass the host restriction or enter a
130d299c4b2b15be45532a176604c71fdc7bea5bnd valid username and password. This can be used to password restrict
130d299c4b2b15be45532a176604c71fdc7bea5bnd an area, but to let clients from particular addresses in without
130d299c4b2b15be45532a176604c71fdc7bea5bnd prompting for a password.</p>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <p>For example, if you wanted to let people on your network have
130d299c4b2b15be45532a176604c71fdc7bea5bnd unrestricted access to a portion of your website, but require that
130d299c4b2b15be45532a176604c71fdc7bea5bnd people outside of your network provide a password, you could use a
130d299c4b2b15be45532a176604c71fdc7bea5bnd configuration similar to the following:</p>
130d299c4b2b15be45532a176604c71fdc7bea5bnd Require valid-user<br />
130d299c4b2b15be45532a176604c71fdc7bea5bnd Allow from 192.168.1<br />
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd Satisfy any
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd </example>
fb77c505254b6e9c925e23e734463e87574f8f40kess <seealso><directive module="mod_authz_host">Allow</directive></seealso>
fb77c505254b6e9c925e23e734463e87574f8f40kess <seealso><directive module="core">Require</directive></seealso>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess</directivesynopsis>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<directivesynopsis>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<description>Technique for locating the interpreter for CGI
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivescripts</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>ScriptInterpreterSource registry|script</syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<context>directory</context><context>.htaccess</context></contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This directive is used to control how Apache finds the
ef8e89e090461194ecadd31e8796a2c51e0531a2kess interpreter used to run CGI scripts. The default technique is to
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive use the interpreter pointed to by the #! line in the
530eba85dbd41b8a0fa5255d3648d1440199a661slive script. Setting <code>ScriptInterpreterSource registry</code> will
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele cause the Windows Registry to be searched using the script file
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<description>Email address that the server includes in error
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivemessages sent to the client</description>
ef8e89e090461194ecadd31e8796a2c51e0531a2kess<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <directive>ServerAdmin</directive> sets the e-mail address
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive that the server includes in any error messages it returns to the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive client.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>It may be worth setting up a dedicated address for this, e.g.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive ServerAdmin www-admin@foo.example.com
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>as users do not always mention that they are talking about the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive server!</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
ef8e89e090461194ecadd31e8796a2c51e0531a2kess<description>Alternate names for a host used when matching requests
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveto name-virtual hosts</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>ServerAlias <var>hostname</var> [<var>hostname</var>] ...</syntax>
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele<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
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive href="/vhosts/name-based.html">name-based virtual hosts</a>.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <VirtualHost *><br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive # ...<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </VirtualHost>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><a href="/vhosts/">Apache Virtual Host documentation</a></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Hostname and port that the server uses to identify
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveitself</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>ServerName <var>fully-qualified-domain-name</var>[:<var>port</var>]</syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<compatibility>In version 2.0, this
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directive supersedes the functionality of the <directive>Port</directive>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directive from version 1.3.</compatibility>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>The <directive>ServerName</directive> directive sets the hostname and
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive port that the server uses to identify itself. This is used when
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive creating redirection URLs. For example, if the name of the
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele machine hosting the webserver is <code>simple.example.com</code>,
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele but the machine also has the DNS alias <code>www.example.com</code>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive and you wish the webserver to be so identified, the following
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directive should be used:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive ServerName www.example.com:80
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>If no <directive>ServerName</directive> is specified, then the
ef8e89e090461194ecadd31e8796a2c51e0531a2kess server attempts to deduce the hostname by performing a reverse
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive lookup on the IP address. If no port is specified in the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive servername, then the server will use the port from the incoming
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive request. For optimal reliability and predictability, you should
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive specify an explicit hostname and port using the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive href="/vhosts/name-based.html">name-based virtual hosts</a>,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive type="section" module="core">VirtualHost</directive>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess section specifies what hostname must appear in the request's
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <code>Host:</code> header to match this virtual host.</p>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <p>See the description of the
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <directive module="core">UseCanonicalName</directive> directive for
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess settings which determine whether self-referential URL's (e.g., by the
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess specified port, or to the port number given in the client's request.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><a href="/dns-caveats.html">DNS Issues</a></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive module="core">UseCanonicalName</directive></seealso>
fb77c505254b6e9c925e23e734463e87574f8f40kess<seealso><directive module="core">NameVirtualHost</directive></seealso>
003f0c9fda6664daf5092a0e42f65ede20098153slive<seealso><directive module="core">ServerAlias</directive></seealso>
fb77c505254b6e9c925e23e734463e87574f8f40kess</directivesynopsis>
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele<directivesynopsis>
003f0c9fda6664daf5092a0e42f65ede20098153slive<description>Legacy URL pathname for a name-virtual host that
18831446030f4eda7e0563c92a896ccfdb6eb1d7sliveis accessed by an incompatible browser</description>
ef8e89e090461194ecadd31e8796a2c51e0531a2kess<contextlist><context>virtual host</context></contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The <directive>ServerPath</directive> directive sets the legacy
4cafc94e99922f00654e1779d30c2cccf5278c4fkess URL pathname for a host, for use with <a
4cafc94e99922f00654e1779d30c2cccf5278c4fkess<seealso><a href="/vhosts/">Apache Virtual Host documentation</a></seealso>
4cafc94e99922f00654e1779d30c2cccf5278c4fkess</directivesynopsis>
4cafc94e99922f00654e1779d30c2cccf5278c4fkess<directivesynopsis>
4cafc94e99922f00654e1779d30c2cccf5278c4fkess<description>Base directory for the server installation</description>
27303c8bb552a8a5fc859feb735d686fc59f59a1yoshiki<syntax>ServerRoot <var>directory-path</var></syntax>
4cafc94e99922f00654e1779d30c2cccf5278c4fkess<contextlist><context>server config</context></contextlist>
fb77c505254b6e9c925e23e734463e87574f8f40kess <p>The <directive>ServerRoot</directive> directive sets the
fb77c505254b6e9c925e23e734463e87574f8f40kess directory in which the server lives. Typically it will contain the
4cafc94e99922f00654e1779d30c2cccf5278c4fkess subdirectories <code>conf/</code> and <code>logs/</code>. Relative
4cafc94e99922f00654e1779d30c2cccf5278c4fkess paths for other configuration files are taken as relative to this
4cafc94e99922f00654e1779d30c2cccf5278c4fkess directory.</p>
6452eaa76913f6ba732f88cfce6d4f8bf142482bkess </example>
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive<seealso><a href="/misc/security_tips.html#serverroot">the
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive security tips</a> for information on how to properly set
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive permissions on the ServerRoot</seealso>
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive</directivesynopsis>
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive<directivesynopsis>
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive<description>Configures the footer on server-generated documents</description>
4cafc94e99922f00654e1779d30c2cccf5278c4fkess<contextlist><context>server config</context><context>virtual host</context>
fb77c505254b6e9c925e23e734463e87574f8f40kess<context>directory</context><context>.htaccess</context>
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive</contextlist>
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive <p>The <directive>ServerSignature</directive> directive allows the
96a8ac87abbb04c2a925f7fde5eb12bf1d1f4bc3slive configuration of a trailing footer line under server-generated
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive documents (error messages, mod_proxy ftp directory listings,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive mod_info output, ...). The reason why you would want to enable
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive such a footer line is that in a chain of proxies, the user often
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive has no possibility to tell which of the chained servers actually
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive produced a returned error message.<br /> The <code>Off</code>
003f0c9fda6664daf5092a0e42f65ede20098153slive setting, which is the default, suppresses the error line (and is
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive therefore compatible with the behavior of Apache-1.2 and
2e5e2673cb64d3e4d445d911c6f61ac171020725nd below). The <code>On</code> setting simply adds a line with the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive server version number and <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="core">ServerName</directive> of the serving virtual host,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive and the <code>EMail</code> setting additionally creates a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive "mailto:" reference to the <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive document.</p>
733738e83a9b0113476e3f67992c2278d61ee4dakess<seealso><directive module="core">ServerTokens</directive></seealso>
2e5e2673cb64d3e4d445d911c6f61ac171020725nd</directivesynopsis>
2e5e2673cb64d3e4d445d911c6f61ac171020725nd<directivesynopsis>
2e5e2673cb64d3e4d445d911c6f61ac171020725nd<description>Configures the Server HTTP response header</description>
2e5e2673cb64d3e4d445d911c6f61ac171020725nd<syntax>ServerTokens Major|Minor|Minimal|ProductOnly|OS|Full</syntax>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<contextlist><context>server config</context></contextlist>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>This directive controls whether <code>Server</code> response
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd 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>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <dd>Server sends (<em>e.g.</em>): <code>Server: Apache/2.0.41
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <dt><code>ServerTokens Full</code> (or not specified)</dt>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <dd>Server sends (<em>e.g.</em>): <code>Server: Apache/2.0.41
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>This setting applies to the entire server, and cannot be
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive enabled or disabled on a virtualhost-by-virtualhost basis.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive module="core">ServerSignature</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
e08ad1a326852610a7930269638a43657fc50d06sctemme<directivesynopsis>
fb77c505254b6e9c925e23e734463e87574f8f40kess<description>Forces all matching files to be processed by a
9b5e2c5e769dc678a1aca06df75c32022b2f1492trawickhandler</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>SetHandler <var>handler-name</var>|none</syntax>
9b5e2c5e769dc678a1aca06df75c32022b2f1492trawick<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<context>directory</context><context>.htaccess</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd<compatibility>Moved into the core in Apache 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>
e08ad1a326852610a7930269638a43657fc50d06sctemme section, this directive forces all matching files to be parsed
e08ad1a326852610a7930269638a43657fc50d06sctemme through the <a href="/handler.html">handler</a> given by
e08ad1a326852610a7930269638a43657fc50d06sctemme <var>handler-name</var>. For example, if you had a directory you
e08ad1a326852610a7930269638a43657fc50d06sctemme wanted to be parsed entirely as imagemap rule files, regardless
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive of extension, you might put the following into an
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive SetHandler imap-file
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Another example: if you wanted to have the server display a
e08ad1a326852610a7930269638a43657fc50d06sctemme status report whenever a URL of
e08ad1a326852610a7930269638a43657fc50d06sctemme <code>http://servername/status</code> was called, you might put
e08ad1a326852610a7930269638a43657fc50d06sctemme <Location /status><br />
e08ad1a326852610a7930269638a43657fc50d06sctemme SetHandler server-status<br />
e08ad1a326852610a7930269638a43657fc50d06sctemme </Location>
e08ad1a326852610a7930269638a43657fc50d06sctemme<seealso><directive module="mod_mime">AddHandler</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
e08ad1a326852610a7930269638a43657fc50d06sctemme<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Sets the filters that will process client requests and POST
ef8e89e090461194ecadd31e8796a2c51e0531a2kessinput</description>
ef8e89e090461194ecadd31e8796a2c51e0531a2kess<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
fb77c505254b6e9c925e23e734463e87574f8f40kess <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>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>SetOutputFilter <var>filter</var>[;<var>filter</var>...]</syntax>
003f0c9fda6664daf5092a0e42f65ede20098153slive<contextlist><context>server config</context><context>virtual host</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
7228d3b2eebddc214348190bcc62d80b5e7087e2rbowen elsewhere, including the
7228d3b2eebddc214348190bcc62d80b5e7087e2rbowen <directive module="mod_mime">AddOutputFilter</directive>
fcc04773f0f2cc73650485facef9cd77f2d5bd65nd directive.</p>
58e56a1d61ae176cc5ecb7c4863881736947d8b8rbowen <p>For example, the following configuration will process all files
58e56a1d61ae176cc5ecb7c4863881736947d8b8rbowen in the <code>/www/data/</code> directory for server-side
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd includes.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive SetOutputFilter INCLUDES<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </Directory>
ef8e89e090461194ecadd31e8796a2c51e0531a2kess </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>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context></contextlist>
fb77c505254b6e9c925e23e734463e87574f8f40kess <p>The <directive>TimeOut</directive> directive currently defines
fb77c505254b6e9c925e23e734463e87574f8f40kess the amount of time Apache will wait for three things:</p>
ef8e89e090461194ecadd31e8796a2c51e0531a2kess <li>The total amount of time it takes to receive a GET
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess request.</li>
530eba85dbd41b8a0fa5255d3648d1440199a661slive <li>The amount of time between receipt of TCP packets on a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive POST or PUT request.</li>
530eba85dbd41b8a0fa5255d3648d1440199a661slive <li>The amount of time between ACKs on transmissions of TCP
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive packets in responses.</li>
23b36269d124e7a6aaa5221891f7ae2ef3eeb158jerenkrantz <p>We plan on making these separately configurable at some point
23b36269d124e7a6aaa5221891f7ae2ef3eeb158jerenkrantz down the road. The timer used to default to 1200 before 1.2,
7b5535ed88e0f561b3bfb3330137bd804846afd4slive but has been lowered to 300 which is still far more than
7b5535ed88e0f561b3bfb3330137bd804846afd4slive necessary in most situations. It is not set any lower by
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive default because there may still be odd places in the code where
f35c904c3b359610a46e94fbb4ba8495b2338521slive the timer is not reset when a packet is sent. </p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<directivesynopsis>
ef8e89e090461194ecadd31e8796a2c51e0531a2kess<description>Configures how the server determines its own name and
fb77c505254b6e9c925e23e734463e87574f8f40kessport</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context><context>virtual host</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>In many situations Apache must construct a <em>self-referential</em>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive URL -- that is, a URL that refers back to the same server. With
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>UseCanonicalName on</code> Apache will use the hostname and port
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive specified in the <directive module="core">ServerName</directive>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directive to construct the canonical name for the server. This name
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive is used in all self-referential URLs, and for the values of
530eba85dbd41b8a0fa5255d3648d1440199a661slive <code>SERVER_NAME</code> and <code>SERVER_PORT</code> in CGIs.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>With <code>UseCanonicalName off</code> Apache will form
cf1595220a90759be0a39ab8b11c8cb834b698a9ianh self-referential URLs using the hostname and port supplied by
cf1595220a90759be0a39ab8b11c8cb834b698a9ianh the client if any are supplied (otherwise it will use the
cf1595220a90759be0a39ab8b11c8cb834b698a9ianh canonical name, as defined above). These values are the same
cf1595220a90759be0a39ab8b11c8cb834b698a9ianh that are used to implement <a
cf1595220a90759be0a39ab8b11c8cb834b698a9ianh href="/vhosts/name-based.html">name based virtual hosts</a>,
cf1595220a90759be0a39ab8b11c8cb834b698a9ianh and are available with the same clients. The CGI variables
1a1cf0ee9229ee29e5750b25dd94dbb9b04072cfianh <code>SERVER_NAME</code> and <code>SERVER_PORT</code> will be
1a1cf0ee9229ee29e5750b25dd94dbb9b04072cfianh constructed from the client supplied values as well.</p>
1a1cf0ee9229ee29e5750b25dd94dbb9b04072cfianh <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
530eba85dbd41b8a0fa5255d3648d1440199a661slive type a shortname, and a URL which is a directory, such as
1a1cf0ee9229ee29e5750b25dd94dbb9b04072cfianh <code>http://www/splat</code>, <em>without the trailing
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive slash</em> then Apache will redirect them to
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>http://www.domain.com/splat/</code>. If you have
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive authentication enabled, this will cause the user to have to
1a1cf0ee9229ee29e5750b25dd94dbb9b04072cfianh authenticate twice (once for <code>www</code> and once again
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive href="http://httpd.apache.org/docs/misc/FAQ.html#prompted-twice">the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive FAQ on this subject for more information</a>). But if
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <directive>UseCanonicalName</directive> is set off, then Apache will
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
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code>Host:</code> header. With this option Apache does a
23b36269d124e7a6aaa5221891f7ae2ef3eeb158jerenkrantz reverse DNS lookup on the server IP address that the client
23b36269d124e7a6aaa5221891f7ae2ef3eeb158jerenkrantz connected to in order to work out self-referential URLs.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>If CGIs make assumptions about the values of <code>SERVER_NAME</code>
f35c904c3b359610a46e94fbb4ba8495b2338521slive they may be broken by this option. The client is essentially free
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive to give whatever value they want as a hostname. But if the CGI is
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive only using <code>SERVER_NAME</code> to construct self-referential URLs
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive then it should be just fine.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><directive module="core">ServerName</directive></seealso>
fb77c505254b6e9c925e23e734463e87574f8f40kess<seealso><directive module="mpm_common">Listen</directive></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Contains directives that apply only to a specific
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivehostname or IP address</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax><VirtualHost
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <var>addr</var>[:<var>port</var>] [<var>addr</var>[:<var>port</var>]]
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess ...> ... </VirtualHost></syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<contextlist><context>server config</context></contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <code></VirtualHost></code> are used to enclose a group of
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directives that will apply only to a particular virtual host. Any
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directive that is allowed in a virtual host context may be
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd used. When the server receives a request for a document on a
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd particular virtual host, it uses the configuration directives
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd enclosed in the <directive type="section">VirtualHost</directive>
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess <li>A fully qualified domain name for the IP address of the
db1b819ff8966e3c6a5ca03c59a8ae06c2cecc9frbowen virtual host;</li>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <li>The character *, which is used only in combination with
130d299c4b2b15be45532a176604c71fdc7bea5bnd <code>NameVirtualHost *</code> to match all IP addresses; or</li>
130d299c4b2b15be45532a176604c71fdc7bea5bnd <li>The string <code>_default_</code>, which is used only
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd with IP virtual hosting to catch unmatched IP addresses.</li>
c97e8972ab1f4dd167e3dc4db87daf91114009fbnd <VirtualHost 10.1.2.3><br />
9f1dd1339447bf4b291682cd94bf9f28bc2685e0niq ServerAdmin webmaster@host.foo.com<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </VirtualHost>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>IPv6 addresses must be specified in square brackets because
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the optional port number could not be determined otherwise. An
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd IPv6 example is shown below:</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <VirtualHost [fe80::a00:20ff:fea7:ccea]><br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive ServerAdmin webmaster@host.example.com<br />
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive </VirtualHost>
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
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive accomplished with the <code>ifconfig alias</code> command (if
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive your OS supports it).</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>The use of <directive type="section">VirtualHost</directive> does
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <strong>not</strong> affect what addresses Apache listens on. You
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd may need to ensure that Apache is listening on the correct addresses
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive using <directive module="mpm_common">Listen</directive>.</p>
003f0c9fda6664daf5092a0e42f65ede20098153slive <p>When using IP-based virtual hosting, the special name
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive which case this virtual host will match any IP address that is
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive not explicitly listed in another virtual host. In the absence
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive of any _default_ virtual host the "main" server config,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive consisting of all those definitions outside any VirtualHost
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive section, is used when no IP-match occurs. (But note that any IP
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive address that matches a <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="core">NameVirtualHost</directive> directive will use neither
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the "main" server config nor the _default_ virtual host. See the <a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive href="/vhosts/name-based.html">name-based virtual hosting</a>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive documentation for further details.)</p>
a7f40ca49262952d6dd69d021cf5b0c2b452ae4cnd <p>You can specify a <code>:port</code> to change the port that is
130d299c4b2b15be45532a176604c71fdc7bea5bnd matched. If unspecified then it defaults to the same port as the
130d299c4b2b15be45532a176604c71fdc7bea5bnd most recent <directive module="mpm_common">Listen</directive>
130d299c4b2b15be45532a176604c71fdc7bea5bnd statement of the main server. You may also specify <code>:*</code>
130d299c4b2b15be45532a176604c71fdc7bea5bnd to match all ports on that address. (This is recommended when used
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>See the <a href="/misc/security_tips.html">security tips</a>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive document for details on why your security could be compromised if the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directory where logfiles are stored is writable by anyone other
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive than the user that starts the server.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><a href="/vhosts/">Apache Virtual Host documentation</a></seealso>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<seealso><a href="/dns-caveats.html">Warnings about DNS and
6b64034fa2a644ba291c484c0c01c7df5b8d982ckess Directory, 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>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</modulesynopsis>