Difference between revisions of "URL Rewrite"

Revision as of 10:59, 16 July 2015 (view source) DavidC (Talk | contribs) (→‎Common Rewrite Rules) ← Older edit		Revision as of 11:02, 16 July 2015 (view source) DavidC (Talk | contribs) (→‎Redirect to www) Newer edit →
Line 110:		Line 110:
	== Common Rewrite Rules ==		== Common Rewrite Rules ==
	=== Redirect to www ===		=== Redirect to www ===
		+
		+	'''Linux (Apache)'''
	<source lang="apache">		<source lang="apache">
Line 118:		Line 120:
	RewriteRule ^(.*)$ http://www.example.com/$1 [L,R=301,NC]		RewriteRule ^(.*)$ http://www.example.com/$1 [L,R=301,NC]
	</IfModule>		</IfModule>
		+	</source>
		+
		+	'''Windows (IIS)'''
		+
		+	<source lang="xml">
		+	<?xml version="1.0" encoding="UTF-8"?>
		+	<configuration>
		+	<system.webServer>
		+	<rewrite>
		+	<rules>
		+	<rule name="Redirect to www" stopProcessing="true">
		+	<match url="^(.*)$"  ignoreCase="true" />
		+	<action type="Rewrite" url="/http://www.example.com/{R:1}"  />
		+	</rule>
		+	</rules>
		+	</rewrite>
		+	</system.webServer>
		+	</configuration>
	</source>		</source>

---

Revision as of 11:02, 16 July 2015

Overview

Platform Compatibility

Apache (Linux)

Directives - RewriteEngine

Directives - Rewrite Options

Directives - RewriteLog

Directives - RewriteLogLevel

Directives - RewriteLock

Directives - RewriteMap

Directives - RewriteBase

Directives - RewriteCond

Directives - RewriteRule

Flags - RewriteRules

Flags - RewriteCond

Variables - HTTP Headers

Variables - Request

Variables - Server Internals

Variables - Special

Variables - Time

<IfModule>

Common Issues - Filename

Common Issues - AllowOverride

Common Issues - Syntax

Common Issues - Special Characters

Common Issues - Nesting

Additional Resources

IIS (Windows)

Inbound Rules

Outbound Rules

Inheritance

Rewrite Conditions

Server Variables

String Functions

Rewrite Maps

Externalization of Rewrite Rules

Additional Resources

• URL Rewrite

  http://www.iis.net/downloads/microsoft/url-rewrite

• URL Rewrite Community Forum

  http://forums.iis.net/1152.aspx

ISAPIRewrite (Windows)

Unsupported Features

Common Issues - Leading Slashes

Common Issues - Windows Filename Requirements

Additional Resources

• ISAPI_Rewrite 3

  http://www.helicontech.com/isapi_rewrite/

• ISAPI_Rewrite 3 - Documentation

  http://www.helicontech.com/isapi_rewrite/doc/introduct.htm

Redirect Codes

301 - Moved Permanently

302 - Found

303 - See Other

307 - Temporary Redirect

308 - Permanent Redirect

Regular Expressions

Anchors

Character Classes

Character Classes - POSIX

Assertions

Quantifiers

Escape Sequences

Common Meta Characters

Special Characters

Groups and Ranges

Pattern Modifiers

String Replacement

Testing Tools

Below is a brief list of online tools to create and test regular expressions.

• Regular Expressions 101
  

  https://regex101.com/

• RegExr
  

  http://regexr.com/

• RegexPal
  

  http://regexpal.com/

• Rubular
  

  http://rubular.com

Additional Resources

Below is a list of useful online resource to help you learn and familiarize yourself with regular expressions.

• Regular Expression (Wikipedia)

  https://en.wikipedia.org/wiki/Regular_expression

• Regular Expressions

  http://www.regular-expressions.info/

• Regular Expressions (Mozilla)

  https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions

• JavaScrip RegExp Reference

  http://www.w3schools.com/jsref/jsref_obj_regexp.asp

