danvics/openreader
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
386 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 4a985b3bf1 feat(tts): add continuation loop guard and block fingerprinting 
Introduce safeguards for continuation handling in TTS flow to prevent looping and over-carrying text. Add constants to limit carried characters and words, and loop-guard thresholds. Implement normalizeBlockFingerprint to create compact fingerprints of page-first blocks and store them in pageFirstBlockFingerprintRef. Use fingerprint comparison and progress threshold to skip to next page when a loop is detected. Cap continuation slices by characters and words and ensure carried text matches the returned addition.

test(ui): make settings save button click more robust

In tests/helpers.ts wait for the Settings Save button to become visible (with a short timeout) before attempting to open Settings, and click the Settings button with force to avoid intermittent pointer-interception failures. Improve stability of setupTest by handling enter transitions and overlays.
2026-04-04 14:50:34 -06:00
.github feat: enhance docs deployment workflow with conditional execution for workflow runs 2026-02-19 13:02:18 -07:00
docs-site docs: snapshot v2.1.0 2026-03-19 18:40:29 +00:00
drizzle feat: Implement S3 proxy client, enhance session handling, and improve Drizzle migration script. 2026-02-18 02:39:54 -07: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 continuation loop guard and block fingerprinting 2026-04-04 14:50:34 -06:00
tests feat(tts): add continuation loop guard and block fingerprinting 2026-04-04 14:50:34 -06:00
.env.example feat(ui): add feature flag for TTS Providers tab and update related documentation 2026-03-19 12:25:42 -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 feat: Add SeaweedFS license retrieval and third-party license report generation in Dockerfile 2026-02-28 14:56:49 -07: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(package): update version to v2.1.0 2026-03-19 12:37:48 -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(privacy): implement data export and encryption with updated policy 2026-02-17 17:16:58 -07:00
postcss.config.mjs First push 2025-01-18 04:58:57 -07:00
README.md feat: add KittenTTS-FastAPI support and update documentation 2026-02-21 20:19:00 -07: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 (OpenAI, DeepInfra, Kokoro, KittenTTS-FastAPI, Orpheus, custom).
  • 📖 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.