Skip to content

Commit 264f3c1

Browse files
committed
docs(README): refine details and update TTS provider information
1 parent cc03724 commit 264f3c1

File tree

1 file changed

+25
-24
lines changed

1 file changed

+25
-24
lines changed

README.md

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -9,26 +9,25 @@
99

1010
# 📄🔊 OpenReader WebUI
1111

12-
OpenReader WebUI is an open source text to speech document reader web app built using Next.js, offering a TTS read along experience with narration for EPUB, PDF, TXT, MD, and DOCX documents. It supports multiple TTS providers including OpenAI, Deepinfra, and custom OpenAI-compatible endpoints like [Kokoro-FastAPI](https://github.com/remsky/Kokoro-FastAPI) and [Orpheus-FastAPI](https://github.com/Lex-au/Orpheus-FastAPI)
13-
14-
- 🧠 **(New) Smart Sentence-Aware Narration**: EPUB and PDF playback use shared NLP (compromise) and smart sentence continuation to merge sentences that span pages/chapters for smoother TTS trying to prevent hard cuts at page breaks
15-
- 🎧 **(New) Reliable Audiobook Export**: Create and export audiobooks from PDF and EPUB files **(in m4b or mp3 format using ffmpeg)** with resumable, chapter/page-based export and per-chapter regeneration
16-
- 🎯 **(New) Multi-Provider TTS Support**:
17-
- **Deepinfra**: Kokoro-82M, Orpheus-3B, Sesame-1B models with extensive voice libraries
18-
- **OpenAI API ($$)**: tts-1, tts-1-hd, gpt-4o-mini-tts models
19-
- **Kokoro-FastAPI**: Self-hosted OpenAI-compatible TTS API server supporting Kokoro-82M and multi-voice combinations (like `af_heart+bf_emma`)
20-
- **Orpheus-FastAPI**: Self-hosted OpenAI-compatible TTS API server supporting Orpheus-3B
21-
- And other Custom OpenAI-compatible endpoints with a `/v1/audio/voices` endpoint
22-
- 🚀 **(New) Optimized TTS Pipeline**: Next.js TTS backend with in-memory LRU audio cache, ETag-aware responses, and in-flight request de-duplication for faster repeat playback
23-
- 💾 **Local-First Architecture**: IndexedDB browser storage for documents and settings (now using Dexie.js)
24-
- 🛜 **Optional Server-side documents**: Manually upload documents to the Next.js backend (and Docker `docstore`) for all users to download
25-
- 📖 **Read Along Experience**: Follow along with real-time highlighted text as the TTS narrates PDF files, using an overlay-based highlighter, per-sentence navigation, and skip controls
26-
- 📄 **Document formats**: EPUB, PDF, TXT, MD, DOCX (with libreoffice installed, plus hardened DOCX→PDF conversion for better reliability)
27-
- 🎨 **Customizable Experience**:
28-
- 🔑 Select TTS provider (OpenAI, Deepinfra, or Custom OpenAI-compatible)
29-
- 🔐 Set TTS API base URL and optional API key
12+
OpenReader WebUI is an open source text to speech document reader web app built using Next.js, offering a TTS read along experience with narration for **EPUB, PDF, TXT, MD, and DOCX documents**. It supports multiple TTS providers including OpenAI, Deepinfra, and custom OpenAI-compatible endpoints like [Kokoro-FastAPI](https://github.com/remsky/Kokoro-FastAPI) and [Orpheus-FastAPI](https://github.com/Lex-au/Orpheus-FastAPI)
13+
14+
- 🧠 *(New)* **Smart Sentence-Aware Narration** merges sentences across pages/chapters for smoother TTS
15+
- 🎧 *(New)* **Reliable Audiobook Export** in **m4b/mp3**, with resumable, chapter-based export and regeneration
16+
- 🎯 *(New)* **Multi-Provider TTS Support**
17+
- [**Kokoro-FastAPI**](https://github.com/remsky/Kokoro-FastAPI): Supporting multi-voice combinations (like `af_heart+af_bella`)
18+
- [**Orpheus-FastAPI**](https://github.com/Lex-au/Orpheus-FastAPI)
19+
- **Custom OpenAI-compatible**: Any TTS API with `/v1/audio/voices` and `/v1/audio/speech` endpoints
20+
- **Cloud TTS Providers (requiring API keys)**
21+
- [**Deepinfra**](https://deepinfra.com/models/text-to-speech): Kokoro-82M + models with support for cloned voices and more
22+
- [**OpenAI API ($$)**](https://platform.openai.com/docs/pricing#transcription-and-speech): tts-1, tts-1-hd, and gpt-4o-mini-tts w/ instructions
23+
- 🚀 *(New)* **Optimized Next.js TTS Proxy** with audio caching and optimized repeat playback
24+
- 💾 *(Updated)* **Local-First Architecture** stores documents and more in-browser with Dexie.js
25+
- 📖 *(Updated)* **Read Along Experience** providing real-time PDF text highlighting during playback
26+
- 🛜 **Optional Server-side documents** using backend `/docstore` for all users
27+
- 🎨 **Customizable Experience**
3028
- 🎨 Multiple app theme options
31-
- And more...
29+
- ⚙️ Various TTS and document handling settings
30+
- And more ...
3231

3332
<details>
3433
<summary>
@@ -121,8 +120,6 @@ docker pull ghcr.io/richardr1126/openreader-webui:latest
121120

122121
You can run the Kokoro TTS API server directly with Docker. **We are not responsible for issues with [Kokoro-FastAPI](https://github.com/remsky/Kokoro-FastAPI).** For best performance, use an NVIDIA GPU (for GPU version) or Apple Silicon (for CPU version).
123122

124-
> **Note:** When using these, set the `API_BASE` env var to `http://host.docker.internal:8880/v1` or `http://kokoro-tts:8880/v1`.
125-
> You can also use the example `docker-compose.yml` in `examples/docker-compose.yml` if you prefer Docker Compose.
126123

127124
<details>
128125
<summary>
@@ -146,6 +143,8 @@ docker run -d \
146143
ghcr.io/remsky/kokoro-fastapi-cpu:v0.2.4
147144
```
148145

146+
> Adjust environment variables as needed for your hardware and use case.
147+
149148
</details>
150149

151150
<details>
@@ -168,12 +167,14 @@ docker run -d \
168167
ghcr.io/remsky/kokoro-fastapi-gpu:v0.2.4
169168
```
170169

170+
> Adjust environment variables as needed for your hardware and use case.
171+
171172
</details>
172173

173-
> **Note:**
174-
> - These commands are for running the Kokoro TTS API server only. For issues or support, see the [Kokoro-FastAPI repository](https://github.com/remsky/Kokoro-FastAPI).
174+
> **⚠️ Important Notes:**
175+
> - For best results, set the `-e API_BASE=` for OpenReader's Docker to `http://kokoro-tts:8880/v1`
176+
> - For issues or support, see the [Kokoro-FastAPI repository](https://github.com/remsky/Kokoro-FastAPI).
175177
> - The GPU version requires NVIDIA Docker support and works best with NVIDIA GPUs. The CPU version works best on Apple Silicon or modern x86 CPUs.
176-
> - Adjust environment variables as needed for your hardware and use case.
177178
178179
## Local Development Installation
179180

0 commit comments

Comments
 (0)