openreader/docs-site/docs/integrations/orpheus-fastapi.md
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

746 B

title
Orpheus-FastAPI

Use Orpheus-FastAPI as an OpenAI-compatible TTS backend for OpenReader.

Upstream project

OpenReader setup

  1. Start your Orpheus-FastAPI server.
  2. In OpenReader settings, choose provider Custom OpenAI-Like and model Orpheus.
  3. Set OpenReader API_BASE to your Orpheus base URL (typically ending with /v1).
  4. Set API_KEY if your Orpheus deployment requires one.
  5. Choose voice.

Notes

  • API_BASE is needed here because Orpheus is configured through the custom provider path.
  • OpenReader expects OpenAI-compatible audio endpoints.
  • For variable details, see Environment Variables.