Aller au contenu

Notifications Notifico

Aperçu

Notifico vous permet d’envoyer un message vers un ou plusieurs salons IRC.

  1. Rendez-vous sur https://n.tkte.ch et creez un compte.
  2. Creez un projet, manuellement ou en le synchronisant avec GitHub.
  3. Depuis le projet, creez ensuite un Plain Text Message Hook. notifico plain text hook

Une fois votre hook cree avec succes, vous pouvez recuperer depuis la page principale du projet le lien necessaire a l’envoi de vos messages. C’est ce dont Apprise a besoin : notifico hook capture instructions

L’URL ressemblera a ceci :

https://n.tkte.ch/h/2144/uJmKaBW9WFk42miB146ci3Kj
^ ^
| |
project id message hook

Cette URL correspond en pratique a :
https://n.tkte.ch/h/{ProjectID}/{MessageHook}

Si vous souhaitez la convertir en URL Apprise, procede comme suit : La derniere partie de l’URL recue correspond aux 2 arguments qui nous interessent. Dans l’exemple ci-dessus, il s’agit de :

  1. ProjectID is 2144
  2. MessageHook is uJmKaBW9WFk42miB146ci3Kj

Vous pouvez transmettre directement l’URL native telle que recuperée sur le site :

  • https://n.tkte.ch/h/{ProjectID}/{MessageHook}

Ou vous pouvez la reformater pour Apprise, ce qui reduit legerement la surcharge :

  • notifico://{ProjectID}/{MessageHook}

Vous pouvez aussi desactiver les couleurs, activees par defaut :

  • notifico://{ProjectID}/{MessageHook}?color=off

Par defaut, Apprise envoie un prefixe avec chaque message ; vous pouvez aussi le desactiver ainsi :

  • notifico://{ProjectID}/{MessageHook}?prefix=off
VariableObligatoireDescription
ProjectIDOuiIdentifiant du projet. C’est un entier qui constitue la premiere partie de l’URL du Notifico Message Hook fournie.
MessageHookOuiLe hook de message se trouve a la fin de l’URL du Notifico Message Hook fournie.
colorNonUtilise les couleurs IRC pour offrir un rendu plus riche. Cela permet egalement d’interpreter les couleurs IRC deja presentes dans la notification transmise. Assurez-vous que la case Color est cochee lors de la creation du Message Hook. La valeur par defaut est Yes.
prefixNonTous les messages envoyes vers IRC comportent par defaut un prefixe permettant d’identifier le type de message, info, error, warning ou success, ainsi que le systeme a l’origine de la notification. Par defaut, cette valeur est Yes.
VariableDescription
overflowCe paramètre peut être défini sur split, truncate ou upstream. Il détermine la manière dont Apprise remet le message que vous lui transmettez. Par défaut, il vaut upstream.
👉 upstream : ne fait aucune modification et transmet le message exactement tel qu’il a été reçu au service.
👉 truncate : veille à ce que le message tienne dans la limite amont documentée par le service. Si plus d’informations sont fournies que la limite définie, l’excédent est tronqué.
👉 split : similaire à truncate, sauf que si le message dépasse la limite amont documentée par le service, il est découpé en plusieurs morceaux plus petits puis envoyés séquentiellement.
formatCe paramètre peut être défini sur text, html ou markdown. Certains services prennent en charge plusieurs formats de publication du contenu. La valeur par défaut varie selon le service choisi et peut correspondre à l’un de ces trois formats. Vous pouvez facultativement forcer cette option pour vous écarter du comportement par défaut. Si le service ne prend pas en charge plusieurs formats de transmission, ce champ est ignoré.
verifyLes requêtes externes vers des emplacements sécurisés, par exemple via https, utilisent des certificats. Par défaut, Apprise vérifie la validité de ces certificats ; si ce n’est pas le cas, aucune notification n’est envoyée à la source. Dans certains cas, un utilisateur ne dispose pas d’une autorité de certification pour valider la clé ou fait simplement confiance à la source ; dans ce cas, vous pouvez définir ce drapeau sur no. Par défaut, il vaut yes.
ctoSignifie Socket Connect Timeout. Il s’agit du nombre de secondes pendant lesquelles Requests attend que votre client établisse une connexion avec une machine distante, ce qui correspond à l’appel connect() sur la socket. La valeur par défaut est de 4.0 secondes.
rtoSignifie Socket Read Timeout. Il s’agit du nombre de secondes pendant lesquelles le client attend que le serveur envoie une réponse. La valeur par défaut est de 4.0 secondes.
emojisActive la prise en charge des emojis, par exemple :+1: qui sera traduit en 👍. Par défaut, cette option vaut no.
Remarque : selon la configuration côté serveur, l’administrateur peut désactiver globalement la prise en charge des emojis ; mais par défaut, ce n’est pas le cas.
tzIdentifie le fuseau horaire de la base IANA que vous souhaitez utiliser. Par défaut, celui-ci est détecté à partir de la configuration du serveur qui exécute Apprise. Vous pouvez le définir sur des valeurs comme America/Toronto, ou sur tout autre fuseau correctement formaté correspondant à votre région.

Envoyer une notification Notifico :

Fenêtre de terminal
# L'exemple ci-dessous envoie une notification Notifico
# Supposons que notre {ProjectID} soit 2144
# Supposons que notre {MessageHook} soit uJmKaBW9WFk42miB146ci3Kj
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
notifico://2144/uJmKaBW9WFk42miB146ci3Kj
Questions ou commentaires ?

Documentation

Vous avez repéré une faute de frappe ou une erreur ? Signalez-la ou proposez une correction .

Problèmes Techniques

Vous rencontrez un problème avec le code ? Ouvrez un ticket sur GitHub :

Conçu avec amour depuis le Canada