http-proxy-middleware
Node.js proxying made simple. Configure proxy middleware with ease for connect, express, browser-sync and many more.
Powered by the popular Nodejitsu http-proxy
.
TL;DR
Proxy /api
requests to http://www.example.org
All http-proxy
options can be used, along with some extra http-proxy-middleware
options.
💡 Tip: Set the option changeOrigin
to true
for name-based virtual hosted sites.
Table of Contents
Install
Core concept
Proxy middleware configuration.
proxy([context,] config)
context: Determine which requests should be proxied to the target host. (more on context matching)
options.target: target host to proxy to. (protocol + host)
(full list of http-proxy-middleware
configuration options)
proxy(uri [, config])
More about the shorthand configuration.
Example
An example with express
server.
Context matching
Providing an alternative way to decide which requests should be proxied; In case you are not able to use the server's path
parameter to mount the proxy or when you need more flexibility.
RFC 3986 path
is used for context matching.
path matching
proxy({...})
- matches any path, all requests will be proxied.proxy('/', {...})
- matches any path, all requests will be proxied.proxy('/api', {...})
- matches paths starting with/api
multiple path matching
proxy(['/api', '/ajax', '/someotherpath'], {...})
wildcard path matching
For fine-grained control you can use wildcard matching. Glob pattern matching is done by micromatch. Visit micromatch or glob for more globbing examples.
proxy('**', {...})
matches any path, all requests will be proxied.proxy('**/*.html', {...})
matches any path which ends with.html
proxy('/*.html', {...})
matches paths directly under path-absoluteproxy('/api/**/*.html', {...})
matches requests ending with.html
in the path of/api
proxy(['/api/**', '/ajax/**'], {...})
combine multiple patternsproxy(['/api/**', '!**/bad.json'], {...})
exclusion
Note: In multiple path matching, you cannot use string paths and wildcard paths together.
custom matching
For full control you can provide a custom function to determine which requests should be proxied or not.
Options
http-proxy-middleware options
option.pathRewrite: object/function, rewrite target's url path. Object-keys will be used as RegExp to match paths.
option.router: object/function, re-target
option.target
for specific requests.option.logLevel: string, ['debug', 'info', 'warn', 'error', 'silent']. Default:
'info'
option.logProvider: function, modify or replace log provider. Default:
console
.(DEPRECATED) option.proxyHost: Use
option.changeOrigin = true
instead.(DEPRECATED) option.proxyTable: Use
option.router
instead.
http-proxy events
Subscribe to http-proxy events:
option.onError: function, subscribe to http-proxy's
error
event for custom error handling.option.onProxyRes: function, subscribe to http-proxy's
proxyRes
event.option.onProxyReq: function, subscribe to http-proxy's
proxyReq
event.option.onProxyReqWs: function, subscribe to http-proxy's
proxyReqWs
event.option.onOpen: function, subscribe to http-proxy's
open
event.option.onClose: function, subscribe to http-proxy's
close
event.
http-proxy options
The following options are provided by the underlying http-proxy library.
option.target: url string to be parsed with the url module
option.forward: url string to be parsed with the url module
option.agent: object to be passed to http(s).request (see Node's https agent and http agent objects)
option.ssl: object to be passed to https.createServer()
option.ws: true/false: if you want to proxy websockets
option.xfwd: true/false, adds x-forward headers
option.secure: true/false, if you want to verify the SSL Certs
option.toProxy: true/false, passes the absolute URL as the
path
(useful for proxying to proxies)option.prependPath: true/false, Default: true - specify whether you want to prepend the target's path to the proxy path
option.ignorePath: true/false, Default: false - specify whether you want to ignore the proxy path of the incoming request (note: you will have to append / manually if required).
option.localAddress : Local interface string to bind for outgoing connections
option.changeOrigin: true/false, Default: false - changes the origin of the host header to the target URL
option.preserveHeaderKeyCase: true/false, Default: false - specify whether you want to keep letter case of response header key
option.auth : Basic authentication i.e. 'user:password' to compute an Authorization header.
option.hostRewrite: rewrites the location hostname on (301/302/307/308) redirects.
option.autoRewrite: rewrites the location host/port on (301/302/307/308) redirects based on requested host/port. Default: false.
option.protocolRewrite: rewrites the location protocol on (301/302/307/308) redirects to 'http' or 'https'. Default: null.
option.cookieDomainRewrite: rewrites domain of
set-cookie
headers. Possible values:false
(default): disable cookie rewritingString: new domain, for example
cookieDomainRewrite: "new.domain"
. To remove the domain, usecookieDomainRewrite: ""
.Object: mapping of domains to new domains, use
"*"
to match all domains. For example keep one domain unchanged, rewrite one domain and remove other domains:
option.cookiePathRewrite: rewrites path of
set-cookie
headers. Possible values:false
(default): disable cookie rewritingString: new path, for example
cookiePathRewrite: "/newPath/"
. To remove the path, usecookiePathRewrite: ""
. To set path to root usecookiePathRewrite: "/"
.Object: mapping of paths to new paths, use
"*"
to match all paths. For example, to keep one path unchanged, rewrite one path and remove other paths:
option.headers: object, adds request headers. (Example:
{host:'www.example.org'}
)option.proxyTimeout: timeout (in millis) when proxy receives no response from target
option.timeout: timeout (in millis) for incoming requests
option.followRedirects: true/false, Default: false - specify whether you want to follow redirects
option.selfHandleResponse true/false, if set to true, none of the webOutgoing passes are called and it's your responsibility to appropriately return the response by listening and acting on the
proxyRes
eventoption.buffer: stream of data to send as the request body. Maybe you have some middleware that consumes the request stream before proxying it on e.g. If you read the body of a request into a field called 'req.rawbody' you could restream this field in the buffer option:
Shorthand
Use the shorthand syntax when verbose configuration is not needed. The context
and option.target
will be automatically configured when shorthand is used. Options can still be used if needed.
app.use(path, proxy)
If you want to use the server's app.use
path
parameter to match requests; Create and mount the proxy without the http-proxy-middleware context
parameter:
app.use
documentation:
express: http://expressjs.com/en/4x/api.html#app.use
connect: https://github.com/senchalabs/connect#mount-middleware
WebSocket
External WebSocket upgrade
In the previous WebSocket examples, http-proxy-middleware relies on a initial http request in order to listen to the http upgrade
event. If you need to proxy WebSockets without the initial http request, you can subscribe to the server's http upgrade
event manually.
Working examples
View and play around with working examples.
Browser-Sync (example source)
express (example source)
connect (example source)
WebSocket (example source)
Recipes
View the recipes for common use cases.
Compatible servers
http-proxy-middleware
is compatible with the following servers:
Sample implementations can be found in the server recipes.
Tests
Run the test suite:
Changelog
License
The MIT License (MIT)
Copyright (c) 2015-2018 Steven Chim
Last updated