A simple http/2 & http/1.1 to http/1.1 spec compliant proxy helper for Node.
- Proxies HTTP 2, HTTP 1.1 and WebSocket
- Simple and easy to follow implementation
- Hop by hop header handling
- Connection header handling
- Via header handling
- Forwarded header handling
$ npm install http2-proxy
http2-proxy
requires node v8.5.0 or newer with http2
enabled. See nightly node builds or building node from source. Pass the --expose-http2
option when starting node v8.x.x.
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)
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))
})
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'))
})
req
:http.IncomingMessage
orhttp2.Http2ServerRequest
res
:http.ServerResponse
orhttp2.Http2ServerResponse
options
: see OptionsonProxyError(err)
: called on error
See request
req
:http.IncomingMessage
socket
:net.Socket
head
:Buffer
options
: see OptionsonProxyError(err)
: called on error
See upgrade
hostname
: proxyhttp.request(options)
target hostnameport
: proxyhttp.request(options)
target portproxyTimeout
: proxyhttp.request(options)
timeoutproxyName
: proxy name used for Via headertimeout
:http.IncomingMessage
orhttp2.Http2ServerRequest
timeoutonReq(req, options)
: called before proxy requestreq
:http.IncomingMessage
orhttp2.Http2ServerRequest
options
: options passed tohttp.request(options)
onRes(req, resOrSocket)
: called before proxy responsereq
:http.IncomingMessage
orhttp2.Http2ServerRequest
resOrSocket
: Forweb
http.ServerResponse
orhttp2.Http2ServerResponse
and forws
net.Socket