Changelog

[nextcloud-backup-restore.git] / NextcloudBackup.sh

diff --git a/NextcloudBackup.sh b/NextcloudBackup.sh
index ea817e49cabd6141720bfadf2bad66d44d730cc4..d1b1ed2a403866ff2172e619a7746eee8c30446c 100644 (file)
--- a/NextcloudBackup.sh
+++ b/NextcloudBackup.sh
@@ -2,9 +2,14 @@
 
 #
 # Bash script for creating backups of Nextcloud.
 
 #
 # Bash script for creating backups of Nextcloud.

-# Usage: ./NextcloudBackup.sh
-# 
-# The script is based on an installation of Nextcloud using nginx and MariaDB, see https://decatec.de/home-server/nextcloud-auf-ubuntu-server-mit-nginx-mariadb-php-lets-encrypt-redis-und-fail2ban/
+#
+# Version 1.1.0
+#
+# Usage:
+#      - With backup directory specified in the script:  ./NextcloudBackup.sh
+#      - With backup directory specified by parameter: ./NextcloudBackup.sh <BackupDirectory> (e.g. ./NextcloudBackup.sh /media/hdd/nextcloud_backup)
+#
+# The script is based on an installation of Nextcloud using nginx and MariaDB, see https://decatec.de/home-server/nextcloud-auf-ubuntu-server-18-04-lts-mit-nginx-mariadb-php-lets-encrypt-redis-und-fail2ban/

 #
 
 #
 #
 
 #


@@ -14,36 +19,96 @@
 #
 
 # Variables
 #
 
 # Variables

+backupMainDir=$1
+
+if [ -z "$backupMainDir" ]; then
+       # TODO: The directory where you store the Nextcloud backups (when not specified by args)
+    backupMainDir='/media/hdd/nextcloud_backup'
+fi
+

 currentDate=$(date +"%Y%m%d_%H%M%S")
 currentDate=$(date +"%Y%m%d_%H%M%S")

-# TODO: The directory where you store the Nextcloud backups
-backupMainDir="/mnt/Share/NextcloudBackups/"
-# The actual directory of the current backup - this is is subdirectory of the main directory above with a timestamp
+
+# The actual directory of the current backup - this is a subdirectory of the main directory above with a timestamp

 backupdir="${backupMainDir}/${currentDate}/"
 backupdir="${backupMainDir}/${currentDate}/"

+

 # TODO: The directory of your Nextcloud installation (this is a directory under your web root)
 # TODO: The directory of your Nextcloud installation (this is a directory under your web root)

-nextcloudFileDir="/var/www/nextcloud"
+nextcloudFileDir='/var/www/nextcloud'
+

 # TODO: The directory of your Nextcloud data directory (outside the Nextcloud file directory)
 # If your data directory is located under Nextcloud's file directory (somewhere in the web root), the data directory should not be a separate part of the backup
 # TODO: The directory of your Nextcloud data directory (outside the Nextcloud file directory)
 # If your data directory is located under Nextcloud's file directory (somewhere in the web root), the data directory should not be a separate part of the backup

-nextcloudDataDir="/var/nextcloud_data"
+nextcloudDataDir='/var/nextcloud_data'
+
+# TODO: The directory of your Nextcloud's local external storage.
+# Uncomment if you use local external storage.
+#nextcloudLocalExternalDataDir='/var/nextcloud_external_data'
+
+# TODO: The service name of the web server. Used to start/stop web server (e.g. 'systemctl start <webserverServiceName>')
+webserverServiceName='nginx'
+
+# TODO: Your web server user
+webserverUser='www-data'
+
+# TODO: The name of the database system (ome of: mysql, mariadb, postgresql)
+databaseSystem='mariadb'
+

 # TODO: Your Nextcloud database name
 # TODO: Your Nextcloud database name

-nextcloudDatabase="nextcloud_db"
+nextcloudDatabase='nextcloud_db'
+

 # TODO: Your Nextcloud database user
 # TODO: Your Nextcloud database user

-dbUser="nextcloud_db_user"
+dbUser='nextcloud_db_user'
+

 # TODO: The password of the Nextcloud database user
 # TODO: The password of the Nextcloud database user

