https://github.com/richardr1126/openreader

An open-source read-along document reader server with high-quality TTS options, synchronized highlighting, and audiobook export for EPUB, PDF, DOCX, TXT, and MD.
https://github.com/richardr1126/openreader

deepinfra-api document epub epub-reader epubjs gpt-4o-mini-tts kitten-tts kokoro-tts markdown-reader open-ai open-ai-tts openai-api orpheus-tts pdf pdf-reader text-to-speech tts txt-files

Last synced: 7 days ago
JSON representation

An open-source read-along document reader server with high-quality TTS options, synchronized highlighting, and audiobook export for EPUB, PDF, DOCX, TXT, and MD.

• Host: GitHub
• URL: https://github.com/richardr1126/openreader
• Owner: richardr1126
• License: mit
• Created: 2025-01-18T07:36:14.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2026-04-07T07:17:38.000Z (8 days ago)
• Last Synced: 2026-04-07T09:00:53.430Z (7 days ago)
• Topics: deepinfra-api, document, epub, epub-reader, epubjs, gpt-4o-mini-tts, kitten-tts, kokoro-tts, markdown-reader, open-ai, open-ai-tts, openai-api, orpheus-tts, pdf, pdf-reader, text-to-speech, tts, txt-files
• Language: TypeScript
• Homepage: https://openreader.richardr.dev
• Size: 4.14 MB
• Stars: 303
• Watchers: 9
• Forks: 48
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
[![GitHub Release](https://img.shields.io/github/v/release/richardr1126/openreader)](https://github.com/richardr1126/openreader/releases)

[![License](https://img.shields.io/github/license/richardr1126/openreader)](LICENSE)

[![Docs](https://img.shields.io/badge/docs-openreader-0a6c74)](https://docs.openreader.richardr.dev/)

[![Playwright Tests](https://github.com/richardr1126/openreader/actions/workflows/playwright.yml/badge.svg)](https://github.com/richardr1126/openreader/actions/workflows/playwright.yml)

[![Docs Check](https://github.com/richardr1126/openreader/actions/workflows/docs-check.yml/badge.svg)](https://github.com/richardr1126/openreader/actions/workflows/docs-check.yml)

[![GitHub Stars](https://img.shields.io/github/stars/richardr1126/openreader)](https://github.com/richardr1126/openreader/stargazers)

[![GitHub Forks](https://img.shields.io/github/forks/richardr1126/openreader)](https://github.com/richardr1126/openreader/network/members)

[![Discussions](https://img.shields.io/badge/Discussions-Ask%20a%20Question-blue)](https://github.com/richardr1126/openreader/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](https://docs.openreader.richardr.dev/)**.

## ✨ 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](https://docs.openreader.richardr.dev/docker-quick-start) |

| Deploy on Vercel | [Vercel Deployment](https://docs.openreader.richardr.dev/deploy/vercel-deployment) |

| Develop locally | [Local Development](https://docs.openreader.richardr.dev/deploy/local-development) |

| Configure auth | [Auth](https://docs.openreader.richardr.dev/configure/auth) |

| Configure SQL database | [Database and Migrations](https://docs.openreader.richardr.dev/configure/database) |

| Configure object storage | [Object / Blob Storage](https://docs.openreader.richardr.dev/configure/object-blob-storage) |

| Configure TTS providers | [TTS Providers](https://docs.openreader.richardr.dev/configure/tts-providers) |

| Run Kokoro locally | [Kokoro-FastAPI](https://docs.openreader.richardr.dev/configure/tts-provider-guides/kokoro-fastapi) |

| Run KittenTTS locally | [KittenTTS-FastAPI](https://docs.openreader.richardr.dev/configure/tts-provider-guides/kitten-tts-fastapi) |

| Get support or contribute | [Support and Contributing](https://docs.openreader.richardr.dev/about/support-and-contributing) |

## 🧭 Community

- Questions and ideas: [GitHub Discussions](https://github.com/richardr1126/openreader/discussions)

- Bug reports: [GitHub Issues](https://github.com/richardr1126/openreader/issues)

- Contributions: open a pull request

## 📜 License

MIT. See [LICENSE](LICENSE).