Notifications YouLMK
Configuration du compte
Section intitulée « Configuration du compte »YouLMK est une boîte de réception hébergée pour les notifications. Tout client HTTP peut y envoyer un message. Pour chaque expéditeur (une source), vous choisissez sa portée (Silencieux, Pastille, Bannière, Prioritaire), le respect des heures calmes et le regroupement des répétitions. Les notifications peuvent arriver sur votre téléphone, dans votre navigateur, par e-mail, dans Slack ou sur votre propre webhook.
- Connectez-vous sur youlmk.com ou dans l’application, puis créez une source pour l’expéditeur (par exemple
apprise). Chaque source possède sa propre clé et ses propres règles. - Ouvrez l’écran Key de la source. Il affiche deux identifiants utilisables ici :
- le jeton bearer,
ylk_suivi de 32 caractères - la clé d’URL,
k_suivie de 14 caractères
- le jeton bearer,
L’essai comprend 10 notifications et 3 surveillances, sans carte bancaire ; ensuite, l’envoi coûte 4 $ par mois.
La syntaxe valide est la suivante :
https://youlmk.com/k/{key}youlmk://{token}youlmk://{key}youlmk://{token}?priority={priority}youlmk://{token}?info={priority}&success={priority}&warning={priority}&failure={priority}youlmk://{token}?url={link}&url_label={label}&group={group}
La priorité peut être forcée pour toutes les notifications avec ?priority=, ou définie par type de notification Apprise avec ?info=, ?success=, ?warning= et ?failure=. Si elle est omise, elle est déduite du type de notification :
| Type Apprise | Priorité YouLMK |
|---|---|
info | normal |
success | normal |
warning | high |
failure | high |
critical n’est jamais une valeur par défaut : cette priorité peut passer outre les heures calmes et le mode Focus lorsque la source l’autorise. Elle doit donc être choisie explicitement. La portée (Reach) de la source reste le plafond ; une priorité ne peut que descendre en dessous.
Détail des Paramètres
Section intitulée « Détail des Paramètres »| Variable | Obligatoire | Description |
|---|---|---|
| token | *Oui | Jeton bearer de la source (ylk_ et 32 caractères) ou clé d’URL (k_ et 14 caractères). Il peut aussi être fourni avec ?token=. |
| priority | Non | Force cette priorité pour toutes les notifications : low, normal, high ou critical. Les formes abrégées fonctionnent aussi (par exemple crit). |
| info / success / warning / failure | Non | Remplace la priorité de ce type de notification (valeurs par défaut : normal / normal / high / high). Ex. ?info=low&failure=critical. |
| url | Non | Adresse derrière le bouton principal de la notification, par exemple l’exécution ou le journal concerné. |
| url_label | Non | Libellé du bouton, limité à 24 caractères. YouLMK affiche Open lorsque ce champ est absent. |
| group | Non | Les notifications du même groupe reçues en dix minutes sont regroupées sur une carte avec un compteur. Par défaut, le titre sert de groupe. |
| image | Non | Définissez yes pour remplacer l’icône de la source par l’image du type de notification Apprise. Valeur par défaut : no. |
Paramètres Globaux
Section intitulée « Paramètres Globaux »| 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. |
Exemples
Section intitulée « Exemples »Envoyer une notification :
apprise -vv -t "Sauvegarde terminée" -b "4,2 Go en 3 min 10 s" \ "youlmk://ylk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"La même chose avec la clé d’URL :
apprise -vv -t "Sauvegarde terminée" -b "4,2 Go en 3 min 10 s" \ "youlmk://k_xxxxxxxxxxxxxx"Rendre chaque échec critique, avec un lien vers le journal :
apprise -vv -n failure -t "Échec de la sauvegarde" -b "exit 2" \ "youlmk://ylk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx?failure=critical&url=https://example.com/logs/2041&url_label=Voir%20le%20journal"Exemple de configuration YAML :
urls: - youlmk://ylk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx?failure=critical - youlmk://k_xxxxxxxxxxxxxx?priority=low&group=nightly&image=yes 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 :