HTTP proxying for the masses
node-http-proxy is an HTTP programmable proxying library that supports
websockets. It is suitable for implementing components such as reverse
proxies and load balancers.
npm install http-proxy --save
A new proxy is created by calling
createProxyServer and passing
options object as argument (valid properties are available here)
var httpProxy = ;var proxy = httpProxy; // See (†)
†Unless listen(..) is invoked on the object, this does not create a webserver. See below.
An object will be returned with four methods:
req, res, [options](used for proxying regular HTTP(S) requests)
req, socket, head, [options](used for proxying WS(S) requests)
port(a function that wraps the object in a webserver, for your convenience)
[callback](a function that closes the inner webserver and stops listening on given port)
It is then possible to proxy requests by calling these functions
Errors can be listened on either using the Event Emitter API
or using the callback API
When a request is proxied it follows two different pipelines (available here)
which apply transformations to both the
The first pipeline (ingoing) is responsible for the creation and manipulation of the stream that connects your client to the target.
The second pipeline (outgoing) is responsible for the creation and manipulation of the stream that, from your target, returns data
to the client.
var http =httpProxy = ;//// Create your proxy server and set the target in the options.//httpProxy; // See (†)//// Create your target server//http;
†Invoking listen(..) triggers the creation of a web server. Otherwise, just the proxy instance is created.
This example show how you can proxy a request using your own HTTP server and also you can put your own logic to handle the request.
var http =httpProxy = ;//// Create a proxy server with custom application logic//var proxy = httpProxy;//// Create your custom server and just call `proxy.web()` to proxy// a web request to the target passed in the options// also you can use `proxy.ws()` to proxy a websockets request//var server = http;consoleserver;
This example shows how you can proxy a request using your own HTTP server that modifies the outgoing proxy request by adding a special header.
var http =httpProxy = ;//// Create a proxy server with custom application logic//var proxy = httpProxy;// To modify the proxy connection before data is sent, you can listen// for the 'proxyReq' event. When the event is fired, you will receive// the following arguments:// (http.ClientRequest proxyReq, http.IncomingMessage req,// http.ServerResponse res, Object options). This mechanism is useful when// you need to modify the proxy request before the proxy connection// is made to the target.//proxy;var server = http;consoleserver;
Sometimes when you have received a HTML/XML document from the server of origin you would like to modify it before forwarding it on.
Harmon allows you to do this in a streaming style so as to keep the pressure on the proxy to a minimum.
var http =httpProxy = ;//// Create a proxy server with latency//var proxy = httpProxy;//// Create your server that makes an operation that waits a while// and then proxies the request//http;//// Create your target server//http;
You can activate the validation of a secure SSL certificate to the target connection (avoid self signed certs), just set
secure: true in the options.
//// Create the HTTPS proxy server in front of a HTTP server//httpProxy;
//// Create the proxy server listening on port 443//httpProxy;
You can activate the websocket support for the proxy using
ws:true in the options.
//// Create a proxy server for websockets//httpProxy;
Also you can proxy the websocket requests just calling the
ws(req, socket, head) method.
//// Setup our server to proxy standard HTTP requests//var proxy =target:host: 'localhost'port: 9015;var proxyServer = http;//// Listen to the `upgrade` event and proxy the// WebSocket requests as well.//proxyServer;proxyServer;
httpProxy.createProxyServer supports the following options:
path(useful for proxying to proxies)
options.ssl are optional.
options.forward cannot both be missing
If you are using the
proxyServer.listen method, the following options are also applicable:
error: The error event is emitted if the request to the target fail. We do not do any error handling of messages passed between client and proxy, and messages passed between proxy and target, so it is recommended that you listen on errors and handle them.
proxyReq: This event is emitted before the data is sent. It gives you a chance to alter the proxyReq request object. Applies to "web" connections
proxyReqWs: This event is emitted before the data is sent. It gives you a chance to alter the proxyReq request object. Applies to "websocket" connections
proxyRes: This event is emitted if the request to the target got a response.
open: This event is emitted once the proxy websocket was created and piped into the target websocket.
close: This event is emitted once the proxy websocket was closed.
proxySocket: Deprecated in favor of
var httpProxy = ;// Error example//// Http Proxy Server with bad target//var proxy = httpProxy;proxy;//// Listen for the `error` event on `proxy`.proxy;//// Listen for the `proxyRes` event on `proxy`.//proxy;//// Listen for the `open` event on `proxy`.//proxy;//// Listen for the `close` event on `proxy`.//proxy;
var proxy =target:host: 'localhost'port: 1337;proxy;
A proxy table API is available through this add-on module, which lets you define a set of rules to translate matching routes to target routes that the reverse proxy will talk to.
$ npm test
Logo created by Diego Pasquali
The MIT License (MIT)
Copyright (c) 2010 - 2016 Charlie Robbins, Jarrett Cruger & the Contributors.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.