Aller au contenu

Notifications IRC

Aperçu

IRC ne nécessite pas de configuration de compte formelle dans Apprise. Vous avez seulement besoin d’un accès à un serveur IRC, ou d’un accès à un relayeur ZNC si vous prévoyez d’utiliser le mode relayeur.

Si votre réseau IRC requiert une authentification NickServ, assurez-vous d’avoir enregistré votre pseudo et d’avoir votre mot de passe NickServ à portée de main.

Si vous utilisez ZNC, vérifiez que votre relayeur est accessible et que votre nom d’utilisateur et mot de passe ZNC sont corrects.

La syntaxe valide est la suivante :

  • irc://{host}/{target}
  • ircs://{host}/{target}

Les cibles sont définies dans le chemin de l’URL sous forme d’une ou plusieurs entrées :

  • Les canaux utilisent le préfixe # : #channel
  • Les utilisateurs utilisent le préfixe @ : @nickname

Vous pouvez fournir plusieurs cibles en les séparant par / :

  • ircs://irc.example.net/#alerts/@bob/@alice

Si un canal est protégé par une clé, ajoutez-la après le nom du canal en utilisant : :

  • ircs://irc.example.net/#private:channel-key
Variable Requis Description
host Oui Nom d’hôte ou adresse IP du serveur IRC.
port Non Port du serveur IRC. Par défaut 6667 pour irc:// et 6697 pour ircs://.
user Non Nom d’utilisateur utilisé pour l’authentification. La signification dépend du mode.
password Non Mot de passe utilisé pour l’authentification. La signification dépend du mode.
target Non Un ou plusieurs destinataires (canaux et/ou utilisateurs) fournis dans le chemin de l’URL.
to Non Alias de targets. Permet de définir les destinataires dans la chaîne de requête plutôt que dans le chemin.
nick Non Pseudo utilisé lors de l’enregistrement sur le serveur. Si non spécifié, le pseudo prend par défaut la valeur de user lorsque celui-ci est fourni.
name Non Nom réel (GECOS) utilisé lors de l’enregistrement.
mode Non Mode d’authentification, l’un des suivants : server, nickserv, znc. Par défaut server.
join Non Contrôle si Apprise rejoint les canaux avant d’envoyer. Par défaut yes.
Les canaux protégés par un mot de passe (fourni sous la forme #channel:key) ne peuvent pas recevoir le message sans avoir d’abord rejoint le canal. Ainsi, si join=no, cela ne s’applique pas aux canaux avec des mots de passe assignés, mais s’applique à tout le reste. Ce paramètre n’a aucun effet si vous ne contactez que des utilisateurs.
  • mode=server : Le password optionnel est envoyé comme PASS serveur lors de l’enregistrement s’il est fourni.
  • mode=nickserv : Utilise le flux d’identification NickServ après la connexion, puis envoie les notifications.
  • mode=znc : S’authentifie auprès du relayeur ZNC. La ligne PASS est construite sous la forme user:password pour la compatibilité avec les configurations ZNC courantes. Une vérification de disponibilité PING/PONG est effectuée avant l’envoi des notifications.
Variable Description
overflow Gère les messages qui dépassent la limite documentée d’un service. La valeur par défaut est upstream.
👉 upstream : envoie un seul message sans le découper ni le tronquer selon cette limite.
👉 truncate : conserve la partie qui tient dans la limite et supprime le reste.
👉 split : privilégie une coupure lisible, utilise une coupure stricte si nécessaire, puis envoie toutes les parties dans l’ordre.
Le découpage d’un contenu non déclaré ou structuré reste une solution au mieux. Utilisez upstream si le corps doit rester intact.
format Ce 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é.
verify Les 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.
redirect Par défaut, Apprise suit les redirections HTTP (réponses 3xx) émises par le serveur distant, conformément au comportement de la bibliothèque requests sous-jacente. Si vous souhaitez empêcher la transmission des en-têtes personnalisés et des identifiants vers des destinations différentes de l’URL d’origine, définissez cette option sur no. Par défaut, elle vaut yes.
cto Signifie 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.
rto Signifie 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.
emojis Active 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.
tz Identifie 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.
retry Nombre de tentatives de remise supplémentaires après le premier échec, avant d’abandonner. Accepte un entier compris entre 0 et 10. La valeur par défaut est 0 (aucune nouvelle tentative – une seule tentative est effectuée). Lorsqu’il est combiné avec wait, Apprise marque une pause du nombre de secondes spécifié entre chaque tentative.
wait Nombre de secondes à attendre entre les nouvelles tentatives. Accepte une valeur décimale comprise entre 0.0 et 20.0 ; les entiers sont automatiquement convertis en virgule flottante. La valeur par défaut est 0.5. Ce paramètre n’est utile que si retry est supérieur à zéro – un service avec retry=0 effectue exactement une tentative, quelle que soit la valeur de wait.
optional Lorsqu’il est défini sur yes, un échec de remise pour ce service est silencieusement absorbé. Le résultat global de notify() est quand même considéré comme réussi même si ce point de terminaison était injoignable, à condition que tous les services requis (non optionnels) du même lot aient réussi. Ce drapeau ne saute pas la remise ni ne contourne la logique de nouvelles tentatives – toutes les tentatives configurées sont effectuées avant que l’échec soit absorbé. Par défaut, il vaut no, ce qui signifie que chaque échec est propagé à l’appelant.

Envoyer un message vers un canal via TLS :

Fenêtre de terminal
apprise -vv -t "Title" -b "Corps du Message" \
"ircs://irc.example.net/#alerts"

Envoyer vers plusieurs cibles :

Fenêtre de terminal
apprise -vv -t "Title" -b "Corps du Message" \
"ircs://irc.example.net/#alerts/@bob/@alice"

Envoyer vers un canal protégé par un mot de passe :

Fenêtre de terminal
apprise -vv -t "Title" -b "Corps du Message" \
"ircs://irc.example.net/#private:channel-key"

Exemple en mode NickServ :

Fenêtre de terminal
apprise -vv -t "Title" -b "Corps du Message" \
"ircs://user:pass@irc.example.net/#alerts?mode=nickserv&nick=MyNick"

Exemple en mode relayeur ZNC :

Fenêtre de terminal
apprise -vv -t "Title" -b "Corps du Message" \
"ircs://zncuser:zncpass@znc.example.net/#alerts?mode=znc&nick=MyNick"

Mode ZNC, plusieurs cibles :

Fenêtre de terminal
apprise -vv -t "Title" -b "Corps du Message" \
"ircs://zncuser:zncpass@znc.example.net/#alerts/@bob?mode=znc&nick=MyNick"
Questions ou commentaires ?

Documentation

Vous avez repéré une faute de frappe ou une erreur ?

Problèmes Techniques

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

Conçu avec amour depuis le Canada