1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
4 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
5 This file is generated from xml source: DO NOT EDIT
6 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
8 <title>mod_rewrite - Apache HTTP Server</title>
9 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
10 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
11 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
12 <script src="../style/scripts/prettify.min.js" type="text/javascript">
15 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
17 <div id="page-header">
18 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
19 <p class="apache">Apache HTTP Server Version 2.5</p>
20 <img alt="" src="../images/feather.gif" /></div>
21 <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
23 <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.5</a> > <a href="./">Modules</a></div>
24 <div id="page-content">
25 <div id="preamble"><h1>Apache Module mod_rewrite</h1>
27 <p><span>Available Languages: </span><a href="../en/mod/mod_rewrite.html" title="English"> en </a> |
28 <a href="../fr/mod/mod_rewrite.html" hreflang="fr" rel="alternate" title="Français"> fr </a></p>
30 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Provides a rule-based rewriting engine to rewrite requested
31 URLs on the fly</td></tr>
32 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
33 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>rewrite_module</td></tr>
34 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_rewrite.c</td></tr></table>
37 <p>The <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> module uses a rule-based rewriting
38 engine, based on a PCRE regular-expression parser, to rewrite requested URLs on
39 the fly. By default, <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> maps a URL to a filesystem
40 path. However, it can also be used to redirect one URL to another URL, or
41 to invoke an internal proxy fetch.</p>
42 <p><code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> provides a flexible and powerful way to
43 manipulate URLs using an unlimited number of rules. Each rule can have an
44 unlimited number of attached rule conditions, to allow you to rewrite URL
45 based on server variables, environment variables, HTTP headers, or time
47 <p><code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> operates on the full URL path, including the
48 path-info section. A rewrite rule can be invoked in
49 <code>httpd.conf</code> or in <code>.htaccess</code>. The path generated
50 by a rewrite rule can include a query string, or can lead to internal
51 sub-processing, external request redirection, or internal proxy
54 <p>Further details, discussion, and examples, are provided in the
55 <a href="../rewrite/">detailed mod_rewrite documentation</a>.</p>
57 <div id="quickview"><h3 class="directives">Directives</h3>
59 <li><img alt="" src="../images/down.gif" /> <a href="#rewritebase">RewriteBase</a></li>
60 <li><img alt="" src="../images/down.gif" /> <a href="#rewritecond">RewriteCond</a></li>
61 <li><img alt="" src="../images/down.gif" /> <a href="#rewriteengine">RewriteEngine</a></li>
62 <li><img alt="" src="../images/down.gif" /> <a href="#rewritemap">RewriteMap</a></li>
63 <li><img alt="" src="../images/down.gif" /> <a href="#rewriteoptions">RewriteOptions</a></li>
64 <li><img alt="" src="../images/down.gif" /> <a href="#rewriterule">RewriteRule</a></li>
68 <li><img alt="" src="../images/down.gif" /> <a href="#logging">Logging</a></li>
69 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
70 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
72 <h2><a name="logging" id="logging">Logging</a></h2>
74 <p><code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> offers detailed logging of its actions
75 at the <code>trace1</code> to <code>trace8</code> log levels. The
76 log level can be set specifically for <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>
77 using the <code class="directive"><a href="../mod/core.html#loglevel">LogLevel</a></code> directive: Up to
78 level <code>debug</code>, no actions are logged, while <code>trace8</code>
79 means that practically all actions are logged.</p>
82 Using a high trace log level for <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>
83 will slow down your Apache HTTP Server dramatically! Use a log
84 level higher than <code>trace2</code> only for debugging!
87 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">LogLevel alert rewrite:trace3</pre>
90 <div class="note"><h3>RewriteLog</h3>
91 <p>Those familiar with earlier versions of
92 <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> will no doubt be looking for the
93 <code>RewriteLog</code> and <code>RewriteLogLevel</code>
94 directives. This functionality has been completely replaced by the
95 new per-module logging configuration mentioned above.
98 <p>To get just the <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>-specific log
99 messages, pipe the log file through grep:</p>
100 <div class="example"><p><code>
101 tail -f error_log|fgrep '[rewrite:'
106 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
107 <div class="directive-section"><h2><a name="RewriteBase" id="RewriteBase">RewriteBase</a> <a name="rewritebase" id="rewritebase">Directive</a></h2>
108 <table class="directive">
109 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the base URL for per-directory rewrites</td></tr>
110 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RewriteBase <em>URL-path</em></code></td></tr>
111 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>None</code></td></tr>
112 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
113 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
114 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
115 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_rewrite</td></tr>
117 <p>The <code class="directive">RewriteBase</code> directive specifies the
118 URL prefix to be used for per-directory (htaccess)
119 <code class="directive">RewriteRule</code> directives that substitute a relative
121 <p> This directive is <em>required</em> when you use a relative path
122 in a substitution in per-directory (htaccess) context unless either
123 of the following conditions are true:</p>
125 <li> The original request, and the substitution, are underneath the
126 <code class="directive"><a href="../mod/core.html#documentroot">DocumentRoot</a></code>
127 (as opposed to reachable by other means, such as
128 <code class="directive"><a href="../mod/mod_alias.html#alias">Alias</a></code>).</li>
129 <li> The <em>filesystem</em> path to the directory containing the
130 <code class="directive">RewriteRule</code>, suffixed by the relative
131 substitution is also valid as a URL path on the server
135 <p> In the example below, <code class="directive">RewriteBase</code> is necessary
136 to avoid rewriting to http://example.com/opt/myapp-1.2.3/welcome.html
137 since the resource was not relative to the document root. This
138 misconfiguration would normally cause the server to look for an "opt"
139 directory under the document root.</p>
140 <pre class="prettyprint lang-config">DocumentRoot /var/www/example.com
141 Alias /myapp /opt/myapp-1.2.3
142 <Directory /opt/myapp-1.2.3>
145 RewriteRule ^index\.html$ welcome.html
146 </Directory></pre>
150 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
151 <div class="directive-section"><h2><a name="RewriteCond" id="RewriteCond">RewriteCond</a> <a name="rewritecond" id="rewritecond">Directive</a></h2>
152 <table class="directive">
153 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Defines a condition under which rewriting will take place
155 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code> RewriteCond
156 <em>TestString</em> <em>CondPattern</em></code></td></tr>
157 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
158 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
159 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
160 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_rewrite</td></tr>
162 <p>The <code class="directive">RewriteCond</code> directive defines a
163 rule condition. One or more <code class="directive">RewriteCond</code>
164 can precede a <code class="directive"><a href="#rewriterule">RewriteRule</a></code>
165 directive. The following rule is then only used if both
166 the current state of the URI matches its pattern, <strong>and</strong> if these conditions are met.</p>
168 <p><em>TestString</em> is a string which can contain the
169 following expanded constructs in addition to plain text:</p>
173 <strong>RewriteRule backreferences</strong>: These are
174 backreferences of the form <strong><code>$N</code></strong>
175 (0 <= N <= 9). $1 to $9 provide access to the grouped
176 parts (in parentheses) of the pattern, from the
177 <code>RewriteRule</code> which is subject to the current
178 set of <code>RewriteCond</code> conditions. $0 provides
179 access to the whole string matched by that pattern.
182 <strong>RewriteCond backreferences</strong>: These are
183 backreferences of the form <strong><code>%N</code></strong>
184 (0 <= N <= 9). %1 to %9 provide access to the grouped
185 parts (again, in parentheses) of the pattern, from the last matched
186 <code>RewriteCond</code> in the current set
187 of conditions. %0 provides access to the whole string matched by
191 <strong>RewriteMap expansions</strong>: These are
192 expansions of the form <strong><code>${mapname:key|default}</code></strong>.
193 See <a href="#mapfunc">the documentation for
194 RewriteMap</a> for more details.
197 <strong>Server-Variables</strong>: These are variables of
199 <strong><code>%{</code> <em>NAME_OF_VARIABLE</em>
200 <code>}</code></strong>
201 where <em>NAME_OF_VARIABLE</em> can be a string taken
202 from the following list:
207 <th>HTTP headers:</th> <th>connection & request:</th> <th />
212 HTTP_USER_AGENT<br />
217 HTTP_PROXY_CONNECTION<br />
223 CONN_REMOTE_ADDR<br />
229 SCRIPT_FILENAME<br />
239 <th>server internals:</th> <th>date and time:</th> <th>specials:</th>
249 SERVER_PROTOCOL<br />
250 SERVER_SOFTWARE<br />
268 REQUEST_FILENAME<br />
273 CONN_REMOTE_ADDR<br />
278 <p>These variables all
279 correspond to the similarly named HTTP
280 MIME-headers, C variables of the Apache HTTP Server or
281 <code>struct tm</code> fields of the Unix system.
282 Most are documented elsewhere in the Manual or in
283 the CGI specification.</p>
285 <p>SERVER_NAME and SERVER_PORT depend on the values of
286 <code class="directive"><a href="../mod/core.html#usecanonicalname">UseCanonicalName</a></code> and
287 <code class="directive"><a href="../mod/core.html#usecanonicalphysicalport">UseCanonicalPhysicalPort</a></code>
290 <p>Those that are special to mod_rewrite include those below.</p>
293 <dt><code>IS_SUBREQ</code></dt>
295 <dd>Will contain the text "true" if the request
296 currently being processed is a sub-request,
297 "false" otherwise. Sub-requests may be generated
298 by modules that need to resolve additional files
299 or URIs in order to complete their tasks.</dd>
301 <dt><code>API_VERSION</code></dt>
303 <dd>This is the version of the Apache httpd module API
304 (the internal interface between server and
305 module) in the current httpd build, as defined in
306 include/ap_mmn.h. The module API version
307 corresponds to the version of Apache httpd in use (in
308 the release version of Apache httpd 1.3.14, for
309 instance, it is 19990320:10), but is mainly of
310 interest to module authors.</dd>
312 <dt><code>THE_REQUEST</code></dt>
314 <dd>The full HTTP request line sent by the
315 browser to the server (e.g., "<code>GET
316 /index.html HTTP/1.1</code>"). This does not
317 include any additional headers sent by the
318 browser. This value has not been unescaped
319 (decoded), unlike most other variables below.</dd>
321 <dt><code>REQUEST_URI</code></dt>
323 <dd>The path component of the requested URI,
324 such as "/index.html". This notably excludes the
325 query string which is available as as its own variable
326 named <code>QUERY_STRING</code>.</dd>
328 <dt><code>REQUEST_FILENAME</code></dt>
330 <dd>The full local filesystem path to the file or
331 script matching the request, if this has already
332 been determined by the server at the time
333 <code>REQUEST_FILENAME</code> is referenced. Otherwise,
334 such as when used in virtual host context, the same
335 value as <code>REQUEST_URI</code>. Depending on the value of
336 <code class="directive"><a href="../mod/core.html#acceptpathinfo">AcceptPathInfo</a></code>, the
337 server may have only used some leading components of the
338 <code>REQUEST_URI</code> to map the request to a file.
341 <dt><code>HTTPS</code></dt>
343 <dd>Will contain the text "on" if the connection is
344 using SSL/TLS, or "off" otherwise. (This variable
345 can be safely used regardless of whether or not
346 <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> is loaded).</dd>
348 <dt><code>REQUEST_SCHEME</code></dt>
350 <dd>Will contain the scheme of the request (usually
351 "http" or "https"). This value can be influenced with
352 <code class="directive"><a href="../mod/core.html#servername">ServerName</a></code>.</dd>
354 <dt><code>REMOTE_ADDR</code></dt>
355 <dd>The IP address of the remote host (see the
356 <code class="module"><a href="../mod/mod_remoteip.html">mod_remoteip</a></code> module).</dd>
358 <dt><code>CONN_REMOTE_ADDR</code></dt>
359 <dd>Since 2.4.8: The peer IP address of the connection (see the
360 <code class="module"><a href="../mod/mod_remoteip.html">mod_remoteip</a></code> module).</dd>
367 <p>If the <em>TestString</em> has the special value <code>expr</code>,
368 the <em>CondPattern</em> will be treated as an
369 <a href="../expr.html">ap_expr</a>. HTTP headers referenced in the
370 expression will be added to the Vary header if the <code>novary</code>
371 flag is not given.</p>
373 <p>Other things you should be aware of:</p>
377 <p>The variables SCRIPT_FILENAME and REQUEST_FILENAME
378 contain the same value - the value of the
379 <code>filename</code> field of the internal
380 <code>request_rec</code> structure of the Apache HTTP Server.
381 The first name is the commonly known CGI variable name
382 while the second is the appropriate counterpart of
383 REQUEST_URI (which contains the value of the
384 <code>uri</code> field of <code>request_rec</code>).</p>
385 <p>If a substitution occurred and the rewriting continues,
386 the value of both variables will be updated accordingly.</p>
387 <p>If used in per-server context (<em>i.e.</em>, before the
388 request is mapped to the filesystem) SCRIPT_FILENAME and
389 REQUEST_FILENAME cannot contain the full local filesystem
390 path since the path is unknown at this stage of processing.
391 Both variables will initially contain the value of REQUEST_URI
392 in that case. In order to obtain the full local filesystem
393 path of the request in per-server context, use an URL-based
394 look-ahead <code>%{LA-U:REQUEST_FILENAME}</code> to determine
395 the final value of REQUEST_FILENAME.</p></li>
398 <code>%{ENV:variable}</code>, where <em>variable</em> can be
399 any environment variable, is also available.
400 This is looked-up via internal
401 Apache httpd structures and (if not found there) via
402 <code>getenv()</code> from the Apache httpd server process.</li>
405 <code>%{SSL:variable}</code>, where <em>variable</em> is the
406 name of an <a href="mod_ssl.html#envvars">SSL environment
407 variable</a>, can be used whether or not
408 <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> is loaded, but will always expand to
409 the empty string if it is not. Example:
410 <code>%{SSL:SSL_CIPHER_USEKEYSIZE}</code> may expand to
411 <code>128</code>.</li>
414 <code>%{HTTP:header}</code>, where <em>header</em> can be
415 any HTTP MIME-header name, can always be used to obtain the
416 value of a header sent in the HTTP request.
417 Example: <code>%{HTTP:Proxy-Connection}</code> is
418 the value of the HTTP header
419 ``<code>Proxy-Connection:</code>''.
420 <p>If a HTTP header is used in a condition this header is added to
421 the Vary header of the response in case the condition evaluates
422 to true for the request. It is <strong>not</strong> added if the
423 condition evaluates to false for the request. Adding the HTTP header
424 to the Vary header of the response is needed for proper caching.</p>
425 <p>It has to be kept in mind that conditions follow a short circuit
426 logic in the case of the '<strong><code>ornext|OR</code></strong>' flag
427 so that certain conditions might not be evaluated at all.</p></li>
430 <a id="LA-U" name="LA-U"><code>%{LA-U:variable}</code></a>
431 can be used for look-aheads which perform
432 an internal (URL-based) sub-request to determine the final
433 value of <em>variable</em>. This can be used to access
434 variable for rewriting which is not available at the current
435 stage, but will be set in a later phase.
436 <p>For instance, to rewrite according to the
437 <code>REMOTE_USER</code> variable from within the
438 per-server context (<code>httpd.conf</code> file) you must
439 use <code>%{LA-U:REMOTE_USER}</code> - this
440 variable is set by the authorization phases, which come
441 <em>after</em> the URL translation phase (during which mod_rewrite
443 <p>On the other hand, because mod_rewrite implements
444 its per-directory context (<code>.htaccess</code> file) via
445 the Fixup phase of the API and because the authorization
446 phases come <em>before</em> this phase, you just can use
447 <code>%{REMOTE_USER}</code> in that context.</p></li>
450 <code>%{LA-F:variable}</code> can be used to perform an internal
451 (filename-based) sub-request, to determine the final value
452 of <em>variable</em>. Most of the time, this is the same as
456 <p><em>CondPattern</em> is the condition pattern,
457 a regular expression which is applied to the
458 current instance of the <em>TestString</em>.
459 <em>TestString</em> is first evaluated, before being matched against
460 <em>CondPattern</em>.</p>
462 <p><em>CondPattern</em> is usually a
463 <em>perl compatible regular expression</em>, but there is
464 additional syntax available to perform other useful tests against
465 the <em>Teststring</em>:</p>
468 <li>You can prefix the pattern string with a
469 '<code>!</code>' character (exclamation mark) to specify a
470 <strong>non</strong>-matching pattern.</li>
473 You can perform lexicographical string comparisons:
476 <li>'<strong><CondPattern</strong>' (lexicographically
478 Treats the <em>CondPattern</em> as a plain string and
479 compares it lexicographically to <em>TestString</em>. True if
480 <em>TestString</em> lexicographically precedes
481 <em>CondPattern</em>.</li>
483 <li>'<strong>>CondPattern</strong>' (lexicographically
485 Treats the <em>CondPattern</em> as a plain string and
486 compares it lexicographically to <em>TestString</em>. True if
487 <em>TestString</em> lexicographically follows
488 <em>CondPattern</em>.</li>
490 <li>'<strong>=CondPattern</strong>' (lexicographically
492 Treats the <em>CondPattern</em> as a plain string and
493 compares it lexicographically to <em>TestString</em>. True if
494 <em>TestString</em> is lexicographically equal to
495 <em>CondPattern</em> (the two strings are exactly
496 equal, character for character). If <em>CondPattern</em>
497 is <code>""</code> (two quotation marks) this
498 compares <em>TestString</em> to the empty string.</li>
500 <li>'<strong><=CondPattern</strong>' (lexicographically
501 less than or equal to)<br />
502 Treats the <em>CondPattern</em> as a plain string and
503 compares it lexicographically to <em>TestString</em>. True
504 if <em>TestString</em> lexicographically precedes
505 <em>CondPattern</em>, or is equal to <em>CondPattern</em>
506 (the two strings are equal, character for character).</li>
508 <li>'<strong>>=CondPattern</strong>' (lexicographically
509 greater than or equal to)<br />
510 Treats the <em>CondPattern</em> as a plain string and
511 compares it lexicographically to <em>TestString</em>. True
512 if <em>TestString</em> lexicographically follows
513 <em>CondPattern</em>, or is equal to <em>CondPattern</em>
514 (the two strings are equal, character for character).</li>
518 You can perform integer comparisons:
521 <li>'<strong>-eq</strong>' (is numerically
522 <strong>eq</strong>ual to)<br />
523 The <em>TestString</em> is treated as an integer, and is
524 numerically compared to the <em>CondPattern</em>. True if
525 the two are numerically equal.</li>
527 <li>'<strong>-ge</strong>' (is numerically
528 <strong>g</strong>reater than or <strong>e</strong>qual to)<br />
529 The <em>TestString</em> is treated as an integer, and is
530 numerically compared to the <em>CondPattern</em>. True if
531 the <em>TestString</em> is numerically greater than or equal
532 to the <em>CondPattern</em>.</li>
534 <li>'<strong>-gt</strong>' (is numerically
535 <strong>g</strong>reater <strong>t</strong>han)<br />
536 The <em>TestString</em> is treated as an integer, and is
537 numerically compared to the <em>CondPattern</em>. True if
538 the <em>TestString</em> is numerically greater than
539 the <em>CondPattern</em>.</li>
541 <li>'<strong>-le</strong>' (is numerically
542 <strong>l</strong>ess than or <strong>e</strong>qual to)<br />
543 The <em>TestString</em> is treated as an integer, and is
544 numerically compared to the <em>CondPattern</em>. True if
545 the <em>TestString</em> is numerically less than or equal
546 to the <em>CondPattern</em>. Avoid confusion with the
547 <strong>-l</strong> by using the <strong>-L</strong> or
548 <strong>-h</strong> variant.</li>
550 <li>'<strong>-lt</strong>' (is numerically
551 <strong>l</strong>ess <strong>t</strong>han)<br />
552 The <em>TestString</em> is treated as an integer, and is
553 numerically compared to the <em>CondPattern</em>. True if
554 the <em>TestString</em> is numerically less than
555 the <em>CondPattern</em>. Avoid confusion with the
556 <strong>-l</strong> by using the <strong>-L</strong> or
557 <strong>-h</strong> variant.</li>
562 <li>You can perform various file attribute tests:
564 <li>'<strong>-d</strong>' (is
565 <strong>d</strong>irectory)<br />
566 Treats the <em>TestString</em> as a pathname and tests
567 whether or not it exists, and is a directory.</li>
569 <li>'<strong>-f</strong>' (is regular
570 <strong>f</strong>ile)<br />
571 Treats the <em>TestString</em> as a pathname and tests
572 whether or not it exists, and is a regular file.</li>
574 <li>'<strong>-F</strong>' (is existing file, via
576 Checks whether or not <em>TestString</em> is a valid file,
577 accessible via all the server's currently-configured
578 access controls for that path. This uses an internal
579 subrequest to do the check, so use it with care -
580 it can impact your server's performance!</li>
582 <li>'<strong>-H</strong>' (is symbolic link, bash convention)<br />
583 See <strong>-l</strong>.</li>
585 <li>'<strong>-l</strong>' (is symbolic
586 <strong>l</strong>ink)<br />
587 Treats the <em>TestString</em> as a pathname and tests
588 whether or not it exists, and is a symbolic link. May also
589 use the bash convention of <strong>-L</strong> or
590 <strong>-h</strong> if there's a possibility of confusion
591 such as when using the <strong>-lt</strong> or
592 <strong>-le</strong> tests.</li>
594 <li>'<strong>-L</strong>' (is symbolic link, bash convention)<br />
595 See <strong>-l</strong>.</li>
597 <li>'<strong>-s</strong>' (is regular file, with
598 <strong>s</strong>ize)<br />
599 Treats the <em>TestString</em> as a pathname and tests
600 whether or not it exists, and is a regular file with size greater
603 <li><p>'<strong>-U</strong>' (is existing URL, via
605 Checks whether or not <em>TestString</em> is a valid URL,
606 accessible via all the server's currently-configured
607 access controls for that path. This uses an internal
608 subrequest to do the check, so use it with care -
609 it can impact your server's performance!</p>
610 <p> This flag <em>only</em> returns information about things
611 like access control, authentication, and authorization. This flag
612 <em>does not</em> return information about the status code the
613 configured handler (static file, CGI, proxy, etc.) would have
616 <li>'<strong>-x</strong>' (has e<strong>x</strong>ecutable
618 Treats the <em>TestString</em> as a pathname and tests
619 whether or not it exists, and has executable permissions.
620 These permissions are determined according to
621 the underlying OS.</li>
625 <div class="note"><h3>Note:</h3>
626 All of these tests can
627 also be prefixed by an exclamation mark ('!') to
628 negate their meaning.
633 <p>If the <em>TestString</em> has the special value <code>expr</code>, the
634 <em>CondPattern</em> will be treated as an
635 <a href="../expr.html">ap_expr</a>.</p>
638 In the below example, <code>-strmatch</code> is used to
639 compare the <code>REFERER</code> against the site hostname,
640 to block unwanted hotlinking.
643 <pre class="prettyprint lang-config"> RewriteCond expr "! %{HTTP_REFERER} -strmatch '*://%{HTTP_HOST}/*'"<br />
644 RewriteRule ^/images - [F]</pre>
648 <li>You can also set special flags for
649 <em>CondPattern</em> by appending
650 <strong><code>[</code><em>flags</em><code>]</code></strong>
651 as the third argument to the <code>RewriteCond</code>
652 directive, where <em>flags</em> is a comma-separated list of any of the
656 <li>'<strong><code>nocase|NC</code></strong>'
657 (<strong>n</strong>o <strong>c</strong>ase)<br />
658 This makes the test case-insensitive - differences
659 between 'A-Z' and 'a-z' are ignored, both in the
660 expanded <em>TestString</em> and the <em>CondPattern</em>.
661 This flag is effective only for comparisons between
662 <em>TestString</em> and <em>CondPattern</em>. It has no
663 effect on filesystem and subrequest checks.</li>
666 '<strong><code>ornext|OR</code></strong>'
667 (<strong>or</strong> next condition)<br />
668 Use this to combine rule conditions with a local OR
669 instead of the implicit AND. Typical example:
671 <pre class="prettyprint lang-config">RewriteCond %{REMOTE_HOST} ^host1 [OR]
672 RewriteCond %{REMOTE_HOST} ^host2 [OR]
673 RewriteCond %{REMOTE_HOST} ^host3
674 RewriteRule ...some special stuff for any of these hosts...</pre>
677 Without this flag you would have to write the condition/rule
681 <li>'<strong><code>novary|NV</code></strong>'
682 (<strong>n</strong>o <strong>v</strong>ary)<br />
683 If a HTTP header is used in the condition, this flag prevents
684 this header from being added to the Vary header of the response. <br />
685 Using this flag might break proper caching of the response if
686 the representation of this response varies on the value of this header.
687 So this flag should be only used if the meaning of the Vary header
694 <p><strong>Example:</strong></p>
696 <p>To rewrite the Homepage of a site according to the
697 ``<code>User-Agent:</code>'' header of the request, you can
698 use the following: </p>
700 <pre class="prettyprint lang-config">RewriteCond %{HTTP_USER_AGENT} (iPhone|Blackberry|Android)
701 RewriteRule ^/$ /homepage.mobile.html [L]
703 RewriteRule ^/$ /homepage.std.html [L]</pre>
706 <p>Explanation: If you use a browser which identifies itself
707 as a mobile browser (note that the example is incomplete, as
708 there are many other mobile platforms), the mobile version of
709 the homepage is served. Otherwise, the standard page is served.
714 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
715 <div class="directive-section"><h2><a name="RewriteEngine" id="RewriteEngine">RewriteEngine</a> <a name="rewriteengine" id="rewriteengine">Directive</a></h2>
716 <table class="directive">
717 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables or disables runtime rewriting engine</td></tr>
718 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RewriteEngine on|off</code></td></tr>
719 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>RewriteEngine off</code></td></tr>
720 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
721 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
722 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
723 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_rewrite</td></tr>
726 <p>The <code class="directive">RewriteEngine</code> directive enables or
727 disables the runtime rewriting engine. If it is set to
728 <code>off</code> this module does no runtime processing at
729 all. It does not even update the <code>SCRIPT_URx</code>
730 environment variables.</p>
732 <p>Use this directive to disable rules in a particular contact,
733 rather than commenting out all the <code class="directive"><a href="#rewriterule">RewriteRule</a></code> directives.</p>
735 <p>Note that rewrite configurations are not
736 inherited by virtual hosts. This means that you need to have a
737 <code>RewriteEngine on</code> directive for each virtual host
738 in which you wish to use rewrite rules.</p>
740 <p><code class="directive">RewriteMap</code> directives of the type <code>prg</code>
741 are not started during server initialization if they're defined in a
742 context that does not have <code class="directive">RewriteEngine</code> set to
746 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
747 <div class="directive-section"><h2><a name="RewriteMap" id="RewriteMap">RewriteMap</a> <a name="rewritemap" id="rewritemap">Directive</a></h2>
748 <table class="directive">
749 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Defines a mapping function for key-lookup</td></tr>
750 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RewriteMap <em>MapName</em> <em>MapType</em>:<em>MapSource</em>
752 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
753 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
754 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_rewrite</td></tr>
756 <p>The <code class="directive">RewriteMap</code> directive defines a
757 <em>Rewriting Map</em> which can be used inside rule
758 substitution strings by the mapping-functions to
759 insert/substitute fields through a key lookup. The source of
760 this lookup can be of various types.</p>
762 <p>The <a id="mapfunc" name="mapfunc"><em>MapName</em></a> is
763 the name of the map and will be used to specify a
764 mapping-function for the substitution strings of a rewriting
765 rule via one of the following constructs:</p>
768 <strong><code>${</code> <em>MapName</em> <code>:</code>
769 <em>LookupKey</em> <code>}</code><br />
770 <code>${</code> <em>MapName</em> <code>:</code>
771 <em>LookupKey</em> <code>|</code> <em>DefaultValue</em>
772 <code>}</code></strong>
775 <p>When such a construct occurs, the map <em>MapName</em> is
776 consulted and the key <em>LookupKey</em> is looked-up. If the
777 key is found, the map-function construct is substituted by
778 <em>SubstValue</em>. If the key is not found then it is
779 substituted by <em>DefaultValue</em> or by the empty string
780 if no <em>DefaultValue</em> was specified. Empty values
781 behave as if the key was absent, therefore it is not possible
782 to distinguish between empty-valued keys and absent keys.</p>
784 <p>For example, you might define a
785 <code class="directive">RewriteMap</code> as:</p>
787 <pre class="prettyprint lang-config">RewriteMap examplemap txt:/path/to/file/map.txt</pre>
790 <p>You would then be able to use this map in a
791 <code class="directive">RewriteRule</code> as follows:</p>
793 <pre class="prettyprint lang-config">RewriteRule ^/ex/(.*) ${examplemap:$1}</pre>
796 <p>The following combinations for <em>MapType</em> and
797 <em>MapSource</em> can be used:</p>
802 <dd>A plain text file containing space-separated key-value
803 pairs, one per line. (<a href="../rewrite/rewritemap.html#txt">Details ...</a>)</dd>
806 <dd>Randomly selects an entry from a plain text file (<a href="../rewrite/rewritemap.html#rnd">Details ...</a>)</dd>
809 <dd>Looks up an entry in a dbm file containing name, value
810 pairs. Hash is constructed from a plain text file format using
811 the <code><a href="../programs/httxt2dbm.html">httxt2dbm</a></code>
812 utility. (<a href="../rewrite/rewritemap.html#dbm">Details ...</a>)</dd>
815 <dd>One of the four available internal functions provided by
816 <code>RewriteMap</code>: toupper, tolower, escape or
817 unescape. (<a href="../rewrite/rewritemap.html#int">Details ...</a>)</dd>
820 <dd>Calls an external program or script to process the
821 rewriting. (<a href="../rewrite/rewritemap.html#prg">Details ...</a>)</dd>
823 <dt>dbd or fastdbd</dt>
824 <dd>A SQL SELECT statement to be performed to look up the
825 rewrite target. (<a href="../rewrite/rewritemap.html#dbd">Details ...</a>)</dd>
828 <p>Further details, and numerous examples, may be found in the <a href="../rewrite/rewritemap.html">RewriteMap HowTo</a></p>
832 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
833 <div class="directive-section"><h2><a name="RewriteOptions" id="RewriteOptions">RewriteOptions</a> <a name="rewriteoptions" id="rewriteoptions">Directive</a></h2>
834 <table class="directive">
835 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets some special options for the rewrite engine</td></tr>
836 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RewriteOptions <var>Options</var></code></td></tr>
837 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
838 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
839 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
840 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_rewrite</td></tr>
843 <p>The <code class="directive">RewriteOptions</code> directive sets some
844 special options for the current per-server or per-directory
845 configuration. The <em>Option</em> string can currently
846 only be one of the following:</p>
849 <dt><code>Inherit</code></dt>
852 <p>This forces the current configuration to inherit the
853 configuration of the parent. In per-virtual-server context,
854 this means that the maps, conditions and rules of the main
855 server are inherited. In per-directory context this means
856 that conditions and rules of the parent directory's
857 <code>.htaccess</code> configuration or
858 <code class="directive"><a href="../mod/core.html#directory"><Directory></a></code>
859 sections are inherited. The inherited rules are virtually copied
860 to the section where this directive is being used. If used in
861 combination with local rules, the inherited rules are copied behind
862 the local rules. The position of this directive - below or above
863 of local rules - has no influence on this behavior. If local
864 rules forced the rewriting to stop, the inherited rules won't
867 <div class="warning">
868 Rules inherited from the parent scope are applied
869 <strong>after</strong> rules specified in the child scope.
873 <dt><code>InheritBefore</code></dt>
875 <p> Like <code>Inherit</code> above, but the rules from the parent scope
876 are applied <strong>before</strong> rules specified in the child scope.<br />
877 Available in Apache HTTP Server 2.3.10 and later.</p>
880 <dt><code>InheritDown</code></dt>
883 <p>If this option is enabled, all child configurations will inherit
884 the configuration of the current configuration. It is equivalent to
885 specifying <code>RewriteOptions Inherit</code> in all child
886 configurations. See the <code>Inherit</code> option for more details
887 on how the parent-child relationships are handled.<br />
888 Available in Apache HTTP Server 2.4.8 and later.</p>
891 <dt><code>InheritDownBefore</code></dt>
894 <p>Like <code>InheritDown</code> above, but the rules from the current
895 scope are applied <strong>before</strong> rules specified in any child's
897 Available in Apache HTTP Server 2.4.8 and later.</p>
900 <dt><code>IgnoreInherit</code></dt>
903 <p>This option forces the current and child configurations to ignore
904 all rules that would be inherited from a parent specifying
905 <code>InheritDown</code> or <code>InheritDownBefore</code>.<br />
906 Available in Apache HTTP Server 2.4.8 and later.</p>
909 <dt><code>AllowNoSlash</code></dt>
911 <p>By default, <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> will ignore URLs that map to a
912 directory on disk but lack a trailing slash, in the expectation that
913 the <code class="module"><a href="../mod/mod_dir.html">mod_dir</a></code> module will issue the client with a redirect to
914 the canonical URL with a trailing slash.</p>
916 <p>When the <code class="directive"><a href="../mod/mod_dir.html#directoryslash">DirectorySlash</a></code> directive
917 is set to off, the <code>AllowNoSlash</code> option can be enabled to ensure
918 that rewrite rules are no longer ignored. This option makes it possible to
919 apply rewrite rules within .htaccess files that match the directory without
920 a trailing slash, if so desired.<br />
921 Available in Apache HTTP Server 2.4.0 and later.</p>
924 <dt><code>AllowAnyURI</code></dt>
927 <p>When <code class="directive"><a href="#rewriterule">RewriteRule</a></code>
928 is used in <code>VirtualHost</code> or server context with
929 version 2.2.22 or later of httpd, <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>
930 will only process the rewrite rules if the request URI is a <a href="directive-dict.html#Syntax">URL-path</a>. This avoids
931 some security issues where particular rules could allow
932 "surprising" pattern expansions (see <a href="http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2011-3368">CVE-2011-3368</a>
933 and <a href="http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2011-4317">CVE-2011-4317</a>).
934 To lift the restriction on matching a URL-path, the
935 <code>AllowAnyURI</code> option can be enabled, and
936 <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> will apply the rule set to any
937 request URI string, regardless of whether that string matches
938 the URL-path grammar required by the HTTP specification.<br />
939 Available in Apache HTTP Server 2.4.3 and later.</p>
941 <div class="warning">
942 <h3>Security Warning</h3>
944 <p>Enabling this option will make the server vulnerable to
945 security issues if used with rewrite rules which are not
946 carefully authored. It is <strong>strongly recommended</strong>
947 that this option is not used. In particular, beware of input
948 strings containing the '<code>@</code>' character which could
949 change the interpretation of the transformed URI, as per the
954 <dt><code>MergeBase</code></dt>
957 <p>With this option, the value of <code class="directive"><a href="#rewritebase">RewriteBase</a></code> is copied from where it's explicitly defined
958 into any sub-directory or sub-location that doesn't define its own
959 <code class="directive"><a href="#rewritebase">RewriteBase</a></code>. This was the
960 default behavior in 2.4.0 through 2.4.3, and the flag to restore it is
961 available Apache HTTP Server 2.4.4 and later.</p>
967 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
968 <div class="directive-section"><h2><a name="RewriteRule" id="RewriteRule">RewriteRule</a> <a name="rewriterule" id="rewriterule">Directive</a></h2>
969 <table class="directive">
970 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Defines rules for the rewriting engine</td></tr>
971 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RewriteRule
972 <em>Pattern</em> <em>Substitution</em> [<em>flags</em>]</code></td></tr>
973 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
974 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
975 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
976 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_rewrite</td></tr>
978 <p>The <code class="directive">RewriteRule</code> directive is the real
979 rewriting workhorse. The directive can occur more than once,
980 with each instance defining a single rewrite rule. The
981 order in which these rules are defined is important - this is the order
982 in which they will be applied at run-time.</p>
984 <p><a id="patterns" name="patterns"><em>Pattern</em></a> is
985 a perl compatible <a id="regexp" name="regexp">regular
986 expression</a>. On the first RewriteRule, it is matched against
987 the (%-decoded) <a href="directive-dict.html#Syntax">URL-path</a> (or
988 <a href="directive-dict.html#Syntax">file-path</a>, depending
989 on the context) of the request. Subsequent patterns are matched against the
990 output of the last matching RewriteRule.</p>
992 <div class="note"><h3><a id="what_is_matched" name="what_is_matched">What is matched?</a></h3>
993 <p>In <code class="directive"><a href="../mod/core.html#virtualhost">VirtualHost</a></code> context,
994 The <em>Pattern</em> will initially be matched against the part of the
995 URL after the hostname and port, and before the query string (e.g. "/app1/index.html").</p>
997 <p>In <code class="directive"><a href="../mod/core.html#directory">Directory</a></code> and htaccess context,
998 the <em>Pattern</em> will initially be matched against the
999 <em>filesystem</em> path, after removing the prefix that led the server
1000 to the current <code class="directive">RewriteRule</code> (e.g. "app1/index.html"
1001 or "index.html" depending on where the directives are defined).</p>
1003 <p>If you wish to match against the hostname, port, or query string, use a
1004 <code class="directive"><a href="#rewritecond">RewriteCond</a></code> with the
1005 <code>%{HTTP_HOST}</code>, <code>%{SERVER_PORT}</code>, or
1006 <code>%{QUERY_STRING}</code> variables respectively.</p>
1010 <div class="note"><h3>Per-directory Rewrites</h3>
1012 <li>The rewrite engine may be used in <a href="../howto/htaccess.html">.htaccess</a> files and in <code class="directive"><a href="../mod/core.html#directory"><Directory></a></code> sections, with some additional
1015 <li>To enable the rewrite engine in this context, you need to set
1016 "<code>RewriteEngine On</code>" <strong>and</strong>
1017 "<code>Options FollowSymLinks</code>" must be enabled. If your
1018 administrator has disabled override of <code>FollowSymLinks</code> for
1019 a user's directory, then you cannot use the rewrite engine. This
1020 restriction is required for security reasons.</li>
1022 <li>When using the rewrite engine in <code>.htaccess</code> files the
1023 per-directory prefix (which always is the same for a specific
1024 directory) is automatically <em>removed</em> for the RewriteRule pattern matching
1025 and automatically <em>added</em> after any relative (not starting with a
1026 slash or protocol name) substitution encounters the end of a rule set.
1027 See the <code class="directive"><a href="#rewritebase">RewriteBase</a></code>
1028 directive for more information regarding what prefix will be added back to
1029 relative substitutions.</li>
1031 <li> If you wish to match against the full URL-path in a per-directory
1032 (htaccess) RewriteRule, use the <code>%{REQUEST_URI}</code> variable in
1033 a <code class="directive">RewriteCond</code>.</li>
1035 <li>The removed prefix always ends with a slash, meaning the matching occurs against a string which
1036 <em>never</em> has a leading slash. Therefore, a <em>Pattern</em> with <code>^/</code> never
1037 matches in per-directory context.</li>
1039 <li>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
1040 should never be necessary and is unsupported.</li>
1044 <p>For some hints on <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular
1045 expressions</a>, see
1046 the <a href="../rewrite/intro.html#regex">mod_rewrite
1047 Introduction</a>.</p>
1049 <p>In mod_rewrite, the NOT character
1050 ('<code>!</code>') is also available as a possible pattern
1051 prefix. This enables you to negate a pattern; to say, for instance:
1052 ``<em>if the current URL does <strong>NOT</strong> match this
1053 pattern</em>''. This can be used for exceptional cases, where
1054 it is easier to match the negative pattern, or as a last
1057 <div class="note"><h3>Note</h3>
1058 When using the NOT character to negate a pattern, you cannot include
1059 grouped wildcard parts in that pattern. This is because, when the
1060 pattern does NOT match (ie, the negation matches), there are no
1061 contents for the groups. Thus, if negated patterns are used, you
1062 cannot use <code>$N</code> in the substitution string!
1065 <p>The <a id="rhs" name="rhs"><em>Substitution</em></a> of a
1066 rewrite rule is the string that replaces the original URL-path that
1067 was matched by <em>Pattern</em>. The <em>Substitution</em> may
1072 <dt>file-system path</dt>
1074 <dd>Designates the location on the file-system of the resource
1075 to be delivered to the client. Substitutions are only
1076 treated as a file-system path when the rule is configured in
1077 server (virtualhost) context and the first component of the
1078 path in the substitution exists in the file-system</dd>
1082 <dd>A <code class="directive"><a href="../mod/core.html#documentroot">DocumentRoot</a></code>-relative path to the
1083 resource to be served. Note that <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>
1084 tries to guess whether you have specified a file-system path
1085 or a URL-path by checking to see if the first segment of the
1086 path exists at the root of the file-system. For example, if
1087 you specify a <em>Substitution</em> string of
1088 <code>/www/file.html</code>, then this will be treated as a
1089 URL-path <em>unless</em> a directory named <code>www</code>
1090 exists at the root or your file-system (or, in the case of
1091 using rewrites in a <code>.htaccess</code> file, relative to
1092 your document root), in which case it will
1093 be treated as a file-system path. If you wish other
1094 URL-mapping directives (such as <code class="directive"><a href="../mod/mod_alias.html#alias">Alias</a></code>) to be applied to the
1095 resulting URL-path, use the <code>[PT]</code> flag as
1096 described below.</dd>
1098 <dt>Absolute URL</dt>
1100 <dd>If an absolute URL is specified,
1101 <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> checks to see whether the
1102 hostname matches the current host. If it does, the scheme and
1103 hostname are stripped out and the resulting path is treated as
1104 a URL-path. Otherwise, an external redirect is performed for
1105 the given URL. To force an external redirect back to the
1106 current host, see the <code>[R]</code> flag below.</dd>
1108 <dt><code>-</code> (dash)</dt>
1110 <dd>A dash indicates that no substitution should be performed
1111 (the existing path is passed through untouched). This is used
1112 when a flag (see below) needs to be applied without changing
1117 <p>In addition to plain text, the <em>Substitution</em> string can include</p>
1120 <li>back-references (<code>$N</code>) to the RewriteRule
1123 <li>back-references (<code>%N</code>) to the last matched
1124 RewriteCond pattern</li>
1126 <li>server-variables as in rule condition test-strings
1127 (<code>%{VARNAME}</code>)</li>
1129 <li><a href="#mapfunc">mapping-function</a> calls
1130 (<code>${mapname:key|default}</code>)</li>
1133 <p>Back-references are identifiers of the form
1134 <code>$</code><strong>N</strong>
1135 (<strong>N</strong>=0..9), which will be replaced
1136 by the contents of the <strong>N</strong>th group of the
1137 matched <em>Pattern</em>. The server-variables are the same
1138 as for the <em>TestString</em> of a <code>RewriteCond</code>
1139 directive. The mapping-functions come from the
1140 <code>RewriteMap</code> directive and are explained there.
1141 These three types of variables are expanded in the order above.</p>
1143 <p>Rewrite rules are applied to the results of previous rewrite
1144 rules, in the order in which they are defined
1145 in the config file. The URL-path or file-system path (see <a href="#what_is_matched">"What is matched?"</a>, above) is <strong>completely
1146 replaced</strong> by the <em>Substitution</em> and the
1147 rewriting process continues until all rules have been applied,
1148 or it is explicitly terminated by an
1149 <a href="../rewrite/flags.html#flag_l"><code><strong>L</strong></code> flag</a>,
1150 or other flag which implies immediate termination, such as
1151 <code><strong>END</strong></code> or
1152 <code><strong>F</strong></code>.</p>
1154 <div class="note"><h3>Modifying the Query String</h3>
1155 <p>By default, the query string is passed through unchanged. You
1156 can, however, create URLs in the substitution string containing
1157 a query string part. Simply use a question mark inside the
1158 substitution string to indicate that the following text should
1159 be re-injected into the query string. When you want to erase an
1160 existing query string, end the substitution string with just a
1161 question mark. To combine new and old query strings, use the
1162 <code>[QSA]</code> flag.</p>
1165 <p>Additionally you can set special <a name="rewriteflags" id="rewriteflags">actions</a> to be performed by
1166 appending <strong><code>[</code><em>flags</em><code>]</code></strong>
1167 as the third argument to the <code>RewriteRule</code>
1168 directive. <em>Flags</em> is a comma-separated list, surround by square
1169 brackets, of any of the flags in the following table. More
1170 details, and examples, for each flag, are available in the <a href="../rewrite/flags.html">Rewrite Flags document</a>.</p>
1172 <table class="bordered">
1173 <tr><th>Flag and syntax</th>
1178 <td>Escape non-alphanumeric characters in backreferences <em>before</em>
1179 applying the transformation. <em><a href="../rewrite/flags.html#flag_b">details ...</a></em></td>
1182 <td>backrefnoplus|BNP</td>
1183 <td>If backreferences are being escaped, spaces should be escaped to
1184 %20 instead of +. Useful when the backreference will be used in the
1185 path component rather than the query string.<em><a href="../rewrite/flags.html#flag_bnp">details ...</a></em></td>
1190 <td>Rule is chained to the following rule. If the rule fails,
1191 the rule(s) chained to it will be skipped. <em><a href="../rewrite/flags.html#flag_c">details ...</a></em></td>
1194 <td>cookie|CO=<em>NAME</em>:<em>VAL</em></td>
1195 <td>Sets a cookie in the client browser. Full syntax is:
1196 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>
1200 <td>discardpath|DPI</td>
1201 <td>Causes the PATH_INFO portion of the rewritten URI to be
1202 discarded. <em><a href="../rewrite/flags.html#flag_dpi">details
1207 <td>Stop the rewriting process immediately and don't apply any
1208 more rules. Also prevents further execution of rewrite rules
1209 in per-directory and .htaccess context. (Available in 2.3.9 and later)
1210 <em><a href="../rewrite/flags.html#flag_end">details ...</a></em></td>
1213 <td>env|E=[!]<em>VAR</em>[:<em>VAL</em>]</td>
1214 <td>Causes an environment variable <em>VAR</em> to be set (to the
1215 value <em>VAL</em> if provided). The form !<em>VAR</em> causes
1216 the environment variable <em>VAR</em> to be unset.
1217 <em><a href="../rewrite/flags.html#flag_e">details ...</a></em></td>
1220 <td>forbidden|F</td>
1221 <td>Returns a 403 FORBIDDEN response to the client browser.
1222 <em><a href="../rewrite/flags.html#flag_f">details ...</a></em></td>
1226 <td>Returns a 410 GONE response to the client browser. <em><a href="../rewrite/flags.html#flag_g">details ...</a></em></td>
1229 <td>Handler|H=<em>Content-handler</em></td>
1230 <td>Causes the resulting URI to be sent to the specified
1231 <em>Content-handler</em> for processing. <em><a href="../rewrite/flags.html#flag_h">details ...</a></em></td>
1235 <td>Stop the rewriting process immediately and don't apply any
1236 more rules. Especially note caveats for per-directory and
1237 .htaccess context (see also the END flag). <em><a href="../rewrite/flags.html#flag_l">details ...</a></em></td>
1241 <td>Re-run the rewriting process, starting again with the first
1242 rule, using the result of the ruleset so far as a starting
1243 point. <em><a href="../rewrite/flags.html#flag_n">details
1248 <td>Makes the pattern comparison case-insensitive.
1249 <em><a href="../rewrite/flags.html#flag_nc">details ...</a></em></td>
1252 <td>noescape|NE</td>
1253 <td>Prevent mod_rewrite from applying hexcode escaping of
1254 special characters in the result of the rewrite. <em><a href="../rewrite/flags.html#flag_ne">details ...</a></em></td>
1257 <td>nosubreq|NS</td>
1258 <td>Causes a rule to be skipped if the current request is an
1259 internal sub-request. <em><a href="../rewrite/flags.html#flag_ns">details ...</a></em></td>
1263 <td>Force the substitution URL to be internally sent as a proxy
1264 request. <em><a href="../rewrite/flags.html#flag_p">details
1268 <td>passthrough|PT</td>
1269 <td>Forces the resulting URI to be passed back to the URL
1270 mapping engine for processing of other URI-to-filename
1271 translators, such as <code>Alias</code> or
1272 <code>Redirect</code>. <em><a href="../rewrite/flags.html#flag_pt">details ...</a></em></td>
1275 <td>qsappend|QSA</td>
1276 <td>Appends any query string from the original request URL to
1277 any query string created in the rewrite target.<em><a href="../rewrite/flags.html#flag_qsa">details ...</a></em></td>
1280 <td>qsdiscard|QSD</td>
1281 <td>Discard any query string attached to the incoming URI.
1282 <em><a href="../rewrite/flags.html#flag_qsd">details
1286 <td>redirect|R[=<em>code</em>]</td>
1287 <td>Forces an external redirect, optionally with the specified
1288 HTTP status code. <em><a href="../rewrite/flags.html#flag_r">details ...</a></em>
1292 <td>skip|S=<em>num</em></td>
1293 <td>Tells the rewriting engine to skip the next <em>num</em>
1294 rules if the current rule matches. <em><a href="../rewrite/flags.html#flag_s">details ...</a></em></td>
1297 <td>type|T=<em>MIME-type</em></td>
1298 <td>Force the <a class="glossarylink" href="../glossary.html#mime-type" title="see glossary">MIME-type</a> of the target file
1299 to be the specified type. <em><a href="../rewrite/flags.html#flag_t">details ...</a></em></td>
1303 <div class="note"><h3>Home directory expansion</h3>
1304 <p> When the substitution string begins with a string
1305 resembling "/~user" (via explicit text or backreferences), mod_rewrite performs
1306 home directory expansion independent of the presence or configuration
1307 of <code class="module"><a href="../mod/mod_userdir.html">mod_userdir</a></code>.</p>
1309 <p> This expansion does not occur when the <em>PT</em>
1310 flag is used on the <code class="directive"><a href="#rewriterule">RewriteRule</a></code>
1315 <p>Here are all possible substitution combinations and their
1318 <p><strong>Inside per-server configuration
1319 (<code>httpd.conf</code>)<br />
1320 for request ``<code>GET
1321 /somepath/pathinfo</code>'':</strong><br />
1324 <table class="bordered">
1327 <th>Resulting Substitution</th>
1331 <td>^/somepath(.*) otherpath$1</td>
1332 <td>invalid, not supported</td>
1336 <td>^/somepath(.*) otherpath$1 [R]</td>
1337 <td>invalid, not supported</td>
1341 <td>^/somepath(.*) otherpath$1 [P]</td>
1342 <td>invalid, not supported</td>
1346 <td>^/somepath(.*) /otherpath$1</td>
1347 <td>/otherpath/pathinfo</td>
1351 <td>^/somepath(.*) /otherpath$1 [R]</td>
1352 <td>http://thishost/otherpath/pathinfo via external redirection</td>
1356 <td>^/somepath(.*) /otherpath$1 [P]</td>
1357 <td>doesn't make sense, not supported</td>
1361 <td>^/somepath(.*) http://thishost/otherpath$1</td>
1362 <td>/otherpath/pathinfo</td>
1366 <td>^/somepath(.*) http://thishost/otherpath$1 [R]</td>
1367 <td>http://thishost/otherpath/pathinfo via external redirection</td>
1371 <td>^/somepath(.*) http://thishost/otherpath$1 [P]</td>
1372 <td>doesn't make sense, not supported</td>
1376 <td>^/somepath(.*) http://otherhost/otherpath$1</td>
1377 <td>http://otherhost/otherpath/pathinfo via external redirection</td>
1381 <td>^/somepath(.*) http://otherhost/otherpath$1 [R]</td>
1382 <td>http://otherhost/otherpath/pathinfo via external redirection (the [R] flag is redundant)</td>
1386 <td>^/somepath(.*) http://otherhost/otherpath$1 [P]</td>
1387 <td>http://otherhost/otherpath/pathinfo via internal proxy</td>
1391 <p><strong>Inside per-directory configuration for
1392 <code>/somepath</code><br />
1393 (<code>/physical/path/to/somepath/.htaccess</code>, with
1394 <code>RewriteBase /somepath</code>)<br />
1395 for request ``<code>GET
1396 /somepath/localpath/pathinfo</code>'':</strong><br />
1399 <table class="bordered">
1403 <th>Resulting Substitution</th>
1407 <td>^localpath(.*) otherpath$1</td>
1408 <td>/somepath/otherpath/pathinfo</td>
1412 <td>^localpath(.*) otherpath$1 [R]</td>
1413 <td>http://thishost/somepath/otherpath/pathinfo via external
1418 <td>^localpath(.*) otherpath$1 [P]</td>
1419 <td>doesn't make sense, not supported</td>
1423 <td>^localpath(.*) /otherpath$1</td>
1424 <td>/otherpath/pathinfo</td>
1428 <td>^localpath(.*) /otherpath$1 [R]</td>
1429 <td>http://thishost/otherpath/pathinfo via external redirection</td>
1433 <td>^localpath(.*) /otherpath$1 [P]</td>
1434 <td>doesn't make sense, not supported</td>
1438 <td>^localpath(.*) http://thishost/otherpath$1</td>
1439 <td>/otherpath/pathinfo</td>
1443 <td>^localpath(.*) http://thishost/otherpath$1 [R]</td>
1444 <td>http://thishost/otherpath/pathinfo via external redirection</td>
1448 <td>^localpath(.*) http://thishost/otherpath$1 [P]</td>
1449 <td>doesn't make sense, not supported</td>
1453 <td>^localpath(.*) http://otherhost/otherpath$1</td>
1454 <td>http://otherhost/otherpath/pathinfo via external redirection</td>
1458 <td>^localpath(.*) http://otherhost/otherpath$1 [R]</td>
1459 <td>http://otherhost/otherpath/pathinfo via external redirection (the [R] flag is redundant)</td>
1463 <td>^localpath(.*) http://otherhost/otherpath$1 [P]</td>
1464 <td>http://otherhost/otherpath/pathinfo via internal proxy</td>
1472 <div class="bottomlang">
1473 <p><span>Available Languages: </span><a href="../en/mod/mod_rewrite.html" title="English"> en </a> |
1474 <a href="../fr/mod/mod_rewrite.html" hreflang="fr" rel="alternate" title="Français"> fr </a></p>
1475 </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
1476 <script type="text/javascript"><!--//--><![CDATA[//><!--
1477 var comments_shortname = 'httpd';
1478 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_rewrite.html';
1480 if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
1481 d.write('<div id="comments_thread"><\/div>');
1482 var s = d.createElement('script');
1483 s.type = 'text/javascript';
1485 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
1486 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
1489 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
1491 })(window, document);
1492 //--><!]]></script></div><div id="footer">
1493 <p class="apache">Copyright 2014 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>
1494 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
1495 if (typeof(prettyPrint) !== 'undefined') {