Skip to content

Commit

Permalink
Update README to indicate Mattermost compatibility.
Browse files Browse the repository at this point in the history
  • Loading branch information
dennisoelkers committed Jun 1, 2016
1 parent ca9ee45 commit 2b1fc35
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Slack Plugin for Graylog
Slack/Mattermost Plugin for Graylog
========================

[![Build Status](https://travis-ci.org/Graylog2/graylog-plugin-slack.svg)](https://travis-ci.org/Graylog2/graylog-plugin-slack)
Expand All @@ -11,7 +11,7 @@ Please use version 2.1.0 of this plugin if you are still running Graylog 1.x

![](https://github.com/Graylog2/graylog-plugin-slack/blob/master/screenshot.png)

This plugin can notify [Slack](https://www.slack.com) channels about triggered alerts in Graylog (Alarm Callback) and also forward each message routed into a stream (Message Output) in realtime.
This plugin can notify [Slack](https://www.slack.com) or [Mattermost](http://www.mattermost.org) channels about triggered alerts in Graylog (Alarm Callback) and also forward each message routed into a stream (Message Output) in realtime.

#### Short mode message output:

Expand Down Expand Up @@ -42,10 +42,18 @@ Restart `graylog-server` and you are done.

## Usage

### For Slack:

#### Step 1: Create Slack Incoming Webhook

Create a new Slack Incoming Webhook (https://<organization>.slack.com/services/new/incoming-webhook) and copy the URL it will present to you. It will ask you to select a Slack channel but you can override it in the plugin configuration later.

### For Mattermost:

#### Step 1: Create Mattermost Incoming Webhook

Enable Webhooks in general and create an incoming Webhook for Graylog as described in the [Mattermost docs](http://docs.mattermost.com/developer/webhooks-incoming.html).

#### Step 2: Create alarm callback or message output

Create a "Slack alarm callback" on the "Manage alerts" page of your stream. Enter the requested configuration (use the Incoming Webhook URL you created in step 1) and save. Make sure you also configured alert conditions for the stream so that the alerts are actually triggered.
Expand Down

0 comments on commit 2b1fc35

Please sign in to comment.