fix incorrect filename

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) <year> <copyright holders>
+Copyright (c) 2019 Asif Bacchus
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,7 +1,63 @@
-# seafileBackup
+# Backup a bare-metal Seafile installation using borgbackup <!-- omit in toc -->
 
-Backup Seafile DB and data using borgbackup to rsync.net
+Simple POSIX-compliant script to backup a bare-metal Seafile installation using borgbackup to a remote SSH-capable storage system.  I strongly suggest using rsync.net since they are very reliable, fast and even have special pricing for people using borgbackup/attic [(details here)](https://www.rsync.net/products/attic.html).
 
-This readme will be an overiew of the purpose of the repo and BASIC usability
-information.  Detailed usage information will all be presented in the repo's
-wiki.
+**THIS SCRIPT USES BORG [(borgbackup)](https://borgbackup.readthedocs.io/en/stable/) SO PLEASE ENSURE THAT IS INSTALLED CORRECTLY BEFORE TRYING TO USE THIS SCRIPT!**
+
+- [Basic features of this script:](#Basic-features-of-this-script)
+- [Check out the wiki](#Check-out-the-wiki)
+- [Overview](#Overview)
+- [Installation](#Installation)
+- [Running the script](#Running-the-script)
+- [*seafbackup.sh*](#seafbackupsh)
+- [Final thoughts](#Final-thoughts)
+
+## Basic features of this script:
+
+- Backup your entire Seafile program and data directories.
+- Dump Seafile SQL databases to a temporary directory, add them to the backup and then remove the temporary directory.
+- Easily add additional directories/files to the backup by modifying a plain-text file.
+- Easily exclude directories/files from being backed up (i.e. thumbnails) by modifying a plain-text file.
+- Optionally stop Seafile services during the backup and restart them after.
+- Optionally copy a 503 error page to your webserver so users know your server is unavailable due to a backup being performed. The 503 file is removed when the backup is completed.
+- Run 'borg prune' to trim old backups according to your schedule so you don't pay storage fees for super-old or un-needed backups.
+- Create a clear, easy to parse log file so you can keep an eye on warnings/errors, etc.
+- The generated log file can be easily parsed by tools like *logwatch* so you can integrate backup-monitoring with your existing system-monitoring solutions.
+
+## Check out the wiki
+
+This readme is an overview of the script. For detailed instructions on how the script works, what it does and it's various options, please [read the wiki](https://git.asifbacchus.app/asif/seafileBackup/wiki)! I've tried to annotate the files as best I could with many many comments, but seriously, reading the [wiki](https://git.asifbacchus.app/asif/seafileBackup/wiki) if you're stuck is the best approach since I try to go over everything step-by-step.
+
+## Overview
+
+This script has NO mandatory parameters. If no parameters are specified, it will proceed using defaults which normally align with the recommended Seafile installation defaults. That being said, it is impossible to determine defaults for things like your backup-server settings, so please make sure you customize the *seafbackup.details* file with appropriate details!
+
+By default, the script will dump Seafile SQL databases and back them up along with your entire Seafile program and data directories. You can add additional files to be backed up by adding paths to *xtraLocations.borg*.
+
+## Installation
+
+Simply clone this repo to the desired location.  I recommend somewhere simple like *ROOT's home directory* so any sensitive information is restricted to the root user by default.
+
+```bash
+cd /root
+sudo git clone https://git.asifbacchus.app/asif/seafileBackup.git
+```
+
+## Running the script
+
+```bash
+./seafbackup.sh [parameters]
+
+# display abbreviated help
+./seafbackup.sh --help
+```
+
+## *seafbackup.sh*
+
+Please open this file in a text editor and follow the comments to fill in the parameters with the correct values for your environment and your backup server.
+
+## Final thoughts
+
+I hope this makes backing up your Seafile server easier and removes one more mundane administrative task from your schedule :-) If you have any comments, questions, concerns, suggestions for improvements or notice any bugs, please file an issue in this repo!
+
+For more scripts and solutions like this, check out my blog at [My Techie-Thoughts](https://mytechiethoughts.com). Thanks!

etc/logwatch/conf/logfiles/seafbackup.conf

@@ -1,9 +1,9 @@
 # Location of your script's log file, -l parameter
-LogFile = /path/to/your/backup.log
+LogFile = /path/to/your/seafbackup.log
 
 # Format of logrotate archives for your script. Example assumes compression and
 # extension preservation
-Archive = /path/to/your/logfile.ext.?.gz
+Archive = /path/to/your/seafbackup.log.?.gz
 
 # Apply the correct date/time filtering to match the format of the script's log
 # We are using a custom pl script in /etc/logwatch/scripts/shared/ You don't

etc/logwatch/conf/services/seafbackup.conf

@@ -1,5 +1,5 @@
 # Name of the logfile group without any extension
-LogFile = backup
+LogFile = seafbackup
 
 # Heading displayed on Logwatch's report for this service
 Title = "System and Seafile Backup"

etc/logwatch/scripts/services/seafbackup

@@ -34,7 +34,7 @@ if ($detailLevel == 0) {
         elsif ($ThisLine =~ /\-- \[WARNING\] /) {
             $summaryWarn++;
         }
-        elsif ($ThisLine =~ /All processes completed successfully/) {
+        elsif ($ThisLine =~ /All processes completed/) {
             $summarySuccess++;
         }
     }

seafileBackup/seafbackup.sh

@@ -53,32 +53,32 @@ cleanup () {
     if [ "$err503Copied" -eq 1 ]; then
         if ! rm -f "$webroot/$err503File" 2>>"$logFile"; then
             printf "${warn}[%s] -- [WARNING] Could not remove 503 error page." \
-                "[$(stamp)]" >> "$logFile"
+                "$(stamp)" >> "$logFile"
             printf " Web interface will not function until this file is " \
                 >> "$logFile"
             printf "removed --${norm}\n" >> "$logFile"
             warnCount=$((warnCount+1))
         else
             printf "${cyan}[%s] -- [INFO] 503 error page removed --${norm}\n" \
-                "[$(stamp)]" >> "$logFile"
+                "$(stamp)" >> "$logFile"
         fi        
     fi
     if [ "$sqlCopied" -eq 1 ]; then
         if ! rm -rf "$sqlDumpDir" 2>>"$logFile"; then
             printf "${warn}[%s] -- [WARNING]  Could not remove temporary " \
-                "[$(stamp)]" >> "$logFile"
+                "$(stamp)" >> "$logFile"
             printf "SQL dump directory at %s. " "$sqlDumpDir" >> "$logFile"
             printf "Remove manually to free up space.${norm}\n" >> "$logFile"
             warnCount=$((warnCount+1))
         else
             printf "${cyan}[%s] -- [INFO] Temporary SQL dump directory " \
-                "[$(stamp)]" >> "$logFile"
+                "$(stamp)" >> "$logFile"
             printf "removed --${norm}\n" >> "$logFile"
         fi
     fi
     if [ "$offlineBackup" -eq 1 ]; then
         printf "${cyan}[%s] -- [INFO] Starting seafile services --${norm}\n" \
-        "[$(stamp)]" >> "$logFile"
+        "$(stamp)" >> "$logFile"
         seafSvc start
     fi
 }
@@ -86,11 +86,11 @@ cleanup () {
 # call cleanup and then exit with error report
 exitError () {
     printf "${err}[%s] -- [ERROR] %s: %s --${norm}\n" \
-            "[$(stamp)]" "$1" "$2" >> "$logFile"
+            "$(stamp)" "$1" "$2" >> "$logFile"
     cleanup
     # note script completion with error
     printf "${err}[%s] --- %s execution completed with error ---${norm}\n" \
-        "[$(stamp)]" "$scriptName" >> "$logFile"
+        "$(stamp)" "$scriptName" >> "$logFile"
     exit "$1"
 }
 
@@ -165,9 +165,8 @@ scriptHelp () {
 
     printf "More details and examples of script usage can be found in the "
     printf "repo wiki at\n"
-    printf "${yellow}https://git.asifbacchus.app/asif/seafileBackup.git"
+    printf "${yellow}https://git.asifbacchus.app/BacchusGroup/seafileBackup"
     printf "/wiki${norm}.\n"
-
     printf "${cyan}%s${norm}\n\n" "--------------------------------------------------------------------------------"
 }
 
@@ -178,26 +177,26 @@ seafSvc () {
             exitError 100 "Could not start ${seafService}"
         else
             printf "${cyan}[%s] -- [INFO] Started service: %s --${norm}\n" \
-                "[$(stamp)]" "$seafService" >> "$logFile"
+                "$(stamp)" "$seafService" >> "$logFile"
         fi
         if ! systemctl start "${seafHub}" >> "$logFile" 2>&1; then
             exitError 101 "Could not start ${seafHub}"
         else
             printf "${cyan}[%s] -- [INFO] Started service: %s --${norm}\n" \
-                "[$(stamp)]" "$seafHub" >> "$logFile"
+                "$(stamp)" "$seafHub" >> "$logFile"
         fi
     elif [ "$1" = "stop" ]; then
         if ! systemctl stop "${seafHub}" >> "$logFile" 2>&1; then
             exitError 103 "Could not stop ${seafHub}"
         else
             printf "${cyan}[%s] -- [INFO] Stopped service: %s --${norm}\n" \
-                "[$(stamp)]" "$seafService" >> "$logFile"
+                "$(stamp)" "$seafService" >> "$logFile"
         fi
         if ! systemctl stop "${seafService}" >> "$logFile" 2>&1; then
             exitError 102 "Could not stop ${seafService}"
         else
             printf "${cyan}[%s] -- [INFO] Stopped service: %s --${norm}\n" \
-                "[$(stamp)]" "$seafHub" >> "$logFile"
+                "$(stamp)" "$seafHub" >> "$logFile"
         fi
     fi        
 }
@@ -210,11 +209,11 @@ stamp () {
 # same as exitError but for signal captures
 trapExit () {
     printf "${err}[%s] -- [ERROR] 99: Caught signal --${norm}\n" \
-            "[$(stamp)]" >> "$logFile"
+            "$(stamp)" >> "$logFile"
     cleanup
     # note script completion with error
     printf "${err}[%s] --- %s execution was terminated via signal ---${norm}\n" \
-        "[$(stamp)]" "$scriptName" >> "$logFile"
+        "$(stamp)" "$scriptName" >> "$logFile"
     exit 99
 }
 
@@ -230,7 +229,7 @@ scriptPath="$( CDPATH='' cd -- "$( dirname -- "$0" )" && pwd -P )"
 scriptName="$( basename "$0" )"
 logFile="$scriptPath/${scriptName%.*}.log"
 warnCount=0
-configDetails="$scriptPath/seafbackup.details"
+configDetails="$scriptPath/${scriptName%.*}.details"
 err503Copied=0
 sqlCopied=0
 includeXtra=0
@@ -388,6 +387,11 @@ done
 
 
 ### check pre-requisites and default values
+# check if running as root, otherwise exit
+if [ $( id -u ) -ne 0 ]; then
+    printf "\n${err}ERROR: script MUST be run as ROOT${norm}\n\n"
+    exit 2
+fi
 # does the details file exist?
 if [ ! -f "$configDetails" ]; then
     badParam dne "(--details default)" "$configDetails"
@@ -427,25 +431,25 @@ fi
 
 ### start logging
 printf "${magenta}[%s] --- Start %s execution ---${norm}\n" \
-    "[$(stamp)]" "$scriptName" >> "$logFile"
+    "$(stamp)" "$scriptName" >> "$logFile"
 printf "${cyan}[%s] -- [INFO] Log located at ${yellow}%s${cyan} --${norm}\n" \
-    "[$(stamp)]" "$logFile" >> "$logFile"
+    "$(stamp)" "$logFile" >> "$logFile"
 
 
 ### 503 functionality
 if [ "$use503" -eq 1 ]; then
     printf "${cyan}[%s] -- [INFO] Copying 503 error page to " \
-        "[$(stamp)]" >> "$logFile"
+        "$(stamp)" >> "$logFile"
     printf "webroot -- ${norm}\n" >> "$logFile"
     if ! \cp --force "${err503Path}" "${webroot}/${err503File}" 2>> "$logFile"
         then
         printf "${warn}[%s] -- [WARNING] Failed to copy 503 error page. " \
-            "[$(stamp)]" >> "$logFile"
+            "$(stamp)" >> "$logFile"
         printf "Web users will NOT be notified --${norm}\n" >> "$logFile"
         warnCount=$((warnCount+1))
     else
         printf "${ok}[%s] -- [SUCCESS] 503 error page copied --${norm}\n" \
-            "[$(stamp)]" >> "$logFile"
+            "$(stamp)" >> "$logFile"
         # set cleanup flag
         err503Copied=1
     fi
@@ -455,7 +459,7 @@ fi
 ### stop seahub and seafile service if offline backup requested
 if [ "$offlineBackup" -eq 1 ]; then
     printf "${cyan}[%s] -- [INFO] Stopping seafile services --${norm}\n" \
-        "[$(stamp)]" >> "$logFile"
+        "$(stamp)" >> "$logFile"
     seafSvc stop
 fi
 
@@ -473,7 +477,7 @@ case "${configDetails}" in
         ;;
 esac
 printf "${cyan}[%s] -- [INFO] ${yellow}%s${cyan} imported --${norm}\n" \
-    "[$(stamp)]" "$configDetails" >> "$logFile"
+    "$(stamp)" "$configDetails" >> "$logFile"
 
 
 ### dump sql databases
@@ -499,7 +503,7 @@ fi
 
 ## create tmp directory and generate dumpfile names
 printf "${cyan}[%s] -- [INFO] Dumping SQL databases --${norm}\n" \
-    "[$(stamp)]" >> "$logFile"
+    "$(stamp)" >> "$logFile"
 # create temporary directory to dump files before borg backup
 if ! sqlDumpDir=$( mktemp -d 2>>"$logFile" ); then
     exitError 111 "Could not create temporary directory to dump SQL files"
@@ -507,7 +511,7 @@ fi
 # set cleanup flag
 sqlCopied=1
 printf "${cyan}[%s] -- [INFO] SQL dump files will be temporarily stored in:" \
-    "[$(stamp)]" >> "$logFile"
+    "$(stamp)" >> "$logFile"
 printf "\n${yellow}%s/${cyan} --${norm}\n" "$sqlDumpDir" >> "$logFile"
 # create unique names for database dump files
 sqlDump_ccnet="backup-$(date +%Y%m%d_%H%M%S)_${ccnetDB_name}.sql"
@@ -532,18 +536,18 @@ if ! mysqldump -h"${sqlServer}" -u"${sqlUser}" -p"${sqlPass}" \
     --opt "${seahubDB_name}" > "${sqlDumpDir}/${sqlDump_seahub}" 2>> "$logFile"; then
         exitError 117 "Could not dump ${seahubDB_name} database"
 fi
-printf "${ok}[%s] -- [SUCCESS] SQL databases dumped successfully --${norm}\n" \
-    "[$(stamp)]" >> "$logFile"
+printf "${ok}[%s] -- [SUCCESS] Dumped SQL databases --${norm}\n" \
+    "$(stamp)" >> "$logFile"
 
 
 ### pre-backup tasks completed -- move to borg tasks
 printf "${ok}[%s] -- [SUCCESS] Pre-backup tasks completed --${norm}\n" \
-    "[$(stamp)]" >> "$logFile"
+    "$(stamp)" >> "$logFile"
 
 
 ### Run borg variable checks
 printf "${cyan}[%s] -- [INFO] Verifying supplied borg details --${norm}\n" \
-    "[$(stamp)]" >> "$logFile"
+    "$(stamp)" >> "$logFile"
 
 ## verify borg base directory
 if [ -z "${borgBaseDir}" ]; then
@@ -635,7 +639,7 @@ if [ ! -d "${borgBaseDir}/tmp" ]; then
         exitError 132 "Unable to create borg ${borgBaseDir}/tmp directory"
     else
         printf "${cyan}[%s] -- [INFO] Created ${yellow}%s/tmp " \
-            "[$(stamp)]" "${borgBaseDir}" >> "$logFile"
+            "$(stamp)" "${borgBaseDir}" >> "$logFile"
         printf "${cyan}--${norm}\n" >> "$logFile"
     fi
 fi
@@ -668,18 +672,18 @@ fi
 
 # execute borg
 printf "${cyan}[%s] -- [INFO] Executing borg backup operation --${norm}\n" \
-    "[$(stamp)]" >> "$logFile"
+    "$(stamp)" >> "$logFile"
 ${borgCMD} 2>> "$logFile"
 borgResult="$?"
 
 ## check borg exit status
 if [ "$borgResult" -eq 0 ]; then
     printf "${ok}[%s] -- [SUCCESS] Borg backup completed " \
-        "[$(stamp)]" >> "$logFile"
+        "$(stamp)" >> "$logFile"
     printf "successfully --${norm}\n" >> "$logFile"
 elif [ "$borgResult" -eq 1 ]; then
     printf "${warn}[%s] -- [WARNING] Borg completed with warnings. " \
-        "[$(stamp)]" >> "$logFile"
+        "$(stamp)" >> "$logFile"
     printf "Review this logfile for details --${norm}\n" >> "$logFile"
     warnCount=$((warnCount+1))
 elif [ "$borgResult" -ge 2 ]; then
@@ -688,7 +692,7 @@ elif [ "$borgResult" -ge 2 ]; then
     exitError 138 "$err_1 $err_2"
 else
     printf "${warn}[%s] -- [WARNING] Borg exited with unknown return code. " \
-        "[$(stamp)]" >> "$logFile"
+        "$(stamp)" >> "$logFile"
     printf "Review this logfile for details --${norm}\n" >> "$logFile"
     warnCount=$((warnCount+1))
 fi
@@ -697,13 +701,13 @@ fi
 ### execute borg prune if paramters are provided, otherwise skip with a warning
 if [ -n "${borgPruneSettings}" ]; then
     printf "${cyan}[%s] -- [INFO] Executing borg prune operation --${norm}\n" \
-        "[$(stamp)]" >> "$logFile"
+        "$(stamp)" >> "$logFile"
     borg prune --show-rc -v ${borgPruneParams} ${borgPruneSettings} \
         2>> "$logFile"
     borgPruneResult="$?"
 else
     printf "${warn}[%s] -- [WARNING] No prune parameters provided. " \
-        "[$(stamp)]" >> "$logFile"
+        "$(stamp)" >> "$logFile"
     printf "Your archive will continue growing with each backup --${norm}\n" \
         >> "$logFile"
     warnCount=$((warnCount+1))
@@ -713,10 +717,10 @@ fi
 if [ -n "${borgPruneResult}" ]; then
     if [ "${borgPruneResult}" -eq 0 ]; then
         printf "${ok}[%s] -- [SUCCESS] Borg prune completed --${norm}\n" \
-            "[$(stamp)]" >> "$logFile"
+            "$(stamp)" >> "$logFile"
     elif [ "$borgPruneResult" -eq 1 ]; then
         printf "${warn}[%s] -- [WARNING] Borg prune completed with warnings. " \
-        "[$(stamp)]" >> "$logFile"
+        "$(stamp)" >> "$logFile"
         printf "Review this logfile for details --${norm}\n" >> "$logFile"
         warnCount=$((warnCount+1))
     elif [ "$borgPruneResult" -ge 2 ]; then
@@ -725,7 +729,7 @@ if [ -n "${borgPruneResult}" ]; then
         exitError 139 "$err_1 $err_2"
     else
         printf "${warn}[%s] -- [WARNING] Borg prune exited with an unknown " \
-            "[$(stamp)]" >> "$logFile"
+            "$(stamp)" >> "$logFile"
         printf "return code. Review this logfile for details --${norm}\n" \
             >> "$logFile"
         warnCount=$((warnCount+1))
@@ -737,17 +741,16 @@ fi
 
 # note successful completion of borg commands
 printf "${ok}[%s] -- [SUCCESS] Backup operations completed --${norm}\n" \
-    "[$(stamp)]" >> "$logFile"
+    "$(stamp)" >> "$logFile"
 
 # cleanup
 cleanup
 
 # note complete success, tally warnings and exit
-printf "${ok}[%s] -- [SUCCESS] All processes completed successfully --" \
-    "${norm}\n" \
-    "[$(stamp)]" >> "$logFile"
+printf "${ok}[%s] -- [SUCCESS] All processes completed --${norm}\n" \
+    "$(stamp)" >> "$logFile"
 printf "${magenta}[%s] --- %s execution completed ---${norm}\n" \
-    "[$(stamp)]" "$scriptName" >> "$logFile"
+    "$(stamp)" "$scriptName" >> "$logFile"
 if [ "$warnCount" -gt 0 ]; then
     printf "${warn}%s warnings issued!${norm}\n" "${warnCount}" >> "$logFile"
 else