configuring.html.en revision 1b6d7a3923d2a5cd56970ee9c4389fddd2e402e6
842ae4bd224140319ae7feec1872b93dfd491143fielding<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
842ae4bd224140319ae7feec1872b93dfd491143fielding<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
842ae4bd224140319ae7feec1872b93dfd491143fielding XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
842ae4bd224140319ae7feec1872b93dfd491143fielding This file is generated from xml source: DO NOT EDIT
842ae4bd224140319ae7feec1872b93dfd491143fielding XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd<link href="/style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd<link href="/images/favicon.ico" rel="shortcut icon" /></head>
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="/faq/">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p>
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding<p class="apache">Apache HTTP Server Version 2.1</p>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div>
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs-project/">Documentation</a> > <a href="./">Version 2.1</a></div><div id="page-content"><div id="preamble"><h1>Configuration Files</h1>
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding<p><span>Available Languages: </span><a href="/en/configuring.html" title="English"> en </a> |
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding<a href="/ja/configuring.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
1b21d7b3d97def358b2e923655edeb16613a1c31gstein<a href="/ko/configuring.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
1b21d7b3d97def358b2e923655edeb16613a1c31gstein<p>This document describes the files used to configure the Apache
1b21d7b3d97def358b2e923655edeb16613a1c31gsteinHTTP server.</p>
1b21d7b3d97def358b2e923655edeb16613a1c31gstein<div id="quickview"><ul id="toc"><li><img alt="" src="/images/down.gif" /> <a href="#main">Main Configuration Files</a></li>
2d71630471d1c23f0137309e3c3957c633ecbfd6rbb<li><img alt="" src="/images/down.gif" /> <a href="#syntax">Syntax of the Configuration Files</a></li>
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding<li><img alt="" src="/images/down.gif" /> <a href="#modules">Modules</a></li>
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding<li><img alt="" src="/images/down.gif" /> <a href="#scope">Scope of Directives</a></li>
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding<li><img alt="" src="/images/down.gif" /> <a href="#htaccess">.htaccess Files</a></li>
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
d4f1d9c1ff112a8ab9bee31f196973761329b236rbb<h2><a name="main" id="main">Main Configuration Files</a></h2>
7fae9cc4639013f3c04c085547256c68814aee8ftrawick <table class="related"><tr><th>Related Modules</th><th>Related Directives</th></tr><tr><td><ul><li><code class="module"><a href="/mod/mod_mime.html">mod_mime</a></code></li></ul></td><td><ul><li><code class="directive"><a href="/mod/core.html#ifdefine"><IfDefine></a></code></li><li><code class="directive"><a href="/mod/core.html#include">Include</a></code></li><li><code class="directive"><a href="/mod/mod_mime.html#typesconfig">TypesConfig</a></code></li></ul></td></tr></table>
7fae9cc4639013f3c04c085547256c68814aee8ftrawick <p>Apache is configured by placing <a href="mod/directives.html">directives</a> in plain text
7184de27ec1d62a83c41cdeac0953ca9fd661e8csf configuration files. The main configuration file is usually called
7184de27ec1d62a83c41cdeac0953ca9fd661e8csf <code>httpd.conf</code>. The location of this file is set at
7184de27ec1d62a83c41cdeac0953ca9fd661e8csf compile-time, but may be overridden with the <code>-f</code>
36ef8f77bffe75d1aa327882be1b5bdbe2ff567asf command line flag. In addition, other configuration files may be
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding added using the <code class="directive"><a href="/mod/core.html#include">Include</a></code>
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding directive, and wildcards can be used to include many configuration
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding files. Any directive may be placed in any of these configuration
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding files. Changes to the main configuration files are only
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding recognized by Apache when it is started or restarted.</p>
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding <p>The server also reads a file containing mime document types;
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding the filename is set by the <code class="directive"><a href="/mod/mod_mime.html#typesconfig">TypesConfig</a></code> directive,
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding </div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
785be1b6298010956622771c870ab3cd8ca57a2faaron<h2><a name="syntax" id="syntax">Syntax of the Configuration Files</a></h2>
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding <p>Apache configuration files contain one directive per line.
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding The back-slash "\" may be used as the last character on a line
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding to indicate that the directive continues onto the next line.
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding There must be no other characters or white space between the
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding back-slash and the end of the line.</p>
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding <p>Directives in the configuration files are case-insensitive,
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding but arguments to directives are often case sensitive. Lines
785be1b6298010956622771c870ab3cd8ca57a2faaron that begin with the hash character "#" are considered
785be1b6298010956622771c870ab3cd8ca57a2faaron comments, and are ignored. Comments may <strong>not</strong> be
785be1b6298010956622771c870ab3cd8ca57a2faaron included on a line after a configuration directive. Blank lines
785be1b6298010956622771c870ab3cd8ca57a2faaron and white space occurring before a directive are ignored, so
785be1b6298010956622771c870ab3cd8ca57a2faaron you may indent directives for clarity.</p>
7697b1b7376a532163c621e050b70c90dcb15d66covener <p>You can check your configuration files for syntax errors
7697b1b7376a532163c621e050b70c90dcb15d66covener without starting the server by using <code>apachectl
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding configtest</code> or the <code>-t</code> command line
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding option.</p>
f4b96a996afbc46872f57ad1450e6ee1c8f13707jorton </div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding <table class="related"><tr><th>Related Modules</th><th>Related Directives</th></tr><tr><td><ul><li><code class="module"><a href="/mod/mod_so.html">mod_so</a></code></li></ul></td><td><ul><li><code class="directive"><a href="/mod/core.html#ifmodule"><IfModule></a></code></li><li><code class="directive"><a href="/mod/mod_so.html#loadmodule">LoadModule</a></code></li></ul></td></tr></table>
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding <p>Apache is a modular server. This implies that only the most
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding basic functionality is included in the core server. Extended
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding features are available through <a href="mod/">modules</a> which can be loaded
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding into Apache. By default, a <a href="mod/module-dict.html#Status">base</a> set of modules is
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding included in the server at compile-time. If the server is
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding compiled to use <a href="dso.html">dynamically loaded</a>
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding modules, then modules can be compiled separately and added at
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding any time using the <code class="directive"><a href="/mod/mod_so.html#loadmodule">LoadModule</a></code>
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding Otherwise, Apache must be recompiled to add or remove modules.
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding Configuration directives may be included conditional on a
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding presence of a particular module by enclosing them in an <code class="directive"><a href="/mod/core.html#ifmodule"><IfModule></a></code> block.</p>
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding <p>To see which modules are currently compiled into the server,
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding you can use the <code>-l</code> command line option.</p>
e08076ca56e6cb68b30846b9e9339061058aae6dpoirier </div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
e08076ca56e6cb68b30846b9e9339061058aae6dpoirier<h2><a name="scope" id="scope">Scope of Directives</a></h2>
e08076ca56e6cb68b30846b9e9339061058aae6dpoirier <table class="related"><tr><th>Related Modules</th><th>Related Directives</th></tr><tr><td /><td><ul><li><code class="directive"><a href="/mod/core.html#directory"><Directory></a></code></li><li><code class="directive"><a href="/mod/core.html#directorymatch"><DirectoryMatch></a></code></li><li><code class="directive"><a href="/mod/core.html#files"><Files></a></code></li><li><code class="directive"><a href="/mod/core.html#filesmatch"><FilesMatch></a></code></li><li><code class="directive"><a href="/mod/core.html#location"><Location></a></code></li><li><code class="directive"><a href="/mod/core.html#locationmatch"><LocationMatch></a></code></li><li><code class="directive"><a href="/mod/core.html#virtualhost"><VirtualHost></a></code></li></ul></td></tr></table>
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding <p>Directives placed in the main configuration files apply to
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding the entire server. If you wish to change the configuration for
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding only a part of the server, you can scope your directives by
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding placing them in <code class="directive"><a href="/mod/core.html#directory"><Directory></a></code>, <code class="directive"><a href="/mod/core.html#directorymatch"><DirectoryMatch></a></code>, <code class="directive"><a href="/mod/core.html#files"><Files></a></code>, <code class="directive"><a href="/mod/core.html#filesmatch"><FilesMatch></a></code>, <code class="directive"><a href="/mod/core.html#location"><Location></a></code>, and <code class="directive"><a href="/mod/core.html#locationmatch"><LocationMatch></a></code>
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding sections. These sections limit the application of the
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding directives which they enclose to particular filesystem
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding locations or URLs. They can also be nested, allowing for very
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding fine grained configuration.</p>
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding <p>Apache has the capability to serve many different websites
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding simultaneously. This is called <a href="vhosts/">Virtual
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding Hosting</a>. Directives can also be scoped by placing them
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding inside <code class="directive"><a href="/mod/core.html#virtualhost"><VirtualHost></a></code>
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding sections, so that they will only apply to requests for a
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding particular website.</p>
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding <p>Although most directives can be placed in any of these
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding sections, some directives do not make sense in some contexts.
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding For example, directives controlling process creation can only
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding be placed in the main server context. To find which directives
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding can be placed in which sections, check the <a href="mod/directive-dict.html#Context">Context</a> of the
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding directive. For further information, we provide details on <a href="sections.html">How Directory, Location and Files sections
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding </div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding<h2><a name="htaccess" id="htaccess">.htaccess Files</a></h2>
e08076ca56e6cb68b30846b9e9339061058aae6dpoirier <table class="related"><tr><th>Related Modules</th><th>Related Directives</th></tr><tr><td /><td><ul><li><code class="directive"><a href="/mod/core.html#accessfilename">AccessFileName</a></code></li><li><code class="directive"><a href="/mod/core.html#allowoverride">AllowOverride</a></code></li></ul></td></tr></table>
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding <p>Apache allows for decentralized management of configuration
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding via special files placed inside the web tree. The special files
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding are usually called <code>.htaccess</code>, but any name can be
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding specified in the <code class="directive"><a href="/mod/core.html#accessfilename">AccessFileName</a></code>
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding directive. Directives placed in <code>.htaccess</code> files
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding apply to the directory where you place the file, and all
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding sub-directories. The <code>.htaccess</code> files follow the
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding same syntax as the main configuration files. Since
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding <code>.htaccess</code> files are read on every request, changes
1ccd992d37d62c8cb2056126f2234f64ec189bfddougm made in these files take immediate effect.</p>
6b38fca3ec543a0f72efd5683e91a0b30fc752d1trawick <p>To find which directives can be placed in
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding <code>.htaccess</code> files, check the <a href="mod/directive-dict.html#Context">Context</a> of the
8a261a9f7d18d1e862d63f68e93f288d3e1f0d94trawick directive. The server administrator further controls what
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding directives may be placed in <code>.htaccess</code> files by
6b38fca3ec543a0f72efd5683e91a0b30fc752d1trawick configuring the <code class="directive"><a href="/mod/core.html#allowoverride">AllowOverride</a></code>
6b38fca3ec543a0f72efd5683e91a0b30fc752d1trawick directive in the main configuration files.</p>
6b38fca3ec543a0f72efd5683e91a0b30fc752d1trawick <p>For more information on <code>.htaccess</code> files, see
8a261a9f7d18d1e862d63f68e93f288d3e1f0d94trawick the <a href="howto/htaccess.html">.htaccess tutorial</a>.</p>
785be1b6298010956622771c870ab3cd8ca57a2faaron<p><span>Available Languages: </span><a href="/en/configuring.html" title="English"> en </a> |
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding<a href="/ja/configuring.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
6b38fca3ec543a0f72efd5683e91a0b30fc752d1trawick<a href="/ko/configuring.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
e160b861b50a3a8dcc013b8cd3ef849fe777e52fgregames<p class="apache">Copyright 1999-2004 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
e160b861b50a3a8dcc013b8cd3ef849fe777e52fgregames<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="/faq/">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p></div>