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" /><link rel="stylesheet" type="text/css" href="./style/css/prettify.css" />
  12 <script src="./style/scripts/prettify.js" type="text/javascript">
  13 </script>
  14
  15 <link href="./images/favicon.ico" rel="shortcut icon" /></head>
  16 <body id="manual-page"><div id="page-header">
  17 <p class="menu"><a href="./mod/">Modules</a> | <a href="./mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="./glossary.html">Glossary</a> | <a href="./sitemap.html">Sitemap</a></p>
  18 <p class="apache">Apache HTTP Server Version 2.5</p>
  19 <img alt="" src="./images/feather.gif" /></div>
  20 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="./images/left.gif" /></a></div>
  21 <div id="path">
  22 <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.5</a></div><div id="page-content"><div id="preamble"><h1>Configuration Files</h1>
  23 <div class="toplang">
  24 <p><span>Available Languages: </span><a href="./de/configuring.html" hreflang="de" rel="alternate" title="Deutsch">&nbsp;de&nbsp;</a> |
  25 <a href="./en/configuring.html" title="English">&nbsp;en&nbsp;</a> |
  26 <a href="./fr/configuring.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
  27 <a href="./ja/configuring.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
  28 <a href="./ko/configuring.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
  29 <a href="./tr/configuring.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
  30 </div>
  31
  32 <p>This document describes the files used to configure Apache HTTP
  33 Server.</p>
  34 </div>
  35 <div id="quickview"><ul id="toc"><li><img alt="" src="./images/down.gif" /> <a href="#main">Main Configuration Files</a></li>
  36 <li><img alt="" src="./images/down.gif" /> <a href="#syntax">Syntax of the Configuration Files</a></li>
  37 <li><img alt="" src="./images/down.gif" /> <a href="#modules">Modules</a></li>
  38 <li><img alt="" src="./images/down.gif" /> <a href="#scope">Scope of Directives</a></li>
  39 <li><img alt="" src="./images/down.gif" /> <a href="#htaccess">.htaccess Files</a></li>
  40 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
  41 <div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
  42 <div class="section">
  43 <h2><a name="main" id="main">Main Configuration Files</a></h2>
  44
  45     <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>
  46
  47     <p>Apache HTTP Server is configured by placing <a href="mod/directives.html">directives</a> in plain text
  48     configuration files. The main configuration file is usually called
  49     <code>httpd.conf</code>. The location of this file is set at
  50     compile-time, but may be overridden with the <code>-f</code>
  51     command line flag. In addition, other configuration files may be
  52     added using the <code class="directive"><a href="./mod/core.html#include">Include</a></code>
  53     directive, and wildcards can be used to include many configuration
  54     files. Any directive may be placed in any of these configuration
  55     files. Changes to the main configuration files are only
  56     recognized by httpd when it is started or restarted.</p>
  57
  58     <p>The server also reads a file containing mime document types;
  59     the filename is set by the <code class="directive"><a href="./mod/mod_mime.html#typesconfig">TypesConfig</a></code> directive,
  60     and is <code>mime.types</code> by default.</p>
  61   </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
  62 <div class="section">
  63 <h2><a name="syntax" id="syntax">Syntax of the Configuration Files</a></h2>
  64
  65
  66     <p>httpd configuration files contain one directive per line.
  67     The backslash "\" may be used as the last character on a line
  68     to indicate that the directive continues onto the next line.
  69     There must be no other characters or white space between the
  70     backslash and the end of the line.</p>
  71
  72     <p>Directives in the configuration files are case-insensitive,
  73     but arguments to directives are often case sensitive. Lines
  74     that begin with the hash character "#" are considered
  75     comments, and are ignored. Comments may <strong>not</strong> be
  76     included on a line after a configuration directive. Blank lines
  77     and white space occurring before a directive are ignored, so
  78     you may indent directives for clarity.</p>
  79
  80     <p>The values of variables defined with the <code class="directive"><a href="./mod/core.html#define">Define</a></code> of or shell environment variables can
  81     be used in configuration file lines using the syntax <code>${VAR}</code>.
  82     If "VAR" is the name of a valid variable, the value of that variable is
  83     substituted into that spot in the configuration file line, and processing
  84     continues as if that text were found directly in the configuration file.
  85     Variables defined with <code class="directive"><a href="./mod/core.html#define">Define</a></code> take
  86     precedence over shell environment variables.
  87     If the "VAR" variable is not found, the characters <code>${VAR}</code>
  88     are left unchanged, and a warning is logged.
  89     Variable names may not contain colon ":" characters, to avoid clashes with
  90     <code class="directive"><a href="./mod/mod_rewrite.html#rewritemap">RewriteMap</a></code>'s syntax.</p>
  91
  92     <p>Only shell environment variables defined before the server is started
  93     can be used in expansions. Environment variables defined in the
  94     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 used for
  95     expansions in the configuration file.</p>
  96
  97     <p>The maximum length of a line in normal configuration files, after
  98     variable substitution and joining any continued lines, is approximately
  99     16 MiB. In <a href="configuring.xml#htaccess">.htaccess files</a>, the
 100     maximum length is 8190 characters.</p>
 101
 102     <p>You can check your configuration files for syntax errors
 103     without starting the server by using <code>apachectl
 104     configtest</code> or the <code>-t</code> command line
 105     option.</p>
 106
 107     <p>You can use <code class="module"><a href="./mod/mod_info.html">mod_info</a></code>'s <code>-DDUMP_CONFIG</code> to
 108     dump the configuration with all included files and environment
 109     variables resolved and all comments and non-matching
 110     <code class="directive"><a href="./mod/core.html#ifdefine">&lt;IfDefine&gt;</a></code> and
 111     <code class="directive"><a href="./mod/core.html#ifmodule">&lt;IfModule&gt;</a></code> sections
 112     removed. However, the output does not reflect the merging or overriding
 113     that may happen for repeated directives.</p>
 114   </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
 115 <div class="section">
 116 <h2><a name="modules" id="modules">Modules</a></h2>
 117
 118
 119     <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>
 120
 121     <p>httpd is a modular server. This implies that only the most
 122     basic functionality is included in the core server. Extended
 123     features are available through <a href="mod/">modules</a> which can be loaded
 124     into httpd. By default, a <a href="mod/module-dict.html#Status">base</a> set of modules is
 125     included in the server at compile-time. If the server is
 126     compiled to use <a href="dso.html">dynamically loaded</a>
 127     modules, then modules can be compiled separately and added at
 128     any time using the <code class="directive"><a href="./mod/mod_so.html#loadmodule">LoadModule</a></code>
 129     directive.
 130     Otherwise, httpd must be recompiled to add or remove modules.
 131     Configuration directives may be included conditional on a
 132     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,
 133     <code class="directive">&lt;IfModule&gt;</code> blocks are not
 134     required, and in some cases may mask the fact that you're missing an
 135     important module.</p>
 136
 137     <p>To see which modules are currently compiled into the server,
 138     you can use the <code>-l</code> command line option. You can also
 139     see what modules are loaded dynamically using the <code>-M</code>
 140     command line option.</p>
 141   </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
 142 <div class="section">
 143 <h2><a name="scope" id="scope">Scope of Directives</a></h2>
 144
 145
 146     <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>
 147
 148     <p>Directives placed in the main configuration files apply to
 149     the entire server. If you wish to change the configuration for
 150     only a part of the server, you can scope your directives by
 151     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>
 152     sections. These sections limit the application of the
 153     directives which they enclose to particular filesystem
 154     locations or URLs. They can also be nested, allowing for very
 155     fine grained configuration.</p>
 156
 157     <p>httpd has the capability to serve many different websites
 158     simultaneously. This is called <a href="vhosts/">Virtual
 159     Hosting</a>. Directives can also be scoped by placing them
 160     inside <code class="directive"><a href="./mod/core.html#virtualhost">&lt;VirtualHost&gt;</a></code>
 161     sections, so that they will only apply to requests for a
 162     particular website.</p>
 163
 164     <p>Although most directives can be placed in any of these
 165     sections, some directives do not make sense in some contexts.
 166     For example, directives controlling process creation can only
 167     be placed in the main server context. To find which directives
 168     can be placed in which sections, check the <a href="mod/directive-dict.html#Context">Context</a> of the
 169     directive. For further information, we provide details on <a href="sections.html">How Directory, Location and Files sections
 170     work</a>.</p>
 171   </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
 172 <div class="section">
 173 <h2><a name="htaccess" id="htaccess">.htaccess Files</a></h2>
 174
 175
 176     <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>
 177
 178     <p>httpd allows for decentralized management of configuration
 179     via special files placed inside the web tree. The special files
 180     are usually called <code>.htaccess</code>, but any name can be
 181     specified in the <code class="directive"><a href="./mod/core.html#accessfilename">AccessFileName</a></code>
 182     directive. Directives placed in <code>.htaccess</code> files
 183     apply to the directory where you place the file, and all
 184     sub-directories. The <code>.htaccess</code> files follow the
 185     same syntax as the main configuration files. Since
 186     <code>.htaccess</code> files are read on every request, changes
 187     made in these files take immediate effect.</p>
 188
 189     <p>To find which directives can be placed in
 190     <code>.htaccess</code> files, check the <a href="mod/directive-dict.html#Context">Context</a> of the
 191     directive. The server administrator further controls what
 192     directives may be placed in <code>.htaccess</code> files by
 193     configuring the <code class="directive"><a href="./mod/core.html#allowoverride">AllowOverride</a></code>
 194     directive in the main configuration files.</p>
 195
 196     <p>For more information on <code>.htaccess</code> files, see
 197     the <a href="howto/htaccess.html">.htaccess tutorial</a>.</p>
 198   </div></div>
 199 <div class="bottomlang">
 200 <p><span>Available Languages: </span><a href="./de/configuring.html" hreflang="de" rel="alternate" title="Deutsch">&nbsp;de&nbsp;</a> |
 201 <a href="./en/configuring.html" title="English">&nbsp;en&nbsp;</a> |
 202 <a href="./fr/configuring.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
 203 <a href="./ja/configuring.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 204 <a href="./ko/configuring.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
 205 <a href="./tr/configuring.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
 206 </div><div class="top"><a href="#page-header"><img src="./images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&amp;A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
 207 <script type="text/javascript"><!--//--><![CDATA[//><!--
 208 var comments_shortname = 'httpd';
 209 var comments_identifier = 'http://httpd.apache.org/docs/trunk/configuring.html';
 210 (function(w, d) {
 211     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 212         d.write('<div id="comments_thread"><\/div>');
 213         var s = d.createElement('script');
 214         s.type = 'text/javascript';
 215         s.async = true;
 216         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 217         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 218     }
 219     else {
 220         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 221     }
 222 })(window, document);
 223 //--><!]]></script></div><div id="footer">
 224 <p class="apache">Copyright 2013 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>
 225 <p class="menu"><a href="./mod/">Modules</a> | <a href="./mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="./glossary.html">Glossary</a> | <a href="./sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
 226 if (typeof(prettyPrint) !== 'undefined') {
 227     prettyPrint();
 228 }
 229 //--><!]]></script>
 230 </body></html>