Skip to Content
Getting StartedWeb UI

Overview

The Web UI provides a browser-based dashboard for managing backups, snapshots, restores, cloud targets, and Azure-to-Azure DR. It should be run on the same machine or trusted network as the backup server.

Prerequisite: npm must be available on the server.

Installation

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

Starting the Web UI

Simple Start

cd web
./start.sh

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

Using Docker

cd replicator
./start-simple.sh

Configuration

The Web UI connects to the backup server via gRPC. Configure the server address using environment variables:

export BACKUP_GRPC_ADDRESS=localhost:50051
export NEXT_PUBLIC_API_URL=http://localhost:3000/api

If using Docker, edit docker-compose.simple.yml to set these values.

Features

Dashboard

  • System health overview
  • Recent backup activity
  • Storage usage statistics
  • License information

Snapshots

  • View all snapshots by hostname and device
  • Browse snapshot contents
  • Search for specific files
  • Restore files or entire snapshots

Clients

  • View connected backup agents
  • Monitor backup status
  • Trigger ad-hoc backups
  • View backup history

Disaster Recovery

  • Enable DR for source disks
  • Prepare newly mapped DR target disks with wipe/zero or continue without wiping
  • Configure Azure targets
  • Build DR blueprints for OS and data disks
  • Run precheck before failover
  • Trigger Azure failover and review row-level logs
  • Prepare failback, check primary disks, sync back, and review operation history

Cloud Storage (if configured)

  • Monitor cloud sync status
  • View cloud storage usage
  • Configure cloud storage settings

Settings

  • Configure backup schedules
  • Manage retention policies
  • View and update license

DR UI Controls

Use the DR page for Azure-to-Azure recovery workflows:

TabMain controls
SourcesEnable/disable DR, retry backfill, check health, view target disk assignment.
TargetsAdd and edit Azure tenant, subscription, region, resource group, VNet, subnet, and VM size config.
BlueprintsSelect VM disks and choose attach-as-is or snapshot-based disk strategy.
FailoverRun precheck, trigger failover, and follow execution logs.
FailbackPrepare mappings, run primary disk checks, sync back, and complete failback.
HistoryReview previous failover and failback operations.

For the full operator runbook, see Azure-to-Azure DR.

Common Operations

Viewing Snapshots

  1. Go to the Snapshots page.
  2. Select a hostname and device from the dropdowns.
  3. View the snapshot timeline.
  4. Click a snapshot to browse its contents.

Restoring Files

  1. Go to the Snapshots page.
  2. Select the snapshot to restore from.
  3. Browse or search for files.
  4. Click Restore.
  5. Select a restore location.

Triggering a Backup

  1. Go to the Clients page.
  2. Select a client.
  3. Click Trigger Backup.
  4. Monitor progress in real time.

Running an Azure DR Drill

  1. Go to DR > Sources and confirm all selected sources are healthy.
  2. Go to DR > Blueprints and confirm the target config and disk strategies.
  3. Go to DR > Failover and run precheck.
  4. Trigger failover only when blockers are clear.
  5. Validate the recovered Azure VM and application.
  6. Use DR > Failback when the primary side is ready for controlled return.

Production Deployment

For production, place the Web UI behind an nginx reverse proxy with HTTPS:

server {
    listen 443 ssl http2;
    server_name backup.example.com;
 
    ssl_certificate /etc/ssl/certs/backup.crt;
    ssl_certificate_key /etc/ssl/private/backup.key;
 
    location / {
        proxy_pass http://localhost:3000;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
    }
}
Last updated on
Verify InstallationDaemon Mode