Provides a http proxy as middleware for the grunt-contrib-connect plugin.
This plugin requires Grunt ~0.4.1
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-connect-proxy --save-devOne the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-connect-proxy');In your project's Gruntfile, add a section named proxies to your existing connect definition.
grunt.initConfig({
connect: {
server: {
options: {
port: 9000,
hostname: 'localhost'
},
proxies: [
{
context: '/cortex',
host: '10.10.2.202',
port: 8080,
https: false,
changeOrigin: false,
xforward: false,
headers: {
"x-custom-added-header": value
}
}
]
}
}
})Add the middleware call from the connect option middleware hook
connect: {
livereload: {
options: {
middleware: function (connect, options) {
var middlewares = [];
var directory = options.directory || options.base[options.base.length - 1];
if (!Array.isArray(options.base)) {
options.base = [options.base];
}
options.base.forEach(function(base) {
// Serve static files.
middlewares.push(connect.static(base));
});
// Setup the proxy
middlewares.push(require('grunt-connect-proxy/lib/utils').proxyRequest);
// Make directory browse-able.
middlewares.push(connect.directory(directory));
return middlewares;
}
}
}
}It is possible to add the proxy middleware without Livereload as follows:
// server
connect: {
server: {
options: {
port: 8000,
base: 'public',
logger: 'dev',
hostname: 'localhost',
middleware: function (connect, options) {
var proxy = require('grunt-connect-proxy/lib/utils').proxyRequest;
return [
// Include the proxy first
proxy,
// Serve static files.
connect.static(options.base),
// Make empty directories browsable.
connect.directory(options.base)
];
}
},
proxies: [ /* as defined above */ ]
}
}For the server task, add the configureProxies task before the connect task
grunt.registerTask('server', function (target) {
grunt.task.run([
'clean:server',
'compass:server',
'configureProxies:server',
'livereload-start',
'connect:livereload',
'open',
'watch'
]);
});IMPORTANT: You must specify the connect target in the configureProxies task.
The available configuration options from a given proxy are generally the same as what is provided by the underlying httpproxy library
Type: String or Array
The context(s) to match requests against. Matching requests will be proxied. Should start with /. Should not end with / Multiple contexts can be matched for the same proxy rule via an array such as: context: ['/api', 'otherapi']
Type: String
The host to proxy to. Should not start with the http/https protocol.
Type: Number
Default: 80
The port to proxy to.
Type: Boolean
Default: false
Whether to proxy with https
Type: Boolean
Default: false
Whether to change the origin on the request to the proxy, or keep the original origin.
Type: Boolean
Default: false
Whether to reject self-signed certificates when https: true is set. Defaults to accept self-signed certs since proxy is meant for development environments.
Type: Boolean
Default: false
Whether to add x-forward headers to the proxy request, such as "x-forwarded-for": "127.0.0.1", "x-forwarded-port": 50892, "x-forwarded-proto": "http"
Type: Boolean
Default: true
Set to false to isolate multi-task configuration proxy options from parent level instead of appending them.
Type: Object
Allows rewrites of url (including context) when proxying. The object's keys serve as the regex used in the replacement operation. As an example the following proxy configuration will remove the context when proxying:
proxies: [
context: '/context',
host: 'host',
port: 8080,
rewrite: {
'^/removingcontext': '',
'^/changingcontext': '/anothercontext'
}
]Type: Number
The connection timeout in milliseconds. The default timeout is 2 minutes (120000 ms).
Type: Object
A map of headers to be added to proxied requests.
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.
grunt-contrib-connect multi-server configuration is supported. You can define proxies blocks in per-server options and refer to those blocks in task invocation.
grunt.initConfig({
connect: {
options: {
port: 9000,
hostname: 'localhost'
},
server2: {
proxies: [
{
context: '/cortex',
host: '10.10.2.202',
port: 8080,
https: false,
changeOrigin: false
}
]
},
server3: {
appendProxies: false,
proxies: [
{
context: '/api',
host: 'example.org'
}
]
}
}
})
grunt.registerTask('e2etest', function (target) {
grunt.task.run([
'configureProxies:server2',
'open',
'karma'
]);
});- 0.1.0 Initial release
- 0.1.1 Fix changeOrigin
- 0.1.2 Support multiple server definitions, bumped to grunt 0.4.1 (thanks to @lauripiispanen)
- 0.1.3 Bumped http-proxy dependency to 0.10.2
- 0.1.4 Added proxy rewrite support (thanks to @slawrence)
- 0.1.5 Default rejectUnauthorized to false to allow self-signed certificates over SSL
- 0.1.6 Add xforward option, added support for context arrays, added debug logging