Operator and integrator documentation beyond the top-level docs/ guides.
Standalone static site — not served by the playout server. Open in any browser:
docs/wiki-site/index.html
From the repo root:
npm run wiki:build # after editing markdown under docs/
npm run wiki:open # Linux/macOS shortcut
Or double-click docs/wiki-site/index.html. All page content is embedded in assets/wiki-bundle.js at build time (works with file:// — no server required).
| Page | Contents |
|---|---|
| install/calamares-install-to-disk.md | Calamares — disable CSM, launch, pick disk, Erase vs manual bios_grub + / |
| ../CALAMARES_INSTALL_TO_DISK.md | Full install guide (partition tables, rsync 11, session.log) |
| Page | Contents |
|---|---|
| api/README.md | Base URL, auth, Caspar gate, response format, WebSocket |
| api/openapi.yaml | OpenAPI 3.1 (core routes fully specified) |
| api/scene-take.md | POST /api/scene/take — request/response schemas, PGM/PRV, examples |
| api/playback.md | Playback — play/load/loadbg, transport, swap/call, playbackMatrix |
| api/playback-and-amcp.md | AMCP batch/raw, print, restart, server control |
| api/mixer.md | Mixer — opacity/fill/crop, defer/commit, effects |
| api/mixer-cg-scene.md | FTB, LED test card, PiP |
| api/cg.md | CG — /api/cg/{command} |
| api/project.md | Project — save/load/bundle/sync, USB/bridge volume catalog |
| api/state-and-media.md | State, variables, media, thumbnails |
| api/project-state-media.md | Index → project + state pages |
| api/timelines.md | Timelines — CRUD, play/seek/take, sendTo |
| api/timelines-multiview.md | Multiview, NDI |
| api/streaming-audio-osc.md | WebRTC streams, RTMP/record, audio routing, OSC |
| api/system-settings-hardware.md | Settings, GPU, Caspar config, logs, exFAT sync, device view |
| api/network-tailscale.md | Tailscale — status, login, operator-monitor UI |
| api/ingest-usb-plugins.md | Ingest, USB import, plugins, optional modules |
| Page | Contents |
|---|---|
| guides/shader-fx.md | Shader FX — audio-reactive Shadertoy-style shader templates: create, put on air, edit, limits |
| Page | Contents |
|---|---|
| integration/usb-v4l2-input.md | USB / V4L2 — ATEM, webcams, FFmpeg bridge, operator setup |
Legacy single-file overview (partial): ../api-reference.md — prefer the wiki for completeness.