| <?xml version="1.0" encoding="ISO-8859-1"?> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head> |
| <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" /> |
| <meta content="noindex, nofollow" name="robots" /> |
| <!-- |
| XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| This file is generated from xml source: DO NOT EDIT |
| XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| --> |
| <title>mod_dir - Apache HTTP Server</title> |
| <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" /> |
| <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" /> |
| <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /> |
| <link href="../images/favicon.ico" rel="shortcut icon" /><link href="http://httpd.apache.org/docs/current/mod/mod_dir.html" rel="canonical" /></head> |
| <body> |
| <div id="page-header"> |
| <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> |
| <p class="apache">Apache HTTP Server Version 2.0</p> |
| <img alt="" src="../images/feather.gif" /></div> |
| <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div> |
| <div id="path"> |
| <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.0</a> > <a href="./">Modules</a></div> |
| <div id="page-content"> |
| <div class="retired"><h4>Please note</h4> |
| <p>This document refers to the <strong>2.0</strong> version of Apache httpd, which <strong>is no longer maintained</strong>. Upgrade, and refer to the current version of httpd instead, documented at:</p> |
| <ul><li><a href="http://httpd.apache.org/docs/current/">Current release version of Apache HTTP Server documentation</a></li></ul><p>You may follow <a href="http://httpd.apache.org/docs/current/mod/mod_dir.html">this link</a> to go to the current version of this document.</p></div><div id="preamble"><h1>Apache Module mod_dir</h1> |
| <div class="toplang"> |
| <p><span>Available Languages: </span><a href="../en/mod/mod_dir.html" title="English"> en </a> | |
| <a href="../ja/mod/mod_dir.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> | |
| <a href="../ko/mod/mod_dir.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> | |
| <a href="../tr/mod/mod_dir.html" hreflang="tr" rel="alternate" title="Türkçe"> tr </a></p> |
| </div> |
| <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Provides for "trailing slash" redirects and |
| serving directory index files</td></tr> |
| <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr> |
| <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>dir_module</td></tr> |
| <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_dir.c</td></tr></table> |
| <h3>Summary</h3> |
| |
| <p>The index of a directory can come from one of two sources:</p> |
| |
| <ul> |
| <li>A file written by the user, typically called |
| <code>index.html</code>. The <code class="directive"><a href="#directoryindex">DirectoryIndex</a></code> directive sets the |
| name of this file. This is controlled by |
| <code class="module"><a href="../mod/mod_dir.html">mod_dir</a></code>.</li> |
| |
| <li>Otherwise, a listing generated by the server. This is |
| provided by <code class="module"><a href="../mod/mod_autoindex.html">mod_autoindex</a></code>.</li> |
| </ul> |
| <p>The two functions are separated so that you can completely |
| remove (or replace) automatic index generation should you want |
| to.</p> |
| |
| <p>A "trailing slash" redirect is issued when the server |
| receives a request for a URL |
| <code>http://servername/foo/dirname</code> where |
| <code>dirname</code> is a directory. Directories require a |
| trailing slash, so <code class="module"><a href="../mod/mod_dir.html">mod_dir</a></code> issues a redirect to |
| <code>http://servername/foo/dirname/</code>.</p> |
| </div> |
| <div id="quickview"><h3 class="directives">Directives</h3> |
| <ul id="toc"> |
| <li><img alt="" src="../images/down.gif" /> <a href="#directoryindex">DirectoryIndex</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#directoryslash">DirectorySlash</a></li> |
| </ul> |
| </div> |
| |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="directive-section"><h2><a name="DirectoryIndex" id="DirectoryIndex">DirectoryIndex</a> <a name="directoryindex" id="directoryindex">Directive</a></h2> |
| <table class="directive"> |
| <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>List of resources to look for when the client requests |
| a directory</td></tr> |
| <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DirectoryIndex |
| <var>local-url</var> [<var>local-url</var>] ...</code></td></tr> |
| <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>DirectoryIndex index.html</code></td></tr> |
| <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr> |
| <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr> |
| <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> |
| <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_dir</td></tr> |
| </table> |
| <p>The <code class="directive">DirectoryIndex</code> directive sets the |
| list of resources to look for, when the client requests an index |
| of the directory by specifying a / at the end of the directory |
| name. <var>Local-url</var> is the (%-encoded) URL of a document on |
| the server relative to the requested directory; it is usually the |
| name of a file in the directory. Several URLs may be given, in |
| which case the server will return the first one that it finds. If |
| none of the resources exist and the <code>Indexes</code> option is |
| set, the server will generate its own listing of the |
| directory.</p> |
| |
| <div class="example"><h3>Example</h3><p><code> |
| DirectoryIndex index.html |
| </code></p></div> |
| |
| <p>then a request for <code>http://myserver/docs/</code> would |
| return <code>http://myserver/docs/index.html</code> if it |
| exists, or would list the directory if it did not.</p> |
| |
| <p>Note that the documents do not need to be relative to the |
| directory;</p> |
| |
| <div class="example"><p><code> |
| DirectoryIndex index.html index.txt /cgi-bin/index.pl |
| </code></p></div> |
| |
| <p>would cause the CGI script <code>/cgi-bin/index.pl</code> to be |
| executed if neither <code>index.html</code> or <code>index.txt</code> |
| existed in a directory.</p> |
| |
| </div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="directive-section"><h2><a name="DirectorySlash" id="DirectorySlash">DirectorySlash</a> <a name="directoryslash" id="directoryslash">Directive</a></h2> |
| <table class="directive"> |
| <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Toggle trailing slash redirects on or off</td></tr> |
| <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DirectorySlash On|Off</code></td></tr> |
| <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>DirectorySlash On</code></td></tr> |
| <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr> |
| <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr> |
| <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> |
| <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_dir</td></tr> |
| <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.0.51 and later</td></tr> |
| </table> |
| <p>The <code class="directive">DirectorySlash</code> directive determines, whether |
| <code class="module"><a href="../mod/mod_dir.html">mod_dir</a></code> should fixup URLs pointing to a directory or |
| not.</p> |
| |
| <p>Typically if a user requests a resource without a trailing slash, which |
| points to a directory, <code class="module"><a href="../mod/mod_dir.html">mod_dir</a></code> redirects him to the same |
| resource, but <em>with</em> trailing slash for some good reasons:</p> |
| |
| <ul> |
| <li>The user is finally requesting the canonical URL of the resource</li> |
| <li><code class="module"><a href="../mod/mod_autoindex.html">mod_autoindex</a></code> works correctly. Since it doesn't emit |
| the path in the link, it would point to the wrong path.</li> |
| <li><code class="directive"><a href="#directoryindex">DirectoryIndex</a></code> will be evaluated |
| <em>only</em> for directories requested with trailing slash.</li> |
| <li>Relative URL references inside html pages will work correctly.</li> |
| </ul> |
| |
| <p>Well, if you don't want this effect <em>and</em> the reasons above don't |
| apply to you, you can turn off the redirect with:</p> |
| |
| <div class="example"><p><code> |
| # see security warning below!<br /> |
| <Location /some/path><br /> |
| <span class="indent"> |
| DirectorySlash Off<br /> |
| SetHandler some-handler<br /> |
| </span> |
| </Location> |
| </code></p></div> |
| |
| <div class="warning"><h3>Security Warning</h3> |
| <p>Turning off the trailing slash redirect may result in an information |
| disclosure. Consider a situation where <code class="module"><a href="../mod/mod_autoindex.html">mod_autoindex</a></code> is |
| active (<code>Options +Indexes</code>) and <code class="directive"><a href="#directoryindex">DirectoryIndex</a></code> is set to a valid resource (say, |
| <code>index.html</code>) and there's no other special handler defined for |
| that URL. In this case a request with a trailing slash would show the |
| <code>index.html</code> file. <strong>But a request without trailing slash |
| would list the directory contents</strong>.</p> |
| </div> |
| |
| </div> |
| </div> |
| <div class="bottomlang"> |
| <p><span>Available Languages: </span><a href="../en/mod/mod_dir.html" title="English"> en </a> | |
| <a href="../ja/mod/mod_dir.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> | |
| <a href="../ko/mod/mod_dir.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> | |
| <a href="../tr/mod/mod_dir.html" hreflang="tr" rel="alternate" title="Türkçe"> tr </a></p> |
| </div><div id="footer"> |
| <p class="apache">Copyright 2013 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> |
| <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> |
| </body></html> |
