Notifications Gotify

Aperçu

• Source: https://github.com/gotify/server
• Prise en charge des images: Non
• Prise en charge des pièces jointes: Non
• Limites de caractères des messages:
  • Corps: 32768
• Créer votre URL Apprise

Syntaxe

La syntaxe valide est la suivante :

• gotify://{hostname}/{token}
• gotifys://{hostname}/{token}
• gotifys://{hostname}:{port}/{token}
• gotifys://{hostname}/{path}/{token}
• gotifys://{hostname}:{port}/{path}/{token}
• gotifys://{hostname}/{token}/?priority=high

Les connexions securisees, via HTTPS, doivent etre referencees avec gotifys://, tandis que les connexions non securisees, via HTTP, doivent etre referencees avec gotify://.

Détail des Paramètres

Variable	Obligatoire	Description
hostname	Oui	Serveur Gotify auquel vous envoyez votre notification.
token	Oui	Application Token que vous avez genere sur votre serveur Gotify.
port	Non	Port sur lequel le serveur Gotify ecoute. La valeur par defaut est 80 pour gotify:// et 443 pour toutes les references gotifys://.
path	Non	Pour les personnes hebergeant leur serveur Gotify sur un hote necessitant un prefixe de chemin supplementaire, il suffit de l’inclure dans l’URL. La valeur par defaut est ’/’. L’important est que la derniere entree de l’URL reste le token.
priority	Non	Niveau de priorite avec lequel transmettre le message. Les valeurs possibles sont low, moderate, normal et high. Si aucune priorite n’est precisee, normal est utilise.
format	Non	Format de message a annoncer a Gotify. Par defaut, toutes les informations sont identifiees comme text. Vous pouvez toutefois definir cette valeur sur markdown.

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 Gotify :

# Supposons que notre {hostname} soit localhost
# Supposons que notre {token} soit abcdefghijklmn
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "gotify://gotify.server.local/abcdefghijklmn"

# Si votre serveur est heberge ailleurs et exige un chemin supplementaire
# pour y acceder, vous pouvez le notifier comme suit :
# Supposons que notre {hostname} soit localhost
# Supposons que notre {token} soit abcdefghijklmn
# Supposons que notre {path} soit /my/gotify/path/
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "gotify://gotify.server.local/my/gotify/path/abcdefghijklmn"

Il existe aussi une prise en charge de markdown si vous souhaitez l’exploiter ; ajoutez simplement format=markdown a votre URL :

# Supposons que notre {hostname} soit localhost
# Supposons que notre {token} soit abcdefghijklmn
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "gotify://gotify.server.local/abcdefghijklmn?format=markdown"
#                                                ^      ^
#                                                |      |