granicus.if.org Git - apache/blob - docs/manual/rewrite/flags.html.en

   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 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
   5 <!--
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7               This file is generated from xml source: DO NOT EDIT
   8         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   9       -->
  10 <title>RewriteRule Flags - Apache HTTP Server Version 2.5</title>
  11 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  12 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  13 <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" />
  14 <script src="../style/scripts/prettify.min.js" type="text/javascript">
  15 </script>
  16
  17 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  18 <body id="manual-page"><div id="page-header">
  19 <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>
  20 <p class="apache">Apache HTTP Server Version 2.5</p>
  21 <img alt="" src="../images/feather.png" /></div>
  22 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  23 <div id="path">
  24 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.5</a> &gt; <a href="./">Rewrite</a></div><div id="page-content"><div id="preamble"><h1>RewriteRule Flags</h1>
  25 <div class="toplang">
  26 <p><span>Available Languages: </span><a href="../en/rewrite/flags.html" title="English">&nbsp;en&nbsp;</a> |
  27 <a href="../fr/rewrite/flags.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a></p>
  28 </div>
  29
  30 <p>This document discusses the flags which are available to the
  31 <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> directive,
  32 providing detailed explanations and examples.</p>
  33 </div>
  34 <div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#introduction">Introduction</a></li>
  35 <li><img alt="" src="../images/down.gif" /> <a href="#flag_b">B (escape backreferences)</a></li>
  36 <li><img alt="" src="../images/down.gif" /> <a href="#flag_bnp">BNP|backrefnoplus (don't escape space to +)</a></li>
  37 <li><img alt="" src="../images/down.gif" /> <a href="#flag_c">C|chain</a></li>
  38 <li><img alt="" src="../images/down.gif" /> <a href="#flag_co">CO|cookie</a></li>
  39 <li><img alt="" src="../images/down.gif" /> <a href="#flag_dpi">DPI|discardpath</a></li>
  40 <li><img alt="" src="../images/down.gif" /> <a href="#flag_e">E|env</a></li>
  41 <li><img alt="" src="../images/down.gif" /> <a href="#flag_end">END</a></li>
  42 <li><img alt="" src="../images/down.gif" /> <a href="#flag_f">F|forbidden</a></li>
  43 <li><img alt="" src="../images/down.gif" /> <a href="#flag_g">G|gone</a></li>
  44 <li><img alt="" src="../images/down.gif" /> <a href="#flag_h">H|handler</a></li>
  45 <li><img alt="" src="../images/down.gif" /> <a href="#flag_l">L|last</a></li>
  46 <li><img alt="" src="../images/down.gif" /> <a href="#flag_n">N|next</a></li>
  47 <li><img alt="" src="../images/down.gif" /> <a href="#flag_nc">NC|nocase</a></li>
  48 <li><img alt="" src="../images/down.gif" /> <a href="#flag_ne">NE|noescape</a></li>
  49 <li><img alt="" src="../images/down.gif" /> <a href="#flag_ns">NS|nosubreq</a></li>
  50 <li><img alt="" src="../images/down.gif" /> <a href="#flag_p">P|proxy</a></li>
  51 <li><img alt="" src="../images/down.gif" /> <a href="#flag_pt">PT|passthrough</a></li>
  52 <li><img alt="" src="../images/down.gif" /> <a href="#flag_qsa">QSA|qsappend</a></li>
  53 <li><img alt="" src="../images/down.gif" /> <a href="#flag_qsd">QSD|qsdiscard</a></li>
  54 <li><img alt="" src="../images/down.gif" /> <a href="#flag_qsl">QSL|qslast</a></li>
  55 <li><img alt="" src="../images/down.gif" /> <a href="#flag_r">R|redirect</a></li>
  56 <li><img alt="" src="../images/down.gif" /> <a href="#flag_s">S|skip</a></li>
  57 <li><img alt="" src="../images/down.gif" /> <a href="#flag_t">T|type</a></li>
  58 </ul><h3>See also</h3><ul class="seealso"><li><a href="../mod/mod_rewrite.html">Module documentation</a></li><li><a href="intro.html">mod_rewrite introduction</a></li><li><a href="remapping.html">Redirection and remapping</a></li><li><a href="access.html">Controlling access</a></li><li><a href="vhosts.html">Virtual hosts</a></li><li><a href="proxy.html">Proxying</a></li><li><a href="rewritemap.html">Using RewriteMap</a></li><li><a href="advanced.html">Advanced techniques</a></li><li><a href="avoid.html">When not to use mod_rewrite</a></li><li><a href="#comments_section">Comments</a></li></ul></div>
  59 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  60 <div class="section">
  61 <h2><a name="introduction" id="introduction">Introduction</a></h2>
  62 <p>A <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> can have
  63 its behavior modified by one or more flags. Flags are included in
  64 square brackets at the end of the rule, and multiple flags are separated
  65 by commas.</p>
  66 <pre class="prettyprint lang-config">RewriteRule pattern target [Flag1,Flag2,Flag3]</pre>
  67
  68
  69 <p>Each flag (with a few exceptions) has a short form, such as
  70 <code>CO</code>, as well as a longer form, such as <code>cookie</code>.
  71 While it is most common to use
  72 the short form, it is recommended that you familiarize yourself with the
  73 long form, so that you remember what each flag is supposed to do.
  74 Some flags take one or more arguments. Flags are not case sensitive.</p>
  75
  76 <p>Flags that alter metadata associated with the request (T=, H=, E=)
  77 have no affect in per-directory and htaccess context, when a substitution
  78 (other than '-') is performed during the same round of rewrite processing.
  79 </p>
  80
  81 <p>Presented here are each of the available flags, along with an example
  82 of how you might use them.</p>
  83 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  84 <div class="section">
  85 <h2><a name="flag_b" id="flag_b">B (escape backreferences)</a></h2>
  86 <p>The [B] flag instructs <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> to escape non-alphanumeric
  87 characters before applying the transformation.</p>
  88 <p>In 2.4.10 and later, you can limit the escaping to specific characters
  89 in backreferences by listing them: <code>[B=#?;]</code>. Note: The space
  90 character can be used in the list of characters to escape, but it cannot be
  91 the last character in the list.</p>
  92
  93 <p><code>mod_rewrite</code> has to unescape URLs before mapping them,
  94 so backreferences are unescaped at the time they are applied.
  95 Using the B flag, non-alphanumeric characters in backreferences
  96 will be escaped. For example, consider the rule:</p>
  97
  98 <pre class="prettyprint lang-config">RewriteRule "^search/(.*)$" "/search.php?term=$1"</pre>
  99
 100
 101 <p>Given a search term of 'x &amp; y/z', a browser will encode it as
 102 'x%20%26%20y%2Fz', making the request 'search/x%20%26%20y%2Fz'. Without the B
 103 flag, this rewrite rule will map to 'search.php?term=x &amp; y/z', which
 104 isn't a valid URL, and so would be encoded as
 105 <code>search.php?term=x%20&amp;y%2Fz=</code>, which is not what was intended.</p>
 106
 107 <p>With the B flag set on this same rule, the parameters are re-encoded
 108 before being passed on to the output URL, resulting in a correct mapping to
 109 <code>/search.php?term=x%20%26%20y%2Fz</code>.</p>
 110
 111 <p>Note that you may also need to set <code class="directive"><a href="../mod/core.html#allowencodedslashes">AllowEncodedSlashes</a></code> to <code>On</code> to get this
 112 particular example to work, as httpd does not allow encoded slashes in URLs, and
 113 returns a 404 if it sees one.</p>
 114
 115 <p>This escaping is particularly necessary in a proxy situation,
 116 when the backend may break if presented with an unescaped URL.</p>
 117
 118 <p>An alternative to this flag is using a <code class="directive"><a href="../mod/mod_rewrite.html#rewritecond">RewriteCond</a></code> to capture against %{THE_REQUEST} which will capture
 119 strings in the encoded form.</p>
 120 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 121 <div class="section">
 122 <h2><a name="flag_bnp" id="flag_bnp">BNP|backrefnoplus (don't escape space to +)</a></h2>
 123 <p>The [BNP] flag instructs <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> to escape the space character
 124 in a backreference to %20 rather than '+'. Useful when the backreference
 125 will be used in the path component rather than the query string.</p>
 126 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 127 <div class="section">
 128 <h2><a name="flag_c" id="flag_c">C|chain</a></h2>
 129 <p>The [C] or [chain] flag indicates that the <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> is chained to the next
 130 rule. That is, if the rule matches, then it is processed as usual and
 131 control moves on to the next rule. However, if it does not match, then
 132 the next rule, and any other rules that are chained together, are
 133 skipped.</p>
 134
 135 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 136 <div class="section">
 137 <h2><a name="flag_co" id="flag_co">CO|cookie</a></h2>
 138 <p>The [CO], or [cookie] flag, allows you to set a cookie when a
 139 particular <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code>
 140 matches. The argument consists of three required fields and four optional
 141 fields.</p>
 142
 143 <p>The full syntax for the flag, including all attributes, is as
 144 follows:</p>
 145
 146 <div class="example"><p><code>
 147 [CO=NAME:VALUE:DOMAIN:lifetime:path:secure:httponly]
 148 </code></p></div>
 149
 150 <p>If a literal ':' character is needed in any of the cookie fields, an
 151 alternate syntax is available.  To opt-in to the alternate syntax, the cookie
 152 "Name" should be preceded with a ';' character, and field separators should be
 153 specified as ';'.</p>
 154
 155 <div class="example"><p><code>
 156 [CO=;NAME;VALUE:MOREVALUE;DOMAIN;lifetime;path;secure;httponly]
 157 </code></p></div>
 158
 159 <p>You must declare a name, a value, and a domain for the cookie to be set.</p>
 160
 161 <dl>
 162 <dt>Domain</dt>
 163 <dd>The domain for which you want the cookie to be valid. This may be a
 164 hostname, such as <code>www.example.com</code>, or it may be a domain,
 165 such as <code>.example.com</code>. It must be at least two parts
 166 separated by a dot. That is, it may not be merely <code>.com</code> or
 167 <code>.net</code>. Cookies of that kind are forbidden by the cookie
 168 security model.</dd>
 169 </dl>
 170
 171 <p>You may optionally also set the following values:</p>
 172
 173 <dl>
 174 <dt>Lifetime</dt>
 175 <dd>The time for which the cookie will persist, in minutes.</dd>
 176 <dd>A value of 0 indicates that the cookie will persist only for the
 177 current browser session. This is the default value if none is
 178 specified.</dd>
 179
 180 <dt>Path</dt>
 181 <dd>The path, on the current website, for which the cookie is valid,
 182 such as <code>/customers/</code> or <code>/files/download/</code>.</dd>
 183 <dd>By default, this is set to <code>/</code> - that is, the entire
 184 website.</dd>
 185
 186 <dt>Secure</dt>
 187 <dd>If set to <code>secure</code>, <code>true</code>, or <code>1</code>,
 188 the cookie will only be permitted to be translated via secure (https)
 189 connections.</dd>
 190
 191 <dt>httponly</dt>
 192 <dd>If set to <code>HttpOnly</code>, <code>true</code>, or
 193 <code>1</code>, the cookie will have the <code>HttpOnly</code> flag set,
 194 which means that the cookie is inaccessible to JavaScript code on
 195 browsers that support this feature.</dd>
 196 </dl>
 197
 198 <p>Consider this example:</p>
 199
 200 <pre class="prettyprint lang-config">RewriteEngine On
 201 RewriteRule   "^/index\.html"   "-" [CO=frontdoor:yes:.example.com:1440:/]</pre>
 202
 203
 204 <p>In the example give, the rule doesn't rewrite the request.
 205 The "-" rewrite target tells mod_rewrite to pass the request
 206 through unchanged. Instead, it sets a cookie
 207 called 'frontdoor' to a value of 'yes'. The cookie is valid for any host
 208 in the <code>.example.com</code> domain. It is set to expire in 1440
 209 minutes (24 hours) and is returned for all URIs.</p>
 210
 211 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 212 <div class="section">
 213 <h2><a name="flag_dpi" id="flag_dpi">DPI|discardpath</a></h2>
 214 <p>The DPI flag causes the PATH_INFO portion of the rewritten URI to be
 215 discarded.</p>
 216 <p>This flag is available in version 2.2.12 and later.</p>
 217 <p>In per-directory context, the URI each <code class="directive">RewriteRule</code>
 218 compares against is the concatenation of the current values of the URI
 219 and PATH_INFO.</p>
 220
 221 <p>The current URI can be the initial URI as requested by the client, the
 222 result of a previous round of mod_rewrite processing, or the result of
 223 a prior rule in the current round of mod_rewrite processing.</p>
 224
 225 <p>In contrast, the PATH_INFO that is appended to the URI before each
 226 rule reflects only the value of PATH_INFO before this round of
 227 mod_rewrite processing. As a consequence, if large portions
 228 of the URI are matched and copied into a substitution in multiple
 229 <code class="directive">RewriteRule</code> directives, without regard for
 230 which parts of the URI came from the current PATH_INFO, the final
 231 URI may have multiple copies of PATH_INFO appended to it.</p>
 232
 233 <p>Use this flag on any substitution where the PATH_INFO that resulted
 234 from the previous mapping of this request to the filesystem is not of
 235 interest.  This flag permanently forgets the PATH_INFO established
 236 before this round of mod_rewrite processing began. PATH_INFO will
 237 not be recalculated until the current round of mod_rewrite processing
 238 completes.  Subsequent rules during this round of processing will see
 239 only the direct result of substitutions, without any PATH_INFO
 240 appended.</p>
 241 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 242 <div class="section">
 243 <h2><a name="flag_e" id="flag_e">E|env</a></h2>
 244 <p>With the [E], or [env] flag, you can set the value of an environment
 245 variable. Note that some environment variables may be set after the rule
 246 is run, thus unsetting what you have set. See <a href="../env.html">the
 247 Environment Variables document</a> for more details on how Environment
 248 variables work.</p>
 249
 250 <p>The full syntax for this flag is:</p>
 251
 252 <pre class="prettyprint lang-config">[E=VAR:VAL]
 253 [E=!VAR]</pre>
 254
 255
 256 <p><code>VAL</code> may contain backreferences (<code>$N</code> or
 257 <code>%N</code>) which are expanded.</p>
 258
 259 <p>Using the short form</p>
 260
 261 <div class="example"><p><code>
 262 [E=VAR]
 263 </code></p></div>
 264
 265 <p>you can set the environment variable named <code>VAR</code> to an
 266 empty value.</p>
 267
 268 <p>The form</p>
 269
 270 <div class="example"><p><code>
 271 [E=!VAR]
 272 </code></p></div>
 273
 274 <p>allows to unset a previously set environment variable named
 275 <code>VAR</code>.</p>
 276
 277 <p>Environment variables can then be used in a variety of
 278 contexts, including CGI programs, other RewriteRule directives, or
 279 CustomLog directives.</p>
 280
 281 <p>The following example sets an environment variable called 'image' to a
 282 value of '1' if the requested URI is an image file. Then, that
 283 environment variable is used to exclude those requests from the access
 284 log.</p>
 285
 286 <pre class="prettyprint lang-config">RewriteRule "\.(png|gif|jpg)$"   "-" [E=image:1]
 287 CustomLog   "logs/access_log"    combined env=!image</pre>
 288
 289
 290 <p>Note that this same effect can be obtained using <code class="directive"><a href="../mod/mod_setenvif.html#setenvif">SetEnvIf</a></code>. This technique is offered as
 291 an example, not as a recommendation.</p>
 292 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 293 <div class="section">
 294 <h2><a name="flag_end" id="flag_end">END</a></h2>
 295 <p>Using the [END] flag terminates not only the current round of rewrite
 296 processing (like [L]) but also prevents any subsequent rewrite
 297 processing from occurring in per-directory (htaccess) context.</p>
 298
 299 <p>This does not apply to new requests resulting from external
 300 redirects.</p>
 301 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 302 <div class="section">
 303 <h2><a name="flag_f" id="flag_f">F|forbidden</a></h2>
 304 <p>Using the [F] flag causes the server to return a 403 Forbidden status
 305 code to the client. While the same behavior can be accomplished using
 306 the <code class="directive"><a href="../mod/mod_access_compat.html#deny">Deny</a></code> directive, this
 307 allows more flexibility in assigning a Forbidden status.</p>
 308
 309 <p>The following rule will forbid <code>.exe</code> files from being
 310 downloaded from your server.</p>
 311
 312 <pre class="prettyprint lang-config">RewriteRule "\.exe"   "-" [F]</pre>
 313
 314
 315 <p>This example uses the "-" syntax for the rewrite target, which means
 316 that the requested URI is not modified. There's no reason to rewrite to
 317 another URI, if you're going to forbid the request.</p>
 318
 319 <p>When using [F], an [L] is implied - that is, the response is returned
 320 immediately, and no further rules are evaluated.</p>
 321
 322 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 323 <div class="section">
 324 <h2><a name="flag_g" id="flag_g">G|gone</a></h2>
 325 <p>The [G] flag forces the server to return a 410 Gone status with the
 326 response. This indicates that a resource used to be available, but is no
 327 longer available.</p>
 328
 329 <p>As with the [F] flag, you will typically use the "-" syntax for the
 330 rewrite target when using the [G] flag:</p>
 331
 332 <pre class="prettyprint lang-config">RewriteRule "oldproduct"   "-" [G,NC]</pre>
 333
 334
 335 <p>When using [G], an [L] is implied - that is, the response is returned
 336 immediately, and no further rules are evaluated.</p>
 337
 338 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 339 <div class="section">
 340 <h2><a name="flag_h" id="flag_h">H|handler</a></h2>
 341 <p>Forces the resulting request to be handled with the specified
 342 handler. For example, one might use this to force all files without a
 343 file extension to be parsed by the php handler:</p>
 344
 345 <pre class="prettyprint lang-config">RewriteRule "!\."  "-" [H=application/x-httpd-php]</pre>
 346
 347
 348 <p>
 349 The regular expression above - <code>!\.</code> - will match any request
 350 that does not contain the literal <code>.</code> character.
 351 </p>
 352
 353 <p>This can be also used to force the handler based on some conditions.
 354 For example, the following snippet used in per-server context allows
 355 <code>.php</code> files to be <em>displayed</em> by <code>mod_php</code>
 356 if they are requested with the <code>.phps</code> extension:</p>
 357
 358 <pre class="prettyprint lang-config">RewriteRule "^(/source/.+\.php)s$" "$1" [H=application/x-httpd-php-source]</pre>
 359
 360
 361 <p>The regular expression above - <code>^(/source/.+\.php)s$</code> - will
 362 match any request that starts with <code>/source/</code> followed by 1 or
 363 n characters followed by <code>.phps</code> literally. The backreference
 364 $1 referrers to the captured match within parenthesis of the regular
 365 expression.</p>
 366 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 367 <div class="section">
 368 <h2><a name="flag_l" id="flag_l">L|last</a></h2>
 369 <p>The [L] flag causes <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> to stop processing
 370 the rule set. In most contexts, this means that if the rule matches, no
 371 further rules will be processed. This corresponds to the
 372 <code>last</code> command in Perl, or the <code>break</code> command in
 373 C. Use this flag to indicate that the current rule should be applied
 374 immediately without considering further rules.</p>
 375
 376 <p>If you are using <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> in either
 377 <code>.htaccess</code> files or in
 378 <code class="directive"><a href="../mod/core.html#directory">&lt;Directory&gt;</a></code> sections,
 379 it is important to have some understanding of how the rules are
 380 processed.  The simplified form of this is that once the rules have been
 381 processed, the rewritten request is handed back to the URL parsing
 382 engine to do what it may with it. It is possible that as the rewritten
 383 request is handled, the <code>.htaccess</code> file or
 384 <code class="directive"><a href="../mod/core.html#directory">&lt;Directory&gt;</a></code> section
 385 may be encountered again, and thus the ruleset may be run again from the
 386 start. Most commonly this will happen if one of the rules causes a
 387 redirect - either internal or external - causing the request process to
 388 start over.</p>
 389
 390 <p>It is therefore important, if you are using <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> directives in one of these
 391 contexts, that you take explicit steps to avoid rules looping, and not
 392 count solely on the [L] flag to terminate execution of a series of
 393 rules, as shown below.</p>
 394
 395 <p> An alternative flag, [END], can be used to terminate not only the
 396 current round of rewrite processing but prevent any subsequent
 397 rewrite processing from occurring in per-directory (htaccess)
 398 context. This does not apply to new requests resulting from external
 399 redirects.</p>
 400
 401 <p>The example given here will rewrite any request to
 402 <code>index.php</code>, giving the original request as a query string
 403 argument to <code>index.php</code>, however, the <code class="directive"><a href="../mod/mod_rewrite.html#rewritecond">RewriteCond</a></code> ensures that if the request
 404 is already for <code>index.php</code>, the <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> will be skipped.</p>
 405
 406 <pre class="prettyprint lang-config">RewriteBase "/"
 407 RewriteCond "%{REQUEST_URI}" !=/index.php
 408 RewriteRule "^(.*)"          "/index.php?req=$1" [L,PT]</pre>
 409
 410 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 411 <div class="section">
 412 <h2><a name="flag_n" id="flag_n">N|next</a></h2>
 413 <p>
 414 The [N] flag causes the ruleset to start over again from the top, using
 415 the result of the ruleset so far as a starting point. Use
 416 with extreme caution, as it may result in loop.
 417 </p>
 418 <p>
 419 The [Next] flag could be used, for example, if you wished to replace a
 420 certain string or letter repeatedly in a request. The example shown here
 421 will replace A with B everywhere in a request, and will continue doing
 422 so until there are no more As to be replaced.
 423 </p>
 424 <pre class="prettyprint lang-config">RewriteRule "(.*)A(.*)" "$1B$2" [N]</pre>
 425
 426 <p>You can think of this as a <code>while</code> loop: While this
 427 pattern still matches (i.e., while the URI still contains an
 428 <code>A</code>), perform this substitution (i.e., replace the
 429 <code>A</code> with a <code>B</code>).</p>
 430
 431 <p>In 2.5.0 and later, this module returns an error after 10,000 iterations to
 432 protect against unintended looping.  An alternative maximum number of
 433 iterations can be specified by adding to the N flag.  </p>
 434 <pre class="prettyprint lang-config"># Be willing to replace 1 character in each pass of the loop
 435 RewriteRule "(.+)[&gt;&lt;;]$" "$1" [N=32000]
 436 # ... or, give up if after 10 loops
 437 RewriteRule "(.+)[&gt;&lt;;]$" "$1" [N=10]</pre>
 438
 439
 440 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 441 <div class="section">
 442 <h2><a name="flag_nc" id="flag_nc">NC|nocase</a></h2>
 443 <p>Use of the [NC] flag causes the <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> to be matched in a
 444 case-insensitive manner. That is, it doesn't care whether letters appear
 445 as upper-case or lower-case in the matched URI.</p>
 446
 447 <p>In the example below, any request for an image file will be proxied
 448 to your dedicated image server. The match is case-insensitive, so that
 449 <code>.jpg</code> and <code>.JPG</code> files are both acceptable, for
 450 example.</p>
 451
 452 <pre class="prettyprint lang-config">RewriteRule "(.*\.(jpg|gif|png))$" "http://images.example.com$1" [P,NC]</pre>
 453
 454 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 455 <div class="section">
 456 <h2><a name="flag_ne" id="flag_ne">NE|noescape</a></h2>
 457 <p>By default, special characters, such as <code>&amp;</code> and
 458 <code>?</code>, for example, will be converted to their hexcode
 459 equivalent. Using the [NE] flag prevents that from happening.
 460 </p>
 461
 462 <pre class="prettyprint lang-config">RewriteRule "^/anchor/(.+)" "/bigpage.html#$1" [NE,R]</pre>
 463
 464
 465 <p>
 466 The above example will redirect <code>/anchor/xyz</code> to
 467 <code>/bigpage.html#xyz</code>. Omitting the [NE] will result in the #
 468 being converted to its hexcode equivalent, <code>%23</code>, which will
 469 then result in a 404 Not Found error condition.
 470 </p>
 471
 472 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 473 <div class="section">
 474 <h2><a name="flag_ns" id="flag_ns">NS|nosubreq</a></h2>
 475 <p>Use of the [NS] flag prevents the rule from being used on
 476 subrequests. For example, a page which is included using an SSI (Server
 477 Side Include) is a subrequest, and you may want to avoid rewrites
 478 happening on those subrequests. Also, when <code class="module"><a href="../mod/mod_dir.html">mod_dir</a></code>
 479 tries to find out information about possible directory default files
 480 (such as <code>index.html</code> files), this is an internal
 481 subrequest, and you often want to avoid rewrites on such subrequests.
 482 On subrequests, it is not always useful, and can even cause errors, if
 483 the complete set of rules are applied. Use this flag to exclude
 484 problematic rules.</p>
 485
 486 <p>To decide whether or not to use this rule: if you prefix URLs with
 487 CGI-scripts, to force them to be processed by the CGI-script, it's
 488 likely that you will run into problems (or significant overhead)
 489 on sub-requests. In these cases, use this flag.</p>
 490
 491 <p>
 492 Images, javascript files, or css files, loaded as part of an HTML page,
 493 are not subrequests - the browser requests them as separate HTTP
 494 requests.
 495 </p>
 496 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 497 <div class="section">
 498 <h2><a name="flag_p" id="flag_p">P|proxy</a></h2>
 499 <p>Use of the [P] flag causes the request to be handled by
 500 <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>, and handled via a proxy request. For
 501 example, if you wanted all image requests to be handled by a back-end
 502 image server, you might do something like the following:</p>
 503
 504 <pre class="prettyprint lang-config">RewriteRule "/(.*)\.(jpg|gif|png)$" "http://images.example.com/$1.$2" [P]</pre>
 505
 506
 507 <p>Use of the [P] flag implies [L] - that is, the request is immediately
 508 pushed through the proxy, and any following rules will not be
 509 considered.</p>
 510
 511 <p>
 512 You must make sure that the substitution string is a valid URI
 513 (typically starting with <code>http://</code><em>hostname</em>) which can be
 514 handled by the <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>. If not, you will get an
 515 error from the proxy module. Use this flag to achieve a
 516 more powerful implementation of the <code class="directive"><a href="../mod/mod_proxy.html#proxypass">ProxyPass</a></code> directive,
 517 to map remote content into the namespace of the local server.</p>
 518
 519 <div class="warning">
 520 <h3>Security Warning</h3>
 521 <p>Take care when constructing the target URL of the rule, considering
 522 the security impact from allowing the client influence over the set of
 523 URLs to which your server will act as a proxy.  Ensure that the scheme
 524 and hostname part of the URL is either fixed, or does not allow the
 525 client undue influence.</p>
 526 </div>
 527
 528 <div class="warning">
 529 <h3>Performance warning</h3>
 530 <p>Using this flag triggers the use of <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>, without handling of persistent connections. This
 531 means the performance of your proxy will be better if you set it up with <code class="directive"><a href="../mod/mod_proxy.html#proxypass">ProxyPass</a></code> or
 532 <code class="directive"><a href="../mod/mod_proxy.html#proxypassmatch">ProxyPassMatch</a></code></p>
 533 <p>This is because this flag triggers the use of the default worker, which does not handle connection pooling.</p>
 534 <p>Avoid using this flag and prefer those directives, whenever you can.</p>
 535 </div>
 536
 537 <p>Note: <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> must be enabled in order
 538 to use this flag.</p>
 539
 540 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 541 <div class="section">
 542 <h2><a name="flag_pt" id="flag_pt">PT|passthrough</a></h2>
 543
 544 <p>
 545 The target (or substitution string) in a RewriteRule is assumed to be a
 546 file path, by default. The use of the [PT] flag causes it to be treated
 547 as a URI instead. That is to say, the
 548 use of the [PT] flag causes the result of the <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> to be passed back through
 549 URL mapping, so that location-based mappings, such as <code class="directive"><a href="../mod/mod_alias.html#alias">Alias</a></code>, <code class="directive"><a href="../mod/mod_alias.html#redirect">Redirect</a></code>, or <code class="directive"><a href="../mod/mod_alias.html#scriptalias">ScriptAlias</a></code>, for example, might have a
 550 chance to take effect.
 551 </p>
 552
 553 <p>
 554 If, for example, you have an
 555 <code class="directive"><a href="../mod/mod_alias.html#alias">Alias</a></code>
 556 for /icons, and have a <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> pointing there, you should
 557 use the [PT] flag to ensure that the
 558 <code class="directive"><a href="../mod/mod_alias.html#alias">Alias</a></code> is evaluated.
 559 </p>
 560
 561 <pre class="prettyprint lang-config">Alias "/icons" "/usr/local/apache/icons"
 562 RewriteRule "/pics/(.+)\.jpg$" "/icons/$1.gif" [PT]</pre>
 563
 564
 565 <p>
 566 Omission of the [PT] flag in this case will cause the Alias to be
 567 ignored, resulting in a 'File not found' error being returned.
 568 </p>
 569
 570 <p>The <code>PT</code> flag implies the <code>L</code> flag:
 571 rewriting will be stopped in order to pass the request to
 572 the next phase of processing.</p>
 573
 574 <p>Note that the <code>PT</code> flag is implied in per-directory
 575 contexts such as
 576 <code class="directive"><a href="../mod/core.html#directory">&lt;Directory&gt;</a></code> sections
 577 or in <code>.htaccess</code> files. The only way to circumvent that
 578 is to rewrite to <code>-</code>.</p>
 579
 580 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 581 <div class="section">
 582 <h2><a name="flag_qsa" id="flag_qsa">QSA|qsappend</a></h2>
 583 <p>
 584 When the replacement URI contains a query string, the default behavior
 585 of <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> is to discard
 586 the existing query string, and replace it with the newly generated one.
 587 Using the [QSA] flag causes the query strings to be combined.
 588 </p>
 589
 590 <p>Consider the following rule:</p>
 591
 592 <pre class="prettyprint lang-config">RewriteRule "/pages/(.+)" "/page.php?page=$1" [QSA]</pre>
 593
 594
 595 <p>With the [QSA] flag, a request for <code>/pages/123?one=two</code> will be
 596 mapped to <code>/page.php?page=123&amp;one=two</code>. Without the [QSA]
 597 flag, that same request will be mapped to
 598 <code>/page.php?page=123</code> - that is, the existing query string
 599 will be discarded.
 600 </p>
 601 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 602 <div class="section">
 603 <h2><a name="flag_qsd" id="flag_qsd">QSD|qsdiscard</a></h2>
 604 <p>
 605 When the requested URI contains a query string, and the target URI does
 606 not, the default behavior of <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> is to copy that query
 607 string to the target URI. Using the [QSD] flag causes the query string
 608 to be discarded.
 609 </p>
 610
 611 <p>This flag is available in version 2.4.0 and later.</p>
 612
 613 <p>
 614 Using [QSD] and [QSA] together will result in [QSD] taking precedence.
 615 </p>
 616
 617 <p>
 618 If the target URI has a query string, the default behavior will be
 619 observed - that is, the original query string will be discarded and
 620 replaced with the query string in the <code>RewriteRule</code> target
 621 URI.
 622 </p>
 623
 624 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 625 <div class="section">
 626 <h2><a name="flag_qsl" id="flag_qsl">QSL|qslast</a></h2>
 627 <p>
 628 By default, the first (left-most) question mark in the substitution
 629 delimits the path from the query string.  Using the [QSL] flag instructs
 630 <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> to instead split
 631 the two components using the last (right-most) question mark.  </p>
 632
 633 <p>
 634 This is useful when mapping to files that have literal question marks in
 635 their filename.  If no query string is used in the substitution,
 636 a question mark can be appended to it in combination with this flag.  </p>
 637
 638 <p> This flag is available in version 2.4.19 and later.</p>
 639
 640 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 641 <div class="section">
 642 <h2><a name="flag_r" id="flag_r">R|redirect</a></h2>
 643 <p>
 644 Use of the [R] flag causes a HTTP redirect to be issued to the browser.
 645 If a fully-qualified URL is specified (that is, including
 646 <code>http://servername/</code>) then a redirect will be issued to that
 647 location. Otherwise, the current protocol, servername, and port number
 648 will be used to generate the URL sent with the redirect.
 649 </p>
 650
 651 <p>
 652 <em>Any</em> valid HTTP response  status code may be specified,
 653 using the syntax [R=305], with a 302 status code being used by
 654 default if none is specified. The status code specified need not
 655 necessarily be a redirect (3xx) status code. However,
 656 if a status code is outside the redirect range (300-399) then the
 657 substitution string is dropped entirely, and rewriting is stopped as if
 658 the <code>L</code> were used.</p>
 659
 660 <p>In addition to response status codes, you may also specify redirect
 661 status using their symbolic names: <code>temp</code> (default),
 662 <code>permanent</code>, or <code>seeother</code>.</p>
 663
 664 <p>
 665 You will almost always want to use [R] in conjunction with [L] (that is,
 666 use [R,L]) because on its own, the [R] flag prepends
 667 <code>http://thishost[:thisport]</code> to the URI, but then passes this
 668 on to the next rule in the ruleset, which can often result in 'Invalid
 669 URI in request' warnings.
 670 </p>
 671
 672 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 673 <div class="section">
 674 <h2><a name="flag_s" id="flag_s">S|skip</a></h2>
 675 <p>The [S] flag is used to skip rules that you don't want to run. The
 676 syntax of the skip flag is [S=<em>N</em>], where <em>N</em> signifies
 677 the number of rules to skip (provided the <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">
 678 RewriteRule</a></code> and any preceding <code class="directive"><a href="../mod/mod_rewrite.html#rewritecond">
 679 RewriteCond</a></code> directives match). This can be thought of as a
 680 <code>goto</code> statement in your rewrite ruleset. In the following
 681 example, we only want to run the <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">
 682 RewriteRule</a></code> if the requested URI doesn't correspond with an
 683 actual file.</p>
 684
 685 <pre class="prettyprint lang-config"># Is the request for a non-existent file?
 686 RewriteCond "%{REQUEST_FILENAME}" !-f
 687 RewriteCond "%{REQUEST_FILENAME}" !-d
 688 # If so, skip these two RewriteRules
 689 RewriteRule ".?"                  "-" [S=2]
 690
 691 RewriteRule "(.*\.gif)"           "images.php?$1"
 692 RewriteRule "(.*\.html)"          "docs.php?$1"</pre>
 693
 694
 695 <p>This technique is useful because a <code class="directive"><a href="../mod/mod_rewrite.html#rewritecond">RewriteCond</a></code> only applies to the
 696 <code class="directive"><a href="../mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> immediately
 697 following it. Thus, if you want to make a <code>RewriteCond</code> apply
 698 to several <code>RewriteRule</code>s, one possible technique is to
 699 negate those conditions and add a <code>RewriteRule</code> with a [Skip] flag. You can
 700 use this to make pseudo if-then-else constructs: The last rule of
 701 the then-clause becomes <code>skip=N</code>, where N is the
 702 number of rules in the else-clause:</p>
 703 <pre class="prettyprint lang-config"># Does the file exist?
 704 RewriteCond "%{REQUEST_FILENAME}" !-f
 705 RewriteCond "%{REQUEST_FILENAME}" !-d
 706 # Create an if-then-else construct by skipping 3 lines if we meant to go to the "else" stanza.
 707 RewriteRule ".?"                  "-" [S=3]
 708
 709 # IF the file exists, then:
 710     RewriteRule "(.*\.gif)"  "images.php?$1"
 711     RewriteRule "(.*\.html)" "docs.php?$1"
 712     # Skip past the "else" stanza.
 713     RewriteRule ".?"         "-" [S=1]
 714 # ELSE...
 715     RewriteRule "(.*)"       "404.php?file=$1"
 716 # END</pre>
 717
 718
 719 <p>It is probably easier to accomplish this kind of configuration using
 720 the <code class="directive">&lt;If&gt;</code>, <code class="directive">&lt;ElseIf&gt;</code>, and <code class="directive">&lt;Else&gt;</code> directives instead.</p>
 721
 722 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 723 <div class="section">
 724 <h2><a name="flag_t" id="flag_t">T|type</a></h2>
 725 <p>Sets the MIME type with which the resulting response will be
 726 sent. This has the same effect as the <code class="directive"><a href="../mod/mod_mime.html#addtype">AddType</a></code> directive.</p>
 727
 728 <p>For example, you might use the following technique to serve Perl
 729 source code as plain text, if requested in a particular way:</p>
 730
 731 <pre class="prettyprint lang-config"># Serve .pl files as plain text
 732 RewriteRule "\.pl$"  "-" [T=text/plain]</pre>
 733
 734
 735 <p>Or, perhaps, if you have a camera that produces jpeg images without
 736 file extensions, you could force those images to be served with the
 737 correct MIME type by virtue of their file names:</p>
 738
 739 <pre class="prettyprint lang-config"># Files with 'IMG' in the name are jpg images.
 740 RewriteRule "IMG"  "-" [T=image/jpg]</pre>
 741
 742
 743 <p>Please note that this is a trivial example, and could be better done
 744 using <code class="directive"><a href="../mod/core.html#filesmatch">&lt;FilesMatch&gt;</a></code>
 745 instead. Always consider the alternate
 746 solutions to a problem before resorting to rewrite, which will
 747 invariably be a less efficient solution than the alternatives.</p>
 748
 749 <p>
 750 If used in per-directory context, use only <code>-</code> (dash)
 751 as the substitution <em>for the entire round of mod_rewrite processing</em>,
 752 otherwise the MIME-type set with this flag is lost due to an internal
 753 re-processing (including subsequent rounds of mod_rewrite processing).
 754 The <code>L</code> flag can be useful in this context to end the
 755 <em>current</em> round of mod_rewrite processing.</p>
 756
 757 </div></div>
 758 <div class="bottomlang">
 759 <p><span>Available Languages: </span><a href="../en/rewrite/flags.html" title="English">&nbsp;en&nbsp;</a> |
 760 <a href="../fr/rewrite/flags.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a></p>
 761 </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&amp;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>
 762 <script type="text/javascript"><!--//--><![CDATA[//><!--
 763 var comments_shortname = 'httpd';
 764 var comments_identifier = 'http://httpd.apache.org/docs/trunk/rewrite/flags.html';
 765 (function(w, d) {
 766     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 767         d.write('<div id="comments_thread"><\/div>');
 768         var s = d.createElement('script');
 769         s.type = 'text/javascript';
 770         s.async = true;
 771         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 772         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 773     }
 774     else {
 775         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 776     }
 777 })(window, document);
 778 //--><!]]></script></div><div id="footer">
 779 <p class="apache">Copyright 2016 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>
 780 <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[//><!--
 781 if (typeof(prettyPrint) !== 'undefined') {
 782     prettyPrint();
 783 }
 784 //--><!]]></script>
 785 </body></html>