X-Git-Url: https://git.p6c8.net/nextcloud-backup-restore.git/blobdiff_plain/3ba26cfe9a8d11e874cd2a9c2e042fc9bc4dd2aa..HEAD:/NextcloudRestore.sh?ds=sidebyside diff --git a/NextcloudRestore.sh b/NextcloudRestore.sh index 51581be..5febde7 100644 --- a/NextcloudRestore.sh +++ b/NextcloudRestore.sh @@ -3,13 +3,20 @@ # # Bash script for restoring backups of Nextcloud. # -# Version 2.1.0 +# 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 (e.g. ./NextcloudRestore.sh 20170910_132703) # - With backup directory specified by parameter: ./NextcloudRestore.sh (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,21 +25,28 @@ # 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='/media/hdd/nextcloud_backup' + 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 -currentRestoreDir="${backupMainDir}/${restore}" +# 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' @@ -63,6 +77,9 @@ dbUser='nextcloud_db_user' # 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. fileNameBackupFileDir='nextcloud-filedir.tar' @@ -73,12 +90,15 @@ if [ "$useCompression" = true ] ; then fileNameBackupDataDir='nextcloud-datadir.tar.gz' fi -# TODO: Uncomment if you use local external storage -#fileNameBackupExternalDataDir='nextcloud-external-datadir.tar' -# -#if [ "$useCompression" = true ] ; then -# fileNameBackupExternalDataDir='nextcloud-external-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' @@ -135,7 +155,7 @@ fi # # 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 @@ -143,7 +163,7 @@ echo # # Stop web server # -echo "Stopping web server..." +echo "$(date +"%H:%M:%S"): Stopping web server..." systemctl stop "${webserverServiceName}" echo "Done" echo @@ -153,36 +173,37 @@ echo # # 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 -# 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 -echo "Restoring Nextcloud file directory..." +echo "$(date +"%H:%M:%S"): Restoring Nextcloud file directory..." if [ "$useCompression" = true ] ; then - tar -xmpzf "${currentRestoreDir}/${fileNameBackupFileDir}" -C "${nextcloudFileDir}" + `$compressionCommand "${currentRestoreDir}/${fileNameBackupFileDir}" -C "${nextcloudFileDir}"` else tar -xmpf "${currentRestoreDir}/${fileNameBackupFileDir}" -C "${nextcloudFileDir}" fi @@ -191,10 +212,10 @@ echo "Done" echo # Data directory -echo "Restoring Nextcloud data directory..." +echo "$(date +"%H:%M:%S"): Restoring Nextcloud data directory..." if [ "$useCompression" = true ] ; then - tar -xmpzf "${currentRestoreDir}/${fileNameBackupDataDir}" -C "${nextcloudDataDir}" + `$compressionCommand "${currentRestoreDir}/${fileNameBackupDataDir}" -C "${nextcloudDataDir}"` else tar -xmpf "${currentRestoreDir}/${fileNameBackupDataDir}" -C "${nextcloudDataDir}" fi @@ -203,22 +224,23 @@ echo "Done" echo # Local external storage -# TODO: Uncomment if you use local external storage -#echo "Restoring Nextcloud data directory..." -# -#if [ "$useCompression" = true ] ; then -# tar -xmpzf "${currentRestoreDir}/${fileNameBackupExternalDataDir}" -C "${nextcloudLocalExternalDataDir}" -#else -# tar -xmpf "${currentRestoreDir}/${fileNameBackupExternalDataDir}" -C "${nextcloudLocalExternalDataDir}" -#fi -# -#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..." +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}" @@ -229,21 +251,24 @@ fi 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 - # 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}" + 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 \"UTF8\";" + sudo -u postgres psql -c "CREATE DATABASE ${nextcloudDatabase} WITH OWNER ${dbUser} TEMPLATE template0 ENCODING \"UNICODE\";" 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}" @@ -257,7 +282,7 @@ echo # # Start web server # -echo "Starting web server..." +echo "$(date +"%H:%M:%S"): Starting web server..." systemctl start "${webserverServiceName}" echo "Done" echo @@ -265,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}" -# 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 # -# Update the system data-fingerprint (see https://docs.nextcloud.com/server/latest/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