ForgeLibrary

Ce qu'il faut

• Docker et Docker Compose installés
• Accès à un serveur (ou machine locale) avec connexion internet
• OpenSSL pour générer le secret JWT
• Certbot (optionnel) pour le certificat HTTPS

Installation

Premier lancement

1. 1Ouvrir le navigateur et accéder à l'URL du serveur (ex. https://forgelibrary.heiphaistos.org).
2. 2Se connecter avec le compte admin créé lors de l'installation.
3. 3Accéder au tableau de bord `/admin` pour configurer les paramètres généraux et ajouter d'autres comptes si besoin.

importer des livres

Vous pouvez ajouter des livres par glisser‑déposer, dépôt dans le dossier surveillé ou via SFTP.

1. 1Se rendre sur la page principale et glisser les fichiers dans la zone d'import.
2. 2Copier les fichiers dans le répertoire `/data/inbox` du serveur (via SFTP ou montage réseau).
3. 3Lancer un scan manuel si besoin : `POST /api/import/scan` depuis un outil comme curl ou Postman.

gérer les métadonnées

Les métadonnées sont extraites puis enrichies automatiquement.

1. 1Ouvrir la fiche d'un livre depuis le tableau de bord.
2. 2Vérifier les informations affichées (couverture, auteur, résumé, ISBN).
3. 3Modifier manuellement les champs qui nécessitent une correction, puis enregistrer.

utiliser l'étagère 3D

Visualisez votre collection sous forme de volumes sur des étagères virtuelles.

1. 1Activer l'étagère 3D depuis le bouton d'interrupteur présent dans les paramètres d'affichage.
2. 2Naviguer dans la vue 3D en utilisant la souris ou le pavé tactile.
3. 3Désactiver l'étagère 3D pour économiser la bande passante; le script three.js ne sera plus chargé.

synchroniser la lecture entre appareils

La position de lecture est sauvegardée et restaurée sur tous les appareils connectés.

1. 1Ouvrir un livre sur un appareil et lire quelques pages.
2. 2Fermer le livre ou changer d'appareil ; la position est enregistrée automatiquement.
3. 3Rouvrir le même livre sur un autre appareil ; la lecture reprend à la même position.

installer l'application PWA

ForgeLibrary peut être installée comme application web progressive pour une utilisation hors‑ligne.

1. 1Ouvrir le site dans Chrome ou Edge.
2. 2Cliquer sur l'icône d'installation (dans la barre d'adresse) et choisir « Installer ».
3. 3Lancer l'application depuis le raccourci créé ; les livres déjà ouverts restent accessibles hors‑ligne.

utiliser le catalogue OPDS

Accédez à votre bibliothèque depuis des lecteurs externes compatibles OPDS.

1. 1Ouvrir l'URL `/opds` dans votre lecteur (ex. KOReader, Moon+ Reader).
2. 2Saisir l'identifiant et le mot de passe du compte ForgeLibrary.
3. 3Parcourir le catalogue et télécharger les livres souhaités directement dans le lecteur.

effectuer une sauvegarde manuelle

Les sauvegardes quotidiennes sont automatiques, mais vous pouvez en télécharger une à tout moment.

1. 1Se rendre dans le panneau d'administration → Sauvegardes.
2. 2Choisir la sauvegarde souhaitée parmi les 14 dernières et cliquer sur « Télécharger ».
3. 3Conserver le fichier .db dans un lieu sûr pour une éventuelle restauration.

déployer automatiquement avec GitHub Actions

Le dépôt possède un workflow qui déploie le serveur à chaque push sur master.

1. 1Configurer les secrets du dépôt : `VPS_SSH_KEY`, `VPS_HOST` (optionnel) et `VPS_KNOWN_HOSTS`.
2. 2Pousser les modifications sur la branche master ; le workflow déclenchera le déploiement.
3. 3Vérifier le journal d'Actions pour s'assurer que le déploiement s'est déroulé sans erreur.

Astuces

• Utilisez des mots‑de‑passe longs et uniques pour les comptes admin.
• Activez la corbeille de 30 jours pour pouvoir restaurer des livres supprimés accidentellement.
• Personnalisez l'apparence (thème, disposition, typographie) depuis les paramètres pour une lecture confortable.

Questions fréquentes