# 📚 BookLore ### *Your Personal Library, Beautifully Organized* **🌐 Official Website: [https://booklore.org](https://booklore.org/)**

BookLore Demo

[![Release](https://img.shields.io/github/v/release/adityachandelgit/BookLore?color=4c6ef5&style=for-the-badge&logo=github)](https://github.com/booklore-app/booklore/releases) [![License](https://img.shields.io/github/license/adityachandelgit/BookLore?color=fab005&style=for-the-badge)](LICENSE) [![Stars](https://img.shields.io/github/stars/adityachandelgit/BookLore?style=for-the-badge&color=ffd43b)](https://github.com/booklore-app/booklore/stargazers) [![Docker Pulls](https://img.shields.io/docker/pulls/booklore/booklore?color=2496ED&style=for-the-badge&logo=docker&logoColor=white)](https://hub.docker.com/r/booklore/booklore) [![Discord](https://img.shields.io/badge/Join_Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/Ee5hd458Uz) [![Open Collective](https://img.shields.io/opencollective/all/booklore?style=for-the-badge&color=7FADF2&logo=opencollective)](https://opencollective.com/booklore) --- **BookLore** is a powerful, self-hosted web application designed to organize and manage your personal book collection with elegance and ease. Build your dream library with an intuitive interface, robust metadata management, and seamless multi-user support. [🚀 Get Started](#-getting-started-with-booklore) • [📖 Documentation](https://booklore.org/docs/getting-started) • [🎮 Try Demo](#-live-demo-explore-booklore-in-action) • [💬 Community](https://discord.gg/Ee5hd458Uz)

---

## ✨ **Features That Make BookLore Shine**

### 📖 Library Management - Smart Organization: Custom shelves with powerful filters - Magic Shelves: Dynamic, auto-updating collections - Auto Metadata: Rich details from multiple sources - Advanced Search: Find any book instantly	### 🌐 Connectivity - Kobo Integration: Seamless device sync - OPDS Support: Connect any reading app - KOReader Sync: Cross-platform progress tracking - Email Sharing: One-click book sending
### 👥 User Experience - Multi-User Support: Granular permissions - Flexible Auth: Local or OIDC providers - Mobile Ready: Responsive on all devices - Built-in Reader: PDFs, EPUBs, comics	### 🚀 Smart Features - BookDrop Import: Auto-detect bulk files - Private Notes: Personal reading annotations - Community Reviews: Enriched book data - Progress Tracking: Reading statistics

---

## 💖 **Support the Project**

Your support helps BookLore grow and improve! 🌱

### ⭐ **Star Us** Give us a star to show your support and help others discover BookLore! [![Star this repo](https://img.shields.io/github/stars/adityachandelgit/BookLore?style=social)](https://github.com/booklore-app/booklore)

### 💰 **Sponsor** Support development, hosting, and testing costs [![Open Collective](https://img.shields.io/badge/Open_Collective-7FADF2?style=for-the-badge&logo=opencollective&logoColor=white)](https://opencollective.com/booklore)

### 📢 **Spread the Word** Share BookLore with fellow book lovers and developers!

> 🎯 **Current Goal:** Raising funds for a **Kobo device** to implement native Kobo sync support > [💡 Support the Kobo Sync Bounty →](https://opencollective.com/booklore/projects/kobo-device-for-testing)

---

## 🎮 **Live Demo: Explore BookLore in Action**

Experience BookLore's features in a live environment before deploying your own instance! | 🌐 Demo URL | 👤 Username | 🔑 Password | |----------------------------------------------------|-------------|--------------------| | **[demo.booklore.org](https://demo.booklore.org)** | `booklore` | `9HC20PGGfitvWaZ1` | > ⚠️ **Note:** Demo account has standard user permissions only. > Admin features (user management, library setup) require a self-hosted instance.

---

## 🚀 **Getting Started with BookLore** ### Choose Your Path

### 📘 **Documentation** Guides for installation, setup, features, and more [![Read the Docs](https://img.shields.io/badge/📖_Read_the_Docs-4c6ef5?style=for-the-badge)](https://booklore.org/docs/getting-started) *Contribute to the docs at: [booklore-docs](https://github.com/booklore-app/booklore-docs)*

### 🐳 **Quick Deploy** Get up and running in minutes with Docker [![Deploy with Docker](https://img.shields.io/badge/🐳_Deploy_Now-2496ED?style=for-the-badge)](#-deploy-with-docker) *Easiest way to self-host BookLore*

---

## 🐳 **Deploy with Docker**

### **Prerequisites** Ensure you have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed.

📦 Image Repositories

- 🐳 **Docker Hub:** `booklore/booklore` - 📦 **GitHub Container Registry:** `ghcr.io/booklore-app/booklore` > 💡 Legacy images at `ghcr.io/adityachandelgit/booklore-app` remain available but won't receive updates.

### **Step 1️⃣: Create Environment Configuration** Create a `.env` file in your project directory: ```ini # 🎯 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 Docker Compose File** Create a `docker-compose.yml` file: ```yaml 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 healthcheck: test: wget -q -O - http://localhost:${BOOKLORE_PORT}/api/v1/healthcheck interval: 60s retries: 5 start_period: 60s timeout: 10s 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 ``` ### **Step 3️⃣: Launch BookLore** ```bash docker compose up -d ``` ### **Step 4️⃣: Access Your Library** Open your browser and navigate to: **🌐 http://localhost:6060** 🎉 **Welcome to your personal library!** ---

## 📥 **BookDrop: Automatic Import** ### *Drop Files, Import Automatically*

BookLore's **BookDrop** feature automatically detects and processes book files dropped into a designated folder. ### **How It Works** ```mermaid graph LR A[📁 Drop Files] --> B[🔍 Auto-Detect] B --> C[📊 Extract Metadata] C --> D[✅ Review & Import] ``` 1. **File Watcher**: Monitors the BookDrop folder continuously 2. **Auto-Detection**: Processes new files and extracts metadata 3. **Metadata Enrichment**: Fetches details from Google Books, Open Library 4. **Review & Finalize**: Review, edit, and import to your library ### **Docker Configuration** Add the BookDrop volume to your `docker-compose.yml`: ```yaml services: booklore: volumes: - ./data:/app/data - ./books:/books - ./bookdrop:/bookdrop # 👈 BookDrop magic happens here ``` ---

## 🤝 **Community & Support**

### 🐞 **Bug Reports** Found an issue? [![Open Issue](https://img.shields.io/badge/Report-ff6b6b?style=for-the-badge)](https://github.com/booklore-app/booklore/issues/new?template=bug_report.yml)

### 💡 **Feature Req** Have an idea? [![Request Feature](https://img.shields.io/badge/Suggest-4ecdc4?style=for-the-badge)](https://github.com/booklore-app/booklore/issues/new?template=feature_request.yml)

### 🤝 **Contribute** Join development! [![Contributing](https://img.shields.io/badge/Contribute-95e1d3?style=for-the-badge)](CONTRIBUTING.md)

### 💬 **Chat** Join community! [![Discord](https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/Ee5hd458Uz)

---

## 📊 **Project Analytics** ### Repository Activity ![Repository Activity](https://repobeats.axiom.co/api/embed/44a04220bfc5136e7064181feb07d5bf0e59e27e.svg) ### ⭐ Star History

---

## 👨‍💻 **Contributors** ### Thanks to all our amazing contributors! 🙏 [![Contributors](https://contrib.rocks/image?repo=adityachandelgit/BookLore)](https://github.com/booklore-app/booklore/graphs/contributors) **Want to see your face here?** [Start contributing today!](CONTRIBUTING.md)

---

## 🌟 **Sponsors** ### Thank you to our amazing sponsors!

*Become a sponsor and get your logo here! [Support us on Open Collective](https://opencollective.com/booklore)*

---

## ⚖️ **License** **GNU General Public License v3.0** Copyright © 2024-2025 BookLore [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg?style=for-the-badge)](http://www.gnu.org/licenses/gpl.html) --- _{Made with ❤️ by the BookLore community} **[⬆ Back to Top](#-booklore)**

### 📖 Library Management - Smart Organization: Custom shelves with powerful filters - Magic Shelves: Dynamic, auto-updating collections - Auto Metadata: Rich details from multiple sources - Advanced Search: Find any book instantly	### 🌐 Connectivity - Kobo Integration: Seamless device sync - OPDS Support: Connect any reading app - KOReader Sync: Cross-platform progress tracking - Email Sharing: One-click book sending
### 👥 User Experience - Multi-User Support: Granular permissions - Flexible Auth: Local or OIDC providers - Mobile Ready: Responsive on all devices - Built-in Reader: PDFs, EPUBs, comics	### 🚀 Smart Features - BookDrop Import: Auto-detect bulk files - Private Notes: Personal reading annotations - Community Reviews: Enriched book data - Progress Tracking: Reading statistics