Skip to content
Find file
Fetching contributors…
Cannot retrieve contributors at this time
85 lines (58 sloc) 2.56 KB

Connect Host Redirect

connect-redirecthost is middleware for the Express.js framework that allows redirecting multiple domains to a default one.

Build Status

Installation

$ npm install connect-redirecthost

Quick Start

Using connect-redirecthost is easy. Register it within Express.js as middleware by adding the following line into your app.js file before most calls to app.use(...):

app.use(require('connect-redirecthost').redirectHost('www.example.com'));

Localhost is always excluded to make local development easier.

Exceptions

Redirect exceptions are supported. If, for example, your site uses a CDN on a separate domain, you can create an exception for that domain

app.use(require('connect-redirecthost').redirectHost({
 to: 'www.example.com',       // all requests not on www.example.com will be redirected to www.example.com
 except: 'cdn.example.com'    // except for those to cdn.example.com
}));

You can also specify multiple exceptions using an array.

app.use(require('connect-redirecthost').redirectHost({
 to: 'www.example.com',
 except: ['cdn.example.com', 'origin.example.com']
}));

Path handling

By default, the root-relative path is preserved during the redirect. Should the root relative path need to be modified reset, the following options can be used, where the path will be set to the associated domain's value

app.use(require('connect-redirecthost').redirectHost({
    to: 'www.example.com',
    changePath: {'www.example.ca': '/ca', 'www.example.us': '/us'}
}));

You can also specify a function to determine the new path;

app.use(require('connect-redirecthost').redirectHost({
    to: 'www.example.com',
    changePath: {
     'www.example.ca': function(host, url){return '/ca' + url;},
     'www.example.us': function(host, url){return '/us' + url;}
    }
}));

Protocol overrides

By default, the current protocol is preserved when redirecting. Using the protocol option forces the redirect to a particular protocol. Typical values are http and https.

app.use(require('connect-redirecthost').redirectHost({
    to: 'www.example.com',
    protocol: 'https'
}));

IMPORTANT! Keep in mind this only sets the protocol when redirecting based on host matches. This will not normalize the protocol on all requests. You'll need another module to accomplish that.

License

MIT License, see the LICENSE file.

Something went wrong with that request. Please try again.