Ready to take your JavaScript development to the next level? Meet npm Enterprise - the ultimate in enterprise JavaScript. Learn more »

grunt-node-auto-deploy

1.0.2 • Public • Published

grunt-node-auto-deploy

Automatic deployment of your node apps via grunt to ubuntu server using nginx and upstart.

About

The task connects to your server via SSH (via ssh key only) and writes nginx configuration files. Your app starts on boot a runs as a service via pm2. Application is cloned from it's remote git repository. When the app is cloned, task runs npm install together with optional commands like grunt tasks to build distribution files. Then it reloads nginx.

Dependencies

This grunt task requires you to have linux server (ubuntu 16 tested) running nginx, nodejs, npm, and git.

Issues

Please report all issues you may find. Do it preferably at https://github.com/petrkrulis/grunt-node-auto-deploy/issues. It'll be very helpful.

Changelog

1.0.2

  • empty aliases fix

1.0.1

  • almost zero downtime (fetch & install in temporary folder)
  • dont obtain SSL certificates every time (only when they are not present)

1.0.0

  • now using pm2 instead upstart
  • custom nginx conf file
  • able to obtain letsencrypt certs
  • able to use only static web (no node app)

0.6.4

  • fixed start/stop application in apps subfolder

0.6.3

  • updated dependencies (mainly grunt 1.x.x)

0.6.2

  • /etc/init scripts are saved to the /etc/init/apps subfolder

0.6.1

  • Fixed fatal bug

0.6.0

  • Conf property
  • Alias is now a redirect instead of standalone server

0.5.8

  • Properly close SSH connection after deployment

0.5.5

  • Removed unwanted console output

0.5.4

  • Added support for domain alias (so you can add www subdomain easily)
  • Fixed optional commands order

Getting Started

This plugin requires Grunt >=0.4.5

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-node-auto-deploy --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-node-auto-deploy');

The "node_auto_deploy" task

Overview

In your project's Gruntfile, add a section named node_auto_deploy to the data object passed into grunt.initConfig().

grunt.initConfig({
  node_auto_deploy: {
    options: {
      url: 'petrkrulis.cz',
      alias: ['www.petrkrulis.cz', 'alias.petrkrulis.cz'], // can be string or array
      getSSLCerts: true, (will call 'letsencrypt certonly -a webroot --agree-tos --renew-by-default --webroot-path=/var/www/html -d domain')
      conf: true, // set to false to not upload nginx conf file
      useNode: settings.useNode, // use statis web or nginx proxy to node app
      command: 'node server.js', // discontinued
      index: 'server.js' // nodejs app index
      name: 'petrkrulis-web', // pm2 app name
      port: '8081',
      path: '/var/www/sites',
      nginx: '/etc/nginx/sites-enabled',
      nginxConf: 'nginx.conf' // nginx custom conf file to use
      git: 'git://github.com/petrkrulis.cz/grunt-node-auto-deploy.git',
      branch: 'master',
      ssh: 'user@12.34.56.78',
      before: [
        'echo hello'
      ],
      then: [
        'grunt build'
      ]
    }
  },
});

Options

options.url

Type: String

The URL of your app. If you don't own a domain name yet, just pass example.com to it and add that domain to your hosts file. You can test the app from the browser then.

options.alias

Type: String or Array (optional)

Alias is optional. Use it to redirect for example a www subdomain to your app.

options.conf

Type: Boolean (optional)

Whether to upload ngnix configuration files. Default value is true (will be uploaded). If you need to manage conf files by yourself, let the plugin know not to upload them.

options.command

Type: String

Command used to start the app. Mostly it'll be something like 'node app.js' but you can use anything you need.

options.port

Type: String

NodeJS application port (where the server is listening for connections).

options.path

Type: String

Absolute path to the app. This task takes the options.path path, creates a folder named by the options.url in it and clone the git repository specified in options.git.

options.nginx

Type: String

Path to ngnix sites-enabled folder. Or basicaly any folder where nginx automatically load all conf files and use them in it's configuration.

options.git

Type: String

Git repository to clone. It should contain the app you want to run :)

options.branch

Type: String

The branch which will be cloned from the git repository.

options.ssh

Type: String

SSH server adress. Use ssh key to login instead of password. I decided not to add support for password access. It's insecure and slow and you would need to type itevery time (you don't want to store the password in a gruntfile).

options.before

Type: Array (optional)

It's an optional array of commands executed before anything else. All commands in options.before & options.then are executed from application path (the app's root where package.json is stored).

options.then

Type: Array (optional)

It's an optional array of commands executed after successful deploy and npm install and before start command. Useful as hell if you dont want to include distribution files to git repository. You can easily build them on server, just include all necessary packages in dependecies (not only in devDependencies - this runs in production environment).

Contributing

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.

install

npm i grunt-node-auto-deploy

Downloadsweekly downloads

2

version

1.0.2

license

none

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability