6a7d71eb77725eb1b1091a94289696ab07946c7bslive<?xml version="1.0"?>

d24d4c5159bcb11c25bb294926cfe7105c789ea9slive<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">

e942c741056732f50da2074b36fe59805d370650slive<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>

d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd

d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd

7db9f691a00ead175b03335457ca296a33ddf31bnd<modulesynopsis metafile="mod_dir.xml.meta">

6a7d71eb77725eb1b1091a94289696ab07946c7bslive<name>mod_dir</name>

6a7d71eb77725eb1b1091a94289696ab07946c7bslive<description>Provides for "trailing slash" redirects and

d24d4c5159bcb11c25bb294926cfe7105c789ea9slive serving directory index files</description>

6a7d71eb77725eb1b1091a94289696ab07946c7bslive<status>Base</status>

6a7d71eb77725eb1b1091a94289696ab07946c7bslive<sourcefile>mod_dir.c</sourcefile>

6a7d71eb77725eb1b1091a94289696ab07946c7bslive<identifier>dir_module</identifier>

6a7d71eb77725eb1b1091a94289696ab07946c7bslive

6a7d71eb77725eb1b1091a94289696ab07946c7bslive<summary>

6a7d71eb77725eb1b1091a94289696ab07946c7bslive <p>The index of a directory can come from one of two sources:</p>

6a7d71eb77725eb1b1091a94289696ab07946c7bslive

6a7d71eb77725eb1b1091a94289696ab07946c7bslive <ul>

6a7d71eb77725eb1b1091a94289696ab07946c7bslive <li>A file written by the user, typically called

6a7d71eb77725eb1b1091a94289696ab07946c7bslive <code>index.html</code>. The <directive module="mod_dir"

6a7d71eb77725eb1b1091a94289696ab07946c7bslive >DirectoryIndex</directive> directive sets the

6a7d71eb77725eb1b1091a94289696ab07946c7bslive name of this file. This is controlled by

6a7d71eb77725eb1b1091a94289696ab07946c7bslive <module>mod_dir</module>.</li>

6a7d71eb77725eb1b1091a94289696ab07946c7bslive

6a7d71eb77725eb1b1091a94289696ab07946c7bslive <li>Otherwise, a listing generated by the server. This is

6a7d71eb77725eb1b1091a94289696ab07946c7bslive provided by <module>mod_autoindex</module>.</li>

6a7d71eb77725eb1b1091a94289696ab07946c7bslive </ul>

6a7d71eb77725eb1b1091a94289696ab07946c7bslive <p>The two functions are separated so that you can completely

6a7d71eb77725eb1b1091a94289696ab07946c7bslive remove (or replace) automatic index generation should you want

6a7d71eb77725eb1b1091a94289696ab07946c7bslive to.</p>

6a7d71eb77725eb1b1091a94289696ab07946c7bslive

6a7d71eb77725eb1b1091a94289696ab07946c7bslive <p>A "trailing slash" redirect is issued when the server

6a7d71eb77725eb1b1091a94289696ab07946c7bslive receives a request for a URL

6a7d71eb77725eb1b1091a94289696ab07946c7bslive <code>http://servername/foo/dirname</code> where

6a7d71eb77725eb1b1091a94289696ab07946c7bslive <code>dirname</code> is a directory. Directories require a

6a7d71eb77725eb1b1091a94289696ab07946c7bslive trailing slash, so <module>mod_dir</module> issues a redirect to

6a7d71eb77725eb1b1091a94289696ab07946c7bslive <code>http://servername/foo/dirname/</code>.</p>

6a7d71eb77725eb1b1091a94289696ab07946c7bslive</summary>

6a7d71eb77725eb1b1091a94289696ab07946c7bslive

6a7d71eb77725eb1b1091a94289696ab07946c7bslive<directivesynopsis>

d24d4c5159bcb11c25bb294926cfe7105c789ea9slive<name>DirectoryIndex</name>

6a7d71eb77725eb1b1091a94289696ab07946c7bslive<description>List of resources to look for when the client requests

6a7d71eb77725eb1b1091a94289696ab07946c7bslivea directory</description>

6a7d71eb77725eb1b1091a94289696ab07946c7bslive<syntax>DirectoryIndex

b6d2c204c150843e48f6787c1090ae75b718896ecovener disabled | <var>local-url</var> [<var>local-url</var>] ...</syntax>

6a7d71eb77725eb1b1091a94289696ab07946c7bslive<default>DirectoryIndex index.html</default>

f5cbf3a7818c08d2f19c04fdf4f47257eea7d3c6nd<contextlist><context>server config</context><context>virtual host</context>

