Update readme.md

Fixed some typo's and added Hak5 Forum Thread url.
pull/24/head
rcoemans 2020-08-21 09:36:02 +02:00 committed by GitHub
parent 8633b49886
commit 9fc6ec944b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 8 deletions

View File

@ -1,21 +1,18 @@
# Backup and Restore shell scripts for Shark Jack # Backup and Restore shell scripts for Shark Jack
---
Author: Robert Coemans Author: Robert Coemans
Version: 1.0 Version: 1.0
## Description ## 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. 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. 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 ## backup.sh
--- This section describes the `backup.sh` shell script.
### Use ### Use
@ -68,6 +65,10 @@ Finished | Green very fast blinking followed by solid [LED FINISH]
## restore.sh ## 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. 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` 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 ## Discussion
--- [Hak5 Forum Thread](https://forums.hak5.org/topic/52883-payload-backup-and-restore-shell-scripts-for-shark-jack/)
[Hak5 Forum Thread to be added]()