Skip to content

toafez/AutoPilot

Repository files navigation

English | Deutsch

Package icon AutoPilot für externe Datenträger

AutoPilot ermöglicht das Ausführen von beliebigen Shellscript Anweisungen, die nach dem Anschluss eines externen Datenträgers an deine Synology DiskStation automatisch ausgeführt werden. Vorhandene Basic Backup Aufträge sowie Hyper Backup Aufgaben (ab Version 4) werden dabei in AutoPilot übersichtlich angezeigt und lassen sich mit bereits vorkonfigurierten Shellscripts verbinden und somit ebenfalls ausführen. Nach der Ausführung kann der externe Datenträger auf Wunsch wieder automatisch ausgeworfen werden.

Einen externen Datenträger einrichten

Zur späteren Identifizierung eines externen Datenträgers wird in einer Ersteinrichtung die UUID (Universally Unique Identifier) der ausgewählten Partition bzw. des sich darauf befindlichen Dateisystems ausgelesen. Anschließend wird eine leere Datei mit dem Namen autopilot (ohne Dateiendung) im Wurzelverzeichnis der zuvor ausgewählten Partition abgelegt. Im nächsten Schritt muss der Name und der Speicherort des auszuführenden Shellscripts angegeben werden, welches sich idealerweise in einem gemeinsamen Ordner der DiskStation befinden sollte. Abschließend wird die so ermittelte UUID mit den Angaben zum Shellscript fest miteinander verknüpft und intern gespeichert. Damit ist die Ersteinrichtung abgeschlossen.

So funktioniert AutoPilot genau

AutoPilot nutzt, wie weiter oben bereits beschrieben, die UUID der ausgewählten Partition bzw. des sich darauf befindlichen Dateisystems eines externen Datenträgers zur eindeutigen Identifikation. Die so ermittelte UUID wird im dem, von Synology bereitgestellten AutoPilot Paketordner in Form eines Dateinamens abgespeichert und ist somit vor fremden Zugriff weitestgehend geschützt. In dieser Datei wird im Anschluss der Pfad und der Dateiname des eigentlich auszuführenden Shellscripts als Variable hinterlegt. Das Shellscript selbst sollte sich dabei innerhalb der Ordnerstruktur eines gemeinsamen Ordners der DiskStation befinden um diese ebenfalls vor fremden Zugriff zu schützen. Es besteht zwar die Möglichkeit, das Shellscript auf dem externen Datenträger selbst zu hinterlegen, jedoch wird aus Sicherheitsgründen davon abgeraten. Der so präparierte externe Datenträger wird zukünftig beim anschließen an deine Synology DiskStation durch AutoPilot eindeutig identifiziert. Dabei durchsucht eine sogenannte UDEV-Regel in allen vorhandenen Partitionen des externen Datenträger nach der leeren Datei autopilot. War die Suche erfolgreich, wird die ermittelte UUID des extern angeschlossenen Datenträgers mit der intern gespeicherten UUID verglichen und bei Übereinstimmung mit dem damit verknüpften Shellscript verbundenen und ausgeführt. Durch dieses Vorgehen ist sichergestellt, das über den externen Datenträger kein Schadcode in Verbindung mit AutoPilot ausgeführt werden kann.

Systemvoraussetzungen

AutoPilot für externe Datenträger wurde speziell für die Verwendung auf Synology NAS Systemen entwickelt die das Betriebsystem DiskStation Mangager 7.0 oder höher verwenden. Für die Anzeige und Weiterverarbeitung von Hyper Backup Aufgaben wird die Version 4 von Hyper Backup benötigt, die zusammen mit dem DiskStation Manager 7.2 veröffentlicht wurde.

Installationshinweise

Lade dir die jeweils aktuellste Version von AutoPilot aus dem Bereich Releases herunter. Öffne anschließend im DiskStation Manager (DSM) das Paket-Zentrum, wähle oben rechts die Schaltfläche Manuelle Installation aus und folge dem Assistenten, um das neue Paket bzw. die entsprechende .spk-Datei hochzuladen und zu installieren. Dieser Vorgang ist sowohl für eine Erstinstallation als auch für die Durchführung eines Updates identisch.

Nach dem Start von AutoPilot wird die lokal installierte Version mit der auf GitHub verfügbaren Version verglichen. Steht ein Update zur Verfügung, wird der Benutzer über die App darüber informiert und es wird ein entsprechender Link zu dem ensprechenden Release eingeblendet. Der Download sowie der anschließende Updatevorgang wurde bereits weiter oben erläutert.

App-Berechtigung erweitern

