adityachandelgit/BookLore

BookLore

GitHub release (latest by date) License Issues

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

📚 Organized Book Management - Categorize books with Libraries and Shelves for easy discovery and structured organization.
🧠 Smart Metadata Handling - Automatically fetch book details from Goodreads, Amazon, and Google Books, or edit them manually with fine-grained control.
👥 Multi-User Support - Admins can create accounts, assign libraries, and manage permissions for metadata edits, uploads, and downloads.
📖 Built-in PDF & ePub Reader - A fast, feature-rich reader for PDFs and ePubs, with customizable reading settings and a clean UI.
🌐 OPDS 1.2 Support - Browse and download books through the Open Publication Distribution System – compatible with many reading apps.
🔐 Optional OIDC Authentication - Secure access with OpenID Connect, supporting both local JWT authentication and external providers like Authentik.
📤 Multi-Book Uploads - Upload multiple books at once with metadata auto-detection and file organization.
📧 Send Books via Email - Share books directly with others by sending them via email – quick and easy.
🚀 Continuous Improvements - Frequent updates with new features, performance enhancements, and UI improvements. BookLore is perfect for self-hosters who want complete control over their digital library. Stay tuned for updates!

🎥 Video Guides & Tutorials

For a step-by-step walkthrough, check out the official BookLore video guides on YouTube:

📺 BookLore Tutorials – YouTube

These videos cover deployment, configuration, and feature highlights to help you get started quickly.

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

2️⃣ Create docker-compose.yml

Create a docker-compose.yml file with content:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41


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 # 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
      - /your/local/path/to/booklore/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=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: 10

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

3️⃣ Start the Containers

Run the following command to start the services:

1

docker compose up -d

4️⃣ Access BookLore

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

1

http://localhost:6060

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

🔐 Remote Authentication (Trusted Header SSO, Forward Auth)

If you run BookLore behind a reverse proxy with remote authentication (middleware), you can enable automatic login by setting REMOTE_AUTH_ENABLED to true.

This allows you to use your existing authentication system (e.g., OAuth, SAML) to log in to BookLore.

The following remote auth environment variables can be configured:

Variable Name	Description	Default Value
REMOTE_AUTH_ENABLED	Enable remote authentication	`false`
REMOTE_AUTH_CREATE_NEW_USERS	Auto-create users from remote auth	`true`
REMOTE_AUTH_HEADER_NAME	HTTP header containing user’s name	`Remote-Name`
REMOTE_AUTH_HEADER_USER	HTTP header containing username	`Remote-User`
REMOTE_AUTH_HEADER_EMAIL	HTTP header containing user’s email	`Remote-Email`
REMOTE_AUTH_HEADER_GROUPS	HTTP header containing user’s groups	`Remote-Groups`
REMOTE_AUTH_ADMIN_GROUP	Group name that grants admin privileges	-