Creation of sole feckback repo.

Last commit: 28-12-2020

Author: lordfeck

README.md

@@ -0,0 +1,43 @@
+# FECKBACK
+A specifically-tailored backup script collection. Works well for my situation. It may also work well for yours!
+
+*Licence* 3BSD. Not GPL because I don't want contributions, but you're free to it!
+
+# Requirements
+* Bash
+* ssh with keys installed
+* tar
+* rsync (optional)
+
+## Configuration
+Run setup.sh.
+
+Edit `~/.config/feckback.conf` to suit your environment.
+
+Edit `~/.config/feckback.exclude` specify any directories for exclusion. 
+
+**Note:** For feckback.exclude, all directories are relative to the root of the backupDir.
+This isn't pattern matched, so you'll have to specify each subdirectory for exclusion manually.
+
+### Configuration - multiple jobs
+It's possible you may want to have more than one backup job on your system.
+
+In that case, run `./setup.sh <newjob>` to install a new job with that name..
+
+Then, edit `~/.config/feckback.d/<newjob>.conf` and `<newjob>.exclude` for your job.
+
+Call `./feckback.sh <jobname>` and the config and exclude files for that job will be read from `feckback.d`. Then the job will begin.
+
+## Usage
+Run `./feckback.sh`. If your hosts are configured correctly, this should work.
+
+## Auxilary Scripts
+### syncnas.sh 
+It's always wise to backup your backups. So, I wrote this script because by Synology NAS couldn't write any data to USB without corrupting the filesystem. 
+
+Syncnas should be run on an external headless device such as a RPi. It will sync the contents of the network drive with portable storage, assuming you've ssh access and rsync running.
+
+It uses nohup to continue running after logout.
+
+## Future plans
+`backupwin.cmd` - An equivalent in Windows Batch (*not* Bash) to backup and copy Windows files.

backuplx.sh

@@ -0,0 +1,70 @@
+#!/bin/bash
+
+# Feckback: Linux Backup Script
+# Author: Lordfeck. Authored: 5/07/2020
+
+function checkFatal {
+    if [ "$?" -ne "0" ]; then
+        echo "Failure when $@"
+        exit 1
+    fi
+}
+
+# Params indicate a jobname, otherwise homedir
+if [ ! -n "$1" ]; then
+    jobname="homedir"
+    fbConf="${HOME}/.config/feckback.conf"
+    excludeText="${HOME}/.config/feckback.exclude"
+else
+    jobname="$1"
+    fbConf="${HOME}/.config/feckback.d/$jobname.conf"
+    excludeText="${HOME}/.config/feckback.d/$jobname.exclude"
+fi
+
+source "$fbConf"
+checkFatal  "reading config file. Exiting."
+
+
+if [ ! -e "$excludeText" ]; then
+    noExclude="1"
+else
+    excludeDirs="$(cat $excludeText | tr '\n' ',')"
+fi
+
+: ${toBackup:?"Fatal: Backup source unset."}
+: ${destPath:?"Fatal: Backup destination path unset."}
+: ${destHost:?"Fatal: Backup destination host unset."}
+: ${localDest:?"Fatal: Local destination path unset."}
+
+backupFile="$( hostname )-${USER}-${jobname}.tar.gz"
+
+# Begin main execution... or interpretation?
+
+echo -e "Feckback begins.\nJobname: $jobname\nSrc: $toBackup."
+echo "Excluding: $excludeDirs"
+echo "Destination Host: $destHost"
+echo "Destination Path: $destPath"
+echo "Backup File: $backupFile"
+echo "Local Destination: $localDest"
+
+echo "Stage 1: Connect to destination and create destination directory, if necessary."
+ssh "$destHost" mkdir -pv "$destPath"
+checkFatal "connecting to dest. host or creating dest. directory"
+
+sleep 1
+echo "Stage 2: Creating the backup in /$localDest/$backupFile"
+mkdir -pv "/$localDest/"
+checkFatal "creating destination directory"
+
+if [ "$noExclude" = 1 ]; then
+    tar -czf "/$localDest/$backupFile" "$toBackup"
+    checkFatal "creating local backup archive"
+else
+    tar -czf "/$localDest/$backupFile" -X "$excludeText" "$toBackup"
+    checkFatal "creating local backup archive"
+fi
+
+sleep 1
+echo "Stage 3: Copy backup to destination host."
+scp "/$localDest/$backupFile" "$destHost:$destPath"
+checkFatal "Copying backup archive to destination."

feckback.conf

@@ -0,0 +1,8 @@
+# Feckback Backup Config
+# Edit then place in ~/.config/feckback.conf
+
+toBackup="$HOME"
+
+destPath="/volume/backups/$(hostname)"
+destHost="netdrive"
+localDest="/var/tmp"

feckback.exclude

@@ -0,0 +1,4 @@
+music
+Downloads
+.cache
+src_notmine

setup.sh

@@ -0,0 +1,53 @@
+#!/bin/bash
+
+# Feckback Setup Script
+# Author: Lordfeck
+
+if [ -n "$1" ]; then
+    jobname="$1"
+fi
+
+readonly confDir="$HOME/.config"
+
+function checkFatal {
+    if [ "$?" -ne "0" ]; then 
+        echo "$@"
+        exit 1
+    fi
+}
+
+function copyConf {
+    local dest="$2"
+    mkdir -pv "$dest"
+
+    if [ -s "$dest/$1.conf" ]; then
+        echo "$1.conf already exists, skipping copy stage."
+    else
+        cp -v "./feckback.conf" "$dest/$1.conf"
+        checkFatal "installing $1.conf"
+    fi
+
+    if [ -s "$dest/$1.exclude" ]; then
+        echo "$1.exclude already exists, skipping copy stage."
+    else
+        cp -v "./feckback.exclude" "$dest/$1.exclude"
+        checkFatal "installing $1.conf"
+    fi
+}
+
+# If a param is supplied, use it as jobname. Else only install default.
+
+if [ -n "$jobname" ]; then
+    echo "Installing new job $jobname to $confDir/feckback.d/$jobname.conf..."
+    mkdir -pv "$confDir/feckback.d"
+    checkFatal "Creating feckback.d"
+
+    echo "First installing default feckback.conf, if not already present."
+    copyConf "feckback" "$confDir"
+    echo "Now installing $jobname"
+    copyConf "$jobname" "$confDir/feckback.d"
+else
+    copyConf "feckback" "$confDir"
+fi
+
+echo "Setup complete."

syncnas.ignore

@@ -0,0 +1 @@
+@*

syncnas.sh

@@ -0,0 +1,4 @@
+#!/bin/sh
+# Feckback: Quick Rsync wrapper to sync NAS and USB Mirror.
+
+nohup rsync --archive --exclude-from syncnas.ignore --bwlimit=5000 host:/volume1/{Archive,Share} /media/usbdisk/nas/ > rsync.log &