Bouncy uses node's http parser innards to bounce http requests around to where they need to go in an entirely transparent way.
Use bouncy as a load balancer or http host router, either programmatically or with the simple command-line tool.
Bouncy is websocket and tls (https) capable.
Route requests based on the host field
var bouncy = require('bouncy');
bouncy(function (req, bounce) {
if (req.headers.host === 'beep.example.com') {
bounce(8001);
}
else if (req.headers.host === 'boop.example.com') {
bounce(8002);
}
}).listen(8000);
Just create a routes.json
file like this:
{
"beep.example.com" : 8000,
"boop.example.com" : 8001
}
Then point the bouncy
command at this routes.json
file and give it a port to
listen on:
bouncy routes.json 80
The routes.json
file should just map host names to host/port combos.
Use a colon-separated string to specify a host and port in a route.
Use ""
for the host as a default route.
bouncy(cb)
returns a new net.Server object that you can .listen()
on.
If you specify opts.key
and opts.cert
, the connection will be set to secure
mode using tls. Do this if you want to make an https router.
Your callback cb
will get these arguments:
The node http module request object.
To catch parse errors, listen for the "error" event.
Call this function when you're ready to bounce the request to a stream.
The exact request that was received will be written to stream
and future
incoming data will be piped to and from it.
To send data to a different url path on the destination stream, you can specify
opts.path
.
You can specify header fields to insert into the request with opts.headers
.
By default, "x-forwarded-for"
, "x-forwarded-port"
, and "x-forwarded-proto"
are all automatically inserted into the outgoing header.
You can pass in an EventEmitter on opts.emitter
to listen for "drop"
events
which occur when a .write()
fails which happens with annoying frequency in
node v0.4.x.
If you pass in an emitter you'll get the connection object on "drop"
events so
you can handle these yourself by writing an error message to the stream. If you
don't pass in an opts.emitter
, the connection will be .destroy()
ed.
bounce()
returns the stream object that it's using. This is useful if you pass
in a port so you can .on('error', fn)
to detect connection errors.
These variants of bounce()
are sugar for
bounce(net.createConnection(port))
and
bounce(net.createConnection(port, host))
.
Optionally you can pass port and host keys to opts
and it does the same thing.
Passing bounce()
a string that looks like a url (with or without "http://"
)
will set the opts.host, opts.port, and opts.path accordingly.
Return a new HTTP response object for the request. This is useful if you need to write an error result.
Manually upgrade the connection using parsley.
Discard all buffered data. This is sometimes useful for upgraded connections.
The parsley parser being used.
The buffered stream used to buffer the headers and body until bounce() is called.
With npm, do:
npm install bouncy
to install as a library or
npm install -g bouncy
to get the command-line tool.
MIT/X11
With npm, do:
npm test