BookLore BookLore is a web app for hosting, ma @codeKK AndroidOpen Source Website

BookLore

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

More: Author ReportBugs

Tags:

GitHub release (latest by date) License Docker Pulls

🚨 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/booklore

The 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.

BookLore Demo

✨ Key Features

📚 Smart Organization: Build your dream library with custom shelves, smart sorting, and powerful filters to find any book instantly
👥 Multi-User Management: Add users with granular permissions for library access and content control
📲 Kobo Integration: Seamlessly sync your library with Kobo devices and convert EPUBs to KEPUB automatically
✨ Magic Shelves: Create dynamic, rule-based smart collections that auto-update in real time - like smart playlists for your books
🧠 Auto Metadata: Fetch rich book details from Goodreads, Amazon, Google Books, and Hardcover
📤 BookDrop Import: Drop files in a folder for automatic detection and bulk import
🌐 OPDS Support: Connect reading apps directly to your library for wireless downloads
🔑 Flexible Authentication: Choose between local accounts or external OIDC providers (Authentik, Pocket ID)
🔄 KOReader Sync: Track reading progress across KOReader and BookLore
📧 One-Click Sharing: Send books via email directly from the interface
🔐 Private Notes: Save personal reading notes visible only to you
🌍 Community Reviews: Auto-fetch public reviews to enrich your library
📖 Built-in Reader: Read PDFs, EPUBs, and comics with customizable themes
📱 Mobile Ready: Fully responsive design optimized for all devices

💖 Support the Project

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.

🌐 Live Demo: Explore BookLore in Action

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.

🚀 Getting Started with BookLore

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.

💡 Want to improve the documentation?
You can update the docs at booklore-app/booklore-docs and create a pull request to contribute your changes!

🎥 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.

🐳 Deploy with Docker

You can quickly set up and run BookLore using Docker.

1️⃣ Install Docker & Docker Compose

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-app will remain available but will not receive new updates.

2️⃣ Set Up Your docker-compose.yml Configuration

Step 1: Create a .env file in the same directory as your docker-compose.yml:

# BookLore Application Settings
APP_USER_ID=0
APP_GROUP_ID=0
TZ=Etc/UTC
BOOKLORE_PORT=6060

# Database Connection (BookLore)
DATABASE_URL=jdbc:mariadb://mariadb:3306/booklore
DB_USER=booklore
DB_PASSWORD=ChangeMe_BookLoreApp_2025!

# MariaDB Container Settings
DB_USER_ID=1000
DB_GROUP_ID=1000
MYSQL_ROOT_PASSWORD=ChangeMe_MariaDBRoot_2025!
MYSQL_DATABASE=booklore

Step 2: Create a docker-compose.yml file that references the .env variables:

services:
  booklore:
    image: booklore/booklore:latest
    # Alternative: Use GitHub Container Registry
    # image: ghcr.io/booklore-app/booklore:latest
    container_name: booklore
    environment:
      - USER_ID=${APP_USER_ID}
      - GROUP_ID=${APP_GROUP_ID}
      - TZ=${TZ}
      - DATABASE_URL=${DATABASE_URL}
      - DATABASE_USERNAME=${DB_USER}
      - DATABASE_PASSWORD=${DB_PASSWORD}
      - BOOKLORE_PORT=${BOOKLORE_PORT}
    depends_on:
      mariadb:
        condition: service_healthy
    ports:
      - "${BOOKLORE_PORT}:${BOOKLORE_PORT}"
    volumes:
      - ./data:/app/data
      - ./books:/books
      - ./bookdrop:/bookdrop
    restart: unless-stopped

  mariadb:
    image: lscr.io/linuxserver/mariadb:11.4.5
    container_name: mariadb
    environment:
      - PUID=${DB_USER_ID}
      - PGID=${DB_GROUP_ID}
      - TZ=${TZ}
      - MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD}
      - MYSQL_DATABASE=${MYSQL_DATABASE}
      - MYSQL_USER=${DB_USER}
      - MYSQL_PASSWORD=${DB_PASSWORD}
    volumes:
      - ./mariadb/config:/config
    restart: unless-stopped
    healthcheck:
      test: [ "CMD", "mariadb-admin", "ping", "-h", "localhost" ]
      interval: 5s
      timeout: 5s
      retries: 10

3️⃣ Start the Containers

Run the following command to start the services:

docker compose up -d

4️⃣ Access BookLore

Once the containers are up, access BookLore in your browser at:

http://localhost:6060

📥 Bookdrop Folder: Auto-Import Files

BookLore 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.

🔍 How It Works

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.

⚙️ Configuration (Docker Setup)

To enable the Bookdrop feature in Docker:

services:
  booklore:
    ...
    volumes:
      - ./data:/app/data
      - ./books:/books
      - ./bookdrop:/bookdrop # 👈 Bookdrop directory

🔑 OIDC/OAuth2 Authentication (Authentik, Pocket ID, etc.)

BookLore 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:

🛡️ Forward Auth with Reverse Proxy

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: