🚨 Important Announcement:
Docker images have moved to new repositories:
- Docker Hub:
https://hub.docker.com/r/booklore/booklore- GitHub Container Registry:
https://ghcr.io/booklore-app/bookloreThe legacy repo (
https://ghcr.io/adityachandelgit/booklore-app) will remain available for existing images but will not receive further updates.
BookLore is a self-hosted web app for organizing and managing your personal book collection. It provides an intuitive interface to browse, read, and track your progress across PDFs and eBooks. With robust metadata management, multi-user support, and a sleek, modern UI, BookLore makes it easy to build and explore your personal library.
- 📚 Book Organization: Organize with Libraries and Shelves. Sort by genre, author, or mood.
- 🧠 Smart Metadata: Auto-fetch from Goodreads, Amazon, Google Books, Hardcover, and more.
- 👥 Multi-User with Permissions: Add users, assign libraries, control edit/upload/download access.
- 📖 Built-in Reader: Read PDFs, ePubs, and CBX files in your browser with customizable themes.
- 🌐 OPDS 1.2 Support: Connect to reading apps for seamless downloads.
- 🔐 Flexible Auth: Optional OIDC login (Authentik, Pocket ID) or local JWT.
- 📤 BookDrop Auto-Import: Drop books in a folder for automatic scanning and metadata fetching.
- 📧 Email Sharing: Send books directly via email with one click.
- 📱 Mobile-Optimized: Responsive design for phones and tablets.
- 🔄 Open Source & Self-Hosted: Full control of your digital library.
- 🚀 Active Development: Regular updates to features, UI, and performance.
If you find BookLore helpful, please consider supporting its development:
- ⭐ Star this repository to show your appreciation and help others discover it.
- 💸 Contribute via Open Collective to help fund development, hosting, and testing costs.
📌 Currently raising funds for a Kobo device to implement and test native Kobo sync support.
💡 Support the Kobo Sync Bounty → - ⚡ Prefer one-time support? You can also donate via Venmo.
Evaluate BookLore’s features and user experience in a live environment:
Demo Access:
- 🌐 URL: demo.booklore.dev
- 👤 Username:
booklore - 🔑 Password:
9HC20PGGfitvWaZ1
⚠️ Note: The demo account has standard user permissions only.
- Admin features (user management, library setup, advanced configuration) are not available in this demo.
- To explore all capabilities, including administration and multi-user management, please deploy your own instance as described below.
Kick off your BookLore journey with our official documentation and helpful video guides.
📘 BookLore Documentation: Getting Started
Our up-to-date docs walk you through installation, setup, configuration, and key features, everything you need to get up and running smoothly.
🎥 BookLore Tutorials: YouTube
These older videos provide useful walkthroughs and visual guidance, but note that some content may be outdated compared to the current docs.
You can quickly set up and run BookLore using Docker.
Ensure you have Docker and Docker Compose installed.
Image Repositories:
- Docker Hub:
https://hub.docker.com/r/booklore/booklore - GitHub Container Registry:
https://ghcr.io/booklore-app/booklore
Note: Legacy images under
https://ghcr.io/adityachandelgit/booklore-appwill remain available but will not receive new updates.
Create a docker-compose.yml file with content:
services:
booklore:
# Official Docker Hub image:
image: booklore/booklore:latest
# Or the GHCR image:
# image: ghcr.io/booklore-app/booklore:latest
container_name: booklore
environment:
- PUID=1000
- PGID=1000
- TZ=Etc/UTC
- DATABASE_URL=jdbc:mariadb://mariadb:3306/booklore # Only modify this if you're familiar with JDBC and your database setup
- DATABASE_USERNAME=booklore # Must match MYSQL_USER defined in the mariadb container
- DATABASE_PASSWORD=your_secure_password # Use a strong password; must match MYSQL_PASSWORD defined in the mariadb container
- SWAGGER_ENABLED=false # Enable or disable Swagger UI (API docs). Set to 'true' to allow access; 'false' to block access (recommended for production).
depends_on:
mariadb:
condition: service_healthy
ports:
- "6060:6060"
volumes:
- /your/local/path/to/booklore/data:/app/data # Internal app data (settings, metadata, cache)
- /your/local/path/to/booklore/books1:/books1 # Book library folder — point to one of your collections
- /your/local/path/to/booklore/books2:/books2 # Another book library — you can mount multiple library folders this way
- /your/local/path/to/booklore/bookdrop:/bookdrop # Bookdrop folder — drop new files here for automatic import into libraries
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=super_secure_password # Use a strong password for the database's root user, should be different from MYSQL_PASSWORD
- MYSQL_DATABASE=booklore
- MYSQL_USER=booklore # Must match DATABASE_USERNAME defined in the booklore container
- MYSQL_PASSWORD=your_secure_password # Use a strong password; must match DATABASE_PASSWORD defined in the booklore container
volumes:
- /your/local/path/to/mariadb/config:/config
restart: unless-stopped
healthcheck:
test: ["CMD", "mariadb-admin", "ping", "-h", "localhost"]
interval: 5s
timeout: 5s
retries: 10Note: You can find the latest BookLore image tag BOOKLORE_IMAGE_TAG (e.g. v.0.x.x) from the Releases section:
📦 Latest Image Tag – GitHub Releases
Run the following command to start the services:
docker compose up -dOnce the containers are up, access BookLore in your browser at:
http://localhost:6060BookLore now supports a Bookdrop folder, a special directory where you can drop your book files (.pdf, .epub, .cbz, etc.), and BookLore will automatically detect, process, and prepare them for import. This makes it easy to bulk add new books without manually uploading each one.
- File Watcher: A background process continuously monitors the Bookdrop folder.
- File Detection: When new files are added, BookLore automatically reads them and extracts basic metadata (title, author, etc.) from filenames or embedded data.
- Optional Metadata Fetching: If enabled, BookLore can query metadata sources like Google Books or Open Library to enrich the book information.
- Review & Finalize: You can then review the detected books in the Bookdrop UI, edit metadata if needed, and assign each book to a library and folder structure before finalizing the import.
To enable the Bookdrop feature in Docker:
services:
booklore:
...
volumes:
- /your/local/path/to/booklore/data:/app/data
- /your/local/path/to/booklore/books:/books
- /your/local/path/to/booklore/bookdrop:/bookdrop # 👈 Bookdrop directoryBookLore supports optional OIDC/OAuth2 authentication for secure access. This feature allows you to integrate external authentication providers for a seamless login experience.
While the integration has been tested with Authentik and Pocket ID, it should work with other OIDC providers like Authelia as well. The setup allows you to use either JWT-based local authentication or external providers, giving users the flexibility to choose their preferred method.
For detailed instructions on setting up OIDC authentication:
BookLore also supports Forward Auth (also known as Remote Auth) for authentication through reverse proxies like Traefik, Nginx, or Caddy. Forward Auth works by having your reverse proxy handle authentication and pass user information via HTTP headers to BookLore. This can be set up with providers like Authelia and Authentik.
For detailed setup instructions and configuration examples:
- 🐞 Found a bug? Open an issue
- ✨ Want to contribute? Check out CONTRIBUTING.md
- 💬 Ask questions or share feedback: Discussions
- 💬 Join our Discord: Click here to chat with the community
Thanks to all the amazing people who contribute to Booklore.
- GNU GPL v3
- Copyright 2024-2025
