Documentation

Built-in plugins

Review the built-in stack plugins and their configuration sections.

Stack plugin IDs are used in vectron.stack.toml through the required enabled array and by vectron stack --only/--skip filters. The accepted IDs below match the current code-level plugin catalog.

Use the vectron.stack.toml reference for exact field defaults and validation rules.

Use the stack examples for complete, copyable plugin combinations.

Foundation

ID	Role	Dependencies	Configuration
`certificates`	Generates local TLS certificates with `mkcert`.	None	No dedicated config section. Added implicitly by `nginx`.
`dnsmasq`	Configures local DNS helpers and `/etc/resolver`.	None	No dedicated config section.
`ssh`	Bootstraps local SSH configuration used by the generated stack.	None	No dedicated config section.

Reverse proxy

ID	Role	Dependencies	Configuration
`nginx`	Provides the HTTPS reverse proxy and landing page.	Adds `certificates` implicitly.	Uses `[nginx]`, `[nginx.landing]`, `[[nginx.server]]`, server links, upstreams, and routes.

Observability

ID	Role	Dependencies	Configuration
`prometheus`	Provides metrics scraping and storage.	None	Optional `[prometheus]` with `scrape_config_files`.
`loki`	Provides log storage.	None	No dedicated config section. Added implicitly by `alloy`.
`alloy`	Provides Grafana Alloy pipelines, imports, raw blocks, and optional Docker log ingestion.	Adds `loki` implicitly.	Optional `[alloy]`, `[[alloy.import_files]]`, `[alloy.docker_logs]`, and relabel rules.
`grafana`	Provides dashboards and datasources.	None	Optional `[grafana]` and `[[grafana.dashboard_dirs]]`.

Datastores

ID	Role	Dependencies	Configuration
`mongodb`	Provides a local MongoDB service.	None	No dedicated config section.
`postgresql`	Provides a local PostgreSQL service.	None	No dedicated config section.
`redis`	Provides a local Redis service.	None	No dedicated config section.
`neo4j`	Provides a local Neo4j service and optional schema provisioning.	None	Optional `[neo4j]` with `schema_files`.
`minio`	Provides S3-compatible local object storage.	None	No dedicated config section.
`qdrant`	Provides a local Qdrant vector database.	None	No dedicated config section.
`influxdb`	Provides a local InfluxDB service.	None	No dedicated config section.

Messaging and IoT

ID	Role	Dependencies	Configuration
`rabbitmq`	Provides RabbitMQ and vhost/queue provisioning.	None	Requires `[rabbitmq]` when enabled; uses `[[rabbitmq.vhost]]`.
`mosquitto`	Provides a local MQTT broker.	None	No dedicated config section.
`zigbee2mqtt`	Provides a local Zigbee2MQTT service.	None	No dedicated config section.

Containers and clusters

ID	Role	Dependencies	Configuration
`docker`	Adds Docker daemon metrics scrape support.	None	No dedicated config section.
`kubernetes`	Provisions a local Kubernetes cluster.	None	Optional `[kubernetes]`; default driver is `k3d`, accepted drivers are `kind`, `k3d`, and `minikube`.

Selection rules

enabled = [...] in vectron.stack.toml must contain at least one plugin ID.
Plugin IDs must be unique and non-empty after trimming.
vectron stack provision/check/landing-ids --only replaces the initial enabled selection with the requested plugin IDs before implicit dependencies are added.
vectron stack provision/check/landing-ids --skip removes requested plugin IDs from the selected set.
nginx adds certificates.
alloy adds loki.

Recommendation

Start with a small enabled = [...] list, validate with vectron stack check, then add plugins incrementally. Use vectron stack landing-ids when configuring nginx.landing.quick_links.

Example starting points:

Reverse proxy and local DNS for nginx and dnsmasq.
Services and queues for RabbitMQ, Redis, MongoDB, MinIO, and Qdrant.
Observability and Docker logs for Prometheus, Loki, Alloy, Grafana, and Docker logs.
Kubernetes local cluster for local cluster settings.