diff --git a/README.md b/README.md new file mode 100644 index 0000000..5b372bb --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# Proxmox Backup Manager PRO (Windows GUI) + +A lightweight PowerShell-based Graphical User Interface for the [proxmox-backup-client-go](https://github.com/tizbac/proxmox-backup-client-go) by tizbac. This tool simplifies managing directory and physical drive backups to a Proxmox Backup Server (PBS) from Windows machines. + +## Features + +- **Dual Mode Backup:** Supports both `pbsdirectorybackup.exe` (for folders) and `pbsmachinebackup.exe` (for physical disk images). +- **Automated Scheduling:** Easily register backup jobs in the Windows Task Scheduler to run under the `SYSTEM` account. +- **Auto-Elevation:** Automatically requests Administrator privileges required for VSS snapshots and disk access. +- **Physical Drive Mapping:** Automatically detects and correctly formats physical drive paths (e.g., `\\.\\PhysicalDrive0`) to avoid common CLI syntax errors. +- **Job Management:** Save, edit, and delete multiple backup configurations in a local `backup_jobs.json` file. + +## Prerequisites + +1. Download the latest Windows release of `proxmox-backup-client-go` from [tizbac's repository](https://github.com/tizbac/proxmox-backup-client-go/releases). +2. Extract the executables (`pbsdirectorybackup.exe` and `pbsmachinebackup.exe`) into the same folder as this script. + +## Setup & Usage + +1. Place `proxmoxclient_go_gui.ps1` in the directory containing the PBS executables. +2. Right-click the script and select **Run with PowerShell**. +3. Fill in your PBS details: + - **PBS URL:** `https://:8007` + - **Fingerprint:** Your server's SHA-256 fingerprint. + - **Token ID:** e.g., `root@pam!MH-WS01` + - **Secret:** Your API token secret. +4. Select **Directory** or **Machine** mode and choose your source. +5. Click **Save Job**, then either **Run Backup Now** to test or **Automate in Task Scheduler** for recurring backups. + +## Credits & Disclaimer + +- **Core CLI:** This GUI is a wrapper for the excellent work by [tizbac](https://github.com/tizbac). +- **GUI Development:** This interface was developed and refined with the assistance of **Gemini (Google AI)** to ensure robust error handling and seamless Windows integration. + +--- +*Note: Always ensure you have a valid backup of your data before relying solely on automated systems.* \ No newline at end of file