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

860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim 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>

7087ccb939b4146f850f4d482fd8ab13de6335dchumbedooh DirectoryIndex index.html

f5cbf3a7818c08d2f19c04fdf4f47257eea7d3c6nd </example>

7087ccb939b4146f850f4d482fd8ab13de6335dchumbedooh

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

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

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

68ac503285e50f47ed404dcd7daaad8c6b99710bcovener

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

6a7d71eb77725eb1b1091a94289696ab07946c7bslive directory;</p>

6a7d71eb77725eb1b1091a94289696ab07946c7bslive

6a7d71eb77725eb1b1091a94289696ab07946c7bslive <example>

6a7d71eb77725eb1b1091a94289696ab07946c7bslive DirectoryIndex index.html index.txt /cgi-bin/index.pl

7087ccb939b4146f850f4d482fd8ab13de6335dchumbedooh </example>

f5cbf3a7818c08d2f19c04fdf4f47257eea7d3c6nd

7087ccb939b4146f850f4d482fd8ab13de6335dchumbedooh <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>

6a7d71eb77725eb1b1091a94289696ab07946c7bslive existed in a directory.</p>

f5cbf3a7818c08d2f19c04fdf4f47257eea7d3c6nd

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

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

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

e2d704f65ae715639ae9d21d98bbf19ebcad58ffhumbedooh as well.</p>

b6d2c204c150843e48f6787c1090ae75b718896ecovener

b6d2c204c150843e48f6787c1090ae75b718896ecovener</usage>

63de18ba5e922ffaab500317d7d1d0ad6b27b7e2covener</directivesynopsis>

02c8e4c50471e515a88620bddba4d15ad2384f8bgryzor

02c8e4c50471e515a88620bddba4d15ad2384f8bgryzor<directivesynopsis>

efb7d0e919bad231c2147ae783cd12a2fe639577humbedooh<name>DirectorySlash</name>

1e54625c5f8d2ef6513949447c4f9cc7401120a3humbedooh<description>Toggle trailing slash redirects on or off</description>

1e54625c5f8d2ef6513949447c4f9cc7401120a3humbedooh<syntax>DirectorySlash On|Off</syntax>

efb7d0e919bad231c2147ae783cd12a2fe639577humbedooh<default>DirectorySlash On</default>

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

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

efb7d0e919bad231c2147ae783cd12a2fe639577humbedooh<override>Indexes</override>

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

efb7d0e919bad231c2147ae783cd12a2fe639577humbedooh

efb7d0e919bad231c2147ae783cd12a2fe639577humbedooh<usage>

efb7d0e919bad231c2147ae783cd12a2fe639577humbedooh <p>The <directive>DirectorySlash</directive> directive determines, whether

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

efb7d0e919bad231c2147ae783cd12a2fe639577humbedooh not.</p>

efb7d0e919bad231c2147ae783cd12a2fe639577humbedooh

066f5930841d824f2d8011b9abec9757e81e64e1humbedooh <p>Typically if a user requests a resource without a trailing slash, which

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

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

efb7d0e919bad231c2147ae783cd12a2fe639577humbedooh

efb7d0e919bad231c2147ae783cd12a2fe639577humbedooh <ul>

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

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

1e54625c5f8d2ef6513949447c4f9cc7401120a3humbedooh the path in the link, it would point to the wrong path.</li>

1e54625c5f8d2ef6513949447c4f9cc7401120a3humbedooh <li><directive module="mod_dir">DirectoryIndex</directive> will be evaluated

6a7d71eb77725eb1b1091a94289696ab07946c7bslive <em>only</em> for directories requested with trailing slash.</li>

6a7d71eb77725eb1b1091a94289696ab07946c7bslive <li>Relative URL references inside html pages will work correctly.</li>

6a7d71eb77725eb1b1091a94289696ab07946c7bslive </ul>

c7a0eab564f789b5272019889e3dfafa3767aa2bcovener

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

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

c7a0eab564f789b5272019889e3dfafa3767aa2bcovener

860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim <example>

c7a0eab564f789b5272019889e3dfafa3767aa2bcovener # see security warning below!<br />

c7a0eab564f789b5272019889e3dfafa3767aa2bcovener &lt;Location /some/path&gt;<br />

c7a0eab564f789b5272019889e3dfafa3767aa2bcovener <indent>

c7a0eab564f789b5272019889e3dfafa3767aa2bcovener DirectorySlash Off<br />

c7a0eab564f789b5272019889e3dfafa3767aa2bcovener SetHandler some-handler<br />

c7a0eab564f789b5272019889e3dfafa3767aa2bcovener </indent>

39648a91fe21ca9a7c979a0eded8ba358925c0c6lgentis &lt;/Location&gt;

c7a0eab564f789b5272019889e3dfafa3767aa2bcovener </example>

c7a0eab564f789b5272019889e3dfafa3767aa2bcovener

c7a0eab564f789b5272019889e3dfafa3767aa2bcovener <note type="warning"><title>Security Warning</title>

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

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

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

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

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

650401e2cb916188d0e1a280dfa78dd67e24ce3bgryzor that URL. In this case a request with a trailing slash would show the

650401e2cb916188d0e1a280dfa78dd67e24ce3bgryzor <code>index.html</code> file. <strong>But a request without trailing slash

650401e2cb916188d0e1a280dfa78dd67e24ce3bgryzor would list the directory contents</strong>.</p>

650401e2cb916188d0e1a280dfa78dd67e24ce3bgryzor </note>

650401e2cb916188d0e1a280dfa78dd67e24ce3bgryzor</usage>

650401e2cb916188d0e1a280dfa78dd67e24ce3bgryzor</directivesynopsis>

650401e2cb916188d0e1a280dfa78dd67e24ce3bgryzor<directivesynopsis>

650401e2cb916188d0e1a280dfa78dd67e24ce3bgryzor<name>DefaultMapping</name>

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

650401e2cb916188d0e1a280dfa78dd67e24ce3bgryzor<syntax>DefaultMapping <var>local-url</var></syntax>

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

7087ccb939b4146f850f4d482fd8ab13de6335dchumbedooh<contextlist><context>server config</context><context>virtual host</context>

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

7087ccb939b4146f850f4d482fd8ab13de6335dchumbedooh<override>Indexes</override>

c7a0eab564f789b5272019889e3dfafa3767aa2bcovener<usage>

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

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

c7a0eab564f789b5272019889e3dfafa3767aa2bcovener For example</p>

860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim <example>

c7a0eab564f789b5272019889e3dfafa3767aa2bcovener <code>DefaultMapping default.php</code>

c7a0eab564f789b5272019889e3dfafa3767aa2bcovener </example>

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

c7a0eab564f789b5272019889e3dfafa3767aa2bcovener <code>default.php</code>, while requests for files that exist

c7a0eab564f789b5272019889e3dfafa3767aa2bcovener are unaffected.</p>

c7a0eab564f789b5272019889e3dfafa3767aa2bcovener</usage>

3b2d0dc9701458b42e573190ffe7344315d7bd31nd</directivesynopsis>

3b2d0dc9701458b42e573190ffe7344315d7bd31nd

3b2d0dc9701458b42e573190ffe7344315d7bd31nd</modulesynopsis>

3b2d0dc9701458b42e573190ffe7344315d7bd31nd