grunt-nginx
Grunt task for Nginx to start, stop and restart a server.
Getting Started
Install the plugin with this command:
npm install grunt-nginx --save-dev
Then add this line to your project's Gruntfile.js
gruntfile:
grunt;
Overview
Inside your Gruntfile.js
file add a section called nginx
. This section specifies the nginx
task and any options you want to pass to it.
Arguments
grunt-nginx uses colon-separated arguments for the nginx
tasks:
- nginx:start
- nginx:stop
- nginx:restart
These are all self-explanatory.
Options
string
- required
config Specify which configuration file Nginx should use instead of the default.
string
- optional
prefix Sets the prefix path (default: /usr/local/nginx/). Any references in the config file will be relative to this path.
string
- optional
globals Sets global directives. Further Information can be found here.
string
- optional
test Don't run, just test the configuration file. Nginx checks configuration for correct syntax and then try to open files referred in configuration.
boolean
- optional
useSudo Runs nginx with sudo. Useful if you want to run it on port 80.
Paths
grunt-nginx supports both absolute and relative paths. Like most grunt plugins, relative paths are with respect to the Gruntfile.js
gruntfile.
Example
nginx: options: config: '/path/to/nginx.conf' prefix: './relative/path/nginx' globals: 'pid /var/run/nginx.pid' 'worker_processes 2' grunt;