Notifications Notifico

Aperçu

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

Configuration du compte

Notifico vous permet d’envoyer un message vers un ou plusieurs salons IRC. Le service d’origine heberge a n.tkte.ch est hors ligne, mais le projet est open source et peut etre auto-heberge.

Configuration officielle / legacy (n.tkte.ch)

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.

Une fois votre hook cree avec succes, recuperez depuis la page principale du projet le lien necessaire a l’envoi de vos messages :

L’URL ressemblera a ceci :

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

Dans l’exemple ci-dessus :

1. ProjectID est 2144
2. MessageHook est uJmKaBW9WFk42miB146ci3Kj

Configuration auto-hebergee

Deployez une instance Notifico en suivant les instructions disponibles sur https://notifico.tech/. Une fois l’instance en fonctionnement, creez un projet et un Plain Text Message Hook comme decrit ci-dessus. Utilisez le nom d’hote (et le port si necessaire) de votre instance dans l’URL Apprise.

Syntaxe

Vous pouvez transmettre directement l’URL native de n.tkte.ch :

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

Ou utiliser l’une des formes d’URL Apprise ci-dessous.

Endpoint officiel (n.tkte.ch) :

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

Instance auto-hebergee (HTTP) :

• notifico://{host}/{ProjectID}/{MessageHook}
• notifico://{host}:{port}/{ProjectID}/{MessageHook}
• notifico://{user}@{host}/{ProjectID}/{MessageHook}
• notifico://{user}:{password}@{host}/{ProjectID}/{MessageHook}
• notifico://{user}:{password}@{host}:{port}/{ProjectID}/{MessageHook}

Instance auto-hebergee (HTTPS) :

• notificos://{host}/{ProjectID}/{MessageHook}
• notificos://{host}:{port}/{ProjectID}/{MessageHook}
• notificos://{user}@{host}/{ProjectID}/{MessageHook}
• notificos://{user}:{password}@{host}/{ProjectID}/{MessageHook}
• notificos://{user}:{password}@{host}:{port}/{ProjectID}/{MessageHook}

Vous pouvez desactiver les couleurs (activees par defaut) :

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

Vous pouvez desactiver le prefixe de type de notification (active par defaut) :

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

Detail des Parametres

Variable	Obligatoire	Description
ProjectID	Oui	Identifiant du projet. C’est un entier qui constitue la premiere partie de l’URL du hook. Pour l’endpoint officiel, il est place en position d’hote dans l’URL ; pour les instances auto-hebergees, il suit le nom d’hote.
MessageHook	Oui	Le token de hook de message, situe a la fin de l’URL fournie.
host	Non	Le nom d’hote (ou l’adresse IP) d’une instance Notifico auto-hebergee. Lorsqu’il est omis, les notifications sont envoyees vers l’endpoint officiel n.tkte.ch.
port	Non	Le port de l’instance auto-hebergee. Par defaut, 80 (HTTP) ou 443 (HTTPS) si non specifie.
user	Non	Nom d’utilisateur optionnel pour l’authentification HTTP Basic sur une instance auto-hebergee.
password	Non	Mot de passe optionnel pour l’authentification HTTP Basic sur une instance auto-hebergee.
color	Non	Utilise les couleurs IRC pour offrir un rendu plus riche. Cela permet egalement d’interpreter les couleurs IRC deja presentes dans la notification. Assurez-vous que la case Color est cochee lors de la creation du Message Hook. La valeur par defaut est Yes.
prefix	Non	Tous 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.

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.
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é. L’appel global notify() retourne quand même True 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.

Exemples

Envoyer une notification Notifico vers l’endpoint officiel :

# 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

Envoyer une notification Notifico vers une instance auto-hebergee en HTTP :

apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   notifico://monhote.example/2144/uJmKaBW9WFk42miB146ci3Kj

Envoyer une notification Notifico vers une instance auto-hebergee en HTTPS avec authentification :

apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   notificos://utilisateur:motdepasse@monhote.example:8443/2144/uJmKaBW9WFk42miB146ci3Kj