X-Git-Url: https://git.p6c8.net/nextcloud-backup-restore.git/blobdiff_plain/81d53268ae45a780cf6f83a6c745a111a9dd4e96..refs/heads/master:/NextcloudRestore.sh

diff --git a/NextcloudRestore.sh b/NextcloudRestore.sh
index 3903e8a..5febde7 100644
--- a/NextcloudRestore.sh
+++ b/NextcloudRestore.sh
@@ -2,11 +2,21 @@
 
 #
 # Bash script for restoring backups of Nextcloud.
-# Usage: 
+#
+# Version 2.3.3
+#
+# Requirements:
+#	- pigz (https://zlib.net/pigz/) for using backup compression. If not available, you can use another compression algorithm (e.g. gzip)
+#
+# Supported database systems:
+# 	- MySQL/MariaDB
+# 	- PostgreSQL
+#
+# Usage:
 #   - With backup directory specified in the script: ./NextcloudRestore.sh <BackupName> (e.g. ./NextcloudRestore.sh 20170910_132703)
 #   - With backup directory specified by parameter: ./NextcloudRestore.sh <BackupName> <BackupDirectory> (e.g. ./NextcloudRestore.sh 20170910_132703 /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/
+# The script is based on an installation of Nextcloud using nginx and MariaDB, see https://decatec.de/home-server/nextcloud-auf-ubuntu-server-20-04-lts-mit-nginx-mariadb-php-lets-encrypt-redis-und-fail2ban/
 #
 
 #
@@ -15,65 +25,93 @@
 # All entries which need to be customized are tagged with "TODO".
 #
 
+# Make sure the script exits when any command fails
+set -Eeuo pipefail
+
 # Variables
-restore=$1
-backupMainDir=$2
+restore=${1:-} 
+backupMainDir=${2:-} 
 
 if [ -z "$backupMainDir" ]; then
 	# TODO: The directory where you store the Nextcloud backups (when not specified by args)
-    backupMainDir="/mnt/hdd1/nextcloudb_ackups"
+	backupMainDir='/media/hdd/nextcloud_backup'
 fi
 
 echo "Backup directory: $backupMainDir"
 
 currentRestoreDir="${backupMainDir}/${restore}"
 
+# TODO: Set this to true, if the backup was created with compression enabled, otherwiese false.
+useCompression=true
+
+# TOOD: The bare tar command for using compression.
+# Use 'tar -xmpzf' if you want to use gzip compression.
+compressionCommand="tar -I pigz -xmpf"
+
 # 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 restored separately
-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"
+#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"
+webserverServiceName='nginx'
+
+# TODO: Your web server user
+webserverUser='www-data'
+
+# TODO: The name of the database system (one of: mysql, mariadb, postgresql)
+databaseSystem='mariadb'
 
 # TODO: Your Nextcloud database name
-nextcloudDatabase="nextcloud_db"
+nextcloudDatabase='nextcloud_db'
 
 # TODO: Your Nextcloud database user
-dbUser="nextcloud_db_user"
+dbUser='nextcloud_db_user'
 
 # TODO: The password of the Nextcloud database user
-dbPassword="mYpAsSw0rd"
+dbPassword='mYpAsSw0rd'
 
-# TODO: Your web server user
-webserverUser="www-data"
+# TODO: Uncomment this and set to true if the database from the backup DOES NOT use UTF8 with multibyte support (e.g. for emoijs in filenames)
+#dbNoMultibyte=true
 
 # File names for backup files
 # If you prefer other file names, you'll also have to change the NextcloudBackup.sh script.
-fileNameBackupFileDir="nextcloud-filedir.tar.gz"
-fileNameBackupDataDir="nextcloud-datadir.tar.gz"
+fileNameBackupFileDir='nextcloud-filedir.tar'
+fileNameBackupDataDir='nextcloud-datadir.tar'
 
-# TOOD: Uncomment if you use local external storage
-#fileNameBackupExternalDataDir="nextcloud-external-datadir.tar.gz"
+if [ "$useCompression" = true ] ; then
+    fileNameBackupFileDir='nextcloud-filedir.tar.gz'
+    fileNameBackupDataDir='nextcloud-datadir.tar.gz'
+fi
+
+fileNameBackupExternalDataDir=''
+
+if [ ! -z "${nextcloudLocalExternalDataDir+x}" ] ; then
+    fileNameBackupExternalDataDir='nextcloud-external-datadir.tar'
+
+    if [ "$useCompression" = true ] ; then
+        fileNameBackupExternalDataDir='nextcloud-external-datadir.tar.gz'
+    fi
+fi
 
