Skip to content

Commit

Permalink
Merge pull request #7 from tam7t/readme-1.0.0
Browse files Browse the repository at this point in the history
readme: v1 usage
  • Loading branch information
tam7t committed Feb 25, 2016
2 parents e1e4455 + 786d85b commit 9073f0a
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,20 @@ This utility helps secure the `private` interface on DigitalOcean droplets by
adding `iptable` rules that only allow traffic from your other droplets. `dolan`
queries the DigitalOcean API and automatically updates `iptable` rules.

## Installation

The latest release is available on the github [release page](https://github.com/tam7t/dolan/releases).

You can setup a cron job to run every 5 minutes in `/etc/cron.d`

```
*/5 * * * * root PATH=/sbin DO_KEY=READONLY_KEY /usr/local/bin/dolan >/var/log/dolan.log 2>&1
```

## Usage

```
DO_KEY=<read_only_api_token> /path/to/dolan_linux_amd64
DO_KEY=<read_only_api_token> /path/to/dolan
```

The `iptables` rules added by `dolan` are equivalent to:
Expand All @@ -31,5 +41,5 @@ Dependencies are vendored with [govendor](https://github.com/kardianos/govendor)

A `Makefile` is included:
* `test` - runs unit tests
* `build` - builds `dolan` for all platforms
* `build_local` - builds `dolan` for just the local architecture
* `build` - builds `dolan` on the current platform
* `release` - builds releasable artifacts

0 comments on commit 9073f0a

Please sign in to comment.