ftp-deploy

ftp-deploy

Ftp a folder from your local disk to a remote ftp destination. Does not delete from destination directory. Derived from https://github.com/zonak/grunt-ftp-deploy.

A Node.js package.

Usage

var FtpDeploy = require('ftp-deploy');
var ftpDeploy = new FtpDeploy();

var config = {
	username: "username",
	password: "password",
	host: "ftp.someserver.com",
	port: 21,
	localRoot: __dirname + "/local-folder",
	remoteRoot: "/public_html/remote-folder/",
	parallelUploads: 10,
	exclude: ['.git', '.idea', 'tmp/*']
}
	
ftpDeploy.deploy(config, function(err) {
	if (err) console.log(err)
	else console.log('finished');
});

// if you want to be notified of what ftpDeploy is doing
// listen to some of the events it's emitting
// Want more events? Let me know and I'll add them.
ftpDeploy.on('uploading', function(relativeFilePath) {
	console.log('uploading ' + relativeFilePath);
});
ftpDeploy.on('uploaded', function(relativeFilePath) {
	var percentTransferred = Math.round((ftpDeploy.transferred/ftpDeploy.total) * 100);
	console.log(percentTransferred + '% uploaded   ' + relativeFilePath);
});

Changes

• 0.3.x

  • New config setting exclude can be used to exclude folders/files from the ftp deploy process

• 0.2.x

  • Requiring ftp-deploy returns the FtpDeploy object, and you will need to instantiate is separately on your own.
  • New config setting paralleluploads: sets number of parallelUploads (within a specific folder)
  • ftpDeploy instance has properties transferred and total. Useful for determining progress based on file count.

Installation

npm install ftp-deploy

License

MIT

Changelog

0.3.0

• New config setting exclude can be used to exclude folders/files from the ftp deploy process