Skip to content

Installing the Agent

The Arcadium Agent is a lightweight service that runs on your game server machine and manages your game servers. It's required to deploy and control game servers from the dashboard.

Prerequisites

System Requirements

Operating System:

  • Linux (Ubuntu 20.04+, Debian 11+, CentOS 8+, or similar)
  • Windows Server 2019+
  • Windows 10/11 (for development/testing)

Hardware (Minimum):

  • 2 CPU cores
  • 4GB RAM
  • 20GB free disk space
  • Stable internet connection

Hardware (Recommended):

  • 4+ CPU cores
  • 8GB+ RAM
  • 100GB+ SSD storage
  • 100Mbps+ internet connection

Access Requirements

  • Root/Administrator access - The agent needs elevated permissions
  • Ports - Ensure firewall allows game server ports (varies by game)
  • Internet - Connection to arcadiumpanel.com on port 443 (HTTPS/WSS)

TIP

The agent itself only needs outbound connection to Arcadium. Game servers will need their respective ports open.

Installation

Step 1: Register Machine

Before installing the agent, register your machine in Arcadium:

  1. Go to your cluster dashboard
  2. Click Machines in the sidebar
  3. Click Add Machine
  4. Enter a descriptive name (e.g., "Dedicated Server #1")
  5. Click Create

You'll see installation instructions with a unique authentication token.

Step 2: Install Agent

Copy the installation command shown in the dashboard. The token is embedded in the command.

On Linux

bash
curl -fsSL https://arcadiumpanel.com/install/agent.sh | sudo bash -s -- YOUR_TOKEN_HERE

This script will:

  • Detect your system architecture
  • Download the appropriate agent binary
  • Install it to /opt/arcadium/bin/
  • Create a systemd service
  • Start the agent automatically

On Windows

Open PowerShell as Administrator and run:

powershell
iwr https://arcadiumpanel.com/install/agent.ps1 -useb | iex

When prompted, paste your token.

This script will:

  • Download the Windows agent binary
  • Install it to C:\Program Files\Arcadium\
  • Create a Windows service
  • Start the agent automatically

Step 3: Verify Connection

After installation (wait 30 seconds), check your dashboard:

  1. Refresh the Machines page
  2. Your machine should show:
    • Status: Online (green indicator)
    • Last Seen: Just now
    • System Info: OS, CPU, RAM visible

If the machine shows as offline, see Troubleshooting.

Post-Installation

Check Agent Status

Linux (systemd):

bash
sudo systemctl status arcadium-agent

Windows:

powershell
Get-Service arcadium-agent

View Agent Logs

Linux:

bash
sudo journalctl -u arcadium-agent -f

Windows:

powershell
Get-Content "C:\Program Files\Arcadium\logs\agent.log" -Tail 50 -Wait

Agent Configuration

The agent configuration file is located at:

Linux: /etc/arcadium/agent.yaml
Windows: C:\Program Files\Arcadium\config\agent.yaml

yaml
api_url: wss://arcadiumpanel.com/agent/ws
token: your-machine-token
log_level: info
server_path: /opt/arcadium/servers  # Linux
# server_path: C:\Arcadium\Servers  # Windows
backup_path: /opt/arcadium/backups

WARNING

Don't modify the token unless you're regenerating it from the dashboard.

Security Best Practices

Firewall Configuration

Allow Outbound:

  • Port 443 (HTTPS/WSS) to arcadiumpanel.com

Allow Inbound (for game servers):

  • Game-specific ports (ARK: 7777, 27015; Minecraft: 25565; etc.)

Example (Linux - UFW):

bash
# Allow Arcadium connection
sudo ufw allow out 443

# Allow ARK ports (example)
sudo ufw allow 7777/udp
sudo ufw allow 27015/udp
sudo ufw allow 27020/tcp

Dedicated User (Linux)

The agent runs as root by default to manage game servers. For enhanced security:

  1. Create a dedicated user:
bash
sudo useradd -r -s /bin/false arcadium
  1. Grant necessary permissions:
bash
sudo setcap cap_net_bind_service=+ep /opt/arcadium/bin/arcadium-agent
  1. Update the systemd service to run as arcadium user

Token Security

  • Never share your machine token
  • Regenerate tokens if compromised (Dashboard → Machines → Regenerate Token)
  • Use separate machines for production and testing

Auto-Updates

The agent automatically updates itself when new versions are released:

  1. Checks for updates every hour
  2. Downloads new version if available
  3. Verifies checksums
  4. Restarts with new version

Updates are non-disruptive - game servers continue running during agent restarts.

Uninstallation

Linux

bash
# Stop and remove service
sudo systemctl stop arcadium-agent
sudo systemctl disable arcadium-agent
sudo rm /etc/systemd/system/arcadium-agent.service

# Remove files
sudo rm -rf /opt/arcadium
sudo rm /etc/arcadium/agent.yaml

Windows

powershell
# Stop and remove service
Stop-Service arcadium-agent
sc.exe delete arcadium-agent

# Remove files
Remove-Item "C:\Program Files\Arcadium" -Recurse -Force

DANGER

Uninstalling the agent will stop all game servers on that machine. Back up server data first!

Troubleshooting

Machine Shows Offline

Check agent is running:

bash
# Linux
sudo systemctl status arcadium-agent

# Windows
Get-Service arcadium-agent

Check logs for errors:

bash
# Linux
sudo journalctl -u arcadium-agent -n 100

# Windows
Get-Content "C:\Program Files\Arcadium\logs\agent.log" -Tail 100

Common issues:

  • Firewall blocking - Ensure port 443 outbound is allowed
  • Invalid token - Regenerate from dashboard and update config
  • DNS issues - Test: ping arcadiumpanel.com

Connection Errors

Error: "Failed to connect to WebSocket"

  • Check internet connection
  • Verify arcadiumpanel.com is reachable
  • Check firewall/proxy settings

Error: "Authentication failed"

  • Token may be invalid or expired
  • Regenerate token from dashboard
  • Update /etc/arcadium/agent.yaml (Linux) or config file (Windows)

Permission Errors

Error: "Permission denied" when installing games

  • Agent needs root/admin privileges
  • On Linux: run agent with sudo
  • On Windows: ensure service runs as Administrator

Still Having Issues?

  1. Check GitHub Issues
  2. Join our Discord community
  3. Contact support: support@arcadiumpanel.com

Include agent logs and machine specs when requesting help.

Released under the MIT License.