Skip to content

BeePub v0.1.0

Choose a tag to compare

@oalieno oalieno released this 07 Jul 15:09
eeed092

First public release of BeePub — a self-hosted EPUB library and reader, built as a modern alternative to calibre-web.

Highlights

  • Built-in web reader: reading progress, highlights, notes, table of contents, dark mode, mobile gestures
  • Proper CJK support: vertical (vertical-rl) EPUBs render correctly, including right-to-left page turns
  • iOS app via Capacitor, with offline reading for downloaded books
  • Library management: tags, series, metadata lookup from external sources, Calibre library import
  • Reading stats: activity tracking, streaks, and gacha-style random book pulls
  • Optional AI features: tagging, summaries, semantic search (pgvector), similar-book recommendations, companion chat, illustrations

Install

Two files, two env vars, no build:

mkdir beepub && cd beepub
curl -LO https://raw.githubusercontent.com/oalieno/beepub/main/docker-compose.yml
curl -Lo .env https://raw.githubusercontent.com/oalieno/beepub/main/.env.example
# edit .env: set POSTGRES_PASSWORD and SECRET_KEY (openssl rand -hex 32)
docker compose up -d

Open http://localhost and register — the first account becomes the admin. Images are multi-arch (amd64/arm64) on GHCR; pin a version with BEEPUB_VERSION=0.1.0 in .env. See the README for reverse-proxy and configuration details.