From 42d4e673e809fededf7d2bb59e99178870109082 Mon Sep 17 00:00:00 2001 From: Tommy Murphy Date: Wed, 24 Feb 2016 21:04:57 -0500 Subject: [PATCH 1/2] readme: v1 usage --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 72be7eb..2c6fde3 100644 --- a/README.md +++ b/README.md @@ -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= /path/to/dolan_linux_amd64 +DO_KEY= /path/to/dolan ``` The `iptables` rules added by `dolan` are equivalent to: From 786d85b42eec0d91aa03aa4c54580bf8a5b54660 Mon Sep 17 00:00:00 2001 From: Tommy Murphy Date: Wed, 24 Feb 2016 21:07:11 -0500 Subject: [PATCH 2/2] reamde: update makefile targets --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2c6fde3..778c453 100644 --- a/README.md +++ b/README.md @@ -41,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