ProxSave is a backup tool focused on Proxmox VE (PVE) and Proxmox Backup Server (PBS) configuration. It creates compressed archives of your configuration (and optional system inventories), can optionally encrypt the final archive with AGE, and can distribute the result across local/secondary/cloud storage.
What It Backs Up
ProxSave is primarily a configuration backup solution. The collector is configurable: you can enable/disable sources and add custom paths.
PVE (Proxmox VE)
- Cluster configuration (config.db, corosync.conf)
- VM and container configs (.conf files in /etc/pve/)
- Proxmox configuration such as firewall rules, jobs/schedules, ACLs (depending on your enabled toggles)
- Optional metadata about storages and backup datastores (see below)
PBS (Proxmox Backup Server)
- PBS configuration under /etc/proxmox-backup/ (datastores, users/ACLs, jobs/schedules, etc.)
- Optional PXAR metadata reports (see below)
System (common)
- Network configuration (interfaces, DNS)
- SSL certificates (node certs, custom CAs)
- SSH keys (host keys, authorized keys)
- ZFS pool/dataset configuration (when enabled)
- Cron jobs and systemd service units
- Package and hardware inventory (when enabled)
- Script directories (/usr/local/bin, /usr/local/sbin) and optional script repository (when enabled)
- Optional /root and /home/* collection (when enabled)
- Any custom paths you add via
CUSTOM_BACKUP_PATHS
Datastore and backup-file metadata (optional)
ProxSave can collect metadata about backup artifacts without becoming a full VM/CT backup system:
- With
BACKUP_PVE_BACKUP_FILES=true, ProxSave can generate metadata reports about backup files detected in PVE storages (samples, disk usage, and analysis reports). - With
BACKUP_SMALL_PVE_BACKUPS=true, ProxSave can optionally include small backup artifacts in the archive (up toMAX_PVE_BACKUP_SIZE). - With
PXAR_SCAN_ENABLE=true(orBACKUP_PXAR_FILES=true), ProxSave can collect metadata reports about PBS datastore PXAR backups (not the entire datastore contents).
For full VM/CT disk-image backups and retention, use Proxmox’s vzdump and/or PBS as your primary data-protection solution.
Key Features
Cluster-Aware Backups
ProxSave understands Proxmox cluster architecture. It backs up the cluster database (config.db) and can restore it with proper service management to avoid split-brain scenarios.
Encryption at Rest
When enabled, the final archive can be encrypted using AGE. Encryption is streaming (the tool does not keep a plaintext archive alongside the encrypted one).
Multi-Tier Storage
Backups are distributed across up to three tiers:
- Local storage (required)
- Secondary storage like NAS (optional)
- Cloud storage via rclone (optional)
Secondary and cloud storage failures are non-blocking: they do not abort the run, but they may result in a warning exit code and a warning status in notifications.
Flexible Retention
Two retention policies are available:
- Simple: Keep last N backups per tier
- GFS: Grandfather-Father-Son with daily, weekly, monthly, and yearly retention
Interactive Restore
The restore wizard provides:
- Backup selection from any storage tier
- Automatic decryption if encrypted
- Four restore modes (Full, Storage, Base, Custom)
- Safety backup creation before overwriting files
- Category-based selective restore
Notifications
ProxSave can notify backup outcomes via Telegram, Email, Gotify, and Webhooks (multiple channels can be enabled simultaneously).
What It Does Not Do
- Does not aim to replace full VM/CT disk-image backups (it can optionally include small backup artifacts when explicitly enabled)
- Does not replace vzdump or PBS for data protection
- Does not manage Proxmox services (only stops/starts during restore)
- Does not modify your Proxmox configuration during normal operation (it writes its own artifacts under
BASE_DIRand uses a temporary workspace under /tmp/proxsave)