No description or website provided.
JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
lib
.gitignore
README.md
index.js First commit Jan 29, 2012
package.json

README.md

Intro

express-subdomain-handler takes the headache out of dynamic subdomain routing in Express. It captures the contents of any subdomain and writes them into the Express req.url. This means you can write specific route handlers for subdomain urls.

As you can see below, express-subdomain-handler can manage single or multiple subdomains.

Examples

  • http://mysubdomain.example.com => '/subdomain/mysubdomain/'
  • http://myexcellentsubdom.example.com/homepage => '/subdomain/myexcellentsubdom/homepage'
  • http://first.second.example.com => '/subdomain/first/second/'
  • http://first.second.example.com/another/page => '/subdomain/first/second/another/page'

Installation

npm install express-subdomain-handler

Usage

Add express-subdomain-handler to your express middleware stack (before your routes are specified). You need to specify what the base url of your site is ('example.com', 'example.local', etc), what you what subdomain urls to be prefixed with ('subdomain' by default) and whether you want logging turned on (false by default)

app.use( require('express-subdomain-handler')({ baseUrl: 'example.com', prefix: 'myprefix', logger: true }) );

Setup routes to catch subdomain urls so for http://mysubdomain.example.com/homepage I would write my route handler to look like this.

app.get('/myprefix/:thesubdomain/thepage', function(req, res, next){

  // for the example url this will print 'mysubdomain'
  res.send(req.params.thesubdomain);

});

Follow me

If you like my stuff, follow me on Twitter