From e93194a96be00b16e54f632290f093f1ef99cf59 Mon Sep 17 00:00:00 2001
From: Martin Ortbauer <mortbauer@gmail.com>
Date: Sun, 19 May 2024 10:27:13 +0200
Subject: [PATCH] add readme with restore instruction

---
 README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d8bcdca
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# Backuper
+
+The data is backupped via the awesome borg backup.
+
+## Restore
+
+To restore for example the files from the fcat_foodsoft volume do the following steps:
+
+1. create a new interactie docker container where you mount the borgrepo volume and the volume where you want to restore some data, for example:
+```
+docker run --rm -it -v /var/lib/docker/volumes/fcat_foodsoft/_data:/backup/foodsoft -v /var/lib/docker/volumes/fcat_backup_storage_local/_data:/repo ghcr.io/foodcoopsat/backuper ash
+```
+
+2. export the 2 environment variables BORG_PASSPHRASE and BORG_REPO
+3. list the available backups in the repo with:
+
+```
+borg list
+```
+
+4. decide which of the backups you want to restore files from and copy the name of the archive
+5. cd to the root directory
+6. run the restore command, for example
+
+```
+borg extract /repo/borgrepo::fa04941d5e5c-2024-05-19T02:23:26 /backup/foodsoft
+```
+
+will restore the files below path `/backup/foodsoft` from archive `fa04941d5e5c-2024-05-19T02:23:26`