Operator & integrator handbook (JOE-1639)¶
Quick map of production docs (read this first):
| Topic | Doc |
|---|---|
| Install / quickstart | Getting started |
| CLI | CLI |
| Config | Configuration |
| Providers / matrix | Providers · Matrix |
| TTS / BYOM | TTS |
| Remote audio formats | Remote audio |
| FFI / jobs | FFI |
| Doctor | aurum doctor / aurum doctor --json |
| Troubleshooting | Troubleshooting |
| Threat model | Threat model |
| Hardening | Hardening |
| Provider qualification | Provider qualification |
| Release gate | Release gate |
| RC freeze inventory | RC freeze |
| RC dogfood | RC dogfood |
| RC rollback | RC rollback |
| Support / security-fix policy | Support policy |
| RC exit report (v0.0.22) | RC exit |
| Product acceptance (v0.0.22) | v0.0.22 acceptance |
| External security review brief | External review brief |
| Post-provider freeze checklist | Post-provider freeze |
| Supply chain | Supply chain |
| Compatibility | Compatibility |
| Architecture | Architecture |
| ADRs | Kokoro ADR-001 · Provider registry ADR-002 |
| Security reporting | SECURITY.md |
Versioning: continuous 0.0.x. Product-outcomes cut is v0.0.22 (not 1.0).
Diagnose¶
Upgrade¶
- Read CHANGELOG for the target version.
aurum doctorafter install.- Verify release checksums when installing binaries.
Recover¶
| Symptom | First checks |
|---|---|
| Model missing | aurum cache status; drop local_only once to download |
| Corrupt cache | aurum cache verify / repair |
| FFmpeg errors | aurum doctor ffmpeg check |
| TTS pack failure | aurum tts verify <pack> |
| FFI busy on shutdown | wait/cancel jobs; aurum_shutdown_ex |