Use this page when you are installing XReplicator packages on VMs or adding agents to a platform that was already created with Quickstart.

Recommended Order (Server First)

1. Choose the platform path.
2. Install and verify the backup server or Kubernetes release.
3. Install backup agents.
4. Point agents at the backup endpoint.
5. Verify agent connectivity and first backup.

Why server first? Agents require a reachable server to register and upload backups.

Choose the Install Path

Available Packages

XReplicator is distributed as pre-built packages:

Install the Backup Server (First)

Use the VM package path for single-server deployments outside Kubernetes. For Kubernetes or container-first installs, use Quickstart and Deployment Models instead.

The backup-server package also includes maintenance and cloud-sync commands.

wget https://github.com/xmigrate/xreplicator/releases/download/RELEASE_TAG/backup-server_VERSION_amd64.deb

sudo dpkg -i backup-server_VERSION_amd64.deb

sudo systemctl enable backup-server
sudo systemctl start backup-server

sudo systemctl status backup-server

Package Contents

• Binary: /usr/local/bin/xreplicator
• Configuration: /etc/xreplicator/server.yaml
• Systemd service: /etc/systemd/system/backup-server.service

Install the Backup Agent (After Server)

Install agents on every protected Linux or Windows machine. Set the agent server_address to the backup endpoint from your VM, Docker Compose, or Helm deployment.

# Download the package
wget https://github.com/xmigrate/xreplicator/releases/download/RELEASE_TAG/backup-agent_VERSION_amd64.deb

# Install the package
sudo dpkg -i backup-agent_VERSION_amd64.deb

# Enable and start the service
sudo systemctl enable backup-agent
sudo systemctl start backup-agent

# Verify service status
sudo systemctl status backup-agent

# Download the package
wget https://github.com/xmigrate/xreplicator/releases/download/RELEASE_TAG/backup-agent-VERSION-1.x86_64.rpm
 
# Install the package
sudo rpm -i backup-agent-VERSION-1.x86_64.rpm
 
# Enable and start the service
sudo systemctl enable backup-agent
sudo systemctl start backup-agent
 
# Verify service status
sudo systemctl status backup-agent

# Download the Windows agent MSI
Invoke-WebRequest -Uri https://github.com/xmigrate/xreplicator/releases/download/RELEASE_TAG/xreplicator-agent-VERSION-windows-amd64.msi -OutFile C:\Temp\xreplicator-agent-VERSION-windows-amd64.msi

# Install (run as Administrator)
Start-Process msiexec -Wait -ArgumentList '/i C:\Temp\xreplicator-agent-VERSION-windows-amd64.msi'

# Edit the installed config
notepad C:\ProgramData\xreplicator\agent.yaml

# Start the service (it is set to auto-start by default)
Start-Service XReplicatorAgent
Get-Service XReplicatorAgent

Package Contents

• Binary: /usr/local/bin/xreplicator
• Configuration: /etc/xreplicator/agent.yaml
• Systemd service: /etc/systemd/system/backup-agent.service

Windows Contents

• Binary: C:\Program Files\XReplicator\backup.exe
• Service wrapper: C:\Program Files\XReplicator\XReplicatorAgent.exe
• Configuration: C:\ProgramData\xreplicator\agent.yaml
• Logs: C:\ProgramData\xreplicator\logs
• Service: XReplicatorAgent

Example Agent Configs

• Linux: /docs/configuration/agent-config-linux
• Windows: /docs/configuration/agent-config-windows

Install the Web UI (Optional)

Docker Compose and Helm installs already include the frontend service. Use the standalone Web UI package only for VM-based deployments where you manage the web process yourself.

# Download the package
wget https://github.com/xmigrate/xreplicator/releases/download/RELEASE_TAG/xreplicator-web-VERSION.tar.gz
 
# Extract the archive
tar xzf xreplicator-web-VERSION.tar.gz
 
# Navigate to the web directory
cd web
 
# Start the web UI
./start.sh

The Web UI will be available at http://localhost:3000

Next Steps

• Configure the backup server: Backup Server Mode
• Configure agents: Daemon Mode
• Verify installation: Verify Installation
• Enable cloud sync if needed: Cloud Sync Mode