Differences

This shows you the differences between two versions of the page.

--- publications:synology_trigger_hyper_backup_on_usb_connect [2020/01/08 18:41] – [Trigger check] Maik Wodarz
+++ publications:synology_trigger_hyper_backup_on_usb_connect [2022/05/01 11:01] (current) – Maik Wodarz
@@ Line 1: / Line 1: @@
 ====== About ======
-This article describes how can be configured an automatic USB hyperbackup, which is triggered by USB-connect.
+This article describes how can be configured an automatic USB //hyper backup//, which is triggered by USB-connect.
 ====== Introduction ======
-The synology diskstation out of the box isn’t able to start an backup job automatically as reaction of USB hard drive connection.
+The //Synology Diskstation (DS)// out of the box isn’t able to start an backup job automatically as reaction of USB hard drive connection.
 My DS-216 has a copy button.
-Using the app forseen for this button you can do some simple tasks like “copy all files from USB-Drive to a predefined destination folder” or “copy all files in predefined folder to USB drive.
+Using the app foreseen for this button you can do some simple tasks like “copy all files from USB-Drive to a predefined destination folder” or “copy all files in predefined folder to USB drive”.
-When we talk about backups this is a quite poor solution. Wishable would be a trigger of a hyper backup job. Reason: hyperbackup does maintain a history of files. (like time capsule) and compresses.
+Talking about backups, this isn't a solution. Desired would be a trigger for a hyper backup job. Reason: //hyper backup// does maintain a history of files. (like time capsule) and does compression.
-In addition the copy button action can only handle the front usb port of the Synology.
+In addition, the //Copy// button action can only handle the front USB port of the //Synology DS//.
-Sadly the solution of Bernd Distler [1] is not working anymore because I couldn’t get running the autorun functionality.
+My solution is derived from Bernd Distler's [1] solution. Bernd Distler is using //autorun//, a 3th party package.
+I wanted to find a solution without third party software.
-The following article describes preconditions, the general workflow as well as the details how it is possible to trigger a hyper backup job start on USB connect event.
+The following article describes preconditions, the general workflow as well as the details how it is possible to trigger a //hyper backup// job start on USB connect event.
 ====== Preconditions ======
-  * ssh access to synology nas is enabled and the user is aware how to use it.
+  * SSH access to Synology NAS is enabled and the user is aware how to use it
-  * Basic knowledge about usage of bash and vi editor.
+  * Basic knowledge about usage of BASH and VI editor
-  * Synology hyper backup app is installed
+  * //Synology Hyper backup// app is installed
-  * Synlogy USB-Copy app is installed
+  * //Synlogy USB-Copy// app is installed
-  * Hyper backup jobs using USB are configured.
+  * //Hyper backup// tasks using USB are configured
 ====== Overview - general workflow ======
-  * Create a cron job which checkt peridically a predefined file system location for existence of a flag file. (I’ll call it trigger file)
+  * Create a cron job which checks peridically a predefined file system location for existence of a flag file. (I’ll call it trigger file)
-  * Create an USB copy job using USB-Copy app from Synology, which copies a trigger file from a just connected USB drive to predefined location on NAS.
+  * Create an USB copy job using //USB-Copy// app from Synology, which copies a trigger file from a just connected USB drive to predefined location on NAS.
-  * When the cron job finds the trigger file and there is still no active job (activity file)
+  * When the cron job finds the trigger file and there is still no active job (activity file), then:
     * Remember that a job is active => create the activity file (using touch)
     * Remove the trigger file
@@ Line 37: / Line 38: @@
 ====== USB-Copy ======
-Originaly the USB-Copy app from Synology is intendet to do simple jobs like “copy file from USB drive to NAS” or “copy files from NAS to USB drive” when the copy button is pressed or a specific backup medium is detected. (UUID) It has to be installed by Synology package center.
+Originally the //USB-Copy// app from Synology is intended to do simple jobs like “copy file from USB drive to NAS” or “copy files from NAS to USB drive” when the copy button is pressed or a specific backup medium is detected. (UUID) It has to be installed by //Synology package center//.
-Actions caused by copy button are affecting only the fron USB port while USB detecting actions are working for the back site USB ports as well.
+Actions caused by copy button are affecting only the front USB port while USB detecting actions are working for the back site USB ports as well.
-For my objective – triggering a hyper backup job – I simply copy a flag file from predefined location on USB drive to a predefined location on NAS. So after connecting the USB drive a file named autobackup is copied to
+For my objective – triggering a //Hyper backup// job – I simply copy a flag file from predefined location on USB drive to a predefined location on NAS. So after connecting the USB drive a file named autobackup is copied to
   /volume1/Shared/USB_AUTO_BACKUP/TRIGGERS/DATEN/autobackup
 The following screenshot is depicting it.
@@ Line 55: / Line 56: @@
   /volume1/Shared/USB_AUTO_BACKUP/TRIGGERS/MEDIA/autobackup
