crocodilestick/calibre-web-automated

★ 5,580JavaScriptAudience · generalComplexity · 3/5Setup · moderate

Mindmap

mindmap
  root((repo))
    What it does
      Self-hosted ebook library
      Auto-imports new books
      Format conversion
    Deployment
      Docker container
      NAS network share
    Features
      KOReader sync
      OAuth login
      Metadata management
    Companion apps
      Shelfmark web search
      Android mobile app

mindmap root((repo)) What it does Self-hosted ebook library Auto-imports new books Format conversion Deployment Docker container NAS network share Features KOReader sync OAuth login Metadata management Companion apps Shelfmark web search Android mobile app

Click or tap to explore — scroll the page freely

Things people build with this

USE CASE 1

Set up a personal ebook server where dropping an epub or PDF into a folder automatically adds it to your library with no manual steps.

USE CASE 2

Automatically convert ebooks to the right format for your reader device when they are added to the library.

USE CASE 3

Sync reading progress between your home server and a KOReader device so you can pick up where you left off across devices.

USE CASE 4

Access your entire ebook collection through a web browser from any device on your home network, secured with OAuth login.

Tech stack

JavaScriptDockerPythonCalibre

Getting it running

Difficulty · moderate Time to first run · 1h+

Runs as a Docker container, requires Docker Compose setup and a configured watched folder for automatic book ingestion.

In plain English

Calibre-Web Automated is a self-hosted digital library application built on top of Calibre-Web, a popular open-source tool for managing and reading ebooks through a web browser. The project adds a large set of automation features and quality-of-life improvements that the original Calibre-Web does not include, with the aim of making it a complete, standalone ebook library solution that runs on your own server. The original Calibre desktop application is well known and feature-rich, but it was designed for desktop use and becomes awkward when run inside a container on a home server. Calibre-Web solved part of that problem by offering a lighter, browser-based front end, but it lacked some of Calibre's core functions. Calibre-Web Automated bridges that gap by combining the clean web interface of Calibre-Web with the processing capabilities of Calibre, then adding extras such as automatic book ingestion, format conversion, and metadata management. The system runs as a Docker container. When you drop an ebook file into a monitored folder, the application can automatically detect it, convert it to the right format if needed, and add it to your library without any manual steps. It also supports syncing reading progress with KOReader devices, OAuth-based login for more secure authentication, and a network-share mode for deployments where the library files live on a NAS or shared network drive. Two companion projects are mentioned in the README: Shelfmark, a web interface for searching and requesting book downloads, and a mobile app called Calibre Web Companion for Android that provides a more phone-friendly browsing and download experience. The project is free and open source and has a community Discord server. The full README is longer than what was shown.

Copy-paste prompts

Prompt 1

Help me set up Calibre-Web Automated using Docker Compose, including a watched folder that auto-imports new ebook files and converts them to EPUB.

Prompt 2

Show me how to configure Calibre-Web Automated to automatically convert MOBI files to EPUB when they are dropped into the import folder.

Prompt 3

Set up OAuth login for Calibre-Web Automated using Google so users don't need a separate username and password to access the library.

Prompt 4

Configure Calibre-Web Automated to store the ebook library on a NAS network share using the network-share deployment mode.

Prompt 5

Walk me through setting up reading progress sync between Calibre-Web Automated and a KOReader device on my local network.

Open on GitHub → Explain another repo

← crocodilestick on gitmyhub — every repo by this author, as a profile.

Verify against the repo before relying on details.