-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
11 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,25 @@ | ||
# slack-docker | ||
|
||
Slack integration that notifies Docker events on your host. | ||
A Slack integration to notify Docker events. | ||
|
||
|
||
## How to Run | ||
## Run | ||
|
||
Set up [an incoming WebHook](https://my.slack.com/services/new/incoming-webhook) and get the token. | ||
Set up [an incoming WebHook integration](https://my.slack.com/services/new/incoming-webhook) and get the token. | ||
|
||
Run a container, | ||
Run a container | ||
|
||
```sh | ||
docker run -d -v /var/run/docker.sock:/var/run/docker.sock -e domain=DOMAIN -e token=TOKEN -e channel=infra int128/slack-docker | ||
``` | ||
|
||
with following environment variables. | ||
|
||
* `domain` is the first part of your .slack.com. (Mandatory) | ||
* `token` is the token provided on the integration setup page. (Mandatory) | ||
* `channel` is the channel without hash prefix. (Default is `general`) | ||
* `domain` is the first part of your .slack.com. | ||
* `token` is the token provided on the integration page. | ||
* `channel` is the channel without hash prefix. Default is `general`. | ||
|
||
|
||
## Contribution | ||
|
||
Please let me know an issue or pull request. |