danvics/openreader
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
465 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 ff62cc702e
Some checks failed
Create and publish Docker images / prepare (push) Has been cancelled
Details
Version Docs on Tag / version-docs (push) Has been cancelled
Details
Create and publish Docker images / build (amd64, linux/amd64, ubuntu-24.04) (push) Has been cancelled
Details
Create and publish Docker images / build (arm64, linux/arm64, ubuntu-24.04-arm) (push) Has been cancelled
Details
Create and publish Docker images / merge (push) Has been cancelled
Details
chore(config): downgrade pnpm version and refine allowBuilds exclusions 
Revert packageManager to pnpm@10.33.4 in package.json for compatibility.
Expand allowBuilds in pnpm-workspace.yaml to explicitly exclude canvas,
core-js, es5-ext, esbuild, sharp, and unrs-resolver from workspace builds.
These adjustments enhance build reliability and prevent issues with
problematic dependencies.
2026-05-14 16:22:07 -06:00
.github chore(workspace): streamline monorepo and CI with pnpm workspace, dependency, and workflow updates 2026-05-14 15:44:22 -06:00
docs-site chore(workspace): streamline monorepo and CI with pnpm workspace, dependency, and workflow updates 2026-05-14 15:44:22 -06:00
drizzle feat(admin,config,ui,db): introduce runtime-editable site config and admin-managed TTS providers 2026-05-12 22:39:24 -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(changelog): add changelog feed support and settings integration 2026-05-14 09:45:04 -06:00
src chore(workspace): streamline monorepo and CI with pnpm workspace, dependency, and workflow updates 2026-05-14 15:44:22 -06:00
tests feat(auth): add runtime toggle for user sign-ups and enforce signup policy 2026-05-14 12:47:05 -06:00
.env.example docs(admin-panel): clarify admin provider key handling and AUTH_SECRET rotation 2026-05-14 13:56:53 -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 chore(workspace): streamline monorepo and CI with pnpm workspace, dependency, and workflow updates 2026-05-14 15:44:22 -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(config): downgrade pnpm version and refine allowBuilds exclusions 2026-05-14 16:22:07 -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 chore(workspace): streamline monorepo and CI with pnpm workspace, dependency, and workflow updates 2026-05-14 15:44:22 -06:00
pnpm-workspace.yaml chore(config): downgrade pnpm version and refine allowBuilds exclusions 2026-05-14 16:22:07 -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.