Skip to main content

Install on Linux

Prerequisites​

  • 64-bit Linux (Ubuntu 20.04+, Debian 11+, CentOS/RHEL 8+)
  • sudo or root access
  • Outbound TCP 443 connectivity to the CLM
  1. Go to Agents in the sidebar menu
  2. Click Install Agent
  3. On the Quick Install tab, fill in:
    • Agent Name — unique identifier for this agent, e.g.: linux-prod-01
  4. Click Generate Pairing Code
  5. Copy the generated command and run it on the Linux server with sudo

The script automatically performs:

  • Download of the clm-agent binary
  • Creation of the /opt/clm-agent/config.yaml file
  • Registration of the clm-agent systemd service
  • Automatic start of the service

After a few seconds, the agent will appear with Online status on the Agents screen.

Manual installation (offline environments)​

1. Create the agent in the CLM

Go to Agents → Install Agent → Quick Install, fill in the name and click Generate Pairing Code. Save the generated token — it is shown only once.

2. Download the binary

On the Manual Setup tab, download the Linux amd64 binary and transfer it to the server via SCP or an internal mirror.

3. Prepare the directory

sudo mkdir -p /opt/clm-agent
sudo mv clm-agent-linux-amd64 /opt/clm-agent/clm-agent
sudo chmod +x /opt/clm-agent/clm-agent

4. Create the configuration file

sudo nano /opt/clm-agent/config.yaml

Content:

server:
  url: "wss://SEU-DOMINIO-CLM/api/agent/connect"
  token: "agent_COLE_O_TOKEN_AQUI"

agent:
  name: "nome-do-servidor"
  heartbeat_interval: 30
  reconnect_delay: 5
  max_reconnect_delay: 300

5. Register as a systemd service

sudo nano /etc/systemd/system/clm-agent.service

Content:

[Unit]
Description=CLM On-Premises Agent
After=network.target

[Service]
ExecStart=/opt/clm-agent/clm-agent --config /opt/clm-agent/config.yaml
Restart=always
RestartSec=5
WorkingDirectory=/opt/clm-agent

[Install]
WantedBy=multi-user.target

Enable and start the service:

sudo systemctl daemon-reload
sudo systemctl enable clm-agent
sudo systemctl start clm-agent

Managing the agent​

Check status

sudo systemctl status clm-agent

Start

sudo systemctl start clm-agent

Stop

sudo systemctl stop clm-agent

Restart

sudo systemctl restart clm-agent

View logs in real time

sudo journalctl -u clm-agent -f

Rotate token

Generate a new token on the agent's row in Agents → Rotate Token, update config.yaml, and restart:

sudo nano /opt/clm-agent/config.yaml
sudo systemctl restart clm-agent

Uninstall

sudo systemctl stop clm-agent
sudo systemctl disable clm-agent
sudo rm /etc/systemd/system/clm-agent.service
sudo systemctl daemon-reload
sudo rm -rf /opt/clm-agent
note
Uninstalling the agent from the server does not remove its registration in the CLM. Use the **Delete** action on the agent's row under **Agents** to also remove the record from the platform.