(docs) Add manual restore guidance for snapshots
Document the manual restore workflow in the README and surface snapshot- specific restore commands on the snapshot detail page. The guidance keeps restores intentionally manual for now: inspect the snapshot data directory, run rsync with --dry-run, restore to staging first, and treat hardlinked snapshot files as read-only.
This commit is contained in:
31
README.md
31
README.md
@@ -154,6 +154,37 @@ The UI includes:
|
||||
- `/self-check/` for runtime checks
|
||||
- `/logs/` for filtered pobsync service logs
|
||||
|
||||
## Restoring Data
|
||||
|
||||
pobsync 1.0 treats restores as an explicit manual operation. The control panel shows restore guidance on each snapshot
|
||||
detail page, but it does not run restore commands for you yet. That is deliberate: restores should be inspected and
|
||||
tested before data is copied back into a live system.
|
||||
|
||||
Each snapshot directory contains:
|
||||
|
||||
```
|
||||
<snapshot>/data/ # backed-up filesystem contents
|
||||
<snapshot>/meta/ # metadata and rsync logs
|
||||
```
|
||||
|
||||
Use the `data/` directory as the rsync source. Start with a dry run and restore to a staging path first:
|
||||
|
||||
```
|
||||
rsync -aHAX --numeric-ids --info=progress2 --dry-run /backups/example.org/scheduled/<snapshot>/data/ /restore/example.org/
|
||||
rsync -aHAX --numeric-ids --info=progress2 /backups/example.org/scheduled/<snapshot>/data/ /restore/example.org/
|
||||
```
|
||||
|
||||
After validating the staged files, copy the specific files or directories back to the target machine. For a full-host
|
||||
restore, use another dry run before writing to the remote root:
|
||||
|
||||
```
|
||||
rsync -aHAX --numeric-ids --info=progress2 --dry-run /backups/example.org/scheduled/<snapshot>/data/ root@example.org:/
|
||||
```
|
||||
|
||||
Snapshots may use hardlinks for files that are unchanged between backups. That saves disk space and is safe for normal
|
||||
restore copies, but do not edit files inside snapshot directories. Treat snapshots as read-only and copy data out with
|
||||
rsync.
|
||||
|
||||
## SSH Keys
|
||||
|
||||
SSH keys can be managed from `/ssh-credentials/`. The recommended flow is to generate keys from Django or during the
|
||||
|
||||
Reference in New Issue
Block a user