core.html revision 67da4273edec0f9f7c6164b58bdfaa231a98b35f
967e5f3c25249c779575864692935627004d3f9eChristian Maeder<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
967e5f3c25249c779575864692935627004d3f9eChristian Maeder<HTML>
81d182b21020b815887e9057959228546cf61b6bChristian Maeder<HEAD>
f11f713bebd8e1e623a0a4361065df256033de47Christian Maeder<TITLE>Apache Core Features</TITLE>
97018cf5fa25b494adffd7e9b4e87320dae6bf47Christian Maeder</HEAD>
967e5f3c25249c779575864692935627004d3f9eChristian Maeder
3f69b6948966979163bdfe8331c38833d5d90ecdChristian Maeder<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
967e5f3c25249c779575864692935627004d3f9eChristian Maeder<BODY
89054b2b95a3f92e78324dc852f3d34704e2ca49Christian Maeder BGCOLOR="#FFFFFF"
f3a94a197960e548ecd6520bb768cb0d547457bbChristian Maeder TEXT="#000000"
717686b54b9650402e2ebfbaadf433eab8ba5171Christian Maeder LINK="#0000FF"
717686b54b9650402e2ebfbaadf433eab8ba5171Christian Maeder VLINK="#000080"
967e5f3c25249c779575864692935627004d3f9eChristian Maeder ALINK="#FF0000"
967e5f3c25249c779575864692935627004d3f9eChristian Maeder>
967e5f3c25249c779575864692935627004d3f9eChristian Maeder<!--#include virtual="header.html" -->
967e5f3c25249c779575864692935627004d3f9eChristian Maeder
fd896e2068ad7e50aed66ac18c3720ea7ff2619fChristian Maeder<H1 ALIGN="CENTER">Apache Core Features</h1>
7221c71b38c871ce66eee4537cb681d468308dfbChristian Maeder<P>
ee93fb771fcf3000d73c8e2f2000adb4b9a5158cChristian MaederThese configuration parameters control the core Apache features, and are
ee93fb771fcf3000d73c8e2f2000adb4b9a5158cChristian Maederalways available.
ee93fb771fcf3000d73c8e2f2000adb4b9a5158cChristian Maeder</P>
ac19f8695aa1b2d2d1cd1319da2530edd8f46a96Christian Maeder<H2>Directives</H2>
8b9fda012e5ee53b7b2320c0638896a0ff6e99f3Christian Maeder<ul>
ee93fb771fcf3000d73c8e2f2000adb4b9a5158cChristian Maeder<li><A HREF="#accessconfig">AccessConfig</A>
ee93fb771fcf3000d73c8e2f2000adb4b9a5158cChristian Maeder<li><A HREF="#accessfilename">AccessFileName</A>
e1839fb37a3a2ccd457464cb0dcc5efd466dbe22Christian Maeder<li><A HREF="#addmodule">AddModule</A>
4ef2a978e66e2246ff0b7f00c77deb7aabb28b8eChristian Maeder<li><A HREF="#allowoverride">AllowOverride</A>
551af0e4ba6d96bb24f3555f3b30ed648e22e34aChristian Maeder<li><A HREF="#authname">AuthName</A>
fd896e2068ad7e50aed66ac18c3720ea7ff2619fChristian Maeder<li><A HREF="#authtype">AuthType</A>
967e5f3c25249c779575864692935627004d3f9eChristian Maeder<li><A HREF="#bindaddress">BindAddress</A>
8e9c3881fb6e710b1e08bf5ac8ff9d393df2e74eChristian Maeder<li><A HREF="#clearmodulelist">ClearModuleList</A>
78eeae099616e255ccf2e5f9122387bb10c68338Christian Maeder<li><A HREF="#coredumpdirectory">CoreDumpDirectory</A>
72b9099aeec0762bae4546db3bc4b48721027bf4Christian Maeder<li><A HREF="#defaulttype">DefaultType</A>
72b9099aeec0762bae4546db3bc4b48721027bf4Christian Maeder<li><A HREF="#directory">&lt;Directory&gt;</A>
72b9099aeec0762bae4546db3bc4b48721027bf4Christian Maeder<li><A HREF="#directorymatch">&lt;DirectoryMatch&gt;</A>
ad187062b0009820118c1b773a232e29b879a2faChristian Maeder<li><A HREF="#documentroot">DocumentRoot</A>
ad270004874ce1d0697fb30d7309f180553bb315Christian Maeder<li><A HREF="#errordocument">ErrorDocument</A>
fd896e2068ad7e50aed66ac18c3720ea7ff2619fChristian Maeder<li><A HREF="#errorlog">ErrorLog</A>
551af0e4ba6d96bb24f3555f3b30ed648e22e34aChristian Maeder<li><A HREF="#files">&lt;Files&gt;</A>
551af0e4ba6d96bb24f3555f3b30ed648e22e34aChristian Maeder<li><A HREF="#filesmatch">&lt;FilesMatch&gt;</A>
551af0e4ba6d96bb24f3555f3b30ed648e22e34aChristian Maeder<li><A HREF="#group">Group</A>
72b9099aeec0762bae4546db3bc4b48721027bf4Christian Maeder<li><A HREF="#hostnamelookups">HostNameLookups</A>
551af0e4ba6d96bb24f3555f3b30ed648e22e34aChristian Maeder<li><A HREF="#identitycheck">IdentityCheck</A>
551af0e4ba6d96bb24f3555f3b30ed648e22e34aChristian Maeder<li><A HREF="#ifmodule">&lt;IfModule&gt;</A>
551af0e4ba6d96bb24f3555f3b30ed648e22e34aChristian Maeder<li><A HREF="#include">&lt;Include&gt;</A>
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<li><A HREF="#keepalive">KeepAlive</A>
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<li><A HREF="#keepalivetimeout">KeepAliveTimeout</A>
51fb5d7edd9369c367dda2f8b15ddd6f8a146606Christian Maeder<li><A HREF="#limit">&lt;Limit&gt;</A>
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<li><A HREF="#listen">Listen</A>
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<li><A HREF="#listenbacklog">ListenBacklog</A>
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<li><A HREF="#location">&lt;Location&gt;</A>
51fb5d7edd9369c367dda2f8b15ddd6f8a146606Christian Maeder<li><A HREF="#locationmatch">&lt;LocationMatch&gt;</A>
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<li><A HREF="#lockfile">LockFile</A>
67d92da5e9610aabad39055a16031154b4dc3748Christian Maeder<li><A HREF="#maxclients">MaxClients</A>
67d92da5e9610aabad39055a16031154b4dc3748Christian Maeder<li><A HREF="#maxkeepaliverequests">MaxKeepAliveRequests</a>
67d92da5e9610aabad39055a16031154b4dc3748Christian Maeder<li><A HREF="#maxrequestsperchild">MaxRequestsPerChild</A>
72b9099aeec0762bae4546db3bc4b48721027bf4Christian Maeder<li><A HREF="#maxspareservers">MaxSpareServers</A>
72b9099aeec0762bae4546db3bc4b48721027bf4Christian Maeder<li><A HREF="#minspareservers">MinSpareServers</A>
67d92da5e9610aabad39055a16031154b4dc3748Christian Maeder<li><A HREF="#options">Options</A>
67d92da5e9610aabad39055a16031154b4dc3748Christian Maeder<li><A HREF="#pidfile">PidFile</A>
67d92da5e9610aabad39055a16031154b4dc3748Christian Maeder<li><A HREF="#port">Port</A>
67d92da5e9610aabad39055a16031154b4dc3748Christian Maeder<li><A HREF="#require">require</A>
67d92da5e9610aabad39055a16031154b4dc3748Christian Maeder<li><A HREF="#resourceconfig">ResourceConfig</A>
7a879b08ae0ca30006f9be887a73212b07f10204Christian Maeder<li><A HREF="#rlimitcpu">RLimitCPU</A>
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<li><A HREF="#rlimitmem">RLimitMEM</A>
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<li><A HREF="#rlimitnproc">RLimitNPROC</A>
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<li><A HREF="#satisfy">Satisfy</A>
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<li><A HREF="#scoreboardfile">ScoreBoardFile</A>
67d92da5e9610aabad39055a16031154b4dc3748Christian Maeder<li><A HREF="#sendbuffersize">SendBufferSize</A>
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<li><A HREF="#serveradmin">ServerAdmin</A>
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<li><A HREF="#serveralias">ServerAlias</A>
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<li><A HREF="#servername">ServerName</A>
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<li><A HREF="#serverpath">ServerPath</A>
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<li><A HREF="#serverroot">ServerRoot</A>
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<li><A HREF="#servertype">ServerType</A>
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<li><A HREF="#startservers">StartServers</A>
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<li><A HREF="#threadsperchild">ThreadsPerChild</a>
67d92da5e9610aabad39055a16031154b4dc3748Christian Maeder<li><A HREF="#timeout">TimeOut</A>
7a879b08ae0ca30006f9be887a73212b07f10204Christian Maeder<li><A HREF="#user">User</A>
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<li><A HREF="#virtualhost">&lt;VirtualHost&gt;</A>
67d92da5e9610aabad39055a16031154b4dc3748Christian Maeder</ul>
b66eb6038bfbcd2fe520d87c151bb4f1f510e985Christian Maeder<hr>
a89389521ddf76109168a0b339031575aafbd512Christian Maeder
a89389521ddf76109168a0b339031575aafbd512Christian Maeder<h2><A name="accessconfig">AccessConfig directive</A></h2>
a89389521ddf76109168a0b339031575aafbd512Christian Maeder<!--%plaintext &lt;?INDEX {\tt AccessConfig} directive&gt; -->
a89389521ddf76109168a0b339031575aafbd512Christian Maeder<strong>Syntax:</strong> AccessConfig <em>filename</em><br>
a89389521ddf76109168a0b339031575aafbd512Christian Maeder<strong>Default:</strong> <code>AccessConfig conf/access.conf</code><br>
a89389521ddf76109168a0b339031575aafbd512Christian Maeder<strong>Context:</strong> server config, virtual host<br>
a89389521ddf76109168a0b339031575aafbd512Christian Maeder<strong>Status:</strong> core<p>
a89389521ddf76109168a0b339031575aafbd512Christian Maeder
a89389521ddf76109168a0b339031575aafbd512Christian MaederThe server will read this file for more directives after reading the
54ff63bb3b23ef18efbdc51b053a2ca6f348329aChristian Maeder<A HREF="#resourceconfig">ResourceConfig</A> file. <em>Filename</em> is
54ff63bb3b23ef18efbdc51b053a2ca6f348329aChristian Maederrelative to the <A HREF="#serverroot">ServerRoot</A>.
54ff63bb3b23ef18efbdc51b053a2ca6f348329aChristian MaederThis feature can be disabled using:
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<blockquote><code>AccessConfig /dev/null</code></blockquote>
54ff63bb3b23ef18efbdc51b053a2ca6f348329aChristian MaederHistorically, this file only contained
54ff63bb3b23ef18efbdc51b053a2ca6f348329aChristian Maeder<A HREF="#directory">&lt;Directory&gt;</A> sections; in fact it can now
ceef5f7843a1f96fe5a62e0f6880e38b3d5f4708Christian Maedercontain any server directive allowed in the <em>server config</em> context.
54ff63bb3b23ef18efbdc51b053a2ca6f348329aChristian Maeder<p><hr>
54ff63bb3b23ef18efbdc51b053a2ca6f348329aChristian Maeder
ceef5f7843a1f96fe5a62e0f6880e38b3d5f4708Christian Maeder<h2><A name="accessfilename">AccessFileName directive</A></h2>
ceef5f7843a1f96fe5a62e0f6880e38b3d5f4708Christian Maeder<!--%plaintext &lt;?INDEX {\tt AccessFileName} directive&gt; -->
ceef5f7843a1f96fe5a62e0f6880e38b3d5f4708Christian Maeder<strong>Syntax:</strong> AccessFileName <em>filename filename ...</em><br>
54ff63bb3b23ef18efbdc51b053a2ca6f348329aChristian Maeder<strong>Default:</strong> <code>AccessFileName .htaccess</code><br>
ceef5f7843a1f96fe5a62e0f6880e38b3d5f4708Christian Maeder<strong>Context:</strong> server config, virtual host<br>
54ff63bb3b23ef18efbdc51b053a2ca6f348329aChristian Maeder<strong>Status:</strong> core<br>
ee93fb771fcf3000d73c8e2f2000adb4b9a5158cChristian Maeder<strong>Compatibility:</strong> AccessFileName can accept more than one filename only in Apache 1.3 and later<p>
e77eadd37125110f448dd5ddec7da5b78d35285fChristian Maeder
ee93fb771fcf3000d73c8e2f2000adb4b9a5158cChristian MaederWhen returning a document to the client the server looks for the first existing
54ff63bb3b23ef18efbdc51b053a2ca6f348329aChristian Maederaccess control file from this list of names in every directory of the path to
54ff63bb3b23ef18efbdc51b053a2ca6f348329aChristian Maederthe document, if access control files are enabled for that directory.
54ff63bb3b23ef18efbdc51b053a2ca6f348329aChristian Maeder
ceef5f7843a1f96fe5a62e0f6880e38b3d5f4708Christian MaederFor example:
ceef5f7843a1f96fe5a62e0f6880e38b3d5f4708Christian Maeder<blockquote><code>AccessFileName .acl</code></blockquote>
ceef5f7843a1f96fe5a62e0f6880e38b3d5f4708Christian Maederbefore returning the document /usr/local/web/index.html, the
54ff63bb3b23ef18efbdc51b053a2ca6f348329aChristian Maederserver will read /.acl, /usr/.acl, /usr/local/.acl and /usr/local/web/.acl
54ff63bb3b23ef18efbdc51b053a2ca6f348329aChristian Maederfor directives, unless they have been disabled with
ee93fb771fcf3000d73c8e2f2000adb4b9a5158cChristian Maeder<blockquote><code>
67086e0fe40a985c5e8a3cf50e611f43234580c2Christian Maeder&lt;Directory /&gt;<br>
e77eadd37125110f448dd5ddec7da5b78d35285fChristian MaederAllowOverride None<br>
67d92da5e9610aabad39055a16031154b4dc3748Christian Maeder&lt;/Directory&gt;</code></blockquote><p><hr>
ee93fb771fcf3000d73c8e2f2000adb4b9a5158cChristian Maeder
67086e0fe40a985c5e8a3cf50e611f43234580c2Christian Maeder<h2><A name="addmodule">AddModule directive</A></h2>
588c0c022a0f4e129a89c3bc569daf6a835e182dChristian Maeder<!--%plaintext &lt;?INDEX {\tt AddModule} directive&gt; -->
717686b54b9650402e2ebfbaadf433eab8ba5171Christian Maeder<strong>Syntax:</strong> AddModule <em>module module ...</em><br>
717686b54b9650402e2ebfbaadf433eab8ba5171Christian Maeder<strong>Context:</strong> server config <br>
d48085f765fca838c1d972d2123601997174583dChristian Maeder<strong>Status:</strong> core<br>
d48085f765fca838c1d972d2123601997174583dChristian Maeder<strong>Compatibility:</strong> AddModule is only available in Apache 1.2 and later<p>
717686b54b9650402e2ebfbaadf433eab8ba5171Christian Maeder
d48085f765fca838c1d972d2123601997174583dChristian MaederThe server can have modules compiled in which are not actively in use.
d48085f765fca838c1d972d2123601997174583dChristian MaederThis directive can be used to enable the use of those modules. The
588c0c022a0f4e129a89c3bc569daf6a835e182dChristian Maederserver comes with a pre-loaded list of active modules; this list can
d48085f765fca838c1d972d2123601997174583dChristian Maederbe cleared with the <A HREF="#clearmodulelist">ClearModuleList</A>
717686b54b9650402e2ebfbaadf433eab8ba5171Christian Maederdirective.<p><hr>
717686b54b9650402e2ebfbaadf433eab8ba5171Christian Maeder
e7ce154edb906685b3fa7f6c0a764e18a4658068Christian Maeder<h2><A name="allowoverride">AllowOverride directive</A></h2>
b66eb6038bfbcd2fe520d87c151bb4f1f510e985Christian Maeder<!--%plaintext &lt;?INDEX {\tt AllowOverride} directive&gt; -->
9b30898b139ee02f97ac933b6d935ef0a4206921Christian Maeder<strong>Syntax:</strong> AllowOverride <em>override override ...</em><br>
b66eb6038bfbcd2fe520d87c151bb4f1f510e985Christian Maeder<strong>Default:</strong> <code>AllowOverride All</code><br>
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<strong>Context:</strong> directory<br>
b66eb6038bfbcd2fe520d87c151bb4f1f510e985Christian Maeder<strong>Status:</strong> core<p>
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder
b66eb6038bfbcd2fe520d87c151bb4f1f510e985Christian MaederWhen the server finds an .htaccess file (as specified by
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<A HREF="#accessfilename">AccessFileName</A>) it needs to know which
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maederdirectives declared in that file can override earlier access information.<p>
b66eb6038bfbcd2fe520d87c151bb4f1f510e985Christian Maeder
b66eb6038bfbcd2fe520d87c151bb4f1f510e985Christian Maeder<em>Override</em> can be set to <code>None</code>, in which case the server
67d92da5e9610aabad39055a16031154b4dc3748Christian Maederwill not read the file, <code>All</code> in which case the server will
b66eb6038bfbcd2fe520d87c151bb4f1f510e985Christian Maederallow all the directives, or one or more of the following:
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<dl>
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<dt>AuthConfig
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<dd>
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<!--%plaintext &lt;?INDEX {\tt AuthConfig} override&gt; -->
c5c193a80459071696b68baf835f1b88f0f8c82eChristian MaederAllow use of the authorization directives
0a8ea95bcf0e3f84fed0b725c049ec2a956a4a28Christian Maeder(<A HREF="mod_auth_dbm.html#authdbmgroupfile">AuthDBMGroupFile</A>,
967e5f3c25249c779575864692935627004d3f9eChristian Maeder<A HREF="mod_auth_dbm.html#authdbmuserfile">AuthDBMUserFile</A>,
18b513ff41708f24e1a7407f36b719add813ffeaChristian Maeder<A HREF="mod_auth.html#authgroupfile">AuthGroupFile</A>,
dedabc954aa15f6ad0764472a9434dc6dafe3db2Christian Maeder<A HREF="#authname">AuthName</A>, <A HREF="#authtype">AuthType</A>,
a89e661aad28f1b39f4fc9f9f9a4d46074234123Christian Maeder<A HREF="mod_auth.html#authuserfile">AuthUserFile</A>,
a23e572c8f957cc051a1b0831abd6fe9380d45c7Christian Maeder<A HREF="#require">require</A>, etc.).
58b5ac21d1c88344246aaedab0c0bdc7b759d7c6Christian Maeder<dt>FileInfo
58b5ac21d1c88344246aaedab0c0bdc7b759d7c6Christian Maeder<dd>
3c8d067accf18572352351ec42ff905c7297a8a5Christian Maeder<!--%plaintext &lt;?INDEX {\tt FileInfo} override&gt; -->
58b5ac21d1c88344246aaedab0c0bdc7b759d7c6Christian MaederAllow use of the directives controlling document types
f2ee9fc53048ea92bad79e3f5d292d83efd7f8beMihai Codescu(<A HREF="mod_mime.html#addencoding">AddEncoding</A>,
3c8d067accf18572352351ec42ff905c7297a8a5Christian Maeder<A HREF="mod_mime.html#addlanguage">AddLanguage</A>,
81d182b21020b815887e9057959228546cf61b6bChristian Maeder<A HREF="mod_mime.html#addtype">AddType</A>,
58b5ac21d1c88344246aaedab0c0bdc7b759d7c6Christian Maeder<A HREF="#defaulttype">DefaultType</A>,
242397ba0f1cc490e892130bf0df239deeecf5daChristian Maeder<A HREF="#errordocument">ErrorDocument</A>,
2e9985cd67e4f2414becb670ef33b8f16513e41dChristian Maeder<A HREF="mod_negotiation.html#languagepriority">LanguagePriority</A>, etc.).
242397ba0f1cc490e892130bf0df239deeecf5daChristian Maeder<dt>Indexes
58b5ac21d1c88344246aaedab0c0bdc7b759d7c6Christian Maeder<dd>
d769b9ca726a9b50d661847c0e58c41d6ef334b4Christian Maeder<!--%plaintext &lt;?INDEX {\tt Indexes} override&gt; -->
551af0e4ba6d96bb24f3555f3b30ed648e22e34aChristian MaederAllow use of the directives controlling directory indexing
58b5ac21d1c88344246aaedab0c0bdc7b759d7c6Christian Maeder(<A HREF="mod_autoindex.html#adddescription">AddDescription</A>,
551af0e4ba6d96bb24f3555f3b30ed648e22e34aChristian Maeder<A HREF="mod_autoindex.html#addicon">AddIcon</A>,
551af0e4ba6d96bb24f3555f3b30ed648e22e34aChristian Maeder<A HREF="mod_autoindex.html#addiconbyencoding">AddIconByEncoding</A>,
c5c193a80459071696b68baf835f1b88f0f8c82eChristian Maeder<A HREF="mod_autoindex.html#addiconbytype">AddIconByType</A>,
c5c193a80459071696b68baf835f1b88f0f8c82eChristian Maeder<A HREF="mod_autoindex.html#defaulticon">DefaultIcon</A>,
c5c193a80459071696b68baf835f1b88f0f8c82eChristian Maeder<A HREF="mod_autoindex.html#directoryindex">DirectoryIndex</A>,
c5c193a80459071696b68baf835f1b88f0f8c82eChristian Maeder<A HREF="mod_autoindex.html#fancyindexing">FancyIndexing</A>,
c5c193a80459071696b68baf835f1b88f0f8c82eChristian Maeder<A HREF="mod_autoindex.html#headername">HeaderName</A>,
c5c193a80459071696b68baf835f1b88f0f8c82eChristian Maeder<A HREF="mod_autoindex.html#indexignore">IndexIgnore</A>,
58b5ac21d1c88344246aaedab0c0bdc7b759d7c6Christian Maeder<A HREF="mod_autoindex.html#indexoptions">IndexOptions</A>,
ad187062b0009820118c1b773a232e29b879a2faChristian Maeder<A HREF="mod_autoindex.html#readmename">ReadmeName</A>, etc.).
c5c193a80459071696b68baf835f1b88f0f8c82eChristian Maeder<dt>Limit
551af0e4ba6d96bb24f3555f3b30ed648e22e34aChristian Maeder<dd>
dedabc954aa15f6ad0764472a9434dc6dafe3db2Christian Maeder<!--%plaintext &lt;?INDEX {\tt Limit} override&gt; -->
842eedc62639561781b6c33533d1949693ef6cc5Christian MaederAllow use of the directives controlling host access (allow, deny and order).
588c0c022a0f4e129a89c3bc569daf6a835e182dChristian Maeder<dt>Options
588c0c022a0f4e129a89c3bc569daf6a835e182dChristian Maeder<dd>
588c0c022a0f4e129a89c3bc569daf6a835e182dChristian Maeder<!--%plaintext &lt;?INDEX {\tt Options} override&gt; -->
842eedc62639561781b6c33533d1949693ef6cc5Christian MaederAllow use of the directives controlling specific directory features
bfa9e03532243ceb487f0384d0f6a447f1ce7670Till Mossakowski(<A HREF="#options">Options</A> and
967e5f3c25249c779575864692935627004d3f9eChristian Maeder<A HREF="mod_include.html#xbithack">XBitHack</A>).
967e5f3c25249c779575864692935627004d3f9eChristian Maeder</dl><p><hr>
f2ee9fc53048ea92bad79e3f5d292d83efd7f8beMihai Codescu
967e5f3c25249c779575864692935627004d3f9eChristian Maeder<h2><A name="authname">AuthName directive</A></h2>
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian Maeder<!--%plaintext &lt;?INDEX {\tt AuthName} directive&gt; -->
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian Maeder<strong>Syntax:</strong> AuthName <em>auth-domain</em><br>
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian Maeder<strong>Context:</strong> directory, .htaccess<br>
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian Maeder<strong>Override:</strong> AuthConfig<br>
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian Maeder<strong>Status:</strong> core<p>
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian Maeder
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian MaederThis directive sets the name of the authorization realm for a directory.
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian MaederThis realm is given to the client so that the user knows which username and
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian Maederpassword to send.
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian MaederIt must be accompanied by <A HREF="#authtype">AuthType</A> and
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian Maeder<A HREF="#require">require</A> directives, and directives such as
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian Maeder<A HREF="mod_auth.html#authuserfile">AuthUserFile</A> and
967e5f3c25249c779575864692935627004d3f9eChristian Maeder<A HREF="mod_auth.html#authgroupfile">AuthGroupFile</A> to work.<p><hr>
967e5f3c25249c779575864692935627004d3f9eChristian Maeder
ad187062b0009820118c1b773a232e29b879a2faChristian Maeder<h2><A name="authtype">AuthType directive</A></h2>
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian Maeder<!--%plaintext &lt;?INDEX {\tt AuthType} directive&gt; -->
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian Maeder<strong>Syntax:</strong> AuthType <em>type</em><br>
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian Maeder<strong>Context:</strong> directory, .htaccess<br>
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian Maeder<strong>Override:</strong> AuthConfig<br>
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian Maeder<strong>Status:</strong> core<p>
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian Maeder
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian MaederThis directive selects the type of user authentication for a directory.
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian MaederOnly <code>Basic</code> is currently implemented.
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian Maeder<!--%plaintext &lt;?INDEX {\tt Basic} authentication scheme&gt; -->
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian MaederIt must be accompanied by <A HREF="#authname">AuthName</A> and
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian Maeder<A HREF="#require">require</A> directives, and directives such as
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian Maeder<A HREF="mod_auth.html#authuserfile">AuthUserFile</A> and
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian Maeder<A HREF="mod_auth.html#authgroupfile">AuthGroupFile</A> to work.<p><hr>
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian Maeder
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian Maeder<h2><A name="bindaddress">BindAddress directive</A></h2>
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<!--%plaintext &lt;?INDEX {\tt BindAddress} directive&gt; -->
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<strong>Syntax:</strong> BindAddress <em>saddr</em><br>
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<strong>Default:</strong> <code>BindAddress *</code><br>
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<strong>Context:</strong> server config<br>
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<strong>Status:</strong> core<p>
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder
1a75698c909ad515d59c76e65bd783f015c21c4dChristian MaederA Unix&#174; http server can either listen for connections to every
1a75698c909ad515d59c76e65bd783f015c21c4dChristian MaederIP address of the server machine, or just one IP address of the server
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maedermachine. <em>Saddr</em> can be
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian Maeder
ad187062b0009820118c1b773a232e29b879a2faChristian Maeder<menu>
ad187062b0009820118c1b773a232e29b879a2faChristian Maeder<li>*
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian Maeder<li>An IP address
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian Maeder<li>A fully-qualified Internet domain name
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder</menu>
1a75698c909ad515d59c76e65bd783f015c21c4dChristian MaederIf the value is *, then the server will listen for connections on
ad187062b0009820118c1b773a232e29b879a2faChristian Maederevery IP address, otherwise it will only listen on the IP address
ad187062b0009820118c1b773a232e29b879a2faChristian Maederspecified. <p>
ad187062b0009820118c1b773a232e29b879a2faChristian Maeder
1a75698c909ad515d59c76e65bd783f015c21c4dChristian MaederOnly one <code>BindAddress</code> directive can be used. For more
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maedercontrol over which address and ports Apache listens to, use the
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian Maeder<code><a href="#listen">Listen</a></code> directive instead of
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian Maeder<code>BindAddress</code>.<p>
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian Maeder
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian Maeder<code>BindAddress</code> can be used as an alternative method for
9659c509ce5e78adc51d7b02a76274eddcba9338Christian Maedersupporting <A HREF="/virtual-host.html">virtual hosts</A> using
9659c509ce5e78adc51d7b02a76274eddcba9338Christian Maedermultiple independent servers, instead of using <code><A
1a75698c909ad515d59c76e65bd783f015c21c4dChristian MaederHREF="#virtualhost">&lt;VirtualHost&gt;</A></code> sections.
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<p><strong>See Also:</strong>
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian Maeder<a href="/dns-caveats.html">DNS Issues</a><br>
9659c509ce5e78adc51d7b02a76274eddcba9338Christian Maeder<strong>See Also:</strong>
9659c509ce5e78adc51d7b02a76274eddcba9338Christian Maeder<a href="/bind.html">Setting which addresses and ports Apache uses</a></p>
551af0e4ba6d96bb24f3555f3b30ed648e22e34aChristian Maeder
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian Maeder<hr>
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian Maeder
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<h2><A name="clearmodulelist">ClearModuleList directive</A></h2>
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian Maeder<!--%plaintext &lt;?INDEX {\tt ClearModuleList} directive&gt; -->
83814002b4922114cbe7e9ba728472a0bf44aac5Christian Maeder<strong>Syntax:</strong> ClearModuleList<br>
83814002b4922114cbe7e9ba728472a0bf44aac5Christian Maeder<strong>Context:</strong> server config<br>
a95f5379cabb30d3beb0545002cf50e9e4fc2c86Christian Maeder<strong>Status:</strong> core<br>
97ee7048e63953c5617342ce38c30cbcb35cc0beChristian Maeder<strong>Compatibility:</strong> ClearModuleList is only available in Apache 1.2 and later<p>
97ee7048e63953c5617342ce38c30cbcb35cc0beChristian Maeder
b66eb6038bfbcd2fe520d87c151bb4f1f510e985Christian MaederThe server comes with a built-in list of active modules. This
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maederdirective clears the list. It is assumed that the list will then be
b66eb6038bfbcd2fe520d87c151bb4f1f510e985Christian Maederre-populated using the <A HREF="#addmodule">AddModule</A> directive.<p><hr>
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<h2><A name="coredumpdirectory">CoreDumpDirectory directive</A></h2>
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<!--%plaintext &lt;?INDEX {\tt CoreDumpDirectory} directive&gt; -->
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<strong>Syntax:</strong> CoreDumpDirectory <em>directory</em><br>
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder<strong>Default:</strong> the same location as ServerRoot<br>
588c0c022a0f4e129a89c3bc569daf6a835e182dChristian Maeder<strong>Context:</strong> server config<br>
b66eb6038bfbcd2fe520d87c151bb4f1f510e985Christian Maeder<strong>Status:</strong> core<p>
2dfc7b04f2db681992ca04175f2beb0f127c9844Christian Maeder
2dfc7b04f2db681992ca04175f2beb0f127c9844Christian MaederThis controls the directory to which Apache attempts to switch before
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maederdumping core. The default is in the <A HREF="#serverroot">ServerRoot</A>
dedabc954aa15f6ad0764472a9434dc6dafe3db2Christian Maederdirectory, however since this should not be writable by the user
ad187062b0009820118c1b773a232e29b879a2faChristian Maederthe server runs as, core dumps won't normally get written. If you
ad187062b0009820118c1b773a232e29b879a2faChristian Maederwant a core dump for debugging, you can use this directive to place
588c0c022a0f4e129a89c3bc569daf6a835e182dChristian Maederit in a different location.<p><hr>
1a75698c909ad515d59c76e65bd783f015c21c4dChristian Maeder
588c0c022a0f4e129a89c3bc569daf6a835e182dChristian Maeder<h2><A name="defaulttype">DefaultType directive</A></h2>
ad187062b0009820118c1b773a232e29b879a2faChristian Maeder<!--%plaintext &lt;?INDEX {\tt DefaultType} directive&gt; -->
07b72edb610ee53b4832d132e96b0a3d8423f8ebChristian Maeder<strong>Syntax:</strong> DefaultType <em>mime-type</em><br>
<strong>Default:</strong> <code>DefaultType text/html</code><br>
<strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
<strong>Override:</strong> FileInfo<br>
<strong>Status:</strong> core<p>
There will be times when the server is asked to provide a document
whose type cannot be determined by its MIME types mappings.<p>
The server must inform the client of the content-type of the document, so in
the event of an unknown type it uses the <CODE>DefaultType</CODE>. For
example:
<blockquote><code>DefaultType image/gif</code></blockquote>
would be appropriate for a directory which contained many gif images
with filenames missing the .gif extension.<p><hr>
<h2><A name="directory">&lt;Directory&gt; directive</A></h2>
<!--%plaintext &lt;?INDEX {\tt Directory} section directive&gt; -->
<strong>Syntax:</strong> &lt;Directory <em>directory</em>&gt; ... &lt;/Directory&gt; <br>
<strong>Context:</strong> server config, virtual host<br>
<strong>Status:</strong> Core. <p>
&lt;Directory&gt; and &lt;/Directory&gt; are used to enclose a group of
directives which will apply only to the named directory and sub-directories
of that directory. Any directive which is allowed in a directory
context may be used. <em>Directory</em> is either the full path to a directory,
or a wild-card string. In a wild-card string, `?' matches any single character,
and `*' matches any sequences of characters. As of Apache 1.3, you
may also use `[]' character ranges like in the shell. Also as of Apache 1.3
none of the wildcards match a `/' character, which more closely mimics the
behaviour of Unix shells.
Example:
<pre>
&lt;Directory /usr/local/httpd/htdocs&gt;
Options Indexes FollowSymLinks
&lt;/Directory&gt;
</pre>
<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;Directory ~ &quot;^/www/.*/[0-9]{3}&quot;&gt;
</pre>
would match directories in /www/ that consisted of three numbers.</p>
<p>If multiple (non-regular expression) directory sections match the
directory (or its parents) containing
a document, then the directives are applied in the order of shortest match
first, interspersed with the directives from the
<A HREF="#accessfilename">.htaccess</A> files. For example, with
<blockquote><code>
&lt;Directory /&gt;<br>
AllowOverride None<br>
&lt;/Directory&gt;<br><br>
&lt;Directory /home/*&gt;<br>
AllowOverride FileInfo<br>
&lt;/Directory&gt;</code></blockquote>
for access to the document <code>/home/web/dir/doc.html</code> the
steps are:
<menu>
<li>Apply directive <code>AllowOverride None</code> (disabling
<code>.htaccess</code> files).
<li>Apply directive <code>AllowOverride FileInfo</code> (for directory
<code>/home/web</code>).
<li>Apply any FileInfo directives in <code>/home/web/.htaccess</code>
</menu>
<P>
Regular expression directory sections are handled slightly differently
by Apache 1.2 and 1.3. In Apache 1.2 they are interspersed with the normal
directory sections and applied in the order they appear in the configuration
file. They are applied only once, and apply when the shortest match
possible occurs. In Apache 1.3 regular expressions are not considered
until after all of the normal sections have been applied. Then all of
the regular expressions are tested in the order they appeared in the
configuration file. For example, with
<blockquote><code>
&lt;Directory ~ abc$&gt;<br>
... directives here ...<br>
&lt;/Directory&gt;<br>
</code></blockquote>
Suppose that the filename being accessed is
<code>/home/abc/public_html/abc/index.html</code>. The server
considers each of <code>/</code>, <code>/home</code>, <code>/home/abc</code>,
<code>/home/abc/public_html</code>, and <code>/home/abc/public_html/abc</code>
in that order. In Apache 1.2, when
<code>/home/abc</code> is considered, the regular expression will match
and be applied. In Apache 1.3 the regular expression isn't considered
at all at that point in the tree. It won't be considered until after
all normal &lt;Directory&gt;s and <code>.htaccess</code> files have
been applied. Then the regular expression will
match on <code>/home/abc/public_html/abc</code> and be applied.
<P>
<STRONG>
Note that the default Apache access for &lt;Directory /&gt; is
<SAMP>Allow from All</SAMP>. This means that Apache will serve any file
mapped from an URL. It is recommended that you change this with a block
such as
</STRONG>
<PRE>
&lt;Directory /&gt;
Order Deny,Allow
Deny from All
&lt;/Directory&gt;
</PRE>
<P>
<STRONG>
and then override this for directories you <EM>want</EM> accessible.
See the
<A
HREF="/misc/security_tips.html"
>Security Tips</A>
page for more details.
</STRONG>
</P>
The directory sections typically occur in the access.conf file, but they
may appear in any configuration file. &lt;Directory&gt; directives cannot
nest, and cannot appear in a <A HREF="#limit">&lt;Limit&gt;</A> section.
<p><hr>
<h2><A name="directorymatch">&lt;DirectoryMatch&gt;</A></h2>
<strong>Syntax:</strong> &lt;DirectoryMatch <em>regex</em>&gt; ... &lt;/DirectoryMatch&gt; <br>
<strong>Context:</strong> server config, virtual host<br>
<strong>Status:</strong> Core.<br>
<strong>Compatibility:</strong> Available in Apache 1.3 and later
<p>&lt;DirectoryMatch&gt; and &lt;/DirectoryMatch&gt; are used to enclose a group of
directives which will apply only to the named directory and sub-directories
of that directory, the same as <a
href="#directory">&lt;Directory&gt;</a>. However, it takes as an
argument a regular expression. For example:</p>
<pre>
&lt;DirectoryMatch &quot;^/www/.*/[0-9]{3}&quot;&gt;
</pre>
<p>would match directories in /www/ that consisted of three numbers.</p>
<p><strong>See Also:</strong>
<a href="#directory">&lt;Directory&gt;</a> for a description of how
regular expressions are mixed in with normal &lt;Directory&gt;s.</p>
<hr>
<h2><A NAME="documentroot">DocumentRoot directive</A></h2>
<!--%plaintext &lt;?INDEX {\tt DocumentRoot} directive&gt; -->
<strong>Syntax:</strong> DocumentRoot <em>directory-filename</em><br>
<strong>Default:</strong> <code>DocumentRoot
/usr/local/etc/httpd/htdocs</code><br>
<strong>Context:</strong> server config, virtual host<br>
<strong>Status:</strong> core<p>
This directive sets the directory from which httpd will serve files.
Unless matched by a directive like Alias, the server appends the path
from the requested URL to the document root to make the path to the
document. Example:
<blockquote><code>DocumentRoot /usr/web</code></blockquote>
then an access to <code>http://www.my.host.com/index.html</code> refers
to <code>/usr/web/index.html</code>.
<P>There appears to be a bug in mod_dir which causes problems when the
DocumentRoot has a trailing slash (i.e. "DocumentRoot /usr/web/") so
please avoid that.
<p><hr>
<h2><A name="errordocument">ErrorDocument directive</A></h2>
<!--%plaintext &lt;?INDEX {\tt ErrorDocument} directive&gt; -->
<strong>Syntax:</strong> ErrorDocument <em>error-code document</em><br>
<strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
<strong>Status:</strong> core<br>
<strong>Override:</strong> FileInfo<br>
<strong>Compatibility:</strong> The directory and .htaccess contexts
are only available in Apache 1.1 and later.<p>
In the event of a problem or error, Apache can be configured to do
one of four things,
<OL>
<LI>output a simple hardcoded error message
<LI>output a customized message
<LI>redirect to a local URL to handle the problem/error
<LI>redirect to an external URL to handle the problem/error
</OL>
<P>The first option is the default, while options 2-4 are configured
using the <CODE>ErrorDocument</CODE> directive, which is followed by
the HTTP response code and a message or URL.
<P><em>Messages</em> in this context begin with a single quote
(<code>"</code>), which does not form part of the message itself.
Apache will sometimes offer additional information regarding the
problem/error.
<P>URLs can begin with a slash (/) for local URLs, or be a full
URL which the client can resolve. Examples:
<blockquote><code>
ErrorDocument 500 http://foo.example.com/cgi-bin/tester<br>
ErrorDocument 404 /cgi-bin/bad_urls.pl<br>
ErrorDocument 401 /subscription_info.html<br>
ErrorDocument 403 "Sorry can't allow you access today
</code></blockquote>
<P>Note that when you specify an <CODE>ErrorDocument</CODE> that
points to a remote URL (ie. anything with a method such as "http" in
front of it) Apache will send a redirect to the client to tell it
where to find the document, even if the document ends up being
on the same server.. This has several implications, the
most important being that <STRONG>if you use an "ErrorDocument 401"
directive then it must refer to a local document.</STRONG> This results
from the nature of the HTTP basic authentication scheme.
<P>See Also: <A HREF="/custom-error.html">documentation of customizable
responses.</A><p><hr>
<h2><A name="errorlog">ErrorLog directive</A></h2>
<!--%plaintext &lt;?INDEX {\tt ErrorLog} directive&gt; -->
<strong>Syntax:</strong> ErrorLog <em>filename</em><br>
<strong>Default:</strong> <code>ErrorLog logs/error_log</code><br>
<strong>Context:</strong> server config, virtual host<br>
<strong>Status:</strong> core<p>
The error log directive sets the name of the file to which the server will log
any errors it encounters. If the filename does not begin with a slash (/)
then it is assumed to be relative to the <A HREF="#serverroot">ServerRoot</A>.
Example:
<blockquote><code>ErrorLog /dev/null</code></blockquote>
This effectively turns off error logging.<p>
SECURITY: 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><hr>
<h2><A name="files">&lt;Files&gt; directive</A></h2>
<strong>Syntax:</strong> &lt;Files <em>filename</em>&gt;
... &lt;/Files&gt;<br>
<strong>Context:</strong> server config, virtual host, .htaccess<br>
<strong>Status:</strong> core<br>
<strong>Compatibility:</strong> only available in Apache
1.2 and above.<p>
<p>The &lt;Files&gt; directive provides for access control by
filename. It is comparable to the <a
href="#directory">&lt;Directory&gt;</a> directive and
<a href="#location">&lt;Location&gt;</a> directives. It
should be matched with a &lt;/Files&gt; directive. Directives that
apply to the filename given should be listed
within. <code>&lt;Files&gt;</code> sections are processed in the
order they appear in the configuration file, after the
&lt;Directory&gt; sections and <code>.htaccess</code> files are
read, but before &lt;Location&gt; sections.</p>
<p>The <em>filename</em> argument should include a filename, or a
wild-card string, where `?' matches any single character, and `*' matches any
sequences of characters. Extended regular expressions can also be used,
with the addition of
the <code>~</code> character. For example:</p>
<pre>
&lt;Files ~ &quot;\.(gif|jpe?g|png)$&quot;&gt;
</pre>
would match most common Internet graphics formats. In Apache 1.3 and
later, <a href="#filesmatch">&lt;FilesMatch&gt;</a> is preferred,
however.
<p>Note that unlike <a
href="#directory"><code>&lt;Directory&gt;</code></a> and <a
href="#location"><code>&lt;Location&gt;</code></a> sections,
<code>&lt;Files&gt;</code> sections can be used inside .htaccess
files. This allows users to control access to their own files, at a
file-by-file level. When used in an .htaccess file, if the
<em>filename</em> does not begin with a <code>/</code> character,
the directory being applied will be prefixed automatically.
<p> <hr>
<h2><A name="filesmatch">&lt;FilesMatch&gt;</A></h2>
<strong>Syntax:</strong> &lt;FilesMatch <em>regex</em>&gt;
... &lt;/Files&gt;<br>
<strong>Context:</strong> server config, virtual host, .htaccess<br>
<strong>Status:</strong> core<br>
<strong>Compatibility:</strong> only available in Apache
1.3 and above.<p>
<p>The &lt;FilesMatch&gt; directive provides for access control by
filename, just as the <a href="#files">&lt;Files&gt;</a> directive
does. However, it accepts a regular expression. For example:</p>
<pre>
&lt;FilesMatch &quot;\.(gif|jpe?g|png)$&quot;&gt;
</pre>
<p>would match most common Internet graphics formats.</p>
<hr>
<h2><A name="group">Group directive</A></h2>
<!--%plaintext &lt;?INDEX {\tt Group} directive&gt; -->
<strong>Syntax:</strong> Group <em>unix-group</em><br>
<strong>Default:</strong> <code>Group #-1</code><br>
<strong>Context:</strong> server config, virtual host<br>
<strong>Status:</strong> core<p>
The Group directive sets the group under which the server will answer requests.
In order to use this directive, the stand-alone server must be run initially
as root. <em>Unix-group</em> is one of:
<dl>
<dt>A group name
<dd>Refers to the given group by name.
<dt># followed by a group number.
<dd>Refers to a group by its number.
</dl>
It is recommended that you set up a new group specifically for running the
server. Some admins use user <code>nobody</code>, but this is not always
possible or desirable.<p>
Note: if you start the server as a non-root user, it will fail to change
to the specified group, and will instead continue to run as the group of the
original user. <p>
Special note: Use of this directive in &lt;VirtualHost&gt; requires a
properly configured <A HREF="/suexec.html">suEXEC wrapper</A>.
When used inside a &lt;VirtualHost&gt; in this manner, only the group
that CGIs are run as is affected. Non-CGI requests are still processed
as the group specified in the main Group directive.<p>
SECURITY: See <A HREF="#user">User</A> for a discussion of the security
considerations.<p><hr>
<h2><A name="hostnamelookups">HostNameLookups directive</A></h2>
<!--%plaintext &lt;?INDEX {\tt HostNameLookups} directive&gt; -->
<strong>Syntax:</strong> HostNameLookups <em>on | off | double</em><br>
<strong>Default:</strong> <code>HostNameLookups off</code><br>
<strong>Context:</strong> server config, virtual host<br>
<strong>Status:</strong> core<br>
<strong>Compatibility:</strong> <code>double</code> available only in Apache
1.3 and above.<br>
<strong>Compatibility:</strong> Default was <code>on</code> prior to Apache
1.3.<p>
This directive enables DNS lookups so that host names can be logged (and
passed to CGIs/SSIs in <code>REMOTE_HOST</code>).
The value <code>double</code> refers to doing double-reverse DNS.
That is, after a reverse lookup is performed, a forward lookup is then
performed on that result. At least one of the ip addresses in the forward
lookup must match the original address. (In "tcpwrappers" terminology
this is called <code>PARANOID</code>.)<p>
Regardless of the setting, when <a href="mod_access.html">mod_access</a>
is used for controlling access by hostname, a double reverse lookup
will be performed. This is necessary for security. Note that the
result of this double-reverse isn't generally available unless
you set <code>HostnameLookups double</code>. For example, if only
<code>HostnameLookups on</code> and a request is made to an object that
is protected by hostname restrictions, regardless of whether the
double-reverse fails or not, CGIs will still be passed the single-reverse
result in <code>REMOTE_HOST</code>.<p>
The default for this directive was previously <code>on</code> in
versions of Apache prior to 1.3. It was changed to <code>off</code>
in order to save the network traffic for those sites that don't truly
need the reverse lookups done. It is also better for the end users
because they don't have to suffer the extra latency that a lookup
entails.
Heavily loaded sites should leave this directive <code>off</code>, since DNS
lookups can take considerable amounts of time. The utility <i>logresolve</i>,
provided in the <i>/support</i> directory, can be used to look up host names
from logged IP addresses offline.<p><hr>
<h2><A name="identitycheck">IdentityCheck directive</A></h2>
<!--%plaintext &lt;?INDEX {\tt IdentityCheck} directive&gt; -->
<strong>Syntax:</strong> IdentityCheck <em>boolean</em><br>
<strong>Default:</strong> <code>IdentityCheck off</code><br>
<strong>Context:</strong> server config, virtual host<br>
<strong>Status:</strong> core<p>
This directive enables RFC1413-compliant logging of the remote user name
for each connection, where the client machine runs identd or something similar.
This information is logged in the access log. <em>Boolean</em> is either
<code>on</code> or <code>off</code>.<p>
The information should not be trusted in any way except for rudimentary usage
tracking.<p>
Note that this can cause serious latency problems accessing your server
since every request requires one of these lookups to be performed. When
firewalls are involved each lookup might possibly fail and add 30 seconds
of latency to each hit. So in general this is not very useful on public
servers accessible from the Internet.
<p><hr>
<H2><A NAME="ifmodule">&lt;IfModule&gt; directive</A></H2>
<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="include">Include directive</a></h2>
<strong>Syntax: (Apache 1.2)</strong> Include <em>filename</em><br>
<strong>Context:</strong> server config<br>
<strong>Status:</strong> Core<br>
<strong>Compatibility:</strong> Include is only available in Apache 1.3 and later.
<P>
This directive allows inclusion of other configuration files from within the server configuration files.
<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><hr>
<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 <code><a
href="#port">Port</a></code> directive.</p>
<tt>Listen</tt> can be used instead of <tt><a
href="bindaddress">BindAddress</a></tt> and <tt>Port</tt>. It tells
the server to accept incoming requests on the specified port or
address-and-port combination. If the first format is used, with a port
number only, the server listens to the given port on all interfaces,
instead of the port given by the <tt>Port</tt> directive. If an IP
address is given as well as a port, the server will listen on the
given port and interface. <p>
Note that you may still require a <tt>Port</tt> directive so
that URLs that Apache generates that point to your server still
work.<p>
Multiple Listen directives may be used
to specify a number of addresses and ports to listen to. The server
will respond to requests from any of the listed addresses and
ports.
<p>
For example, to make the server accept connections on both port
80 and port 8000, use:
<pre>
Listen 80
Listen 8000
</pre>
To make the server accept connections on two specified
interfaces and port numbers, use
<pre>
Listen 192.170.2.1:80
Listen 192.170.2.5:8000
</pre>
<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.</p><hr>
<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 preferred.</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.</p><hr>
<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> <e>Unset; uses operating system defaults</e><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> <e>Unset; uses operating system defaults</e><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> <e>Unset; uses operating system defaults</e><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, different port number 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>NOTE</strong>: The use of &lt;VirtualHost&gt; does
<strong>not</strong> affect what addresses Apache listens on. You may
need to ensure that Apache is listening on the correct addresses using
either <a href="#bindaddress">BindAddress</a> or <a
href="#listen">Listen</a>.
<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><br>
<strong>See also:</strong>
<a href="/bind.html">Setting which addresses and ports Apache uses</a>
</p>
<!--#include virtual="footer.html" -->
</BODY>
</HTML>