core.html revision 32ed30210ab8f16d81e27f751121e6939d11ce25
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
d63ae51ba337165172a9b50fd5d84805ffe50044Tinderbox User<HTML>
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence<HEAD>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<TITLE>Apache Core Features</TITLE>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews</HEAD>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<BODY
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein BGCOLOR="#FFFFFF"
47058d17266420179fa294de6b82d8fb5b918df4Michael Sawyer TEXT="#000000"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer LINK="#0000FF"
5dcc67a0fff89e7ebf051f64b6b987862c331a04Mark Andrews VLINK="#000080"
0819ae2ca51571d205df061b52d8468889f3a0dfMichael Sawyer ALINK="#FF0000"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer>
5dcc67a0fff89e7ebf051f64b6b987862c331a04Mark Andrews<!--#include virtual="header.html" -->
5dcc67a0fff89e7ebf051f64b6b987862c331a04Mark Andrews
5dcc67a0fff89e7ebf051f64b6b987862c331a04Mark Andrews<H1 ALIGN="CENTER">Apache Core Features</H1>
5dcc67a0fff89e7ebf051f64b6b987862c331a04Mark Andrews<P>
5dcc67a0fff89e7ebf051f64b6b987862c331a04Mark AndrewsThese configuration parameters control the core Apache features, and are
5dcc67a0fff89e7ebf051f64b6b987862c331a04Mark Andrewsalways available.
5dcc67a0fff89e7ebf051f64b6b987862c331a04Mark Andrews</P>
5dcc67a0fff89e7ebf051f64b6b987862c331a04Mark Andrews<H2>Directives</H2>
5dcc67a0fff89e7ebf051f64b6b987862c331a04Mark Andrews<UL>
5dcc67a0fff89e7ebf051f64b6b987862c331a04Mark Andrews<LI><A HREF="#accessconfig">AccessConfig</A>
5dcc67a0fff89e7ebf051f64b6b987862c331a04Mark Andrews<LI><A HREF="#accessfilename">AccessFileName</A>
c9defbf4b968e8a61f391246431ac63d0d6a39abMichael Sawyer<LI><A HREF="#addmodule">AddModule</A>
c9defbf4b968e8a61f391246431ac63d0d6a39abMichael Sawyer<LI><A HREF="#allowoverride">AllowOverride</A>
6d3f954c572db02159deedd444373161fda47a88Brian Wellington<LI><A HREF="#authname">AuthName</A>
db080b7310851fc975f66fc017ff0c3825e5391aAndreas Gustafsson<LI><A HREF="#authtype">AuthType</A>
c9defbf4b968e8a61f391246431ac63d0d6a39abMichael Sawyer<LI><A HREF="#bindaddress">BindAddress</A>
c9defbf4b968e8a61f391246431ac63d0d6a39abMichael Sawyer<LI><A HREF="#bs2000account">BS2000Account</A>
1893b56ef9f5f2bc2a0fbe80d3c6b69df1bdc7c2Michael Sawyer<LI><A HREF="#clearmodulelist">ClearModuleList</A>
21f1794606dce19928cf455029e173321f166380Mark Andrews<LI><A HREF="#contentdigest">ContentDigest</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#coredumpdirectory">CoreDumpDirectory</A>
6d3f954c572db02159deedd444373161fda47a88Brian Wellington<LI><A HREF="#defaulttype">DefaultType</A>
6d3f954c572db02159deedd444373161fda47a88Brian Wellington<LI><A HREF="#directory">&lt;Directory&gt;</A>
24139527f3d0d3fe743bd867329a2edd529728a6Andreas Gustafsson<LI><A HREF="#directorymatch">&lt;DirectoryMatch&gt;</A>
24139527f3d0d3fe743bd867329a2edd529728a6Andreas Gustafsson<LI><A HREF="#documentroot">DocumentRoot</A>
24139527f3d0d3fe743bd867329a2edd529728a6Andreas Gustafsson<LI><A HREF="#errordocument">ErrorDocument</A>
aa6054ec74819f754bcf19442ca9b39d948171adMichael Sawyer<LI><A HREF="#errorlog">ErrorLog</A>
24139527f3d0d3fe743bd867329a2edd529728a6Andreas Gustafsson<LI><A HREF="#files">&lt;Files&gt;</A>
aa6054ec74819f754bcf19442ca9b39d948171adMichael Sawyer<LI><A HREF="#filesmatch">&lt;FilesMatch&gt;</A>
9a8cec4995c1586d27e95f13d421e4de61a97eb5Mark Andrews<LI><A HREF="#group">Group</A>
24139527f3d0d3fe743bd867329a2edd529728a6Andreas Gustafsson<LI><A HREF="#hostnamelookups">HostNameLookups</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#identitycheck">IdentityCheck</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#ifdefine">&lt;IfDefine&gt;</A>
0e0e575ec135a983a53c501cf48734b823361ab4Brian Wellington<LI><A HREF="#ifmodule">&lt;IfModule&gt;</A>
2706bea98ef713e844670b85274af9502f87d7bcMichael Graff<LI><A HREF="#include">Include</A>
e9b85f0309c6bb6eebc2d6a0acf6a8f3bcc376acTatuya JINMEI 神明達哉<LI><A HREF="#keepalive">KeepAlive</A>
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉<LI><A HREF="#keepalivetimeout">KeepAliveTimeout</A>
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉<LI><A HREF="#limit">&lt;Limit&gt;</A>
8d18fc189ff99f37544b1a0763e8931a7305a7f8Mark Andrews<LI><A HREF="#limitrequestbody">LimitRequestBody</A>
b8a04d50a361eb5e6a6b098d530daa0c56c6fdd9Mark Andrews<LI><A HREF="#limitrequestfields">LimitRequestFields</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#limitrequestfieldsize">LimitRequestFieldsize</A>
7efc8c3f692fc3226c00ce8bdc1b90eb06562352David Lawrence<LI><A HREF="#limitrequestline">LimitRequestLine</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#listen">Listen</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#listenbacklog">ListenBacklog</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#location">&lt;Location&gt;</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#locationmatch">&lt;LocationMatch&gt;</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#lockfile">LockFile</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#loglevel">LogLevel</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#maxclients">MaxClients</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#maxkeepaliverequests">MaxKeepAliveRequests</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#maxrequestsperchild">MaxRequestsPerChild</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#maxspareservers">MaxSpareServers</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#minspareservers">MinSpareServers</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#namevirtualhost">NameVirtualHost</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#options">Options</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#pidfile">PidFile</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#port">Port</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#require">require</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#resourceconfig">ResourceConfig</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#rlimitcpu">RLimitCPU</A>
7efc8c3f692fc3226c00ce8bdc1b90eb06562352David Lawrence<LI><A HREF="#rlimitmem">RLimitMEM</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#rlimitnproc">RLimitNPROC</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#satisfy">Satisfy</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#scoreboardfile">ScoreBoardFile</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#scriptinterpretersource">ScriptInterpreterSource</A>
da5d1cf1b1aa29ae53a0427be49291b04bd60549Mark Andrews<LI><A HREF="#sendbuffersize">SendBufferSize</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#serveradmin">ServerAdmin</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#serveralias">ServerAlias</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#servername">ServerName</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#serverpath">ServerPath</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#serverroot">ServerRoot</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#serversignature">ServerSignature</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#servertokens">ServerTokens</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#servertype">ServerType</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#startservers">StartServers</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#threadsperchild">ThreadsPerChild</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#timeout">TimeOut</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#usecanonicalname">UseCanonicalName</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#user">User</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI><A HREF="#virtualhost">&lt;VirtualHost&gt;</A>
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson</UL>
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson<HR>
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson<H2><A NAME="accessconfig">AccessConfig directive</A></H2>
1d2f2d7c9ab1c38a80f38dbbde26fe1d65a26144Michael Sawyer<!--%plaintext &lt;?INDEX {\tt AccessConfig} directive&gt; -->
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson<A
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson HREF="directive-dict.html#Syntax"
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson REL="Help"
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson><STRONG>Syntax:</STRONG></A> AccessConfig <EM>filename</EM><BR>
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson<A
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson HREF="directive-dict.html#Default"
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson REL="Help"
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson><STRONG>Default:</STRONG></A> <CODE>AccessConfig conf/access.conf</CODE><BR>
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson<A
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson HREF="directive-dict.html#Context"
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson REL="Help"
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson><STRONG>Context:</STRONG></A> server config, virtual host<BR>
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson<A
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson HREF="directive-dict.html#Status"
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson REL="Help"
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson><STRONG>Status:</STRONG></A> core<P>
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael SawyerThe server will read this file for more directives after reading the
d302a620e0d49811874b9555ac2e4c6e05861a6bFrancis Dupont<A HREF="#resourceconfig">ResourceConfig</A> file. <EM>Filename</EM> is
d302a620e0d49811874b9555ac2e4c6e05861a6bFrancis Dupontrelative to the <A HREF="#serverroot">ServerRoot</A>.
d302a620e0d49811874b9555ac2e4c6e05861a6bFrancis DupontThis feature can be disabled using:
d302a620e0d49811874b9555ac2e4c6e05861a6bFrancis Dupont<BLOCKQUOTE><CODE>AccessConfig /dev/null</CODE></BLOCKQUOTE>
d302a620e0d49811874b9555ac2e4c6e05861a6bFrancis DupontHistorically, this file only contained
d302a620e0d49811874b9555ac2e4c6e05861a6bFrancis Dupont<A HREF="#directory">&lt;Directory&gt;</A> sections; in fact it can now
d302a620e0d49811874b9555ac2e4c6e05861a6bFrancis Dupontcontain any server directive allowed in the <EM>server config</EM> context.
d302a620e0d49811874b9555ac2e4c6e05861a6bFrancis Dupont<P><HR>
d302a620e0d49811874b9555ac2e4c6e05861a6bFrancis Dupont
d302a620e0d49811874b9555ac2e4c6e05861a6bFrancis Dupont<H2><A NAME="accessfilename">AccessFileName directive</A></H2>
d302a620e0d49811874b9555ac2e4c6e05861a6bFrancis Dupont<!--%plaintext &lt;?INDEX {\tt AccessFileName} directive&gt; -->
d302a620e0d49811874b9555ac2e4c6e05861a6bFrancis Dupont<A
d302a620e0d49811874b9555ac2e4c6e05861a6bFrancis Dupont HREF="directive-dict.html#Syntax"
d302a620e0d49811874b9555ac2e4c6e05861a6bFrancis Dupont REL="Help"
d302a620e0d49811874b9555ac2e4c6e05861a6bFrancis Dupont><STRONG>Syntax:</STRONG></A> AccessFileName <EM>filename filename ...</EM><BR>
d302a620e0d49811874b9555ac2e4c6e05861a6bFrancis Dupont<A
d302a620e0d49811874b9555ac2e4c6e05861a6bFrancis Dupont HREF="directive-dict.html#Default"
debd489a44363870f96f75818e89ec27d3cab736Francis Dupont REL="Help"
debd489a44363870f96f75818e89ec27d3cab736Francis Dupont><STRONG>Default:</STRONG></A> <CODE>AccessFileName .htaccess</CODE><BR>
debd489a44363870f96f75818e89ec27d3cab736Francis Dupont<A
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer HREF="directive-dict.html#Context"
d0ad6ddcdd20c637477e12d757090cb0b5ff81cbDavid Lawrence REL="Help"
24139527f3d0d3fe743bd867329a2edd529728a6Andreas Gustafsson><STRONG>Context:</STRONG></A> server config, virtual host<BR>
555469af35c12189525921abbc3de3cefb5f9f0fMark Andrews<A
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrews HREF="directive-dict.html#Status"
5d3083c4b5b11dfb653b15fd0eeb8e0cc9b175e0Mark Andrews REL="Help"
7949dbdae1db33e6263d754e5940daa1dfba59f9Michael Sawyer><STRONG>Status:</STRONG></A> core<BR>
aa5e0fe0fc4a901517754c4cba1c20f075f8c2efBrian Wellington<A
7949dbdae1db33e6263d754e5940daa1dfba59f9Michael Sawyer HREF="directive-dict.html#Compatibility"
ec3984e9df6fd9b7811daa0dacb1b3dd1423ebf3Mark Andrews REL="Help"
555469af35c12189525921abbc3de3cefb5f9f0fMark Andrews><STRONG>Compatibility:</STRONG></A> AccessFileName can accept more than
555469af35c12189525921abbc3de3cefb5f9f0fMark Andrewsone filename only in Apache 1.3 and later<P>
7949dbdae1db33e6263d754e5940daa1dfba59f9Michael Sawyer
7949dbdae1db33e6263d754e5940daa1dfba59f9Michael SawyerWhen returning a document to the client the server looks for the first existing
7949dbdae1db33e6263d754e5940daa1dfba59f9Michael Sawyeraccess control file from this list of names in every directory of the path to
3d711f2f75cb9a9ddcbf1fca9b2de192e75340e6Mark Andrewsthe document, if access control files are enabled for that directory.
7949dbdae1db33e6263d754e5940daa1dfba59f9Michael Sawyer
7949dbdae1db33e6263d754e5940daa1dfba59f9Michael SawyerFor example:
7949dbdae1db33e6263d754e5940daa1dfba59f9Michael Sawyer<BLOCKQUOTE><CODE>AccessFileName .acl</CODE></BLOCKQUOTE>
555469af35c12189525921abbc3de3cefb5f9f0fMark Andrewsbefore returning the document /usr/local/web/index.html, the
7949dbdae1db33e6263d754e5940daa1dfba59f9Michael Sawyerserver will read /.acl, /usr/.acl, /usr/local/.acl and /usr/local/web/.acl
ea17e969771f19485dc7ab2f731d641128a9ee3bMark Andrewsfor directives, unless they have been disabled with
ea17e969771f19485dc7ab2f731d641128a9ee3bMark Andrews<BLOCKQUOTE><CODE>
555469af35c12189525921abbc3de3cefb5f9f0fMark Andrews&lt;Directory /&gt;<BR>
19c8df90f1f23c3df870c1771c89c1acdb15020eMichael SawyerAllowOverride None<BR>
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence&lt;/Directory&gt;</CODE></BLOCKQUOTE><P><HR>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer
6fe03d6c83ec02d4494edc870f5e892d419b6885Michael Sawyer<H2><A NAME="addmodule">AddModule directive</A></H2>
6fe03d6c83ec02d4494edc870f5e892d419b6885Michael Sawyer<!--%plaintext &lt;?INDEX {\tt AddModule} directive&gt; -->
6fe03d6c83ec02d4494edc870f5e892d419b6885Michael Sawyer<A
6fe03d6c83ec02d4494edc870f5e892d419b6885Michael Sawyer HREF="directive-dict.html#Syntax"
6fe03d6c83ec02d4494edc870f5e892d419b6885Michael Sawyer REL="Help"
7949dbdae1db33e6263d754e5940daa1dfba59f9Michael Sawyer><STRONG>Syntax:</STRONG></A> AddModule <EM>module module ...</EM><BR>
acf6bcebf95a699789e75d58674f0f2d04b9e7eeAndreas Gustafsson<A
c4ae16b2aa93f6983695f4a5debeb7c53ef111bbMichael Sawyer HREF="directive-dict.html#Context"
c4ae16b2aa93f6983695f4a5debeb7c53ef111bbMichael Sawyer REL="Help"
c4ae16b2aa93f6983695f4a5debeb7c53ef111bbMichael Sawyer><STRONG>Context:</STRONG></A> server config <BR>
056aaae3e2399b2c1df8f82be52d9bd43ceda50cMichael Sawyer<A
b4876b6ddf706977153954507b498baf79a23442Andreas Gustafsson HREF="directive-dict.html#Status"
b4876b6ddf706977153954507b498baf79a23442Andreas Gustafsson REL="Help"
1f1d36a87b65186d9f89aac7f456ab1fd2a39ef6Andreas Gustafsson><STRONG>Status:</STRONG></A> core<BR>
7d4e4d498456b628c5632d6b35442884c8aaf21cDanny Mayer<A
b4876b6ddf706977153954507b498baf79a23442Andreas Gustafsson HREF="directive-dict.html#Compatibility"
b4876b6ddf706977153954507b498baf79a23442Andreas Gustafsson REL="Help"
c4ae16b2aa93f6983695f4a5debeb7c53ef111bbMichael Sawyer><STRONG>Compatibility:</STRONG></A> AddModule is only available in
7949dbdae1db33e6263d754e5940daa1dfba59f9Michael SawyerApache 1.2 and later<P>
7949dbdae1db33e6263d754e5940daa1dfba59f9Michael Sawyer
7949dbdae1db33e6263d754e5940daa1dfba59f9Michael SawyerThe server can have modules compiled in which are not actively in use.
f9521c63ea42fee93f7ae67512e4330ab13081c8Brian WellingtonThis directive can be used to enable the use of those modules. The
24139527f3d0d3fe743bd867329a2edd529728a6Andreas Gustafssonserver comes with a pre-loaded list of active modules; this list can
7949dbdae1db33e6263d754e5940daa1dfba59f9Michael Sawyerbe cleared with the <A HREF="#clearmodulelist">ClearModuleList</A>
7949dbdae1db33e6263d754e5940daa1dfba59f9Michael Sawyerdirective.<P><HR>
f9521c63ea42fee93f7ae67512e4330ab13081c8Brian Wellington
7949dbdae1db33e6263d754e5940daa1dfba59f9Michael Sawyer<H2><A NAME="allowoverride">AllowOverride directive</A></H2>
7949dbdae1db33e6263d754e5940daa1dfba59f9Michael Sawyer<!--%plaintext &lt;?INDEX {\tt AllowOverride} directive&gt; -->
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A
7efc8c3f692fc3226c00ce8bdc1b90eb06562352David Lawrence HREF="directive-dict.html#Syntax"
df5503799f5d2609cc759a7a1f3274daeb728236Michael Sawyer REL="Help"
df5503799f5d2609cc759a7a1f3274daeb728236Michael Sawyer><STRONG>Syntax:</STRONG></A> AllowOverride <EM>override override ...</EM><BR>
46e349e515e0b992ecafdc9597f9d5ee0cf81b2aBrian Wellington<A
46e349e515e0b992ecafdc9597f9d5ee0cf81b2aBrian Wellington HREF="directive-dict.html#Default"
46e349e515e0b992ecafdc9597f9d5ee0cf81b2aBrian Wellington REL="Help"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer><STRONG>Default:</STRONG></A> <CODE>AllowOverride All</CODE><BR>
187bf10eb566d407d54e66b42b468c6c33f2591cAndreas Gustafsson<A
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer HREF="directive-dict.html#Context"
46e349e515e0b992ecafdc9597f9d5ee0cf81b2aBrian Wellington REL="Help"
187bf10eb566d407d54e66b42b468c6c33f2591cAndreas Gustafsson><STRONG>Context:</STRONG></A> directory<BR>
187bf10eb566d407d54e66b42b468c6c33f2591cAndreas Gustafsson<A
187bf10eb566d407d54e66b42b468c6c33f2591cAndreas Gustafsson HREF="directive-dict.html#Status"
46e349e515e0b992ecafdc9597f9d5ee0cf81b2aBrian Wellington REL="Help"
187bf10eb566d407d54e66b42b468c6c33f2591cAndreas Gustafsson><STRONG>Status:</STRONG></A> core<P>
187bf10eb566d407d54e66b42b468c6c33f2591cAndreas Gustafsson
187bf10eb566d407d54e66b42b468c6c33f2591cAndreas GustafssonWhen the server finds an .htaccess file (as specified by
187bf10eb566d407d54e66b42b468c6c33f2591cAndreas Gustafsson<A HREF="#accessfilename">AccessFileName</A>) it needs to know which
187bf10eb566d407d54e66b42b468c6c33f2591cAndreas Gustafssondirectives declared in that file can override earlier access information.<P>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer
46e349e515e0b992ecafdc9597f9d5ee0cf81b2aBrian Wellington<EM>Override</EM> can be set to <CODE>None</CODE>, in which case the server
354f4f1ab20ba521818a4bff9ffdbf9e00142b91Ben Cottrellwill not read the file, <CODE>All</CODE> in which case the server will
d8dde7c9fb66407ebe3263859f75e3d64164de82Ben Cottrellallow all the directives, or one or more of the following:
354f4f1ab20ba521818a4bff9ffdbf9e00142b91Ben Cottrell<DL>
354f4f1ab20ba521818a4bff9ffdbf9e00142b91Ben Cottrell<DT>AuthConfig
46e349e515e0b992ecafdc9597f9d5ee0cf81b2aBrian Wellington<DD>
46e349e515e0b992ecafdc9597f9d5ee0cf81b2aBrian Wellington<!--%plaintext &lt;?INDEX {\tt AuthConfig} override&gt; -->
df5503799f5d2609cc759a7a1f3274daeb728236Michael SawyerAllow use of the authorization directives
b4876b6ddf706977153954507b498baf79a23442Andreas Gustafsson(<A HREF="mod_auth_dbm.html#authdbmgroupfile">AuthDBMGroupFile</A>,
df5503799f5d2609cc759a7a1f3274daeb728236Michael Sawyer<A HREF="mod_auth_dbm.html#authdbmuserfile">AuthDBMUserFile</A>,
b4876b6ddf706977153954507b498baf79a23442Andreas Gustafsson<A HREF="mod_auth.html#authgroupfile">AuthGroupFile</A>,
1d2f2d7c9ab1c38a80f38dbbde26fe1d65a26144Michael Sawyer<A HREF="#authname">AuthName</A>, <A HREF="#authtype">AuthType</A>,
1d2f2d7c9ab1c38a80f38dbbde26fe1d65a26144Michael Sawyer<A HREF="mod_auth.html#authuserfile">AuthUserFile</A>,
2a23a625246acfbf6ff92b86a6b8b9df59dbeaa4Mark Andrews<A HREF="#require">require</A>, <EM>etc.</EM>).
1ae75c1024eb0475c2be352b8707772e16332ad0Mark Andrews<DT>FileInfo
1ae75c1024eb0475c2be352b8707772e16332ad0Mark Andrews<DD>
1ae75c1024eb0475c2be352b8707772e16332ad0Mark Andrews<!--%plaintext &lt;?INDEX {\tt FileInfo} override&gt; -->
1ae75c1024eb0475c2be352b8707772e16332ad0Mark AndrewsAllow use of the directives controlling document types
1ae75c1024eb0475c2be352b8707772e16332ad0Mark Andrews(<A HREF="mod_mime.html#addencoding">AddEncoding</A>,
1ae75c1024eb0475c2be352b8707772e16332ad0Mark Andrews<A HREF="mod_mime.html#addlanguage">AddLanguage</A>,
1ae75c1024eb0475c2be352b8707772e16332ad0Mark Andrews<A HREF="mod_mime.html#addtype">AddType</A>,
1ae75c1024eb0475c2be352b8707772e16332ad0Mark Andrews<A HREF="#defaulttype">DefaultType</A>,
1ae75c1024eb0475c2be352b8707772e16332ad0Mark Andrews<A HREF="#errordocument">ErrorDocument</A>,
1ae75c1024eb0475c2be352b8707772e16332ad0Mark Andrews<A HREF="mod_negotiation.html#languagepriority">LanguagePriority</A>, <EM>etc.</EM>).
1ae75c1024eb0475c2be352b8707772e16332ad0Mark Andrews<DT>Indexes
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<DD>
7efc8c3f692fc3226c00ce8bdc1b90eb06562352David Lawrence<!--%plaintext &lt;?INDEX {\tt Indexes} override&gt; -->
7efc8c3f692fc3226c00ce8bdc1b90eb06562352David LawrenceAllow use of the directives controlling directory indexing
7efc8c3f692fc3226c00ce8bdc1b90eb06562352David Lawrence(<A HREF="mod_autoindex.html#adddescription">AddDescription</A>,
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A HREF="mod_autoindex.html#addicon">AddIcon</A>,
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A HREF="mod_autoindex.html#addiconbyencoding">AddIconByEncoding</A>,
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A HREF="mod_autoindex.html#addiconbytype">AddIconByType</A>,
c03bb27f0675a6e60ceea66b451548e8481bc05cMark Andrews<A HREF="mod_autoindex.html#defaulticon">DefaultIcon</A>,
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A HREF="mod_dir.html#directoryindex">DirectoryIndex</A>,
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A HREF="mod_autoindex.html#fancyindexing">FancyIndexing</A>,
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A HREF="mod_autoindex.html#headername">HeaderName</A>,
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A HREF="mod_autoindex.html#indexignore">IndexIgnore</A>,
11463c0ac24692e229ec87f307f5e7df3c0a7e10Evan Hunt<A HREF="mod_autoindex.html#indexoptions">IndexOptions</A>,
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A HREF="mod_autoindex.html#readmename">ReadmeName</A>, <EM>etc.</EM>).
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<DT>Limit
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence<DD>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<!--%plaintext &lt;?INDEX {\tt Limit} override&gt; -->
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael SawyerAllow use of the directives controlling host access (allow, deny and order).
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<DT>Options
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<DD>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<!--%plaintext &lt;?INDEX {\tt Options} override&gt; -->
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael SawyerAllow use of the directives controlling specific directory features
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer(<A HREF="#options">Options</A> and
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A HREF="mod_include.html#xbithack">XBitHack</A>).
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer</DL><P><HR>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<H2><A NAME="authname">AuthName directive</A></H2>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<!--%plaintext &lt;?INDEX {\tt AuthName} directive&gt; -->
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer HREF="directive-dict.html#Syntax"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer REL="Help"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer><STRONG>Syntax:</STRONG></A> AuthName <EM>auth-domain</EM><BR>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer HREF="directive-dict.html#Context"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer REL="Help"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer><STRONG>Context:</STRONG></A> directory, .htaccess<BR>
11463c0ac24692e229ec87f307f5e7df3c0a7e10Evan Hunt<A
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer HREF="directive-dict.html#Override"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer REL="Help"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer><STRONG>Override:</STRONG></A> AuthConfig<BR>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer HREF="directive-dict.html#Status"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer REL="Help"
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉><STRONG>Status:</STRONG></A> core<P>
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉This directive sets the name of the authorization realm for a directory.
7a272c6b0de3b8c0ad018b9896e287da19c43befAutomatic UpdaterThis realm is given to the client so that the user knows which username and
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉password to send. <SAMP>AuthName</SAMP> takes a single argument;
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉if the realm name contains spaces, it must be enclosed in quotation marks.
7a272c6b0de3b8c0ad018b9896e287da19c43befAutomatic UpdaterIt must be accompanied by <A HREF="#authtype">AuthType</A> and
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉<A HREF="#require">require</A> directives, and directives such as
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉<A HREF="mod_auth.html#authuserfile">AuthUserFile</A> and
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉<A HREF="mod_auth.html#authgroupfile">AuthGroupFile</A> to work.<P><HR>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<H2><A NAME="authtype">AuthType directive</A></H2>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<!--%plaintext &lt;?INDEX {\tt AuthType} directive&gt; -->
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer HREF="directive-dict.html#Syntax"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer REL="Help"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer><STRONG>Syntax:</STRONG></A> AuthType <EM>type</EM><BR>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer HREF="directive-dict.html#Context"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer REL="Help"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer><STRONG>Context:</STRONG></A> directory, .htaccess<BR>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer HREF="directive-dict.html#Override"
d0ad6ddcdd20c637477e12d757090cb0b5ff81cbDavid Lawrence REL="Help"
d0ad6ddcdd20c637477e12d757090cb0b5ff81cbDavid Lawrence><STRONG>Override:</STRONG></A> AuthConfig<BR>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence HREF="directive-dict.html#Status"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer REL="Help"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer><STRONG>Status:</STRONG></A> core<P>
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas GustafssonThis directive selects the type of user authentication for a directory.
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas GustafssonOnly <CODE>Basic</CODE> and <CODE>Digest</CODE> are currently implemented.
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson<!--%plaintext &lt;?INDEX {\tt Basic} authentication scheme&gt; -->
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas GustafssonIt must be accompanied by <A HREF="#authname">AuthName</A> and
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A HREF="#require">require</A> directives, and directives such as
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson<A HREF="mod_auth.html#authuserfile">AuthUserFile</A> and
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson<A HREF="mod_auth.html#authgroupfile">AuthGroupFile</A> to work.<P><HR>
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson<H2><A NAME="bindaddress">BindAddress directive</A></H2>
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson<!--%plaintext &lt;?INDEX {\tt BindAddress} directive&gt; -->
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson<A
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson HREF="directive-dict.html#Syntax"
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson REL="Help"
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson><STRONG>Syntax:</STRONG></A> BindAddress <EM>saddr</EM><BR>
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson<A
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson HREF="directive-dict.html#Default"
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson REL="Help"
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson><STRONG>Default:</STRONG></A> <CODE>BindAddress *</CODE><BR>
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson<A
9ecb35e7d4ec2384d5426f41e90dad1eb9891898Andreas Gustafsson HREF="directive-dict.html#Context"
d044d9891d326da1326b8e9c3cc9b200f82c83ebMichael Sawyer REL="Help"
df5503799f5d2609cc759a7a1f3274daeb728236Michael Sawyer><STRONG>Context:</STRONG></A> server config<BR>
368b37b616234fce3d23099eb180f1dd38e1fb62Mark Andrews<A
7efc8c3f692fc3226c00ce8bdc1b90eb06562352David Lawrence HREF="directive-dict.html#Status"
7efc8c3f692fc3226c00ce8bdc1b90eb06562352David Lawrence REL="Help"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer><STRONG>Status:</STRONG></A> core<P>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael SawyerA Unix&#174; http server can either listen for connections to every
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael SawyerIP address of the server machine, or just one IP address of the server
6e49e91bd08778d7eae45a2229dcf41ed97cc636David Lawrencemachine. <EM>Saddr</EM> can be
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<MENU>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI>*
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI>An IP address
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI>A fully-qualified Internet domain name
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer</MENU>
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David LawrenceIf the value is *, then the server will listen for connections on
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyerevery IP address, otherwise it will only listen on the IP address
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyerspecified. <P>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael SawyerOnly one <CODE>BindAddress</CODE> directive can be used. For more
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyercontrol over which address and ports Apache listens to, use the
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<CODE><A HREF="#listen">Listen</A></CODE> directive instead of
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence<CODE>BindAddress</CODE>.<P>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<CODE>BindAddress</CODE> can be used as an alternative method for
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyersupporting <A HREF="/vhosts/index.html">virtual hosts</A> using
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyermultiple independent servers, instead of using <CODE><A
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael SawyerHREF="#virtualhost">&lt;VirtualHost&gt;</A></CODE> sections.
7efc8c3f692fc3226c00ce8bdc1b90eb06562352David Lawrence
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<P><STRONG>See Also:</STRONG>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A HREF="/dns-caveats.html">DNS Issues</A><BR>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<STRONG>See Also:</STRONG>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A HREF="/bind.html">Setting which addresses and ports Apache uses</A></P>
11463c0ac24692e229ec87f307f5e7df3c0a7e10Evan Hunt
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<HR>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence<H2><A NAME="bs2000account">BS2000Account directive</A></H2>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<!--%plaintext &lt;?INDEX {\tt BS2000Account} directive&gt; -->
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A
11463c0ac24692e229ec87f307f5e7df3c0a7e10Evan Hunt HREF="directive-dict.html#Syntax"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer REL="Help"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer><STRONG>Syntax:</STRONG></A> BS2000Account <EM>account</EM><BR>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer HREF="directive-dict.html#Default"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer REL="Help"
6e49e91bd08778d7eae45a2229dcf41ed97cc636David Lawrence><STRONG>Default:</STRONG></A> <EM>none</EM><BR>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer HREF="directive-dict.html#Context"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer REL="Help"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer><STRONG>Context:</STRONG></A> server config<BR>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A
9a8cec4995c1586d27e95f13d421e4de61a97eb5Mark Andrews HREF="directive-dict.html#Status"
9a8cec4995c1586d27e95f13d421e4de61a97eb5Mark Andrews REL="Help"
9a8cec4995c1586d27e95f13d421e4de61a97eb5Mark Andrews><STRONG>Status:</STRONG></A> core<BR>
9a8cec4995c1586d27e95f13d421e4de61a97eb5Mark Andrews<A
9a8cec4995c1586d27e95f13d421e4de61a97eb5Mark Andrews HREF="directive-dict.html#Compatibility"
9a8cec4995c1586d27e95f13d421e4de61a97eb5Mark Andrews REL="Help"
9a8cec4995c1586d27e95f13d421e4de61a97eb5Mark Andrews><STRONG>Compatibility:</STRONG></A> BS2000Account is only available for
9a8cec4995c1586d27e95f13d421e4de61a97eb5Mark AndrewsBS2000 machines, as of Apache 1.3 and later.<P>
7a272c6b0de3b8c0ad018b9896e287da19c43befAutomatic Updater
9a8cec4995c1586d27e95f13d421e4de61a97eb5Mark AndrewsThe <CODE>BS2000Account</CODE> directive is available for BS2000 hosts
9a8cec4995c1586d27e95f13d421e4de61a97eb5Mark Andrewsonly. It must be used to define the account number for the non-privileged
9a8cec4995c1586d27e95f13d421e4de61a97eb5Mark Andrewsapache server user (which was configured using the
9a8cec4995c1586d27e95f13d421e4de61a97eb5Mark Andrews<A HREF="#user">User</A> directive).
9a8cec4995c1586d27e95f13d421e4de61a97eb5Mark AndrewsThis is required by the BS2000 POSIX subsystem (to change the underlying
9a8cec4995c1586d27e95f13d421e4de61a97eb5Mark AndrewsBS2000 task environment by performing a sub-LOGON) to prevent CGI scripts
9a8cec4995c1586d27e95f13d421e4de61a97eb5Mark Andrewsfrom accessing resources of the privileged account which started the
9a8cec4995c1586d27e95f13d421e4de61a97eb5Mark Andrewsserver, usually <SAMP>SYSROOT</SAMP>.<BR>
9a8cec4995c1586d27e95f13d421e4de61a97eb5Mark AndrewsOnly one <CODE>BS2000Account</CODE> directive can be used. <P>
9a8cec4995c1586d27e95f13d421e4de61a97eb5Mark Andrews
9a8cec4995c1586d27e95f13d421e4de61a97eb5Mark Andrews<P><STRONG>See Also:</STRONG>
9a8cec4995c1586d27e95f13d421e4de61a97eb5Mark Andrews<A HREF="/ebcdic.html">Apache EBCDIC port</A></P>
9a8cec4995c1586d27e95f13d421e4de61a97eb5Mark Andrews
9a8cec4995c1586d27e95f13d421e4de61a97eb5Mark Andrews<HR>
9a8cec4995c1586d27e95f13d421e4de61a97eb5Mark Andrews
9a8cec4995c1586d27e95f13d421e4de61a97eb5Mark Andrews<H2><A NAME="clearmodulelist">ClearModuleList directive</A></H2>
9a8cec4995c1586d27e95f13d421e4de61a97eb5Mark Andrews<!--%plaintext &lt;?INDEX {\tt ClearModuleList} directive&gt; -->
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A
df5503799f5d2609cc759a7a1f3274daeb728236Michael Sawyer HREF="directive-dict.html#Syntax"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer REL="Help"
6e49e91bd08778d7eae45a2229dcf41ed97cc636David Lawrence><STRONG>Syntax:</STRONG></A> ClearModuleList<BR>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A
6e49e91bd08778d7eae45a2229dcf41ed97cc636David Lawrence HREF="directive-dict.html#Context"
e9b85f0309c6bb6eebc2d6a0acf6a8f3bcc376acTatuya JINMEI 神明達哉 REL="Help"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer><STRONG>Context:</STRONG></A> server config<BR>
24139527f3d0d3fe743bd867329a2edd529728a6Andreas Gustafsson<A
52f5715dcc6305ed0e9de9129d440cc6d08b96f5Michael Sawyer HREF="directive-dict.html#Status"
e9b85f0309c6bb6eebc2d6a0acf6a8f3bcc376acTatuya JINMEI 神明達哉 REL="Help"
e9b85f0309c6bb6eebc2d6a0acf6a8f3bcc376acTatuya JINMEI 神明達哉><STRONG>Status:</STRONG></A> core<BR>
e9b85f0309c6bb6eebc2d6a0acf6a8f3bcc376acTatuya JINMEI 神明達哉<A
e9b85f0309c6bb6eebc2d6a0acf6a8f3bcc376acTatuya JINMEI 神明達哉 HREF="directive-dict.html#Compatibility"
e9b85f0309c6bb6eebc2d6a0acf6a8f3bcc376acTatuya JINMEI 神明達哉 REL="Help"
e9b85f0309c6bb6eebc2d6a0acf6a8f3bcc376acTatuya JINMEI 神明達哉><STRONG>Compatibility:</STRONG></A> ClearModuleList is only available in
e22bd3c4bc0de0b96531fab5c2c944251e02e975Mark AndrewsApache 1.2 and later<P>
46e349e515e0b992ecafdc9597f9d5ee0cf81b2aBrian Wellington
46e349e515e0b992ecafdc9597f9d5ee0cf81b2aBrian WellingtonThe server comes with a built-in list of active modules. This
97beb7237b6383cf518d79cee08e23c8aa2bae3fMichael Sawyerdirective clears the list. It is assumed that the list will then be
3f79a8b6f1b50f8e1bc2f274bcfe91d6af74f161Mark Andrewsre-populated using the <A HREF="#addmodule">AddModule</A> directive.<P><HR>
46e349e515e0b992ecafdc9597f9d5ee0cf81b2aBrian Wellington
46e349e515e0b992ecafdc9597f9d5ee0cf81b2aBrian Wellington<H2><A NAME="contentdigest">ContentDigest directive</A></H2>
46e349e515e0b992ecafdc9597f9d5ee0cf81b2aBrian Wellington<!--%plaintext &lt;?INDEX {\tt ContentDigest} directive&gt; -->
97beb7237b6383cf518d79cee08e23c8aa2bae3fMichael Sawyer<A
e22bd3c4bc0de0b96531fab5c2c944251e02e975Mark Andrews HREF="directive-dict.html#Syntax"
97beb7237b6383cf518d79cee08e23c8aa2bae3fMichael Sawyer REL="Help"
97beb7237b6383cf518d79cee08e23c8aa2bae3fMichael Sawyer><STRONG>Syntax:</STRONG></A> ContentDigest <EM>on|off</EM><BR>
1d2f2d7c9ab1c38a80f38dbbde26fe1d65a26144Michael Sawyer<A
46e349e515e0b992ecafdc9597f9d5ee0cf81b2aBrian Wellington HREF="directive-dict.html#Default"
46e349e515e0b992ecafdc9597f9d5ee0cf81b2aBrian Wellington REL="Help"
7786d6542bb800be7d8c56793985d510626806b2Mark Andrews><STRONG>Default:</STRONG></A> <CODE>ContentDigest off</CODE><BR>
7786d6542bb800be7d8c56793985d510626806b2Mark Andrews<A
7786d6542bb800be7d8c56793985d510626806b2Mark Andrews HREF="directive-dict.html#Context"
7786d6542bb800be7d8c56793985d510626806b2Mark Andrews REL="Help"
7786d6542bb800be7d8c56793985d510626806b2Mark Andrews><STRONG>Context:</STRONG></A> server config, virtual host, directory,
7786d6542bb800be7d8c56793985d510626806b2Mark Andrews.htaccess<BR>
7786d6542bb800be7d8c56793985d510626806b2Mark Andrews<A
7786d6542bb800be7d8c56793985d510626806b2Mark Andrews HREF="directive-dict.html#Override"
7786d6542bb800be7d8c56793985d510626806b2Mark Andrews REL="Help"
7786d6542bb800be7d8c56793985d510626806b2Mark Andrews><STRONG>Override:</STRONG></A> Options<BR>
7786d6542bb800be7d8c56793985d510626806b2Mark Andrews<A
7786d6542bb800be7d8c56793985d510626806b2Mark Andrews HREF="directive-dict.html#Status"
1d2f2d7c9ab1c38a80f38dbbde26fe1d65a26144Michael Sawyer REL="Help"
1d2f2d7c9ab1c38a80f38dbbde26fe1d65a26144Michael Sawyer><STRONG>Status:</STRONG></A> experimental<BR>
2706bea98ef713e844670b85274af9502f87d7bcMichael Graff<A
2706bea98ef713e844670b85274af9502f87d7bcMichael Graff HREF="directive-dict.html#Compatibility"
2706bea98ef713e844670b85274af9502f87d7bcMichael Graff REL="Help"
2706bea98ef713e844670b85274af9502f87d7bcMichael Graff><STRONG>Compatibility:</STRONG></A> ContentDigest is only available in
9a8cec4995c1586d27e95f13d421e4de61a97eb5Mark AndrewsApache 1.1 and later<P>
9a8cec4995c1586d27e95f13d421e4de61a97eb5Mark Andrews
2706bea98ef713e844670b85274af9502f87d7bcMichael GraffThis directive enables the generation of <CODE>Content-MD5</CODE> headers
2706bea98ef713e844670b85274af9502f87d7bcMichael Graffas defined in RFC1864 respectively RFC2068.<P>
9a8cec4995c1586d27e95f13d421e4de61a97eb5Mark Andrews
9a8cec4995c1586d27e95f13d421e4de61a97eb5Mark AndrewsMD5 is an algorithm for computing a "message digest" (sometimes called
9a8cec4995c1586d27e95f13d421e4de61a97eb5Mark Andrews"fingerprint") of arbitrary-length data, with a high degree of confidence
9a8cec4995c1586d27e95f13d421e4de61a97eb5Mark Andrewsthat any alterations in the data will be reflected in alterations in the
9a8cec4995c1586d27e95f13d421e4de61a97eb5Mark Andrewsmessage digest.<P>
2706bea98ef713e844670b85274af9502f87d7bcMichael Graff
2706bea98ef713e844670b85274af9502f87d7bcMichael GraffThe <CODE>Content-MD5</CODE> header provides an end-to-end message
2706bea98ef713e844670b85274af9502f87d7bcMichael Graffintegrity check (MIC) of the entity-body. A proxy or client may check this
2706bea98ef713e844670b85274af9502f87d7bcMichael Graffheader for detecting accidental modification of the entity-body
2706bea98ef713e844670b85274af9502f87d7bcMichael Graffin transit.
2706bea98ef713e844670b85274af9502f87d7bcMichael GraffExample header:
7a272c6b0de3b8c0ad018b9896e287da19c43befAutomatic Updater<PRE> Content-MD5: AuLb7Dp1rqtRtxz2m9kRpA==</PRE><P>
2706bea98ef713e844670b85274af9502f87d7bcMichael Graff
2706bea98ef713e844670b85274af9502f87d7bcMichael GraffNote that this can cause performance problems on your server
2706bea98ef713e844670b85274af9502f87d7bcMichael Graffsince the message digest is computed on every request
2706bea98ef713e844670b85274af9502f87d7bcMichael Graff(the values are not cached).<P>
2706bea98ef713e844670b85274af9502f87d7bcMichael Graff
2706bea98ef713e844670b85274af9502f87d7bcMichael Graff<CODE>Content-MD5</CODE> is only sent for documents served by the
2706bea98ef713e844670b85274af9502f87d7bcMichael Graffcore, and not by any module. For example, SSI documents, output from
2706bea98ef713e844670b85274af9502f87d7bcMichael GraffCGI scripts, and byte range responses do not have this header.
2706bea98ef713e844670b85274af9502f87d7bcMichael Graff
2706bea98ef713e844670b85274af9502f87d7bcMichael Graff<HR>
7a272c6b0de3b8c0ad018b9896e287da19c43befAutomatic Updater
2706bea98ef713e844670b85274af9502f87d7bcMichael Graff<H2><A NAME="coredumpdirectory">CoreDumpDirectory directive</A></H2>
2706bea98ef713e844670b85274af9502f87d7bcMichael Graff<!--%plaintext &lt;?INDEX {\tt CoreDumpDirectory} directive&gt; -->
2706bea98ef713e844670b85274af9502f87d7bcMichael Graff<A
2706bea98ef713e844670b85274af9502f87d7bcMichael Graff HREF="directive-dict.html#Syntax"
2706bea98ef713e844670b85274af9502f87d7bcMichael Graff REL="Help"
2706bea98ef713e844670b85274af9502f87d7bcMichael Graff><STRONG>Syntax:</STRONG></A> CoreDumpDirectory <EM>directory</EM><BR>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer HREF="directive-dict.html#Default"
d302a620e0d49811874b9555ac2e4c6e05861a6bFrancis Dupont REL="Help"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer><STRONG>Default:</STRONG></A> the same location as ServerRoot<BR>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer HREF="directive-dict.html#Context"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer REL="Help"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer><STRONG>Context:</STRONG></A> server config<BR>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer HREF="directive-dict.html#Status"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer REL="Help"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer><STRONG>Status:</STRONG></A> core<P>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael SawyerThis controls the directory to which Apache attempts to switch before
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyerdumping core. The default is in the <A HREF="#serverroot">ServerRoot</A>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyerdirectory, however since this should not be writable by the user
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyerthe server runs as, core dumps won't normally get written. If you
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyerwant a core dump for debugging, you can use this directive to place
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyerit in a different location.<P><HR>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<H2><A NAME="defaulttype">DefaultType directive</A></H2>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<!--%plaintext &lt;?INDEX {\tt DefaultType} directive&gt; -->
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer HREF="directive-dict.html#Syntax"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer REL="Help"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer><STRONG>Syntax:</STRONG></A> DefaultType <EM>MIME-type</EM><BR>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer HREF="directive-dict.html#Default"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer REL="Help"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer><STRONG>Default:</STRONG></A> <CODE>DefaultType text/html</CODE><BR>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer HREF="directive-dict.html#Context"
0874abad14e3e9ecfc3dc1a1a2b9969f2f027724Mark Andrews REL="Help"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer><STRONG>Context:</STRONG></A> server config, virtual host, directory,
6e49e91bd08778d7eae45a2229dcf41ed97cc636David Lawrence.htaccess<BR>
6e49e91bd08778d7eae45a2229dcf41ed97cc636David Lawrence<A
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer HREF="directive-dict.html#Override"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer REL="Help"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer><STRONG>Override:</STRONG></A> FileInfo<BR>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer HREF="directive-dict.html#Status"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer REL="Help"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer><STRONG>Status:</STRONG></A> core<P>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael SawyerThere will be times when the server is asked to provide a document
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyerwhose type cannot be determined by its MIME types mappings.<P>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael SawyerThe server must inform the client of the content-type of the document, so in
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyerthe event of an unknown type it uses the <CODE>DefaultType</CODE>. For
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyerexample:
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<BLOCKQUOTE><CODE>DefaultType image/gif</CODE></BLOCKQUOTE>
24139527f3d0d3fe743bd867329a2edd529728a6Andreas Gustafssonwould be appropriate for a directory which contained many gif images
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyerwith filenames missing the .gif extension.<P><HR>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer
df5503799f5d2609cc759a7a1f3274daeb728236Michael Sawyer<H2><A NAME="directory">&lt;Directory&gt; directive</A></H2>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<!--%plaintext &lt;?INDEX {\tt Directory} section directive&gt; -->
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer HREF="directive-dict.html#Syntax"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer REL="Help"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer><STRONG>Syntax:</STRONG></A> &lt;Directory <EM>directory</EM>&gt;
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer ... &lt;/Directory&gt; <BR>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A
d0ad6ddcdd20c637477e12d757090cb0b5ff81cbDavid Lawrence HREF="directive-dict.html#Context"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer REL="Help"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer><STRONG>Context:</STRONG></A> server config, virtual host<BR>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A
286e74a21b84c612a038852f4808832b45a385a0Michael Sawyer HREF="directive-dict.html#Status"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer REL="Help"
24139527f3d0d3fe743bd867329a2edd529728a6Andreas Gustafsson><STRONG>Status:</STRONG></A> Core. <P>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer&lt;Directory&gt; and &lt;/Directory&gt; are used to enclose a group of
df5503799f5d2609cc759a7a1f3274daeb728236Michael Sawyerdirectives which will apply only to the named directory and sub-directories
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyerof that directory. Any directive which is allowed in a directory
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyercontext may be used. <EM>Directory</EM> is either the full path to a directory,
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyeror a wild-card string. In a wild-card string, `?' matches any single character,
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyerand `*' matches any sequences of characters. As of Apache 1.3, you
24139527f3d0d3fe743bd867329a2edd529728a6Andreas Gustafssonmay also use `[]' character ranges like in the shell. Also as of Apache 1.3
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyernone of the wildcards match a `/' character, which more closely mimics the
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyerbehaviour of Unix shells.
df5503799f5d2609cc759a7a1f3274daeb728236Michael SawyerExample:
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<PRE>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer &lt;Directory /usr/local/httpd/htdocs&gt;
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer Options Indexes FollowSymLinks
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer &lt;/Directory&gt;
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer</PRE>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<P><STRONG>Apache 1.2 and above:</STRONG>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael SawyerExtended regular expressions can also be used, with the addition of the
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<CODE>~</CODE> character. For example:</P>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<PRE>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer &lt;Directory ~ &quot;^/www/.*/[0-9]{3}&quot;&gt;
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer</PRE>
2706bea98ef713e844670b85274af9502f87d7bcMichael Graff
2706bea98ef713e844670b85274af9502f87d7bcMichael Graffwould match directories in /www/ that consisted of three numbers.
06a949d2ce8d4b4cbfbf4e7a0335316520aafa46Andreas Gustafsson
06a949d2ce8d4b4cbfbf4e7a0335316520aafa46Andreas Gustafsson<P>If multiple (non-regular expression) directory sections match the
06a949d2ce8d4b4cbfbf4e7a0335316520aafa46Andreas Gustafssondirectory (or its parents) containing
06a949d2ce8d4b4cbfbf4e7a0335316520aafa46Andreas Gustafssona document, then the directives are applied in the order of shortest match
06a949d2ce8d4b4cbfbf4e7a0335316520aafa46Andreas Gustafssonfirst, interspersed with the directives from the
06a949d2ce8d4b4cbfbf4e7a0335316520aafa46Andreas Gustafsson<A HREF="#accessfilename">.htaccess</A> files. For example, with
06a949d2ce8d4b4cbfbf4e7a0335316520aafa46Andreas Gustafsson<BLOCKQUOTE><CODE>
e9b85f0309c6bb6eebc2d6a0acf6a8f3bcc376acTatuya JINMEI 神明達哉&lt;Directory /&gt;<BR>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael SawyerAllowOverride None<BR>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer&lt;/Directory&gt;<BR><BR>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer&lt;Directory /home/*&gt;<BR>
3001a1b4e6298466882a4147307b4c28a3b08f91Mark AndrewsAllowOverride FileInfo<BR>
67d01dcacb2051a03377c8ec5c0e36604c17aea5Evan Hunt&lt;/Directory&gt;</CODE></BLOCKQUOTE>
67d01dcacb2051a03377c8ec5c0e36604c17aea5Evan Huntfor access to the document <CODE>/home/web/dir/doc.html</CODE> the
67d01dcacb2051a03377c8ec5c0e36604c17aea5Evan Huntsteps are:
67d01dcacb2051a03377c8ec5c0e36604c17aea5Evan Hunt<MENU>
67d01dcacb2051a03377c8ec5c0e36604c17aea5Evan Hunt<LI>Apply directive <CODE>AllowOverride None</CODE> (disabling
67d01dcacb2051a03377c8ec5c0e36604c17aea5Evan Hunt<CODE>.htaccess</CODE> files).
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrews<LI>Apply directive <CODE>AllowOverride FileInfo</CODE> (for directory
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrews<CODE>/home/web</CODE>).
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrews<LI>Apply any FileInfo directives in <CODE>/home/web/.htaccess</CODE>
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrews</MENU>
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrews
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrews<P>
4d86cda3d7eb31578c9088c51a26643d43799533Mark AndrewsRegular expression directory sections are handled slightly differently
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrewsby Apache 1.2 and 1.3. In Apache 1.2 they are interspersed with the normal
2f5baf12a411b29ac693f82b1ee8457b749d515cMark Andrewsdirectory sections and applied in the order they appear in the configuration
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrewsfile. They are applied only once, and apply when the shortest match
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrewspossible occurs. In Apache 1.3 regular expressions are not considered
3933e5c7639ce930ab58366e8f6e544926784ea6Francis Dupontuntil after all of the normal sections have been applied. Then all of
3933e5c7639ce930ab58366e8f6e544926784ea6Francis Dupontthe regular expressions are tested in the order they appeared in the
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrewsconfiguration file. For example, with
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrews<BLOCKQUOTE><CODE>
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrews&lt;Directory ~ abc$&gt;<BR>
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrews... directives here ...<BR>
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrews&lt;/Directory&gt;<BR>
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrews</CODE></BLOCKQUOTE>
b8a04d50a361eb5e6a6b098d530daa0c56c6fdd9Mark AndrewsSuppose that the filename being accessed is
b8a04d50a361eb5e6a6b098d530daa0c56c6fdd9Mark Andrews<CODE>/home/abc/public_html/abc/index.html</CODE>. The server
b8a04d50a361eb5e6a6b098d530daa0c56c6fdd9Mark Andrewsconsiders each of <CODE>/</CODE>, <CODE>/home</CODE>, <CODE>/home/abc</CODE>,
b8a04d50a361eb5e6a6b098d530daa0c56c6fdd9Mark Andrews<CODE>/home/abc/public_html</CODE>, and <CODE>/home/abc/public_html/abc</CODE>
b8a04d50a361eb5e6a6b098d530daa0c56c6fdd9Mark Andrewsin that order. In Apache 1.2, when
b8a04d50a361eb5e6a6b098d530daa0c56c6fdd9Mark Andrews<CODE>/home/abc</CODE> is considered, the regular expression will match
b8a04d50a361eb5e6a6b098d530daa0c56c6fdd9Mark Andrewsand be applied. In Apache 1.3 the regular expression isn't considered
b8a04d50a361eb5e6a6b098d530daa0c56c6fdd9Mark Andrewsat all at that point in the tree. It won't be considered until after
b8a04d50a361eb5e6a6b098d530daa0c56c6fdd9Mark Andrewsall normal &lt;Directory&gt;s and <CODE>.htaccess</CODE> files have
b8a04d50a361eb5e6a6b098d530daa0c56c6fdd9Mark Andrewsbeen applied. Then the regular expression will
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrewsmatch on <CODE>/home/abc/public_html/abc</CODE> and be applied.
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrews
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrews<P>
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrews
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrews<STRONG>
4d86cda3d7eb31578c9088c51a26643d43799533Mark AndrewsNote that the default Apache access for &lt;Directory /&gt; is
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrews<SAMP>Allow from All</SAMP>. This means that Apache will serve any file
3d711f2f75cb9a9ddcbf1fca9b2de192e75340e6Mark Andrewsmapped from an URL. It is recommended that you change this with a block
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrewssuch as
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrews</STRONG>
1599ac12be522feb3f0cf8dab9fdde695a93a03fTinderbox User<PRE>
67d01dcacb2051a03377c8ec5c0e36604c17aea5Evan Hunt &lt;Directory /&gt;
67d01dcacb2051a03377c8ec5c0e36604c17aea5Evan Hunt Order Deny,Allow
67d01dcacb2051a03377c8ec5c0e36604c17aea5Evan Hunt Deny from All
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrews &lt;/Directory&gt;
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrews</PRE>
c9c2ffe729bf24a7fd0f0a234a4a84e67621d414Mark Andrews<P>
6100b1769956200b2815803ab7b35556396ce0d1Mark Andrews<STRONG>
6100b1769956200b2815803ab7b35556396ce0d1Mark Andrewsand then override this for directories you <EM>want</EM> accessible.
c9c2ffe729bf24a7fd0f0a234a4a84e67621d414Mark AndrewsSee the
c9c2ffe729bf24a7fd0f0a234a4a84e67621d414Mark Andrews<A
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrews HREF="/misc/security_tips.html"
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrews>Security Tips</A>
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrewspage for more details.
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrews</STRONG>
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrews</P>
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrews
4d86cda3d7eb31578c9088c51a26643d43799533Mark AndrewsThe directory sections typically occur in the access.conf file, but they
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrewsmay appear in any configuration file. &lt;Directory&gt; directives cannot
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrewsnest, and cannot appear in a <A HREF="#limit">&lt;Limit&gt;</A> section.
93f429295a682f44940c8f4e2b05773c50da4e7dMark Andrews<P>
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrews
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrews<STRONG>See also</STRONG>: <A HREF="/sections.html">How Directory,
6fe03d6c83ec02d4494edc870f5e892d419b6885Michael SawyerLocation and Files sections work</A> for an explanation of how these
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyerdifferent sections are combined when a request is received
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<HR>
5d20773abcdf9ff3afe14a349413174f94594188Michael Sawyer
f17b62a64bec4690f7ef0263efee1fa727b66fd5Michael Sawyer<H2><A NAME="directorymatch">&lt;DirectoryMatch&gt;</A></H2>
aa6054ec74819f754bcf19442ca9b39d948171adMichael Sawyer<A
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉 HREF="directive-dict.html#Syntax"
aa6054ec74819f754bcf19442ca9b39d948171adMichael Sawyer REL="Help"
aa6054ec74819f754bcf19442ca9b39d948171adMichael Sawyer><STRONG>Syntax:</STRONG></A> &lt;DirectoryMatch <EM>regex</EM>&gt;
b8fff4f0d70bb9c5e53023ad0dae0acda67b5cdaMark Andrews ... &lt;/DirectoryMatch&gt; <BR>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A
52f5715dcc6305ed0e9de9129d440cc6d08b96f5Michael Sawyer HREF="directive-dict.html#Context"
52f5715dcc6305ed0e9de9129d440cc6d08b96f5Michael Sawyer REL="Help"
aa6054ec74819f754bcf19442ca9b39d948171adMichael Sawyer><STRONG>Context:</STRONG></A> server config, virtual host<BR>
aa6054ec74819f754bcf19442ca9b39d948171adMichael Sawyer<A
3d711f2f75cb9a9ddcbf1fca9b2de192e75340e6Mark Andrews HREF="directive-dict.html#Status"
3d711f2f75cb9a9ddcbf1fca9b2de192e75340e6Mark Andrews REL="Help"
4e7973990c2aaec391cf307a7e60583331568e01Evan Hunt><STRONG>Status:</STRONG></A> Core.<BR>
3d711f2f75cb9a9ddcbf1fca9b2de192e75340e6Mark Andrews<A
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrews HREF="directive-dict.html#Compatibility"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer REL="Help"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer><STRONG>Compatibility:</STRONG></A> Available in Apache 1.3 and later
aa6054ec74819f754bcf19442ca9b39d948171adMichael Sawyer
aa6054ec74819f754bcf19442ca9b39d948171adMichael Sawyer<P>&lt;DirectoryMatch&gt; and &lt;/DirectoryMatch&gt; are used to enclose a
cc7732e1299042bff430dfdfbc2624fb340047b2Michael Sawyergroup of
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉directives which will apply only to the named directory and sub-directories
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyerof that directory, the same as <A
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael SawyerHREF="#directory">&lt;Directory&gt;</A>. However, it takes as an
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyerargument a regular expression. For example:</P>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<PRE>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer &lt;DirectoryMatch &quot;^/www/.*/[0-9]{3}&quot;&gt;
aa6054ec74819f754bcf19442ca9b39d948171adMichael Sawyer</PRE>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<P>would match directories in /www/ that consisted of three numbers.</P>
b8fff4f0d70bb9c5e53023ad0dae0acda67b5cdaMark Andrews
b8fff4f0d70bb9c5e53023ad0dae0acda67b5cdaMark Andrews<P><STRONG>See Also:</STRONG>
b8fff4f0d70bb9c5e53023ad0dae0acda67b5cdaMark Andrews<A HREF="#directory">&lt;Directory&gt;</A> for a description of how
b8fff4f0d70bb9c5e53023ad0dae0acda67b5cdaMark Andrewsregular expressions are mixed in with normal &lt;Directory&gt;s.
b8fff4f0d70bb9c5e53023ad0dae0acda67b5cdaMark Andrews<BR>
b8fff4f0d70bb9c5e53023ad0dae0acda67b5cdaMark Andrews<STRONG>See also</STRONG>: <A HREF="/sections.html">How Directory,
b8fff4f0d70bb9c5e53023ad0dae0acda67b5cdaMark AndrewsLocation and Files sections work</A> for an explanation of how these
b8fff4f0d70bb9c5e53023ad0dae0acda67b5cdaMark Andrewsdifferent sections are combined when a request is received
b8fff4f0d70bb9c5e53023ad0dae0acda67b5cdaMark Andrews
b8fff4f0d70bb9c5e53023ad0dae0acda67b5cdaMark Andrews<HR>
b8fff4f0d70bb9c5e53023ad0dae0acda67b5cdaMark Andrews
aa6054ec74819f754bcf19442ca9b39d948171adMichael Sawyer<H2><A NAME="documentroot">DocumentRoot directive</A></H2>
b8fff4f0d70bb9c5e53023ad0dae0acda67b5cdaMark Andrews<!--%plaintext &lt;?INDEX {\tt DocumentRoot} directive&gt; -->
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence<A
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉 HREF="directive-dict.html#Syntax"
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉 REL="Help"
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉><STRONG>Syntax:</STRONG></A> DocumentRoot <EM>directory-filename</EM><BR>
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉<A
cc7732e1299042bff430dfdfbc2624fb340047b2Michael Sawyer HREF="directive-dict.html#Default"
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉 REL="Help"
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉><STRONG>Default:</STRONG></A> <CODE>DocumentRoot
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉/usr/local/apache/htdocs</CODE><BR>
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉<A
5dcc67a0fff89e7ebf051f64b6b987862c331a04Mark Andrews HREF="directive-dict.html#Context"
5dcc67a0fff89e7ebf051f64b6b987862c331a04Mark Andrews REL="Help"
5dcc67a0fff89e7ebf051f64b6b987862c331a04Mark Andrews><STRONG>Context:</STRONG></A> server config, virtual host<BR>
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉<A
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉 HREF="directive-dict.html#Status"
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉 REL="Help"
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉><STRONG>Status:</STRONG></A> core<P>
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉
b8fff4f0d70bb9c5e53023ad0dae0acda67b5cdaMark AndrewsThis directive sets the directory from which httpd will serve files.
b8fff4f0d70bb9c5e53023ad0dae0acda67b5cdaMark AndrewsUnless matched by a directive like Alias, the server appends the path
9e4b25fc3eb5777202147634d789345d893b4539Mark Andrewsfrom the requested URL to the document root to make the path to the
b8fff4f0d70bb9c5e53023ad0dae0acda67b5cdaMark Andrewsdocument. Example:
3001a1b4e6298466882a4147307b4c28a3b08f91Mark Andrews<BLOCKQUOTE><CODE>DocumentRoot /usr/web</CODE></BLOCKQUOTE>
3001a1b4e6298466882a4147307b4c28a3b08f91Mark Andrewsthen an access to <CODE>http://www.my.host.com/index.html</CODE> refers
3001a1b4e6298466882a4147307b4c28a3b08f91Mark Andrewsto <CODE>/usr/web/index.html</CODE>.
5dcc67a0fff89e7ebf051f64b6b987862c331a04Mark Andrews
5dcc67a0fff89e7ebf051f64b6b987862c331a04Mark Andrews<P>There appears to be a bug in mod_dir which causes problems when the
5dcc67a0fff89e7ebf051f64b6b987862c331a04Mark AndrewsDocumentRoot has a trailing slash (<EM>i.e.</EM>, "DocumentRoot /usr/web/") so
5dcc67a0fff89e7ebf051f64b6b987862c331a04Mark Andrewsplease avoid that.
5dcc67a0fff89e7ebf051f64b6b987862c331a04Mark Andrews
5dcc67a0fff89e7ebf051f64b6b987862c331a04Mark Andrews<P><HR>
5dcc67a0fff89e7ebf051f64b6b987862c331a04Mark Andrews
b8fff4f0d70bb9c5e53023ad0dae0acda67b5cdaMark Andrews<H2><A NAME="errordocument">ErrorDocument directive</A></H2>
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉<!--%plaintext &lt;?INDEX {\tt ErrorDocument} directive&gt; -->
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉<A
93f429295a682f44940c8f4e2b05773c50da4e7dMark Andrews HREF="directive-dict.html#Syntax"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer REL="Help"
1d2f2d7c9ab1c38a80f38dbbde26fe1d65a26144Michael Sawyer><STRONG>Syntax:</STRONG></A> ErrorDocument <EM>error-code document</EM><BR>
aa6054ec74819f754bcf19442ca9b39d948171adMichael Sawyer<A
aa6054ec74819f754bcf19442ca9b39d948171adMichael Sawyer HREF="directive-dict.html#Context"
aa6054ec74819f754bcf19442ca9b39d948171adMichael Sawyer REL="Help"
aa6054ec74819f754bcf19442ca9b39d948171adMichael Sawyer><STRONG>Context:</STRONG></A> server config, virtual host, directory,
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence.htaccess<BR>
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉<A
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉 HREF="directive-dict.html#Status"
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉 REL="Help"
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉><STRONG>Status:</STRONG></A> core<BR>
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉<A
aa6054ec74819f754bcf19442ca9b39d948171adMichael Sawyer HREF="directive-dict.html#Override"
cc7732e1299042bff430dfdfbc2624fb340047b2Michael Sawyer REL="Help"
cc7732e1299042bff430dfdfbc2624fb340047b2Michael Sawyer><STRONG>Override:</STRONG></A> FileInfo<BR>
2706bea98ef713e844670b85274af9502f87d7bcMichael Graff<A
1d2f2d7c9ab1c38a80f38dbbde26fe1d65a26144Michael Sawyer HREF="directive-dict.html#Compatibility"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer REL="Help"
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉><STRONG>Compatibility:</STRONG></A> The directory and .htaccess contexts
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉are only available in Apache 1.1 and later.<P>
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉
905ba39e10a8f483d167b992ec31f4c0bf34326eMark AndrewsIn the event of a problem or error, Apache can be configured to do
905ba39e10a8f483d167b992ec31f4c0bf34326eMark Andrewsone of four things,
905ba39e10a8f483d167b992ec31f4c0bf34326eMark Andrews
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉<OL>
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉<LI>output a simple hardcoded error message
cc7732e1299042bff430dfdfbc2624fb340047b2Michael Sawyer<LI>output a customized message
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<LI>redirect to a local URL to handle the problem/error
2706bea98ef713e844670b85274af9502f87d7bcMichael Graff<LI>redirect to an external URL to handle the problem/error
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer</OL>
ec3984e9df6fd9b7811daa0dacb1b3dd1423ebf3Mark Andrews
ec3984e9df6fd9b7811daa0dacb1b3dd1423ebf3Mark Andrews<P>The first option is the default, while options 2-4 are configured
ec3984e9df6fd9b7811daa0dacb1b3dd1423ebf3Mark Andrewsusing the <CODE>ErrorDocument</CODE> directive, which is followed by
6d3f954c572db02159deedd444373161fda47a88Brian Wellingtonthe HTTP response code and a message or URL.
ec3984e9df6fd9b7811daa0dacb1b3dd1423ebf3Mark Andrews
6d3f954c572db02159deedd444373161fda47a88Brian Wellington<P><EM>Messages</EM> in this context begin with a single quote
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrews(<CODE>"</CODE>), which does not form part of the message itself.
4d86cda3d7eb31578c9088c51a26643d43799533Mark AndrewsApache will sometimes offer additional information regarding the
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrewsproblem/error.
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer
38cf6e52ce4b33795713388824b69d78e430b115Michael Sawyer<P>URLs can begin with a slash (/) for local URLs, or be a full
38cf6e52ce4b33795713388824b69d78e430b115Michael SawyerURL which the client can resolve. Examples:
38cf6e52ce4b33795713388824b69d78e430b115Michael Sawyer<BLOCKQUOTE><CODE>
38cf6e52ce4b33795713388824b69d78e430b115Michael SawyerErrorDocument 500 http://foo.example.com/cgi-bin/tester<BR>
0819ae2ca51571d205df061b52d8468889f3a0dfMichael SawyerErrorDocument 404 /cgi-bin/bad_urls.pl<BR>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael SawyerErrorDocument 401 /subscription_info.html<BR>
7949dbdae1db33e6263d754e5940daa1dfba59f9Michael SawyerErrorDocument 403 "Sorry can't allow you access today
7949dbdae1db33e6263d754e5940daa1dfba59f9Michael Sawyer</CODE></BLOCKQUOTE>
7949dbdae1db33e6263d754e5940daa1dfba59f9Michael Sawyer
7949dbdae1db33e6263d754e5940daa1dfba59f9Michael Sawyer<P>Note that when you specify an <CODE>ErrorDocument</CODE> that
7949dbdae1db33e6263d754e5940daa1dfba59f9Michael Sawyerpoints to a remote URL (ie. anything with a method such as "http" in
7949dbdae1db33e6263d754e5940daa1dfba59f9Michael Sawyerfront of it) Apache will send a redirect to the client to tell it
2706bea98ef713e844670b85274af9502f87d7bcMichael Graffwhere to find the document, even if the document ends up being
2706bea98ef713e844670b85274af9502f87d7bcMichael Graffon the same server.. This has several implications, the
2706bea98ef713e844670b85274af9502f87d7bcMichael Graffmost important being that <STRONG>if you use an "ErrorDocument 401"
7949dbdae1db33e6263d754e5940daa1dfba59f9Michael Sawyerdirective then it must refer to a local document.</STRONG> This results
df5503799f5d2609cc759a7a1f3274daeb728236Michael Sawyerfrom the nature of the HTTP basic authentication scheme.
aa6054ec74819f754bcf19442ca9b39d948171adMichael Sawyer
3001a1b4e6298466882a4147307b4c28a3b08f91Mark Andrews<P>See Also: <A HREF="/custom-error.html">documentation of customizable
3001a1b4e6298466882a4147307b4c28a3b08f91Mark Andrewsresponses.</A><P><HR>
3001a1b4e6298466882a4147307b4c28a3b08f91Mark Andrews
3001a1b4e6298466882a4147307b4c28a3b08f91Mark Andrews<H2><A NAME="errorlog">ErrorLog directive</A></H2>
3001a1b4e6298466882a4147307b4c28a3b08f91Mark Andrews<!--%plaintext &lt;?INDEX {\tt ErrorLog} directive&gt; -->
df5503799f5d2609cc759a7a1f3274daeb728236Michael Sawyer<A
1d2f2d7c9ab1c38a80f38dbbde26fe1d65a26144Michael Sawyer HREF="directive-dict.html#Syntax"
38cf6e52ce4b33795713388824b69d78e430b115Michael Sawyer REL="Help"
3806886c281873e563420a86a024bd09e57fd90eBrian Wellington><STRONG>Syntax:</STRONG></A> ErrorLog <EM>filename</EM>|<CODE>syslog[:facility]</CODE>
cc7732e1299042bff430dfdfbc2624fb340047b2Michael Sawyer<BR>
aa6054ec74819f754bcf19442ca9b39d948171adMichael Sawyer<A
cc7732e1299042bff430dfdfbc2624fb340047b2Michael Sawyer HREF="directive-dict.html#Default"
aa6054ec74819f754bcf19442ca9b39d948171adMichael Sawyer REL="Help"
aa6054ec74819f754bcf19442ca9b39d948171adMichael Sawyer><STRONG>Default:</STRONG></A> <CODE>ErrorLog logs/error_log</CODE> (Unix)<BR>
354f4f1ab20ba521818a4bff9ffdbf9e00142b91Ben Cottrell<A
2706bea98ef713e844670b85274af9502f87d7bcMichael Graff HREF="directive-dict.html#Default"
1d2f2d7c9ab1c38a80f38dbbde26fe1d65a26144Michael Sawyer REL="Help"
7949dbdae1db33e6263d754e5940daa1dfba59f9Michael Sawyer><STRONG>Default:</STRONG></A> <CODE>ErrorLog logs/error.log</CODE>
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence (Windows and OS/2)<BR>
24139527f3d0d3fe743bd867329a2edd529728a6Andreas Gustafsson<A
7949dbdae1db33e6263d754e5940daa1dfba59f9Michael Sawyer HREF="directive-dict.html#Context"
7949dbdae1db33e6263d754e5940daa1dfba59f9Michael Sawyer REL="Help"
d821f1cd7e97552401296e880e7518c98c9ebea1Michael Sawyer><STRONG>Context:</STRONG></A> server config, virtual host<BR>
c9c2ffe729bf24a7fd0f0a234a4a84e67621d414Mark Andrews<A
d821f1cd7e97552401296e880e7518c98c9ebea1Michael Sawyer HREF="directive-dict.html#Status"
ea17e969771f19485dc7ab2f731d641128a9ee3bMark Andrews REL="Help"
b8a04d50a361eb5e6a6b098d530daa0c56c6fdd9Mark Andrews><STRONG>Status:</STRONG></A> core<P>
ea17e969771f19485dc7ab2f731d641128a9ee3bMark Andrews
ea17e969771f19485dc7ab2f731d641128a9ee3bMark AndrewsThe error log directive sets the name of the file to which the server will log
b8a04d50a361eb5e6a6b098d530daa0c56c6fdd9Mark Andrewsany errors it encounters. If the filename does not begin with a slash (/)
ea17e969771f19485dc7ab2f731d641128a9ee3bMark Andrewsthen it is assumed to be relative to the <A HREF="#serverroot">ServerRoot</A>.
3d711f2f75cb9a9ddcbf1fca9b2de192e75340e6Mark AndrewsIf the filename begins with a pipe (|) then it is assumed to be a command to
3d711f2f75cb9a9ddcbf1fca9b2de192e75340e6Mark Andrewsspawn to handle the error log.
3d711f2f75cb9a9ddcbf1fca9b2de192e75340e6Mark Andrews
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<P><STRONG>Apache 1.3 and above:</STRONG>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael SawyerUsing <CODE>syslog</CODE> instead of a filename enables logging via syslogd(8)
acf6bcebf95a699789e75d58674f0f2d04b9e7eeAndreas Gustafssonif the system supports it. The default is to use syslog facility
2706bea98ef713e844670b85274af9502f87d7bcMichael Graff<CODE>local7</CODE>, but you can override this by using the
2706bea98ef713e844670b85274af9502f87d7bcMichael Graff<CODE>syslog:</CODE><EM>facility</EM> syntax where <EM>facility</EM> can be
acf6bcebf95a699789e75d58674f0f2d04b9e7eeAndreas Gustafssonone of the names usually documented in syslog(1).
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer
acf6bcebf95a699789e75d58674f0f2d04b9e7eeAndreas Gustafsson<P>
c12904ec531fb210066bafc33bde74d43889caacMark AndrewsSECURITY: See the
c12904ec531fb210066bafc33bde74d43889caacMark Andrews<A HREF="/misc/security_tips.html#serverroot">security tips</A>
24139527f3d0d3fe743bd867329a2edd529728a6Andreas Gustafssondocument for details on why your security could be compromised if
b31e7ab8857a62eb94d4a6a681243739f158374dDanny Mayerthe directory where logfiles are stored is writable by anyone other
b31e7ab8857a62eb94d4a6a681243739f158374dDanny Mayerthan the user that starts the server.
286e74a21b84c612a038852f4808832b45a385a0Michael Sawyer
715361d0c3800e5ad886e5df971936ce6cd1ca89Mark Andrews<P><STRONG>See also:</STRONG> <A HREF="#loglevel">LogLevel</A>
715361d0c3800e5ad886e5df971936ce6cd1ca89Mark Andrews<P><HR>
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<H2><A NAME="files">&lt;Files&gt; directive</A></H2>
974f1d7b49442d65542ad3517dbd61146ee3b653Mark Andrews<A
1ae75c1024eb0475c2be352b8707772e16332ad0Mark Andrews HREF="directive-dict.html#Syntax"
5d20773abcdf9ff3afe14a349413174f94594188Michael Sawyer REL="Help"
5d20773abcdf9ff3afe14a349413174f94594188Michael Sawyer><STRONG>Syntax:</STRONG></A> &lt;Files <EM>filename</EM>&gt;
771218f9cacfbade2fcf3ab65520e8c473a12a3aBrian Wellington... &lt;/Files&gt;<BR>
cc7732e1299042bff430dfdfbc2624fb340047b2Michael Sawyer<A
2706bea98ef713e844670b85274af9502f87d7bcMichael Graff HREF="directive-dict.html#Context"
24139527f3d0d3fe743bd867329a2edd529728a6Andreas Gustafsson REL="Help"
d7a2e0511222811b96f2e8757272ee383ec7b5e6Michael Sawyer><STRONG>Context:</STRONG></A> server config, virtual host, .htaccess<BR>
d7a2e0511222811b96f2e8757272ee383ec7b5e6Michael Sawyer<A
14cd8ac04c999fd1d2e620856330e808cae57950Mark Andrews HREF="directive-dict.html#Status"
24139527f3d0d3fe743bd867329a2edd529728a6Andreas Gustafsson REL="Help"
17747cd5ee98901b435cd2b3019c52937955a981Michael Sawyer><STRONG>Status:</STRONG></A> core<BR>
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer<A
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer HREF="directive-dict.html#Compatibility"
3fbc17b5e380bcdcc882dc35015676b2cf1a06aeMichael Sawyer REL="Help"
cefd68008fbba3488a077052ae62aa12b6de502bMichael Sawyer><STRONG>Compatibility:</STRONG></A> only available in Apache
cefd68008fbba3488a077052ae62aa12b6de502bMichael Sawyer1.2 and above.<P>
3ce3305278210aa6c931ea338e8c71c83a55d028Brian Wellington
3ce3305278210aa6c931ea338e8c71c83a55d028Brian Wellington<P>The &lt;Files&gt; directive provides for access control by
2706bea98ef713e844670b85274af9502f87d7bcMichael Grafffilename. It is comparable to the <A
2706bea98ef713e844670b85274af9502f87d7bcMichael GraffHREF="#directory">&lt;Directory&gt;</A> directive and
cefd68008fbba3488a077052ae62aa12b6de502bMichael Sawyer<A HREF="#location">&lt;Location&gt;</A> directives. It
cefd68008fbba3488a077052ae62aa12b6de502bMichael Sawyershould be matched with a &lt;/Files&gt; directive. The
cefd68008fbba3488a077052ae62aa12b6de502bMichael Sawyerdirectives given within this section will be applied to any
7a272c6b0de3b8c0ad018b9896e287da19c43befAutomatic Updaterobject with a basename (last component of filename) matching
3ac2a9987875e947e0d0a09702b5a9b4dd745b75Tatuya JINMEI 神明達哉the specified filename.
5dcc67a0fff89e7ebf051f64b6b987862c331a04Mark Andrews<CODE>&lt;Files&gt;</CODE> sections are processed in the
5dcc67a0fff89e7ebf051f64b6b987862c331a04Mark Andrewsorder they appear in the configuration file, after the
5dcc67a0fff89e7ebf051f64b6b987862c331a04Mark Andrews&lt;Directory&gt; sections and <CODE>.htaccess</CODE> files are
cefd68008fbba3488a077052ae62aa12b6de502bMichael Sawyerread, but before &lt;Location&gt; sections. Note that
38cf6e52ce4b33795713388824b69d78e430b115Michael Sawyer&lt;Files&gt; can be nested inside &lt;Directory&gt;
38cf6e52ce4b33795713388824b69d78e430b115Michael Sawyersections to restrict the portion of the filesystem they
4d86cda3d7eb31578c9088c51a26643d43799533Mark Andrewsapply to.</P>
bdf0739d6e1d042355123931ba44d7f3bc9066b9Mark Andrews
bdf0739d6e1d042355123931ba44d7f3bc9066b9Mark Andrews<P>The <EM>filename</EM> argument should include a filename, or a
cefd68008fbba3488a077052ae62aa12b6de502bMichael Sawyerwild-card string, where `?' matches any single character, and `*' matches any
b8a04d50a361eb5e6a6b098d530daa0c56c6fdd9Mark Andrewssequences of characters. Extended regular expressions can also be used,
4e7973990c2aaec391cf307a7e60583331568e01Evan Huntwith the addition of
58e291cb8dd77656048d6d7727f2bc2388110785Evan Huntthe <CODE>~</CODE> character. For example:</P>
58e291cb8dd77656048d6d7727f2bc2388110785Evan Hunt
58e291cb8dd77656048d6d7727f2bc2388110785Evan Hunt<PRE>
58e291cb8dd77656048d6d7727f2bc2388110785Evan Hunt &lt;Files ~ &quot;\.(gif|jpe?g|png)$&quot;&gt;
3ce3305278210aa6c931ea338e8c71c83a55d028Brian Wellington</PRE>
3ce3305278210aa6c931ea338e8c71c83a55d028Brian Wellington
cefd68008fbba3488a077052ae62aa12b6de502bMichael Sawyerwould match most common Internet graphics formats. In Apache 1.3 and
8cd54a7461ad183f9e839d96cedb7b7ad03fb244Michael Sawyerlater, <A HREF="#filesmatch">&lt;FilesMatch&gt;</A> is preferred,
8cd54a7461ad183f9e839d96cedb7b7ad03fb244Michael Sawyerhowever.
db8b100cae62de849ecf4ba9ad3be811fb375b53Michael Sawyer
e9b85f0309c6bb6eebc2d6a0acf6a8f3bcc376acTatuya JINMEI 神明達哉<P>Note that unlike <A
cefd68008fbba3488a077052ae62aa12b6de502bMichael SawyerHREF="#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.
<P>
<STRONG>See also</STRONG>: <A HREF="/sections.html">How Directory,
Location and Files sections work</A> for an explanation of how these
different sections are combined when a request is received
<HR>
<H2><A NAME="filesmatch">&lt;FilesMatch&gt;</A></H2>
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> &lt;FilesMatch <EM>regex</EM>&gt;
... &lt;/FilesMatch&gt;<BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config, virtual host, .htaccess<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<BR>
<A
HREF="directive-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> only available in Apache
1.3 and above.<P>
<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>
<STRONG>See also</STRONG>: <A HREF="/sections.html">How Directory,
Location and Files sections work</A> for an explanation of how these
different sections are combined when a request is received
<HR>
<H2><A NAME="group">Group directive</A></H2>
<!--%plaintext &lt;?INDEX {\tt Group} directive&gt; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> Group <EM>unix-group</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> <CODE>Group #-1</CODE><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config, virtual host<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<P>
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; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> HostNameLookups <EM>on | off | double</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> <CODE>HostNameLookups off</CODE><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config, virtual host, directory<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<BR>
<A
HREF="directive-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> <CODE>double</CODE> available only in
Apache
1.3 and above.<BR>
<A
HREF="directive-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> Default was <CODE>on</CODE> prior to
Apache 1.3.<P>
This directive enables DNS lookups so that host names can be 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 <EM>logresolve</EM>,
provided in the <EM>/support</EM> 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; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> IdentityCheck <EM>boolean</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> <CODE>IdentityCheck off</CODE><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config, virtual host, directory<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<P>
This directive enables RFC1413-compliant logging of the 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="ifdefine">&lt;IfDefine&gt; directive</A></H2>
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> &lt;IfDefine [!]<EM>parameter-name</EM>&gt; <EM>...</EM>
&lt;/IfDefine&gt;<BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> None<BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> all<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> Core<BR>
<A
HREF="directive-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> &lt;IfDefine&gt; is only available in
1.3.1 and later.<P>
<P>
The &lt;IfDefine <EM>test</EM>&gt;...&lt;/IfDefine&gt;
section is used to mark directives that are conditional. The
directives within an IfDefine section are only
processed if the <EM>test</EM> is true. If <EM>test</EM>
is false, everything between the start and end markers
is ignored.<P>
The <EM>test</EM> in the &lt;IfDefine&gt; section directive
can be one of two forms:
<UL>
<LI><EM>parameter-name</EM>
<LI><CODE>!</CODE><EM>parameter-name</EM>
</UL>
<P>In the former case, the directives between the start and end markers are
only processed if the parameter named <EM>parameter-name</EM> is defined.
The second format reverses the test, and only processes the directives if
<EM>parameter-name</EM> is <STRONG>not</STRONG> defined.
<P>The <EM>parameter-name</EM> argument is a define as given on the
<CODE>httpd</CODE> command line via <CODE>-D</CODE><EM>parameter-</EM>, at the
time the server was started.
<P>&lt;IfDefine&gt; sections are nest-able, which can be used to implement
simple multiple-parameter tests.
Example:
<PRE>
$ httpd -DReverseProxy ...
# httpd.conf
&lt;IfDefine ReverseProxy&gt;
LoadModule rewrite_module libexec/mod_rewrite.so
LoadModule proxy_module libexec/libproxy.so
&lt;/IfDefine&gt;
</PRE>
<P> <HR>
<H2><A NAME="ifmodule">&lt;IfModule&gt; directive</A></H2>
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> &lt;IfModule [!]<EM>module-name</EM>&gt;
<EM>...</EM>
&lt;/IfModule&gt;<BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> None<BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> all<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> Core<BR>
<A
HREF="directive-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> IfModule is only available in 1.2 and
later.<P>
<P>
The &lt;IfModule <EM>test</EM>&gt;...&lt;/IfModule&gt;
section is used to mark directives that are conditional. The
directives within an IfModule section are only
processed if the <EM>test</EM> is true. If <EM>test</EM>
is false, everything between the start and end markers
is ignored.<P>
The <EM>test</EM> in the &lt;IfModule&gt; section directive
can be one of two forms:
<UL>
<LI><EM>module name</EM>
<LI>!<EM>module name</EM>
</UL>
<P>In the former case, the directives between the start and end markers
are only processed if the module named <EM>module name</EM> is compiled
in to Apache. The second format reverses the test, and only processes
the directives if <EM>module name</EM> is <STRONG>not</STRONG> compiled in.
<P>The <EM>module name</EM> 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:</STRONG> Include <EM>filename</EM><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> Core<BR>
<A
HREF="directive-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> Include is only available in Apache 1.3
and later.
<P>
This directive allows inclusion of other configuration files 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>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> Core<BR>
<A
HREF="directive-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> KeepAlive is only available in Apache
1.1 and later.<P>
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>
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> KeepAliveTimeout <EM>seconds</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> <CODE>KeepAliveTimeout 15</CODE><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> Core<BR>
<A
HREF="directive-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> KeepAliveTimeout is only available in
Apache 1.1 and later.<P>
The number of seconds Apache will wait for a subsequent 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="limit">&lt;Limit&gt; directive</A></H2>
<!--%plaintext &lt;?INDEX {\tt Limit} section directive&gt; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A>
&lt;Limit <EM>method method</EM> ... &gt; ... &lt;/Limit&gt;<BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> any<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<P>
&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. The method names
listed can be one or more of: GET, POST, PUT, DELETE, CONNECT or
OPTIONS. <STRONG>The method name is case-sensitive.</STRONG>
If GET is used it will also restrict HEAD requests.
<STRONG>If you wish to limit all methods, do not include any
&lt;Limit&gt; directive at all.</STRONG>
<P><HR>
<H2><A NAME="limitrequestbody">LimitRequestBody directive</A></H2>
<!--%plaintext &lt;?INDEX {\tt LimitRequestBody} directive&gt; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> LimitRequestBody <EM>number</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> <CODE>LimitRequestBody 0</CODE><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config, virtual host, directory,
.htaccess<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<BR>
<A
HREF="directive-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> LimitRequestBody is only available in
Apache 1.3.2 and later.
<P>
<EM>Number</EM> is a long integer from 0 (meaning unlimited) to 2147483647
(2GB). The default value is defined by the compile-time constant
<CODE>DEFAULT_LIMIT_REQUEST_BODY</CODE> (0 as distributed).
<P>
The LimitRequestBody directive allows the user to set a
limit on the allowed size of an HTTP request message body within
the context in which the directive is given (server, per-directory,
per-file or per-location). If the client request exceeds that limit,
the server will return an error response instead of servicing the request.
The size of a normal request message body will vary greatly depending
on the nature of the resource and the methods allowed on that resource.
CGI scripts typically use the message body for passing form information
to the server. Implementations of the PUT method will require a value
at least as large as any representation that the server wishes
to accept for that resource.
<P>
This directive gives the server administrator greater control over abnormal
client request behavior, which may be useful for avoiding some forms
of denial-of-service attacks.
<P>
<P><HR>
<H2><A NAME="limitrequestfields">LimitRequestFields directive</A></H2>
<!--%plaintext &lt;?INDEX {\tt LimitRequestFields} directive&gt; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> LimitRequestFields <EM>number</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> <CODE>LimitRequestFields 100</CODE><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<BR>
<A
HREF="directive-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> LimitRequestFields is only available in
Apache 1.3.2 and later.
<P>
<EM>Number</EM> is an integer from 0 (meaning unlimited) to 32767.
The default value is defined by the compile-time constant
<CODE>DEFAULT_LIMIT_REQUEST_FIELDS</CODE> (100 as distributed).
<P>
The LimitRequestFields directive allows the server administrator to modify
the limit on the number of request header fields allowed in an HTTP request.
A server needs this value to be larger than the number of fields that a
normal client request might include. The number of request header fields
used by a client rarely exceeds 20, but this may vary among different
client implementations, often depending upon the extent to which a user
has configured their browser to support detailed content negotiation.
Optional HTTP extensions are often expressed using request header fields.
<P>
This directive gives the server administrator greater control over abnormal
client request behavior, which may be useful for avoiding some forms
of denial-of-service attacks. The value should be increased if normal
clients see an error response from the server that indicates too many
fields were sent in the request.<P>
<P><HR>
<H2><A NAME="limitrequestfieldsize">LimitRequestFieldsize directive</A></H2>
<!--%plaintext &lt;?INDEX {\tt LimitRequestFieldsize} directive&gt; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> LimitRequestFieldsize <EM>number</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> <CODE>LimitRequestFieldsize 8190</CODE><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<BR>
<A
HREF="directive-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> LimitRequestFieldsize is only available in
Apache 1.3.2 and later.
<P>
<EM>Number</EM> is an integer size in bytes from 0 to the value of the
compile-time constant <CODE>DEFAULT_LIMIT_REQUEST_FIELDSIZE</CODE>
(8190 as distributed).
<P>
The LimitRequestFieldsize directive allows the server administrator to reduce
the limit on the allowed size of an HTTP request header field below the
normal input buffer size compiled with the server. A server needs this
value to be large enough to hold any one header field from a normal client
request. The size of a normal request header field will vary greatly
among different client implementations, often depending upon the extent
to which a user has configured their browser to support detailed
content negotiation.
<P>
This directive gives the server administrator greater control over abnormal
client request behavior, which may be useful for avoiding some forms
of denial-of-service attacks. Under normal conditions, the value should
not be changed from the default.<P>
<P><HR>
<H2><A NAME="limitrequestline">LimitRequestLine directive</A></H2>
<!--%plaintext &lt;?INDEX {\tt LimitRequestLine} directive&gt; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> LimitRequestLine <EM>number</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> <CODE>LimitRequestLine 8190</CODE><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<BR>
<A
HREF="directive-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> LimitRequestLine is only available in
Apache 1.3.2 and later.
<P>
<EM>Number</EM> is an integer size in bytes from 0 to the value of the
compile-time constant <CODE>DEFAULT_LIMIT_REQUEST_LINE</CODE>
(8190 as distributed).
<P>
The LimitRequestLine directive allows the server administrator to reduce
the limit on the allowed size of a client's HTTP request-line below the
normal input buffer size compiled with the server. Since the request-line
consists of the HTTP method, URI, and protocol version, the
LimitRequestLine directive places a restriction on the length of a
request-URI allowed for a request on the server. A server needs this
value to be large enough to hold any of its resource names, including
any information that might be passed in the query part of a GET request.
<P>
This directive gives the server administrator greater control over abnormal
client request behavior, which may be useful for avoiding some forms
of denial-of-service attacks. Under normal conditions, the value should
not be changed from the default.<P>
<P><HR>
<H2><A NAME="listen">Listen directive</A></H2>
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A>
Listen [<EM>IP address</EM>:]<EM>port number</EM><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<BR>
<A
HREF="directive-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> 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="http://www.apache.org/info/known_bugs.html#listenbug">Known Bugs</A>
</P>
<HR>
<H2><A NAME="listenbacklog">ListenBacklog directive</A></H2>
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> ListenBacklog <EM>backlog</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> <CODE>ListenBacklog 511</CODE><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> Core<BR>
<A
HREF="directive-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> 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>This will often be limited to a smaller number by the operating
system. This varies from OS to OS. Also note that many OSes do not
use exactly what is specified as the backlog, but use a number based on
(but normally larger than) what is set.
<HR>
<H2><A NAME="location">&lt;Location&gt; directive</A></H2>
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> &lt;Location <EM>URL</EM>&gt;
... &lt;/Location&gt;<BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config, virtual host<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<BR>
<A
HREF="directive-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> Location is only available in Apache
1.1 and later.<P>
<P>The &lt;Location&gt; directive provides for access control by
URL. It is similar to the <A
HREF="#directory">&lt;Directory&gt;</A> directive, and
starts a subsection which is terminated with a &lt;/Location&gt;
directive. <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, and after the &lt;Files&gt; sections.</P>
<P>Note that URLs do not have to line up with the filesystem at all,
it should be emphasized that &lt;Location&gt; operates completely outside
the filesystem.
<P>For all origin (non-proxy) requests, the URL to be matched is
of the form <CODE>/path/</CODE>, and you should not include any
<CODE>http://servername</CODE> prefix. For proxy requests, the URL
to be matched is of the form <CODE>scheme://servername/path</CODE>,
and you must include the prefix.
<P>The URL may use wildcards 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". In Apache 1.3 and above, a new directive
<A HREF="#locationmatch">&lt;LocationMatch&gt;</A> exists which
behaves identical to the regex version of
<CODE>&lt;Location&gt;</CODE>.
<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>
<P><STRONG>Apache 1.3 and above note about / (slash)</STRONG>: The slash
character has special
meaning depending on where in a URL it appears. People may be used
to its behaviour in the filesystem where multiple adjacent slashes are
frequently collapsed to a single slash (<EM>i.e.</EM>, <CODE>/home///foo</CODE>
is the same as <CODE>/home/foo</CODE>). In URL-space this is not
necessarily true. The <CODE>&lt;LocationMatch&gt;</CODE> directive
and the regex version of <CODE>&lt;Location&gt;</CODE> require you
to explicitly specify multiple slashes if that is your intention.
For example, <CODE>&lt;LocationMatch ^/abc&gt;</CODE> would match the
request URL <CODE>/abc</CODE> but not the request URL <CODE>//abc</CODE>.
The (non-regex) <CODE>&lt;Location&gt;</CODE> directive behaves
similarly when used for proxy requests. But when (non-regex)
<CODE>&lt;Location&gt;</CODE> is used for non-proxy requests it will
implicitly match multiple slashes with a single slash. For example,
if you specify <CODE>&lt;Location /abc/def&gt;</CODE> and the request
is to <CODE>/abc//def</CODE> then it will match.
<P>
<STRONG>See also</STRONG>: <A HREF="/sections.html">How Directory,
Location and Files sections work</A> for an explanation of how these
different sections are combined when a request is received
<HR>
<H2><A NAME="locationmatch">&lt;LocationMatch&gt;</A></H2>
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> &lt;LocationMatch <EM>regex</EM>&gt;
... &lt;/LocationMatch&gt;<BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config, virtual host<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<BR>
<A
HREF="directive-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> LocationMatch is only available in
Apache 1.3 and later.<P>
<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>
<STRONG>See also</STRONG>: <A HREF="/sections.html">How Directory,
Location and Files sections work</A> for an explanation of how these
different sections are combined when a request is received
<HR>
<H2><A NAME="lockfile">LockFile directive</A></H2>
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> LockFile <EM>filename</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> <CODE>LockFile logs/accept.lock</CODE><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<P>
The 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 <STRONG>the lockfile
must be stored on a local disk</STRONG>. The PID of the main
server process is automatically appended to the filename. <P>
<STRONG>SECURITY:</STRONG> It is best to avoid putting this file in a
world writable directory such as <CODE>/var/tmp</CODE> because someone
could create a denial of service attack and prevent the server from
starting by creating a lockfile with the same name as the one the
server will try to create.<P>
<P><HR>
<H2><A NAME="loglevel">LogLevel directive</A></H2>
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> LogLevel <EM>level</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> <CODE>LogLevel error</CODE><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config, virtual host<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<BR>
<A
HREF="directive-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> LogLevel is only available in 1.3 or
later.
<P>LogLevel adjusts the verbosity of the messages recorded in the
error logs (see <A HREF="#errorlog">ErrorLog</A> directive).
The following <EM>level</EM>s are available, in order of
decreasing significance:
<P><TABLE>
<TR><TH ALIGN="LEFT"><STRONG>Level</STRONG>
<TH ALIGN="LEFT"><STRONG>Description</STRONG>
<TR><TH><TH ALIGN="LEFT"><STRONG>Example</STRONG>
<TR><TD><CODE>emerg</CODE>
<TD>Emergencies - system is unusable.
<TR><TD><TD>"Child cannot open lock file. Exiting"
<TR><TD><CODE>alert</CODE>
<TD>Action must be taken immediately.
<TR><TD><TD>"getpwuid: couldn't determine user name from uid"
<TR><TD><CODE>crit</CODE>
<TD>Critical Conditions.
<TR><TD><TD>"socket: Failed to get a socket, exiting child"
<TR><TD><CODE>error</CODE>
<TD>Error conditions.
<TR><TD><TD>"Premature end of script headers"
<TR><TD><CODE>warn</CODE>
<TD>Warning conditions.
<TR><TD><TD>"child process 1234 did not exit, sending another SIGHUP"
<TR><TD><CODE>notice</CODE>
<TD>Normal but significant condition.
<TR><TD><TD>"httpd: caught SIGBUS, attempting to dump core in ..."
<TR><TD><CODE>info</CODE>
<TD>Informational.
<TR><TD><TD>"Server seems busy, (you may need to increase StartServers, or
Min/MaxSpareServers)..."
<TR><TD><CODE>debug</CODE>
<TD>Debug-level messages
<TR><TD><TD>"Opening config file ..."
</TABLE>
<P>When a particular level is specified, messages from all other levels
of higher significance will be reported as well. <EM>E.g.</EM>, when
<CODE>LogLevel info</CODE> is specified, then messages with log levels of
<CODE>notice</CODE> and <CODE>warn</CODE> will also be posted.
<P>
Using a level of at least <CODE>crit</CODE> is recommended.
<P><HR>
<H2><A NAME="maxclients">MaxClients directive</A></H2>
<!--%plaintext &lt;?INDEX {\tt MaxClients} directive&gt; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> MaxClients <EM>number</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> <CODE>MaxClients 256</CODE><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<P>
<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. To configure more than 256 clients, you must
edit the HARD_SERVER_LIMIT entry in httpd.h and recompile.
<P>Any connection attempts over the MaxClients limit will normally
be queued, up to a number based on the <A HREF="#listenbacklog">
ListenBacklog</A> directive. Once a child process is freed at the
end of a different request, the connection will then be serviced.
<HR>
<H2><A NAME="maxkeepaliverequests">MaxKeepAliveRequests directive</A></H2>
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> MaxKeepAliveRequests <EM>number</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> <CODE>MaxKeepAliveRequests 100</CODE><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<BR>
<A
HREF="directive-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> Only available in Apache
1.2 and later.
<P>The MaxKeepAliveRequests directive limits the number of requests
allowed per connection when <A HREF="#keepalive">KeepAlive</A> is
on. If it is set to "<CODE>0</CODE>", unlimited requests will be
allowed. We 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; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> MaxRequestsPerChild <EM>number</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> <CODE>MaxRequestsPerChild 0</CODE><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<P>
The 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>This directive has no effect on Win32.
<P><HR>
<H2><A NAME="maxspareservers">MaxSpareServers directive</A></H2>
<!--%plaintext &lt;?INDEX {\tt MaxSpareServers} directive&gt; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> MaxSpareServers <EM>number</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> <CODE>MaxSpareServers 10</CODE><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<P>
The 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>
This directive has no effect when used with the Apache Web server on a
Microsoft Windows platform.
<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; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> MinSpareServers <EM>number</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> <CODE>MinSpareServers 5</CODE><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<P>
The 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>
This directive has no effect on Microsoft Windows.
<P>
See also <A HREF="#maxspareservers">MaxSpareServers</A> and
<A HREF="#startservers">StartServers</A>.<P><HR>
<H2><A NAME="namevirtualhost">NameVirtualHost directive</A></H2>
<!--%plaintext &lt;?INDEX {\tt NameVirtualHost} directive&gt; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> NameVirtualHost <EM>addr</EM>[:<EM>port</EM>]<BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<BR>
<A
HREF="directive-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> NameVirtualHost is only available in
Apache 1.3 and later<P>
The NameVirtualHost directive is a required directive if you want to configure
<A HREF="/vhosts/index.html">name-based virtual hosts</A>.<P>
Although <EM>addr</EM> can be hostname it is recommended that you always use
an IP address, <EM>e.g.</EM>
<BLOCKQUOTE><CODE>NameVirtualHost 111.22.33.44</CODE></BLOCKQUOTE>
With the NameVirtualHost directive you specify the address to which your
name-based virtual host names resolve. If you have multiple name-based
hosts on multiple addresses, repeat the directive for each address.<P>
Note: the "main server" and any _default_ servers will <STRONG>never</STRONG>
be served for a request to a NameVirtualHost IP Address (unless for some
reason you specify NameVirtualHost but then don't define any VirtualHosts
for that address).<P>
Optionally you can specify a port number on which the name-based
virtual hosts should be used, <EM>e.g.</EM>
<BLOCKQUOTE><CODE>NameVirtualHost 111.22.33.44:8080</CODE></BLOCKQUOTE>
<STRONG>See also:</STRONG>
<A HREF="/vhosts/index.html">Apache Virtual Host documentation</A>
<HR>
<H2><A NAME="options">Options directive</A></H2>
<!--%plaintext &lt;?INDEX {\tt Options} directive&gt; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> Options <EM>[+|-]option [+|-]option ...</EM><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config, virtual host, directory,
.htaccess<BR>
<A
HREF="directive-dict.html#Override"
REL="Help"
><STRONG>Override:</STRONG></A> Options<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<P>
The Options directive controls which server features are available in
a particular directory.
<P>
<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. This is the default setting.
<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.
<BR>
<STRONG>Note</STRONG>: even though the server follows the symlink it
does <EM>not</EM>
change the pathname used to match against <CODE>&lt;Directory&gt;</CODE>
sections.
<BR>
<STRONG>Note</STRONG>: this option gets ignored if set inside a
&lt;Location&gt; section.
<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 (<EM>e.g.</EM>, 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.
<BR>
<STRONG>Note</STRONG>: this option gets ignored if set inside a
&lt;Location&gt; section.
</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 <EM>all</EM> 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.<P>
<STRONG>Note:</STRONG> Using <CODE>-IncludesNOEXEC</CODE> or
<CODE>-Includes</CODE>
disables server-side includes completely regardless of the previous setting.<P>
The default in the absence of any other settings is <CODE>All</CODE>.<P>
<HR>
<H2><A NAME="pidfile">PidFile directive</A></H2>
<!--%plaintext &lt;?INDEX {\tt PidFile} directive&gt; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> PidFile <EM>filename</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> <CODE>PidFile logs/httpd.pid</CODE><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<P>
The 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#serverroot">security</A>.
<P><HR>
<H2><A NAME="port">Port directive</A></H2>
<!--%plaintext &lt;?INDEX {\tt Port} directive&gt; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> Port <EM>number</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> <CODE>Port 80</CODE><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<P>
<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,
a Port directive given in the "main server"
(<EM>i.e.</EM>, outside any <A HREF="#virtualhost">&lt;VirtualHost&gt</A> section)
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). This
behaviour is modified by
<A HREF="#usecanonicalname">UseCanonicalName</A>.
</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 <EM>canonical</EM>
address of the server.
(See also <A HREF="#usecanonicalname">UseCanonicalName</A>.)<P>
Port 80 is one of Unix's special ports. All ports numbered
below 1024 are reserved for system use, <EM>i.e.</EM>, 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; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> require <EM>entity-name entity entity...</EM><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> directory, .htaccess<BR>
<A
HREF="directive-dict.html#Override"
REL="Help"
><STRONG>Override:</STRONG></A> AuthConfig<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<P>
This directive selects which authenticated users can access 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; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> ResourceConfig <EM>filename</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> <CODE>ResourceConfig conf/srm.conf</CODE><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config, virtual host<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<P>
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; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> RLimitCPU <EM># or 'max'</EM>
<EM>[# or 'max']</EM>
<BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> <EM>Unset; uses operating system defaults</EM>
<BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config, virtual host<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<BR>
<A
HREF="directive-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> RLimitCPU is only available in Apache 1.2
and later<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; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> RLimitMEM <EM># or 'max'</EM>
<EM>[# or 'max']</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> <EM>Unset; uses operating system defaults</EM>
<BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config, virtual host<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<BR>
<A
HREF="directive-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> RLimitMEM is only available in Apache 1.2
and later<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; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> RLimitNPROC <EM># or 'max'</EM>
<EM>[# or 'max']</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> <EM>Unset; uses operating system defaults</EM>
<BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config, virtual host<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<BR>
<A
HREF="directive-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> RLimitNPROC is only available in Apache
1.2 and later<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 <STRONG>not</STRONG> running under userids other
than the
web server userid, this directive will limit the number of processes that the
server itself can create. Evidence of this situation will be indicated by
<STRONG><EM>cannot fork</EM></STRONG> messages in the error_log.<P>
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; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> Satisfy <EM>'any' or 'all'</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> Satisfy all<BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> directory, .htaccess<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<BR>
<A
HREF="directive-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> Satisfy is only available in Apache 1.2
and later<P>
Access policy if both 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 <EM>and</EM> client host address. In this case the
default behavior ("all") is to require that the client passes the
address access restriction <EM>and</EM> enters a valid username and
password. With the "any" option the client will be granted access if
they either pass the host restriction or enter a valid username and
password. This can be used to password restrict an area, but to let
clients from particular addresses in without prompting for a password.
<P><HR>
<H2><A NAME="scoreboardfile">ScoreBoardFile directive</A></H2>
<!--%plaintext &lt;?INDEX {\tt ScoreBoardFile} directive&gt; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> ScoreBoardFile <EM>filename</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> <CODE>ScoreBoardFile logs/apache_status</CODE>
<BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<P>
The 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 -DUSE_SHMGET_SCOREBOARD</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. (Prior to 1.3b4, <CODE>HAVE_SHMGET</CODE> would have sufficed.)<P>
SVR4 users should consider adding
<CODE>-DHAVE_SHMGET -DUSE_SHMGET_SCOREBOARD</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. (Prior to 1.3b4, <CODE>HAVE_SHMGET</CODE> would have sufficed.)<P>
<STRONG>See Also</STRONG>:
<A HREF="/stopping.html">Stopping and Restarting Apache</A></P>
<P><HR>
<H2><A NAME="scriptinterpretersource">ScriptInterpreterSource directive</A></H2>
<!--%plaintext &lt;?INDEX {\tt ScriptInterpreterSource} directive&gt; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> ScriptInterpreterSource <EM>'registry' or 'script'</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> <CODE>ScriptInterpreterSource script</CODE>
<BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> directory, .htaccess<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core (Windows only)<P>
This directive is used to control how Apache 1.3.5 and later finds the interpreter
used to run CGI scripts. The default technique is to use the interpreter pointed to by
the #! line in the script. Setting ScriptInterpreterSource registry will cause the
Windows Registry to be searched using the script file extension (e.g., .pl) as a search key.
<P><HR>
<H2><A NAME="sendbuffersize">SendBufferSize directive</A></H2>
<!--%plaintext &lt;?INDEX {\tt SendBufferSize} directive&gt; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> SendBufferSize <EM>bytes</EM><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<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 (<EM>i.e.</EM>, 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; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> ServerAdmin <EM>email-address</EM><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config, virtual host<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<P>
The ServerAdmin sets the e-mail address that the server includes in any
error messages it returns to the client.<P>
It may be worth setting up a dedicated address for this, <EM>e.g.</EM>
<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>
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> ServerAlias <EM>host1 host2 ...</EM><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> virtual host<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<BR>
<A
HREF="directive-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> ServerAlias is only available in Apache
1.1 and later.<P>
The ServerAlias directive sets the alternate names for a host, for use
with
<A HREF="/vhosts/name-based.html">name-based virtual hosts</A>.
<P><STRONG>See also:</STRONG>
<A HREF="/vhosts/index.html">Apache Virtual Host documentation</A>
<HR>
<H2><A NAME="servername">ServerName directive</A></H2>
<!--%plaintext &lt;?INDEX {\tt ServerName} directive&gt; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> ServerName <EM>fully-qualified domain name</EM>
<BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config, virtual host<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<P>
The 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>:<BR>
<A HREF="/dns-caveats.html">DNS Issues</A><BR>
<A HREF="#usecanonicalname">UseCanonicalName</A><BR>
</P>
<HR>
<H2><A NAME="serverpath">ServerPath directive</A></H2>
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> ServerPath <EM>pathname</EM><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> virtual host<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<BR>
<A
HREF="directive-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> ServerPath is only available in Apache
1.1 and later.<P>
The ServerPath directive sets the legacy URL pathname for a host, for
use with <A HREF="/vhosts/index.html">name-based virtual hosts</A>.
<P><STRONG>See also:</STRONG>
<A HREF="/vhosts/index.html">Apache Virtual Host documentation</A>
<HR>
<H2><A NAME="serverroot">ServerRoot directive</A></H2>
<!--%plaintext &lt;?INDEX {\tt ServerRoot} directive&gt; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> ServerRoot <EM>directory-filename</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> <CODE>ServerRoot /usr/local/apache</CODE><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<P>
The ServerRoot directive sets the directory in which the server lives.
Typically it will contain the subdirectories <CODE>conf/</CODE> and
<CODE>logs/</CODE>. Relative paths for other configuration files are taken
as relative to this directory.<P>
See also <A HREF="/invoking.html">the <CODE>-d</CODE> option to httpd</A>.<P>
See also <A HREF="/misc/security_tips.html#serverroot">the security tips</A>
for information on how to properly set permissions on the ServerRoot.<P>
<HR>
<H2><A NAME="serversignature">ServerSignature directive</A></H2>
<!--%plaintext &lt;?INDEX {\tt ServerSignature} directive&gt; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> ServerSignature <EM>Off | On | EMail</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> <CODE>ServerSignature Off</CODE><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config, virtual host, directory,
.htaccess<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<BR>
<A
HREF="directive-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> ServerSignature is only available in
Apache
1.3 and later.<P>
The ServerSignature directive allows the configuration of a trailing
footer line under server-generated documents (error messages,
mod_proxy ftp directory listings, mod_info output, ...). The reason
why you would want to enable such a footer line is that in a chain
of proxies, the user often has no possibility to tell which of the
chained servers actually produced a returned error message.<BR>
The <SAMP>Off</SAMP> setting, which is the default, suppresses the
error line (and is therefore compatible with the behavior of
Apache-1.2 and below). The <SAMP>On</SAMP> setting simply adds a
line with the server version number and <A
HREF="#servername">ServerName</A> of the serving virtual host, and
the <SAMP>EMail</SAMP> setting additionally creates a "mailto:"
reference to the <A HREF="#serveradmin">ServerAdmin</A> of the
referenced document.
<HR>
<H2><A NAME="servertokens">ServerTokens directive</A></H2>
<!--%plaintext &lt;?INDEX {\tt ServerTokens} directive&gt; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> ServerTokens <EM>Minimal|OS|Full</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> <CODE>ServerTokens Full</CODE><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config <BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<BR>
<A
HREF="directive-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> ServerTokens is only available
in Apache 1.3 and later
<P>
This directive controls whether <SAMP>Server</SAMP> response header
field which is sent back to clients includes a description of the generic
OS-type of the server as well as information about compiled-in modules.
</P>
<DL>
<DT><CODE>ServerTokens Min[imal]</CODE>
</DT>
<DD>Server sends (<EM>e.g.</EM>): <SAMP>Server: Apache/1.3.0</SAMP>
</DD>
<DT><CODE>ServerTokens OS</CODE>
</DT>
<DD>Server sends (<EM>e.g.</EM>): <SAMP>Server: Apache/1.3.0 (Unix)</SAMP>
</DD>
<DT><CODE>ServerTokens Full</CODE> (or not specified)
</DT>
<DD>Server sends (<EM>e.g.</EM>): <SAMP>Server: Apache/1.3.0 (Unix) PHP/3.0
MyMod/1.2</SAMP>
</DD>
</DL>
<P>
This setting applies to the entire server, and cannot be enabled or
disabled on a virtualhost-by-virtualhost basis.
</P>
<HR>
<H2><A NAME="servertype">ServerType directive</A></H2>
<!--%plaintext &lt;?INDEX {\tt ServerType} directive&gt; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> ServerType <EM>type</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> <CODE>ServerType standalone</CODE><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<P>
The 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.
<FONT COLOR="red">Inetd mode is no longer recommended and does not always
work properly. Avoid it if at all possible.</FONT>
<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>
<HR>
<H2><A NAME="startservers">StartServers directive</A></H2>
<!--%plaintext &lt;?INDEX {\tt StartServers} directive&gt; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> StartServers <EM>number</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> <CODE>StartServers 5</CODE><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<P>
The 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 under Microsoft Windows, this directive has no effect.
There is always one child which handles all requests. Within the
child requests are handled by separate threads. The
<A HREF="#threadsperchild">ThreadsPerChild</A> directive controls
the maximum number of child threads handling requests, which will
have a similar effect to the setting of <SAMP>StartServers</SAMP>
on Unix.
<P>
See also <A HREF="#minspareservers">MinSpareServers</A> and
<A HREF="#maxspareservers">MaxSpareServers</A>.<P><HR>
<H2><A NAME="threadsperchild">ThreadsPerChild</A></H2>
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> ThreadsPerChild <EM>number</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> <CODE>ThreadsPerChild 50</CODE><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core (Windows)<BR>
<STRONG>Compatibility:</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>This directive has no effect on Unix systems. Unix users should look
at <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; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> TimeOut <EM>number</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> <CODE>TimeOut 300</CODE><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<P>
The TimeOut directive currently defines the amount of time Apache will
wait for three things:
<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="usecanonicalname">UseCanonicalName directive</A></H2>
<!--%plaintext &lt;?INDEX {\tt UseCanonicalName} directive&gt; -->
<A HREF="directive-dict.html#Syntax" REL="Help">
<STRONG>Syntax:</STRONG></A> UseCanonicalName <EM>on|off</EM><BR>
<A HREF="directive-dict.html#Default" REL="Help">
<STRONG>Default:</STRONG></A> <CODE>UseCanonicalName on</CODE><BR>
<A HREF="directive-dict.html#Context" REL="Help">
<STRONG>Context:</STRONG></A> server config, virtual host, directory, .htaccess
<BR>
<A HREF="directive-dict.html#Override" REL="Help">
<STRONG>Override:</STRONG></A> Options<BR>
<A HREF="directive-dict.html#Compatibility" REL="Help">
<STRONG>Compatibility:</STRONG></A> UseCanonicalName is only available in
Apache 1.3 and later<P>
In many situations Apache has to construct a <EM>self-referential</EM>
URL. That is, a URL which refers back to the same server.
With <CODE>UseCanonicalName on</CODE> (and in all versions prior to
1.3) Apache will use the <A HREF="#servername">ServerName</A> and <A
HREF="#port">Port</A> directives to construct a canonical name for the
server. This name is used in all self-referential URLs, and for the
values of <CODE>SERVER_NAME</CODE> and <CODE>SERVER_PORT</CODE> in CGIs.
<P>With <CODE>UseCanonicalName off</CODE> Apache will form
self-referential URLs using the hostname and port supplied
by the client if any are supplied (otherwise it will use the
canonical name). These values are the same that are used to
implement <A HREF="/vhosts/name-based.html">name based virtual
hosts</A>, and are available with the same clients. The CGI variables
<CODE>SERVER_NAME</CODE> and <CODE>SERVER_PORT</CODE> will be constructed
from the client supplied values as well.
<P>An example where this may be useful is on an intranet server where
you have users connecting to the machine using short names such as
<CODE>www</CODE>. You'll notice that if the users type a shortname,
and a URL which is a directory, such as <CODE>http://www/splat</CODE>,
<EM>without the trailing slash</EM> then Apache will redirect them to
<CODE>http://www.domain.com/splat/</CODE>. If you have authentication
enabled, this will cause the user to have to reauthenticate twice (once
for <CODE>www</CODE> and once again for <CODE>www.domain.com</CODE>).
But if <CODE>UseCanonicalName</CODE> is set off, then Apache will redirect
to <CODE>http://www/splat/</CODE>.
<P><STRONG>Warning:</STRONG> if CGIs make assumptions about the values of
<CODE>SERVER_NAME</CODE> they may be broken by this option. The client
is essentially free to give whatever value they want as a hostname.
But if the CGI is only using <CODE>SERVER_NAME</CODE> to construct
self-referential URLs then it should be just fine.
<P><STRONG>See also:</STRONG>
<A HREF="#servername">ServerName</A>,
<A HREF="#port">Port</A>
<P><HR>
<H2><A NAME="user">User directive</A></H2>
<!--%plaintext &lt;?INDEX {\tt User} directive&gt; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> User <EM>unix-userid</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> <CODE>User #-1</CODE><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config, virtual host<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> core<P>
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.
For example mod_proxy's cache, when enabled, must be accessible to this user
(see the <A HREF="mod_proxy.html#cacheroot"><CODE>CacheRoot</CODE>
directive</A>).<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; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> &lt;VirtualHost <EM>addr</EM>[:<EM>port</EM>]
...&gt; ...
&lt;/VirtualHost&gt; <BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> server config<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> Core.<BR>
<A
HREF="directive-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> Non-IP address-based Virtual Hosting only
available in Apache 1.1 and later.<BR>
<A
HREF="directive-dict.html#Compatibility"
REL="Help"
><STRONG>Compatibility:</STRONG></A> Multiple address support only available in
Apache 1.2 and later.<P>
&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="/vhosts/index.html">Apache Virtual Host documentation</A><BR>
<STRONG>See also:</STRONG>
<A HREF="/dns-caveats.html">Warnings about DNS and Apache</A><BR>
<STRONG>See also:</STRONG>
<A HREF="/bind.html">Setting which addresses and ports Apache uses</A><BR>
<STRONG>See also</STRONG>: <A HREF="/sections.html">How Directory,
Location and Files sections work</A> for an explanation of how these
different sections are combined when a request is received
</P>
<!--#include virtual="footer.html" -->
</BODY>
</HTML>