Installation

Apprise peut être installé comme paquet Python, comme paquet système sous Linux, ou exécuté dans un conteneur. Choisissez la méthode qui convient le mieux à votre environnement.

PyPI (Standard)

La manière la plus courante d’installer Apprise est d’utiliser pip. Cette méthode fonctionne sous Windows, macOS et Linux.

pip install apprise

Si vous n’utilisez pas d’environnement virtuel ou si vous ne disposez pas des droits suffisants sur la machine utilisée, vous devrez peut-être utiliser pip3 ou ajouter l’option --user :

pip3 install apprise --user

Distributions Linux

Apprise est empaqueté au format RPM et disponible via EPEL, avec prise en charge de CentOS, Red Hat, Rocky et Oracle Linux.

Red Hat / Rocky / Oracle / Fedora

Commencez par activer les dépôts EPEL si ce n’est pas déjà fait :

sudo dnf install epel-release

Installez ensuite Apprise :

sudo dnf install apprise

Docker

Apprise est disponible sous la forme d’une image Docker légère. C’est idéal si vous voulez exécuter l’API Apprise ou isoler le CLI de votre système hôte.

Récupérer l’Image

docker pull caronc/apprise:latest

Exécuter le CLI

Vous pouvez lancer directement la commande apprise via Docker sans installer Python sur votre machine hôte :

# Envoyer une notification via Docker
docker run --rm -it caronc/apprise \
    -t "Bonjour" -b "Monde" \
    "discord://webhook_id/webhook_token"

Exécuter le Serveur API

Vous pouvez aussi installer la version API avec interface graphique (API Apprise) depuis ce dépôt afin de centraliser votre configuration et vos notifications dans une interface web plus pratique.

# /config    sert à stocker tous les fichiers de configuration
#            générés via l'API.
#            Le stockage persistant interne vit sous /config/store, un
#            seul volume /config suffit donc.
# /plugin    sert à ajouter vos propres plugins Apprise personnalisés.
#            Vous n'avez pas besoin de le monter si vous ne comptez pas l'utiliser.
# /attach    sert aux pièces jointes.
#
# /tmp       fichiers temporaires, adapté à tmpfs dans les déploiements durcis.
#
# L'exemple ci-dessous définit APPRISE_WORKER_COUNT à une petite valeur
# (en remplacement d'un réglage de production plus élevé). Cela peut suffire
# pour une solution auto-hébergée légère.
#
# Définir APPRISE_STATEFUL_MODE sur simple vous permet de faire correspondre
# directement votre {key} à un fichier situé dans /config. Dans une
# configuration domestique simple, c'est souvent l'approche idéale.
#
# Définissez votre UID et votre GID si vous souhaitez remplacer la valeur
# par défaut de 1000. Dans l'exemple ci-dessous, nous nous assurons que
# le conteneur s'exécute avec l'utilisateur qui l'a créé.

# pré-créez vos répertoires
mkdir -p /path/to/local/{config,plugin,attach}

docker run --name apprise \
   -p 8000:8000 \
   --user "$(id -u):$(id -g)" \
   -v /path/to/local/config:/config \
   -v /path/to/local/plugin:/plugin \
   -v /path/to/local/attach:/attach \
   -e APPRISE_STATEFUL_MODE=simple \
   -e APPRISE_WORKER_COUNT=1 \
   -e APPRISE_ADMIN=y \
   -d caronc/apprise:latest

Vous pouvez accéder à votre nouvelle instance auto-hébergée de l’API Apprise à l’adresse : http://docker-host:8000

Docker Compose

Vous pouvez configurer l’API Apprise via Docker Compose. Consultez Déploiement pour les instructions complètes.