README
¶
ProxSave
Proxmox PBS & PVE System Files Backup
About the Project
ProxSave is a project created by enthusiasts, with the aim of simplifying recovery in critical moments.
Restoring a PVE or PBS server after a disaster (or even just a migration) is always a process that requires skill, time, and patience, ProxSave allows you to save your entire environment and restore it at any time, allowing you to prepare the new installation to accommodate your personal data with as few manual changes as possible.
ProxSave allows you to save and restore, integrating advanced features: automatic backups, multi-path saves, intelligent retention, encryption of backups, integrated Telegram and email notifications (cloud relay or Proxmox Notifications), and compatibility with webhooks, Gotify, and Prometheus.
For more information, take a look at our landing page at proxsave.dev.
Installation
bash -c "$(curl -fsSL https://raw.githubusercontent.com/tis24dev/proxsave/main/install.sh)"
or: if you need a fully clean reinstall use: (preserves env/ and identity/)
bash -c "$(curl -fsSL https://raw.githubusercontent.com/tis24dev/proxsave/main/install.sh)" _ --new-install
You can find the installation script source here.
[!NOTE] Please refer to the docs for more information about the installation.
Guide
You can find the guide files for the various functions here.
Support
Every report or issue is important to us. There are various channels you can use to report a problem.
It is important that you provide as much information as possible with each report. You will often find these details listed. They are important, so please do not forget to include them:
example
===========================================
Version: 0.11.2
Build Signature: 60d0d998f* (2025-12-02T14:46:14+01:00) hash=eeb72ef6b8b6ad89
===========================================
Donations
To stay completely free and open-source, with no feature behind the paywall and evolve the project, we need your help. If you like ProxSave, please consider donating to help us fund the project's future development.
Thank you so much!
Recognitions
Release Testing & Feedback
A special thanks to the community members who help by testing releases and reporting issues. 💙
@NukeThemTillTheyGlow release testing |
@marc6901 release testing |
Repo Activity
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DocAsset ¶
DocAsset represents an embedded documentation file that can be materialized during installation.
func InstallableDocs ¶
func InstallableDocs() []DocAsset
InstallableDocs returns the list of documentation files embedded in the binary that should be written to the installation root.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
proxsave
command
|
|
|
internal
|
|
|
notify
Package notify provides notification services for backup operations.
|
Package notify provides notification services for backup operations. |
|
storage
Package storage provides interfaces and implementations for managing backup storage across primary (local), secondary (remote filesystem), and cloud (rclone) destinations.
|
Package storage provides interfaces and implementations for managing backup storage across primary (local), secondary (remote filesystem), and cloud (rclone) destinations. |
|
types
Package types defines shared application data types.
|
Package types defines shared application data types. |
|
pkg
|
|
|
bech32
Package bech32 is a modified version of the reference implementation of BIP173.
|
Package bech32 is a modified version of the reference implementation of BIP173. |
|
utils
Package utils provides helper functions for working with files, directories and strings that are shared across the proxsave codebase.
|
Package utils provides helper functions for working with files, directories and strings that are shared across the proxsave codebase. |