Erweitern der Dokumentation

This commit is contained in:
Tim Schilling | IuK
2024-12-03 08:12:22 +01:00
parent 0f4035341a
commit 1d517cefca
4 changed files with 64 additions and 28 deletions
+28 -3
View File
@@ -3,13 +3,38 @@
Dieses Projekt befasst sich mit dem automatischen verschieben der Exportierten Passwortdatein aus Vaultwarden auf ein externes WebDAV laufwerk.
## Requirements
## Voraussetzungen
- rclone muss auf Ausführendem Host installiert sein
- ssh KEY authentifizierung bei sftp remote host
- SSH KEY Authentifizierung bei Docker Host
- SSH Schlüsselauthentifizierung zu allen benötigten Hosts (Docker und SFTP) muss gegeben sein.
## Funktion
Dieses Projekt besteht aus zwei Skripten, der '''setup.sh''' und der '''backup.sh''. Die Eigendliche funktion funktioniert jedoch auschließlich die '''backup.sh'''
Die '''setup.sh''' ist für die Erstellung der für das einbinden der WebDAV Freigabe benötigten vorkonfiguration zuständig. Sie fürt folgende schritte aus:
- Installieren von rclone (Programm für die Verbindung der Freigabe)
- Verschlüsselung des Benötigten Passworts
- Erstellen der rclone Konfigurationsdatei
- Sicherstellen das Berechtigungen richtig gesetzt sind
Die '''backup.sh''' ist für das Verschiben der Datein benötigt, diese solte auch mit einem cron task automatisch mit einem zeitintervall ausgeführt werden. Die ausgeführten schritte sind wie folgt:
- Erstellen des benötigten Mount Punktes für WebDAV
- Starten des benötigten Docker Containers und warten bis dieser durchgelaufen ist
- Transferieren der Datein von Remotehost auf Lokale maschine
- Einhängen / Verbinden der Webdav Freigabe
- Leeren der WebDAV freigabe von Alten Backups
- Übertragen der neunen Backups von Lokaler Maschine auf WebDAV Freigabe.
- Aushängen der WebDAV Freigabe
## Dateibaum
'''
├──.git
├── .gitignore
├── README.md
├── backup.sh
├── setup.sh
├── temp
└── webdav
'''