Skip to Content
Getting StartedInstallation

Operating System

  • Linux kernel 4.7+ (recommended for eBPF change tracking)
  • Ubuntu 20.04+ / Debian 10+
  • RHEL 8+ / CentOS 8+ / Fedora
  • Windows 10/11 (Administrator required)

Filesystems

  • NTFS (Windows)
  • ext4 / XFS (Linux)

Privileges

  • Linux: root or CAP_BPF + CAP_SYS_ADMIN
  • Windows: Administrator

Networking

  • Allow TCP 50051 between agents and the backup server

Hardware (baseline)

  • CPU: 2+ cores
  • RAM: 4–8 GB

Dependencies

  • systemd
  • Windows: MSI includes the service wrapper (WinSW); no external dependencies
  1. Install and configure the Backup Server
  2. Start and verify the Backup Server
  3. Install Backup Agent(s)
  4. Point agents at the server address
  5. Verify agent connectivity and first backup

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

Available Packages

XReplicator is distributed as pre-built packages:

PackageDescriptionFormat
backup-agentBackup agent daemon for client machinesdeb, rpm
backup-agent (Windows)Backup agent daemon for Windowsmsi
backup-serverCentralized backup serverdeb
xreplicator-webWeb-based management UItar.gz

Install the Backup Server (First)

The backup-server package also includes the compactor and cloud-sync functionality.

Download the package
wget https://github.com/xmigrate/xreplicator/releases/download/VERSION/backup-server_VERSION_amd64.deb
Install the package
sudo dpkg -i backup-server_VERSION_amd64.deb
Enable and start the service
sudo systemctl enable backup-server
sudo systemctl start backup-server
Verify service status
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)

# Download the package
wget https://github.com/xmigrate/xreplicator/releases/download/VERSION/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

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)

# Download the package
wget https://github.com/xmigrate/xreplicator/releases/download/VERSION/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

  • Verify installation: /docs/getting-started/verify-installation
  • Configure agents: /docs/configuration/daemon-mode
  • Enable cloud sync (optional): /docs/configuration/cloud-sync-mode
Last updated on
QuickstartVerify Installation