danvics/openreader
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
786 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 56305d5c1b refactor(documents): improve SSRF protection and filename sanitization 
Enhance SSRF mitigation in web-loader by expanding private IP detection for both
IPv4 and IPv6, including checks for multicast and broadcast addresses. Update
filename sanitization logic in UploadMenuDialog to collapse consecutive
disallowed characters and trim underscores, ensuring cleaner filenames. Remove
redundant userId check in import-url API route for streamlined authentication.
2026-06-10 12:59:14 -06:00
.github ci(playwright): simplify workflow by removing test matrix for browsers 2026-06-05 10:40:45 -06:00
compute Merge pull request #115 from richardr1126/fix/worker-sleep-railway 2026-06-10 10:00:53 -06:00
docker/entrypoint-migration-tools feat(build): improve Docker image layering and embed migration/worker tools 2026-06-03 14:08:33 -06:00
docs-site docs: snapshot v4.2.1 2026-06-10 00:01:38 +00:00
drizzle Refactor user data cleanup and TTS storage flows (#105) 2026-06-07 13:33:20 -06:00
public update(auth): enhance rate limiting with device/IP backstops and improve UI 2026-01-25 14:38:31 -07:00
scripts feat(user): remove legacy local file deletion and add cleanup for claimed FS sources 2026-06-03 14:35:27 -06:00
src refactor(documents): improve SSRF protection and filename sanitization 2026-06-10 12:59:14 -06:00
tests test(nlp): add case to ensure Catalan middle dot is preserved in audio text normalization 2026-06-10 09:38:41 -06:00
.dockerignore refactor(onboarding): modularize onboarding flow logic and improve testability 2026-05-29 18:03:17 -06:00
.env.example docs(security): update secret key generation instructions to use base64 encoding 2026-06-07 14:07:45 -06:00
.gitattributes Fix check mark in SettingsModal 2025-02-11 21:31:11 -07:00
.gitignore refactor(onboarding): modularize onboarding flow logic and improve testability 2026-05-29 18:03:17 -06:00
.npmrc chore: add .npmrc for npm configuration 2026-05-21 11:18:41 -06:00
Dockerfile Refactor user data cleanup and TTS storage flows (#105) 2026-06-07 13:33:20 -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 chore(lint): fix eslint violations in worker config and e2e tests 2026-05-21 21:44:58 -06:00
eslint.config.mjs Redesign: shared UI design system + app-wide migration (#96) 2026-06-01 16:17:12 -06:00
LICENSE Initial commit 2025-01-18 00:36:14 -07:00
next.config.ts refactor(pdf): centralize pdf.js runtime configuration and asset resolution 2026-06-05 10:40:38 -06:00
package.json feat(documents): add web import and creation dialog with SSRF-safe loader 2026-06-10 10:57:51 -06:00
playwright.config.ts Refactor user data cleanup and TTS storage flows (#105) 2026-06-07 13:33:20 -06:00
pnpm-lock.yaml feat(documents): add web import and creation dialog with SSRF-safe loader 2026-06-10 10:57:51 -06:00
pnpm-workspace.yaml feat(build): improve Docker image layering and embed migration/worker tools 2026-06-03 14:08:33 -06:00
postcss.config.mjs First push 2025-01-18 04:58:57 -07:00
README.md docs(intro): clarify open-source status and multilingual support in introduction 2026-06-06 12:19:28 -06:00
tailwind.config.ts Redesign: shared UI design system + app-wide migration (#96) 2026-06-01 16:17:12 -06:00
tsconfig.json build(tsconfig): add path alias for compute-core control-plane module 2026-05-26 15:45:19 -06:00
vercel.json Refactor user data cleanup and TTS storage flows (#105) 2026-06-07 13:33:20 -06:00
vitest.config.ts refactor(env): remove legacy no-auth mode and enforce required auth env vars 2026-05-31 12:09:37 -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 multilingual, 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).
  • 🌐 Multilingual support — choose a document language for language-aware narration and highlighting. Available languages depend on the configured TTS provider and voice.
  • 🎧 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

📜 License

MIT. See LICENSE.