fixing typo in clean commands

adding clean command
adding systemd files
2021-09-29 20:49:24 -07:00 · 2021-09-29 20:31:40 -07:00 · 2021-09-29 20:27:25 -07:00 · 2021-07-19 14:45:50 -07:00 · 2021-07-16 06:48:48 -07:00 · 2021-07-16 06:46:59 -07:00
4 changed files with 252 additions and 143 deletions
--- a/backup.sh
+++ b/backup.sh
@ -8,167 +8,219 @@ cat <<'EOF'
 | |_) | (_| | (__|   <| |_| | |_) |\__ \ | | |
 |_.__/ \__,_|\___|_|\_\\__,_| .__(_)___/_| |_|
                            |_|               
+
+A wrapper around restic to help control configuration.
 EOF
-# Copyright (c) 2020 Andrew Davidson
+# Copyright (c) 2021 Andrew Davidson
 }

 print_help () {
    echo -e """
    Usage:
-    backup.sh 'command' 'destination'
+    backup.sh 'command' 'destination' 'input'
    
    Supported Commands:
    backup        - initiate a backup of the home folder to the destination
-    list          - list backups on the destination
+    check         - check repository for consistency
+    clean         - clean (prune) extra files from the repository
+    find          - find a file by a string in the repository (requires input)
+                    ex: backup.sh find s3 critical_file.doc
+    help          - print this help
+    init          - intiialize a new backup repository
+    mount         - mount repository as a local file system
+                    ex: backup.sh mount s3 /mnt/restic
    prune         - prune old backups on the destination
+    restore       - restores file from repository (requires input)
+                    ex: backup.sh restore s3 latest --target=/tmp/restore --include=/home/user/Documents
+    snapshots     - list backups on the destination
+    stats         - print statistics about the backup repository
+    unlock        - unlock a locked repository - use for stale locks
+
+    Required Configuration: 
+    \$XDG_CONFIG_HOME/backup.sh/\$DESTINATION/\$DESTINATION.repo 
+    - Define the repository path in this file
+
+    \$XDG_CONFIG_HOME/backup.sh/\$DESTINATION/\$DESTINATION.pwd
+    - Define the repository password in this file
+
+    \$XDG_CONFIG_HOME/backup.sh/\$DESTINATION/\$DESTINATION.paths
+    - list of paths to be backed up
+
+    \$XDG_CONFIG_HOME/backup.sh/\$DESTINATION/\$DESTINATION.exclude
+    - list of paths to be excluded
+
+    \$XDG_CONFIG_HOME/backup.sh/\$DESTINATION/\$DESTINATION.keys
+    - OPTIONAL: bash exports of required keys for s3/b2 backups
+
+    \$XDG_DATA_HOME/backup.sh/\$DESTINATION/\$DESTINATION.log
+    - empty file for logging
+
    
-    Supported destinations:
-    royal         - local borg/SFTP backup to Royal
-    wasabi        - remote restic backup to Wasabi
+
    """
 }

+print_and_log () {
+    /usr/bin/ts "%Y-%m-%dT%H:%M:%S" | /usr/bin/tee -a $BACKUP_LOG
+}

 set -o errexit
 set -o pipefail

 ACTION=$1
 DESTINATION=$2
+INPUT="${@:3}"
+
+if [[ -z $DESTINATION && $ACTION == "help" ]]; then
+    print_logo
+    print_help
+elif [[ -z $DESTINATION ]]; then
+    echo "Destination must not be blank"
+    print_help
+else
+
+    if [[ -f "$XDG_CONFIG_HOME/backup.sh/$DESTINATION/$DESTINATION.repo" ]]; then
+        BACKUP_REPOSITORY=$(cat $XDG_CONFIG_HOME/backup.sh/$DESTINATION/$DESTINATION.repo)
+    else 
+        echo "Must configure repository at $XDG_CONFIG_HOME/backup.sh/$DESTINATION"
+        print_help
+        exit 2
+    fi
+    if [[ -f "$XDG_CONFIG_HOME/backup.sh/$DESTINATION/$DESTINATION.keys" ]]; then
+        source "$XDG_CONFIG_HOME/backup.sh/$DESTINATION/$DESTINATION.keys"
+    fi
+    BACKUP_PASSWORD="$XDG_CONFIG_HOME/backup.sh/$DESTINATION/$DESTINATION.pwd"
+    BACKUP_EXCLUDE_FILE="$XDG_CONFIG_HOME/backup.sh/$DESTINATION/$DESTINATION.exclude"
+    BACKUP_PATHS="$XDG_CONFIG_HOME/backup.sh/$DESTINATION/$DESTINATION.paths"
+    BACKUP_LOG="$XDG_DATA_HOME/backup.sh/$DESTINATION/$DESTINATION.log"
+
+    if [[ -f "/sys/class/power_supply/AC/online" ]]; then
+        AC_POWER=$(cat /sys/class/power_supply/AC/online)
+    else
+        AC_POWER=1
+    fi


