Panels Options

panelModules

List of module names that have registered panels

panels

UI panels for core Stackpanel modules.

Panels are UI components that display information about a module's state, configuration, or managed resources. Unlike extension panels, these belong to built-in modules like Go, Caddy, Healthchecks, etc.

Example: stackpanel.panels.go-status = { module = "go"; title = "Go Environment"; type = "PANEL_TYPE_STATUS"; order = 10; fields = [ { name = "metrics"; type = "FIELD_TYPE_STRING"; value = "..."; } ]; };

Example:

{
  go-status = {
    module = "go";
    title = "Go Environment";
    type = "PANEL_TYPE_STATUS";
    order = 10;
    fields = [
      {
        name = "metrics";
        type = "FIELD_TYPE_STRING";
        value = builtins.toJSON [
          { label = "Go Version"; value = "1.22"; status = "ok"; }
          { label = "Apps"; value = "3"; status = "ok"; }
        ];
      }
    ];
  };
  caddy-status = {
    module = "caddy";
    title = "Reverse Proxy";
    type = "PANEL_TYPE_STATUS";
    order = 20;
    fields = [ ... ];
  };
}

panels.<name>.apps

Per-app data for apps grid panels

panels.<name>.apps.<name>.config

This option has no description.

panels.<name>.apps.<name>.enabled

This option has no description.

panels.<name>.columns

Column definitions for table panels

panels.<name>.columns.*.key

Column key (matches row data)

panels.<name>.columns.*.label

Column header label

panels.<name>.description

Optional description shown below the title

panels.<name>.enabled

Whether this panel is enabled and should be shown

panels.<name>.fields

Panel configuration fields passed to the component

panels.<name>.fields.*.configPath

Nix config path for saving field value (e.g., 'stackpanel.deployment.fly.organization')

panels.<name>.fields.*.description

Help text shown below the field

panels.<name>.fields.*.editPath

Dot-separated path within the app's config for writes. E.g., "go.mainPackage" tells the agent to patch apps..go.mainPackage in the data file.

panels.<name>.fields.*.editable

Whether the field can be modified from the UI

panels.<name>.fields.*.example

Example value shown as help text

panels.<name>.fields.*.label

Human-readable label for the field (defaults to name if null)

panels.<name>.fields.*.name

Field name (maps to component prop)

panels.<name>.fields.*.options

Options for select fields (strings or {value, label} objects)

panels.<name>.fields.*.placeholder

Placeholder text for input fields

panels.<name>.fields.*.type

Field type

panels.<name>.fields.*.value

Field value (JSON-encoded for complex types, null if unset)

panels.<name>.icon

Icon name from lucide-react (e.g., 'server', 'database')

panels.<name>.module

The core module this panel belongs to (e.g., "go", "caddy", "healthchecks"). Used for grouping panels in the UI.

panels.<name>.order

Display order within the module (lower = first)

panels.<name>.readme

Module documentation in markdown format. Rendered in the UI panel to help users understand the module's configuration.

panels.<name>.rows

Row data for table panels

panels.<name>.title

Display title for the panel

panels.<name>.type

Panel type (determines which component to render)

panelsByModule

Panels grouped by their parent module

panelsComputed

Serializable panels for UI consumption

panelsList

List of all panels sorted by order