Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Erweiterungen/Plugins

Es besteht die Möglichkeit, eigene Codeerweiterungen vor und nach dem Backupprozess des Scripts einzubinden. Dieses ist sinnvoll, wenn eigentlich Änderungen im Backupscript notwendig sind, die aber dann nach jedem Update von raspiBackup auf eine neue Version wieder neu eingepflegt werden müssten. Die Extensions (Plugins) sind unabhängig vom jeweiligen Codestand von raspiBackup und deshalb in diesem Falle zu empfehlen.

Beispielerweiterungen stehen zur Verfügung und können als Vorlage für eigene Erweiterungen dienen. Durch die ersten wird die CPU Temperatur sowie die Hauptspeicher- und Backuppartitionsbelegung sowie die Partitionsbelegung vor und nach dem Backup ausgegeben. Die letzte Erweiterung wird nur am Ende des Backups aufgerufen und kann bei Erfolg bzw. Misserfolg des Backups unterschiedliche Aktionen auslösen.

Wer nützliche Erweiterungenfür die Community erstellt hat, kann sie gerne im deutschen Raspberry Pi Forum vorstellen und die Downloadlocation nennen. Sollten Fähigkeiten der Plugins fehlen, bitte einen Issue bei GitHub anlegen.

Außerdem existieren interessante, von raspiBackup Nutzern geschriebene, Plugins.

Plugin-Aufrufstellen beim Backup

Die verschiedenen Plugins werden an folgenden Stellen im Backupverlauf aufgerufen:

  • eMail Plugin (mem)
  • Notification (notify) Plugin, wenn eingeschaltet (DEFAULT_NOTIFY_START)
  • Slack, Pushover und Telegram Notifications, falls konfiguriert und wenn eingeschaltet (DEFAULT_NOTIFY_START)
  • BEFORE_STOPSERVICES (Definierte Befehle werden ausgeführt)
  • STOP_SERVICES (Definierte Befehle werden ausgeführt)
  • PRE_BACKUP_EXTENSION
  • READY_BACKUP_EXTENSION