-dbPassword="mYpAsSw0rd"
-# TODO: Your webserver user
-webserverUser="www-data"
+dbPassword='mYpAsSw0rd'
+

 # TODO: The maximum number of backups to keep (when set to 0, all backups are kept)
 maxNrOfBackups=0
 
 # TODO: The maximum number of backups to keep (when set to 0, all backups are kept)
 maxNrOfBackups=0
 

+# TODO: Ignore updater's backup directory in the data directory to safe space
+# Set to true to ignore the backup directory
+ignoreUpdaterBackups=false
+

 # File names for backup files
 # If you prefer other file names, you'll also have to change the NextcloudRestore.sh script.
 # File names for backup files
 # If you prefer other file names, you'll also have to change the NextcloudRestore.sh script.

-fileNameBackupFileDir="nextcloud-filedir.tar.gz"
-fileNameBackupDataDir="nextcloud-datadir.tar.gz"
-fileNameBackupDb="nextcloud-db.sql"
+fileNameBackupFileDir='nextcloud-filedir.tar.gz'
+fileNameBackupDataDir='nextcloud-datadir.tar.gz'
+
+# TODO: Uncomment if you use local external storage
+#fileNameBackupExternalDataDir='nextcloud-external-datadir.tar.gz'
+
+fileNameBackupDb='nextcloud-db.sql'

 
 # Function for error messages
 errorecho() { cat <<< "$@" 1>&2; }
 
 
 # Function for error messages
 errorecho() { cat <<< "$@" 1>&2; }
 

+function DisableMaintenanceMode() {
+       echo "Switching off maintenance mode..."
+       sudo -u "${webserverUser}" php ${nextcloudFileDir}/occ maintenance:mode --off
+       echo "Done"
+       echo
+}
+
+# Capture CTRL+C
+trap CtrlC INT
+
+function CtrlC() {
+       read -p "Backup cancelled. Keep maintenance mode? [y/n] " -n 1 -r
+       echo
+
+       if ! [[ $REPLY =~ ^[Yy]$ ]]
+       then
+               DisableMaintenanceMode
+       else
+               echo "Maintenance mode still enabled."
+       fi
+
+       exit 1
+}
+
+#
+# Print information
+#
+echo "Backup directory: ${backupMainDir}"
+

 #
 # Check for root
 #
 #
 # Check for root
 #


@@ -68,75 +133,106 @@ fi
 # Set maintenance mode
 #
 echo "Set maintenance mode for Nextcloud..."
 # Set maintenance mode
 #
 echo "Set maintenance mode for Nextcloud..."

-cd "${nextcloudFileDir}"
-sudo -u "${webserverUser}" php occ maintenance:mode --on
-cd ~
+sudo -u "${webserverUser}" php ${nextcloudFileDir}/occ maintenance:mode --on

 echo "Done"
 echo
 
 #
 echo "Done"
 echo
 
 #

-# Stop webserver
+# Stop web server

 #
 #

-echo "Stopping nginx..."
-service nginx stop
+echo "Stopping web server..."
+systemctl stop "${webserverServiceName}"

 echo "Done"
 echo
 
 #
 echo "Done"
 echo
 
 #

-# Backup file and data directory
+# Backup file directory

 #
 echo "Creating backup of Nextcloud file directory..."
 tar -cpzf "${backupdir}/${fileNameBackupFileDir}" -C "${nextcloudFileDir}" .
 echo "Done"
 echo
 
 #
 echo "Creating backup of Nextcloud file directory..."
 tar -cpzf "${backupdir}/${fileNameBackupFileDir}" -C "${nextcloudFileDir}" .
 echo "Done"
 echo
 

+#
+# Backup data directory
+#

 echo "Creating backup of Nextcloud data directory..."
 echo "Creating backup of Nextcloud data directory..."

