Skip to main content

Quickstart

Get the AtherOps Linux Agent running on a host in three steps.

Prerequisites​

  • A Linux host with systemd, curl or wget, tar, and gzip.
  • Root access (the installer needs to write to /usr/local/bin, /etc/atherops, and /etc/systemd/system).
  • An AtherOps account and an active organization. From the UI: Hosts → Add Host generates a one-time install token for you.

1. Generate an install token​

In the AtherOps UI, go to Hosts and click Add Host. You'll get a token that's valid for 24 hours. Copy it.

2. Run the installer​

On the target host:

curl -sSL https://docs.atherops.com/linux-agent/install.sh | sudo INSTALL_TOKEN=<your-token> bash
tip

Pass INSTALL_TOKEN after sudo so sudo propagates it to the script. If you put it before curl, sudo's default policy strips it and the agent will start without credentials.

The installer will:

  1. Detect your architecture (amd64 or arm64).
  2. Download the agent and its bundled collectors into /usr/local/bin.
  3. Write default configuration to /etc/atherops/config.yaml and /etc/atherops/env.
  4. Install and enable the atherops-agent systemd service.

The full installer log lives at /tmp/atherops-install.log if you need to inspect it.

3. Start the agent and verify​

sudo systemctl start atherops-agent
sudo systemctl status atherops-agent

Tail the logs to confirm it's healthy:

sudo journalctl -u atherops-agent -f

Within a minute, the host should appear in the AtherOps UI under Hosts, and metrics will start flowing.

Setting the API key manually​

If you didn't supply INSTALL_TOKEN at install time, the agent won't have credentials yet. Add them by editing the env file:

sudo nano /etc/atherops/env

Set:

ATHEROPS_API_KEY=your-api-key

Then restart the service:

sudo systemctl restart atherops-agent

Uninstalling​

sudo bash /etc/atherops/uninstall.sh

Next steps​