diff options
| author | Joshua Slive <slive@apache.org> | 2002-02-19 18:37:19 +0000 |
|---|---|---|
| committer | Joshua Slive <slive@apache.org> | 2002-02-19 18:37:19 +0000 |
| commit | e0172fec31bcb7a83d7475ed6a283eb49021e530 (patch) | |
| tree | 6a83863c4999f908daaff5df6e87dfc511f62a7e /docs/manual/mod/core.html | |
| parent | b4e054ff330e68b1df5cd981867bc60caac912ec (diff) | |
| download | httpd-e0172fec31bcb7a83d7475ed6a283eb49021e530.tar.gz | |
Here goes: now committing the transformed version of the xml docs. This is
necessary to avoid having to keep the two in sync while we convert.
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@93501 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'docs/manual/mod/core.html')
| -rw-r--r-- | docs/manual/mod/core.html | 6395 |
1 files changed, 4136 insertions, 2259 deletions
diff --git a/docs/manual/mod/core.html b/docs/manual/mod/core.html index c2a3b5819f..9ccd54a78f 100644 --- a/docs/manual/mod/core.html +++ b/docs/manual/mod/core.html @@ -1,204 +1,301 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> +<head> +<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<!-- +XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + This file is generated from xml source: DO NOT EDIT +XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX +--> +<title>core - Apache HTTP Server</title> +<link href="../style/manual.css" type="text/css" rel="stylesheet"> +</head> +<body> +<blockquote> +<div align="center"> +<img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"><h3>Apache HTTP Server Version 2.0</h3> +</div> +<h1 align="center">Apache Module core</h1> +<table cellspacing="1" cellpadding="0" bgcolor="#cccccc"> +<tr> +<td> +<table bgcolor="#ffffff"> +<tr> +<td><span class="help">Description:</span></td><td> +<description>Core Apache HTTP Server features that are always +available</description> +</td> +</tr> +<tr> +<td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +</table> +</td> +</tr> +</table> +<h2>Directives</h2> +<ul> +<li> +<a href="#acceptpathinfo">AcceptPathInfo</a> +</li> +<li> +<a href="#accessfilename">AccessFileName</a> +</li> +<li> +<a href="#adddefaultcharset">AddDefaultCharset</a> +</li> +<li> +<a href="#addmodule">AddModule</a> +</li> +<li> +<a href="#allowoverride">AllowOverride</a> +</li> +<li> +<a href="#authname">AuthName</a> +</li> +<li> +<a href="#authtype">AuthType</a> +</li> +<li> +<a href="#contentdigest">ContentDigest</a> +</li> +<li> +<a href="#defaulttype">DefaultType</a> +</li> +<li> +<a href="#directory">Directory</a> +</li> +<li> +<a href="#directorymatch">DirectoryMatch</a> +</li> +<li> +<a href="#documentroot">DocumentRoot</a> +</li> +<li> +<a href="#errordocument">ErrorDocument</a> +</li> +<li> +<a href="#errorlog">ErrorLog</a> +</li> +<li> +<a href="#fileetag">FileETag</a> +</li> +<li> +<a href="#files">Files</a> +</li> +<li> +<a href="#filesmatch">FilesMatch</a> +</li> +<li> +<a href="#forcetype">ForceType</a> +</li> +<li> +<a href="#hostnamelookups">HostnameLookups</a> +</li> +<li> +<a href="#identitycheck">IdentityCheck</a> +</li> +<li> +<a href="#ifdefine">IfDefine</a> +</li> +<li> +<a href="#ifmodule">IfModule</a> +</li> +<li> +<a href="#include">Include</a> +</li> +<li> +<a href="#keepalive">KeepAlive</a> +</li> +<li> +<a href="#keepalivetimeout">KeepAliveTimeout</a> +</li> +<li> +<a href="#limit">Limit</a> +</li> +<li> +<a href="#limitexcept">LimitExcept</a> +</li> +<li> +<a href="#limitrequestbody">LimitRequestBody</a> +</li> +<li> +<a href="#limitrequestfields">LimitRequestFields</a> +</li> +<li> +<a href="#limitrequestfieldsize">LimitRequestFieldSize</a> +</li> +<li> +<a href="#limitrequestline">LimitRequestLine</a> +</li> +<li> +<a href="#limitxmlrequestbody">LimitXMLRequestBody</a> +</li> +<li> +<a href="#location">Location</a> +</li> +<li> +<a href="#locationmatch">LocationMatch</a> +</li> +<li> +<a href="#loglevel">LogLevel</a> +</li> +<li> +<a href="#maxkeepaliverequests">MaxKeepAliveRequests</a> +</li> +<li> +<a href="#namevirtualhost">NameVirtualHost</a> +</li> +<li> +<a href="#options">Options</a> +</li> +<li> +<a href="#require">Require</a> +</li> +<li> +<a href="#rlimitcpu">RLimitCPU</a> +</li> +<li> +<a href="#rlimitmem">RLimitMEM</a> +</li> +<li> +<a href="#rlimitnproc">RLimitNPROC</a> +</li> +<li> +<a href="#satisfy">Satisfy</a> +</li> +<li> +<a href="#scriptinterpretersource">ScriptInterpreterSource</a> +</li> +<li> +<a href="#serveradmin">ServerAdmin</a> +</li> +<li> +<a href="#serveralias">ServerAlias</a> +</li> +<li> +<a href="#servername">ServerName</a> +</li> +<li> +<a href="#serverpath">ServerPath</a> +</li> +<li> +<a href="#serverroot">ServerRoot</a> +</li> +<li> +<a href="#serversignature">ServerSignature</a> +</li> +<li> +<a href="#servertokens">ServerTokens</a> +</li> +<li> +<a href="#sethandler">SetHandler</a> +</li> +<li> +<a href="#setinputfilter">SetInputFilter</a> +</li> +<li> +<a href="#setoutputfilter">SetOutputFilter</a> +</li> +<li> +<a href="#timeout">TimeOut</a> +</li> +<li> +<a href="#usecanonicalname">UseCanonicalName</a> +</li> +<li> +<a href="#virtualhost">VirtualHost</a> +</li> +</ul> +<hr> +<h2> +<a name="AcceptPathInfo">AcceptPathInfo</a> <a name="acceptpathinfo">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Controls whether requests can contain trailing pathname information</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>AcceptPathInfo On|Off|Default</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>AcceptPathInfo Default</code></td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Available in Apache 2.0.30 and later</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> -<html xmlns="http://www.w3.org/1999/xhtml"> - <head> - <meta name="generator" content="HTML Tidy, see www.w3.org" /> - - <title>Apache Core Features</title> - </head> - <!-- Background white, links blue (unvisited), navy (visited), red (active) --> - - <body bgcolor="#FFFFFF" text="#000000" link="#0000FF" - vlink="#000080" alink="#FF0000"> - <!--#include virtual="header.html" --> - - <h1 align="CENTER">Apache Core Features</h1> - - <p>These configuration parameters control the core Apache - features, and are always available.</p> - - <h2>Directives</h2> - - <ul> - <li><a href="#acceptpathinfo">AcceptPathInfo</a></li> - - <li><a href="#accessfilename">AccessFileName</a></li> - - <li><a href="#adddefaultcharset">AddDefaultCharset</a></li> - - <li><a href="#addmodule">AddModule</a></li> - - <li><a href="#allowoverride">AllowOverride</a></li> - - <li><a href="#authname">AuthName</a></li> - - <li><a href="#authtype">AuthType</a></li> - - <li><a href="#clearmodulelist">ClearModuleList</a></li> - - <li><a href="#contentdigest">ContentDigest</a></li> - - <li><a href="#coredumpdirectory">CoreDumpDirectory</a></li> - - <li><a href="#defaulttype">DefaultType</a></li> - - <li><a href="#directory"><Directory></a></li> - - <li><a href="#directorymatch"><DirectoryMatch></a></li> - - <li><a href="#documentroot">DocumentRoot</a></li> - - <li><a href="#errordocument">ErrorDocument</a></li> - - <li><a href="#errorlog">ErrorLog</a></li> - - <li><a href="#fileetag">FileETag</a></li> - - <li><a href="#files"><Files></a></li> - - <li><a href="#filesmatch"><FilesMatch></a></li> - - <li><a href="#forcetype">ForceType</a></li> - - <li><a href="#hostnamelookups">HostnameLookups</a></li> - - <li><a href="#identitycheck">IdentityCheck</a></li> - - <li><a href="#ifdefine"><IfDefine></a></li> - - <li><a href="#ifmodule"><IfModule></a></li> - - <li><a href="#include">Include</a></li> - - <li><a href="#keepalive">KeepAlive</a></li> - - <li><a href="#keepalivetimeout">KeepAliveTimeout</a></li> - - <li><a href="#limit"><Limit></a></li> - - <li><a href="#limitexcept"><LimitExcept></a></li> - - <li><a href="#limitrequestbody">LimitRequestBody</a></li> - - <li><a href="#limitrequestfields">LimitRequestFields</a></li> - - <li><a - href="#limitrequestfieldsize">LimitRequestFieldsize</a></li> - - <li><a href="#limitrequestline">LimitRequestLine</a></li> - - <li><a - href="#limitxmlrequestbody">LimitXMLRequestBody</a></li> - - <li><a href="#location"><Location></a></li> - - <li><a href="#locationmatch"><LocationMatch></a></li> - - <li><a href="#loglevel">LogLevel</a></li> - - <li><a - href="#maxkeepaliverequests">MaxKeepAliveRequests</a></li> - - <li><a href="#namevirtualhost">NameVirtualHost</a></li> - - <li><a href="#options">Options</a></li> - - <li><a href="#require">Require</a></li> - - <li><a href="#rlimitcpu">RLimitCPU</a></li> - - <li><a href="#rlimitmem">RLimitMEM</a></li> - - <li><a href="#rlimitnproc">RLimitNPROC</a></li> - - <li><a href="#satisfy">Satisfy</a></li> - - <li><a - href="#scriptinterpretersource">ScriptInterpreterSource</a></li> - - <li><a href="#serveradmin">ServerAdmin</a></li> - - <li><a href="#serveralias">ServerAlias</a></li> - - <li><a href="#servername">ServerName</a></li> - - <li><a href="#serverpath">ServerPath</a></li> - - <li><a href="#serverroot">ServerRoot</a></li> - - <li><a href="#serversignature">ServerSignature</a></li> - - <li><a href="#servertokens">ServerTokens</a></li> - - <li><a href="#sethandler">SetHandler</a></li> - - <li><a href="#setinputfilter">SetInputFilter</a></li> - - <li><a href="#setoutputfilter">SetOutputFilter</a></li> - - <li><a href="#timeout">TimeOut</a></li> - - <li><a href="#usecanonicalname">UseCanonicalName</a></li> - - <li><a href="#virtualhost"><VirtualHost></a></li> - </ul> - <hr /> - - <h2><a id="acceptpathinfo" - name="adddefaultcharset">AcceptPathInfo directive</a></h2> - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> AcceptPathInfo On|Off|Default<br /> - <a href="directive-dict.html#Default" - rel="Help"><strong>Default:</strong></a> - <code>AcceptPathInfo Default</code><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config, virtual host, - directory, .htaccess<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> - AcceptPathInfo is only available in Apache 2.0.30 and later - - <p>This directive controls whether requests that contain trailing + +<p>This directive controls whether requests that contain trailing pathname information that follows an actual filename (or non-existent file in an existing directory) will be accepted or rejected. The trailing pathname information can be made available to scripts in the PATH_INFO environment variable.</p> - <p>For example, assume the location <code>/test/</code> points to + +<p>For example, assume the location <code>/test/</code> points to a directory that contains only the single file <code>here.html</code>. Then requests for <code>/test/here.html/more</code> and <code>/test/nothere.html/more</code> both collect <code>/more</code> as PATH_INFO.</p> - <p>The three possible arguments for the - <code>AcceptPathInfo</code> directive are:</p> - <dl> - <dt><code>off</code></dt><dd>A request will only be accepted if it + +<p>The three possible arguments for the + <code class="directive">AcceptPathInfo</code> directive are:</p> + +<dl> + +<dt> +<code>off</code> +</dt> +<dd>A request will only be accepted if it maps to a literal path that exists. Therefore a request with trailing pathname information after the true filename such as <code>/test/here.html/more</code> in the above example will return a 404 NOT FOUND error.</dd> - <dt><code>on</code></dt><dd>A request will be accepted if a + +<dt> +<code>on</code> +</dt> +<dd>A request will be accepted if a leading path component maps to a file that exists. The above example <code>/test/here.html/more</code> will be accepted if - <code>/test/here.html</code> maps to a valid file.</dt> + <code>/test/here.html</code> maps to a valid file.</dd> - <dt><code>default</code><dd>The treatment of requests with - trailing pathname information is determined by the <a - href="../handler.html">handler</a> responsible for the request. + +<dt> +<code>default</code> +</dt> +<dd>The treatment of requests with + trailing pathname information is determined by the <a href="../handler.html">handler</a> responsible for the request. The core handler for normal files defaults to rejecting PATH_INFO. - Handlers that serve scripts, such as <a - href="mod_cgi.html">cgi-script</a> and <a - href="mod_isapi.html">isapi-isa</a>, generally accept PATH_INFO by + Handlers that serve scripts, such as <a href="mod_cgi.html">cgi-script</a> and <a href="mod_isapi.html">isapi-isa</a>, generally accept PATH_INFO by default.</dd> - </dl> + +</dl> - <p>The primary purpose of the <code>AcceptPathInfo</code> + +<p>The primary purpose of the <code>AcceptPathInfo</code> directive is to allow you to override the handler's choice of accepting or rejecting PATH_INFO. This override is required, for example, when you use a <a href="../filter.html">filter</a>, such @@ -206,637 +303,1036 @@ based on PATH_INFO. The core handler would usually reject the request, so you can use the following configuration to enable such a script:</p> -<pre> -<Files "mypaths.shtml"> - Options +Includes - SetOutputFilter INCLUDES - AcceptPathInfo on + +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code> +<Files "mypaths.shtml"><br> + Options +Includes<br> + SetOutputFilter INCLUDES<br> + AcceptPathInfo on<br> </Files> -</pre> - <hr /> - - <h2><a id="accessfilename" name="accessfilename">AccessFileName - directive</a></h2> - - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> AccessFileName - <em>filename</em> [<em>filename</em>] ...<br /> - <a href="directive-dict.html#Default" - rel="Help"><strong>Default:</strong></a> <code>AccessFileName - .htaccess</code><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config, virtual - host<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> AccessFileName - can accept more than one filename only in Apache 1.3 and later - - <p>When returning a document to the client the server looks for +</code></td> +</tr> +</table> +</blockquote> + +</usage> +<hr> +<h2> +<a name="AccessFileName">AccessFileName</a> <a name="accessfilename">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Sets the name of the .htaccess file</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>AccessFileName <em>filename</em> [<em>filename</em>] ...</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>AccessFileName .htaccess</code></td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>When returning a document to the client the server looks for the first existing access control file from this list of names in every directory of the path to the document, if access control files are enabled for that directory. For example:</p> - <blockquote> - <code>AccessFileName .acl</code> - </blockquote> - before returning the document /usr/local/web/index.html, the - server will read /.acl, /usr/.acl, /usr/local/.acl and - /usr/local/web/.acl for directives, unless they have been - disabled with - - <blockquote> - <code><Directory /><br /> - AllowOverride None<br /> - </Directory></code> - </blockquote> - - <p><strong>See Also:</strong> <a - href="#allowoverride">AllowOverride</a> and <a - href="../configuring.html">Configuration Files</a></p> - <hr /> - - <h2><a id="adddefaultcharset" - name="adddefaultcharset">AddDefaultCharset directive</a></h2> - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> AddDefaultCharset - On|Off|<em>charset</em><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> all<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core<br /> - <a href="directive-dict.html#Default" - rel="Help"><strong>Default:</strong></a> - <code>AddDefaultCharset Off</code><br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> - AddDefaultCharset is only available in Apache 1.3.12 and later - - <p>This directive specifies the name of the character set that - will be added to any response that does not have any parameter - on the content type in the HTTP headers. This will override any - character set specified in the body of the document via a - <code>META</code> tag. A setting of <code>AddDefaultCharset - Off</code> disables this functionality. <code>AddDefaultCharset - On</code> enables Apache's internal default charset of - <code>iso-8859-1</code> as required by the directive. You can - also specify an alternate <em>charset</em> to be used. For - example:</p> - - <blockquote> - <code>AddDefaultCharset utf-8</code> - </blockquote> - - <hr /> - <h2><a id="addmodule" name="addmodule">AddModule - directive</a></h2> +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code> +AccessFileName .acl +</code></td> +</tr> +</table> +</blockquote> - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> AddModule - <em>module</em> [<em>module</em>] ...<br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config <br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> AddModule is - only available in Apache 1.2 and later + +<p>before returning the document + <code>/usr/local/web/index.html</code>, the server will read + <code>/.acl</code>, <code>/usr/.acl</code>, + <code>/usr/local/.acl</code> and <code>/usr/local/web/.acl</code> + for directives, unless they have been disabled with</p> + + +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code> +<Directory /><br> + AllowOverride None<br> +</Directory> +</code></td> +</tr> +</table> +</blockquote> + +</usage> +<p> +<strong>See also:</strong> +</p> +<ul> +<li> +<code class="directive"><a href="#allowoverride" class="directive">AllowOverride</a></code> +</li> +<li> +<a href="../configuring.html">Configuration Files</a> +</li> +</ul> +<hr> +<h2> +<a name="AddDefaultCharset">AddDefaultCharset</a> <a name="adddefaultcharset">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Specifies the default character set to be added for a +response without an explicit character set</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>AddDefaultCharset On|Off|<em>charset</em> +</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>AddDefaultCharset Off</code></td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> - <p>The server can have modules compiled in which are not + +<p>This directive specifies the name of the character set that + will be added to any response that does not have any parameter on + the content type in the HTTP headers. This will override any + character set specified in the body of the document via a + <code>META</code> tag. A setting of <code>AddDefaultCharset + Off</code> disables this + functionality. <code>AddDefaultCharset On</code> enables + Apache's internal default charset of <code>iso-8859-1</code> as + required by the directive. You can also specify an alternate + <em>charset</em> to be used. For example:</p> + + +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code> + AddDefaultCharset utf-8 +</code></td> +</tr> +</table> +</blockquote> + +</usage> +<hr> +<h2> +<a name="AddModule">AddModule</a> <a name="addmodule">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td></td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>AddModule <em>module</em> [<em>module</em>] ...</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>The server can have modules compiled in which are not actively in use. This directive can be used to enable the use of those modules. The server comes with a pre-loaded list of - active modules; this list can be cleared with the <a - href="#clearmodulelist">ClearModuleList</a> directive.</p> - - <p>For example:</p> - - <blockquote> - <code>AddDefaultCharset utf-8</code> - </blockquote> - - <hr /> - - <h2><a id="allowoverride" name="allowoverride">AllowOverride - directive</a></h2> - - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> AllowOverride - All|None|<em>directive-type</em> [<em>directive-type</em>] - ...<br /> - <a href="directive-dict.html#Default" - rel="Help"><strong>Default:</strong></a> <code>AllowOverride - All</code><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> directory<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core - - <p>When the server finds an .htaccess file (as specified by <a - href="#accessfilename">AccessFileName</a>) it needs to know + active modules; this list can be cleared with the <code class="directive"><a href="#clearmodulelist" class="directive">ClearModuleList</a></code> directive.</p> + + +<p>For example:</p> + +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code> +AddDefaultCharset utf-8 +</code></td> +</tr> +</table> +</blockquote> + +</usage> +<hr> +<h2> +<a name="AllowOverride">AllowOverride</a> <a name="allowoverride">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Sets the types of directives that are allowed in +.htaccess files</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>AllowOverride All|None|<em>directive-type</em> [<em>directive-type</em>] ...</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>AllowOverride All</code></td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>When the server finds an .htaccess file (as specified by <code class="directive"><a href="#accessfilename" class="directive">AccessFileName</a></code>) it needs to know which directives declared in that file can override earlier access information.</p> - <p>When this directive is set to <code>None</code>, then + +<p>When this directive is set to <code>None</code>, then .htaccess files are completely ignored. In this case, the server will not even attempt to read .htaccess files in the filesystem.</p> - <p>When this directive is set to <code>All</code>, then any - directive which has the .htaccess <a - href="directive-dict.html#Context">Context</a> is allowed in + +<p>When this directive is set to <code>All</code>, then any + directive which has the .htaccess <a href="directive-dict.html#Context">Context</a> is allowed in .htaccess files.</p> - <p>The <em>directive-type</em> can be one of the following + +<p>The <em>directive-type</em> can be one of the following groupings of directives.</p> - <dl> - <dt>AuthConfig</dt> - - <dd> - - Allow use of the authorization directives (<a - href="mod_auth_dbm.html#authdbmgroupfile">AuthDBMGroupFile</a>, - <a - href="mod_auth_dbm.html#authdbmuserfile">AuthDBMUserFile</a>, - <a href="mod_auth.html#authgroupfile">AuthGroupFile</a>, <a - href="#authname">AuthName</a>, <a - href="#authtype">AuthType</a>, <a - href="mod_auth.html#authuserfile">AuthUserFile</a>, <a - href="#require">Require</a>, <em>etc.</em>).</dd> - - <dt>FileInfo</dt> - - <dd> - Allow use of the directives controlling document types (<a - href="#defaulttype">DefaultType</a>, <a - href="#errordocument">ErrorDocument</a>, <a - href="#forcetype">ForceType</a>, <a - href="mod_negotiation.html#languagepriority">LanguagePriority</a>, - <a href="#sethandler">SetHandler</a>, <a - href="#setinputfilter">SetInputFilter</a>, <a - href="#setoutputfilter">SetOutputFilter</a>, and <a - href="mod_mime.html">mod_mime Add* and Remove* - directives</a>, <em>etc.</em>).</dd> - - <dt>Indexes</dt> - - <dd> + +<dl> + +<dt>AuthConfig</dt> + + +<dd> + + Allow use of the authorization directives (<code class="directive"><a href="mod_auth_dbm.html#authdbmgroupfile" class="directive">AuthDBMGroupFile</a></code>, + <code class="directive"><a href="mod_auth_dbm.html#authdbmuserfile" class="directive">AuthDBMUserFile</a></code>, + <code class="directive"><a href="mod_auth.html#authgroupfile" class="directive">AuthGroupFile</a></code>, + <code class="directive"><a href="#authname" class="directive">AuthName</a></code>, + <code class="directive"><a href="#authtype" class="directive">AuthType</a></code>, <code class="directive"><a href="mod_auth.html#authuserfile" class="directive">AuthUserFile</a></code>, <code class="directive"><a href="#require" class="directive">Require</a></code>, <em>etc.</em>).</dd> + + +<dt>FileInfo</dt> + + +<dd> + Allow use of the directives controlling document types (<code class="directive"><a href="#defaulttype" class="directive">DefaultType</a></code>, <code class="directive"><a href="#errordocument" class="directive">ErrorDocument</a></code>, <code class="directive"><a href="#forcetype" class="directive">ForceType</a></code>, <code class="directive"><a href="mod_negotiation.html#languagepriority" class="directive">LanguagePriority</a></code>, + <code class="directive"><a href="#sethandler" class="directive">SetHandler</a></code>, <code class="directive"><a href="#setinputfilter" class="directive">SetInputFilter</a></code>, <code class="directive"><a href="#setoutputfilter" class="directive">SetOutputFilter</a></code>, and + <code><a href="mod_mime.html">mod_mime</a></code> Add* and Remove* + directives, <em>etc.</em>).</dd> + + +<dt>Indexes</dt> + + +<dd> Allow use of the directives controlling directory indexing - (<a - href="mod_autoindex.html#adddescription">AddDescription</a>, - <a href="mod_autoindex.html#addicon">AddIcon</a>, <a - href="mod_autoindex.html#addiconbyencoding">AddIconByEncoding</a>, - <a href="mod_autoindex.html#addiconbytype">AddIconByType</a>, - <a href="mod_autoindex.html#defaulticon">DefaultIcon</a>, <a - href="mod_dir.html#directoryindex">DirectoryIndex</a>, <a - href="mod_autoindex.html#fancyindexing">FancyIndexing</a>, <a - href="mod_autoindex.html#headername">HeaderName</a>, <a - href="mod_autoindex.html#indexignore">IndexIgnore</a>, <a - href="mod_autoindex.html#indexoptions">IndexOptions</a>, <a - href="mod_autoindex.html#readmename">ReadmeName</a>, + (<code class="directive"><a href="mod_autoindex.html#adddescription" class="directive">AddDescription</a></code>, + <code class="directive"><a href="mod_autoindex.html#addicon" class="directive">AddIcon</a></code>, <code class="directive"><a href="mod_autoindex.html#addiconbyencoding" class="directive">AddIconByEncoding</a></code>, + <code class="directive"><a href="mod_autoindex.html#addiconbytype" class="directive">AddIconByType</a></code>, + <code class="directive"><a href="mod_autoindex.html#defaulticon" class="directive">DefaultIcon</a></code>, <code class="directive"><a href="mod_dir.html#directoryindex" class="directive">DirectoryIndex</a></code>, <code class="directive"><a href="mod_autoindex.html#fancyindexing" class="directive">FancyIndexing</a></code>, <code class="directive"><a href="mod_autoindex.html#headername" class="directive">HeaderName</a></code>, <code class="directive"><a href="mod_autoindex.html#indexignore" class="directive">IndexIgnore</a></code>, <code class="directive"><a href="mod_autoindex.html#indexoptions" class="directive">IndexOptions</a></code>, <code class="directive"><a href="mod_autoindex.html#readmename" class="directive">ReadmeName</a></code>, <em>etc.</em>).</dd> - <dt>Limit</dt> + +<dt>Limit</dt> - <dd> - Allow use of the directives controlling host access (Allow, - Deny and Order).</dd> + +<dd> + Allow use of the directives controlling host access (<code class="directive"><a href="mod_access.html#allow" class="directive">Allow</a></code>, <code class="directive"><a href="mod_access.html#deny" class="directive">Deny</a></code> and <code class="directive"><a href="mod_access.html#order" class="directive">Order</a></code>).</dd> - <dt>Options</dt> + +<dt>Options</dt> - <dd> + +<dd> Allow use of the directives controlling specific directory - features (<a href="#options">Options</a> and <a - href="mod_include.html#xbithack">XBitHack</a>).</dd> - </dl> - - <p>Example:</p> - - <blockquote><code>AllowOverride AuthConfig Indexes</code></blockquote> - - <p><strong>See Also:</strong> <a - href="#accessfilename">AccessFileName</a> and <a - href="configuring.html">Configuration Files</a></p> - <hr /> - - <h2><a id="authname" name="authname">AuthName - directive</a></h2> - - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> AuthName - <em>auth-domain</em><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> directory, - .htaccess<br /> - <a href="directive-dict.html#Override" - rel="Help"><strong>Override:</strong></a> AuthConfig<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core - - <p>This directive sets the name of the authorization realm for - a directory. This realm is given to the client so that the user + features (<code class="directive"><a href="#options" class="directive">Options</a></code> and + <code class="directive"><a href="mod_include.html#xbithack" class="directive">XBitHack</a></code>).</dd> + +</dl> + + +<p>Example:</p> + + +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code>AllowOverride AuthConfig Indexes</code></td> +</tr> +</table> +</blockquote> + +</usage> +<p> +<strong>See also:</strong> +</p> +<ul> +<li> +<code class="directive"><a href="#accessfilename" class="directive">AccessFileName</a></code> +</li> +<li> +<a href="../configuring.html">Configuration Files</a> +</li> +</ul> +<hr> +<h2> +<a name="AuthName">AuthName</a> <a name="authname">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Sets the authorization realm for use in HTTP +authentication</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>AuthName <em>auth-domain</em> +</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td> +</tr> +<tr> +<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>This directive sets the name of the authorization realm for a + directory. This realm is given to the client so that the user knows which username and password to send. - <samp>AuthName</samp> takes a single argument; if the realm - name contains spaces, it must be enclosed in quotation marks. - It must be accompanied by <a href="#authtype">AuthType</a> and - <a href="#require">Require</a> directives, and directives such - as <a href="mod_auth.html#authuserfile">AuthUserFile</a> and <a - href="mod_auth.html#authgroupfile">AuthGroupFile</a> to + <code class="directive">AuthName</code> takes a single argument; if the + realm name contains spaces, it must be enclosed in quotation + marks. It must be accompanied by <code class="directive"><a href="#authtype" class="directive">AuthType</a></code> and <code class="directive"><a href="#require" class="directive">Require</a></code> directives, and directives such + as <code class="directive"><a href="mod_auth.html#authuserfile" class="directive">AuthUserFile</a></code> and + <code class="directive"><a href="mod_auth.html#authgroupfile" class="directive">AuthGroupFile</a></code> to work.</p> - <p>For example:</p> + +<p>For example:</p> - <blockquote><code>AuthName "Top Secret"</code></blockquote> + +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code>AuthName "Top Secret"</code></td> +</tr> +</table> +</blockquote> - <p>The string provided for the <code>AuthRealm</code> is what will + +<p>The string provided for the <code>AuthRealm</code> is what will appear in the password dialog provided by most browsers.</p> - <p><strong>See also:</strong> <a - href="../howto/auth.html">Authentication, Authorization, and - Access Control</a></p> - - <hr /> - - <h2><a id="authtype" name="authtype">AuthType - directive</a></h2> - - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> AuthType - Basic|Digest<br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> directory, - .htaccess<br /> - <a href="directive-dict.html#Override" - rel="Help"><strong>Override:</strong></a> AuthConfig<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core - - <p>This directive selects the type of user authentication for a +</usage> +<p> +<strong>See also:</strong> +</p> +<ul> +<li> +<a href="../howto/auth.html">Authentication, Authorization, and + Access Control</a> +</li> +</ul> +<hr> +<h2> +<a name="AuthType">AuthType</a> <a name="authtype">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Selects the type of user authentication</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>AuthType Basic|Digest</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>This directive selects the type of user authentication for a directory. Only <code>Basic</code> and <code>Digest</code> are currently implemented. - It must be accompanied by <a href="#authname">AuthName</a> and - <a href="#require">Require</a> directives, and directives such - as <a href="mod_auth.html#authuserfile">AuthUserFile</a> and <a - href="mod_auth.html#authgroupfile">AuthGroupFile</a> to - work.</p> - - <p><strong>See also:</strong> <a - href="../howto/auth.html">Authentication, Authorization, and - Access Control</a></p> - <hr /> - - <h2><a id="clearmodulelist" - name="clearmodulelist">ClearModuleList directive</a></h2> - - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> ClearModuleList<br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> ClearModuleList - is only available in Apache 1.2 and later - - <p>The server comes with a built-in list of active modules. - This directive clears the list. It is assumed that the list - will then be re-populated using the <a - href="#addmodule">AddModule</a> directive.</p> - <hr /> - - <h2><a id="contentdigest" name="contentdigest">ContentDigest - directive</a></h2> - - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> ContentDigest - on|off<br /> - <a href="directive-dict.html#Default" - rel="Help"><strong>Default:</strong></a> <code>ContentDigest - off</code><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config, virtual - host, directory, .htaccess<br /> - <a href="directive-dict.html#Override" - rel="Help"><strong>Override:</strong></a> Options<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> experimental<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> ContentDigest is - only available in Apache 1.1 and later - - <p>This directive enables the generation of + It must be accompanied by <code class="directive"><a href="#authname" class="directive">AuthName</a></code> and <code class="directive"><a href="#require" class="directive">Require</a></code> directives, and directives such + as <code class="directive"><a href="mod_auth.html#authuserfile" class="directive">AuthUserFile</a></code> and + <code class="directive"><a href="mod_auth.html#authgroupfile" class="directive">AuthGroupFile</a></code> to + work.</p> + +</usage> +<p> +<strong>See also:</strong> +</p> +<ul> +<li> +<a href="../howto/auth.html">Authentication, Authorization, +and Access Control</a> +</li> +</ul> +<hr> +<h2> +<a name="ContentDigest">ContentDigest</a> <a name="contentdigest">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Enables the generation of Content-MD5 HTTP Response +headers</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>ContentDigest on|off</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ContentDigest off</code></td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td> +</tr> +<tr> +<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Options</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Available in Apache 1.1 and later</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>This directive enables the generation of <code>Content-MD5</code> headers as defined in RFC1864 respectively RFC2068.</p> - <p>MD5 is an algorithm for computing a "message digest" + +<p>MD5 is an algorithm for computing a "message digest" (sometimes called "fingerprint") of arbitrary-length data, with a high degree of confidence that any alterations in the data will be reflected in alterations in the message digest.</p> - <p>The <code>Content-MD5</code> header provides an end-to-end + +<p>The <code>Content-MD5</code> header provides an end-to-end message integrity check (MIC) of the entity-body. A proxy or client may check this header for detecting accidental modification of the entity-body in transit. Example header:</p> -<pre> + +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code> Content-MD5: AuLb7Dp1rqtRtxz2m9kRpA== -</pre> +</code></td> +</tr> +</table> +</blockquote> - <p>Note that this can cause performance problems on your server + +<p>Note that this can cause performance problems on your server since the message digest is computed on every request (the values are not cached).</p> - <p><code>Content-MD5</code> is only sent for documents served + +<p> +<code>Content-MD5</code> is only sent for documents served by the core, and not by any module. For example, SSI documents, output from CGI scripts, and byte range responses do not have this header.</p> - <hr /> - - <h2><a id="defaulttype" name="defaulttype">DefaultType - directive</a></h2> - - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> DefaultType - <em>MIME-type</em><br /> - <a href="directive-dict.html#Default" - rel="Help"><strong>Default:</strong></a> <code>DefaultType - text/html</code><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config, virtual - host, directory, .htaccess<br /> - <a href="directive-dict.html#Override" - rel="Help"><strong>Override:</strong></a> FileInfo<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core - - <p>There will be times when the server is asked to provide a + +</usage> +<hr> +<h2> +<a name="DefaultType">DefaultType</a> <a name="defaulttype">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Sets the MIME content-type that will be sent if the +server cannot determine a type in any other way</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>DefaultType <em>MIME-type</em> +</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>DefaultType text/html</code></td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td> +</tr> +<tr> +<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>There will be times when the server is asked to provide a document whose type cannot be determined by its MIME types mappings.</p> - <p>The server must inform the client of the content-type of the + +<p>The server must inform the client of the content-type of the document, so in the event of an unknown type it uses the <code>DefaultType</code>. For example:</p> - <blockquote> + +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code> <code>DefaultType image/gif</code> - </blockquote> +</code></td> +</tr> +</table> +</blockquote> would be appropriate for a directory which contained many gif images with filenames missing the .gif extension. - <p>Note that unlike <a href="#forcetype">ForceType</a>, this - directive is only provides the default mime-type. All other - mime-type definitions, including filename extensions, that - might identify the media type will override this default.</p> - <hr /> - - <h2><a id="directory" name="directory"><Directory> - directive</a></h2> - - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> <Directory - <em>directory-path</em>> ... </Directory> <br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config, virtual - host<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> Core. - - <p><Directory> and </Directory> are used to enclose - a group of directives which will apply only to the named - directory and sub-directories of that directory. Any directive - which is allowed in a directory context may be used. - <em>Directory-path</em> is either the full path to a directory, - or a wild-card string. In a wild-card string, `?' matches any - single character, and `*' matches any sequences of characters. - As of Apache 1.3, you may also use `[]' character ranges like - in the shell. Also as of Apache 1.3 none of the wildcards match - a `/' character, which more closely mimics the behavior of Unix - shells. Example:</p> -<pre> - <Directory /usr/local/httpd/htdocs> - Options Indexes FollowSymLinks - </Directory> -</pre> + <p>Note that unlike <code class="directive"><a href="#forcetype" class="directive">ForceType</a></code>, this directive is only + provides the default mime-type. All other mime-type definitions, + including filename extensions, that might identify the media type + will override this default.</p> + +</usage> +<hr> +<h2> +<a name="Directory"><Directory></a> <a name="directory">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Enclose a group of directives that apply only to the +named file-system directory and sub-directories</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax><Directory <em>directory-path</em>> +... </Directory></syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p> +<code class="directive"><Directory></code> and + <code></Directory></code> are used to enclose a group of + directives which will apply only to the named directory and + sub-directories of that directory. Any directive which is allowed + in a directory context may be used. <em>Directory-path</em> is + either the full path to a directory, or a wild-card string. In a + wild-card string, `?' matches any single character, and `*' + matches any sequences of characters. You may + also use `[]' character ranges like in the shell. Also as of + Apache 1.3 none of the wildcards match a `/' character, which more + closely mimics the behavior of Unix shells. Example:</p> + +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code> + <Directory /usr/local/httpd/htdocs><br> + Options Indexes FollowSymLinks<br> + </Directory><br> + +</code></td> +</tr> +</table> +</blockquote> - <p><strong>Apache 1.2 and above:</strong> Extended regular + +<p>Extended regular expressions can also be used, with the addition of the <code>~</code> character. For example:</p> -<pre> + +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code> <Directory ~ "^/www/.*/[0-9]{3}"> -</pre> +</code></td> +</tr> +</table> +</blockquote> would match directories in /www/ that consisted of three numbers. <p>If multiple (non-regular expression) directory sections match the directory (or its parents) containing a document, then the directives are applied in the order of shortest match - first, interspersed with the directives from the <a - href="#accessfilename">.htaccess</a> files. For example, + first, interspersed with the directives from the <a href="#accessfilename">.htaccess</a> files. For example, with</p> - <blockquote> - <code><Directory /><br /> - AllowOverride None<br /> - </Directory><br /> - <br /> - <Directory /home/*><br /> - AllowOverride FileInfo<br /> - </Directory></code> - </blockquote> - for access to the document <code>/home/web/dir/doc.html</code> - the steps are: - - <ul> - <li>Apply directive <code>AllowOverride None</code> + +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code> + <Directory /><br> + AllowOverride None<br> + </Directory><br> + +<br> + <Directory /home/*><br> + AllowOverride FileInfo<br> + </Directory> +</code></td> +</tr> +</table> +</blockquote> + +<p>for access to the document <code>/home/web/dir/doc.html</code> + the steps are:</p> + + +<ul> + +<li>Apply directive <code>AllowOverride None</code> (disabling <code>.htaccess</code> files).</li> - <li>Apply directive <code>AllowOverride FileInfo</code> (for + +<li>Apply directive <code>AllowOverride FileInfo</code> (for directory <code>/home/web</code>).</li> - <li>Apply any FileInfo directives in - <code>/home/web/.htaccess</code></li> - </ul> - - <p>Regular expression directory sections are handled slightly - differently by Apache 1.2 and 1.3. In Apache 1.2 they are - interspersed with the normal directory sections and applied in - the order they appear in the configuration file. They are - applied only once, and apply when the shortest match possible - occurs. In Apache 1.3 regular expressions are not considered - until after all of the normal sections have been applied. Then - all of the regular expressions are tested in the order they - appeared in the configuration file. For example, with</p> - - <blockquote> - <code><Directory ~ abc$><br /> - ... directives here ...<br /> - </Directory><br /> - </code> - </blockquote> - Suppose that the filename being accessed is - <code>/home/abc/public_html/abc/index.html</code>. The server - considers each of <code>/</code>, <code>/home</code>, - <code>/home/abc</code>, <code>/home/abc/public_html</code>, and - <code>/home/abc/public_html/abc</code> in that order. In Apache - 1.2, when <code>/home/abc</code> is considered, the regular - expression will match and be applied. In Apache 1.3 the regular - expression isn't considered at all at that point in the tree. - It won't be considered until after all normal - <Directory>s and <code>.htaccess</code> files have been - applied. Then the regular expression will match on - <code>/home/abc/public_html/abc</code> and be applied. - - <p><strong>Note that the default Apache access for + +<li>Apply any FileInfo directives in + <code>/home/web/.htaccess</code> +</li> + +</ul> + + +<p>Regular expressions are not considered until after all of the + normal sections have been applied. Then all of the regular + expressions are tested in the order they appeared in the + configuration file. For example, with</p> + + +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code><Directory ~ abc$><br> + ... directives here ...<br> + </Directory><br> + +</code></td> +</tr> +</table> +</blockquote> + + +<p>The regular expression section won't be considered until after + all normal <Directory>s and <code>.htaccess</code> files + have been applied. Then the regular expression will match on + <code>/home/abc/public_html/abc</code> and be applied.</p> + + +<p> +<strong>Note that the default Apache access for <Directory /> is <samp>Allow from All</samp>. This means that Apache will serve any file mapped from an URL. It is recommended that you change this with a block such - as</strong></p> -<pre> - <Directory /> - Order Deny,Allow - Deny from All + as</strong> +</p> + + +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code> + <Directory /><br> + Order Deny,Allow<br> + Deny from All<br> </Directory> -</pre> +</code></td> +</tr> +</table> +</blockquote> + + +<p> +<strong>and then override this for directories you + <em>want</em> accessible. See the <a href="../misc/security_tips.html">Security Tips</a> page for more + details.</strong> +</p> - <p><strong>and then override this for directories you - <em>want</em> accessible. See the <a - href="../misc/security_tips.html">Security Tips</a> page for - more details.</strong></p> - The directory sections typically occur in the access.conf file, - but they may appear in any configuration file. - <Directory> directives cannot nest, and cannot appear in - a <a href="#limit"><Limit></a> or <a - href="#limitexcept"><LimitExcept></a> section. - - <p><strong>See also</strong>: <a href="../sections.html">How + +<p>The directory sections typically occur in + the access.conf file, but they may appear in any configuration + file. <code class="directive"><Directory></code> directives + cannot nest, and cannot appear in a <code class="directive"><a href="#limit" class="directive"><Limit></a></code> or <code class="directive"><a href="#limitexcept" class="directive"><LimitExcept></a></code> section.</p> + +</usage> +<p> +<strong>See also:</strong> +</p> +<ul> +<li> +<a href="../sections.html">How Directory, Location and Files sections work</a> for an explanation of how these different sections are combined when a - request is received</p> - <hr /> - - <h2><a id="directorymatch" - name="directorymatch"><DirectoryMatch></a></h2> - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> <DirectoryMatch - <em>regex</em>> ... </DirectoryMatch> <br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config, virtual - host<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> Core.<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> Available in - Apache 1.3 and later - - <p><DirectoryMatch> and </DirectoryMatch> are used - to enclose a group of directives which will apply only to the - named directory and sub-directories of that directory, the same - as <a href="#directory"><Directory></a>. However, it + request is received</li> +</ul> +<hr> +<h2> +<a name="DirectoryMatch"><DirectoryMatch></a> <a name="directorymatch">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Enclose a group of directives that apply only to +file-system directories that match a regular expression and their +subdirectories</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax><Directory <em>regex</em>> +... </Directory></syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p> +<code class="directive"><DirectoryMatch></code> and + <code></DirectoryMatch></code> are used to enclose a group + of directives which will apply only to the named directory and + sub-directories of that directory, the same as <code class="directive"><a href="#directory" class="directive"><Directory></a></code>. However, it takes as an argument a regular expression. For example:</p> -<pre> + +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code> <DirectoryMatch "^/www/.*/[0-9]{3}"> -</pre> +</code></td> +</tr> +</table> +</blockquote> - <p>would match directories in /www/ that consisted of three + +<p>would match directories in <code>/www/</code> that consisted of three numbers.</p> - <p><strong>See Also:</strong> <a - href="#directory"><Directory></a> for a description of - how regular expressions are mixed in with normal - <Directory>s.<br /> - <strong>See also</strong>: <a href="../sections.html">How - Directory, Location and Files sections work</a> for an - explanation of how these different sections are combined when a - request is received</p> - <hr /> - - <h2><a id="documentroot" name="documentroot">DocumentRoot - directive</a></h2> - - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> DocumentRoot - <em>directory-path</em><br /> - <a href="directive-dict.html#Default" - rel="Help"><strong>Default:</strong></a> <code>DocumentRoot - /usr/local/apache/htdocs</code><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config, virtual - host<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core - - <p>This directive sets the directory from which httpd will +</usage> +<p> +<strong>See also:</strong> +</p> +<ul> +<li> +<code class="directive"><a href="#directory" class="directive"><Directory></a></code> for +a description of how regular expressions are mixed in with normal +<code><Directory></code>s</li> +<li> +<a href="../sections.html">How Directory, Location and Files sections +work</a> for an explanation of how these different sections are +combined when a request is received</li> +</ul> +<hr> +<h2> +<a name="DocumentRoot">DocumentRoot</a> <a name="documentroot">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Sets the directory that forms the main document tree visible +from the web</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>DocumentRoot <em>directory-path</em> +</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>DocumentRoot /usr/local/apache/htdocs</code></td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>This directive sets the directory from which httpd will serve files. Unless matched by a directive like Alias, the server appends the path from the requested URL to the document root to make the path to the document. Example:</p> - <blockquote> - <code>DocumentRoot /usr/web</code> - </blockquote> - then an access to +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code> + DocumentRoot /usr/web +</code></td> +</tr> +</table> +</blockquote> + +<p>then an access to <code>http://www.my.host.com/index.html</code> refers to - <code>/usr/web/index.html</code>. - - <p>There appears to be a bug in mod_dir which causes problems - when the DocumentRoot has a trailing slash (<em>i.e.</em>, - "DocumentRoot /usr/web/") so please avoid that.</p> - <hr /> - - <h2><a id="errordocument" name="errordocument">ErrorDocument - directive</a></h2> - - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> ErrorDocument - <em>error-code document</em><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config, virtual - host, directory, .htaccess<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core<br /> - <a href="directive-dict.html#Override" - rel="Help"><strong>Override:</strong></a> FileInfo<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> The directory - and .htaccess contexts are only available in Apache 1.1 and - later. The quoting syntax prior to Apache 2.0 was different. - - <p>In the event of a problem or error, Apache can be configured + <code>/usr/web/index.html</code>.</p> + + +<p>The <code class="directive">DocumentRoot</code> should be specified without + a trailing slash.</p> + +</usage> +<p> +<strong>See also:</strong> +</p> +<ul> +<li> +<a href="../urlmapping.html">Mapping URLs to Filesystem +Location</a> +</li> +</ul> +<hr> +<h2> +<a name="ErrorDocument">ErrorDocument</a> <a name="errordocument">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Specifies what the server will return to the client +in case of an error</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>ErrorDocument <em>error-code document</em> +</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td> +</tr> +<tr> +<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Quoting syntax for text messages is different in Apache +2.0</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>In the event of a problem or error, Apache can be configured to do one of four things,</p> - <ol> - <li>output a simple hardcoded error message</li> + +<ol> + +<li>output a simple hardcoded error message</li> - <li>output a customized message</li> + +<li>output a customized message</li> - <li>redirect to a local <em>URL-path</em> to handle the + +<li>redirect to a local <em>URL-path</em> to handle the problem/error</li> - <li>redirect to an external <em>URL</em> to handle the + +<li>redirect to an external <em>URL</em> to handle the problem/error</li> - </ol> + +</ol> - <p>The first option is the default, while options 2-4 are - configured using the <code>ErrorDocument</code> directive, - which is followed by the HTTP response code and a URL or a - message. Apache will sometimes offer additional information + +<p>The first option is the default, while options 2-4 are + configured using the <code class="directive">ErrorDocument</code> + directive, which is followed by the HTTP response code and a URL + or a message. Apache will sometimes offer additional information regarding the problem/error.</p> - <p>URLs can begin with a slash (/) for local URLs, or be a full + +<p>URLs can begin with a slash (/) for local URLs, or be a full URL which the client can resolve. Alternatively, a message can be provided to be displayed by the browser. Examples:</p> - <blockquote> - <code>ErrorDocument 500 - http://foo.example.com/cgi-bin/tester<br /> - ErrorDocument 404 /cgi-bin/bad_urls.pl<br /> - ErrorDocument 401 /subscription_info.html<br /> + +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code> + ErrorDocument 500 + http://foo.example.com/cgi-bin/tester<br> + ErrorDocument 404 /cgi-bin/bad_urls.pl<br> + ErrorDocument 401 /subscription_info.html<br> ErrorDocument 403 "Sorry can't allow you access - today"</code> - </blockquote> + today" +</code></td> +</tr> +</table> +</blockquote> - <p>Note that when you specify an <code>ErrorDocument</code> + +<p>Note that when you specify an <code class="directive">ErrorDocument</code> that points to a remote URL (ie. anything with a method such as "http" in front of it), Apache will send a redirect to the client to tell it where to find the document, even if the @@ -850,254 +1346,433 @@ know to prompt the user for a password since it will not receive the 401 status code. Therefore, <strong>if you use an "ErrorDocument 401" directive then it must refer to a local - document.</strong></p> + document.</strong> +</p> - <p>Prior to version 2.0, messages were indicated by prefixing + +<p>Prior to version 2.0, messages were indicated by prefixing them with a single unmatched double quote character.</p> - <p>See Also: <a href="../custom-error.html">documentation of - customizable responses.</a></p> - <hr /> - - <h2><a id="errorlog" name="errorlog">ErrorLog - directive</a></h2> - - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> ErrorLog - <em>file-path</em>|syslog[:<em>facility</em>] <br /> - <a href="directive-dict.html#Default" - rel="Help"><strong>Default:</strong></a> <code>ErrorLog - logs/error_log</code> (Unix)<br /> - <a href="directive-dict.html#Default" - rel="Help"><strong>Default:</strong></a> <code>ErrorLog - logs/error.log</code> (Windows and OS/2)<br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config, virtual - host<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core - - <p>The error log directive sets the name of the file to which - the server will log any errors it encounters. If the - <em>file-path</em> does not begin with a slash (/) then it is - assumed to be relative to the <a - href="#serverroot">ServerRoot</a>. If the <em>file-path</em> - begins with a pipe (|) then it is assumed to be a command to - spawn to handle the error log.</p> - - <p><strong>Apache 1.3 and above:</strong> Using - <code>syslog</code> instead of a filename enables logging via - syslogd(8) if the system supports it. The default is to use - syslog facility <code>local7</code>, but you can override this - by using the <code>syslog:</code><em>facility</em> syntax where +</usage> +<p> +<strong>See also:</strong> +</p> +<ul> +<li> +<a href="../custom-error.html">documentation of + customizable responses</a> +</li> +</ul> +<hr> +<h2> +<a name="ErrorLog">ErrorLog</a> <a name="errorlog">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Sets the name of the file to which the server +will log errors</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax> ErrorLog <em>file-path</em>|syslog[:<em>facility</em>]</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ErrorLog logs/error_log (Unix) +ErrorLog logs/error.log (Windows and OS/2)</code></td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>The <code class="directive">ErrorLog</code> directive sets the name of + the file to which the server will log any errors it encounters. If + the <em>file-path</em> does not begin with a slash (/) then it is + assumed to be relative to the <code class="directive"><a href="#serverroot" class="directive">ServerRoot</a></code>. If the <em>file-path</em> + begins with a pipe (|) then it is assumed to be a command to spawn + to handle the error log.</p> + + +<p>Using <code>syslog</code> instead of a filename enables logging + via syslogd(8) if the system supports it. The default is to use + syslog facility <code>local7</code>, but you can override this by + using the <code>syslog:</code><em>facility</em> syntax where <em>facility</em> can be one of the names usually documented in syslog(1).</p> - <p>SECURITY: See the <a - href="../misc/security_tips.html#serverroot">security tips</a> + +<p>SECURITY: See the <a href="../misc/security_tips.html#serverroot">security tips</a> document for details on why your security could be compromised if the directory where logfiles are stored is writable by anyone other than the user that starts the server.</p> - <p><strong>See also:</strong> <a href="#loglevel">LogLevel</a> - and <a href="../logs.html">Apache Log Files</a></p> - <hr /> - - <h2><a id="fileetag" name="fileetag">FileETag directive</a></h2> - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> FileETag - <i>component</i> ...<br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config, virtual - host, directory, .htaccess<br /> - <a href="directive-dict.html#Override" - rel="Help"><strong>Override:</strong></a> FileInfo<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> only available - in Apache 1.3.23 versions and later. - - <p> - The FileETag directive configures the file attributes that are - used to create the ETag (entity tag) response header field - when the document is based on a file. - (The ETag value is used in cache management to save network - bandwidth.) In Apache 1.3.22 and earlier, the ETag value was - <i>always</i> formed from the file's inode, size, and last-modified - time (mtime). The FileETag directive allows you to choose - which of these -- if any -- should be used. The recognised - keywords are: +</usage> +<p> +<strong>See also:</strong> +</p> +<ul> +<li> +<code class="directive"><a href="#loglevel" class="directive">LogLevel</a></code> +</li> +<li> +<a href="../logs.html">Apache Log Files</a> +</li> +</ul> +<hr> +<h2> +<a name="FileETag">FileETag</a> <a name="fileetag">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Configures the file attributes used to create the ETag +HTTP response header</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>FileETag <em>component</em> ...</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td> +</tr> +<tr> +<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p> + The <code class="directive">FileETag</code> directive configures the file + attributes that are used to create the ETag (entity tag) response + header field when the document is based on a file. (The ETag + value is used in cache management to save network bandwidth.) In + Apache 1.3.22 and earlier, the ETag value was <em>always</em> formed + from the file's inode, size, and last-modified time (mtime). The + FileETag directive allows you to choose which of these -- if any + -- should be used. The recognized keywords are: </p> - <dl compact="compact"> - <dt><b>INode</b></dt> - <dd>The file's i-node number will be included in the calculation</dd> - <dt><b>MTime</b></dt> - <dd>The date and time the file was last modified will be included</dd> - <dt><b>Size</b></dt> - <dd>The number of bytes in the file will be included</dd> - <dt><b>All</b></dt> - <dd>All available fields will be used (equivalent to + +<dl compact="compact"> + +<dt> +<b>INode</b> +</dt> + +<dd>The file's i-node number will be included in the calculation</dd> + +<dt> +<b>MTime</b> +</dt> + +<dd>The date and time the file was last modified will be included</dd> + +<dt> +<b>Size</b> +</dt> + +<dd>The number of bytes in the file will be included</dd> + +<dt> +<b>All</b> +</dt> + +<dd>All available fields will be used (equivalent to '<code>FileETag INode MTime Size</code>')</dd> - <dt><b>None</b></dt> - <dd>If a document is file-based, no ETag field will be included in the + +<dt> +<b>None</b> +</dt> + +<dd>If a document is file-based, no ETag field will be included in the response</dd> - </dl> - <p> + +</dl> + +<p> The INode, MTime, and Size keywords may be prefixed with either '+' or '-', which allow changes to be made to the default setting inherited from a broader scope. Any keyword appearing without such a prefix immediately and completely cancels the inherited setting. </p> - <p> + +<p> If a directory's configuration includes '<code>FileETag INode MTime Size</code>', and a subdirectory's includes '<code>FileETag -INode</code>', the setting for that subdirectory (which will be inherited by any sub-subdirectories that don't override it) will be equivalent to - '<code>FileETag MTime Size</code>'. + '<code>FileETag MTime Size</code>'. </p> - <hr /> - - <h2><a id="files" name="files"><Files> directive</a></h2> - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> <Files - <em>filename</em>> ... </Files><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config, virtual - host, .htaccess<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> only available - in Apache 1.2 and above. - - <p>The <Files> directive provides for access control by - filename. It is comparable to the <a - href="#directory"><Directory></a> directive and <a - href="#location"><Location></a> directives. It should be - matched with a </Files> directive. The directives given - within this section will be applied to any object with a - basename (last component of filename) matching the specified - filename. <code><Files></code> sections are processed in - the order they appear in the configuration file, after the - <Directory> sections and <code>.htaccess</code> files are - read, but before <Location> sections. Note that - <Files> can be nested inside <Directory> sections - to restrict the portion of the filesystem they apply to.</p> - - <p>The <em>filename</em> argument should include a filename, or + +</usage> +<hr> +<h2> +<a name="Files"><Files></a> <a name="files">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Contains that directives that apply to matched +filenames</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax><Files <em>filename</em>> ... </Files></syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>The <code class="directive"><Files></code> directive + provides for access control by filename. It is comparable to the + <code class="directive"><a href="#directory" class="directive">Directory</a></code> + directive and <code class="directive"><a href="#location" class="directive">Location</a></code> directives. It should be + matched with a <code></Files></code> directive. The + directives given within this section will be applied to any object + with a basename (last component of filename) matching the + specified filename. <code class="directive"><Files></code> + sections are processed in the order they appear in the + configuration file, after the <code class="directive"><a href="#directory" class="directive"><Directory></a></code> sections and + <code>.htaccess</code> files are read, but before <code class="directive"><a href="#location" class="directive"><Location></a></code> sections. Note + that <code class="directive"><Files></code> can be nested + inside <code class="directive"><a href="#directory" class="directive"><Directory></a></code> sections to restrict the + portion of the filesystem they apply to.</p> + + +<p>The <em>filename</em> argument should include a filename, or a wild-card string, where `?' matches any single character, and `*' matches any sequences of characters. Extended regular expressions can also be used, with the addition of the <code>~</code> character. For example:</p> -<pre> + +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code> <Files ~ "\.(gif|jpe?g|png)$"> -</pre> - would match most common Internet graphics formats. In Apache - 1.3 and later, <a href="#filesmatch"><FilesMatch></a> is - preferred, however. - - <p>Note that unlike <a - href="#directory"><code><Directory></code></a> and <a - href="#location"><code><Location></code></a> sections, - <code><Files></code> sections can be used inside - .htaccess files. This allows users to control access to their - own files, at a file-by-file level.</p> - - <p><strong>See also</strong>: <a href="../sections.html">How +</code></td> +</tr> +</table> +</blockquote> + +<p>would match most common Internet graphics formats. In Apache 1.3 + and later, <code class="directive"><a href="#filesmatch" class="directive"><FilesMatch></a></code> is preferred, however.</p> + + +<p>Note that unlike <code class="directive"><a href="#directory" class="directive"><Directory></a></code> and <code class="directive"><a href="#location" class="directive"><Location></a></code> sections, <code class="directive"><Files></code> sections can be used inside + .htaccess files. This allows users to control access to their own + files, at a file-by-file level.</p> + + +</usage> +<p> +<strong>See also:</strong> +</p> +<ul> +<li> +<a href="../sections.html">How Directory, Location and Files sections work</a> for an explanation of how these different sections are combined when a - request is received</p> - <hr /> - - <h2><a id="filesmatch" - name="filesmatch"><FilesMatch></a></h2> - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> <FilesMatch - <em>regex</em>> ... </FilesMatch><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config, virtual - host, .htaccess<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> only available - in Apache 1.3 and above. - - <p>The <FilesMatch> directive provides for access control - by filename, just as the <a href="#files"><Files></a> - directive does. However, it accepts a regular expression. For - example:</p> -<pre> + request is received</li> +</ul> +<hr> +<h2> +<a name="FilesMatch"><FilesMatch></a> <a name="filesmatch">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Contains that directives that apply to regular-expression matched +filenames</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax><FilesMatch <em>regex</em>> ... </FilesMatch></syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>The <code class="directive"><FilesMatch></code> directive + provides for access control by filename, just as the <code class="directive"><a href="#files" class="directive"><Files></a></code> directive + does. However, it accepts a regular expression. For example:</p> + +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code> <FilesMatch "\.(gif|jpe?g|png)$"> -</pre> +</code></td> +</tr> +</table> +</blockquote> - <p>would match most common Internet graphics formats.</p> - <strong>See also</strong>: <a href="../sections.html">How + +<p>would match most common Internet graphics formats.</p> + +</usage> +<p> +<strong>See also:</strong> +</p> +<ul> +<li> +<a href="../sections.html">How Directory, Location and Files sections work</a> for an explanation of how these different sections are combined when a - request is received - <hr /> - - <h2><a id="forcetype" name="forcetype">ForceType</a> - directive</h2> - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> ForceType - <em>mime-type</em><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> directory, - .htaccess<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> Base<br /> - <a href="directive-dict.html#Module" - rel="Help"><strong>Module:</strong></a> core<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> ForceType was - introduced in mod_mime with Apache 1.1, and moved to the core - in Apache 2.0. - - <p>When placed into an <code>.htaccess</code> file or a - <code><Directory></code>, or - <code><Location></code> or or <code><Files></code> + request is received</li> +</ul> +<hr> +<h2> +<a name="ForceType">ForceType</a> <a name="forcetype">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Forces all matching files to be served with the specified +MIME content-type</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>ForceType <em>mime-type</em> +</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Moved to the core in Apache 2.0</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>When placed into an <code>.htaccess</code> file or a + <code class="directive"><a href="#directory" class="directive"><Directory></a></code>, or + <code class="directive"><a href="#location" class="directive"><Location></a></code> or + <code class="directive"><a href="#files" class="directive"><Files></a></code> section, this directive forces all matching files to be served with the content type identification given by <em>mime-type</em>. For example, if you had a directory full of GIF files, but did not want to label them all with ".gif", you might want to use:</p> -<pre> + +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code> ForceType image/gif -</pre> +</code></td> +</tr> +</table> +</blockquote> - <p>Note that unlike <a href="#defaulttype">DefaultType</a>, + +<p>Note that unlike <code class="directive"><a href="#defaulttype" class="directive">DefaultType</a></code>, this directive overrides all mime-type associations, including filename extensions, that might identify the media type.</p> - <hr /> - - <h2><a id="hostnamelookups" - name="hostnamelookups">HostnameLookups directive</a></h2> - - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> HostnameLookups - on|off|double<br /> - <a href="directive-dict.html#Default" - rel="Help"><strong>Default:</strong></a> <code>HostnameLookups - off</code><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config, virtual - host, directory<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> - <code>double</code> available only in Apache 1.3 and - above.<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> Default was - <code>on</code> prior to Apache 1.3. - - <p>This directive enables DNS lookups so that host names can be + +</usage> +<hr> +<h2> +<a name="HostnameLookups">HostnameLookups</a> <a name="hostnamelookups">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Enables DNS lookups on client IP addresses</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>HostnameLookups on|off|double</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>HostnameLookups off</code></td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>This directive enables DNS lookups so that host names can be logged (and passed to CGIs/SSIs in <code>REMOTE_HOST</code>). The value <code>double</code> refers to doing double-reverse DNS. That is, after a reverse lookup is performed, a forward @@ -1106,108 +1781,163 @@ address. (In "tcpwrappers" terminology this is called <code>PARANOID</code>.)</p> - <p>Regardless of the setting, when <a - href="mod_access.html">mod_access</a> is used for controlling - access by hostname, a double reverse lookup will be performed. - This is necessary for security. Note that the result of this - double-reverse isn't generally available unless you set - <code>HostnameLookups double</code>. For example, if only - <code>HostnameLookups on</code> and a request is made to an - object that is protected by hostname restrictions, regardless - of whether the double-reverse fails or not, CGIs will still be - passed the single-reverse result in - <code>REMOTE_HOST</code>.</p> - - <p>The default for this directive was previously - <code>on</code> in versions of Apache prior to 1.3. It was - changed to <code>off</code> in order to save the network + +<p>Regardless of the setting, when <code><a href="mod_access.html">mod_access</a></code> is + used for controlling access by hostname, a double reverse lookup + will be performed. This is necessary for security. Note that the + result of this double-reverse isn't generally available unless you + set <code>HostnameLookups double</code>. For example, if only + <code>HostnameLookups on</code> and a request is made to an object + that is protected by hostname restrictions, regardless of whether + the double-reverse fails or not, CGIs will still be passed the + single-reverse result in <code>REMOTE_HOST</code>.</p> + + +<p>The default is off in order to save the network traffic for those sites that don't truly need the reverse lookups done. It is also better for the end users because they don't have to suffer the extra latency that a lookup entails. Heavily loaded sites should leave this directive <code>off</code>, since DNS lookups can take considerable - amounts of time. The utility <a - href="../programs/logresolve.html">logresolve</a>, provided in + amounts of time. The utility <a href="../programs/logresolve.html">logresolve</a>, provided in the <em>/support</em> directory, can be used to look up host names from logged IP addresses offline.</p> - <hr /> - - <h2><a id="identitycheck" name="identitycheck">IdentityCheck - directive</a></h2> - - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> IdentityCheck - on|off<br /> - <a href="directive-dict.html#Default" - rel="Help"><strong>Default:</strong></a> <code>IdentityCheck - off</code><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config, virtual - host, directory<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core - - <p>This directive enables RFC1413-compliant logging of the + +</usage> +<hr> +<h2> +<a name="IdentityCheck">IdentityCheck</a> <a name="identitycheck">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Enables logging of the RFC1413 identity of the remote +user</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>IdentityCheck on|off</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>IdentityCheck off</code></td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td></td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>This directive enables RFC1413-compliant logging of the remote user name for each connection, where the client machine runs identd or something similar. This information is logged in - the access log. <em>Boolean</em> is either <code>on</code> or - <code>off</code>.</p> + the access log.</p> - <p>The information should not be trusted in any way except for + +<p>The information should not be trusted in any way except for rudimentary usage tracking.</p> - <p>Note that this can cause serious latency problems accessing + +<p>Note that this can cause serious latency problems accessing your server since every request requires one of these lookups to be performed. When firewalls are involved each lookup might possibly fail and add 30 seconds of latency to each hit. So in general this is not very useful on public servers accessible from the Internet.</p> - <hr /> - - <h2><a id="ifdefine" name="ifdefine"><IfDefine> - directive</a></h2> - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> <IfDefine - [!]<em>parameter-name</em>> <em>...</em> - </IfDefine><br /> - <a href="directive-dict.html#Default" - rel="Help"><strong>Default:</strong></a> None<br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> all<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> Core<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> <IfDefine> - is only available in 1.3.1 and later. - - <p>The <IfDefine <em>test</em>>...</IfDefine> - section is used to mark directives that are conditional. The - directives within an IfDefine section are only processed if the - <em>test</em> is true. If <em>test</em> is false, everything - between the start and end markers is ignored.</p> - - <p>The <em>test</em> in the <IfDefine> section directive - can be one of two forms:</p> - - <ul> - <li><em>parameter-name</em></li> - - <li><code>!</code><em>parameter-name</em></li> - </ul> - - <p>In the former case, the directives between the start and end + +</usage> +<hr> +<h2> +<a name="IfDefine"><IfDefine></a> <a name="ifdefine">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Encloses directives that will be processed only +if a test is true at startup</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax><IfDefine [!]<em>parameter-name</em>> <em>...</em> + </IfDefine></syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>The <code><IfDefine + <em>test</em>>...</IfDefine></code> section is used to + mark directives that are conditional. The directives within an + <code class="directive"><IfDefine></code> section are only + processed if the <em>test</em> is true. If <em>test</em> is false, + everything between the start and end markers is ignored.</p> + + +<p>The <em>test</em> in the <code class="directive"><IfDefine></code> section directive can be one + of two forms:</p> + + +<ul> + +<li> +<em>parameter-name</em> +</li> + + +<li> +<code>!</code><em>parameter-name</em> +</li> + +</ul> + + +<p>In the former case, the directives between the start and end markers are only processed if the parameter named <em>parameter-name</em> is defined. The second format reverses the test, and only processes the directives if <em>parameter-name</em> is <strong>not</strong> defined.</p> - <p>The <em>parameter-name</em> argument is a define as given on + +<p>The <em>parameter-name</em> argument is a define as given on the <code>httpd</code> command line via <code>-D</code><em>parameter-</em>, at the time the server was started.</p> - <p><IfDefine> sections are nest-able, which can be used - to implement simple multiple-parameter tests. Example:</p> + +<p> +<code class="directive"><IfDefine></code> sections are + nest-able, which can be used to implement simple + multiple-parameter tests. Example:</p> + +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code> <pre> $ httpd -DReverseProxy ... @@ -1217,132 +1947,241 @@ LoadModule proxy_module modules/libproxy.so </IfDefine> </pre> - <hr /> - - <h2><a id="ifmodule" name="ifmodule"><IfModule> - directive</a></h2> - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> <IfModule - [!]<em>module-name</em>> <em>...</em> - </IfModule><br /> - <a href="directive-dict.html#Default" - rel="Help"><strong>Default:</strong></a> None<br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> all<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> Core<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> IfModule is only - available in 1.2 and later. - - <p>The <IfModule <em>test</em>>...</IfModule> - section is used to mark directives that are conditional. The - directives within an IfModule section are only processed if the - <em>test</em> is true. If <em>test</em> is false, everything - between the start and end markers is ignored.</p> - - <p>The <em>test</em> in the <IfModule> section directive - can be one of two forms:</p> - - <ul> - <li><em>module name</em></li> - - <li>!<em>module name</em></li> - </ul> - - <p>In the former case, the directives between the start and end +</code></td> +</tr> +</table> +</blockquote> + + +</usage> +<hr> +<h2> +<a name="IfModule"><IfModule></a> <a name="ifmodule">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Encloses directives that are processed conditional on the +presence of absence of a specific module</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax><IfModule [!]<em>module-name</em>> <em>...</em> + </IfModule></syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>The <code><IfModule + <em>test</em>>...</IfModule></code> section is used to + mark directives that are conditional. The directives within an + <code class="directive"><IfModule></code> section are only + processed if the <em>test</em> is true. If <em>test</em> is false, + everything between the start and end markers is ignored.</p> + + +<p>The <em>test</em> in the <code class="directive"><IfModule></code> section directive can be one + of two forms:</p> + + +<ul> + +<li> +<em>module name</em> +</li> + + +<li>!<em>module name</em> +</li> + +</ul> + + +<p>In the former case, the directives between the start and end markers are only processed if the module named <em>module name</em> is included in Apache -- either compiled in or - dynamically loaded using <a - href="mod_so.html#loadmodule">LoadModule</a>. The second format + dynamically loaded using <code class="directive"><a href="mod_so.html#loadmodule" class="directive">LoadModule</a></code>. The second format reverses the test, and only processes the directives if <em>module name</em> is <strong>not</strong> included.</p> - <p>The <em>module name</em> argument is the file name of the + +<p>The <em>module name</em> argument is the file name of the module, at the time it was compiled. For example, <code>mod_rewrite.c</code>.</p> - <p><IfModule> sections are nest-able, which can be used - to implement simple multiple-module tests.</p> - <hr /> - - <h2><a id="include" name="include">Include directive</a></h2> - <strong>Syntax:</strong> Include - <em>file-path</em>|<em>directory-path</em><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> Core<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> Include is only - available in Apache 1.3 and later. - - <p>This directive allows inclusion of other configuration files + +<p> +<code class="directive"><IfModule></code> sections are + nest-able, which can be used to implement simple multiple-module + tests.</p> + +</usage> +<hr> +<h2> +<a name="Include">Include</a> <a name="include">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Includes other configuration files from within +the server configuration files</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>Include <em>file-path</em>|<em>directory-path</em> +</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>This directive allows inclusion of other configuration files from within the server configuration files.</p> - <p>If <code>Include</code> points to a directory, rather than a + +<p>If <code class="directive">Include</code> points to a directory, rather than a file, Apache will read all files in that directory, and any subdirectory, and parse those as configuration files.</p> - <p>The file path specified may be a fully qualified path (i.e. + +<p>The file path specified may be a fully qualified path (i.e. starting with a slash), or may be relative to the - <code>ServerRoot</code> directory.</p> + <code class="directive"><a href="#serverroot" class="directive">ServerRoot</a></code> directory.</p> + + +<p>Examples:</p> - <p>Examples:</p> - <blockquote> - <code>Include /usr/local/apache/conf/ssl.conf<br /> +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code> + Include /usr/local/apache/conf/ssl.conf<br> Include /usr/local/apache/conf/vhosts/ - </code> - </blockquote> +</code></td> +</tr> +</table> +</blockquote> - <p>Or, providing paths relative to your <code>ServerRoot</code> + +<p>Or, providing paths relative to your <code>ServerRoot</code> directory:</p> - <blockquote> - <code>Include conf/ssl.conf<br /> + +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code> + Include conf/ssl.conf<br> Include conf/vhosts/ - </code> - </blockquote> +</code></td> +</tr> +</table> +</blockquote> - <p>Make sure that an included directory does not contain any stray + +<p>Make sure that an included directory does not contain any stray files, such as editor temporary files, for example, as Apache will attempt to read them in and use the contents as configuration directives, which may cause the server to fail on start up. Running <code>apachectl configtest</code> will give you a list of the files that are being processed during the configuration - check:<p> + check:</p> + - <pre> +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code> +<pre> root@host# apachectl configtest Processing config directory: /usr/local/apache/conf/vhosts Processing config file: /usr/local/apache/conf/vhosts/vhost1 Processing config file: /usr/local/apache/conf/vhosts/vhost2 Syntax OK - </pre> +</pre> +</code></td> +</tr> +</table> +</blockquote> - <p>This will help in verifying that you are getting only the files + +<p>This will help in verifying that you are getting only the files that you intended as part of your configuration.</p> - <p><strong>See also</strong>: <a - href="../programs/apachectl.html">apachectl</a></p> - - - <hr /> - - <h2><a id="keepalive" name="keepalive">KeepAlive - directive</a></h2> - <strong>Syntax:</strong> KeepAlive on/off<br /> - <strong>Default:</strong> <code>KeepAlive On</code><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> Core<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> KeepAlive is - only available in Apache 1.1 and later. - - <p>The Keep-Alive extension to HTTP/1.0 and the persistent +</usage> +<p> +<strong>See also:</strong> +</p> +<ul> +<li> +<a href="../programs/apachectl.html">apachectl</a> +</li> +</ul> +<hr> +<h2> +<a name="KeepAlive">KeepAlive</a> <a name="keepalive">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Turns on or off HTTP persistent connections.</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>KeepAlive on|off</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>KeepAlive On</code></td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>The Keep-Alive extension to HTTP/1.0 and the persistent connection feature of HTTP/1.1 provide long-lived HTTP sessions which allow multiple requests to be sent over the same TCP connection. In some cases this has been shown to result in an @@ -1350,7 +2189,8 @@ many images. To enable Keep-Alive connections in Apache 1.2 and later, set <code>KeepAlive On</code>.</p> - <p>For HTTP/1.0 clients, Keep-Alive connections will only be + +<p>For HTTP/1.0 clients, Keep-Alive connections will only be used if they are specifically requested by a client. In addition, a Keep-Alive connection with an HTTP/1.0 client can only be used when the length of the content is known in @@ -1362,853 +2202,1386 @@ encoding will be used in order to send content of unknown length over persistent connections.</p> - <p>See also <a - href="#maxkeepaliverequests">MaxKeepAliveRequests</a>.</p> - <hr /> - - <h2><a id="keepalivetimeout" - name="keepalivetimeout">KeepAliveTimeout directive</a></h2> - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> KeepAliveTimeout - <em>seconds</em><br /> - <a href="directive-dict.html#Default" - rel="Help"><strong>Default:</strong></a> <code>KeepAliveTimeout - 15</code><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> Core<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> KeepAliveTimeout - is only available in Apache 1.1 and later. - - <p>The number of seconds Apache will wait for a subsequent +</usage> +<p> +<strong>See also:</strong> +</p> +<ul> +<li> +<code class="directive"><a href="#maxkeepaliverequests" class="directive">MaxKeepAliveRequests</a></code> +</li> +</ul> +<hr> +<h2> +<a name="KeepAliveTimeout">KeepAliveTimeout</a> <a name="keepalivetimeout">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Sets the amount of time the server will wait for subsequent +requests on a persistent connection</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>KeepAliveTimeout <em>seconds</em> +</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>KeepAliveTimeout 15</code></td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>The number of seconds Apache will wait for a subsequent request before closing the connection. Once a request has been - received, the timeout value specified by the <a - href="#timeout"><code>Timeout</code></a> directive applies.</p> + received, the timeout value specified by the + <code class="directive"><a href="#timeout" class="directive">Timeout</a></code> directive applies.</p> - <p>Setting <code>KeepAliveTimeout</code> to a high value may - cause performance problems in heavily loaded servers. The + +<p>Setting <code class="directive">KeepAliveTimeout</code> to a high value + may cause performance problems in heavily loaded servers. The higher the timeout, the more server processes will be kept occupied waiting on connections with idle clients.</p> - <hr /> - <h2><a id="limit" name="limit"><Limit> directive</a></h2> - - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> <Limit - <em>method</em> [<em>method</em>] ... > ... - </Limit><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> any<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core - - <p>Access controls are normally effective for +</usage> +<hr> +<h2> +<a name="Limit"><Limit></a> <a name="limit">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Restrict access controls to only certain HTTP +methods</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax><Limit <em>method</em> [<em>method</em>] ... > ... + </Limit></syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>Access controls are normally effective for <strong>all</strong> access methods, and this is the usual desired behavior. <strong>In the general case, access control directives should not be placed within a - <code><limit></code> section.</strong></p> - - <p>The purpose of the <Limit> directive is to restrict - the effect of the access controls to the nominated HTTP - methods. For all other methods, the access restrictions that - are enclosed in the <Limit> bracket <strong>will have no - effect</strong>. The following example applies the access - control only to the methods POST, PUT, and DELETE, leaving all - other methods unprotected:</p> - - <blockquote> - <code><Limit POST PUT DELETE><br /> - Require valid-user<br /> + <code class="directive"><limit></code> section.</strong> +</p> + + +<p>The purpose of the <code class="directive"><Limit></code> + directive is to restrict the effect of the access controls to the + nominated HTTP methods. For all other methods, the access + restrictions that are enclosed in the <code><Limit></code> + bracket <strong>will have no effect</strong>. The following + example applies the access control only to the methods POST, PUT, + and DELETE, leaving all other methods unprotected:</p> + + +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code> + <code><Limit POST PUT DELETE><br> + Require valid-user<br> </Limit></code> - </blockquote> - The method names listed can be one or more of: GET, POST, PUT, +</code></td> +</tr> +</table> +</blockquote> + +<p>The method names listed can be one or more of: GET, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH, PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, and UNLOCK. <strong>The method name is case-sensitive.</strong> If GET is used it will also restrict - HEAD requests. - <hr /> - - <h2><a id="limitexcept" name="limitexcept"><LimitExcept> - directive</a></h2> - - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> <LimitExcept - <em>method</em> [<em>method</em>] ... > ... - </LimitExcept><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> any<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> Available in - Apache 1.3.5 and later - - <p><LimitExcept> and </LimitExcept> are used to - enclose a group of access control directives which will then - apply to any HTTP access method <strong>not</strong> listed in - the arguments; i.e., it is the opposite of a <a - href="#limit"><Limit></a> section and can be used to - control both standard and nonstandard/unrecognized methods. See - the documentation for <a href="#limit"><Limit></a> for - more details.</p> - <hr /> - - <h2><a id="limitrequestbody" - name="limitrequestbody">LimitRequestBody directive</a></h2> - - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> LimitRequestBody - <em>bytes</em><br /> - <a href="directive-dict.html#Default" - rel="Help"><strong>Default:</strong></a> <code>LimitRequestBody - 0</code><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config, virtual - host, directory, .htaccess<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> LimitRequestBody - is only available in Apache 1.3.2 and later. - - <p>This directive specifies the number of <em>bytes</em> from 0 + HEAD requests.</p> + +</usage> +<hr> +<h2> +<a name="LimitExcept"><LimitExcept></a> <a name="limitexcept">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Restrict access controls to all HTTP methods +except the named ones</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax><LimitExcept <em>method</em> [<em>method</em>] ... > ... + </LimitExcept></syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p> +<code class="directive"><LimitExcept></code> and + <code></LimitExcept></code> are used to enclose a group of + access control directives which will then apply to any HTTP access + method <strong>not</strong> listed in the arguments; i.e., it is + the opposite of a <code class="directive"><a href="#limit" class="directive"><Limit></a></code> section and can be used to control + both standard and nonstandard/unrecognized methods. See the + documentation for <code class="directive"><a href="#limit" class="directive"><Limit></a></code> for more details.</p> + +</usage> +<hr> +<h2> +<a name="LimitRequestBody">LimitRequestBody</a> <a name="limitrequestbody">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Restricts the total size of the HTTP request body sent +from the client</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>LimitRequestBody <em>bytes</em> +</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>LimitRequestBody 0</code></td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>This directive specifies the number of <em>bytes</em> from 0 (meaning unlimited) to 2147483647 (2GB) that are allowed in a request body. The default value is defined by the compile-time constant <code>DEFAULT_LIMIT_REQUEST_BODY</code> (0 as distributed).</p> - <p>The LimitRequestBody directive allows the user to set a - limit on the allowed size of an HTTP request message body - within the context in which the directive is given (server, - per-directory, per-file or per-location). If the client request - exceeds that limit, the server will return an error response - instead of servicing the request. The size of a normal request - message body will vary greatly depending on the nature of the - resource and the methods allowed on that resource. CGI scripts - typically use the message body for passing form information to - the server. Implementations of the PUT method will require a - value at least as large as any representation that the server - wishes to accept for that resource.</p> - - <p>This directive gives the server administrator greater + +<p>The <code class="directive">LimitRequestBody</code> directive allows + the user to set a limit on the allowed size of an HTTP request + message body within the context in which the directive is given + (server, per-directory, per-file or per-location). If the client + request exceeds that limit, the server will return an error + response instead of servicing the request. The size of a normal + request message body will vary greatly depending on the nature of + the resource and the methods allowed on that resource. CGI scripts + typically use the message body for passing form information to the + server. Implementations of the PUT method will require a value at + least as large as any representation that the server wishes to + accept for that resource.</p> + + +<p>This directive gives the server administrator greater control over abnormal client request behavior, which may be useful for avoiding some forms of denial-of-service attacks.</p> - <hr /> - - <h2><a id="limitrequestfields" - name="limitrequestfields">LimitRequestFields directive</a></h2> - - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> LimitRequestFields - <em>number</em><br /> - <a href="directive-dict.html#Default" - rel="Help"><strong>Default:</strong></a> - <code>LimitRequestFields 100</code><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> - LimitRequestFields is only available in Apache 1.3.2 and later. - - - <p><em>Number</em> is an integer from 0 (meaning unlimited) to + +</usage> +<hr> +<h2> +<a name="LimitRequestFields">LimitRequestFields</a> <a name="limitrequestfields">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Limits the number of HTTP request header fields that +will be accepted from the client</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>LimitRequestFields <em>number</em> +</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>LimitRequestFields 100</code></td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p> +<em>Number</em> is an integer from 0 (meaning unlimited) to 32767. The default value is defined by the compile-time constant <code>DEFAULT_LIMIT_REQUEST_FIELDS</code> (100 as distributed).</p> - <p>The LimitRequestFields directive allows the server - administrator to modify the limit on the number of request - header fields allowed in an HTTP request. A server needs this - value to be larger than the number of fields that a normal - client request might include. The number of request header - fields used by a client rarely exceeds 20, but this may vary - among different client implementations, often depending upon - the extent to which a user has configured their browser to - support detailed content negotiation. Optional HTTP extensions - are often expressed using request header fields.</p> - - <p>This directive gives the server administrator greater + +<p>The <code class="directive">LimitRequestFields</code> directive allows + the server administrator to modify the limit on the number of + request header fields allowed in an HTTP request. A server needs + this value to be larger than the number of fields that a normal + client request might include. The number of request header fields + used by a client rarely exceeds 20, but this may vary among + different client implementations, often depending upon the extent + to which a user has configured their browser to support detailed + content negotiation. Optional HTTP extensions are often expressed + using request header fields.</p> + + +<p>This directive gives the server administrator greater control over abnormal client request behavior, which may be useful for avoiding some forms of denial-of-service attacks. The value should be increased if normal clients see an error response from the server that indicates too many fields were sent in the request.</p> - <hr /> - - <h2><a id="limitrequestfieldsize" - name="limitrequestfieldsize">LimitRequestFieldsize - directive</a></h2> - - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> LimitRequestFieldsize - <em>bytes</em><br /> - <a href="directive-dict.html#Default" - rel="Help"><strong>Default:</strong></a> - <code>LimitRequestFieldsize 8190</code><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> - LimitRequestFieldsize is only available in Apache 1.3.2 and - later. - - <p>This directive specifies the number of <em>bytes</em> from 0 + +</usage> +<hr> +<h2> +<a name="LimitRequestFieldSize">LimitRequestFieldSize</a> <a name="limitrequestfieldsize">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Limits the size of the HTTP request header allowed from the +client</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>LimitRequestFieldsize <em>bytes</em> +</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>LimitRequestFieldsize 8190</code></td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>This directive specifies the number of <em>bytes</em> from 0 to the value of the compile-time constant <code>DEFAULT_LIMIT_REQUEST_FIELDSIZE</code> (8190 as distributed) that will be allowed in an HTTP request header.</p> - <p>The LimitRequestFieldsize directive allows the server - administrator to reduce the limit on the allowed size of an - HTTP request header field below the normal input buffer size - compiled with the server. A server needs this value to be large - enough to hold any one header field from a normal client + +<p>The <code class="directive">LimitRequestFieldsize</code> directive + allows the server administrator to reduce the limit on the allowed + size of an HTTP request header field below the normal input buffer + size compiled with the server. A server needs this value to be + large enough to hold any one header field from a normal client request. The size of a normal request header field will vary greatly among different client implementations, often depending upon the extent to which a user has configured their browser to support detailed content negotiation.</p> - <p>This directive gives the server administrator greater + +<p>This directive gives the server administrator greater control over abnormal client request behavior, which may be useful for avoiding some forms of denial-of-service attacks. Under normal conditions, the value should not be changed from the default.</p> - <hr /> - - <h2><a id="limitrequestline" - name="limitrequestline">LimitRequestLine directive</a></h2> - - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> LimitRequestLine - <em>bytes</em><br /> - <a href="directive-dict.html#Default" - rel="Help"><strong>Default:</strong></a> <code>LimitRequestLine - 8190</code><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> LimitRequestLine - is only available in Apache 1.3.2 and later. - - <p>This directive sets the number of <em>bytes</em> from 0 to + +</usage> +<hr> +<h2> +<a name="LimitRequestLine">LimitRequestLine</a> <a name="limitrequestline">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Limit the size of the HTTP request line that will be accepted +from the client</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>LimitRequestLine <em>bytes</em> +</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>LimitRequestLine 8190</code></td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>This directive sets the number of <em>bytes</em> from 0 to the value of the compile-time constant <code>DEFAULT_LIMIT_REQUEST_LINE</code> (8190 as distributed) that will be allowed on the HTTP request-line.</p> - <p>The LimitRequestLine directive allows the server - administrator to reduce the limit on the allowed size of a - client's HTTP request-line below the normal input buffer size - compiled with the server. Since the request-line consists of - the HTTP method, URI, and protocol version, the - LimitRequestLine directive places a restriction on the length - of a request-URI allowed for a request on the server. A server - needs this value to be large enough to hold any of its resource - names, including any information that might be passed in the - query part of a GET request.</p> - - <p>This directive gives the server administrator greater + +<p>The <code class="directive">LimitRequestLine</code> directive allows + the server administrator to reduce the limit on the allowed size + of a client's HTTP request-line below the normal input buffer size + compiled with the server. Since the request-line consists of the + HTTP method, URI, and protocol version, the + <code class="directive">LimitRequestLine</code> directive places a + restriction on the length of a request-URI allowed for a request + on the server. A server needs this value to be large enough to + hold any of its resource names, including any information that + might be passed in the query part of a GET request.</p> + + +<p>This directive gives the server administrator greater control over abnormal client request behavior, which may be useful for avoiding some forms of denial-of-service attacks. Under normal conditions, the value should not be changed from the default.</p> - <hr /> - - <h2><a id="limitxmlrequestbody" - name="limitxmlrequestbody">LimitXMLRequestBody - directive</a></h2> - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> LimitXMLRequestBody - <em>number</em><br /> - <a href="directive-dict.html#Default" - rel="Help"><strong>Default:</strong></a> - <code>LimitXMLRequestBody 1000000</code><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core<br /> - - <p>Limit (in bytes) on maximum size of an XML-based request +</usage> +<hr> +<h2> +<a name="LimitXMLRequestBody">LimitXMLRequestBody</a> <a name="limitxmlrequestbody">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Limits the size of an XML-based request body</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>LimitXMLRequestBody <em>number</em> +</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>LimitXMLRequestBody 1000000</code></td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>Limit (in bytes) on maximum size of an XML-based request body. A value of <code>0</code> will disable any checking.</p> - <hr /> - - <h2><a id="location" name="location"><Location> - directive</a></h2> - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> <Location - <em>URL-path</em>|<em>URL</em>> ... </Location><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config, virtual - host<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> Location is only - available in Apache 1.1 and later. - - <p>The <Location> directive provides for access control - by URL. It is similar to the <a - href="#directory"><Directory></a> directive, and starts a - subsection which is terminated with a </Location> - directive. <code><Location></code> sections are processed - in the order they appear in the configuration file, after the - <Directory> sections and <code>.htaccess</code> files are - read, and after the <Files> sections.</p> - - <p>Note that URLs do not have to line up with the filesystem at + +</usage> +<hr> +<h2> +<a name="Location"><Location></a> <a name="location">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Applies the enclosed directives only to matching +URLs</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax><Location + <em>URL-path</em>|<em>URL</em>> ... </Location></syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>The <code class="directive"><Location></code> directive + provides for access control by URL. It is similar to the + <code class="directive"><a href="#directory" class="directive"><Directory></a></code> + directive, and starts a subsection which is terminated with a + <code></Location></code> directive. <code class="directive"><Location></code> sections are processed in the + order they appear in the configuration file, after the <code class="directive"><a href="#directory" class="directive"><Directory></a></code> sections and + <code>.htaccess</code> files are read, and after the <code class="directive"><a href="#files" class="directive"><Files></a></code> sections.</p> + + +<p>Note that URLs do not have to line up with the filesystem at all, it should be emphasized that <Location> operates completely outside the filesystem.</p> - <p>For all origin (non-proxy) requests, the URL to be matched + +<p>For all origin (non-proxy) requests, the URL to be matched is of the form <code>/path/</code>, and you should not include any <code>http://servername</code> prefix. For proxy requests, the URL to be matched is of the form <code>scheme://servername/path</code>, and you must include the prefix.</p> - <p>The URL may use wildcards In a wild-card string, `?' matches + +<p>The URL may use wildcards In a wild-card string, `?' matches any single character, and `*' matches any sequences of characters.</p> - <p><strong>Apache 1.2 and above:</strong> Extended regular + +<p>Extended regular expressions can also be used, with the addition of the <code>~</code> character. For example:</p> -<pre> + +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code> <Location ~ "/(extra|special)/data"> -</pre> +</code></td> +</tr> +</table> +</blockquote> - <p>would match URLs that contained the substring "/extra/data" - or "/special/data". In Apache 1.3 and above, a new directive <a - href="#locationmatch"><LocationMatch></a> exists which - behaves identical to the regex version of - <code><Location></code>.</p> - - <p>The <code>Location</code> functionality is especially useful - when combined with the <code><a - href="mod_mime.html#sethandler">SetHandler</a></code> - directive. For example, to enable status requests, but allow - them only from browsers at foo.com, you might use:</p> -<pre> - <Location /status> - SetHandler server-status - Order Deny,Allow - Deny from all - Allow from .foo.com - </Location> -</pre> + +<p>would match URLs that contained the substring "/extra/data" or + "/special/data". In Apache 1.3 and above, a new directive + <code class="directive"><a href="#locationmatch" class="directive"><LocationMatch></a></code> + exists which behaves identical to the regex version of + <code class="directive"><Location></code>.</p> - <p><strong>Apache 1.3 and above note about / (slash)</strong>: - The slash character has special meaning depending on where in a - URL it appears. People may be used to its behavior in the - filesystem where multiple adjacent slashes are frequently - collapsed to a single slash (<em>i.e.</em>, - <code>/home///foo</code> is the same as - <code>/home/foo</code>). In URL-space this is not necessarily - true. The <code><LocationMatch></code> directive and the - regex version of <code><Location></code> require you to - explicitly specify multiple slashes if that is your intention. - For example, <code><LocationMatch ^/abc></code> would - match the request URL <code>/abc</code> but not the request URL - <code>//abc</code>. The (non-regex) - <code><Location></code> directive behaves similarly when - used for proxy requests. But when (non-regex) - <code><Location></code> is used for non-proxy requests it - will implicitly match multiple slashes with a single slash. For - example, if you specify <code><Location /abc/def></code> - and the request is to <code>/abc//def</code> then it will - match.</p> - - <p><strong>See also</strong>: <a href="../sections.html">How + +<p>The <code class="directive"><Location></code> + functionality is especially useful when combined with the + <code class="directive"><a href="#sethandler" class="directive">SetHandler</a></code> + directive. For example, to enable status requests, but allow them + only from browsers at foo.com, you might use:</p> + +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code> + <Location /status><br> + SetHandler server-status<br> + Order Deny,Allow<br> + Deny from all<br> + Allow from .foo.com<br> + </Location> +</code></td> +</tr> +</table> +</blockquote> + + +<blockquote> +<table> +<tr> +<td bgcolor="#e0e5f5"> +<p align="center"> +<strong>Note about / (slash)</strong> +</p> +<p>The slash character has +special meaning depending on where in a URL it appears. People may be +used to its behavior in the filesystem where multiple adjacent slashes +are frequently collapsed to a single slash (<em>i.e.</em>, +<code>/home///foo</code> is the same as <code>/home/foo</code>). In +URL-space this is not necessarily true. The <code class="directive"><a href="#locationmatch" class="directive"><LocationMatch></a></code> directive and the regex +version of <code class="directive"><Location></code> require you +to explicitly specify multiple slashes if that is your intention. For +example, <code><LocationMatch ^/abc></code> would match the +request URL <code>/abc</code> but not the request URL +<code>//abc</code>. The (non-regex) <code class="directive"><Location></code> directive behaves similarly when +used for proxy requests. But when (non-regex) <code class="directive"><Location></code> is used for non-proxy requests it +will implicitly match multiple slashes with a single slash. For +example, if you specify <code><Location /abc/def></code> and the +request is to <code>/abc//def</code> then it will match.</p> + +</td> +</tr> +</table> +</blockquote> + +</usage> +<p> +<strong>See also:</strong> +</p> +<ul> +<li> +<a href="../sections.html">How Directory, Location and Files sections work</a> for an explanation of how these different sections are combined when a - request is received</p> - <hr /> - - <h2><a id="locationmatch" - name="locationmatch"><LocationMatch></a></h2> - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> <LocationMatch - <em>regex</em>> ... </LocationMatch><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config, virtual - host<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> LocationMatch is - only available in Apache 1.3 and later. - - <p>The <LocationMatch> directive provides for access - control by URL, in an identical manner to <a - href="#location"><Location></a>. However, it takes a - regular expression as an argument instead of a simple string. - For example:</p> -<pre> + request is received</li> +</ul> +<hr> +<h2> +<a name="LocationMatch"><LocationMatch></a> <a name="locationmatch">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Applies the enclosed directives only to regular-expression +matching URLs</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax><LocationMatch + <em>regex</em>> ... </Location></syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>The <code class="directive"><LocationMatch></code> directive + provides for access control by URL, in an identical manner to + <code class="directive"><a href="#location" class="directive"><Location></a></code>. However, it takes a regular + expression as an argument instead of a simple string. For + example:</p> + +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code> <LocationMatch "/(extra|special)/data"> -</pre> +</code></td> +</tr> +</table> +</blockquote> - <p>would match URLs that contained the substring "/extra/data" + +<p>would match URLs that contained the substring "/extra/data" or "/special/data".</p> - <strong>See also</strong>: <a href="../sections.html">How + +</usage> +<p> +<strong>See also:</strong> +</p> +<ul> +<li> +<a href="../sections.html">How Directory, Location and Files sections work</a> for an explanation of how these different sections are combined when a - request is received - <hr /> - - <h2><a id="loglevel" name="loglevel">LogLevel - directive</a></h2> - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> LogLevel - <em>level</em><br /> - <a href="directive-dict.html#Default" - rel="Help"><strong>Default:</strong></a> <code>LogLevel - warn</code><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config, virtual - host<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> LogLevel is only - available in 1.3 or later. - - <p>LogLevel adjusts the verbosity of the messages recorded in - the error logs (see <a href="#errorlog">ErrorLog</a> - directive). The following <em>level</em>s are available, in - order of decreasing significance:</p> - - <table> - <tr> - <th align="LEFT"><strong>Level</strong> </th> + request is received</li> +</ul> +<hr> +<h2> +<a name="LogLevel">LogLevel</a> <a name="loglevel">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Controls the verbosity of the ErrorLog</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>LogLevel <em>level</em> +</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>LogLevel warn</code></td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p> +<code class="directive">LogLevel</code> adjusts the verbosity of the + messages recorded in the error logs (see <code class="directive"><a href="#errorlog" class="directive">ErrorLog</a></code> directive). The following + <em>level</em>s are available, in order of decreasing + significance:</p> + + +<table> + +<tr> + +<th align="LEFT"><strong>Level</strong> </th> <th align="LEFT"><strong>Description</strong> </th> - </tr> + +</tr> - <tr> - <th> + +<tr> + +<th> </th> <th align="LEFT"><strong>Example</strong> </th> - </tr> + +</tr> - <tr> - <td><code>emerg</code> </td> + +<tr> + +<td><code>emerg</code> </td> <td>Emergencies - system is unusable.</td> - </tr> + +</tr> - <tr> - <td> + +<tr> + +<td> </td> <td>"Child cannot open lock file. Exiting"</td> - </tr> + +</tr> - <tr> - <td><code>alert</code> </td> + +<tr> + +<td><code>alert</code> </td> <td>Action must be taken immediately.</td> - </tr> + +</tr> - <tr> - <td> + +<tr> + +<td> </td> <td>"getpwuid: couldn't determine user name from uid"</td> - </tr> + +</tr> - <tr> - <td><code>crit</code> </td> + +<tr> + +<td><code>crit</code> </td> <td>Critical Conditions.</td> - </tr> + +</tr> - <tr> - <td> + +<tr> + +<td> </td> <td>"socket: Failed to get a socket, exiting child"</td> - </tr> + +</tr> - <tr> - <td><code>error</code> </td> + +<tr> + +<td><code>error</code> </td> <td>Error conditions.</td> - </tr> + +</tr> - <tr> - <td> + +<tr> + +<td> </td> <td>"Premature end of script headers"</td> - </tr> + +</tr> - <tr> - <td><code>warn</code> </td> + +<tr> + +<td><code>warn</code> </td> <td>Warning conditions.</td> - </tr> + +</tr> - <tr> - <td> + +<tr> + +<td> </td> <td>"child process 1234 did not exit, sending another SIGHUP"</td> - </tr> + +</tr> - <tr> - <td><code>notice</code> </td> + +<tr> + +<td><code>notice</code> </td> <td>Normal but significant condition.</td> - </tr> + +</tr> - <tr> - <td> + +<tr> + +<td> </td> <td>"httpd: caught SIGBUS, attempting to dump core in ..."</td> - </tr> + +</tr> - <tr> - <td><code>info</code> </td> + +<tr> + +<td><code>info</code> </td> <td>Informational.</td> - </tr> + +</tr> - <tr> - <td> + +<tr> + +<td> </td> <td>"Server seems busy, (you may need to increase StartServers, or Min/MaxSpareServers)..."</td> - </tr> + +</tr> - <tr> - <td><code>debug</code> </td> + +<tr> + +<td><code>debug</code> </td> <td>Debug-level messages</td> - </tr> + +</tr> - <tr> - <td> + +<tr> + +<td> </td> <td>"Opening config file ..."</td> - </tr> - </table> + +</tr> + +</table> - <p>When a particular level is specified, messages from all + +<p>When a particular level is specified, messages from all other levels of higher significance will be reported as well. <em>E.g.</em>, when <code>LogLevel info</code> is specified, then messages with log levels of <code>notice</code> and <code>warn</code> will also be posted.</p> - <p>Using a level of at least <code>crit</code> is + +<p>Using a level of at least <code>crit</code> is recommended.</p> - <hr /> - - <h2><a id="maxkeepaliverequests" - name="maxkeepaliverequests">MaxKeepAliveRequests - directive</a></h2> - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> MaxKeepAliveRequests - <em>number</em><br /> - <a href="directive-dict.html#Default" - rel="Help"><strong>Default:</strong></a> - <code>MaxKeepAliveRequests 100</code><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> Only available - in Apache 1.2 and later. - - <p>The MaxKeepAliveRequests directive limits the number of - requests allowed per connection when <a - href="#keepalive">KeepAlive</a> is on. If it is set to - "<code>0</code>", unlimited requests will be allowed. We + +</usage> +<hr> +<h2> +<a name="MaxKeepAliveRequests">MaxKeepAliveRequests</a> <a name="maxkeepaliverequests">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Sets the number of requests allowed on a persistent +connection</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>MaxKeepAliveRequests <em>number</em> +</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>MaxKeepAliveRequests 100</code></td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>The <code class="directive">MaxKeepAliveRequests</code> directive + limits the number of requests allowed per connection when + <code class="directive"><a href="#keepalive" class="directive">KeepAlive</a></code> is on. If it is + set to "<code>0</code>", unlimited requests will be allowed. We recommend that this setting be kept to a high value for maximum server performance.</p> - <hr /> - - <h2><a id="namevirtualhost" - name="namevirtualhost">NameVirtualHost directive</a></h2> - - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> NameVirtualHost - <em>addr</em>[:<em>port</em>]<br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> NameVirtualHost - is only available in Apache 1.3 and later - - <p>The NameVirtualHost directive is a required directive if you - want to configure <a href="../vhosts/">name-based virtual - hosts</a>.</p> - - <p>Although <em>addr</em> can be hostname it is recommended - that you always use an IP address, <em>e.g.</em></p> - - <blockquote> - <code>NameVirtualHost 111.22.33.44</code> - </blockquote> - With the NameVirtualHost directive you specify the IP address - on which the server will receive requests for the name-based - virtual hosts. This will usually be the address to which your - name-based virtual host names resolve. In cases where a - firewall or other proxy receives the requests and forwards them - on a different IP address to the server, you must specify the - IP address of the physical interface on the machine which will - be servicing the requests. If you have multiple name-based - hosts on multiple addresses, repeat the directive for each - address. - - <p>Note: the "main server" and any _default_ servers will - <strong>never</strong> be served for a request to a - NameVirtualHost IP Address (unless for some reason you specify - NameVirtualHost but then don't define any VirtualHosts for that - address).</p> - <p>Optionally you can specify a port number on which the - name-based virtual hosts should be used, <em>e.g.</em></p> +</usage> +<hr> +<h2> +<a name="NameVirtualHost">NameVirtualHost</a> <a name="namevirtualhost">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Configures an IP address for name-virtual +hosting</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>NameVirtualHost <em>addr</em>[:<em>port</em>]</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>The <code class="directive">NameVirtualHost</code> directive is a + required directive if you want to configure <a href="../vhosts/">name-based virtual hosts</a>.</p> - <blockquote> - <code>NameVirtualHost 111.22.33.44:8080</code> - </blockquote> + +<p>Although <em>addr</em> can be hostname it is recommended + that you always use an IP address, <em>e.g.</em> +</p> - <p>IPv6 addresses must be enclosed in square brackets, as shown - in the following example:</p> - <blockquote> - <code>NameVirtualHost [fe80::a00:20ff:fea7:ccea]:8080</code> - </blockquote> +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code>NameVirtualHost 111.22.33.44</code></td> +</tr> +</table> +</blockquote> - <strong>See also:</strong> <a href="../vhosts/">Apache Virtual - Host documentation</a> - <hr /> + +<p>With the <code class="directive">NameVirtualHost</code> directive you + specify the IP address on which the server will receive requests + for the name-based virtual hosts. This will usually be the address + to which your name-based virtual host names resolve. In cases + where a firewall or other proxy receives the requests and forwards + them on a different IP address to the server, you must specify the + IP address of the physical interface on the machine which will be + servicing the requests. If you have multiple name-based hosts on + multiple addresses, repeat the directive for each address.</p> - <h2><a id="options" name="options">Options directive</a></h2> + +<p>Note: the "main server" and any _default_ servers will + <strong>never</strong> be served for a request to a + <code class="directive">NameVirtualHost</code> IP Address (unless for some + reason you specify <code class="directive">NameVirtualHost</code> but then + don't define any VirtualHosts for that address).</p> + + +<p>Optionally you can specify a port number on which the + name-based virtual hosts should be used, <em>e.g.</em> +</p> - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> Options - [+|-]<em>option</em> [[+|-]<em>option</em>] ...<br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config, virtual - host, directory, .htaccess<br /> - <a href="directive-dict.html#Override" - rel="Help"><strong>Override:</strong></a> Options<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core - <p>The Options directive controls which server features are - available in a particular directory.</p> +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code>NameVirtualHost 111.22.33.44:8080</code></td> +</tr> +</table> +</blockquote> + + +<p>IPv6 addresses must be enclosed in square brackets, as shown + in the following example:</p> + + +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code>NameVirtualHost [fe80::a00:20ff:fea7:ccea]:8080</code></td> +</tr> +</table> +</blockquote> + + +</usage> +<hr> +<h2> +<a name="Options">Options</a> <a name="options">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Configures what features are available in a particular +directory</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>Options + [+|-]<em>option</em> [[+|-]<em>option</em>] ...</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Options All</code></td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td> +</tr> +<tr> +<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Options</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>The <code class="directive">Options</code> directive controls which + server features are available in a particular directory.</p> - <p><em>option</em> can be set to <code>None</code>, in which + +<p> +<em>option</em> can be set to <code>None</code>, in which case none of the extra features are enabled, or one or more of the following:</p> - <dl> - <dt>All</dt> + +<dl> + +<dt>All</dt> - <dd>All options except for MultiViews. This is the default + +<dd>All options except for MultiViews. This is the default setting.</dd> - <dt>ExecCGI</dt> + +<dt>ExecCGI</dt> - <dd> + +<dd> Execution of CGI scripts is permitted.</dd> - <dt>FollowSymLinks</dt> + +<dt>FollowSymLinks</dt> - <dd> + +<dd> - The server will follow symbolic links in this - directory.<br /> - <strong>Note</strong>: even though the server follows the - symlink it does <em>not</em> change the pathname used to - match against <code><Directory></code> sections.<br /> - <strong>Note</strong>: this option gets ignored if set - inside a <Location> section.</dd> + The server will follow symbolic links in this directory.<br> + +<strong>Note</strong>: even though the server follows the + symlink it does <em>not</em> change the pathname used to match + against <code class="directive"><a href="#directory" class="directive"><Directory></a></code> sections.<br> + +<strong>Note</strong>: this option gets ignored if set inside a + <code class="directive"><a href="#location" class="directive"><Location></a></code> + section.</dd> - <dt>Includes</dt> + +<dt>Includes</dt> - <dd> + +<dd> Server-side includes are permitted.</dd> - <dt>IncludesNOEXEC</dt> + +<dt>IncludesNOEXEC</dt> - <dd> + +<dd> Server-side includes are permitted, but the #exec command and #exec CGI are disabled. It is still possible to #include virtual CGI scripts from ScriptAliase'd directories.</dd> - <dt>Indexes</dt> + +<dt>Indexes</dt> - <dd> + +<dd> If a URL which maps to a directory is requested, and the there is no DirectoryIndex (<em>e.g.</em>, index.html) in that directory, then the server will return a formatted listing of the directory.</dd> - <dt>MultiViews</dt> + +<dt>MultiViews</dt> - <dd> - <a href="../content-negotiation.html">Content negotiated</a> + +<dd> + +<a href="../content-negotiation.html">Content negotiated</a> MultiViews are allowed.</dd> - <dt>SymLinksIfOwnerMatch</dt> + +<dt>SymLinksIfOwnerMatch</dt> - <dd> + +<dd> - The server will only follow symbolic links for which the - target file or directory is owned by the same user id as the - link.<br /> - <strong>Note</strong>: this option gets ignored if set - inside a <Location> section.</dd> - </dl> - Normally, if multiple <code>Options</code> could apply to a + The server will only follow symbolic links for which the target + file or directory is owned by the same user id as the link.<br> +<strong>Note</strong>: this option gets ignored if set inside + a <code class="directive"><a href="#location" class="directive"><Location></a></code> + section.</dd> + +</dl> + +<p>Normally, if multiple <code class="directive">Options</code> could apply to a directory, then the most specific one is taken complete; the options are not merged. However if <em>all</em> the options on - the <code>Options</code> directive are preceded by a + or - + the <code class="directive">Options</code> directive are preceded by a + or - symbol, the options are merged. Any options preceded by a + are added to the options currently in force, and any options preceded by a - are removed from the options currently in - force. - - <p>For example, without any + and - symbols:</p> - - <blockquote> - <code><Directory /web/docs><br /> - Options Indexes FollowSymLinks<br /> - </Directory><br /> - <Directory /web/docs/spec><br /> - Options Includes<br /> - </Directory></code> - </blockquote> - then only <code>Includes</code> will be set for the - /web/docs/spec directory. However if the second - <code>Options</code> directive uses the + and - symbols: + force. </p> - <blockquote> - <code><Directory /web/docs><br /> - Options Indexes FollowSymLinks<br /> - </Directory><br /> - <Directory /web/docs/spec><br /> - Options +Includes -Indexes<br /> - </Directory></code> - </blockquote> - then the options <code>FollowSymLinks</code> and - <code>Includes</code> are set for the /web/docs/spec directory. + +<p>For example, without any + and - symbols:</p> + + + +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code><Directory /web/docs><br> + Options Indexes FollowSymLinks<br> + </Directory><br> + <Directory /web/docs/spec><br> + Options Includes<br> + </Directory> +</code></td> +</tr> +</table> +</blockquote> + +<p>then only <code>Includes</code> will be set for the + /web/docs/spec directory. However if the second + <code class="directive">Options</code> directive uses the + and - symbols:</p> + + +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code> + <Directory /web/docs><br> + Options Indexes FollowSymLinks<br> + </Directory><br> + <Directory /web/docs/spec><br> + Options +Includes -Indexes<br> + </Directory> +</code></td> +</tr> +</table> +</blockquote> + +<p>then the options <code>FollowSymLinks</code> and + <code>Includes</code> are set for the /web/docs/spec directory.</p> - <p><strong>Note:</strong> Using <code>-IncludesNOEXEC</code> or + +<p> +<strong>Note:</strong> Using <code>-IncludesNOEXEC</code> or <code>-Includes</code> disables server-side includes completely regardless of the previous setting.</p> - <p>The default in the absence of any other settings is + +<p>The default in the absence of any other settings is <code>All</code>.</p> - <hr /> - - <h2><a id="require" name="require">Require directive</a></h2> - - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> Require - <em>entity-name</em> [<em>entity-name</em>] ...<br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> directory, - .htaccess<br /> - <a href="directive-dict.html#Override" - rel="Help"><strong>Override:</strong></a> AuthConfig<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core - - <p>This directive selects which authenticated users can access + +</usage> +<hr> +<h2> +<a name="Require">Require</a> <a name="require">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Selects which authenticated users can access +a resource</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>Require <em>entity-name</em> [<em>entity-name</em>] ...</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td> +</tr> +<tr> +<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>This directive selects which authenticated users can access a directory. The allowed syntaxes are:</p> - <ul> - <li> + +<ul> + +<li> Require user <em>userid</em> [<em>userid</em>] ... <p>Only the named users can access the directory.</p> - </li> + +</li> - <li> + +<li> Require group <em>group-name</em> [<em>group-name</em>] ... <p>Only users in the named groups can access the directory.</p> - </li> + +</li> - <li> + +<li> Require valid-user <p>All valid users can access the directory.</p> - </li> - </ul> - - <p>Require must be accompanied by <a - href="#authname">AuthName</a> and <a - href="#authtype">AuthType</a> directives, and directives such - as <a href="mod_auth.html#authuserfile">AuthUserFile</a> and <a - href="mod_auth.html#authgroupfile">AuthGroupFile</a> (to define - users and groups) in order to work correctly. Example:</p> - - <blockquote> - <code>AuthType Basic<br /> - AuthName "Restricted Directory"<br /> - AuthUserFile /web/users<br /> - AuthGroupFile /web/groups<br /> - Require group admin<br /> - </code> - </blockquote> - Access controls which are applied in this way are effective for + +</li> + +</ul> + + +<p> +<code class="directive">Require</code> must be accompanied by + <code class="directive"><a href="#authname" class="directive">AuthName</a></code> and <code class="directive"><a href="#authtype" class="directive">AuthType</a></code> directives, and directives such + as <code class="directive"><a href="mod_auth.html#authuserfile" class="directive">AuthUserFile</a></code> + and <code class="directive"><a href="mod_auth.html#authgroupfile" class="directive">AuthGroupFile</a></code> (to + define users and groups) in order to work correctly. Example:</p> + + +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code> + AuthType Basic<br> + AuthName "Restricted Directory"<br> + AuthUserFile /web/users<br> + AuthGroupFile /web/groups<br> + Require group admin<br> + +</code></td> +</tr> +</table> +</blockquote> + + +<p>Access controls which are applied in this way are effective for <strong>all</strong> methods. <strong>This is what is normally desired.</strong> If you wish to apply access controls only to specific methods, while leaving other methods unprotected, then - place the <code>Require</code> statement into a <a - href="#limit"><Limit></a> section - - <p>See also <a href="#satisfy">Satisfy</a> and <a - href="mod_access.html">mod_access</a>.</p> - <hr /> - - <h2><a id="rlimit" name="rlimit">RLimitCPU</a> <a - id="rlimitcpu" name="rlimitcpu">directive</a></h2> - - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> RLimitCPU - <em>number</em>|max [<em>number</em>|max] <br /> - <a href="directive-dict.html#Default" - rel="Help"><strong>Default:</strong></a> <em>Unset; uses - operating system defaults</em> <br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config, virtual - host<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> RLimitCPU is - only available in Apache 1.2 and later. Moved in version 2.0 to - the <a href="../mpm.html">MPMs</a>. - - <p>Takes 1 or 2 parameters. The first parameter sets the soft + place the <code class="directive">Require</code> statement into a + <code class="directive"><a href="#limit" class="directive"><Limit></a></code> + section.</p> + +</usage> +<p> +<strong>See also:</strong> +</p> +<ul> +<li> +<code class="directive"><a href="#satisfy" class="directive">Satisfy</a></code> +</li> +<li> +<code><a href="mod_access.html">mod_access</a></code> +</li> +</ul> +<hr> +<h2> +<a name="RLimitCPU">RLimitCPU</a> <a name="rlimitcpu">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Limits the CPU consumption of processes launched +by Apache children</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>RLimitCPU <em>number</em>|max [<em>number</em>|max]</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Unset; uses operating system defaults</code></td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Moved in version 2.0 to + the MPMs</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>Takes 1 or 2 parameters. The first parameter sets the soft resource limit for all processes and the second parameter sets the maximum resource limit. Either parameter can be a number, or <em>max</em> to indicate to the server that the limit should @@ -2217,39 +3590,68 @@ the server is running as root, or in the initial startup phase.</p> - <p>This applies to processes forked off from Apache children + +<p>This applies to processes forked off from Apache children servicing requests, not the Apache children themselves. This includes CGI scripts and SSI exec commands, but not any processes forked off from the Apache parent such as piped logs.</p> - <p>CPU resource limits are expressed in seconds per + +<p>CPU resource limits are expressed in seconds per process.</p> - <p>See also <a href="#rlimitmem">RLimitMEM</a> or <a - href="#rlimitnproc">RLimitNPROC</a>.</p> - <hr /> - - <h2><a id="rlimitmem" name="rlimitmem">RLimitMEM - directive</a></h2> - - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> RLimitMEM - <em>number</em>|max [<em>number</em>|max]<br /> - <a href="directive-dict.html#Default" - rel="Help"><strong>Default:</strong></a> <em>Unset; uses - operating system defaults</em> <br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config, virtual - host<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> RLimitMEM is - only available in Apache 1.2 and later. Moved in version 2.0 to - the <a href="../mpm.html">MPMs</a>. - - <p>Takes 1 or 2 parameters. The first parameter sets the soft +</usage> +<p> +<strong>See also:</strong> +</p> +<ul> +<li> +<code class="directive"><a href="#rlimitmem" class="directive">RLimitMEM</a></code> +</li> +<li> +<code class="directive"><a href="#rlimitnproc" class="directive">RLimitNPROC</a></code> +</li> +</ul> +<hr> +<h2> +<a name="RLimitMEM">RLimitMEM</a> <a name="rlimitmem">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Limits the memory consumption of processes launched +by Apache children</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>RLimitMEM <em>number</em>|max [<em>number</em>|max]</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Unset; uses operating system defaults</code></td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Moved in version 2.0 to the MPMs.</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>Takes 1 or 2 parameters. The first parameter sets the soft resource limit for all processes and the second parameter sets the maximum resource limit. Either parameter can be a number, or <em>max</em> to indicate to the server that the limit should @@ -2258,39 +3660,68 @@ the server is running as root, or in the initial startup phase.</p> - <p>This applies to processes forked off from Apache children + +<p>This applies to processes forked off from Apache children servicing requests, not the Apache children themselves. This includes CGI scripts and SSI exec commands, but not any processes forked off from the Apache parent such as piped logs.</p> - <p>Memory resource limits are expressed in bytes per + +<p>Memory resource limits are expressed in bytes per process.</p> - <p>See also <a href="#rlimitcpu">RLimitCPU</a> or <a - href="#rlimitnproc">RLimitNPROC</a>.</p> - <hr /> - - <h2><a id="rlimitnproc" name="rlimitnproc">RLimitNPROC - directive</a></h2> - - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> RLimitNPROC - <em>number</em>|max [<em>number</em>|max]<br /> - <a href="directive-dict.html#Default" - rel="Help"><strong>Default:</strong></a> <em>Unset; uses - operating system defaults</em> <br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config, virtual - host<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> RLimitNPROC is - only available in Apache 1.2 and later. Moved in version 2.0 to - the <a href="../mpm.html">MPMs</a>. - - <p>Takes 1 or 2 parameters. The first parameter sets the soft +</usage> +<p> +<strong>See also:</strong> +</p> +<ul> +<li> +<code class="directive"><a href="#rlimitcpu" class="directive">RLimitCPU</a></code> +</li> +<li> +<code class="directive"><a href="#rlimitnproc" class="directive">RLimitNPROC</a></code> +</li> +</ul> +<hr> +<h2> +<a name="RLimitNPROC">RLimitNPROC</a> <a name="rlimitnproc">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Limits the number of processes that can be launched by +processes launched by Apache children</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>RLimitNPROC <em>number</em>|max [<em>number</em>|max]</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Unset; uses operating system defaults</code></td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Moved in version 2.0 to the MPMs.</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>Takes 1 or 2 parameters. The first parameter sets the soft resource limit for all processes and the second parameter sets the maximum resource limit. Either parameter can be a number, or <code>max</code> to indicate to the server that the limit @@ -2299,155 +3730,282 @@ the server is running as root, or in the initial startup phase.</p> - <p>This applies to processes forked off from Apache children + +<p>This applies to processes forked off from Apache children servicing requests, not the Apache children themselves. This includes CGI scripts and SSI exec commands, but not any processes forked off from the Apache parent such as piped logs.</p> - <p>Process limits control the number of processes per user.</p> + +<p>Process limits control the number of processes per user.</p> - <p>Note: If CGI processes are <strong>not</strong> running + +<p>Note: If CGI processes are <strong>not</strong> running under userids other than the web server userid, this directive will limit the number of processes that the server itself can create. Evidence of this situation will be indicated by <strong><em>cannot fork</em></strong> messages in the error_log.</p> - <p>See also <a href="#rlimitmem">RLimitMEM</a> or <a - href="#rlimitcpu">RLimitCPU</a>.</p> - <hr /> - - <h2><a id="satisfy" name="satisfy">Satisfy directive</a></h2> - - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> Satisfy any|all<br /> - <a href="directive-dict.html#Default" - rel="Help"><strong>Default:</strong></a> Satisfy all<br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> directory, - .htaccess<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> Satisfy is only - available in Apache 1.2 and later - - <p>Access policy if both <code>Allow</code> and - <code>Require</code> used. The parameter can be either - <em>'all'</em> or <em>'any'</em>. This directive is only useful - if access to a particular area is being restricted by both - username/password <em>and</em> client host address. In this - case the default behavior ("all") is to require that the client - passes the address access restriction <em>and</em> enters a - valid username and password. With the "any" option the client - will be granted access if they either pass the host restriction - or enter a valid username and password. This can be used to - password restrict an area, but to let clients from particular - addresses in without prompting for a password.</p> - - <p>See also <a href="#require">Require</a> and <a - href="mod_access.html">mod_access</a>.</p> - <hr /> - - <h2><a id="scriptinterpretersource" - name="scriptinterpretersource">ScriptInterpreterSource - directive</a></h2> - - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> ScriptInterpreterSource - registry|script<br /> - <a href="directive-dict.html#Default" - rel="Help"><strong>Default:</strong></a> - <code>ScriptInterpreterSource script</code> <br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> directory, - .htaccess<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core (Windows only) - - <p>This directive is used to control how Apache 1.3.5 and later - finds the interpreter used to run CGI scripts. The default - technique is to use the interpreter pointed to by the #! line - in the script. Setting ScriptInterpreterSource registry will +</usage> +<p> +<strong>See also:</strong> +</p> +<ul> +<li> +<code class="directive"><a href="#rlimitmem" class="directive">RLimitMEM</a></code> +</li> +<li> +<code class="directive"><a href="#rlimitcpu" class="directive">RLimitCPU</a></code> +</li> +</ul> +<hr> +<h2> +<a name="Satisfy">Satisfy</a> <a name="satisfy">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Configures how host-level access control and user authentication +interact</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>Satisfy any|all</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Satisfy all</code></td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>Access policy if both <code class="directive"><a href="#allow" class="directive">Allow</a></code> and <code class="directive"><a href="#require" class="directive">Require</a></code> used. The parameter can be + either <em>'all'</em> or <em>'any'</em>. This directive is only + useful if access to a particular area is being restricted by both + username/password <em>and</em> client host address. In this case + the default behavior ("all") is to require that the client passes + the address access restriction <em>and</em> enters a valid + username and password. With the "any" option the client will be + granted access if they either pass the host restriction or enter a + valid username and password. This can be used to password restrict + an area, but to let clients from particular addresses in without + prompting for a password.</p> + +</usage> +<hr> +<h2> +<a name="ScriptInterpreterSource">ScriptInterpreterSource</a> <a name="scriptinterpretersource">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Controls how the interpreter for CGI scripts is +located</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>ScriptInterpreterSource registry|script</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ScriptInterpreterSource script</code></td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Win32 only</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>This directive is used to control how Apache finds the + interpreter used to run CGI scripts. The default technique is to + use the interpreter pointed to by the #! line in the + script. Setting <code>ScriptInterpreterSource registry</code> will cause the Windows Registry to be searched using the script file extension (e.g., .pl) as a search key.</p> - <hr /> - - <h2><a id="serveradmin" name="serveradmin">ServerAdmin - directive</a></h2> - - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> ServerAdmin - <em>email-address</em><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config, virtual - host<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core - - <p>The ServerAdmin sets the e-mail address that the server - includes in any error messages it returns to the client.</p> - - <p>It may be worth setting up a dedicated address for this, - <em>e.g.</em></p> - - <blockquote> - <code>ServerAdmin www-admin@foo.bar.com</code> - </blockquote> - as users do not always mention that they are talking about the - server! - <hr /> - - <h2><a id="serveralias" name="serveralias">ServerAlias - directive</a></h2> - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> ServerAlias - <em>hostname</em> [<em>hostname</em>] ...<br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> virtual host<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> ServerAlias is - only available in Apache 1.1 and later. - - <p>The ServerAlias directive sets the alternate names for a - host, for use with <a - href="../vhosts/name-based.html">name-based virtual - hosts</a>.</p> - - <p>Example:</p> - - <pre> - <VirtualHost *> - ServerName server.domain.com - ServerAlias server server2.domain.com server2 - ... + +</usage> +<hr> +<h2> +<a name="ServerAdmin">ServerAdmin</a> <a name="serveradmin">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Sets the email address that the server includes in error +messages sent to the client</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>ServerAdmin <em>email-address</em> +</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>The <code class="directive">ServerAdmin</code> sets the e-mail address + that the server includes in any error messages it returns to the + client.</p> + + +<p>It may be worth setting up a dedicated address for this, + <em>e.g.</em> +</p> + +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code>ServerAdmin www-admin@foo.bar.com</code></td> +</tr> +</table> +</blockquote> + +<p>as users do not always mention that they are talking about the + server!</p> + +</usage> +<hr> +<h2> +<a name="ServerAlias">ServerAlias</a> <a name="serveralias">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Sets alternate names for a host used when matching requests +to name-virtual hosts</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>ServerAlias <em>hostname</em> [<em>hostname</em>] ...</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>virtual host</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>The <code class="directive">ServerAlias</code> directive sets the + alternate names for a host, for use with <a href="../vhosts/name-based.html">name-based virtual hosts</a>.</p> + + +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code> + <VirtualHost *><br> + ServerName server.domain.com<br> + ServerAlias server server2.domain.com server2<br> + ...<br> </VirtualHost> - </pre> - - <p><strong>See also:</strong> <a href="../vhosts/">Apache - Virtual Host documentation</a></p> - <hr /> - - <h2><a id="servername" name="servername">ServerName - directive</a></h2> - - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> ServerName - <em>fully-qualified-domain-name[:port]</em> <br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config, virtual - host<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> In version 2.0, this - directive supercedes the functionality of the <code>Port</code> - directive from version 1.3. - - <p>The <code>ServerName</code> directive sets the hostname and +</code></td> +</tr> +</table> +</blockquote> + +</usage> +<p> +<strong>See also:</strong> +</p> +<ul> +<li> +<a href="../vhosts/">Apache Virtual Host documentation</a> +</li> +</ul> +<hr> +<h2> +<a name="ServerName">ServerName</a> <a name="servername">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Sets the hostname and port that the server uses to identify +itself</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>ServerName <em>fully-qualified-domain-name[:port]</em> +</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>In version 2.0, this + directive supersedes the functionality of the Port + directive from version 1.3.</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>The <code class="directive">ServerName</code> directive sets the hostname and port that the server uses to identify itself. This is used when creating redirection URLs. For example, if the name of the machine hosting the webserver is <code>simple.example.com</code>, @@ -2455,348 +4013,606 @@ and you wish the webserver to be so identified, the following directive should be used:</p> - <blockquote> - <code>ServerName www.example.com:80</code> - </blockquote> - - <p>If no <code>ServerName</code> is specified, then the server attempts - to deduce the hostname by performing a reverse lookup on the IP - address. If no port is specified in the servername, then the - server will use the port from the incoming request. For optimal - reliability and predictability, you should specify an explict - hostname and port using the <code>ServerName</code> directive.</p> - - <p>If you are using <a - href="../vhosts/name-based.html">name-based virtual hosts</a>, - the <code>ServerName</code> inside a <a - href="#virtualhost"><code><VirtualHost></code></a> + +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code>ServerName www.example.com:80</code></td> +</tr> +</table> +</blockquote> + + +<p>If no <code class="directive">ServerName</code> is specified, then the + server attempts to deduce the hostname by performing a reverse + lookup on the IP address. If no port is specified in the + servername, then the server will use the port from the incoming + request. For optimal reliability and predictability, you should + specify an explicit hostname and port using the + <code class="directive">ServerName</code> directive.</p> + + +<p>If you are using <a href="../vhosts/name-based.html">name-based virtual hosts</a>, + the <code class="directive">ServerName</code> inside a + <code class="directive"><a href="#virtualhost" class="directive"><VirtualHost></a></code> section specifies what hostname must appear in the request's <code>Host:</code> header to match this virtual host.</p> - <p>See the description of the - <a href="#usecanonicalname">UseCanonicalName</a> directive for + +<p>See the description of the + <code class="directive"><a href="#usecanonicalname" class="directive">UseCanonicalName</a></code> directive for settings which determine whether self-referential URL's (e.g., by the - <a href="mod_dir.html">mod_dir</a> module) will refer to the + <code><a href="mod_dir.html">mod_dir</a></code> module) will refer to the specified port, or to the port number given in the client's request. </p> - <p><strong>See Also</strong>:<br /> - <a href="../dns-caveats.html">DNS Issues</a><br /> - <a href="../vhosts/">Apache virtual host - documentation</a><br /> - <a href="#usecanonicalname">UseCanonicalName</a><br /> - <a href="#namevirtualhost">NameVirtualHost</a><br /> - <a href="#serveralias">ServerAlias</a><br /> - </p> - <hr /> - - <h2><a id="serverpath" name="serverpath">ServerPath - directive</a></h2> - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> ServerPath - <em>directory-path</em><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> virtual host<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> ServerPath is - only available in Apache 1.1 and later. - - <p>The ServerPath directive sets the legacy URL pathname for a - host, for use with <a href="../vhosts/">name-based virtual - hosts</a>.</p> - - <p><strong>See also:</strong> <a href="../vhosts/">Apache - Virtual Host documentation</a></p> - <hr /> - - <h2><a id="serverroot" name="serverroot">ServerRoot - directive</a></h2> - - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> ServerRoot - <em>directory-path</em><br /> - <a href="directive-dict.html#Default" - rel="Help"><strong>Default:</strong></a> <code>ServerRoot - /usr/local/apache</code><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core - - <p>The ServerRoot directive sets the directory in which the - server lives. Typically it will contain the subdirectories - <code>conf/</code> and <code>logs/</code>. Relative paths for - other configuration files are taken as relative to this +</usage> +<p> +<strong>See also:</strong> +</p> +<ul> +<li> +<a href="../dns-caveats.html">DNS Issues</a> +</li> +<li> +<a href="../vhosts/">Apache virtual host + documentation</a> +</li> +<li> +<code class="directive"><a href="#usecanonicalname" class="directive">UseCanonicalName</a></code> +</li> +<li> +<code class="directive"><a href="#namevirtualhost" class="directive">NameVirtualHost</a></code> +</li> +<li> +<code class="directive"><a href="#serveralias" class="directive">ServerAlias</a></code> +</li> +</ul> +<hr> +<h2> +<a name="ServerPath">ServerPath</a> <a name="serverpath">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Sets the legacy URL pathname for a name-virtual host that +is accessed by an incompatible browser</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>ServerPath <em>directory-path</em> +</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>virtual host</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>The <code class="directive">ServerPath</code> directive sets the legacy + URL pathname for a host, for use with <a href="../vhosts/">name-based virtual hosts</a>.</p> + +</usage> +<p> +<strong>See also:</strong> +</p> +<ul> +<li> +<a href="../vhosts/">Apache Virtual Host documentation</a> +</li> +</ul> +<hr> +<h2> +<a name="ServerRoot">ServerRoot</a> <a name="serverroot">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Sets the base directory for the server installation</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>ServerRoot <em>directory-path</em> +</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ServerRoot /usr/local/apache</code></td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>The <code class="directive">ServerRoot</code> directive sets the + directory in which the server lives. Typically it will contain the + subdirectories <code>conf/</code> and <code>logs/</code>. Relative + paths for other configuration files are taken as relative to this directory.</p> - <p>See also <a href="../invoking.html">the <code>-d</code> - option to httpd</a>.</p> - - <p>See also <a href="../misc/security_tips.html#serverroot">the +</usage> +<p> +<strong>See also:</strong> +</p> +<ul> +<li> +<a href="../invoking.html">the <code>-d</code> + option to <code>httpd</code></a> +</li> +<li> +<a href="../misc/security_tips.html#serverroot">the security tips</a> for information on how to properly set - permissions on the ServerRoot.</p> - <hr /> - - <h2><a id="serversignature" - name="serversignature">ServerSignature directive</a></h2> - - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> ServerSignature - On|Off|EMail<br /> - <a href="directive-dict.html#Default" - rel="Help"><strong>Default:</strong></a> <code>ServerSignature - Off</code><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config, virtual - host, directory, .htaccess<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> ServerSignature - is only available in Apache 1.3 and later. - - <p>The ServerSignature directive allows the configuration of a - trailing footer line under server-generated documents (error - messages, mod_proxy ftp directory listings, mod_info output, - ...). The reason why you would want to enable such a footer - line is that in a chain of proxies, the user often has no - possibility to tell which of the chained servers actually - produced a returned error message.<br /> - The <samp>Off</samp> setting, which is the default, suppresses - the error line (and is therefore compatible with the behavior - of Apache-1.2 and below). The <samp>On</samp> setting simply - adds a line with the server version number and <a - href="#servername">ServerName</a> of the serving virtual host, + permissions on the ServerRoot</li> +</ul> +<hr> +<h2> +<a name="ServerSignature">ServerSignature</a> <a name="serversignature">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Configures the footer on server-generated documents</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>ServerSignature On|Off|EMail</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ServerSignature Off</code></td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>The <code class="directive">ServerSignature</code> directive allows the + configuration of a trailing footer line under server-generated + documents (error messages, mod_proxy ftp directory listings, + mod_info output, ...). The reason why you would want to enable + such a footer line is that in a chain of proxies, the user often + has no possibility to tell which of the chained servers actually + produced a returned error message.<br> The <samp>Off</samp> + setting, which is the default, suppresses the error line (and is + therefore compatible with the behavior of Apache-1.2 and + below). The <samp>On</samp> setting simply adds a line with the + server version number and <code class="directive"><a href="#servername" class="directive">ServerName</a></code> of the serving virtual host, and the <samp>EMail</samp> setting additionally creates a - "mailto:" reference to the <a - href="#serveradmin">ServerAdmin</a> of the referenced + "mailto:" reference to the <code class="directive"><a href="#serveradmin" class="directive">ServerAdmin</a></code> of the referenced document.</p> - <hr /> - - <h2><a id="servertokens" name="servertokens">ServerTokens - directive</a></h2> - - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> ServerTokens - Minimal|ProductOnly|OS|Full<br /> - <a href="directive-dict.html#Default" - rel="Help"><strong>Default:</strong></a> <code>ServerTokens - Full</code><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config <br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> ServerTokens is - only available in Apache 1.3 and later; the - <code>ProductOnly</code> keyword is only available in versions - later than 1.3.12 - - <p>This directive controls whether <samp>Server</samp> response + +</usage> +<hr> +<h2> +<a name="ServerTokens">ServerTokens</a> <a name="servertokens">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Configures the Server HTTP response header</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>ServerTokens Minimal|ProductOnly|OS|Full</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>ServerTokens Full</code></td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>This directive controls whether <samp>Server</samp> response header field which is sent back to clients includes a description of the generic OS-type of the server as well as information about compiled-in modules.</p> - <dl> - <dt><code>ServerTokens Prod[uctOnly]</code></dt> - - <dd>Server sends (<em>e.g.</em>): <samp>Server: - Apache</samp></dd> - - <dt><code>ServerTokens Min[imal]</code></dt> - - <dd>Server sends (<em>e.g.</em>): <samp>Server: - Apache/1.3.0</samp></dd> - - <dt><code>ServerTokens OS</code></dt> - - <dd>Server sends (<em>e.g.</em>): <samp>Server: Apache/1.3.0 - (Unix)</samp></dd> - - <dt><code>ServerTokens Full</code> (or not specified)</dt> - - <dd>Server sends (<em>e.g.</em>): <samp>Server: Apache/1.3.0 - (Unix) PHP/3.0 MyMod/1.2</samp></dd> - </dl> + +<dl> + +<dt> +<code>ServerTokens Prod[uctOnly]</code> +</dt> + + +<dd>Server sends (<em>e.g.</em>): <samp>Server: + Apache</samp> +</dd> + + +<dt> +<code>ServerTokens Min[imal]</code> +</dt> + + +<dd>Server sends (<em>e.g.</em>): <samp>Server: + Apache/1.3.0</samp> +</dd> + + +<dt> +<code>ServerTokens OS</code> +</dt> + + +<dd>Server sends (<em>e.g.</em>): <samp>Server: Apache/1.3.0 + (Unix)</samp> +</dd> + + +<dt> +<code>ServerTokens Full</code> (or not specified)</dt> + + +<dd>Server sends (<em>e.g.</em>): <samp>Server: Apache/1.3.0 + (Unix) PHP/3.0 MyMod/1.2</samp> +</dd> + +</dl> - <p>This setting applies to the entire server, and cannot be + +<p>This setting applies to the entire server, and cannot be enabled or disabled on a virtualhost-by-virtualhost basis.</p> - <hr /> - - <h2><a id="sethandler" name="sethandler">SetHandler</a> - directive</h2> - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> SetHandler - <em>handler-name</em><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> directory, files, - location, .htaccess<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> Base<br /> - <a href="directive-dict.html#Module" - rel="Help"><strong>Module:</strong></a> core<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> SetHandler was - introduced in mod_mime with Apache 1.1, and moved into the core - with Apache 2.0 - - <p>When placed into an <code>.htaccess</code> file or a - <code><Directory></code> or <code><Location></code> + +</usage> +<hr> +<h2> +<a name="SetHandler">SetHandler</a> <a name="sethandler">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Forces all matching files to be processed by a +handler</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>SetHandler <em>handler-name</em> +</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Compatibility" class="help">Compatibility:</a></td><td>Moved into the core in Apache 2.0</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>When placed into an <code>.htaccess</code> file or a + <code class="directive"><a href="#directory" class="directive"><Directory></a></code> or + <code class="directive"><a href="#location" class="directive"><Location></a></code> section, this directive forces all matching files to be parsed through the <a href="../handler.html">handler</a> given by <em>handler-name</em>. For example, if you had a directory you wanted to be parsed entirely as imagemap rule files, regardless of extension, you might put the following into an <code>.htaccess</code> file in that directory:</p> -<pre> + +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code> SetHandler imap-file -</pre> +</code></td> +</tr> +</table> +</blockquote> - <p>Another example: if you wanted to have the server display a + +<p>Another example: if you wanted to have the server display a status report whenever a URL of <code>http://servername/status</code> was called, you might put - the following into access.conf:</p> -<pre> - <Location /status> - SetHandler server-status + the following into httpd.conf:</p> + +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code> + <Location /status><br> + SetHandler server-status<br> </Location> -</pre> - <hr /> - - <h2><a id="setinputfilter" name="setinputfilter">SetInputFilter - directive</a></h2> - - <p><a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> SetInputFilter - <em>filter</em>[<em>;filter</em>...]<br /> - <a href="directive-dict.html#Default" - rel="Help"><strong>Default:</strong></a> none<br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> directory, files, - location, .htaccess<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core</p> - - <p>The <code>SetInputFilter</code> directive sets the filter or - filters which will process client requests and POST input when - they are received by the server. This is in addition to any - filters defined elsewhere, including the <a - href="mod_mime.html#addinputfilter">AddInputFilter</a> +</code></td> +</tr> +</table> +</blockquote> + +</usage> +<hr> +<h2> +<a name="SetInputFilter">SetInputFilter</a> <a name="setinputfilter">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Sets the filters that will process client requests and POST +input</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>SetInputFilter <em>filter</em>[<em>;filter</em>...]</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>The <code class="directive">SetInputFilter</code> directive sets the + filter or filters which will process client requests and POST + input when they are received by the server. This is in addition to + any filters defined elsewhere, including the + <code class="directive"><a href="mod_mime.html#addinputfilter" class="directive">AddInputFilter</a></code> directive.</p> - <p>If more than one filter is specified, they must be seperated + +<p>If more than one filter is specified, they must be separated by semicolons in the order in which they should process the content.</p> - <p>See also the <a href="../filter.html">Filters</a> - documentation.</p> - <hr /> - - <h2><a id="setoutputfilter" - name="setoutputfilter">SetOutputFilter directive</a></h2> - - <p><a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> SetOutputFilter - <em>filter</em> [<em>filter</em>] ...<br /> - <a href="directive-dict.html#Default" - rel="Help"><strong>Default:</strong></a> none<br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> directory, files, - location, .htaccess<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core</p> - - <p>The <code>SetOutputFilter</code> directive sets the filters +</usage> +<p> +<strong>See also:</strong> +</p> +<ul> +<li> +<a href="../filter.html">Filters</a> documentation</li> +</ul> +<hr> +<h2> +<a name="SetOutputFilter">SetOutputFilter</a> <a name="setoutputfilter">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Sets the filters that will process responses from the +server</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>SetOutputFilter <em>filter</em> [<em>filter</em>] ...</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>The <code class="directive">SetOutputFilter</code> directive sets the filters which will process responses from the server before they are sent to the client. This is in addition to any filters defined - elsewhere, including the <a - href="mod_mime.html#addoutputfilter">AddOutputFilter</a> + elsewhere, including the + <code class="directive"><a href="mod_mime.html#addoutputfilter" class="directive">AddOutputFilter</a></code> directive.</p> - For example, the following configuration will process all files - in the <code>/www/data/</code> directory for server-side - includes.<br /> - <br /> - - <blockquote> - <code><Directory /www/data/><br /> - SetOutputFilter INCLUDES<br /> - </Directory></code> - </blockquote> + +<p>For example, the following configuration will process all files + in the <code>/www/data/</code> directory for server-side + includes.</p> + +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code> +<Directory /www/data/><br> + SetOutputFilter INCLUDES<br> +</Directory> +</code></td> +</tr> +</table> +</blockquote> - <p>If more than one filter is specified, they must be seperated + +<p>If more than one filter is specified, they must be separated by semicolons in the order in which they should process the content.</p> - <p>See also the <a href="../filter.html">Filters</a> - documentation.</p> - <hr /> - - <h2><a id="timeout" name="timeout">TimeOut directive</a></h2> - - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> TimeOut - <em>number</em><br /> - <a href="directive-dict.html#Default" - rel="Help"><strong>Default:</strong></a> <code>TimeOut - 300</code><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> core - - <p>The TimeOut directive currently defines the amount of time - Apache will wait for three things:</p> +</usage> +<p> +<strong>See also:</strong> +</p> +<ul> +<li> +<a href="../filter.html">Filters</a> documentation</li> +</ul> +<hr> +<h2> +<a name="TimeOut">TimeOut</a> <a name="timeout">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Defines the amount of time the server will wait for +certain events before failing a request</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>TimeOut <em>number</em> +</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>TimeOut 300</code></td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>The <code class="directive">TimeOut</code> directive currently defines + the amount of time Apache will wait for three things:</p> - <ol> - <li>The total amount of time it takes to receive a GET + +<ol> + +<li>The total amount of time it takes to receive a GET request.</li> - <li>The amount of time between receipt of TCP packets on a + +<li>The amount of time between receipt of TCP packets on a POST or PUT request.</li> - <li>The amount of time between ACKs on transmissions of TCP + +<li>The amount of time between ACKs on transmissions of TCP packets in responses.</li> - </ol> - We plan on making these separately configurable at some point + +</ol> + + +<p>We plan on making these separately configurable at some point down the road. The timer used to default to 1200 before 1.2, but has been lowered to 300 which is still far more than necessary in most situations. It is not set any lower by default because there may still be odd places in the code where - the timer is not reset when a packet is sent. - <hr /> - - <h2><a id="usecanonicalname" - name="usecanonicalname">UseCanonicalName directive</a></h2> - - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> UseCanonicalName - on|off|dns<br /> - <a href="directive-dict.html#Default" - rel="Help"><strong>Default:</strong></a> <code>UseCanonicalName - on</code><br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config, virtual - host, directory<br /> - <a href="directive-dict.html#Override" - rel="Help"><strong>Override:</strong></a> Options<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> UseCanonicalName - is only available in Apache 1.3 and later - - <p>In many situations Apache has to construct a - <em>self-referential</em> URL. That is, a URL which refers back - to the same server. With <code>UseCanonicalName on</code> (and - in all versions prior to 1.3) Apache will use the hostname and - port specified in the <a href="#servername">ServerName</a> - directive to construct a canonical name for the server. This - name is used in all self-referential URLs, and for the values - of <code>SERVER_NAME</code> and <code>SERVER_PORT</code> in - CGIs.</p> - - <p>With <code>UseCanonicalName off</code> Apache will form + the timer is not reset when a packet is sent. </p> + +</usage> +<hr> +<h2> +<a name="UseCanonicalName">UseCanonicalName</a> <a name="usecanonicalname">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Configures how the server determines its own name and +port</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax>UseCanonicalName on|off|dns</syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>UseCanonicalName on</code></td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td> +</tr> +<tr> +<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Options</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p>In many situations Apache has to construct a + <em>self-referential</em> URL. That is, a URL which refers back to + the same server. With <code>UseCanonicalName on</code> Apache will + use the hostname and port specified in the <code class="directive"><a href="#servername" class="directive">ServerName</a></code> directive to construct a canonical + name for the server. This name is used in all self-referential + URLs, and for the values of <code>SERVER_NAME</code> and + <code>SERVER_PORT</code> in CGIs.</p> + + +<p>With <code>UseCanonicalName off</code> Apache will form self-referential URLs using the hostname and port supplied by the client if any are supplied (otherwise it will use the canonical name). These values are the same that are used to @@ -2806,7 +4622,8 @@ <code>SERVER_PORT</code> will be constructed from the client supplied values as well.</p> - <p>An example where this may be useful is on an intranet server + +<p>An example where this may be useful is on an intranet server where you have users connecting to the machine using short names such as <code>www</code>. You'll notice that if the users type a shortname, and a URL which is a directory, such as @@ -2816,135 +4633,195 @@ authentication enabled, this will cause the user to have to reauthenticate twice (once for <code>www</code> and once again for <code>www.domain.com</code>). But if - <code>UseCanonicalName</code> is set off, then Apache will + <code class="directive">UseCanonicalName</code> is set off, then Apache will redirect to <code>http://www/splat/</code>.</p> - <p>There is a third option, <code>UseCanonicalName DNS</code>, + +<p>There is a third option, <code>UseCanonicalName DNS</code>, which is intended for use with mass IP-based virtual hosting to support ancient clients that do not provide a <code>Host:</code> header. With this option Apache does a reverse DNS lookup on the server IP address that the client connected to in order to work out self-referential URLs.</p> - <p><strong>Warning:</strong> if CGIs make assumptions about the + +<p> +<strong>Warning:</strong> if CGIs make assumptions about the values of <code>SERVER_NAME</code> they may be broken by this option. The client is essentially free to give whatever value they want as a hostname. But if the CGI is only using <code>SERVER_NAME</code> to construct self-referential URLs then it should be just fine.</p> - <p><strong>See also:</strong> <a - href="#servername">ServerName</a>, <a - href="mpm_common.html#listen">Listen</a></p> - <hr /> +</usage> +<p> +<strong>See also:</strong> +</p> +<ul> +<li> +<code class="directive"><a href="#servername" class="directive">ServerName</a></code> +</li> +<li> +<code class="directive"><a href="mpm_common.html#listen" class="directive">Listen</a></code> +</li> +</ul> +<hr> +<h2> +<a name="VirtualHost"><VirtualHost></a> <a name="virtualhost">Directive</a> +</h2> +<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"> +<tr> +<td> +<table width="100%" bgcolor="#ffffff"> +<tr> +<td><strong>Description: </strong></td><td>Contains directives that apply only to a specific +hostname or IP address</td> +</tr> +<tr> +<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> +<syntax><VirtualHost + <em>addr</em>[:<em>port</em>] [<em>addr</em>[:<em>port</em>]] + ...> ... </VirtualHost></syntax> +</td> +</tr> +<tr> +<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config</td> +</tr> +<tr> +<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Core</td> +</tr> +<tr> +<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>core</td> +</tr> +</table> +</td> +</tr> +</table> +<usage> + +<p> +<code class="directive"><VirtualHost></code> and + <code></VirtualHost></code> are used to enclose a group of + directives which will apply only to a particular virtual host. Any + directive which is allowed in a virtual host context may be + used. When the server receives a request for a document on a + particular virtual host, it uses the configuration directives + enclosed in the <code class="directive"><VirtualHost></code> + section. <em>Addr</em> can be</p> - <h2><a id="virtualhost" name="virtualhost"><VirtualHost> - directive</a></h2> + +<ul> + +<li>The IP address of the virtual host</li> - <a href="directive-dict.html#Syntax" - rel="Help"><strong>Syntax:</strong></a> <VirtualHost - <em>addr</em>[:<em>port</em>] [<em>addr</em>[:<em>port</em>]] - ...> ... </VirtualHost> <br /> - <a href="directive-dict.html#Context" - rel="Help"><strong>Context:</strong></a> server config<br /> - <a href="directive-dict.html#Status" - rel="Help"><strong>Status:</strong></a> Core.<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> Non-IP - address-based Virtual Hosting only available in Apache 1.1 and - later.<br /> - <a href="directive-dict.html#Compatibility" - rel="Help"><strong>Compatibility:</strong></a> Multiple address - support only available in Apache 1.2 and later. - - <p><VirtualHost> and </VirtualHost> are used to - enclose a group of directives which will apply only to a - particular virtual host. Any directive which is allowed in a - virtual host context may be used. When the server receives a - request for a document on a particular virtual host, it uses - the configuration directives enclosed in the - <VirtualHost> section. <em>Addr</em> can be</p> - - <ul> - <li>The IP address of the virtual host</li> - - <li>A fully qualified domain name for the IP address of the + +<li>A fully qualified domain name for the IP address of the virtual host.</li> - </ul> + +</ul> Example: - <blockquote> - <code><VirtualHost 10.1.2.3><br /> - ServerAdmin webmaster@host.foo.com<br /> - DocumentRoot /www/docs/host.foo.com<br /> - ServerName host.foo.com<br /> - ErrorLog logs/host.foo.com-error_log<br /> - TransferLog logs/host.foo.com-access_log<br /> - </VirtualHost></code> - </blockquote> - - <p>IPv6 addresses must be specified in square brackets because - the optional port number could not be determined otherwise. An - IPv6 example is shown below:</p> - - <blockquote> - <code><VirtualHost [fe80::a00:20ff:fea7:ccea]><br /> - ServerAdmin webmaster@host.foo.com<br /> - DocumentRoot /www/docs/host.foo.com<br /> - ServerName host.foo.com<br /> - ErrorLog logs/host.foo.com-error_log<br /> - TransferLog logs/host.foo.com-access_log<br /> - </VirtualHost></code> - </blockquote> - - <p>Each VirtualHost must correspond to a different IP address, +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code><VirtualHost 10.1.2.3><br> + ServerAdmin webmaster@host.foo.com<br> + DocumentRoot /www/docs/host.foo.com<br> + ServerName host.foo.com<br> + ErrorLog logs/host.foo.com-error_log<br> + TransferLog logs/host.foo.com-access_log<br> + </VirtualHost> +</code></td> +</tr> +</table> +</blockquote> + + + +<p>IPv6 addresses must be specified in square brackets because + the optional port number could not be determined otherwise. An + IPv6 example is shown below:</p> + + +<blockquote> +<table cellpadding="10"> +<tr> +<td bgcolor="#eeeeee"><code> +<VirtualHost [fe80::a00:20ff:fea7:ccea]><br> + ServerAdmin webmaster@host.foo.com<br> + DocumentRoot /www/docs/host.foo.com<br> + ServerName host.foo.com<br> + ErrorLog logs/host.foo.com-error_log<br> + TransferLog logs/host.foo.com-access_log<br> + </VirtualHost> +</code></td> +</tr> +</table> +</blockquote> + + +<p>Each Virtual Host must correspond to a different IP address, different port number or a different host name for the server, in the former case the server machine must be configured to accept IP packets for multiple addresses. (If the machine does not have multiple network interfaces, then this can be accomplished with the <code>ifconfig alias</code> command (if - your OS supports it), or with kernel patches like <a - href="../misc/vif-info.html">VIF</a> (for SunOS(TM) 4.1.x)).</p> + your OS supports it), or with kernel patches like <a href="../misc/vif-info.html">VIF</a> (for SunOS(TM) 4.1.x)).</p> - <p>The special name <code>_default_</code> can be specified in + +<p>The special name <code>_default_</code> can be specified in which case this virtual host will match any IP address that is not explicitly listed in another virtual host. In the absence of any _default_ virtual host the "main" server config, consisting of all those definitions outside any VirtualHost section, is used when no match occurs.</p> - <p>You can specify a <code>:port</code> to change the port that - is matched. If unspecified then it defaults to the same port as - the most recent <code><a - href="mpm_common.html#listen">Listen</a></code> statement - of the main server. You may also specify <code>:*</code> to - match all ports on that address. (This is recommended when used + +<p>You can specify a <code>:port</code> to change the port that is + matched. If unspecified then it defaults to the same port as the + most recent <code class="directive"><a href="mpm_common.html#listen" class="directive">Listen</a></code> + statement of the main server. You may also specify <code>:*</code> + to match all ports on that address. (This is recommended when used with <code>_default_</code>.)</p> - <p><strong>SECURITY</strong>: See the <a - href="../misc/security_tips.html">security tips</a> document + +<p> +<strong>SECURITY</strong>: See the <a href="../misc/security_tips.html">security tips</a> document for details on why your security could be compromised if the directory where logfiles are stored is writable by anyone other than the user that starts the server.</p> - <p><strong>NOTE</strong>: The use of <VirtualHost> does - <strong>not</strong> affect what addresses Apache listens on. - You may need to ensure that Apache is listening on the correct - addresses using <a - href="mpm_common.html#listen">Listen</a>.</p> - - <p><strong>See also:</strong> <a href="../vhosts/">Apache - Virtual Host documentation</a><br /> - <strong>See also:</strong> <a - href="../dns-caveats.html">Warnings about DNS and - Apache</a><br /> - <strong>See also:</strong> <a href="../bind.html">Setting - which addresses and ports Apache uses</a><br /> - <strong>See also</strong>: <a href="../sections.html">How + +<p> +<strong>NOTE</strong>: The use of <code class="directive"><VirtualHost></code> does <strong>not</strong> + affect what addresses Apache listens on. You may need to ensure + that Apache is listening on the correct addresses using <code class="directive"><a href="mpm_common.html#listen" class="directive">Listen</a></code>.</p> + +</usage> +<p> +<strong>See also:</strong> +</p> +<ul> +<li> +<a href="../vhosts/">Apache Virtual Host documentation</a> +</li> +<li> +<a href="../dns-caveats.html">Warnings about DNS and + Apache</a> +</li> +<li> +<a href="../bind.html">Setting + which addresses and ports Apache uses</a> +</li> +<li> +<a href="../sections.html">How Directory, Location and Files sections work</a> for an explanation of how these different sections are combined when a - request is received</p> - <!--#include virtual="footer.html" --> - </body> + request is received</li> +</ul> +<hr> +<h3 align="center">Apache HTTP Server Version 2.0</h3> +<a href="./"><img alt="Index" src="../images/index.gif"></a><a href="../"><img alt="Home" src="../images/home.gif"></a> +</blockquote> +</body> </html> - |