-tar -cpzf "${backupdir}/${fileNameBackupDataDir}"  -C "${nextcloudDataDir}" .
+
+if [ "$ignoreUpdaterBackups" = true ] ; then
+        echo "Ignoring updater backup directory"
+        tar -cpzf "${backupdir}/${fileNameBackupDataDir}"  --exclude="updater-*/backups/*" -C "${nextcloudDataDir}" .
+else
+        tar -cpzf "${backupdir}/${fileNameBackupDataDir}"  -C "${nextcloudDataDir}" .
+fi
+

 echo "Done"
 echo
 
 echo "Done"
 echo
 

+# Backup local external storage.
+# Uncomment if you use local external storage
+#echo "Creating backup of Nextcloud local external storage directory..."
+#tar -cpzf "${backupdir}/${fileNameBackupExternalDataDir}"  -C "${nextcloudLocalExternalDataDir}" .
+#echo "Done"
+#echo
+

 #
 # Backup DB
 #
 #
 # Backup DB
 #

-echo "Backup Nextcloud database..."
-mysqldump --single-transaction -h localhost -u "${dbUser}" -p"${dbPassword}" "${nextcloudDatabase}" > "${backupdir}/${fileNameBackupDb}"
-echo "Done"
-echo
+if [ "${databaseSystem,,}" = "mysql" ] || [ "${databaseSystem,,}" = "mariadb" ]; then
+       echo "Backup Nextcloud database (MySQL/MariaDB)..."
+
+       if ! [ -x "$(command -v mysqldump)" ]; then
+               errorecho "ERROR: MySQL/MariaDB not installed (command mysqldump not found)."
+               errorecho "ERROR: No backup of database possible!"
+       else
+               mysqldump --single-transaction -h localhost -u "${dbUser}" -p"${dbPassword}" "${nextcloudDatabase}" > "${backupdir}/${fileNameBackupDb}"
+       fi
+
+       echo "Done"
+       echo
+elif [ "${databaseSystem,,}" = "postgresql" ]; then
+       echo "Backup Nextcloud database (PostgreSQL)..."
+
+       if ! [ -x "$(command -v pg_dump)" ]; then
+               errorecho "ERROR:PostgreSQL not installed (command pg_dump not found)."
+               errorecho "ERROR: No backup of database possible!"
+       else
+               PGPASSWORD="${dbPassword}" pg_dump "${nextcloudDatabase}" -h localhost -U "${dbUser}" -f "${backupdir}/${fileNameBackupDb}"
+       fi
+       
+       echo "Done"
+       echo
+fi

 
 #
 
 #

-# Start webserver
+# Start web server

 #
 #

-echo "Starting webserver..."
-service nginx start
+echo "Starting web server..."
+systemctl start "${webserverServiceName}"

 echo "Done"
 echo
 
 #
 # Disable maintenance mode
 #
 echo "Done"
 echo
 
 #
 # Disable maintenance mode
 #

-echo "Switching off maintenance mode..."
-cd "${nextcloudFileDir}"
-sudo -u "${webserverUser}" php occ maintenance:mode --off
-cd ~
-echo "Done"
-echo
+DisableMaintenanceMode

 
 #
 # Delete old backups
 #
 if [ ${maxNrOfBackups} != 0 ]
 
 #
 # Delete old backups
 #
 if [ ${maxNrOfBackups} != 0 ]

-then   
+then

        nrOfBackups=$(ls -l ${backupMainDir} | grep -c ^d)
        nrOfBackups=$(ls -l ${backupMainDir} | grep -c ^d)

-       
-       if [  ${maxNrOfBackups} > ${nrOfBackups} ]
+
+       if [[ ${nrOfBackups} > ${maxNrOfBackups} ]]

        then
                echo "Removing old backups..."
        then
                echo "Removing old backups..."

-               ls -t ${backupMainDir} | tail -$(( nrOfBackups - maxNrOfBackups )) | while read dirToRemove; do
-               echo "${dirToRemove}"
-               rm -r ${backupMainDir}/${dirToRemove}
-               echo "Done"
-               echo
-    done
+               ls -t ${backupMainDir} | tail -$(( nrOfBackups - maxNrOfBackups )) | while read -r dirToRemove; do
+                       echo "${dirToRemove}"
+                       rm -r "${backupMainDir}/${dirToRemove:?}"
+                       echo "Done"
+                       echo
+               done

        fi
 fi
 
        fi
 fi