From 9fc6ec944bc3e4179e742980df8eb4c67305bac1 Mon Sep 17 00:00:00 2001 From: rcoemans <44841751+rcoemans@users.noreply.github.com> Date: Fri, 21 Aug 2020 09:36:02 +0200 Subject: [PATCH] Update readme.md Fixed some typo's and added Hak5 Forum Thread url. --- .../readme.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/payloads/library/util/Backup-and-Restore-scripts-with-logging-and-notification/readme.md b/payloads/library/util/Backup-and-Restore-scripts-with-logging-and-notification/readme.md index db5e8d0..2b4ff76 100644 --- a/payloads/library/util/Backup-and-Restore-scripts-with-logging-and-notification/readme.md +++ b/payloads/library/util/Backup-and-Restore-scripts-with-logging-and-notification/readme.md @@ -1,21 +1,18 @@ # Backup and Restore shell scripts for Shark Jack ---- - Author: Robert Coemans + Version: 1.0 ## Description ---- - Being tired of having to re-image your Shark Jack and going through the hassle of backing up and restoring the device? These shell scripts will help you to backup and restore all important data on your Shark Jack. The scripts has been created in a modular fashion which allows easy extending the scripts with new functions. The backup script (`backup.sh`) incorporates logic to determine already existing backup folders and create a new (unique) backup folder every time the script is executed. ## backup.sh ---- +This section describes the `backup.sh` shell script. ### Use @@ -68,6 +65,10 @@ Finished | Green very fast blinking followed by solid [LED FINISH] ## restore.sh +This section describes the `restore.sh` shell script. + +### Use + 1. Copy a backup created with `backup.sh` to the Shark Jack with: `scp backup.zip root@172.16.24.1:/destination/folder/` example: `scp 1-20200101-SharkJack-backup.zip root@172.16.24.1:/tmp/` 1. Execute the script with: `bash ./restore.sh /path/to/backup.zip` example: `bash ./restore.sh /tmp/1-20200101-SharkJack-backup.zip` @@ -119,6 +120,4 @@ Finished | Green very fast blinking followed by solid [LED FINISH] ## Discussion ---- - -[Hak5 Forum Thread to be added]() \ No newline at end of file +[Hak5 Forum Thread](https://forums.hak5.org/topic/52883-payload-backup-and-restore-shell-scripts-for-shark-jack/)