calibre-web/README.md

Calibre-Web

Calibre-Web is a web app that offers a clean and intuitive interface for browsing, reading, and downloading eBooks using a valid Calibre database.

Table of Contents (click to expand)

1. About
2. Features
3. Installation
   • Installation via pip (recommended)
   • Quick start
   • Requirements
4. Docker Images
5. Contributor Recognition
6. Contact
7. Contributing to Calibre-Web

This software is a fork of library and licensed under the GPL v3 License.

Features

• Modern and responsive Bootstrap 3 HTML5 interface
• Full graphical setup
• Comprehensive user management with fine-grained per-user permissions
• Admin interface
• Multilingual user interface supporting 20+ languages (supported languages)
• OPDS feed for eBook reader apps
• Advanced search and filtering options
• Custom book collection (shelves) creation
• eBook metadata editing and deletion support
• Metadata download from various sources (extensible via plugins)
• eBook conversion through Calibre binaries
• eBook download restriction to logged-in users
• Public user registration support
• Send eBooks to E-Readers with a single click
• Sync Kobo devices with your Calibre library
• In-browser eBook reading support for multiple formats
• Upload new books in various formats, including audio formats
• Calibre Custom Columns support
• Content hiding based on categories and Custom Column content per user
• Self-update capability
• "Magic Link" login for easy access on eReaders
• LDAP, Google/GitHub OAuth, and proxy authentication support

Installation

Installation via pip (recommended)

1. Create a virtual environment for Calibre-Web to avoid conflicts with existing Python dependencies
2. Install Calibre-Web via pip: pip install calibreweb (or pip3 depending on your OS/distro)
3. Install optional features via pip as needed, see this page for details
4. Start Calibre-Web by typing cps

Note: Raspberry Pi OS users may encounter issues during installation. If so, please update pip (./venv/bin/python3 -m pip install --upgrade pip) and/or install cargo (sudo apt install cargo) before retrying the installation.

Refer to the Wiki for additional installation examples: manual installation, Linux Mint, Cloud Provider.

Quick Start

1. Open your browser and navigate to http://localhost:8083 or http://localhost:8083/opds for the OPDS catalog
2. Log in with the default admin credentials
3. If you don't have a Calibre database, you can use this database (move it out of the Calibre-Web folder to prevent overwriting during updates)
4. Set Location of Calibre database to the path of the folder containing your Calibre library (metadata.db) and click "Save"
5. Optionally, use Google Drive to host your Calibre library by following the Google Drive integration guide
6. Configure your Calibre-Web instance via the admin page, referring to the Basic Configuration and UI Configuration guides

Default Admin Login:

• Username: admin
• Password: admin123

Requirements

• Python 3.7+
• Imagemagick for cover extraction from EPUBs (Windows users may need to install Ghostscript for PDF cover extraction)
• Windows users need to install libmagic for 32bit python or libmagic for 64bit python, depending on the python version; The files need to be installed in path (e.g. script folder of your Calibre-Web venv, or in the root folder of Calibre-Web
• Optional: Calibre desktop program for on-the-fly conversion and metadata editing (set "calibre's converter tool" path on the setup page)
• Optional: Kepubify tool for Kobo device support (place the binary in /opt/kepubify on Linux or C:\Program Files\kepubify on Windows)

Docker Images

Pre-built Docker images are available in the following Docker Hub repositories (maintained by the LinuxServer team):

LinuxServer - x64, aarch64

• Docker Hub

• GitHub

• GitHub - Optional Calibre layer

  Include the environment variable DOCKER_MODS=linuxserver/mods:universal-calibre in your Docker run/compose file to add the Calibre ebook-convert binary (x64 only). Omit this variable for a lightweight image.

  Both the Calibre-Web and Calibre-Mod images are automatically rebuilt on new releases and updates.

  • Set "Path to Calibre Binaries" to /usr/bin
  • Set "Path to Unrar" to /usr/bin/unrar

Contributor Recognition

We would like to thank all the contributors and maintainers of Calibre-Web for their valuable input and dedication to the project. Your contributions are greatly appreciated.

Contact

Join us on Discord

For more information, How To's, and FAQs, please visit the Wiki

Contributing to Calibre-Web

Check out our Contributing Guidelines