Notifications IRC

Aperçu

• Source: https://ircv3.net/
• Prise en charge des images: Non
• Prise en charge des pièces jointes: Non
• Limites de caractères des messages:
  • Corps: 380
• Créer votre URL Apprise

Configuration du Compte

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.

Syntaxe

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

Clés de Canal

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

Détail des Paramètres

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.

Remarques sur les Modes

• 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.

Paramètres Globaux

Variable	Description
overflow	Ce 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.
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.
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.

Exemples

Envoyer un message vers un canal via TLS :

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

Envoyer vers plusieurs cibles :

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 :

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

Exemple en mode NickServ :

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

Exemple en mode relayeur ZNC :

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

Mode ZNC, plusieurs cibles :

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