Skip to main content

Technical reference

Five sections describe the system. Each has its own page that lists what it contains. The split follows the question you ask, not the order in which things happen.

SectionAnswers
Protocol & dataWhat a message is on the wire, and what it means
Platform & configurationHow a fleet is configured, and who is allowed into it
Gears catalogWhat each gear does and what it accepts
Operations & analyticsRunning the two processes, and reading what they report
Development & QAExtending the platform, and proving it behaves

Technical stack sits outside them: it is what fluxrig builds on, and the licence of each dependency.

Where to start​

Evaluating. Read Data model for what travels. Then read Orchestration scenarios for how you compose a node. The Gears catalog says what you can compose.

Integrating a protocol. ISO8583 SDL describes a dialect. Protocol reference is the document that you render from one, which is what a counterparty reads.

Running it. Operating fluxrig covers both processes. Platform configuration lists every field and its default.

TIP

For the "Studio & Stage" thinking behind the naming, see Design philosophy.