Skip to main content

What nomctl is

nomctl is a single static binary for deploying and operating Zenon Network (NoM) nodes on Debian and Ubuntu. It is a Go port of the bash toolkit at hypercore-one/deployment: the same interactive menu and the same non-interactive commands for automation, with no dependency on gum, jq or any other helper.

What it does

AreaCommands
Deploy a node from sourcedeploy
Control the servicestart, stop, restart, logs, resync
Back up and restore chain databackup, restore
Watch the nodestatus, top
Get alerted on Telegramalerts
Collect diagnostics to sharesupport-bundle
Install Prometheus and Grafanaanalytics install
Do all of the above from a menunomctl with no arguments

Requirements

  • Debian or Ubuntu with systemd and apt. The tested target is Ubuntu 24.04.
  • amd64 or arm64.
  • root for every command except --help, --version, env and completion.
  • At least 4 CPU cores and 4 GiB RAM, checked at startup.
  • For the installer: curl, tar and sha256sum, all present on a stock Ubuntu install.

Where things live

PathPurpose
/usr/local/bin/nomctlthe binary
/usr/local/bin/znndthe node binary built by deploy
/opt/nomctlGo toolchain and the go-zenon checkout
/root/.znnnode data directory (NOMCTL_ZNN_DIR)
/backupbackup archives (NOMCTL_BACKUP_DIR)
/etc/nomctl/alerts.jsonalert pairing and thresholds
/var/log/nomctl.logplain-text log of every run
/etc/systemd/system/go-zenon.servicethe node unit

Next: Getting started.