danvics/openreader
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
openreader/docs-site/docs/configure/tts-rate-limiting.md
Richard R 83aa1152cb docs(config): update environment variable docs for runtime JSON seed and remove legacy RUNTIME_SEED_* usage 
Remove all references to legacy RUNTIME_SEED_* environment variables from documentation and codebase. Update docs and .env.example to document the new RUNTIME_SEED_JSON and RUNTIME_SEED_JSON_PATH variables for first-boot runtime config and provider seeding. Refactor admin seed logic and runtime config schema to eliminate env-var-based seeding in favor of JSON-based initialization. Update admin panel UI and badges to reflect new seed sources. Remove obsolete env parsing logic and tests for RUNTIME_SEED_* flags. Add new tests for JSON seed behavior.

BREAKING CHANGE: RUNTIME_SEED_* environment variables are no longer supported; use RUNTIME_SEED_JSON or RUNTIME_SEED_JSON_PATH for first-boot runtime config and provider seeding.
2026-05-31 00:13:03 -06:00

1.8 KiB
Raw Blame History

title
TTS Rate Limiting

This page explains OpenReader's TTS character rate limiting controls.

Overview

  • TTS rate limiting is disabled by default.
  • Primary control is Settings → Admin → Site features → Disable TTS daily rate limiting.
  • Limits are enforced per day in UTC.
  • Enforcement applies only when auth is enabled.

How enforcement works

When enabled, OpenReader enforces:

  • Per-user daily character limits.
  • IP backstop daily character limits.
  • Anonymous device backstop tracking (cookie-based) to reduce limit resets.

If a request exceeds the active limit, the TTS API returns 429 with reset metadata for the next UTC day.

Required auth behavior

  • Auth must be enabled (BASE_URL + AUTH_SECRET) for TTS char limits to apply.
  • If auth is disabled, TTS character limits are effectively unlimited.
  • DISABLE_AUTH_RATE_LIMIT only affects Better Auth's own request throttling.
  • DISABLE_AUTH_RATE_LIMIT does not disable TTS character limits.

Runtime config

  • disableTtsRateLimit default: true
  • Per-user and IP backstop limit values are configured in Settings → Admin → Site features and stored in DB runtime settings.
  • Optional first-boot seeding can be done via RUNTIME_SEED_JSON / RUNTIME_SEED_JSON_PATH (runtimeConfig.disableTtsRateLimit).

Related docs