-###
-# ~/.env should contain these variables:
-#
-#    ## Borg Royal Environment
-#    export BORG_PASSPHRASE=
-#
-#    ## Restic Wasabi Environment
-#    export AWS_ACCESS_KEY_ID=
-#    export AWS_SECRET_ACCESS_KEY=
-#    export RESTIC_REPOSITORY=s3:s3.wasabisys.com/backup
-#    export RESTIC_PASSWORD=
-###
-source ~/.env 
-
-###
-# For the borg backup to work properly, the backup host should be 
-# configured in `$HOME/.ssh/config`:
-#     Host backup
-#        Hostname backup.hostname
-#        Port 22
-#        User backupuser
-###
-
-
-case $DESTINATION in
-    "royal")
-        case $ACTION in
-            "backup")
-                if on_ac_power; then
-                    borg create  \
-                        --exclude $HOME/backups \
-                        --exclude $HOME/tmp \
-                        --exclude $HOME/Downloads \
-                        --exclude $HOME/Desktop \
-                        --exclude $HOME/.cache \
-                        --exclude $HOME/.local/gnome-boxes \
-                        backup:/bkup/$(hostname)::$(date '+%s') \
-                        $HOME
-                else
-                    echo "Not plugged in, canceling backup."
-                fi
-                ;;
-            "check")
-                borg check backup:/bkup/$(hostname)
-                ;;
-            "list")
-                borg list backup:/bkup/$(hostname)
-                ;;
-            "prune")
+    case $ACTION in
+        "backup")
+            if [[ $AC_POWER == 1 ]]; then
+                echo "backing up to $DESTINATION." | print_and_log
+                /usr/bin/restic \
+                    -r "$BACKUP_REPOSITORY" \
+                    -p "$BACKUP_PASSWORD" \
+                    --cleanup-cache \
+                    --exclude-caches \
+                    --exclude-file="$BACKUP_EXCLUDE_FILE" \
+                    --files-from="$BACKUP_PATHS" \
+                    --verbose \
+                    backup | print_and_log 
+            else
+                echo "not plugged in, canceling backup."
+            fi
+            ;;
+        "check")
+            echo "Checking backup repository at $DESTINATION" | print_and_log
+            /usr/bin/restic \
+                -r "$BACKUP_REPOSITORY" \
+                -p "$BACKUP_PASSWORD" \
+                --verbose \
+                check | print_and_log
+            ;;
+        "find")
+            echo "Searching for $INPUT at $DESTINATION" 
+            /usr/bin/restic \
+                -r "$BACKUP_REPOSITORY" \
+                -p "$BACKUP_PASSWORD" \
+                --verbose \
+                find $INPUT 
+            ;;
+        "help")
+            print_logo
+            print_help
+            ;;
+        "init")
+            echo "Initializing backup repository at $DESTINATION" | print_and_log
+            /usr/bin/restic \
+                -r "$BACKUP_REPOSITORY" \
+                -p "$BACKUP_PASSWORD" \
+                --verbose \
+                init | print_and_log
+            ;;
+        "mount")
+            echo "Mounting backup repository $DESTINATION at $INPUT" | print_and_log
+            /usr/bin/restic \
+                -r "$BACKUP_REPOSITORY" \
+                -p "$BACKUP_PASSWORD" \
+                --verbose \
+                mount "$INPUT" | print_and_log
+            ;;
+        "restore")
+            echo "Restoring from $DESTINATION, $INPUT" | print_and_log
+            /usr/bin/restic \
+                -r "$BACKUP_REPOSITORY" \
+                -p "$BACKUP_PASSWORD" \
+                --verbose \
+                restore $INPUT | print_and_log 
+            ;;
+        "snapshots")
+            echo "Listing snapshots on $DESTINATION"
+            /usr/bin/restic \
+                -r "$BACKUP_REPOSITORY" \
+                -p "$BACKUP_PASSWORD" \
+                --verbose \
+                snapshots 
+            ;;
+        "stats")
+            echo "Printing statistics for $DESTINATION"
+            /usr/bin/restic \
+                -r "$BACKUP_REPOSITORY" \
+                -p "$BACKUP_PASSWORD" \
+                --verbose \
+                stats 
+            ;;
+        "prune")
+            if [[ $AC_POWER == 1 ]]; then
                echo """
-                Pruning $DESTINATION backups...
+                Pruning backups at $DESTINATION ...
                Keeping:
                - 24 hourly backups
                - 90 daily backups
                - 12 monthly backups
                - 5  yearly backups
-                """
-                borg prune \
-                    --stats --list \
-                    --keep-hourly 24 \
-                    --keep-daily 90 \
-                    --keep-monthly 12 \
-                    --keep-yearly 5 \
-                    backup:/bkup/$(hostname)
-                ;;
-            "help")
-                print_logo
-                print_help
-                ;;
-            *)
-                echo "Action: $ACTION not recognized."
-                print_help
-                ;;
-        esac
-        ;;
-    "wasabi")
-        case $ACTION in
-            "backup")
-                if on_ac_power; then
-                    restic backup \
-                        --quiet \
-                        --exclude $HOME/backups \
-                        --exclude $HOME/tmp \
-                        --exclude $HOME/Desktop \
-                        --exclude $HOME/Downloads \
-                        --exclude $HOME/.cache \
-                        --exclude $HOME/.cargo \
-                        --exclude $HOME/.local/share/gnome-boxes \
-                        $HOME
-                else
-                    echo "Not plugged in, canceling backup."
-                fi
-                ;;
-            "check")
-                restic check
-                ;;
-            "list")
-                restic snapshots
-                ;;
-            "prune")
-                echo """
-                Pruning $DESTINATION backups...
-                Keeping:
-                - 90 daily backups
-                - 12 monthly backups
-                - 5  yearly backups
-                """
-
-                restic forget --prune \
-                    --keep-hourly 4 \
-                    --keep-daily 90 \
-                    --keep-monthly 12 \
-                    --keep-yearly 5
-
-                ;;
-            "help")
-                print_logo
-                print_help
-                ;;
-            *)
-                echo "Action: $ACTION not recognized."
-                print_help
-                ;;
-        esac
-        ;;
-    *)
-        if [[ -z $DESTINATION && $ACTION == "help" ]]; then
-            print_logo
+                """ | print_and_log
+                /usr/bin/restic \
+                    -r "$BACKUP_REPOSITORY" \
+                    -p "$BACKUP_PASSWORD" \
+                    --verbose \
+                    --prune \
+                    --keep-hourly=24 \
+                    --keep-daily=90 \
+                    --keep-monthly=12 \
+                    --keep-yearly=5 \
+                    forget | print_and_log
+            else
+                echo "Not plugged in, canceling prune."
+            fi
+            ;;
+        "unlock")
+            echo "Unlocking backup repository at $DESTINATION" | print_and_log
+            /usr/bin/restic \
+                -r "$BACKUP_REPOSITORY" \
+                -p "$BACKUP_PASSWORD" \
+                --verbose \
+                unlock | print_and_log
+            ;;
+        "clean")
+            echo "Cleaning repository at $DESTINATION" | print_and_log
+            /usr/bin/restic \
+                -r "$BACKUP_REPOSITORY" \
+                -p "$BACKUP_PASSWORD" \
+                --verbose \
+                prune | print_and_log
+            ;;
+        *)
+            echo "Action: $ACTION not recognized."
            print_help
-        else
-            echo "Destination: $DESTINATION not recognized."
-            print_help
-        fi
-        ;;
-esac
-
+            ;;
+    esac
+fi
--- a/backup.sh.service
+++ b/backup.sh.service
@ -0,0 +1,11 @@
+[Unit]
+Description=Run backup.sh as configured
+
+[Service]
+Environment=XDG_CONFIG_HOME=/home/FIXME/.config
+Environment=XDG_DATA_HOME=/home/FIXME/.local/share
+Type=simple
+ExecStart=/home/FIXME/.local/share/backup.sh/backup.sh backup FIXME
+
+[Install]
+WantedBy=default.target
--- a/backup.sh.timer
+++ b/backup.sh.timer
@ -0,0 +1,17 @@
+[Unit]
+Description=Run backup.sh at specified interval
+RefuseManualStart=no        # Allow manual starts
+RefuseManualStop=no         # Allow manual stops
+
+[Timer]
+# Execute job if it missed a run due to machine being off
+Persistent=true
+# Run 15 minutes after boot for the first time
+OnBootSec=900
+# Run every 24 hours thereafter
+OnUnitInactiveSec=86400
+# File describing job to execute
+Unit=backup.sh.service
+
+[Install]
+WantedBy=timers.target
--- a/readme.md
+++ b/readme.md
@ -1,6 +1,4 @@
 ```bash
-#!/usr/bin/env bash
-
 print_logo () {
 cat <<'EOF'
 _                _                     _     
@ -9,23 +7,54 @@ cat <<'EOF'
 | |_) | (_| | (__|   <| |_| | |_) |\__ \ | | |
 |_.__/ \__,_|\___|_|\_\\__,_| .__(_)___/_| |_|
                            |_|               
+
+A wrapper around restic to help control configuration.
 EOF
-# Copyright (c) 2020 Andrew Davidson
+# Copyright (c) 2021 Andrew Davidson
 }

 print_help () {
    echo -e """
    Usage:
