Skip to content

Commit

Permalink
update readme with docker usage
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelneu committed Aug 14, 2019
1 parent 8f7b441 commit 374e159
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,22 @@
# watchdog

[![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/hackaburg/watchdog)](https://hub.docker.com/r/hackaburg/watchdog)
[![MicroBadger Size](https://img.shields.io/microbadger/image-size/hackaburg/watchdog)](https://hub.docker.com/r/hackaburg/watchdog)
[![MicroBadger Layers](https://img.shields.io/microbadger/layers/hackaburg/watchdog))](https://hub.docker.com/r/hackaburg/watchdog)

If run inside a docker-compose setup, the watchdog will notify the configured Slack channel about its shutdown.

## Usage

To get the watchdog, simply pull the `hackaburg/watchdog` image from the Docker hub and pass in your Slack webhook url as an environment variable:

```bash
$ docker run \
--rm \
-it \
-e SLACK_WEBHOOK_URL=https://your-slack-webhook_url \
hackaburg/watchdog
```

## License

Expand Down

0 comments on commit 374e159

Please sign in to comment.