Skip to content

calibrain/calibre-web-automated-book-downloader

Repository files navigation

πŸ“š Calibre-Web-Automated-Book-Downloader

Calibre-Web Automated Book Downloader

An intuitive web interface for searching and requesting book downloads, designed to work seamlessly with Calibre-Web-Automated. This project streamlines the process of downloading books and preparing them for integration into your Calibre library.

✨ Features

  • 🌐 User-friendly web interface for book search and download
  • πŸ”„ Automated download to your specified ingest folder
  • πŸ”Œ Seamless integration with Calibre-Web-Automated
  • πŸ“– Support for multiple book formats (epub, mobi, azw3, fb2, djvu, cbz, cbr)
  • πŸ›‘οΈ Cloudflare bypass capability for reliable downloads
  • 🐳 Docker-based deployment for quick setup

πŸ–ΌοΈ Screenshots

Main search interface Screenshot

Details modal Screenshot placeholder

Download queue Screenshot placeholder

πŸš€ Quick Start

Prerequisites

Installation Steps

  1. Get the docker-compose.yml:

    curl -O https://raw.githubusercontent.com/calibrain/calibre-web-automated-book-downloader/refs/heads/main/docker-compose.yml
  2. Start the service:

    docker compose up -d
  3. Access the web interface at http://localhost:8084

βš™οΈ Configuration

Environment Variables

Application Settings

Variable Description Default Value
FLASK_PORT Web interface port 8084
FLASK_DEBUG Debug mode toggle false
FLASK_HOST Web interface binding 0.0.0.0
INGEST_DIR Book download directory /cwa-book-ingest
UID Runtime user ID 1000
GID Runtime group ID 100
ENABLE_LOGGING Enable log file true

If logging is enabld, log folder default location is var/log/cwa-book-downloader

Download Settings

Variable Description Default Value
MAX_RETRY Maximum retry attempts 3
DEFAULT_SLEEP Retry delay (seconds) 5
MAIN_LOOP_SLEEP_TIME Processing loop delay (seconds) 5
SUPPORTED_FORMATS Supported book formats epub,mobi,azw3,fb2,djvu,cbz,cbr
BOOK_LANGUAGE Preferred language for books en
AA_DONATOR_KEY Optional Donator key for Anna's Archive fast download API ``

Note that PDF are NOT supported at the moment (they do not get ingested by CWA, but if you want to just download them locally, you can add pdf to the SUPPORTED_FORMATS env)
If you change BOOK_LANGUAGE, you can add multiple comma separated languages, such as en,fr,ru etc.

AA

Variable Description Default Value
AA_BASE_URL Base URL of Annas-Archive (could be changed for a proxy) https://annas-archive.org
USE_CF_BYPASS Disable CF bypass and use alternative links instead true

If you are a donator on AA, you can use your Key in AA_DONATOR_KEY to speed up downloads and bypass the wait times. If disabling the cloudflare bypass, you will be using alternative download hosts, such as libgen or z-lib, but they usually have a delay before getting the more recent books and their collection is not as big as aa's. But this setting should work for the majority of books.

Network Settings

Variable Description Default Value
CLOUDFLARE_PROXY_URL Cloudflare bypass service URL http://localhost:8000
PORT Container external port 8084

CLOUDFLARE_PROXY_URL is ignored if USE_CF_BYPASS is set to false

Volume Configuration

volumes:
  - /your/local/path:/cwa-book-ingest

Mount should align with your Calibre-Web-Automated ingest folder.

πŸ—οΈ Architecture

The application consists of two key services:

  1. calibre-web-automated-bookdownloader: Main application providing web interface and download functionality
  2. cloudflarebypassforscraping: Support service for handling Cloudflare-protected websites

πŸ₯ Health Monitoring

Built-in health checks monitor:

  • Web interface availability
  • Download service status
  • Cloudflare bypass service connection

Checks run every 30 seconds with a 30-second timeout and 3 retries.

πŸ“ Logging

Logs are available in:

  • Container: /var/logs/calibre-web-automated-bookdownloader.log
  • Docker logs: Access via docker logs

🀝 Contributing

Contributions are welcome! Feel free to submit a Pull Request.

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

⚠️ Important Disclaimers

Copyright Notice

While this tool can access various sources including those that might contain copyrighted material (e.g., Anna's Archive), it is designed for legitimate use only. Users are responsible for:

  • Ensuring they have the right to download requested materials
  • Respecting copyright laws and intellectual property rights
  • Using the tool in compliance with their local regulations

Duplicate Downloads Warning

Please note that the current version:

  • Does not check for existing files in the download directory
  • Does not verify if books already exist in your Calibre database
  • Exercise caution when requesting multiple books to avoid duplicates

πŸ’¬ Support

For issues or questions, please file an issue on the GitHub repository.