Home

Awesome

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.

License Commit Activity All Releases PyPI PyPI - Downloads Discord

<details> <summary><strong>Table of Contents</strong> (click to expand)</summary>
  1. About
  2. Features
  3. Installation
  4. Docker Images
  5. Troubleshooting
  6. Contributor Recognition
  7. Contact
  8. Contributing to Calibre-Web
</details>

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

Main screen

Features

Installation

Installation via pip (recommended)

  1. Create a virtual environment: It’s essential to isolate your Calibre-Web installation to avoid dependency conflicts. You can create a virtual environment by running:
    python3 -m venv calibre-web-env
    
  2. Activate the virtual environment:
    source calibre-web-env/bin/activate
    
  3. Install Calibre-Web: Use pip to install the application:
    pip install calibreweb
    
  4. Install optional features: For additional functionality, you may need to install optional features. Refer to this page for details on what can be installed.
  5. Start Calibre-Web: After installation, you can start the application with:
    cps
    

Note: Users of Raspberry Pi OS may encounter installation issues. If you do, try upgrading pip and/or installing cargo as follows:

./venv/bin/python3 -m pip install --upgrade pip
sudo apt install cargo

Important Links

Quick Start

  1. Access Calibre-Web: Open your browser and navigate to:
    http://localhost:8083
    
    or for the OPDS catalog:
    http://localhost:8083/opds
    
  2. Log in: Use the default admin credentials:
    • Username: admin
    • Password: admin123
  3. Database Setup: If you do not have a Calibre database, download a sample from:
    https://github.com/janeczku/calibre-web/raw/master/library/metadata.db
    
    Move it out of the Calibre-Web folder to avoid overwriting during updates.
  4. Configure Calibre Database: In the admin interface, set the Location of Calibre database to the path of the folder containing your Calibre library (where metadata.db is located) and click "Save".
  5. Google Drive Integration: For hosting your Calibre library on Google Drive, refer to the Google Drive integration guide.
  6. Admin Configuration: Configure your instance via the admin page, referring to the Basic Configuration and UI Configuration guides.

Requirements

Docker Images

Pre-built Docker images are available:

LinuxServer - x64, aarch64

To include the Calibre ebook-convert binary (x64 only), add the environment variable:

DOCKER_MODS=linuxserver/mods:universal-calibre

in your Docker run/compose file. Omit this variable for a lightweight image.

Troubleshooting

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

To contribute, please check our Contributing Guidelines. We welcome issues, feature requests, and pull requests from the community.

Reporting Bugs

If you encounter bugs or issues, please report them in the issues section of the repository. Be sure to include detailed information about your setup and the problem encountered.

Feature Requests

We welcome suggestions for new features. Please create a new issue in the repository to discuss your ideas.

Additional Resources


Thank you for using Calibre-Web! We hope you enjoy managing your eBook library with our tool.