6.1 KiB
Executable File
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.
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
- 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)
- Create a virtual environment for Calibre-Web to avoid conflicts with existing Python dependencies
- Install Calibre-Web via pip:
pip install calibreweb
(orpip3
depending on your OS/distro) - Install optional features via pip as needed, see this page for details
- 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
- Open your browser and navigate to
http://localhost:8083
orhttp://localhost:8083/opds
for the OPDS catalog - Log in with the default admin credentials
- 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)
- Set
Location of Calibre database
to the path of the folder containing your Calibre library (metadata.db) and click "Submit" - Optionally, use Google Drive to host your Calibre library by following the Google Drive integration guide
- 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.5+
- Imagemagick for cover extraction from EPUBs (Windows users may need to install Ghostscript for PDF cover extraction)
- 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 orC:\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, armhf, aarch64
-
GitHub - Optional Calibre layer
Include the environment variable
DOCKER_MODS=linuxserver/calibre-web:calibre
in your Docker run/compose file to add the Calibreebook-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 convertertool" to
/usr/bin/ebook-convert
- Set "path to unrar" to
/usr/bin/unrar
- Set "path to convertertool" to
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