From 06ca51a308eebeb17b0abc3bb6bd6c4dbf055560 Mon Sep 17 00:00:00 2001 From: Erik Osterman Date: Mon, 8 Jan 2018 10:13:52 -0800 Subject: [PATCH] Update documentation (#14) 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. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 7cf74ca..6824cc1 100644 --- a/README.md +++ b/README.md @@ -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) | |