#
# Bash script for restoring backups of Nextcloud.
-# Usage:
+#
+# Version 1.0.0
+#
+# 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)
#
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: 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 (ome 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"
-
-# TODO: Your web server user
-webserverUser="www-data"
+dbPassword='mYpAsSw0rd'
# 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.gz'
+fileNameBackupDataDir='nextcloud-datadir.tar.gz'
-# TOOD: Uncomment if you use local external storage
-#fileNameBackupExternalDataDir="nextcloud-external-datadir.tar.gz"
+# TODO: Uncomment if you use local external storage
+#fileNameBackupExternalDataDir='nextcloud-external-datadir.tar.gz'
-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
#
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" ]; 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 ~
+sudo -u "${webserverUser}" php ${nextcloudFileDir}/occ maintenance:mode --on
echo "Done"
echo
echo
#
-# Delete old Nextcloud direcories
+# Delete old Nextcloud directories
#
# File directory
echo
# Local external storage
-# TOOD: Uncomment if you use 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
# Local external storage
-# TOOD: Uncomment if you use local external storage
+# TODO: Uncomment if you use local external storage
#echo "Restoring Nextcloud data directory..."
#tar -xmpzf "${currentRestoreDir}/${fileNameBackupExternalDataDir}" -C "${nextcloudLocalExternalDataDir}"
#echo "Done"
# Restore database
#
echo "Dropping old Nextcloud DB..."
-# MySQL/MariaDB:
-mysql -h localhost -u "${dbUser}" -p"${dbPassword}" -e "DROP DATABASE ${nextcloudDatabase}"
-# PostgreSQL (uncomment if you are using PostgreSQL as Nextcloud database)
-#sudo -u postgres psql -c "DROP DATABASE ${nextcloudDatabase};"
+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
+
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}"
-
-# 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\";"
+
+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\";"
+fi
+
echo "Done"
echo
echo "Restoring backup DB..."
-# MySQL/MariaDB:
-mysql -h localhost -u "${dbUser}" -p"${dbPassword}" "${nextcloudDatabase}" < "${currentRestoreDir}/${fileNameBackupDb}"
-# PostgreSQL (uncomment if you are using PostgreSQL as Nextcloud database)
-#sudo -u postgres psql "${nextcloudDatabase}" < "${currentRestoreDir}/${fileNameBackupDb}"
+if [ "${databaseSystem,,}" = "mysql" ] || [ "${databaseSystem,,}" = "mariadb" ]; then
+ mysql -h localhost -u "${dbUser}" -p"${dbPassword}" "${nextcloudDatabase}" < "${currentRestoreDir}/${fileNameBackupDb}"
+elif [ "${databaseSystem,,}" = "postgresql" ]; then
+ sudo -u postgres psql "${nextcloudDatabase}" < "${currentRestoreDir}/${fileNameBackupDb}"
+fi
+
echo "Done"
echo
echo "Setting directory permissions..."
chown -R "${webserverUser}":"${webserverUser}" "${nextcloudFileDir}"
chown -R "${webserverUser}":"${webserverUser}" "${nextcloudDataDir}"
-# TOOD: Uncomment if you use local external storage
+# TODO: Uncomment if you use local external storage
#chown -R "${webserverUser}":"${webserverUser}" "${nextcloudLocalExternalDataDir}"
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)
+# Update the system data-fingerprint (see https://docs.nextcloud.com/server/16/admin_manual/configuration_server/occ_command.html#maintenance-commands-label)
#
echo "Updating the system data-fingerprint..."
sudo -u "${webserverUser}" php ${nextcloudFileDir}/occ maintenance:data-fingerprint