ProxDR documentation
From install to orchestrated failover β everything you need to run disaster recovery for Proxmox VE.
New here? Start with Introduction βGetting started
- Introduction
What ProxDR is, and the core concepts β sites, DR Site Pairs, and protected guests.
- Install ProxDR
One-line install on a Linux host, the systemd service it sets up, and the ports it uses.
- First run & sign-in
Set the admin password on first launch and step through the optional onboarding wizard.
- Updating & rollback
Update an existing install to the latest release with one command, pin a version, or roll back.
Setting up your site
- Connect your Proxmox nodes
Add the Proxmox cluster this controller manages, via SSH auto-provisioning or an API token.
- Create a DR Site Pair
Pair your production controller with a recovery-site controller using a pairing code and pinned fingerprint.
- Recovery placement & networking
Choose where recovered VMs run, map production networks to recovery networks, and keep IPs on failover.
Using the web UI
- The web UI at a glance
A tour of the ProxDR console β the navigation, the Overview dashboard, and where each task lives.
- Inventory
Connect and manage the Proxmox clusters this controller sees β nodes, guests, storage, and live utilization.
- Site Pairs
Create, join, and manage the DR Site Pairs that link this site to its recovery sites.
- Replication & recovery operations
Protect guests, set RPO, use recovery points and the ransomware guard, restore from backups, and run failover, DR tests, and planned migration.
- Shadows
See every recovery replica across your sites β active and orphaned β and reclaim storage from replicas that are no longer needed.
- Recovery Plans
Group guests into ordered runbooks with boot order and dependencies, then run failover or a DR test as one orchestrated operation.
- Compliance & reporting
Turn DR tests into exportable evidence, and schedule recurring tests and reports.
- License & trial
Understand the trial, activate a key, manage your pair pool, and how offline validation keeps DR running.
- Users & security
Accounts and roles (RBAC), dual-control approvals, the audit log, and automation hooks.
- Settings
Topology mode, operator defaults, dual-control, web console URL, replication limits, settings sync, controller backup, and experimental features.
CLI reference
- CLI basics
Running the daemon, the global data-dir flag, TLS options, and checking the version.
- CLI tasks & recovery
Quality-of-life commands β reset the admin password, back up and restore the controller, manage licensing, remotes, and pairs from the shell.
Concepts
- How VM replication works in Proxmox
ZFS pvesr, Ceph RBD mirroring, the storage backends Proxmox can't replicate, and how QEMU dirty-bitmap replication fills the gap.
- RPO and RTO for Proxmox
What RPO and RTO mean for Proxmox disaster recovery, how to choose them per workload, and how replication interval and orchestration drive each metric.