... Erstellen des Backups ...

  • POST_BACKUP_EXTENSION
  • START_SERVICES (Definierte Befehle werden ausgeführt
  • AFTER_STARTSERVICES (Definierte Befehle werden ausgeführt)

... Aufräumarbeiten, wie das Löschen von obsoleten Backups (kann länger dauern) ...

  • FINAL_COMMANDS (ab Release 0.6.8) (Definierte Befehle werden ausgeführt)
  • eMail (mail) Plugin
  • Notification (notify) Plugin
  • Slack, Pushover und Telegram Notifications falls konfiguriert

... Final housekeeping ...

  • Exit

Plugin-Aufrufstellen beim Restore

Die verschiedenen Plugins werden an folgenden Stellen im Restoreverlauf aufgerufen:

  • PRE_RESTORE_EXTENSION

... restoren des Backups ...

  • POST_RESTORE_EXTENSION  

Beispielerweiterungen

  1. Der einfachste Weg ist, die Beispielerweiterungen mit dem Installer zu installieren und zu aktivieren. Entweder über die Menüfolge Installiere Komponenten->Installiere Beispielerweiterungen oder direkt über die Befehlszeile mit der Option -e.

    raspiBackupInstallUI.sh

    oder

    raspiBackupInstallUI.sh -e

  2. Wer die Beispielerweiterungen manuell installieren möchte, kann die tgz-Datei mit diesem Link mit einem Browser downloaden oder auch direkt wie folgt auf die Raspberry downloaden und nach /usr/local/bin auspacken:

    wget http://www.linux-tips-and-tricks.de/raspiBackupSampleExtensions.tgz -O raspiBackupSampleExtensions.tgz
tar -xzf raspiBackupSampleExtensions.tgz -C /usr/local/bin

Dadurch werden die folgenden Scripts nach/usr/local/bin kopiert:

  1. raspiBackup_mem_pre.sh und raspiBackup_mem_post.sh - Berichtet Memory Usage der Raspberry vor und nach dem Backup

  2. raspiBackup_temp_pre.sh und raspiBackup_temp_post.sh - Berichtet die CPU Temperatur der Raspberry vor und nach dem Backup

  3. raspiBackup_disk_pre.sh und raspiBackup_disk_post.sh - Berichtet die Plattennutzung vor und nach dem Backup

  4. raspiBackup_execute_post.sh - Wird am Ende des Backups aufgerufen. Hilfreich, wenn eine eigene Erfolg/Fehler Benachrichtigungsfunktion genutzt werden soll.

Um die Plugins zu aktivieren, ist noch folgender zusätzlicher Aufrufparameter bei raspiBackup notwendig:

-N "temp mem disk execute"

bzw. in die Konfigurationsdatei ist folgende Zeile aufzunehmen

DEFAULT_EXTENSIONS="temp mem disk execute"

Notification Erweiterung

Für Notifications per Slack, Pushover und Telegram müssen keine Extensions geschrieben werden. Es genügt, die Notifications in raspiBackup zu konfigurieren. Wer andere Notificationziele versorgen möchte, kann das in einem Script mit dem Namen raspiBackup_notify.sh tun.

Beispielerweiterungen

Die folgenden Extensions können ein pre und/oder post Script haben und müssen raspiBackup_<extension>_pre.sh und/oder raspiBackup_<extension>_post.sh heißen.

  1. temp
  2. mem
  3. disk

Alle anderen Extensions müssen kein _pre und _post am Ende haben.

Die Plugins erzeugen folgende Meldungen:

--- RBK1001I: Memory usage - Pre backup - Used: 97 MB Free: 130 MB - Post backup - Used: 98 MB Free: 121 MB
--- RBK1000I: CPU temperature pre and post backup: 53.2'C - 55.8'C
--- RBK1002I: Disk usage pre backup: Used: 1.30 TiB Free: 2.18 TiB
--- RBK1003I: Disk usage post backup: Used: 1.30 TiB Free: 2.18 TiB
--- RBK1004I: Free change: -256.00 KiB (0.00 %)

Meldungen

Die Beispielerweiterungen benutzen Meldungen, die ab dem Nummernbereich 1000 beginnen, wie z.B. RBK1000I. Wer eigene Erweiterungen erstellt, sollte, sofern sie Meldungen schreiben, diese bei 2000 beginnen lassen und nicht den Bereich unter 1999 benutzen.

Interface

Eine Erweiterungn bekommt im Aufruf den aktuellen Statuscode von raspiBackup mitgegeben. Ein Statuscode von 0 bedeutet in den Posterweiterungen: das Backup war erfolgreich. Jeder andere Statuscode bedeutet, dass das Backup abgebrochen wurde.

eMailErweiterung

Möchte man den Versand von eMails selbst programmieren, kann die emailErweiterung genutzt werden. Das ist dann besonders hilfreich, wenn die vom Script unterstützen eMailProgramme den eigenen eMailClient nicht unterstützen. Außerdem kann das Aussehen der eMail beliebig geändert werden. Eine Erweiterung, das mailx benutzt, befindet sich in den Beispielerweiterungen.

Die folgenden Parameter werden der eMailerweiterung übergeben:

email="$1"        # target email address
subject="$2"      # email subject
content="$3"      # email contents
parms="$4"        # addtl email parms passed with -E
append="$5"       # file to append

Hinweise

  • Achtung: Die Erweiterungen laufen mit root Rechten und können deshalb bei Fehlern das laufende System schädigen oder sogar zerstören!

  • Es sind nicht beide Scripts (pre und post) notwendig. Eines genügt.

  • Zum Testen von Erweiterungen ist der Parameter -F sehr hilfreich. Damit wird der eigentliche Backupprozess übersprungen und somit der Scriptdurchlauf sehr schnell.

  • Die Erweiterungen werden im Scope von raspiBackup aufgerufen. Daher besteht Zugriff auf dessen interne Scriptvariablen. Davon ist allerdings dringend abzuraten, da sich die Interna jederzeit ändern können. Aus diesem Grunde ist es auch ratsam, eigene Variablen mit einem erweiterungsspezifischen Prefix zu versehen, um mögliche Konflikte mit Variablennamen, die von raspiBackup benutzt werden, zu vermeiden.

  • Wer seinen Erweiterungscode teilen möchte, kann gerne einen Pullrequest auf GitHub anlegen. Dort sind alle Erweiterungen im Quellcode verfügbar, um sie zu erweitern und neue hinzuzufügen.