Sign inSign up

waazaafr/arr-calendar-notifier

By waazaafr

Updated about 2 years ago
Archived

Send notification on servarr calendar events

Image
0

279

waazaafr/arr-calendar-notifier repository overview

...Some bugs discovered, please wait before using this image...

=====================================================================================

Docker
docker run -d --name arr-calendar-notifier \
    --hostname=arr-calendar-notifier --memory=100m \
    -e TZ=Europe/Paris \
    -v /mnt/user/appdata/arr-calendar-notifier/:/app \
    -p 5000:5000
    waazaafr/arr-calendar-notifier:latest

====================================================================================================================

Configuration des connexions API des -arr

Dans les mappages de dossiers si config.ini n'existe pas au démarrage alors il sera créé et le container s’arrêtera en vous indiquant en console qu'il faut aller le paramétrer. Ce config.ini contient tous les paramètres.

Chaque -arr peut avoir un block de configuration individuel comme par exemple:

[SONARR]
USE=true
SERVER=http://192.168.1.40:8989
API_KEY=3f2cb69axxxxx6a7712a6ec26464f3

ou

[RADARR]
USE=true
SERVER=http://192.168.1.40:7878
API_KEY=16f47cexxxx0ee0cd2164c50

ou

[LIDARR]
USE=true
SERVER=http://192.168.1.40:8686
API_KEY=16f47cexxxx0ee0cd2164c50

Les informations demandées sont évidentes. Ce sont les informations de connexion et une variable USE à mettre sur true si vous voulez activer ou false si vous ne le voulez pas.

====================================================================================================================

Ajout de canaux de notifications

Pour le moment 3 canaux de notifications sont disponibles: GOTIFY, EMAIL et DISCORD. Pour attacher un canal de notification à un -arr il faut le définir dans son block de configuration.

Si je reprends le block** [SONARR]** par exemple et que je veux ajouter le canal GOTIFY il devient:

[SONARR]
USE=true
SERVER=http://192.168.1.40:8989
API_KEY=3f2cb69axxxxx6a7712a6ec26464f3
NOTIFICATIONS = GOTIFY

Si je veux utiliser GOTIFY, EMAIL et DISCORD voici comment le préciser:

[SONARR]
USE=true
SERVER=http://192.168.1.40:8989
API_KEY=3f2cb69axxxxx6a7712a6ec26464f3
NOTIFICATIONS = GOTIFY
                EMAIL
                DISCORD

Si je veux que mon [RADARR] et mon [SONARR] utilisent tous les deux les canaux GOTIFY, EMAIL et DISCORD:

[SONARR]
USE=true
SERVER=http://192.168.1.40:8989
API_KEY=3f2cb69axxxxx6a7712a6ec26464f3
NOTIFICATIONS = GOTIFY
                EMAIL
                DISCORD

[RADARR]
USE=true
SERVER=http://192.168.1.40:7878
API_KEY=16f47cexxxx0ee0cd2164c50
NOTIFICATIONS = GOTIFY
                EMAIL
                DISCORD

====================================================================================================================

Configuration d'un canal de notification

Chaque canal de notification demande potentiellement des informations de connexion ou du paramétrage. Pour les canaux actuellement disponibles voici leur blocks de paramétrage:

GOTIFY

[SONARR.NOTIFICATIONS.GOTIFY]
SERVER=https://gotify.example.com
TOKEN=AGWIR_cfdsfe6VT

Notez le nom du block [SONARR.NOTIFICATIONS.GOTIFY]. SONARR dans ce nom de block indique que cette configuration de GOTIFY est pour le [SONARR]

On indique dans ce block les informations de connexion au serveur Gotify.

EMAIL

[SONARR.NOTIFICATIONS.EMAIL]
SERVER=mail.example.com
PORT=587
[email protected]
PASSWORD=P455w0rD
[email protected]

Notez le nom du block [SONARR.NOTIFICATIONS.EMAIL]. SONARR dans ce nom de block indique que cette configuration de EMAIL est pour le [SONARR]

