danvics/openreader
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
openreader/docs-site/docs/introduction.md
Richard R 9da9232d39 feat: add support for Replicate TTS provider and models 
- Updated environment variables documentation to include Replicate as a TTS provider option.
- Added Replicate to the sidebar for TTS provider guides.
- Included Replicate as a dependency in package.json and pnpm-lock.yaml.
- Enhanced audiobook chapter generation to normalize native speed settings based on the TTS provider.
- Improved error handling in TTS API routes to provide retry information for rate-limited responses.
- Updated AudiobookExportModal to reflect native speed support for Replicate models.
- Modified SettingsModal to set default model for Replicate.
- Enhanced SpeedControl component to conditionally render native speed controls based on provider support.
- Updated TTSContext to utilize effective native speed for TTS requests.
- Implemented Replicate request handling in the TTS generation logic.
- Added new documentation for configuring Replicate as a TTS provider.
2026-04-16 11:20:38 -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: google/gemini-3.1-flash-tts, minimax/speech-2.8-turbo, qwen/qwen3-tts, and inworld/tts-1.5-mini
      • 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