granicus.if.org Git - apache/blob - docs/manual/mod/overrides.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE overrideindex SYSTEM "../style/modulesynopsis.dtd">
   3 <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
   4 <!-- $LastChangedRevision$ -->
   5
   6 <!--
   7  Licensed to the Apache Software Foundation (ASF) under one or more
   8  contributor license agreements.  See the NOTICE file distributed with
   9  this work for additional information regarding copyright ownership.
  10  The ASF licenses this file to You under the Apache License, Version 2.0
  11  (the "License"); you may not use this file except in compliance with
  12  the License.  You may obtain a copy of the License at
  13
  14      http://www.apache.org/licenses/LICENSE-2.0
  15
  16  Unless required by applicable law or agreed to in writing, software
  17  distributed under the License is distributed on an "AS IS" BASIS,
  18  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  19  See the License for the specific language governing permissions and
  20  limitations under the License.
  21 -->
  22
  23 <overrideindex metafile="overrides.xml.meta">
  24   <title>Override Class Index for .htaccess</title>
  25   <summary>
  26     <p>
  27       This is an index of the directives that are allowed in .htaccess files for
  28       various <directive module="core">AllowOverride</directive> settings,
  29       organized by class. Its intended purpose is to help server administrators
  30       verify the privileges they're granting to .htaccess users. For an overview
  31       of how .htaccess works, see the
  32       <a href="../howto/htaccess.html">.htaccess tutorial</a>.
  33     </p>
  34
  35     <p>
  36       To determine the set of directives that your server configuration allows
  37       .htaccess users to use:
  38     </p>
  39
  40     <ol>
  41       <li>Start with the set of directives in the <code>AllowOverrideList</code>
  42       for the directory in question. (By default, this is set to
  43       <code>None</code>.)</li>
  44       <li>Find the <code>AllowOverride</code> setting for the directory in
  45       question. (By default, it is set to <code>None</code>.) There are two
  46       special cases:
  47         <ol>
  48           <li>If your <code>AllowOverride</code> setting is <code>All</code>,
  49           add every directive listed on this page to the list.</li>
  50           <li>If your <code>AllowOverride</code> setting is <code>None</code>,
  51           you're done. Only the directives in the <code>AllowOverrideList</code>
  52           (if any) will be allowed.</li>
  53         </ol>
  54       </li>
  55       <li>For each override class listed in <code>AllowOverride</code>, look up
  56       the corresponding set of directives below and add them to the list.</li>
  57       <li>Finally, add the set of directives that is always allowed in
  58       .htaccess (these are listed in the
  59       <a href="#override-all">All section</a>, below).</li>
  60     </ol>
  61
  62     <p>
  63       Several of the override classes are quite powerful and give .htaccess
  64       users a large amount of control over the server. For a stricter approach,
  65       set <code>AllowOverride None</code> and use
  66       <directive module="core">AllowOverrideList</directive> to specify the
  67       exact list of directives that .htaccess users are allowed to use.
  68     </p>
  69   </summary>
  70
  71   <!--
  72     Provide one overridesummary element for each Override type. The content will
  73     be sucked into the relevant section on the override index page.
  74   -->
  75
  76   <overridesummary class="All">
  77     <p>
  78       The following directives are allowed in any .htaccess file, as long as
  79       overrides are enabled in the server configuration.
  80     </p>
  81   </overridesummary>
  82
  83   <overridesummary class="AuthConfig">
  84     <p>
  85       The following directives are allowed in .htaccess files when
  86       <code>AllowOverride AuthConfig</code> is in effect. They give .htaccess
  87       users control over the authentication and authorization methods that are
  88       applied to their directory subtrees, including several related utility
  89       directives for session handling and TLS settings.
  90     </p>
  91   </overridesummary>
  92
  93   <overridesummary class="FileInfo">
  94     <p>
  95       The following directives are allowed in .htaccess files when
  96       <code>AllowOverride FileInfo</code> is in effect. They give .htaccess
  97       users a wide range of control over the responses and metadata given by the
  98       server.
  99     </p>
 100   </overridesummary>
 101
 102   <overridesummary class="Indexes">
 103     <p>
 104       The following directives are allowed in .htaccess files when
 105       <code>AllowOverride Indexes</code> is in effect. They allow .htaccess
 106       users to control aspects of the directory index pages provided by the
 107       server, including autoindex generation.
 108     </p>
 109   </overridesummary>
 110
 111   <overridesummary class="Limit">
 112     <p>
 113       The following directives are allowed in .htaccess files when
 114       <code>AllowOverride Limit</code> is in effect. This extremely narrow
 115       override type mostly allows the use of the legacy authorization directives
 116       provided by <module>mod_access_compat</module>.
 117     </p>
 118   </overridesummary>
 119
 120   <overridesummary class="Options">
 121     <p>
 122       The following directives are allowed in .htaccess files when
 123       <code>AllowOverride Options</code> is in effect. They give .htaccess
 124       users access to <code>Options</code> and similar directives, as well as
 125       directives that control the filter chain.
 126     </p>
 127   </overridesummary>
 128
 129   <!--
 130     This is the error message for when a directive shows up in a section that
 131     has no explicit overridesummary above.
 132   -->
 133   <overridesummary fallback="yes">
 134     <p><em>
 135     [This section has no description. It's possible that the documentation is
 136     incomplete, or that the directives here have an incorrect or misspelled
 137     Override type. Please consider reporting this in the
 138     <a href="#comments_section">comments section</a>.]
 139     </em></p>
 140   </overridesummary>
 141 </overrideindex>