f5cbf3a7818c08d2f19c04fdf4f47257eea7d3c6nd<context>directory</context><context>.htaccess</context></contextlist>

6a7d71eb77725eb1b1091a94289696ab07946c7bslive<override>Indexes</override>

6a7d71eb77725eb1b1091a94289696ab07946c7bslive

6a7d71eb77725eb1b1091a94289696ab07946c7bslive<usage>

6a7d71eb77725eb1b1091a94289696ab07946c7bslive <p>The <directive>DirectoryIndex</directive> directive sets the

6a7d71eb77725eb1b1091a94289696ab07946c7bslive list of resources to look for, when the client requests an index

1887c0b8ceab2c8d64a1e5b3aa512e77b86b49fayoshiki of the directory by specifying a / at the end of the directory

f5cbf3a7818c08d2f19c04fdf4f47257eea7d3c6nd name. <var>Local-url</var> is the (%-encoded) URL of a document on

6a7d71eb77725eb1b1091a94289696ab07946c7bslive the server relative to the requested directory; it is usually the

6a7d71eb77725eb1b1091a94289696ab07946c7bslive name of a file in the directory. Several URLs may be given, in

6a7d71eb77725eb1b1091a94289696ab07946c7bslive which case the server will return the first one that it finds. If

6a7d71eb77725eb1b1091a94289696ab07946c7bslive none of the resources exist and the <code>Indexes</code> option is

6a7d71eb77725eb1b1091a94289696ab07946c7bslive set, the server will generate its own listing of the

6a7d71eb77725eb1b1091a94289696ab07946c7bslive directory.</p>

6a7d71eb77725eb1b1091a94289696ab07946c7bslive

f5cbf3a7818c08d2f19c04fdf4f47257eea7d3c6nd <example><title>Example</title>

f5cbf3a7818c08d2f19c04fdf4f47257eea7d3c6nd DirectoryIndex index.html

f5cbf3a7818c08d2f19c04fdf4f47257eea7d3c6nd </example>

6a7d71eb77725eb1b1091a94289696ab07946c7bslive

6a7d71eb77725eb1b1091a94289696ab07946c7bslive <p>then a request for <code>http://myserver/docs/</code> would

6a7d71eb77725eb1b1091a94289696ab07946c7bslive return <code>http://myserver/docs/index.html</code> if it

6a7d71eb77725eb1b1091a94289696ab07946c7bslive exists, or would list the directory if it did not.</p>

6a7d71eb77725eb1b1091a94289696ab07946c7bslive

6a7d71eb77725eb1b1091a94289696ab07946c7bslive <p>Note that the documents do not need to be relative to the

6a7d71eb77725eb1b1091a94289696ab07946c7bslive directory;</p>

6a7d71eb77725eb1b1091a94289696ab07946c7bslive

f5cbf3a7818c08d2f19c04fdf4f47257eea7d3c6nd <example>

f5cbf3a7818c08d2f19c04fdf4f47257eea7d3c6nd DirectoryIndex index.html index.txt /cgi-bin/index.pl

f5cbf3a7818c08d2f19c04fdf4f47257eea7d3c6nd </example>

f5cbf3a7818c08d2f19c04fdf4f47257eea7d3c6nd

6a7d71eb77725eb1b1091a94289696ab07946c7bslive <p>would cause the CGI script <code>/cgi-bin/index.pl</code> to be

f5cbf3a7818c08d2f19c04fdf4f47257eea7d3c6nd executed if neither <code>index.html</code> or <code>index.txt</code>

f5cbf3a7818c08d2f19c04fdf4f47257eea7d3c6nd existed in a directory.</p>

63de18ba5e922ffaab500317d7d1d0ad6b27b7e2covener

b6d2c204c150843e48f6787c1090ae75b718896ecovener <p>A single argument of "disabled" prevents <module>mod_dir</module> from

b6d2c204c150843e48f6787c1090ae75b718896ecovener searching for an index. An argument of "disabled" will be interpeted

b6d2c204c150843e48f6787c1090ae75b718896ecovener literally if it has any arguments before or after it, even if they are "disabled"

b6d2c204c150843e48f6787c1090ae75b718896ecovener as well.</p>

63de18ba5e922ffaab500317d7d1d0ad6b27b7e2covener

6a7d71eb77725eb1b1091a94289696ab07946c7bslive</usage>

6a7d71eb77725eb1b1091a94289696ab07946c7bslive</directivesynopsis>

6a7d71eb77725eb1b1091a94289696ab07946c7bslive

3b2d0dc9701458b42e573190ffe7344315d7bd31nd<directivesynopsis>

3b2d0dc9701458b42e573190ffe7344315d7bd31nd<name>DirectorySlash</name>

