granicus.if.org Git - apache/blob - docs/manual/configuring.html.en

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
   4         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   5               This file is generated from xml source: DO NOT EDIT
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7       -->
   8 <title>Configuration Files - Apache HTTP Server</title>
   9 <link href="./style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10 <link href="./style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11 <link href="./style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
  12 <link href="./images/favicon.ico" rel="shortcut icon" /></head>
  13 <body id="manual-page"><div id="page-header">
  14 <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>
  15 <p class="apache">Apache HTTP Server Version 2.3</p>
  16 <img alt="" src="./images/feather.gif" /></div>
  17 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="./images/left.gif" /></a></div>
  18 <div id="path">
  19 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="./">Version 2.3</a></div><div id="page-content"><div id="preamble"><h1>Configuration Files</h1>
  20 <div class="toplang">
  21 <p><span>Available Languages: </span><a href="./de/configuring.html" hreflang="de" rel="alternate" title="Deutsch">&nbsp;de&nbsp;</a> |
  22 <a href="./en/configuring.html" title="English">&nbsp;en&nbsp;</a> |
  23 <a href="./fr/configuring.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
  24 <a href="./ja/configuring.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
  25 <a href="./ko/configuring.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
  26 <a href="./tr/configuring.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
  27 </div>
  28
  29 <p>This document describes the files used to configure the Apache
  30 HTTP server.</p>
  31 </div>
  32 <div id="quickview"><ul id="toc"><li><img alt="" src="./images/down.gif" /> <a href="#main">Main Configuration Files</a></li>
  33 <li><img alt="" src="./images/down.gif" /> <a href="#syntax">Syntax of the Configuration Files</a></li>
  34 <li><img alt="" src="./images/down.gif" /> <a href="#modules">Modules</a></li>
  35 <li><img alt="" src="./images/down.gif" /> <a href="#scope">Scope of Directives</a></li>
  36 <li><img alt="" src="./images/down.gif" /> <a href="#htaccess">.htaccess Files</a></li>
  37 </ul></div>
  38 <div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
  39 <div class="section">
  40 <h2><a name="main" id="main">Main Configuration Files</a></h2>
  41
  42     <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">&lt;IfDefine&gt;</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>
  43
  44     <p>Apache is configured by placing <a href="mod/directives.html">directives</a> in plain text
  45     configuration files. The main configuration file is usually called
  46     <code>httpd.conf</code>. The location of this file is set at
  47     compile-time, but may be overridden with the <code>-f</code>
  48     command line flag. In addition, other configuration files may be
  49     added using the <code class="directive"><a href="./mod/core.html#include">Include</a></code>
  50     directive, and wildcards can be used to include many configuration
  51     files. Any directive may be placed in any of these configuration
  52     files.  Changes to the main configuration files are only
  53     recognized by Apache when it is started or restarted.</p>
  54
  55     <p>The server also reads a file containing mime document types;
  56     the filename is set by the <code class="directive"><a href="./mod/mod_mime.html#typesconfig">TypesConfig</a></code> directive,
  57     and is <code>mime.types</code> by default.</p>
  58   </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
  59 <div class="section">
  60 <h2><a name="syntax" id="syntax">Syntax of the Configuration Files</a></h2>
  61
  62
  63     <p>Apache configuration files contain one directive per line.
  64     The back-slash "\" may be used as the last character on a line
  65     to indicate that the directive continues onto the next line.
  66     There must be no other characters or white space between the
  67     back-slash and the end of the line.</p>
  68
  69     <p>Directives in the configuration files are case-insensitive,
  70     but arguments to directives are often case sensitive. Lines
  71     that begin with the hash character "#" are considered
  72     comments, and are ignored. Comments may <strong>not</strong> be
  73     included on a line after a configuration directive. Blank lines
  74     and white space occurring before a directive are ignored, so
  75     you may indent directives for clarity.</p>
  76
  77     <p>The values of shell environment variables can be used in
  78     configuration file lines using the syntax <code>${ENVVAR}</code>.
  79     If "ENVVAR" is the name of a valid environment variable, the value
  80     of that variable is substituted into that spot in the
  81     configuration file line, and processing continues as if that text
  82     were found directly in the configuration file.  (If the ENVVAR
  83     variable is not found, the characters "${ENVVAR}" are left
  84     unchanged for use by later stages in the config file
  85     processing.)</p>
  86
  87     <p>The maximum length of a line in the configuration file, after
  88     environment-variable substitution, joining any continued lines and
  89     removing leading and trailing white space, is 8192 characters.</p>
  90
  91     <p>You can check your configuration files for syntax errors
  92     without starting the server by using <code>apachectl
  93     configtest</code> or the <code>-t</code> command line
  94     option.</p>
  95   </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
  96 <div class="section">
  97 <h2><a name="modules" id="modules">Modules</a></h2>
  98
  99
 100     <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">&lt;IfModule&gt;</a></code></li><li><code class="directive"><a href="./mod/mod_so.html#loadmodule">LoadModule</a></code></li></ul></td></tr></table>
 101
 102     <p>Apache is a modular server. This implies that only the most
 103     basic functionality is included in the core server. Extended
 104     features are available through <a href="mod/">modules</a> which can be loaded
 105     into Apache. By default, a <a href="mod/module-dict.html#Status">base</a> set of modules is
 106     included in the server at compile-time. If the server is
 107     compiled to use <a href="dso.html">dynamically loaded</a>
 108     modules, then modules can be compiled separately and added at
 109     any time using the <code class="directive"><a href="./mod/mod_so.html#loadmodule">LoadModule</a></code>
 110     directive.
 111     Otherwise, Apache must be recompiled to add or remove modules.
 112     Configuration directives may be included conditional on a
 113     presence of a particular module by enclosing them in an <code class="directive"><a href="./mod/core.html#ifmodule">&lt;IfModule&gt;</a></code> block.</p>
 114
 115     <p>To see which modules are currently compiled into the server,
 116     you can use the <code>-l</code> command line option.</p>
 117   </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
 118 <div class="section">
 119 <h2><a name="scope" id="scope">Scope of Directives</a></h2>
 120
 121
 122     <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">&lt;Directory&gt;</a></code></li><li><code class="directive"><a href="./mod/core.html#directorymatch">&lt;DirectoryMatch&gt;</a></code></li><li><code class="directive"><a href="./mod/core.html#files">&lt;Files&gt;</a></code></li><li><code class="directive"><a href="./mod/core.html#filesmatch">&lt;FilesMatch&gt;</a></code></li><li><code class="directive"><a href="./mod/core.html#location">&lt;Location&gt;</a></code></li><li><code class="directive"><a href="./mod/core.html#locationmatch">&lt;LocationMatch&gt;</a></code></li><li><code class="directive"><a href="./mod/core.html#virtualhost">&lt;VirtualHost&gt;</a></code></li></ul></td></tr></table>
 123
 124     <p>Directives placed in the main configuration files apply to
 125     the entire server. If you wish to change the configuration for
 126     only a part of the server, you can scope your directives by
 127     placing them in <code class="directive"><a href="./mod/core.html#directory">&lt;Directory&gt;</a></code>, <code class="directive"><a href="./mod/core.html#directorymatch">&lt;DirectoryMatch&gt;</a></code>, <code class="directive"><a href="./mod/core.html#files">&lt;Files&gt;</a></code>, <code class="directive"><a href="./mod/core.html#filesmatch">&lt;FilesMatch&gt;</a></code>, <code class="directive"><a href="./mod/core.html#location">&lt;Location&gt;</a></code>, and <code class="directive"><a href="./mod/core.html#locationmatch">&lt;LocationMatch&gt;</a></code>
 128     sections. These sections limit the application of the
 129     directives which they enclose to particular filesystem
 130     locations or URLs. They can also be nested, allowing for very
 131     fine grained configuration.</p>
 132
 133     <p>Apache has the capability to serve many different websites
 134     simultaneously. This is called <a href="vhosts/">Virtual
 135     Hosting</a>. Directives can also be scoped by placing them
 136     inside <code class="directive"><a href="./mod/core.html#virtualhost">&lt;VirtualHost&gt;</a></code>
 137     sections, so that they will only apply to requests for a
 138     particular website.</p>
 139
 140     <p>Although most directives can be placed in any of these
 141     sections, some directives do not make sense in some contexts.
 142     For example, directives controlling process creation can only
 143     be placed in the main server context. To find which directives
 144     can be placed in which sections, check the <a href="mod/directive-dict.html#Context">Context</a> of the
 145     directive. For further information, we provide details on <a href="sections.html">How Directory, Location and Files sections
 146     work</a>.</p>
 147   </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
 148 <div class="section">
 149 <h2><a name="htaccess" id="htaccess">.htaccess Files</a></h2>
 150
 151
 152     <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>
 153
 154     <p>Apache allows for decentralized management of configuration
 155     via special files placed inside the web tree. The special files
 156     are usually called <code>.htaccess</code>, but any name can be
 157     specified in the <code class="directive"><a href="./mod/core.html#accessfilename">AccessFileName</a></code>
 158     directive. Directives placed in <code>.htaccess</code> files
 159     apply to the directory where you place the file, and all
 160     sub-directories. The <code>.htaccess</code> files follow the
 161     same syntax as the main configuration files. Since
 162     <code>.htaccess</code> files are read on every request, changes
 163     made in these files take immediate effect.</p>
 164
 165     <p>To find which directives can be placed in
 166     <code>.htaccess</code> files, check the <a href="mod/directive-dict.html#Context">Context</a> of the
 167     directive. The server administrator further controls what
 168     directives may be placed in <code>.htaccess</code> files by
 169     configuring the <code class="directive"><a href="./mod/core.html#allowoverride">AllowOverride</a></code>
 170     directive in the main configuration files.</p>
 171
 172     <p>For more information on <code>.htaccess</code> files, see
 173     the <a href="howto/htaccess.html">.htaccess tutorial</a>.</p>
 174   </div></div>
 175 <div class="bottomlang">
 176 <p><span>Available Languages: </span><a href="./de/configuring.html" hreflang="de" rel="alternate" title="Deutsch">&nbsp;de&nbsp;</a> |
 177 <a href="./en/configuring.html" title="English">&nbsp;en&nbsp;</a> |
 178 <a href="./fr/configuring.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
 179 <a href="./ja/configuring.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 180 <a href="./ko/configuring.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
 181 <a href="./tr/configuring.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
 182 </div><div id="footer">
 183 <p class="apache">Copyright 2009 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>
 184 <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>
 185 </body></html>