remapping.xml revision 856d8f134df3b2d23a76717121e042877f85ae3b
4a1711ab536d965e63d7be80e29f912287fe70b2rbowen<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>
6896b3498e144d33f374efe93e6bab2669af535fnd<!-- $LastChangedRevision: 832069 $ -->
4a1711ab536d965e63d7be80e29f912287fe70b2rbowen Licensed to the Apache Software Foundation (ASF) under one or more
4a1711ab536d965e63d7be80e29f912287fe70b2rbowen contributor license agreements. See the NOTICE file distributed with
4a1711ab536d965e63d7be80e29f912287fe70b2rbowen this work for additional information regarding copyright ownership.
4a1711ab536d965e63d7be80e29f912287fe70b2rbowen The ASF licenses this file to You under the Apache License, Version 2.0
4a1711ab536d965e63d7be80e29f912287fe70b2rbowen (the "License"); you may not use this file except in compliance with
4a1711ab536d965e63d7be80e29f912287fe70b2rbowen the License. You may obtain a copy of the License at
4a1711ab536d965e63d7be80e29f912287fe70b2rbowen Unless required by applicable law or agreed to in writing, software
4a1711ab536d965e63d7be80e29f912287fe70b2rbowen distributed under the License is distributed on an "AS IS" BASIS,
4a1711ab536d965e63d7be80e29f912287fe70b2rbowen WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
4a1711ab536d965e63d7be80e29f912287fe70b2rbowen See the License for the specific language governing permissions and
4a1711ab536d965e63d7be80e29f912287fe70b2rbowen limitations under the License.
4a1711ab536d965e63d7be80e29f912287fe70b2rbowen<title>Redirecting and Remapping with mod_rewrite</title>
4a1711ab536d965e63d7be80e29f912287fe70b2rbowen<p>This document supplements the <module>mod_rewrite</module>
2bb0656f94af82b1ff5e3e77a99b4427c52e4953rbowen<a href="/mod_rewrite.html">reference documentation</a>. It describes
4a1711ab536d965e63d7be80e29f912287fe70b2rbowenhow you can use <module>mod_rewrite</module> to redirect and remap
4a1711ab536d965e63d7be80e29f912287fe70b2rbowenrequest. This includes many examples of common uses of mod_rewrite,
4a1711ab536d965e63d7be80e29f912287fe70b2rbowenincluding detailed descriptions of how each works.</p>
1a1f0f42c4b3840641897888fec7792af8ba384frbowen<note type="warning">Note that many of these examples won't work unchanged in your
4a1711ab536d965e63d7be80e29f912287fe70b2rbowenparticular server configuration, so it's important that you understand
4a1711ab536d965e63d7be80e29f912287fe70b2rbowenthem, rather than merely cutting and pasting the examples into your
1a1f0f42c4b3840641897888fec7792af8ba384frbowenconfiguration.</note>
4a1711ab536d965e63d7be80e29f912287fe70b2rbowen<seealso><a href="/mod/mod_rewrite.html">Module documentation</a></seealso>
4a1711ab536d965e63d7be80e29f912287fe70b2rbowen<seealso><a href="intro.html">mod_rewrite introduction</a></seealso>
1a1f0f42c4b3840641897888fec7792af8ba384frbowen <p>Assume we have recently renamed the page
1a1f0f42c4b3840641897888fec7792af8ba384frbowen <code>foo.html</code> to <code>bar.html</code> and now want
1a1f0f42c4b3840641897888fec7792af8ba384frbowen to provide the old URL for backward compatibility. However,
1a1f0f42c4b3840641897888fec7792af8ba384frbowen we want that users of the old URL even not recognize that
1a1f0f42c4b3840641897888fec7792af8ba384frbowen the pages was renamed - that is, we don't want the address to
1a1f0f42c4b3840641897888fec7792af8ba384frbowen change in their browser.</p>
1a1f0f42c4b3840641897888fec7792af8ba384frbowen <p>We rewrite the old URL to the new one internally via the
1a1f0f42c4b3840641897888fec7792af8ba384frbowen following rule:</p>
1a1f0f42c4b3840641897888fec7792af8ba384frbowenRewriteEngine on
1a1f0f42c4b3840641897888fec7792af8ba384frbowenRewriteRule ^<strong>/old</strong>\.html$ <strong>/new</strong>.html [PT]
1a1f0f42c4b3840641897888fec7792af8ba384frbowen <p>Assume again that we have recently renamed the page
1a1f0f42c4b3840641897888fec7792af8ba384frbowen <code>foo.html</code> to <code>bar.html</code> and now want
1a1f0f42c4b3840641897888fec7792af8ba384frbowen to provide the old URL for backward compatibility. But this
1a1f0f42c4b3840641897888fec7792af8ba384frbowen time we want that the users of the old URL get hinted to
1a1f0f42c4b3840641897888fec7792af8ba384frbowen the new one, i.e. their browsers Location field should
1a1f0f42c4b3840641897888fec7792af8ba384frbowen change, too.</p>
1a1f0f42c4b3840641897888fec7792af8ba384frbowen <p>We force a HTTP redirect to the new URL which leads to a
1a1f0f42c4b3840641897888fec7792af8ba384frbowen change of the browsers and thus the users view:</p>
1a1f0f42c4b3840641897888fec7792af8ba384frbowenRewriteEngine on
1a1f0f42c4b3840641897888fec7792af8ba384frbowenRewriteRule ^<strong>/foo</strong>\.html$ <strong>bar</strong>.html [<strong>R</strong>]
bdf760e4562a3fb875452418faf0fcd3680184d8rbowen href="#old-to-new-intern">internal</a> example above, we can simply
1a1f0f42c4b3840641897888fec7792af8ba384frbowen use the Redirect directive. mod_rewrite was used in that earlier
1a1f0f42c4b3840641897888fec7792af8ba384frbowen example in order to hide the redirect from the client:</p>
67398034ea8b919da6274d4e178661559e1eb1e2rbowen <p>If a resource has moved to another server, you may wish to have
67398034ea8b919da6274d4e178661559e1eb1e2rbowen URLs continue to work for a time on the old server while people
67398034ea8b919da6274d4e178661559e1eb1e2rbowen update their bookmarks.</p>
67398034ea8b919da6274d4e178661559e1eb1e2rbowen <p>You can use <module>mod_rewrite</module> to redirect these URLs
67398034ea8b919da6274d4e178661559e1eb1e2rbowen to the new server, but you might also consider using the Redirect
67398034ea8b919da6274d4e178661559e1eb1e2rbowen or RedirectMatch directive.</p>
67398034ea8b919da6274d4e178661559e1eb1e2rbowenRewriteEngine on
67398034ea8b919da6274d4e178661559e1eb1e2rbowenRewriteRule ^/docs/(.+) http://new.example.com/docs/$1 [R,L]
67398034ea8b919da6274d4e178661559e1eb1e2rbowenRedirectMatch ^/docs/(.*) http://new.example.com/docs/$1
1a1f0f42c4b3840641897888fec7792af8ba384frbowen <p>How can we transform a static page
1a1f0f42c4b3840641897888fec7792af8ba384frbowen <code>foo.cgi</code> in a seamless way, i.e. without notice
1a1f0f42c4b3840641897888fec7792af8ba384frbowen <p>We just rewrite the URL to the CGI-script and force the
1a1f0f42c4b3840641897888fec7792af8ba384frbowen handler to be <strong>cgi-script</strong> so that it is
1a1f0f42c4b3840641897888fec7792af8ba384frbowen executed as a CGI program.
1a1f0f42c4b3840641897888fec7792af8ba384frbowen internally leads to the invocation of
1a1f0f42c4b3840641897888fec7792af8ba384frbowenRewriteEngine on
1a1f0f42c4b3840641897888fec7792af8ba384frbowenRewriteBase /~quux/
1a1f0f42c4b3840641897888fec7792af8ba384frbowenRewriteRule ^foo\.<strong>html</strong>$ foo.<strong>cgi</strong> [H=<strong>cgi-script</strong>]
1a1f0f42c4b3840641897888fec7792af8ba384frbowen <title>Backward Compatibility for file extension change</title>
13e125c14cbafff43783b7f3aed11de6d4cb5b14rbowen <p>How can we make URLs backward compatible (still
13e125c14cbafff43783b7f3aed11de6d4cb5b14rbowen existing virtually) after migrating <code>document.YYYY</code>
13e125c14cbafff43783b7f3aed11de6d4cb5b14rbowen to <code>document.XXXX</code>, e.g. after translating a
13e125c14cbafff43783b7f3aed11de6d4cb5b14rbowen bunch of <code>.html</code> files to <code>.php</code>?</p>
13e125c14cbafff43783b7f3aed11de6d4cb5b14rbowen <p>We rewrite the name to its basename and test for
13e125c14cbafff43783b7f3aed11de6d4cb5b14rbowen existence of the new extension. If it exists, we take
13e125c14cbafff43783b7f3aed11de6d4cb5b14rbowen that name, else we rewrite the URL to its original state.</p>
13e125c14cbafff43783b7f3aed11de6d4cb5b14rbowen# backward compatibility ruleset for
13e125c14cbafff43783b7f3aed11de6d4cb5b14rbowen# when and only when document.php exists
bdf760e4562a3fb875452418faf0fcd3680184d8rbowenRewriteEngine on
bdf760e4562a3fb875452418faf0fcd3680184d8rbowenRewriteCond $1.php -f
bdf760e4562a3fb875452418faf0fcd3680184d8rbowenRewriteCond $1.html !-f
bdf760e4562a3fb875452418faf0fcd3680184d8rbowenRewriteRule ^(.*).html$ $1.php
bdf760e4562a3fb875452418faf0fcd3680184d8rbowen</Directory>
bdf760e4562a3fb875452418faf0fcd3680184d8rbowen <p>This example uses an often-overlooked feature of mod_rewrite,
67398034ea8b919da6274d4e178661559e1eb1e2rbowen by taking advantage of the order of execution of the ruleset. In
bdf760e4562a3fb875452418faf0fcd3680184d8rbowen particular, mod_rewrite evaluates the left-hand-side of the
13e125c14cbafff43783b7f3aed11de6d4cb5b14rbowen RewriteRule before it evaluates the RewriteCond directives.
13e125c14cbafff43783b7f3aed11de6d4cb5b14rbowen Consequently, $1 is already defined by the time the RewriteRule
13e125c14cbafff43783b7f3aed11de6d4cb5b14rbowen directives are evaluated. This allows us to test for the existence
13e125c14cbafff43783b7f3aed11de6d4cb5b14rbowen of the the original (<code>document.html</code>) and target
13e125c14cbafff43783b7f3aed11de6d4cb5b14rbowen (<code>document.php</code>) files using the same base filename.</p>
13e125c14cbafff43783b7f3aed11de6d4cb5b14rbowen <p>This ruleset is designed to use in a per-directory context (In a
13e125c14cbafff43783b7f3aed11de6d4cb5b14rbowen <Directory> block or in a .htaccess file), so that the
0464ea692a2abb32bccd571ee98ddbd43dad4ffbrbowen <code>-f</code> checks are looking at the correct directory path.
13e125c14cbafff43783b7f3aed11de6d4cb5b14rbowen You may need to set a <directive
48193e92704a478a74d9065fc32874505847bfd9lgentis module="mod_rewite">RewriteBase</directive> directive to specify the
13e125c14cbafff43783b7f3aed11de6d4cb5b14rbowen directory base that you're working in.</p>
73036acae345bfcd48167c09e7ee2f0f0a19df8arbowen<section id="canonicalhost"><title>Canonical Hostnames</title>
13e125c14cbafff43783b7f3aed11de6d4cb5b14rbowen <dd>The goal of this rule is to force the use of a particular
13e125c14cbafff43783b7f3aed11de6d4cb5b14rbowen hostname, in preference to other hostnames which may be used to
43289eb78809cbdec92c7d90433a8852233f0b2brbowen reach the same site. For example, if you wish to force the use
43289eb78809cbdec92c7d90433a8852233f0b2brbowen <strong>example.com</strong>, you might use a variant of the
1a1f0f42c4b3840641897888fec7792af8ba384frbowen following recipe.</dd>
1a1f0f42c4b3840641897888fec7792af8ba384frbowenRewriteCond %{HTTP_HOST} !^www\.example\.com [NC]
1a1f0f42c4b3840641897888fec7792af8ba384frbowenRewriteCond %{HTTP_HOST} !^$
1a1f0f42c4b3840641897888fec7792af8ba384frbowenRewriteCond %{SERVER_PORT} !^80$
1a1f0f42c4b3840641897888fec7792af8ba384frbowenRewriteRule ^/?(.*) http://www.example.com:%{SERVER_PORT}/$1 [L,R,NE]
a58ef077d369c62da387d53516fc389cdb5c313arbowenRewriteCond %{HTTP_HOST} !^www\.example\.com [NC]
a58ef077d369c62da387d53516fc389cdb5c313arbowenRewriteCond %{HTTP_HOST} !^$
59d2c89abd6eaaac4fbb9b7af6b164c3d083f11crbowenRewriteRule ^/?(.*) http://www.example.com/$1 [L,R,NE]
cccddf21ee1d4cf391c1a3e0119f2f6fb0bcb9dcrbowen If you wanted to do this generically for all domain names - that
cccddf21ee1d4cf391c1a3e0119f2f6fb0bcb9dcrbowen is, if you want to redirect <strong>example.com</strong> to
cccddf21ee1d4cf391c1a3e0119f2f6fb0bcb9dcrbowen <strong>www.example.com</strong> for all possible values of
cccddf21ee1d4cf391c1a3e0119f2f6fb0bcb9dcrbowen <strong>example.com</strong>, you could use the following
cccddf21ee1d4cf391c1a3e0119f2f6fb0bcb9dcrbowen recipe:</p>
cccddf21ee1d4cf391c1a3e0119f2f6fb0bcb9dcrbowenRewriteCond %{HTTP_HOST} !^www\. [NC]
cccddf21ee1d4cf391c1a3e0119f2f6fb0bcb9dcrbowenRewriteCond %{HTTP_HOST} !^$
cccddf21ee1d4cf391c1a3e0119f2f6fb0bcb9dcrbowenRewriteRule ^/?(.*) http://www.%{HTTP_HOST}/$1 [L,R,NE]
cccddf21ee1d4cf391c1a3e0119f2f6fb0bcb9dcrbowen <p>These rulesets will work either in your main server configuration
a58ef077d369c62da387d53516fc389cdb5c313arbowen file, or in a <code>.htaccess</code> file placed in the <directive
cccddf21ee1d4cf391c1a3e0119f2f6fb0bcb9dcrbowen module="core">DocumentRoot</directive> of the server.</p>
97aaaf4db69986e48302566b12ceef65380647carbowen <title>Search for pages in more than one directory</title>
97aaaf4db69986e48302566b12ceef65380647carbowen <p>A particular resource might exist in one of several places, and
97aaaf4db69986e48302566b12ceef65380647carbowen we want to look in those places for the resource when it is
97aaaf4db69986e48302566b12ceef65380647carbowen requested. Perhaps we've recently rearranged our directory
97aaaf4db69986e48302566b12ceef65380647carbowen structure, dividing content into several locations.</p>
97aaaf4db69986e48302566b12ceef65380647carbowen <p>The following ruleset searches in two directories to find the
97aaaf4db69986e48302566b12ceef65380647carbowen resource, and, if not finding it in either place, will attempt to
97aaaf4db69986e48302566b12ceef65380647carbowen just serve it out of the location requested.</p>
a58ef077d369c62da387d53516fc389cdb5c313arbowenRewriteEngine on
bdf760e4562a3fb875452418faf0fcd3680184d8rbowen# first try to find it in dir1/...
bdf760e4562a3fb875452418faf0fcd3680184d8rbowen# ...and if found stop and be happy:
bdf760e4562a3fb875452418faf0fcd3680184d8rbowenRewriteCond %{DOCUMENT_ROOT}/<strong>dir1</strong>/%{REQUEST_URI} -f
bdf760e4562a3fb875452418faf0fcd3680184d8rbowenRewriteRule ^(.+) %{DOCUMENT_ROOT}/<strong>dir1</strong>/$1 [L]
bdf760e4562a3fb875452418faf0fcd3680184d8rbowen# second try to find it in dir2/...
1a1f0f42c4b3840641897888fec7792af8ba384frbowen# ...and if found stop and be happy:
1a1f0f42c4b3840641897888fec7792af8ba384frbowenRewriteCond %{DOCUMENT_ROOT}/<strong>dir2</strong>/%{REQUEST_URI} -f
bdf760e4562a3fb875452418faf0fcd3680184d8rbowenRewriteRule ^(.+) %{DOCUMENT_ROOT}/<strong>dir2</strong>/$1 [L]
bdf760e4562a3fb875452418faf0fcd3680184d8rbowen# else go on for other Alias or ScriptAlias directives,
bdf760e4562a3fb875452418faf0fcd3680184d8rbowenRewriteRule ^(.+) - [PT]
bdf760e4562a3fb875452418faf0fcd3680184d8rbowen <title>Redirecting to Geographically Distributed Servers</title>
1a1f0f42c4b3840641897888fec7792af8ba384frbowen <p>We have numerous mirrors of our website, and want to redirect
1a1f0f42c4b3840641897888fec7792af8ba384frbowen people to the one that is located in the country where they are
1a1f0f42c4b3840641897888fec7792af8ba384frbowen located.</p>
13e125c14cbafff43783b7f3aed11de6d4cb5b14rbowen <p>Looking at the hostname of the requesting client, we determine
13e125c14cbafff43783b7f3aed11de6d4cb5b14rbowen which country they are coming from. If we can't do a lookup on their
13e125c14cbafff43783b7f3aed11de6d4cb5b14rbowen IP address, we fall back to a default server.</p>
13e125c14cbafff43783b7f3aed11de6d4cb5b14rbowen <p>We'll use <directive module="mod_rewrite">RewriteMap</directive>
13e125c14cbafff43783b7f3aed11de6d4cb5b14rbowen directive to build a list of servers that we wish to use.</p>
13e125c14cbafff43783b7f3aed11de6d4cb5b14rbowenHostnameLookups on
13e125c14cbafff43783b7f3aed11de6d4cb5b14rbowenRewriteEngine on
13e125c14cbafff43783b7f3aed11de6d4cb5b14rbowenRewriteCond %{REMOTE_HOST} ([a-z]+)$ [NC]
13e125c14cbafff43783b7f3aed11de6d4cb5b14rbowenRewriteRule ^/(.*)$ ${multiplex:<strong>%1</strong>|http://www.example.com/}$1 [R,L]
13e125c14cbafff43783b7f3aed11de6d4cb5b14rbowen## map.mirrors -- Multiplexing Map
bdf760e4562a3fb875452418faf0fcd3680184d8rbowen a significant performance hit.</note>
bdf760e4562a3fb875452418faf0fcd3680184d8rbowen <p>The <directive module="mod_rewrite">RewriteCond</directive>
bdf760e4562a3fb875452418faf0fcd3680184d8rbowen directive captures the last portion of the hostname of the
bdf760e4562a3fb875452418faf0fcd3680184d8rbowen requesting client - the country code - and the following RewriteRule
bdf760e4562a3fb875452418faf0fcd3680184d8rbowen uses that value to look up the appropriate mirror host in the map
aa3ddf73a3cb180f88a18742f363f2cb9a0c5cderbowen <p>We wish to provide different content based on the browser, or
aa3ddf73a3cb180f88a18742f363f2cb9a0c5cderbowen user-agent, which is requesting the content.</p>
aa3ddf73a3cb180f88a18742f363f2cb9a0c5cderbowen <p>We have to decide, based on the HTTP header "User-Agent",
aa3ddf73a3cb180f88a18742f363f2cb9a0c5cderbowen which content to serve. The following config
aa3ddf73a3cb180f88a18742f363f2cb9a0c5cderbowen does the following: If the HTTP header "User-Agent"
aa3ddf73a3cb180f88a18742f363f2cb9a0c5cderbowen rewriting stops. If the browser is "Lynx" or "Mozilla" of
48193e92704a478a74d9065fc32874505847bfd9lgentis version 1 or 2, the URL becomes <code>foo.20.html</code>.
aa3ddf73a3cb180f88a18742f363f2cb9a0c5cderbowen All other browsers receive page <code>foo.32.html</code>.
aa3ddf73a3cb180f88a18742f363f2cb9a0c5cderbowen This is done with the following ruleset:</p>
bdf760e4562a3fb875452418faf0fcd3680184d8rbowenRewriteCond %{HTTP_USER_AGENT} ^<strong>Mozilla/3</strong>.*
bdf760e4562a3fb875452418faf0fcd3680184d8rbowenRewriteRule ^foo\.html$ foo.<strong>NS</strong>.html [<strong>L</strong>]
4634fe331f9689ad14057c5ca77d285b50ce08c4rbowenRewriteCond %{HTTP_USER_AGENT} ^<strong>Lynx/</strong>.* [OR]
bdf760e4562a3fb875452418faf0fcd3680184d8rbowenRewriteCond %{HTTP_USER_AGENT} ^<strong>Mozilla/[12]</strong>.*
aa3ddf73a3cb180f88a18742f363f2cb9a0c5cderbowenRewriteRule ^foo\.html$ foo.<strong>20</strong>.html [<strong>L</strong>]
bdf760e4562a3fb875452418faf0fcd3680184d8rbowenRewriteRule ^foo\.html$ foo.<strong>32</strong>.html [<strong>L</strong>]
aa3ddf73a3cb180f88a18742f363f2cb9a0c5cderbowen <p>On some webservers there is more than one URL for a
aa3ddf73a3cb180f88a18742f363f2cb9a0c5cderbowen resource. Usually there are canonical URLs (which are be
aa3ddf73a3cb180f88a18742f363f2cb9a0c5cderbowen actually used and distributed) and those which are just
aa3ddf73a3cb180f88a18742f363f2cb9a0c5cderbowen shortcuts, internal ones, and so on. Independent of which URL the
aa3ddf73a3cb180f88a18742f363f2cb9a0c5cderbowen user supplied with the request, they should finally see the
aa3ddf73a3cb180f88a18742f363f2cb9a0c5cderbowen canonical one in their browser address bar.</p>
32e1018ca3ab0e0bd089fd38ce8d97bb7a607639rbowen <p>We do an external HTTP redirect for all non-canonical
32e1018ca3ab0e0bd089fd38ce8d97bb7a607639rbowen URLs to fix them in the location view of the Browser and
32e1018ca3ab0e0bd089fd38ce8d97bb7a607639rbowen for all subsequent requests. In the example ruleset below
32e1018ca3ab0e0bd089fd38ce8d97bb7a607639rbowen we replace <code>/puppies</code> and <code>/canines</code>
32e1018ca3ab0e0bd089fd38ce8d97bb7a607639rbowenRewriteRule ^/(puppies|canines)/(.*) /dogs/$2 [R]
32e1018ca3ab0e0bd089fd38ce8d97bb7a607639rbowen This should really be accomplished with Redirect or RedirectMatch
32e1018ca3ab0e0bd089fd38ce8d97bb7a607639rbowen directives:
32e1018ca3ab0e0bd089fd38ce8d97bb7a607639rbowen RedirectMatch ^/(puppies|canines)/(.*) /dogs/$2
bdf760e4562a3fb875452418faf0fcd3680184d8rbowen</manualpage>