Package Exports
- http2-proxy
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (http2-proxy) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
node-http2-proxy
A simple high performance http/2 & http/1.1 to http/1.1 spec compliant proxy helper for Node.
Features
- Proxies HTTP 2, HTTP 1.1 and WebSocket
- Simple and easy to follow implementation
- GC friendly with minimal allocations
- Hop by hop header handling
- Connection header handling
- Via header handling
- Forwarded header handling
Installation
$ npm install http2-proxy
Notes
http2-proxy
requires node v8.5.0 or newer with http2
enabled. Pass the --expose-http2
option when starting node v8.x.x.
Usage
You must pass allowHTTP1: true
to the http2.createServer
or http2.createSecureServer
factory methods.
import http2 from 'http2'
import proxy from 'http2-proxy'
const server = http2.createServer({ allowHTTP1: true })
server.listen(8000)
Proxy HTTP 1.1/2 and WebSocket
server.on('request', (req, res) => {
proxy.web(req, res, {
hostname: 'localhost'
port: 9000
}, err => console.error(err, 'proxy error'))
})
server.on('upgrade', (req, socket, head) => {
proxy.ws(req, socket, head, {
hostname: 'localhost'
port: 9000
}, err => console.error('proxy error', err))
})
Use Helmet to secure response headers
server.on('request', (req, res) => {
proxy.web(req, res, {
hostname: 'localhost'
port: 9000,
onRes: (req, res) => helmet(req, res, () => {})
}, err => console.error('proxy error', err))
})
Add x-forwarded headers
server.on('request', (req, res) => {
proxy.web(req, res, {
hostname: 'localhost'
port: 9000,
onReq: (req, { headers }) => {
headers['x-forwarded-for'] = req.socket.remoteAddress
headers['x-forwarded-proto'] = req.socket.encrypted ? 'https' : 'http'
headers['x-forwarded-host'] = req.headers['host']
}
}, err => console.error(err, 'proxy error'))
})
API
web (req, res, options, onProxyError)
req
:http.IncomingMessage
orhttp2.Http2ServerRequest
.res
:http.ServerResponse
orhttp2.Http2ServerResponse
.options
: See Options.onProxyError(err)
: Called on error.
See request
ws (req, socket, head, options, onProxyError)
req
:http.IncomingMessage
.socket
:net.Socket
.head
:Buffer
.options
: See Options.onProxyError(err)
: Called on error.
See upgrade
Options
hostname
: Proxyhttp.request(options)
target hostname.port
: Proxyhttp.request(options)
target port.proxyTimeout
: Proxyhttp.request(options)
timeout.proxyName
: Proxy name used for Via header.timeout
:http.IncomingMessage
orhttp2.Http2ServerRequest
timeoutonReq(req, options)
: Called before proxy request. Note you cannot keep a reference to the options object as it will be re-used byhttp2-proxy
.req
:http.IncomingMessage
orhttp2.Http2ServerRequest
options
: Options passed tohttp.request(options)
.
onRes(req, resOrSocket)
: Called before proxy response.req
:http.IncomingMessage
orhttp2.Http2ServerRequest
.resOrSocket
: Forweb
http.ServerResponse
orhttp2.Http2ServerResponse
and forws
net.Socket
.