Aller au contenu

Notifications Lunasea

Aperçu

La syntaxe valide est la suivante :

  • lunasea://{toFireBaseUser}
  • lunasea://{toFireBaseUser1}/{toFireBaseUser2}/{toFireBaseUserN}
  • lunasea://+{toFireBaseDevice}
  • lunasea://+{toFireBaseDevice1}/{toFireBaseDevice2}/{toFireBaseDeviceN}

Vous pouvez également combiner les formats :

  • lunasea://{user}:{pass}@/+{toFireBaseUser1}/{toFireBaseDevice1}/

Cela fonctionne exactement de la même façon ; vous pouvez simplement spécifier en plus vos informations de connexion à votre serveur local :

  • lunasea://{user}:{pass}@{hostname}/{toFireBaseUser}
  • lunasea://{user}:{pass}@{hostname}/{toFireBaseUser1}/{toFireBaseUser2}/{toFireBaseUserN}
  • lunasea://{user}:{pass}@{hostname}/+{toFireBaseDevice}
  • lunasea://{user}:{pass}@{hostname}/+{toFireBaseDevice1}/{toFireBaseDevice2}/{toFireBaseDeviceN}
  • lunasea://{user}:{pass}@{hostname}:{port}/{toFireBaseUser}
  • lunasea://{user}:{pass}@{hostname}:{port}/{toFireBaseUser1}/{toFireBaseUser2}/{toFireBaseUserN}
  • lunasea://{user}:{pass}@{hostname}:{port}/+{toFireBaseDevice}
  • lunasea://{user}:{pass}@{hostname}:{port}/+{toFireBaseDevice1}/{toFireBaseDevice2}/{toFireBaseDeviceN}

Remarque : Le {user}/{pass} est entièrement facultatif.

Vous pouvez également combiner les formats :

  • lunasea://{user}:{pass}@{hostname}/+{toFireBaseUser1}/{toFireBaseDevice1}/
  • lunasea://{user}:{pass}@{hostname}:{port}/+{toFireBaseUser1}/{toFireBaseDevice1}/

Utilisez lunaseas:// pour une connexion sécurisée (https://) et lunasea:// pour une connexion non sécurisée (http://).

lsea:// et lseas:// peuvent également être utilisés comme alias de lunasea:// et lunaseas:// (respectivement) si vous le souhaitez.

VariableRequisDescription
to*NonUn ou plusieurs identifiants Firebase User ou Device auxquels vous souhaitez envoyer votre notification. Vous pouvez utiliser des virgules pour séparer plusieurs entrées.
imageNonAssocie l’image liée au type de notification à la charge utile. Par défaut, cette valeur est définie sur no.
modeNonLe mode par défaut pour interpréter l’URL fournie. Les valeurs possibles sont cloud et private. Ce mode est détecté automatiquement si rien n’est précisé. En mode private, un nom d’hôte doit être fourni dans l’URL. En mode cloud, tous les éléments sont supposés être des points de terminaison de notification et https://lunasea.app est utilisé. En mode nuagique, toutes les transactions sont sécurisées (que vous spécifiiez lunasea:// ou lsea://).
VariableDescription
overflowCe 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.
formatCe 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é.
verifyLes 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.
ctoSignifie 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.
rtoSignifie 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.
emojisActive 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.
tzIdentifie 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.

Envoyer une notification LunaSea :

Fenêtre de terminal
# Assuming our {FireBaseDeviceID} is abcd_abcd_abcd
# Send to a Device (make sure to add + at front):
apprise -t "Titre de Test" -b "Message de Test" \
lunasea://+abcd_abcd_abcd
# Assuming our {FireBaseDeviceID} is abcd_abcd_abcd
# Assuming our {FireBaseUserID} is wxyz_wxyz_wxyz
#Send to a device (add +) and a user (optionally add @)
apprise -t "Titre de Test" -b "Message de Test" \
lunasea://+abcd_abcd_abcd/@wxyz_wxyz_wxyz
# Running your own private server, no problem:
# Assuming our {hostname} is myhostname
# Assuming our {user} is user
# Assuming our {password} is pass
# Assuming our {FireBaseDeviceID} is abcd_abcd_abcd
# Assuming our {FireBaseUserID} is wxyz_wxyz_wxyz
apprise -t "Titre de Test" -b "Message de Test" \
lunasea://user:pass@myhostname/+FireBaseDevice1/@FireBaseUserID
Questions ou commentaires ?

Documentation

Vous avez repéré une faute de frappe ou une erreur ? Signalez-la ou proposez une correction .

Problèmes Techniques

Vous rencontrez un problème avec le code ? Ouvrez un ticket sur GitHub :

Conçu avec amour depuis le Canada