A Node.js package to help with deploying code. Ftp a folder from your local disk to a remote ftp destination. Does not delete from destination directory.
npm install --save-dev ftp-deploy(Need sftp? Check out sftp-upload)
I've taken over from Rick in May 2017, and will start working on the deprecation warnings, and the 'delete remote directory' requests.
I create a file - e.g. deploy.js - in the root of my source code and add a script to its package.json so that I can npm run deploy.
"scripts": {
"deploy": "node deploy"
},The most basic usage (stops uploading when an error occurs):
var FtpDeploy = require('ftp-deploy');
var ftpDeploy = new FtpDeploy();
var config = {
username: "username",
password: "password", // optional, prompted if none given
host: "ftp.someserver.com",
port: 21,
localRoot: __dirname + "/local-folder",
remoteRoot: "/public_html/remote-folder/",
include: ['*.php', 'dist/*'],
exclude: ['.*', 'tmp/*', 'build/*']
}
ftpDeploy.deploy(config, function(err) {
if (err) console.log(err)
else console.log('finished');
});include: all files that match will be uploaded.exclude: all files that match willnopt be uploaded- default: All files that match neither test WILL be uploaded
To be notified of what ftpDeploy is doing:
ftpDeploy.on('uploading', function(data) {
data.totalFileCount; // total file count being transferred
data.transferredFileCount; // number of files transferred
data.percentComplete; // percent as a number 1 - 100
data.filename; // partial path with filename being uploaded
});
ftpDeploy.on('uploaded', function(data) {
console.log(data); // same data as uploading event
});To continue uploading files even if a file upload fails:
config = {
// .. your other configuration here ..
continueOnError: true
};
ftpDeploy.on('upload-error', function (data) {
console.log(data.err); // data will also include filename, relativePath, and other goodies
});I use proftpd to create a simple ftp server at test/remote and then run the script at node ./test/test
MIT