From 7643aaa53a3f8ee30403a6df7110b84fd1fbc6cb Mon Sep 17 00:00:00 2001 From: Phil Date: Sun, 8 Nov 2026 13:02:31 +0000 Subject: [PATCH] Fixed README --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 84c8002..f4c163e 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# proxmox-backup-watch +# pve-backup-watch Wait for a Proxmox VE backup to finish, then restart the guest. -`proxmox-backup-watch` is a small, dependency-free Go CLI that runs on a Proxmox VE node. You give it one or more VMIDs. It watches the node's task list until the vzdump backup for each guest has finished, then restarts that guest. You don't need to know when the backup job will run or how long it will take. +`pve-backup-watch` is a small, dependency-free Go CLI that runs on a Proxmox VE node. You give it one or more VMIDs. It watches the node's task list until the vzdump backup for each guest has finished, then restarts that guest. You don't need to know when the backup job will run or how long it will take. ## Contents @@ -42,13 +42,13 @@ Build from source and copy the binary to the node: ```bash make -scp proxmox-backup-watch root@your-node:/usr/local/bin/ +scp pve-backup-watch root@your-node:/usr/local/bin/ ``` `make` builds a static `linux/amd64` binary and embeds the version, git commit and build date. If you build on the node itself, or want another architecture, run `go build` directly: ```bash -go build -o proxmox-backup-watch . +go build -ldflags "-X main.version=dev-0.0.1 -X 'main.commit=First Build' -X 'main.date=$(date +%Y-%m-%d\ %H:%M:%S)'" -o .pve-backup-watch . ``` A plain `go build` reports the version as `dev`. @@ -56,7 +56,7 @@ A plain `go build` reports the version as `dev`. ## Usage ``` -proxmox-backup-watch [options] VMID [VMID...] +pve-backup-watch [options] VMID [VMID...] ``` Options can appear before, between or after the VMIDs. With several VMIDs, they are handled one after another in the order given. @@ -101,31 +101,31 @@ Temporary errors from `pvesh` or JSON parsing don't abort the wait. A warning is Preview what would happen for VM 123: ```bash -proxmox-backup-watch -n 123 +pve-backup-watch -n 123 ``` Restart VM 123 as soon as its backup finishes, whatever the result: ```bash -proxmox-backup-watch 123 +pve-backup-watch 123 ``` Restart only if the backup failed, treating warnings as success: ```bash -proxmox-backup-watch -f -w 123 +pve-backup-watch -f -w 123 ``` Watch several guests, checking every 15 seconds and giving up after 2 hours each: ```bash -proxmox-backup-watch -i 15s -t 2h 123 124 200 +pve-backup-watch -i 15s -t 2h 123 124 200 ``` Run in the background and keep a log: ```bash -nohup proxmox-backup-watch 123 &> /var/log/proxmox-backup-watch-123.log & +nohup pve-backup-watch 123 &> /var/log/pve-backup-watch-123.log & ``` ## Things to know @@ -142,7 +142,7 @@ nohup proxmox-backup-watch 123 &> /var/log/proxmox-backup-watch-123.log & This project follows [Semantic Versioning](https://semver.org). The current version is in the `VERSION` file and is embedded in the binary at build time. Check it with: ```bash -proxmox-backup-watch -version +pve-backup-watch -version ``` The tool also prints its version at the start of every run, so log files show which version produced them. See `CHANGELOG.md` for the history.