Files
app/docs/interface/index.md
T
Melvin Strobl 4286acadfd Capability report: PUT /devices/{id}/report, a Capabilities section, offline devices degraded
A device reports its board, screen, camera and ports from its own
credential (16 KB, schema 1, replacing the last report), and the flows
are validated against it again. The node panel turns a reported port's
config schema into a form, a reported screen is a canvas preset and a
touch screen's first report turns Touch friendly on. An offline device
node is degraded: amber on the canvas, a warning on Home, never a fault.
2026-10-16 17:37:49 +02:00

99 lines
3.7 KiB
Markdown

# The dashboard app
Open your instance's app address, or select it at [fluksio.com](https://fluksio.com)
after enrollment. For the local Docker setup, use
[app.localhost](http://app.localhost) and the admin login printed by
`make init`. See [Getting started](../getting-started/index.md) for setup.
## Finding your way around
The sidebar opens as a sheet on phones.
| Entry | Use it to |
|---|---|
| **Home** | see the brain graph, health and recent activity |
| **Flows** | create flows and open their editors |
| **Dashboards** | build widget dashboards |
| **Devices** | pair wall screens and choose the dashboards each shows |
| **Runs** | start batch runs and review their results |
| **Workers** | manage machines that execute nodes |
| **Secrets** | store credentials; superusers only |
| **Modules** | see or install packages used by node code |
| **Alerts** | choose where failures are reported |
| **Admin** | manage users and OAuth clients; superusers only |
| **Search** | find items by name |
| **Settings** | change your account, appearance and remote access |
**Assistant** appears when a provider is configured. **Documentation** opens
the docs in another tab.
### Search
Use **Search**, or ⌘K / Ctrl-K, to find flows, nodes, flow inputs and outputs,
dashboards, widgets, devices, secrets, modules, workers and alert channels.
Selecting a result opens its editor or settings.
Search covers the current instance. When connected through a portal,
**All instances** returns to the instance list.
## Home
### The brain graph
The graph combines nodes from published flows. Nodes talking to the same
broker topic, URL or other external target share a neuron; computation nodes
appear individually. Messages connect them, and activity makes them pulse.
A problem keeps the affected neuron's label visible. A
[`wren` node](../reference/node-types.md#wren) also adds a chat button for its
[Control tab](../code/agents.md#control).
### Flows and dashboards
The flow list includes switches to start and stop flows. Dashboard tiles show
a small sketch of each layout; open one for its live readings.
### Health
Health shows flow status, node load errors, queue depth and event-loop lag.
After you have used batch runs, it also shows running and queued runs.
A degraded instance lists the problems that need attention. Warnings, such as
a device that is offline, are listed in amber and leave the status as it is.
### Execution time per node type
One bar per node type at its average time per run, slowest first, on a log
scale. Each row also shows how often the type ran and its slowest single run,
so a slow or busy kind of node stands out.
### Activity
Choose 1h, 6h, 24h or 7d to review executions and failures, recent runs,
dead-lettered work and the audit trail. Hover a chart to filter the lists to
that moment; click to hold the selection while you read.
## Managing flows and dashboards
The lists show titles, unpublished changes and status. Use **New flow** or
**New dashboard** to create one. The Flows list offers **Publish all changes**
when drafts are waiting.
To delete or duplicate several items, hold a card or Ctrl-click it, then
select the rest. The create button becomes a trash button with a duplicate
button beside it. Deletion asks for confirmation; Escape clears the selection.
A duplicate is named after the original with `_copy` and starts as an
unpublished draft, so it runs nothing and no panel shows it until you publish
it.
## Appearance
Light and dark follow your system by default. Change this under
**Settings → Appearance**. Dashboards also have their own theme settings.
## Next stops
- [The flow editor](flow-editor.md)
- [Dashboards and devices](dashboards.md)
- [Secrets, modules and alerts](operations.md)
- [Accounts and the portal](portal.md)