Forever SSH Deploy

a simple deployment tool for node.js

Installation

npm install forever-ssh-deploy

Deployment Process

1. zip the source folder [srcFolderPath]

   • if you set field "modifiedHours" with number, only files modified within limit hours are to be included

2. upload the zip file onto the server via SFTP (authentication by either private key or password)

   • you can set different servers at one time

3. unzip and execute bash script to restart the project

   • the default script uses forever to start "index.js" located at the parent folder of the remote folder [destFolderPath]

   • you can override the bash script via field "initScript" in the constructor argument for class Deploy

Example Usage

There are two examples in examples folder. One is for SFTP certification with private key and another is for password. Five mandatory fields for argument: author, srcFolderPath, destFolderPath, privateKeyPath | password, host, username. Optional field: port

const Deploy = require('forever-ssh-deploy');

const author = 'your name';
const srcFolderPath = 'the path for the local project sub folder which is to replace the remote counterpart';
const modifiedHours = 24;
const deployConfigs = [
    {
        destFolderPath: 'remote project sub folder which is to be replaced by the local counterpart',
        host: 'xxx.xxx.xxx.xxx',
        username: 'developer',
        port: 22,
        privateKeyPath: 'path for ssh private key'
    },
    {
        destFolderPath: 'remote project #2 sub folder which is to be replaced by the local counterpart',
        host: 'yyy.yyy.yyy.yyy',
        username: 'developer #2',
        port: 22,
        privateKeyPath: 'path for ssh private key'
    }
]

const deploy = new Deploy({author, srcFolderPath, modifiedHours, servers: deployConfigs});
deploy.exec();

Default Init Script

#!/bin/bash
# author: WangFan
# description: backup server directory
time1=$(date +"%Y-%m-%dT%H-%M-%S")
str1='server.'
str2='${author}.tar.gz'
time2=$str1$time1$str2
tar -czvf $time2 server &&
 unzip -o server.zip -d ${destFolderPath} &&
 sleep 2 &&
 rm -f server.zip &
 nohup forever stop index.js &
 forever start -o nohup.out -e nohup.out index.js