Install an Agent

简体中文 | English

Enroll and Start

Sign in to the Center and open Nodes. Rotate the automatic-enrollment key if one does not exist, then run the displayed one-line command as root on each supported node.

The installer:

1. selects an Agent from the stable or RC channel;
2. verifies the official manifest, size, and checksums;
3. installs required download dependencies;
4. enrolls the node and obtains a node-specific credential; and
5. starts a systemd or OpenRC service.

The Center does not choose a specific Agent version for the installer. Pass --version VERSION directly to the installer only when deliberately selecting one release. Re-running the install command preserves a still-valid local node identity.

The node credential, local queues, and recovery state are stored under the root-only /var/lib/ipchronicle-agent directory. Turning off automatic enrollment blocks new nodes but does not disconnect enrolled Agents.

Check the Service

# systemd
systemctl status ipchronicle-agent
journalctl -u ipchronicle-agent -f

# OpenRC
rc-service ipchronicle-agent status
tail -f /var/log/ipchronicle-agent.log

A node is online when it has reported within two minutes. Configuration normally converges on the next 30-second poll. An administrator may start a temporary synchronization session for up to ten minutes while making live changes. It uses WebSocket wake-ups but does not replace polling or open an inbound Agent port.

Enrollment does not immediately run a complete probe. The recurring schedule defaults to midnight in the node timezone; the administrator decides when to run the first probe.

Uninstall

Remove the service and binary while preserving node identity and pending data:

curl --proto '=https' --tlsv1.2 -fsSL \
  "https://raw.githubusercontent.com/ipchronicle/ipchronicle/main/scripts/install-agent.sh" |
  sh -s -- --uninstall

Permanently remove /var/lib/ipchronicle-agent as well:

curl --proto '=https' --tlsv1.2 -fsSL \
  "https://raw.githubusercontent.com/ipchronicle/ipchronicle/main/scripts/install-agent.sh" |
  sh -s -- --uninstall --purge

--purge discards the node credential, retained configuration, proxy credentials, update recovery state, task identity, and pending uploads. A later installation enrolls a new node. Neither uninstall mode removes Center-side configuration or history; revoke or delete the old node separately.