6d5fb65a72
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
51 lines
1.5 KiB
Markdown
51 lines
1.5 KiB
Markdown
---
|
|
title: TTS Rate Limiting
|
|
---
|
|
|
|
This page explains OpenReader's TTS character rate limiting controls.
|
|
|
|
## Overview
|
|
|
|
- TTS rate limiting is disabled by default.
|
|
- To enable it, set `TTS_ENABLE_RATE_LIMIT=true`.
|
|
- 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.
|
|
|
|
## Environment variables
|
|
|
|
Enable/disable:
|
|
|
|
- `TTS_ENABLE_RATE_LIMIT` (default: `false`)
|
|
|
|
Per-user daily limits:
|
|
|
|
- `TTS_DAILY_LIMIT_ANONYMOUS` (default: `50000`)
|
|
- `TTS_DAILY_LIMIT_AUTHENTICATED` (default: `500000`)
|
|
|
|
IP backstop daily limits:
|
|
|
|
- `TTS_IP_DAILY_LIMIT_ANONYMOUS` (default: `100000`)
|
|
- `TTS_IP_DAILY_LIMIT_AUTHENTICATED` (default: `1000000`)
|
|
|
|
## Related docs
|
|
|
|
- Full variable list: [Environment Variables](./environment-variables)
|
|
- Auth configuration: [Auth](./configuration)
|
|
- Provider setup: [TTS Providers](./tts-providers)
|