01.-Installation.md

@@ -0,0 +1,31 @@
+# installation
+There is nothing to install. Simply clone this repo, copy the script and config files to a suitable location, customize and you're good to go.  Things are easier if you do everything as your root user.  The following examples will assume that is the case.
+
+```bash
+# switch to root user
+sudo -s
+# change to root directory
+cd /root
+# clone the repo and change to that directory
+git clone https://git.asifbacchus.app/asif/seafileBackup.git
+cd seafileBackup
+# ensure the script is executable
+chmod +x seafbackup.sh
+```
+
+## configure everything (*seafbackup.details*)
+All configuration details are stored in the *seafbackup.details* file.  This file does contain sensitive information, so make sure you've set permissions properly to prevent anyone other than *root* from accessing it.
+
+```bash
+chown root:root seafbackup.details
+chmod 600 seafbackup.details
+```
+
+The *seafbackup.details* file is completely annotated so you should have no problems updating parameters.  Assuming default Seafile and borgbackup installations, you shouldn't have to change very much in this file.  At a **minimum**, however, you will have to update the following parameters:
+
+- sqlPass: the password SEAFILE uses to access it's SQL databases
+- borgSSHKey: path to the SSH key file used to access your backup provider
+- borgConnectRepo: the unified *username@url:reponame* used to access your backup provider
+- borgRepoPassphrase: the passphrase used to access your remote borg repo
+
+That's everything you need in terms of setup.  Keep reading for script parameters.