On indique dans ce block les informations de connexion au serveur Email.

DISCORD

[SONARR.NOTIFICATIONS.DISCORD]
WEBHOOK_URL=https://discord.com/api/webhooks/1148946739747880970/RAfl44rSfdsegfhghgfG32joJbm51Rz_3dInzpSWjCOCLLcQMoUfpf5Qa5BcbBg5u95K

Notez le nom du block [SONARR.NOTIFICATIONS.DISCORD]. SONARR dans ce nom de block indique que cette configuration de DISCORD est pour le [SONARR]

On indique dans ce block les informations de connexion au webhook Discord.

Un exemple complet pour [SONARR] avec uniquement le canal GOTIFY serait:

[SONARR]
USE=true
SERVER=http://192.168.1.40:8989
API_KEY=3f2cb69axxxxx6a7712a6ec26464f3
NOTIFICATIONS = GOTIFY

[SONARR.NOTIFICATIONS.GOTIFY]
SERVER=https://gotify.example.com
TOKEN=AGWIR_cfdsfe6VT

Un exemple complet pour [SONARR] avec les canaux GOTIFY, EMAIL et DISCORD serait:

[SONARR]
USE=true
SERVER=http://192.168.1.40:8989
API_KEY=3f2cb69axxxxx6a7712a6ec26464f3
NOTIFICATIONS = GOTIFY
                EMAIL
                DISCORD

[SONARR.NOTIFICATIONS.GOTIFY]
SERVER=https://gotify.example.com
TOKEN=AGWIR_cfdsfe6VT

[SONARR.NOTIFICATIONS.EMAIL]
SERVER=mail.example.com
PORT=587
[email protected]
PASSWORD=P455w0rD
[email protected]

[SONARR.NOTIFICATIONS.DISCORD]
WEBHOOK_URL=https://discord.com/api/webhooks/1148946739747880970/RAfl44rSfdsegfhghgfG32joJbm51Rz_3dInzpSWjCOCLLcQMoUfpf5Qa5BcbBg5u95K

Un exemple complet pour [SONARR] et [RADARR] avec les canaux GOTIFY, EMAIL et DISCORD serait:

[SONARR]
USE=true
SERVER=http://192.168.1.40:8989
API_KEY=3f2cb69axxxxx6a7712a6ec26464f3
NOTIFICATIONS = GOTIFY
                EMAIL
                DISCORD

[SONARR.NOTIFICATIONS.GOTIFY]
SERVER=https://gotify.example.com
TOKEN=AGWIR_cfdsfe6VT

[SONARR.NOTIFICATIONS.EMAIL]
SERVER=mail.example.com
PORT=587
[email protected]
PASSWORD=P455w0rD
[email protected]

[SONARR.NOTIFICATIONS.DISCORD]
WEBHOOK_URL=https://discord.com/api/webhooks/1148946739747880970/RAfl44rSfdsegfhghgfG32joJbm51Rz_3dInzpSWjCOCLLcQMoUfpf5Qa5BcbBg5u95K

[RADARR]
USE=true
SERVER=http://192.168.1.40:7878
API_KEY=16f47cexxxx0ee0cd2164c50
NOTIFICATIONS = GOTIFY
                EMAIL
                DISCORD

[RADARR.NOTIFICATIONS.GOTIFY]
SERVER=https://gotify.example.com
TOKEN=AGWIR_cfdsfeh<tf

[RADARR.NOTIFICATIONS.EMAIL]
SERVER=mail.example.com
PORT=587
[email protected]
PASSWORD=P455w0rD
[email protected]

[RADARR.NOTIFICATIONS.DISCORD]
WEBHOOK_URL=https://discord.com/api/webhooks/1148946739747880970/RAfl44rertsfdffG32joJbm51Rz_3dInzpSWjCOCLLcQMoUfpf5Qa5BcbBg5u95K

====================================================================================================================

Paramétrer la mise en forme des messages envoyés