-The USB-Copy program lets beep the NAS after connecting twice.
+The //USB-Copy// program lets beep the NAS after connecting twice.
-After finishing the trigger file it beebs again twice.
+After finishing the trigger file it beeps again twice.
 ====== Trigger check ======
 The trigger checker script /opt/bin/checkTrigger.sh is called by cron every minute.
 {{:publications:2020-01-08_13_34_42-wodarz_burstnas_.png?600|}}
-First the script is checking if it is running already. (avoid duplicate run)
+First, the script is checking if it is running already. (avoid duplicate run)
 In order to do so it checks if the activity file exists. (''/opt/var/dataBackupRunning'')
@@ Line 68: / Line 69: @@
 If the activity file exists, it terminates immediately. Otherwise it continues.
-Then it determines the trigger file counts. (counts directory entries in:
+Then it determines the trigger file counts. (count directory entries in:
   /volume1/Shared/USB_AUTO_BACKUP/TRIGGERS/DATEN/ and
@@ Line 77: / Line 78: @@
 So it is possible to connect the second backup drive a bit later or even in the same moment. The backups are handled serial.
-What happens when a trigger counter is bigger than Zero?:
+What happens when a trigger counter is bigger than zero?:
   * Create activity file (using touch command)
   * Remove all entries in trigger folders:
@@ Line 131: / Line 132: @@
 fi
 </code>
+====== Backup task id ======
+Hyper backup has a config file in ''/usr/syno/etc/synobackup.conf''.
+There all hyper backup tasks are configured.
+We need to identify our task and derive the is from task phrase. (see middle line in the screenshot)
+{{:publications:2020-01-08_13_53_25-wodarz_burstnas_.png?600|}}
+You can determine the id by taking a look tot he number. Just cut of “task_”. So in our screenshot the task is is 4.
+====== Synousbcopy ======
+''/usr/syno/bin/synousbcopy'' was a script until DSM5. So it was easier to manipulate it respective to replace it inside file system. Further, this script was containing the whole copy button handling. Since DSM6 the copy button handlich was moved into an app called //USB-Copy//. Nowadays the script is still there but contains some helper functions probably used by the //USB-Copy// app.
+What can ''synousbcopy'' do for us?
+  /usr/syno/bin/synousbcopy –h
+Shows the help.
+I’ll use it in order to manipulate the copy LED state. In addition, it can be used for unmounting USB-drives. (eject)
+====== Synobackup ======
+''/usr/syno/bin/synobackup'' is a program (served by Synology) which is able to trigger hyper backup tasks. Hyper backup uses the mode „image“. Here an example call:
+  /usr/syno/bin/synobackup --backup 4 --type image
+When hyper backup is done it eject’s the corresponding USB drive. So we don’t need to care about ejecting.
+====== Script startDatenBackup.sh ======
+This script or the corresponding counterpart ''startMediaBackup.sh'' is the heart of the trigger process.
+It does the following:
+  * activate copy LED blinking
+  * triggers //hyper backup// task
+  * waits until the hyper backup task finishes.
+  * Deactivates the copy LED
+''startDatenBackup.sh''
+<code>
+#!/bin/sh
+LOGFILE="/volume1/Shared/USB_AUTO_BACKUP/hyperBackupTrigger.log"
+/usr/syno/bin/synousbcopy -b  # blink usb copy led
+ctime=`date -R`
+echo "[I] $ctime starting daten backup" >> $LOGFILE
+/usr/syno/bin/synobackup --backup 4 --type image
+sleep 60
+while [ "$(/bin/pidof img_backup)" -o  "$(/bin/pidof dsmbackup)" -o  "$(/bin/pidof synoimgbktool)" -o  "$(/bin/pidof synolocalbkp)" -o  "$(/bin/pidof synonetbkp)" -o  "$(/bin/pidof updatebackup)" ]
+do
+ ctime=`date -R`
+ echo "[D] $ctime still running ..." >> $LOGFILE
+ sleep 60
+done
+#/usr/syno/bin/synousbcopy -e # eject hdd
+/usr/syno/bin/synousbcopy -f # usb copy led off
+ctime=`date -R`
+echo "[D] $ctime daten backup done." >> $LOGFILE
+return 0
+</code>
+====== Script startMediaBackup.sh ======
+Is the same as ''startDatenBackup.sh''
+The only difference ist he task id and some logging output.
+''startDatenBackup.sh'' and ''startDatenBackup.sh'' could be merged or put in a function in order to optimize. I left it here in order to depict.
+====== Activity file (/opt/bin/checkTrigger.sh) ======
+''/opt/var/dataBackupRunning'' is the activity file. It is used as a flag. I fit exists no other backup job shall be triggered. It will be created at the beginning and removed at the end of ''checkTrigger.sh''.
+====== Logging ======
+The scripts ''/opt/bin/checkTrigger.sh'', ''/opt/bin/startDatenBackup.sh'' and ''/opt/bin/startMediaBackup.sh'' are logging to ''/volume1/Shared/USB_AUTO_BACKUP/hyperBackupTrigger.log'' by redirecting ''stderr'' and ''stdout'' using pipe.
+====== References ======
+[1] [[https://bernd.distler.ws/archives/1835-Synology-automatische-Datensicherung-mit-DSM6.html]]