https://github.com/tommoral/mattermost_notifier

Mattermost notifier for experiments on distant cluster
https://github.com/tommoral/mattermost_notifier

Last synced: 23 days ago
JSON representation

Mattermost notifier for experiments on distant cluster

• Host: GitHub
• URL: https://github.com/tommoral/mattermost_notifier
• Owner: tomMoral
• Created: 2021-05-15T13:32:21.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-07-23T12:56:14.000Z (over 3 years ago)
• Last Synced: 2023-06-02T11:49:31.489Z (over 1 year ago)
• Language: Python
• Size: 172 KB
• Stars: 2
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# mattermost_notifier

Mattermost notifier for experiments on distant cluster.

## Config

This function needs to have access to the URK and the API_KEY for the mattermost webhooks.

### Generate the API key

* Login to your Mattermost team site and go to **Account Settings** -> **Integrations**.

* Next to **Incoming Webhooks** click **Edit**.

* Select the channel or private group to receive webhook payloads, then click **Add** to create the webhook

* The API key is the last part of the URL (eg: u2x8rkfugj8zbqby9pw3huqnyc)

### Provide the config details to the function:

It can be provided via different mechanism:

* It can be passed explicitely in the function as `url, api_key` arguments.

* It can be set globally for the process with the environment variable `MATTERHOOK_API_KEY` and `MATTERMOST_URL`.

* It can be set in a config file `matterhook.cfg`, either in the current directory or in `$HOME/.config/`. The config file should have the structure:

```config

[matterhook]

url = https://mattermost.yourcompany.com

api_key = XXX

```