Richard R 6d5fb65a72 feat(docs): add configurable rate limiting and external docs

Add environment variables for fine-grained control over TTS rate limiting
and Better Auth behavior. Move documentation to external Docusaurus site
with automated deployment workflows.

- TTS rate limiting can now be enabled/disabled via TTS_ENABLE_RATE_LIMIT
- Customizable daily limits for anonymous/authenticated users and IP backstops
- Better Auth rate limiting can be disabled via DISABLE_AUTH_RATE_LIMIT
- Rename library import env vars to IMPORT_LIBRARY_DIRS/DIR
- Add docs-site with Docusaurus and GitHub Actions workflows
- Update README to reference external documentation

2026-02-10 15:11:37 -07:00

3.3 KiB

Raw Blame History

📄🔊 OpenReader WebUI

OpenReader WebUI 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.

Get started in the docs.

✨ Highlights

🎯 Multi-provider TTS with OpenAI-compatible endpoints (OpenAI, DeepInfra, Kokoro, 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
Develop locally	Local Development
Configure auth	Auth
Configure SQL database	SQL Database
Configure object storage	Object / Blob Storage
Configure TTS providers	TTS Providers
Run Kokoro locally	Kokoro-FastAPI
Get support or contribute	Support and Contributing

🧭 Community

Questions and ideas: GitHub Discussions
Bug reports: GitHub Issues
Contributions: open a pull request

📜 License

MIT. See LICENSE.