vhost

NPM Version NPM Downloads Build Status Test Coverage

インストール

$ npm install vhost

API

var vhost = require('vhost')

vhost(hostname, handle)

リクエストの受信ホストが hostname と一致した場合に、handle にリクエストを渡す新しいミドルウェア関数を作成します。この関数は標準ミドルウェアのように handle(req, res, next) として呼び出されます。

hostname は文字列または正規表現オブジェクトにすることができます。hostname が文字列の場合、その文字列に * を含めて、ホスト名のそのセクションにある 1 文字以上の文字と一致させることができます。hostname が正規表現の場合、大文字と小文字を区別しない (ホスト名がそうであるため) よう強制され、ホスト名の先頭と末尾に基づいて一致するように強制されます。

ホストが一致し、リクエストが vhost ハンドラーに送信されると、req.vhost プロパティにオブジェクトが追加されます。このオブジェクトには、各ワイルドカード (または正規表現オブジェクトが提供されている場合のキャプチャグループ) と一致した hostname の数値プロパティがあります。

var connect = require('connect')
var vhost = require('vhost')
var app = connect()

app.use(vhost('*.*.example.com', function handle (req, res, next) {
  // for match of "foo.bar.example.com:8080" against "*.*.example.com":
  console.dir(req.vhost.host) // => 'foo.bar.example.com:8080'
  console.dir(req.vhost.hostname) // => 'foo.bar.example.com'
  console.dir(req.vhost.length) // => 2
  console.dir(req.vhost[0]) // => 'foo'
  console.dir(req.vhost[1]) // => 'bar'
}))

静的配信用の接続で使用

var connect = require('connect')
var serveStatic = require('serve-static')
var vhost = require('vhost')

var mailapp = connect()

// add middlewares to mailapp for mail.example.com

// create app to serve static files on subdomain
var staticapp = connect()
staticapp.use(serveStatic('public'))

// create main app
var app = connect()

// add vhost routing to main app for mail
app.use(vhost('mail.example.com', mailapp))

// route static assets for "assets-*" subdomain to get
// around max host connections limit on browsers
app.use(vhost('assets-*.example.com', staticapp))

// add middlewares and main usage to app

app.listen(3000)

ユーザーサブドメイン用の接続で使用

var connect = require('connect')
var serveStatic = require('serve-static')
var vhost = require('vhost')

var mainapp = connect()

// add middlewares to mainapp for the main web site

// create app that will server user content from public/{username}/
var userapp = connect()

userapp.use(function (req, res, next) {
  var username = req.vhost[0] // username is the "*"

  // pretend request was for /{username}/* for file serving
  req.originalUrl = req.url
  req.url = '/' + username + req.url

  next()
})
userapp.use(serveStatic('public'))

// create main app
var app = connect()

// add vhost routing for main app
app.use(vhost('userpages.local', mainapp))
app.use(vhost('www.userpages.local', mainapp))

// listen on all subdomains for user pages
app.use(vhost('*.userpages.local', userapp))

app.listen(3000)

一般的なリクエストハンドラーで使用

var connect = require('connect')
var http = require('http')
var vhost = require('vhost')

// create main app
var app = connect()

app.use(vhost('mail.example.com', function (req, res) {
  // handle req + res belonging to mail.example.com
  res.setHeader('Content-Type', 'text/plain')
  res.end('hello from mail!')
}))

// an external api server in any framework
var httpServer = http.createServer(function (req, res) {
  res.setHeader('Content-Type', 'text/plain')
  res.end('hello from the api!')
})

app.use(vhost('api.example.com', function (req, res) {
  // handle req + res belonging to api.example.com
  // pass the request to a standard Node.js HTTP server
  httpServer.emit('request', req, res)
}))

app.listen(3000)

ライセンス

MIT