manual/mod/core.html

	core.html revision 44afbb2bc1622ddf021058e2a157cfd31fb67fd0
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<HTML>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<HEAD>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<TITLE>Apache Core Features</TITLE>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen</HEAD>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<BODY>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<!--#include virtual="header.html" -->
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<H1>Apache Core Features</h1>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo SirainenThese configuration parameters control the core Apache features, and are
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainenalways available.
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen
d482b35af87f5fd872bad007da0475813a401a49Timo Sirainen<ul>
d482b35af87f5fd872bad007da0475813a401a49Timo Sirainen<li><A HREF="#accessconfig">AccessConfig</A>
d482b35af87f5fd872bad007da0475813a401a49Timo Sirainen<li><A HREF="#accessfilename">AccessFileName</A>
d482b35af87f5fd872bad007da0475813a401a49Timo Sirainen<li><A HREF="#addmodule">AddModule</A>
d482b35af87f5fd872bad007da0475813a401a49Timo Sirainen<li><A HREF="#allowoverride">AllowOverride</A>
d482b35af87f5fd872bad007da0475813a401a49Timo Sirainen<li><A HREF="#authname">AuthName</A>
d482b35af87f5fd872bad007da0475813a401a49Timo Sirainen<li><A HREF="#authtype">AuthType</A>
d482b35af87f5fd872bad007da0475813a401a49Timo Sirainen<li><A HREF="#bindaddress">BindAdress</A>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<li><A HREF="#clearmodulelist">ClearModuleList</A>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<li><A HREF="#defaulttype">DefaultType</A>
d482b35af87f5fd872bad007da0475813a401a49Timo Sirainen<li><A HREF="#directory">&lt;Directory&gt;</A>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<li><A HREF="#documentroot">DocumentRoot</A>
d482b35af87f5fd872bad007da0475813a401a49Timo Sirainen<li><A HREF="#errordocument">ErrorDocument</A>
d482b35af87f5fd872bad007da0475813a401a49Timo Sirainen<li><A HREF="#errorlog">ErrorLog</A>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<li><A HREF="#files">&lt;Files&gt;</A>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<li><A HREF="#group">Group</A>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<li><A HREF="#identitycheck">IdentityCheck</A>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<li><A HREF="#ifmodule">&lt;IfModule&gt;</A>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<li><A HREF="#keepalive">KeepAlive</A>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<li><A HREF="#keepalivetimeout">KeepAliveTimeout</A>
d482b35af87f5fd872bad007da0475813a401a49Timo Sirainen<li><A HREF="#limit">&lt;Limit&gt;</A>
d482b35af87f5fd872bad007da0475813a401a49Timo Sirainen<li><A HREF="#listen">Listen</A>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<li><A HREF="#location">&lt;Location&gt;</A>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<li><A HREF="#maxclients">MaxClients</A>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<li><A HREF="#maxrequestsperchild">MaxRequestsPerChild</A>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<li><A HREF="#maxspareservers">MaxSpareServers</A>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<li><A HREF="#minspareservers">MinSpareServers</A>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<li><A HREF="#options">Options</A>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<li><A HREF="#pidfile">PidFile</A>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<li><A HREF="#port">Port</A>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<li><A HREF="#require">require</A>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<li><A HREF="#resourceconfig">ResourceConfig</A>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<li><A HREF="#rlimitcpu">RLimitCPU</A>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<li><A HREF="#rlimitmem">RLimitMEM</A>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<li><A HREF="#rlimitnproc">RLimitNPROC</A>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<li><A HREF="#satisfy">Satisfy</A>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<li><A HREF="#sendbuffersize">SendBufferSize</A>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<li><A HREF="#serveradmin">ServerAdmin</A>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<li><A HREF="#serveralias">ServerAlias</A>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<li><A HREF="#servername">ServerName</A>
8603622835ec0566e49056ee839ef5992b48c46dTimo Sirainen<li><A HREF="#serverpath">ServerPath</A>
8603622835ec0566e49056ee839ef5992b48c46dTimo Sirainen<li><A HREF="#serverroot">ServerRoot</A>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<li><A HREF="#servertype">ServerType</A>
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainen<li><A HREF="#startservers">StartServers</A>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<li><A HREF="#timeout">TimeOut</A>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<li><A HREF="#user">User</A>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<li><A HREF="#virtualhost">&lt;VirtualHost&gt;</A>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen</ul>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<hr>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<A name="accessconfig"><h2>AccessConfig directive</h2></A>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<!--%plaintext &lt;?INDEX {\tt AccessConfig} directive&gt; -->
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<strong>Syntax:</strong> AccessConfig <em>filename</em><br>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<strong>Default:</strong> <code>AccessConfig conf/access.conf</code><br>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<strong>Context:</strong> server config, virtual host<br>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<strong>Status:</strong> core<p>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo SirainenThe server will read this file for more directives after reading the
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainen<A HREF="#resourceconfig">ResourceConfig</A> file. <em>Filename</em> is
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainenrelative to the <A HREF="#serverroot">ServerRoot</A>.
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo SirainenThis feature can be disabled using:
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainen<blockquote><code>AccessConfig /dev/null</code></blockquote>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo SirainenHistorically, this file only contained
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<A HREF="#directory">&lt;Directory&gt;</A> sections; in fact it can now
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainencontain any server directive allowed in the <em>server config</em> context.
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainen<p><hr>
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainen
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainen<A name="accessfilename"><h2>AccessFileName directive</h2></A>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<!--%plaintext &lt;?INDEX {\tt AccessFileName} directive&gt; -->
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<strong>Syntax:</strong> AccessFileName <em>filename</em><br>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<strong>Default:</strong> <code>AccessFileName .htaccess</code><br>
3b94ff5951db4d4eddb7a80ed4e3f61207202635Timo Sirainen<strong>Context:</strong> server config, virtual host<br>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<strong>Status:</strong> core<p>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo SirainenWhen returning a document to the client the server looks for an
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainenaccess control file with this name in every directory of the path to
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainenthe document, if access control files are enabled for that directory.
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo SirainenFor example:
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<blockquote><code>AccessFileName .acl</code></blockquote>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainenbefore returning the document /usr/local/web/index.html, the
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainenserver will read /.acl, /usr/.acl, /usr/local/.acl and /usr/local/web/.acl
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainenfor directives, unless they have been disabled with
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<blockquote><code>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen&lt;Directory /&gt;<br>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo SirainenAllowOverride None<br>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen&lt;/Directory&gt;</code></blockquote><p><hr>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<A name="addmodule"><h2>AddModule directive</h2></A>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<!--%plaintext &lt;?INDEX {\tt AddModule} directive&gt; -->
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<strong>Syntax:</strong> AddModule <em>module module ...</em><br>
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainen<strong>Context:</strong> server config <br>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<strong>Status:</strong> core<br>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<strong>Compatibility:</strong> AddModule is only available in Apache 1.2 and later<p>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo SirainenThe server can have modules compiled in which are not actively in use.
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo SirainenThis directive can be used to enable the use of those modules.  The
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainenserver comes with a pre-loaded list of active modules; this list can
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainenbe cleared with the <A HREF="#clearmodulelist">ClearModuleList</A>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainendirective.<p><hr>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<A name="allowoverride"><h2>AllowOverride directive</h2></A>
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainen<!--%plaintext &lt;?INDEX {\tt AllowOverride} directive&gt; -->
ace3c14e47a5a865df8aeea2fabc993b609dd163Timo Sirainen<strong>Syntax:</strong> AllowOverride <em>override override ...</em><br>
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainen<strong>Default:</strong> <code>AllowOverride All</code><br>
ace3c14e47a5a865df8aeea2fabc993b609dd163Timo Sirainen<strong>Context:</strong> directory<br>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<strong>Status:</strong> core<p>
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainen
ace3c14e47a5a865df8aeea2fabc993b609dd163Timo SirainenWhen the server finds an .htaccess file (as specified by
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainen<A HREF="#accessfilename">AccessFileName</A>) it needs to know which
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainendirectives declared in that file can override earlier access information.<p>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<em>Override</em> can be set to <code>None</code>, in which case the server
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainenwill not read the file, <code>All</code> in which case the server will
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainenallow all the directives, or one or more of the following:
3b94ff5951db4d4eddb7a80ed4e3f61207202635Timo Sirainen<dl>
ace3c14e47a5a865df8aeea2fabc993b609dd163Timo Sirainen<dt>AuthConfig
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<dd>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<!--%plaintext &lt;?INDEX {\tt AuthConfig} override&gt; -->
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo SirainenAllow use of the authorization directives
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen(<A HREF="mod_auth_dbm.html#authdbmgroupfile">AuthDBMGroupFile</A>,
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<A HREF="mod_auth_dbm.html#authdbmuserfile">AuthDBMUserFile</A>,
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<A HREF="mod_auth.html#authgroupfile">AuthGroupFile</A>,
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<A HREF="#authname">AuthName</A>, <A HREF="#authtype">AuthType</A>,
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<A HREF="mod_auth.html#authuserfile">AuthUserFile</A> and
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<A HREF="#require">require</A>).
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<dt>FileInfo
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainen<dd>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<!--%plaintext &lt;?INDEX {\tt FileInfo} override&gt; -->
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo SirainenAllow use of the directives controlling document types
d8b77aef97e89f1ccc5cbdaef77be9052279e35fTimo Sirainen(<A HREF="mod_mime.html#addencoding">AddEncoding</A>,
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainen<A HREF="mod_mime.html#addlanguage">AddLanguage</A>,
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainen<A HREF="mod_mime.html#addtype">AddType</A>,
659fe5d24825b160cae512538088020d97a60239Timo Sirainen<A HREF="#defaulttype">DefaultType</A> and
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<A HREF="mod_negotiation.html#languagepriority">LanguagePriority</A>).
659fe5d24825b160cae512538088020d97a60239Timo Sirainen<dt>Indexes
659fe5d24825b160cae512538088020d97a60239Timo Sirainen<dd>
659fe5d24825b160cae512538088020d97a60239Timo Sirainen<!--%plaintext &lt;?INDEX {\tt Indexes} override&gt; -->
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo SirainenAllow use of the directives controlling directory indexing
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen(<A HREF="mod_dir.html#adddescription">AddDescription</A>,
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<A HREF="mod_dir.html#addicon">AddIcon</A>,
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<A HREF="mod_dir.html#addiconbyencoding">AddIconByEncoding</A>,
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<A HREF="mod_dir.html#addiconbytype">AddIconByType</A>,
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<A HREF="mod_dir.html#defaulticon">DefaultIcon</A>,
b35f7104715edee0cfac6d46ab0b342033867eb7Timo Sirainen<A HREF="mod_dir.html#directoryindex">DirectoryIndex</A>,
d8b77aef97e89f1ccc5cbdaef77be9052279e35fTimo Sirainen<A HREF="mod_dir.html#fancyindexing">FancyIndexing</A>,
d8b77aef97e89f1ccc5cbdaef77be9052279e35fTimo Sirainen<A HREF="mod_dir.html#headername">HeaderName</A>,
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<A HREF="mod_dir.html#indexignore">IndexIgnore</A>,
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<A HREF="mod_dir.html#indexoptions">IndexOptions</A> and
d8b77aef97e89f1ccc5cbdaef77be9052279e35fTimo Sirainen<A HREF="mod_dir.html#readmename">ReadmeName</A>).
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<dt>Limit
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<dd>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<!--%plaintext &lt;?INDEX {\tt Limit} override&gt; -->
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo SirainenAllow use of the directives controlling host access (allow, deny and order).
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainen<dt>Options
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainen<dd>
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainen<!--%plaintext &lt;?INDEX {\tt Options} override&gt; -->
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo SirainenAllow use of the directives controlling specific directory features
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen(<A HREF="#options">Options</A> and
d8b77aef97e89f1ccc5cbdaef77be9052279e35fTimo Sirainen<A HREF="mod_include.html#xbithack">XBitHack</A>).
d8b77aef97e89f1ccc5cbdaef77be9052279e35fTimo Sirainen</dl><p><hr>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<A name="authname"><h2>AuthName directive</h2></A>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<!--%plaintext &lt;?INDEX {\tt AuthName} directive&gt; -->
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<strong>Syntax:</strong> AuthName <em>auth-domain</em><br>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<strong>Context:</strong> directory, .htaccess<br>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<strong>Override:</strong> AuthConfig<br>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<strong>Status:</strong> core<p>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo SirainenThis directive sets the name of the authorization realm for a directory.
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo SirainenThis realm is given to the client so that the user knows which username and
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainenpassword to send.
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo SirainenIt must be accompanied by <A HREF="#authtype">AuthType</A> and
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<A HREF="#require">require</A> directives, and directives such as
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<A HREF="mod_auth.html#authuserfile">AuthUserFile</A> and
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<A HREF="mod_auth.html#authgroupfile">AuthGroupFile</A> to work.<p><hr>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<A name="authtype"><h2>AuthType directive</h2></A>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<!--%plaintext &lt;?INDEX {\tt AuthType} directive&gt; -->
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<strong>Syntax:</strong> AuthType <em>type</em><br>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<strong>Context:</strong> directory, .htaccess<br>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<strong>Override:</strong> AuthConfig<br>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<strong>Status:</strong> core<p>
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainen
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo SirainenThis directive selects the type of user authentication for a directory.
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo SirainenOnly <code>Basic</code> is currently implemented.
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainen<!--%plaintext &lt;?INDEX {\tt Basic} authentication scheme&gt; -->
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo SirainenIt must be accompanied by <A HREF="#authname">AuthName</A> and
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<A HREF="#require">require</A> directives, and directives such as
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<A HREF="mod_auth.html#authuserfile">AuthUserFile</A> and
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<A HREF="mod_auth.html#authgroupfile">AuthGroupFile</A> to work.<p><hr>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<A name="clearmodulelist"><h2>ClearModuleList directive</h2></A>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<!--%plaintext &lt;?INDEX {\tt ClearModuleList} directive&gt; -->
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<strong>Syntax:</strong> ClearModuleList<br>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<strong>Context:</strong> server config<br>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<strong>Status:</strong> core<br>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<strong>Compatibility:</strong> ClearModuleList is only available in Apache 1.2 and later<p>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo SirainenThe server comes with a built-in list of active modules.  This
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainendirective clears the list.  It is assumed that the list will then be
1175f27441385a7011629f295f42708f9a3a4ffcTimo Sirainenre-populated using the <A HREF="#addmodule">AddModule</A> directive.<p><hr>
1175f27441385a7011629f295f42708f9a3a4ffcTimo Sirainen
1175f27441385a7011629f295f42708f9a3a4ffcTimo Sirainen<A name="bindaddress"><h2>BindAddress directive</h2></A>
1175f27441385a7011629f295f42708f9a3a4ffcTimo Sirainen<!--%plaintext &lt;?INDEX {\tt BindAddress} directive&gt; -->
1175f27441385a7011629f295f42708f9a3a4ffcTimo Sirainen<strong>Syntax:</strong> BindAddress <em>saddr</em><br>
1175f27441385a7011629f295f42708f9a3a4ffcTimo Sirainen<strong>Default:</strong> <code>BindAddress *</code><br>
1175f27441385a7011629f295f42708f9a3a4ffcTimo Sirainen<strong>Context:</strong> server config<br>
1175f27441385a7011629f295f42708f9a3a4ffcTimo Sirainen<strong>Status:</strong> core<p>
1175f27441385a7011629f295f42708f9a3a4ffcTimo Sirainen
1175f27441385a7011629f295f42708f9a3a4ffcTimo SirainenA Unix&#174; http server can either listen on for connections to every
1175f27441385a7011629f295f42708f9a3a4ffcTimo SirainenIP address of the server machine, or just one IP address of the server
1175f27441385a7011629f295f42708f9a3a4ffcTimo Sirainenmachine. <em>Saddr</em> can be
1175f27441385a7011629f295f42708f9a3a4ffcTimo Sirainen
1175f27441385a7011629f295f42708f9a3a4ffcTimo Sirainen<menu>
1175f27441385a7011629f295f42708f9a3a4ffcTimo Sirainen<li>*
1175f27441385a7011629f295f42708f9a3a4ffcTimo Sirainen<li>An IP address
1175f27441385a7011629f295f42708f9a3a4ffcTimo Sirainen<li>A fully-qualified internet domain name
1175f27441385a7011629f295f42708f9a3a4ffcTimo Sirainen</menu>
1175f27441385a7011629f295f42708f9a3a4ffcTimo SirainenIf the value is *, then the server will listen for connections on
1175f27441385a7011629f295f42708f9a3a4ffcTimo Sirainenevery IP address, otherwise it will only listen on the IP address
1175f27441385a7011629f295f42708f9a3a4ffcTimo Sirainenspecified. <p>
1175f27441385a7011629f295f42708f9a3a4ffcTimo Sirainen
1175f27441385a7011629f295f42708f9a3a4ffcTimo SirainenThis option can be used as an alternative method for supporting
1175f27441385a7011629f295f42708f9a3a4ffcTimo Sirainen<A HREF="virtual-host.html">virtual hosts</A> instead of using
1175f27441385a7011629f295f42708f9a3a4ffcTimo Sirainen<A HREF="#virtualhost">&lt;VirtualHost&gt;</A> sections.<p><hr>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<p><strong>See Also:</strong>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<a href="bind.html">Setting which addresses and ports Apache uses</a></p>
b2105c78f0fd58281317e6d777ded860f33153a3Timo Sirainen
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<A name="defaulttype"><h2>DefaultType directive</h2></A>
6a675eda973195f8c00c101519521b788781ba37Timo Sirainen<!--%plaintext &lt;?INDEX {\tt DefaultType} directive&gt; -->
31ddc75584c5cde53d2e78a737587f2e7fdcb0d2Timo Sirainen<strong>Syntax:</strong> DefaultType <em>mime-type</em><br>
31ddc75584c5cde53d2e78a737587f2e7fdcb0d2Timo Sirainen<strong>Default:</strong> <code>DefaultType text/html</code><br>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<strong>Override:</strong> FileInfo<br>
b2105c78f0fd58281317e6d777ded860f33153a3Timo Sirainen<strong>Status:</strong> core<p>
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainen
b2105c78f0fd58281317e6d777ded860f33153a3Timo SirainenThere will be times when the server is asked to provide a document
b2105c78f0fd58281317e6d777ded860f33153a3Timo Sirainenwhose type cannot be determined by its MIME types mappings.<p>
b2105c78f0fd58281317e6d777ded860f33153a3Timo Sirainen
690af4a90eaf8611c2573d34126bb7a852c50a44Timo SirainenThe server must inform the client of the content-type of the document, so in
690af4a90eaf8611c2573d34126bb7a852c50a44Timo Sirainenthe event of an unknown type it uses the <CODE>DefaultType</CODE>. For
690af4a90eaf8611c2573d34126bb7a852c50a44Timo Sirainenexample:
e4fb5bfcdff32d337d054cce36e00e1cdfaae9f8Timo Sirainen<blockquote><code>DefaultType image/gif</code></blockquote>
e4fb5bfcdff32d337d054cce36e00e1cdfaae9f8Timo Sirainenwould be appropriate for a directory which contained many gif images
690af4a90eaf8611c2573d34126bb7a852c50a44Timo Sirainenwith filenames missing the .gif extension.<p><hr>
690af4a90eaf8611c2573d34126bb7a852c50a44Timo Sirainen
b2105c78f0fd58281317e6d777ded860f33153a3Timo Sirainen<A name="directory"><h2>&lt;Directory&gt; directive</h2></A>
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainen<!--%plaintext &lt;?INDEX {\tt Directory} section directive&gt; -->
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<strong>Syntax:</strong> &lt;Directory <em>directory</em>&gt; ... &lt;/Directory&gt; <br>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<strong>Context:</strong> server config, virtual host<br>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<strong>Status:</strong> Core. <p>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen&lt;Directory&gt; and &lt;/Directory&gt; are used to enclose a group of
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainendirectives which will apply only to the named directory and sub-directories
b2105c78f0fd58281317e6d777ded860f33153a3Timo Sirainenof that directory. Any directive which is allowed in a directory
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainencontext may be used. <em>Directory</em> is either the full path to a directory,
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainenor a wild-card string. In a wild-card string, `?' matches any single character,
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainenand `*' matches any sequences of characters. Example:
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<pre>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen   &lt;Directory /usr/local/httpd/htdocs&gt;
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen   Options Indexes FollowSymLinks
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen   &lt;/Directory&gt;
215daa7d5bf9a849849586490fd6fdd28a724dd8Timo Sirainen</pre>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<p><strong>Apache 1.2 and above:</strong>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo SirainenExtended regular expressions can also be used, with the addition of the
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<code>~</code> character. For example:</p>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<pre>
31ddc75584c5cde53d2e78a737587f2e7fdcb0d2Timo Sirainen   &lt;Directory ~ &quot;^/www/.*/[0-9]{3}&quot;&gt;
5c1a8aee989af87bddefd71e2aa83aa2bd695155Timo Sirainen</pre>
5c1a8aee989af87bddefd71e2aa83aa2bd695155Timo Sirainen
5c1a8aee989af87bddefd71e2aa83aa2bd695155Timo Sirainenwould match directories in /www/ that consisted of three numbers.<p>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<p>If multiple directory sections match the directory (or its parents) containing
215daa7d5bf9a849849586490fd6fdd28a724dd8Timo Sirainena document, then the directives are applied in the order of shortest match
31ddc75584c5cde53d2e78a737587f2e7fdcb0d2Timo Sirainenfirst, interspersed with the directives from the
31ddc75584c5cde53d2e78a737587f2e7fdcb0d2Timo Sirainen<A HREF="#accessfilename">.htaccess</A> files. For example, with
31ddc75584c5cde53d2e78a737587f2e7fdcb0d2Timo Sirainen<blockquote><code>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen&lt;Directory /&gt;<br>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo SirainenAllowOverride None<br>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen&lt;/Directory&gt;<br><br>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen&lt;Directory /home/*&gt;<br>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo SirainenAllowOverride FileInfo<br>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen&lt;/Directory&gt;</code></blockquote>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo SirainenThe for access to the document <code>/home/web/dir/doc.html</code> the
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainensteps are:
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<menu>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<li>Apply directive <code>AllowOverride None</code> (disabling
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<code>.htaccess</code> files).
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<li>Apply directive <code>AllowOverride FileInfo</code> (for directory
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<code>/home/web</code>).
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<li>Apply any FileInfo directives in <code>/home/web/.htaccess</code>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen</menu>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo SirainenThe directory sections typically occur in the access.conf file, but they
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainenmay appear in any configuration file. &lt;Directory&gt; directives cannot
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainennest, and cannot appear in a <A HREF="#limit">&lt;Limit&gt;</A> section.
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<p><hr>
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainen
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<A NAME="documentroot"><h2>DocumentRoot directive</h2></A>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<!--%plaintext &lt;?INDEX {\tt DocumentRoot} directive&gt; -->
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<strong>Syntax:</strong> DocumentRoot <em>directory-filename</em><br>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<strong>Default:</strong> <code>DocumentRoot
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen/usr/local/etc/httpd/htdocs</code><br>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<strong>Context:</strong> server config, virtual host<br>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<strong>Status:</strong> core<p>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen
659fe5d24825b160cae512538088020d97a60239Timo SirainenThis directive sets the directory from which httpd will serve files.
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo SirainenUnless matched by a directive like Alias, the server appends the path
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainenfrom the requested URL to the document root to make the path to the
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainendocument. Example:
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<blockquote><code>DocumentRoot /usr/web</code></blockquote>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainenthen an access to <code>http://www.my.host.com/index.html</code> refers
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainento <code>/usr/web/index.html</code>.
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainen
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainen<P>There appears to be a bug in mod_dir which causes problems when the
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo SirainenDocumentRoot has a trailing slash (i.e. "DocumentRoot /usr/web/") so
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainenplease avoid that.
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<p><hr>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<A name="errordocument"><h2>ErrorDocument directive</h2></A>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<!--%plaintext &lt;?INDEX {\tt ErrorDocument} directive&gt; -->
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<strong>Syntax:</strong> ErrorDocument <em>error-code document</em><br>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<strong>Context</strong> server config, virtual host, directory, .htaccess<br>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<strong>Status:</strong> core<br>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<strong>Compatibility:</strong> The directory and .htaccess contexts
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainenare only available in Apache 1.1 and later.<p>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo SirainenIn the event of a problem or error, Apache can be configured to do
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainenone of four things,
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen
b35f7104715edee0cfac6d46ab0b342033867eb7Timo Sirainen<OL>
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainen<LI>behave like NCSA httpd 1.3
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainen<LI>output a customized message
b35f7104715edee0cfac6d46ab0b342033867eb7Timo Sirainen<LI>redirect to a local URL to handle the problem/error
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainen<LI>redirect to an external URL to handle the problem/error
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo Sirainen</OL>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<P>2-4 are configured using <CODE>ErrorDocument</CODE>, which
b35f7104715edee0cfac6d46ab0b342033867eb7Timo Sirainenis followed by the HTTP response code and a message or URL.
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen
b35f7104715edee0cfac6d46ab0b342033867eb7Timo Sirainen<P><em>Messages</em> in this context, begin with a single quote
b35f7104715edee0cfac6d46ab0b342033867eb7Timo Sirainen(<code>"</code>), which does not form part of the message itself. Apache will
b35f7104715edee0cfac6d46ab0b342033867eb7Timo Sirainensometime offer additional information regarding the problem/error.
31ddc75584c5cde53d2e78a737587f2e7fdcb0d2Timo Sirainen
b2105c78f0fd58281317e6d777ded860f33153a3Timo Sirainen<P>URLs will begin with a slash (/) for local URLs, or will be a full
8e7da21696c9f8a6d5e601243fb6172ec85d47b2Timo SirainenURL which the client can resolve. Examples:
b2105c78f0fd58281317e6d777ded860f33153a3Timo Sirainen<blockquote><code>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo SirainenErrorDocument 500 /cgi-bin/tester<br>
b2105c78f0fd58281317e6d777ded860f33153a3Timo SirainenErrorDocument 404 /cgi-bin/bad_urls.pl<br>
5c1a8aee989af87bddefd71e2aa83aa2bd695155Timo SirainenErrorDocument 401 http://www2.foo.bar/subscription_info.html<br>
5c1a8aee989af87bddefd71e2aa83aa2bd695155Timo SirainenErrorDocument 403 "Sorry can't allow you access today
5c1a8aee989af87bddefd71e2aa83aa2bd695155Timo Sirainen</code></blockquote>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo SirainenSee Also: <A HREF="custom-error.html">documentation of customizable
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainenresponses.</A><p><hr>
5c1a8aee989af87bddefd71e2aa83aa2bd695155Timo Sirainen
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<A name="errorlog"><h2>ErrorLog directive</h2></A>
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<!--%plaintext &lt;?INDEX {\tt ErrorLog} directive&gt; -->
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<strong>Syntax:</strong> ErrorLog <em>filename</em><br>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<strong>Default:</strong> <code>ErrorLog logs/error_log</code><br>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen<strong>Context:</strong> server config, virtual host<br>
1175f27441385a7011629f295f42708f9a3a4ffcTimo Sirainen<strong>Status:</strong> core<p>
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen
The error log directive sets the name of the file to which the server will log
any errors it encounters. If the filename does not begin with a slash (/)
then it is assumed to be relative to the <A HREF="#serverroot">ServerRoot</A>.
Example:
<blockquote><code>ErrorLog /dev/null</code></blockquote>
This effectively turns off error logging.<p><hr>

<A name="files"><h2>&lt;Files&gt;</h2></A>
<strong>Syntax:</strong> &lt;Files <em>filename</em>&gt;
... &lt;/Files&gt;<br>
<strong>Context:</strong> server config, virtual host, htaccess<br>
<strong>Status:</strong> core<br>
<strong>Compatibility:</strong> only available in Apache
1.2 and above.<p>

<p>The &lt;Files&gt; directive provides for access control by
filename. It is comparable to the <a
href="#directory">&lt;Directory&gt;</a> directive and
<a href="#location">&lt;Location&gt;</a> directives. It
should be matched with a &lt;/Files&gt; directive. Directives that
apply to the filename given should be listed
within. <code>&lt;Files&gt;</code> sections are processed in the
order they appear in the configuration file, after the
&lt;Directory&gt; sections and <code>.htaccess</code> files are
read, but before &lt;Location&gt; sections.</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>
   &lt;Files ~ &quot;\.(gif|jpe?g|png)$&quot;&gt;
</pre>

would match most common Internet graphics formats.

<p>Note that unlike <a
href="#directory"><code>&lt;Directory&gt;</code></a> and <a
href="#location"><code>&lt;Location&gt;</code></a> sections,
<code>&lt;Files&gt;</code> sections can be used inside .htaccess
files. This allows users to control access to their own files, at a
file-by-file level. When used in an .htaccess file, if the
<em>filename</em> does not begin with a <code>/</code> character,
the directory being applied will be prefixed automatically.

<p> <hr>

<A name="group"><h2>Group directive</h2></A>
<!--%plaintext &lt;?INDEX {\tt Group} directive&gt; -->
<strong>Syntax:</strong> Group <em>unix-group</em><br>
<strong>Default:</strong> <code>Group #-1</code><br>
<strong>Context:</strong> server config, virtual host<br>
<strong>Status:</strong> core<p>

The Group directive sets the group under which the server will answer requests.
In order to use this directive, the stand-alone server must be run initially
as root. <em>Unix-group</em> is one of:
<dl>
<dt>A group name
<dd>Refers to the given group by name.
<dt># followed by a group number.
<dd>Refers to a group by its number.
</dl>

It is recommended that you set up a new group specifically for running the
server. Some admins use user <code>nobody</code>, but this is not always
possible or desirable.<p>

Note: if you start the server as a non-root user, it will fail to change
to the specified, and will instead continue to run as the group of the
original user. <p>

Special note: Use of this directive in &lt;VirtualHost&gt; requires a
properly configured <A HREF="/suexec.html">SUEXEC wrapper</A>.<p>

SECURITY: See <A HREF="#user">User</A> for a discussion of the security
considerations.<p><hr>

<A name="identitycheck"><h2>IdentityCheck directive</h2></A>
<!--%plaintext &lt;?INDEX {\tt IdentityCheck} directive&gt; -->
<strong>Syntax:</strong> IdentityCheck <em>boolean</em><br>
<strong>Default:</strong> <code>IdentityCheck off</code><br>
<strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
<strong>Status:</strong> core<p>

This directive enables RFC931-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 information should not trusted in any way except for rudimentary usage
tracking.<p><hr>

<A NAME="ifmodule"><H2>&lt;IfModule&gt;</H2></A>
<b>Syntax:</b> &lt;IfModule [!]<i>module-name</i>&gt; <i>...</i>
&lt;/IfModule&gt;<br>
<b>Default:</b> None<br>
<b>Context:</b> all<br>
<b>Status:</b> Core
<strong>Compatibility:</strong> ScriptLog is only available in 1.2 and
later.<P>

<p>

The &lt;IfModule <i>test</i>&gt;...&lt;/IfModule&gt;
section is used to mark directives that are conditional. The
directives within an IfModule section are only
processed if the <i>test</i> is true. If <i>test</i>
is false, everything between the start and end markers
is ignored.<p>

The <i>test</i> in the &lt;IfModule&gt; section directive
can be one of two forms:

<ul>
<li><i>module name</i>
<li>!<i>module name</i>
</ul>

<p>In the former case, the directives between the start and end markers
are only processed if the module named <i>module name</i> is compiled
in to Apache. The second format reverses the test, and only processes
the directives if <i>module name</i> is <b>not</b> compiled in.

<p>The <i>module name</i> argument is a module name as given as the file
name of the module, at the time it was compiled. For example,
<code>mod_rewrite.c</code>.

<p>&lt;IfModule&gt; sections are nest-able, which can be used to implement
simple multiple-module tests.

<P> <hr>

<h2><a name="keepalive">KeepAlive</a></h2>
<strong>Syntax:</strong> KeepAlive <em>max-requests</em><br>
<strong>Default:</strong> <code>KeepAlive 5</code><br>
<strong>Context:</strong> server config<br>
<strong>Status:</strong> Core<br>
<strong>Compatibility:</strong> KeepAlive is only available in Apache
1.1 and later.<p>

This directive enables
<a href="keepalive.html">Keep-Alive</a>
support. Set <em>max-requests</em>
to the maximum number of requests you want Apache to entertain per
request. A limit is imposed to prevent a client from hogging your
server resources. Set this to <code>0</code> to disable support.

<h2><a name="keepalivetimeout">KeepAliveTimeout</a></h2>
<strong>Syntax:</strong> KeepAliveTimeout <em>seconds</em><br>
<strong>Default:</strong> <code>KeepAliveTimeout 15</code><br>
<strong>Context:</strong> server config<br>
<strong>Status:</strong> Core<br>
<strong>Compatibility:</strong> KeepAliveTimeout is only available in Apache
1.1 and later.<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="/core.html#timeout"><code>Timeout</code></a> directive
applies.
<hr>

<A name="listen"><h2>Listen</h2></A>
<strong>Syntax:</strong>
Listen [<em>IP address</em>:]<em>port number</em><br>
<strong>Context:</strong> server config<br>
<strong>Status:</strong> core<br>
<strong>Compatibility:</strong> Listen is only available in Apache
1.1 and later.<p>

<p>The Listen directive instructs Apache to listen to more than one IP
address or port; by default it responds to requests on all IP
interfaces, but only on the port given by the <a href="#port">Port</a>
directive.</p>

<p><strong>See Also</strong>:
<a href="bind.html">Setting which addresses and ports Apache uses</a></p>
<hr>

<A name="limit"><h2>&lt;Limit&gt; directive</h2></A>
<!--%plaintext &lt;?INDEX {\tt Limit} section directive&gt; -->
<strong>Syntax:</strong>
 &lt;Limit <em>method method</em> ... &gt; ... &lt;/Limit&gt;<br>
<strong>Context:</strong> any<br>
<strong>Status:</strong> core<p>

&lt;Limit&gt; and &lt;/Limit&gt; are used to enclose a group of
access control directives which will then apply only to the specified
access methods, where <em>method</em> is any valid HTTP method.
Any directive except another &lt;Limit&gt; or
<A HREF="#directory">&lt;Directory&gt;</A> may be used; the majority will be
unaffected by the &lt;Limit&gt;. Example:
<blockquote><code>
&lt;Limit GET POST&gt;<br>
require valid-user<br>
&lt;/Limit&gt;</code></blockquote>
If an access control directive appears outside a &lt;Limit&gt; directive,
then it applies to all access methods.<p><hr>

<h2><a name="location">&lt;Location&gt;</a></h2>

<strong>Syntax:</strong> &lt;Location <em>URL</em>&gt;
... &lt;/Location&gt;<br>
<strong>Context:</strong> server config, virtual host<br>
<strong>Status:</strong> core<br>
<strong>Compatibility:</strong> Location is only available in Apache
1.1 and later.<p>

<p>The &lt;Location&gt; directive provides for access control by
URL. It is comparable to the <a
href="#directory">&lt;Directory&gt;</a> directive, and
should be matched with a &lt;/Location&gt; directive. Directives that
apply to the URL given should be listen
within. <code>&lt;Location&gt;</code> sections are processed in the
order they appear in the configuration file, after the
&lt;Directory&gt; sections and <code>.htaccess</code> files are
read.</p>

<p>Note that, due to the way HTTP functions, <em>URL prefix</em>
should, save for proxy requests, be of the form <code>/path/</code>,
and should not include the <code>http://servername</code>. It doesn't
necessarily have to protect a directory (it can be an individual
file, or a number of files), and can include wild-cards.  In a wild-card
string, `?' matches any single character, and `*' matches any
sequences of characters.

<p><strong>Apache 1.2 and above:</strong>
Extended regular expressions can also be used, with the addition of
the
<code>~</code> character. For example:</p>

<pre>
   &lt;Location ~ &quot;/(extra|special)/data&quot;&gt;
</pre>

would match URLs that contained the substring "/extra/data" or
"/special/data".</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:

<pre>
    &lt;Location /status&gt;
    SetHandler server-status
    <Limit GET>
    order deny,allow
    deny from all
    allow from .foo.com
    </Limit>
    &lt;/Location&gt;
</pre>
<hr>

<A name="maxclients"><h2>MaxClients directive</h2></A>
<!--%plaintext &lt;?INDEX {\tt MaxClients} directive&gt; -->
<strong>Syntax:</strong> MaxClients <em>number</em><br>
<strong>Default:</strong> <code>MaxClients 256</code><br>
<strong>Context:</strong> server config<br>
<strong>Status:</strong> core<p>

The MaxClients directive sets the limit on the number of simultaneous
requests that can be supported; not more than this number of child server
processes will be created.<p><hr>

<A name="maxrequestsperchild"><h2>MaxRequestsPerChild directive</h2></A>
<!--%plaintext &lt;?INDEX {\tt MaxRequestsPerChild} directive&gt; -->
<strong>Syntax:</strong> MaxRequestsPerChild <em>number</em><br>
<strong>Default:</strong> <code>MaxRequestsPerChild 0</code><br>
<strong>Context:</strong> server config<br>
<strong>Status:</strong> core<p>

The MaxRequestsPerChild directive sets the limit on the number of requests
that an individual child server process will handle. After MaxRequestsPerChild
requests, the child process will die. If MaxRequestsPerChild is 0, then
the process will never expire.<p>

Setting MaxRequestsPerChild to a non-zero limit has two beneficial effects:
<ul>
<li>it limits the amount of memory that process can consume by (accidental)
memory leakage;
<li> by giving processes a finite lifetime, it helps reduce the
number of processes when the server load reduces.
</ul><p><hr>

<A name="maxspareservers"><h2>MaxSpareServers directive</h2></A>
<!--%plaintext &lt;?INDEX {\tt MaxSpareServers} directive&gt; -->
<strong>Syntax:</strong> MaxSpareServers <em>number</em><br>
<strong>Default:</strong> <code>MaxSpareServers 10</code><br>
<strong>Context:</strong> server config<br>
<strong>Status:</strong> core<p>

The MaxSpareServers directive sets the desired maximum number of <em>idle</em>
child server processes. An idle process is one which is not handling
a request. If there are more than MaxSpareServers idle, then the parent
process will kill off the excess processes.<p>

Tuning of this parameter should only be necessary on very busy sites.
Setting this parameter to a large number is almost always a bad idea.<p>

See also <A HREF="#minspareservers">MinSpareServers</A> and
<A HREF="#startservers">StartServers</A>.<p><hr>

<A name="minspareservers"><h2>MinSpareServers directive</h2></A>
<!--%plaintext &lt;?INDEX {\tt MinSpareServers} directive&gt; -->
<strong>Syntax:</strong> MinSpareServers <em>number</em><br>
<strong>Default:</strong> <code>MinSpareServers 5</code><br>
<strong>Context:</strong> server config<br>
<strong>Status:</strong> core<p>

The MinSpareServers directive sets the desired minimum number of <em>idle</em>
child server processes. An idle process is one which is not handling
a request. If there are fewer than MinSpareServers idle, then the parent
process creates new children at a maximum rate of 1 per second.<p>

Tuning of this parameter should only be necessary on very busy sites.
Setting this parameter to a large number is almost always a bad idea.<p>

See also <A HREF="#maxspareservers">MaxSpareServers</A> and
<A HREF="#startservers">StartServers</A>.<p><hr>

<A name="options"><h2>Options directive</h2></A>
<!--%plaintext &lt;?INDEX {\tt Options} directive&gt; -->
<strong>Syntax:</strong> Options <em>[+|-]option [+|-]option ...</em><br>
<strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
<strong>Override:</strong> Options<br>
<strong>Status:</strong> core<p>

The Options directive controls which server features are available in
a particular directory.
<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:
<dl>
<dt>All
<dd>All options except for MultiViews.
<dt>ExecCGI
<dd>
<!--%plaintext &lt;?INDEX {\tt ExecCGI} option&gt; -->
Execution of CGI scripts is permitted.
<dt>FollowSymLinks
<dd>
<!--%plaintext &lt;?INDEX {\tt FollowSymLinks} option&gt; -->
The server will follow symbolic links in this directory.
<dt>Includes
<dd>
<!--%plaintext &lt;?INDEX {\tt Includes} option&gt; -->
Server-side includes are permitted.
<dt>IncludesNOEXEC
<dd>
<!--%plaintext &lt;?INDEX {\tt IncludesNOEXEC} option&gt; -->
Server-side includes are permitted, but the #exec command and
#include of CGI scripts are disabled.
<dt>Indexes
<dd>
<!--%plaintext &lt;?INDEX {\tt Indexes} option&gt; -->
If a URL which maps to a directory is requested, and the there is no
DirectoryIndex (e.g. index.html) in that directory, then the server will
return a formatted listing of the directory.
<dt>MultiViews
<dd>
<!--%plaintext &lt;?INDEX {\tt MultiViews} option&gt; -->
<A HREF="content-negotiation.html">Content negotiated</A> MultiViews are
allowed.
<dt>SymLinksIfOwnerMatch
<dd>
<!--%plaintext &lt;?INDEX {\tt SymLinksIfOwnerMatch} option&gt; -->
The server will only follow symbolic links for which the target
file or directory is owned by the same user id as the link.
</dl>

Normally, if multiple <code>Options</code> could apply to a directory,
then the most specific one is taken complete; the options are not
merged. However if <i>all</i> the options on the <code>Options</code>
directive are preceeded by a + or - symbol, the options are
merged. Any options preceeded by a + are added to the options
currently in force, and any options preceeded by a - are removed from
the options currently in force.  <P>

For example, without any + and - symbols:

<blockquote><code>
&lt;Directory /web/docs&gt; <br>
Options Indexes FollowSymLinks<br>
&lt;/Directory&gt;<br>
&lt;Directory /web/docs/spec&gt; <br>
Options Includes<br>
&lt;/Directory&gt;
</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:<p>

<blockquote><code>
&lt;Directory /web/docs&gt; <br>
Options Indexes FollowSymLinks<br>
&lt;/Directory&gt;<br>
&lt;Directory /web/docs/spec&gt; <br>
Options +Includes -Indexes<br>
&lt;/Directory&gt;
</code></blockquote>
then the options <code>FollowSymLinks</code> and <code>Includes</code>
are set for the /web/docs/spec directory.
<hr>

<A name="pidfile"><h2>PidFile directive</h2></A>
<!--%plaintext &lt;?INDEX {\tt PidFile} directive&gt; -->
<strong>Syntax:</strong> PidFile <em>filename</em><br>
<strong>Default:</strong> <code>PidFile logs/httpd.pid</code><br>
<strong>Context:</strong> server config<br>
<strong>Status:</strong> core<p>

The PidFile directive sets the file to which the server records the
process id of the daemon. If the filename does not begin with a slash (/)
then it is assumed to be relative to the <A HREF="#serverroot">ServerRoot</A>.
The PidFile is only used in <A HREF="#servertype">standalone</A> mode.<p>

It is often useful to be able to send the server a signal, so that it closes
and then reopens its <A HREF="#errorlog">ErrorLog</A> and TransferLog, and
re-reads its configuration files. This is done by sending a SIGHUP (kill -1)
signal to the process id listed in the PidFile.<p><hr>

<A name="port"><h2>Port directive</h2></A>
<!--%plaintext &lt;?INDEX {\tt Port} directive&gt; -->
<strong>Syntax:</strong> Port <em>number</em><br>
<strong>Default:</strong> <code>Port 80</code><br>
<strong>Context:</strong> server config<br>
<strong>Status:</strong> core<p>

The Port directive sets the network port on which the server listens.
<em>Num</em> is a number from 0 to 65535; some port numbers (especially below
1024) are reserved for particular protocols. See <code>/etc/services</code>
for a list of some defined ports; the standard port for the http protocol
is 80.<p>

Port 80 is one of Unix's special ports. All ports numbered
below 1024 are reserved for system use, i.e. regular (non-root) users cannot
make use of them; instead they can only use higher port numbers.<p>

To use port 80, you must start the server from the root account.
After binding to the port and before accepting requests, Apache will change
to a low privileged user as set by the <A HREF="#user">User directive</A>.<p>

If you cannot use port 80, choose any other unused port. Non-root users
will have to choose a port number higher than 1023, such as 8000.<p>

SECURITY: if you do start the server as root, be sure
not to set <A HREF="#user">User</A> to root. If you run the server as
root whilst handling connections, your site may be open to a major security
attack.<p><hr>

<A name="require"><h2>require directive</h2></A>
<!--%plaintext &lt;?INDEX {\tt require} directive&gt; -->
<strong>Syntax:</strong> require <em>entity-name entity entity...</em><br>
<strong>Context:</strong> directory, .htaccess<br>
<strong>Override:</strong> AuthConfig<br>
<strong>Status:</strong> core<p>

This directive selects which authenticated users can access a directory.
The allowed syntaxes are:
<ul>
<li>require user <em>userid userid ...</em><p>
Only the named users can access the directory.<p>
<li>require group <em>group-name group-name ...</em><p>
Only users in the named groups can access the directory.<p>
<li>require valid-user<p>
All valid users can access the directory.
</ul>
<p>
If <code>require</code> appears in a <A HREF="#limit">&lt;Limit&gt;</A>
section, then it restricts access to the named methods, otherwise
it restricts access for all methods. Example:
<blockquote><code>
AuthType Basic<br>
AuthName somedomain<br>
AuthUserFile /web/users<br>
AuthGroupFile /web/groups<br>
Limit &lt;GET POST&gt;<br>
require group admin<br>
&lt;/Limit&gt;
</code></blockquote>

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.<p><hr>

<A name="resourceconfig"><h2>ResourceConfig directive</h2></A>
<!--%plaintext &lt;?INDEX {\tt ResourceConfig} directive&gt; -->
<strong>Syntax:</strong> ResourceConfig <em>filename</em><br>
<strong>Default:</strong> <code>ResourceConfig conf/srm.conf</code><br>
<strong>Context:</strong> server config, virtual host<br>
<strong>Status:</strong> core<p>

The server will read this file for more directives after reading the
httpd.conf file. <em>Filename</em> is relative to the
<A HREF="#serverroot">ServerRoot</A>.
This feature can be disabled using:
<blockquote><code>ResourceConfig /dev/null</code></blockquote>
Historically, this file contained most directives except for server
configuration directives and <A HREF="#directory">&lt;Directory&gt;</A>.
sections; in fact it can now contain any server directive allowed in the
<em>server config</em> context.<p>

See also <A HREF="#accessconfig">AccessConfig</A>.<p><hr>

<A name="rlimit">
<A name="rlimitcpu"><h2>RLimitCPU directive</h2></A>
<!--%plaintext &lt;?INDEX {\tt RLimitCPU} directive&gt; -->
<strong>Syntax:</strong> RLimitCPU <em># or 'max'</em> <em>[# or 'max']</em><br>
<strong>Default:</strong> <code>Unset uses operating system defaults</code><br>
<strong>Context:</strong> server config, virtual host<br>
<strong>Status:</strong> core<br>
<strong>Compatibility:</strong> RLimitCPU is only available in Apache 1.2 and later<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
be set to the maximum allowed by the operating system configuration. Raising the
maximum resource limit requires that the server is running as root, or in the initial
startup phase.<p>

CPU resource limits are expressed in seconds per process.<p>

See also <A HREF="#rlimitmem">RLimitMEM</A> or <A HREF="#rlimitnproc">RLimitNPROC</A>.<p><hr>

<A name="rlimitmem"><h2>RLimitMEM directive</h2></A>
<!--%plaintext &lt;?INDEX {\tt RLimitMEM} directive&gt; -->
<strong>Syntax:</strong> RLimitMEM <em># or 'max'</em> <em>[# or 'max']</em><br>
<strong>Default:</strong> <code>Unset uses operating system defaults</code><br>
<strong>Context:</strong> server config, virtual host<br>
<strong>Status:</strong> core<br>
<strong>Compatibility:</strong> RLimitMEM is only available in Apache 1.2 and later<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
be set to the maximum allowed by the operating system configuration. Raising the
maximum resource limit requires that the server is running as root, or in the initial
startup phase.<p>

Memory resource limits are expressed in bytes per process.<p>

See also <A HREF="#rlimitcpu">RLimitCPU</A> or <A HREF="#rlimitnproc">RLimitNPROC</A>.<p><hr>

<A name="rlimitnproc"><h2>RLimitNPROC directive</h2></A>
<!--%plaintext &lt;?INDEX {\tt RLimitNPROC} directive&gt; -->
<strong>Syntax:</strong> RLimitNPROC <em># or 'max'</em> <em>[# or 'max']</em><br>
<strong>Default:</strong> <code>Unset uses operating system defaults</code><br>
<strong>Context:</strong> server config, virtual host<br>
<strong>Status:</strong> core<br>
<strong>Compatibility:</strong> RLimitNPROC is only available in Apache 1.2 and later<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
be set to the maximum allowed by the operating system configuration. Raising the
maximum resource limit requires that the server is running as root, or in the initial
startup phase.<p>

Process limits control the number of processes per user.<p>

Note: If CGI processes are <b>not</b> 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
<b><em>cannot fork</em></b> messages in the error_log.<p>

See also <A HREF="#rlimitmem">RLimitMEM</A> or <A HREF="#rlimitcpu">RLimitCPU</A>.

<p><hr>

<A name="satisfy"><h2>Satisfy</h2></A>
<!--%plaintext &lt;?INDEX {\tt Satisfy} directive&gt; -->
<strong>Syntax:</strong><br>
<strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
<strong>Status:</strong> core<br>
<strong>Compatibility:</strong> Satisfy is only available in Apache 1.2 and later<p>

<p><hr>

<A name="sendbuffersize"><h2>SendBufferSize</h2></A>
<!--%plaintext &lt;?INDEX {\tt SendBufferSize} directive&gt; -->
<strong>Syntax:</strong> SendBufferSize <em>bytes</em><br>
<strong>Context:</strong> server config, virtual host<br>
<strong>Status:</strong> core<p>

The server will set the TCP buffer size to the number of bytes
specified. Very useful to increase past standard OS defaults on high
speed high latency (i.e. 100ms or so, such as transcontinental
fast pipes)
<p><hr>

<A name="serveradmin"><h2>ServerAdmin directive</h2></A>
<!--%plaintext &lt;?INDEX {\tt ServerAdmin} directive&gt; -->
<strong>Syntax:</strong> ServerAdmin <em>email-address</em><br>
<strong>Context:</strong> server config, virtual host<br>
<strong>Status:</strong> core<p>

The ServerAdmin sets the e-mail address that the server includes in any
error messages it returns to the client.<p>

It may be worth setting up a dedicated address for this, e.g.
<blockquote><code>ServerAdmin www-admin@foo.bar.com</code></blockquote>
as users do not always mention that they are talking about the server!<p><hr>

<A name="serveralias"><h2>ServerAlias directive</h2></A>

<strong>Syntax:</strong> ServerAlias <em>host1 host2 ...</em><br>
<strong>Context:</strong> virtual host<br>
<strong>Status:</strong> core<br>
<strong>Compatibility:</strong> 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="host.html">Host-header based virtual hosts</a>.

<p><hr>

<A name="servername"><h2>ServerName directive</h2></A>
<!--%plaintext &lt;?INDEX {\tt ServerName} directive&gt; -->
<strong>Syntax:</strong> ServerName <em>fully-qualified domain name</em><br>
<strong>Context:</strong> server config, virtual host<br>
<strong>Status:</strong> core<p>

The ServerName directive sets the hostname of the server; this is only
used when creating redirection URLs. If it is not specified, then the
server attempts to deduce it from its own IP address; however this may
not work reliably, or may not return the preferred hostname. For example:
<blockquote><code>ServerName www.wibble.com</code></blockquote>
would be used if the canonical (main) name of the actual machine
were <code>monster.wibble.com</code>.<p><hr>

<A name="serverpath"><h2>ServerPath directive</h2></A>

<strong>Syntax:</strong> ServerPath <em>pathname</em><br>
<strong>Context:</strong> virtual host<br>
<strong>Status:</strong> core<br>
<strong>Compatibility:</strong> ServerPath is only available in Apache
1.1 and later.<p>

The ServerAlias directive sets the legacy URL pathname for a host, for
use with <a href="host.html">Host-header based virtual hosts</a>.
<hr>

<A name="serverroot"><h2>ServerRoot directive</h2></A>
<!--%plaintext &lt;?INDEX {\tt ServerRoot} directive&gt; -->
<strong>Syntax:</strong> ServerRoot <em>directory-filename</em><br>
<strong>Default:</strong> <code>ServerRoot /usr/local/etc/httpd</code><br>
<strong>Context:</strong> server config<br>
<strong>Status:</strong> 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 directory.<p><hr>

<A name="servertype"><h2>ServerType directive</h2></A>
<!--%plaintext &lt;?INDEX {\tt ServerType} directive&gt; -->
<strong>Syntax:</strong> ServerType <em>type</em><br>
<strong>Default:</strong> <code>ServerType standalone</code><br>
<strong>Context:</strong> server config<br>
<strong>Status:</strong> core<p>

The ServerType directive sets how the server is executed by the system.
<em>Type</em> is one of
<dl>
<dt>inetd
<dd>The server will be run from the system process inetd; the command to start
the server is added to <code>/etc/inetd.conf</code>
<dt>standalone
<dd>The server will run as a daemon process; the command to start the server
is added to the system startup scripts. (<code>/etc/rc.local</code> or
<code>/etc/rc3.d/...</code>.)
</dl>

Inetd is the lesser used of the two options. For each http
connection received, a new copy of the server is started from scratch;
after the connection is complete, this program exits. There is a high price to
pay per connection, but for security reasons, some admins prefer this option.
<p>

Standalone is the most common setting for ServerType since
it is far more efficient. The server is started once, and services all
subsequent connections. If you intend running Apache to serve a busy site,
standalone will probably be your only option.<p>

SECURITY: if you are paranoid about security, run in inetd mode. Security
cannot be guaranteed in either, but whilst most people are happy to use
standalone, inetd is probably least prone to attack.<p><hr>

<A name="startservers"><h2>StartServers directive</h2></A>
<!--%plaintext &lt;?INDEX {\tt StartServers} directive&gt; -->
<strong>Syntax:</strong> StartServers <em>number</em><br>
<strong>Default:</strong> <code>StartServers 5</code><br>
<strong>Context:</strong> server config<br>
<strong>Status:</strong> core<p>

The StartServers directive sets the number of child server processes created
on startup. As the number of processes is dynamically controlled depending
on the load, there is usually little reason to adjust this parameter.<p>

See also <A HREF="#minspareservers">MinSpareServers</A> and
<A HREF="#maxspareservers">MaxSpareServers</A>.<p><hr>

<A name="timeout"><h2>TimeOut directive</h2></A>
<!--%plaintext &lt;?INDEX {\tt TimeOut} directive&gt; -->
<strong>Syntax:</strong> TimeOut <em>number</em><br>
<strong>Default:</strong> <code>TimeOut 1200</code><br>
<strong>Context:</strong> server config<br>
<strong>Status:</strong> core<p>

The TimeOut directive sets the maximum time that the server will wait
for the receipt of a request and the completion of a request, in seconds.
So if it takes more than TimeOut seconds for a client to send a request or
receive a response, the server will break off the connection. Thus TimeOut
limits the maximum a transfer can take; for large files, and slow networks
transfer times can be large.
<p><hr>

<A name="user"><h2>User directive</h2></A>
<!--%plaintext &lt;?INDEX {\tt User} directive&gt; -->
<strong>Syntax:</strong> User <em>unix-userid</em><br>
<strong>Default:</strong> <code>User #-1</code><br>
<strong>Context:</strong> server config, virtual host<br>
<strong>Status:</strong> core<p>

The User directive sets the userid as which the server will answer requests.
In order to use this directive, the standalone server must be run initially
as root. <em>Unix-userid</em> is one of:
<dl>
<dt>A username
<dd>Refers to the given user by name.
<dt># followed by a user number.
<dd>Refers to a user by their number.
</dl>

The user should have no privileges which result in it being able to access
files which are not intended to be visible to the outside world, and
similarly, the user should not be able to execute code which is not
meant for httpd requests. It is recommended that you set up a new user and
group specifically for running the server. Some admins use user
<code>nobody</code>, but this is not always possible or desirable.<p>

Notes: If you start the server as a non-root user, it will fail to change
to the lesser privileged user, and will instead continue to run as
that original user. If you do start the server as root, then it is normal
for the parent process to remain running as root.<p>

Special note: Use of this directive in &lt;VirtualHost&gt; requires a
properly configured <A HREF="/suexec.html">SUEXEC wrapper</A>.<p>

SECURITY: Don't set User (or <A HREF="#group">Group</A>) to
<code>root</code> unless you know exactly what you are doing, and what the
dangers are.<p><hr>

<A name="virtualhost"><h2>&lt;VirtualHost&gt; directive</h2></A>
<!--%plaintext &lt;?INDEX {\tt VirtualHost} section directive&gt; -->
<strong>Syntax:</strong> &lt;VirtualHost <em>addr</em>[:<em>port</em>]&gt; ...
&lt;/VirtualHost&gt; <br>
<strong>Context:</strong> server config<br>
<strong>Status:</strong> Core. <p>

&lt;VirtualHost&gt; and &lt;/VirtualHost&gt; 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 &lt;VirtualHost&gt;
section. <em>Addr</em> can be
<menu>
<li>The IP address of the virtual host
<li>A fully qualified domain name for the IP address of the virtual host.
</menu> Example:
<blockquote>
<code>
&lt;VirtualHost host.foo.com&gt; <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>
&lt;/VirtualHost&gt;
</code></blockquote>

Currently, each VirtualHost must correspond to a different IP address for
the server, so 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="vif.info.txt">VIF</A> (for SunOS(TM) 4.1.x).<p>


<p><strong>See also:</strong>
<A HREF="virtual-host.html">Information on Virtual Hosts.
(multihome)</A><br>
<strong>See also:</strong>
<a href="host.html">Non-IP address-based Virtual Hosts</a>
</p>

<!--#include virtual="footer.html" -->
</BODY>
</HTML>