mod_alias.xml revision bd63a8c7b38d0af10e7c9d891a245913daabd352
d24d4c5159bcb11c25bb294926cfe7105c789ea9slive<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">
88f76f668542dcd72fc9d71577997967c6bf123bslive<?xml-stylesheet type="text/xsl" href="/style/manual.xsl"?>
88f76f668542dcd72fc9d71577997967c6bf123bslive<modulesynopsis>
88f76f668542dcd72fc9d71577997967c6bf123bslive<description>Provides for mapping different parts of the host
88f76f668542dcd72fc9d71577997967c6bf123bslive filesystem in the document tree and for URL redirection</description>
88f76f668542dcd72fc9d71577997967c6bf123bslive <p>The directives contained in this module allow for manipulation
88f76f668542dcd72fc9d71577997967c6bf123bslive and control of URLs as requests arrive at the server. The
88f76f668542dcd72fc9d71577997967c6bf123bslive <directive module="mod_alias">Alias</directive> and <directive
88f76f668542dcd72fc9d71577997967c6bf123bslive module="mod_alias">ScriptAlias</directive> directives are used to
88f76f668542dcd72fc9d71577997967c6bf123bslive map between URLs and filesystem paths. This allows for content
88f76f668542dcd72fc9d71577997967c6bf123bslive which is not directly under the <directive
88f76f668542dcd72fc9d71577997967c6bf123bslive module="core">DocumentRoot</directive> served as part of the web
88f76f668542dcd72fc9d71577997967c6bf123bslive document tree. The <directive
88f76f668542dcd72fc9d71577997967c6bf123bslive module="mod_alias">ScriptAlias</directive> directive has the
88f76f668542dcd72fc9d71577997967c6bf123bslive additional effect of marking the target directory as containing
88f76f668542dcd72fc9d71577997967c6bf123bslive only CGI scripts.</p>
88f76f668542dcd72fc9d71577997967c6bf123bslive <p>The <directive module="mod_alias">Redirect</directive>
88f76f668542dcd72fc9d71577997967c6bf123bslive directives are used to instruct clients to make a new request with
88f76f668542dcd72fc9d71577997967c6bf123bslive a different URL. They are often used when a resource has moved to
88f76f668542dcd72fc9d71577997967c6bf123bslive a new location.</p>
38677582e6ddf26e810728a68cbe560345486e48slive<seealso><module>mod_rewrite</module></seealso> <seealso><a
38677582e6ddf26e810728a68cbe560345486e48slivehref="/urlmapping.html">Mapping URLs to the filesystem</a></seealso>
88f76f668542dcd72fc9d71577997967c6bf123bslive<directivesynopsis>
88f76f668542dcd72fc9d71577997967c6bf123bslive<description>Maps URLs to filesystem locations</description>
88f76f668542dcd72fc9d71577997967c6bf123bslive<contextlist><context>server config</context><context>virtual host</context>
88f76f668542dcd72fc9d71577997967c6bf123bslive</contextlist>
88f76f668542dcd72fc9d71577997967c6bf123bslive <p>The <directive>Alias</directive> directive allows documents to
88f76f668542dcd72fc9d71577997967c6bf123bslive be stored in the local filesystem other than under the
88f76f668542dcd72fc9d71577997967c6bf123bslive <directive module="core">DocumentRoot</directive>. URLs with a
88f76f668542dcd72fc9d71577997967c6bf123bslive (%-decoded) path beginning with <em>url-path</em> will be mapped
88f76f668542dcd72fc9d71577997967c6bf123bslive to local files beginning with <em>directory-filename</em>.</p>
88f76f668542dcd72fc9d71577997967c6bf123bslive <p>A request for http://myserver/image/foo.gif would cause the
88f76f668542dcd72fc9d71577997967c6bf123bslive <p>Note that if you include a trailing / on the
88f76f668542dcd72fc9d71577997967c6bf123bslive <em>url-path</em> then the server will require a trailing / in
88f76f668542dcd72fc9d71577997967c6bf123bslive order to expand the alias. That is, if you use <code>Alias
88f76f668542dcd72fc9d71577997967c6bf123bslive <p>Note that you may need to specify additional <directive
88f76f668542dcd72fc9d71577997967c6bf123bslive module="core"><Directory></directive> sections which cover
88f76f668542dcd72fc9d71577997967c6bf123bslive the <em>destination</em> of aliases. Aliasing occurs before
88f76f668542dcd72fc9d71577997967c6bf123bslive <directive module="core"><Directory></directive> sections
88f76f668542dcd72fc9d71577997967c6bf123bslive are checked, so only the destination of aliases are affected.
88f76f668542dcd72fc9d71577997967c6bf123bslive (Note however <directive module="core"><Location></directive>
88f76f668542dcd72fc9d71577997967c6bf123bslive sections are run through once before aliases are performed, so
88f76f668542dcd72fc9d71577997967c6bf123bslive they will apply.)</p>
88f76f668542dcd72fc9d71577997967c6bf123bslive</directivesynopsis>
88f76f668542dcd72fc9d71577997967c6bf123bslive<directivesynopsis>
88f76f668542dcd72fc9d71577997967c6bf123bslive<description>Maps URLs to filesystem locations using regular
88f76f668542dcd72fc9d71577997967c6bf123bsliveexpressions</description>
88f76f668542dcd72fc9d71577997967c6bf123bslive<contextlist><context>server config</context><context>virtual host</context>
88f76f668542dcd72fc9d71577997967c6bf123bslive</contextlist>
88f76f668542dcd72fc9d71577997967c6bf123bslive module="mod_alias">Alias</directive>, but makes use of standard
88f76f668542dcd72fc9d71577997967c6bf123bslive regular expressions, instead of simple prefix matching. The
88f76f668542dcd72fc9d71577997967c6bf123bslive supplied regular expression is matched against the URL-path, and
88f76f668542dcd72fc9d71577997967c6bf123bslive if it matches, the server will substitute any parenthesized
88f76f668542dcd72fc9d71577997967c6bf123bslive matches into the given string and use it as a filename. For
88f76f668542dcd72fc9d71577997967c6bf123bslive example, to activate the <code>/icons</code> directory, one might
88f76f668542dcd72fc9d71577997967c6bf123bslive</directivesynopsis>
88f76f668542dcd72fc9d71577997967c6bf123bslive<directivesynopsis>
88f76f668542dcd72fc9d71577997967c6bf123bslive<description>Sends an external redirect asking the client to fetch
88f76f668542dcd72fc9d71577997967c6bf123bslivea different URL</description>
88f76f668542dcd72fc9d71577997967c6bf123bslive<syntax>Redirect [<em>status</em>] <em>URL-path URL</em></syntax>
88f76f668542dcd72fc9d71577997967c6bf123bslive<contextlist><context>server config</context><context>virtual host</context>
88f76f668542dcd72fc9d71577997967c6bf123bslive<context>directory</context><context>.htaccess</context></contextlist>
88f76f668542dcd72fc9d71577997967c6bf123bslive <p>The Redirect directive maps an old URL into a new one. The
88f76f668542dcd72fc9d71577997967c6bf123bslive new URL is returned to the client which attempts to fetch it
88f76f668542dcd72fc9d71577997967c6bf123bslive again with the new address. <em>URL-path</em> a (%-decoded)
88f76f668542dcd72fc9d71577997967c6bf123bslive path; any requests for documents beginning with this path will
88f76f668542dcd72fc9d71577997967c6bf123bslive be returned a redirect error to a new (%-encoded) URL beginning
88f76f668542dcd72fc9d71577997967c6bf123bslive<example>Redirect /service http://foo2.bar.com/service</example>
88f76f668542dcd72fc9d71577997967c6bf123bslive <p>If the client requests http://myserver/service/foo.txt, it
88f76f668542dcd72fc9d71577997967c6bf123bslive will be told to access http://foo2.bar.com/service/foo.txt
88f76f668542dcd72fc9d71577997967c6bf123bslive instead.</p>
88f76f668542dcd72fc9d71577997967c6bf123bslive<note><title>Note</title> <p>Redirect directives take precedence over
88f76f668542dcd72fc9d71577997967c6bf123bsliveAlias and ScriptAlias directives, irrespective of their ordering in
88f76f668542dcd72fc9d71577997967c6bf123bslivethe configuration file. Also, <em>URL-path</em> must be an absolute
88f76f668542dcd72fc9d71577997967c6bf123bslivepath, not a relative path, even when used with .htaccess files or
88f76f668542dcd72fc9d71577997967c6bf123bsliveinside of <directive module="core"><Directory></directive>
88f76f668542dcd72fc9d71577997967c6bf123bslive <p>If no <em>status</em> argument is given, the redirect will
88f76f668542dcd72fc9d71577997967c6bf123bslive be "temporary" (HTTP status 302). This indicates to the client
88f76f668542dcd72fc9d71577997967c6bf123bslive that the resource has moved temporarily. The <em>status</em>
88f76f668542dcd72fc9d71577997967c6bf123bslive argument can be used to return other HTTP status codes:</p>
88f76f668542dcd72fc9d71577997967c6bf123bslive <dd>Returns a permanent redirect status (301) indicating that
88f76f668542dcd72fc9d71577997967c6bf123bslive the resource has moved permanently.</dd>
88f76f668542dcd72fc9d71577997967c6bf123bslive <dd>Returns a temporary redirect status (302). This is the
88f76f668542dcd72fc9d71577997967c6bf123bslive default.</dd>
88f76f668542dcd72fc9d71577997967c6bf123bslive <dd>Returns a "See Other" status (303) indicating that the
88f76f668542dcd72fc9d71577997967c6bf123bslive resource has been replaced.</dd>
88f76f668542dcd72fc9d71577997967c6bf123bslive <dd>Returns a "Gone" status (410) indicating that the
88f76f668542dcd72fc9d71577997967c6bf123bslive resource has been permanently removed. When this status is
88f76f668542dcd72fc9d71577997967c6bf123bslive used the <em>url</em> argument should be omitted.</dd>
88f76f668542dcd72fc9d71577997967c6bf123bslive <p>Other status codes can be returned by giving the numeric
88f76f668542dcd72fc9d71577997967c6bf123bslive status code as the value of <em>status</em>. If the status is
88f76f668542dcd72fc9d71577997967c6bf123bslive between 300 and 399, the <em>url</em> argument must be present,
88f76f668542dcd72fc9d71577997967c6bf123bslive otherwise it must be omitted. Note that the status must be
88f76f668542dcd72fc9d71577997967c6bf123bslive known to the Apache code (see the function
88f76f668542dcd72fc9d71577997967c6bf123bslive <code>send_error_response</code> in http_protocol.c).</p>
bd63a8c7b38d0af10e7c9d891a245913daabd352rbowen Redirect 303 /three http://example.com/other
88f76f668542dcd72fc9d71577997967c6bf123bslive</directivesynopsis>
88f76f668542dcd72fc9d71577997967c6bf123bslive<directivesynopsis>
88f76f668542dcd72fc9d71577997967c6bf123bslive<description>Sends an external redirect asking the client to fetch
88f76f668542dcd72fc9d71577997967c6bf123bslivea different URL based on a regular expression match of the
88f76f668542dcd72fc9d71577997967c6bf123bslivecurrent URL</description>
88f76f668542dcd72fc9d71577997967c6bf123bslive<syntax>RedirectMatch [<em>status</em>] <em>regex URL</em></syntax>
88f76f668542dcd72fc9d71577997967c6bf123bslive<contextlist><context>server config</context><context>virtual host</context>
88f76f668542dcd72fc9d71577997967c6bf123bslive<context>directory</context><context>.htaccess</context></contextlist>
88f76f668542dcd72fc9d71577997967c6bf123bslive module="mod_alias">Redirect</directive>, but makes use of standard
88f76f668542dcd72fc9d71577997967c6bf123bslive regular expressions, instead of simple prefix matching. The
88f76f668542dcd72fc9d71577997967c6bf123bslive supplied regular expression is matched against the URL-path, and
88f76f668542dcd72fc9d71577997967c6bf123bslive if it matches, the server will substitute any parenthesized
88f76f668542dcd72fc9d71577997967c6bf123bslive matches into the given string and use it as a filename. For
88f76f668542dcd72fc9d71577997967c6bf123bslive example, to redirect all GIF files to like-named JPEG files on
88f76f668542dcd72fc9d71577997967c6bf123bslive another server, one might use:</p>
88f76f668542dcd72fc9d71577997967c6bf123bslive RedirectMatch (.*)\.gif$ http://www.anotherserver.com$1.jpg
88f76f668542dcd72fc9d71577997967c6bf123bslive</directivesynopsis>
88f76f668542dcd72fc9d71577997967c6bf123bslive<directivesynopsis>
88f76f668542dcd72fc9d71577997967c6bf123bslive<description>Sends an external temporary redirect asking the client to fetch
88f76f668542dcd72fc9d71577997967c6bf123bslivea different URL</description>
88f76f668542dcd72fc9d71577997967c6bf123bslive<contextlist><context>server config</context><context>virtual host</context>
88f76f668542dcd72fc9d71577997967c6bf123bslive<context>directory</context><context>.htaccess</context></contextlist>
88f76f668542dcd72fc9d71577997967c6bf123bslive <p>This directive makes the client know that the Redirect is
88f76f668542dcd72fc9d71577997967c6bf123bslive only temporary (status 302). Exactly equivalent to
88f76f668542dcd72fc9d71577997967c6bf123bslive</directivesynopsis>
88f76f668542dcd72fc9d71577997967c6bf123bslive<directivesynopsis>
88f76f668542dcd72fc9d71577997967c6bf123bslive<description>Sends an external permanent redirect asking the client to fetch
88f76f668542dcd72fc9d71577997967c6bf123bslivea different URL</description>
88f76f668542dcd72fc9d71577997967c6bf123bslive<syntax>RedirectPermanent <em>URL-path URL</em></syntax>
88f76f668542dcd72fc9d71577997967c6bf123bslive<contextlist><context>server config</context><context>virtual host</context>
88f76f668542dcd72fc9d71577997967c6bf123bslive<context>directory</context><context>.htaccess</context></contextlist>
88f76f668542dcd72fc9d71577997967c6bf123bslive <p>This directive makes the client know that the Redirect is
88f76f668542dcd72fc9d71577997967c6bf123bslive permanent (status 301). Exactly equivalent to <code>Redirect
88f76f668542dcd72fc9d71577997967c6bf123bslive</directivesynopsis>
88f76f668542dcd72fc9d71577997967c6bf123bslive<directivesynopsis>
88f76f668542dcd72fc9d71577997967c6bf123bslive<description>Maps a URL to a filesystem location and designates the
88f76f668542dcd72fc9d71577997967c6bf123bslivetarget as a CGI script</description>
88f76f668542dcd72fc9d71577997967c6bf123bslive<syntax>ScriptAlias
88f76f668542dcd72fc9d71577997967c6bf123bslive<em>URL-path file-path</em>|<em>directory-path</em></syntax>
88f76f668542dcd72fc9d71577997967c6bf123bslive<contextlist><context>server config</context><context>virtual host</context>
88f76f668542dcd72fc9d71577997967c6bf123bslive</contextlist>
88f76f668542dcd72fc9d71577997967c6bf123bslive <p>The <directive>ScriptAlias</directive> directive has the same
88f76f668542dcd72fc9d71577997967c6bf123bslive behavior as the <directive module="mod_alias">Alias</directive>
88f76f668542dcd72fc9d71577997967c6bf123bslive directive, except that in addition it marks the target directory
88f76f668542dcd72fc9d71577997967c6bf123bslive as containing CGI scripts that will be processed by <module
88f76f668542dcd72fc9d71577997967c6bf123bslive >mod_cgi</module>'s cgi-script handler. URLs with a
88f76f668542dcd72fc9d71577997967c6bf123bslive (%-decoded) path beginning with <em>URL-path</em> will be mapped
88f76f668542dcd72fc9d71577997967c6bf123bslive to scripts beginning with the second argument which is a full
88f76f668542dcd72fc9d71577997967c6bf123bslive pathname in the local filesystem.</p>
88f76f668542dcd72fc9d71577997967c6bf123bslive <p>A request for <code>http://myserver/cgi-bin/foo</code> would cause the
88f76f668542dcd72fc9d71577997967c6bf123bslive server to run the script <code>/web/cgi-bin/foo</code>.</p>
88f76f668542dcd72fc9d71577997967c6bf123bslive</directivesynopsis>
88f76f668542dcd72fc9d71577997967c6bf123bslive<directivesynopsis>
88f76f668542dcd72fc9d71577997967c6bf123bslive<description>Maps a URL to a filesystem location using a regular expression
88f76f668542dcd72fc9d71577997967c6bf123bsliveand designates the target as a CGI script</description>
88f76f668542dcd72fc9d71577997967c6bf123bslive<syntax>ScriptAliasMatch
88f76f668542dcd72fc9d71577997967c6bf123bslive<em>regex file-path</em>|<em>directory-path</em></syntax>
88f76f668542dcd72fc9d71577997967c6bf123bslive<contextlist><context>server config</context><context>virtual host</context>
88f76f668542dcd72fc9d71577997967c6bf123bslive</contextlist>
88f76f668542dcd72fc9d71577997967c6bf123bslive <p>This directive is equivalent to <directive module="mod_alias"
88f76f668542dcd72fc9d71577997967c6bf123bslive >ScriptAlias</directive>, but makes use of standard
88f76f668542dcd72fc9d71577997967c6bf123bslive regular expressions, instead of simple prefix matching. The
88f76f668542dcd72fc9d71577997967c6bf123bslive supplied regular expression is matched against the URL-path,
88f76f668542dcd72fc9d71577997967c6bf123bslive and if it matches, the server will substitute any parenthesized
88f76f668542dcd72fc9d71577997967c6bf123bslive matches into the given string and use it as a filename. For
88f76f668542dcd72fc9d71577997967c6bf123bslive example, to activate the standard <code>/cgi-bin</code>, one
88f76f668542dcd72fc9d71577997967c6bf123bslive might use:</p>
88f76f668542dcd72fc9d71577997967c6bf123bslive ScriptAliasMatch ^/cgi-bin(.*) /usr/local/apache/cgi-bin$1
88f76f668542dcd72fc9d71577997967c6bf123bslive</directivesynopsis>
88f76f668542dcd72fc9d71577997967c6bf123bslive</modulesynopsis>