Chaque canal de notification envoi un message. Ce message vous pouvez choisir comment il est construit, sa mise en forme.

Il y a 2 éléments dans un message: un titre et un contenu. Dans chaque block NOTIFICATIONS vous pouvez fixer ces mises en forme en ajoutant deux paramètres disponibles: TEMPLATE_TITLE et TEMPLATE_CONTENT

Ces deux paramètres optionnels sont donc à ajouter dans un block de NOTIFICATIONS et contiennent ce que l'on va pas appeler un template. Prenons un exemple avec le block [SONARR.NOTIFICATIONS.GOTIFY]:

[SONARR.NOTIFICATIONS.GOTIFY]
SERVER=https://gotify.example.com
TOKEN=AGWIR_cfdsfe6VT
TEMPLATE_TITLE={{serieTitle}} - S{{seasonNumber}}E{{episodeNumber}}
TEMPLATE_CONTENT=Diffusion à {{hour}} - Suivi: {{monitored}}

Chaque pseudo-variable entre {{ }} sera remplacée par l'application au moment de l'envoi du message.

Les pseudo-variables disponibles selon le service -arr choisis

RADARR

{{title}} - Titre du film {{originalTitle}} - Titre original {{event_dates}} - Les différentes dates de sorties connues (inCinemas / digitalRelease / physicalRelease) {{event_trigger}} - Evènement déclencheur (inCinemas / digitalRelease / physicalRelease) {{overview}} - Résumé {{runtime}} - Durée du film {{imdbId}} - Id de la série, chez IMDB {{tvdbId}} - Id de la série, chez TvDB {{poster}} - URL de l'affiche {{monitored}} - Série suivie ou non

SONARR

{{serieTitle}} - Titre de la série {{seasonNumber}} - Numéro de saison sur 2 digits minimum {{episodeNumber}} - Numéro d'épisode' sur 2 digits minimum {{episodeTitle}} - Titre de l'épisode {{runtime}} - Durée de l'épisode {{seriesId}} - Id de la série, interne à Sonarr {{tvdbId}} - Id de la série, chez TvDB {{air_time}} - Date et heure de diffusion selon la timezone définie {{hour}} - Heure de diffusion {{poster}} - URL de l'affiche {{monitored}} - Série suivie ou non

LIDARR

{{id}} - Id sur Lidarr {{title}} - Titre de l'album {{artistName}} - Nom de l'artiste {{artistOverview}} - Bio de l'artiste {{poster}} - URL de la pochette

La pseudo-variable {{poster}} se transformera en affichage de l'image dans les canaux GOTIFY et EMAIL. En ce qui concerne DISCORD il n'est pas utilie de l'utiliser car l'affiche est par défaut affichée.

====================================================================================================================

Tester votre config.ini

Si vous voulez tester votre config.ini en envoyant une notification de test pour RADARR et/ou SONARR et/ou LIDARR si vous les avez activé allez en console de votre container et lancez la commande suivante; ./test

====================================================================================================================

Ajout de flux RSS

A la demande de Gaetan voici la mise en place de flux RSS par évenements de calendrier de nos -arr. Pour pouvoir obtenir ces flux RSS il faut mapper le port 5000 du container.

Une fois le port 5000 mappé et si l'ip de votre container est par exemple 192.168.1.40 vous trouverez ces flux aux urls suivantes: http://192.168.1.40:5000/SONARR.xml http://192.168.1.40:5000/RADARR.xml http://192.168.1.40:5000/LIDARR.xml

=======================================================================

Feel free to join me on https://discord.gg/p9xkjEw8ts⁠

If you like this, consider buing me a coffee: https://buymeacoffee.com/waazaa⁠

If you need an UnRAID license follow this link: https://unraid.net/pricing?via=4c3f80⁠

Tag summary

Content type

Image

Digest

sha256:2ace8d18e

Size

57.6 MB

Last updated

about 2 years ago

docker pull waazaafr/arr-calendar-notifier:0.0.2