-    backup.sh 'command' 'destination'
+    backup.sh 'command' 'destination' 'input'
    
    Supported Commands:
    backup        - initiate a backup of the home folder to the destination
-    list          - list backups on the destination
+    check         - check repository for consistency
+    find          - find a file by a string in the repository (requires input)
+                    ex: backup.sh find s3 critical_file.doc
+    help          - print this help
+    init          - intiialize a new backup repository
+    mount         - mount repository as a local file system
+                    ex: backup.sh mount s3 /mnt/restic
    prune         - prune old backups on the destination
+    restore       - restores file from repository (requires input)
+                    ex: backup.sh restore s3 latest --target=/tmp/restore --include=/home/user/Documents
+    snapshots     - list backups on the destination
+    stats         - print statistics about the backup repository
+    unlock        - unlock a locked repository - use for stale locks
+
+    Required Configuration: 
+    \$XDG_CONFIG_HOME/backup.sh/\$DESTINATION/\$DESTINATION.repo 
+    - Define the repository path in this file
+
+    \$XDG_CONFIG_HOME/backup.sh/\$DESTINATION/\$DESTINATION.pwd
+    - Define the repository password in this file
+
+    \$XDG_CONFIG_HOME/backup.sh/\$DESTINATION/\$DESTINATION.paths
+    - list of paths to be backed up
+
+    \$XDG_CONFIG_HOME/backup.sh/\$DESTINATION/\$DESTINATION.exclude
+    - list of paths to be excluded
+
+    \$XDG_CONFIG_HOME/backup.sh/\$DESTINATION/\$DESTINATION.keys
+    - OPTIONAL: bash exports of required keys for s3/b2 backups
+
+    \$XDG_DATA_HOME/backup.sh/\$DESTINATION/\$DESTINATION.log
+    - empty file for logging
+
    
