ac2480bc24
DOCUMENTATION UPDATE: Added detailed step-by-step guide covering the entire installation process from PBS server setup to completion. README.md Changes: Prerequisites Section (Expanded): - How to create API tokens in PBS web interface - How to configure datastore permissions - Common permission error and how to fix it - Information gathering checklist before running installer New: Step-by-Step Walkthrough (14 Steps): 1. Running the installer 2. PBS server configuration (IP, port, datastore) 3. Authentication method selection (why API tokens) 4. Entering API token details 5. Backup type selection (files/block/hybrid) 6. File backup paths configuration 7. Block device selection and auto-detection 8. Backup schedule configuration 9. Retention policy settings 10. Encryption setup and key management 11. 3-step connection test process 12. Systemd service creation 13. Optional immediate backup 14. Completion summary Each step includes: - Example prompts and responses - Explanation of options - Recommendations and best practices - Common device types and their paths - Troubleshooting tips CHANGELOG.md Updates: - Documented new comprehensive walkthrough - Listed PBS server setup documentation - Added permission error troubleshooting to Added section This addresses the most common user questions and provides a complete reference for first-time users. Users can now follow the guide step-by-step to successfully configure PBS backups. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
71 lines
3.4 KiB
Markdown
71 lines
3.4 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
|
|
|
|
### 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
|
|
|
|
### 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
|
|
- 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
|