-fileNameBackupDb="nextcloud-db.sql"
+fileNameBackupDb='nextcloud-db.sql'
 
 # Function for error messages
 errorecho() { cat <<< "$@" 1>&2; }
 
 #
-# Check if parameter given
+# Check if parameter(s) given
 #
-if [ $# != "1" ]
+if [ $# != "1" ] && [ $# != "2" ]
 then
-    errorecho "ERROR: No backup name to restore given!"
-	errorecho "Usage: NextcloudRestore.sh 'BackupDate'"
+    errorecho "ERROR: No backup name to restore given, or wrong number of parameters!"
+    errorecho "Usage: NextcloudRestore.sh 'BackupDate' ['BackupDirectory']"
     exit 1
 fi
 
@@ -91,114 +129,160 @@ fi
 #
 if [ ! -d "${currentRestoreDir}" ]
 then
-	 errorecho "ERROR: Backup ${restore} not found!"
+	errorecho "ERROR: Backup ${restore} not found!"
     exit 1
 fi
 
+#
+# Check if the commands for restoring the database are available
+#
+if [ "${databaseSystem,,}" = "mysql" ] || [ "${databaseSystem,,}" = "mariadb" ]; then
+    if ! [ -x "$(command -v mysql)" ]; then
+		errorecho "ERROR: MySQL/MariaDB not installed (command mysql not found)."
+		errorecho "ERROR: No restore of database possible!"
+        errorecho "Cancel restore"
+        exit 1
+    fi
+elif [ "${databaseSystem,,}" = "postgresql" ] || [ "${databaseSystem,,}" = "pgsql" ]; then
+    if ! [ -x "$(command -v psql)" ]; then
+		errorecho "ERROR: PostgreSQL not installed (command psql not found)."
+		errorecho "ERROR: No restore of database possible!"
+        errorecho "Cancel restore"
+        exit 1
+	fi
+fi
+
 #
 # Set maintenance mode
 #
-echo "Set maintenance mode for Nextcloud..."
-cd "${nextcloudFileDir}"
-sudo -u "${webserverUser}" php occ maintenance:mode --on
-cd ~
+echo "$(date +"%H:%M:%S"): Set maintenance mode for Nextcloud..."
+sudo -u "${webserverUser}" php ${nextcloudFileDir}/occ maintenance:mode --on
 echo "Done"
 echo
 
 #
 # Stop web server
 #
-echo "Stopping web server..."
+echo "$(date +"%H:%M:%S"): Stopping web server..."
 systemctl stop "${webserverServiceName}"
 echo "Done"
 echo
 
 #
-# Delete old Nextcloud direcories
+# Delete old Nextcloud directories
 #
 
 # File directory
-echo "Deleting old Nextcloud file directory..."
+echo "$(date +"%H:%M:%S"): Deleting old Nextcloud file directory..."
 rm -r "${nextcloudFileDir}"
 mkdir -p "${nextcloudFileDir}"
 echo "Done"
 echo
 
 # Data directory
-echo "Deleting old Nextcloud data directory..."
+echo "$(date +"%H:%M:%S"): Deleting old Nextcloud data directory..."
 rm -r "${nextcloudDataDir}"
 mkdir -p "${nextcloudDataDir}"
 echo "Done"
 echo
 
 # Local external storage
-# TOOD: Uncomment if you use local external storage
-#echo "Deleting old Nextcloud local external storage directory..."
-#rm -r "${nextcloudLocalExternalDataDir}"
-#mkdir -p "${nextcloudLocalExternalDataDir}"
-#echo "Done"
-#echo
+if [ ! -z "${nextcloudLocalExternalDataDir+x}" ] ; then
+    echo "Deleting old Nextcloud local external storage directory..."
+    rm -r "${nextcloudLocalExternalDataDir}"
+    mkdir -p "${nextcloudLocalExternalDataDir}"
+    echo "Done"
+    echo
+fi
 
 #
 # Restore file and data directory
 #
 
 # File directory
-echo "Restoring Nextcloud file directory..."
-tar -xmpzf "${currentRestoreDir}/${fileNameBackupFileDir}" -C "${nextcloudFileDir}"
+echo "$(date +"%H:%M:%S"): Restoring Nextcloud file directory..."
+
+if [ "$useCompression" = true ] ; then
+    `$compressionCommand "${currentRestoreDir}/${fileNameBackupFileDir}" -C "${nextcloudFileDir}"`
+else
+    tar -xmpf "${currentRestoreDir}/${fileNameBackupFileDir}" -C "${nextcloudFileDir}"
+fi
+
 echo "Done"
 echo
 
 # Data directory
-echo "Restoring Nextcloud data directory..."
-tar -xmpzf "${currentRestoreDir}/${fileNameBackupDataDir}" -C "${nextcloudDataDir}"
+echo "$(date +"%H:%M:%S"): Restoring Nextcloud data directory..."
+
+if [ "$useCompression" = true ] ; then
+    `$compressionCommand "${currentRestoreDir}/${fileNameBackupDataDir}" -C "${nextcloudDataDir}"`
+else
+    tar -xmpf "${currentRestoreDir}/${fileNameBackupDataDir}" -C "${nextcloudDataDir}"
+fi
+
 echo "Done"
 echo
 
 # Local external storage
-# TOOD: Uncomment if you use local external storage
-#echo "Restoring Nextcloud data directory..."
-#tar -xmpzf "${currentRestoreDir}/${fileNameBackupExternalDataDir}" -C "${nextcloudLocalExternalDataDir}"
-#echo "Done"
-#echo
+if [ ! -z "${nextcloudLocalExternalDataDir+x}" ] ; then
+    echo "$(date +"%H:%M:%S"): Restoring Nextcloud local external storage directory..."
+    
+    if [ "$useCompression" = true ] ; then
+        `$compressionCommand "${currentRestoreDir}/${fileNameBackupExternalDataDir}" -C "${nextcloudLocalExternalDataDir}"`
+    else
+        tar -xmpf "${currentRestoreDir}/${fileNameBackupExternalDataDir}" -C "${nextcloudLocalExternalDataDir}"
+    fi
+    
+    echo "Done"
+    echo
+fi
 
 #
 # Restore database
 #
-echo "Dropping old Nextcloud DB..."
-# MySQL/MariaDB:
-mysql -h localhost -u "${dbUser}" -p"${dbPassword}" -e "DROP DATABASE ${nextcloudDatabase}"
+echo "$(date +"%H:%M:%S"): Dropping old Nextcloud DB..."
+
+if [ "${databaseSystem,,}" = "mysql" ] || [ "${databaseSystem,,}" = "mariadb" ]; then
+    mysql -h localhost -u "${dbUser}" -p"${dbPassword}" -e "DROP DATABASE ${nextcloudDatabase}"
+elif [ "${databaseSystem,,}" = "postgresql" ]; then
+	sudo -u postgres psql -c "DROP DATABASE ${nextcloudDatabase};"
+fi
 
-# PostgreSQL (uncomment if you are using PostgreSQL as Nextcloud database)
-#sudo -u postgres psql -c "DROP DATABASE ${nextcloudDatabase};"
 echo "Done"
 echo
 
-echo "Creating new DB for Nextcloud..."
-# MySQL/MariaDB:
-# Use this if the databse from the backup uses UTF8 with multibyte support (e.g. for emoijs in filenames):
-mysql -h localhost -u "${dbUser}" -p"${dbPassword}" -e "CREATE DATABASE ${nextcloudDatabase} CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci"
-# Use this if the database from the backup DOES NOT use UTF8 with multibyte support (e.g. for emoijs in filenames):
-#mysql -h localhost -u "${dbUser}" -p"${dbPassword}" -e "CREATE DATABASE ${nextcloudDatabase}"
+echo "$(date +"%H:%M:%S"): Creating new DB for Nextcloud..."
+
+if [ "${databaseSystem,,}" = "mysql" ] || [ "${databaseSystem,,}" = "mariadb" ]; then
+    if [ ! -z "${dbNoMultibyte+x}" ] && [ "${dbNoMultibyte}" = true ] ; then
+        # Database from the backup DOES NOT use UTF8 with multibyte support (e.g. for emoijs in filenames)
+        mysql -h localhost -u "${dbUser}" -p"${dbPassword}" -e "CREATE DATABASE ${nextcloudDatabase}"
+    else
+        # Database from the backup uses UTF8 with multibyte support (e.g. for emoijs in filenames)
+        mysql -h localhost -u "${dbUser}" -p"${dbPassword}" -e "CREATE DATABASE ${nextcloudDatabase} CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci"
+    fi
+elif [ "${databaseSystem,,}" = "postgresql" ] || [ "${databaseSystem,,}" = "pgsql" ]; then
+    sudo -u postgres psql -c "CREATE DATABASE ${nextcloudDatabase} WITH OWNER ${dbUser} TEMPLATE template0 ENCODING \"UNICODE\";"
+fi
 
-# PostgreSQL (uncomment if you are using PostgreSQL as Nextcloud database)
-#sudo -u postgres psql -c "CREATE DATABASE ${nextcloudDatabase} WITH OWNER ${dbUser} TEMPLATE template0 ENCODING \"UTF8\";"
 echo "Done"
 echo
 
-echo "Restoring backup DB..."
-# MySQL/MariaDB:
-mysql -h localhost -u "${dbUser}" -p"${dbPassword}" "${nextcloudDatabase}" < "${currentRestoreDir}/${fileNameBackupDb}"
+echo "$(date +"%H:%M:%S"): Restoring backup DB..."
+
+if [ "${databaseSystem,,}" = "mysql" ] || [ "${databaseSystem,,}" = "mariadb" ]; then
+	mysql -h localhost -u "${dbUser}" -p"${dbPassword}" "${nextcloudDatabase}" < "${currentRestoreDir}/${fileNameBackupDb}"
+elif [ "${databaseSystem,,}" = "postgresql" ] || [ "${databaseSystem,,}" = "pgsql" ]; then
+	sudo -u postgres psql "${nextcloudDatabase}" < "${currentRestoreDir}/${fileNameBackupDb}"
+fi
 
-# PostgreSQL (uncomment if you are using PostgreSQL as Nextcloud database)
-#sudo -u postgres psql "${nextcloudDatabase}" < "${currentRestoreDir}/${fileNameBackupDb}"
 echo "Done"
 echo
 
 #
 # Start web server
 #
-echo "Starting web server..."
+echo "$(date +"%H:%M:%S"): Starting web server..."
 systemctl start "${webserverServiceName}"
 echo "Done"
 echo
@@ -206,30 +290,33 @@ echo
 #
 # Set directory permissions
 #
-echo "Setting directory permissions..."
+echo "$(date +"%H:%M:%S"): Setting directory permissions..."
 chown -R "${webserverUser}":"${webserverUser}" "${nextcloudFileDir}"
 chown -R "${webserverUser}":"${webserverUser}" "${nextcloudDataDir}"
-# TOOD: Uncomment if you use local external storage
-#chown -R "${webserverUser}":"${webserverUser}" "${nextcloudLocalExternalDataDir}"
+
+if [ ! -z "${nextcloudLocalExternalDataDir+x}" ] ; then
+    chown -R "${webserverUser}":"${webserverUser}" "${nextcloudLocalExternalDataDir}"
+fi
+
 echo "Done"
 echo
 
 #
-# Update the system data-fingerprint (see https://docs.nextcloud.com/server/15/admin_manual/configuration_server/occ_command.html#maintenance-commands-label)
+# Disbale maintenance mode
 #
-echo "Updating the system data-fingerprint..."
-sudo -u "${webserverUser}" php ${nextcloudFileDir}/occ maintenance:data-fingerprint
+echo "$(date +"%H:%M:%S"): Switching off maintenance mode..."
+sudo -u "${webserverUser}" php ${nextcloudFileDir}/occ maintenance:mode --off
 echo "Done"
 echo
 
 #
-# Disbale maintenance mode
+# Update the system data-fingerprint (see https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/occ_command.html#maintenance-commands-label)
 #
-echo "Switching off maintenance mode..."
-sudo -u "${webserverUser}" php ${nextcloudFileDir}/occ maintenance:mode --off
+echo "$(date +"%H:%M:%S"): Updating the system data-fingerprint..."
+sudo -u "${webserverUser}" php ${nextcloudFileDir}/occ maintenance:data-fingerprint
 echo "Done"
 echo
 
 echo
 echo "DONE!"
-echo "Backup ${restore} successfully restored."
\ No newline at end of file
+echo "$(date +"%H:%M:%S"): Backup ${restore} successfully restored."
\ No newline at end of file