Readme

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

diff --git a/NextcloudRestore.sh b/NextcloudRestore.sh
index 08fc504cc94331754ff73106f91fdc2d46133ba1..90fa3360af9a3e746557f596e17a5bba1c91004e 100644 (file)
--- a/NextcloudRestore.sh
+++ b/NextcloudRestore.sh
@@ -3,13 +3,20 @@
 #
 # Bash script for restoring backups of Nextcloud.
 #
 #
 # Bash script for restoring backups of Nextcloud.
 #

-# Version 1.1.0
+# Version 2.3.2
+#
+# 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)
 #
 #
 # 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/

 #
 
 #
 #
 
 #


@@ -18,19 +25,29 @@
 # All entries which need to be customized are tagged with "TODO".
 #
 
 # All entries which need to be customized are tagged with "TODO".
 #
 

+# Make sure the script exits when any command fails
+set -Eeuo pipefail
+

 # Variables
 # 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)
 
 if [ -z "$backupMainDir" ]; then
        # TODO: The directory where you store the Nextcloud backups (when not specified by args)

-    backupMainDir='/media/hdd/nextcloud_backup'
+       backupMainDir='/media/hdd/nextcloud_backup'

 fi
 
 echo "Backup directory: $backupMainDir"
 
 currentRestoreDir="${backupMainDir}/${restore}"
 
 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'
 
 # TODO: The directory of your Nextcloud installation (this is a directory under your web root)
 nextcloudFileDir='/var/www/nextcloud'
 


@@ -48,7 +65,7 @@ webserverServiceName='nginx'
 # TODO: Your web server user
 webserverUser='www-data'
 
 # TODO: Your web server user
 webserverUser='www-data'
 

-# TODO: The name of the database system (ome of: mysql, mariadb, postgresql)
+# TODO: The name of the database system (one of: mysql, mariadb, postgresql)

 databaseSystem='mariadb'
 
 # TODO: Your Nextcloud database name
 databaseSystem='mariadb'
 
 # TODO: Your Nextcloud database name


@@ -60,13 +77,28 @@ dbUser='nextcloud_db_user'
 # TODO: The password of the Nextcloud database user
 dbPassword='mYpAsSw0rd'
 
 # TODO: The password of the Nextcloud database user
 dbPassword='mYpAsSw0rd'
 

+# 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.
 # 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'
+
+if [ "$useCompression" = true ] ; then
+    fileNameBackupFileDir='nextcloud-filedir.tar.gz'
+    fileNameBackupDataDir='nextcloud-datadir.tar.gz'
+fi
+
+fileNameBackupExternalDataDir=''

 
 

-# TODO: Uncomment if you use local external storage
-#fileNameBackupExternalDataDir='nextcloud-external-datadir.tar.gz'
+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'
 


@@ -111,7 +143,7 @@ if [ "${databaseSystem,,}" = "mysql" ] || [ "${databaseSystem,,}" = "mariadb" ];
         errorecho "Cancel restore"
         exit 1
     fi
         errorecho "Cancel restore"
         exit 1
     fi

-elif [ "${databaseSystem,,}" = "postgresql" ]; then
+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!"
     if ! [ -x "$(command -v psql)" ]; then
                errorecho "ERROR: PostgreSQL not installed (command psql not found)."
                errorecho "ERROR: No restore of database possible!"


@@ -123,7 +155,7 @@ fi
 #
 # Set maintenance mode
 #
 #
 # Set maintenance mode
 #

-echo "Set maintenance mode for Nextcloud..."
+echo "$(date +"%H:%M:%S"): Set maintenance mode for Nextcloud..."

 sudo -u "${webserverUser}" php ${nextcloudFileDir}/occ maintenance:mode --on
 echo "Done"
 echo
 sudo -u "${webserverUser}" php ${nextcloudFileDir}/occ maintenance:mode --on
 echo "Done"
 echo


@@ -131,7 +163,7 @@ echo
 #
 # Stop web server
 #
 #
 # Stop web server
 #

-echo "Stopping web server..."
+echo "$(date +"%H:%M:%S"): Stopping web server..."

 systemctl stop "${webserverServiceName}"
 echo "Done"
 echo
 systemctl stop "${webserverServiceName}"
 echo "Done"
 echo


@@ -141,54 +173,74 @@ echo
 #
 
 # File directory
 #
 
 # 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
 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
 rm -r "${nextcloudDataDir}"
 mkdir -p "${nextcloudDataDir}"
 echo "Done"
 echo
 
 # Local external storage

-# TODO: 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
 
 #
 # 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 "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
 echo "Done"
 echo
 
 # Local external storage

