mod_rewrite.html.en revision cea021a7fc2657b091df4d3b031c4254ec371dd7
fb18194cd0e59b737cc179eb2354a2dcd16087d4trawick<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
fb18194cd0e59b737cc179eb2354a2dcd16087d4trawick<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
fb18194cd0e59b737cc179eb2354a2dcd16087d4trawick XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
fb18194cd0e59b737cc179eb2354a2dcd16087d4trawick This file is generated from xml source: DO NOT EDIT
fb18194cd0e59b737cc179eb2354a2dcd16087d4trawick XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
fb18194cd0e59b737cc179eb2354a2dcd16087d4trawick<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
fb18194cd0e59b737cc179eb2354a2dcd16087d4trawick<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
fb18194cd0e59b737cc179eb2354a2dcd16087d4trawick<link href="/style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
fb18194cd0e59b737cc179eb2354a2dcd16087d4trawick<link href="/images/favicon.ico" rel="shortcut icon" /></head>
fb18194cd0e59b737cc179eb2354a2dcd16087d4trawick<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="/faq/">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p>
fb18194cd0e59b737cc179eb2354a2dcd16087d4trawick<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick<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.3</a> > <a href="./">Modules</a></div>
61a4b32b1032d530e84e1131cb803f803acf7461trawick<div id="preamble"><h1>Apache Module mod_rewrite</h1>
61a4b32b1032d530e84e1131cb803f803acf7461trawick<p><span>Available Languages: </span><a href="/en/mod/mod_rewrite.html" title="English"> en </a> |
182d9b96e04124d14c9f539109fb4e8cbd360d36trawick<a href="/fr/mod/mod_rewrite.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a></p>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Provides a rule-based rewriting engine to rewrite requested
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>rewrite_module</td></tr>
4e2fbd7af73349caa41681acc2ec43d6d7011beatrawick<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_rewrite.c</td></tr></table>
4e2fbd7af73349caa41681acc2ec43d6d7011beatrawick <p>The <code class="module"><a href="/mod/mod_rewrite.html">mod_rewrite</a></code> module uses a rule-based rewriting
4e2fbd7af73349caa41681acc2ec43d6d7011beatrawick engine, based on a regular-expression parser, to rewrite requested URLs on
d66e2366f1cceb0e2b107020fe61e36d090b6d9ctrawick the fly. By default, <code class="module"><a href="/mod/mod_rewrite.html">mod_rewrite</a></code> maps a URL to a filesystem
d66e2366f1cceb0e2b107020fe61e36d090b6d9ctrawick path. However, it can also be used to redirect one URL to another URL, or
d66e2366f1cceb0e2b107020fe61e36d090b6d9ctrawick to invoke an internal proxy fetch.</p>
d66e2366f1cceb0e2b107020fe61e36d090b6d9ctrawick <p><code class="module"><a href="/mod/mod_rewrite.html">mod_rewrite</a></code> provides a flexible and powerful way to
d66e2366f1cceb0e2b107020fe61e36d090b6d9ctrawick manipulate URLs using an unlimited number of rules. Each rule can have an
d66e2366f1cceb0e2b107020fe61e36d090b6d9ctrawick unlimited number of attached rule conditions, to allow you to rewrite URL
4e2fbd7af73349caa41681acc2ec43d6d7011beatrawick based on server variables, environment variables, HTTP headers, or time
d66e2366f1cceb0e2b107020fe61e36d090b6d9ctrawick stamps.</p>
4e2fbd7af73349caa41681acc2ec43d6d7011beatrawick <p><code class="module"><a href="/mod/mod_rewrite.html">mod_rewrite</a></code> operates on the full URL path, including the
4e2fbd7af73349caa41681acc2ec43d6d7011beatrawick path-info section. A rewrite rule can be invoked in
4e2fbd7af73349caa41681acc2ec43d6d7011beatrawick <code>httpd.conf</code> or in <code>.htaccess</code>. The path generated
4e2fbd7af73349caa41681acc2ec43d6d7011beatrawick by a rewrite rule can include a query string, or can lead to internal
4e2fbd7af73349caa41681acc2ec43d6d7011beatrawick sub-processing, external request redirection, or internal proxy
4e2fbd7af73349caa41681acc2ec43d6d7011beatrawick throughput.</p>
4e2fbd7af73349caa41681acc2ec43d6d7011beatrawick <p>Further details, discussion, and examples, are provided in the
4e2fbd7af73349caa41681acc2ec43d6d7011beatrawick <a href="/rewrite/">detailed mod_rewrite documentation</a>.</p>
4e2fbd7af73349caa41681acc2ec43d6d7011beatrawick<div id="quickview"><h3 class="directives">Directives</h3>
4e2fbd7af73349caa41681acc2ec43d6d7011beatrawick<li><img alt="" src="/images/down.gif" /> <a href="#rewritebase">RewriteBase</a></li>
4e2fbd7af73349caa41681acc2ec43d6d7011beatrawick<li><img alt="" src="/images/down.gif" /> <a href="#rewritecond">RewriteCond</a></li>
4e2fbd7af73349caa41681acc2ec43d6d7011beatrawick<li><img alt="" src="/images/down.gif" /> <a href="#rewriteengine">RewriteEngine</a></li>
182d9b96e04124d14c9f539109fb4e8cbd360d36trawick<li><img alt="" src="/images/down.gif" /> <a href="#rewritelog">RewriteLog</a></li>
182d9b96e04124d14c9f539109fb4e8cbd360d36trawick<li><img alt="" src="/images/down.gif" /> <a href="#rewriteloglevel">RewriteLogLevel</a></li>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick<li><img alt="" src="/images/down.gif" /> <a href="#rewritemap">RewriteMap</a></li>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick<li><img alt="" src="/images/down.gif" /> <a href="#rewriteoptions">RewriteOptions</a></li>
798cfee8074b529042079c77eee6962a723350detrawick<li><img alt="" src="/images/down.gif" /> <a href="#rewriterule">RewriteRule</a></li>
e5819d621124ccc8ee3b7f1854c2d55ffaf91d32trawick<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
798cfee8074b529042079c77eee6962a723350detrawick<div class="directive-section"><h2><a name="RewriteBase" id="RewriteBase">RewriteBase</a> <a name="rewritebase" id="rewritebase">Directive</a></h2>
bbd9d609b3e1f45b4a5beda3ef5e8a589b3657b4trawick<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the base URL for per-directory rewrites</td></tr>
bbd9d609b3e1f45b4a5beda3ef5e8a589b3657b4trawick<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RewriteBase <em>URL-path</em></code></td></tr>
798cfee8074b529042079c77eee6962a723350detrawick<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>None</code></td></tr>
4e2fbd7af73349caa41681acc2ec43d6d7011beatrawick<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
4e2fbd7af73349caa41681acc2ec43d6d7011beatrawick<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
4e2fbd7af73349caa41681acc2ec43d6d7011beatrawick<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
4e2fbd7af73349caa41681acc2ec43d6d7011beatrawick<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_rewrite</td></tr>
4e2fbd7af73349caa41681acc2ec43d6d7011beatrawick <p>The <code class="directive">RewriteBase</code> directive explicitly
4e2fbd7af73349caa41681acc2ec43d6d7011beatrawick sets the base URL-path (not filesystem directory path!) for per-directory rewrites.
4e2fbd7af73349caa41681acc2ec43d6d7011beatrawick When you use a <code class="directive"><a href="#rewriterule">RewriteRule</a></code>
4e2fbd7af73349caa41681acc2ec43d6d7011beatrawick in a <code>.htaccess</code> file, <code class="module"><a href="/mod/mod_rewrite.html">mod_rewrite</a></code> strips off
39d69ffeb80a2db1b3ffeed705f0652b1e77fe49trawick the local directory prefix before processing, then rewrites the rest of
39d69ffeb80a2db1b3ffeed705f0652b1e77fe49trawick the URL. When the rewrite is completed, <code class="module"><a href="/mod/mod_rewrite.html">mod_rewrite</a></code>
39d69ffeb80a2db1b3ffeed705f0652b1e77fe49trawick automatically adds the local directory prefix back on to the path.</p>
39d69ffeb80a2db1b3ffeed705f0652b1e77fe49trawick <p>This directive is <em>required</em> for per-directory rewrites whose context
39d69ffeb80a2db1b3ffeed705f0652b1e77fe49trawick is a directory made available via the <code class="directive"><a href="/mod/mod_alias.html#alias">Alias</a></code>
39d69ffeb80a2db1b3ffeed705f0652b1e77fe49trawick directive.</p>
39d69ffeb80a2db1b3ffeed705f0652b1e77fe49trawick <p>If your URL path does not exist verbatim on the filesystem,
39d69ffeb80a2db1b3ffeed705f0652b1e77fe49trawick or isn't directly under your <code class="directive"><a href="/mod/core.html#documentroot">DocumentRoot</a></code>,
e5819d621124ccc8ee3b7f1854c2d55ffaf91d32trawick you must use <code class="directive">RewriteBase</code> in every
e5819d621124ccc8ee3b7f1854c2d55ffaf91d32trawick <code>.htaccess</code> file where you want to use <code class="directive"><a href="#rewriterule">RewriteRule</a></code> directives.</p>
e5819d621124ccc8ee3b7f1854c2d55ffaf91d32trawick <p>The example below demonstrates how to map
e5819d621124ccc8ee3b7f1854c2d55ffaf91d32trawick /home/www/example/newsite.html, in a <code>.htaccess</code> file. This
e5819d621124ccc8ee3b7f1854c2d55ffaf91d32trawick assumes that the content available at
e5819d621124ccc8ee3b7f1854c2d55ffaf91d32trawick http://example.com/ is on disk at /home/www/example/</p>
e5819d621124ccc8ee3b7f1854c2d55ffaf91d32trawickRewriteEngine On
e5819d621124ccc8ee3b7f1854c2d55ffaf91d32trawick# The URL-path used to get to this context, not the filesystem path
e5819d621124ccc8ee3b7f1854c2d55ffaf91d32trawickRewriteBase /myapp/
e5819d621124ccc8ee3b7f1854c2d55ffaf91d32trawickRewriteRule ^index\.html$ newsite.html
e5819d621124ccc8ee3b7f1854c2d55ffaf91d32trawick<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
61a4b32b1032d530e84e1131cb803f803acf7461trawick<div class="directive-section"><h2><a name="RewriteCond" id="RewriteCond">RewriteCond</a> <a name="rewritecond" id="rewritecond">Directive</a></h2>
61a4b32b1032d530e84e1131cb803f803acf7461trawick<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Defines a condition under which rewriting will take place
61a4b32b1032d530e84e1131cb803f803acf7461trawick<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code> RewriteCond
61a4b32b1032d530e84e1131cb803f803acf7461trawick <em>TestString</em> <em>CondPattern</em></code></td></tr>
61a4b32b1032d530e84e1131cb803f803acf7461trawick<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
61a4b32b1032d530e84e1131cb803f803acf7461trawick<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
61a4b32b1032d530e84e1131cb803f803acf7461trawick<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
61a4b32b1032d530e84e1131cb803f803acf7461trawick<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_rewrite</td></tr>
61a4b32b1032d530e84e1131cb803f803acf7461trawick <p>The <code class="directive">RewriteCond</code> directive defines a
61a4b32b1032d530e84e1131cb803f803acf7461trawick rule condition. One or more <code class="directive">RewriteCond</code>
61a4b32b1032d530e84e1131cb803f803acf7461trawick can precede a <code class="directive"><a href="#rewriterule">RewriteRule</a></code>
61a4b32b1032d530e84e1131cb803f803acf7461trawick directive. The following rule is then only used if both
61a4b32b1032d530e84e1131cb803f803acf7461trawick the current state of the URI matches its pattern, <strong>and</strong> if these conditions are met.</p>
61a4b32b1032d530e84e1131cb803f803acf7461trawick <p><em>TestString</em> is a string which can contain the
61a4b32b1032d530e84e1131cb803f803acf7461trawick following expanded constructs in addition to plain text:</p>
61a4b32b1032d530e84e1131cb803f803acf7461trawick <strong>RewriteRule backreferences</strong>: These are
61a4b32b1032d530e84e1131cb803f803acf7461trawick backreferences of the form <strong><code>$N</code></strong>
61a4b32b1032d530e84e1131cb803f803acf7461trawick (0 <= N <= 9). $1 to $9 provide access to the grouped
61a4b32b1032d530e84e1131cb803f803acf7461trawick parts (in parentheses) of the pattern, from the
61a4b32b1032d530e84e1131cb803f803acf7461trawick <code>RewriteRule</code> which is subject to the current
61a4b32b1032d530e84e1131cb803f803acf7461trawick set of <code>RewriteCond</code> conditions. $0 provides
61a4b32b1032d530e84e1131cb803f803acf7461trawick access to the whole string matched by that pattern.
61a4b32b1032d530e84e1131cb803f803acf7461trawick <strong>RewriteCond backreferences</strong>: These are
61a4b32b1032d530e84e1131cb803f803acf7461trawick backreferences of the form <strong><code>%N</code></strong>
61a4b32b1032d530e84e1131cb803f803acf7461trawick (0 <= N <= 9). %1 to %9 provide access to the grouped
61a4b32b1032d530e84e1131cb803f803acf7461trawick parts (again, in parentheses) of the pattern, from the last matched
61a4b32b1032d530e84e1131cb803f803acf7461trawick of conditions. %0 provides access to the whole string matched by
61a4b32b1032d530e84e1131cb803f803acf7461trawick that pattern.
61a4b32b1032d530e84e1131cb803f803acf7461trawick expansions of the form <strong><code>${mapname:key|default}</code></strong>.
61a4b32b1032d530e84e1131cb803f803acf7461trawick RewriteMap</a> for more details.
61a4b32b1032d530e84e1131cb803f803acf7461trawick <strong>Server-Variables</strong>: These are variables of
61a4b32b1032d530e84e1131cb803f803acf7461trawick where <em>NAME_OF_VARIABLE</em> can be a string taken
61a4b32b1032d530e84e1131cb803f803acf7461trawick from the following list:
61a4b32b1032d530e84e1131cb803f803acf7461trawick <th>HTTP headers:</th> <th>connection & request:</th> <th />
61a4b32b1032d530e84e1131cb803f803acf7461trawick HTTP_USER_AGENT<br />
61a4b32b1032d530e84e1131cb803f803acf7461trawick HTTP_REFERER<br />
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick HTTP_COOKIE<br />
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick HTTP_FORWARDED<br />
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick HTTP_HOST<br />
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick HTTP_PROXY_CONNECTION<br />
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick HTTP_ACCEPT<br />
cf30286e95bd9b293bb4e3d5e4b89ed9d51d7a3ftrawick REMOTE_ADDR<br />
cf30286e95bd9b293bb4e3d5e4b89ed9d51d7a3ftrawick REMOTE_HOST<br />
cf30286e95bd9b293bb4e3d5e4b89ed9d51d7a3ftrawick REMOTE_PORT<br />
cf30286e95bd9b293bb4e3d5e4b89ed9d51d7a3ftrawick REMOTE_USER<br />
cf30286e95bd9b293bb4e3d5e4b89ed9d51d7a3ftrawick REMOTE_IDENT<br />
cf30286e95bd9b293bb4e3d5e4b89ed9d51d7a3ftrawick REQUEST_METHOD<br />
cf30286e95bd9b293bb4e3d5e4b89ed9d51d7a3ftrawick SCRIPT_FILENAME<br />
cf30286e95bd9b293bb4e3d5e4b89ed9d51d7a3ftrawick PATH_INFO<br />
cf30286e95bd9b293bb4e3d5e4b89ed9d51d7a3ftrawick QUERY_STRING<br />
cf30286e95bd9b293bb4e3d5e4b89ed9d51d7a3ftrawick AUTH_TYPE<br />
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick <th>server internals:</th> <th>date and time:</th> <th>specials:</th>
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick DOCUMENT_ROOT<br />
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick SERVER_ADMIN<br />
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick SERVER_NAME<br />
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick SERVER_ADDR<br />
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick SERVER_PORT<br />
9dddb8cb288d6aa75b4955285c96c8725a8a35bbtrawick SERVER_PROTOCOL<br />
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick SERVER_SOFTWARE<br />
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick TIME_YEAR<br />
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick TIME_MON<br />
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick TIME_DAY<br />
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick TIME_HOUR<br />
9dddb8cb288d6aa75b4955285c96c8725a8a35bbtrawick TIME_MIN<br />
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick TIME_SEC<br />
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick TIME_WDAY<br />
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick API_VERSION<br />
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick THE_REQUEST<br />
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick REQUEST_URI<br />
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick REQUEST_FILENAME<br />
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick IS_SUBREQ<br />
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick HTTPS<br />
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick <p>These variables all
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick correspond to the similarly named HTTP
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick MIME-headers, C variables of the Apache HTTP Server or
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick Most are documented elsewhere in the Manual or in
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick the CGI specification. Those that are special to
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick mod_rewrite include those below.</p>
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick <dd>Will contain the text "true" if the request
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick currently being processed is a sub-request,
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick "false" otherwise. Sub-requests may be generated
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick by modules that need to resolve additional files
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick or URIs in order to complete their tasks.</dd>
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick <dd>This is the version of the Apache httpd module API
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick (the internal interface between server and
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick module) in the current httpd build, as defined in
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick corresponds to the version of Apache httpd in use (in
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick the release version of Apache httpd 1.3.14, for
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick instance, it is 19990320:10), but is mainly of
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick interest to module authors.</dd>
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick <dd>The full HTTP request line sent by the
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick include any additional headers sent by the
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick browser.</dd>
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick <dd>The resource requested in the HTTP request
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick line. (In the example above, this would be
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick <dd>The full local filesystem path to the file or
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick script matching the request, if this has already
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick been determined by the server at the time
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick <code>REQUEST_FILENAME</code> is referenced. Otherwise,
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick such as when used in virtual host context, the same
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick <dd>Will contain the text "on" if the connection is
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick can be safely used regardless of whether or not
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick <code class="module"><a href="/mod/mod_ssl.html">mod_ssl</a></code> is loaded).</dd>
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick <p>The variables SCRIPT_FILENAME and REQUEST_FILENAME
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick contain the same value - the value of the
9dddb8cb288d6aa75b4955285c96c8725a8a35bbtrawick <code>request_rec</code> structure of the Apache HTTP Server.
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick The first name is the commonly known CGI variable name
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick while the second is the appropriate counterpart of
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick REQUEST_URI (which contains the value of the
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick <code>uri</code> field of <code>request_rec</code>).</p>
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick <p>If a substitution occurred and the rewriting continues,
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick the value of both variables will be updated accordingly.</p>
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick <p>If used in per-server context (<em>i.e.</em>, before the
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick request is mapped to the filesystem) SCRIPT_FILENAME and
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick REQUEST_FILENAME cannot contain the full local filesystem
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick path since the path is unknown at this stage of processing.
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick Both variables will initially contain the value of REQUEST_URI
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick in that case. In order to obtain the full local filesystem
9dddb8cb288d6aa75b4955285c96c8725a8a35bbtrawick path of the request in per-server context, use an URL-based
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick look-ahead <code>%{LA-U:REQUEST_FILENAME}</code> to determine
4e12fead2bfdf613e0e2149f9f853edce6eab1fctrawick <code>%{ENV:variable}</code>, where <em>variable</em> can be
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick any environment variable, is also available.
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick This is looked-up via internal
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick Apache httpd structures and (if not found there) via
8b69a6447203b4cbd4c063010092dbe931503644trawick <code>getenv()</code> from the Apache httpd server process.</li>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick <code>%{SSL:variable}</code>, where <em>variable</em> is the
61a4b32b1032d530e84e1131cb803f803acf7461trawick name of an <a href="mod_ssl.html#envvars">SSL environment
d66e2366f1cceb0e2b107020fe61e36d090b6d9ctrawick variable</a>, can be used whether or not
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick <code class="module"><a href="/mod/mod_ssl.html">mod_ssl</a></code> is loaded, but will always expand to
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick the empty string if it is not. Example:
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick <code>%{SSL:SSL_CIPHER_USEKEYSIZE}</code> may expand to
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick <code>%{HTTP:header}</code>, where <em>header</em> can be
61a4b32b1032d530e84e1131cb803f803acf7461trawick any HTTP MIME-header name, can always be used to obtain the
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick value of a header sent in the HTTP request.
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick the value of the HTTP header
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick <p>If a HTTP header is used in a condition this header is added to
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick the Vary header of the response in case the condition evaluates to
4e12fead2bfdf613e0e2149f9f853edce6eab1fctrawick to true for the request. It is <strong>not</strong> added if the
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick condition evaluates to false for the request. Adding the HTTP header
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick to the Vary header of the response is needed for proper caching.</p>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick <p>It has to be kept in mind that conditions follow a short circuit
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick logic in the case of the '<strong><code>ornext|OR</code></strong>' flag
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick so that certain conditions might not be evaluated at all.</p></li>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick <code>%{LA-U:variable}</code> can be used for look-aheads which perform
88c0d6d1cfdecfa8c2b6d7ae2482f06755cd7887trawick an internal (URL-based) sub-request to determine the final
182d9b96e04124d14c9f539109fb4e8cbd360d36trawick value of <em>variable</em>. This can be used to access
182d9b96e04124d14c9f539109fb4e8cbd360d36trawick variable for rewriting which is not available at the current
182d9b96e04124d14c9f539109fb4e8cbd360d36trawick stage, but will be set in a later phase.
182d9b96e04124d14c9f539109fb4e8cbd360d36trawick <p>For instance, to rewrite according to the
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick per-server context (<code>httpd.conf</code> file) you must
d66e2366f1cceb0e2b107020fe61e36d090b6d9ctrawick variable is set by the authorization phases, which come
d66e2366f1cceb0e2b107020fe61e36d090b6d9ctrawick <em>after</em> the URL translation phase (during which mod_rewrite
d66e2366f1cceb0e2b107020fe61e36d090b6d9ctrawick operates).</p>
d66e2366f1cceb0e2b107020fe61e36d090b6d9ctrawick <p>On the other hand, because mod_rewrite implements
d66e2366f1cceb0e2b107020fe61e36d090b6d9ctrawick its per-directory context (<code>.htaccess</code> file) via
d66e2366f1cceb0e2b107020fe61e36d090b6d9ctrawick the Fixup phase of the API and because the authorization
a7b9ea00b96407cc3c1f3660162b3cb4918af396trawick phases come <em>before</em> this phase, you just can use
a7b9ea00b96407cc3c1f3660162b3cb4918af396trawick <code>%{REMOTE_USER}</code> in that context.</p></li>
a7b9ea00b96407cc3c1f3660162b3cb4918af396trawick <code>%{LA-F:variable}</code> can be used to perform an internal
a7b9ea00b96407cc3c1f3660162b3cb4918af396trawick (filename-based) sub-request, to determine the final value
a7b9ea00b96407cc3c1f3660162b3cb4918af396trawick of <em>variable</em>. Most of the time, this is the same as
a7b9ea00b96407cc3c1f3660162b3cb4918af396trawick LA-U above.</li>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick a regular expression which is applied to the
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick <em>TestString</em> is first evaluated, before being matched against
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick <p><strong>Remember:</strong> <em>CondPattern</em> is a
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick <em>perl compatible regular expression</em> with some
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick additions:</p>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick <li>You can prefix the pattern string with a
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick '<code>!</code>' character (exclamation mark) to specify a
182d9b96e04124d14c9f539109fb4e8cbd360d36trawick There are some special variants of <em>CondPatterns</em>.
182d9b96e04124d14c9f539109fb4e8cbd360d36trawick Instead of real regular expression strings you can also
182d9b96e04124d14c9f539109fb4e8cbd360d36trawick use one of the following:
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick <li>'<strong><CondPattern</strong>' (lexicographically
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick precedes)<br />
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick Treats the <em>CondPattern</em> as a plain string and
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick compares it lexicographically to <em>TestString</em>. True if
4e12fead2bfdf613e0e2149f9f853edce6eab1fctrawick <li>'<strong>>CondPattern</strong>' (lexicographically
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick follows)<br />
61a4b32b1032d530e84e1131cb803f803acf7461trawick Treats the <em>CondPattern</em> as a plain string and
61a4b32b1032d530e84e1131cb803f803acf7461trawick compares it lexicographically to <em>TestString</em>. True if
182d9b96e04124d14c9f539109fb4e8cbd360d36trawick <li>'<strong>=CondPattern</strong>' (lexicographically
182d9b96e04124d14c9f539109fb4e8cbd360d36trawick equal)<br />
182d9b96e04124d14c9f539109fb4e8cbd360d36trawick Treats the <em>CondPattern</em> as a plain string and
182d9b96e04124d14c9f539109fb4e8cbd360d36trawick compares it lexicographically to <em>TestString</em>. True if
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick equal, character for character). If <em>CondPattern</em>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick compares <em>TestString</em> to the empty string.</li>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick Treats the <em>TestString</em> as a pathname and tests
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick whether or not it exists, and is a directory.</li>
182d9b96e04124d14c9f539109fb4e8cbd360d36trawick Treats the <em>TestString</em> as a pathname and tests
182d9b96e04124d14c9f539109fb4e8cbd360d36trawick whether or not it exists, and is a regular file.</li>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick Treats the <em>TestString</em> as a pathname and tests
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick whether or not it exists, and is a regular file with size greater
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick than zero.</li>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick Treats the <em>TestString</em> as a pathname and tests
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick whether or not it exists, and is a symbolic link.</li>
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick <li>'<strong>-x</strong>' (has e<strong>x</strong>ecutable
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick permissions)<br />
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick Treats the <em>TestString</em> as a pathname and tests
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick whether or not it exists, and has executable permissions.
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick These permissions are determined according to
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick the underlying OS.</li>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick subrequest)<br />
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick Checks whether or not <em>TestString</em> is a valid file,
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick accessible via all the server's currently-configured
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick access controls for that path. This uses an internal
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick subrequest to do the check, so use it with care -
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick it can impact your server's performance!</li>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick subrequest)<br />
e6114dbc138189372015ea6ed63bc757645922a7trawick Checks whether or not <em>TestString</em> is a valid URL,
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick accessible via all the server's currently-configured
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick access controls for that path. This uses an internal
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick subrequest to do the check, so use it with care -
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick it can impact your server's performance!</li>
0ce6a6bda16e6c66ee68cc9784db36cc1bd558a7trawick All of these tests can
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick also be prefixed by an exclamation mark ('!') to
0ce6a6bda16e6c66ee68cc9784db36cc1bd558a7trawick negate their meaning.
798cfee8074b529042079c77eee6962a723350detrawick <li>You can also set special flags for
798cfee8074b529042079c77eee6962a723350detrawick <strong><code>[</code><em>flags</em><code>]</code></strong>
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick as the third argument to the <code>RewriteCond</code>
798cfee8074b529042079c77eee6962a723350detrawick directive, where <em>flags</em> is a comma-separated list of any of the
798cfee8074b529042079c77eee6962a723350detrawick following flags:
798cfee8074b529042079c77eee6962a723350detrawick This makes the test case-insensitive - differences
798cfee8074b529042079c77eee6962a723350detrawick between 'A-Z' and 'a-z' are ignored, both in the
798cfee8074b529042079c77eee6962a723350detrawick expanded <em>TestString</em> and the <em>CondPattern</em>.
798cfee8074b529042079c77eee6962a723350detrawick This flag is effective only for comparisons between
798cfee8074b529042079c77eee6962a723350detrawick <em>TestString</em> and <em>CondPattern</em>. It has no
798cfee8074b529042079c77eee6962a723350detrawick effect on filesystem and subrequest checks.</li>
bc2c3a74fda3d3684ecb4a8a94ca03e5604ef670trawick Use this to combine rule conditions with a local OR
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick instead of the implicit AND. Typical example:
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawickRewriteCond %{REMOTE_HOST} ^host1.* [OR]
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawickRewriteCond %{REMOTE_HOST} ^host2.* [OR]
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawickRewriteCond %{REMOTE_HOST} ^host3.*
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawickRewriteRule ...some special stuff for any of these hosts...
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick Without this flag you would have to write the condition/rule
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick pair three times.
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick If a HTTP header is used in the condition, this flag prevents
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick this header from being added to the Vary header of the response. <br />
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick Using this flag might break proper caching of the response if
798cfee8074b529042079c77eee6962a723350detrawick the representation of this response varies on the value of this header.
798cfee8074b529042079c77eee6962a723350detrawick So this flag should be only used if the meaning of the Vary header
9dddb8cb288d6aa75b4955285c96c8725a8a35bbtrawick is well understood.
9dddb8cb288d6aa75b4955285c96c8725a8a35bbtrawick <p>To rewrite the Homepage of a site according to the
9dddb8cb288d6aa75b4955285c96c8725a8a35bbtrawick ``<code>User-Agent:</code>'' header of the request, you can
9dddb8cb288d6aa75b4955285c96c8725a8a35bbtrawick use the following: </p>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawickRewriteCond %{HTTP_USER_AGENT} ^Mozilla.*
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawickRewriteRule ^/$ /homepage.max.html [L]
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawickRewriteCond %{HTTP_USER_AGENT} ^Lynx.*
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawickRewriteRule ^/$ /homepage.min.html [L]
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawickRewriteRule ^/$ /homepage.std.html [L]
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick <p>Explanation: If you use a browser which identifies itself
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick as 'Mozilla' (including Netscape Navigator, Mozilla etc), then you
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick get the max homepage (which could include frames, or other special
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick If you use the Lynx browser (which is terminal-based), then
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick you get the min homepage (which could be a version designed for
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick easy, text-only browsing).
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick If neither of these conditions apply (you use any other browser,
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick or your browser identifies itself as something non-standard), you get
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick the std (standard) homepage.</p>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick<div class="directive-section"><h2><a name="RewriteEngine" id="RewriteEngine">RewriteEngine</a> <a name="rewriteengine" id="rewriteengine">Directive</a></h2>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables or disables runtime rewriting engine</td></tr>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RewriteEngine on|off</code></td></tr>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>RewriteEngine off</code></td></tr>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_rewrite</td></tr>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick <p>The <code class="directive">RewriteEngine</code> directive enables or
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick disables the runtime rewriting engine. If it is set to
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick <code>off</code> this module does no runtime processing at
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick all. It does not even update the <code>SCRIPT_URx</code>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick environment variables.</p>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick <p>Use this directive to disable the module instead of
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick commenting out all the <code class="directive"><a href="#rewriterule">RewriteRule</a></code> directives!</p>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick <p>Note that rewrite configurations are not
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick inherited by virtual hosts. This means that you need to have a
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick <code>RewriteEngine on</code> directive for each virtual host
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick in which you wish to use rewrite rules.</p>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick <p><code class="directive">RewriteMap</code> directives of the type <code>prg</code>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick are not started during server initialization if they're defined in a
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick context that does not have <code class="directive">RewriteEngine</code> set to
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick<div class="directive-section"><h2><a name="RewriteLog" id="RewriteLog">RewriteLog</a> <a name="rewritelog" id="rewritelog">Directive</a></h2>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the name of the file used for logging rewrite engine
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RewriteLog <em>file-path</em></code></td></tr>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_rewrite</td></tr>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick <p>The <code class="directive">RewriteLog</code> directive sets the name
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick of the file to which the server logs any rewriting actions it
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick performs. If the name does not begin with a slash
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick ('<code>/</code>') then it is assumed to be relative to the
6500ceb45a2075fad36a0dc5c86a23858bf9c84etrawick <em>Server Root</em>. The directive should occur only once per
6500ceb45a2075fad36a0dc5c86a23858bf9c84etrawick server config.</p>
6500ceb45a2075fad36a0dc5c86a23858bf9c84etrawick rewriting actions it is not recommended to set
4fb787199739239f1162e8ff35cbf42c9b452b8ftrawick <em>Filename</em> to <code>/dev/null</code>, because
4fb787199739239f1162e8ff35cbf42c9b452b8ftrawick although the rewriting engine does not then output to a
6500ceb45a2075fad36a0dc5c86a23858bf9c84etrawick logfile it still creates the logfile output internally.
6500ceb45a2075fad36a0dc5c86a23858bf9c84etrawick <strong>This will slow down the server with no advantage
6500ceb45a2075fad36a0dc5c86a23858bf9c84etrawick to the administrator!</strong> To disable logging either
6500ceb45a2075fad36a0dc5c86a23858bf9c84etrawick remove or comment out the <code class="directive">RewriteLog</code>
6500ceb45a2075fad36a0dc5c86a23858bf9c84etrawickSee the <a href="/misc/security_tips.html">Apache HTTP Server Security Tips</a>
6500ceb45a2075fad36a0dc5c86a23858bf9c84etrawickdocument for details on how your security could be compromised if the
6500ceb45a2075fad36a0dc5c86a23858bf9c84etrawickdirectory where logfiles are stored is writable by anyone other than
6500ceb45a2075fad36a0dc5c86a23858bf9c84etrawickthe user that starts the server.
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick<div class="directive-section"><h2><a name="RewriteLogLevel" id="RewriteLogLevel">RewriteLogLevel</a> <a name="rewriteloglevel" id="rewriteloglevel">Directive</a></h2>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the verbosity of the log file used by the rewrite
e6114dbc138189372015ea6ed63bc757645922a7trawick<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RewriteLogLevel <em>Level</em></code></td></tr>
e6114dbc138189372015ea6ed63bc757645922a7trawick<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>RewriteLogLevel 0</code></td></tr>
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_rewrite</td></tr>
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick <p>The <code class="directive">RewriteLogLevel</code> directive sets the
1b7ea70f150ac2343f7086af4df0b81749885eb1trawick verbosity level of the rewriting logfile. The default level 0
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick means no logging, while 9 or more means that practically all
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick actions are logged.</p>
88c0d6d1cfdecfa8c2b6d7ae2482f06755cd7887trawick <p>To disable the logging of rewriting actions simply set
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick <em>Level</em> to 0. This disables all rewrite action
e5819d621124ccc8ee3b7f1854c2d55ffaf91d32trawick <em>Level</em> will slow down your Apache HTTP Server
e5819d621124ccc8ee3b7f1854c2d55ffaf91d32trawick dramatically! Use the rewriting logfile at a
88c0d6d1cfdecfa8c2b6d7ae2482f06755cd7887trawickRewriteLogLevel 3
1f5a6b18eb1d06210b03a7c8ea7a07506f5949ddtrawick<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
88c0d6d1cfdecfa8c2b6d7ae2482f06755cd7887trawick<div class="directive-section"><h2><a name="RewriteMap" id="RewriteMap">RewriteMap</a> <a name="rewritemap" id="rewritemap">Directive</a></h2>
88c0d6d1cfdecfa8c2b6d7ae2482f06755cd7887trawick<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Defines a mapping function for key-lookup</td></tr>
88c0d6d1cfdecfa8c2b6d7ae2482f06755cd7887trawick<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RewriteMap <em>MapName</em> <em>MapType</em>:<em>MapSource</em>
1f5a6b18eb1d06210b03a7c8ea7a07506f5949ddtrawick<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
88c0d6d1cfdecfa8c2b6d7ae2482f06755cd7887trawick<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_rewrite</td></tr>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>The choice of different dbm types is available in
e6114dbc138189372015ea6ed63bc757645922a7trawick <p>The <code class="directive">RewriteMap</code> directive defines a
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick <em>Rewriting Map</em> which can be used inside rule
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick substitution strings by the mapping-functions to
88c0d6d1cfdecfa8c2b6d7ae2482f06755cd7887trawick insert/substitute fields through a key lookup. The source of
a63c98c28033ca762ca4dcbed6b3adef63580e7ctrawick this lookup can be of various types.</p>
88c0d6d1cfdecfa8c2b6d7ae2482f06755cd7887trawick <p>The <a id="mapfunc" name="mapfunc"><em>MapName</em></a> is
a63c98c28033ca762ca4dcbed6b3adef63580e7ctrawick the name of the map and will be used to specify a
e6114dbc138189372015ea6ed63bc757645922a7trawick mapping-function for the substitution strings of a rewriting
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick rule via one of the following constructs:</p>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick <strong><code>${</code> <em>MapName</em> <code>:</code>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick <em>LookupKey</em> <code>|</code> <em>DefaultValue</em>
d66e2366f1cceb0e2b107020fe61e36d090b6d9ctrawick <p>When such a construct occurs, the map <em>MapName</em> is
d66e2366f1cceb0e2b107020fe61e36d090b6d9ctrawick consulted and the key <em>LookupKey</em> is looked-up. If the
d66e2366f1cceb0e2b107020fe61e36d090b6d9ctrawick key is found, the map-function construct is substituted by
d66e2366f1cceb0e2b107020fe61e36d090b6d9ctrawick <em>SubstValue</em>. If the key is not found then it is
5a2741099e61f454d3071092ae7e606418e5809atrawick substituted by <em>DefaultValue</em> or by the empty string
4e12fead2bfdf613e0e2149f9f853edce6eab1fctrawick <p>For example, you might define a
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick <p>You would then be able to use this map in a
bc2c3a74fda3d3684ecb4a8a94ca03e5604ef670trawick <code class="directive">RewriteRule</code> as follows:</p>
bc2c3a74fda3d3684ecb4a8a94ca03e5604ef670trawick RewriteRule ^/ex/(.*) ${examplemap:$1}
39d69ffeb80a2db1b3ffeed705f0652b1e77fe49trawick <p>The following combinations for <em>MapType</em> and
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick MapType: <code>txt</code>, MapSource: Unix filesystem
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick path to valid regular file
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick <p>This is the standard rewriting map feature where the
633bb5999839dd4433603525a2b76dc3be6df8f4trawick either blank lines, comment lines (starting with a '#'
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick character) or pairs like the following - one per
bc2c3a74fda3d3684ecb4a8a94ca03e5604ef670trawick## map.txt -- rewriting map
0ce6a6bda16e6c66ee68cc9784db36cc1bd558a7trawickRalf.S.Engelschall rse # Bastard Operator From Hell
bbd9d609b3e1f45b4a5beda3ef5e8a589b3657b4trawickMr.Joe.Average joe # Mr. Average
39d69ffeb80a2db1b3ffeed705f0652b1e77fe49trawick MapType: <code>rnd</code>, MapSource: Unix filesystem
bbd9d609b3e1f45b4a5beda3ef5e8a589b3657b4trawick path to valid regular file
0ce6a6bda16e6c66ee68cc9784db36cc1bd558a7trawick <p>This is identical to the Standard Plain Text variant
0ce6a6bda16e6c66ee68cc9784db36cc1bd558a7trawick above but with a special post-processing feature: After
0ce6a6bda16e6c66ee68cc9784db36cc1bd558a7trawick looking up a value it is parsed according to contained
0ce6a6bda16e6c66ee68cc9784db36cc1bd558a7trawick ``<code>|</code>'' characters which have the meaning of
0ce6a6bda16e6c66ee68cc9784db36cc1bd558a7trawick ``or''. In other words they indicate a set of
0ce6a6bda16e6c66ee68cc9784db36cc1bd558a7trawick alternatives from which the actual returned value is
0ce6a6bda16e6c66ee68cc9784db36cc1bd558a7trawick chosen randomly. For example, you might use the following map
0ce6a6bda16e6c66ee68cc9784db36cc1bd558a7trawick file and directives to provide a random load balancing between
0ce6a6bda16e6c66ee68cc9784db36cc1bd558a7trawick several back-end server, via a reverse-proxy. Images are sent
0ce6a6bda16e6c66ee68cc9784db36cc1bd558a7trawick to one of the servers in the 'static' pool, while everything
0ce6a6bda16e6c66ee68cc9784db36cc1bd558a7trawick else is sent to one of the 'dynamic' pool.</p>
0ce6a6bda16e6c66ee68cc9784db36cc1bd558a7trawick## map.txt -- rewriting map
0ce6a6bda16e6c66ee68cc9784db36cc1bd558a7trawickstatic www1|www2|www3|www4
39d69ffeb80a2db1b3ffeed705f0652b1e77fe49trawickdynamic www5|www6
0ce6a6bda16e6c66ee68cc9784db36cc1bd558a7trawick<div class="example"><h3>Configuration directives</h3><p><code>
5a2741099e61f454d3071092ae7e606418e5809atrawickRewriteRule ^/(.*\.(png|gif|jpg)) http://${servers:static}/$1
0ce6a6bda16e6c66ee68cc9784db36cc1bd558a7trawick[NC,P,L]<br />
0ce6a6bda16e6c66ee68cc9784db36cc1bd558a7trawickRewriteRule ^/(.*) http://${servers:dynamic}/$1 [P,L]
bbd9d609b3e1f45b4a5beda3ef5e8a589b3657b4trawick <code>dbm[=<em>type</em>]</code>, MapSource: Unix filesystem
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick path to valid regular file
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick <p>Here the source is a binary format DBM file containing
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick the same contents as a <em>Plain Text</em> format file, but
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick in a special representation which is optimized for really
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick fast lookups. The <em>type</em> can be sdbm, gdbm, ndbm, or
0ce6a6bda16e6c66ee68cc9784db36cc1bd558a7trawick db depending on <a href="/install.html#dbm">compile-time
39d69ffeb80a2db1b3ffeed705f0652b1e77fe49trawick compile-time default will be chosen.</p>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick <p>To create a dbm file from a source text file, use the <a href="/programs/httxt2dbm.html">httxt2dbm</a> utility.</p>
a63c98c28033ca762ca4dcbed6b3adef63580e7ctrawick MapType: <code>int</code>, MapSource: Internal Apache httpd
a63c98c28033ca762ca4dcbed6b3adef63580e7ctrawick <p>Here, the source is an internal Apache httpd function.
a63c98c28033ca762ca4dcbed6b3adef63580e7ctrawick Currently you cannot create your own, but the following
a63c98c28033ca762ca4dcbed6b3adef63580e7ctrawick functions already exist:</p>
a63c98c28033ca762ca4dcbed6b3adef63580e7ctrawick Converts the key to all upper case.</li>
a63c98c28033ca762ca4dcbed6b3adef63580e7ctrawick Converts the key to all lower case.</li>
a63c98c28033ca762ca4dcbed6b3adef63580e7ctrawick Translates special characters in the key to
a63c98c28033ca762ca4dcbed6b3adef63580e7ctrawick hex-encodings.</li>
a63c98c28033ca762ca4dcbed6b3adef63580e7ctrawick Translates hex-encodings in the key back to
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick special characters.</li>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick MapType: <code>prg</code>, MapSource: Unix filesystem
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick path to valid regular file
0ce6a6bda16e6c66ee68cc9784db36cc1bd558a7trawick <p>Here the source is a program, not a map file. To
0ce6a6bda16e6c66ee68cc9784db36cc1bd558a7trawick create it you can use a language of your choice, but
0ce6a6bda16e6c66ee68cc9784db36cc1bd558a7trawick the result has to be an executable program (either
0ce6a6bda16e6c66ee68cc9784db36cc1bd558a7trawick object-code or a script with the magic cookie trick
0ce6a6bda16e6c66ee68cc9784db36cc1bd558a7trawick <p>This program is started once, when the Apache httpd server
0ce6a6bda16e6c66ee68cc9784db36cc1bd558a7trawick is started, and then communicates with the rewriting engine
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick file-handles. For each map-function lookup it will
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick receive the key to lookup as a newline-terminated string
6500ceb45a2075fad36a0dc5c86a23858bf9c84etrawick looked-up value as a newline-terminated string on
4e12fead2bfdf613e0e2149f9f853edce6eab1fctrawick ``<code>NULL</code>'' if it fails (<em>i.e.</em>, there
6500ceb45a2075fad36a0dc5c86a23858bf9c84etrawick is no corresponding value for the given key).</p>
0ce6a6bda16e6c66ee68cc9784db36cc1bd558a7trawick <p>This feature utilizes the <code>rewrite-map</code> mutex,
0ce6a6bda16e6c66ee68cc9784db36cc1bd558a7trawick which is required for reliable communication with the program.
0ce6a6bda16e6c66ee68cc9784db36cc1bd558a7trawick The mutex mechanism and lock file can be configured with the
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick <code class="directive"><a href="/mod/core.html#mutex">Mutex</a></code> directive.</p>
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick <p>External rewriting programs are not started if they're defined in a
a8002cb6eb5309086e06721eb2cdc20b891840fftrawick context that does not have <code class="directive">RewriteEngine</code> set to
a63c98c28033ca762ca4dcbed6b3adef63580e7ctrawick <p>A trivial program which will implement a 1:1 map (<em>i.e.</em>,
a8002cb6eb5309086e06721eb2cdc20b891840fftrawick key == value) could be:</p>
a63c98c28033ca762ca4dcbed6b3adef63580e7ctrawickwhile (<STDIN>) {
a63c98c28033ca762ca4dcbed6b3adef63580e7ctrawick # ...put here any transformations or lookups...
4e2fbd7af73349caa41681acc2ec43d6d7011beatrawick If this program hangs, it will cause Apache httpd to hang
4e2fbd7af73349caa41681acc2ec43d6d7011beatrawick when trying to use the relevant rewrite rule.</li>
4e2fbd7af73349caa41681acc2ec43d6d7011beatrawick <li>A common mistake is to use buffered I/O on
0ce6a6bda16e6c66ee68cc9784db36cc1bd558a7trawick <code>stdout</code>. Avoid this, as it will cause a deadloop!
0ce6a6bda16e6c66ee68cc9784db36cc1bd558a7trawick ``<code>$|=1</code>'' is used above, to prevent this.</li>
4e2fbd7af73349caa41681acc2ec43d6d7011beatrawick MapSource: An SQL SELECT statement that takes a single
4e2fbd7af73349caa41681acc2ec43d6d7011beatrawick argument and returns a single value.</p>
4e2fbd7af73349caa41681acc2ec43d6d7011beatrawick <p>This uses <code class="module"><a href="/mod/mod_dbd.html">mod_dbd</a></code> to implement a rewritemap
bbd9d609b3e1f45b4a5beda3ef5e8a589b3657b4trawick by lookup in an SQL database. There are two forms:
bbd9d609b3e1f45b4a5beda3ef5e8a589b3657b4trawick <code>fastdbd</code> caches database lookups internally,
bbd9d609b3e1f45b4a5beda3ef5e8a589b3657b4trawick <code>dbd</code> doesn't. So <code>dbd</code> incurs a
4e2fbd7af73349caa41681acc2ec43d6d7011beatrawick performance penalty but responds immediately if the database
4e2fbd7af73349caa41681acc2ec43d6d7011beatrawick contents are updated, while <code>fastdbd</code> is more
e6114dbc138189372015ea6ed63bc757645922a7trawick efficient but won't re-read database contents until server
4e2fbd7af73349caa41681acc2ec43d6d7011beatrawick restart.</p>
e6114dbc138189372015ea6ed63bc757645922a7trawick <p>If a query returns more than one row, a random row from
e6114dbc138189372015ea6ed63bc757645922a7trawick the result set is used.</p>
4e2fbd7af73349caa41681acc2ec43d6d7011beatrawickRewriteMap myquery "fastdbd:SELECT destination FROM rewrite WHERE source = %s"
e6114dbc138189372015ea6ed63bc757645922a7trawick <p>The <code class="directive">RewriteMap</code> directive can occur more than
4e2fbd7af73349caa41681acc2ec43d6d7011beatrawick once. For each mapping-function use one
fcd5c4e9e126e867eb270ed2d4138348cb1e46e5trawick <code class="directive">RewriteMap</code> directive to declare its rewriting
<div class="directive-section"><h2><a name="RewriteOptions" id="RewriteOptions">RewriteOptions</a> <a name="rewriteoptions" id="rewriteoptions">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets some special options for the rewrite engine</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RewriteOptions <var>Options</var></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#Compatibility">Compatibility:</a></th><td><code>MaxRedirects</code> is no longer available in version 2.1 and
<div class="directive-section"><h2><a name="RewriteRule" id="RewriteRule">RewriteRule</a> <a name="rewriterule" id="rewriterule">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Defines rules for the rewriting engine</td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<p>For some hints on <a class="glossarylink" href="/glossary.html#regex" title="see glossary">regular
<dd>A <code class="directive"><a href="/mod/core.html#documentroot">DocumentRoot</a></code>-relative path to the
resource to be served. Note that <code class="module"><a href="/mod/mod_rewrite.html">mod_rewrite</a></code>
URL-mapping directives (such as <code class="directive"><a href="/mod/mod_alias.html#alias">Alias</a></code>) to be applied to the
<code class="module"><a href="/mod/mod_rewrite.html">mod_rewrite</a></code> checks to see whether the
<p>Additionally you can set special <a name="rewriteflags" id="rewriteflags">actions</a> to be performed by
details, and examples, for each flag, are available in the <a href="/rewrite/flags.html">Rewrite Flags document</a>.</p>
the rule(s) chained to it will be skipped. <em><a href="/rewrite/flags.html#flag_c">details ...</a></em></td>
CO=<em>NAME</em>:<em>VAL</em>[:<em>domain</em>[:<em>lifetime</em>[:<em>path</em>[:<em>secure</em>[:<em>httponly</em>]]]]] <em><a href="/rewrite/flags.html#flag_co">details ...</a></em>
<td>Returns a 410 GONE response to the client browser. <em><a href="/rewrite/flags.html#flag_g">details ...</a></em></td>
<em>Content-handler</em> for processing. <em><a href="/rewrite/flags.html#flag_h">details ...</a></em></td>
special characters in the result of the rewrite. <em><a href="/rewrite/flags.html#flag_ne">details ...</a></em></td>
any query string that was in the original request URL. <em><a href="/rewrite/flags.html#flag_qsa">details ...</a></em></td>
rules if the current rule matches. <em><a href="/rewrite/flags.html#flag_s">details ...</a></em></td>
<td>Force the <a class="glossarylink" href="/glossary.html#mime-type" title="see glossary">MIME-type</a> of the target file
<p>The rewrite engine may be used in <a href="/howto/htaccess.html">.htaccess</a> files. To enable the
<p>The rewrite engine may also be used in <code class="directive"><a href="/mod/core.html#directory"><Directory></a></code> sections with the same
virtual host context, rather than in a <code class="directive"><a href="/mod/core.html#directory"><Directory></a></code> section.</p>
<p>Although rewrite rules are syntactically permitted in <code class="directive"><a href="/mod/core.html#location"><Location></a></code> and <code class="directive"><a href="/mod/core.html#files"><Files></a></code> sections, this
^/somepath(.*) /otherpath$1 [R] http://thishost/otherpath/pathinfo
^/somepath(.*) http://thishost/otherpath$1 [P] doesn't make sense, not supported
^localpath(.*) otherpath$1 [R] http://thishost/somepath/otherpath/pathinfo
^localpath(.*) /otherpath$1 [R] http://thishost/otherpath/pathinfo
^localpath(.*) http://thishost/otherpath$1 [P] doesn't make sense, not supported
<p><span>Available Languages: </span><a href="/en/mod/mod_rewrite.html" title="English"> en </a> |
<a href="/fr/mod/mod_rewrite.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a></p>
<p class="apache">Copyright 2010 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="/faq/">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p></div>