f90884915ff10ae83f59e709c68824de834e64f5Dominik Luecke<?xml version='1.0' encoding='UTF-8' ?>

f90884915ff10ae83f59e709c68824de834e64f5Dominik Luecke<!DOCTYPE manualpage SYSTEM "/style/manualpage.dtd">

f90884915ff10ae83f59e709c68824de834e64f5Dominik Luecke<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>

f90884915ff10ae83f59e709c68824de834e64f5Dominik Luecke

f90884915ff10ae83f59e709c68824de834e64f5Dominik Luecke

f90884915ff10ae83f59e709c68824de834e64f5Dominik Luecke<manualpage metafile="configuring.xml.meta">

f90884915ff10ae83f59e709c68824de834e64f5Dominik Luecke

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke <title>Configuration Files</title>

f90884915ff10ae83f59e709c68824de834e64f5Dominik Luecke

f90884915ff10ae83f59e709c68824de834e64f5Dominik Luecke<summary>

f90884915ff10ae83f59e709c68824de834e64f5Dominik Luecke<p>This document describes the files used to configure Apache HTTPD.</p>

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke</summary>

f90884915ff10ae83f59e709c68824de834e64f5Dominik Luecke

cf04ba46b9eb495d334466e24e082e391055ca7bDominik Luecke <section id="main">

cf04ba46b9eb495d334466e24e082e391055ca7bDominik Luecke <title>Main Configuration Files</title>

cf04ba46b9eb495d334466e24e082e391055ca7bDominik Luecke <related>

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke <modulelist>

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke <module>mod_mime</module>

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke </modulelist>

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke <directivelist>

f90884915ff10ae83f59e709c68824de834e64f5Dominik Luecke <directive module="core" type="section">IfDefine</directive>

f90884915ff10ae83f59e709c68824de834e64f5Dominik Luecke <directive module="core">Include</directive>

f90884915ff10ae83f59e709c68824de834e64f5Dominik Luecke <directive module="mod_mime">TypesConfig</directive>

f90884915ff10ae83f59e709c68824de834e64f5Dominik Luecke </directivelist>

f90884915ff10ae83f59e709c68824de834e64f5Dominik Luecke </related>

f90884915ff10ae83f59e709c68824de834e64f5Dominik Luecke

f90884915ff10ae83f59e709c68824de834e64f5Dominik Luecke <p>Apache HTTPD is configured by placing <a

b72a390042c19e630cf221494b60c9df2a60d187Dominik Luecke href="mod/directives.html">directives</a> in plain text

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke configuration files. The main configuration file is usually called

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke <code>httpd.conf</code>. The location of this file is set at

b72a390042c19e630cf221494b60c9df2a60d187Dominik Luecke compile-time, but may be overridden with the <code>-f</code>

b72a390042c19e630cf221494b60c9df2a60d187Dominik Luecke command line flag. In addition, other configuration files may be

b72a390042c19e630cf221494b60c9df2a60d187Dominik Luecke added using the <directive module="core">Include</directive>

b72a390042c19e630cf221494b60c9df2a60d187Dominik Luecke directive, and wildcards can be used to include many configuration

b72a390042c19e630cf221494b60c9df2a60d187Dominik Luecke files. Any directive may be placed in any of these configuration

b72a390042c19e630cf221494b60c9df2a60d187Dominik Luecke files. Changes to the main configuration files are only

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke recognized by httpd when it is started or restarted.</p>

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke <p>The server also reads a file containing mime document types;

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke the filename is set by the <directive

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke module="mod_mime">TypesConfig</directive> directive,

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke and is <code>mime.types</code> by default.</p>

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke </section>

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke <section id="syntax">

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke <title>Syntax of the Configuration Files</title>

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke <p>httpd configuration files contain one directive per line.

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke The back-slash "\" may be used as the last character on a line

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke to indicate that the directive continues onto the next line.

b72a390042c19e630cf221494b60c9df2a60d187Dominik Luecke There must be no other characters or white space between the

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke back-slash and the end of the line.</p>

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke <p>Directives in the configuration files are case-insensitive,

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke but arguments to directives are often case sensitive. Lines

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke that begin with the hash character "#" are considered

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke comments, and are ignored. Comments may <strong>not</strong> be

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke included on a line after a configuration directive. Blank lines

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke and white space occurring before a directive are ignored, so

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke you may indent directives for clarity.</p>

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke <p>The values of shell environment variables can be used in

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke configuration file lines using the syntax <code>${ENVVAR}</code>.

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke If "ENVVAR" is the name of a valid environment variable, the value

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke of that variable is substituted into that spot in the

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke configuration file line, and processing continues as if that text

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke were found directly in the configuration file. (If the ENVVAR

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke variable is not found, the characters "${ENVVAR}" are left

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke unchanged for use by later stages in the config file

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke processing.)</p>

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke <p>Only environment variables defined before the server is started

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke can be used in expansions. Variables defined in the

