Appendix | XMigrate Docs

Configuration File Locations

Item	Linux	Windows
Agent config	`/etc/xreplicator/agent.yaml`	`C:\ProgramData\xreplicator\agent.yaml`
Server config	`/etc/xreplicator/server.yaml`	—
Cloud config	`<repo>/cloud-config.yaml` or `/etc/xreplicator/cloud-config.yaml`	—
License	`<repo>/license.json` or `/etc/xreplicator/license.json`	—
Logs	systemd journal	`C:\ProgramData\xreplicator\logs`

Service Management (Linux)


# Backup Agent
sudo systemctl start backup-agent
sudo systemctl stop backup-agent
sudo systemctl restart backup-agent
sudo systemctl status backup-agent
 
# Backup Server
sudo systemctl start backup-server
sudo systemctl stop backup-server
sudo systemctl restart backup-server
sudo systemctl status backup-server

All Services at Once


# Start all
sudo systemctl start backup-agent backup-server
 
# Stop all
sudo systemctl stop backup-agent backup-server
 
# Enable all (auto-start on boot)
sudo systemctl enable backup-agent backup-server
 
# Status all
sudo systemctl status backup-agent backup-server

Service Management (Windows)


# Backup Agent service
Start-Service XReplicatorAgent
Stop-Service XReplicatorAgent
Restart-Service XReplicatorAgent
Get-Service XReplicatorAgent

Viewing Logs


# Systemd journal (follow mode)
sudo journalctl -u backup-agent -f
sudo journalctl -u backup-server -f
 
# All backup services
sudo journalctl -u backup-* -f


# WinSW logs
Get-ChildItem "C:\ProgramData\xreplicator\logs"
Get-Content "C:\ProgramData\xreplicator\logs\XReplicatorAgent.out.log" -Tail 200
Get-Content "C:\ProgramData\xreplicator\logs\XReplicatorAgent.err.log" -Tail 200

To enable debug logging, set log_level: "debug" in the relevant config file and restart the service.

Useful Commands


# List all snapshots
xreplicator snapshots --server localhost:50051
 
# Restore a snapshot
xreplicator restore \
  --snapshot <snapshot-id> \
  --target /path/to/restore \
  --server localhost:50051
 
# Run compaction (dry-run)
xreplicator compact --repo /var/lib/backup/repo
 
# Run cloud sync (dry-run)
xreplicator cloud-sync --repo /var/lib/backup/repo
 
# Check version
xreplicator --version
 
# General help
xreplicator --help
xreplicator <command> --help

System Requirements Reference

Component	Requirement
OS	Windows 10/11 and Linux kernel 4.7+ (Ubuntu 20.04+, Debian 10+, RHEL 8+, CentOS 8+). Legacy kernels < 4.7 supported with eBPF disabled (incremental backups fall back to full disk scan, so they are less efficient).
Privileges	Windows: Administrator. Linux: Root or `CAP_BPF` + `CAP_SYS_ADMIN`
CPU	2+ cores recommended
RAM	4 GB minimum, 8 GB recommended
Init system	systemd (Linux), WinSW (Windows MSI)

Package Reference

Package	Format	Description
`backup-agent`	deb + rpm	Backup agent daemon for client machines
`backup-agent` (Windows)	msi	Backup agent daemon for Windows
`backup-server`	deb	Centralized backup server
`xreplicator-web`	tarball	Web UI