mod_dir.xml revision 68ac503285e50f47ed404dcd7daaad8c6b99710b
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter<!-- $LastChangedRevision$ -->
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter Licensed to the Apache Software Foundation (ASF) under one or more
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter contributor license agreements. See the NOTICE file distributed with
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter this work for additional information regarding copyright ownership.
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter The ASF licenses this file to You under the Apache License, Version 2.0
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter (the "License"); you may not use this file except in compliance with
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter the License. You may obtain a copy of the License at
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter Unless required by applicable law or agreed to in writing, software
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter distributed under the License is distributed on an "AS IS" BASIS,
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter See the License for the specific language governing permissions and
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter limitations under the License.
65e99be301d5a19db33f25841f671756e8dbb9b5ludovicp<description>Provides for "trailing slash" redirects and
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter serving directory index files</description>
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter <p>The index of a directory can come from one of two sources:</p>
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter <li>A file written by the user, typically called
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter <code>index.html</code>. The <directive module="mod_dir"
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter >DirectoryIndex</directive> directive sets the
9aa7345ed04cb0b19c9302863d6012606c67c0c6kenneth_suter name of this file. This is controlled by
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter <li>Otherwise, a listing generated by the server. This is
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter provided by <module>mod_autoindex</module>.</li>
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter <p>The two functions are separated so that you can completely
9aa7345ed04cb0b19c9302863d6012606c67c0c6kenneth_suter remove (or replace) automatic index generation should you want
9aa7345ed04cb0b19c9302863d6012606c67c0c6kenneth_suter <p>A "trailing slash" redirect is issued when the server
9b761258216936f3551ace24acfd987f32791d67jvergara receives a request for a URL
9aa7345ed04cb0b19c9302863d6012606c67c0c6kenneth_suter <code>http://servername/foo/dirname</code> where
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter <code>dirname</code> is a directory. Directories require a
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter trailing slash, so <module>mod_dir</module> issues a redirect to
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter <code>http://servername/foo/dirname/</code>.</p>
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter<directivesynopsis>
9aa7345ed04cb0b19c9302863d6012606c67c0c6kenneth_suter<description>List of resources to look for when the client requests
9aa7345ed04cb0b19c9302863d6012606c67c0c6kenneth_sutera directory</description>
9aa7345ed04cb0b19c9302863d6012606c67c0c6kenneth_suter<syntax>DirectoryIndex
9aa7345ed04cb0b19c9302863d6012606c67c0c6kenneth_suter disabled | <var>local-url</var> [<var>local-url</var>] ...</syntax>
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter<contextlist><context>server config</context><context>virtual host</context>
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter<context>directory</context><context>.htaccess</context></contextlist>
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter <p>The <directive>DirectoryIndex</directive> directive sets the
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter list of resources to look for, when the client requests an index
9aa7345ed04cb0b19c9302863d6012606c67c0c6kenneth_suter of the directory by specifying a / at the end of the directory
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter name. <var>Local-url</var> is the (%-encoded) URL of a document on
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter the server relative to the requested directory; it is usually the
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter name of a file in the directory. Several URLs may be given, in
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter which case the server will return the first one that it finds. If
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter none of the resources exist and the <code>Indexes</code> option is
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter set, the server will generate its own listing of the
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter directory.</p>
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter DirectoryIndex index.html
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter <p>then a request for <code>http://example.com/docs/</code> would
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter return <code>http://example.com/docs/index.html</code> if it
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter exists, or would list the directory if it did not.</p>
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter <p>Note that the documents do not need to be relative to the
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter directory;</p>
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter DirectoryIndex index.html index.txt /cgi-bin/index.pl
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter <p>would cause the CGI script <code>/cgi-bin/index.pl</code> to be
4e75d856e42d4ea01d4a4ed72534266c45b4a99djvergara executed if neither <code>index.html</code> or <code>index.txt</code>
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter existed in a directory.</p>
4e75d856e42d4ea01d4a4ed72534266c45b4a99djvergara <p>A single argument of "disabled" prevents <module>mod_dir</module> from
4e75d856e42d4ea01d4a4ed72534266c45b4a99djvergara searching for an index. An argument of "disabled" will be interpeted
4e75d856e42d4ea01d4a4ed72534266c45b4a99djvergara literally if it has any arguments before or after it, even if they are "disabled"
4e75d856e42d4ea01d4a4ed72534266c45b4a99djvergara as well.</p>
4e75d856e42d4ea01d4a4ed72534266c45b4a99djvergara</directivesynopsis>
4e75d856e42d4ea01d4a4ed72534266c45b4a99djvergara<directivesynopsis>
4e75d856e42d4ea01d4a4ed72534266c45b4a99djvergara<description>Configures an external redirect for directory indexes.
4e75d856e42d4ea01d4a4ed72534266c45b4a99djvergara</description>
4e75d856e42d4ea01d4a4ed72534266c45b4a99djvergara<syntax>DirectoryIndexRedirect on | off | permanent | temp | seeother |
4e75d856e42d4ea01d4a4ed72534266c45b4a99djvergara<contextlist><context>server config</context><context>virtual host</context>
4e75d856e42d4ea01d4a4ed72534266c45b4a99djvergara<context>directory</context><context>.htaccess</context></contextlist>
4e75d856e42d4ea01d4a4ed72534266c45b4a99djvergara<compatability>Available in version 2.3.14 and later</compatability>
9b761258216936f3551ace24acfd987f32791d67jvergara <p>By default, the <directive>DirectoryIndex</directive> is selected
4e75d856e42d4ea01d4a4ed72534266c45b4a99djvergara and returned transparently to the client. <directive
4e75d856e42d4ea01d4a4ed72534266c45b4a99djvergara >DirectoryIndexRedirect</directive> causes an external redirect
4e75d856e42d4ea01d4a4ed72534266c45b4a99djvergara to instead be issued.</p>
4e75d856e42d4ea01d4a4ed72534266c45b4a99djvergara DirectoryIndexRedirect on
4e75d856e42d4ea01d4a4ed72534266c45b4a99djvergara <p>A request for <code>http://example.com/docs/</code> would
4e75d856e42d4ea01d4a4ed72534266c45b4a99djvergara return a temporary redirect to <code
4e75d856e42d4ea01d4a4ed72534266c45b4a99djvergara if it exists.</p>
4e75d856e42d4ea01d4a4ed72534266c45b4a99djvergara</directivesynopsis>
4e75d856e42d4ea01d4a4ed72534266c45b4a99djvergara<directivesynopsis>
4e75d856e42d4ea01d4a4ed72534266c45b4a99djvergara<description>Toggle trailing slash redirects on or off</description>
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter<contextlist><context>server config</context><context>virtual host</context>
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter<context>directory</context><context>.htaccess</context></contextlist>
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter<compatibility>Available in version 2.0.51 and later</compatibility>
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter <p>The <directive>DirectorySlash</directive> directive determines whether
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter <module>mod_dir</module> should fixup URLs pointing to a directory or
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter <p>Typically if a user requests a resource without a trailing slash, which
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter points to a directory, <module>mod_dir</module> redirects him to the same
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter resource, but <em>with</em> trailing slash for some good reasons:</p>
4e75d856e42d4ea01d4a4ed72534266c45b4a99djvergara <li>The user is finally requesting the canonical URL of the resource</li>
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter <li><module>mod_autoindex</module> works correctly. Since it doesn't emit
9b761258216936f3551ace24acfd987f32791d67jvergara the path in the link, it would point to the wrong path.</li>
9aa7345ed04cb0b19c9302863d6012606c67c0c6kenneth_suter <li><directive module="mod_dir">DirectoryIndex</directive> will be evaluated
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter <em>only</em> for directories requested with trailing slash.</li>
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter <li>Relative URL references inside html pages will work correctly.</li>
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter <p>If you don't want this effect <em>and</em> the reasons above don't
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter apply to you, you can turn off the redirect as shown below. However,
9aa7345ed04cb0b19c9302863d6012606c67c0c6kenneth_suter be aware that there are possible security implications to doing
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter # see security warning below!<br />
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter DirectorySlash Off<br />
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter SetHandler some-handler<br />
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter </Location>
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter <note type="warning"><title>Security Warning</title>
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter <p>Turning off the trailing slash redirect may result in an information
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter disclosure. Consider a situation where <module>mod_autoindex</module> is
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter active (<code>Options +Indexes</code>) and <directive module="mod_dir"
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter >DirectoryIndex</directive> is set to a valid resource (say,
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter <code>index.html</code>) and there's no other special handler defined for
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter that URL. In this case a request with a trailing slash would show the
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter <code>index.html</code> file. <strong>But a request without trailing slash
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter would list the directory contents</strong>.</p>
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter</directivesynopsis>
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter<directivesynopsis>
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter<description>Define a default URL for requests that don't map to a file</description>
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter<syntax>FallbackResource <var>local-url</var></syntax>
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter<default>None - httpd will return 404 (Not Found)</default>
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter<contextlist><context>server config</context><context>virtual host</context>
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter<context>directory</context><context>.htaccess</context></contextlist>
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter <p>Use this to set a handler for any URL that doesn't map to anything
9b761258216936f3551ace24acfd987f32791d67jvergara in your filesystem, and would otherwise return HTTP 404 (Not Found).
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter For example</p>
e7b89fa07f734d79858edc56f1078a08f8b66d46kenneth_suter <p>will cause requests for non-existent files to be handled by
9aa7345ed04cb0b19c9302863d6012606c67c0c6kenneth_suter <code>not-404.php</code>, while requests for files that exist
9aa7345ed04cb0b19c9302863d6012606c67c0c6kenneth_suter are unaffected.</p>
9aa7345ed04cb0b19c9302863d6012606c67c0c6kenneth_suter <p>It is frequently desirable to have a single file or resource
9aa7345ed04cb0b19c9302863d6012606c67c0c6kenneth_suter handle all requests to a particular directory, except those requests
9aa7345ed04cb0b19c9302863d6012606c67c0c6kenneth_suter that correspond to an existing file or script. This is often
9aa7345ed04cb0b19c9302863d6012606c67c0c6kenneth_suter referred to as a 'front controller.'</p>
9aa7345ed04cb0b19c9302863d6012606c67c0c6kenneth_suter <p>In earlier versions of httpd, this effect typically required
9aa7345ed04cb0b19c9302863d6012606c67c0c6kenneth_suter <module>mod_rewrite</module>, and the use of the <code>-f</code> and
9aa7345ed04cb0b19c9302863d6012606c67c0c6kenneth_suter <code>-d</code> tests for file and directory existence. This now
9aa7345ed04cb0b19c9302863d6012606c67c0c6kenneth_suter requires only one line of configuration.</p>
9aa7345ed04cb0b19c9302863d6012606c67c0c6kenneth_suter <p>Existing files, such as images, css files, and so on, will be
9aa7345ed04cb0b19c9302863d6012606c67c0c6kenneth_suter served normally.</p>
9aa7345ed04cb0b19c9302863d6012606c67c0c6kenneth_suter <p>In a sub-URI, such as <em>http://example.com/blog/</em> this
9aa7345ed04cb0b19c9302863d6012606c67c0c6kenneth_suter <em>sub-URI</em> has to be supplied as <var>local-url</var>:</p>
9aa7345ed04cb0b19c9302863d6012606c67c0c6kenneth_suter <Directory /web/example.com/htdocs/blog><br />
9aa7345ed04cb0b19c9302863d6012606c67c0c6kenneth_suter </Directory>
9aa7345ed04cb0b19c9302863d6012606c67c0c6kenneth_suter</directivesynopsis>
9aa7345ed04cb0b19c9302863d6012606c67c0c6kenneth_suter</modulesynopsis>