mod_rewrite - Apache HTTP Server

Example

-      LogLevel alert rewrite:trace3
-

Example

LogLevel alert rewrite:trace3

RewriteLog

@@ -139,15 +137,13 @@ URLs on the fly since the resource was not relative to the document root. This misconfiguration would normally cause the server to look for an "opt" directory under the document root.

-DocumentRoot /var/www/example.com
+DocumentRoot /var/www/example.com
 Alias /myapp /opt/myapp-1.2.3
 <Directory /opt/myapp-1.2.3>
     RewriteEngine On
     RewriteBase /myapp/
     RewriteRule ^index\.html$  welcome.html 
-</Directory>
-
+</Directory>

@@ -213,26 +209,30 @@ Alias /myapp /opt/myapp-1.2.3 - HTTP_USER_AGENT
- HTTP_REFERER
+ HTTP_ACCEPT
HTTP_COOKIE
HTTP_FORWARDED
HTTP_HOST
HTTP_PROXY_CONNECTION
- HTTP_ACCEPT
+ HTTP_REFERER
+ HTTP_USER_AGENT
+ AUTH_TYPE
+ CONN_REMOTE_ADDR
+ CONTEXT_PREFIX
+ CONTEXT_DOCUMENT_ROOT
+ IPV6
+ PATH_INFO
+ QUERY_STRING
REMOTE_ADDR
REMOTE_HOST
+ REMOTE_IDENT
REMOTE_PORT
REMOTE_USER
- REMOTE_IDENT
REQUEST_METHOD
SCRIPT_FILENAME
- PATH_INFO
- QUERY_STRING
- AUTH_TYPE
@@ -245,9 +245,11 @@ Alias /myapp /opt/myapp-1.2.3 DOCUMENT_ROOT
+ SCRIPT_GROUP
+ SCRIPT_USER
+ SERVER_ADDR
SERVER_ADMIN
SERVER_NAME
- SERVER_ADDR
SERVER_PORT
SERVER_PROTOCOL
SERVER_SOFTWARE
@@ -266,12 +268,14 @@ Alias /myapp /opt/myapp-1.2.3 API_VERSION
- THE_REQUEST
- REQUEST_URI
- REQUEST_FILENAME
- IS_SUBREQ
+ CONN_REMOTE_ADDR
HTTPS
+ IS_SUBREQ
+ REMOTE_ADDR
+ REQUEST_FILENAME
REQUEST_SCHEME
+ REQUEST_URI
+ THE_REQUEST
@@ -280,8 +284,8 @@ Alias /myapp /opt/myapp-1.2.3 correspond to the similarly named HTTP MIME-headers, C variables of the Apache HTTP Server or struct tm fields of the Unix system. - Most are documented elsewhere in the Manual or in - the CGI specification.

+ Most are documented here + or elsewhere in the Manual or in the CGI specification.

SERVER_NAME and SERVER_PORT depend on the values of UseCanonicalName and @@ -291,14 +295,6 @@ Alias /myapp /opt/myapp-1.2.3

Those that are special to mod_rewrite include those below.

