Modules Options

_moduleMetas

Fast module metadata for discovery without full module evaluation. Each key is a module ID, value is the contents of that module's meta.nix. This is set automatically by the module auto-discovery in modules/default.nix.

modules

Stackpanel modules that provide features and UI panels.

Modules are the unified way to extend stackpanel functionality:

Each module can define:

Modules can be:

Example:

{
  postgres = {
    enable = true;
    meta = {
      name = "PostgreSQL";
      description = "PostgreSQL database server";
      icon = "database";
      category = "database";
    };
    source.type = "builtin";
    features = {
      services = true;
      healthchecks = true;
      packages = true;
    };
    healthcheckModule = "postgres";
    panels = [{
      id = "postgres-status";
      title = "PostgreSQL Status";
      type = "PANEL_TYPE_STATUS";
      fields = [{
        name = "metrics";
        type = "FIELD_TYPE_JSON";
        value = "[{\"label\":\"Status\",\"value\":\"Running\",\"status\":\"ok\"}]";
      }];
    }];
  };

  my-custom-module = {
    enable = true;
    meta = {
      name = "My Custom Module";
      description = "Does something useful";
      category = "development";
    };
    source = {
      type = "flake-input";
      flakeInput = "my-module";
    };
  };
}

modules.<name>.apps

Per-app module data (app name -> module data)

modules.<name>.apps.<name>.config

Module config for this app (string key-value pairs)

modules.<name>.apps.<name>.enabled

Whether module is enabled for this app

modules.<name>.configSchema

JSON Schema string for generating configuration forms in the UI. The schema should describe the module's configurable options.

Example:

''
  {
    "type": "object",
    "properties": {
      "port": { "type": "integer", "default": 5432 },
      "version": { "type": "string", "enum": ["15", "16"], "default": "16" }
    }
  }
''

modules.<name>.conflicts

Other modules that conflict with this module

modules.<name>.enable

Whether to enable the ‹name› module.

Example:

true

modules.<name>.features

Which stackpanel features this module uses

modules.<name>.features.appModule

Module extends per-app configuration via appModules

modules.<name>.features.files

Module generates files via stackpanel.files

modules.<name>.features.healthchecks

Module defines health checks

modules.<name>.features.packages

Module adds devshell packages

modules.<name>.features.scripts

Module provides shell scripts/commands

modules.<name>.features.secrets

Module manages secrets/variables

modules.<name>.features.services

Module configures background services/processes

modules.<name>.features.tasks

Module defines turborepo tasks

modules.<name>.flakeInputs

Flake inputs required by this module. Used for auto-installation from the registry.

modules.<name>.flakeInputs.*.followsNixpkgs

Whether to add inputs.nixpkgs.follows = "nixpkgs"

modules.<name>.flakeInputs.*.name

Input name in flake.nix (e.g., "my-module")

modules.<name>.flakeInputs.*.url

Flake URL (e.g., "github:author/my-module")

modules.<name>.healthcheckModule

Name of the healthcheck module that provides health checks for this module. This links to stackpanel.healthchecks.modules..

modules.<name>.meta

Module metadata for display in the UI

Default:

{
  name = "‹name›";
}

modules.<name>.meta.author

Author or maintainer of the module

modules.<name>.meta.category

Category for grouping in the UI

modules.<name>.meta.description

Human-readable description of what the module does

modules.<name>.meta.homepage

URL to module documentation or repository

modules.<name>.meta.icon

Lucide icon name for the module (e.g., 'database', 'box', 'cloud')

modules.<name>.meta.name

Display name of the module

modules.<name>.meta.version

Module version

modules.<name>.panels

UI panels provided by this module

modules.<name>.panels.*.description

Panel description

modules.<name>.panels.*.fields

Panel configuration fields

modules.<name>.panels.*.fields.*.name

Field name (maps to component prop)

modules.<name>.panels.*.fields.*.options

Options for select fields

modules.<name>.panels.*.fields.*.type

Field type

modules.<name>.panels.*.fields.*.value

Field value (JSON-encoded for complex types)

modules.<name>.panels.*.id

Unique panel identifier

modules.<name>.panels.*.order

Display order (lower = first)

modules.<name>.panels.*.title

Display title

modules.<name>.panels.*.type

Panel type (determines which component to render)

modules.<name>.priority

Load order priority (lower = earlier)

modules.<name>.requires

Other modules that must be enabled for this module to work

modules.<name>.source

Module source configuration

modules.<name>.source.flakeInput

Name of the flake input (for flake-input source type)

modules.<name>.source.path

Local path to the module (for local source type)

modules.<name>.source.ref

Git ref (branch, tag, commit) for remote modules

modules.<name>.source.registryId

Registry identifier (for registry source type, e.g., 'stackpanel/docker')

modules.<name>.source.type

Source type for the module

modules.<name>.tags

Tags for categorizing/filtering modules

modulesBuiltin

Builtin modules shipped with stackpanel

modulesComputed

Computed module configurations (only enabled modules, serializable)

modulesComputedAll

Computed module configurations (all modules including disabled, serializable)

modulesExternal

External modules (local, flake-input, or registry)

modulesList

Flat list of enabled modules (for API consumption)

modulesListAll

Flat list of all modules including disabled (for API consumption)