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 Version 2.5</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 />
216 HTTP_PROXY_CONNECTION<br />
218 HTTP_USER_AGENT<br />
223 CONN_REMOTE_ADDR<br />
225 CONTEXT_DOCUMENT_ROOT<br />
235 SCRIPT_FILENAME<br />
242 <th>server internals:</th> <th>date and time:</th> <th>specials:</th>
254 SERVER_PROTOCOL<br />
255 SERVER_SOFTWARE<br />
271 CONN_REMOTE_ADDR<br />
275 REQUEST_FILENAME<br />
283 <p>These variables all
284 correspond to the similarly named HTTP
285 MIME-headers, C variables of the Apache HTTP Server or
286 <code>struct tm</code> fields of the Unix system.
287 Most are documented <a href="../expr.html#vars">here</a>
288 or elsewhere in the Manual or in the CGI specification.</p>
290 <p>SERVER_NAME and SERVER_PORT depend on the values of
291 <code class="directive"><a href="../mod/core.html#usecanonicalname">UseCanonicalName</a></code> and
292 <code class="directive"><a href="../mod/core.html#usecanonicalphysicalport">UseCanonicalPhysicalPort</a></code>
295 <p>Those that are special to mod_rewrite include those below.</p>
298 <dt><code>API_VERSION</code></dt>
300 <dd>This is the version of the Apache httpd module API
301 (the internal interface between server and
302 module) in the current httpd build, as defined in
303 include/ap_mmn.h. The module API version
304 corresponds to the version of Apache httpd in use (in
305 the release version of Apache httpd 1.3.14, for
306 instance, it is 19990320:10), but is mainly of
307 interest to module authors.</dd>
309 <dt><code>CONN_REMOTE_ADDR</code></dt>
311 <dd>Since 2.4.8: The peer IP address of the connection (see the
312 <code class="module"><a href="../mod/mod_remoteip.html">mod_remoteip</a></code> module).</dd>
314 <dt><code>HTTPS</code></dt>
316 <dd>Will contain the text "on" if the connection is
317 using SSL/TLS, or "off" otherwise. (This variable
318 can be safely used regardless of whether or not
319 <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> is loaded).</dd>
321 <dt><code>IS_SUBREQ</code></dt>
323 <dd>Will contain the text "true" if the request
324 currently being processed is a sub-request,
325 "false" otherwise. Sub-requests may be generated
326 by modules that need to resolve additional files
327 or URIs in order to complete their tasks.</dd>
329 <dt><code>REMOTE_ADDR</code></dt>
331 <dd>The IP address of the remote host (see the
332 <code class="module"><a href="../mod/mod_remoteip.html">mod_remoteip</a></code> module).</dd>
334 <dt><code>REQUEST_FILENAME</code></dt>
336 <dd>The full local filesystem path to the file or
337 script matching the request, if this has already
338 been determined by the server at the time
339 <code>REQUEST_FILENAME</code> is referenced. Otherwise,
340 such as when used in virtual host context, the same
341 value as <code>REQUEST_URI</code>. Depending on the value of
342 <code class="directive"><a href="../mod/core.html#acceptpathinfo">AcceptPathInfo</a></code>, the
343 server may have only used some leading components of the
344 <code>REQUEST_URI</code> to map the request to a file.
347 <dt><code>REQUEST_SCHEME</code></dt>
349 <dd>Will contain the scheme of the request (usually
350 "http" or "https"). This value can be influenced with
351 <code class="directive"><a href="../mod/core.html#servername">ServerName</a></code>.</dd>
353 <dt><code>REQUEST_URI</code></dt>
355 <dd>The path component of the requested URI,
356 such as "/index.html". This notably excludes the
357 query string which is available as as its own variable
358 named <code>QUERY_STRING</code>.</dd>
360 <dt><code>THE_REQUEST</code></dt>
362 <dd>The full HTTP request line sent by the
363 browser to the server (e.g., "<code>GET
364 /index.html HTTP/1.1</code>"). This does not
365 include any additional headers sent by the
366 browser. This value has not been unescaped
367 (decoded), unlike most other variables below.</dd>
374 <p>If the <em>TestString</em> has the special value <code>expr</code>,
375 the <em>CondPattern</em> will be treated as an
376 <a href="../expr.html">ap_expr</a>. HTTP headers referenced in the
377 expression will be added to the Vary header if the <code>novary</code>
378 flag is not given.</p>
380 <p>Other things you should be aware of:</p>
384 <p>The variables SCRIPT_FILENAME and REQUEST_FILENAME
385 contain the same value - the value of the
386 <code>filename</code> field of the internal
387 <code>request_rec</code> structure of the Apache HTTP Server.
388 The first name is the commonly known CGI variable name
389 while the second is the appropriate counterpart of
390 REQUEST_URI (which contains the value of the
391 <code>uri</code> field of <code>request_rec</code>).</p>
392 <p>If a substitution occurred and the rewriting continues,
393 the value of both variables will be updated accordingly.</p>
394 <p>If used in per-server context (<em>i.e.</em>, before the
395 request is mapped to the filesystem) SCRIPT_FILENAME and
396 REQUEST_FILENAME cannot contain the full local filesystem
397 path since the path is unknown at this stage of processing.
398 Both variables will initially contain the value of REQUEST_URI
399 in that case. In order to obtain the full local filesystem
400 path of the request in per-server context, use an URL-based
401 look-ahead <code>%{LA-U:REQUEST_FILENAME}</code> to determine
402 the final value of REQUEST_FILENAME.</p></li>
405 <code>%{ENV:variable}</code>, where <em>variable</em> can be
406 any environment variable, is also available.
407 This is looked-up via internal
408 Apache httpd structures and (if not found there) via
409 <code>getenv()</code> from the Apache httpd server process.</li>
412 <code>%{SSL:variable}</code>, where <em>variable</em> is the
413 name of an <a href="mod_ssl.html#envvars">SSL environment
414 variable</a>, can be used whether or not
415 <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> is loaded, but will always expand to
416 the empty string if it is not. Example:
417 <code>%{SSL:SSL_CIPHER_USEKEYSIZE}</code> may expand to
418 <code>128</code>.</li>
421 <code>%{HTTP:header}</code>, where <em>header</em> can be
422 any HTTP MIME-header name, can always be used to obtain the
423 value of a header sent in the HTTP request.
424 Example: <code>%{HTTP:Proxy-Connection}</code> is
425 the value of the HTTP header
426 ``<code>Proxy-Connection:</code>''.
427 <p>If a HTTP header is used in a condition this header is added to
428 the Vary header of the response in case the condition evaluates
429 to true for the request. It is <strong>not</strong> added if the
430 condition evaluates to false for the request. Adding the HTTP header
431 to the Vary header of the response is needed for proper caching.</p>
432 <p>It has to be kept in mind that conditions follow a short circuit
433 logic in the case of the '<strong><code>ornext|OR</code></strong>' flag
434 so that certain conditions might not be evaluated at all.</p></li>
437 <a id="LA-U" name="LA-U"><code>%{LA-U:variable}</code></a>
438 can be used for look-aheads which perform
439 an internal (URL-based) sub-request to determine the final
440 value of <em>variable</em>. This can be used to access
441 variable for rewriting which is not available at the current
442 stage, but will be set in a later phase.
443 <p>For instance, to rewrite according to the
444 <code>REMOTE_USER</code> variable from within the
445 per-server context (<code>httpd.conf</code> file) you must
446 use <code>%{LA-U:REMOTE_USER}</code> - this
447 variable is set by the authorization phases, which come
448 <em>after</em> the URL translation phase (during which mod_rewrite
450 <p>On the other hand, because mod_rewrite implements
451 its per-directory context (<code>.htaccess</code> file) via
452 the Fixup phase of the API and because the authorization
453 phases come <em>before</em> this phase, you just can use
454 <code>%{REMOTE_USER}</code> in that context.</p></li>
457 <code>%{LA-F:variable}</code> can be used to perform an internal
458 (filename-based) sub-request, to determine the final value
459 of <em>variable</em>. Most of the time, this is the same as
463 <p><em>CondPattern</em> is the condition pattern,
464 a regular expression which is applied to the
465 current instance of the <em>TestString</em>.
466 <em>TestString</em> is first evaluated, before being matched against
467 <em>CondPattern</em>.</p>
469 <p><em>CondPattern</em> is usually a
470 <em>perl compatible regular expression</em>, but there is
471 additional syntax available to perform other useful tests against
472 the <em>Teststring</em>:</p>
475 <li>You can prefix the pattern string with a
476 '<code>!</code>' character (exclamation mark) to specify a
477 <strong>non</strong>-matching pattern.</li>
480 You can perform lexicographical string comparisons:
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 precedes
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> lexicographically follows
495 <em>CondPattern</em>.</li>
497 <li>'<strong>=CondPattern</strong>' (lexicographically
499 Treats the <em>CondPattern</em> as a plain string and
500 compares it lexicographically to <em>TestString</em>. True if
501 <em>TestString</em> is lexicographically equal to
502 <em>CondPattern</em> (the two strings are exactly
503 equal, character for character). If <em>CondPattern</em>
504 is <code>""</code> (two quotation marks) this
505 compares <em>TestString</em> to the empty string.</li>
507 <li>'<strong><=CondPattern</strong>' (lexicographically
508 less than or equal to)<br />
509 Treats the <em>CondPattern</em> as a plain string and
510 compares it lexicographically to <em>TestString</em>. True
511 if <em>TestString</em> lexicographically precedes
512 <em>CondPattern</em>, or is equal to <em>CondPattern</em>
513 (the two strings are equal, character for character).</li>
515 <li>'<strong>>=CondPattern</strong>' (lexicographically
516 greater than or equal to)<br />
517 Treats the <em>CondPattern</em> as a plain string and
518 compares it lexicographically to <em>TestString</em>. True
519 if <em>TestString</em> lexicographically follows
520 <em>CondPattern</em>, or is equal to <em>CondPattern</em>
521 (the two strings are equal, character for character).</li>
525 You can perform integer comparisons:
528 <li>'<strong>-eq</strong>' (is numerically
529 <strong>eq</strong>ual to)<br />
530 The <em>TestString</em> is treated as an integer, and is
531 numerically compared to the <em>CondPattern</em>. True if
532 the two are numerically equal.</li>
534 <li>'<strong>-ge</strong>' (is numerically
535 <strong>g</strong>reater than or <strong>e</strong>qual to)<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 or equal
539 to the <em>CondPattern</em>.</li>
541 <li>'<strong>-gt</strong>' (is numerically
542 <strong>g</strong>reater <strong>t</strong>han)<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 greater than
546 the <em>CondPattern</em>.</li>
548 <li>'<strong>-le</strong>' (is numerically
549 <strong>l</strong>ess than or <strong>e</strong>qual to)<br />
550 The <em>TestString</em> is treated as an integer, and is
551 numerically compared to the <em>CondPattern</em>. True if
552 the <em>TestString</em> is numerically less than or equal
553 to the <em>CondPattern</em>. Avoid confusion with the
554 <strong>-l</strong> by using the <strong>-L</strong> or
555 <strong>-h</strong> variant.</li>
557 <li>'<strong>-lt</strong>' (is numerically
558 <strong>l</strong>ess <strong>t</strong>han)<br />
559 The <em>TestString</em> is treated as an integer, and is
560 numerically compared to the <em>CondPattern</em>. True if
561 the <em>TestString</em> is numerically less than
562 the <em>CondPattern</em>. Avoid confusion with the
563 <strong>-l</strong> by using the <strong>-L</strong> or
564 <strong>-h</strong> variant.</li>
569 <li>You can perform various file attribute tests:
571 <li>'<strong>-d</strong>' (is
572 <strong>d</strong>irectory)<br />
573 Treats the <em>TestString</em> as a pathname and tests
574 whether or not it exists, and is a directory.</li>
576 <li>'<strong>-f</strong>' (is regular
577 <strong>f</strong>ile)<br />
578 Treats the <em>TestString</em> as a pathname and tests
579 whether or not it exists, and is a regular file.</li>
581 <li>'<strong>-F</strong>' (is existing file, via
583 Checks whether or not <em>TestString</em> is a valid file,
584 accessible via all the server's currently-configured
585 access controls for that path. This uses an internal
586 subrequest to do the check, so use it with care -
587 it can impact your server's performance!</li>
589 <li>'<strong>-H</strong>' (is symbolic link, bash convention)<br />
590 See <strong>-l</strong>.</li>
592 <li>'<strong>-l</strong>' (is symbolic
593 <strong>l</strong>ink)<br />
594 Treats the <em>TestString</em> as a pathname and tests
595 whether or not it exists, and is a symbolic link. May also
596 use the bash convention of <strong>-L</strong> or
597 <strong>-h</strong> if there's a possibility of confusion
598 such as when using the <strong>-lt</strong> or
599 <strong>-le</strong> tests.</li>
601 <li>'<strong>-L</strong>' (is symbolic link, bash convention)<br />
602 See <strong>-l</strong>.</li>
604 <li>'<strong>-s</strong>' (is regular file, with
605 <strong>s</strong>ize)<br />
606 Treats the <em>TestString</em> as a pathname and tests
607 whether or not it exists, and is a regular file with size greater
610 <li><p>'<strong>-U</strong>' (is existing URL, via
612 Checks whether or not <em>TestString</em> is a valid URL,
613 accessible via all the server's currently-configured
614 access controls for that path. This uses an internal
615 subrequest to do the check, so use it with care -
616 it can impact your server's performance!</p>
617 <p> This flag <em>only</em> returns information about things
618 like access control, authentication, and authorization. This flag
619 <em>does not</em> return information about the status code the
620 configured handler (static file, CGI, proxy, etc.) would have
623 <li>'<strong>-x</strong>' (has e<strong>x</strong>ecutable
625 Treats the <em>TestString</em> as a pathname and tests
626 whether or not it exists, and has executable permissions.
627 These permissions are determined according to
628 the underlying OS.</li>
632 <div class="note"><h3>Note:</h3>
633 All of these tests can
634 also be prefixed by an exclamation mark ('!') to
635 negate their meaning.
640 <p>If the <em>TestString</em> has the special value <code>expr</code>, the
641 <em>CondPattern</em> will be treated as an
642 <a href="../expr.html">ap_expr</a>.</p>
645 In the below example, <code>-strmatch</code> is used to
646 compare the <code>REFERER</code> against the site hostname,
647 to block unwanted hotlinking.
650 <pre class="prettyprint lang-config"> RewriteCond expr "! %{HTTP_REFERER} -strmatch '*://%{HTTP_HOST}/*'"<br />
651 RewriteRule ^/images - [F]</pre>
655 <li>You can also set special flags for
656 <em>CondPattern</em> by appending
657 <strong><code>[</code><em>flags</em><code>]</code></strong>
658 as the third argument to the <code>RewriteCond</code>
659 directive, where <em>flags</em> is a comma-separated list of any of the
663 <li>'<strong><code>nocase|NC</code></strong>'
664 (<strong>n</strong>o <strong>c</strong>ase)<br />
665 This makes the test case-insensitive - differences
666 between 'A-Z' and 'a-z' are ignored, both in the
667 expanded <em>TestString</em> and the <em>CondPattern</em>.
668 This flag is effective only for comparisons between
669 <em>TestString</em> and <em>CondPattern</em>. It has no
670 effect on filesystem and subrequest checks.</li>
673 '<strong><code>ornext|OR</code></strong>'
674 (<strong>or</strong> next condition)<br />
675 Use this to combine rule conditions with a local OR
676 instead of the implicit AND. Typical example:
678 <pre class="prettyprint lang-config">RewriteCond %{REMOTE_HOST} ^host1 [OR]
679 RewriteCond %{REMOTE_HOST} ^host2 [OR]
680 RewriteCond %{REMOTE_HOST} ^host3
681 RewriteRule ...some special stuff for any of these hosts...</pre>
684 Without this flag you would have to write the condition/rule
688 <li>'<strong><code>novary|NV</code></strong>'
689 (<strong>n</strong>o <strong>v</strong>ary)<br />
690 If a HTTP header is used in the condition, this flag prevents
691 this header from being added to the Vary header of the response. <br />
692 Using this flag might break proper caching of the response if
693 the representation of this response varies on the value of this header.
694 So this flag should be only used if the meaning of the Vary header
701 <p><strong>Example:</strong></p>
703 <p>To rewrite the Homepage of a site according to the
704 ``<code>User-Agent:</code>'' header of the request, you can
705 use the following: </p>
707 <pre class="prettyprint lang-config">RewriteCond %{HTTP_USER_AGENT} (iPhone|Blackberry|Android)
708 RewriteRule ^/$ /homepage.mobile.html [L]
710 RewriteRule ^/$ /homepage.std.html [L]</pre>
713 <p>Explanation: If you use a browser which identifies itself
714 as a mobile browser (note that the example is incomplete, as
715 there are many other mobile platforms), the mobile version of
716 the homepage is served. Otherwise, the standard page is served.
721 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
722 <div class="directive-section"><h2><a name="RewriteEngine" id="RewriteEngine">RewriteEngine</a> <a name="rewriteengine" id="rewriteengine">Directive</a></h2>
723 <table class="directive">
724 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables or disables runtime rewriting engine</td></tr>
725 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RewriteEngine on|off</code></td></tr>
726 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>RewriteEngine off</code></td></tr>
727 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
728 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
729 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
730 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_rewrite</td></tr>
733 <p>The <code class="directive">RewriteEngine</code> directive enables or
734 disables the runtime rewriting engine. If it is set to
735 <code>off</code> this module does no runtime processing at
736 all. It does not even update the <code>SCRIPT_URx</code>
737 environment variables.</p>
739 <p>Use this directive to disable rules in a particular context,
740 rather than commenting out all the <code class="directive"><a href="#rewriterule">RewriteRule</a></code> directives.</p>
742 <p>Note that rewrite configurations are not
743 inherited by virtual hosts. This means that you need to have a
744 <code>RewriteEngine on</code> directive for each virtual host
745 in which you wish to use rewrite rules.</p>
747 <p><code class="directive">RewriteMap</code> directives of the type <code>prg</code>
748 are not started during server initialization if they're defined in a
749 context that does not have <code class="directive">RewriteEngine</code> set to
753 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
754 <div class="directive-section"><h2><a name="RewriteMap" id="RewriteMap">RewriteMap</a> <a name="rewritemap" id="rewritemap">Directive</a></h2>
755 <table class="directive">
756 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Defines a mapping function for key-lookup</td></tr>
757 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RewriteMap <em>MapName</em> <em>MapType</em>:<em>MapSource</em>
759 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
760 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
761 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_rewrite</td></tr>
763 <p>The <code class="directive">RewriteMap</code> directive defines a
764 <em>Rewriting Map</em> which can be used inside rule
765 substitution strings by the mapping-functions to
766 insert/substitute fields through a key lookup. The source of
767 this lookup can be of various types.</p>
769 <p>The <a id="mapfunc" name="mapfunc"><em>MapName</em></a> is
770 the name of the map and will be used to specify a
771 mapping-function for the substitution strings of a rewriting
772 rule via one of the following constructs:</p>
775 <strong><code>${</code> <em>MapName</em> <code>:</code>
776 <em>LookupKey</em> <code>}</code><br />
777 <code>${</code> <em>MapName</em> <code>:</code>
778 <em>LookupKey</em> <code>|</code> <em>DefaultValue</em>
779 <code>}</code></strong>
782 <p>When such a construct occurs, the map <em>MapName</em> is
783 consulted and the key <em>LookupKey</em> is looked-up. If the
784 key is found, the map-function construct is substituted by
785 <em>SubstValue</em>. If the key is not found then it is
786 substituted by <em>DefaultValue</em> or by the empty string
787 if no <em>DefaultValue</em> was specified. Empty values
788 behave as if the key was absent, therefore it is not possible
789 to distinguish between empty-valued keys and absent keys.</p>
791 <p>For example, you might define a
792 <code class="directive">RewriteMap</code> as:</p>
794 <pre class="prettyprint lang-config">RewriteMap examplemap txt:/path/to/file/map.txt</pre>
797 <p>You would then be able to use this map in a
798 <code class="directive">RewriteRule</code> as follows:</p>
800 <pre class="prettyprint lang-config">RewriteRule ^/ex/(.*) ${examplemap:$1}</pre>
803 <p>The following combinations for <em>MapType</em> and
804 <em>MapSource</em> can be used:</p>
809 <dd>A plain text file containing space-separated key-value
810 pairs, one per line. (<a href="../rewrite/rewritemap.html#txt">Details ...</a>)</dd>
813 <dd>Randomly selects an entry from a plain text file (<a href="../rewrite/rewritemap.html#rnd">Details ...</a>)</dd>
816 <dd>Looks up an entry in a dbm file containing name, value
817 pairs. Hash is constructed from a plain text file format using
818 the <code><a href="../programs/httxt2dbm.html">httxt2dbm</a></code>
819 utility. (<a href="../rewrite/rewritemap.html#dbm">Details ...</a>)</dd>
822 <dd>One of the four available internal functions provided by
823 <code>RewriteMap</code>: toupper, tolower, escape or
824 unescape. (<a href="../rewrite/rewritemap.html#int">Details ...</a>)</dd>
827 <dd>Calls an external program or script to process the
828 rewriting. (<a href="../rewrite/rewritemap.html#prg">Details ...</a>)</dd>
830 <dt>dbd or fastdbd</dt>
831 <dd>A SQL SELECT statement to be performed to look up the
832 rewrite target. (<a href="../rewrite/rewritemap.html#dbd">Details ...</a>)</dd>
835 <p>Further details, and numerous examples, may be found in the <a href="../rewrite/rewritemap.html">RewriteMap HowTo</a></p>
839 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
840 <div class="directive-section"><h2><a name="RewriteOptions" id="RewriteOptions">RewriteOptions</a> <a name="rewriteoptions" id="rewriteoptions">Directive</a></h2>
841 <table class="directive">
842 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets some special options for the rewrite engine</td></tr>
843 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RewriteOptions <var>Options</var></code></td></tr>
844 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
845 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
846 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
847 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_rewrite</td></tr>
850 <p>The <code class="directive">RewriteOptions</code> directive sets some
851 special options for the current per-server or per-directory
852 configuration. The <em>Option</em> string can currently
853 only be one of the following:</p>
856 <dt><code>Inherit</code></dt>
859 <p>This forces the current configuration to inherit the
860 configuration of the parent. In per-virtual-server context,
861 this means that the maps, conditions and rules of the main
862 server are inherited. In per-directory context this means
863 that conditions and rules of the parent directory's
864 <code>.htaccess</code> configuration or
865 <code class="directive"><a href="../mod/core.html#directory"><Directory></a></code>
866 sections are inherited. The inherited rules are virtually copied
867 to the section where this directive is being used. If used in
868 combination with local rules, the inherited rules are copied behind
869 the local rules. The position of this directive - below or above
870 of local rules - has no influence on this behavior. If local
871 rules forced the rewriting to stop, the inherited rules won't
874 <div class="warning">
875 Rules inherited from the parent scope are applied
876 <strong>after</strong> rules specified in the child scope.
880 <dt><code>InheritBefore</code></dt>
882 <p> Like <code>Inherit</code> above, but the rules from the parent scope
883 are applied <strong>before</strong> rules specified in the child scope.<br />
884 Available in Apache HTTP Server 2.3.10 and later.</p>
887 <dt><code>InheritDown</code></dt>
890 <p>If this option is enabled, all child configurations will inherit
891 the configuration of the current configuration. It is equivalent to
892 specifying <code>RewriteOptions Inherit</code> in all child
893 configurations. See the <code>Inherit</code> option for more details
894 on how the parent-child relationships are handled.<br />
895 Available in Apache HTTP Server 2.4.8 and later.</p>
898 <dt><code>InheritDownBefore</code></dt>
901 <p>Like <code>InheritDown</code> above, but the rules from the current
902 scope are applied <strong>before</strong> rules specified in any child's
904 Available in Apache HTTP Server 2.4.8 and later.</p>
907 <dt><code>IgnoreInherit</code></dt>
910 <p>This option forces the current and child configurations to ignore
911 all rules that would be inherited from a parent specifying
912 <code>InheritDown</code> or <code>InheritDownBefore</code>.<br />
913 Available in Apache HTTP Server 2.4.8 and later.</p>
916 <dt><code>AllowNoSlash</code></dt>
918 <p>By default, <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> will ignore URLs that map to a
919 directory on disk but lack a trailing slash, in the expectation that
920 the <code class="module"><a href="../mod/mod_dir.html">mod_dir</a></code> module will issue the client with a redirect to
921 the canonical URL with a trailing slash.</p>
923 <p>When the <code class="directive"><a href="../mod/mod_dir.html#directoryslash">DirectorySlash</a></code> directive
924 is set to off, the <code>AllowNoSlash</code> option can be enabled to ensure
925 that rewrite rules are no longer ignored. This option makes it possible to
926 apply rewrite rules within .htaccess files that match the directory without
927 a trailing slash, if so desired.<br />
928 Available in Apache HTTP Server 2.4.0 and later.</p>
931 <dt><code>AllowAnyURI</code></dt>
934 <p>When <code class="directive"><a href="#rewriterule">RewriteRule</a></code>
935 is used in <code>VirtualHost</code> or server context with
936 version 2.2.22 or later of httpd, <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>
937 will only process the rewrite rules if the request URI is a <a href="directive-dict.html#Syntax">URL-path</a>. This avoids
938 some security issues where particular rules could allow
939 "surprising" pattern expansions (see <a href="http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2011-3368">CVE-2011-3368</a>
940 and <a href="http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2011-4317">CVE-2011-4317</a>).
941 To lift the restriction on matching a URL-path, the
942 <code>AllowAnyURI</code> option can be enabled, and
943 <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> will apply the rule set to any
944 request URI string, regardless of whether that string matches
945 the URL-path grammar required by the HTTP specification.<br />
946 Available in Apache HTTP Server 2.4.3 and later.</p>
948 <div class="warning">
949 <h3>Security Warning</h3>
951 <p>Enabling this option will make the server vulnerable to
952 security issues if used with rewrite rules which are not
953 carefully authored. It is <strong>strongly recommended</strong>
954 that this option is not used. In particular, beware of input
955 strings containing the '<code>@</code>' character which could
956 change the interpretation of the transformed URI, as per the
961 <dt><code>MergeBase</code></dt>
964 <p>With this option, the value of <code class="directive"><a href="#rewritebase">RewriteBase</a></code> is copied from where it's explicitly defined
965 into any sub-directory or sub-location that doesn't define its own
966 <code class="directive"><a href="#rewritebase">RewriteBase</a></code>. This was the
967 default behavior in 2.4.0 through 2.4.3, and the flag to restore it is
968 available Apache HTTP Server 2.4.4 and later.</p>
974 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
975 <div class="directive-section"><h2><a name="RewriteRule" id="RewriteRule">RewriteRule</a> <a name="rewriterule" id="rewriterule">Directive</a></h2>
976 <table class="directive">
977 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Defines rules for the rewriting engine</td></tr>
978 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RewriteRule
979 <em>Pattern</em> <em>Substitution</em> [<em>flags</em>]</code></td></tr>
980 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
981 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
982 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
983 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_rewrite</td></tr>
985 <p>The <code class="directive">RewriteRule</code> directive is the real
986 rewriting workhorse. The directive can occur more than once,
987 with each instance defining a single rewrite rule. The
988 order in which these rules are defined is important - this is the order
989 in which they will be applied at run-time.</p>
991 <p><a id="patterns" name="patterns"><em>Pattern</em></a> is
992 a perl compatible <a id="regexp" name="regexp">regular
993 expression</a>. On the first RewriteRule, it is matched against
994 the (%-decoded) <a href="directive-dict.html#Syntax">URL-path</a> (or
995 <a href="directive-dict.html#Syntax">file-path</a>, depending
996 on the context) of the request. Subsequent patterns are matched against the
997 output of the last matching RewriteRule.</p>
999 <div class="note"><h3><a id="what_is_matched" name="what_is_matched">What is matched?</a></h3>
1000 <p>In <code class="directive"><a href="../mod/core.html#virtualhost">VirtualHost</a></code> context,
1001 The <em>Pattern</em> will initially be matched against the part of the
1002 URL after the hostname and port, and before the query string (e.g. "/app1/index.html").</p>
1004 <p>In <code class="directive"><a href="../mod/core.html#directory">Directory</a></code> and htaccess context,
1005 the <em>Pattern</em> will initially be matched against the
1006 <em>filesystem</em> path, after removing the prefix that led the server
1007 to the current <code class="directive">RewriteRule</code> (e.g. "app1/index.html"
1008 or "index.html" depending on where the directives are defined).</p>
1010 <p>If you wish to match against the hostname, port, or query string, use a
1011 <code class="directive"><a href="#rewritecond">RewriteCond</a></code> with the
1012 <code>%{HTTP_HOST}</code>, <code>%{SERVER_PORT}</code>, or
1013 <code>%{QUERY_STRING}</code> variables respectively.</p>
1017 <div class="note"><h3>Per-directory Rewrites</h3>
1019 <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
1022 <li>To enable the rewrite engine in this context, you need to set
1023 "<code>RewriteEngine On</code>" <strong>and</strong>
1024 "<code>Options FollowSymLinks</code>" must be enabled. If your
1025 administrator has disabled override of <code>FollowSymLinks</code> for
1026 a user's directory, then you cannot use the rewrite engine. This
1027 restriction is required for security reasons.</li>
1029 <li>When using the rewrite engine in <code>.htaccess</code> files the
1030 per-directory prefix (which always is the same for a specific
1031 directory) is automatically <em>removed</em> for the RewriteRule pattern matching
1032 and automatically <em>added</em> after any relative (not starting with a
1033 slash or protocol name) substitution encounters the end of a rule set.
1034 See the <code class="directive"><a href="#rewritebase">RewriteBase</a></code>
1035 directive for more information regarding what prefix will be added back to
1036 relative substitutions.</li>
1038 <li> If you wish to match against the full URL-path in a per-directory
1039 (htaccess) RewriteRule, use the <code>%{REQUEST_URI}</code> variable in
1040 a <code class="directive">RewriteCond</code>.</li>
1042 <li>The removed prefix always ends with a slash, meaning the matching occurs against a string which
1043 <em>never</em> has a leading slash. Therefore, a <em>Pattern</em> with <code>^/</code> never
1044 matches in per-directory context.</li>
1046 <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
1047 should never be necessary and is unsupported.</li>
1051 <p>For some hints on <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular
1052 expressions</a>, see
1053 the <a href="../rewrite/intro.html#regex">mod_rewrite
1054 Introduction</a>.</p>
1056 <p>In mod_rewrite, the NOT character
1057 ('<code>!</code>') is also available as a possible pattern
1058 prefix. This enables you to negate a pattern; to say, for instance:
1059 ``<em>if the current URL does <strong>NOT</strong> match this
1060 pattern</em>''. This can be used for exceptional cases, where
1061 it is easier to match the negative pattern, or as a last
1064 <div class="note"><h3>Note</h3>
1065 When using the NOT character to negate a pattern, you cannot include
1066 grouped wildcard parts in that pattern. This is because, when the
1067 pattern does NOT match (ie, the negation matches), there are no
1068 contents for the groups. Thus, if negated patterns are used, you
1069 cannot use <code>$N</code> in the substitution string!
1072 <p>The <a id="rhs" name="rhs"><em>Substitution</em></a> of a
1073 rewrite rule is the string that replaces the original URL-path that
1074 was matched by <em>Pattern</em>. The <em>Substitution</em> may
1079 <dt>file-system path</dt>
1081 <dd>Designates the location on the file-system of the resource
1082 to be delivered to the client. Substitutions are only
1083 treated as a file-system path when the rule is configured in
1084 server (virtualhost) context and the first component of the
1085 path in the substitution exists in the file-system</dd>
1089 <dd>A <code class="directive"><a href="../mod/core.html#documentroot">DocumentRoot</a></code>-relative path to the
1090 resource to be served. Note that <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>
1091 tries to guess whether you have specified a file-system path
1092 or a URL-path by checking to see if the first segment of the
1093 path exists at the root of the file-system. For example, if
1094 you specify a <em>Substitution</em> string of
1095 <code>/www/file.html</code>, then this will be treated as a
1096 URL-path <em>unless</em> a directory named <code>www</code>
1097 exists at the root or your file-system (or, in the case of
1098 using rewrites in a <code>.htaccess</code> file, relative to
1099 your document root), in which case it will
1100 be treated as a file-system path. If you wish other
1101 URL-mapping directives (such as <code class="directive"><a href="../mod/mod_alias.html#alias">Alias</a></code>) to be applied to the
1102 resulting URL-path, use the <code>[PT]</code> flag as
1103 described below.</dd>
1105 <dt>Absolute URL</dt>
1107 <dd>If an absolute URL is specified,
1108 <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> checks to see whether the
1109 hostname matches the current host. If it does, the scheme and
1110 hostname are stripped out and the resulting path is treated as
1111 a URL-path. Otherwise, an external redirect is performed for
1112 the given URL. To force an external redirect back to the
1113 current host, see the <code>[R]</code> flag below.</dd>
1115 <dt><code>-</code> (dash)</dt>
1117 <dd>A dash indicates that no substitution should be performed
1118 (the existing path is passed through untouched). This is used
1119 when a flag (see below) needs to be applied without changing
1124 <p>In addition to plain text, the <em>Substitution</em> string can include</p>
1127 <li>back-references (<code>$N</code>) to the RewriteRule
1130 <li>back-references (<code>%N</code>) to the last matched
1131 RewriteCond pattern</li>
1133 <li>server-variables as in rule condition test-strings
1134 (<code>%{VARNAME}</code>)</li>
1136 <li><a href="#mapfunc">mapping-function</a> calls
1137 (<code>${mapname:key|default}</code>)</li>
1140 <p>Back-references are identifiers of the form
1141 <code>$</code><strong>N</strong>
1142 (<strong>N</strong>=0..9), which will be replaced
1143 by the contents of the <strong>N</strong>th group of the
1144 matched <em>Pattern</em>. The server-variables are the same
1145 as for the <em>TestString</em> of a <code>RewriteCond</code>
1146 directive. The mapping-functions come from the
1147 <code>RewriteMap</code> directive and are explained there.
1148 These three types of variables are expanded in the order above.</p>
1150 <p>Rewrite rules are applied to the results of previous rewrite
1151 rules, in the order in which they are defined
1152 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
1153 replaced</strong> by the <em>Substitution</em> and the
1154 rewriting process continues until all rules have been applied,
1155 or it is explicitly terminated by an
1156 <a href="../rewrite/flags.html#flag_l"><code><strong>L</strong></code> flag</a>,
1157 or other flag which implies immediate termination, such as
1158 <code><strong>END</strong></code> or
1159 <code><strong>F</strong></code>.</p>
1161 <div class="note"><h3>Modifying the Query String</h3>
1162 <p>By default, the query string is passed through unchanged. You
1163 can, however, create URLs in the substitution string containing
1164 a query string part. Simply use a question mark inside the
1165 substitution string to indicate that the following text should
1166 be re-injected into the query string. When you want to erase an
1167 existing query string, end the substitution string with just a
1168 question mark. To combine new and old query strings, use the
1169 <code>[QSA]</code> flag.</p>
1172 <p>Additionally you can set special <a name="rewriteflags" id="rewriteflags">actions</a> to be performed by
1173 appending <strong><code>[</code><em>flags</em><code>]</code></strong>
1174 as the third argument to the <code>RewriteRule</code>
1175 directive. <em>Flags</em> is a comma-separated list, surround by square
1176 brackets, of any of the flags in the following table. More
1177 details, and examples, for each flag, are available in the <a href="../rewrite/flags.html">Rewrite Flags document</a>.</p>
1179 <table class="bordered"><tr class="header"><th>Flag and syntax</th>
1184 <td>Escape non-alphanumeric characters in backreferences <em>before</em>
1185 applying the transformation. <em><a href="../rewrite/flags.html#flag_b">details ...</a></em></td>
1188 <td>backrefnoplus|BNP</td>
1189 <td>If backreferences are being escaped, spaces should be escaped to
1190 %20 instead of +. Useful when the backreference will be used in the
1191 path component rather than the query string.<em><a href="../rewrite/flags.html#flag_bnp">details ...</a></em></td>
1195 <td>Rule is chained to the following rule. If the rule fails,
1196 the rule(s) chained to it will be skipped. <em><a href="../rewrite/flags.html#flag_c">details ...</a></em></td>
1199 <td>cookie|CO=<em>NAME</em>:<em>VAL</em></td>
1200 <td>Sets a cookie in the client browser. Full syntax is:
1201 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>
1205 <td>discardpath|DPI</td>
1206 <td>Causes the PATH_INFO portion of the rewritten URI to be
1207 discarded. <em><a href="../rewrite/flags.html#flag_dpi">details
1212 <td>Stop the rewriting process immediately and don't apply any
1213 more rules. Also prevents further execution of rewrite rules
1214 in per-directory and .htaccess context. (Available in 2.3.9 and later)
1215 <em><a href="../rewrite/flags.html#flag_end">details ...</a></em></td>
1218 <td>env|E=[!]<em>VAR</em>[:<em>VAL</em>]</td>
1219 <td>Causes an environment variable <em>VAR</em> to be set (to the
1220 value <em>VAL</em> if provided). The form !<em>VAR</em> causes
1221 the environment variable <em>VAR</em> to be unset.
1222 <em><a href="../rewrite/flags.html#flag_e">details ...</a></em></td>
1225 <td>forbidden|F</td>
1226 <td>Returns a 403 FORBIDDEN response to the client browser.
1227 <em><a href="../rewrite/flags.html#flag_f">details ...</a></em></td>
1231 <td>Returns a 410 GONE response to the client browser. <em><a href="../rewrite/flags.html#flag_g">details ...</a></em></td>
1234 <td>Handler|H=<em>Content-handler</em></td>
1235 <td>Causes the resulting URI to be sent to the specified
1236 <em>Content-handler</em> for processing. <em><a href="../rewrite/flags.html#flag_h">details ...</a></em></td>
1240 <td>Stop the rewriting process immediately and don't apply any
1241 more rules. Especially note caveats for per-directory and
1242 .htaccess context (see also the END flag). <em><a href="../rewrite/flags.html#flag_l">details ...</a></em></td>
1246 <td>Re-run the rewriting process, starting again with the first
1247 rule, using the result of the ruleset so far as a starting
1248 point. <em><a href="../rewrite/flags.html#flag_n">details
1253 <td>Makes the pattern comparison case-insensitive.
1254 <em><a href="../rewrite/flags.html#flag_nc">details ...</a></em></td>
1257 <td>noescape|NE</td>
1258 <td>Prevent mod_rewrite from applying hexcode escaping of
1259 special characters in the result of the rewrite. <em><a href="../rewrite/flags.html#flag_ne">details ...</a></em></td>
1262 <td>nosubreq|NS</td>
1263 <td>Causes a rule to be skipped if the current request is an
1264 internal sub-request. <em><a href="../rewrite/flags.html#flag_ns">details ...</a></em></td>
1268 <td>Force the substitution URL to be internally sent as a proxy
1269 request. <em><a href="../rewrite/flags.html#flag_p">details
1273 <td>passthrough|PT</td>
1274 <td>Forces the resulting URI to be passed back to the URL
1275 mapping engine for processing of other URI-to-filename
1276 translators, such as <code>Alias</code> or
1277 <code>Redirect</code>. <em><a href="../rewrite/flags.html#flag_pt">details ...</a></em></td>
1280 <td>qsappend|QSA</td>
1281 <td>Appends any query string from the original request URL to
1282 any query string created in the rewrite target.<em><a href="../rewrite/flags.html#flag_qsa">details ...</a></em></td>
1285 <td>qsdiscard|QSD</td>
1286 <td>Discard any query string attached to the incoming URI.
1287 <em><a href="../rewrite/flags.html#flag_qsd">details
1291 <td>redirect|R[=<em>code</em>]</td>
1292 <td>Forces an external redirect, optionally with the specified
1293 HTTP status code. <em><a href="../rewrite/flags.html#flag_r">details ...</a></em>
1297 <td>skip|S=<em>num</em></td>
1298 <td>Tells the rewriting engine to skip the next <em>num</em>
1299 rules if the current rule matches. <em><a href="../rewrite/flags.html#flag_s">details ...</a></em></td>
1302 <td>type|T=<em>MIME-type</em></td>
1303 <td>Force the <a class="glossarylink" href="../glossary.html#mime-type" title="see glossary">MIME-type</a> of the target file
1304 to be the specified type. <em><a href="../rewrite/flags.html#flag_t">details ...</a></em></td>
1308 <div class="note"><h3>Home directory expansion</h3>
1309 <p> When the substitution string begins with a string
1310 resembling "/~user" (via explicit text or backreferences), mod_rewrite performs
1311 home directory expansion independent of the presence or configuration
1312 of <code class="module"><a href="../mod/mod_userdir.html">mod_userdir</a></code>.</p>
1314 <p> This expansion does not occur when the <em>PT</em>
1315 flag is used on the <code class="directive"><a href="#rewriterule">RewriteRule</a></code>
1320 <p>Here are all possible substitution combinations and their
1323 <p><strong>Inside per-server configuration
1324 (<code>httpd.conf</code>)<br />
1325 for request ``<code>GET
1326 /somepath/pathinfo</code>'':</strong><br />
1329 <table class="bordered"><tr class="header">
1331 <th>Resulting Substitution</th>
1334 <td>^/somepath(.*) otherpath$1</td>
1335 <td>invalid, not supported</td>
1338 <td>^/somepath(.*) otherpath$1 [R]</td>
1339 <td>invalid, not supported</td>
1342 <td>^/somepath(.*) otherpath$1 [P]</td>
1343 <td>invalid, not supported</td>
1346 <td>^/somepath(.*) /otherpath$1</td>
1347 <td>/otherpath/pathinfo</td>
1350 <td>^/somepath(.*) /otherpath$1 [R]</td>
1351 <td>http://thishost/otherpath/pathinfo via external redirection</td>
1354 <td>^/somepath(.*) /otherpath$1 [P]</td>
1355 <td>doesn't make sense, not supported</td>
1358 <td>^/somepath(.*) http://thishost/otherpath$1</td>
1359 <td>/otherpath/pathinfo</td>
1362 <td>^/somepath(.*) http://thishost/otherpath$1 [R]</td>
1363 <td>http://thishost/otherpath/pathinfo via external redirection</td>
1366 <td>^/somepath(.*) http://thishost/otherpath$1 [P]</td>
1367 <td>doesn't make sense, not supported</td>
1370 <td>^/somepath(.*) http://otherhost/otherpath$1</td>
1371 <td>http://otherhost/otherpath/pathinfo via external redirection</td>
1374 <td>^/somepath(.*) http://otherhost/otherpath$1 [R]</td>
1375 <td>http://otherhost/otherpath/pathinfo via external redirection (the [R] flag is redundant)</td>
1378 <td>^/somepath(.*) http://otherhost/otherpath$1 [P]</td>
1379 <td>http://otherhost/otherpath/pathinfo via internal proxy</td>
1383 <p><strong>Inside per-directory configuration for
1384 <code>/somepath</code><br />
1385 (<code>/physical/path/to/somepath/.htaccess</code>, with
1386 <code>RewriteBase /somepath</code>)<br />
1387 for request ``<code>GET
1388 /somepath/localpath/pathinfo</code>'':</strong><br />
1391 <table class="bordered"><tr class="header">
1393 <th>Resulting Substitution</th>
1396 <td>^localpath(.*) otherpath$1</td>
1397 <td>/somepath/otherpath/pathinfo</td>
1400 <td>^localpath(.*) otherpath$1 [R]</td>
1401 <td>http://thishost/somepath/otherpath/pathinfo via external
1405 <td>^localpath(.*) otherpath$1 [P]</td>
1406 <td>doesn't make sense, not supported</td>
1409 <td>^localpath(.*) /otherpath$1</td>
1410 <td>/otherpath/pathinfo</td>
1413 <td>^localpath(.*) /otherpath$1 [R]</td>
1414 <td>http://thishost/otherpath/pathinfo via external redirection</td>
1417 <td>^localpath(.*) /otherpath$1 [P]</td>
1418 <td>doesn't make sense, not supported</td>
1421 <td>^localpath(.*) http://thishost/otherpath$1</td>
1422 <td>/otherpath/pathinfo</td>
1425 <td>^localpath(.*) http://thishost/otherpath$1 [R]</td>
1426 <td>http://thishost/otherpath/pathinfo via external redirection</td>
1429 <td>^localpath(.*) http://thishost/otherpath$1 [P]</td>
1430 <td>doesn't make sense, not supported</td>
1433 <td>^localpath(.*) http://otherhost/otherpath$1</td>
1434 <td>http://otherhost/otherpath/pathinfo via external redirection</td>
1437 <td>^localpath(.*) http://otherhost/otherpath$1 [R]</td>
1438 <td>http://otherhost/otherpath/pathinfo via external redirection (the [R] flag is redundant)</td>
1441 <td>^localpath(.*) http://otherhost/otherpath$1 [P]</td>
1442 <td>http://otherhost/otherpath/pathinfo via internal proxy</td>
1449 <div class="bottomlang">
1450 <p><span>Available Languages: </span><a href="../en/mod/mod_rewrite.html" title="English"> en </a> |
1451 <a href="../fr/mod/mod_rewrite.html" hreflang="fr" rel="alternate" title="Français"> fr </a></p>
1452 </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>
1453 <script type="text/javascript"><!--//--><![CDATA[//><!--
1454 var comments_shortname = 'httpd';
1455 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_rewrite.html';
1457 if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
1458 d.write('<div id="comments_thread"><\/div>');
1459 var s = d.createElement('script');
1460 s.type = 'text/javascript';
1462 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
1463 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
1466 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
1468 })(window, document);
1469 //--><!]]></script></div><div id="footer">
1470 <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>
1471 <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[//><!--
1472 if (typeof(prettyPrint) !== 'undefined') {