granicus.if.org Git - apache/blob - docs/manual/mod/mod_dir.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>mod_dir - 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" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
  12 <script src="../style/scripts/prettify.js" type="text/javascript">
  13 </script>
  14
  15 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  16 <body>
  17 <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.5</p>
  20 <img alt="" src="../images/feather.gif" /></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.5</a> &gt; <a href="./">Modules</a></div>
  24 <div id="page-content">
  25 <div id="preamble"><h1>Apache Module mod_dir</h1>
  26 <div class="toplang">
  27 <p><span>Available Languages: </span><a href="../en/mod/mod_dir.html" title="English">&nbsp;en&nbsp;</a> |
  28 <a href="../fr/mod/mod_dir.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
  29 <a href="../ja/mod/mod_dir.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
  30 <a href="../ko/mod/mod_dir.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
  31 <a href="../tr/mod/mod_dir.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
  32 </div>
  33 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Provides for "trailing slash" redirects and
  34     serving directory index files</td></tr>
  35 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
  36 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>dir_module</td></tr>
  37 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_dir.c</td></tr></table>
  38 <h3>Summary</h3>
  39
  40     <p>The index of a directory can come from one of two sources:</p>
  41
  42     <ul>
  43       <li>A file written by the user, typically called
  44       <code>index.html</code>. The <code class="directive"><a href="#directoryindex">DirectoryIndex</a></code> directive sets the
  45       name of this file. This is controlled by
  46       <code class="module"><a href="../mod/mod_dir.html">mod_dir</a></code>.</li>
  47
  48       <li>Otherwise, a listing generated by the server. This is
  49       provided by <code class="module"><a href="../mod/mod_autoindex.html">mod_autoindex</a></code>.</li>
  50     </ul>
  51     <p>The two functions are separated so that you can completely
  52     remove (or replace) automatic index generation should you want
  53     to.</p>
  54
  55     <p>A "trailing slash" redirect is issued when the server
  56     receives a request for a URL
  57     <code>http://servername/foo/dirname</code> where
  58     <code>dirname</code> is a directory. Directories require a
  59     trailing slash, so <code class="module"><a href="../mod/mod_dir.html">mod_dir</a></code> issues a redirect to
  60     <code>http://servername/foo/dirname/</code>.</p>
  61 </div>
  62 <div id="quickview"><h3 class="directives">Directives</h3>
  63 <ul id="toc">
  64 <li><img alt="" src="../images/down.gif" /> <a href="#directoryindex">DirectoryIndex</a></li>
  65 <li><img alt="" src="../images/down.gif" /> <a href="#directoryindexredirect">DirectoryIndexRedirect</a></li>
  66 <li><img alt="" src="../images/down.gif" /> <a href="#directoryslash">DirectorySlash</a></li>
  67 <li><img alt="" src="../images/down.gif" /> <a href="#fallbackresource">FallbackResource</a></li>
  68 </ul>
  69 <ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
  70
  71 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  72 <div class="directive-section"><h2><a name="DirectoryIndex" id="DirectoryIndex">DirectoryIndex</a> <a name="directoryindex" id="directoryindex">Directive</a></h2>
  73 <table class="directive">
  74 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>List of resources to look for when the client requests
  75 a directory</td></tr>
  76 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DirectoryIndex
  77     disabled | <var>local-url</var> [<var>local-url</var>] ...</code></td></tr>
  78 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>DirectoryIndex index.html</code></td></tr>
  79 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
  80 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr>
  81 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
  82 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_dir</td></tr>
  83 </table>
  84     <p>The <code class="directive">DirectoryIndex</code> directive sets the
  85     list of resources to look for, when the client requests an index
  86     of the directory by specifying a / at the end of the directory
  87     name.  <var>Local-url</var> is the (%-encoded) URL of a document on
  88     the server relative to the requested directory; it is usually the
  89     name of a file in the directory. Several URLs may be given, in
  90     which case the server will return the first one that it finds.  If
  91     none of the resources exist and the <code>Indexes</code> option is
  92     set, the server will generate its own listing of the
  93     directory.</p>
  94
  95     <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">
  96       DirectoryIndex index.html
  97       </pre>
  98 </div>
  99
 100     <p>then a request for <code>http://example.com/docs/</code> would
 101     return <code>http://example.com/docs/index.html</code> if it
 102     exists, or would list the directory if it did not.</p>
 103
 104     <p>Note that the documents do not need to be relative to the
 105     directory;</p>
 106
 107     <pre class="prettyprint lang-config">
 108       DirectoryIndex index.html index.txt  /cgi-bin/index.pl
 109     </pre>
 110
 111
 112     <p>would cause the CGI script <code>/cgi-bin/index.pl</code> to be
 113     executed if neither <code>index.html</code> or <code>index.txt</code>
 114     existed in a directory.</p>
 115
 116     <p>A single argument of "disabled" prevents <code class="module"><a href="../mod/mod_dir.html">mod_dir</a></code> from
 117     searching for an index.  An argument of "disabled" will be interpreted
 118     literally if it has any arguments before or after it, even if they are "disabled"
 119     as well.</p>
 120
 121     <p><strong>Note:</strong> Multiple <code class="directive">DirectoryIndex</code>
 122     directives within the <a href="../sections.html"><em>same context</em></a> will add
 123     to the list of resources to look for rather than replace:
 124     </p>
 125     <pre class="prettyprint lang-config">
 126 # Example A: Set index.html as an index page, then add index.php to that list as well.
 127 &lt;Directory /foo&gt;
 128     DirectoryIndex index.html
 129     DirectoryIndex index.php
 130 &lt;/Directory&gt;
 131
 132 # Example B: This is identical to example A, except it's done with a single directive.
 133 &lt;Directory /foo&gt;
 134     DirectoryIndex index.html index.php
 135 &lt;/Directory&gt;
 136
 137 # Example C: To replace the list, you must explicitly reset it first:
 138 # In this example, only index.php will remain as an index resource.
 139 &lt;Directory /foo&gt;
 140     DirectoryIndex index.html
 141     DirectoryIndex disabled
 142     DirectoryIndex index.php
 143 &lt;/Directory&gt;
 144     </pre>
 145
 146
 147
 148 </div>
 149 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 150 <div class="directive-section"><h2><a name="DirectoryIndexRedirect" id="DirectoryIndexRedirect">DirectoryIndexRedirect</a> <a name="directoryindexredirect" id="directoryindexredirect">Directive</a></h2>
 151 <table class="directive">
 152 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures an external redirect for directory indexes.
 153 </td></tr>
 154 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DirectoryIndexRedirect on | off | permanent | temp | seeother |
 155 <var>3xx-code</var>
 156 </code></td></tr>
 157 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>DirectoryIndexRedirect off</code></td></tr>
 158 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 159 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr>
 160 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 161 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_dir</td></tr>
 162 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.3.14 and later</td></tr>
 163 </table>
 164     <p>By default, the <code class="directive">DirectoryIndex</code> is selected
 165     and returned transparently to the client.  <code class="directive">DirectoryIndexRedirect</code> causes an external redirect
 166     to instead be issued.</p>
 167
 168     <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">
 169       DirectoryIndexRedirect on
 170       </pre>
 171 </div>
 172
 173     <p>A request for <code>http://example.com/docs/</code> would
 174     return a temporary redirect to <code>http://example.com/docs/index.html</code>
 175     if it exists.</p>
 176
 177
 178 </div>
 179 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 180 <div class="directive-section"><h2><a name="DirectorySlash" id="DirectorySlash">DirectorySlash</a> <a name="directoryslash" id="directoryslash">Directive</a></h2>
 181 <table class="directive">
 182 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Toggle trailing slash redirects on or off</td></tr>
 183 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DirectorySlash On|Off</code></td></tr>
 184 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>DirectorySlash On</code></td></tr>
 185 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 186 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr>
 187 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 188 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_dir</td></tr>
 189 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.0.51 and later</td></tr>
 190 </table>
 191     <p>The <code class="directive">DirectorySlash</code> directive determines whether
 192     <code class="module"><a href="../mod/mod_dir.html">mod_dir</a></code> should fixup URLs pointing to a directory or
 193     not.</p>
 194
 195     <p>Typically if a user requests a resource without a trailing slash, which
 196     points to a directory, <code class="module"><a href="../mod/mod_dir.html">mod_dir</a></code> redirects him to the same
 197     resource, but <em>with</em> trailing slash for some good reasons:</p>
 198
 199     <ul>
 200     <li>The user is finally requesting the canonical URL of the resource</li>
 201     <li><code class="module"><a href="../mod/mod_autoindex.html">mod_autoindex</a></code> works correctly. Since it doesn't emit
 202     the path in the link, it would point to the wrong path.</li>
 203     <li><code class="directive"><a href="#directoryindex">DirectoryIndex</a></code> will be evaluated
 204     <em>only</em> for directories requested with trailing slash.</li>
 205     <li>Relative URL references inside html pages will work correctly.</li>
 206     </ul>
 207
 208     <p>If you don't want this effect <em>and</em> the reasons above don't
 209     apply to you, you can turn off the redirect as shown below. However,
 210     be aware that there are possible security implications to doing
 211     this.</p>
 212
 213     <pre class="prettyprint lang-config">
 214 # see security warning below!
 215 &lt;Location /some/path&gt;
 216     DirectorySlash Off
 217     SetHandler some-handler
 218 &lt;/Location&gt;
 219     </pre>
 220
 221
 222     <div class="warning"><h3>Security Warning</h3>
 223     <p>Turning off the trailing slash redirect may result in an information
 224     disclosure. Consider a situation where <code class="module"><a href="../mod/mod_autoindex.html">mod_autoindex</a></code> is
 225     active (<code>Options +Indexes</code>) and <code class="directive"><a href="#directoryindex">DirectoryIndex</a></code> is set to a valid resource (say,
 226     <code>index.html</code>) and there's no other special handler defined for
 227     that URL. In this case a request with a trailing slash would show the
 228     <code>index.html</code> file. <strong>But a request without trailing slash
 229     would list the directory contents</strong>.</p>
 230     </div>
 231         <p>Also note that some browsers may erroneously change POST requests into GET
 232         (thus discarding POST data) when a redirect is issued.</p>
 233
 234 </div>
 235 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 236 <div class="directive-section"><h2><a name="FallbackResource" id="FallbackResource">FallbackResource</a> <a name="fallbackresource" id="fallbackresource">Directive</a></h2>
 237 <table class="directive">
 238 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Define a default URL for requests that don't map to a file</td></tr>
 239 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>FallbackResource <var>local-url</var></code></td></tr>
 240 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>None - httpd will return 404 (Not Found)</code></td></tr>
 241 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 242 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr>
 243 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 244 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_dir</td></tr>
 245 </table>
 246     <p>Use this to set a handler for any URL that doesn't map to anything
 247     in your filesystem, and would otherwise return HTTP 404 (Not Found).
 248     For example</p>
 249     <pre class="prettyprint lang-config">
 250         FallbackResource /not-404.php
 251     </pre>
 252
 253     <p>will cause requests for non-existent files to be handled by
 254     <code>not-404.php</code>, while requests for files that exist
 255     are unaffected.</p>
 256     <p>It is frequently desirable to have a single file or resource
 257     handle all requests to a particular directory, except those requests
 258     that correspond to an existing file or script. This is often
 259     referred to as a 'front controller.'</p>
 260     <p>In earlier versions of httpd, this effect typically required
 261     <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>, and the use of the <code>-f</code> and
 262     <code>-d</code> tests for file and directory existence. This now
 263     requires only one line of configuration.</p>
 264     <pre class="prettyprint lang-config">
 265         FallbackResource /index.php
 266     </pre>
 267
 268     <p>Existing files, such as images, css files, and so on, will be
 269     served normally.</p>
 270     <p>In a sub-URI, such as <em>http://example.com/blog/</em> this
 271     <em>sub-URI</em> has to be supplied as <var>local-url</var>:</p>
 272     <pre class="prettyprint lang-config">
 273 &lt;Directory /web/example.com/htdocs/blog&gt;
 274     FallbackResource /blog/index.php
 275 &lt;/Directory&gt;
 276     </pre>
 277
 278
 279 </div>
 280 </div>
 281 <div class="bottomlang">
 282 <p><span>Available Languages: </span><a href="../en/mod/mod_dir.html" title="English">&nbsp;en&nbsp;</a> |
 283 <a href="../fr/mod/mod_dir.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
 284 <a href="../ja/mod/mod_dir.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 285 <a href="../ko/mod/mod_dir.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
 286 <a href="../tr/mod/mod_dir.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
 287 </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>
 288 <script type="text/javascript"><!--//--><![CDATA[//><!--
 289 var comments_shortname = 'httpd';
 290 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_dir.html';
 291 (function(w, d) {
 292     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 293         d.write('<div id="comments_thread"><\/div>');
 294         var s = d.createElement('script');
 295         s.type = 'text/javascript';
 296         s.async = true;
 297         s.src = 'https://c.apaste.info/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 298         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 299     }
 300     else {
 301         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 302     }
 303 })(window, document);
 304 //--><!]]></script></div><div id="footer">
 305 <p class="apache">Copyright 2012 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>
 306 <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[//><!--
 307 if (typeof(prettyPrint) !== 'undefined') {
 308     prettyPrint();
 309 }
 310 //--><!]]></script>
 311 </body></html>