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