https://github.com/paulden/meugnon-mattermost-slash-command
Meugnon API for Mattermost Slash command
https://github.com/paulden/meugnon-mattermost-slash-command
docker docker-compose flask mattermost python
Last synced: 3 months ago
JSON representation
Meugnon API for Mattermost Slash command
- Host: GitHub
- URL: https://github.com/paulden/meugnon-mattermost-slash-command
- Owner: paulden
- Created: 2022-08-29T16:34:28.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-08-30T12:05:59.000Z (almost 4 years ago)
- Last Synced: 2025-12-27T09:26:03.312Z (6 months ago)
- Topics: docker, docker-compose, flask, mattermost, python
- Language: Python
- Homepage:
- Size: 4.88 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Mattermost Meugnon slash command
Simple Flask API returning meugnons links (courtesy of Imgur) to setup a Mattermost Slash command.
## Run locally
- Generate an Imgur client ID (you need an account) here: https://api.imgur.com/oauth2/addclient
- (optional) Generate a Mattermost token when registering your Slash command.
- Run using Docker, in standalone mode or with docker-compose if you want to start a local Mattermost instance.
### Using Docker
- Build and run API:
```
$ docker build -t meugnon-api .
$ docker run -e IMGUR_CLIENT_ID= -p 8000 meugnon-api
$ curl localhost:8000/healthz
{
"message": "Tutto bene!"
}
```
### Standalone
- Create a `.env` file with the Mattermost tokens and the Imgur client ID as described in `.env.template` (if the
`MATTERMOST_TOKENS` is empty or not set, token validation will be skipped)
- Install required Python dependencies with a tool such as `virtualenv`:
```
$ virtualenv ./venv -p python3.8
$ source venv/bin/active
$ pip install -r requirements.txt
```
- Run and test API is up
```
$ python run.py
$ curl localhost:8000/healthz
{
"message": "Tutto bene!"
}
$ curl localhost:8000
{
"response_type": "in_channel",
"text": "https://i.imgur.com/DPVf0HB.jpg"
}
```
### Run with docker-compose using a local Mattermost instance
Based on https://github.com/mattermost/mattermost-bot-sample-golang
- Start containers with `docker-compose up`.
- Run script to add users with `./add_users.sh`.
- Go to your local Mattermost instance on http://localhost:8065 and log in with `bill@example.com` / `Password1.`.
- Create a test team and authorize untrusted connections to your API by going to `System console > Environment > Developer`
and adding `meugnon-api_meugnon_1` in `Allow untrusted internal connections to`.
- Enable link preview to easily get your meugnonnerie in `System Console > Site Configuration > Posts > Enable website link previews`.
- Create your Slash command on `Integrations > Slash Commands > Add Slash Commands` and set request method to `GET`, and
request URL to `http://meugnon-api_meugnon_1:8000` (rest is your choice).
## TODO
- Tests
- Filter out MP4 links (not previewed in Mattermost :( )
- Build "cache" object with links to avoid useless calls to API