From 5644f009f71642cf5f619a1e97241d641b22fcc8 Mon Sep 17 00:00:00 2001
From: Ralf Zerres
Date: Sat, 18 Jan 2020 19:10:47 +0100
Subject: [PATCH] dsnap-sync: update documentation to comply with v0.6.5
* english README.md
* german README.md
Signed-off-by: Ralf Zerres
---
README.md | 50 ++++++++++++++++++++++++++--------
lang/german/README.md | 63 +++++++++++++++++++++++++++++++++++++++++--
2 files changed, 100 insertions(+), 13 deletions(-)
diff --git a/README.md b/README.md
index dafddc8..a1eb32a 100644
--- a/README.md
+++ b/README.md
@@ -306,6 +306,34 @@ An open-source implementation can be found at
## Restore
+### From Snapshot
+
+When `dsnap-sync` did save the data using a native btrfs method
+(`btrfs-snapshot` or `btrfs-clone`), data will be stored in a snapper compatible
+directory structure on the target.
+
+The structure may look like:
+
+* └ backups
+ * └ @\
+ * └ \
+ * └ \
+ * ├ \.snapshot\>
+ * └ info.xml
+
+To restore the data, you may either use `snapper` methods or copy back
+the needed files using standard OS tools.
+
+ * using snapper
+ You may use `snapper diff .. [files]` to compare the differences
+ between the given suvol-id's.
+ You may use `snapper rollback ` to restore all data from the given \
+
+ * using OS tools
+ Use your favorit file-manager and change into the directory storing your
+ target backup subvol-id. The snapshots are stored in **read-only** mode.
+ Data are presented flat file and can be copied to any desired destination.
+
### From Tape
When `dsnap-sync` did save the data with method `btrfs-archive`, you will find
@@ -313,22 +341,22 @@ the corresponding data in a snapper compatible directory structure on the tape.
The structure may look like:
-> └── backups
-> └── @
-> └── archive-
-> └──
-> ├── _full.btrfs
-> └── info.xml
+ * └ backups
+ * └ @\
+ * └ archive-\
+ * └ \
+ * ├ \_full.btrfs
+ * └ info.xml
-The file `info.xml` provide the metadata corresponding to the snapshot.
+The file `info.xml` provides the metadata corresponding to the snapshot.
The data of the snapshot is stored in the file `_full.btrfs`.
This file has to be decrypted with btrfs tool `btrfs-send` to a btrfs
restore directory:
- cd /target_btrfs_path
- cp /path_to_tape_root/backups/@/archive-/_full.btrfs .
- cat _full.btrfs | btrfs receive -v .
- rm _full.btrfs
+ cd /target_btrfs_path
+ cp /path_to_tape_root/backups/@/archive-/_full.btrfs .
+ cat _full.btrfs | btrfs receive -v .
+ rm _full.btrfs
Please consult btrfs-send man-page for further info.
diff --git a/lang/german/README.md b/lang/german/README.md
index f25e162..57ed139 100644
--- a/lang/german/README.md
+++ b/lang/german/README.md
@@ -1,5 +1,5 @@
-
+
# dsnap-sync
@@ -7,7 +7,6 @@
English |
Englisch
- Deutsch
## Über
@@ -333,6 +332,66 @@ dann mit den gewohnten Betriebssystem Tools. Eine Open-Source Implementierung
finden Sie z.B. unter
[LinearTapeFileSystem](https://github.com/LinearTapeFileSystem/ltfs).
+## Rücksicherung (restore)
+
+### Dateisystem (target)
+
+Wurden Daten mit einer nativen btrfs Methode (`btrfs-snapshot`,
+`btrfs-clone`) gesichert, befinden sie sich in einer `snapper` kompatiblen
+Verzeichnisstruktur auf dem gewählten Target.
+
+Diese Struktur könnte so aussehen:
+
+* └ backups
+ * └ @\
+ * └ \
+ * └ \
+ * ├ \.snapshot\>
+ * └ info.xml
+
+Um Daten zurückzusichern, können Sie entweder native `snapper` Methoden verwenden,
+oder auf Betriebssystem Programme zurückgreifen.
+
+ * native snapper Methoden
+
+ Verwenden Sie `snapper diff .. [Dateien]`, um Unterschiede in den
+ gewählten subvol-id's aufzuzeigen.
+ Verwenden Sie `snapper rollback `, um alle Daten der Sicherung (\)
+ an den Ursprungsort zurückzusichern.
+
+ * Betriebssystem Programme
+
+ Verwenden Sie Ihren bevorzugten Datei-Manager und wechseln Sie in das
+ Verzeichnis, in dem sich die Daten des gewünschten Backups (\)
+ befinden. Die Daten wurden als **read-only** Snapshot gesichert.
+ Sie können von hier aus in jedes gewünsche Zielverzeichnis kopiert werden.
+
+### Band-Sicherung (tape)
+
+Wurden Daten mit der Methode `btrfs-archive` gesichert, speichert `dsnap-sync`
+diese in einer `snapper` kompatiblen Datei-Struktur auf dem Band.
+
+Dies Struktur könnte so aussehen:
+
+ * └ backups
+ * └ @\
+ * └ archive-\
+ * └ \
+ * ├ \_full.btrfs
+ * └ info.xml
+
+In der Datei `info.xml` werden die Metadaten zum Snapshot gespeichert.
+Die Bewegungsdaten des snapshots befinden sich in der Datei `\_full.btrfs`.
+Diese Datei muss mit dem btrfs programm `btrfs-send` auf ein btrfs Verzeichnis zurück
+geschrieben werden:
+
+ cd /target_btrfs_path
+ cp /path_to_tape_root/backups/@/archive-/_full.btrfs .
+ cat _full.btrfs | btrfs receive -v .
+ rm _full.btrfs
+
+Die man-page zu `btrfs-send` enthält weiterführende Informationen.
+
## Mitarbeit
Hilfe ist sehr willkommen! Gerne könnt Ihr das Projekt forken und PR's einreichen,