Update README and CHANGELOG with live progress monitoring documentation
Documentation improvements to showcase the new live backup progress monitoring feature and make it easier for users to understand how to run and monitor backups. README.md Updates: Step 13 - Optional Immediate Backup: - Added example output showing live progress monitoring - Shows the progress box, real-time stats, and completion - Example includes file counts, transfer speeds, and timing - Explains what users will see during backup - Notes ability to exit with Ctrl+C Reconfiguration Section: - Updated to numbered list format for clarity - Added option 4: "Run backup now" with description - Explains what "Run backup now" provides: * Immediate backup testing * Live progress monitoring with real-time statistics * File counts, transfer speeds, compression ratios * Automatic completion detection * Option to exit early (backup continues) Post-Installation → Manual Backup: - Added "Easy way (with live progress)" section - Shows how to use installer option 4 for backups - Lists benefits: live monitoring, auto-completion, clear status - Kept "Direct command" section for advanced users - Makes it clear which method provides better UX CHANGELOG.md Updates: - Documented README changes in "Changed" section - Listed all three sections that were updated - Notes recommendation of easy method via installer Impact: Users now have clear documentation showing: 1. What live progress looks like during backups 2. How to access it (option 4 in main menu) 3. Why it's better than manual systemctl commands 4. What information they'll see in real-time This makes the feature discoverable and encourages users to use the built-in progress monitoring instead of manual log following. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
parent
a828f7eb1f
commit
93debf1e21
2 changed files with 62 additions and 10 deletions
|
|
@ -46,6 +46,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
- Reduced authentication timeout from 30s to 15s
|
||||
- README now includes comprehensive step-by-step walkthrough
|
||||
- Prerequisites section expanded with detailed PBS server setup instructions
|
||||
- README updated with live backup progress examples in Step 13
|
||||
- Reconfiguration section now documents "Run backup now" option (option 4)
|
||||
- Manual Backup section updated to recommend easy method via installer
|
||||
- **Default realm changed from "pbs" to "pam"** (more common for root authentication)
|
||||
- **Default encryption setting changed from "yes" to "no"** (user can opt-in if needed)
|
||||
- Main menu now includes "Run backup now" option for immediate backup testing
|
||||
|
|
|
|||
69
README.md
69
README.md
|
|
@ -255,9 +255,35 @@ The installer creates systemd service and timer:
|
|||
```
|
||||
Do you want to run a backup now? (yes/no) [no]: yes
|
||||
[INFO] Starting immediate backup...
|
||||
|
||||
╔════════════════════════════════════════════════════════════╗
|
||||
║ Backup Progress (Live) ║
|
||||
║ Press Ctrl+C to exit (backup continues in background) ║
|
||||
╚════════════════════════════════════════════════════════════╝
|
||||
|
||||
[2025-11-01 18:30:00] Starting backup for mcware-01
|
||||
[2025-11-01 18:30:00] Backup type: both
|
||||
[2025-11-01 18:30:00] Starting file-level backup (.pxar)...
|
||||
Starting backup: host/mcware-01/2025-11-01T23:30:00Z
|
||||
Client name: mcware-01
|
||||
Starting backup protocol: Sat Nov 1 18:30:00 2025
|
||||
|
||||
Uploaded 123.4 MiB in 5s (24.7 MiB/s)
|
||||
Files: 12,345 | Dirs: 1,234 | Size: 4.5 GiB
|
||||
|
||||
[2025-11-01 18:30:05] File-level backup completed successfully
|
||||
════════════════════════════════════════════════════════════
|
||||
|
||||
[INFO] Backup completed successfully!
|
||||
```
|
||||
|
||||
Choose `yes` to test your backup immediately, or `no` to wait for the scheduled time.
|
||||
Choose `yes` to test your backup immediately with **live progress monitoring**, or `no` to wait for the scheduled time.
|
||||
|
||||
**What you'll see:**
|
||||
- Real-time backup progress with file counts and transfer speeds
|
||||
- PBS client's built-in progress indicators
|
||||
- Automatic completion detection
|
||||
- You can press Ctrl+C to exit (backup continues in background)
|
||||
|
||||
### Step 14: Completion
|
||||
|
||||
|
|
@ -283,23 +309,30 @@ Configuration Summary:
|
|||
If PBS client is already installed, the script will detect this and offer you options:
|
||||
|
||||
**With existing configuration:**
|
||||
- **Reconfigure connection only** - Quick update of PBS server IP/credentials only
|
||||
- **Full reconfiguration** - Redo all settings (paths, schedules, retention, etc.)
|
||||
- **Reinstall PBS client and reconfigure** - Complete reinstall
|
||||
- **Exit without changes**
|
||||
1. **Reconfigure connection only** - Quick update of PBS server IP/credentials only
|
||||
2. **Full reconfiguration** - Redo all settings (paths, schedules, retention, etc.)
|
||||
3. **Reinstall PBS client and reconfigure** - Complete reinstall
|
||||
4. **Run backup now** - Test your backups with live progress monitoring
|
||||
5. **Exit without changes**
|
||||
|
||||
**Without existing configuration:**
|
||||
- **Configure PBS client** - Set up for the first time
|
||||
- **Reinstall and configure** - Fresh installation
|
||||
- **Exit without changes**
|
||||
1. **Configure PBS client** - Set up for the first time
|
||||
2. **Reinstall and configure** - Fresh installation
|
||||
3. **Exit without changes**
|
||||
|
||||
The connection-only reconfiguration is perfect for:
|
||||
**Connection-only reconfiguration is perfect for:**
|
||||
- Switching to a different backup server
|
||||
- Updating expired API tokens
|
||||
- Changing authentication methods
|
||||
- Updating datastore names
|
||||
- All backup settings (paths, schedules, retention policies) are preserved
|
||||
|
||||
All backup settings (paths, schedules, retention policies) are preserved.
|
||||
**Run backup now provides:**
|
||||
- Immediate backup testing without waiting for schedule
|
||||
- Live progress monitoring with real-time statistics
|
||||
- File counts, transfer speeds, and compression ratios
|
||||
- Automatic completion detection
|
||||
- Option to exit early (backup continues in background)
|
||||
|
||||
## Usage Example
|
||||
|
||||
|
|
@ -413,10 +446,26 @@ sudo journalctl -fu pbs-backup.service
|
|||
|
||||
### Manual Backup
|
||||
|
||||
**Easy way (with live progress):**
|
||||
```bash
|
||||
# Run the installer and choose option 4
|
||||
sudo ./pbs-client-installer.sh
|
||||
# Select: 4) Run backup now
|
||||
```
|
||||
|
||||
This provides:
|
||||
- Live progress monitoring with file counts and transfer speeds
|
||||
- Automatic completion detection
|
||||
- Clear success/failure status
|
||||
|
||||
**Direct command (no progress display):**
|
||||
```bash
|
||||
# Run backup immediately
|
||||
sudo systemctl start pbs-backup.service
|
||||
|
||||
# Follow logs manually
|
||||
sudo journalctl -fu pbs-backup.service
|
||||
|
||||
# List all backups
|
||||
sudo -E proxmox-backup-client snapshot list
|
||||
```
|
||||
|
|
|
|||
Loading…
Reference in a new issue