IS_SUBREQ: Will contain the text "true" if the request - currently being processed is a sub-request, - "false" otherwise. Sub-requests may be generated - by modules that need to resolve additional files - or URIs in order to complete their tasks.
API_VERSION: This is the version of the Apache httpd module API @@ -310,21 +306,30 @@ Alias /myapp /opt/myapp-1.2.3 instance, it is 19990320:10), but is mainly of interest to module authors.
THE_REQUEST
CONN_REMOTE_ADDR: The full HTTP request line sent by the - browser to the server (e.g., "GET - /index.html HTTP/1.1"). This does not - include any additional headers sent by the - browser. This value has not been unescaped - (decoded), unlike most other variables below.; Since 2.4.8: The peer IP address of the connection (see the + mod_remoteip module).
REQUEST_URI
HTTPS: The path component of the requested URI, - such as "/index.html". This notably excludes the - query string which is available as as its own variable - named QUERY_STRING.; Will contain the text "on" if the connection is + using SSL/TLS, or "off" otherwise. (This variable + can be safely used regardless of whether or not + mod_ssl is loaded).
IS_SUBREQ: Will contain the text "true" if the request + currently being processed is a sub-request, + "false" otherwise. Sub-requests may be generated + by modules that need to resolve additional files + or URIs in order to complete their tasks.
REMOTE_ADDR: The IP address of the remote host (see the + mod_remoteip module).
REQUEST_FILENAME
HTTPS: Will contain the text "on" if the connection is - using SSL/TLS, or "off" otherwise. (This variable - can be safely used regardless of whether or not - mod_ssl is loaded).
REQUEST_SCHEME: Will contain the scheme of the request (ususally +; Will contain the scheme of the request (usually "http" or "https"). This value can be influenced with ServerName.
REQUEST_URI: The path component of the requested URI, + such as "/index.html". This notably excludes the + query string which is available as as its own variable + named QUERY_STRING.
THE_REQUEST: The full HTTP request line sent by the + browser to the server (e.g., "GET + /index.html HTTP/1.1"). This does not + include any additional headers sent by the + browser. This value has not been unescaped + (decoded), unlike most other variables below.

If the TestString has the special value expr, the - CondPattern will be treated as an - ap_expr.

If the TestString has the special value expr, + the CondPattern will be treated as an + ap_expr. HTTP headers referenced in the + expression will be added to the Vary header if the novary + flag is not given.

Other things you should be aware of:

@@ -405,7 +425,7 @@ Alias /myapp /opt/myapp-1.2.3 the value of the HTTP header ``Proxy-Connection:''.

If a HTTP header is used in a condition this header is added to - the Vary header of the response in case the condition evaluates to + the Vary header of the response in case the condition evaluates to true for the request. It is not added if the condition evaluates to false for the request. Adding the HTTP header to the Vary header of the response is needed for proper caching.

@@ -414,7 +434,8 @@ Alias /myapp /opt/myapp-1.2.3 so that certain conditions might not be evaluated at all.

- %{LA-U:variable} can be used for look-aheads which perform + %{LA-U:variable} + can be used for look-aheads which perform an internal (URL-based) sub-request to determine the final value of variable. This can be used to access variable for rewriting which is not available at the current @@ -586,13 +607,18 @@ Alias /myapp /opt/myapp-1.2.3 whether or not it exists, and is a regular file with size greater than zero.

'-U' (is existing URL, via +

'-U' (is existing URL, via subrequest)
Checks whether or not TestString is a valid URL, accessible via all the server's currently-configured access controls for that path. This uses an internal subrequest to do the check, so use it with care - - it can impact your server's performance!

+ it can impact your server's performance!

This flag only returns information about things + like access control, authentication, and authorization. This flag + does not return information about the status code the + configured handler (static file, CGI, proxy, etc.) would have + returned.

'-x' (has executable permissions)
@@ -621,10 +647,8 @@ Alias /myapp /opt/myapp-1.2.3 to block unwanted hotlinking.

-           RewriteCond expr "! %{HTTP_REFERER} -strmatch '*://%{HTTP_HOST}/*'"

-           RewriteRule ^/images - [F]
-

           RewriteCond expr "! %{HTTP_REFERER} -strmatch '*://%{HTTP_HOST}/*'"

+           RewriteRule ^/images - [F]

@@ -651,12 +675,10 @@ Alias /myapp /opt/myapp-1.2.3 Use this to combine rule conditions with a local OR instead of the implicit AND. Typical example: -

-RewriteCond %{REMOTE_HOST}  ^host1  [OR]
+RewriteCond %{REMOTE_HOST}  ^host1  [OR]
 RewriteCond %{REMOTE_HOST}  ^host2  [OR]
 RewriteCond %{REMOTE_HOST}  ^host3
-RewriteRule ...some special stuff for any of these hosts...
-
+RewriteRule ...some special stuff for any of these hosts...

Without this flag you would have to write the condition/rule @@ -682,27 +704,17 @@ RewriteRule ...some special stuff for any of these hosts... ``User-Agent:'' header of the request, you can use the following:

-RewriteCond  %{HTTP_USER_AGENT}  ^Mozilla
-RewriteRule  ^/$                 /homepage.max.html  [L]
+RewriteCond  %{HTTP_USER_AGENT}  (iPhone|Blackberry|Android)
+RewriteRule  ^/$                 /homepage.mobile.html  [L]
 
-RewriteCond  %{HTTP_USER_AGENT}  ^Lynx
-RewriteRule  ^/$                 /homepage.min.html  [L]
-
-RewriteRule  ^/$                 /homepage.std.html  [L]
-
+RewriteRule  ^/$                 /homepage.std.html  [L]

Explanation: If you use a browser which identifies itself - as 'Mozilla' (including Netscape Navigator, Mozilla etc), then you - get the max homepage (which could include frames, or other special - features). - If you use the Lynx browser (which is terminal-based), then - you get the min homepage (which could be a version designed for - easy, text-only browsing). - If neither of these conditions apply (you use any other browser, - or your browser identifies itself as something non-standard), you get - the std (standard) homepage.

+ as a mobile browser (note that the example is incomplete, as + there are many other mobile platforms), the mobile version of + the homepage is served. Otherwise, the standard page is served. +

Use this directive to disable the module instead of - commenting out all the RewriteRule directives!

Use this directive to disable rules in a particular context, + rather than commenting out all the RewriteRule directives.

Note that rewrite configurations are not inherited by virtual hosts. This means that you need to have a @@ -747,8 +759,6 @@ RewriteRule ^/$ /homepage.std.html [L] Context:server config, virtual host Status:Extension Module:mod_rewrite -Compatibility:The choice of different dbm types is available in -Apache HTTP Server 2.0.41 and later

The RewriteMap directive defines a Rewriting Map which can be used inside rule @@ -781,17 +791,13 @@ Apache HTTP Server 2.0.41 and later

The following combinations for MapType and @@ -839,8 +845,6 @@ Apache HTTP Server 2.0.41 and later Override:FileInfo Status:Extension Module:mod_rewrite -Compatibility:MaxRedirects is no longer available in version 2.1 and -later

Pattern is a perl compatible regular expression. On the first RewriteRule, it is matched against - the (%-decoded) URL-path (or - file-path, depending + the (%-decoded) URL-path (or + file-path, depending on the context) of the request. Subsequent patterns are matched against the output of the last matching RewriteRule.

Flag and syntax	Function
B	Escape non-alphanumeric characters before applying - the transformation. details ...	Escape non-alphanumeric characters in backreferences before + applying the transformation. details ...
backrefnoplus\|BNP	If backreferences are being escaped, spaces should be escaped to + %20 instead of +. Useful when the backreference will be used in the + path component rather than the query string.details ...
chain\|C	Rule is chained to the following rule. If the rule fails, the rule(s) chained to it will be skipped. details ...
cookie\|CO=NAME:VAL	Sets a cookie in the client browser. Full syntax is: CO=NAME:VAL:domain[:lifetime[:path[:secure[:httponly]]]] details ...
discardpath\|DPI	Causes the PATH_INFO portion of the rewritten URI to be discarded. details ...
END	Stop the rewriting process immediately and don't apply any + more rules. Also prevents further execution of rewrite rules + in per-directory and .htaccess context. (Available in 2.3.9 and later) + details ...
env\|E=[!]VAR[:VAL]	Causes an environment variable VAR to be set (to the value VAL if provided). The form !VAR causes - the environment variable VAR to be unset.details ...
forbidden\|F	Returns a 403 FORBIDDEN response to the client browser. details ...
gone\|G	Returns a 410 GONE response to the client browser. details ...
Handler\|H=Content-handler	Causes the resulting URI to be sent to the specified Content-handler for processing. details ...
last\|L	Stop the rewriting process immediately and don't apply any more rules. Especially note caveats for per-directory and .htaccess context (see also the END flag). details ...
next\|N	Re-run the rewriting process, starting again with the first rule, using the result of the ruleset so far as a starting point. details ...
nocase\|NC	Makes the pattern comparison case-insensitive. details ...
noescape\|NE	Prevent mod_rewrite from applying hexcode escaping of special characters in the result of the rewrite. details ...
nosubreq\|NS	Causes a rule to be skipped if the current request is an internal sub-request. details ...
proxy\|P	Force the substitution URL to be internally sent as a proxy request. details ...
passthrough\|PT	Forces the resulting URI to be passed back to the URL mapping engine for processing of other URI-to-filename translators, such as `Alias` or `Redirect`. details ...
qsappend\|QSA	Appends any query string from the original request URL to any query string created in the rewrite target.details ...
qsdiscard\|QSD	Discard any query string attached to the incoming URI. details ...
redirect\|R[=code]	Forces an external redirect, optionally with the specified HTTP status code. details ...
END	Stop the rewriting process immediately and don't apply any - more rules. Also prevents further execution of rewrite rules - in per-directory and .htaccess context. (Available in 2.3.9 and later) - details ...
skip\|S=num	Tells the rewriting engine to skip the next num rules if the current rule matches. details ...
type\|T=MIME-type	Force the MIME-type of the target file to be the specified type. details ...

Home directory expansion

When the substitution string begins with a string @@ -1246,68 +1326,55 @@ directive.

/somepath/pathinfo'':

- - +

- - - + - - - + - - - + - - - + - - - + - - - + @@ -1315,80 +1382,65 @@ directive.

Inside per-directory configuration for /somepath
- (/physical/path/to/somepath/.htacccess, with + (/physical/path/to/somepath/.htaccess, with RewriteBase /somepath)
for request ``GET /somepath/localpath/pathinfo'':

Given Rule	Resulting Substitution
^/somepath(.*) otherpath$1	invalid, not supported
^/somepath(.*) otherpath$1 [R]	invalid, not supported
^/somepath(.*) otherpath$1 [P]	invalid, not supported
^/somepath(.*) /otherpath$1	/otherpath/pathinfo
^/somepath(.*) /otherpath$1 [R]	http://thishost/otherpath/pathinfo via external redirection
^/somepath(.*) /otherpath$1 [P]	doesn't make sense, not supported
^/somepath(.*) http://thishost/otherpath$1	/otherpath/pathinfo
^/somepath(.*) http://thishost/otherpath$1 [R]	http://thishost/otherpath/pathinfo via external redirection
^/somepath(.*) http://thishost/otherpath$1 [P]	doesn't make sense, not supported
^/somepath(.*) http://otherhost/otherpath$1	http://otherhost/otherpath/pathinfo via external redirection
^/somepath(.*) http://otherhost/otherpath$1 [R]	http://otherhost/otherpath/pathinfo via external redirection (the [R] flag is redundant)
^/somepath(.*) http://otherhost/otherpath$1 [P]	http://otherhost/otherpath/pathinfo via internal proxy

- - +

- - - + - - - + - - - + - - - + - - - + - - - + -

Given Rule	Resulting Substitution
^localpath(.*) otherpath$1	/somepath/otherpath/pathinfo
^localpath(.*) otherpath$1 [R]	http://thishost/somepath/otherpath/pathinfo via external redirection
^localpath(.*) otherpath$1 [P]	doesn't make sense, not supported
^localpath(.*) /otherpath$1	/otherpath/pathinfo
^localpath(.*) /otherpath$1 [R]	http://thishost/otherpath/pathinfo via external redirection
^localpath(.*) /otherpath$1 [P]	doesn't make sense, not supported
^localpath(.*) http://thishost/otherpath$1	/otherpath/pathinfo
^localpath(.*) http://thishost/otherpath$1 [R]	http://thishost/otherpath/pathinfo via external redirection
^localpath(.*) http://thishost/otherpath$1 [P]	doesn't make sense, not supported
^localpath(.*) http://otherhost/otherpath$1	http://otherhost/otherpath/pathinfo via external redirection
^localpath(.*) http://otherhost/otherpath$1 [R]	http://otherhost/otherpath/pathinfo via external redirection (the [R] flag is redundant)
^localpath(.*) http://otherhost/otherpath$1 [P]	http://otherhost/otherpath/pathinfo via internal proxy

@@ -1397,26 +1449,27 @@ redirection

Available Languages: en | fr

Comments

This section is experimental!
Comments placed here should not be expected -to last beyond the testing phase of this system, nor do we in any way guarantee that we'll read them.

Comments

Notice:
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 mailing lists.

Example

Example

RewriteLog

Security Warning

Home directory expansion

Comments

Comments