Node-ftpsync

An FTP synchronization app for NodeJS based on jsftp. With an emphasis on speed and simplicity ftpsync aims to fulfull your one-click file deployment needs.

Notice: The core functionality to push files to a remote server is now fully implemented. Until the timestamp comparison logic is worked out, updates (ie overwriting files) are determined solely by comparing file sizes. This is not ftp-deploy. This application will delete files and directories on the remote server to match the local machine. Use this application in production at your own risk.

Usage

$ ftpsync --help

 Usage: ftpsync [options]

 Options:

   -h, --help            output usage information
   -V, --version         output the version number
   -v, --verbose         Verbose logging
   -l, --local []        Local root path
   -r, --remote []       Remote root path
   -h, --host []         FTP host name/address
   -p, --port <>         FTP connection port
   -u, --user []         FTP user name
   -s, --pass []         FTP password
   -c, --connections <>  Max number of concurrent FTP connections
   -i, --ignore <items>  List of files to ignore (separated by commas)

See ftpsync.settings{} for detailed info about the settings.

Using a config file

As an alternative to the traditional command line interface a config file may also be used to load the settings.

Step 1 - Create a configuration file

config.json

{
  "local":"~/www/",
  "remote":"/",
  "host":"example.com",
  "port":21,
  "user":"username",
  "pass":"password",
  "connections":"2",
  "ignore":[
    ".htaccess"
  ]
}

See ftpsync.settings{} for detailed info about the settings.

Step 2 - Place the config file in the directory where ftpsync will be exectued

By default ftpsync will use the configuration supplied buy a config.json file located in the CWD.

Step 3 - Run the script

ftpsync

Optional - Logging to a file

To log the output to a file simply pipe STDOUT to a log file.

ftpsync > ftpsync.log &

API

Declaring ftpsync

Basic usage example

var ftpSync = require('ftpsync');

var options = {
  host: 'localhost',
  user: 'testuser',
  pass: 'password',
  local: '/your/local/directory',
  remote: 'directoryname'
};

ftpSunc.settings = options;
ftpSync.run(function(err, result) {

  ... your code ...

};

options{} an object containing settings for ftpsync.

See ftpsync.settings{} for detailed info about the settings.

ftpsync.settings{}

Contains the application settings for ftpsync.

host - hostname/address of the remote ftp server (required).
port - port of the remote ftp server (default 21).
user - ftp username (required).
pass - ftp password (required).
local - the root directory of the local host (default './').
remote - the root path of the remote server (default './').
connections - the max number of concurrent ftp connections (default 1).
ignore - the list of file patterns to ignore.

Note: Ignore patterns can be defined as a filename, file path, or glob match.

ftpsync.local{}

The file and directory listings for the local host.

ftpsync.local.dirs - contains a simple list.

Each path represents a local directory.

ftpsync.local.files - contains a list of objects.

Each object in the list represents a file and contains a id, size, and time attribute with the requisite values for that file.

Populated by running collect() or utils.walkLocal().

ftpsync.remote{}

The file and directory listings for the remote host.

ftpsync.remote.dirs - contains a simple list.

Each path represents a remote directory.

ftpsync.remote.files - contains a list of objects.

Each object in the list represents a file and contains a id, size, and time attribute with the requisite values for that file.

Populated by running collect() or utils.walkremote().