@artcodestudio/redbird
Advanced tools
This is a temporary fork of redbird until the original works with node 14.
It should be easy and robust to handle dynamic virtual hosts, load balancing, proxying web sockets and SSL encryption.
With Redbird you get a complete library to build dynamic reverse proxies with the speed and robustness of http-proxy.
This light-weight package includes everything you need for easy reverse routing of your applications. Great for routing many applications from different domains in one single host, handling SSL with ease, etc.
Developed by manast
Support for HTTP2. You can now enable HTTP2 just by setting the HTTP2 flag to true. Keep in mind that HTTP2 requires SSL/TLS certificates. Thankfully we also support LetsEncrypt so this becomes easy as pie.
We have now support for automatic generation of SSL certificates using LetsEncrypt. Zero config setup for your TLS protected services that just works.
npm install @artcodestudio/redbird
You can programmatically register or unregister routes dynamically even if the proxy is already running:
const Redbird = require('@artcodestudio/redbird');
var proxy = new Redbird({port: 80});
// OPTIONAL: Setup your proxy but disable the X-Forwarded-For header
var proxy = new Redbird({port: 80, xfwd: false});
// Route to any global ip
proxy.register("optimalbits.com", "http://167.23.42.67:8000");
// Route to any local ip, for example from docker containers.
proxy.register("example.com", "http://172.17.42.1:8001");
// Route from hostnames as well as paths
proxy.register("example.com/static", "http://172.17.42.1:8002");
proxy.register("example.com/media", "http://172.17.42.1:8003");
// Subdomains, paths, everything just works as expected
proxy.register("abc.example.com", "http://172.17.42.4:8080");
proxy.register("abc.example.com/media", "http://172.17.42.5:8080");
// Route to any href including a target path
proxy.register("foobar.example.com", "http://172.17.42.6:8080/foobar");
// You can also enable load balancing by registering the same hostname with different
// target hosts. The requests will be evenly balanced using a Round-Robin scheme.
proxy.register("balance.me", "http://172.17.40.6:8080");
proxy.register("balance.me", "http://172.17.41.6:8080");
proxy.register("balance.me", "http://172.17.42.6:8080");
proxy.register("balance.me", "http://172.17.43.6:8080");
// You can unregister routes as well
proxy.register("temporary.com", "http://172.17.45.1:8004");
proxy.unregister("temporary.com", "http://172.17.45.1:8004");
// LetsEncrypt support
// With Redbird you can get zero conf and automatic SSL certificates for your domains
redbird.register('example.com', 'http://172.60.80.2:8082', {
ssl: {
letsencrypt: {
email: 'john@example.com', // Domain owner/admin email
production: true, // WARNING: Only use this flag when the proxy is verified to work correctly to avoid being banned!
}
}
});
//
// LetsEncrypt requires a minimal web server for handling the challenges, this is by default on port 3000
// it can be configured when initiating the proxy. This web server is only used by Redbird internally so most of the time
// you do not need to do anything special other than avoid having other web services in the same host running
// on the same port.
//
// HTTP2 Support using LetsEncrypt for the certificates
//
var proxy = new Redbird({
port: 80, // http port is needed for LetsEncrypt challenge during request / renewal. Also enables automatic http->https redirection for registered https routes.
letsencrypt: {
path: __dirname + '/certs',
port: 9999 // LetsEncrypt minimal web server port for handling challenges. Routed 80->9999, no need to open 9999 in firewall. Default 3000 if not defined.
},
greenlock: {
packageRoot: __dirname, // The folder must contain your main package.json
},
ssl: {
http2: true,
port: 443, // SSL port used to serve registered https routes with LetsEncrypt certificate.
}
});
The HTTPS proxy supports virtual hosts by using SNI (which most modern browsers support: IE7 and above). The proxying is performed by hostname, so you must use the same SSL certificates for a given hostname independently of its paths.
Some important considerations when using LetsEncrypt. You need to agree to LetsEncrypt terms of service. When using LetsEncrypt, the obtained certificates will be copied to disk to the specified path. Its your responsibility to backup, or save persistently when applicable. Keep in mind that these certificates needs to be handled with care so that they cannot be accessed by malicious users. The certificates will be renewed every 2 months automatically forever.
(NOTE: This is a legacy example not needed when using LetsEncrypt)
Conceptually HTTPS is easy, but it is also easy to struggle getting it right. With Redbird its straightforward, check this complete example:
/certs $ openssl genrsa -out dev-key.pem 1024
/certs $ openssl req -new -key dev-key.pem -out dev-csr.pem
// IMPORTANT: Do not forget to fill the field! Common Name (e.g. server FQDN or YOUR name) []:localhost
/certs $ openssl x509 -req -in dev-csr.pem -signkey dev-key.pem -out dev-cert.pem
Note: For production sites you need to buy valid SSL certificates from a trusted authority.
var redbird = new Redbird({
port: 8080,
// Specify filenames to default SSL certificates (in case SNI is not supported by the
// user's browser)
ssl: {
port: 8443,
key: "certs/dev-key.pem",
cert: "certs/dev-cert.pem",
}
});
// Since we will only have one https host, we dont need to specify additional certificates.
redbird.register('localhost', 'http://localhost:8082', {ssl: true});
Point your browser to localhost:8000 and you will see how it automatically redirects to your https server and proxies you to
your target server.
You can define many virtual hosts, each with its own SSL certificate. And if you do not define any, they will use the default one as in the example above:
redbird.register('example.com', 'http://172.60.80.2:8082', {
ssl: {
key: "../certs/example.key",
cert: "../certs/example.crt",
ca: "../certs/example.ca"
}
});
redbird.register('foobar.com', 'http://172.60.80.3:8082', {
ssl: {
key: "../certs/foobar.key",
cert: "../certs/foobar.crt",
}
});
You can also specify https hosts as targets and also specify if you want the connection to the target host to be secure (default is true).
var redbird = new Redbird({
port: 80,
secure: false,
ssl: {
port: 443,
key: "../certs/default.key",
cert: "../certs/default.crt",
}
});
redbird.register('tutorial.com', 'https://172.60.80.2:8083', {
ssl: {
key: "../certs/tutorial.key",
cert: "../certs/tutorial.crt",
}
});
Edge case scenario: you have an HTTPS server with two IP addresses assigned to it and your clients use old software without SNI support. In this case, both IP addresses will receive the same fallback certificate. I.e. some of the domains will get a wrong certificate. To handle this case you can create two HTTPS servers each one bound to its own IP address and serving the appropriate certificate.
var redbird = new Redbird({
port: 8080,
// Specify filenames to default SSL certificates (in case SNI is not supported by the
// user's browser)
ssl: [
{
port: 443,
ip: '123.45.67.10', // assigned to tutorial.com
key: 'certs/tutorial.key',
cert: 'certs/tutorial.crt',
},
{
port: 443,
ip: '123.45.67.11', // assigned to my-other-domain.com
key: 'certs/my-other-domain.key',
cert: 'certs/my-other-domain.crt',
}
]
});
// These certificates will be served if SNI is supported
redbird.register('tutorial.com', 'http://192.168.0.10:8001', {
ssl: {
key: 'certs/tutorial.key',
cert: 'certs/tutorial.crt',
}
});
redbird.register('my-other-domain.com', 'http://192.168.0.12:8001', {
ssl: {
key: 'certs/my-other-domain.key',
cert: 'certs/my-other-domain.crt',
}
});
If you use docker, you can tell Redbird to automatically register routes based on image names. You register your image name and then every time a container starts from that image, it gets registered, and unregistered if the container is stopped. If you run more than one container from the same image, Redbird will load balance following a round-robin algorithm:
var redbird = new Redbird({
port: 8080,
});
var docker = Redbird.docker;
docker(redbird).register("old.api.com", 'company/api:v1.0.0');
docker(redbird).register("stable.api.com", 'company/api:v2.*');
docker(redbird).register("preview.api.com", 'company/api:v[3-9].*');
Redbird can use node-etcd to automatically create proxy records from an etcd cluster. Configuration is accomplished by passing an array of options, plus the hosts and path variables, which define which etcd cluster hosts, and which directory within those hosts, that Redbird should poll for updates.
var redbird = new Redbird({
port:8080
});
var options = {
hosts: ['localhost:2379'], // REQUIRED - you must define array of cluster hosts
path: ['@artcodestudio/redbird'], // OPTIONAL - path to etcd keys
... // OPTIONAL - pass in node-etcd connection options
}
Redbird.etcd(redbird,options);
etcd records can be created in one of two ways, either as a target destination pair:
/redbird/example.com "8.8.8.8"
or by passing a JSON object containing multiple hosts, and Redbird options:
/redbird/derek.com { "hosts" : ["10.10.10.10", "11.11.11.11"]}
/redbird/johnathan.com { "ssl" : true }
/redbird/jeff.com { "docker" : "alpine/alpine:latest" }
Redbird supports automatic node cluster generation. To use, just specify the number of processes that you want Redbird to use in the options object. Redbird will automatically restart any thread that crashes, increasing reliability.
var redbird = new Redbird({
port: 8080,
cluster: 4
});
If you need NTLM support, you can tell Redbird to add the required header handler. This registers a response handler which makes sure the NTLM auth header is properly split into two entries from http-proxy.
var redbird = new Redbird({
port: 8080,
ntlm: true
});
With custom resolvers, you can decide how the proxy server handles request. Custom resolvers allow you to extend Redbird considerably. With custom resolvers, you can perform the following:
Resolvers should be:
this context of such function is the Redbird Proxy object. The resolver function takes in two parameters : host and url {
url: string or array of string [required], when array, the urls will be load-balanced across.
path: path prefix for route, [optional], defaults to '/',
opts: {} // Redbird target options, see Redbird.register() [optional],
}
Resolvers can be defined when initializing the proxy object with the resolvers parameter. An example is below:
// for every URL path that starts with /api/, send request to upstream API service
var customResolver1 = function(host, url, req) {
if(/^\/api\//.test(url)){
return 'http://127.0.0.1:8888';
}
};
// assign high priority
customResolver1.priority = 100;
var proxy = new Redbird({
port: 8080,
resolvers: [
customResolver1,
// uses the same priority as default resolver, so will be called after default resolver
function(host, url, req) {
if(/\.example\.com/.test(host)){
return 'http://127.0.0.1:9999'
}
}]
})
You can add or remove resolvers at runtime, this is useful in situations where your upstream is tied to a service discovery service system.
var topPriority = function(host, url, req) {
return /app\.example\.com/.test(host) ? {
// load balanced
url: [
'http://127.0.0.1:8000',
'http://128.0.1.1:9999'
]
} : null;
};
topPriority.priority = 200;
proxy.addResolver(topPriority);
// remove top priority after 10 minutes,
setTimeout(function() {
proxy.removeResolver(topPriority);
}, 600000);
By passing serverModule: module or ssl: {serverModule : module} you can override the default http/https
servers used to listen for connections with another module.
One application for this is to enable support for PROXY protocol: This is useful if you want to use a module like findhit-proxywrap to enable support for the PROXY protocol.
PROXY protocol is used in tools like HA-Proxy, and can be optionally enabled in Amazon ELB load balancers to pass the original client IP when proxying TCP connections (similar to an X-Forwarded-For header, but for raw TCP). This is useful if you want to run redbird on AWS behind an ELB load balancer, but have redbird terminate any HTTPS connections so you can have SNI/Let's Encrypt/HTTP2support. With this in place Redbird will see the client's IP address rather than the load-balancer's, and pass this through in an X-Forwarded-For header.
//Options for proxywrap. This means the proxy will also respond to regular HTTP requests without PROXY information as well.
proxy_opts = {strict: false};
proxyWrap = require('findhit-proxywrap');
var opts = {
port: process.env.HTTP_PORT,
serverModule: proxyWrap.proxy( require('http'), proxy_opts),
ssl: {
//Do this if you want http2:
http2: true,
serverModule: proxyWrap.proxy(require('spdy').server, proxy_opts),
//Do this if you only want regular https
// serverModule: proxyWrap.proxy( require('http'), proxy_opts),
port: process.env.HTTPS_PORT,
}
}
// Create the proxy
var proxy = new Redbird(opts);
constructor register unregister notFound close
This is the Proxy constructor. Creates a new Proxy and starts listening to the given port.
Arguments
opts {Object} // Options to pass to the proxy:
{
port: {Number} // port number that the proxy will listen to.
ssl: { // Optional SSL proxying.
port: {Number} // SSL port the proxy will listen to.
// Default certificates
key: keyPath,
cert: certPath,
ca: caPath // Optional.
redirectPort: port, // optional https port number to be redirected if entering using http.
http2: false, //Optional, setting to true enables http2/spdy support
serverModule : require('https') // Optional, override the https server module used to listen for https or http2 connections. Default is require('https') or require('spdy')
}
bunyan: {Object} // Bunyan options. Check [bunyan](https://github.com/trentm/node-bunyan) for info.
// If you want to disable bunyan, just set this option to false. Keep in mind that
// having logs enabled incours in a performance penalty of about one order of magnitude per request.
resolvers: {Function | Array} // A list of custom resolvers. Can be a single function or an array of functions. See more details about resolvers above.
serverModule : {Module} // Optional - Override the http server module used to listen for http connections. Default is require('http')
}
Register a new route. As soon as this method is called, the proxy will start routing the sources to the given targets.
Arguments
src {String} {String|URL} // A string or a url parsed by node url module.
// Note that port is ignored, since the proxy just listens to one port.
target {String|URL} // A string or a url parsed by node url module.
opts {Object} // route options:
// examples:
{ssl : true} // Will use default ssl certificates.
{ssl: {
redirect: true, // False to disable HTTPS autoredirect to this route.
key: keyPath,
cert: certPath,
ca: caPath, // optional
secureOptions: constants.SSL_OP_NO_TLSv1 //optional, see below
}
}
{onRequest: (req, res, target) => {
// called before forwarding is occurred, you can modify req.headers for example
// return undefined to forward to default target
}}
Note: if you need to use ssl.secureOptions, to disable older, insecure TLS versions, import crypto/constants first:
const { constants } = require('crypto')
Unregisters a route. After calling this method, the given route will not be proxied anymore.
Arguments
src {String|URL} A string or a url parsed by node url module.
target {String|URL} A string or a url parsed by node url module. If not
specified, it will unregister all routes for the given source.
Gives Redbird a callback function with two parameters, the HTTP request and response objects, respectively, which will be called when a proxy route is not found. The default is
function(req, res){
res.statusCode = 404;
res.write('Not Found');
res.end();
};
.
Arguments
src {Function(req, res)} The callback which will be called with the HTTP
request and response objects when a proxy route is not found.
Close the proxy stopping all the incoming connections.
FAQs
A reverse proxy with support for dynamic tables
The npm package @artcodestudio/redbird receives a total of 6 weekly downloads. As such, @artcodestudio/redbird popularity was classified as not popular.
We found that @artcodestudio/redbird demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.