SSH Deployer

SSH-Deployer is designed to run commands and copy files/directories over SSH using a preconfigured JSON file.

Usage: ssh-deployer [options]

Options:
  -f, --file  JSON Configuration File       [required]

Getting Started

Install 'ssh-deployer' globally by running the following command.

npm install -g ssh-deployer

Create your JSON file. In this case it would be....

{
    "machine": {
        "host": "192.168.1.100",
        "username": "your-ssh-username",
        "password": "your-ssh-password"
    },
    "directories": [
        {
            "source": "./dist",
            "destination": "/uploads"
        }
    ],
    "files": [
        {
            "source": "./web.config",
            "destination": "/opt/app/web.config"
        }
    ],
    "commands": [
        "sudo apt-get update",
        "sudo ufw status"
    ]
}

Saved as 'sample.json'

To execute this file, run the following command.

ssh-deployer --file "sample.json"

Adding parameters to JSON file.

In the previous example the mahcine host, username and password was hard-coded.

Parameters can be added by using the '$' sign. For example.

{
    "machine": {
        "host": "$host",
        "username": "$username",
        "password": "$password"
    },
    "directories": [
        {
            "source": "./dist",
            "destination": "/uploads"
        }
    ],
    "files": [
        {
            "source": "./web.config",
            "destination": "/opt/$appname/web.config"
        }
    ],
    "commands": [
        "sudo apt-get update",
        "sudo ufw status"
    ]
}

To execute this file with parameters, run the following command.

ssh-deployer --file "sample.json" --host 192.168.1.100 --username hello --password world --appname myapp

Notes

The order of execution is as follow:

• Copies directories in the given order.
• Copies files in the given order.
• Executes commands in the given order.