Richard R 3a21f2a5f5 refactor(config): migrate compute and runtime env vars to new naming scheme

- Replace `OPENREADER_COMPUTE_MODE` and related variables with `COMPUTE_MODE`
- Replace `OPENREADER_*` PDF/Whisper model URLs with `PDF_LAYOUT_MODEL_BASE_URL` and `WHISPER_MODEL_BASE_URL`
- Remove legacy `NEXT_PUBLIC_*` runtime config seeds in favor of `RUNTIME_SEED_*`
- Update documentation, code, and environment references to match new variable names
- Remove deprecated `scripts/fetch-models.mjs` and related npm script
- Update runtime config SSR injection from `window.__OPENREADER_RUNTIME_CONFIG__` to `window.__RUNTIME_CONFIG__`
- Adjust Next.js config to use new compute mode env var and optimize output file tracing for ONNX dependencies

BREAKING CHANGE: Environment variable names for compute mode, model URLs, and runtime config seeding have changed. Update `.env` files and deployment configs to use `COMPUTE_MODE`, `PDF_LAYOUT_MODEL_BASE_URL`, `WHISPER_MODEL_BASE_URL`, and `RUNTIME_SEED_*` as appropriate. Legacy `OPENREADER_*` and `NEXT_PUBLIC_*` variables are no longer supported.

2026-05-19 13:27:07 -06:00

3.6 KiB

Raw Blame History

📄🔊 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

🎯 Multi-provider TTS with OpenAI-compatible endpoints and cloud providers (Kokoro-FastAPI, KittenTTS-FastAPI, Orpheus-FastAPI or OpenAI, Replicate, DeepInfra).
📖 Read-along playback for PDF/EPUB with sentence-aware narration.
⏱️ Word-by-word highlighting via built-in ONNX Whisper alignment in local compute mode (COMPUTE_MODE=local).
🧱 Layout-aware PDF parsing (PP-DocLayoutV3 ONNX) with structured blocks for cleaner TTS/chaptering.
🛜 Sync + library import to bring docs across devices and from server-mounted folders.
🗂️ Flexible storage with embedded SeaweedFS or external S3-compatible backends.
🎧 Audiobook export in m4b/mp3 with resumable chapter processing.
🐳 Self-host friendly with Docker, optional auth, and automatic startup migrations.

🚀 Start Here

Goal	Link
Run with Docker	Docker Quick Start
Deploy on Vercel	Vercel Deployment
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

Questions and ideas: GitHub Discussions
Bug reports: GitHub Issues
Contributions: open a pull request

📜 License

MIT. See LICENSE.