Skip to content
Open app

Installing an agent

An agent lets CuliPulse check targets only reachable from inside your own network. Setting one up takes two steps: enroll it, then run it.

1. Enroll

Section titled “1. Enroll”
  1. Go to Agents → Add agent.
  2. Give it a name and a label for where it runs (e.g. office-lan, prod-vpc).
  3. Choose its capabilities — which check types it may run (HTTP/TLS, TCP, Ping, UDP).
  4. CuliPulse generates a one-time enrollment token. It’s shown once — the install command on the next screen already has it filled in, so copy that command directly.

2. Run

Section titled “2. Run”

The enroll screen gives you a ready-to-run command for each method, pre-filled with your API URL and token. Copy the one you want — the shapes below are just for reference.

Docker

Section titled “Docker”
Terminal window
docker run -d --restart=unless-stopped --cap-add=NET_RAW \
  -e CULIPULSE_API_URL=https://culipulse.dev \
  -e CULIPULSE_AGENT_TOKEN=<your-token> \
  ghcr.io/culipulse/agent:latest

NET_RAW is needed for ICMP (ping) checks.

Native Linux (systemd)

Section titled “Native Linux (systemd)”

Installs a small static binary as a hardened systemd service — no Docker required. Re-running the same command later updates it in place.

Terminal window
curl -fsSL https://culipulse.dev/install.sh | sudo \
  CULIPULSE_API_URL=https://culipulse.dev \
  CULIPULSE_AGENT_TOKEN=<your-token> sh

Kubernetes

Section titled “Kubernetes”

The enroll screen generates a manifest (a Secret plus a single-replica Deployment, with the NET_RAW capability granted for ping). Apply it:

Terminal window
kubectl apply -f culipulse-agent.yaml

3. Confirm it connected

Section titled “3. Confirm it connected”

After the agent starts, the enroll screen watches for its first check-in and shows connected. The agent now appears in your Agents list and can be picked as a checkpoint on any monitor.