-# TODO: 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
 #
 
 #
 # Restore database
 #

-echo "Dropping old Nextcloud DB..."
+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}"
 
 if [ "${databaseSystem,,}" = "mysql" ] || [ "${databaseSystem,,}" = "mariadb" ]; then
     mysql -h localhost -u "${dbUser}" -p"${dbPassword}" -e "DROP DATABASE ${nextcloudDatabase}"


@@ -199,25 +251,28 @@ fi
 echo "Done"
 echo
 
 echo "Done"
 echo
 

-echo "Creating new DB for Nextcloud..."
+echo "$(date +"%H:%M:%S"): Creating new DB for Nextcloud..."

 
 if [ "${databaseSystem,,}" = "mysql" ] || [ "${databaseSystem,,}" = "mariadb" ]; then
 
 if [ "${databaseSystem,,}" = "mysql" ] || [ "${databaseSystem,,}" = "mariadb" ]; then

-    # 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"
-    # TODO: 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}"
-elif [ "${databaseSystem,,}" = "postgresql" ]; then
-    sudo -u postgres psql -c "CREATE DATABASE ${nextcloudDatabase} WITH OWNER ${dbUser} TEMPLATE template0 ENCODING \"UTF8\";"
+    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
 
 echo "Done"
 echo
 
 fi
 
 echo "Done"
 echo
 

-echo "Restoring backup DB..."
+echo "$(date +"%H:%M:%S"): Restoring backup DB..."

 
 if [ "${databaseSystem,,}" = "mysql" ] || [ "${databaseSystem,,}" = "mariadb" ]; then
        mysql -h localhost -u "${dbUser}" -p"${dbPassword}" "${nextcloudDatabase}" < "${currentRestoreDir}/${fileNameBackupDb}"
 
 if [ "${databaseSystem,,}" = "mysql" ] || [ "${databaseSystem,,}" = "mariadb" ]; then
        mysql -h localhost -u "${dbUser}" -p"${dbPassword}" "${nextcloudDatabase}" < "${currentRestoreDir}/${fileNameBackupDb}"

-elif [ "${databaseSystem,,}" = "postgresql" ]; then
+elif [ "${databaseSystem,,}" = "postgresql" ] || [ "${databaseSystem,,}" = "pgsql" ]; then

        sudo -u postgres psql "${nextcloudDatabase}" < "${currentRestoreDir}/${fileNameBackupDb}"
 fi
 
        sudo -u postgres psql "${nextcloudDatabase}" < "${currentRestoreDir}/${fileNameBackupDb}"
 fi
 


@@ -227,7 +282,7 @@ echo
 #
 # Start web server
 #
 #
 # Start web server
 #

-echo "Starting web server..."
+echo "$(date +"%H:%M:%S"): Starting web server..."

 systemctl start "${webserverServiceName}"
 echo "Done"
 echo
 systemctl start "${webserverServiceName}"
 echo "Done"
 echo


@@ -235,18 +290,21 @@ echo
 #
 # Set directory permissions
 #
 #
 # 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}"
 chown -R "${webserverUser}":"${webserverUser}" "${nextcloudFileDir}"
 chown -R "${webserverUser}":"${webserverUser}" "${nextcloudDataDir}"

-# TODO: 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
 
 #
 echo "Done"
 echo
 
 #

-# Update the system data-fingerprint (see https://docs.nextcloud.com/server/16/admin_manual/configuration_server/occ_command.html#maintenance-commands-label)
+# Update the system data-fingerprint (see https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/occ_command.html#maintenance-commands-label)

 #
 #

-echo "Updating the system data-fingerprint..."
+echo "$(date +"%H:%M:%S"): Updating the system data-fingerprint..."

 sudo -u "${webserverUser}" php ${nextcloudFileDir}/occ maintenance:data-fingerprint
 echo "Done"
 echo
 sudo -u "${webserverUser}" php ${nextcloudFileDir}/occ maintenance:data-fingerprint
 echo "Done"
 echo


@@ -254,11 +312,11 @@ echo
 #
 # Disbale maintenance mode
 #
 #
 # Disbale maintenance mode
 #

-echo "Switching off maintenance mode..."
+echo "$(date +"%H:%M:%S"): Switching off maintenance mode..."

 sudo -u "${webserverUser}" php ${nextcloudFileDir}/occ maintenance:mode --off
 echo "Done"
 echo
 
 echo
 echo "DONE!"
 sudo -u "${webserverUser}" php ${nextcloudFileDir}/occ maintenance:mode --off
 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