-    Supported destinations:
-    royal         - local borg/SFTP backup to Royal
-    wasabi        - remote restic backup to Wasabi
+
    """
 }
 ```
Author	SHA1	Message	Date
Andrew Davidson	e972c90fe5	fixing typo in clean commands	2021-09-29 20:49:24 -07:00
Andrew Davidson	d039bb6ed9	adding clean command	2021-09-29 20:31:40 -07:00
Andrew Davidson	de3e59db98	adding systemd files	2021-09-29 20:27:25 -07:00
Andrew Davidson	6266e3977a	Adding mount command, fixes #7	2021-07-19 14:45:50 -07:00
Andrew Davidson	3328c83133	Catching up the readme	2021-07-16 06:48:48 -07:00
Andrew Davidson	c8f66d3976	Adding restore functionality, fixes #6	2021-07-16 06:46:59 -07:00
Andrew Davidson	4db272d957	Added searching of repository with find command, closes #5	2021-07-16 06:39:21 -07:00
Andrew Davidson	6848637b8e	finishing fix for #4 , closed.	2021-07-16 06:12:25 -07:00
Andrew Davidson	9be12f79b9	updating readme	2021-07-15 21:11:57 -07:00
Andrew Davidson	00a45d80a5	moving to be a wrapper around restic specifically	2021-07-15 21:09:57 -07:00