Documentation

Sign In

Installation

Complete guide to installing and configuring the Compute Share agent on your machines.

System Requirements

Supported Operating Systems

  • Linux: Ubuntu 20.04+, Debian 11+, CentOS 8+, RHEL 8+
  • macOS: 11.0 (Big Sur) or later
  • Windows: Windows 10/11, Windows Server 2019+

Hardware Requirements

Minimum recommended specifications:

  • CPU: 2 cores
  • RAM: 4 GB
  • Disk: 20 GB free space
  • Network: Stable internet connection

Installing the Agent

Linux & macOS

Install using our automated script:

curl -fsSL https://install.compute-share.io | sh

Or install manually:

# Download the binary
wget https://releases.compute-share.io/latest/compute-share-linux-amd64

# Make it executable
chmod +x compute-share-linux-amd64

# Move to system path
sudo mv compute-share-linux-amd64 /usr/local/bin/compute-share

Windows

Download and run the installer:

# Using PowerShell
Invoke-WebRequest -Uri https://releases.compute-share.io/latest/compute-share-windows-amd64.exe -OutFile compute-share.exe

# Or download from the releases page and run the installer

Configuration

Register Your Machine

After installation, register your machine with your organization:

compute-share register --name "my-machine" --token YOUR_ORG_TOKEN

The registration token can be obtained from your organization administrator or the dashboard settings.

Configure the Agent

Edit the configuration file:

# Linux/macOS
nano ~/.compute-share/config.yaml

# Windows
notepad %USERPROFILE%\.compute-share\config.yaml

Example configuration:

machine:
  name: my-machine
  max_concurrent_jobs: 4

organization:
  token: YOUR_ORG_TOKEN

resources:
  cpu_limit: 80  # Percentage
  memory_limit: 16384  # MB

network:
  heartbeat_interval: 30  # seconds

Running the Agent

Start the Agent

# Start in foreground
compute-share start

# Start as daemon (Linux/macOS)
compute-share start --daemon

# Start as Windows service
compute-share install-service
net start ComputeShare

Verify Installation

Check that your machine appears in the dashboard:

  1. Navigate to Machines
  2. Verify your machine shows as "Available"
  3. Check the last heartbeat timestamp

Troubleshooting

Agent Won't Start

Check logs for errors:

# Linux/macOS
tail -f ~/.compute-share/logs/agent.log

# Windows
Get-Content -Path "$env:USERPROFILE\.compute-share\logs\agent.log" -Tail 50 -Wait

Connection Issues

Ensure firewall rules allow outbound HTTPS:

  • Port 443 for API communication
  • WebSocket connection to wss://api.compute-share.io

Registration Fails

Common issues:

  • Invalid token: Verify your organization token
  • Machine name conflict: Choose a unique name
  • Network restrictions: Check proxy settings

Updating

Update the Agent

# Linux/macOS
compute-share update

# Or reinstall
curl -fsSL https://install.compute-share.io | sh

# Windows
# Download and run the latest installer

Uninstalling

Remove the Agent

# Linux/macOS
compute-share stop
sudo rm /usr/local/bin/compute-share
rm -rf ~/.compute-share

# Windows
net stop ComputeShare
compute-share uninstall-service
# Then uninstall via Control Panel

Don't forget to remove the machine from your organization in the dashboard!