Unter DSM 7 wird eine 3rd_Party Anwendung wie AutoPilot (im folgenden App genannt) mit stark eingeschränkten Benutzer- und Gruppenrechten ausgestattet. Dies hat u.a. zur Folge, das systemnahe Befehle nicht ausgeführt werden können. Für den reibungslosen Betrieb von AutoPilot werden jedoch erweiterte Systemrechte benötigt um z.B. auf die Ordnerstuktur des Systems zugreifen zu können. Zum erweitern der App-Berechtigungen muss AutoPilot in die Gruppe der Administratoren aufgenommen werden, was jedoch nur durch den Benutzer selbst durchgeführt werden kann. Die nachfolgende Anleitung beschreibt diesen Vorgang.

  • Erweitern bzw. beschränken der App-Berechtigungen über die Konsole

    • Melde dich als Benutzer root auf der Konsole deine Synology NAS an.

      • Befehl zum erweitern der App-Berechtigungen

      /usr/syno/synoman/webman/3rdparty/AutoPilot/permissions.sh "adduser"

      • Befehl zum beschränken der App-Berechtigungen

      /usr/syno/synoman/webman/3rdparty/AutoPilot/permissions.sh "deluser"

  • Erweitern bzw. beschränken der App-Berechtigungen über den Aufgabenplaner

    • Im DSM unter Hauptmenü > Systemsteuerung den Aufgabenplaner öffnen.

    • Im Aufgabenplaner über die Schaltfläche Erstellen > Geplante Aufgabe > Benutzerdefiniertes Script auswählen.

    • In dem nun geöffneten Pop-up-Fenster im Reiter Allgemein > Allgemeine Einstellungen der Aufgabe einen Namen geben und als Benutzer: root auswählen. Außerdem den Haken bei Aktiviert entfernen.

    • Im Reiter Aufgabeneinstellungen > Befehl ausführen > Benutzerdefiniertes Script nachfolgenden Befehl in das Textfeld einfügen...

    • Befehl zum erweitern der App-Berechtigungen

      /usr/syno/synoman/webman/3rdparty/AutoPilot/permissions.sh "adduser"

    • Befehl zum beschränken der App-Berechtigungen

      `/usr/syno/synoman/webman/3rdparty/AutoPilot/permissions.sh "deluser"`
      
    • Eingaben mit OK speichern und die anschließende Warnmeldung ebenfalls mit OK bestätigen.

    • Die grade erstellte Aufgabe in der Übersicht des Aufgabenplaners markieren, jedoch nicht aktivieren (die Zeile sollte nach dem markieren blau hinterlegt sein).

    • Führen Sie die Aufgabe durch Betätigen Sie Schaltfläche Ausführen einmalig aus.

UDEV-Gerätetreiber für die Erkennung externer Datenträger (de)-aktivieren

  • UDEV Gerätetreiber über die Konsole aktivieren

    • Melde dich als Benutzer root auf der Konsole deiner DiskStation an und führe folgenden Befehl aus
      • Befehl um den UDEV-Gerätetreiber über die Konsole zu aktivieren

        /usr/syno/synoman/webman/3rdparty/AutoPilot/driver.sh "install"

      • Befehl um den UDEV-Gerätetreiber über die Konsole zu deaktivieren

        /usr/syno/synoman/webman/3rdparty/AutoPilot/driver.sh "uninstall"

  • UDEV-Gerätetreiber über den DSM Aufgabenplaner (de)-aktivieren

    • Öffne im DSM unter Hauptmenü > Systemsteuerung den Aufgabenplaner.
      • Wähle im Aufgabenplaner über die Schaltfläche Erstellen > Geplante Aufgabe > Benutzerdefiniertes Script aus.

      • In dem sich nun öffnenden Pop-up-Fenster gibst du im Reiter Allgemein > Allgemeine Einstellungen der Aufgabe einen individuellen Namen und wählst als Benutzer root aus. Anschließend entfernst du noch den Haken bei Aktiviert.

      • Füge im Reiter Aufgabeneinstellungen > Befehl ausführen > Benutzerdefiniertes Script den nachfolgenden Befehl in das Textfeld ein...

        • Befehl um den UDEV-Gerätetreiber über den Aufgabenplaner zu aktivieren

          /usr/syno/synoman/webman/3rdparty/AutoPilot/driver.sh "install"

        • Befehl um den UDEV-Gerätetreiber über den Aufgabenplaner deaktivieren

          /usr/syno/synoman/webman/3rdparty/AutoPilot/driver.sh "uninstall"

      • Bestätige deine Eingaben mit die Schaltfläche OK und akzeptiere die anschließende Warnmeldung ebenfalls mit OK.

      • Damit die Aufgabe dem Aufgabenplaner hinzugefügt wird, musst du abschließend das Passwort deines aktuell am DSM angemeldeten Benutzers eingeben und den Vorgang über die Schaltfläche Senden bestätigen.

      • In der Übersicht des Aufgabenplaners musst du nun die grade erstellte Aufgabe mit der Maus markieren die Zeile sollte nach dem markieren blau hinterlegt sein), jedoch keinen Haken in der Checkbox setzen, um die Aufgabe dauerhaft zu aktivieren.

      • Führe die Aufgabe nun durch betätigen der Schaltfläche Ausführen einmalig aus.

      • Schließe die AutoPilot und rufe sie erneut auf, damit die Änderungen wirksam werden.

  • AutoPilot für einen externen Datenträger einrichten

    In der AutoPilot App findest du unter dem Menüpunkt Hilfe detailierte Anleitungen, wie du einen externen Datenträger entweder über die Konsole oder aber über den DSM-Aufgabenplaner einrichten kannst.

Versionsgeschichte

  • Details zur Versionsgeschichte finest du in der Datei CHANGELOG.

Entwickler-Information

Hilfe und Diskussion

Lizenz

Dieses Programm ist freie Software. Sie können es unter den Bedingungen der GNU General Public License, wie von der Free Software Foundation veröffentlicht, weitergeben und/oder modifizieren, entweder gemäß Version 3 der Lizenz oder (nach Ihrer Option) jeder späteren Version.

Die Veröffentlichung dieses Programms erfolgt in der Hoffnung, daß es Ihnen von Nutzen sein wird, aber OHNE IRGENDEINE GARANTIE, sogar ohne die implizite Garantie der MARKTREIFE oder der VERWENDBARKEIT FÜR EINEN BESTIMMTEN ZWECK. Details finden Sie in der Datei GNU General Public License.