manual/mod/mod_dir.html.en

	mod_dir.html.en revision 1462ff536f1b939bb337766b2056109c29664c4e
4063N/A<?xml version="1.0" encoding="ISO-8859-1"?>
4063N/A<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4063N/A<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
4063N/A        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
4063N/A              This file is generated from xml source: DO NOT EDIT
4063N/A        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
4063N/A      -->
4063N/A<title>mod_dir - Apache HTTP Server</title>
4063N/A<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
4063N/A<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
4063N/A<link href="/style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
4063N/A<link href="/images/favicon.ico" rel="shortcut icon" /></head>
4063N/A<body>
4063N/A<div id="page-header">
4063N/A<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>
4063N/A<p class="apache">Apache HTTP Server Version 2.3</p>
4063N/A<img alt="" src="/images/feather.gif" /></div>
4063N/A<div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="/images/left.gif" /></a></div>
4063N/A<div id="path">
4063N/A<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.3</a> &gt; <a href="./">Modules</a></div>
4063N/A<div id="page-content">
4063N/A<div id="preamble"><h1>Apache Module mod_dir</h1>
4063N/A<div class="toplang">
4063N/A<p><span>Available Languages: </span><a href="/en/mod/mod_dir.html" title="English">&nbsp;en&nbsp;</a> |
4063N/A<a href="/fr/mod/mod_dir.html" hreflang="fr" rel="alternate" title="Fran�ais">&nbsp;fr&nbsp;</a> |
4063N/A<a href="/ja/mod/mod_dir.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
4063N/A<a href="/ko/mod/mod_dir.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
4063N/A<a href="/tr/mod/mod_dir.html" hreflang="tr" rel="alternate" title="T�rk�e">&nbsp;tr&nbsp;</a></p>
4063N/A</div>
4063N/A<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Provides for "trailing slash" redirects and
4063N/A    serving directory index files</td></tr>
4063N/A<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
4063N/A<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>dir_module</td></tr>
4063N/A<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_dir.c</td></tr></table>
4063N/A<h3>Summary</h3>
4063N/A
4063N/A    <p>The index of a directory can come from one of two sources:</p>
4063N/A
4063N/A    <ul>
4063N/A      <li>A file written by the user, typically called
4063N/A      <code>index.html</code>. The <code class="directive"><a href="#directoryindex">DirectoryIndex</a></code> directive sets the
4063N/A      name of this file. This is controlled by
4063N/A      <code class="module"><a href="/mod/mod_dir.html">mod_dir</a></code>.</li>
4063N/A
4063N/A      <li>Otherwise, a listing generated by the server. This is
4063N/A      provided by <code class="module"><a href="/mod/mod_autoindex.html">mod_autoindex</a></code>.</li>
4063N/A    </ul>
4063N/A    <p>The two functions are separated so that you can completely
4063N/A    remove (or replace) automatic index generation should you want
4063N/A    to.</p>
4063N/A
4063N/A    <p>A "trailing slash" redirect is issued when the server
4063N/A    receives a request for a URL
4063N/A    <code>http://servername/foo/dirname</code> where
4063N/A    <code>dirname</code> is a directory. Directories require a
4063N/A    trailing slash, so <code class="module"><a href="/mod/mod_dir.html">mod_dir</a></code> issues a redirect to
4063N/A    <code>http://servername/foo/dirname/</code>.</p>
4063N/A</div>
4063N/A<div id="quickview"><h3 class="directives">Directives</h3>
4063N/A<ul id="toc">
4063N/A<li><img alt="" src="/images/down.gif" /> <a href="#directoryindex">DirectoryIndex</a></li>
4337N/A<li><img alt="" src="/images/down.gif" /> <a href="#directoryindexredirect">DirectoryIndexRedirect</a></li>
4337N/A<li><img alt="" src="/images/down.gif" /> <a href="#directoryslash">DirectorySlash</a></li>
4063N/A<li><img alt="" src="/images/down.gif" /> <a href="#fallbackresource">FallbackResource</a></li>
4063N/A</ul>
4063N/A</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
    disabled | <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://example.com/docs/</code> would
    return <code>http://example.com/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>

    <p>A single argument of "disabled" prevents <code class="module"><a href="/mod/mod_dir.html">mod_dir</a></code> from
    searching for an index.  An argument of "disabled" will be interpeted
    literally if it has any arguments before or after it, even if they are "disabled"
    as well.</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="DirectoryIndexRedirect" id="DirectoryIndexRedirect">DirectoryIndexRedirect</a> <a name="directoryindexredirect" id="directoryindexredirect">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures an external redirect for directory indexes.
