Fluksio/app
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs

Browse Source
This commit is contained in:
stroblme
2026-10-13 10:02:20 +02:00
parent a93f865e91
commit 80e595c02e
24 changed files with 2210 additions and 4310 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/index.md
+21 -41
View File
@@ -1,53 +1,33 @@
# Fluksio
Fluksio is a node-based automation engine. You describe what should happen as a
graph of small pieces of logic, and it keeps that graph running: reacting to
what arrives, or executing once from parameters to a result.
Fluksio is a node-based automation engine for experiments, buildings, and
homelabs. Connect small pieces of logic through typed messages, then let the
engine do the running.
It runs two kinds of graph:
- **Live flows** react to sensors, webhooks, and schedules.
- **Batch runs** take parameters, finish with a result, and keep metrics,
artifacts, and a history you can compare.
- A **live flow** produces values forever. A sensor publishes, a rule fires, a
relay closes, a dashboard on the wall shows what happened. It never ends.
- A **run** produces a value once. Parameters go in, stages execute, and it
finishes, leaving metrics, artifacts and a record to compare against.
Both use the same nodes, the same type checking, the same editor and the same
API.
## What you get
- A **flow engine** that owns your graph, checks the types on every edge, and
keeps running when a node fails.
- A **canvas** that lays flows out for you and an editor for the Python inside
each node, with the running values drawn on the wires while you work.
- **Dashboards** built next to the logic that feeds them, including ones you
can hang on a wall tablet that has no keyboard.
- **Runs**: parameters, metrics, artifacts, sweeps and a queryable history, with
no second server and no project bootstrap per execution.
- **Distributed workers**: a node marked `device: gpu` runs on the machine that
has one, which dials out to the engine rather than needing to be reachable.
- An **HTTP API** covering everything the browser does, plus an MCP endpoint for
agents.
Both use the same nodes, editor, and API. Flows are versioned in git, so your
next bright idea comes with an undo trail.
## Start here
[Getting started](getting-started/index.md) has two paths: one installs a Python
package, the other stands up a server. Everything after that is shared.
[Pick your starting point](getting-started/index.md):
To look before installing, the hosted demo at
[fluksio.com](https://fluksio.com) runs a real instance: a small-house panel, a
media screen, and a lab where a training pipeline runs and its runs are
compared, four screens on one panel.
- [Data science](getting-started/data-science.md): install with pip in your
research environment and run your first experiment.
- [Facility automation](getting-started/facility-automation.md): start the
Docker stack and build your first live flow in the browser.
## Where things are
## Explore
| If you want to… | Read |
| To… | Read |
|---|---|
| Understand what a flow, a node and a message are | [Concepts](concepts/flows.md) |
| Drive Fluksio from the browser | [The interface](interface/index.md) |
| Drive it from Python, a shell or CI | [Code and the CLI](code/cli.md) |
| Look up a node type or a payload type | [Reference](reference/node-types.md) |
| Understand flows, nodes, and messages | [Concepts](concepts/flows.md) |
| Edit flows and build dashboards | [The interface](interface/index.md) |
| Use Python, the CLI, or the API | [Code and the CLI](code/cli.md) |
| Look up nodes, payloads, and settings | [Reference](reference/node-types.md) |
Fluksio is self-hosted by default. An instance runs offline, keeps its data
on its own disk, and never contacts anything unless you
[connect it to a portal](interface/portal.md) yourself.
Your instance keeps its data on its own disk. Connecting it to a
[portal](interface/portal.md) is optional; local flows and runs work offline.