danvics/openreader
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
openreader/docs-site/docs/introduction.md
Richard R 893f74f038 refactor(tts): update Replicate model defaults and voice resolution 
Align default Replicate model to the versioned Kokoro model across UI, docs,
and server logic. Refactor TTS settings merging for audiobooks to ensure
consistent normalization. Improve Retry-After header handling for upstream
rate limits. Expand Replicate voice resolution to use model schemas when
available, with test coverage for custom and built-in models.

Update documentation to reflect new Replicate defaults, model selection,
and configuration guidance.
2026-04-16 12:52:08 -06:00

2.9 KiB
Raw Blame History

id title slug
intro Introduction /

OpenReader is an open source text-to-speech document reader built with Next.js. It provides a read-along experience with narration for EPUB, PDF, TXT, MD, and DOCX documents.

Previously named OpenReader-WebUI.

It supports multiple TTS providers including OpenAI, Replicate, DeepInfra, and custom OpenAI-compatible endpoints such as Kokoro-FastAPI, KittenTTS-FastAPI, and Orpheus-FastAPI.

✨ Highlights

  • 🎯 Multi-Provider TTS Support
    • Kokoro-FastAPI: supports multi-voice combinations (for example af_heart+af_bella)
    • KittenTTS-FastAPI: lightweight, CPU-friendly self-hosted TTS
    • Orpheus-FastAPI
    • Custom OpenAI-compatible: any TTS API with /v1/audio/voices and /v1/audio/speech endpoints
    • Cloud TTS providers:
      • Replicate: includes a built-in catalog and supports any Replicate model ID via Other
      • DeepInfra: Kokoro-82M and other hosted models
      • OpenAI API: tts-1, tts-1-hd, and gpt-4o-mini-tts
  • 🛜 Server-side Document Storage
    • Documents are persisted in server blob/object storage for consistent access
  • 📚 External Library Import
    • Import documents from server-mounted folders
  • 🎧 Server-side Audiobook Export in m4b/mp3 with resumable chapter generation
  • 📖 Read Along Experience
    • Real-time highlighting for PDF/EPUB, with optional word-level whisper.cpp timestamps
  • 🔐 Auth Optional by Design
    • Run no-auth for local use, or enable auth with user isolation and claim flow
  • 🗂️ Flexible Storage and Database Modes with embedded defaults or external S3/Postgres
  • 🚀 Production-ready Server Behavior with TTS caching/retries/rate limits and startup migrations
  • 🎨 Customizable Experience
    • 13 built-in themes (light and dark palettes), TTS, and document handling controls

🧭 Key Docs

Source Repository