core.html revision 2724768e1047c3c6d547805ef7310837656daaf8
f79d43bbe70a01454049b77d6f15f6369744959eStéphane Graber<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<HTML>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<HEAD>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<TITLE>Apache Core Features</TITLE>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano</HEAD>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<BODY
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano BGCOLOR="#FFFFFF"
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano TEXT="#000000"
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano LINK="#0000FF"
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano VLINK="#000080"
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano ALINK="#FF0000"
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<!--#include virtual="header.html" -->
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<H1 ALIGN="CENTER">Apache Core Features</h1>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<P>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoThese configuration parameters control the core Apache features, and are
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoalways available.
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano</P>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<H2>Directives</H2>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<ul>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#accessconfig">AccessConfig</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#accessfilename">AccessFileName</A>
aa8d013ec5b09cd1cd904173d6234ef126eb2126Peter Simons<li><A HREF="#addmodule">AddModule</A>
99e4008cad9e959b683c6f48411fcf15a92be3b5Michel Normand<li><A HREF="#allowoverride">AllowOverride</A>
99e4008cad9e959b683c6f48411fcf15a92be3b5Michel Normand<li><A HREF="#authname">AuthName</A>
99e4008cad9e959b683c6f48411fcf15a92be3b5Michel Normand<li><A HREF="#authtype">AuthType</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#bindaddress">BindAddress</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#clearmodulelist">ClearModuleList</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#defaulttype">DefaultType</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#directory">&lt;Directory&gt;</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#directorymatch">&lt;DirectoryMatch&gt;</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#documentroot">DocumentRoot</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#errordocument">ErrorDocument</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#errorlog">ErrorLog</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#files">&lt;Files&gt;</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#filesmatch">&lt;FilesMatch&gt;</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#group">Group</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#hostnamelookups">HostNameLookups</A>
d5cf438682963ac84c3617941032ba623d4ac9b2Michel Normand<li><A HREF="#identitycheck">IdentityCheck</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#ifmodule">&lt;IfModule&gt;</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#keepalive">KeepAlive</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#keepalivetimeout">KeepAliveTimeout</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#limit">&lt;Limit&gt;</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#listen">Listen</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#listenbacklog">ListenBacklog</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#location">&lt;Location&gt;</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#locationmatch">&lt;LocationMatch&gt;</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#lockfile">LockFile</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#maxclients">MaxClients</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#maxkeepaliverequests">MaxKeepAliveRequests</a>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#maxrequestsperchild">MaxRequestsPerChild</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#maxspareservers">MaxSpareServers</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#minspareservers">MinSpareServers</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#options">Options</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#pidfile">PidFile</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#port">Port</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#require">require</A>
6a22713f648be8bd21297f57d9b631eb4c537ffeDaniel Lezcano<li><A HREF="#resourceconfig">ResourceConfig</A>
6a22713f648be8bd21297f57d9b631eb4c537ffeDaniel Lezcano<li><A HREF="#rlimitcpu">RLimitCPU</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#rlimitmem">RLimitMEM</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#rlimitnproc">RLimitNPROC</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#satisfy">Satisfy</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#scoreboardfile">ScoreBoardFile</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#sendbuffersize">SendBufferSize</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#serveradmin">ServerAdmin</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#serveralias">ServerAlias</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#servername">ServerName</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#serverpath">ServerPath</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#serverroot">ServerRoot</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#servertype">ServerType</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#startservers">StartServers</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#threadsperchild">ThreadsPerChild</a>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#timeout">TimeOut</A>
b6d441f289eb03a1a6fe0662a14c26ecc852be21dlezcano<li><A HREF="#user">User</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li><A HREF="#virtualhost">&lt;VirtualHost&gt;</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano</ul>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<hr>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<h2><A name="accessconfig">AccessConfig directive</A></h2>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<!--%plaintext &lt;?INDEX {\tt AccessConfig} directive&gt; -->
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Syntax:</strong> AccessConfig <em>filename</em><br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Default:</strong> <code>AccessConfig conf/access.conf</code><br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Context:</strong> server config, virtual host<br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Status:</strong> core<p>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoThe server will read this file for more directives after reading the
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<A HREF="#resourceconfig">ResourceConfig</A> file. <em>Filename</em> is
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanorelative to the <A HREF="#serverroot">ServerRoot</A>.
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoThis feature can be disabled using:
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<blockquote><code>AccessConfig /dev/null</code></blockquote>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoHistorically, this file only contained
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand<A HREF="#directory">&lt;Directory&gt;</A> sections; in fact it can now
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanocontain any server directive allowed in the <em>server config</em> context.
b6d441f289eb03a1a6fe0662a14c26ecc852be21dlezcano<p><hr>
b6d441f289eb03a1a6fe0662a14c26ecc852be21dlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<h2><A name="accessfilename">AccessFileName directive</A></h2>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<!--%plaintext &lt;?INDEX {\tt AccessFileName} directive&gt; -->
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Syntax:</strong> AccessFileName <em>filename filename ...</em><br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Default:</strong> <code>AccessFileName .htaccess</code><br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Context:</strong> server config, virtual host<br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Status:</strong> core<br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Compatibility:</strong> AccessFileName can accept more than one filename only in Apache 1.3 and later<p>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
0478642a4349846ab8e76e318909886e795df92dFilippo GiunchediWhen returning a document to the client the server looks for the first existing
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoaccess control file from this list of names in every directory of the path to
0478642a4349846ab8e76e318909886e795df92dFilippo Giunchedithe document, if access control files are enabled for that directory.
0478642a4349846ab8e76e318909886e795df92dFilippo Giunchedi
0478642a4349846ab8e76e318909886e795df92dFilippo GiunchediFor example:
0478642a4349846ab8e76e318909886e795df92dFilippo Giunchedi<blockquote><code>AccessFileName .acl</code></blockquote>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanobefore returning the document /usr/local/web/index.html, the
0478642a4349846ab8e76e318909886e795df92dFilippo Giunchediserver will read /.acl, /usr/.acl, /usr/local/.acl and /usr/local/web/.acl
0478642a4349846ab8e76e318909886e795df92dFilippo Giunchedifor directives, unless they have been disabled with
0478642a4349846ab8e76e318909886e795df92dFilippo Giunchedi<blockquote><code>
0478642a4349846ab8e76e318909886e795df92dFilippo Giunchedi&lt;Directory /&gt;<br>
0478642a4349846ab8e76e318909886e795df92dFilippo GiunchediAllowOverride None<br>
0478642a4349846ab8e76e318909886e795df92dFilippo Giunchedi&lt;/Directory&gt;</code></blockquote><p><hr>
0478642a4349846ab8e76e318909886e795df92dFilippo Giunchedi
0478642a4349846ab8e76e318909886e795df92dFilippo Giunchedi<h2><A name="addmodule">AddModule directive</A></h2>
0478642a4349846ab8e76e318909886e795df92dFilippo Giunchedi<!--%plaintext &lt;?INDEX {\tt AddModule} directive&gt; -->
6a22713f648be8bd21297f57d9b631eb4c537ffeDaniel Lezcano<strong>Syntax:</strong> AddModule <em>module module ...</em><br>
6a22713f648be8bd21297f57d9b631eb4c537ffeDaniel Lezcano<strong>Context:</strong> server config <br>
6a22713f648be8bd21297f57d9b631eb4c537ffeDaniel Lezcano<strong>Status:</strong> core<br>
6a22713f648be8bd21297f57d9b631eb4c537ffeDaniel Lezcano<strong>Compatibility:</strong> AddModule is only available in Apache 1.2 and later<p>
6a22713f648be8bd21297f57d9b631eb4c537ffeDaniel Lezcano
6a22713f648be8bd21297f57d9b631eb4c537ffeDaniel LezcanoThe server can have modules compiled in which are not actively in use.
6a22713f648be8bd21297f57d9b631eb4c537ffeDaniel LezcanoThis directive can be used to enable the use of those modules. The
6a22713f648be8bd21297f57d9b631eb4c537ffeDaniel Lezcanoserver comes with a pre-loaded list of active modules; this list can
6a22713f648be8bd21297f57d9b631eb4c537ffeDaniel Lezcanobe cleared with the <A HREF="#clearmodulelist">ClearModuleList</A>
ac30d6a43245e0c50aad9e2ebfb88d80aaeea691Filippo Giunchedidirective.<p><hr>
ac30d6a43245e0c50aad9e2ebfb88d80aaeea691Filippo Giunchedi
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<h2><A name="allowoverride">AllowOverride directive</A></h2>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<!--%plaintext &lt;?INDEX {\tt AllowOverride} directive&gt; -->
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Syntax:</strong> AllowOverride <em>override override ...</em><br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Default:</strong> <code>AllowOverride All</code><br>
0d9f8e188c1c4832e4f6b9de646478947ae86877Daniel Lezcano<strong>Context:</strong> directory<br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Status:</strong> core<p>
b6d441f289eb03a1a6fe0662a14c26ecc852be21dlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoWhen the server finds an .htaccess file (as specified by
0d9f8e188c1c4832e4f6b9de646478947ae86877Daniel Lezcano<A HREF="#accessfilename">AccessFileName</A>) it needs to know which
0d9f8e188c1c4832e4f6b9de646478947ae86877Daniel Lezcanodirectives declared in that file can override earlier access information.<p>
6a22713f648be8bd21297f57d9b631eb4c537ffeDaniel Lezcano
6a22713f648be8bd21297f57d9b631eb4c537ffeDaniel Lezcano<em>Override</em> can be set to <code>None</code>, in which case the server
6a22713f648be8bd21297f57d9b631eb4c537ffeDaniel Lezcanowill not read the file, <code>All</code> in which case the server will
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoallow all the directives, or one or more of the following:
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<dl>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<dt>AuthConfig
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<dd>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<!--%plaintext &lt;?INDEX {\tt AuthConfig} override&gt; -->
0d9f8e188c1c4832e4f6b9de646478947ae86877Daniel LezcanoAllow use of the authorization directives
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano(<A HREF="mod_auth_dbm.html#authdbmgroupfile">AuthDBMGroupFile</A>,
0d9f8e188c1c4832e4f6b9de646478947ae86877Daniel Lezcano<A HREF="mod_auth_dbm.html#authdbmuserfile">AuthDBMUserFile</A>,
0d9f8e188c1c4832e4f6b9de646478947ae86877Daniel Lezcano<A HREF="mod_auth.html#authgroupfile">AuthGroupFile</A>,
0d9f8e188c1c4832e4f6b9de646478947ae86877Daniel Lezcano<A HREF="#authname">AuthName</A>, <A HREF="#authtype">AuthType</A>,
0d9f8e188c1c4832e4f6b9de646478947ae86877Daniel Lezcano<A HREF="mod_auth.html#authuserfile">AuthUserFile</A>,
0d9f8e188c1c4832e4f6b9de646478947ae86877Daniel Lezcano<A HREF="#require">require</A>, etc.).
0d9f8e188c1c4832e4f6b9de646478947ae86877Daniel Lezcano<dt>FileInfo
0d9f8e188c1c4832e4f6b9de646478947ae86877Daniel Lezcano<dd>
0d9f8e188c1c4832e4f6b9de646478947ae86877Daniel Lezcano<!--%plaintext &lt;?INDEX {\tt FileInfo} override&gt; -->
0d9f8e188c1c4832e4f6b9de646478947ae86877Daniel LezcanoAllow use of the directives controlling document types
0d9f8e188c1c4832e4f6b9de646478947ae86877Daniel Lezcano(<A HREF="mod_mime.html#addencoding">AddEncoding</A>,
0d9f8e188c1c4832e4f6b9de646478947ae86877Daniel Lezcano<A HREF="mod_mime.html#addlanguage">AddLanguage</A>,
0d9f8e188c1c4832e4f6b9de646478947ae86877Daniel Lezcano<A HREF="mod_mime.html#addtype">AddType</A>,
0d9f8e188c1c4832e4f6b9de646478947ae86877Daniel Lezcano<A HREF="#defaulttype">DefaultType</A>,
0d9f8e188c1c4832e4f6b9de646478947ae86877Daniel Lezcano<A HREF="#errordocument">ErrorDocument</A>,
0d9f8e188c1c4832e4f6b9de646478947ae86877Daniel Lezcano<A HREF="mod_negotiation.html#languagepriority">LanguagePriority</A>, etc.).
0d9f8e188c1c4832e4f6b9de646478947ae86877Daniel Lezcano<dt>Indexes
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<dd>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<!--%plaintext &lt;?INDEX {\tt Indexes} override&gt; -->
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoAllow use of the directives controlling directory indexing
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano(<A HREF="mod_autoindex.html#adddescription">AddDescription</A>,
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<A HREF="mod_autoindex.html#addicon">AddIcon</A>,
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand<A HREF="mod_autoindex.html#addiconbyencoding">AddIconByEncoding</A>,
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand<A HREF="mod_autoindex.html#addiconbytype">AddIconByType</A>,
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand<A HREF="mod_autoindex.html#defaulticon">DefaultIcon</A>,
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand<A HREF="mod_autoindex.html#directoryindex">DirectoryIndex</A>,
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand<A HREF="mod_autoindex.html#fancyindexing">FancyIndexing</A>,
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand<A HREF="mod_autoindex.html#headername">HeaderName</A>,
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand<A HREF="mod_autoindex.html#indexignore">IndexIgnore</A>,
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<A HREF="mod_autoindex.html#indexoptions">IndexOptions</A>,
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<A HREF="mod_autoindex.html#readmename">ReadmeName</A>, etc.).
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<dt>Limit
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<dd>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<!--%plaintext &lt;?INDEX {\tt Limit} override&gt; -->
b6d441f289eb03a1a6fe0662a14c26ecc852be21dlezcanoAllow use of the directives controlling host access (allow, deny and order).
b6d441f289eb03a1a6fe0662a14c26ecc852be21dlezcano<dt>Options
b6d441f289eb03a1a6fe0662a14c26ecc852be21dlezcano<dd>
b6d441f289eb03a1a6fe0662a14c26ecc852be21dlezcano<!--%plaintext &lt;?INDEX {\tt Options} override&gt; -->
b6d441f289eb03a1a6fe0662a14c26ecc852be21dlezcanoAllow use of the directives controlling specific directory features
b6d441f289eb03a1a6fe0662a14c26ecc852be21dlezcano(<A HREF="#options">Options</A> and
b6d441f289eb03a1a6fe0662a14c26ecc852be21dlezcano<A HREF="mod_include.html#xbithack">XBitHack</A>).
b6d441f289eb03a1a6fe0662a14c26ecc852be21dlezcano</dl><p><hr>
b6d441f289eb03a1a6fe0662a14c26ecc852be21dlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<h2><A name="authname">AuthName directive</A></h2>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<!--%plaintext &lt;?INDEX {\tt AuthName} directive&gt; -->
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Syntax:</strong> AuthName <em>auth-domain</em><br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Context:</strong> directory, .htaccess<br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Override:</strong> AuthConfig<br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Status:</strong> core<p>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoThis directive sets the name of the authorization realm for a directory.
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoThis realm is given to the client so that the user knows which username and
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanopassword to send.
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoIt must be accompanied by <A HREF="#authtype">AuthType</A> and
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<A HREF="#require">require</A> directives, and directives such as
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<A HREF="mod_auth.html#authuserfile">AuthUserFile</A> and
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<A HREF="mod_auth.html#authgroupfile">AuthGroupFile</A> to work.<p><hr>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<h2><A name="authtype">AuthType directive</A></h2>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<!--%plaintext &lt;?INDEX {\tt AuthType} directive&gt; -->
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Syntax:</strong> AuthType <em>type</em><br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Context:</strong> directory, .htaccess<br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Override:</strong> AuthConfig<br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Status:</strong> core<p>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoThis directive selects the type of user authentication for a directory.
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoOnly <code>Basic</code> is currently implemented.
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<!--%plaintext &lt;?INDEX {\tt Basic} authentication scheme&gt; -->
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoIt must be accompanied by <A HREF="#authname">AuthName</A> and
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<A HREF="#require">require</A> directives, and directives such as
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<A HREF="mod_auth.html#authuserfile">AuthUserFile</A> and
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<A HREF="mod_auth.html#authgroupfile">AuthGroupFile</A> to work.<p><hr>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<h2><A name="bindaddress">BindAddress directive</A></h2>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<!--%plaintext &lt;?INDEX {\tt BindAddress} directive&gt; -->
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Syntax:</strong> BindAddress <em>saddr</em><br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Default:</strong> <code>BindAddress *</code><br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Context:</strong> server config<br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Status:</strong> core<p>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoA Unix&#174; http server can either listen for connections to every
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoIP address of the server machine, or just one IP address of the server
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanomachine. <em>Saddr</em> can be
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<menu>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li>*
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li>An IP address
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li>A fully-qualified Internet domain name
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano</menu>
f79d43bbe70a01454049b77d6f15f6369744959eStéphane GraberIf the value is *, then the server will listen for connections on
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoevery IP address, otherwise it will only listen on the IP address
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanospecified. <p>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoThis option can be used as an alternative method for supporting
c159cb963868d4646cf415abb064d8fd4b6ee848Daniel Lezcano<A HREF="/virtual-host.html">virtual hosts</A> instead of using
c159cb963868d4646cf415abb064d8fd4b6ee848Daniel Lezcano<A HREF="#virtualhost">&lt;VirtualHost&gt;</A> sections.
c159cb963868d4646cf415abb064d8fd4b6ee848Daniel Lezcano
c159cb963868d4646cf415abb064d8fd4b6ee848Daniel Lezcano<p><strong>See Also:</strong>
c159cb963868d4646cf415abb064d8fd4b6ee848Daniel Lezcano<a href="/dns-caveats.html">DNS Issues</a><br>
f79d43bbe70a01454049b77d6f15f6369744959eStéphane Graber<strong>See Also:</strong>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<a href="/bind.html">Setting which addresses and ports Apache uses</a></p>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<hr>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<h2><A name="clearmodulelist">ClearModuleList directive</A></h2>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<!--%plaintext &lt;?INDEX {\tt ClearModuleList} directive&gt; -->
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Syntax:</strong> ClearModuleList<br>
b6d441f289eb03a1a6fe0662a14c26ecc852be21dlezcano<strong>Context:</strong> server config<br>
b6d441f289eb03a1a6fe0662a14c26ecc852be21dlezcano<strong>Status:</strong> core<br>
b6d441f289eb03a1a6fe0662a14c26ecc852be21dlezcano<strong>Compatibility:</strong> ClearModuleList is only available in Apache 1.2 and later<p>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoThe server comes with a built-in list of active modules. This
b6d441f289eb03a1a6fe0662a14c26ecc852be21dlezcanodirective clears the list. It is assumed that the list will then be
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanore-populated using the <A HREF="#addmodule">AddModule</A> directive.<p><hr>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<h2><A name="defaulttype">DefaultType directive</A></h2>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<!--%plaintext &lt;?INDEX {\tt DefaultType} directive&gt; -->
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Syntax:</strong> DefaultType <em>mime-type</em><br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Default:</strong> <code>DefaultType text/html</code><br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Override:</strong> FileInfo<br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Status:</strong> core<p>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoThere will be times when the server is asked to provide a document
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanowhose type cannot be determined by its MIME types mappings.<p>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoThe server must inform the client of the content-type of the document, so in
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanothe event of an unknown type it uses the <CODE>DefaultType</CODE>. For
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoexample:
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<blockquote><code>DefaultType image/gif</code></blockquote>
aa8d013ec5b09cd1cd904173d6234ef126eb2126Peter Simonswould be appropriate for a directory which contained many gif images
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanowith filenames missing the .gif extension.<p><hr>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<h2><A name="directory">&lt;Directory&gt; directive</A></h2>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<!--%plaintext &lt;?INDEX {\tt Directory} section directive&gt; -->
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Syntax:</strong> &lt;Directory <em>directory</em>&gt; ... &lt;/Directory&gt; <br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Context:</strong> server config, virtual host<br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Status:</strong> Core. <p>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano&lt;Directory&gt; and &lt;/Directory&gt; are used to enclose a group of
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanodirectives which will apply only to the named directory and sub-directories
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoof that directory. Any directive which is allowed in a directory
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanocontext may be used. <em>Directory</em> is either the full path to a directory,
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoor a wild-card string. In a wild-card string, `?' matches any single character,
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoand `*' matches any sequences of characters. Example:
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<pre>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano &lt;Directory /usr/local/httpd/htdocs&gt;
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano Options Indexes FollowSymLinks
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano &lt;/Directory&gt;
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano</pre>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<p><strong>Apache 1.2 and above:</strong>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoExtended regular expressions can also be used, with the addition of the
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<code>~</code> character. For example:</p>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
aa8d013ec5b09cd1cd904173d6234ef126eb2126Peter Simons<pre>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano &lt;Directory ~ &quot;^/www/.*/[0-9]{3}&quot;&gt;
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano</pre>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanowould match directories in /www/ that consisted of three numbers. In
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoApache 1.3 and later, it is reccomended to use
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<a href="#directorymatch">&lt;DirectoryMatch&gt;</a> instead.<p>
f79d43bbe70a01454049b77d6f15f6369744959eStéphane Graber
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<p>If multiple directory sections match the directory (or its parents) containing
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoa document, then the directives are applied in the order of shortest match
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanofirst, interspersed with the directives from the
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<A HREF="#accessfilename">.htaccess</A> files. For example, with
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<blockquote><code>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano&lt;Directory /&gt;<br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoAllowOverride None<br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano&lt;/Directory&gt;<br><br>
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand&lt;Directory /home/*&gt;<br>
a941cc0bf6c215079f56d68930370dcd8c6002afMichel NormandAllowOverride FileInfo<br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano&lt;/Directory&gt;</code></blockquote>
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normandfor access to the document <code>/home/web/dir/doc.html</code> the
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normandsteps are:
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand<menu>
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand<li>Apply directive <code>AllowOverride None</code> (disabling
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand<code>.htaccess</code> files).
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li>Apply directive <code>AllowOverride FileInfo</code> (for directory
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<code>/home/web</code>).
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<li>Apply any FileInfo directives in <code>/home/web/.htaccess</code>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano</menu>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<P>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<STRONG>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoNote that the default Apache access for &lt;Directory /&gt; is
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<SAMP>Allow from All</SAMP>. This means that Apache will serve any file
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanomapped from an URL. It is recommended that you change this with a block
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanosuch as
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand</STRONG>
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand<PRE>
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand &lt;Directory /&gt;
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand Order Deny,Allow
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand Deny from All
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand &lt;/Directory&gt;
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand</PRE>
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand<P>
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand<STRONG>
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normandand then override this for directories you <EM>want</EM> accessible.
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoSee the
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand<A
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand HREF="/misc/security_tips.html"
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand>Security Tips</A>
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normandpage for more details.
6a22713f648be8bd21297f57d9b631eb4c537ffeDaniel Lezcano</STRONG>
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand</P>
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand
a941cc0bf6c215079f56d68930370dcd8c6002afMichel NormandThe directory sections typically occur in the access.conf file, but they
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normandmay appear in any configuration file. &lt;Directory&gt; directives cannot
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normandnest, and cannot appear in a <A HREF="#limit">&lt;Limit&gt;</A> section.
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand<p><hr>
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand
f79d43bbe70a01454049b77d6f15f6369744959eStéphane Graber<h2><A name="directorymatch">&lt;DirectoryMatch&gt;</A></h2>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Syntax:</strong> &lt;DirectoryMatch <em>regex</em>&gt; ... &lt;/DirectoryMatch&gt; <br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Context:</strong> server config, virtual host<br>
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand<strong>Status:</strong> Core.<br>
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand<strong>Compatibility:</strong> Available in Apache 1.3 and later
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<p>&lt;DirectoryMatch&gt; and &lt;/DirectoryMatch&gt; are used to enclose a group of
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normanddirectives which will apply only to the named directory and sub-directories
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoof that directory, the same as <a
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanohref="#directory">&lt;Directory&gt;</a>. However, it takes as an
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoargument a regular expression. For example:</p>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<pre>
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand &lt;DirectoryMatch &quot;^/www/.*/[0-9]{3}&quot;&gt;
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand</pre>
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand<p>would match directories in /www/ that consisted of three numbers.</p>
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand<hr>
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<h2><A NAME="documentroot">DocumentRoot directive</A></h2>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<!--%plaintext &lt;?INDEX {\tt DocumentRoot} directive&gt; -->
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Syntax:</strong> DocumentRoot <em>directory-filename</em><br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Default:</strong> <code>DocumentRoot
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand/usr/local/etc/httpd/htdocs</code><br>
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand<strong>Context:</strong> server config, virtual host<br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Status:</strong> core<p>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoThis directive sets the directory from which httpd will serve files.
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoUnless matched by a directive like Alias, the server appends the path
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanofrom the requested URL to the document root to make the path to the
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanodocument. Example:
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<blockquote><code>DocumentRoot /usr/web</code></blockquote>
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normandthen an access to <code>http://www.my.host.com/index.html</code> refers
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoto <code>/usr/web/index.html</code>.
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<P>There appears to be a bug in mod_dir which causes problems when the
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoDocumentRoot has a trailing slash (i.e. "DocumentRoot /usr/web/") so
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normandplease avoid that.
b6d441f289eb03a1a6fe0662a14c26ecc852be21dlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<p><hr>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<h2><A name="errordocument">ErrorDocument directive</A></h2>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<!--%plaintext &lt;?INDEX {\tt ErrorDocument} directive&gt; -->
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Syntax:</strong> ErrorDocument <em>error-code document</em><br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Context</strong> server config, virtual host, directory, .htaccess<br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Status:</strong> core<br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Override:</strong> FileInfo<br>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano<strong>Compatibility:</strong> The directory and .htaccess contexts
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcanoare only available in Apache 1.1 and later.<p>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcanoIn the event of a problem or error, Apache can be configured to do
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcanoone of four things,
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano<OL>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano<LI>output a simple hardcoded error message
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano<LI>output a customized message
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano<LI>redirect to a local URL to handle the problem/error
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano<LI>redirect to an external URL to handle the problem/error
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano</OL>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano<P>The first option is the default, while options 2-4 are configured
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanousing the <CODE>ErrorDocument</CODE> directive, which is followed by
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normandthe HTTP response code and a message or URL.
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<P><em>Messages</em> in this context begin with a single quote
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano(<code>"</code>), which does not form part of the message itself.
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoApache will sometimes offer additional information regarding the
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoproblem/error.
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<P>URLs can begin with a slash (/) for local URLs, or be a full
f79d43bbe70a01454049b77d6f15f6369744959eStéphane GraberURL which the client can resolve. Examples:
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<blockquote><code>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoErrorDocument 500 http://foo.example.com/cgi-bin/tester<br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoErrorDocument 404 /cgi-bin/bad_urls.pl<br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoErrorDocument 401 /subscription_info.html<br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoErrorDocument 403 "Sorry can't allow you access today
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand</code></blockquote>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<P>Note that when you specify an <CODE>ErrorDocument</CODE> that
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanopoints to a remote URL (ie. anything with a method such as "http" in
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanofront of it) Apache will send a redirect to the client to tell it
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanowhere to find the document, even if the document ends up being
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoon the same server.. This has several implications, the
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanomost important being that <STRONG>if you use an "ErrorDocument 401"
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanodirective then it must refer to a local document.</STRONG> This results
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanofrom the nature of the HTTP basic authentication scheme.
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<P>See Also: <A HREF="/custom-error.html">documentation of customizable
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoresponses.</A><p><hr>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand<h2><A name="errorlog">ErrorLog directive</A></h2>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<!--%plaintext &lt;?INDEX {\tt ErrorLog} directive&gt; -->
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Syntax:</strong> ErrorLog <em>filename</em><br>
c159cb963868d4646cf415abb064d8fd4b6ee848Daniel Lezcano<strong>Default:</strong> <code>ErrorLog logs/error_log</code><br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Context:</strong> server config, virtual host<br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Status:</strong> core<p>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoThe error log directive sets the name of the file to which the server will log
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoany errors it encounters. If the filename does not begin with a slash (/)
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanothen it is assumed to be relative to the <A HREF="#serverroot">ServerRoot</A>.
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoExample:
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<blockquote><code>ErrorLog /dev/null</code></blockquote>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoThis effectively turns off error logging.<p>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoSECURITY: See the <A HREF="/misc/security_tips.html">security tips</A>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanodocument for details on why your security could be compromised if
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanothe directory where logfiles are stored is writable by anyone other
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanothan the user that starts the server.
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<p><hr>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<h2><A name="files">&lt;Files&gt; directive</A></h2>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Syntax:</strong> &lt;Files <em>filename</em>&gt;
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano... &lt;/Files&gt;<br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Context:</strong> server config, virtual host, htaccess<br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Status:</strong> core<br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Compatibility:</strong> only available in Apache
c159cb963868d4646cf415abb064d8fd4b6ee848Daniel Lezcano1.2 and above.<p>
c159cb963868d4646cf415abb064d8fd4b6ee848Daniel Lezcano
c159cb963868d4646cf415abb064d8fd4b6ee848Daniel Lezcano<p>The &lt;Files&gt; directive provides for access control by
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanofilename. It is comparable to the <a
c159cb963868d4646cf415abb064d8fd4b6ee848Daniel Lezcanohref="#directory">&lt;Directory&gt;</a> directive and
c159cb963868d4646cf415abb064d8fd4b6ee848Daniel Lezcano<a href="#location">&lt;Location&gt;</a> directives. It
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoshould be matched with a &lt;/Files&gt; directive. Directives that
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoapply to the filename given should be listed
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanowithin. <code>&lt;Files&gt;</code> sections are processed in the
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoorder they appear in the configuration file, after the
b6d441f289eb03a1a6fe0662a14c26ecc852be21dlezcano&lt;Directory&gt; sections and <code>.htaccess</code> files are
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoread, but before &lt;Location&gt; sections.</p>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<p>The <em>filename</em> argument should include a filename, or a
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanowild-card string, where `?' matches any single character, and `*' matches any
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanosequences of characters. Extended regular expressions can also be used,
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanowith the addition of
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanothe <code>~</code> character. For example:</p>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<pre>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano &lt;Files ~ &quot;\.(gif|jpe?g|png)$&quot;&gt;
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano</pre>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanowould match most common Internet graphics formats. In Apache 1.3 and
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanolater, <a href="#filesmatch">&lt;FilesMatch&gt;</a> is perferred,
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanohowever.
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
83c2e175242f590ef8984174fe62fa13720ea654Michel Normand<p>Note that unlike <a
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanohref="#directory"><code>&lt;Directory&gt;</code></a> and <a
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanohref="#location"><code>&lt;Location&gt;</code></a> sections,
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<code>&lt;Files&gt;</code> sections can be used inside .htaccess
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanofiles. This allows users to control access to their own files, at a
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanofile-by-file level. When used in an .htaccess file, if the
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<em>filename</em> does not begin with a <code>/</code> character,
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanothe directory being applied will be prefixed automatically.
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<p> <hr>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<h2><A name="filesmatch">&lt;FilesMatch&gt;</A></h2>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Syntax:</strong> &lt;FilesMatch <em>regex</em>&gt;
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano... &lt;/Files&gt;<br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Context:</strong> server config, virtual host, htaccess<br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Status:</strong> core<br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Compatibility:</strong> only available in Apache
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano1.3 and above.<p>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<p>The &lt;FilesMatch&gt; directive provides for access control by
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanofilename, just as the <a href="#files">&lt;Files&gt;</a> directive
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanodoes. However, it accepts a regular expression. For example:</p>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<pre>
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normand &lt;FilesMatch &quot;\.(gif|jpe?g|png)$&quot;&gt;
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano</pre>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<p>would match most common Internet graphics formats.</p>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<hr>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<h2><A name="group">Group directive</A></h2>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<!--%plaintext &lt;?INDEX {\tt Group} directive&gt; -->
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Syntax:</strong> Group <em>unix-group</em><br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Default:</strong> <code>Group #-1</code><br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Context:</strong> server config, virtual host<br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Status:</strong> core<p>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoThe Group directive sets the group under which the server will answer requests.
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoIn order to use this directive, the stand-alone server must be run initially
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoas root. <em>Unix-group</em> is one of:
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<dl>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<dt>A group name
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<dd>Refers to the given group by name.
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<dt># followed by a group number.
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<dd>Refers to a group by its number.
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano</dl>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoIt is recommended that you set up a new group specifically for running the
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoserver. Some admins use user <code>nobody</code>, but this is not always
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanopossible or desirable.<p>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoNote: if you start the server as a non-root user, it will fail to change
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoto the specified group, and will instead continue to run as the group of the
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanooriginal user. <p>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoSpecial note: Use of this directive in &lt;VirtualHost&gt; requires a
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoproperly configured <A HREF="/suexec.html">suEXEC wrapper</A>.
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoWhen used inside a &lt;VirtualHost&gt; in this manner, only the group
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanothat CGIs are run as is affected. Non-CGI requests are still processed
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoas the group specified in the main Group directive.<p>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
aa8d013ec5b09cd1cd904173d6234ef126eb2126Peter SimonsSECURITY: See <A HREF="#user">User</A> for a discussion of the security
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoconsiderations.<p><hr>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<h2><A name="hostnamelookups">HostNameLookups directive</A></h2>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<!--%plaintext &lt;?INDEX {\tt HostNameLookups} directive&gt; -->
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Syntax:</strong> HostNameLookups <em>on | off | double</em><br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Default:</strong> <code>HostNameLookups off</code><br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Context:</strong> server config, virtual host<br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Status:</strong> core<br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Compatibility:</strong> <code>double</code> available only in Apache
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano1.3 and above.<br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Compatibility:</strong> Default was <code>on</code> prior to Apache
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano1.3.<p>
aa8d013ec5b09cd1cd904173d6234ef126eb2126Peter Simons
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoThis directive enables DNS lookups so that host names can be logged (and
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanopassed to CGIs/SSIs in <code>REMOTE_HOST</code>).
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoThe value <code>double</code> refers to doing double-reverse DNS.
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoThat is, after a reverse lookup is performed, a forward lookup is then
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoperformed on that result. At least one of the ip addresses in the forward
a941cc0bf6c215079f56d68930370dcd8c6002afMichel Normandlookup must match the original address. (In "tcpwrappers" terminology
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanothis is called <code>PARANOID</code>.)<p>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoRegardless of the setting, when <a href="mod_access.html">mod_access</a>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanois used for controlling access by hostname, a double reverse lookup
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanowill be performed. This is necessary for security. Note that the
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoresult of this double-reverse isn't generally available unless
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoyou set <code>HostnameLookups double</code>. For example, if only
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<code>HostnameLookups on</code> and a request is made to an object that
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanois protected by hostname restrictions, regardless of whether the
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanodouble-reverse fails or not, CGIs will still be passed the single-reverse
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoresult in <code>REMOTE_HOST</code>.<p>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoThe default for this directive was previously <code>on</code> in
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoversions of Apache prior to 1.3. It was changed to <code>off</code>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoin order to save the network traffic for those sites that don't truly
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoneed the reverse lookups done. It is also better for the end users
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanobecause they don't have to suffer the extra latency that a lookup
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoentails.
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoHeavily loaded sites should leave this directive <code>off</code>, since DNS
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanolookups can take considerable amounts of time. The utility <i>logresolve</i>,
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoprovided in the <i>/support</i> directory, can be used to look up host names
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanofrom logged IP addresses offline.<p><hr>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<h2><A name="identitycheck">IdentityCheck directive</A></h2>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<!--%plaintext &lt;?INDEX {\tt IdentityCheck} directive&gt; -->
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Syntax:</strong> IdentityCheck <em>boolean</em><br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Default:</strong> <code>IdentityCheck off</code><br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Context:</strong> server config, virtual host<br>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<strong>Status:</strong> core<p>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoThis directive enables RFC1413-compliant logging of the remote user name
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanofor each connection, where the client machine runs identd or something similar.
99e4008cad9e959b683c6f48411fcf15a92be3b5Michel NormandThis information is logged in the access log. <em>Boolean</em> is either
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<code>on</code> or <code>off</code>.<p>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoThe information should not be trusted in any way except for rudimentary usage
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanotracking.<p>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoNote that this can cause serious latency problems accessing your server
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanosince every request requires one of these lookups to be performed. When
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanofirewalls are involved each lookup might possibly fail and add 30 seconds
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoof latency to each hit. So in general this is not very useful on public
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcanoservers accessible from the Internet.
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<p><hr>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<H2><A NAME="ifmodule">&lt;IfModule&gt; directive</A></H2>
f1d8791c17f7e0f131de20d7bbc8836b992bd4dbdlezcano<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<br>
<strong>Compatibility:</strong> IfModule 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 directive</a></h2>
<strong>Syntax: (Apache 1.1)</strong> KeepAlive <em>max-requests</em><br>
<strong>Default: (Apache 1.1)</strong> <code>KeepAlive 5</code><br>
<strong>Syntax: (Apache 1.2)</strong> KeepAlive <em>on/off</em><br>
<strong>Default: (Apache 1.2)</strong> <code>KeepAlive On</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.
<p><strong>Apache 1.1</strong>: 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.
<p><strong>Apache 1.2 and later</strong>: Set to "On" to enable
persistent connections, "Off" to disable. See also the <a
href="#maxkeepaliverequests">MaxKeepAliveRequests</a> directive.</p>
<h2><a name="keepalivetimeout">KeepAliveTimeout directive</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="#timeout"><code>Timeout</code></a> directive
applies.
<hr>
<h2><A name="listen">Listen directive</A></h2>
<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="/dns-caveats.html">DNS Issues</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="/misc/known_bugs.html#listenbug">Known Bugs</a></p>
<hr>
<H2><A NAME="listenbacklog">ListenBacklog directive</A></H2>
<strong>Syntax:</strong> ListenBacklog <em>backlog</em><br>
<strong>Default:</strong> <code>ListenBacklog 511</code><br>
<strong>Context:</strong> server config<br>
<strong>Status:</strong> Core<br>
<strong>Compatibility:</strong> ListenBacklog is only available in Apache
versions after 1.2.0.<p>
The maximum length of the queue of pending connections. Generally no
tuning is needed or desired, however on some systems it is desirable
to increase this when under a TCP SYN flood attack. See
the backlog parameter to the <code>listen(2)</code> system call.
<h2><A name="limit">&lt;Limit&gt; directive</A></h2>
<!--%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; directive</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 listed
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>
<p>would match URLs that contained the substring "/extra/data" or
"/special/data". However, in Apache 1.3 and above, use of <a
href="#locationmatch">&lt;LocationMatch&gt;</a> is perferred.</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
order deny,allow
deny from all
allow from .foo.com
&lt;/Location&gt;
</pre>
<hr>
<h2><a name="locationmatch">&lt;LocationMatch&gt;</a></h2>
<strong>Syntax:</strong> &lt;LocationMatch <em>regex</em>&gt;
... &lt;/LocationMatch&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.3 and later.<p>
<p>The &lt;LocationMatch&gt; directive provides for access control by
URL, in an identical manner to <a
href="#location">&lt;Location&gt;</a>. However, it takes a regular
expression as an argument instead of a simple string. For example:</p>
<pre>
&lt;LocationMatch &quot;/(extra|special)/data&quot;&gt;
</pre>
<p>would match URLs that contained the substring "/extra/data" or
"/special/data".</p>
<hr>
<H2><A NAME="lockfile">LockFile directive</A></H2>
<strong>Syntax:</strong> LockFile <em>filename</em><BR>
<strong>Default:</strong> <code>LockFile logs/accept.lock</code><BR>
<strong>Context:</strong> server config<BR>
<strong>Status:</strong> core<P>
The LockFile directive sets the path to the lockfile used when
Apache is compiled with either USE_FCNTL_SERIALIZED_ACCEPT or
USE_FLOCK_SERIALIZED_ACCEPT. This directive should normally be
left at its default value. The main reason for changing it is if
the <code>logs</code> directory is NFS mounted, since the lockfile
should be stored on a local disk if possible. The PID of the main
server process is automatically appended to the filename.
<P><HR>
<h2><A name="maxclients">MaxClients directive</A></h2>
<!--%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>
<h2><A name="maxkeepaliverequests">MaxKeepAliveRequests directive</A></h2>
<strong>Syntax:</strong> MaxKeepAliveRequests <em>number</em><br>
<strong>Default:</strong> <code>MaxKeepAliveRequests 100</code><br>
<strong>Context:</strong> server config<br>
<strong>Status:</strong> core<br>
<strong>Compatibility:</strong> 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 recommend that this setting be kept to a high value for
maximum server performance.
<h2><A name="maxrequestsperchild">MaxRequestsPerChild directive</A></h2>
<!--%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>
<h2><A name="maxspareservers">MaxSpareServers directive</A></h2>
<!--%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>
<h2><A name="minspareservers">MinSpareServers directive</A></h2>
<!--%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>
<h2><A name="options">Options directive</A></h2>
<!--%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.
<b>Note</b>: even though the server follows the symlink it does <i>not</i>
change the pathname used to match against <code>&lt;Directory&gt;</code>
sections.
<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 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:
<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>
<h2><A name="pidfile">PidFile directive</A></h2>
<!--%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>
The PidFile is subject to the same warnings about log file placement and
<a href="/misc/security_tips.html">security</a>.
<p><hr>
<h2><A name="port">Port directive</A></h2>
<!--%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>
<em>Number</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>
The Port directive has two behaviors, the first of which is necessary for
NCSA backwards compatibility (and which is confusing in the context of
Apache).<p>
<ul>
<li>
In the absence of any <a href="#listen">Listen</a> or
<a href="#bindaddress">BindAddress</a> directives specifying a port number,
the Port directive sets the network port on which the server listens.
If there are any Listen or BindAddress directives specifying
<code>:number</code> then Port has no effect on what address the server
listens at.
<li>The Port directive
sets the <code>SERVER_PORT</code> environment variable (for
<a href="mod_cgi.html">CGI</a> and <a href="mod_include.html">SSI</a>),
and is used when the server must generate a URL that refers to itself
(for example when creating an external redirect to itself).
</ul>
In no event does a Port setting affect
what ports a <a href="#virtualhost">VirtualHost</a> responds on, the
VirtualHost directive itself is used for that.<p>
The primary behaviour of Port should be considered to be similar to that of
the <a href="#servername">ServerName</a> directive. The ServerName
and Port together specify what you consider to be the <i>canonical</i>
address of the server.<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.
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>
<h2><A name="require">require directive</A></h2>
<!--%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>
&lt;Limit 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>
<h2><A name="resourceconfig">ResourceConfig directive</A></h2>
<!--%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>
<H2><A name="rlimit">RLimitCPU</A> <A NAME="rlimitcpu">directive</A></H2>
<!--%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>
<h2><A name="rlimitmem">RLimitMEM directive</A></h2>
<!--%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>
<h2><A name="rlimitnproc">RLimitNPROC directive</A></h2>
<!--%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>
<h2><A name="satisfy">Satisfy directive</A></h2>
<!--%plaintext &lt;?INDEX {\tt Satisfy} directive&gt; -->
<strong>Syntax:</strong> Satisfy <em>'any' or 'all'</em><br>
<strong>Default:</strong> Satisfy all<br>
<strong>Context:</strong> directory, .htaccess<br>
<strong>Status:</strong> core<br>
<strong>Compatibility:</strong> Satisfy is only available in Apache 1.2 and later<p>
Access policy if both allow and require 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 <i>and</i> client host address. In this case the
default behavior ("all") is to require that the client passes the
address access restriction <i>and</i> 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><hr>
<h2><A name="scoreboardfile">ScoreBoardFile directive</A></h2>
<!--%plaintext &lt;?INDEX {\tt ScoreBoardFile} directive&gt; -->
<strong>Syntax:</strong> ScoreBoardFile <em>filename</em><br>
<strong>Default:</strong> <code>ScoreBoardFile logs/apache_status</code><br>
<strong>Context:</strong> server config<br>
<strong>Status:</strong> core<p>
The ScoreBoardFile directive is required on some architectures to place
a file that the server will use to communicate between its children and
the parent. The easiest way to find out if your architecture requires
a scoreboard file is to run Apache and see if it creates the file named
by the directive. If your architecture requires it then you must ensure
that this file is not used at the same time by more than one invocation
of Apache.<p>
If you have to use a ScoreBoardFile then you may see improved speed by
placing it on a RAM disk. But be careful that you heed the same warnings
about log file placement and
<a href="/misc/security_tips.html">security</a>.<p>
Apache 1.2 and above:<p>
Linux 1.x users might be able to add <code>-DHAVE_SHMGET</code> to
the <code>EXTRA_CFLAGS</code> in your <code>Configuration</code>. This
might work with some 1.x installations, but won't work with all of
them.<p>
SVR4 users should consider adding <code>-DHAVE_SHMGET</code> to the
<code>EXTRA_CFLAGS</code> in your <code>Configuration</code>. This
is believed to work, but we were unable to test it in time for 1.2
release.<p>
<strong>See Also</strong>:
<a href="/stopping.html">Stopping and Restarting Apache</a></p>
<p><hr>
<h2><A name="sendbuffersize">SendBufferSize directive</A></h2>
<!--%plaintext &lt;?INDEX {\tt SendBufferSize} directive&gt; -->
<strong>Syntax:</strong> SendBufferSize <em>bytes</em><br>
<strong>Context:</strong> server config<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>
<h2><A name="serveradmin">ServerAdmin directive</A></h2>
<!--%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>
<h2><A name="serveralias">ServerAlias directive</A></h2>
<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><strong>See Also</strong>:
<a href="/vhosts-in-depth.html">In-depth description of Virtual Host matching</a></p>
<hr>
<h2><A name="servername">ServerName directive</A></h2>
<!--%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>
<p><strong>See Also</strong>:
<a href="/dns-caveats.html">DNS Issues</a></p>
<hr>
<h2><A name="serverpath">ServerPath directive</A></h2>
<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 ServerPath directive sets the legacy URL pathname for a host, for
use with <a href="/host.html">Host-header based virtual hosts</a>.
<p><strong>See Also</strong>:
<a href="/vhosts-in-depth.html">In-depth description of Virtual Host matching</a></p>
<hr>
<h2><A name="serverroot">ServerRoot directive</A></h2>
<!--%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.<br>
See also <a href="/invoking.html">the <code>-d</code> option to httpd</a>.<p><hr>
<h2><A name="servertype">ServerType directive</A></h2>
<!--%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>
<h2><A name="startservers">StartServers directive</A></h2>
<!--%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>
<p>When running with Microsoft Windows, this directive sets the total
number of child processes running. Since the Windows version of Apache
is multithreaded, one processes handles all the requests. The rest are
held in reserve until the main processes dies.
See also <A HREF="#minspareservers">MinSpareServers</A> and
<A HREF="#maxspareservers">MaxSpareServers</A>.<p><hr>
<h2><A name="threadsperchild">ThreadsPerChild</A></h2>
<strong>Syntax:</strong> ThreadsPerChild <em>number</em><br>
<strong>Default:</strong> <code>ThreadsPerChild 50</code><br>
<strong>Context:</strong> server config<br>
<strong>Status:</strong> core (Windows)<br>
<strong>Compatbility:</strong> Available only with Apache 1.3 and later
with Windows
<p>This directive tells the server how many threads it should use. This
is the maximum number of connections the server can handle at once; be
sure and set this number high enough for your site if you get a lot of
hits.
<p>See also <A HREF="#startservers">StartServers</A> and <A
HREF="#maxrequestsperchild">MaxRequestsPerChild</A>.</p>
<hr>
<h2><A name="timeout">TimeOut directive</A></h2>
<!--%plaintext &lt;?INDEX {\tt TimeOut} directive&gt; -->
<strong>Syntax:</strong> TimeOut <em>number</em><br>
<strong>Default:</strong> <code>TimeOut 300</code><br>
<strong>Context:</strong> server config<br>
<strong>Status:</strong> core<p>
The TimeOut directive currently defines the amount of time Apache will
wait for three things:
<OL>
<LI>The total amount of time it takes to receive a GET request.
<LI>The amount of time between receipt of TCP packets on a POST or
PUT request.
<LI>The amount of time between ACKs on transmissions of TCP packets
in responses.
</OL>
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.
<p><hr>
<h2><A name="user">User directive</A></h2>
<!--%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>.
When used inside a &lt;VirtualHost&gt; in this manner, only the user
that CGIs are run as is affected. Non-CGI requests are still processed
with the user specified in the main User directive.<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>
<h2><A name="virtualhost">&lt;VirtualHost&gt; directive</A></h2>
<!--%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.<br>
<strong>Compatibility:</strong> Non-IP address-based Virtual Hosting only
available in Apache 1.1 and later.<br>
<strong>Compatibility:</strong> Multiple address support only available in
Apache 1.2 and later.<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 10.1.2.3&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>
Each VirtualHost must correspond to a different IP address or a
different host name for the server, in the latter 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>
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>
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="#port">Port</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>
<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><strong>See also:</strong>
<A HREF="/dns-caveats.html">Warnings about DNS and Apache</a><br>
<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><br>
<strong>See also:</strong>
<a href="/vhosts-in-depth.html">In-depth description of Virtual Host matching</a>
</p>
<!--#include virtual="footer.html" -->
</BODY>
</HTML>