Reference

Lookup material — configuration keys, the HTTP API, MCP tools, notification variables, write protocols and built-in metrics. Generated from the source tree wherever possible.

Configuration reference

Every key in config.toml and etc/edge/edge.toml, with defaults and which process reads it.

Environment variables

The environment variables Nightingale reads, and why config keys cannot be overridden that way.

CLI reference

The command line is thin: every process takes three flags, configuration lives in the toml files under etc/, and there are no subcommands for managing rules.

HTTP API

The API the UI runs on: authentication, endpoints by object, and why there is no OpenAPI document.

MCP tool reference

All 74 tools across 13 toolsets with parameters, and which are read versus write.

Permission matrix

Every permission point, which built-in roles hold it, and the menu or API it guards.

Notification variables

The event fields and helper functions available inside a message template.

Data write protocols

Prometheus Remote Write, OpenTSDB, Datadog and Falcon: endpoints, payloads and label handling.

Integration schema

The file layout of an integration template, so you can write and contribute one.

Built-in metrics

What each Nightingale process exposes about itself on /metrics.

Ports and network flows

Every listening port and every outbound connection, so a firewall rule set can be written from one table.

Limits and defaults

Hard limits, soft limits and default sizes: queue lengths, timeouts, retention.

Compatibility matrix

What is known to work with which versions, and why there is no official support matrix here.