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

   1 <?xml version="1.0"?>
   2 <!DOCTYPE modulesynopsis 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 <modulesynopsis metafile="mod_dir.xml.meta">
  24 <name>mod_dir</name>
  25 <description>Provides for "trailing slash" redirects and
  26     serving directory index files</description>
  27 <status>Base</status>
  28 <sourcefile>mod_dir.c</sourcefile>
  29 <identifier>dir_module</identifier>
  30
  31 <summary>
  32     <p>The index of a directory can come from one of two sources:</p>
  33
  34     <ul>
  35       <li>A file written by the user, typically called
  36       <code>index.html</code>. The <directive module="mod_dir"
  37       >DirectoryIndex</directive> directive sets the
  38       name of this file. This is controlled by
  39       <module>mod_dir</module>.</li>
  40
  41       <li>Otherwise, a listing generated by the server. This is
  42       provided by <module>mod_autoindex</module>.</li>
  43     </ul>
  44     <p>The two functions are separated so that you can completely
  45     remove (or replace) automatic index generation should you want
  46     to.</p>
  47
  48     <p>A "trailing slash" redirect is issued when the server
  49     receives a request for a URL
  50     <code>http://servername/foo/dirname</code> where
  51     <code>dirname</code> is a directory. Directories require a
  52     trailing slash, so <module>mod_dir</module> issues a redirect to
  53     <code>http://servername/foo/dirname/</code>.</p>
  54 </summary>
  55
  56 <directivesynopsis>
  57 <name>DirectoryIndex</name>
  58 <description>List of resources to look for when the client requests
  59 a directory</description>
  60 <syntax>DirectoryIndex
  61     disabled | <var>local-url</var> [<var>local-url</var>] ...</syntax>
  62 <default>DirectoryIndex index.html</default>
  63 <contextlist><context>server config</context><context>virtual host</context>
  64 <context>directory</context><context>.htaccess</context></contextlist>
  65 <override>Indexes</override>
  66
  67 <usage>
  68     <p>The <directive>DirectoryIndex</directive> directive sets the
  69     list of resources to look for, when the client requests an index
  70     of the directory by specifying a / at the end of the directory
  71     name.  <var>Local-url</var> is the (%-encoded) URL of a document on
  72     the server relative to the requested directory; it is usually the
  73     name of a file in the directory. Several URLs may be given, in
  74     which case the server will return the first one that it finds.  If
  75     none of the resources exist and the <code>Indexes</code> option is
  76     set, the server will generate its own listing of the
  77     directory.</p>
  78
  79     <example><title>Example</title>
  80     <highlight language="config">
  81       DirectoryIndex index.html
  82       </highlight>
  83     </example>
  84
  85     <p>then a request for <code>http://example.com/docs/</code> would
  86     return <code>http://example.com/docs/index.html</code> if it
  87     exists, or would list the directory if it did not.</p>
  88
  89     <p>Note that the documents do not need to be relative to the
  90     directory;</p>
  91
  92     <highlight language="config">
  93       DirectoryIndex index.html index.txt  /cgi-bin/index.pl
  94     </highlight>
  95
  96     <p>would cause the CGI script <code>/cgi-bin/index.pl</code> to be
  97     executed if neither <code>index.html</code> or <code>index.txt</code>
  98     existed in a directory.</p>
  99
 100     <p>A single argument of "disabled" prevents <module>mod_dir</module> from
 101     searching for an index.  An argument of "disabled" will be interpreted
 102     literally if it has any arguments before or after it, even if they are "disabled"
 103     as well.</p>
 104
 105     <p><strong>Note:</strong> Multiple <directive>DirectoryIndex</directive>
 106     directives within the <a href="../sections.html"><em>same context</em></a> will add
 107     to the list of resources to look for rather than replace:
 108     </p>
 109     <highlight language="config">
 110 # Example A: Set index.html as an index page, then add index.php to that list as well.
 111 &lt;Directory /foo&gt;
 112     DirectoryIndex index.html
 113     DirectoryIndex index.php
 114 &lt;/Directory&gt;
 115
 116 # Example B: This is identical to example A, except it's done with a single directive.
 117 &lt;Directory /foo&gt;
 118     DirectoryIndex index.html index.php
 119 &lt;/Directory&gt;
 120
 121 # Example C: To replace the list, you must explicitly reset it first:
 122 # In this example, only index.php will remain as an index resource.
 123 &lt;Directory /foo&gt;
 124     DirectoryIndex index.html
 125     DirectoryIndex disabled
 126     DirectoryIndex index.php
 127 &lt;/Directory&gt;
 128     </highlight>
 129
 130 </usage>
 131 </directivesynopsis>
 132
 133 <directivesynopsis>
 134 <name>DirectoryIndexRedirect</name>
 135 <description>Configures an external redirect for directory indexes.
 136 </description>
 137 <syntax>DirectoryIndexRedirect on | off | permanent | temp | seeother |
 138 <var>3xx-code</var>
 139 </syntax>
 140 <default>DirectoryIndexRedirect off</default>
 141 <contextlist><context>server config</context><context>virtual host</context>
 142 <context>directory</context><context>.htaccess</context></contextlist>
 143 <override>Indexes</override>
 144 <compatibility>Available in version 2.3.14 and later</compatibility>
 145
 146 <usage>
 147     <p>By default, the <directive>DirectoryIndex</directive> is selected
 148     and returned transparently to the client.  <directive
 149     >DirectoryIndexRedirect</directive> causes an external redirect
 150     to instead be issued.</p>
 151
 152     <example><title>Example</title>
 153     <highlight language="config">
 154       DirectoryIndexRedirect on
 155       </highlight>
 156     </example>
 157
 158     <p>A request for <code>http://example.com/docs/</code> would
 159     return a temporary redirect to <code
 160     >http://example.com/docs/index.html</code>
 161     if it exists.</p>
 162
 163 </usage>
 164 </directivesynopsis>
 165
 166
 167 <directivesynopsis>
 168 <name>DirectorySlash</name>
 169 <description>Toggle trailing slash redirects on or off</description>
 170 <syntax>DirectorySlash On|Off</syntax>
 171 <default>DirectorySlash On</default>
 172 <contextlist><context>server config</context><context>virtual host</context>
 173 <context>directory</context><context>.htaccess</context></contextlist>
 174 <override>Indexes</override>
 175
 176 <usage>
 177     <p>The <directive>DirectorySlash</directive> directive determines whether
 178     <module>mod_dir</module> should fixup URLs pointing to a directory or
 179     not.</p>
 180
 181     <p>Typically if a user requests a resource without a trailing slash, which
 182     points to a directory, <module>mod_dir</module> redirects him to the same
 183     resource, but <em>with</em> trailing slash for some good reasons:</p>
 184
 185     <ul>
 186     <li>The user is finally requesting the canonical URL of the resource</li>
 187     <li><module>mod_autoindex</module> works correctly. Since it doesn't emit
 188     the path in the link, it would point to the wrong path.</li>
 189     <li><directive module="mod_dir">DirectoryIndex</directive> will be evaluated
 190     <em>only</em> for directories requested with trailing slash.</li>
 191     <li>Relative URL references inside html pages will work correctly.</li>
 192     </ul>
 193
 194     <p>If you don't want this effect <em>and</em> the reasons above don't
 195     apply to you, you can turn off the redirect as shown below. However,
 196     be aware that there are possible security implications to doing
 197     this.</p>
 198
 199     <highlight language="config">
 200 # see security warning below!
 201 &lt;Location /some/path&gt;
 202     DirectorySlash Off
 203     SetHandler some-handler
 204 &lt;/Location&gt;
 205     </highlight>
 206
 207     <note type="warning"><title>Security Warning</title>
 208     <p>Turning off the trailing slash redirect may result in an information
 209     disclosure. Consider a situation where <module>mod_autoindex</module> is
 210     active (<code>Options +Indexes</code>) and <directive module="mod_dir"
 211     >DirectoryIndex</directive> is set to a valid resource (say,
 212     <code>index.html</code>) and there's no other special handler defined for
 213     that URL. In this case a request with a trailing slash would show the
 214     <code>index.html</code> file. <strong>But a request without trailing slash
 215     would list the directory contents</strong>.</p>
 216     </note>
 217         <p>Also note that some browsers may erroneously change POST requests into GET
 218         (thus discarding POST data) when a redirect is issued.</p>
 219 </usage>
 220 </directivesynopsis>
 221 <directivesynopsis>
 222 <name>FallbackResource</name>
 223 <description>Define a default URL for requests that don't map to a file</description>
 224 <syntax>FallbackResource disabled | <var>local-url</var></syntax>
 225 <default>disabled - httpd will return 404 (Not Found)</default>
 226 <contextlist><context>server config</context><context>virtual host</context>
 227 <context>directory</context><context>.htaccess</context></contextlist>
 228 <override>Indexes</override>
 229 <usage>
 230     <p>Use this to set a handler for any URL that doesn't map to anything
 231     in your filesystem, and would otherwise return HTTP 404 (Not Found).
 232     For example</p>
 233     <highlight language="config">
 234         FallbackResource /not-404.php
 235     </highlight>
 236     <p>will cause requests for non-existent files to be handled by
 237     <code>not-404.php</code>, while requests for files that exist
 238     are unaffected.</p>
 239     <p>It is frequently desirable to have a single file or resource
 240     handle all requests to a particular directory, except those requests
 241     that correspond to an existing file or script. This is often
 242     referred to as a 'front controller.'</p>
 243     <p>In earlier versions of httpd, this effect typically required
 244     <module>mod_rewrite</module>, and the use of the <code>-f</code> and
 245     <code>-d</code> tests for file and directory existence. This now
 246     requires only one line of configuration.</p>
 247     <highlight language="config">
 248         FallbackResource /index.php
 249     </highlight>
 250     <p>Existing files, such as images, css files, and so on, will be
 251     served normally.</p>
 252     <p>Use the <code>disabled</code> argument to disable that feature
 253     if inheritance from a parent directory is not desired.</p>
 254     <p>In a sub-URI, such as <em>http://example.com/blog/</em> this
 255     <em>sub-URI</em> has to be supplied as <var>local-url</var>:</p>
 256     <highlight language="config">
 257 &lt;Directory /web/example.com/htdocs/blog&gt;
 258     FallbackResource /blog/index.php
 259 &lt;/Directory&gt;
 260 &lt;Directory /web/example.com/htdocs/blog/images&gt;
 261     FallbackResource disabled
 262 &lt;/Directory&gt;
 263     </highlight>
 264 </usage>
 265 </directivesynopsis>
 266
 267 </modulesynopsis>