Skip to content
A tool to run scripts on a remote server.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
.babelrc
.gitignore
.npmignore
README.md
package-lock.json
package.json

README.md

Remote Deployer

Deployer is an npm package to deploy to a remote server.

  • deploy with ssh: connect to the server and run command from a script, good for running from client or build server.
  • deploy with http: create get request with secret key to fire deploy process (preconfigure script run), to set up on the remote server.
  • deploy with ftp: coming soon.

Used by me at devresources, helping me to setup ci/cd with gitlab worker.


Setup

npm i -g remote-deployer

API

  • deployer -h //show help file
  • deployer ssh -h //show sub help file
  • deployer init

Notes

  • to support multi configuration, you need to make sure the default_id key in the config is not set. (you need to run the commands in the project folder)
  • to support running deployer from anywhere but support only one configuration make sure default_id is set.
  • on linux and mac, make sure the script as permission, chmod +x script.sh
  • get config file path: deployer config path
  • print config file: deployer config all
  • try running deployer in the project folder. (deployer will interact with git to save release date/data support ssh only)
  • trigger example for deployer http: curl http://api.site:1234/deploy?appKey=bdd110130eg51a5e8ac15b829e336f7710e3ba71
  • read the blog post.

TODO

  • restore to last deployed commit and deploy.
  • ftp deploy
You can’t perform that action at this time.