mod_alias.html revision 240a5b8962329911d02566b600be6226e1f857ae
5066N/A<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
5066N/AXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
5066N/A This file is generated from xml source: DO NOT EDIT
5066N/AXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
5066N/A--><title>mod_alias - Apache HTTP Server</title><link rel="stylesheet" type="text/css" href="/style/manual.css"/></head><body><blockquote><div align="center"><img src="/images/sub.gif" alt="[APACHE DOCUMENTATION]"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_alias</h1><table bgcolor="#cccccc" cellpadding="0" cellspacing="1"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td>Provides for mapping different parts of the host
5066N/A filesystem in the document tree and for URL redirection</td></tr><tr><td><a class="help" href="module-dict.html#Status">Status:</a></td><td>Base</td></tr><tr><td><a class="help" href="module-dict.html#ModuleIdentifier">Module&nbsp;Identifier:</a></td><td>alias_module</td></tr></table></td></tr></table><h2>Summary</h2>
5066N/A <p>The directives contained in this module allow for manipulation
5066N/A and control of URLs as requests arrive at the server. The
5066N/A <a class="directive" href="#alias"><code class="directive">Alias</code></a> and <a class="directive" href="#scriptalias"><code class="directive">ScriptAlias</code></a> directives are used to
5066N/A map between URLs and filesystem paths. This allows for content
5066N/A which is not directly under the <a class="directive" href="core.html#documentroot"><code class="directive">DocumentRoot</code></a> served as part of the web
5066N/A document tree. The <a class="directive" href="#scriptalias"><code class="directive">ScriptAlias</code></a> directive has the
5066N/A additional effect of marking the target directory as containing
5066N/A only CGI scripts.</p>
5066N/A
5066N/A <p>The <a class="directive" href="#redirect"><code class="directive">Redirect</code></a>
5066N/A directives are used to instruct clients to make a new request with
5066N/A a different URL. They are often used when a resource has moved to
5066N/A a new location.</p>
5066N/A<h2>Directives</h2><ul><li><a href="#alias">Alias</a></li><li><a href="#aliasmatch">AliasMatch</a></li><li><a href="#redirect">Redirect</a></li><li><a href="#redirectmatch">RedirectMatch</a></li><li><a href="#redirectpermanent">RedirectPermanent</a></li><li><a href="#redirecttemp">RedirectTemp</a></li><li><a href="#scriptalias">ScriptAlias</a></li><li><a href="#scriptaliasmatch">ScriptAliasMatch</a></li></ul><p><strong>See also </strong></p><ul><li><code><a href="mod_rewrite.html">mod_rewrite</a></code></li><li><a href="/urlmapping.html">Mapping URLs to the filesystem</a></li></ul><hr/><h2><a name="Alias">Alias</a> <a name="alias">Directive</a></h2><table bgcolor="#cccccc" border="0" cellspacing="0" cellpadding="1"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Maps URLs to filesystem locations</td></tr><tr><td><a class="help" href="directive-dict.html#Syntax">Syntax:</a></td><td> Alias <em>URL-path
5066N/A file-path</em>|<em>directory-path</em></td></tr><tr><td><a class="help" href="directive-dict.html#Context">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a class="help" href="directive-dict.html#Status">Status:</a></td><td>Base</td></tr><tr><td><a class="help" href="directive-dict.html#Module">Module:</a></td><td>mod_alias</td></tr></table></td></tr></table>
5066N/A
5066N/A <p>The <code class="directive">Alias</code> directive allows documents to
5066N/A be stored in the local filesystem other than under the
5066N/A <a class="directive" href="core.html#documentroot"><code class="directive">DocumentRoot</code></a>. URLs with a
5488N/A (%-decoded) path beginning with <em>url-path</em> will be mapped
5066N/A to local files beginning with <em>directory-filename</em>.</p>
5066N/A
5066N/A <p>Example:</p>
5066N/A
5066N/A<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>Alias /image /ftp/pub/image</code></td></tr></table></blockquote>
5066N/A
5066N/A <p>A request for http://myserver/image/foo.gif would cause the
5066N/A server to return the file /ftp/pub/image/foo.gif.</p>
5066N/A
5066N/A <p>Note that if you include a trailing / on the
5066N/A <em>url-path</em> then the server will require a trailing / in
5066N/A order to expand the alias. That is, if you use <code>Alias
5492N/A /icons/ /usr/local/apache/icons/</code> then the url
5066N/A <code>/icons</code> will not be aliased.</p>
5066N/A
5066N/A <p>Note that you may need to specify additional <a class="directive" href="core.html#<directory>"><code class="directive">&lt;Directory&gt;</code></a> sections which cover
5066N/A the <em>destination</em> of aliases. Aliasing occurs before
5066N/A <a class="directive" href="core.html#<directory>"><code class="directive">&lt;Directory&gt;</code></a> sections
5066N/A are checked, so only the destination of aliases are affected.
5066N/A (Note however <a class="directive" href="core.html#<location>"><code class="directive">&lt;Location&gt;</code></a>
5066N/A sections are run through once before aliases are performed, so
5066N/A they will apply.)</p>
5066N/A
5066N/A<hr/><h2><a name="AliasMatch">AliasMatch</a> <a name="aliasmatch">Directive</a></h2><table bgcolor="#cccccc" border="0" cellspacing="0" cellpadding="1"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Maps URLs to filesystem locations using regular
5066N/Aexpressions</td></tr><tr><td><a class="help" href="directive-dict.html#Syntax">Syntax:</a></td><td>AliasMatch <em>regex
5066N/A file-path</em>|<em>directory-path</em></td></tr><tr><td><a class="help" href="directive-dict.html#Context">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a class="help" href="directive-dict.html#Status">Status:</a></td><td>Base</td></tr><tr><td><a class="help" href="directive-dict.html#Module">Module:</a></td><td>mod_alias</td></tr></table></td></tr></table>
5066N/A <p>This directive is equivalent to <a class="directive" href="#alias"><code class="directive">Alias</code></a>, but makes use of standard
5066N/A regular expressions, instead of simple prefix matching. The
5066N/A supplied regular expression is matched against the URL-path, and
5066N/A if it matches, the server will substitute any parenthesized
5066N/A matches into the given string and use it as a filename. For
5066N/A example, to activate the <code>/icons</code> directory, one might
5066N/A use:</p>
5066N/A<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
5066N/A AliasMatch ^/icons(.*) /usr/local/apache/icons$1
5066N/A</code></td></tr></table></blockquote>
5066N/A<hr/><h2><a name="Redirect">Redirect</a> <a name="redirect">Directive</a></h2><table bgcolor="#cccccc" border="0" cellspacing="0" cellpadding="1"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sends an external redirect asking the client to fetch
5066N/Aa different URL</td></tr><tr><td><a class="help" href="directive-dict.html#Syntax">Syntax:</a></td><td>Redirect [<em>status</em>] <em>URL-path URL</em></td></tr><tr><td><a class="help" href="directive-dict.html#Context">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a class="help" href="directive-dict.html#Override">Override:</a></td><td>FileInfo</td></tr><tr><td><a class="help" href="directive-dict.html#Status">Status:</a></td><td>Base</td></tr><tr><td><a class="help" href="directive-dict.html#Module">Module:</a></td><td>mod_alias</td></tr></table></td></tr></table>
5066N/A <p>The Redirect directive maps an old URL into a new one. The
5066N/A new URL is returned to the client which attempts to fetch it
5066N/A again with the new address. <em>URL-path</em> a (%-decoded)
5066N/A path; any requests for documents beginning with this path will
5066N/A be returned a redirect error to a new (%-encoded) URL beginning
5066N/A with <em>URL</em>.</p>
5066N/A
5066N/A <p>Example:</p>
5066N/A
5066N/A<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>Redirect /service http://foo2.bar.com/service</code></td></tr></table></blockquote>
5066N/A
5066N/A <p>If the client requests http://myserver/service/foo.txt, it
5066N/A will be told to access http://foo2.bar.com/service/foo.txt
5066N/A instead.</p>
5066N/A
5066N/A<blockquote><table><tr><td bgcolor="#e0e5f5"><p align="center"><strong>Note</strong></p> <p>Redirect directives take precedence over
5066N/AAlias and ScriptAlias directives, irrespective of their ordering in
5066N/Athe configuration file. Also, <em>URL-path</em> must be an absolute
5066N/Apath, not a relative path, even when used with .htaccess files or
5066N/Ainside of <a class="directive" href="core.html#<directory>"><code class="directive">&lt;Directory&gt;</code></a>
5066N/Asections.</p></td></tr></table></blockquote>
5066N/A
5066N/A <p>If no <em>status</em> argument is given, the redirect will
5066N/A be "temporary" (HTTP status 302). This indicates to the client
5066N/A that the resource has moved temporarily. The <em>status</em>
5066N/A argument can be used to return other HTTP status codes:</p>
5066N/A
5066N/A <dl>
5066N/A <dt>permanent</dt>
5066N/A
5066N/A <dd>Returns a permanent redirect status (301) indicating that
5066N/A the resource has moved permanently.</dd>
5066N/A
5066N/A <dt>temp</dt>
5066N/A
5066N/A <dd>Returns a temporary redirect status (302). This is the
5066N/A default.</dd>
5066N/A
5066N/A <dt>seeother</dt>
5066N/A
5066N/A <dd>Returns a "See Other" status (303) indicating that the
5066N/A resource has been replaced.</dd>
5066N/A
5066N/A <dt>gone</dt>
5066N/A
5066N/A <dd>Returns a "Gone" status (410) indicating that the
5066N/A resource has been permanently removed. When this status is
5066N/A used the <em>url</em> argument should be omitted.</dd>
5066N/A </dl>
5066N/A
5066N/A <p>Other status codes can be returned by giving the numeric
5066N/A status code as the value of <em>status</em>. If the status is
5066N/A between 300 and 399, the <em>url</em> argument must be present,
5066N/A otherwise it must be omitted. Note that the status must be
5066N/A known to the Apache code (see the function
5066N/A <code>send_error_response</code> in http_protocol.c).</p>
5066N/A<hr/><h2><a name="RedirectMatch">RedirectMatch</a> <a name="redirectmatch">Directive</a></h2><table bgcolor="#cccccc" border="0" cellspacing="0" cellpadding="1"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sends an external redirect asking the client to fetch
5066N/Aa different URL based on a regular expression match of the
5066N/Acurrent URL</td></tr><tr><td><a class="help" href="directive-dict.html#Syntax">Syntax:</a></td><td>RedirectMatch [<em>status</em>] <em>regex URL</em></td></tr><tr><td><a class="help" href="directive-dict.html#Context">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a class="help" href="directive-dict.html#Override">Override:</a></td><td>FileInfo</td></tr><tr><td><a class="help" href="directive-dict.html#Status">Status:</a></td><td>Base</td></tr><tr><td><a class="help" href="directive-dict.html#Module">Module:</a></td><td>mod_alias</td></tr></table></td></tr></table>
5066N/A <p>This directive is equivalent to <a class="directive" href="#redirect"><code class="directive">Redirect</code></a>, but makes use of standard
5066N/A regular expressions, instead of simple prefix matching. The
5066N/A supplied regular expression is matched against the URL-path, and
5066N/A if it matches, the server will substitute any parenthesized
5066N/A matches into the given string and use it as a filename. For
5066N/A example, to redirect all GIF files to like-named JPEG files on
5066N/A another server, one might use:</p>
5066N/A<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
5066N/A RedirectMatch (.*)\.gif$ http://www.anotherserver.com$1.jpg
5066N/A</code></td></tr></table></blockquote>
5066N/A<hr/><h2><a name="RedirectPermanent">RedirectPermanent</a> <a name="redirectpermanent">Directive</a></h2><table bgcolor="#cccccc" border="0" cellspacing="0" cellpadding="1"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sends an external permanent redirect asking the client to fetch
5066N/Aa different URL</td></tr><tr><td><a class="help" href="directive-dict.html#Syntax">Syntax:</a></td><td>RedirectPermanent <em>URL-path URL</em></td></tr><tr><td><a class="help" href="directive-dict.html#Context">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a class="help" href="directive-dict.html#Override">Override:</a></td><td>FileInfo</td></tr><tr><td><a class="help" href="directive-dict.html#Status">Status:</a></td><td>Base</td></tr><tr><td><a class="help" href="directive-dict.html#Module">Module:</a></td><td>mod_alias</td></tr></table></td></tr></table>
5066N/A <p>This directive makes the client know that the Redirect is
5066N/A permanent (status 301). Exactly equivalent to <code>Redirect
5066N/A permanent</code>.</p>
5066N/A<hr/><h2><a name="RedirectTemp">RedirectTemp</a> <a name="redirecttemp">Directive</a></h2><table bgcolor="#cccccc" border="0" cellspacing="0" cellpadding="1"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sends an external temporary redirect asking the client to fetch
5066N/Aa different URL</td></tr><tr><td><a class="help" href="directive-dict.html#Syntax">Syntax:</a></td><td>RedirectTemp <em>URL-path URL</em></td></tr><tr><td><a class="help" href="directive-dict.html#Context">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a class="help" href="directive-dict.html#Override">Override:</a></td><td>FileInfo</td></tr><tr><td><a class="help" href="directive-dict.html#Status">Status:</a></td><td>Base</td></tr><tr><td><a class="help" href="directive-dict.html#Module">Module:</a></td><td>mod_alias</td></tr></table></td></tr></table>
5066N/A <p>This directive makes the client know that the Redirect is
5066N/A only temporary (status 302). Exactly equivalent to
5066N/A <code>Redirect temp</code>.</p>
5066N/A<hr/><h2><a name="ScriptAlias">ScriptAlias</a> <a name="scriptalias">Directive</a></h2><table bgcolor="#cccccc" border="0" cellspacing="0" cellpadding="1"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Maps a URL to a filesystem location and designates the
5066N/Atarget as a CGI script</td></tr><tr><td><a class="help" href="directive-dict.html#Syntax">Syntax:</a></td><td>ScriptAlias
5066N/A<em>URL-path file-path</em>|<em>directory-path</em></td></tr><tr><td><a class="help" href="directive-dict.html#Context">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a class="help" href="directive-dict.html#Status">Status:</a></td><td>Base</td></tr><tr><td><a class="help" href="directive-dict.html#Module">Module:</a></td><td>mod_alias</td></tr></table></td></tr></table>
5066N/A <p>The <code class="directive">ScriptAlias</code> directive has the same
5066N/A behavior as the <a class="directive" href="#alias"><code class="directive">Alias</code></a>
5066N/A directive, except that in addition it marks the target directory
5066N/A as containing CGI scripts that will be processed by <code><a href="mod_cgi.html">mod_cgi</a></code>'s cgi-script handler. URLs with a
5066N/A (%-decoded) path beginning with <em>URL-path</em> will be mapped
5066N/A to scripts beginning with the second argument which is a full
5066N/A pathname in the local filesystem.</p>
5066N/A
5066N/A <p>Example:</p>
5066N/A
5066N/A<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>ScriptAlias /cgi-bin/ /web/cgi-bin/</code></td></tr></table></blockquote>
5066N/A
5066N/A <p>A request for <code>http://myserver/cgi-bin/foo</code> would cause the
5066N/A server to run the script <code>/web/cgi-bin/foo</code>.</p>
5066N/A<hr/><h2><a name="ScriptAliasMatch">ScriptAliasMatch</a> <a name="scriptaliasmatch">Directive</a></h2><table bgcolor="#cccccc" border="0" cellspacing="0" cellpadding="1"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Maps a URL to a filesystem location using a regular expression
5066N/Aand designates the target as a CGI script</td></tr><tr><td><a class="help" href="directive-dict.html#Syntax">Syntax:</a></td><td>ScriptAliasMatch
5066N/A<em>regex file-path</em>|<em>directory-path</em></td></tr><tr><td><a class="help" href="directive-dict.html#Context">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a class="help" href="directive-dict.html#Status">Status:</a></td><td>Base</td></tr><tr><td><a class="help" href="directive-dict.html#Module">Module:</a></td><td>mod_alias</td></tr></table></td></tr></table>
5066N/A <p>This directive is equivalent to <a class="directive" href="#scriptalias"><code class="directive">ScriptAlias</code></a>, but makes use of standard
5066N/A regular expressions, instead of simple prefix matching. The
5066N/A supplied regular expression is matched against the URL-path,
5066N/A and if it matches, the server will substitute any parenthesized
5066N/A matches into the given string and use it as a filename. For
5066N/A example, to activate the standard <code>/cgi-bin</code>, one
5066N/A might use:</p>
5066N/A<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
5066N/A ScriptAliasMatch ^/cgi-bin(.*) /usr/local/apache/cgi-bin$1
5066N/A</code></td></tr></table></blockquote>
5066N/A<hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img src="/images/index.gif" alt="Index"/></a><a href="../"><img src="/images/home.gif" alt="Home"/></a></blockquote></body></html>