3b2d0dc9701458b42e573190ffe7344315d7bd31nd<description>Toggle trailing slash redirects on or off</description>

3b2d0dc9701458b42e573190ffe7344315d7bd31nd<syntax>DirectorySlash On|Off</syntax>

3b2d0dc9701458b42e573190ffe7344315d7bd31nd<default>DirectorySlash On</default>

3b2d0dc9701458b42e573190ffe7344315d7bd31nd<contextlist><context>server config</context><context>virtual host</context>

3b2d0dc9701458b42e573190ffe7344315d7bd31nd<context>directory</context><context>.htaccess</context></contextlist>

3b2d0dc9701458b42e573190ffe7344315d7bd31nd<override>Indexes</override>

a7749772d764a29ed2376733f951c4c9a28b2121nd<compatibility>Available in version 2.0.51 and later</compatibility>

3b2d0dc9701458b42e573190ffe7344315d7bd31nd

3b2d0dc9701458b42e573190ffe7344315d7bd31nd<usage>

3b2d0dc9701458b42e573190ffe7344315d7bd31nd <p>The <directive>DirectorySlash</directive> directive determines, whether

3b2d0dc9701458b42e573190ffe7344315d7bd31nd <module>mod_dir</module> should fixup URLs pointing to a directory or

3b2d0dc9701458b42e573190ffe7344315d7bd31nd not.</p>

3b2d0dc9701458b42e573190ffe7344315d7bd31nd

3b2d0dc9701458b42e573190ffe7344315d7bd31nd <p>Typically if a user requests a resource without a trailing slash, which

3b2d0dc9701458b42e573190ffe7344315d7bd31nd points to a directory, <module>mod_dir</module> redirects him to the same

90361ddfb3a8abaa0f8fb1729732062c78d8dc50niq resource, but <em>with</em> trailing slash for some good reasons:</p>

3b2d0dc9701458b42e573190ffe7344315d7bd31nd

3b2d0dc9701458b42e573190ffe7344315d7bd31nd <ul>

3b2d0dc9701458b42e573190ffe7344315d7bd31nd <li>The user is finally requesting the canonical URL of the resource</li>

3b2d0dc9701458b42e573190ffe7344315d7bd31nd <li><module>mod_autoindex</module> works correctly. Since it doesn't emit

3b2d0dc9701458b42e573190ffe7344315d7bd31nd the path in the link, it would point to the wrong path.</li>

3b2d0dc9701458b42e573190ffe7344315d7bd31nd <li><directive module="mod_dir">DirectoryIndex</directive> will be evaluated

3b2d0dc9701458b42e573190ffe7344315d7bd31nd <em>only</em> for directories requested with trailing slash.</li>

571d9bf2dccc0cb3d944fd06a96218ab49899513nd <li>Relative URL references inside html pages will work correctly.</li>

3b2d0dc9701458b42e573190ffe7344315d7bd31nd </ul>

3b2d0dc9701458b42e573190ffe7344315d7bd31nd

3b2d0dc9701458b42e573190ffe7344315d7bd31nd <p>Well, if you don't want this effect <em>and</em> the reasons above don't

3b2d0dc9701458b42e573190ffe7344315d7bd31nd apply to you, you can turn off the redirect with:</p>

3b2d0dc9701458b42e573190ffe7344315d7bd31nd

3b2d0dc9701458b42e573190ffe7344315d7bd31nd <example>

3b2d0dc9701458b42e573190ffe7344315d7bd31nd # see security warning below!<br />

3b2d0dc9701458b42e573190ffe7344315d7bd31nd &lt;Location /some/path&gt;<br />

3b2d0dc9701458b42e573190ffe7344315d7bd31nd <indent>

3b2d0dc9701458b42e573190ffe7344315d7bd31nd DirectorySlash Off<br />

3b2d0dc9701458b42e573190ffe7344315d7bd31nd SetHandler some-handler<br />

3b2d0dc9701458b42e573190ffe7344315d7bd31nd </indent>

3b2d0dc9701458b42e573190ffe7344315d7bd31nd &lt;/Location&gt;

3b2d0dc9701458b42e573190ffe7344315d7bd31nd </example>

3b2d0dc9701458b42e573190ffe7344315d7bd31nd

3b2d0dc9701458b42e573190ffe7344315d7bd31nd <note type="warning"><title>Security Warning</title>

3b2d0dc9701458b42e573190ffe7344315d7bd31nd <p>Turning off the trailing slash redirect may result in an information

3b2d0dc9701458b42e573190ffe7344315d7bd31nd disclosure. Consider a situation where <module>mod_autoindex</module> is

