Installer BookLore avec Docker
BookLore

Installer BookLore avec Docker

Table des matières

GitHub - adityachandelgit/BookLore: BookLore is a web app for hosting, managing, and exploring books, with support for PDFs, eBooks, reading progress, metadata, and stats.
BookLore is a web app for hosting, managing, and exploring books, with support for PDFs, eBooks, reading progress, metadata, and stats. - adityachandelgit/BookLore

Aujourd'hui nous allons parler de BookLore ! Une application qui va centraliser vos livres au format PDF, ePub ou CBX. Le moins qu'on puisse dire c'est qu'elle est vachement bien réussie ! Non seulement elle est jolie, ce qui est subjectif, je vous l'accorde, mais par contre niveau fluidité & fonctionnalités, c'est indéniable, elle fait son job, et bien.

On peut apprécier la fonction mail pour envoyer directement un livre à une personne de son choix, directement à partir de l'interface.

Sa réactivité est immédiate à l'ajout d'un livre dans un dossier surveillé, pour peu que vous ayez coché l'option. On en reparle dans le tutoriel.


⚡ Caractéristiques

  • 📚 Gestion organisée des livres : Catégorisez les livres avec des bibliothèques et des étagères pour une découverte facile et une organisation structurée.
  • 🧠 Gestion intelligente des métadonnées : Récupérez automatiquement les détails des livres à partir de Goodreads, Amazon et Google Books, ou modifiez-les manuellement avec un contrôle précis.
  • 👥 Prise en charge multi-utilisateurs : Les administrateurs peuvent créer des comptes, assigner des bibliothèques et gérer les autorisations pour les modifications de métadonnées, les téléchargements et les téléchargements.
  • 📖 Lecteur PDF et ePub intégré : Un lecteur rapide et riche en fonctionnalités pour les PDF et les ePubs, avec des paramètres de lecture personnalisables et une interface utilisateur épurée.
  • 🌐 Prise en charge de l'OPDS 1.2 - Parcourez et téléchargez des livres via l'Open Publication Distribution System - compatible avec de nombreuses applications de lecture.
  • 🔐 Authentification OIDC optionnelle : Accès sécurisé avec OpenID Connect, supportant à la fois l'authentification JWT locale et les fournisseurs externes comme Authentik.
  • 📤 Téléchargement de plusieurs livres : Téléchargement de plusieurs livres à la fois avec auto-détection des métadonnées et organisation des fichiers.
  • 📧 Envoi de livres par courriel : Partagez des livres directement avec d'autres personnes en les envoyant par courriel - rapide et facile.
  • 🚀 Améliorations continues : Mises à jour fréquentes avec de nouvelles fonctionnalités, améliorations des performances et de l'interface utilisateur. BookLore est parfait pour les auto-hébergeurs qui veulent avoir un contrôle total sur leur bibliothèque numérique. Restez à l'écoute des mises à jour !

💾 Installation

Prérequis

Avant de commencer, assurez-vous d’avoir :

  • Distribution Linux (Ubuntu, Debian, etc ...).
  • Docker installé.
  • Accès terminal.
  • Connexion internet.

Étapes d'installation

  1. Créez votre compose.yml dans le dossier ou vous comptez installer BookLore :
nano compose.yml
  1. Et collez ça dedans :