08056875f5f633ef432598d5245ea41c112d2178Dominik Luecke configuration file itself, for example with <directive

module="mod_env">SetEnv</directive>, take effect too late to be

used for expansions in the configuration file.</p>

<p>The maximum length of a line in the configuration file, after

environment-variable substitution, joining any continued lines and

removing leading and trailing white space, is 8192 characters.</p>

<p>You can check your configuration files for syntax errors

without starting the server by using <code>apachectl

configtest</code> or the <code>-t</code> command line

option.</p>

</section>

<section id="modules">

<title>Modules</title>

<related>

<modulelist>

<module>mod_so</module>

</modulelist>

<directivelist>

<directive module="core" type="section">IfModule</directive>

<directive module="mod_so">LoadModule</directive>

</directivelist>

</related>

<p>httpd is a modular server. This implies that only the most

basic functionality is included in the core server. Extended

features are available through <a

href="mod/">modules</a> which can be loaded

into httpd. By default, a <a

href="mod/module-dict.html#Status">base</a> set of modules is

included in the server at compile-time. If the server is

compiled to use <a href="dso.html">dynamically loaded</a>

modules, then modules can be compiled separately and added at

any time using the <directive module="mod_so">LoadModule</directive>

directive.

Otherwise, httpd must be recompiled to add or remove modules.

Configuration directives may be included conditional on a

presence of a particular module by enclosing them in an <directive

module="core" type="section">IfModule</directive> block.</p>

<p>To see which modules are currently compiled into the server,

you can use the <code>-l</code> command line option.</p>

</section>

<section id="scope">

<title>Scope of Directives</title>

<related>

<directivelist>

<directive module="core" type="section">Directory</directive>

<directive module="core" type="section">DirectoryMatch</directive>

<directive module="core" type="section">Files</directive>

<directive module="core" type="section">FilesMatch</directive>

<directive module="core" type="section">Location</directive>

<directive module="core" type="section">LocationMatch</directive>

<directive module="core" type="section">VirtualHost</directive>

</directivelist>

</related>

<p>Directives placed in the main configuration files apply to

the entire server. If you wish to change the configuration for

only a part of the server, you can scope your directives by

placing them in <directive module="core"

type="section">Directory</directive>, <directive module="core"

type="section">DirectoryMatch</directive>, <directive module="core"

type="section">Files</directive>, <directive module="core"

type="section">FilesMatch</directive>, <directive module="core"

type="section">Location</directive>, and <directive module="core"

type="section">LocationMatch</directive>

sections. These sections limit the application of the

directives which they enclose to particular filesystem

locations or URLs. They can also be nested, allowing for very

fine grained configuration.</p>

<p>httpd has the capability to serve many different websites

simultaneously. This is called <a href="vhosts/">Virtual

Hosting</a>. Directives can also be scoped by placing them

inside <directive module="core" type="section">VirtualHost</directive>

sections, so that they will only apply to requests for a

particular website.</p>

<p>Although most directives can be placed in any of these

sections, some directives do not make sense in some contexts.

For example, directives controlling process creation can only

be placed in the main server context. To find which directives

can be placed in which sections, check the <a

href="mod/directive-dict.html#Context">Context</a> of the

directive. For further information, we provide details on <a

href="sections.html">How Directory, Location and Files sections

work</a>.</p>

</section>

<section id="htaccess">

<title>.htaccess Files</title>

<related>

<directivelist>

<directive module="core">AccessFileName</directive>

<directive module="core">AllowOverride</directive>

</directivelist>

</related>

<p>httpd allows for decentralized management of configuration

via special files placed inside the web tree. The special files

are usually called <code>.htaccess</code>, but any name can be

specified in the <directive module="core">AccessFileName</directive>

directive. Directives placed in <code>.htaccess</code> files

apply to the directory where you place the file, and all

sub-directories. The <code>.htaccess</code> files follow the

same syntax as the main configuration files. Since

<code>.htaccess</code> files are read on every request, changes

made in these files take immediate effect.</p>

<p>To find which directives can be placed in

<code>.htaccess</code> files, check the <a

href="mod/directive-dict.html#Context">Context</a> of the

directive. The server administrator further controls what

directives may be placed in <code>.htaccess</code> files by

configuring the <directive module="core">AllowOverride</directive>

directive in the main configuration files.</p>

<p>For more information on <code>.htaccess</code> files, see

the <a href="howto/htaccess.html">.htaccess tutorial</a>.</p>

</section>

</manualpage>