mirror of
https://github.com/apache/httpd.git
synced 2025-05-30 01:07:09 +03:00
cadc3c17dd
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1331553 13f79535-47bb-0310-9956-ffa450edef68
268 lines
16 KiB
XML
268 lines
16 KiB
XML
<?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><!--
|
||
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 rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
|
||
<script src="../style/scripts/prettify.js" type="text/javascript">
|
||
</script>
|
||
|
||
<link href="../images/favicon.ico" rel="shortcut icon" /></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.5</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.5</a> > <a href="./">Modules</a></div>
|
||
<div id="page-content">
|
||
<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="../fr/mod/mod_dir.html" hreflang="fr" rel="alternate" title="Français"> fr </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="#directoryindexredirect">DirectoryIndexRedirect</a></li>
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#directoryslash">DirectorySlash</a></li>
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#fallbackresource">FallbackResource</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
|
||
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><pre class="prettyprint lang-config">
|
||
DirectoryIndex index.html
|
||
</pre>
|
||
</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>
|
||
|
||
<pre class="prettyprint lang-config">
|
||
DirectoryIndex index.html index.txt /cgi-bin/index.pl
|
||
</pre>
|
||
|
||
|
||
<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 interpreted
|
||
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><pre class="prettyprint lang-config">
|
||
DirectoryIndexRedirect on
|
||
</pre>
|
||
</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>
|
||
|
||
<pre class="prettyprint lang-config">
|
||
# see security warning below!
|
||
<Location /some/path>
|
||
DirectorySlash Off
|
||
SetHandler some-handler
|
||
</Location>
|
||
</pre>
|
||
|
||
|
||
<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>
|
||
<p>Also note that some browsers may erroneously change POST requests into GET
|
||
(thus discarding POST data) when a redirect is issued.</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="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>
|
||
<pre class="prettyprint lang-config">
|
||
FallbackResource /not-404.php
|
||
</pre>
|
||
|
||
<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>
|
||
<pre class="prettyprint lang-config">
|
||
FallbackResource /index.php
|
||
</pre>
|
||
|
||
<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>
|
||
<pre class="prettyprint lang-config">
|
||
<Directory /web/example.com/htdocs/blog>
|
||
FallbackResource /blog/index.php
|
||
</Directory>
|
||
</pre>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<div class="bottomlang">
|
||
<p><span>Available Languages: </span><a href="../en/mod/mod_dir.html" title="English"> en </a> |
|
||
<a href="../fr/mod/mod_dir.html" hreflang="fr" rel="alternate" title="Français"> fr </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 2012 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><script type="text/javascript"><!--//--><![CDATA[//><!--
|
||
if (typeof(prettyPrint) !== undefined) {
|
||
prettyPrint();
|
||
}
|
||
//--><!]]></script>
|
||
</body></html> |