Anime-Sanctuary

Kavita

Vos BD numérisées et vos livres numériques traînent dans des dossiers, sans marque-page ni couverture. Installons Kavita, un lecteur auto-hébergé qui les range en bibliothèque et retient où vous en êtes.

Parcours
Tutoriel 24 sur 35
Durée
35 min de lecture
Vérifié avec
Commandes : essais sous Debian 13 (Kavita 0.9.1)
Ce que vous saurez faire
  • Écrire un fichier Compose pour Kavita avec ses deux dossiers.
  • Ranger et nommer ses fichiers pour que Kavita les comprenne.
  • Créer le compte administrateur, une bibliothèque, puis des comptes pour la famille.
  • Sauvegarder sa configuration et mettre Kavita à jour.

Avant de commencer : Docker et Docker Compose.

Sommaire
  1. Ce que fait Kavita
  2. Ranger ses fichiers
  3. Écrire le fichier Compose
  4. Premier démarrage
  5. Créer le compte administrateur
  6. Ajouter une bibliothèque
  7. Lire dans le navigateur
  8. Des comptes pour la famille
  9. L'ouvrir sans exposer son port
  10. Sauvegarder et mettre à jour
  11. Si ça échoue
  12. La suite
  13. Sources

Comment installer Kavita avec Docker Compose sur Debian ? Il faut un fichier Compose d'une douzaine de lignes, deux dossiers et surtout des fichiers bien rangés : comptez trente-cinq minutes. Vous obtenez un lecteur de BD et de livres numériques dans le navigateur, qui retient la page où vous vous êtes arrêté.

Ce que fait Kavita

Kavita est une liseuse installée sur votre serveur, qui présente vos BD numérisées et vos livres numériques comme les rayons d'une médiathèque. Chaque série a sa couverture, chaque tome son numéro, et chaque lecteur garde son propre marque-page. Tout se lit dans un navigateur, sur ordinateur, tablette ou téléphone. Vos fichiers ne quittent pas votre serveur.

Kavita lit surtout les archives de pages, comme les fichiers .cbz. Une archive est un fichier qui contient d'autres fichiers ; ici, un zip classique dont chaque image est une page. Il lit aussi les livres numériques et les PDF. Pour qu'il s'y retrouve, vos fichiers doivent suivre un rangement précis, et c'est par là que nous commençons.

1Ranger ses fichiers

Kavita attend un dossier par série, et les tomes dedans. Un fichier posé directement à la racine de la bibliothèque est ignoré, et deux dossiers pour la même série la coupent en deux. Pour trouver le tome, il lit le numéro dans le nom du fichier. Une série d'exemple, Aventures de Pixel, ressemble à ceci :

  • Un dossier par série : Aventures de Pixel.
  • Un fichier par tome, avec le titre puis le numéro : Aventures de Pixel T01.cbz, Aventures de Pixel T02.cbz. La forme v01, que recommande la documentation, marche aussi.

Créons maintenant les deux dossiers de Kavita : un pour sa configuration, un pour vos fichiers à lire.

Sur le serveur
mkdir -p ~/kavita/config ~/kavita/bd
cd ~/kavita

Déposez vos fichiers depuis votre ordinateur avec rsync, vu dans Première sauvegarde avec rsync. Le dossier BD de la commande est le vôtre, avec un dossier par série.

Sur votre ordinateur
rsync -av BD/ alice@203.0.113.10:kavita/bd/

Les fichiers sont rangés. Il reste à décrire le conteneur qui les lira.

2Écrire le fichier Compose

Un seul service suffit : Kavita garde sa base de données dans son dossier de configuration. Le fichier Compose reprend ce que vous savez de l'article Docker et Docker Compose. Il relie vos deux dossiers au conteneur et réserve le port au serveur.

La ligne user indique le compte Linux sous lequel Kavita tourne. Ce sera le vôtre plutôt que root, le compte administrateur, ce qui limite les dégâts en cas de faille. Ce compte s'écrit avec deux nombres : id -u donne votre numéro d'utilisateur, id -g celui de votre groupe. Si alice est le premier compte créé, ils affichent 1000 deux fois.

Sur le serveur
id -u
id -g

Si vous voyez autre chose, remplacez "1000:1000" par vos deux nombres. Dans la commande suivante, cat recopie dans docker-compose.yml le texte placé entre <<'EOF' et la ligne EOF.

Sur le serveur
cat > docker-compose.yml <<'EOF'
services:
  kavita:
    image: jvmilazz0/kavita:0.9.1
    restart: unless-stopped
    user: "1000:1000"
    ports:
      - "127.0.0.1:5000:5000"
    volumes:
      - ./config:/kavita/config
      - ./bd:/books:ro
    environment:
      TZ: Europe/Paris
EOF

