Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,26 @@ minutes after that, one hour after that, 2 hours after that, 4 hours,
8 hours, then every 24 hours thereafter. Finally, you will get an
email when the metric has recovered.

### Dependencies
### Docker image

1. Obviously enough, hound need a running graphite server, accessible via
There is a docker image for running hound and postfix. See
<https://github.com/ccnmtl/postfix-docker>,
<https://hub.docker.com/r/hopsoft/graphite-statsd/> and
<https://github.com/ccnmtl/hound/blob/master/Dockerfile> for more information.

### Without docker

#### Dependencies

1. Obviously enough, hound needs a running graphite server, accessible via
network.
2. In addition, an SMTP host is necessary (without authentication or
encryption) to send the emails out.

### Usage
#### Usage

1. Edit the file `run.sh` with the correct values for your use.
2. run `./run.sh` (preferrably in a detachable session or with `nohup`)
2. run `./run.sh`

### Configuration

Expand Down
1 change: 1 addition & 0 deletions run.sh
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ HOUND_CHECK_INTERVAL=1 \
HOUND_GLOBAL_THROTTLE=10 \
HOUND_HTTP_PORT=9998 \
HOUND_TEMPLATE_FILE="index.html" \
HOUND_ALERT_TEMPLATE_FILE="alert.html" \
HOUND_EMAIL_ON_ERROR=false \
HOUND_SMTP_SERVER=postgres \
HOUND_SMTP_PORT=25 \
Expand Down