diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 15:01:30 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 15:01:30 +0000 |
| commit | 6beeb1b708550be0d4a53b272283e17e5e35fe17 (patch) | |
| tree | 1ce8673d4aaa948e5554000101f46536a1e4cc29 /docs/manual/mod/mod_dir.html.en | |
| parent | Initial commit. (diff) | |
| download | apache2-upstream/2.4.57.tar.xz apache2-upstream/2.4.57.zip | |
Adding upstream version 2.4.57.upstream/2.4.57
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'docs/manual/mod/mod_dir.html.en')
| -rw-r--r-- | docs/manual/mod/mod_dir.html.en | 349 |
1 files changed, 349 insertions, 0 deletions
diff --git a/docs/manual/mod/mod_dir.html.en b/docs/manual/mod/mod_dir.html.en new file mode 100644 index 0000000..f3f53f9 --- /dev/null +++ b/docs/manual/mod/mod_dir.html.en @@ -0,0 +1,349 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!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> +<meta content="text/html; charset=UTF-8" http-equiv="Content-Type" /> +<!-- + XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + This file is generated from xml source: DO NOT EDIT + XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + --> +<title>mod_dir - Apache HTTP Server Version 2.4</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.min.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="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p> +<p class="apache">Apache HTTP Server Version 2.4</p> +<img alt="" src="../images/feather.png" /></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.4</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"><a href="https://www.apache.org/foundation/contributing.html" class="badge"><img src="https://www.apache.org/images/SupportApache-small.png" alt="Support Apache!" /></a><h3 class="directives">Directives</h3> +<ul id="toc"> +<li><img alt="" src="../images/down.gif" /> <a href="#directorycheckhandler">DirectoryCheckHandler</a></li> +<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> +<h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&list_id=144532&product=Apache%20httpd-2&query_format=specific&order=changeddate%20DESC%2Cpriority%2Cbug_severity&component=mod_dir">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&component=mod_dir">Report a bug</a></li></ul><h3>See also</h3> +<ul class="seealso"> +<li><a href="#comments_section">Comments</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="DirectoryCheckHandler" id="DirectoryCheckHandler">DirectoryCheckHandler</a> <a name="directorycheckhandler" id="directorycheckhandler">Directive</a></h2> +<table class="directive"> +<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Toggle how this module responds when another handler is configured</td></tr> +<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DirectoryCheckHandler On|Off</code></td></tr> +<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>DirectoryCheckHandler 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 2.4.8 and later. Releases prior to 2.4 implicitly +act as if "DirectoryCheckHandler ON" was specified.</td></tr> +</table> + <p>The <code class="directive">DirectoryCheckHandler</code> directive determines + whether <code class="module"><a href="../mod/mod_dir.html">mod_dir</a></code> should check for directory indexes or + add trailing slashes when some other handler has been configured for + the current URL. Handlers can be set by directives such as + <code class="directive"><a href="../mod/core.html#sethandler">SetHandler</a></code> or by other modules, + such as <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> during per-directory substitutions. + </p> + + <p> In releases prior to 2.4, this module did not take any action if any + other handler was configured for a URL. This allows directory indexes to + be served even when a <code class="directive">SetHandler</code> directive is + specified for an entire directory, but it can also result in some conflicts + with modules such as <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>.</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="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> + + <p><strong>Note:</strong> Multiple <code class="directive">DirectoryIndex</code> + directives within the <a href="../sections.html"><em>same context</em></a> will add + to the list of resources to look for rather than replace: + </p> + <pre class="prettyprint lang-config"># Example A: Set index.html as an index page, then add index.php to that list as well. +<Directory "/foo"> + DirectoryIndex index.html + DirectoryIndex index.php +</Directory> + +# Example B: This is identical to example A, except it's done with a single directive. +<Directory "/foo"> + DirectoryIndex index.html index.php +</Directory> + +# Example C: To replace the list, you must explicitly reset it first: +# In this example, only index.php will remain as an index resource. +<Directory "/foo"> + DirectoryIndex index.html + DirectoryIndex disabled + DirectoryIndex index.php +</Directory></pre> + + + +</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> + + <p>The argument can be:</p> + <ul> + <li><code>on</code>: issues a 302 redirection to the index resource.</li> + <li><code>off</code>: does not issue a redirection. This is the legacy behaviour of mod_dir.</li> + <li><code>permanent</code>: issues a 301 (permanent) redirection to the index resource.</li> + <li><code>temp</code>: this has the same effect as <code>on</code></li> + <li><code>seeother</code>: issues a 303 redirection (also known as "See Other") to the index resource.</li> + <li><var>3xx-code</var>: issues a redirection marked by the chosen 3xx code.</li> + </ul> + + + <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> +</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 disabled | <var>local-url</var></code></td></tr> +<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>disabled - 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> +<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>The <code>disabled</code> argument is available in version 2.4.4 and +later</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>Use the <code>disabled</code> argument to disable that feature + if inheritance from a parent directory is not desired.</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> +<Directory "/web/example.com/htdocs/blog/images"> + FallbackResource disabled +</Directory></pre> + + <p>A fallback handler (in the above case, <code>/blog/index.php</code>) + can access the original requested URL via the server variable + <code>REQUEST_URI</code>. For example, to access this variable in PHP, + use <code>$_SERVER['REQUEST_URI']</code>.</p> + +</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 class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Libera.chat, or sent to our <a href="https://httpd.apache.org/lists.html">mailing lists</a>.</div> +<script type="text/javascript"><!--//--><![CDATA[//><!-- +var comments_shortname = 'httpd'; +var comments_identifier = 'http://httpd.apache.org/docs/2.4/mod/mod_dir.html'; +(function(w, d) { + if (w.location.hostname.toLowerCase() == "httpd.apache.org") { + d.write('<div id="comments_thread"><\/div>'); + var s = d.createElement('script'); + s.type = 'text/javascript'; + s.async = true; + s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; + (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); + } + else { + d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>'); + } +})(window, document); +//--><!]]></script></div><div id="footer"> +<p class="apache">Copyright 2023 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="http://wiki.apache.org/httpd/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>
\ No newline at end of file |