Notifications Nextcloud

Aperçu

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

Configuration du Compte

L’application officielle Notifications doit être installée. Un « mot de passe d’application » (également appelé mot de passe/token « spécifique à l’appareil ») de l’utilisateur administrateur doit être créé ; consultez la documentation pour plus d’informations. N’oubliez pas de désactiver l’accès au système de fichiers pour ce mot de passe.

Syntaxe

Les connexions sécurisées (via https) doivent être référencées avec nclouds:// tandis que les connexions non sécurisées (via http) doivent utiliser ncloud://.

La syntaxe valide est la suivante :

• ncloud://{hostname}/{targets}
• ncloud://{hostname}:{port}/{targets}
• ncloud://{admin_user}:{password}@{hostname}/{targets}
• ncloud://{admin_user}:{password}@{hostname}:{port}/{targets}
• nclouds://{hostname}/{targets}
• nclouds://{hostname}:{port}/{targets}
• nclouds://{admin_user}:{password}@{hostname}/{targets}
• nclouds://{admin_user}:{password}@{hostname}:{port}/{targets}

Les cibles peuvent être un user ou un @group.

Vous pouvez notifier plusieurs utilisateurs en les enchaînant simplement à la fin de l’URL.

• ncloud://{admin_user}:{password}@{hostname}/{notify_user1}/{notify_user2}/{notify_userN}
• nclouds://{admin_user}:{password}@{hostname}/{notify_user1}/{notify_user2}/{notify_userN}
• ncloud://{admin_user}:{password}@{hostname}/{notify_group1}/{notify_group2}/{notify_groupN}
• nclouds://{admin_user}:{password}@{hostname}/{notify_group1}/{notify_group2}/{notify_groupN}

Vous pouvez également combiner des valeurs @group et user :

• ncloud://{admin_user}:{password}@{hostname}/{notify_group1}/{notify_user1}
• nclouds://{admin_user}:{password}@{hostname}/{notify_group1}/{notify_user1}

Détail des Paramètres

Variable	Requis	Description
hostname	Oui	Le nom d’hôte du serveur hébergeant votre service Nextcloud.
admin_user	Oui	L’utilisateur administrateur du service Nextcloud que vous avez configuré.
password	Oui	Le mot de passe administrateur associé à admin_user pour votre compte Nextcloud.
notify_user	Oui	Un ou plusieurs utilisateurs auxquels vous souhaitez envoyer votre notification.
to	Non	Alias de la variable notify_user.
version	Non	NextCloud a modifié son API à partir de la v21. Par défaut, Apprise utilise la dernière spécification de leur API. Si vous utilisez une version plus ancienne, vous pouvez définir cette valeur en conséquence et Apprise s’adaptera (en revenant à l’ancienne API).

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 une notification Nextcloud sécurisée à l’utilisateur chucknorris :

# Assuming our {host} is localhost
# Assuming our {admin_user} is admin
# Assuming our (admin) {password} is 12345-67890-12345-67890-12345:
apprise nclouds://admin:12345-67890-12345-67890-12345@localhost/chucknorris

Manipulation des En-têtes

Certains utilisateurs peuvent nécessiter la présence d’en-têtes HTTP spéciaux lors de la publication de données sur leur serveur. Cela peut être accompli en ajoutant simplement un tiret (-) devant tout paramètre spécifié dans la chaîne d’URL.

# Below would set the header:
#    X-Token: abcdefg
#
# We want to send an insecure connection (we'll use ncloud://)
# Assuming our {host} is localhost
# Assuming our {admin_user} is admin
# Assuming our (admin) {password} is 12345-67890-12345-67890-12345:
# We want to notify arnold
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   ncloud://admin:12345-67890-12345-67890-12345@localhost/arnold?-X-Token=abcdefg

# Multiple headers just require more entries defined with a hyphen in front:
# Below would set the headers:
#    X-Token: abcdefg
#    X-Apprise: is great
#
# Assuming our {host} is localhost
# Assuming our {admin_user} is admin
# Assuming our (admin) {password} is secret:
# We want to notify arnold
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   ncloud://admin:12345-67890-12345-67890-12345@localhost/arnold?-X-Token=abcdefg&-X-Apprise=is%20great

# If we're using an older version of NextCloud (their API changed) we may need
# to let Apprise know this (using the version= directive)
apprise -t "Title" -b "Corps du Message" "ncloud://admin:12345-67890-12345-67890-12345@localhost/arnold??version=20"

Utilisateurs :

apprise -vv -t "Title" -b "Message" \
  "ncloud://admin:pass@host/user1/user2"

Groupe :

apprise -vv -t "Title" -b "Message" \
  "ncloud://admin:pass@host/#DevTeam"

Tous :

apprise -vv -t "Title" -b "Message" \
  "ncloud://admin:pass@host/all"

Mixte (dédupliqué) :

apprise -vv -t "Title" -b "Message" \
  "ncloud://admin:pass@host/#DevTeam/user3/all"

Sous-chemin :

apprise -vv -t "Title" -b "Message" \
  "ncloud://admin:pass@host:8080/#Ops?url_prefix=/nextcloud"