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 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
6 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
7 This file is generated from xml source: DO NOT EDIT
8 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
10 <title>mod_dir - Apache HTTP Server Version 2.5</title>
11 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
12 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
13 <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" />
14 <script src="../style/scripts/prettify.min.js" type="text/javascript">
17 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
19 <div id="page-header">
20 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.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>
21 <p class="apache">Apache HTTP Server Version 2.5</p>
22 <img alt="" src="../images/feather.png" /></div>
23 <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
25 <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.5</a> > <a href="./">Modules</a></div>
26 <div id="page-content">
27 <div id="preamble"><h1>Apache Module mod_dir</h1>
29 <p><span>Available Languages: </span><a href="../en/mod/mod_dir.html" title="English"> en </a> |
30 <a href="../fr/mod/mod_dir.html" hreflang="fr" rel="alternate" title="Français"> fr </a> |
31 <a href="../ja/mod/mod_dir.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
32 <a href="../ko/mod/mod_dir.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> |
33 <a href="../tr/mod/mod_dir.html" hreflang="tr" rel="alternate" title="Türkçe"> tr </a></p>
35 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Provides for "trailing slash" redirects and
36 serving directory index files</td></tr>
37 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
38 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>dir_module</td></tr>
39 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_dir.c</td></tr></table>
42 <p>The index of a directory can come from one of two sources:</p>
45 <li>A file written by the user, typically called
46 <code>index.html</code>. The <code class="directive"><a href="#directoryindex">DirectoryIndex</a></code> directive sets the
47 name of this file. This is controlled by
48 <code class="module"><a href="../mod/mod_dir.html">mod_dir</a></code>.</li>
50 <li>Otherwise, a listing generated by the server. This is
51 provided by <code class="module"><a href="../mod/mod_autoindex.html">mod_autoindex</a></code>.</li>
53 <p>The two functions are separated so that you can completely
54 remove (or replace) automatic index generation should you want
57 <p>A "trailing slash" redirect is issued when the server
58 receives a request for a URL
59 <code>http://servername/foo/dirname</code> where
60 <code>dirname</code> is a directory. Directories require a
61 trailing slash, so <code class="module"><a href="../mod/mod_dir.html">mod_dir</a></code> issues a redirect to
62 <code>http://servername/foo/dirname/</code>.</p>
64 <div id="quickview"><h3 class="directives">Directives</h3>
66 <li><img alt="" src="../images/down.gif" /> <a href="#directorycheckhandler">DirectoryCheckHandler</a></li>
67 <li><img alt="" src="../images/down.gif" /> <a href="#directoryindex">DirectoryIndex</a></li>
68 <li><img alt="" src="../images/down.gif" /> <a href="#directoryindexredirect">DirectoryIndexRedirect</a></li>
69 <li><img alt="" src="../images/down.gif" /> <a href="#directoryslash">DirectorySlash</a></li>
70 <li><img alt="" src="../images/down.gif" /> <a href="#fallbackresource">FallbackResource</a></li>
72 <h3>Bugfix checklist:</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">HTTPD changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&list_id=144532&product=Apache%20httpd-2&query_format=specific&order=changeddate%20DESC%2Cpriority%2Cbug_severity&component=mod_dir">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2">Report a bug</a></li></ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
74 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
75 <div class="directive-section"><h2><a name="DirectoryCheckHandler" id="DirectoryCheckHandler">DirectoryCheckHandler</a> <a name="directorycheckhandler" id="directorycheckhandler">Directive</a></h2>
76 <table class="directive">
77 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Toggle how this module responds when another handler is configured</td></tr>
78 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DirectoryCheckHandler On|Off</code></td></tr>
79 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>DirectoryCheckHandler Off</code></td></tr>
80 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
81 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr>
82 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
83 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_dir</td></tr>
84 <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
85 act as if "DirectoryCheckHandler ON" was specified.</td></tr>
87 <p>The <code class="directive">DirectoryCheckHandler</code> directive determines
88 whether <code class="module"><a href="../mod/mod_dir.html">mod_dir</a></code> should check for directory indexes or
89 add trailing slashes when some other handler has been configured for
90 the current URL. Handlers can be set by directives such as
91 <code class="directive"><a href="../mod/core.html#sethandler">SetHandler</a></code> or by other modules at
94 <p> In releases prior to 2.4, this module did not take any action if any
95 other handler was configured for a URL. This allows directory indexes to
96 be served even when a <code class="directive">SetHandler</code> directive is
97 specified for an entire directory, but it can also result in some conflicts
98 with other modules.</p>
101 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
102 <div class="directive-section"><h2><a name="DirectoryIndex" id="DirectoryIndex">DirectoryIndex</a> <a name="directoryindex" id="directoryindex">Directive</a></h2>
103 <table class="directive">
104 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>List of resources to look for when the client requests
105 a directory</td></tr>
106 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DirectoryIndex
107 disabled | <var>local-url</var> [<var>local-url</var>] ...</code></td></tr>
108 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>DirectoryIndex index.html</code></td></tr>
109 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
110 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr>
111 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
112 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_dir</td></tr>
114 <p>The <code class="directive">DirectoryIndex</code> directive sets the
115 list of resources to look for, when the client requests an index
116 of the directory by specifying a / at the end of the directory
117 name. <var>Local-url</var> is the (%-encoded) URL of a document on
118 the server relative to the requested directory; it is usually the
119 name of a file in the directory. Several URLs may be given, in
120 which case the server will return the first one that it finds. If
121 none of the resources exist and the <code>Indexes</code> option is
122 set, the server will generate its own listing of the
125 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">DirectoryIndex index.html</pre>
128 <p>then a request for <code>http://example.com/docs/</code> would
129 return <code>http://example.com/docs/index.html</code> if it
130 exists, or would list the directory if it did not.</p>
132 <p>Note that the documents do not need to be relative to the
135 <pre class="prettyprint lang-config">DirectoryIndex index.html index.txt /cgi-bin/index.pl</pre>
138 <p>would cause the CGI script <code>/cgi-bin/index.pl</code> to be
139 executed if neither <code>index.html</code> or <code>index.txt</code>
140 existed in a directory.</p>
142 <p>A single argument of "disabled" prevents <code class="module"><a href="../mod/mod_dir.html">mod_dir</a></code> from
143 searching for an index. An argument of "disabled" will be interpreted
144 literally if it has any arguments before or after it, even if they are "disabled"
147 <p><strong>Note:</strong> Multiple <code class="directive">DirectoryIndex</code>
148 directives within the <a href="../sections.html"><em>same context</em></a> will add
149 to the list of resources to look for rather than replace:
151 <pre class="prettyprint lang-config"># Example A: Set index.html as an index page, then add index.php to that list as well.
152 <Directory "/foo">
153 DirectoryIndex index.html
154 DirectoryIndex index.php
157 # Example B: This is identical to example A, except it's done with a single directive.
158 <Directory "/foo">
159 DirectoryIndex index.html index.php
162 # Example C: To replace the list, you must explicitly reset it first:
163 # In this example, only index.php will remain as an index resource.
164 <Directory "/foo">
165 DirectoryIndex index.html
166 DirectoryIndex disabled
167 DirectoryIndex index.php
168 </Directory></pre>
173 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
174 <div class="directive-section"><h2><a name="DirectoryIndexRedirect" id="DirectoryIndexRedirect">DirectoryIndexRedirect</a> <a name="directoryindexredirect" id="directoryindexredirect">Directive</a></h2>
175 <table class="directive">
176 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures an external redirect for directory indexes.
178 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DirectoryIndexRedirect on | off | permanent | temp | seeother |
181 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>DirectoryIndexRedirect off</code></td></tr>
182 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
183 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr>
184 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
185 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_dir</td></tr>
186 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.3.14 and later</td></tr>
188 <p>By default, the <code class="directive">DirectoryIndex</code> is selected
189 and returned transparently to the client. <code class="directive">DirectoryIndexRedirect</code> causes an external redirect
190 to instead be issued.</p>
192 <p>The argument can be:</p>
194 <li><code>on</code>: issues a 302 redirection to the index resource.</li>
195 <li><code>off</code>: does not issue a redirection. This is the legacy behaviour of mod_dir.</li>
196 <li><code>permanent</code>: issues a 301 (permanent) redirection to the index resource.</li>
197 <li><code>temp</code>: this has the same effect as <code>on</code></li>
198 <li><code>seeother</code>: issues a 303 redirection (also known as "See Other") to the index resource.</li>
199 <li><var>3xx-code</var>: issues a redirection marked by the chosen 3xx code.</li>
203 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">DirectoryIndexRedirect on</pre>
206 <p>A request for <code>http://example.com/docs/</code> would
207 return a temporary redirect to <code>http://example.com/docs/index.html</code>
212 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
213 <div class="directive-section"><h2><a name="DirectorySlash" id="DirectorySlash">DirectorySlash</a> <a name="directoryslash" id="directoryslash">Directive</a></h2>
214 <table class="directive">
215 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Toggle trailing slash redirects on or off</td></tr>
216 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DirectorySlash On|Off</code></td></tr>
217 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>DirectorySlash On</code></td></tr>
218 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
219 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr>
220 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
221 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_dir</td></tr>
223 <p>The <code class="directive">DirectorySlash</code> directive determines whether
224 <code class="module"><a href="../mod/mod_dir.html">mod_dir</a></code> should fixup URLs pointing to a directory or
227 <p>Typically if a user requests a resource without a trailing slash, which
228 points to a directory, <code class="module"><a href="../mod/mod_dir.html">mod_dir</a></code> redirects him to the same
229 resource, but <em>with</em> trailing slash for some good reasons:</p>
232 <li>The user is finally requesting the canonical URL of the resource</li>
233 <li><code class="module"><a href="../mod/mod_autoindex.html">mod_autoindex</a></code> works correctly. Since it doesn't emit
234 the path in the link, it would point to the wrong path.</li>
235 <li><code class="directive"><a href="#directoryindex">DirectoryIndex</a></code> will be evaluated
236 <em>only</em> for directories requested with trailing slash.</li>
237 <li>Relative URL references inside html pages will work correctly.</li>
240 <p>If you don't want this effect <em>and</em> the reasons above don't
241 apply to you, you can turn off the redirect as shown below. However,
242 be aware that there are possible security implications to doing
245 <pre class="prettyprint lang-config"># see security warning below!
246 <Location "/some/path">
248 SetHandler some-handler
249 </Location></pre>
252 <div class="warning"><h3>Security Warning</h3>
253 <p>Turning off the trailing slash redirect may result in an information
254 disclosure. Consider a situation where <code class="module"><a href="../mod/mod_autoindex.html">mod_autoindex</a></code> is
255 active (<code>Options +Indexes</code>) and <code class="directive"><a href="#directoryindex">DirectoryIndex</a></code> is set to a valid resource (say,
256 <code>index.html</code>) and there's no other special handler defined for
257 that URL. In this case a request with a trailing slash would show the
258 <code>index.html</code> file. <strong>But a request without trailing slash
259 would list the directory contents</strong>.</p>
261 <p>Also note that some browsers may erroneously change POST requests into GET
262 (thus discarding POST data) when a redirect is issued.</p>
265 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
266 <div class="directive-section"><h2><a name="FallbackResource" id="FallbackResource">FallbackResource</a> <a name="fallbackresource" id="fallbackresource">Directive</a></h2>
267 <table class="directive">
268 <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>
269 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>FallbackResource disabled | <var>local-url</var></code></td></tr>
270 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>disabled - httpd will return 404 (Not Found)</code></td></tr>
271 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
272 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr>
273 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
274 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_dir</td></tr>
275 <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
278 <p>Use this to set a handler for any URL that doesn't map to anything
279 in your filesystem, and would otherwise return HTTP 404 (Not Found).
281 <pre class="prettyprint lang-config">FallbackResource /not-404.php</pre>
283 <p>will cause requests for non-existent files to be handled by
284 <code>not-404.php</code>, while requests for files that exist
286 <p>It is frequently desirable to have a single file or resource
287 handle all requests to a particular directory, except those requests
288 that correspond to an existing file or script. This is often
289 referred to as a 'front controller.'</p>
290 <p>In earlier versions of httpd, this effect typically required
291 <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>, and the use of the <code>-f</code> and
292 <code>-d</code> tests for file and directory existence. This now
293 requires only one line of configuration.</p>
294 <pre class="prettyprint lang-config">FallbackResource /index.php</pre>
296 <p>Existing files, such as images, css files, and so on, will be
298 <p>Use the <code>disabled</code> argument to disable that feature
299 if inheritance from a parent directory is not desired.</p>
300 <p>In a sub-URI, such as <em>http://example.com/blog/</em> this
301 <em>sub-URI</em> has to be supplied as <var>local-url</var>:</p>
302 <pre class="prettyprint lang-config"><Directory "/web/example.com/htdocs/blog">
303 FallbackResource /blog/index.php
305 <Directory "/web/example.com/htdocs/blog/images">
306 FallbackResource disabled
307 </Directory></pre>
312 <div class="bottomlang">
313 <p><span>Available Languages: </span><a href="../en/mod/mod_dir.html" title="English"> en </a> |
314 <a href="../fr/mod/mod_dir.html" hreflang="fr" rel="alternate" title="Français"> fr </a> |
315 <a href="../ja/mod/mod_dir.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
316 <a href="../ko/mod/mod_dir.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> |
317 <a href="../tr/mod/mod_dir.html" hreflang="tr" rel="alternate" title="Türkçe"> tr </a></p>
318 </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>
319 <script type="text/javascript"><!--//--><![CDATA[//><!--
320 var comments_shortname = 'httpd';
321 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_dir.html';
323 if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
324 d.write('<div id="comments_thread"><\/div>');
325 var s = d.createElement('script');
326 s.type = 'text/javascript';
328 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
329 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
332 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
334 })(window, document);
335 //--><!]]></script></div><div id="footer">
336 <p class="apache">Copyright 2016 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>
337 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.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[//><!--
338 if (typeof(prettyPrint) !== 'undefined') {