configuring.html 17 KB

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