Skip to content

Flux Docs

Flux is performance-first Ignition companion tooling for fast local operations views, simulation, tracing, and live-to-sim workflows.

The docs are organized around how Flux is used:

  • Operator Guide: local service, CLI, dashboard, and health workflows.
  • Architecture: system boundaries and ownership.
  • Apps: dashboard, Live, Trace, Serve, Sim, and Opt behavior.
  • Runbooks: repeatable workflows for local operation and recovery.
  • Reference: durable formats such as Spot card context payloads.

Local URLs

Flux web UI:      http://localhost:8000/
Docs server:      http://localhost:8001/
Spot view:        http://localhost:8000/spot/
Chart view:       http://localhost:8000/chart/
Ignition Gateway: http://localhost:8088/web/home
Fluxy bridge:     http://localhost:8088/system/webdev/flux

Local Docs Commands

flux docs serve
flux docs open
flux docs build

Documentation Contract

Docs should preserve Flux architecture. If a page mixes operator workflow, implementation detail, and product intent, split it before it becomes a junk drawer.