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.1</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-project/">Documentation</a> &gt; <a href="./">Version 2.1</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="./en/configuring.html" title="English">&nbsp;en&nbsp;</a> |
  22 <a href="./ja/configuring.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
  23 <a href="./ko/configuring.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
  24 </div>
  25
  26 <p>This document describes the files used to configure the Apache
  27 HTTP server.</p>
  28 </div>
  29 <div id="quickview"><ul id="toc"><li><img alt="" src="./images/down.gif" /> <a href="#main">Main Configuration Files</a></li>
  30 <li><img alt="" src="./images/down.gif" /> <a href="#syntax">Syntax of the Configuration Files</a></li>
  31 <li><img alt="" src="./images/down.gif" /> <a href="#modules">Modules</a></li>
  32 <li><img alt="" src="./images/down.gif" /> <a href="#scope">Scope of Directives</a></li>
  33 <li><img alt="" src="./images/down.gif" /> <a href="#htaccess">.htaccess Files</a></li>
  34 </ul></div>
  35 <div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
  36 <div class="section">
  37 <h2><a name="main" id="main">Main Configuration Files</a></h2>
  38
  39     <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>
  40
  41     <p>Apache is configured by placing <a href="mod/directives.html">directives</a> in plain text
  42     configuration files. The main configuration file is usually called
  43     <code>httpd.conf</code>. The location of this file is set at
  44     compile-time, but may be overridden with the <code>-f</code>
  45     command line flag. In addition, other configuration files may be
  46     added using the <code class="directive"><a href="./mod/core.html#include">Include</a></code>
  47     directive, and wildcards can be used to include many configuration
  48     files. Any directive may be placed in any of these configuration
  49     files.  Changes to the main configuration files are only
  50     recognized by Apache when it is started or restarted.</p>
  51
  52     <p>The server also reads a file containing mime document types;
  53     the filename is set by the <code class="directive"><a href="./mod/mod_mime.html#typesconfig">TypesConfig</a></code> directive,
  54     and is <code>mime.types</code> by default.</p>
  55   </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
  56 <div class="section">
  57 <h2><a name="syntax" id="syntax">Syntax of the Configuration Files</a></h2>
  58
  59
  60     <p>Apache configuration files contain one directive per line.
  61     The back-slash "\" may be used as the last character on a line
  62     to indicate that the directive continues onto the next line.
  63     There must be no other characters or white space between the
  64     back-slash and the end of the line.</p>
  65
  66     <p>Directives in the configuration files are case-insensitive,
  67     but arguments to directives are often case sensitive. Lines
  68     that begin with the hash character "#" are considered
  69     comments, and are ignored. Comments may <strong>not</strong> be
  70     included on a line after a configuration directive. Blank lines
  71     and white space occurring before a directive are ignored, so
  72     you may indent directives for clarity.</p>
  73
  74     <p>You can check your configuration files for syntax errors
  75     without starting the server by using <code>apachectl
  76     configtest</code> or the <code>-t</code> command line
  77     option.</p>
  78   </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
  79 <div class="section">
  80 <h2><a name="modules" id="modules">Modules</a></h2>
  81
  82
  83     <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>
  84
  85     <p>Apache is a modular server. This implies that only the most
  86     basic functionality is included in the core server. Extended
  87     features are available through <a href="mod/">modules</a> which can be loaded
  88     into Apache. By default, a <a href="mod/module-dict.html#Status">base</a> set of modules is
  89     included in the server at compile-time. If the server is
  90     compiled to use <a href="dso.html">dynamically loaded</a>
  91     modules, then modules can be compiled separately and added at
  92     any time using the <code class="directive"><a href="./mod/mod_so.html#loadmodule">LoadModule</a></code>
  93     directive.
  94     Otherwise, Apache must be recompiled to add or remove modules.
  95     Configuration directives may be included conditional on a
  96     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.</p>
  97
  98     <p>To see which modules are currently compiled into the server,
  99     you can use the <code>-l</code> command line 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="scope" id="scope">Scope of Directives</a></h2>
 103
 104
 105     <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>
 106
 107     <p>Directives placed in the main configuration files apply to
 108     the entire server. If you wish to change the configuration for
 109     only a part of the server, you can scope your directives by
 110     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>
 111     sections. These sections limit the application of the
 112     directives which they enclose to particular filesystem
 113     locations or URLs. They can also be nested, allowing for very
 114     fine grained configuration.</p>
 115
 116     <p>Apache has the capability to serve many different websites
 117     simultaneously. This is called <a href="vhosts/">Virtual
 118     Hosting</a>. Directives can also be scoped by placing them
 119     inside <code class="directive"><a href="./mod/core.html#virtualhost">&lt;VirtualHost&gt;</a></code>
 120     sections, so that they will only apply to requests for a
 121     particular website.</p>
 122
 123     <p>Although most directives can be placed in any of these
 124     sections, some directives do not make sense in some contexts.
 125     For example, directives controlling process creation can only
 126     be placed in the main server context. To find which directives
 127     can be placed in which sections, check the <a href="mod/directive-dict.html#Context">Context</a> of the
 128     directive. For further information, we provide details on <a href="sections.html">How Directory, Location and Files sections
 129     work</a>.</p>
 130   </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
 131 <div class="section">
 132 <h2><a name="htaccess" id="htaccess">.htaccess Files</a></h2>
 133
 134
 135     <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>
 136
 137     <p>Apache allows for decentralized management of configuration
 138     via special files placed inside the web tree. The special files
 139     are usually called <code>.htaccess</code>, but any name can be
 140     specified in the <code class="directive"><a href="./mod/core.html#accessfilename">AccessFileName</a></code>
 141     directive. Directives placed in <code>.htaccess</code> files
 142     apply to the directory where you place the file, and all
 143     sub-directories. The <code>.htaccess</code> files follow the
 144     same syntax as the main configuration files. Since
 145     <code>.htaccess</code> files are read on every request, changes
 146     made in these files take immediate effect.</p>
 147
 148     <p>To find which directives can be placed in
 149     <code>.htaccess</code> files, check the <a href="mod/directive-dict.html#Context">Context</a> of the
 150     directive. The server administrator further controls what
 151     directives may be placed in <code>.htaccess</code> files by
 152     configuring the <code class="directive"><a href="./mod/core.html#allowoverride">AllowOverride</a></code>
 153     directive in the main configuration files.</p>
 154
 155     <p>For more information on <code>.htaccess</code> files, see
 156     the <a href="howto/htaccess.html">.htaccess tutorial</a>.</p>
 157   </div></div>
 158 <div class="bottomlang">
 159 <p><span>Available Languages: </span><a href="./en/configuring.html" title="English">&nbsp;en&nbsp;</a> |
 160 <a href="./ja/configuring.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 161 <a href="./ko/configuring.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 162 </div><div id="footer">
 163 <p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p>
 164 <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>
 165 </body></html>