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

⚠️ Warning:
This project is in early development by a sole developer. Expect bugs, missing features, and frequent changes.
Data Loss Risk: Non-backwards compatible database changes may result in loss of metadata, such as book titles, authors, and reading progress. Your actual book files (PDFs and ePubs) are unlikely to be affected, but it's always a good idea to keep a backup of both your database and your book files.
Limited Support: As this is a one-person project, support may be slow, and features could be experimental or incomplete. Contributions and feedback are welcome!

✨ Key Features

Modern, Responsive UI – A sleek, highly reactive, and fluent interface for a seamless reading experience.
Organized Book Management – Categorize books using Libraries and Shelves for better organization.
Smart Metadata Handling – Automatically fetch book details from sources like Goodreads, Amazon, and Google Books, or edit them manually.
Multi-User Support – Admins can create user accounts, assign libraries, and manage permissions for metadata edits, uploads, and downloads.
Powerful eBook & PDF Reader – A feature-rich reader for PDFs and ePubs, with customizable reading settings.
And More to Come! – Continuous improvements and exciting new features are in development.

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:

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

docker compose up -d

4️⃣ Access BookLore

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

http://localhost:6060

After starting the containers, you can log into BookLore with the default admin credentials:

Username: admin
Password: admin123

⚠️ Important:
You’ll be prompted to change the default password upon your first login to ensure better security.

🔧 Configuration

The following environment variables can be configured:

Variable Name	Description	Default Value
DATABASE_URL	JDBC connection URL	`jdbc:mariadb://${DATABASE_HOST}:${DATABASE_PORT}/${DATABASE_NAME}`
DATABASE_HOST	Database hostname	`mariadb`
DATABASE_PORT	Database port	`3306`
DATABASE_NAME	Database name	`booklore`
DATABASE_USERNAME	Database username for app	`root`
DATABASE_PASSWORD	Database password for app	required
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	-
LOG_LEVEL	Log level for the application	`INFO`
ROOT_LOG_LEVEL	If you want to see all Spring logs	`INFO`

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.

Example implementations: