Description: | Provides a rule-based rewriting engine to rewrite requestedURLs on the fly |
---|---|
Status: | Extension |
Module Identifier: | rewrite_module |
Source File: | mod_rewrite.c |
Themod_rewrite
module uses a rule-based rewriting engine, based on a PCRE regular-expression parser, to rewrite requested URLs on the fly. By default,mod_rewrite
maps a URL to a filesystem path. However, it can also be used to redirect one URL to another URL, or to invoke an internal proxy fetch.
mod_rewrite
provides a flexible and powerful way to manipulate URLs using an unlimited number of rules. Each rule can have an unlimited number of attached rule conditions, to allow you to rewrite URL based on server variables, environment variables, HTTP headers, or time stamps.
mod_rewrite
operates on the full URL path, including the path-info section. A rewrite rule can be invoked inhttpd.conf
or in.htaccess
. The path generated by a rewrite rule can include a query string, or can lead to internal sub-processing, external request redirection, or internal proxy throughput.
Further details, discussion, and examples, are provided in thedetailed mod_rewrite documentation.
mod_rewrite
offers detailed logging of its actions at thetrace1
totrace8
log levels. The log level can be set specifically formod_rewrite
using theLogLevel
directive: Up to leveldebug
, no actions are logged, whiletrace8
means that practically all actions are logged.
mod_rewrite
will slow down your Apache HTTP Server dramatically! Use a log level higher thantrace2
only for debugging!LogLevel alert rewrite:trace3
Those familiar with earlier versions ofmod_rewrite
will no doubt be looking for theRewriteLog
andRewriteLogLevel
directives. This functionality has been completely replaced by the new per-module logging configuration mentioned above.
To get just themod_rewrite
-specific log messages, pipe the log file through grep:
tail -f error_log|fgrep '[rewrite:'
Description: | Sets the base URL for per-directory rewrites |
---|---|
Syntax: | RewriteBaseURL-path |
Default: | None |
Context: | directory, .htaccess |
Override: | FileInfo |
Status: | Extension |
Module: | mod_rewrite |
TheRewriteBase
directive specifies the URL prefix to be used for per-directory (htaccess)RewriteRule
directives that substitute a relative path.
This directive isrequired when you use a relative path in a substitution in per-directory (htaccess) context unless any of the following conditions are true:
DocumentRoot
(as opposed to reachable by other means, such asAlias
).RewriteRule
, suffixed by the relative substitution is also valid as a URL path on the server (this is rare).Alias
ormod_userdir
. In the example below,RewriteBase
is necessary to avoid rewriting to http://example.com/opt/myapp-1.2.3/welcome.html 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"AliasMatch "^/myapp" "/opt/myapp-1.2.3"<Directory "/opt/myapp-1.2.3"> RewriteEngine On RewriteBase "/myapp/" RewriteRule "^index\.html$" "welcome.html"</Directory>
Description: | Defines a condition under which rewriting will take place |
---|---|
Syntax: | RewriteCondTestStringCondPattern [flags] |
Context: | server config, virtual host, directory, .htaccess |
Override: | FileInfo |
Status: | Extension |
Module: | mod_rewrite |
TheRewriteCond
directive defines a rule condition. One or moreRewriteCond
can precede aRewriteRule
directive. The following rule is then only used if both the current state of the URI matches its pattern,and if these conditions are met.
TestString is a string which can contain the following expanded constructs in addition to plain text:
$N
(0 <= N <= 9). $1 to $9 provide access to the grouped parts (in parentheses) of the pattern, from theRewriteRule
which is subject to the current set ofRewriteCond
conditions. $0 provides access to the whole string matched by that pattern.%N
(0 <= N <= 9). %1 to %9 provide access to the grouped parts (again, in parentheses) of the pattern, from the last matchedRewriteCond
in the current set of conditions. %0 provides access to the whole string matched by that pattern.${mapname:key|default}
. Seethe documentation for RewriteMap for more details.%{
NAME_OF_VARIABLE}
whereNAME_OF_VARIABLE can be a string taken from the following list:HTTP headers: | connection & request: | |
---|---|---|
HTTP_ACCEPT HTTP_COOKIE HTTP_FORWARDED HTTP_HOST HTTP_PROXY_CONNECTION 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 REQUEST_METHOD SCRIPT_FILENAME | |
server internals: | date and time: | specials: |
DOCUMENT_ROOT SCRIPT_GROUP SCRIPT_USER SERVER_ADDR SERVER_ADMIN SERVER_NAME SERVER_PORT SERVER_PROTOCOL SERVER_SOFTWARE | TIME_YEAR TIME_MON TIME_DAY TIME_HOUR TIME_MIN TIME_SEC TIME_WDAY TIME | API_VERSION CONN_REMOTE_ADDR HTTPS IS_SUBREQ REMOTE_ADDR REQUEST_FILENAME REQUEST_SCHEME REQUEST_URI THE_REQUEST |
These variables all correspond to the similarly named HTTP MIME-headers, C variables of the Apache HTTP Server orstruct tm
fields of the Unix system. Most are documentedhere or elsewhere in the Manual or in the CGI specification.
SERVER_NAME and SERVER_PORT depend on the values ofUseCanonicalName
andUseCanonicalPhysicalPort
respectively.
Those that are special tomod_rewrite
include those below.
API_VERSION
CONN_REMOTE_ADDR
mod_remoteip
module).HTTPS
mod_ssl
is loaded).IS_SUBREQ
REMOTE_ADDR
mod_remoteip
module).REQUEST_FILENAME
REQUEST_FILENAME
is referenced. Otherwise, such as when used in virtual host context, the same value asREQUEST_URI
. Depending on the value ofAcceptPathInfo
, the server may have only used some leading components of theREQUEST_URI
to map the request to a file.REQUEST_SCHEME
ServerName
.REQUEST_URI
QUERY_STRING
. The value returned forREQUEST_URI
has already been %-decoded, to re-encode it pass it through the "escape"mapping-function.THE_REQUEST
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 theTestString has the special valueexpr
, theCondPattern will be treated as anap_expr. HTTP headers referenced in the expression will be added to the Vary header if thenovary
flag is not given.
Other things you should be aware of:
The variables SCRIPT_FILENAME and REQUEST_FILENAME contain the same value - the value of thefilename
field of the internalrequest_rec
structure of the Apache HTTP Server. The first name is the commonly known CGI variable name while the second is the appropriate counterpart of REQUEST_URI (which contains the value of theuri
field ofrequest_rec
).
If a substitution occurred and the rewriting continues, the value of both variables will be updated accordingly.
If used in per-server context (i.e., before the request is mapped to the filesystem) SCRIPT_FILENAME and REQUEST_FILENAME cannot contain the full local filesystem path since the path is unknown at this stage of processing. Both variables will initially contain the value of REQUEST_URI in that case. In order to obtain the full local filesystem path of the request in per-server context, use an URL-based look-ahead%{LA-U:REQUEST_FILENAME}
to determine the final value of REQUEST_FILENAME.
%{ENV:variable}
, wherevariable can be any environment variable, is also available. This is looked-up via internal Apache httpd structures and (if not found there) viagetenv()
from the Apache httpd server process.%{SSL:variable}
, wherevariable is the name of anSSL environment variable, can be used whether or notmod_ssl
is loaded, but will always expand to the empty string if it is not. Example:%{SSL:SSL_CIPHER_USEKEYSIZE}
may expand to128
. These variables are available even without setting theStdEnvVars
option of theSSLOptions
directive.%{HTTP:header}
, whereheader can be any HTTP MIME-header name, can always be used to obtain the value of a header sent in the HTTP request. Example:%{HTTP:Proxy-Connection}
is 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 true for the request. It isnot 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.
It has to be kept in mind that conditions follow a short circuit logic in the case of the 'ornext|OR
' flag so that certain conditions might not be evaluated at all.
%{LA-U:variable}
can be used for look-aheads which perform an internal (URL-based) sub-request to determine the final value ofvariable. This can be used to access variable for rewriting which is not available at the current stage, but will be set in a later phase.For instance, to rewrite according to theREMOTE_USER
variable from within the per-server context (httpd.conf
file) you must use%{LA-U:REMOTE_USER}
- this variable is set by the authorization phases, which comeafter the URL translation phase (during whichmod_rewrite
operates).
On the other hand, becausemod_rewrite
implements its per-directory context (.htaccess
file) via the Fixup phase of the API and because the authorization phases comebefore this phase, you just can use%{REMOTE_USER}
in that context.
%{LA-F:variable}
can be used to perform an internal (filename-based) sub-request, to determine the final value ofvariable. Most of the time, this is the same as LA-U above.CondPattern is the condition pattern, a regular expression which is applied to the current instance of theTestString.TestString is first evaluated, before being matched againstCondPattern.
CondPattern is usually aperl compatible regular expression, but there is additional syntax available to perform other useful tests against theTeststring:
!
' character (exclamation mark) to negate the result of the condition, no matter what kind ofCondPattern is used.""
(two quotation marks) this comparesTestString to the empty string.RewriteCond %{HTTP_USER_AGENT} "=This Robot/1.0"
!-eq
.Is existing URL, via subrequest.
Checks whether or notTestString 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!
This flagonly returns information about things like access control, authentication, and authorization. This flagdoes not return information about the status code the configured handler (static file, CGI, proxy, etc.) would have returned.
RewriteCond /var/www/%{REQUEST_URI} !-fRewriteRule ^(.+) /other/archive/$1 [R]
If theTestString has the special valueexpr
, theCondPattern will be treated as anap_expr.
In the below example,-strmatch
is used to compare theREFERER
against the site hostname, to block unwanted hotlinking.
RewriteCond expr "! %{HTTP_REFERER} -strmatch '*://%{HTTP_HOST}/*'"RewriteRule "^/images" "-" [F]
You can also set special flags forCondPattern by appending[
flags]
as the third argument to theRewriteCond
directive, whereflags is a comma-separated list of any of the following flags:
nocase|NC
' (nocase)ornext|OR
' (or next condition)RewriteCond "%{REMOTE_HOST}" "^host1" [OR]RewriteCond "%{REMOTE_HOST}" "^host2" [OR]RewriteCond "%{REMOTE_HOST}" "^host3"RewriteRule ...some special stuff for any of these hosts...Without this flag you would have to write the condition/rule pair three times.
novary|NV
' (novary)Example:
To rewrite the Homepage of a site according to the ``User-Agent:
'' header of the request, you can use the following:
RewriteCond "%{HTTP_USER_AGENT}" "(iPhone|Blackberry|Android)"RewriteRule "^/$" "/homepage.mobile.html" [L]RewriteRule "^/$" "/homepage.std.html" [L]
Explanation: If you use a browser which identifies itself 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.
By default, multipleRewriteCond
s are evaluated in sequence with an implied logicalAND. If a condition fails, in the absence of anOR
flag, the entire ruleset is abandoned, and further conditions are not evaluated.
Description: | Enables or disables runtime rewriting engine |
---|---|
Syntax: | RewriteEngine on|off |
Default: | RewriteEngine off |
Context: | server config, virtual host, directory, .htaccess |
Override: | FileInfo |
Status: | Extension |
Module: | mod_rewrite |
TheRewriteEngine
directive enables or disables the runtime rewriting engine. If it is set tooff
this module does no runtime processing at all. It does not even update theSCRIPT_URx
environment variables.
Use this directive to disable rules in a particular context, rather than commenting out all theRewriteRule
directives.
Note that rewrite configurations are not inherited by virtual hosts. This means that you need to have aRewriteEngine on
directive for each virtual host in which you wish to use rewrite rules.
RewriteMap
directives of the typeprg
are not started during server initialization if they're defined in a context that does not haveRewriteEngine
set toon
Description: | Defines a mapping function for key-lookup |
---|---|
Syntax: | RewriteMapMapNameMapType:MapSource [MapTypeOptions] |
Context: | server config, virtual host |
Status: | Extension |
Module: | mod_rewrite |
Compatibility: | The 3rd parameter, MapTypeOptions, in only available from Apache2.4.29 and later |
TheRewriteMap
directive defines aRewriting Map which can be used inside rule substitution strings by the mapping-functions to insert/substitute fields through a key lookup. The source of this lookup can be of various types.
TheMapName is the name of the map and will be used to specify a mapping-function for the substitution strings of a rewriting rule via one of the following constructs:
${
MapName:
LookupKey}
${
MapName:
LookupKey|
DefaultValue}
When such a construct occurs, the mapMapName is consulted and the keyLookupKey is looked-up. If the key is found, the map-function construct is substituted bySubstValue. If the key is not found then it is substituted byDefaultValue or by the empty string if noDefaultValue was specified. Empty values behave as if the key was absent, therefore it is not possible to distinguish between empty-valued keys and absent keys.
For example, you might define aRewriteMap
as:
RewriteMap examplemap "txt:/path/to/file/map.txt"
You would then be able to use this map in aRewriteRule
as follows:
RewriteRule "^/ex/(.*)" "${examplemap:$1}"
The meaning of theMapTypeOptions argument depends on particularMapType. See theUsing RewriteMap for more information.
The following combinations forMapType andMapSource can be used:
httxt2dbm
utility. (Details ...)RewriteMap
: toupper, tolower, escape or unescape. (Details ...)Further details, and numerous examples, may be found in theRewriteMap HowTo
Description: | Sets some special options for the rewrite engine |
---|---|
Syntax: | RewriteOptionsOptions |
Context: | server config, virtual host, directory, .htaccess |
Override: | FileInfo |
Status: | Extension |
Module: | mod_rewrite |
TheRewriteOptions
directive sets some special options for the current per-server or per-directory configuration. TheOption string can currently only be one of the following:
Inherit
This forces the current configuration to inherit the configuration of the parent. In per-virtual-server context, this means that the maps, conditions and rules of the main server are inherited. In per-directory context this means that conditions and rules of the parent directory's.htaccess
configuration or<Directory>
sections are inherited. The inherited rules are virtually copied to the section where this directive is being used. If used in combination with local rules, the inherited rules are copied behind the local rules. The position of this directive - below or above of local rules - has no influence on this behavior. If local rules forced the rewriting to stop, the inherited rules won't be processed.
InheritBefore
LikeInherit
above, but the rules from the parent scope are appliedbefore rules specified in the child scope.
Available in Apache HTTP Server 2.3.10 and later.
InheritDown
If this option is enabled, all child configurations will inherit the configuration of the current configuration. It is equivalent to specifyingRewriteOptions Inherit
in all child configurations. See theInherit
option for more details on how the parent-child relationships are handled.
Available in Apache HTTP Server 2.4.8 and later.
InheritDownBefore
LikeInheritDown
above, but the rules from the current scope are appliedbefore rules specified in any child's scope.
Available in Apache HTTP Server 2.4.8 and later.
IgnoreInherit
This option forces the current and child configurations to ignore all rules that would be inherited from a parent specifyingInheritDown
orInheritDownBefore
.
Available in Apache HTTP Server 2.4.8 and later.
AllowNoSlash
By default,mod_rewrite
will ignore URLs that map to a directory on disk but lack a trailing slash, in the expectation that themod_dir
module will issue the client with a redirect to the canonical URL with a trailing slash.
When theDirectorySlash
directive is set to off, theAllowNoSlash
option can be enabled to ensure that rewrite rules are no longer ignored. This option makes it possible to apply rewrite rules within .htaccess files that match the directory without a trailing slash, if so desired.
Available in Apache HTTP Server 2.4.0 and later.
AllowAnyURI
WhenRewriteRule
is used inVirtualHost
or server context with version 2.2.22 or later of httpd,mod_rewrite
will only process the rewrite rules if the request URI is aURL-path. This avoids some security issues where particular rules could allow "surprising" pattern expansions (seeCVE-2011-3368 andCVE-2011-4317). To lift the restriction on matching a URL-path, theAllowAnyURI
option can be enabled, andmod_rewrite
will apply the rule set to any request URI string, regardless of whether that string matches the URL-path grammar required by the HTTP specification.
Available in Apache HTTP Server 2.4.3 and later.
Enabling this option will make the server vulnerable to security issues if used with rewrite rules which are not carefully authored. It isstrongly recommended that this option is not used. In particular, beware of input strings containing the '@
' character which could change the interpretation of the transformed URI, as per the above CVE names.
MergeBase
With this option, the value ofRewriteBase
is copied from where it's explicitly defined into any sub-directory or sub-location that doesn't define its ownRewriteBase
. This was the default behavior in 2.4.0 through 2.4.3, and the flag to restore it is available Apache HTTP Server 2.4.4 and later.
IgnoreContextInfo
When a relative substitution is made in directory (htaccess) context andRewriteBase
has not been set, this module uses some extended URL and filesystem context information to change the relative substitution back into a URL. Modules such asmod_userdir
andmod_alias
supply this extended context info. Available in 2.4.16 and later.
LegacyPrefixDocRoot
Prior to 2.4.26, if a substitution was an absolute URL that matched the current virtual host, the URL might first be reduced to a URL-path and then later reduced to a local path. Since the URL can be reduced to a local path, the path should be prefixed with the document root. This prevents a file such as /tmp/myfile from being accessed when a request is made to http://host/file/myfile with the followingRewriteRule
.
RewriteRule /file/(.*) http://localhost/tmp/$1
This option allows the old behavior to be used where the document root is not prefixed to a local path that was reduced from a URL. Available in 2.4.26 and later.
Description: | Defines rules for the rewriting engine |
---|---|
Syntax: | RewriteRulePatternSubstitution [flags] |
Context: | server config, virtual host, directory, .htaccess |
Override: | FileInfo |
Status: | Extension |
Module: | mod_rewrite |
TheRewriteRule
directive is the real rewriting workhorse. The directive can occur more than once, with each instance defining a single rewrite rule. The order in which these rules are defined is important - this is the order in which they will be applied at run-time.
Pattern is a perl compatibleregular expression. What this pattern is compared against varies depending on where theRewriteRule
directive is defined.
InVirtualHost
context, ThePattern will initially be matched against the part of the URL after the hostname and port, and before the query string (e.g. "/app1/index.html"). This is the (%-decoded)URL-path.
In per-directory context (Directory
and .htaccess), thePattern is matched against only a partial path, for example a request of "/app1/index.html" may result in comparison against "app1/index.html" or "index.html" depending on where theRewriteRule
is defined.
The directory path where the rule is defined is stripped from the currently mapped filesystem path before comparison (up to and including a trailing slash). The net result of this per-directory prefix stripping is that rules in this context only match against the portion of the currently mapped filesystem path "below" where the rule is defined.
Directives such asDocumentRoot
andAlias
, or even the result of previousRewriteRule
substitutions, determine the currently mapped filesystem path.
If you wish to match against the hostname, port, or query string, use aRewriteCond
with the%{HTTP_HOST}
,%{SERVER_PORT}
, or%{QUERY_STRING}
variables respectively.
<Directory>
sections, with some additionalcomplexity.RewriteEngine On
"and"Options FollowSymLinks
" must be enabled. If youradministrator has disabled override ofFollowSymLinks
fora user's directory, then you cannot use the rewrite engine. Thisrestriction is required for security reasons.RewriteBase
directive for more information regarding what prefix will be added back torelative substitutions.%{REQUEST_URI}
variable inaRewriteCond
.^/
nevermatches in per-directory context.<Location>
and<Files>
sections(including their regular expression counterparts), thisshould never be necessary and is unsupported. A likely featureto break in these contexts is relative substitutions.If
blocksfollow the rules of thedirectory context.RewriteOptions
directive can change this behavior,for example using theInherit setting.RewriteOptions
also regulates thebehavior of sections that are stated at the same nesting level of the configuration. In thefollowing example, by default only the RewriteRules stated in the secondIf
blockare considered, since the first ones are overridden. UsingRewriteOptions
Inherit forces mod_rewrite to merge the twosections and consider both set of statements, rather than only the last one.<If "true"> # Without RewriteOptions Inherit, this rule is overridden by the next # section and no redirect will happen for URIs containing 'foo' RewriteRule foo http://example.com/foo [R]</If><If "true"> RewriteRule bar http://example.com/bar [R]</If>
For some hints onregular expressions, see themod_rewrite Introduction.
Inmod_rewrite
, the NOT character ('!
') is also available as a possible pattern prefix. This enables you to negate a pattern; to say, for instance: ``if the current URL doesNOT match this pattern''. This can be used for exceptional cases, where it is easier to match the negative pattern, or as a last default rule.
$N
in the substitution string!TheSubstitution of a rewrite rule is the string that replaces the original URL-path that was matched byPattern. TheSubstitution may be a:
DocumentRoot
-relative path to the resource to be served. Note thatmod_rewrite
tries to guess whether you have specified a file-system path or a URL-path by checking to see if the first segment of the path exists at the root of the file-system. For example, if you specify aSubstitution string of/www/file.html
, then this will be treated as a URL-pathunless a directory namedwww
exists at the root or your file-system (or, in the case of using rewrites in a.htaccess
file, relative to your document root), in which case it will be treated as a file-system path. If you wish other URL-mapping directives (such asAlias
) to be applied to the resulting URL-path, use the[PT]
flag as described below.If an absolute URL is specified,mod_rewrite
checks to see whether the hostname matches the current host. If it does, the scheme and hostname are stripped out and the resulting path is treated as a URL-path. Otherwise, an external redirect is performed for the given URL. To force an external redirect back to the current host, see the[R]
flag below.
Note that a redirect (implicit or not) using an absolute URI will include the requested query-string, to prevent this see the[QSD]
flag below.
-
(dash)In addition to plain text, theSubstitution string can include
$N
) to the RewriteRule pattern%N
) to the last matched RewriteCond pattern%{VARNAME}
)${mapname:key|default}
)Back-references are identifiers of the form$
N (N=0..9), which will be replaced by the contents of theNth group of the matchedPattern. The server-variables are the same as for theTestString of aRewriteCond
directive. The mapping-functions come from theRewriteMap
directive and are explained there. These three types of variables are expanded in the order above.
Rewrite rules are applied to the results of previous rewrite rules, in the order in which they are defined in the config file. The URL-path or file-system path (see"What is matched?", above) iscompletely replaced by theSubstitution and the rewriting process continues until all rules have been applied, or it is explicitly terminated by anL
flag, or other flag which implies immediate termination, such asEND
orF
.
By default, the query string is passed through unchanged. You can, however, create URLs in the substitution string containing a query string part. Simply use a question mark inside the substitution string to indicate that the following text should be re-injected into the query string. When you want to erase an existing query string, end the substitution string with just a question mark. To combine new and old query strings, use the[QSA]
flag.
Additionally you can set specialactions to be performed by appending[
flags]
as the third argument to theRewriteRule
directive.Flags is a comma-separated list, surround by square brackets, of any of the flags in the following table. More details, and examples, for each flag, are available in theRewrite Flags document.
Flag and syntax | Function |
---|---|
B | Escape non-alphanumeric characters in backreferencesbefore applying the transformation. For similar escaping of server-variables, see the "escape"mapping-function.details ... |
BCTLS | Like [B], but only escape control characters and spaces.details ... |
BNE | Characters of [B] or [BCTLS] which shouldnot be escaped.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[samesite]]]]]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 variableVAR to be set (to the valueVAL if provided). The form !VAR causes the environment variableVAR 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 specifiedContent-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 rewrites that result in redirection.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 asAlias orRedirect .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 ... |
qslast|QSL | Interpret the last (right-most) question mark as the query string delimiter, instead of the first (left-most) as normally used. Available in 2.4.19 and later.details ... |
redirect|R[=code] | Forces an external redirect, optionally with the specified HTTP status code.details ... |
skip|S=num | Tells the rewriting engine to skip the nextnum rules if the current rule matches.details ... |
type|T=MIME-type | Force theMIME-type of the target file to be the specified type.details ... |
UnsafeAllow3F | Allows substitutions from URL's that may be unsafe.details ... |
UnsafePrefixStat | Allows potentially unsafe substitutions from a leading variable or backreference to a filesystem path.details ... Available in Apache HTTP Server 2.4.60 and later. |
UNC | Prevents the merging of multiple leading slashes, as used by Windows UNC paths.details ... Available in Apache HTTP Server 2.4.62 and later. |
When the substitution string begins with a stringresembling "/~user" (via explicit text or backreferences),mod_rewrite
performshome directory expansion independent of the presence or configurationofmod_userdir
.
This expansion does not occur when thePTflag is used on theRewriteRule
directive.
Here are all possible substitution combinations and their meanings:
Inside per-server configuration (httpd.conf
)
for request ``GET /somepath/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 |
Inside per-directory configuration for/somepath
(/physical/path/to/somepath/.htaccess
, withRewriteBase "/somepath"
)
for request ``GET /somepath/localpath/pathinfo
'':
Given Rule | Resulting Substitution |
---|---|
^localpath(.*) otherpath$1 | /somepath/otherpath/pathinfo |
^localpath(.*) otherpath$1 [R] | http://thishost/somepath/otherpath/pathinfo via externalredirection |
^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 |
Copyright 2025 The Apache Software Foundation.
Licensed under theApache License, Version 2.0.