https://github.com/niradler/remote-deployer
A tool to run scripts on a remote server.
https://github.com/niradler/remote-deployer
deploy deployer deployment http remote ssh
Last synced: 7 months ago
JSON representation
A tool to run scripts on a remote server.
- Host: GitHub
- URL: https://github.com/niradler/remote-deployer
- Owner: niradler
- Created: 2018-11-06T23:33:04.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-02-07T14:38:59.000Z (about 6 years ago)
- Last Synced: 2025-04-02T09:46:47.664Z (12 months ago)
- Topics: deploy, deployer, deployment, http, remote, ssh
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/remote-deployer
- Size: 86.9 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](https://devresources.site/),
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](https://niradler.com/introduction-remote-deployer/).
### TODO
- restore to last deployed commit and deploy.
- ftp deploy