Intégration domotique Kavita, gratuite et open source
Votre serveur de lecture Kavita dans Gladys : nouvelles séries et tomes, lectures en cours, scans.
Publiée par guim31
- Appareils
- Version 1.0.0
- Nécessite Gladys >=5.1.0
- ★ 0
Intégrez votre serveur de lecture Kavita (livres, BD, mangas, auto-hébergé) à Gladys : les chiffres de vos bibliothèques, vos séries en cours et les pages lues aujourd'hui, les derniers ajouts avec leurs couvertures sur le tableau de bord, et des scènes qui réagissent à l'arrivée d'une nouvelle série ou d'un nouveau tome, ou quand vous terminez une série.
L'intégration a été testée avec un vrai serveur Kavita 0.9.1.4 (l'image Docker officielle), pas encore dans une vraie installation de Gladys : vos retours sont les bienvenus sur le forum Gladys ou dans les issues.
Ce qu'il vous faut
- Gladys Assistant 5.1.0 ou plus récent.
- Un serveur Kavita joignable depuis Gladys : sur votre réseau, ou sur Internet derrière un reverse proxy. Testé avec Kavita 0.9 ; la 0.8 devrait fonctionner.
- La clé d'API de votre compte Kavita : dans Kavita, Paramètres → 3rd Party Clients (Auth Keys depuis Kavita 0.9), copiez la clé. L'intégration voit ce que voit ce compte : ses bibliothèques, sa progression de lecture.
- La clé d'un administrateur donne en plus le nombre de tomes et permet les scans de bibliothèques ; la clé d'un lecteur suffit pour tout le reste.
Mise en place
- Installez l'intégration depuis le catalogue de Gladys.
- Dans Configuration, saisissez l'URL du serveur avec son port (par
exemple
http://192.168.1.20:5000; derrière un reverse proxy,https://example.org/kavita) et la clé d'API. - Si vous le souhaitez, choisissez la fréquence de lecture du serveur (toutes les 5 minutes par défaut) et la langue des noms.
- Enregistrez, puis cliquez sur Tester la connexion : elle affiche la version, le compte (administrateur ou lecteur) et les chiffres trouvés.
- Dans l'onglet Découverte, ajoutez l'appareil Kavita.
Appareil
Kavita (un appareil pour le serveur, vu depuis votre compte) :
| Fonctionnalité | Signification |
|---|---|
| En ligne | 1 tant que l'intégration lit le serveur |
| Bibliothèques | bibliothèques visibles par votre compte |
| Séries | séries du serveur (de vos bibliothèques avec une clé de lecteur) |
| Tomes | tomes du serveur (clé d'administrateur seulement) |
| Séries en cours | séries commencées et pas terminées (« En cours » / « On Deck ») |
| Pages lues aujourd'hui | pages lues aujourd'hui, comptées par Kavita |
| Version | version de Kavita |
Tableau de bord
- Kavita : derniers ajouts : une grille des dernières séries ajoutées, avec leurs couvertures, la date et la bibliothèque, le nombre de séries et de tomes et (clé d'administrateur) un bouton Lancer un scan, le même que l'action de scène ci-dessous.
- Kavita : lectures en cours : vos séries en cours avec leurs couvertures, les pages lues et la progression, le nombre de séries en cours et les pages lues aujourd'hui.
Scènes
Déclencheurs
- Nouvelle série ajoutée : une nouvelle série (livre, BD, manga) apparaît
dans une bibliothèque après un scan. Filtre : la bibliothèque, exactement
comme dans Kavita. Informations : titre de la série, bibliothèque, format
(
archive,epub,pdf,images). - Nouveau tome ou chapitre : un nouveau tome ou chapitre est ajouté à une série déjà présente dans Kavita. Filtre : la série que vous suivez, son titre exactement comme dans Kavita. Informations : titre de la série, bibliothèque.
- Série lue jusqu'au bout : vous arrivez à la dernière page d'une série, ou la marquez comme lue. Filtre : la bibliothèque. Informations : titre de la série, bibliothèque, pages.
Actions
- Scanner les bibliothèques Kavita : Kavita cherche les nouveaux fichiers dans une bibliothèque (son nom, sans tenir compte des majuscules) ou dans toutes ; le scan tourne en arrière-plan et les nouvelles séries arrivent à la lecture suivante, environ une minute plus tard. Clé d'administrateur seulement. Résultat : le nombre de bibliothèques scannées.
- Lire les derniers ajouts de Kavita : une phrase pour une notification ou une enceinte, par exemple « 2 nouvelle(s) série(s) sur Kavita ces 7 derniers jours : Quiet Morning et Test Comic. » Résultats : la phrase, le nombre de nouvelles séries, le titre de la dernière (12 séries au plus).
Idées de scènes
- Nouveau tome de mon manga : quand Nouveau tome ou chapitre avec votre série, envoyer la notification « Nouveau tome de {series} ».
- Résumé du dimanche : chaque dimanche à 10 h, Lire les derniers ajouts de Kavita, puis envoyer la phrase en message.
- Après les téléchargements : chaque nuit à 3 h, Scanner les bibliothèques Kavita, pour que les fichiers déposés par vos outils de téléchargement soient là le matin.
Dépannage
- « le serveur ne répond pas » : vérifiez l'adresse et le port depuis la
machine de Gladys. Gladys fait tourner l'intégration dans un conteneur :
localhostest le conteneur lui-même, utilisez l'adresse IP de la machine. - « clé d'API refusée » : la clé a été réinitialisée ou supprimée dans Kavita ; copiez-la de nouveau.
- « cette clé d'API n'est pas celle d'un administrateur » : le scan demande la clé d'un compte administrateur.
- « aucun serveur Kavita à cette adresse » ou « l'adresse redirige » :
un serveur derrière un reverse proxy demande son chemin de base
(
https://example.org/kavita) ; une page de connexion du proxy bloque l'API. - « certificat refusé » : le HTTPS avec un certificat auto-signé n'est pas
pris en charge ; utilisez l'adresse en
http://de votre réseau. - Pas de couverture : Kavita n'en a pas pour cette série (un EPUB sans image), ou enregistre ses couvertures en AVIF, que Gladys n'affiche pas (Kavita : Paramètres → Media → Save Media As : PNG ou WebP).
- L'intégration ne journalise que son cycle de vie ; avec
LOG_LEVEL=debug, elle journalise aussi chaque événement, avec les titres.
Limites
- Le serveur est lu toutes les 1 à 15 minutes, pas poussé : un ajout arrive dans Gladys dans cet intervalle (et après le scan de Kavita lui-même).
- Au plus 10 événements d'un même type par lecture (un premier gros scan annonce 10 séries, pas des centaines). Les tomes ajoutés depuis plus de 24 heures ne sont pas annoncés (un Gladys arrêté deux jours ne les rejoue pas).
- Série lue jusqu'au bout suit les 20 séries lues en dernier, au niveau de la série (un seul tome lu jusqu'au bout n'est pas un événement).
- Pages lues aujourd'hui suit les statistiques de lecture de Kavita (pages lues dans ses liseuses), comptées depuis la première lecture du jour : les pages lues après minuit pendant un arrêt de Gladys ou de Kavita ne comptent pas.
- Un compte Kavita et un serveur par installation de l'intégration.
- Sans lien avec le projet Kavita.
Paramètres de configuration
Voici les paramètres demandés par Kavita dans son écran de configuration dans Gladys.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| Connexion à votre serveur Kavita | section | Non | Indiquez l'adresse du serveur (par exemple http://192.168.1.20:5000) et la clé d'API de votre compte Kavita : dans Kavita, Paramètres > 3rd Party Clients (Auth Keys depuis la 0.9). La clé d'un administrateur donne aussi le nombre de tomes et les scans. |
| URL du serveur | string | Oui | Adresse du serveur, port inclus (5000 pour l'image Docker). Une adresse https derrière un reverse proxy fonctionne aussi, avec son chemin de base. |
| Clé d'API | secret | Oui | |
| Rafraîchissement | select | Non | Fréquence de lecture du serveur (environ huit requêtes légères à chaque fois). |
| Langue des noms | select | Non | Langue des noms de fonctionnalités et des textes des actions de scène. Les noms sont fixés à la création d'un appareil : pour les renommer après un changement, supprimez puis rajoutez l'appareil. |
Comment installer Kavita dans Gladys
- Dans Gladys, ouvrez Intégrations : Kavita apparaît dans le catalogue, aux côtés des intégrations natives, avec un badge communautaire.
- Cliquez sur Installer. Gladys télécharge l'image Docker (
ghcr.io/guim31/gladys-kavita:1.0.0), la démarre dans un bac à sable isolé du cœur, et génère l'interface de l'intégration (appareils, découverte et configuration). - Ouvrez l'écran Configuration de l'intégration, remplissez les paramètres, puis enregistrez.
- Vous pouvez aussi l'installer directement depuis l'URL de son dépôt : https://github.com/guim31/gladys-kavita.
Kavita nécessite Gladys >=5.1.0. Le catalogue dans Gladys se rafraîchit toutes les heures : une nouvelle version est donc disponible au plus tard une heure après sa sortie.
Vous n'utilisez pas encore Gladys ? C'est gratuit et open source : suivez le guide d'installation pour démarrer.
À propos des intégrations externes
Kavita est une intégration externe : une intégration communautaire empaquetée dans un conteneur Docker et publiée sur GitHub, que Gladys installe en un clic et exécute dans un bac à sable isolé de son cœur. Elle est publiée et maintenue par guim31, et non par l'équipe cœur de Gladys.
- Parcourir toutes les intégrations, natives et communautaires
- Créer et publier votre propre intégration externe
- Code source sur GitHub — source de cette documentation