From 548f459229d5041558f827afa4811e3a4a90aec7 Mon Sep 17 00:00:00 2001
From: Bastian Dehn <hhaalo@arcor.de>
Date: Sat, 14 Sep 2019 09:34:18 +0200
Subject: [PATCH] add: readme file

---
 readme.md | 73 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 73 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..3ed6ed4
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,73 @@
+# Simple Backup
+
+## Abhängigkeiten
+
+- ssh
+- rsync
+- dd
+- gzip
+- filesystem support hardlinks
+
+**Optional:**
+
+- virsh
+- apt-key
+- dpkg
+
+## Schnellstart
+
+### Anpassung
+
+Default Variablen im backup und restore script anpassen:
+
+```bash
+SetDefaultVariables()
+{
+	backpath="<default path>"
+	backname="<backup name>"
+	wunschanzahl="<count of backups>"
+	.
+	.
+	.
+}
+```
+
+### Kennzeichnung der Backups
+
+Auf den Festplatten legt man **eine leere Datei** mit folgenden Bezeichnungen:
+
+- day
+- month
+- week
+
+Diese Datei kennzeichnet die Festplatte um welches Backup es sich handelt: ein
+tägliches ein wöchentliches oder monatliches Backup.
+
+### Backup von einem Rechner
+
+Die Computerangaben welcher Rechner zu sichern ist wird in eine Datei
+geschrieben. **Die Datei heißt "rechner"**, die folgendes pro Zeile enthält:
+
+```code
+<user>@<hostname>:<port>
+```
+
+### Verzeichnisse, die gesichert werden sollen
+
+Die jeweiligen Verzeichnisse, die auf dem jeweiligen Computer gesichert werden
+sollen.
+Gibt man in einer Datei an. **Die Datei heißt "pfad-&lt;hostname&gt;"**
+
+Es kann mit den **Schlagwort "virsh"** veranlasst werden, dass auf dem remote
+Rechner die kvm's (Kernel-based Virtual Machine) gesichert wird. Mit dem
+**Schlagwort "packages"** wird veranlasst, dass die apt packagelist gesichert
+wird inkl. apt-keys.
+
+```code
+/<path>
+virsh
+packages
+```
+# Lizenz
+
+[MIT License](license)
\ No newline at end of file
-- 
2.39.5