Common Rewrite Rules

Redirect to www

Linux (Apache)

# Add WWW Prefix
<IfModule mod_rewrite.c>
    RewriteEngine On
    RewriteCond %{HTTP_HOST} ^example\.com [NC]
    RewriteRule ^(.*)$ http://www.example.com/$1 [L,R=301,NC]
</IfModule>

Windows (IIS)

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <system.webServer>
        <rewrite>
            <rules>
                <rule name="Redirect to www" stopProcessing="true">
                    <match url="^(.*)$"  ignoreCase="true" />
                    <action type="Rewrite" url="/http://www.example.com/{R:1}"  />
                </rule>
            </rules>
        </rewrite>
    </system.webServer>
</configuration>

Redirect to non-www

# Remove WWW Prefix
<IfModule mod_rewrite.c>
    RewriteEngine On
    RewriteCond %{HTTP_HOST} ^www\.example\.com [NC]
    RewriteRule ^(.*)$ http://example.com/$1 [L,R=301]
</IfModule>

Redirect Single Page

# Redirect page
Redirect 301 /old.html /new.html

Redirect Entire Site

# Redirect entire domain
Redirect 301 / http://www.example.com

Redirect Entire Site with Query String

Redirect Entire Site to Sub-Folder

Redirect Sub-Folder to Different Site

Redirect to Different File Extension

# Redirect to new file extension
RedirectMatch 301 (.*)\.html$ http://www.example.com$1.php

Redirect to New Domain

# Redirect to new domain
<IfModule mod_rewrite.c>
    RewriteEngine On
    RewriteCond %{HTTPS} off
    RewriteCond %{HTTP_HOST} !^(www\.)?newdomain\.com$ [NC]
    RewriteRule .* http://newdomain.com%{REQUEST_URI} [R=301,L]
    RewriteCond %{HTTPS} on
    RewriteCond %{HTTP_HOST} !^(www\.)?newdomain\.com$ [NC]
    RewriteRule .* https://newdomain.com%{REQUEST_URI} [R=301,L]
</IfModule>

Redirect Unsecure (HTTP) to Secure (HTTPS)

# Redirect to HTTPS
<IfModule mod_rewrite.c>
    RewriteEngine On
    RewriteCond %{HTTPS} off
    RewriteRule (.*) https://%{HTTP_HOST}%{REQUEST_URI} [R,L]
</IfModule>

Redirect Mobile Users

# Redirect mobile devices
<IfModule mod_rewrite.c>
    RewriteEngine On
    RewriteCond %{HTTP_ACCEPT} "text\/vnd\.wap\.wml|application\/vnd\.wap\.xhtml\+xml" [NC]
    RewriteCond %{REQUEST_URI} ^/$
    RewriteRule ^ http://m.example.com%{REQUEST_URI} [R,L]
</IfModule>

Block IP Addresses

# Block IP addresses
Order Deny,Allow
Deny from 1.2.3.4

Block All Except IP Addresses

# Block all except IP addresses
Order Deny,Allow
Deny from all
Allow from 1.2.3.4

Block Bad Bots

# Block bad bots
<IfModule mod_rewrite.c>
    RewriteEngine On 
    RewriteCond %{HTTP_USER_AGENT} ^Bot [OR]
    RewriteCond %{HTTP_USER_AGENT} ^AnotherBotName
    RewriteRule ^.* - [F,L]
</IfModule>

Prevent Directory Listing

# Prevent directory listing
Options All -Indexes

Custom Error Pages

# Custom error pages
ErrorDocument 400 /error400.html
ErrorDocument 401 /error401.html
ErrorDocument 403 /error403.html
ErrorDocument 404 /error403.html
ErrorDocument 500 /error500.html

Follow Symbolic Links

# Follow symbolic links
Options +FollowSymLinks

Redirect to Maintenance Page

