emp.ria-emp.ria-grunt-ftp-deploy

This is a grunt task for code deployment over the ftp protocol.

For simplicity purposes this task avoids deleting any files and it is not trying to do any size or time stamp comparison. It simply transfers all the files (and folder structure) from your dev / build location to a location on your server.

Getting Started

This plugin requires Grunt ~0.4.0

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 emp.ria-grunt-ftp-deploy --save-dev

and load the task:

grunt.loadNpmTasks('emp.ria-grunt-ftp-deploy');

Usage

To use this task you will need to include the following configuration in your grunt file:

'ftp-deploy': {
  build: {
    auth: {
      host: 'server.com',
      port: 21,
      authKey: 'key1'
    },
    files: [
      {expand: true, cwd: 'path/to/source/folder', src: '*', dest: '/path/to/destination/folder'},
    ]
  }
}

The parameters in our configuration are:

• host - the name or the IP address of the server we are deploying to
• port - the port that the ftp service is running on
• authKey - a key for looking up saved credentials in .ftppass (see next section). If no value is defined, the host parameter will be used
• src - the source location, the local folder that we are transferring to the server
• dest - the destination location, the folder on the server we are deploying to
• exclusions - an optional parameter allowing us to exclude files and folders by utilizing grunt's support for minimatch. The matchBase minimatch option is enabled, so .git* would match the path /foo/bar/.gitignore.

Authentication parameters

Usernames and passwords can be stored in an optional JSON file named .ftppass. This file should be located in the same folder as your Gruntfile. .ftppass should have the following format:

{
  "key1": {
    "username": "username1",
    "password": "password1"
  },
  "key2": {
    "username": "username2",
    "password": "password2"
  }
}

This way we can save as many username / password combinations as we want and look them up by the authKey value defined in the grunt config file where the rest of the target parameters are defined.

The task prompts for credentials that are not found in .ftppass and it prompts for all credentials if .ftppass does not exist.

IMPORTANT: make sure that the .ftppass file uses double quotes (which is the proper JSON syntax) instead of single quotes for the names of the keys and the string values.

Dependencies

This task is built by taking advantage of the great work of Sergi Mansilla and his jsftp node.js module and suited for the 0.4.x branch of grunt.