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 Apache HTTP
  30 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 HTTP Server 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 httpd 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>httpd configuration files contain one directive per line.
  64     The backslash "\" 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     backslash 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>Only environment variables defined before the server is started
  88     can be used in expansions. Variables defined in the
  89     configuration file itself, for example with <code class="directive"><a href="./mod/mod_env.html#setenv">SetEnv</a></code>, take effect too late to be
  90     used for expansions in the configuration file.</p>
  91
  92     <p>The maximum length of a line in the configuration file, after
  93     environment-variable substitution, joining any continued lines and
  94     removing leading and trailing white space, is 8192 characters.</p>
  95
  96     <p>You can check your configuration files for syntax errors
  97     without starting the server by using <code>apachectl
  98     configtest</code> or the <code>-t</code> command line
  99     option.</p>
 100   </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
 101 <div class="section">
 102 <h2><a name="modules" id="modules">Modules</a></h2>
 103
 104
 105     <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>
 106
 107     <p>httpd is a modular server. This implies that only the most
 108     basic functionality is included in the core server. Extended
 109     features are available through <a href="mod/">modules</a> which can be loaded
 110     into httpd. By default, a <a href="mod/module-dict.html#Status">base</a> set of modules is
 111     included in the server at compile-time. If the server is
 112     compiled to use <a href="dso.html">dynamically loaded</a>
 113     modules, then modules can be compiled separately and added at
 114     any time using the <code class="directive"><a href="./mod/mod_so.html#loadmodule">LoadModule</a></code>
 115     directive.
 116     Otherwise, httpd must be recompiled to add or remove modules.
 117     Configuration directives may be included conditional on a
 118     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. However,
 119     <code class="directive">&lt;IfModule&gt;</code> blocks are not
 120     required, and in some cases may mask the fact that you're missing an
 121     important module.</p>
 122
 123     <p>To see which modules are currently compiled into the server,
 124     you can use the <code>-l</code> command line option. You can also
 125     see what modules are loaded dynamically using the <code>-M</code>
 126     command line option.</p>
 127   </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
 128 <div class="section">
 129 <h2><a name="scope" id="scope">Scope of Directives</a></h2>
 130
 131
 132     <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>
 133
 134     <p>Directives placed in the main configuration files apply to
 135     the entire server. If you wish to change the configuration for
 136     only a part of the server, you can scope your directives by
 137     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>
 138     sections. These sections limit the application of the
 139     directives which they enclose to particular filesystem
 140     locations or URLs. They can also be nested, allowing for very
 141     fine grained configuration.</p>
 142
 143     <p>httpd has the capability to serve many different websites
 144     simultaneously. This is called <a href="vhosts/">Virtual
 145     Hosting</a>. Directives can also be scoped by placing them
 146     inside <code class="directive"><a href="./mod/core.html#virtualhost">&lt;VirtualHost&gt;</a></code>
 147     sections, so that they will only apply to requests for a
 148     particular website.</p>
 149
 150     <p>Although most directives can be placed in any of these
 151     sections, some directives do not make sense in some contexts.
 152     For example, directives controlling process creation can only
 153     be placed in the main server context. To find which directives
 154     can be placed in which sections, check the <a href="mod/directive-dict.html#Context">Context</a> of the
 155     directive. For further information, we provide details on <a href="sections.html">How Directory, Location and Files sections
 156     work</a>.</p>
 157   </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
 158 <div class="section">
 159 <h2><a name="htaccess" id="htaccess">.htaccess Files</a></h2>
 160
 161
 162     <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>
 163
 164     <p>httpd allows for decentralized management of configuration
 165     via special files placed inside the web tree. The special files
 166     are usually called <code>.htaccess</code>, but any name can be
 167     specified in the <code class="directive"><a href="./mod/core.html#accessfilename">AccessFileName</a></code>
 168     directive. Directives placed in <code>.htaccess</code> files
 169     apply to the directory where you place the file, and all
 170     sub-directories. The <code>.htaccess</code> files follow the
 171     same syntax as the main configuration files. Since
 172     <code>.htaccess</code> files are read on every request, changes
 173     made in these files take immediate effect.</p>
 174
 175     <p>To find which directives can be placed in
 176     <code>.htaccess</code> files, check the <a href="mod/directive-dict.html#Context">Context</a> of the
 177     directive. The server administrator further controls what
 178     directives may be placed in <code>.htaccess</code> files by
 179     configuring the <code class="directive"><a href="./mod/core.html#allowoverride">AllowOverride</a></code>
 180     directive in the main configuration files.</p>
 181
 182     <p>For more information on <code>.htaccess</code> files, see
 183     the <a href="howto/htaccess.html">.htaccess tutorial</a>.</p>
 184   </div></div>
 185 <div class="bottomlang">
 186 <p><span>Available Languages: </span><a href="./de/configuring.html" hreflang="de" rel="alternate" title="Deutsch">&nbsp;de&nbsp;</a> |
 187 <a href="./en/configuring.html" title="English">&nbsp;en&nbsp;</a> |
 188 <a href="./fr/configuring.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
 189 <a href="./ja/configuring.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 190 <a href="./ko/configuring.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
 191 <a href="./tr/configuring.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
 192 </div><div id="footer">
 193 <p class="apache">Copyright 2010 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>
 194 <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>
 195 </body></html>