annotated sample details file

seafbackup.details

@@ -1,22 +1,80 @@
 #######
 ### Seafile backup script configuration details
 ###
-### this file contains sensitive information, make sure you have protected
+### This file contains sensitive information, make sure you have protected
 ### it by restricting permissions!
-### 'chown root:root ./seafbackup.details'
-### 'chmod 600 ./seafbackup.details'
+### Run the following in the directory where this file is located:
+###     chown root:root ./seafbackup.details
+###     chmod 600 ./seafbackup.details
+###
+### Do NOT include any commands in this file as they WILL be executed!!!
 #######
 
+
 ### SQL server details
 
 ## database names
-# if you are using the defaults, then you don't have to change anything here
+# if you are using the Seafile script installation defaults, then you don't
+# have to change anything here
 ccnetDB_name="ccnet-db"
 seafileDB_name="seafile-db"
 seahubDB_name="seahub-db"
 
 ## database credentials
-# you should be using the same credentials that SEAFILE uses!
+# you should be specifying the same credentials that SEAFILE uses!
+
+# DNS name or ip address of your sql server (mysql -h)
+# this is most likely "localhost" or "127.0.0.1" assuming mysql/mariadb
+# is installed on this machine along with Seafile
 sqlServer="localhost"
+
+# username that Seafile uses to connect to it's SQL databases (mysql -u)
+# you set this up when Seafile was installed, likely via the mysql script
 sqlUser="seafile"
-sqlPass="password"
+
+# password for the above SQL user (mysql -p)
+sqlPass="p@ssW0rd"
+
+
+
+### borg details
+# if you're unsure what to enter here, please consult the repo wiki and/or
+# the borg documentation
+
+# base configuration directory for borg, all borg parameters use this directory
+# as their 'root'.  I recommended setups with this being "/var/borgbackup", the
+# default is "$HOME" or "~$USER" in that order.  If you're unsure, try "$HOME"
+borgBaseDir="/var/borgbackup"
+
+# full path to the SSH key used to connect to your remote backup server
+borgSSHKey="/var/borgbackup/private.key"
+
+# connection string to access the borg repo on your remote backup server
+# this is usually in the form user@servername.tld:repoName/
+borgConnectRepo="jdoe123@borg.server.net:seafileBackup/"
+
+# password to access repo
+# this was set when the repo was initialized and, while optional, is HIGHLY
+# recommended for security
+borgRepoPassphrase="p@ssW0rd"
+
+# OPTIONAL: path to text file containing a list (one per line) of files/
+# directories to include in your backup along with Seafile data
+# see repo wiki for more details
+# leave blank if you only want to backup Seafile related files/directories.
+borgXtraListPath="/root/seafBackup/xtraLocations.borg"
+
+# OPTIONAL: path to file containing files/directories or 'patterns' to be
+# excluded in a BORG RECOGNIZED format
+# see repo wiki for more details or consult borg documentation
+# leave blank for no exclusions.
+borgExcludeListPath="/root/seafBackup/excludeLocations.borg"
+
+# parameters to determine how borg deletes aged backups
+# more details in the repo wiki and/or borg documentation
+# leave blank to skip pruning altogether -- NOT recommended!
+borgPruneSettings="--keep-within=7d --keep-daily=30 --keep-weekly=12 --keep-monthly=-1"
+
+# location of borg instance on your remote backup server
+# this is very often just "borg1"
+borgRemote="borg1"