Skip to content

Commit

Permalink
Rewords
Browse files Browse the repository at this point in the history
  • Loading branch information
int128 committed Oct 4, 2014
1 parent 5fd60bc commit ac06fd8
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions README.md
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.

0 comments on commit ac06fd8

Please sign in to comment.