Getting started

spane self-hosts on Ubuntu 22.04 / 24.04 LTS via Docker Compose. The installer sets up Docker, pulls the stack, and runs interactive setup.

# review the script first — never pipe to bash blind
curl -fsSL https://raw.githubusercontent.com/travisjohnsonga/netpulse/main/scripts/install.sh \
  | bash

• Setup generates secure secrets, initializes OpenBao, and creates your admin account (password 12+ chars).
• First boot takes 2–3 minutes while services initialize — follow with docker compose logs -f api.
• Access the UI at https://YOUR_SERVER_IP and log in with the admin credentials.

In the UI, go to Settings → Agents → Generate Token, choose the target OS and expiry, then run the one-liner on the server you want to monitor. The agent generates its keypair locally and sends only a CSR.

curl -fsSL https://YOUR_SPANE/agent/install | sudo bash -s -- \
  --server 
https://YOUR_SPANE
 \
  --token 
YOUR_ENROLLMENT_TOKEN

• The agent installs as a hardened, low-privilege systemd service and starts immediately.
• For a self-signed server cert, add -k to curl and --insecure to the agent.
• First metrics arrive within one collection interval (default 30s); the host appears under Servers → All Servers.

Network gear needs no agent. Discover a subnet or add a device by hand, supply SNMP/SSH credentials, and spane begins polling.

# option A — discovery
Settings → Discovery → new job → enter subnet → approve devices

# option B — manual
Devices → + Add Device → enter IP + credential profile

• Configure SNMP v3 (recommended) or v2c and SSH access on the device for full telemetry.
• Point device syslog at the spane IP (UDP 514) to pull logs into central logging.
• Optional: enable gNMI/MDT (port 57400) on supported platforms for streaming telemetry.

Open these on the spane server. Agents are outbound-only and need none.

This guide is intentionally a skeleton — these references expand each area.