Richard R 5f28be5d58 refactor(env): remove legacy no-auth mode and enforce required auth env vars

Eliminate all code paths, configuration, and documentation related to running
without authentication. Require AUTH_SECRET and BASE_URL at startup, updating
middleware, server logic, and runtime checks to assume auth is always enabled.
Simplify onboarding, settings, and test helpers to reflect mandatory auth.
Update environment examples, Docker and deployment docs, and CI/test configs.
Remove no-auth-specific UI flows, test cases, and feature toggles.

2026-05-31 12:09:37 -06:00

3.9 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

🧱 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 ONNX Whisper alignment through the compute worker control plane (NATS JetStream-backed).
⚡ 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), built-in auth/session support, 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

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

📜 License

MIT. See LICENSE.