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>Arguments to directives are separated by whitespace. If an
  73     argument contains spaces, you must enclose that argument in quotes.</p>
  74
  75     <p>Directives in the configuration files are case-insensitive,
  76     but arguments to directives are often case sensitive. Lines
  77     that begin with the hash character "#" are considered
  78     comments, and are ignored. Comments may <strong>not</strong> be
  79     included on a line after a configuration directive. Blank lines
  80     and white space occurring before a directive are ignored, so
  81     you may indent directives for clarity.</p>
  82
  83     <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
  84     be used in configuration file lines using the syntax <code>${VAR}</code>.
  85     If "VAR" is the name of a valid variable, the value of that variable is
  86     substituted into that spot in the configuration file line, and processing
  87     continues as if that text were found directly in the configuration file.
  88     Variables defined with <code class="directive"><a href="./mod/core.html#define">Define</a></code> take
  89     precedence over shell environment variables.
  90     If the "VAR" variable is not found, the characters <code>${VAR}</code>
  91     are left unchanged, and a warning is logged.
  92     Variable names may not contain colon ":" characters, to avoid clashes with
  93     <code class="directive"><a href="./mod/mod_rewrite.html#rewritemap">RewriteMap</a></code>'s syntax.</p>
  94
  95     <p>Only shell environment variables defined before the server is started
  96     can be used in expansions. Environment variables defined in the
  97     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
  98     expansions in the configuration file.</p>
  99
 100     <p>The maximum length of a line in normal configuration files, after
 101     variable substitution and joining any continued lines, is approximately
 102     16 MiB. In <a href="configuring.xml#htaccess">.htaccess files</a>, the
 103     maximum length is 8190 characters.</p>
 104
 105     <p>You can check your configuration files for syntax errors
 106     without starting the server by using <code>apachectl
 107     configtest</code> or the <code>-t</code> command line
 108     option.</p>
 109
 110     <p>You can use <code class="module"><a href="./mod/mod_info.html">mod_info</a></code>'s <code>-DDUMP_CONFIG</code> to
 111     dump the configuration with all included files and environment
 112     variables resolved and all comments and non-matching
 113     <code class="directive"><a href="./mod/core.html#ifdefine">&lt;IfDefine&gt;</a></code> and
 114     <code class="directive"><a href="./mod/core.html#ifmodule">&lt;IfModule&gt;</a></code> sections
 115     removed. However, the output does not reflect the merging or overriding
 116     that may happen for repeated directives.</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="modules" id="modules">Modules</a></h2>
 120
 121
 122     <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>
 123
 124     <p>httpd is a modular server. This implies that only the most
 125     basic functionality is included in the core server. Extended
 126     features are available through <a href="mod/">modules</a> which can be loaded
 127     into httpd. By default, a <a href="mod/module-dict.html#Status">base</a> set of modules is
 128     included in the server at compile-time. If the server is
 129     compiled to use <a href="dso.html">dynamically loaded</a>
 130     modules, then modules can be compiled separately and added at
 131     any time using the <code class="directive"><a href="./mod/mod_so.html#loadmodule">LoadModule</a></code>
 132     directive.
 133     Otherwise, httpd must be recompiled to add or remove modules.
 134     Configuration directives may be included conditional on a
 135     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,
 136     <code class="directive">&lt;IfModule&gt;</code> blocks are not
 137     required, and in some cases may mask the fact that you're missing an
 138     important module.</p>
 139
 140     <p>To see which modules are currently compiled into the server,
 141     you can use the <code>-l</code> command line option. You can also
 142     see what modules are loaded dynamically using the <code>-M</code>
 143     command line option.</p>
 144   </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
 145 <div class="section">
 146 <h2><a name="scope" id="scope">Scope of Directives</a></h2>
 147
 148
 149     <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>
 150
 151     <p>Directives placed in the main configuration files apply to
 152     the entire server. If you wish to change the configuration for
 153     only a part of the server, you can scope your directives by
 154     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>
 155     sections. These sections limit the application of the
 156     directives which they enclose to particular filesystem
 157     locations or URLs. They can also be nested, allowing for very
 158     fine grained configuration.</p>
 159
 160     <p>httpd has the capability to serve many different websites
 161     simultaneously. This is called <a href="vhosts/">Virtual
 162     Hosting</a>. Directives can also be scoped by placing them
 163     inside <code class="directive"><a href="./mod/core.html#virtualhost">&lt;VirtualHost&gt;</a></code>
 164     sections, so that they will only apply to requests for a
 165     particular website.</p>
 166
 167     <p>Although most directives can be placed in any of these
 168     sections, some directives do not make sense in some contexts.
 169     For example, directives controlling process creation can only
 170     be placed in the main server context. To find which directives
 171     can be placed in which sections, check the <a href="mod/directive-dict.html#Context">Context</a> of the
 172     directive. For further information, we provide details on <a href="sections.html">How Directory, Location and Files sections
 173     work</a>.</p>
 174   </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
 175 <div class="section">
 176 <h2><a name="htaccess" id="htaccess">.htaccess Files</a></h2>
 177
 178
 179     <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>
 180
 181     <p>httpd allows for decentralized management of configuration
 182     via special files placed inside the web tree. The special files
 183     are usually called <code>.htaccess</code>, but any name can be
 184     specified in the <code class="directive"><a href="./mod/core.html#accessfilename">AccessFileName</a></code>
 185     directive. Directives placed in <code>.htaccess</code> files
 186     apply to the directory where you place the file, and all
 187     sub-directories. The <code>.htaccess</code> files follow the
 188     same syntax as the main configuration files. Since
 189     <code>.htaccess</code> files are read on every request, changes
 190     made in these files take immediate effect.</p>
 191
 192     <p>To find which directives can be placed in
 193     <code>.htaccess</code> files, check the <a href="mod/directive-dict.html#Context">Context</a> of the
 194     directive. The server administrator further controls what
 195     directives may be placed in <code>.htaccess</code> files by
 196     configuring the <code class="directive"><a href="./mod/core.html#allowoverride">AllowOverride</a></code>
 197     directive in the main configuration files.</p>
 198
 199     <p>For more information on <code>.htaccess</code> files, see
 200     the <a href="howto/htaccess.html">.htaccess tutorial</a>.</p>
 201   </div></div>
 202 <div class="bottomlang">
 203 <p><span>Available Languages: </span><a href="./de/configuring.html" hreflang="de" rel="alternate" title="Deutsch">&nbsp;de&nbsp;</a> |
 204 <a href="./en/configuring.html" title="English">&nbsp;en&nbsp;</a> |
 205 <a href="./fr/configuring.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
 206 <a href="./ja/configuring.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 207 <a href="./ko/configuring.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
 208 <a href="./tr/configuring.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
 209 </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>
 210 <script type="text/javascript"><!--//--><![CDATA[//><!--
 211 var comments_shortname = 'httpd';
 212 var comments_identifier = 'http://httpd.apache.org/docs/trunk/configuring.html';
 213 (function(w, d) {
 214     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 215         d.write('<div id="comments_thread"><\/div>');
 216         var s = d.createElement('script');
 217         s.type = 'text/javascript';
 218         s.async = true;
 219         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 220         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 221     }
 222     else {
 223         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 224     }
 225 })(window, document);
 226 //--><!]]></script></div><div id="footer">
 227 <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>
 228 <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[//><!--
 229 if (typeof(prettyPrint) !== 'undefined') {
 230     prettyPrint();
 231 }
 232 //--><!]]></script>
 233 </body></html>