# nomctl

> nomctl is a single static binary for deploying, backing up, monitoring and alerting on Zenon Network (NoM) nodes on Debian/Ubuntu. A Go port of the hypercore-one deployment scripts with a TUI for humans and subcommands for scripts.

Site: https://nomctl.0x3639.com. Every page is also available as Markdown at the same path with a .md suffix, and https://nomctl.0x3639.com/llms-full.txt contains all pages in one file.

## Documentation

- [Alerts overview](https://nomctl.0x3639.com/alerts/overview.md): Telegram alerts for Zenon nodes through a shared relay: how it works, what you get, and privacy.
- [Pairing a node](https://nomctl.0x3639.com/alerts/pairing.md): Pair a node with the nomctl Telegram bot, name it after your pillar, and manage alerts on the node.
- [Running the relay](https://nomctl.0x3639.com/alerts/relay.md): Run your own nomctl-relay on Coolify: bot creation, environment variables, volume, domain, trusted proxies.
- [Alert rules](https://nomctl.0x3639.com/alerts/rules.md): Every alert rule, its threshold, which failure it covers, and how retries and reminders behave.
- [Telegram commands](https://nomctl.0x3639.com/alerts/telegram-commands.md): Bot commands: /start, /nodes, /mute, /unmute, /unpair.
- [Getting started](https://nomctl.0x3639.com/getting-started.md): Install nomctl with one command, deploy a Zenon node, watch it sync, and set up alerts and backups.
- [Analytics stack](https://nomctl.0x3639.com/guide/analytics.md): Install node_exporter, Prometheus and Grafana with the znnd dashboard, and reach Grafana safely.
- [Backups and restore](https://nomctl.0x3639.com/guide/backups.md): Chain-data backups with checksums and retention, a systemd timer for scheduled backups, and restoring from an archive.
- [Deploy](https://nomctl.0x3639.com/guide/deploy.md): How nomctl deploy builds znnd from source, installs Go, writes the go-zenon systemd unit, and how to choose a repository and branch.
- [The interactive menu](https://nomctl.0x3639.com/guide/menu.md): The interactive menu that wraps every nomctl command.
- [Service control and logs](https://nomctl.0x3639.com/guide/service.md): Start, stop, restart, follow logs, resync from genesis, and how nomctl locks node-data operations.
- [Upgrading](https://nomctl.0x3639.com/guide/upgrading.md): Upgrade nomctl in place with nomctl upgrade, roll back, and how status tells you when nomctl or go-zenon has an update.
- [What nomctl is](https://nomctl.0x3639.com/overview.md): What nomctl is, what it does, requirements, and where it puts files on the host.
- [Commands](https://nomctl.0x3639.com/reference/commands.md): Every nomctl subcommand and flag.
- [Configuration](https://nomctl.0x3639.com/reference/configuration.md): Every NOMCTL_* environment variable with its default, and the files nomctl writes.
- [Differences from the bash toolkit](https://nomctl.0x3639.com/reference/differences.md): How nomctl differs from the hypercore-one bash toolkit it replaces.
- [Roadmap](https://nomctl.0x3639.com/roadmap.md): Planned features, hardening follow-ups, and what is deliberately out of scope.
- [First look](https://nomctl.0x3639.com/troubleshooting/first-look.md): How to read nomctl status and nomctl top: service, sync, frontier, pillar, process and host lines.
- [Common signatures](https://nomctl.0x3639.com/troubleshooting/signatures.md): Common failure signatures in the journal and status output, their likely cause, and what to do.
- [Support bundle](https://nomctl.0x3639.com/troubleshooting/support-bundle.md): What nomctl support-bundle collects, what it never collects, and how --watch captures the moments before a restart.

## Source

- [GitHub repository](https://github.com/0x3639/nomctl)
- [Releases](https://github.com/0x3639/nomctl/releases)