BookLore

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.

⚠️ 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 per-user progress tracking and 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 # User ID to ensure correct file permissions
      - PGID=1000 # Group ID to ensure correct file permissions
      - TZ=Etc/UTC # Set the timezone for logs and system operations
    depends_on:
      mariadb:
        condition: service_healthy
    ports:
      - "6060:6060"
    volumes:
      - /your/local/path/to/booklore/data:/app/data # Replace the left side before colon with your system path, keep the right side unchanged
      - /your/local/path/to/booklore/books:/books # Replace the left side before colon with your book storage path, keep the right side unchanged
    restart: unless-stopped

  mariadb:
    image: lscr.io/linuxserver/mariadb:11.4.5
    container_name: mariadb
    environment:
      - PUID=1000 # Ensure correct file ownership for database files
      - PGID=1000 # Ensure correct file ownership for database files
      - TZ=Etc/UTC # Set the timezone for logs and database operations
      - MYSQL_ROOT_PASSWORD=your_secure_password # Replace with a strong password for the database
    volumes:
      - /your/local/path/to/mariadb/config:/config # Replace the left side before colon with your system path, keep the right side unchanged
    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

5️⃣ First-Time Login

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.

Tech Stack

• Backend: Spring Boot (Java)
• Frontend: Angular (TypeScript)
• Database: MariaDB
• Containerization: Docker & Docker Compose