nextcloudBackup.sh

#!/bin/bash

#
# Bash script for creating backups of Nextcloud.
#
# Version 1.0.0
#
# Usage:
#   - With backup directory specified in the script:  ./NextcloudBackup.sh
#   - With backup directory specified by parameter: ./NextcloudBackup.sh <BackupDirectory> (e.g. ./NextcloudBackup.sh /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
#

# Variables

#Backup user Data? true or false
backupUserData=true
backupMainDir=$1

if [ -z "$backupMainDir" ]; then
    # TODO: The directory where you store the Nextcloud backups (when not specified by args)
    backupMainDir='/media/hdd/backup'
fi


currentDate=$(date +"%Y%m%d_%H%M%S")

# The actual directory of the current backup - this is a subdirectory of the main directory above with a timestamp
backupdir="${backupMainDir}/${currentDate}/"

# 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 a separate part of the backup
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"

#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"];')"

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

#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"];')"

# (TODO): Your web server user - abc is the default in linuxserver.io containers
webserverUser='abc'

# TODO: The maximum number of backups to keep (when set to 0, all backups are kept)
maxNrOfBackups=0

# File names for backup files
# If you prefer other file names, you'll also have to change the NextcloudRestore.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; }

rm /tmp/tConfig.php #Delete Helperfile



function DisableMaintenanceMode() {
    echo "Switching off maintenance mode..."
    docker exec $ncDocker sudo -u $webserverUser php /config/www/nextcloud/occ maintenance:mode --off
    echo "Done"
    echo
}

# Capture CTRL+C
trap CtrlC INT

function CtrlC() {
    read -p "Backup cancelled. Keep maintenance mode? [y/n] " -n 1 -r
    echo

    if ! [[ $REPLY =~ ^[Yy]$ ]]
    then
        DisableMaintenanceMode
    else
        echo "Maintenance mode still enabled."
    fi

    exit 1
}

#
# 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 already exists
#
if [ ! -d "${backupdir}" ]
then
    mkdir -p "${backupdir}"
else
    errorecho "ERROR: The backup directory ${backupdir} already exists!"
    exit 1
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

#
# Backup file directory
#
echo "Creating backup of Nextcloud file directory..."
tar -cpzf "${backupdir}/${fileNameBackupFileDir}" -C "${nextcloudFileDir}" .
echo "Done"
echo

#
# Backup data directory
#
if  $backupUserData -eq "true"  ; then
    echo "Creating backup of Nextcloud data directory..."
    tar -cpzf "${backupdir}/${fileNameBackupDataDir}"  -C "${nextcloudDataDir}" .
    echo "Done"
    echo
fi

# Backup local external storage.
# Uncomment if you use local external storage
#echo "Creating backup of Nextcloud local external storage directory..."
#tar -cpzf "${backupdir}/${fileNameBackupExternalDataDir}"  -C "${nextcloudLocalExternalDataDir}" .
#echo "Done"
#echo

#
# Backup DB
#
if [ "${databaseSystem,,}" = "mysql" ] || [ "${databaseSystem,,}" = "mariadb" ]; then
    echo "Backup Nextcloud database (MySQL/MariaDB)..."
        docker exec $dbDocker mysqldump --single-transaction -h localhost -u"$dbUser" -p"$dbPassword" $nextcloudDatabase > "${backupdir}/${fileNameBackupDb}"
    echo "Done"
    echo
elif [ "${databaseSystem,,}" = "postgresql" ]; then
    echo "Backup for postgresql not implemented ... feel free to do it by yourself ;)"
#   echo "Backup Nextcloud database (PostgreSQL)..."
#
#   if ! [ -x "$(command -v pg_dump)" ]; then
#       errorecho "ERROR:PostgreSQL not installed (command pg_dump not found)."
#       errorecho "ERROR: No backup of database possible!"
#   else
#       PGPASSWORD="${dbPassword}" pg_dump "${nextcloudDatabase}" -h localhost -U "${dbUser}" -f "${backupdir}/${fileNameBackupDb}"
#   fi
#
#   echo "Done"
#   echo
fi

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

#
# Disable maintenance mode
#
DisableMaintenanceMode

#
# Delete old backups
#
if [ ${maxNrOfBackups} != 0 ]
then
    nrOfBackups=$(ls -l ${backupMainDir} | grep -c ^d)

    if [[ ${nrOfBackups} > ${maxNrOfBackups} ]]
    then
        echo "Removing old backups..."
        ls -t ${backupMainDir} | tail -$(( nrOfBackups - maxNrOfBackups )) | while read -r dirToRemove; do
            echo "${dirToRemove}"
            rm -r "${backupMainDir}/${dirToRemove:?}"
            echo "Done"
            echo
        done
    fi
fi

echo
echo "DONE!"
echo "Backup created: ${backupdir}"