github.com/krum110487/go-htaccess@v0.0.0-20240316004156-60641c8e7598/tests/data/apache_2_2_34/manual/configuring.html.en (about)

     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.2</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" /><link href="http://httpd.apache.org/docs/current/configuring.html" rel="canonical" /></head>
    18  <body id="manual-page"><div id="page-header">
    19  <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>
    20  <p class="apache">Apache HTTP Server Version 2.2</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.2</a></div><div id="page-content"><div class="retired"><h4>Please note</h4>
    25              <p> This document refers to a legacy release (<strong>2.2</strong>) of Apache httpd. The active release (<strong>2.4</strong>) is documented <a href="http://httpd.apache.org/docs/current">here</a>. If you have not already upgraded, please follow <a href="http://httpd.apache.org/docs/current/upgrading.html">this link</a> for more information.</p>
    26          <p>You may follow <a href="http://httpd.apache.org/docs/current/configuring.html">this link</a> to go to the current version of this document.</p></div><div id="preamble"><h1>Configuration Files</h1>
    27  <div class="toplang">
    28  <p><span>Available Languages: </span><a href="./de/configuring.html" hreflang="de" rel="alternate" title="Deutsch">&nbsp;de&nbsp;</a> |
    29  <a href="./en/configuring.html" title="English">&nbsp;en&nbsp;</a> |
    30  <a href="./fr/configuring.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
    31  <a href="./ja/configuring.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
    32  <a href="./ko/configuring.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
    33  <a href="./tr/configuring.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
    34  </div>
    35  
    36  <p>This document describes the files used to configure the Apache
    37  HTTP server.</p>
    38  </div>
    39  <div id="quickview"><ul id="toc"><li><img alt="" src="./images/down.gif" /> <a href="#main">Main Configuration Files</a></li>
    40  <li><img alt="" src="./images/down.gif" /> <a href="#syntax">Syntax of the Configuration Files</a></li>
    41  <li><img alt="" src="./images/down.gif" /> <a href="#modules">Modules</a></li>
    42  <li><img alt="" src="./images/down.gif" /> <a href="#scope">Scope of Directives</a></li>
    43  <li><img alt="" src="./images/down.gif" /> <a href="#htaccess">.htaccess Files</a></li>
    44  </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
    45  <div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
    46  <div class="section">
    47  <h2><a name="main" id="main">Main Configuration Files</a></h2>
    48      
    49      <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>
    50  
    51      <p>Apache is configured by placing <a href="mod/directives.html">directives</a> in plain text
    52      configuration files. The main configuration file is usually called
    53      <code>httpd.conf</code>. The location of this file is set at
    54      compile-time, but may be overridden with the <code>-f</code>
    55      command line flag. In addition, other configuration files may be
    56      added using the <code class="directive"><a href="./mod/core.html#include">Include</a></code>
    57      directive, and wildcards can be used to include many configuration
    58      files. Any directive may be placed in any of these configuration
    59      files.  Changes to the main configuration files are only
    60      recognized by Apache when it is started or restarted.</p>
    61  
    62      <p>The server also reads a file containing mime document types;
    63      the filename is set by the <code class="directive"><a href="./mod/mod_mime.html#typesconfig">TypesConfig</a></code> directive,
    64      and is <code>mime.types</code> by default.</p>
    65    </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
    66  <div class="section">
    67  <h2><a name="syntax" id="syntax">Syntax of the Configuration Files</a></h2>
    68      
    69  
    70      <p>Apache configuration files contain one directive per line.
    71      The backslash "\" may be used as the last character on a line
    72      to indicate that the directive continues onto the next line.
    73      There must be no other characters or white space between the
    74      backslash and the end of the line.</p>
    75  
    76      <p>Directives in the configuration files are case-insensitive,
    77      but arguments to directives are often case sensitive. Lines
    78      that begin with the hash character "#" are considered
    79      comments, and are ignored. Comments may <strong>not</strong> be
    80      included on the same line as a configuration directive. 
    81      White space occurring before a directive is ignored, so
    82      you may indent directives for clarity. Blank lines are also ignored.</p>
    83  
    84      <p>The values of shell environment variables can be used in
    85      configuration file lines using the syntax <code>${ENVVAR}</code>.
    86      If "ENVVAR" is the name of a valid environment variable, the value
    87      of that variable is substituted into that spot in the
    88      configuration file line, and processing continues as if that text
    89      were found directly in the configuration file.  (If the ENVVAR
    90      variable is not found, the characters "${ENVVAR}" are left
    91      unchanged for use by later stages in the config file
    92      processing.)</p>
    93  
    94      <p>The maximum length of a line in the configuration file, after
    95      environment-variable substitution, joining any continued lines and
    96      removing leading and trailing white space, is 8192 characters.</p>
    97  
    98      <p>You can check your configuration files for syntax errors
    99      without starting the server by using <code>apachectl
   100      configtest</code> or the <code>-t</code> command line
   101      option.</p>
   102    </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
   103  <div class="section">
   104  <h2><a name="modules" id="modules">Modules</a></h2>
   105      
   106  
   107      <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>
   108  
   109      <p>Apache 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 Apache. 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, Apache 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.</p>
   121  
   122      <p>To see which modules are currently compiled into the server,
   123      you can use the <code>-l</code> command line option.</p>
   124    </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
   125  <div class="section">
   126  <h2><a name="scope" id="scope">Scope of Directives</a></h2>
   127      
   128  
   129      <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>
   130  
   131      <p>Directives placed in the main configuration files apply to
   132      the entire server. If you wish to change the configuration for
   133      only a part of the server, you can scope your directives by
   134      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>
   135      sections. These sections limit the application of the
   136      directives which they enclose to particular filesystem
   137      locations or URLs. They can also be nested, allowing for very
   138      fine grained configuration.</p>
   139  
   140      <p>Apache 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  
   147      <p>Although most directives can be placed in any of these
   148      sections, some directives do not make sense in some contexts.
   149      For example, directives controlling process creation can only
   150      be placed in the main server context. To find which directives
   151      can be placed in which sections, check the <a href="mod/directive-dict.html#Context">Context</a> of the
   152      directive. For further information, we provide details on <a href="sections.html">How Directory, Location and Files sections
   153      work</a>.</p>
   154    </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
   155  <div class="section">
   156  <h2><a name="htaccess" id="htaccess">.htaccess Files</a></h2>
   157      
   158  
   159      <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>
   160  
   161      <p>Apache allows for decentralized management of configuration
   162      via special files placed inside the web tree. The special files
   163      are usually called <code>.htaccess</code>, but any name can be
   164      specified in the <code class="directive"><a href="./mod/core.html#accessfilename">AccessFileName</a></code>
   165      directive. Directives placed in <code>.htaccess</code> files
   166      apply to the directory where you place the file, and all
   167      sub-directories. The <code>.htaccess</code> files follow the
   168      same syntax as the main configuration files. Since
   169      <code>.htaccess</code> files are read on every request, changes
   170      made in these files take immediate effect.</p>
   171  
   172      <p>To find which directives can be placed in
   173      <code>.htaccess</code> files, check the <a href="mod/directive-dict.html#Context">Context</a> of the
   174      directive. The server administrator further controls what
   175      directives may be placed in <code>.htaccess</code> files by
   176      configuring the <code class="directive"><a href="./mod/core.html#allowoverride">AllowOverride</a></code>
   177      directive in the main configuration files.</p>
   178  
   179      <p>For more information on <code>.htaccess</code> files, see
   180      the <a href="howto/htaccess.html">.htaccess tutorial</a>.</p>
   181    </div></div>
   182  <div class="bottomlang">
   183  <p><span>Available Languages: </span><a href="./de/configuring.html" hreflang="de" rel="alternate" title="Deutsch">&nbsp;de&nbsp;</a> |
   184  <a href="./en/configuring.html" title="English">&nbsp;en&nbsp;</a> |
   185  <a href="./fr/configuring.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
   186  <a href="./ja/configuring.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
   187  <a href="./ko/configuring.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
   188  <a href="./tr/configuring.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
   189  </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>
   190  <script type="text/javascript"><!--//--><![CDATA[//><!--
   191  var comments_shortname = 'httpd';
   192  var comments_identifier = 'http://httpd.apache.org/docs/2.2/configuring.html';
   193  (function(w, d) {
   194      if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
   195          d.write('<div id="comments_thread"><\/div>');
   196          var s = d.createElement('script');
   197          s.type = 'text/javascript';
   198          s.async = true;
   199          s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
   200          (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
   201      }
   202      else { 
   203          d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
   204      }
   205  })(window, document);
   206  //--><!]]></script></div><div id="footer">
   207  <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>
   208  <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[//><!--
   209  if (typeof(prettyPrint) !== 'undefined') {
   210      prettyPrint();
   211  }
   212  //--><!]]></script>
   213  </body></html>