# Redirect to maintenance page
<IfModule mod_rewrite.c>
    RewriteCond %{REMOTE_ADDR} !^64\.207\.234\.198$
    RewriteCond %{REQUEST_URI} !^/maintenance\.html$ [NC]
    RewriteCond %{REQUEST_URI} !\.(jpg|jpeg|png|gif|svg|swf|css|ico|js)$ [NC]
    RewriteRule .* /maintenance.html [R=302,L]
</IfModule>

Prevent Image Hotlinking

# Prevent hotlinking
<IfModule mod_rewrite.c>
    RewriteCond %{HTTP_REFERER} !^$
    RewriteCond %{HTTP_REFERER} ^https?://([^/]+)/ [NC]
    RewriteCond %1#%{HTTP_HOST} !^(.+)#\1$
    RewriteRule \.(jpg|jpeg|png|gif|swf|svg)$ - [NC,F,L]
</IfModule>

Compress Common Filetypes

# Compress common filetypes
AddOutputFilterByType DEFLATE text/plain
AddOutputFilterByType DEFLATE text/html
AddOutputFilterByType DEFLATE text/xml
AddOutputFilterByType DEFLATE text/css
AddOutputFilterByType DEFLATE application/xml
AddOutputFilterByType DEFLATE application/xhtml+xml
AddOutputFilterByType DEFLATE application/rss+xml
AddOutputFilterByType DEFLATE application/javascript
AddOutputFilterByType DEFLATE application/x-javascript

Application-Specific Rewrite Rules

CakePHP

CodeIgniter

# CodeIgniter permalinks
<IfModule mod_rewrite.c>
    RewriteEngine On
    RewriteCond %{REQUEST_FILENAME} !-f
    RewriteCond %{REQUEST_FILENAME} !-d
    RewriteRule ^(.*)$ index.php/$1 [L]
</IfModule>

concrete5

# Concrete5 permalinks
<IfModule mod_rewrite.c>
    RewriteEngine On
    RewriteCond %{REQUEST_FILENAME} !-f
    RewriteCond %{REQUEST_FILENAME} !-d
    RewriteRule ^(.*)$ index.php/$1 [L]
</IfModule>

DotNetNuke

Joomla

# Joomla permalinks
<IfModule mod_rewrite.c>
    RewriteEngine On
    RewriteCond %{REQUEST_URI} !^/index\.php
    RewriteCond %{REQUEST_FILENAME} !-f
    RewriteCond %{REQUEST_FILENAME} !-d
    RewriteRule .* index.php [L]
</IfModule>

Magento

Mura

WordPress

To enable permalinks within WordPress:

1. Login to your WordPress dashboard
2. Hover over Settings on the menu
3. Choose Permalinks from the menu that appears
4. Choose one of the available permalink structures
5. Click the Save Changes button

Linux (.htaccess)

This file is generated by WordPress automatically when Permalinks are enabled using the instructions above. It is provided here for reference.

# Wordpress permalinks
<IfModule mod_rewrite.c>
    RewriteEngine On
    RewriteBase /
    RewriteRule ^index\.php$ - [L]
    RewriteCond %{REQUEST_FILENAME} !-f
    RewriteCond %{REQUEST_FILENAME} !-d
    RewriteRule . /index.php [L]
</IfModule>

Windows (web.config)

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <system.webServer>
        <rewrite>
            <rules>
                <rule name="WordPress Permalinks - Homepage" stopProcessing="true">
                    <match url="^index\.php$" />
                    <action type="None" />
                </rule>
                <rule name="WordPress Permalinks - All Requests" stopProcessing="true">
                    <match url=".*" />
                    <conditions>
                        <add input="{REQUEST_FILENAME}" matchType="IsFile" negate="true" />
                        <add input="{REQUEST_FILENAME}" matchType="IsDirectory" negate="true" />
                    </conditions>
                    <action type="Rewrite" url="index.php" />
                </rule>
            </rules>
        </rewrite>
    </system.webServer>
</configuration>