feat(slack): add doc for slack

This commit is contained in:
Olivier Lambert 2016-11-18 15:12:59 +01:00
parent 1a0e72c468
commit 4696b6563c
9 changed files with 57 additions and 0 deletions

BIN
docs/assets/DocImg2.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 78 KiB

BIN
docs/assets/DocImg3.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

BIN
docs/assets/DocImg4.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

BIN
docs/assets/DocImg5.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

BIN
docs/assets/DocImg6.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 74 KiB

BIN
docs/assets/DocImg7.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

BIN
docs/assets/DocImg8.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 73 KiB

BIN
docs/assets/DocImg9.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

View File

@ -151,3 +151,60 @@ To configure it, 2 steps in the plugin section (in "Settings"):
That's it: your next scheduled jobs will be recap in a message:
![](https://xen-orchestra.com/blog/content/images/2015/12/xmpp.png)
## Slack or Mattermost notifications
Xen Orchestra is able to send backup report to Slack or Mattermost.
### Plugin configuration
Like all other xo-server plugins, it can be configured directly via
the web iterface, see [the plugin documentation](https://xen-orchestra.com/docs/plugins.html).
### Generate the Webhook
#### Slack
1. Log in your Slack team account
2. Click on the **Main menu** at the top and choose **Apps & Integrations**
![Apps & Integrations](assets/DocImg1.png)
3. Search **Incoming WebHooks**
![Incoming WebHooks](assets/DocImg2.png)
4. Click on **Add Configuration**
![Add Configuration](assets/DocImg3.png)
5. Choose the default channel and click on **Add Incoming WebHooks integration**
![Add Incoming WebHooks integration](assets/DocImg4.png)
6. Modify the default settings and click on **Save Settings**
![Save Settings](assets/DocImg5.png)
#### Mattermost
You need to be an admin.
* Go in MatterMost menu, then Integration
* Click on "Add Incoming webhook"
* "Add Incoming Webhook"
### Testing the plugin
#### Slack
![Slack configuration](assets/DocImg6.png)
![Slack](assets/DocImg7.png)
#### Mattermost
![Mattermost configuration](assets/DocImg8.png)
![Mattermost](assets/DocImg9.png)