Skip to content

Commit

Permalink
Update documentation (#14)
Browse files Browse the repository at this point in the history
By default SLACK_ENABLED is set to 'false' which can be disappointing when a SLACK_WEBHOOK is specified but no notification is send. So it could be useful to specify the enabled flag for users which wants to enable Slack notifications.
  • Loading branch information
osterman committed Jan 8, 2018
1 parent 8dbf44c commit 06ca51a
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ The enforcer is able to send notifications to a slack channel anytime there is a

| ENV | Description | Default |
|----------------------------|:----------------------------------------------------|:---------:|
| `SLACK_ENABLED` | Enabled Slack integration | `false` |
| `SLACK_HOOK` | Slack integration method (e.g. `pam`, `sshrc`) | `sshrc` |
| `SLACK_WEBHOOK_URL` | Webhook URL | |
| `SLACK_USERNAME` | Slack handle of bot (defaults to short-dns name) | |
Expand Down

0 comments on commit 06ca51a

Please sign in to comment.