Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ebeigarts committed Aug 25, 2017
1 parent c43b0d0 commit f66c31c
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Deployer

Deploy [dokku](http://dokku.viewdocs.io/dokku/) applications using [GitHub Deployments](https://developer.github.com/v3/repos/deployments/).
Deploy [dokku](http://dokku.viewdocs.io/dokku/) applications using [GitHub Deployments API](https://developer.github.com/v3/repos/deployments/).

1. Listen/poll new GitHub deployments
2. Create pending GitHub deployment status and empty Gist
Expand Down Expand Up @@ -40,6 +40,31 @@ deployer -h
GitHub username (required)
```

## Installation

Install `deployer` on dokku server:

```bash
$ su - dokku
$ curl -L -o deployer https://github.com/mak-it/deployer/releases/download/v0.1.1/deployer-linux-amd64
$ chmod +x deployer
```

Start `deployer` on system reboot using `cron` and `screen`:

```bash
$ su - dokku
$ echo "@reboot /usr/bin/screen -d -m /home/dokku/deployer -u ghuser -p ghpass -org mak-it -repo myapp -env demo -app myapp-demo -sleep 30
" | crontab -
```

Start `deployer` in `screen`:

```bash
$ su - dokku
$ /usr/bin/screen -d -m /home/dokku/deployer -u ghuser -p ghpass -org mak-it -repo myapp -env demo -app myapp-demo -sleep 30
```

## Example

Trigger deployment from developer's machine:
Expand Down

0 comments on commit f66c31c

Please sign in to comment.