Chaque ligne a sa raison :

  • jvmilazz0/kavita:0.9.1 : l'image officielle, à version fixe. Rien ne change sans que vous l'ayez décidé.
  • 127.0.0.1:5000:5000 : le port 5000 est ouvert au serveur seulement. C'est voulu, nous y revenons plus bas.
  • ./config:/kavita/config : la configuration, les comptes et les couvertures. Le chemin à droite doit rester exactement celui-ci.
  • user: "1000:1000" : le compte sous lequel Kavita lit et écrit ses dossiers, celui que vous venez de vérifier.
  • ./bd:/books:ro : vos fichiers à lire, en lecture seule (ro). Kavita peut les ouvrir, jamais les modifier.
  • TZ : votre fuseau horaire, pour que les dates soient justes. Changez-le si vous n'êtes pas à Paris.

Le fichier est prêt. Allumons Kavita.

3Premier démarrage

La première commande télécharge l'image, puis démarre le conteneur. L'option -d de up -d le laisse tourner en arrière-plan, sans bloquer le terminal. Kavita prépare ensuite ses fichiers pendant près d'une minute.

Sur le serveur
sudo docker compose up -d

Après une minute, demandez-lui s'il est en état de répondre.

Sur le serveur
curl -s http://127.0.0.1:5000/api/health
Résultat attendu
Ok

Si vous obtenez une erreur de connexion, patientez dix secondes et recommencez. Kavita tourne, mais personne n'a encore de compte : c'est le moment de créer le vôtre.

4Créer le compte administrateur

Au premier lancement, Kavita propose de créer un compte, et ce premier compte devient administrateur. Tant qu'il n'existe pas, quiconque atteint le port peut le créer : le premier arrivé est le maître. Voilà pourquoi le port est réservé au serveur, et pourquoi vous passez par un tunnel.

Un tunnel SSH relie le port 5000 de votre ordinateur à celui du serveur, à travers la connexion SSH. Vous l'avez vu avec Nextcloud. Gardez cette fenêtre ouverte pendant la configuration.

Sur votre ordinateur
ssh -L 5000:127.0.0.1:5000 alice@203.0.113.10

Ouvrez http://localhost:5000 dans votre navigateur. Kavita demande un nom d'utilisateur, un mot de passe et une adresse e-mail. Prenez alice, un mot de passe long tiré de votre gestionnaire de mots de passe, et une adresse de votre choix : alice@exemple.fr convient, car Kavita n'envoie rien tant que vous n'avez pas réglé l'envoi de courriels.

Vous arrivez sur un accueil vide. Votre serveur a un administrateur, et c'est vous. Il faut maintenant lui montrer vos fichiers.

5Ajouter une bibliothèque

Une bibliothèque est un dossier que vous confiez à Kavita, avec un type qui dit comment lire son contenu. Dans les réglages du serveur, ouvrez l'onglet des bibliothèques et ajoutez-en une.

  • Nom : ce que vous voulez, par exemple « BD ».
  • Type : « Comic » pour des BD occidentales, « Manga » pour des mangas, « Book » pour des livres numériques. Ce choix change la façon de lire les noms de fichiers.
  • Dossier : /books. C'est le chemin à l'intérieur du conteneur, celui de droite dans le fichier Compose.

Validez : Kavita analyse le dossier. Comptez quelques secondes pour une poignée de fichiers, davantage pour une grosse collection.

Chaque tome apparaît avec sa couverture dans la série Aventures de Pixel. Kavita lit donc vos fichiers et leurs numéros. Ouvrons-en un.

6Lire dans le navigateur

Cliquez sur une série, puis sur un tome : le lecteur s'ouvre en plein écran. Un menu règle l'affichage, par exemple le zoom. Kavita note la page où vous vous arrêtez, et vous la propose à la prochaine visite.

Sur votre ordinateur, tout marche déjà par le tunnel. Un téléphone, lui, ne connaît pas votre localhost : il lui faut l'adresse HTTPS publique de l'étape 8. Avant cela, voyons comment ouvrir la porte à la famille.

Applications pour téléphone

Kavita permet aussi d'utiliser des applications tierces, listées dans son wiki. Elles demandent la même adresse HTTPS publique.

7Des comptes pour la famille

Chaque personne a son propre compte, avec sa progression et ses marque-pages. Vous choisissez ce que chacun peut voir. Dans les réglages du serveur, l'onglet des utilisateurs permet d'inviter quelqu'un :

  • Adresse e-mail : celle de la personne.
  • Rôles : le droit de se connecter suffit pour lire. Gardez « Admin » pour vous seul.
  • Bibliothèques : cochez celles qu'elle peut voir.

Tant que l'envoi de courriels n'est pas réglé, Kavita ne peut pas envoyer l'invitation. Il vous donne alors un lien à transmettre vous-même. Ce lien permet de créer le compte : envoyez-le à la bonne personne seulement, par un message privé.

Chacun peut ensuite se connecter, et vous n'avez plus à partager votre mot de passe. Ces comptes ne servent que si les autres atteignent le serveur : l'étape 8 le publie sur Internet, avec une porte d'entrée solide.

