danvics/openreader
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
512 commits 2 branches 59 tags 8.5 MiB
TypeScript 95.1%
JavaScript 2.9%
CSS 1.8%
Dockerfile 0.2%
Find a file
Richard R a2c714c2a5 refactor(worker,tts): unify PDF and Whisper retry config, add alignment timeouts 
Update compute worker to use separate environment variable for PDF job attempts
(`COMPUTE_PDF_JOB_ATTEMPTS`) and set Whisper job max deliveries to 1, clarifying
and separating retry logic between job types. Adjust `.env.example` and deployment
docs to comment out defaults and document new/renamed variables for advanced tuning.

In TTS segment ensure route, introduce explicit timeouts for Whisper alignment
operations, with configurable durations for local and worker modes, improving
robustness and error handling for long-running alignments.
2026-05-21 12:37:21 -06:00
.github feat(compute): add external compute worker backend and integration 2026-05-19 15:21:25 -06:00
compute refactor(worker,tts): unify PDF and Whisper retry config, add alignment timeouts 2026-05-21 12:37:21 -06:00
docs-site refactor(worker,tts): unify PDF and Whisper retry config, add alignment timeouts 2026-05-21 12:37:21 -06:00
drizzle feat(pdf): implement granular PDF parse progress tracking and migrate to parseState 2026-05-21 10:27:16 -06:00
public update(auth): enhance rate limiting with device/IP backstops and improve UI 2026-01-25 14:38:31 -07:00
scripts refactor(config): migrate compute and runtime env vars to new naming scheme 2026-05-19 13:27:07 -06:00
src refactor(worker,tts): unify PDF and Whisper retry config, add alignment timeouts 2026-05-21 12:37:21 -06:00
tests Add force-reparse confirmation flow in PDF UI 2026-05-21 10:34:29 -06:00
.env.example chore(worker): migrate compute worker from Redis/BullMQ to NATS JetStream 2026-05-20 07:38:03 -06:00
.gitattributes Fix check mark in SettingsModal 2025-02-11 21:31:11 -07:00
.gitignore docs(deploy): update compute worker and Vercel deployment guides for Synadia + Railway 2026-05-20 14:17:07 -06:00
.npmrc chore: add .npmrc for npm configuration 2026-05-21 11:18:41 -06:00
Dockerfile refactor(worker): adopt operation-based API and opKey deduplication for compute flows 2026-05-21 09:05:26 -06:00
drizzle.config.pg.ts Refactor authentication schema and database handling 2026-02-15 12:49:23 -07:00
drizzle.config.sqlite.ts Refactor authentication schema and database handling 2026-02-15 12:49:23 -07:00
empty-module.ts First push 2025-01-18 04:58:57 -07:00
eslint.config.mjs First push 2025-01-18 04:58:57 -07:00
LICENSE Initial commit 2025-01-18 00:36:14 -07:00
next.config.ts refactor(worker): adopt operation-based API and opKey deduplication for compute flows 2026-05-21 09:05:26 -06:00
package.json chore(deps): update node engine requirement and clean server externals 2026-05-20 16:26:07 -06:00
playwright.config.ts refactor(audio): replace ffprobe with ffmpeg for metadata extraction 2026-02-15 12:13:29 -07:00
pnpm-lock.yaml refactor(compute): modularize core contracts and runtime, enable flexible backend resolution 2026-05-20 15:07:22 -06:00
pnpm-workspace.yaml feat(compute): add external compute worker backend and integration 2026-05-19 15:21:25 -06:00
postcss.config.mjs First push 2025-01-18 04:58:57 -07:00
README.md chore(worker): migrate compute worker from Redis/BullMQ to NATS JetStream 2026-05-20 07:38:03 -06:00
tailwind.config.ts fix(tailwind): fix footer layout and tailwind config 2025-11-22 16:32:03 -07:00
tsconfig.json refactor(compute): modularize core contracts and runtime, enable flexible backend resolution 2026-05-20 15:07:22 -06:00

README.md

GitHub Release License Docs Playwright Tests Docs Check

GitHub Stars GitHub Forks Discussions

📄🔊 OpenReader

OpenReader is an open source, self-host-friendly text-to-speech document reader built with Next.js for EPUB, PDF, TXT, MD, and DOCX with synchronized read-along playback.

Previously named OpenReader-WebUI.

Get started in the docs.

✨ Highlights

  • 🧱 Layout-aware PDF parsing with PP-DocLayoutV3 (ONNX) — structured block detection, cross-page stitching, and geometry-based highlighting for precise read-along sync.
  • ⏱️ Word-by-word highlighting via built-in ONNX Whisper alignment — no external dependencies, runs in-process (COMPUTE_MODE=local) or offloaded to a scalable NATS JetStream-backed worker (COMPUTE_MODE=worker).
  • ⚡ Segment-based read-along for EPUB, PDF, TXT, MD, and DOCX — sentence-aware TTS with cached audio segments, background preloading, and resumable playback.
  • 🎯 Multi-provider TTS — self-hosted OpenAI-compatible servers (Kokoro-FastAPI, KittenTTS-FastAPI, Orpheus-FastAPI) or cloud APIs (OpenAI, Replicate, DeepInfra).
  • 🎧 Audiobook export in m4b/mp3 with resumable chapter processing.
  • 🗂️ Flexible backend — embedded SeaweedFS or S3-compatible storage, SQLite or Postgres, server library import, and device sync.
  • 🐳 Self-host friendly — Docker (amd64/arm64), optional auth, and automatic startup migrations.

🚀 Start Here

Goal Link
Run with Docker Docker Quick Start
Deploy on Vercel Vercel Deployment
Deploy external compute worker Compute Worker (NATS JetStream)
Develop locally Local Development
Configure auth Auth
Configure SQL database Database and Migrations
Configure object storage Object / Blob Storage
Configure TTS providers TTS Providers
Run Kokoro locally Kokoro-FastAPI
Run KittenTTS locally KittenTTS-FastAPI
Get support or contribute Support and Contributing

🧭 Community

📜 License

MIT. See LICENSE.