lucas-dclrcq / marrtrix

Sends *Arr notifications to Matrix

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Marrtrix

GitHub Actions workflow status
Conventional commits Repository license

Sends notification from Sonarr and Radarr to a matrix room

Install

  1. Create a matrix user
  2. Invite this user to the room where you want to send notifications
  3. Start marrtrix :
docker -d run --restart=always \
-p 8080:8080 \
-e MARRTRIX_PASSWORD=AwesomePassword \
-e MARRTRIX_MATRIX_URL=https://matrix.org \
-e MARRTRIX_MATRIX_USERNAME=marrtrix \
-e MARRTRIX_MATRIX_PASSWORD=Marrtrix123 \
-e MARRTRIX_MATRIX_ROOM_ID="\!WCoiyAvDnhUEYbsItv:matrix.org" \
marrtrix:latest
  1. Configure the webhook

TODO

Configuration

You can configure Marrtrix using the following environment variables

Name Required Default Description
MARRTRIX_DEBUG false false Enable debug mode where all incoming json requests are logged
MARRTRIX_PASSWORD true The password used to authenticate webhook requests using basic auth
MARRTRIX_MATRIX_URL true The base url of the matrix server
MARRTRIX_MATRIX_USERNAME true A matrix username
MARRTRIX_MATRIX_PASSWORD true A matrix password
MARRTRIX_MATRIX_ROOM_ID true The room internal id (in Element you'll find this id in Room settings > Advanced)

Roadmap

  • Implement radarr notifications
  • Implement sonarr notifications
  • Implement lidarr notifications
  • Implement readarr notifications
  • Support E2E encryption

About

Sends *Arr notifications to Matrix

License:MIT License


Languages

Language:Kotlin 97.5%Language:Dockerfile 2.5%