BookBridge

📖 What is it?

BookBridge is a powerful synchronization engine for Audiobookshelf, KOReader, Storyteller, Grimmory, BookOrbit, Calibre-Web Automated, and reading trackers. It keeps supported reading, listening, and annotation state aligned across your devices and web readers.

✨ Key Features

• Multi-Service Sync: Syncs supported progress paths across Audiobookshelf, KOReader, Storyteller, Grimmory, BookOrbit, CWA/Kobo sync, and reading trackers.
• Multiple Readers: Give each person their own sign-in, their own service logins, and their own progress — everyone sees only the books they are reading, even on a shared book.
• Flexible Match Flows: Link ABS, Grimmory, or BookOrbit audiobooks; use CWA as an ebook source; or create ebook-only links when you only want text sync.
• Flexible Setup: You can intentionally turn Audiobookshelf off for ebook-only or maintenance-focused setups.
• Dashboard Session Details: See recent reading or listening session summaries right on the dashboard cards.
• Smart Alignment Sources: Uses Storyteller forced-alignment transcripts when available, then SMIL, then Whisper fallback.
• Web UI: Management dashboard for tracking syncs and matching books.
• Library Suggestions Page: Scan your library for likely audiobook + ebook pairs, review them, and queue matches in bulk.
• Same-Folder Matching: Treat sibling audiobook and ebook files in the same title folder as high-confidence matches.
• Guided Settings Workflow: Check your service settings from the UI and save everything in one place.
• Bridge Sync Plugin Companion: If you install the Bridge Sync KOReader plugin, it can manage bridge-provided books, sync reading stats, sync highlights/notes, and use Grimmory shelves to shape KOReader collections.
• Split-Port Security: Expose only the sync API to the internet while keeping the dashboard on your LAN.
• Self-Hosted: Runs entirely in Docker on your own server.

[!TIP] Upgrading? Review docs/getting-started.md to potentially simplify your docker-compose.yml volumes. The new Forge tool and CWA integration reduce the need for multiple volume mappings.

Quick Start

services:
  abs-kosync:
    container_name: abs_kosync
    image: ghcr.io/cporcellijr/bookbridge:latest
    restart: unless-stopped
    ports:
      - "8080:5757"
      # - "5758:5758"  # Optional: expose the sync-only port when using KOSYNC_PORT=5758
    environment:
      - TZ=America/New_York
      - LOG_LEVEL=INFO
      # - KOSYNC_PORT=5758  # Optional: enable split-port mode
      # Configure ABS, KOSync, Grimmory, BookOrbit, CWA, Storyteller, and other services in the Web UI.
    volumes:
      - ./data:/data
      - /path/to/ebooks:/books
      # - /path/to/storyteller/library:/storyteller_library  # Optional: local Storyteller fallback/download access
      # - /path/to/storyteller/assets:/storyteller/assets    # Optional: Storyteller transcript ingest

Forge now uploads directly to Storyteller over the API, so a Storyteller library mount is no longer required for normal Forge ingestion.

If you want KOReader to download and manage bridge-provided books for you, an optional Bridge Sync KOReader plugin is available from the project's GitHub Releases page.

If you use that plugin, Grimmory shelf settings in the bridge can also shape the KOReader collections it creates.

For full installation instructions, checking logs, and advanced configuration, please visit the Documentation Site.

License

Released under the MIT License.