Post a message to a matrix room with a simple HTTP POST

Guilhem Saurel 1b31e7bba9 update readme, doc, and status / return codes 1 week ago
Dockerfile bffc7002c1 rename {main -> matrix_webhook}.py 1 month ago
LICENSE 7e6533da5e license details 1 month ago
README.md 1b31e7bba9 update readme, doc, and status / return codes 1 week ago
docker-compose.yml 0f85cc1c9b update DNS 1 month ago
matrix_webhook.py 1b31e7bba9 update readme, doc, and status / return codes 1 week ago

README.md

Matrix Webhook

Post a message to a matrix room with a simple HTTP POST

Configuration

Create a matrix user for the bot, make it join the rooms you want it to talk into, and then set the following environment variables:

  • MATRIX_URL: the url of the matrix homeserver
  • MATRIX_ID: the user id of the bot on this server
  • MATRIX_PW: the password for this user
  • API_KEY: a secret to share with the users of the service

Dev

pip3 install --user matrix-client
./matrix_webhook.py

Prod

  • Use Traefik on the web docker network, eg. with proxyta.net
  • Put the configuration into a .env file
  • Configure your DNS for ${CHATONS_SERVICE:-matrixwebhook}.${CHATONS_DOMAIN:-localhost} and www.${CHATONS_SERVICE:-matrixwebhook}.${CHATONS_DOMAIN:-localhost}
docker-compose up -d

Test / Usage

curl -d '{"text":"new contrib from toto: http://radio.localhost/map/#44", "key": "secret"}' 'matrixwebhook.localhost/!FwpsPdeIYWcXDVpRmO:matrix.org'

(or localhost:4785 without docker)