132N/A<!
DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
132N/A<
TITLE>Apache Core Features</
TITLE>
132N/A<!-- Background white, links blue (unvisited), navy (visited), red (active) --> 132N/A<
H1 ALIGN="CENTER">Apache Core Features</
h1>
132N/AThese configuration parameters control the core Apache features, and are
132N/A<
li><
A HREF="#accessconfig">AccessConfig</
A>
215N/A<
li><
A HREF="#accessfilename">AccessFileName</
A>
132N/A<
li><
A HREF="#addmodule">AddModule</
A>
132N/A<
li><
A HREF="#allowoverride">AllowOverride</
A>
132N/A<
li><
A HREF="#authname">AuthName</
A>
132N/A<
li><
A HREF="#authtype">AuthType</
A>
132N/A<
li><
A HREF="#bindaddress">BindAddress</
A>
132N/A<
li><
A HREF="#clearmodulelist">ClearModuleList</
A>
132N/A<
li><
A HREF="#defaulttype">DefaultType</
A>
132N/A<
li><
A HREF="#directory"><Directory></
A>
132N/A<
li><
A HREF="#documentroot">DocumentRoot</
A>
132N/A<
li><
A HREF="#errordocument">ErrorDocument</
A>
132N/A<
li><
A HREF="#errorlog">ErrorLog</
A>
132N/A<
li><
A HREF="#files"><Files></
A>
132N/A<
li><
A HREF="#group">Group</
A>
132N/A<
li><
A HREF="#hostnamelookups">HostNameLookups</
A>
132N/A<
li><
A HREF="#identitycheck">IdentityCheck</
A>
132N/A<
li><
A HREF="#ifmodule"><IfModule></
A>
132N/A<
li><
A HREF="#keepalive">KeepAlive</
A>
132N/A<
li><
A HREF="#keepalivetimeout">KeepAliveTimeout</
A>
132N/A<
li><
A HREF="#limit"><Limit></
A>
132N/A<
li><
A HREF="#listen">Listen</
A>
132N/A<
li><
A HREF="#listenbacklog">ListenBacklog</
A>
132N/A<
li><
A HREF="#location"><Location></
A>
132N/A<
li><
A HREF="#lockfile">LockFile</
A>
132N/A<
li><
A HREF="#maxclients">MaxClients</
A>
132N/A<
li><
A HREF="#maxkeepaliverequests">MaxKeepAliveRequests</
a>
132N/A<
li><
A HREF="#maxrequestsperchild">MaxRequestsPerChild</
A>
132N/A<
li><
A HREF="#maxspareservers">MaxSpareServers</
A>
132N/A<
li><
A HREF="#minspareservers">MinSpareServers</
A>
132N/A<
li><
A HREF="#options">Options</
A>
132N/A<
li><
A HREF="#pidfile">PidFile</
A>
132N/A<
li><
A HREF="#port">Port</
A>
132N/A<
li><
A HREF="#require">require</
A>
132N/A<
li><
A HREF="#resourceconfig">ResourceConfig</
A>
132N/A<
li><
A HREF="#rlimitcpu">RLimitCPU</
A>
132N/A<
li><
A HREF="#rlimitmem">RLimitMEM</
A>
132N/A<
li><
A HREF="#rlimitnproc">RLimitNPROC</
A>
132N/A<
li><
A HREF="#satisfy">Satisfy</
A>
132N/A<
li><
A HREF="#scoreboardfile">ScoreBoardFile</
A>
132N/A<
li><
A HREF="#sendbuffersize">SendBufferSize</
A>
132N/A<
li><
A HREF="#serveradmin">ServerAdmin</
A>
132N/A<
li><
A HREF="#serveralias">ServerAlias</
A>
132N/A<
li><
A HREF="#servername">ServerName</
A>
132N/A<
li><
A HREF="#serverpath">ServerPath</
A>
132N/A<
li><
A HREF="#serverroot">ServerRoot</
A>
132N/A<
li><
A HREF="#servertype">ServerType</
A>
132N/A<
li><
A HREF="#startservers">StartServers</
A>
132N/A<
li><
A HREF="#timeout">TimeOut</
A>
132N/A<
li><
A HREF="#user">User</
A>
132N/A<
li><
A HREF="#virtualhost"><VirtualHost></
A>
132N/A<
h2><
A name="accessconfig">AccessConfig directive</
A></
h2>
132N/A<!--%plaintext <?INDEX {\tt AccessConfig} directive> --> 132N/A<
strong>Syntax:</
strong> AccessConfig <
em>filename</
em><
br>
132N/A<
strong>Context:</
strong> server config, virtual host<
br>
132N/A<
strong>Status:</
strong> core<
p>
132N/AThe server will read this file for more directives after reading the
132N/A<
A HREF="#resourceconfig">ResourceConfig</
A> file. <
em>Filename</
em> is
132N/Arelative to the <
A HREF="#serverroot">ServerRoot</
A>.
132N/AThis feature can be disabled using:
132N/A<
blockquote><
code>AccessConfig /
dev/
null</
code></
blockquote>
219N/AHistorically, this file only contained
979N/A<
A HREF="#directory"><Directory></
A> sections; in fact it can now
220N/Acontain any server directive allowed in the <
em>server config</
em> context.
379N/A<
h2><
A name="accessfilename">AccessFileName directive</
A></
h2>
411N/A<!--%plaintext <?INDEX {\tt AccessFileName} directive> --> 487N/A<
strong>Syntax:</
strong> AccessFileName <
em>filename</
em><
br>
706N/A<
strong>Default:</
strong> <
code>AccessFileName .htaccess</
code><
br>
706N/A<
strong>Context:</
strong> server config, virtual host<
br>
706N/A<
strong>Status:</
strong> core<
p>
741N/AWhen returning a document to the client the server looks for an
706N/Aaccess control file with this name in every directory of the path to
706N/Athe document, if access control files are enabled for that directory.
704N/A<
blockquote><
code>AccessFileName .acl</
code></
blockquote>
704N/Afor directives, unless they have been disabled with
320N/A</Directory></
code></
blockquote><
p><
hr>
336N/A<
h2><
A name="addmodule">AddModule directive</
A></
h2>
336N/A<!--%plaintext <?INDEX {\tt AddModule} directive> --> 949N/A<
strong>Syntax:</
strong> AddModule <
em>module module ...</
em><
br>
949N/A<
strong>Context:</
strong> server config <
br>
336N/A<
strong>Status:</
strong> core<
br>
336N/A<
strong>Compatibility:</
strong> AddModule is only available in Apache 1.2 and later<
p>
341N/AThe server can have modules compiled in which are not actively in use.
487N/AThis directive can be used to enable the use of those modules. The
336N/Aserver comes with a pre-loaded list of active modules; this list can
336N/Abe cleared with the <
A HREF="#clearmodulelist">ClearModuleList</
A>
379N/A<
h2><
A name="allowoverride">AllowOverride directive</
A></
h2>
487N/A<!--%plaintext <?INDEX {\tt AllowOverride} directive> --> 379N/A<
strong>Syntax:</
strong> AllowOverride <
em>override override ...</
em><
br>
379N/A<
strong>Default:</
strong> <
code>AllowOverride All</
code><
br>
411N/A<
strong>Context:</
strong> directory<
br>
411N/A<
strong>Status:</
strong> core<
p>
411N/AWhen the server finds an .htaccess file (as specified by
411N/A<
A HREF="#accessfilename">AccessFileName</
A>) it needs to know which
411N/Adirectives declared in that file can override earlier access information.<
p>
336N/A<
em>Override</
em> can be set to <
code>None</
code>, in which case the server
320N/Awill not read the file, <
code>All</
code> in which case the server will
336N/Aallow all the directives, or one or more of the following:
949N/A<!--%plaintext <?INDEX {\tt AuthConfig} override> --> 949N/AAllow use of the authorization directives
949N/A<
A HREF="#authname">AuthName</
A>, <
A HREF="#authtype">AuthType</
A>,
949N/A<
A HREF="#require">require</
A>, etc.).
949N/A<!--%plaintext <?INDEX {\tt FileInfo} override> --> 949N/AAllow use of the directives controlling document types
949N/A<
A HREF="#defaulttype">DefaultType</
A>,
949N/A<
A HREF="#errordocument">ErrorDocument</
A>,
949N/A<!--%plaintext <?INDEX {\tt Indexes} override> --> 949N/AAllow use of the directives controlling directory indexing
230N/A<!--%plaintext <?INDEX {\tt Limit} override> --> 230N/AAllow use of the directives controlling host access (allow, deny and order).
230N/A<!--%plaintext <?INDEX {\tt Options} override> --> 230N/AAllow use of the directives controlling specific directory features
230N/A(<
A HREF="#options">Options</
A> and
989N/A<
h2><
A name="authname">AuthName directive</
A></
h2>
989N/A<!--%plaintext <?INDEX {\tt AuthName} directive> --> 989N/A<
strong>Syntax:</
strong> AuthName <
em>auth-domain</
em><
br>
989N/A<
strong>Context:</
strong> directory, .htaccess<
br>
989N/A<
strong>Override:</
strong> AuthConfig<
br>
989N/A<
strong>Status:</
strong> core<
p>
989N/AThis directive sets the name of the authorization realm for a directory.
989N/AThis realm is given to the client so that the user knows which username and
989N/AIt must be accompanied by <
A HREF="#authtype">AuthType</
A> and
989N/A<
A HREF="#require">require</
A> directives, and directives such as
989N/A<
h2><
A name="authtype">AuthType directive</
A></
h2>
989N/A<!--%plaintext <?INDEX {\tt AuthType} directive> --> 989N/A<
strong>Syntax:</
strong> AuthType <
em>type</
em><
br>
989N/A<
strong>Context:</
strong> directory, .htaccess<
br>
989N/A<
strong>Override:</
strong> AuthConfig<
br>
989N/A<
strong>Status:</
strong> core<
p>
230N/AThis directive selects the type of user authentication for a directory.
230N/AOnly <
code>Basic</
code> is currently implemented.
230N/A<!--%plaintext <?INDEX {\tt Basic} authentication scheme> --> 230N/AIt must be accompanied by <
A HREF="#authname">AuthName</
A> and
230N/A<
A HREF="#require">require</
A> directives, and directives such as
132N/A<
h2><
A name="bindaddress">BindAddress directive</
A></
h2>
132N/A<!--%plaintext <?INDEX {\tt BindAddress} directive> --> 949N/A<
strong>Syntax:</
strong> BindAddress <
em>saddr</
em><
br>
213N/A<
strong>Default:</
strong> <
code>BindAddress *</
code><
br>
301N/A<
strong>Context:</
strong> server config<
br>
741N/A<
strong>Status:</
strong> core<
p>
132N/AA Unix® http server can either listen for connections to every
211N/AIP address of the server machine, or just one IP address of the server
213N/Amachine. <
em>Saddr</
em> can be
213N/A<
li>A fully-qualified Internet domain name
213N/AIf the value is *, then the server will listen for connections on
487N/Aevery IP address, otherwise it will only listen on the IP address
213N/AThis option can be used as an alternative method for supporting
213N/A<
A HREF="#virtualhost"><VirtualHost></
A> sections.
213N/A<
p><
strong>See Also:</
strong>
213N/A<
strong>See Also:</
strong>
213N/A<
a href="/bind.html">Setting which addresses and ports Apache uses</
a></
p>
213N/A<
h2><
A name="clearmodulelist">ClearModuleList directive</
A></
h2>
213N/A<!--%plaintext <?INDEX {\tt ClearModuleList} directive> --> 213N/A<
strong>Syntax:</
strong> ClearModuleList<
br>
213N/A<
strong>Context:</
strong> server config<
br>
213N/A<
strong>Status:</
strong> core<
br>
781N/A<
strong>Compatibility:</
strong> ClearModuleList is only available in Apache 1.2 and later<
p>
213N/AThe server comes with a built-in list of active modules. This
213N/Adirective clears the list. It is assumed that the list will then be
213N/Are-populated using the <
A HREF="#addmodule">AddModule</
A> directive.<
p><
hr>
213N/A<
h2><
A name="defaulttype">DefaultType directive</
A></
h2>
213N/A<!--%plaintext <?INDEX {\tt DefaultType} directive> --> 211N/A<
strong>Syntax:</
strong> DefaultType <
em>mime-type</
em><
br>
211N/A<
strong>Default:</
strong> <
code>DefaultType
text/
html</
code><
br>
211N/A<
strong>Context:</
strong> server config, virtual host, directory, .htaccess<
br>
211N/A<
strong>Override:</
strong> FileInfo<
br>
211N/A<
strong>Status:</
strong> core<
p>
246N/AThere will be times when the server is asked to provide a document
246N/Awhose type cannot be determined by its MIME types mappings.<
p>
213N/AThe server must inform the client of the content-type of the document, so in
211N/Athe event of an unknown type it uses the <
CODE>DefaultType</
CODE>. For
211N/Awould be appropriate for a directory which contained many gif images
949N/Awith filenames missing the .gif extension.<
p><
hr>
144N/A<
h2><
A name="directory"><Directory> directive</
A></
h2>
453N/A<!--%plaintext <?INDEX {\tt Directory} section directive> --> 144N/A<
strong>Syntax:</
strong> <Directory <
em>directory</
em>> ... </Directory> <
br>
260N/A<
strong>Context:</
strong> server config, virtual host<
br>
260N/A<
strong>Status:</
strong> Core. <
p>
260N/A<Directory> and </Directory> are used to enclose a group of
260N/Adirectives which will apply only to the named directory and sub-directories
260N/Aof that directory. Any directive which is allowed in a directory
260N/Acontext may be used. <
em>Directory</
em> is either the full path to a directory,
260N/Aor a wild-card string. In a wild-card string, `?' matches any single character,
144N/Aand `*' matches any sequences of characters. Example:
882N/A Options Indexes FollowSymLinks
219N/A<
p><
strong>Apache 1.2 and above:</
strong>
219N/AExtended regular expressions can also be used, with the addition of the
219N/A<
code>~</
code> character. For example:</
p>
220N/A <Directory ~ "^/www/.*/[0-9]{3}">
220N/Awould match directories in /www/ that consisted of three numbers.<
p>
220N/A<
p>If multiple directory sections match the directory (or its parents) containing
979N/Aa document, then the directives are applied in the order of shortest match
949N/Afirst, interspersed with the directives from the
949N/A<
A HREF="#accessfilename">.htaccess</
A> files. For example, with
220N/A</Directory><
br><
br>
979N/A<Directory /home/*><
br>
979N/AAllowOverride FileInfo<
br>
979N/A</Directory></
code></
blockquote>
979N/A<
li>Apply directive <
code>AllowOverride None</
code> (disabling
220N/A<
code>.htaccess</
code> files).
220N/A<
li>Apply directive <
code>AllowOverride FileInfo</
code> (for directory
220N/ANote that the default Apache access for <Directory /> is
220N/A<
SAMP>Allow from All</
SAMP>. This means that Apache will serve any file
220N/Amapped from an URL. It is recommended that you change this with a block
221N/Aand then override this for directories you <
EM>want</
EM> accessible.
336N/Amay appear in any configuration file. <Directory> directives cannot
341N/Anest, and cannot appear in a <
A HREF="#limit"><Limit></
A> section.
879N/A<
h2><
A NAME="documentroot">DocumentRoot directive</
A></
h2>
336N/A<!--%plaintext <?INDEX {\tt DocumentRoot} directive> --> 341N/A<
strong>Syntax:</
strong> DocumentRoot <
em>directory-filename</
em><
br>
341N/A<
strong>Default:</
strong> <
code>DocumentRoot
336N/A<
strong>Context:</
strong> server config, virtual host<
br>
295N/A<
strong>Status:</
strong> core<
p>
295N/AThis directive sets the directory from which httpd will serve files.
295N/AUnless matched by a directive like Alias, the server appends the path
295N/Afrom the requested URL to the document root to make the path to the
295N/A<
blockquote><
code>DocumentRoot /
usr/
web</
code></
blockquote>
295N/A<
P>There appears to be a bug in mod_dir which causes problems when the
339N/A<
h2><
A name="errordocument">ErrorDocument directive</
A></
h2>
339N/A<!--%plaintext <?INDEX {\tt ErrorDocument} directive> --> 339N/A<
strong>Syntax:</
strong> ErrorDocument <
em>error-code document</
em><
br>
341N/A<
strong>Context</
strong> server config, virtual host, directory, .htaccess<
br>
339N/A<
strong>Status:</
strong> core<
br>
339N/A<
strong>Override:</
strong> FileInfo<
br>
339N/A<
strong>Compatibility:</
strong> The directory and .htaccess contexts
339N/Aare only available in Apache 1.1 and later.<
p>
339N/AIn the event of a problem or error, Apache can be configured to do
379N/A<
LI>output a simple hardcoded error message
379N/A<
LI>output a customized message
411N/A<
P>The first option is the default, while options 2-4 are configured
379N/Ausing the <
CODE>ErrorDocument</
CODE> directive, which is followed by
379N/Athe HTTP response code and a message or URL.
386N/A<
P><
em>Messages</
em> in this context begin with a single quote
379N/A(<
code>"</
code>), which does not form part of the message itself.
379N/AApache will sometimes offer additional information regarding the
379N/A<
P>URLs can begin with a slash (/) for local URLs, or be a full
411N/AURL which the client can resolve. Examples:
411N/AErrorDocument 403 "Sorry can't allow you access today
411N/A<
P>Note that when you specify an <
CODE>ErrorDocument</
CODE> that
411N/Apoints to a remote URL (ie. anything with a method such as "http" in
411N/Afront of it) Apache will send a redirect to the client to tell it
411N/Awhere to find the document, even if the document ends up being
411N/Aon the same server.. This has several implications, the
411N/Amost important being that <
STRONG>if you use an "ErrorDocument 401"
411N/Adirective then it must refer to a local document.</
STRONG> This results
411N/Afrom the nature of the HTTP basic authentication scheme.
411N/A<
h2><
A name="errorlog">ErrorLog directive</
A></
h2>
463N/A<!--%plaintext <?INDEX {\tt ErrorLog} directive> --> 411N/A<
strong>Syntax:</
strong> ErrorLog <
em>filename</
em><
br>
336N/A<
strong>Context:</
strong> server config, virtual host<
br>
381N/A<
strong>Status:</
strong> core<
p>
336N/AThe error log directive sets the name of the file to which the server will log
336N/Aany errors it encounters. If the filename does not begin with a slash (/)
336N/Athen it is assumed to be relative to the <
A HREF="#serverroot">ServerRoot</
A>.
336N/AThis effectively turns off error logging.<
p>
336N/Adocument for details on why your security could be compromised if
336N/Athe directory where logfiles are stored is writable by anyone other
301N/Athan the user that starts the server.
301N/A<
h2><
A name="files"><Files> directive</
A></
h2>
301N/A<
strong>Syntax:</
strong> <Files <
em>filename</
em>>
301N/A<
strong>Context:</
strong> server config, virtual host, htaccess<
br>
301N/A<
strong>Status:</
strong> core<
br>
301N/A<
strong>Compatibility:</
strong> only available in Apache
301N/A<
p>The <Files> directive provides for access control by
301N/Afilename. It is comparable to the <
a 301N/Ahref="#directory"><Directory></
a> directive and
301N/A<
a href="#location"><Location></
a> directives. It
301N/Ashould be matched with a </Files> directive. Directives that
448N/Aapply to the filename given should be listed
446N/Awithin. <
code><Files></
code> sections are processed in the
448N/Aorder they appear in the configuration file, after the
500N/A<Directory> sections and <
code>.htaccess</
code> files are
736N/Aread, but before <Location> sections.</
p>
706N/A<
p>The <
em>filename</
em> argument should include a filename, or a
807N/Awild-card string, where `?' matches any single character, and `*' matches any
706N/Asequences of characters. Extended regular expressions can also be used,
706N/Athe <
code>~</
code> character. For example:</
p>
706N/A <Files ~ "\.(gif|jpe?g|png)$">
706N/Awould match most common Internet graphics formats.
455N/Ahref="#directory"><
code><Directory></
code></
a> and <
a 706N/Ahref="#location"><
code><Location></
code></
a> sections,
455N/A<
code><Files></
code> sections can be used inside .htaccess
480N/Afiles. This allows users to control access to their own files, at a
480N/Afile-by-file level. When used in an .htaccess file, if the
741N/A<
em>filename</
em> does not begin with a <
code>/</
code> character,
741N/Athe directory being applied will be prefixed automatically.
706N/A<
h2><
A name="group">Group directive</
A></
h2>
500N/A<!--%plaintext <?INDEX {\tt Group} directive> --> 500N/A<
strong>Syntax:</
strong> Group <
em>unix-group</
em><
br>
706N/A<
strong>Default:</
strong> <
code>Group #-1</
code><
br>
500N/A<
strong>Context:</
strong> server config, virtual host<
br>
500N/A<
strong>Status:</
strong> core<
p>
725N/AThe Group directive sets the group under which the server will answer requests.
725N/AIn order to use this directive, the stand-alone server must be run initially
725N/Aas root. <
em>Unix-group</
em> is one of:
725N/A<
dd>Refers to the given group by name.
725N/A<
dt># followed by a group number.
706N/A<
dd>Refers to a group by its number.
725N/AIt is recommended that you set up a new group specifically for running the
500N/Aserver. Some admins use user <
code>nobody</
code>, but this is not always
500N/Apossible or desirable.<
p>
706N/ANote: if you start the server as a non-root user, it will fail to change
500N/Ato the specified group, and will instead continue to run as the group of the
500N/ASpecial note: Use of this directive in <VirtualHost> requires a
301N/AWhen used inside a <VirtualHost> in this manner, only the group
736N/Athat CGIs are run as is affected. Non-CGI requests are still processed
736N/Aas the group specified in the main Group directive.<
p>
736N/ASECURITY: See <
A HREF="#user">User</
A> for a discussion of the security
736N/A<
h2><
A name="hostnamelookups">HostNameLookups directive</
A></
h2>
736N/A<!--%plaintext <?INDEX {\tt HostNameLookups} directive> --> 736N/A<
strong>Syntax:</
strong> HostNameLookups <
em>boolean</
em><
br>
736N/A<
strong>Default:</
strong> <
code>HostNameLookups on</
code><
br>
736N/A<
strong>Context:</
strong> server config, virtual host<
br>
736N/A<
strong>Status:</
strong> core<
p>
736N/AThis directive enables DNS lookups so that host names can be logged.
736N/AHaving this directive set <
code>on</
code> also enables the use of names
736N/Ain <Limit> blocks for access control.<
p>
736N/AHeavily loaded sites should set this directive <
code>off</
code>, since DNS
736N/Alookups can take considerable amounts of time. The utility <
i>logresolve</
i>,
736N/Aprovided in the <
i>/support</
i> directory, can be used to look up host names
741N/Afrom logged IP addresses offline.<
p><
hr>
737N/A<
h2><
A name="identitycheck">IdentityCheck directive</
A></
h2>
737N/A<!--%plaintext <?INDEX {\tt IdentityCheck} directive> --> 737N/A<
strong>Syntax:</
strong> IdentityCheck <
em>boolean</
em><
br>
736N/A<
strong>Default:</
strong> <
code>IdentityCheck off</
code><
br>
739N/A<
strong>Context:</
strong> server config, virtual host<
br>
736N/A<
strong>Status:</
strong> core<
p>
336N/AThis directive enables RFC1413-compliant logging of the remote user name
301N/Afor each connection, where the client machine runs identd or something similar.
301N/AThis information is logged in the access log. <
em>Boolean</
em> is either
501N/A<
code>on</
code> or <
code>off</
code>.<
p>
301N/AThe information should not be trusted in any way except for rudimentary usage
301N/ANote that this can cause serious latency problems accessing your server
301N/Asince every request requires one of these lookups to be performed. When
301N/Afirewalls are involved each lookup might possibly fail and add 30 seconds
301N/Aof latency to each hit. So in general this is not very useful on public
301N/Aservers accessible from the Internet.
624N/A<
H2><
A NAME="ifmodule"><IfModule> directive</
A></
H2>
624N/A<
b>Syntax:</
b> <IfModule [!]<
i>module-name</
i>> <
i>...</
i>
624N/A<
b>Default:</
b> None<
br>
624N/A<
strong>Compatibility:</
strong> ScriptLog is only available in 1.2 and
624N/AThe <IfModule <
i>test</
i>>...</IfModule>
624N/Asection is used to mark directives that are conditional. The
624N/Adirectives within an IfModule section are only
624N/Aprocessed if the <
i>test</
i> is true. If <
i>test</
i>
624N/Ais false, everything between the start and end markers
624N/AThe <
i>test</
i> in the <IfModule> section directive
624N/Acan be one of two forms:
801N/A<
p>In the former case, the directives between the start and end markers
801N/Aare only processed if the module named <
i>module name</
i> is compiled
801N/Ain to Apache. The second format reverses the test, and only processes
801N/Athe directives if <
i>module name</
i> is <
b>not</
b> compiled in.
801N/A<
p>The <
i>module name</
i> argument is a module name as given as the file
132N/Aname of the module, at the time it was compiled. For example,
<
p><IfModule> sections are nest-able, which can be used to implement
simple multiple-module tests.
<
h2><
a name="keepalive">KeepAlive directive</
a></
h2>
<
strong>Syntax: (Apache 1.1)</
strong> KeepAlive <
em>max-requests</
em><
br>
<
strong>Default: (Apache 1.1)</
strong> <
code>KeepAlive 5</
code><
br>
<
strong>Syntax: (Apache 1.2)</
strong> KeepAlive <
em>
on/
off</
em><
br>
<
strong>Default: (Apache 1.2)</
strong> <
code>KeepAlive On</
code><
br>
<
strong>Context:</
strong> server config<
br>
<
strong>Status:</
strong> Core<
br>
<
strong>Compatibility:</
strong> KeepAlive is only available in Apache
<
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 <
ahref="#maxkeepaliverequests">MaxKeepAliveRequests</
a> directive.</
p>
<
h2><
a name="keepalivetimeout">KeepAliveTimeout directive</
a></
h2>
<
strong>Syntax:</
strong> KeepAliveTimeout <
em>seconds</
em><
br>
<
strong>Default:</
strong> <
code>KeepAliveTimeout 15</
code><
br>
<
strong>Context:</
strong> server config<
br>
<
strong>Status:</
strong> Core<
br>
<
strong>Compatibility:</
strong> KeepAliveTimeout is only available in Apache
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 <
ahref="#timeout"><
code>Timeout</
code></
a> directive
<
h2><
A name="listen">Listen directive</
A></
h2>
Listen [<
em>IP address</
em>:]<
em>port number</
em><
br>
<
strong>Context:</
strong> server config<
br>
<
strong>Status:</
strong> core<
br>
<
strong>Compatibility:</
strong> Listen is only available in Apache
<
p>The Listen directive instructs Apache to listen to more than one IP
address or port; by default it responds to requests on all IP
interfaces, but only on the port given by the <
a href="#port">Port</
a>
<
p><
strong>See Also:</
strong>
<
strong>See Also:</
strong>
<
a href="/bind.html">Setting which addresses and ports Apache uses</
a><
br>
<
strong>See Also:</
strong>
<
H2><
A NAME="listenbacklog">ListenBacklog directive</
A></
H2>
<
strong>Syntax:</
strong> ListenBacklog <
em>backlog</
em><
br>
<
strong>Default:</
strong> <
code>ListenBacklog 511</
code><
br>
<
strong>Context:</
strong> server config<
br>
<
strong>Status:</
strong> Core<
br>
<
strong>Compatibility:</
strong> ListenBacklog is only available in Apache
The maximum length of the queue of pending connections. Generally no
tuning is needed or desired, however on some systems it is desirable
to increase this when under a TCP SYN flood attack. See
the backlog parameter to the <
code>listen(2)</
code> system call.
<
h2><
A name="limit"><Limit> directive</
A></
h2>
<!--%plaintext <?INDEX {\tt Limit} section directive> --> <Limit <
em>method method</
em> ... > ... </Limit><
br>
<
strong>Context:</
strong> any<
br>
<
strong>Status:</
strong> core<
p>
<Limit> and </Limit> 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 <Limit> or
<
A HREF="#directory"><Directory></
A> may be used; the majority will be
unaffected by the <Limit>. Example:
<Limit GET POST><
br>
</Limit></
code></
blockquote>
If an access control directive appears outside a <Limit> directive,
then it applies to all access methods.<
p><
hr>
<
h2><
a name="location"><Location> directive</
a></
h2>
<
strong>Syntax:</
strong> <Location <
em>URL</
em>>
... </Location><
br>
<
strong>Context:</
strong> server config, virtual host<
br>
<
strong>Status:</
strong> core<
br>
<
strong>Compatibility:</
strong> Location is only available in Apache
<
p>The <Location> directive provides for access control by
URL. It is comparable to the <
ahref="#directory"><Directory></
a> directive, and
should be matched with a </Location> directive. Directives that
apply to the URL given should be listed
within. <
code><Location></
code> sections are processed in the
order they appear in the configuration file, after the
<Directory> sections and <
code>.htaccess</
code> files are
<
p>Note that, due to the way HTTP functions, <
em>URL prefix</
em>
should, save for proxy requests, be of the form <
code>/path/</
code>,
necessarily have to protect a directory (it can be an individual
file, or a number of files), and can include wild-cards. In a wild-card
string, `?' matches any single character, and `*' matches any
<
p><
strong>Apache 1.2 and above:</
strong>
Extended regular expressions can also be used, with the addition of
<
code>~</
code> character. For example:</
p>
<Location ~ "/(extra|special)/data">
<
p>would match URLs that contained the substring "/
extra/
data" or
<
p>The <
code>Location</
code> functionality is especially useful when
combined with the <
code><
ahref="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:
<
H2><
A NAME="lockfile">LockFile directive</
A></
H2>
<
strong>Syntax:</
strong> LockFile <
em>filename</
em><
BR>
<
strong>Context:</
strong> server config<
BR>
<
strong>Status:</
strong> core<
P>
The LockFile directive sets the path to the lockfile used when
Apache is compiled with either USE_FCNTL_SERIALIZED_ACCEPT or
USE_FLOCK_SERIALIZED_ACCEPT. This directive should normally be
left at its default value. The main reason for changing it is if
the <
code>logs</
code> directory is NFS mounted, since the lockfile
should be stored on a local disk if possible. The PID of the main
server process is automatically appended to the filename.
<
h2><
A name="maxclients">MaxClients directive</
A></
h2>
<!--%plaintext <?INDEX {\tt MaxClients} directive> --> <
strong>Syntax:</
strong> MaxClients <
em>number</
em><
br>
<
strong>Default:</
strong> <
code>MaxClients 256</
code><
br>
<
strong>Context:</
strong> server config<
br>
<
strong>Status:</
strong> core<
p>
The MaxClients directive sets the limit on the number of simultaneous
requests that can be supported; not more than this number of child server
processes will be created.<
p><
hr>
<
h2><
A name="maxkeepaliverequests">MaxKeepAliveRequests directive</
A></
h2>
<
strong>Syntax:</
strong> MaxKeepAliveRequests <
em>number</
em><
br>
<
strong>Default:</
strong> <
code>MaxKeepAliveRequests 100</
code><
br>
<
strong>Context:</
strong> server config<
br>
<
strong>Status:</
strong> core<
br>
<
strong>Compatibility:</
strong> Only available in Apache
<
p>The MaxKeepAliveRequests directive limits the number of requests
allowed per connection when <
a href="#keepalive">KeepAlive</
a> is
on. If it is set to "<
code>0</
code>", unlimited requests will be
allowed. We recommend that this setting be kept to a high value for
maximum server performance.
<
h2><
A name="maxrequestsperchild">MaxRequestsPerChild directive</
A></
h2>
<!--%plaintext <?INDEX {\tt MaxRequestsPerChild} directive> --> <
strong>Syntax:</
strong> MaxRequestsPerChild <
em>number</
em><
br>
<
strong>Default:</
strong> <
code>MaxRequestsPerChild 0</
code><
br>
<
strong>Context:</
strong> server config<
br>
<
strong>Status:</
strong> core<
p>
The MaxRequestsPerChild directive sets the limit on the number of requests
that an individual child server process will handle. After MaxRequestsPerChild
requests, the child process will die. If MaxRequestsPerChild is 0, then
the process will never expire.<
p>
Setting MaxRequestsPerChild to a non-zero limit has two beneficial effects:
<
li>it limits the amount of memory that process can consume by (accidental)
<
li> by giving processes a finite lifetime, it helps reduce the
number of processes when the server load reduces.
<
h2><
A name="maxspareservers">MaxSpareServers directive</
A></
h2>
<!--%plaintext <?INDEX {\tt MaxSpareServers} directive> --> <
strong>Syntax:</
strong> MaxSpareServers <
em>number</
em><
br>
<
strong>Default:</
strong> <
code>MaxSpareServers 10</
code><
br>
<
strong>Context:</
strong> server config<
br>
<
strong>Status:</
strong> core<
p>
The MaxSpareServers directive sets the desired maximum number of <
em>idle</
em>
child server processes. An idle process is one which is not handling
a request. If there are more than MaxSpareServers idle, then the parent
process will kill off the excess processes.<
p>
Tuning of this parameter should only be necessary on very busy sites.
Setting this parameter to a large number is almost always a bad idea.<
p>
See also <
A HREF="#minspareservers">MinSpareServers</
A> and
<
A HREF="#startservers">StartServers</
A>.<
p><
hr>
<
h2><
A name="minspareservers">MinSpareServers directive</
A></
h2>
<!--%plaintext <?INDEX {\tt MinSpareServers} directive> --> <
strong>Syntax:</
strong> MinSpareServers <
em>number</
em><
br>
<
strong>Default:</
strong> <
code>MinSpareServers 5</
code><
br>
<
strong>Context:</
strong> server config<
br>
<
strong>Status:</
strong> core<
p>
The MinSpareServers directive sets the desired minimum number of <
em>idle</
em>
child server processes. An idle process is one which is not handling
a request. If there are fewer than MinSpareServers idle, then the parent
process creates new children at a maximum rate of 1 per second.<
p>
Tuning of this parameter should only be necessary on very busy sites.
Setting this parameter to a large number is almost always a bad idea.<
p>
See also <
A HREF="#maxspareservers">MaxSpareServers</
A> and
<
A HREF="#startservers">StartServers</
A>.<
p><
hr>
<
h2><
A name="options">Options directive</
A></
h2>
<!--%plaintext <?INDEX {\tt Options} directive> --> <
strong>Syntax:</
strong> Options <
em>[+|-]option [+|-]option ...</
em><
br>
<
strong>Context:</
strong> server config, virtual host, directory, .htaccess<
br>
<
strong>Override:</
strong> Options<
br>
<
strong>Status:</
strong> core<
p>
The Options directive controls which server features are available in
<
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:
<
dd>All options except for MultiViews.
<!--%plaintext <?INDEX {\tt ExecCGI} option> --> Execution of CGI scripts is permitted.
<!--%plaintext <?INDEX {\tt FollowSymLinks} option> --> The server will follow symbolic links in this directory.
<
b>Note</
b>: even though the server follows the symlink it does <
i>not</
i>
change the pathname used to match against <
code><Directory></
code>
<!--%plaintext <?INDEX {\tt Includes} option> --> Server-side includes are permitted.
<!--%plaintext <?INDEX {\tt IncludesNOEXEC} option> --> Server-side includes are permitted, but the #exec command and
#include of CGI scripts are disabled.
<!--%plaintext <?INDEX {\tt Indexes} option> --> If a URL which maps to a directory is requested, and the there is no
DirectoryIndex (
e.g. index.html) in that directory, then the server will
return a formatted listing of the directory.
<!--%plaintext <?INDEX {\tt MultiViews} option> --> <!--%plaintext <?INDEX {\tt SymLinksIfOwnerMatch} option> --> The server will only follow symbolic links for which the target
file or directory is owned by the same user id as the link.
Normally, if multiple <
code>Options</
code> could apply to a directory,
then the most specific one is taken complete; the options are not
merged. However if <
i>all</
i> the options on the <
code>Options</
code>
directive are preceded by a + or - symbol, the options are
merged. Any options preceded by a + are added to the options
currently in force, and any options preceded by a - are removed from
the options currently in force. <
P>
For example, without any + and - symbols:
Options Indexes FollowSymLinks<
br>
then only <
code>Includes</
code> will be set for the /
web/
docs/
specdirectory. However if the second <
code>Options</
code> directive uses the +
Options Indexes FollowSymLinks<
br>
Options +Includes -Indexes<
br>
then the options <
code>FollowSymLinks</
code> and <
code>Includes</
code>
<
h2><
A name="pidfile">PidFile directive</
A></
h2>
<!--%plaintext <?INDEX {\tt PidFile} directive> --> <
strong>Syntax:</
strong> PidFile <
em>filename</
em><
br>
<
strong>Default:</
strong> <
code>PidFile
logs/
httpd.pid</
code><
br>
<
strong>Context:</
strong> server config<
br>
<
strong>Status:</
strong> core<
p>
The PidFile directive sets the file to which the server records the
process id of the daemon. If the filename does not begin with a slash (/)
then it is assumed to be relative to the <
A HREF="#serverroot">ServerRoot</
A>.
The PidFile is only used in <
A HREF="#servertype">standalone</
A> mode.<
p>
It is often useful to be able to send the server a signal, so that it closes
and then reopens its <
A HREF="#errorlog">ErrorLog</
A> and TransferLog, and
re-reads its configuration files. This is done by sending a SIGHUP (kill -1)
signal to the process id listed in the PidFile.<
p>
The PidFile is subject to the same warnings about log file placement and
<
h2><
A name="port">Port directive</
A></
h2>
<!--%plaintext <?INDEX {\tt Port} directive> --> <
strong>Syntax:</
strong> Port <
em>number</
em><
br>
<
strong>Default:</
strong> <
code>Port 80</
code><
br>
<
strong>Context:</
strong> server config<
br>
<
strong>Status:</
strong> core<
p>
<
em>Number</
em> is a number from 0 to 65535; some port numbers (especially below
1024) are reserved for particular protocols. See <
code>/
etc/
services</
code>
for a list of some defined ports; the standard port for the http protocol
The Port directive has two behaviors, the first of which is necessary for
NCSA backwards compatibility (and which is confusing in the context of
In the absence of any <
a href="#listen">Listen</
a> or
<
a href="#bindaddress">BindAddress</
a> directives specifying a port number,
the Port directive sets the network port on which the server listens.
If there are any Listen or BindAddress directives specifying
<
code>:number</
code> then Port has no effect on what address the server
sets the <
code>SERVER_PORT</
code> environment variable (for
and is used when the server must generate a URL that refers to itself
(for example when creating an external redirect to itself).
In no event does a Port setting affect
what ports a <
a href="#virtualhost">VirtualHost</
a> responds on, the
VirtualHost directive itself is used for that.<
p>
The primary behaviour of Port should be considered to be similar to that of
the <
a href="#servername">ServerName</
a> directive. The ServerName
and Port together specify what you consider to be the <
i>canonical</
i>
address of the server.<
p>
Port 80 is one of Unix's special ports. All ports numbered
below 1024 are reserved for system use,
i.e. regular (non-root) users cannot
make use of them; instead they can only use higher port numbers.
To use port 80, you must start the server from the root account.
After binding to the port and before accepting requests, Apache will change
to a low privileged user as set by the <
A HREF="#user">User directive</
A>.<
p>
If you cannot use port 80, choose any other unused port. Non-root users
will have to choose a port number higher than 1023, such as 8000.<
p>
SECURITY: if you do start the server as root, be sure
not to set <
A HREF="#user">User</
A> to root. If you run the server as
root whilst handling connections, your site may be open to a major security
<
h2><
A name="require">require directive</
A></
h2>
<!--%plaintext <?INDEX {\tt require} directive> --> <
strong>Syntax:</
strong> require <
em>entity-name entity entity...</
em><
br>
<
strong>Context:</
strong> directory, .htaccess<
br>
<
strong>Override:</
strong> AuthConfig<
br>
<
strong>Status:</
strong> core<
p>
This directive selects which authenticated users can access a directory.
The allowed syntaxes are:
<
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.
If <
code>require</
code> appears in a <
A HREF="#limit"><Limit></
A>
section, then it restricts access to the named methods, otherwise
it restricts access for all methods. Example:
<Limit GET POST><
br>
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#authgroupfile">AuthGroupFile</
A> (to define users and
groups) in order to work correctly.<
p><
hr>
<
h2><
A name="resourceconfig">ResourceConfig directive</
A></
h2>
<!--%plaintext <?INDEX {\tt ResourceConfig} directive> --> <
strong>Syntax:</
strong> ResourceConfig <
em>filename</
em><
br>
<
strong>Default:</
strong> <
code>ResourceConfig
conf/
srm.conf</
code><
br>
<
strong>Context:</
strong> server config, virtual host<
br>
<
strong>Status:</
strong> core<
p>
The server will read this file for more directives after reading the
httpd.conf file. <
em>Filename</
em> is relative to the
<
A HREF="#serverroot">ServerRoot</
A>.
This feature can be disabled using:
<
blockquote><
code>ResourceConfig /
dev/
null</
code></
blockquote>
Historically, this file contained most directives except for server
configuration directives and <
A HREF="#directory"><Directory></
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 <?INDEX {\tt RLimitCPU} directive> --> <
strong>Syntax:</
strong> RLimitCPU <
em># or 'max'</
em> <
em>[# or 'max']</
em><
br>
<
strong>Default:</
strong> <
code>Unset uses operating system defaults</
code><
br>
<
strong>Context:</
strong> server config, virtual host<
br>
<
strong>Status:</
strong> core<
br>
<
strong>Compatibility:</
strong> RLimitCPU is only available in Apache 1.2 and later<
p>
Takes 1 or 2 parameters. The first parameter sets the soft resource limit for all
processes and the second parameter sets the maximum resource limit. Either parameter
can be a number, or <
em>max</
em> to indicate to the server that the limit should
be set to the maximum allowed by the operating system configuration. Raising the
maximum resource limit requires that the server is running as root, or in the initial
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 <?INDEX {\tt RLimitMEM} directive> --> <
strong>Syntax:</
strong> RLimitMEM <
em># or 'max'</
em> <
em>[# or 'max']</
em><
br>
<
strong>Default:</
strong> <
code>Unset uses operating system defaults</
code><
br>
<
strong>Context:</
strong> server config, virtual host<
br>
<
strong>Status:</
strong> core<
br>
<
strong>Compatibility:</
strong> RLimitMEM is only available in Apache 1.2 and later<
p>
Takes 1 or 2 parameters. The first parameter sets the soft resource limit for all
processes and the second parameter sets the maximum resource limit. Either parameter
can be a number, or <
em>max</
em> to indicate to the server that the limit should
be set to the maximum allowed by the operating system configuration. Raising the
maximum resource limit requires that the server is running as root, or in the initial
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 <?INDEX {\tt RLimitNPROC} directive> --> <
strong>Syntax:</
strong> RLimitNPROC <
em># or 'max'</
em> <
em>[# or 'max']</
em><
br>
<
strong>Default:</
strong> <
code>Unset uses operating system defaults</
code><
br>
<
strong>Context:</
strong> server config, virtual host<
br>
<
strong>Status:</
strong> core<
br>
<
strong>Compatibility:</
strong> RLimitNPROC is only available in Apache 1.2 and later<
p>
Takes 1 or 2 parameters. The first parameter sets the soft resource limit for all
processes and the second parameter sets the maximum resource limit. Either parameter
can be a number, or <
em>max</
em> to indicate to the server that the limit should
be set to the maximum allowed by the operating system configuration. Raising the
maximum resource limit requires that the server is running as root, or in the initial
Process limits control the number of processes per user.<
p>
Note: If CGI processes are <
b>not</
b> running under userids other than the
web server userid, this directive will limit the number of processes that the
server itself can create. Evidence of this situation will be indicated by
<
b><
em>cannot fork</
em></
b> messages in the error_log.<
p>
See also <
A HREF="#rlimitmem">RLimitMEM</
A> or <
A HREF="#rlimitcpu">RLimitCPU</
A>.
<
h2><
A name="satisfy">Satisfy directive</
A></
h2>
<!--%plaintext <?INDEX {\tt Satisfy} directive> --> <
strong>Syntax:</
strong> Satisfy <
em>'any' or 'all'</
em><
br>
<
strong>Default:</
strong> Satisfy all<
br>
<
strong>Context:</
strong> directory, .htaccess<
br>
<
strong>Status:</
strong> core<
br>
<
strong>Compatibility:</
strong> Satisfy is only available in Apache 1.2 and later<
p>
Access policy if both allow and require used. The parameter can be
either <
em>'all'</
em> or <
em>'any'</
em>. This directive is only useful
if access to a particular area is being restricted by both
default behavior ("all") is to require that the client passes the
address access restriction <
i>and</
i> enters a valid username and
password. With the "any" option the client will be granted access if
they either pass the host restriction or enter a valid username and
password. This can be used to password restrict an area, but to let
clients from particular addresses in without prompting for a password.
<
h2><
A name="scoreboardfile">ScoreBoardFile directive</
A></
h2>
<!--%plaintext <?INDEX {\tt ScoreBoardFile} directive> --> <
strong>Syntax:</
strong> ScoreBoardFile <
em>filename</
em><
br>
<
strong>Context:</
strong> server config<
br>
<
strong>Status:</
strong> core<
p>
The ScoreBoardFile directive is required on some architectures to place
a file that the server will use to communicate between its children and
the parent. The easiest way to find out if your architecture requires
a scoreboard file is to run Apache and see if it creates the file named
by the directive. If your architecture requires it then you must ensure
that this file is not used at the same time by more than one invocation
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
Linux
1.x users might be able to add <
code>-DHAVE_SHMGET</
code> to
the <
code>EXTRA_CFLAGS</
code> in your <
code>Configuration</
code>. This
might work with some
1.x installations, but won't work with all of
SVR4 users should consider adding <
code>-DHAVE_SHMGET</
code> to the
<
code>EXTRA_CFLAGS</
code> in your <
code>Configuration</
code>. This
is believed to work, but we were unable to test it in time for 1.2
<
strong>See Also</
strong>:
<
h2><
A name="sendbuffersize">SendBufferSize directive</
A></
h2>
<!--%plaintext <?INDEX {\tt SendBufferSize} directive> --> <
strong>Syntax:</
strong> SendBufferSize <
em>bytes</
em><
br>
<
strong>Context:</
strong> server config<
br>
<
strong>Status:</
strong> core<
p>
The server will set the TCP buffer size to the number of bytes
specified. Very useful to increase past standard OS defaults on high
speed high latency (
i.e. 100ms or so, such as transcontinental
<
h2><
A name="serveradmin">ServerAdmin directive</
A></
h2>
<!--%plaintext <?INDEX {\tt ServerAdmin} directive> --> <
strong>Syntax:</
strong> ServerAdmin <
em>email-address</
em><
br>
<
strong>Context:</
strong> server config, virtual host<
br>
<
strong>Status:</
strong> core<
p>
The ServerAdmin sets the e-mail address that the server includes in any
error messages it returns to the client.<
p>
It may be worth setting up a dedicated address for this,
e.g.<
blockquote><
code>ServerAdmin www-admin@foo.bar.com</
code></
blockquote>
as users do not always mention that they are talking about the server!<
p><
hr>
<
h2><
A name="serveralias">ServerAlias directive</
A></
h2>
<
strong>Syntax:</
strong> ServerAlias <
em>host1 host2 ...</
em><
br>
<
strong>Context:</
strong> virtual host<
br>
<
strong>Status:</
strong> core<
br>
<
strong>Compatibility:</
strong> ServerAlias is only available in Apache
The ServerAlias directive sets the alternate names for a host, for use
<
a href="/host.html">Host-header based virtual hosts</
a>.
<
p><
strong>See Also</
strong>:
<
h2><
A name="servername">ServerName directive</
A></
h2>
<!--%plaintext <?INDEX {\tt ServerName} directive> --> <
strong>Syntax:</
strong> ServerName <
em>fully-qualified domain name</
em><
br>
<
strong>Context:</
strong> server config, virtual host<
br>
<
strong>Status:</
strong> core<
p>
The ServerName directive sets the hostname of the server; this is only
used when creating redirection URLs. If it is not specified, then the
server attempts to deduce it from its own IP address; however this may
not work reliably, or may not return the preferred hostname. For example:
would be used if the canonical (main) name of the actual machine
<
p><
strong>See Also</
strong>:
<
h2><
A name="serverpath">ServerPath directive</
A></
h2>
<
strong>Syntax:</
strong> ServerPath <
em>pathname</
em><
br>
<
strong>Context:</
strong> virtual host<
br>
<
strong>Status:</
strong> core<
br>
<
strong>Compatibility:</
strong> ServerPath is only available in Apache
The ServerPath directive sets the legacy URL pathname for a host, for
use with <
a href="/host.html">Host-header based virtual hosts</
a>.
<
p><
strong>See Also</
strong>:
<
h2><
A name="serverroot">ServerRoot directive</
A></
h2>
<!--%plaintext <?INDEX {\tt ServerRoot} directive> --> <
strong>Syntax:</
strong> ServerRoot <
em>directory-filename</
em><
br>
<
strong>Context:</
strong> server config<
br>
<
strong>Status:</
strong> core<
p>
The ServerRoot directive sets the directory in which the server lives.
Typically it will contain the subdirectories <
code>conf/</
code> and
<
code>logs/</
code>. Relative paths for other configuration files are taken
as relative to this directory.<
br>
See also <
a href="/invoking.html">the <
code>-d</
code> option to httpd</
a>.<
p><
hr>
<
h2><
A name="servertype">ServerType directive</
A></
h2>
<!--%plaintext <?INDEX {\tt ServerType} directive> --> <
strong>Syntax:</
strong> ServerType <
em>type</
em><
br>
<
strong>Default:</
strong> <
code>ServerType standalone</
code><
br>
<
strong>Context:</
strong> server config<
br>
<
strong>Status:</
strong> core<
p>
The ServerType directive sets how the server is executed by the system.
<
dd>The server will be run from the system process inetd; the command to start
<
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
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.
Standalone is the most common setting for ServerType since
it is far more efficient. The server is started once, and services all
subsequent connections. If you intend running Apache to serve a busy site,
standalone will probably be your only option.<
p>
SECURITY: if you are paranoid about security, run in inetd mode. Security
cannot be guaranteed in either, but whilst most people are happy to use
standalone, inetd is probably least prone to attack.<
p><
hr>
<
h2><
A name="startservers">StartServers directive</
A></
h2>
<!--%plaintext <?INDEX {\tt StartServers} directive> --> <
strong>Syntax:</
strong> StartServers <
em>number</
em><
br>
<
strong>Default:</
strong> <
code>StartServers 5</
code><
br>
<
strong>Context:</
strong> server config<
br>
<
strong>Status:</
strong> core<
p>
The StartServers directive sets the number of child server processes created
on startup. As the number of processes is dynamically controlled depending
on the load, there is usually little reason to adjust this parameter.<
p>
See also <
A HREF="#minspareservers">MinSpareServers</
A> and
<
A HREF="#maxspareservers">MaxSpareServers</
A>.<
p><
hr>
<
h2><
A name="timeout">TimeOut directive</
A></
h2>
<!--%plaintext <?INDEX {\tt TimeOut} directive> --> <
strong>Syntax:</
strong> TimeOut <
em>number</
em><
br>
<
strong>Default:</
strong> <
code>TimeOut 300</
code><
br>
<
strong>Context:</
strong> server config<
br>
<
strong>Status:</
strong> core<
p>
The TimeOut directive currently defines the amount of time Apache will
<
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
<
LI>The amount of time between ACKs on transmissions of TCP packets
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
<
h2><
A name="user">User directive</
A></
h2>
<!--%plaintext <?INDEX {\tt User} directive> --> <
strong>Syntax:</
strong> User <
em>unix-userid</
em><
br>
<
strong>Default:</
strong> <
code>User #-1</
code><
br>
<
strong>Context:</
strong> server config, virtual host<
br>
<
strong>Status:</
strong> core<
p>
The User directive sets the userid as which the server will answer requests.
In order to use this directive, the standalone server must be run initially
as root. <
em>Unix-userid</
em> is one of:
<
dd>Refers to the given user by name.
<
dt># followed by a user number.
<
dd>Refers to a user by their number.
The user should have no privileges which result in it being able to access
files which are not intended to be visible to the outside world, and
similarly, the user should not be able to execute code which is not
meant for httpd requests. It is recommended that you set up a new user and
group specifically for running the server. Some admins use user
<
code>nobody</
code>, but this is not always possible or desirable.<
p>
Notes: If you start the server as a non-root user, it will fail to change
to the lesser privileged user, and will instead continue to run as
that original user. If you do start the server as root, then it is normal
for the parent process to remain running as root.<
p>
Special note: Use of this directive in <VirtualHost> requires a
properly configured <
A HREF="/suexec.html">suEXEC wrapper</
A>.
When used inside a <VirtualHost> 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
<
h2><
A name="virtualhost"><VirtualHost> directive</
A></
h2>
<!--%plaintext <?INDEX {\tt VirtualHost} section directive> --> <
strong>Syntax:</
strong> <VirtualHost <
em>addr</
em>[:<
em>port</
em>] ...> ...
</VirtualHost> <
br>
<
strong>Context:</
strong> server config<
br>
<
strong>Status:</
strong> Core.<
br>
<
strong>Compatibility:</
strong> Non-IP address-based Virtual Hosting only
available in Apache 1.1 and later.<
br>
<
strong>Compatibility:</
strong> Multiple address support only available in
<VirtualHost> and </VirtualHost> are used to enclose a group of
directives which will apply only to a particular virtual host.
Any directive which is allowed in a virtual host context may be used.
When the server receives a request for a document on a particular virtual
host, it uses the configuration directives enclosed in the <VirtualHost>
section. <
em>Addr</
em> can be
<
li>The IP address of the virtual host
<
li>A fully qualified domain name for the IP address of the virtual host.
<VirtualHost 10.1.2.3> <
br>
ServerAdmin webmaster@host.foo.com <
br>
Each VirtualHost must correspond to a different IP address or a
different host name for the server, in the latter case the server
machine must be configured to accept IP packets for multiple
addresses. (If the machine does not have multiple network interfaces,
then this can be accomplished with the <
code>ifconfig alias</
code>
command (if your OS supports it), or with kernel patches like <
AThe 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
document for details on why your security could be compromised if
the directory where logfiles are stored is writable by anyone other
than the user that starts the server.
<
p><
strong>See also:</
strong>
<
strong>See also:</
strong>
<
strong>See also:</
strong>
<
a href="/host.html">Non-IP address-based Virtual Hosts</
a><
br>
<
strong>See also:</
strong>