Priority: Medium Component: README.md Type: Documentation
Description
The README explains how to create backups but doesn't explain how to restore from them, which is arguably the most important part of a backup solution.
Current State
The README covers:
Installation
Creating backups
Command-line options
How hardlinks work
Backup structure
Missing:
How to restore files
How to verify backup integrity
How to access old versions of files
Emergency recovery procedures
Proposed Addition
Add a "Restoring from Backup" section:
## Restoring from Backup
### Restoring Individual Files
Since each backup is a complete directory tree, you can simply copy files directly:
```bash
# Find the backup you want
ls /path/to/backups/
# Copy files from that backup
cp /path/to/backups/2025-01-15_10-30-00/documents/important.txt ~/documents/
Restoring an Entire Directory
# Restore entire directory from specific backup
rsync -av /path/to/backups/2025-01-15_10-30-00/documents/ ~/documents/
Viewing Changed Files
Each backup contains a .backup_delta directory showing what changed:
# See what changed in a specific backup
ls /path/to/backups/2025-01-15_10-30-00/.backup_delta/
Emergency Recovery
If you need to restore everything after a disaster:
# Restore from most recent backupLATEST=$(ls -1 /path/to/backups/ | tail -n 1)
rsync -av /path/to/backups/$LATEST/ /restore/location/
## Impact
**Medium** - Critical information for users, especially during emergencies.
# README missing backup restoration instructions
**Priority:** Medium
**Component:** README.md
**Type:** Documentation
## Description
The README explains how to create backups but doesn't explain how to restore from them, which is arguably the most important part of a backup solution.
## Current State
The README covers:
- Installation
- Creating backups
- Command-line options
- How hardlinks work
- Backup structure
Missing:
- How to restore files
- How to verify backup integrity
- How to access old versions of files
- Emergency recovery procedures
## Proposed Addition
Add a "Restoring from Backup" section:
```markdown
## Restoring from Backup
### Restoring Individual Files
Since each backup is a complete directory tree, you can simply copy files directly:
```bash
# Find the backup you want
ls /path/to/backups/
# Copy files from that backup
cp /path/to/backups/2025-01-15_10-30-00/documents/important.txt ~/documents/
```
### Restoring an Entire Directory
```bash
# Restore entire directory from specific backup
rsync -av /path/to/backups/2025-01-15_10-30-00/documents/ ~/documents/
```
### Viewing Changed Files
Each backup contains a `.backup_delta` directory showing what changed:
```bash
# See what changed in a specific backup
ls /path/to/backups/2025-01-15_10-30-00/.backup_delta/
```
### Emergency Recovery
If you need to restore everything after a disaster:
```bash
# Restore from most recent backup
LATEST=$(ls -1 /path/to/backups/ | tail -n 1)
rsync -av /path/to/backups/$LATEST/ /restore/location/
```
```
## Impact
**Medium** - Critical information for users, especially during emergencies.
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
README missing backup restoration instructions
Priority: Medium
Component: README.md
Type: Documentation
Description
The README explains how to create backups but doesn't explain how to restore from them, which is arguably the most important part of a backup solution.
Current State
The README covers:
Missing:
Proposed Addition
Add a "Restoring from Backup" section:
Restoring an Entire Directory
Viewing Changed Files
Each backup contains a
.backup_deltadirectory showing what changed:Emergency Recovery
If you need to restore everything after a disaster: