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