services:
  booklore:
    image: ghcr.io/adityachandelgit/booklore-app:latest
    container_name: booklore
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - DATABASE_URL=jdbc:mariadb://mariadb:3306/booklore
      - DATABASE_USERNAME=booklore
      - DATABASE_PASSWORD=mon_super_mot_de_passe
      - SWAGGER_ENABLED=false
    depends_on:
      mariadb:
        condition: service_healthy
    ports:
      - "6060:6060"
    volumes:
      - ./data:/app/data
      - ./books:/books
    restart: unless-stopped

  mariadb:
    image: lscr.io/linuxserver/mariadb:11.4.5
    container_name: mariadb
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - MYSQL_ROOT_PASSWORD=mon_autre_super_mot_de_passe
      - MYSQL_DATABASE=booklore
      - MYSQL_USER=booklore
      - MYSQL_PASSWORD=mon_super_mot_de_passe
    volumes:
      - ./config:/config
    restart: unless-stopped
    healthcheck:
      test: ["CMD", "mariadb-admin", "ping", "-h", "localhost"]
      interval: 5s
      timeout: 5s
      retries: 10
  • - DATABASE_PASSWORD=mon_super_mot_de_passe => Changez mon_super_mot_de_passe par un autre mot de passe.
  • - MYSQL_ROOT_PASSWORD=mon_autre_super_mot_de_passe => Changez mon_autre_super_mot_de_passe par un mot de passe différent que choisi précédement.
  • - MYSQL_PASSWORD=mon_super_mot_de_passe => Mettez le même mot de passe choisi pour - DATABASE_PASSWORD.
  1. On va déployer l'application :
docker compose up -d
  1. Rendez-vous sur l'ip:port, suivant l'IP de votre serveur local et du port choisi, 6060 par défaut :
http://ip:6060/

ou votre domaine :

https://booklore.mondomaine.com

👤 Création du compte administrateur

Lors de votre première connexion, il vous sera demandé de créer votre compte administrateur.

Remplissez les informations suivantes :

  • 1 => Votre nom d'utilisateur.
  • 2 => Votre nom complet, éventuellement.
  • 3 => Entrez votre adresse mail.
  • 4 => Choisissez un mot de passe, fort de préférence.
  • 5 => Cliquez sur Create Admin Account pour terminer.

Vous pouvez vous connecter avec vos identifiants :

  • 1 => Votre nom d'utilisateur.
  • 2 => Votre mot de passe.
  • 3 => Validez en cliquant sur Login.

Vous voilà sur votre tableau de bord :


📚 Ajouter une bibliothèque

Au préalable, il faut déjà avoir classé sa bibliothèque et mettre le tout dans le dossier books. Vous pouvez également monter un dossier. Bien entendu.

Pour l'exemple j'ai ajouté 4 bibliothèques portant le numéro 1, 2, 3, 4. Très original.

Dans chaque dossier, j'ai des PDF ou des ePub.

Cliquez sur le + en haut à droite de votre interface :

Remplissez les informations demandées :

  • 1 => Nommez votre bibliothèque.
  • 2 => Choisissez une icône.
  • 3 => Cochez cette case si vous voulez que ce dossier soit surveillé, dans ce cas, à partir du moment où vous ajoutez un fichier, il sera automatiquement ajouté. C'est très réactif.
  • 4 => Cliquez sur Next.

Cliquez sur Add Book Folders :

Cliquez sur /books :

Mes Picsou sont dans le dossier 1, je fais un double clic dessus :

Cliquez sur Select :

Terminez en cliquant sur Save :

Immédiatement les fichiers sont repérés et ajoutés :

Faites de même pour chaque bibliothèque :


⬆️ Envoyer un fichier depuis l'interface

Rien de plus simple, cliquez sur la flèche à partir de votre interface :

Sélectionnez votre bibliothèque :

Ensuite il faudra choisir le dossier, dans mon cas je n'en ai qu'un :

Cliquez sur l'icône bleue et sélectionner le ou les fichiers à envoyer :

Maintenant, cliquez sur l'icône verte pour envoyer le tout, en cliquant sur l'icône rouge, cela annulera toute l'opération :

Lorsque c'est envoyé, vous verrez la mention Uploaded, fermez la fenêtre avec la croix :


📫 Configurer le serveur mail

Ajouter le serveur mail

Si vous souhaitez être notifié d'un nouveau rendez-vous, il faudra activer le serveur mail.

Dans le cas où vous avez votre propre service mail, vous avez les informations nécessaires à entrer ci-dessous.

Mais vous pouvez également utiliser les serveurs mail de Google, Outlook, Infomaniak,.. Jetez un œil ici pour avoir les paramètres nécessaires :

