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.min.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.4</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.4</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="/fr/mod/mod_dir.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a> | 29<a href="/ja/mod/mod_dir.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> | 30<a href="/ko/mod/mod_dir.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> | 31<a href="/tr/mod/mod_dir.html" hreflang="tr" rel="alternate" title="T�rk�e"> tr </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="#directorycheckhandler">DirectoryCheckHandler</a></li> 65<li><img alt="" src="/images/down.gif" /> <a href="#directoryindex">DirectoryIndex</a></li> 66<li><img alt="" src="/images/down.gif" /> <a href="#directoryindexredirect">DirectoryIndexRedirect</a></li> 67<li><img alt="" src="/images/down.gif" /> <a href="#directoryslash">DirectorySlash</a></li> 68<li><img alt="" src="/images/down.gif" /> <a href="#fallbackresource">FallbackResource</a></li> 69</ul> 70<ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> 71 72<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 73<div class="directive-section"><h2><a name="DirectoryCheckHandler" id="DirectoryCheckHandler">DirectoryCheckHandler</a> <a name="directorycheckhandler" id="directorycheckhandler">Directive</a></h2> 74<table class="directive"> 75<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Toggle how this module responds when another handler is configured</td></tr> 76<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DirectoryCheckHandler On|Off</code></td></tr> 77<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>DirectoryCheckHandler Off</code></td></tr> 78<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr> 79<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr> 80<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> 81<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_dir</td></tr> 82<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in 2.4.8 and later. Releases prior to 2.4 implicitly 83act as if "DirectoryCheckHandler Off" was specified.</td></tr> 84</table> 85 <p>The <code class="directive">DirectoryCheckHandler</code> directive determines 86 whether <code class="module"><a href="/mod/mod_dir.html">mod_dir</a></code> should check for directory indexes or 87 add trailing slashes when some other handler has been configured for 88 the current URL. Handlers can be set by directives such as 89 <code class="directive"><a href="/mod/core.html#sethandler">SetHandler</a></code> or by other modules, 90 such as <code class="module"><a href="/mod/mod_rewrite.html">mod_rewrite</a></code> during per-directory substitutions. 91 </p> 92 93 <p> In releases prior to 2.4, this module did not take any action if any 94 other handler was configured for a URL. This allows directory indexes to 95 be served even when a <code class="directive">SetHandler</code> directive is 96 specified for an entire directory, but it can also result in some conflicts 97 with modules such as <code class="directive">mod_rewrite</code>.</p> 98 99</div> 100<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 101<div class="directive-section"><h2><a name="DirectoryIndex" id="DirectoryIndex">DirectoryIndex</a> <a name="directoryindex" id="directoryindex">Directive</a></h2> 102<table class="directive"> 103<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>List of resources to look for when the client requests 104a directory</td></tr> 105<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DirectoryIndex 106 disabled | <var>local-url</var> [<var>local-url</var>] ...</code></td></tr> 107<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>DirectoryIndex index.html</code></td></tr> 108<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr> 109<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr> 110<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> 111<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_dir</td></tr> 112</table> 113 <p>The <code class="directive">DirectoryIndex</code> directive sets the 114 list of resources to look for, when the client requests an index 115 of the directory by specifying a / at the end of the directory 116 name. <var>Local-url</var> is the (%-encoded) URL of a document on 117 the server relative to the requested directory; it is usually the 118 name of a file in the directory. Several URLs may be given, in 119 which case the server will return the first one that it finds. If 120 none of the resources exist and the <code>Indexes</code> option is 121 set, the server will generate its own listing of the 122 directory.</p> 123 124 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">DirectoryIndex index.html</pre> 125</div> 126 127 <p>then a request for <code>http://example.com/docs/</code> would 128 return <code>http://example.com/docs/index.html</code> if it 129 exists, or would list the directory if it did not.</p> 130 131 <p>Note that the documents do not need to be relative to the 132 directory;</p> 133 134 <pre class="prettyprint lang-config">DirectoryIndex index.html index.txt /cgi-bin/index.pl</pre> 135 136 137 <p>would cause the CGI script <code>/cgi-bin/index.pl</code> to be 138 executed if neither <code>index.html</code> or <code>index.txt</code> 139 existed in a directory.</p> 140 141 <p>A single argument of "disabled" prevents <code class="module"><a href="/mod/mod_dir.html">mod_dir</a></code> from 142 searching for an index. An argument of "disabled" will be interpreted 143 literally if it has any arguments before or after it, even if they are "disabled" 144 as well.</p> 145 146 <p><strong>Note:</strong> Multiple <code class="directive">DirectoryIndex</code> 147 directives within the <a href="/sections.html"><em>same context</em></a> will add 148 to the list of resources to look for rather than replace: 149 </p> 150 <pre class="prettyprint lang-config"># Example A: Set index.html as an index page, then add index.php to that list as well. 151<Directory /foo> 152 DirectoryIndex index.html 153 DirectoryIndex index.php 154</Directory> 155 156# Example B: This is identical to example A, except it's done with a single directive. 157<Directory /foo> 158 DirectoryIndex index.html index.php 159</Directory> 160 161# Example C: To replace the list, you must explicitly reset it first: 162# In this example, only index.php will remain as an index resource. 163<Directory /foo> 164 DirectoryIndex index.html 165 DirectoryIndex disabled 166 DirectoryIndex index.php 167</Directory></pre> 168 169 170 171</div> 172<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 173<div class="directive-section"><h2><a name="DirectoryIndexRedirect" id="DirectoryIndexRedirect">DirectoryIndexRedirect</a> <a name="directoryindexredirect" id="directoryindexredirect">Directive</a></h2> 174<table class="directive"> 175<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures an external redirect for directory indexes. 176</td></tr> 177<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DirectoryIndexRedirect on | off | permanent | temp | seeother | 178<var>3xx-code</var> 179</code></td></tr> 180<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>DirectoryIndexRedirect off</code></td></tr> 181<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr> 182<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr> 183<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> 184<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_dir</td></tr> 185<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.3.14 and later</td></tr> 186</table> 187 <p>By default, the <code class="directive">DirectoryIndex</code> is selected 188 and returned transparently to the client. <code class="directive">DirectoryIndexRedirect</code> causes an external redirect 189 to instead be issued.</p> 190 191 <p>The argument can be:</p> 192 <ul> 193 <li><code>on</code>: issues a 302 redirection to the index resource.</li> 194 <li><code>off</code>: does not issue a redirection. This is the legacy behaviour of mod_dir.</li> 195 <li><code>permanent</code>: issues a 301 (permanent) redirection to the index resource.</li> 196 <li><code>temp</code>: this has the same effect as <code>on</code></li> 197 <li><code>seeother</code>: issues a 303 redirection (also known as "See Other") to the index resource.</li> 198 <li><var>3xx-code</var>: issues a redirection marked by the chosen 3xx code.</li> 199 </ul> 200 201 202 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">DirectoryIndexRedirect on</pre> 203</div> 204 205 <p>A request for <code>http://example.com/docs/</code> would 206 return a temporary redirect to <code>http://example.com/docs/index.html</code> 207 if it exists.</p> 208 209 210</div> 211<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 212<div class="directive-section"><h2><a name="DirectorySlash" id="DirectorySlash">DirectorySlash</a> <a name="directoryslash" id="directoryslash">Directive</a></h2> 213<table class="directive"> 214<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Toggle trailing slash redirects on or off</td></tr> 215<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DirectorySlash On|Off</code></td></tr> 216<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>DirectorySlash On</code></td></tr> 217<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr> 218<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr> 219<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> 220<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_dir</td></tr> 221</table> 222 <p>The <code class="directive">DirectorySlash</code> directive determines whether 223 <code class="module"><a href="/mod/mod_dir.html">mod_dir</a></code> should fixup URLs pointing to a directory or 224 not.</p> 225 226 <p>Typically if a user requests a resource without a trailing slash, which 227 points to a directory, <code class="module"><a href="/mod/mod_dir.html">mod_dir</a></code> redirects him to the same 228 resource, but <em>with</em> trailing slash for some good reasons:</p> 229 230 <ul> 231 <li>The user is finally requesting the canonical URL of the resource</li> 232 <li><code class="module"><a href="/mod/mod_autoindex.html">mod_autoindex</a></code> works correctly. Since it doesn't emit 233 the path in the link, it would point to the wrong path.</li> 234 <li><code class="directive"><a href="#directoryindex">DirectoryIndex</a></code> will be evaluated 235 <em>only</em> for directories requested with trailing slash.</li> 236 <li>Relative URL references inside html pages will work correctly.</li> 237 </ul> 238 239 <p>If you don't want this effect <em>and</em> the reasons above don't 240 apply to you, you can turn off the redirect as shown below. However, 241 be aware that there are possible security implications to doing 242 this.</p> 243 244 <pre class="prettyprint lang-config"># see security warning below! 245<Location /some/path> 246 DirectorySlash Off 247 SetHandler some-handler 248</Location></pre> 249 250 251 <div class="warning"><h3>Security Warning</h3> 252 <p>Turning off the trailing slash redirect may result in an information 253 disclosure. Consider a situation where <code class="module"><a href="/mod/mod_autoindex.html">mod_autoindex</a></code> is 254 active (<code>Options +Indexes</code>) and <code class="directive"><a href="#directoryindex">DirectoryIndex</a></code> is set to a valid resource (say, 255 <code>index.html</code>) and there's no other special handler defined for 256 that URL. In this case a request with a trailing slash would show the 257 <code>index.html</code> file. <strong>But a request without trailing slash 258 would list the directory contents</strong>.</p> 259 </div> 260 <p>Also note that some browsers may erroneously change POST requests into GET 261 (thus discarding POST data) when a redirect is issued.</p> 262 263</div> 264<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 265<div class="directive-section"><h2><a name="FallbackResource" id="FallbackResource">FallbackResource</a> <a name="fallbackresource" id="fallbackresource">Directive</a></h2> 266<table class="directive"> 267<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> 268<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>FallbackResource disabled | <var>local-url</var></code></td></tr> 269<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>None - httpd will return 404 (Not Found)</code></td></tr> 270<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr> 271<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr> 272<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> 273<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_dir</td></tr> 274<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>The <code>disabled</code> argument is available in version 2.4.4 and 275later</td></tr> 276</table> 277 <p>Use this to set a handler for any URL that doesn't map to anything 278 in your filesystem, and would otherwise return HTTP 404 (Not Found). 279 For example</p> 280 <pre class="prettyprint lang-config">FallbackResource /not-404.php</pre> 281 282 <p>will cause requests for non-existent files to be handled by 283 <code>not-404.php</code>, while requests for files that exist 284 are unaffected.</p> 285 <p>It is frequently desirable to have a single file or resource 286 handle all requests to a particular directory, except those requests 287 that correspond to an existing file or script. This is often 288 referred to as a 'front controller.'</p> 289 <p>In earlier versions of httpd, this effect typically required 290 <code class="module"><a href="/mod/mod_rewrite.html">mod_rewrite</a></code>, and the use of the <code>-f</code> and 291 <code>-d</code> tests for file and directory existence. This now 292 requires only one line of configuration.</p> 293 <pre class="prettyprint lang-config">FallbackResource /index.php</pre> 294 295 <p>Existing files, such as images, css files, and so on, will be 296 served normally.</p> 297 <p>Use the <code>disabled</code> argument to disable that feature 298 if inheritance from a parent directory is not desired.</p> 299 <p>In a sub-URI, such as <em>http://example.com/blog/</em> this 300 <em>sub-URI</em> has to be supplied as <var>local-url</var>:</p> 301 <pre class="prettyprint lang-config"><Directory /web/example.com/htdocs/blog> 302 FallbackResource /blog/index.php 303</Directory> 304<Directory /web/example.com/htdocs/blog/images> 305 FallbackResource disabled 306</Directory></pre> 307 308 309</div> 310</div> 311<div class="bottomlang"> 312<p><span>Available Languages: </span><a href="/en/mod/mod_dir.html" title="English"> en </a> | 313<a href="/fr/mod/mod_dir.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a> | 314<a href="/ja/mod/mod_dir.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> | 315<a href="/ko/mod/mod_dir.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> | 316<a href="/tr/mod/mod_dir.html" hreflang="tr" rel="alternate" title="T�rk�e"> tr </a></p> 317</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> 318<script type="text/javascript"><!--//--><![CDATA[//><!-- 319var comments_shortname = 'httpd'; 320var comments_identifier = 'http://httpd.apache.org/docs/2.4/mod/mod_dir.html'; 321(function(w, d) { 322 if (w.location.hostname.toLowerCase() == "httpd.apache.org") { 323 d.write('<div id="comments_thread"><\/div>'); 324 var s = d.createElement('script'); 325 s.type = 'text/javascript'; 326 s.async = true; 327 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; 328 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); 329 } 330 else { 331 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>'); 332 } 333})(window, document); 334//--><!]]></script></div><div id="footer"> 335<p class="apache">Copyright 2014 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> 336<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[//><!-- 337if (typeof(prettyPrint) !== 'undefined') { 338 prettyPrint(); 339} 340//--><!]]></script> 341</body></html>
