93debf1e21
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>
90 lines
4.7 KiB
Markdown
90 lines
4.7 KiB
Markdown
# Changelog
|
|
|
|
All notable changes to this project will be documented in this file.
|
|
|
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
|
|
## [Unreleased]
|
|
|
|
### Added
|
|
- Intelligent reconfiguration options when PBS client is already installed
|
|
- Quick connection-only reconfiguration (server/credentials only)
|
|
- Full reconfiguration of all settings
|
|
- Reinstall option with reconfiguration
|
|
- Exit without changes option
|
|
- 3-step connection verification process:
|
|
- Step 1: Server reachability test (5s timeout with curl)
|
|
- Step 2: Authentication test with automatic SSL fingerprint acceptance
|
|
- Step 3: Datastore access verification
|
|
- Display available block devices when invalid device is entered
|
|
- Step-by-step progress indicators during connection testing
|
|
- `test-connection.sh` - Diagnostic script for testing PBS connections manually
|
|
- Parameterized for security (no hardcoded credentials)
|
|
- Tests server reachability, authentication, and datastore access
|
|
- Handles SSL fingerprint acceptance interactively
|
|
- Comprehensive documentation in README:
|
|
- Step-by-step walkthrough of complete installation (14 steps)
|
|
- PBS server setup guide (API token creation and permissions)
|
|
- Common permission error troubleshooting
|
|
- Explanation of backup types, schedules, and retention policies
|
|
- **Live backup progress monitoring**
|
|
- Real-time log following when running backups
|
|
- Automatic completion detection
|
|
- Shows PBS client's built-in progress bars and statistics
|
|
- Can exit with Ctrl+C (backup continues in background)
|
|
- Applied to both "Run backup now" menu option and post-install backup
|
|
|
|
### Changed
|
|
- Installation instructions now use `git clone` instead of `wget`
|
|
- Connection test provides better user feedback during testing
|
|
- Script now detects existing configurations and offers appropriate options
|
|
- Block device detection now strips btrfs subvolume notation (e.g., `[/@]`)
|
|
- Connection test succeeds if authentication works, even if no backups exist yet
|
|
- More specific error messages based on which step of connection test fails
|
|
- SSL certificate fingerprints are now automatically accepted during setup
|
|
- 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
|
|
|
|
### Fixed
|
|
- **CRITICAL**: SSL fingerprint prompt no longer causes authentication timeout
|
|
- Script now automatically accepts SSL fingerprints by piping 'y' to login
|
|
- This was the root cause of "authentication hanging" issues
|
|
- **CRITICAL**: Password/token capture no longer includes newline character
|
|
- `prompt_password()` function now outputs formatting to stderr
|
|
- Added defensive newline stripping when writing config file
|
|
- Filters `\n` and `\r` characters from passwords using `tr -d '\n\r'`
|
|
- Fixes "authentication failed - invalid credentials" in backup service
|
|
- Config file now has properly formatted single-line passwords
|
|
- Applied to both `reconfigure_connection()` and `create_systemd_service()`
|
|
- Script no longer hangs indefinitely when PBS server is unreachable
|
|
- Block device auto-detection now correctly handles btrfs subvolumes
|
|
- Invalid device paths like `/dev/mapper/root[/@]` are now properly cleaned
|
|
- Connection test now differentiates between network issues and authentication failures
|
|
- Shows actual PBS client error messages when authentication fails
|
|
- Authentication test now uses correct `login` command instead of non-existent `status` command
|
|
- Connection test no longer times out due to using wrong PBS client commands
|
|
|
|
## [1.0.0] - 2025-11-01
|
|
|
|
### Added
|
|
- Initial release
|
|
- Auto-detection of Linux distribution (Ubuntu, Debian, Arch)
|
|
- Interactive configuration via console prompts
|
|
- Automatic encryption key generation with paper backup
|
|
- Systemd service and timer for automated backups
|
|
- Configurable retention policies
|
|
- Connection testing before finalization
|
|
- Immediate backup option after installation
|
|
- Support for file-level (.pxar) backups
|
|
- Support for block device (.img) backups
|
|
- Hybrid backup mode (daily files + weekly block device)
|
|
- Comprehensive error handling and logging
|
|
- Uninstaller script
|