Update README with recent changes
authorSofian Brabez <sbz@6dev.net>
Fri, 27 Jul 2018 13:48:21 +0000 (14:48 +0100)
committerSofian Brabez <sbz@6dev.net>
Fri, 27 Jul 2018 13:48:21 +0000 (14:48 +0100)
README.md

index 8c91603271355c4b8a70636577f503718a187c06..4a2d0a2ac066e956987479d47b328905dfc5b6e1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -23,12 +23,17 @@ GOOS=linux go build
 
 ## Build Docker container
 
+Container is released on [docker-hub][3] using the following command:
+
 ```
 ./build.sh or bash -x build.sh --no-cache
 ```
 
 # Required Env Vars
 
+* `AWS_ACCESS_KEY_ID`: AWS key
+* `AWS_SECRET_ACCESS_KEY` : AWS secret key
+* `AWS_REGION`: AWS region
 * `MONITOR_VAULT_URL`: HTTPS Vault Address (Format URL:PORT)
 * `MONITOR_ETCD_URL`: HTTP Etcd Address  (Format URL:PORT)
 * `MONITOR_SLACKWEBHOOK_URL`: HTTPS Slack Webhook URL
@@ -39,6 +44,9 @@ GOOS=linux go build
 
 ```
 cat <<EOF >vars
+AWS_ACCESS_KEY_ID=AKIAI2V7TASZJWHPOFEQ
+AWS_SECRET_ACCESS_KEY=<PASSWORD>
+AWS_REGION=eu-central-1
 MONITOR_VAULT_URL=https://vault-address:8200
 MONITOR_ETCD_URL=http://etcd-address:2379
 MONITOR_SLACK_WEBHOOK_URL=https://hooks.slack.com/services/xxx/yyy
@@ -51,3 +59,4 @@ docker run --env-file vars gonitro/vaultmon:latest
 
 [1]: https://github.com/hashicorp/vault
 [2]: https://github.com/coreos/etcd
+[3]: https://hub.docker.com/r/gonitro/vaultmon