Files
app/docs/interface/index.md
T
stroblme 29f4d93c2a Search: node settings are indexed, with credentials masked on the server
/search gains a `setting` category, `<node>.<setting>` under its flow with the
node type and the value in a new `detail` field, so Ctrl-K finds which node
uses a broker or a timeout and opens the node. `setting_text` is the one place
that decides what may be said: a reference to a stored secret shows its name
(to superusers only, as the secrets list does), a plain value in an `x-secret`
field or under a key like password, token or api_key is masked and never
indexed, nested credentials in headers or query are masked, long values are
clipped. The global search ranks what contains the query as typed ahead of
loose spellings before it caps a group, which long setting values would
otherwise have crowded out.
2026-10-28 11:07:27 +01:00

4.3 KiB

The dashboard app

Open your instance's app address, or select it at fluksio.com after enrollment. For the single-container setup, open localhost:8080 and use the admin login printed by docker compose logs fluksio. See Getting started 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. On a phone the header carries one chat button instead: on Home it opens the Control tab, on any other page the assistant.

Use Search, or ⌘K / Ctrl-K, to find flows, nodes, node settings, flow inputs and outputs, dashboards, widgets, devices, secrets, modules, workers and alert channels. Selecting a result opens its editor or settings.

A setting is listed as node.setting with its value beside it, so you can look up which node uses a broker, a topic or a timeout. A credential is never shown. A setting that points at a stored secret shows only the secret's name, and only to superusers. A plain value in a credential field, or under a key such as password, token or api_key, shows as •••• and cannot be searched for.

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 or assistant node also adds a chat button for its Control tab.

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