danvics/openreader
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: document shared compute timeout env vars across app and worker

Browse source
This commit is contained in:
Richard R 2026-05-21 16:27:03 -06:00
parent e384b66b7d
commit d70c6aa5c6
3 changed files with 31 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
.env.example
View file

@ -84,6 +84,12 @@ COMPUTE_MODE=local
# Required when COMPUTE_MODE=worker
# COMPUTE_WORKER_URL=http://localhost:8081
# COMPUTE_WORKER_TOKEN=local-compute-token
# Optional shared compute timeouts used by:
# - local compute runtime
# - worker compute runtime
# - worker client wait budgets
# COMPUTE_WHISPER_TIMEOUT_MS=30000
# COMPUTE_PDF_TIMEOUT_MS=300000
# Worker mode requires worker-reachable shared object storage.
# Non-exposed embedded weed mini is not supported in worker mode.

3
docs-site/docs/deploy/compute-worker.md
View file

@ -67,6 +67,9 @@ COMPUTE_MODE=worker
# Cloud worker example (Railway):
COMPUTE_WORKER_URL=https://<railway-worker-domain>
COMPUTE_WORKER_TOKEN=<same-token-as-worker>
# Optional shared timeout overrides (keep equal to worker service values):
# COMPUTE_WHISPER_TIMEOUT_MS=30000
# COMPUTE_PDF_TIMEOUT_MS=300000
```
`COMPUTE_MODE=worker` has no local fallback. If worker is unavailable, affected requests fail.

22
docs-site/docs/reference/environment-variables.md
View file

@ -56,6 +56,8 @@ For auth-enabled deployments, use **Settings → Admin** as the primary source o
| `COMPUTE_MODE` | Heavy compute backend | `local` | Select `local` (in-process) or `worker` (external worker service) |
| `COMPUTE_WORKER_URL` | Heavy compute backend | unset | Required when `COMPUTE_MODE=worker`; base URL for external compute worker |
| `COMPUTE_WORKER_TOKEN` | Heavy compute backend | unset | Required bearer token for external compute worker auth |
| `COMPUTE_WHISPER_TIMEOUT_MS` | Heavy compute backend | `30000` | Shared whisper alignment timeout budget (local + worker + worker client wait budget) |
| `COMPUTE_PDF_TIMEOUT_MS` | Heavy compute backend | `300000` | Shared PDF idle-timeout budget (local + worker + worker client wait budget) |
| `PDF_LAYOUT_MODEL_BASE_URL` | PDF layout model | PP-DocLayoutV3 ONNX base URL | Optional base URL override for `ensureModel()` |
| `WHISPER_MODEL_BASE_URL` | Whisper ONNX model | onnx-community defaults | Optional base URL override for ONNX whisper-base_timestamped int8 downloads |
| `FFMPEG_BIN` | Audio runtime | auto-detected (`ffmpeg-static`) | Override ffmpeg binary path |
@ -377,6 +379,26 @@ Bearer token for external compute worker auth.
- Used only when `COMPUTE_MODE=worker`
- Must match worker service `COMPUTE_WORKER_TOKEN`
### COMPUTE_WHISPER_TIMEOUT_MS
Shared whisper alignment timeout budget in milliseconds.
- Default: `30000`
- Used by:
- Local compute whisper runtime (`COMPUTE_MODE=local`)
- Worker compute whisper runtime (`COMPUTE_MODE=worker`)
- App server worker-client wait budget (SSE wait timeout)
### COMPUTE_PDF_TIMEOUT_MS
Shared PDF idle-timeout budget in milliseconds.
- Default: `300000` (5 minutes)
- Used by:
- Local compute PDF runtime (idle timeout)
- Worker compute PDF runtime (idle timeout)
- App server worker-client wait budget (SSE wait timeout)
### PDF_LAYOUT_MODEL_BASE_URL
Optional base URL override for PP-DocLayoutV3 artifacts downloaded by `ensureModel()`.