Installation Guide

Detailed installation instructions for all supported Linux distributions.

Supported operating systems

Quick install

Go to your dashboard, click Add Server, and copy the install command. It includes your token and server ID:

$ curl -sSL https://cdn.helmrelay.com/install.sh | sudo bash -s -- --token YOUR_TOKEN --server-id YOUR_SERVER_ID

This script automatically detects your OS and architecture, then:

1. Downloads the correct agent binary
2. Installs it to /usr/local/bin/helmrelay-agent
3. Creates a systemd service (helmrelay-agent.service)
4. Creates a config directory at /etc/helmrelay/
5. Writes your token and server ID to the config
6. Starts the agent and enables it on boot

Manual installation

If you prefer to install manually:

1. Download the binary

# For x86_64
wget https://cdn.helmrelay.com/agent/lts/helmrelay-agent-linux-amd64 -O /usr/local/bin/helmrelay-agent

# For arm64
wget https://cdn.helmrelay.com/agent/lts/helmrelay-agent-linux-arm64 -O /usr/local/bin/helmrelay-agent

chmod +x /usr/local/bin/helmrelay-agent

2. Create the config file

sudo mkdir -p /etc/helmrelay
sudo cat > /etc/helmrelay/agent.yaml << EOF
server_url: https://api.helmrelay.com
token: YOUR_TOKEN_HERE
server_id: YOUR_SERVER_ID
log_level: info
EOF

3. Create the systemd service

sudo cat > /etc/systemd/system/helmrelay-agent.service << EOF
[Unit]
Description=HelmRelay Agent
After=network-online.target
Wants=network-online.target

[Service]
Type=simple
ExecStart=/usr/local/bin/helmrelay-agent
Restart=always
RestartSec=10
StandardOutput=journal
StandardError=journal
SyslogIdentifier=helmrelay-agent

[Install]
WantedBy=multi-user.target
EOF

4. Start the agent

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

Verify installation

# Check service status
sudo systemctl status helmrelay-agent

# Check agent version
helmrelay-agent --version

# View recent logs
sudo journalctl -u helmrelay-agent -n 50 --no-pager

Firewall requirements

The agent needs outbound HTTPS access. No inbound ports required.

If you're behind a corporate proxy, set the HTTPS_PROXY environment variable in the systemd service file.

Updating the agent

The agent auto-updates by default. To update manually, re-run the install command with your token:

$ curl -sSL https://cdn.helmrelay.com/install.sh | sudo bash -s -- --token YOUR_TOKEN --server-id YOUR_SERVER_ID

Or via the dashboard: Server → Settings → Update Agent.

Next steps

• Dashboard overview
• AI Command Center
• Uninstalling the agent