</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DirectoryIndexRedirect on | off | permanent | temp | seeother |
<var>3xx-code</var>
</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>DirectoryIndexRedirect off</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.3.14 and later</td></tr>
</table>
    <p>By default, the <code class="directive">DirectoryIndex</code> is selected
    and returned transparently to the client.  <code class="directive">DirectoryIndexRedirect</code> causes an external redirect
    to instead be issued.</p>

    <div class="example"><h3>Example</h3><p><code>
      DirectoryIndexRedirect on
    </code></p></div>

    <p>A request for <code>http://example.com/docs/</code> would
    return a temporary redirect to <code>http://example.com/docs/index.html</code>
    if it exists.</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>If you don't want this effect <em>and</em> the reasons above don't
    apply to you, you can turn off the redirect as shown below. However,
    be aware that there are possible security implications to doing
    this.</p>

    <div class="example"><p><code>
        # see security warning below!<br />
        &lt;Location /some/path&gt;<br />
        <span class="indent">
            DirectorySlash Off<br />
            SetHandler some-handler<br />
        </span>
        &lt;/Location&gt;
    </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 class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="FallbackResource" id="FallbackResource">FallbackResource</a> <a name="fallbackresource" id="fallbackresource">Directive</a></h2>
<table class="directive">
<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>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>FallbackResource <var>local-url</var></code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>None - httpd will return 404 (Not Found)</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>Use this to set a handler for any URL that doesn't map to anything
    in your filesystem, and would otherwise return HTTP 404 (Not Found).
    For example</p>
    <div class="example"><p><code>
        <code>FallbackResource /not-404.php</code>
    </code></p></div>
    <p>will cause requests for non-existent files to be handled by
    <code>not-404.php</code>, while requests for files that exist
    are unaffected.</p>
    <p>It is frequently desirable to have a single file or resource
    handle all requests to a particular directory, except those requests
    that correspond to an existing file or script. This is often
    referred to as a 'front controller.'</p>
    <p>In earlier versions of httpd, this effect typically required
    <code class="module"><a href="/mod/mod_rewrite.html">mod_rewrite</a></code>, and the use of the <code>-f</code> and
    <code>-d</code> tests for file and directory existence. This now
    requires only one line of configuration.</p>
    <div class="example"><p><code>
        <code>FallbackResource /index.php</code>
    </code></p></div>
    <p>Existing files, such as images, css files, and so on, will be
    served normally.</p>
    <p>In a sub-URI, such as <em>http://example.com/blog/</em> this
    <em>sub-URI</em> has to be supplied as <var>local-url</var>:</p>
    <div class="example"><p><code>
         <code>
             &lt;Directory /web/example.com/htdocs/blog&gt;<br />
         <span class="indent">
                  FallbackResource /blog/index.php<br />
             </span>
             &lt;/Directory&gt;
         </code>
    </code></p></div>

</div>
</div>
<div class="bottomlang">
<p><span>Available Languages: </span><a href="/en/mod/mod_dir.html" title="English">&nbsp;en&nbsp;</a> |
<a href="/fr/mod/mod_dir.html" hreflang="fr" rel="alternate" title="Fran�ais">&nbsp;fr&nbsp;</a> |
<a href="/ja/mod/mod_dir.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
<a href="/ko/mod/mod_dir.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
<a href="/tr/mod/mod_dir.html" hreflang="tr" rel="alternate" title="T�rk�e">&nbsp;tr&nbsp;</a></p>
</div><div id="footer">
<p class="apache">Copyright 2011 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>