3b2d0dc9701458b42e573190ffe7344315d7bd31nd active (<code>Options +Indexes</code>) and <directive module="mod_dir"

3b2d0dc9701458b42e573190ffe7344315d7bd31nd >DirectoryIndex</directive> is set to a valid resource (say,

3b2d0dc9701458b42e573190ffe7344315d7bd31nd <code>index.html</code>) and there's no other special handler defined for

3b2d0dc9701458b42e573190ffe7344315d7bd31nd that URL. In this case a request with a trailing slash would show the

3b2d0dc9701458b42e573190ffe7344315d7bd31nd <code>index.html</code> file. <strong>But a request without trailing slash

3b2d0dc9701458b42e573190ffe7344315d7bd31nd would list the directory contents</strong>.</p>

3b2d0dc9701458b42e573190ffe7344315d7bd31nd </note>

3b2d0dc9701458b42e573190ffe7344315d7bd31nd</usage>

3b2d0dc9701458b42e573190ffe7344315d7bd31nd</directivesynopsis>

a3de986b8f062c83ceda21a7389787712214b02cniq<directivesynopsis>

80370e62044bea458bcd0545c59cb864ed117b04niq<name>FallbackResource</name>

a3de986b8f062c83ceda21a7389787712214b02cniq<description>Define a default URL for requests that don't map to a file</description>

80370e62044bea458bcd0545c59cb864ed117b04niq<syntax>FallbackResource <var>local-url</var></syntax>

a3de986b8f062c83ceda21a7389787712214b02cniq<default>None - httpd will return 404 (Not Found)</default>

a3de986b8f062c83ceda21a7389787712214b02cniq<contextlist><context>server config</context><context>virtual host</context>

a3de986b8f062c83ceda21a7389787712214b02cniq<context>directory</context><context>.htaccess</context></contextlist>

a3de986b8f062c83ceda21a7389787712214b02cniq<override>Indexes</override>

a3de986b8f062c83ceda21a7389787712214b02cniq<usage>

a3de986b8f062c83ceda21a7389787712214b02cniq <p>Use this to set a handler for any URL that doesn't map to anything

a3de986b8f062c83ceda21a7389787712214b02cniq in your filesystem, and would otherwise return HTTP 404 (Not Found).

a3de986b8f062c83ceda21a7389787712214b02cniq For example</p>

a3de986b8f062c83ceda21a7389787712214b02cniq <example>

80370e62044bea458bcd0545c59cb864ed117b04niq <code>FallbackResource not-404.php</code>

a3de986b8f062c83ceda21a7389787712214b02cniq </example>

a3de986b8f062c83ceda21a7389787712214b02cniq <p>will cause requests for non-existent files to be handled by

561dfbf9bb1f0799ca6676e3475703959d3032adniq <code>not-404.php</code>, while requests for files that exist

a3de986b8f062c83ceda21a7389787712214b02cniq are unaffected.</p>

9750e43c0e01cbb2cda812fef5f341de512f03f5rbowen <p>It is frequently desirable to have a single file or resource

9750e43c0e01cbb2cda812fef5f341de512f03f5rbowen handle all requests to a particular directory, except those requests

9750e43c0e01cbb2cda812fef5f341de512f03f5rbowen that correspond to an existing file or script. This is often

9750e43c0e01cbb2cda812fef5f341de512f03f5rbowen referred to as a 'front controller.'</p>

9750e43c0e01cbb2cda812fef5f341de512f03f5rbowen <p>In earlier versions of httpd, this effect typically required

9750e43c0e01cbb2cda812fef5f341de512f03f5rbowen <module>mod_rewrite</module>, and the use of the <code>-f</code> and

9750e43c0e01cbb2cda812fef5f341de512f03f5rbowen <code>-d</code> tests for file and directory existence. This now

9750e43c0e01cbb2cda812fef5f341de512f03f5rbowen requires only one line of configuration.</p>

9750e43c0e01cbb2cda812fef5f341de512f03f5rbowen <example>

9750e43c0e01cbb2cda812fef5f341de512f03f5rbowen <code>FallbackResource index.php</code>

9750e43c0e01cbb2cda812fef5f341de512f03f5rbowen </example>

9750e43c0e01cbb2cda812fef5f341de512f03f5rbowen <p>Existing files, such as images, css files, and so on, will be

9750e43c0e01cbb2cda812fef5f341de512f03f5rbowen served normally.</p>

a3de986b8f062c83ceda21a7389787712214b02cniq</usage>

a3de986b8f062c83ceda21a7389787712214b02cniq</directivesynopsis>

3b2d0dc9701458b42e573190ffe7344315d7bd31nd

7db9f691a00ead175b03335457ca296a33ddf31bnd</modulesynopsis>