granicus.if.org Git - apache/blob - docs/manual/mod/mod_alias.html.en

   1 <html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
   2           XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   3                 This file is generated from xml source: DO NOT EDIT
   4           XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   5         --><title>mod_alias- Apache HTTP Server</title><link href="../style/manual.css" type="text/css" rel="stylesheet"/></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 cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td>Provides for mapping different parts of the host
   6     filesystem in the document tree and for URL redirection</td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module&nbsp;Identifier:</a></td><td>alias_module</td></tr></table></td></tr></table><h2>Summary</h2>
   7     <p>The directives contained in this module allow for manipulation
   8     and control of URLs as requests arrive at the server. The
   9     <a href="#alias" class="directive"><code class="directive">Alias</code></a> and <a href="#scriptalias" class="directive"><code class="directive">ScriptAlias</code></a> directives are used to
  10     map between URLs and filesystem paths.  This allows for content
  11     which is not directly under the <a href="core.html#documentroot" class="directive"><code class="directive">DocumentRoot</code></a> served as part of the web
  12     document tree. The <a href="#scriptalias" class="directive"><code class="directive">ScriptAlias</code></a> directive has the
  13     additional effect of marking the target directory as containing
  14     only CGI scripts.</p>
  15
  16     <p>The <a href="#redirect" class="directive"><code class="directive">Redirect</code></a>
  17     directives are used to instruct clients to make a new request with
  18     a different URL. They are often used when a resource has moved to
  19     a new location.</p>
  20 <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 cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Maps URLs to filesystem locations</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td> Alias <em>URL-path
  21     file-path</em>|<em>directory-path</em></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_alias</td></tr></table></td></tr></table>
  22
  23     <p>The <code class="directive">Alias</code> directive allows documents to
  24     be stored in the local filesystem other than under the
  25     <a href="core.html#documentroot" class="directive"><code class="directive">DocumentRoot</code></a>. URLs with a
  26     (%-decoded) path beginning with <em>url-path</em> will be mapped
  27     to local files beginning with <em>directory-filename</em>.</p>
  28
  29     <p>Example:</p>
  30
  31 <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>Alias /image /ftp/pub/image</code></td></tr></table></blockquote>
  32
  33     <p>A request for http://myserver/image/foo.gif would cause the
  34     server to return the file /ftp/pub/image/foo.gif.</p>
  35
  36     <p>Note that if you include a trailing / on the
  37     <em>url-path</em> then the server will require a trailing / in
  38     order to expand the alias. That is, if you use <code>Alias
  39     /icons/ /usr/local/apache/icons/</code> then the url
  40     <code>/icons</code> will not be aliased.</p>
  41
  42     <p>Note that you may need to specify additional <a href="core.html#<directory>" class="directive"><code class="directive">&lt;Directory&gt;</code></a> sections which cover
  43     the <em>destination</em> of aliases.  Aliasing occurs before
  44     <a href="core.html#<directory>" class="directive"><code class="directive">&lt;Directory&gt;</code></a> sections
  45     are checked, so only the destination of aliases are affected.
  46     (Note however <a href="core.html#<location>" class="directive"><code class="directive">&lt;Location&gt;</code></a>
  47     sections are run through once before aliases are performed, so
  48     they will apply.)</p>
  49
  50 <hr/><h2><a name="AliasMatch">AliasMatch</a> <a name="aliasmatch">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Maps URLs to filesystem locations using regular
  51 expressions</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>AliasMatch <em>regex
  52     file-path</em>|<em>directory-path</em></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_alias</td></tr></table></td></tr></table>
  53     <p>This directive is equivalent to <a href="#alias" class="directive"><code class="directive">Alias</code></a>, but makes use of standard
  54     regular expressions, instead of simple prefix matching. The
  55     supplied regular expression is matched against the URL-path, and
  56     if it matches, the server will substitute any parenthesized
  57     matches into the given string and use it as a filename. For
  58     example, to activate the <code>/icons</code> directory, one might
  59     use:</p>
  60 <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
  61     AliasMatch ^/icons(.*) /usr/local/apache/icons$1
  62 </code></td></tr></table></blockquote>
  63 <hr/><h2><a name="Redirect">Redirect</a> <a name="redirect">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sends an external redirect asking the client to fetch
  64 a different URL</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>Redirect [<em>status</em>] <em>URL-path URL</em></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_alias</td></tr></table></td></tr></table>
  65     <p>The Redirect directive maps an old URL into a new one. The
  66     new URL is returned to the client which attempts to fetch it
  67     again with the new address. <em>URL-path</em> a (%-decoded)
  68     path; any requests for documents beginning with this path will
  69     be returned a redirect error to a new (%-encoded) URL beginning
  70     with <em>URL</em>.</p>
  71
  72     <p>Example:</p>
  73
  74 <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>Redirect /service http://foo2.bar.com/service</code></td></tr></table></blockquote>
  75
  76     <p>If the client requests http://myserver/service/foo.txt, it
  77     will be told to access http://foo2.bar.com/service/foo.txt
  78     instead.</p>
  79
  80 <blockquote><table><tr><td bgcolor="#e0e5f5"><p align="center"><strong>Note</strong></p> <p>Redirect directives take precedence over
  81 Alias and ScriptAlias directives, irrespective of their ordering in
  82 the configuration file. Also, <em>URL-path</em> must be an absolute
  83 path, not a relative path, even when used with .htaccess files or
  84 inside of <a href="core.html#<directory>" class="directive"><code class="directive">&lt;Directory&gt;</code></a>
  85 sections.</p></td></tr></table></blockquote>
  86
  87     <p>If no <em>status</em> argument is given, the redirect will
  88     be "temporary" (HTTP status 302). This indicates to the client
  89     that the resource has moved temporarily. The <em>status</em>
  90     argument can be used to return other HTTP status codes:</p>
  91
  92     <dl>
  93       <dt>permanent</dt>
  94
  95       <dd>Returns a permanent redirect status (301) indicating that
  96       the resource has moved permanently.</dd>
  97
  98       <dt>temp</dt>
  99
 100       <dd>Returns a temporary redirect status (302). This is the
 101       default.</dd>
 102
 103       <dt>seeother</dt>
 104
 105       <dd>Returns a "See Other" status (303) indicating that the
 106       resource has been replaced.</dd>
 107
 108       <dt>gone</dt>
 109
 110       <dd>Returns a "Gone" status (410) indicating that the
 111       resource has been permanently removed. When this status is
 112       used the <em>url</em> argument should be omitted.</dd>
 113     </dl>
 114
 115     <p>Other status codes can be returned by giving the numeric
 116     status code as the value of <em>status</em>. If the status is
 117     between 300 and 399, the <em>url</em> argument must be present,
 118     otherwise it must be omitted. Note that the status must be
 119     known to the Apache code (see the function
 120     <code>send_error_response</code> in http_protocol.c).</p>
 121
 122     <p>Example:</p>
 123
 124     <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
 125         Redirect permanent /one http://example.com/two<br>
 126         Redirect 303 /three http://example.com/other
 127     </code></td></tr></table></blockquote>
 128
 129 <hr/><h2><a name="RedirectMatch">RedirectMatch</a> <a name="redirectmatch">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sends an external redirect asking the client to fetch
 130 a different URL based on a regular expression match of the
 131 current URL</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>RedirectMatch [<em>status</em>] <em>regex URL</em></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_alias</td></tr></table></td></tr></table>
 132     <p>This directive is equivalent to <a href="#redirect" class="directive"><code class="directive">Redirect</code></a>, but makes use of standard
 133     regular expressions, instead of simple prefix matching. The
 134     supplied regular expression is matched against the URL-path, and
 135     if it matches, the server will substitute any parenthesized
 136     matches into the given string and use it as a filename. For
 137     example, to redirect all GIF files to like-named JPEG files on
 138     another server, one might use:</p>
 139 <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
 140     RedirectMatch (.*)\.gif$ http://www.anotherserver.com$1.jpg
 141 </code></td></tr></table></blockquote>
 142 <hr/><h2><a name="RedirectPermanent">RedirectPermanent</a> <a name="redirectpermanent">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sends an external permanent redirect asking the client to fetch
 143 a different URL</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>RedirectPermanent <em>URL-path URL</em></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_alias</td></tr></table></td></tr></table>
 144     <p>This directive makes the client know that the Redirect is
 145     permanent (status 301). Exactly equivalent to <code>Redirect
 146     permanent</code>.</p>
 147 <hr/><h2><a name="RedirectTemp">RedirectTemp</a> <a name="redirecttemp">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sends an external temporary redirect asking the client to fetch
 148 a different URL</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>RedirectTemp <em>URL-path URL</em></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>FileInfo</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_alias</td></tr></table></td></tr></table>
 149     <p>This directive makes the client know that the Redirect is
 150     only temporary (status 302). Exactly equivalent to
 151     <code>Redirect temp</code>.</p>
 152 <hr/><h2><a name="ScriptAlias">ScriptAlias</a> <a name="scriptalias">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Maps a URL to a filesystem location and designates the
 153 target as a CGI script</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>ScriptAlias
 154 <em>URL-path file-path</em>|<em>directory-path</em></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_alias</td></tr></table></td></tr></table>
 155     <p>The <code class="directive">ScriptAlias</code> directive has the same
 156     behavior as the <a href="#alias" class="directive"><code class="directive">Alias</code></a>
 157     directive, except that in addition it marks the target directory
 158     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
 159     (%-decoded) path beginning with <em>URL-path</em> will be mapped
 160     to scripts beginning with the second argument which is a full
 161     pathname in the local filesystem.</p>
 162
 163     <p>Example:</p>
 164
 165 <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>ScriptAlias /cgi-bin/ /web/cgi-bin/</code></td></tr></table></blockquote>
 166
 167     <p>A request for <code>http://myserver/cgi-bin/foo</code> would cause the
 168     server to run the script <code>/web/cgi-bin/foo</code>.</p>
 169 <hr/><h2><a name="ScriptAliasMatch">ScriptAliasMatch</a> <a name="scriptaliasmatch">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Maps a URL to a filesystem location using a regular expression
 170 and designates the target as a CGI script</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>ScriptAliasMatch
 171 <em>regex file-path</em>|<em>directory-path</em></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_alias</td></tr></table></td></tr></table>
 172     <p>This directive is equivalent to <a href="#scriptalias" class="directive"><code class="directive">ScriptAlias</code></a>, but makes use of standard
 173     regular expressions, instead of simple prefix matching. The
 174     supplied regular expression is matched against the URL-path,
 175     and if it matches, the server will substitute any parenthesized
 176     matches into the given string and use it as a filename. For
 177     example, to activate the standard <code>/cgi-bin</code>, one
 178     might use:</p>
 179 <blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
 180     ScriptAliasMatch ^/cgi-bin(.*) /usr/local/apache/cgi-bin$1
 181 </code></td></tr></table></blockquote>
 182 <hr/></blockquote><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></body></html>