Configurer le SMTP pour envoyer un mail avec une application Docker
Tutoriel pour configurer le SMTP afin d’envoyer un mail à partir de vos applications self-hosted.

Rendez-vous dans Settings :

Maintenant cliquez sur Email Settings :

Pour configurer le serveur mail et ajouter le fournisseur, cliquez sur + Create New Provider :

Remplissez les informations demandées :

  • 1 => Nommez votre fournisseur. Gmail, Outlook,...
  • 2 => Indiquez le serveur SMTP.
  • 3 => Indiquez le port. Utilisez le TLS si possible.
  • 4 => Entrez l'adresse mail.
  • 5 => Entrez le mot de passe de l'adresse mail.
  • 6 => Indiquez l'adresse d'expédition, dans mon cas la même qu'au point 4.
  • 7 => Cochez Auth si vous avez une authentification avec mot de passe. Ce qui est très probablement le cas.
  • 8 => Cochez StartTLS si vous utilisez TLS.
  • 9 => Confirmez en cliquant sur Create Email Provider.

Le fournisseur est bien ajouté :

Configurez les destinataires

Vous pourrez envoyer un PDF ou un ePubs par mail directement par l'interface de Booklore. Il suffit de renseigner tous vos destinataires.

Toujours dans la partie mail, cliquez sur + Add New Recipient :

Remplissez les champs suivants :

  • 1 => Nommez le destinataire.
  • 2 => Entrez son adresse mail.
  • 3 => Cochez cette case pour qu'il revienne de destinataire par défaut.
  • 4 => Validez en cliquant sur Add Recipient.

Le destinataire est bien ajouté :

Répétez l'opération pour chaque destinataire.

Envoyer un fichier par mail à partir de l'interface

Cette option est plutôt cool, seul bémol, il ne faudra pas que le fichier excède la taille autorisée par votre serveur mail.

Cliquez sur le i d'un livre :

Si vous cliquez directement sur Quick Send, cela va envoyer le fichier à la personne définie par défaut, si vous cliquez sur la flèche vers le bas, vous pourrez choisir votre destinataire :

Sélectionnez le fournisseur et l'adresse mail à partir duquel cela doit partir et ensuite, la personne à qui l'envoyer et pour terminer, cliquez sur Send Book :

Ce qui donne :

Après quelques instances, le livre est bien arrivé dans ma boîte mail :


🎨 Choisir le thème de son interface

En haut à droite, cliquez sur la palette :

Vous avez le choix entre la couleur principale et le couleur de fond :

Ce qui donne :

Ou encore :


👥 Créer un utilisateur

Vous avez la possibilité d'ajouter un ou des utilisateurs.

Rendez-vous dans Settings :

Ensuite, cliquez sur User Management :

Remplissez les informations demandées :

  • 1 => Entrez le nom complet ou le pseudo, peu importe.
  • 2 => Ajoutez l'adresse mail de l'utilisateur.
  • 3 => Entrez son nom d'utilisateur.
  • 4 => Entrez un mot de passe.

Dans cette partie, il faudra choisir quelles bibliothèques lui seront accessibles :

Cochez les permissions :

  • Upload Books => Permet d'envoyer des fichiers.
  • Download Books => Permet le téléchargement de fichiers.
  • Edit Metadata => Permet d'éditer les metadatas.
  • Email Book => Permet d'envoyer un fichier par mail.
  • Admin => Permet à l'utilisateur d'être administrateur.

Cliquez sur Create User pour terminer.

Le nouvel utilisateur est bien créé :

  • 1 => Permet d'éditer l'utilisateur.
  • 2 => Pour changer le mot de passe.
  • 3 => Pour supprimer l'utilisateur.

zarev

->.<-
🐧 Passionné de self-hosting, je partage ce que je connais et me nourris des connaissances des bonnes âmes qui partagent avec moi. Soutenons l'utilisation des apps open source et leurs développeurs.

Vous pourriez aussi aimer