← All help articles

VPS agent (Go) — install and configuration

The Go agent is a lightweight binary that runs on a VPS you control (root/SSH access) and reports host-level status back to the platform — the checks an outside-in scan can't see.

Quick install

  1. Dashboard → Integrations → VPS agent (Go) to find your license key.
  2. On the VPS, run the install script as root:
curl -fsSL https://app.nodowntimeshield.com/install/agent | sudo bash
  1. The installer provisions a systemd service, stores the license key, and starts checking in within 60 seconds.

What it checks

  • Heartbeat — every 60s: hostname, uptime, disk and memory usage.
  • Probes on demand — HTTP/HTTPS reachability checks the platform can trigger.
  • Disk and process reports — df -h and a bounded process list, requested by the dashboard.
  • Rescan trigger — kick off an immediate stats refresh without waiting for the next tick.

Requirements

  • Linux VPS with systemd (most mainstream distros since 2016).
  • Outbound HTTPS access to app.nodowntimeshield.com.
  • Root or sudo for the initial install only; the service runs unprivileged afterwards.

Shared hosting?

If you don't have SSH/root access, use the PHP agent instead — it installs over plain cPanel/Plesk with no root and no compiled dependencies.