8L'ouvrir sans exposer son port

Ouvrir le port 5000 tel quel enverrait les mots de passe de la famille en clair sur Internet. Il faut donc une porte d'entrée solide : un Reverse proxy. Il reçoit les visiteurs en HTTPS, avec le certificat de HTTPS avec Let's Encrypt, puis transmet leur demande à 127.0.0.1:5000.

La configuration est celle de l'article dédié, avec l'adresse 127.0.0.1:5000 et un nom de domaine, par exemple kavita.exemple.fr, vu dans Nom de domaine et DNS. Kavita garde aussi une connexion ouverte en continu avec le navigateur. Apache a donc besoin de deux modules, des fonctions qu'on active à part : proxy_wstunnel laisse passer cette connexion, et rewrite la reconnaît et l'aiguille. Voici le VirtualHost complet, avec les trois lignes propres à Kavita.

Sur le serveur
sudo tee /etc/apache2/sites-available/kavita.exemple.fr.conf > /dev/null <<'EOF'
<VirtualHost *:80>
    ServerName kavita.exemple.fr
    ProxyPreserveHost On
    RewriteEngine On
    RewriteCond %{HTTP:Upgrade} =websocket [NC]
    RewriteRule /(.*) ws://127.0.0.1:5000/$1 [P,L]
    ProxyPass / http://127.0.0.1:5000/
    ProxyPassReverse / http://127.0.0.1:5000/
    RequestHeader set X-Forwarded-Proto expr=%{REQUEST_SCHEME}
</VirtualHost>
EOF

Activez ensuite les deux modules, puis le site et son certificat comme dans l'article du reverse proxy. a2enmod active un module, et reload fait relire sa configuration à Apache sans le couper.

Sur le serveur
sudo a2enmod proxy_wstunnel rewrite
sudo systemctl reload apache2

Vous n'utiliserez plus le tunnel : l'adresse devient https://kavita.exemple.fr. Tout Internet peut maintenant atteindre la page de connexion : gardez des mots de passe longs et ne créez de comptes que pour des personnes de confiance. Reste à garder une copie de ce que vous avez construit.

9Sauvegarder et mettre à jour

Ce qui compte, c'est le dossier config : comptes, bibliothèques, progression de chacun et couvertures. Vos fichiers se sauvegardent à part, comme dans Première sauvegarde avec rsync. Pour une copie cohérente, on arrête Kavita quelques secondes, on archive config avec tar, qui range le dossier dans un seul fichier compressé, puis on relance.

Sur le serveur
cd ~/kavita
sudo docker compose stop
tar czf kavita-config.tar.gz config
chmod 600 kavita-config.tar.gz
sudo docker compose start

L'archive contient vos comptes et les liens d'invitation : chmod 600 la réserve à vous seul, ne la laissez pas lisible par tous. Elle est petite, quelques dizaines de Ko pour une bibliothèque de test. Copiez-la ailleurs : une sauvegarde qui reste sur le serveur ne le protège pas d'une panne.

Restaurer la configuration

On arrête Kavita, on met la configuration actuelle de côté, on extrait l'archive dans ~/kavita, qui recrée config, puis on relance.

Sur le serveur
cd ~/kavita
sudo docker compose stop
mv config config.ancien
tar xzf kavita-config.tar.gz
sudo docker compose up -d

Pour mettre à jour, sauvegardez d'abord, puis téléchargez la nouvelle image et recréez le conteneur.

Sur le serveur
sudo docker compose pull
sudo docker compose up -d

Cette mise à jour ne change rien tant que le numéro 0.9.1 reste dans le fichier. Pour passer à une version plus récente, changez ce numéro, puis relancez les deux commandes.

Si ça échoue

Trois situations reviennent :

  • Un fichier n'apparaît pas. Il est posé à la racine de la bibliothèque. Rangez chaque série dans son dossier : dans notre essai, un fichier laissé à la racine n'était pas compté, et le même fichier rangé dans un dossier est devenu une série.
  • Une série porte un nom bizarre. Kavita prend le nom du dossier. Notre dossier Scan Final est devenu la série « scan final ». Renommez le dossier, puis relancez l'analyse de la bibliothèque.
  • Kavita ne voit rien alors que tout est bien rangé. Les fichiers ne sont peut-être pas lisibles par votre compte. Testez avec sudo docker compose exec kavita ls /books. Donnez les fichiers au compte de Kavita, celui de la ligne user : sudo chown -R 1000:1000 ~/kavita/bd, avec vos deux nombres si ce ne sont pas 1000. Ne les rendez pas lisibles par tous les comptes du serveur.

La suite

Vos films et vos livres ont chacun leur lecteur, avec des comptes pour la famille. Chaque service a désormais un mot de passe, et il y en aura d'autres. L'article suivant, Vaultwarden, installe un gestionnaire de mots de passe sur votre serveur pour ne plus les retenir un par un.