nextcloudRestore.sh

#!/bin/bash

#
# Bash script for restoring backups of Nextcloud.
#
# 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)
#
# 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/
#

#
# IMPORTANT
# You have to customize this script (directories, users, etc.) for your actual environment.
# All entries which need to be customized are tagged with "TODO".
#

#
# Customisations by Draddy to fit with Docker install with this guide: https://forum.openmediavault.org/index.php/Thread/28216-How-To-Nextcloud-with-Letsencrypt-using-OMV-and-docker-compose/
# all "(TODO)" should work if you don't change the composer file "TODO" still need your attantion
#
# If you try to migrate to another server, the best way would be to reinstall the setup as befor using your composer file
# resetup it the same way (dbuser / password) and bring it up one time (login with admin) after that - run the script to get your settings, apps and userdata back.
#

# Variables
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/backup'
fi


currentRestoreDir="${backupMainDir}/${restore}"

echo "Restore from Backup: $backupMainDir"

# TODO: The directory of your appdata
appdataDir='/srv/dev-disk-by-label-disk1/appdata'

# (TODO): should work if you follow the guide
nextcloudFileDir="${appdataDir}/nextcloud/config"

# (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="${appdataDir}/nextcloud/data"

# TODO: The directory of your Nextcloud's local external storage.
# Uncomment if you use local external storage.
#nextcloudLocalExternalDataDir='/var/nextcloud_external_data'

# config.php to get some values from - Helperfile - can't set a var to the wrapper - will deleted later
cp $"${nextcloudFileDir}/www/nextcloud/config/config.php" /tmp/tConfig.php

# (TODO): Nextcloud containername
ncDocker="nextcloud"

#Database containername
dbDocker="$(php -r 'include("/tmp/tConfig.php"); print $CONFIG["dbhost"];')"

# (TODO): Your web server user
webserverUser='abc'

# The name of the database system (ome of: mysql, mariadb, postgresql)
databaseSystem="$(php -r 'include("/tmp/tConfig.php"); print $CONFIG["dbtype"];')"

# Your Nextcloud database name
nextcloudDatabase="$(php -r 'include("/tmp/tConfig.php"); print $CONFIG["dbname"];')"

# Your Nextcloud database user
dbUser="$(php -r 'include("/tmp/tConfig.php"); print $CONFIG["dbuser"];')"

# The password of the Nextcloud database user
dbPassword="$(php -r 'include("/tmp/tConfig.php"); print $CONFIG["dbpassword"];')"




# 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'

# 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; }

#
# Check if parameter(s) given
#
if [ $# != "1" ] && [ $# != "2" ]
then
    errorecho "ERROR: No backup name to restore given, or wrong number of parameters!"
    errorecho "Usage: NextcloudRestore.sh 'BackupDate' ['BackupDirectory']"
    exit 1
fi

#
# Check for root
#
if [ "$(id -u)" != "0" ]
then
    errorecho "ERROR: This script has to be run as root!"
    exit 1
fi

#
# Check if backup dir exists
#
if [ ! -d "${currentRestoreDir}" ]
then
    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 in#talled (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..."
docker exec $ncDocker sudo -u $webserverUser php /config/www/nextcloud/occ maintenance:mode --on
echo "Done"
echo

#
# Stop web server
#
echo "Stopping web server..."
docker stop $ncDocker
echo "Done"
echo

#
# Delete old Nextcloud directories
#

# File directory
echo "Deleting old Nextcloud file directory..."
rm -r "${nextcloudFileDir}"
mkdir -p "${nextcloudFileDir}"
echo "Done"
echo

# Data directory
echo "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

#
# Restore file and data directory
#

# File directory
echo "Restoring Nextcloud file directory..."
tar -xmpzf "${currentRestoreDir}/${fileNameBackupFileDir}" -C "${nextcloudFileDir}"
echo "Done"
echo

# Data directory
echo "Restoring Nextcloud data directory..."
tar -xmpzf "${currentRestoreDir}/${fileNameBackupDataDir}" -C "${nextcloudDataDir}"
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

#
# Restore database
#
echo "Dropping old Nextcloud DB..."

if [ "${databaseSystem,,}" = "mysql" ] || [ "${databaseSystem,,}" = "mariadb" ]; then
    docker exec $dbDocker mysql -h localhost -u "${dbUser}" -p"${dbPassword}" -e "DROP DATABASE ${nextcloudDatabase}"
elif [ "${databaseSystem,,}" = "postgresql" ]; then
    echo "postgresql not implemented ... feel free to do it by yourself ;)"
#   sudo -u postgres psql -c "DROP DATABASE ${nextcloudDatabase};"
fi

echo "Done"
echo

echo "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):
    docker exec $dbDocker 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
    echo "postgresql not implemented ... feel free to do it by yourself ;)"
#   sudo -u postgres psql -c "CREATE DATABASE ${nextcloudDatabase} WITH OWNER ${dbUser} TEMPLATE template0 ENCODING \"UTF8\";"
fi

echo "Done"
echo

echo "Restoring backup DB..."

if [ "${databaseSystem,,}" = "mysql" ] || [ "${databaseSystem,,}" = "mariadb" ]; then
    docker exec -i $dbDocker mysql -h localhost -u "${dbUser}" -p"${dbPassword}" "${nextcloudDatabase}" < "${currentRestoreDir}/${fileNameBackupDb}"
elif [ "${databaseSystem,,}" = "postgresql" ]; then
    echo "postgresql not implemented ... feel free to do it by yourself ;)"
#   sudo -u postgres psql "${nextcloudDatabase}" < "${currentRestoreDir}/${fileNameBackupDb}"
fi

echo "Done"
echo

#
# Start web server
#
echo "Starting web server..."
docker start $ncDocker
echo "Done"
echo

#
# Set directory permissions
#
echo "Setting directory permissions..."
docker exec $ncDocker chown -R "${webserverUser}":"${webserverUser}" "/config"
docker exec $ncDocker chown -R "${webserverUser}":"${webserverUser}" "/data"
# 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/16/admin_manual/configuration_server/occ_command.html#maintenance-commands-label)
#
echo "Updating the system data-fingerprint..."
docker exec $ncDocker sudo -u "${webserverUser}" php /config/www/nextcloud/occ maintenance:data-fingerprint
echo "Done"
echo

#
# Disbale maintenance mode
#
echo "Switching off maintenance mode..."
docker exec $ncDocker sudo -u $webserverUser php /config/www/nextcloud/occ maintenance:mode --off
echo "Done"
echo

echo
rm /tmp/tConfig.php #Delete Helperfile
echo "DONE!"
echo "Backup ${restore} successfully restored."