README missing backup restoration instructions #25

Open
opened 2025-11-15 03:44:24 +00:00 by snegov · 0 comments
Owner

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:

## 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 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.
# 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.
Sign in to join this conversation.
No Label
No Milestone
No Assignees
1 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: snegov/cura-te-ipsum#25
No description provided.