Skip to content

Operator & integrator handbook (JOE-1639)

Quick map of production docs (read this first):

Topic Doc
Install / quickstart Getting started
CLI CLI
Config Configuration
TTS / BYOM TTS
FFI / jobs FFI
Doctor aurum doctor / aurum doctor --json
Threat model Threat model
Hardening Hardening
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 RC exit
External security review brief External review brief
Supply chain Supply chain
Compatibility Compatibility
Migration 0.0.3 Migration
Architecture Architecture
ADRs Kokoro ADR-001
Security reporting SECURITY.md

Diagnose

aurum doctor
aurum cache status
aurum tts adapters

Upgrade

  1. Read CHANGELOG for the target version.
  2. Run migration notes if present.
  3. aurum doctor after install.
  4. 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