/slack-docker

Slack/Mattermost Integration for notifying Docker events, written in Go

Primary LanguageGoApache License 2.0Apache-2.0

slack-docker go

A Slack integration to notify Docker events.

slack-docker-screenshot

Getting Started

Setup an Incoming WebHook on your Slack workspace and get the WebHook URL.

Install slack-docker by brew tap or from the releases.

brew tap int128/slack-docker
brew install slack-docker

Run the command with the WebHook URL.

slack-docker --webhook=https://hooks.slack.com/services/...

You can run the Docker image ghcr.io/int128/slack-docker.

# Docker
docker run -d -e webhook=https://hooks.slack.com/services/... -h "$(hostname)" -v /var/run/docker.sock:/var/run/docker.sock ghcr.io/int128/slack-docker

# Docker Compose
curl -O https://raw.githubusercontent.com/int128/slack-docker/master/docker-compose.yml
docker-compose up -d

Configuration

It supports the following options and environment variables:

Application Options:
      --webhook=      Slack Incoming WebHook URL [$webhook]
      --image-regexp= Filter events by image name (default to all) [$image_regexp]

Help Options:
  -h, --help          Show this help message

Filter events by image name

webhook=https://hooks.slack.com/services/... image_regexp='^alpine$' ./slack-docker

Contribution

This is an open source software licensed under Apache-2.0. Feel free to open issues or pull requests.