danvics/openreader
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
openreader/docs-site/docs/configure/tts-provider-guides/orpheus-fastapi.md
Richard R dae97b2afc docs(admin,config,tts): document admin panel for runtime TTS provider and feature config 
Add a dedicated Admin Panel documentation page detailing management of shared TTS providers and site features via the admin UI. Update all TTS provider guides, environment variable references, and deployment docs to clarify the new runtime configuration model: environment variables serve as first-boot seeds only, with ongoing management handled through the admin interface. Revise sidebars and cross-links to include the new admin panel docs and clarify the distinction between legacy env-based and admin-managed configuration.
2026-05-12 22:39:37 -06:00

1.4 KiB
Raw Blame History

title
Orpheus-FastAPI

Run Orpheus-FastAPI locally and connect it to OpenReader using the Custom OpenAI-Like provider.

Run Orpheus

Refer to the upstream repository for Docker instructions: Lex-au/Orpheus-FastAPI.

Connect to OpenReader

Recommended (auth + admin): Settings → Admin → Shared providers

  1. Add a shared provider with type custom-openai.
  2. Set base URL to your Orpheus endpoint (e.g. http://orpheus:8000/v1).
  3. Leave API key blank unless required by your deployment.
  4. Set default model to Orpheus (or your backend model id).

Legacy bootstrap seed (optional, first boot only):

API_BASE=http://orpheus:8000/v1

Use the container name if that's how it's named, or host.docker.internal if not.

Or in-app via Settings → TTS Provider:

  1. Set provider to Custom OpenAI-Like.
  2. Set API_BASE to your Orpheus endpoint (e.g. http://orpheus:8000/v1).
  3. Leave API_KEY blank unless your deployment requires one.
  4. Choose model Orpheus (or the model your deployment exposes).

See TTS Providers for admin-shared vs per-user behavior.

References