danvics/openreader
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
414 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 0a7d392d77 docs(tts,storage,dev): update documentation for TTS segment storage, schema, and local setup 
Expand and clarify documentation for TTS segment storage, including key layout, cleanup, and CLI access in object storage. Add details on the `tts_segments` schema and migration process. Revise local development and Docker quick start guides with improved prerequisites, platform-specific setup instructions, and updated TTS provider references. Document new usage of `AUTH_SECRET` for TTS segment text fingerprinting.
2026-05-04 11:29:02 -06:00
.github build(deps): pin SeaweedFS Docker image to 4.18 for stability 2026-04-16 16:32:48 -06:00
docs-site docs(tts,storage,dev): update documentation for TTS segment storage, schema, and local setup 2026-05-04 11:29:02 -06:00
drizzle feat(tts): add TTS segments API, schema, storage, and manifest endpoints 2026-05-04 10:18:56 -06:00
public update(auth): enhance rate limiting with device/IP backstops and improve UI 2026-01-25 14:38:31 -07:00
scripts Fix SQL syntax for user table insert statement 2026-04-04 18:31:09 +11:00
src feat(tts): add TTS segments API, schema, storage, and manifest endpoints 2026-05-04 10:18:56 -06:00
tests feat(tts): add TTS segments API, schema, storage, and manifest endpoints 2026-05-04 10:18:56 -06:00
.env.example feat(tts): add TTS_UPSTREAM_TIMEOUT_MS for configurable request timeout 2026-04-06 17:48:56 -06:00
.gitattributes Fix check mark in SettingsModal 2025-02-11 21:31:11 -07:00
.gitignore feat(auth): implement session gatekeeping and architectural reorganization 2026-02-15 11:12:42 -07:00
.npmrc refactor: improve async state and session reliability 2026-02-15 15:13:25 -07:00
Dockerfile build(deps): pin SeaweedFS Docker image to 4.18 for stability 2026-04-16 16:32:48 -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 feat(auth): implement route protection and security headers 2026-02-16 19:06:24 -07:00
package.json chore: update version to 2.2.0 in package.json 2026-04-18 11:37:36 -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 feat: add support for Replicate TTS provider and models 2026-04-16 11:20:38 -06:00
postcss.config.mjs First push 2025-01-18 04:58:57 -07:00
README.md refactor(tts): update Replicate model defaults and voice resolution 2026-04-16 12:52:08 -06:00
tailwind.config.ts fix(tailwind): fix footer layout and tailwind config 2025-11-22 16:32:03 -07:00
tsconfig.json feat(docs): add configurable rate limiting and external docs 2026-02-10 15:11:37 -07: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

  • 🎯 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 optional whisper.cpp timestamps.
  • 🛜 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

📜 License

MIT. See LICENSE.