Initial vault setup
This commit is contained in:
@@ -0,0 +1,139 @@
|
||||
---
|
||||
title: Grimmory
|
||||
created: 2026-06-07
|
||||
updated: 2026-06-07
|
||||
type: app
|
||||
tags: [catalogue, books, ebook, comics, reader, opds, kobo, koreader, bookdrop, java, booklore]
|
||||
confidence: high
|
||||
contested: false
|
||||
sources: [https://selfh.st/apps/?tag=Books, https://github.com/grimmory-tools/grimmory, https://grimmory.org/]
|
||||
---
|
||||
|
||||
# ✨ Grimmory
|
||||
|
||||
> **La plateforme self-hosted « library-first » pour les lecteurs sérieux** — Fork communautaire indépendant de Booklore, avec lecteur intégré, smart shelves et BookDrop auto-import.
|
||||
|
||||
## 📋 Informations Générales
|
||||
|
||||
| Champ | Valeur |
|
||||
| :--- | :--- |
|
||||
| **Site web** | [grimmory.org](https://grimmory.org/) |
|
||||
| **GitHub** | [grimmory-tools/grimmory](https://github.com/grimmory-tools/grimmory) |
|
||||
| **Licence** | AGPL-3.0 |
|
||||
| **Langage** | Java (51,9%), TypeScript (30,2%) |
|
||||
| **Étoiles GitHub** | 3,4k ⭐ |
|
||||
| **Dernière MAJ** | 2026-06-04 |
|
||||
| **Catégorie** | [[cat-books|Books]] |
|
||||
|
||||
## 📝 Description
|
||||
|
||||
**Grimmory** est un **fork communautaire indépendant de Booklore** créé en 2025 par la communauté self-hosted (Reddit, Matrix, GitHub). Il se présente comme une **plateforme de bibliothèque numérique unifiée** où livres, BDs et audiobooks cohabitent dans une seule UI moderne, pensée pour des **lecteurs sérieux** qui veulent à la fois cataloguer finement, lire confortablement, et garder le contrôle de leurs données.
|
||||
|
||||
Le projet se distingue par ses **Smart Shelves** (étagères dynamiques à base de règles), son **BookDrop** (dossier surveillé qui détecte, enrichit et importe automatiquement les fichiers), son **lecteur intégré** PDF/EPUB/Comics avec annotations et surlignages, et sa **synchro multi-device** (Kobo, KOReader, n'importe quel client OPDS). L'**envoi en un clic** vers Kindle, email ou un autre utilisateur est l'une des fonctions signature.
|
||||
|
||||
Formats supportés : **EPUB, MOBI, AZW, AZW3, FB2, PDF, CBZ, CBR, CB7** pour la lecture, et **M4B, M4A, MP3, OPUS** pour les audiobooks (intégration possible avec [[app-audiobookshelf]]). L'authentification accepte **local + OIDC**. Le tag-line « for people who take their reading seriously » résume l'état d'esprit : pas minimaliste, pas gadget, complet et durable.
|
||||
|
||||
## 🚀 Installation
|
||||
|
||||
### Option 1 : Docker Compose (recommandé)
|
||||
|
||||
```yaml
|
||||
# docker-compose.yml
|
||||
services:
|
||||
grimmory:
|
||||
image: grimmory/grimmory:latest
|
||||
container_name: grimmory
|
||||
environment:
|
||||
- USER_ID=1000
|
||||
- GROUP_ID=1000
|
||||
- TZ=Europe/Paris
|
||||
- DATABASE_URL=jdbc:mariadb://mariadb:3306/grimmory
|
||||
- DATABASE_USERNAME=grimmory
|
||||
- DATABASE_PASSWORD=ChangeMe_Grimmory_2025!
|
||||
- DISK_TYPE=LOCAL
|
||||
depends_on:
|
||||
mariadb:
|
||||
condition: service_healthy
|
||||
ports:
|
||||
- 6060:6060
|
||||
volumes:
|
||||
- ./data:/app/data
|
||||
- ./books:/books
|
||||
- ./bookdrop:/bookdrop
|
||||
restart: unless-stopped
|
||||
|
||||
mariadb:
|
||||
image: lscr.io/linuxserver/mariadb:11.4.5
|
||||
environment:
|
||||
- PUID=1000
|
||||
- PGID=1000
|
||||
- TZ=Europe/Paris
|
||||
- MYSQL_ROOT_PASSWORD=ChangeMe_MariaDBRoot_2025!
|
||||
- MYSQL_DATABASE=grimmory
|
||||
- MYSQL_USER=grimmory
|
||||
- MYSQL_PASSWORD=ChangeMe_Grimmory_2025!
|
||||
volumes:
|
||||
- ./mariadb/config:/config
|
||||
restart: unless-stopped
|
||||
healthcheck:
|
||||
test: ["CMD", "mariadb-admin", "ping", "-h", "localhost"]
|
||||
interval: 5s
|
||||
timeout: 5s
|
||||
retries: 10
|
||||
```
|
||||
|
||||
Premier démarrage : `http://localhost:6060`, créer le compte admin, puis ajouter des **bibliothèques** pointant vers `/books`.
|
||||
|
||||
### Option 2 : Migration depuis Booklore
|
||||
|
||||
Gardez les mêmes `container_name`, base, user, ports, volumes et remplacez simplement l'image par `grimmory/grimmory:<tag>`. La migration est conçue pour être indolore.
|
||||
|
||||
## ⚙️ Configuration
|
||||
|
||||
1. **Bibliothèques** : créez des librairies distinctes par type (livres, BDs, mangas) pour bénéficier des bons scanners.
|
||||
2. **BookDrop** : déposez vos nouveaux achats dans `/bookdrop`, Grimmory détecte, enrichit les métadonnées (Google Books, Open Library, Amazon) et importe.
|
||||
3. **Smart Shelves** : règles AND/OR pour organiser dynamiquement (ex. : « tag = SF ET format = EPUB »).
|
||||
4. **Kobo / KOReader Sync** : activez la synchro depuis l'admin.
|
||||
5. **OIDC** : branchez Authentik / Keycloak pour centraliser l'auth.
|
||||
6. **Helm** : un chart officiel est fourni pour les déploiements Kubernetes.
|
||||
|
||||
## 🔄 Alternatives
|
||||
|
||||
### Open Source
|
||||
- [[app-kavita]] — Concurrent direct, plus EPUB-centric
|
||||
- [[app-komga]] — Référence pour comics / BDs
|
||||
- [[app-stump]] — Serveur Rust jeune
|
||||
- [[app-calibre-web-automated]] — Écosystème Calibre
|
||||
- [[app-audiobookshelf]] — Spécialisé audiobooks
|
||||
|
||||
### Propriétaires
|
||||
- **Booklore** (projet originel, encore maintenu)
|
||||
- **Amazon Kindle Library + Audible**
|
||||
- **Scribd**
|
||||
- **Libby / OverDrive**
|
||||
|
||||
## 🔐 Sécurité
|
||||
|
||||
- ✅ Authentification locale + **OIDC**
|
||||
- ✅ **BookDrop** centralisé et auditable
|
||||
- ✅ Multi-utilisateurs avec préférences isolées
|
||||
- ⚠️ AGPL-3.0 : si vous modifiez et exposez publiquement, partagez les sources
|
||||
- ⚠️ MariaDB : sauvegardez `./mariadb/config` régulièrement
|
||||
- ⚠️ HTTPS obligatoire pour la synchro Kobo/KOReader
|
||||
- ⚠️ N'oubliez pas de changer les mots de passe par défaut
|
||||
|
||||
## 📚 Ressources
|
||||
|
||||
- [selfh.st — Books](https://selfh.st/apps/?tag=Books)
|
||||
- [Site officiel](https://grimmory.org/)
|
||||
- [GitHub grimmory-tools/grimmory](https://github.com/grimmory-tools/grimmory)
|
||||
- [Image Docker Hub](https://hub.docker.com/r/grimmory/grimmory)
|
||||
- [Helm Chart officiel](https://github.com/grimmory-tools/grimmory/tree/develop/deploy/helm/grimmory)
|
||||
|
||||
## Pages Liées
|
||||
|
||||
- [[cat-books]] — Vue d'ensemble de la catégorie Books
|
||||
- [[app-komga]] — Concurrent centré comics/BDs
|
||||
- [[app-kavita]] — Lecteur complet cross-platform
|
||||
- [[app-shelfmark]] — Téléchargeur qui peut alimenter BookDrop
|
||||
- [[recettes-docker-compose]] — Templates Docker
|
||||
Reference in New Issue
Block a user