]> gitweb.hhaalo.de Git - simple-backup.git/commitdiff
update readme
authorBastian Dehn <hhaalo@arcor.de>
Sat, 24 May 2025 14:29:35 +0000 (16:29 +0200)
committerBastian Dehn <hhaalo@arcor.de>
Sat, 24 May 2025 14:29:35 +0000 (16:29 +0200)
readme.md

index 7bd0f723003545d4089c546953d17530e485cff1..c42c2b9444c67ed58032c43fbd47896fd879cceb 100644 (file)
--- a/readme.md
+++ b/readme.md
@@ -1,73 +1,35 @@
 # Simple Backup
 
-## Abhängigkeiten
+## Dependencies
 
 - ssh
 - rsync
-- dd
-- gzip
+- yq
 - filesystem support hardlinks
 
-**Optional:**
+## Configuration
 
-- virsh
-- apt-key
-- dpkg
+config file config.yaml
 
-## Schnellstart
+```yaml
+backup_path: /images/backup
+backup_name: backup
+backup_count: 15
 
-### Anpassung
-
-Default Variablen im backup und restore script anpassen:
-
-```bash
-SetDefaultVariables()
-{
-       backpath="<default path>"
-       backname="<backup name>"
-       wunschanzahl="<count of backups>"
-       .
-       .
-       .
-}
+machines:
+  testpc:
+       remote_user: backupuser
+       host: www.example.com
+       port: 22
+       pathes:
+         - /etc
+         - /home
 ```
 
-### 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:
+### mark backup media
 
-```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
-```
+On disk create empty file `day`, `week` or `month`. It is important for backup
+history.
 
 ## Lizenz