Readme

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

diff --git a/NextcloudBackup.sh b/NextcloudBackup.sh
index 47abd1329cabc5839c849d351c643657e3eab486..a60eb967b953d2d9714605456e423d2a710adbec 100644 (file)
--- a/NextcloudBackup.sh
+++ b/NextcloudBackup.sh
@@ -3,13 +3,20 @@
 #
 # Bash script for creating backups of Nextcloud.
 #
 #
 # Bash script for creating backups of Nextcloud.
 #

-# Version 2.0.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:  ./NextcloudBackup.sh
 #
 # 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)
+#      - 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/
+# 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,18 +25,33 @@
 # 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

-backupMainDir=$1
+backupMainDir=${1:-} 

 
 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'
+else
+       backupMainDir=$(echo $backupMainDir | sed 's:/*$::')

 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
 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}/"
+backupDir="${backupMainDir}/${currentDate}"
+
+# TODO: Use compression for file/data dir
+# When this is the only script for backups, it's recommend to enable compression.
+# If the output of this script is used in another (compressing) backup (e.g. borg backup), 
+# you should probably disable compression here and only enable compression of your main backup script.
+useCompression=true
+
+# TOOD: The bare tar command for using compression.
+# Use 'tar -cpzf' if you want to use gzip compression.
+compressionCommand="tar -I pigz -cpf"

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


@@ -69,11 +91,23 @@ ignoreUpdaterBackups=false
 
 # File names for backup files
 # If you prefer other file names, you'll also have to change the NextcloudRestore.sh script.
 
 # 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'
+fileNameBackupFileDir='nextcloud-filedir.tar'
+fileNameBackupDataDir='nextcloud-datadir.tar'
+
+if [ "$useCompression" = true ] ; then
+       fileNameBackupFileDir='nextcloud-filedir.tar.gz'
+       fileNameBackupDataDir='nextcloud-datadir.tar.gz'
+fi

 
 

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


@@ -81,7 +115,7 @@ fileNameBackupDb='nextcloud-db.sql'
 errorecho() { cat <<< "$@" 1>&2; }
 
 function DisableMaintenanceMode() {
 errorecho() { cat <<< "$@" 1>&2; }
 
 function DisableMaintenanceMode() {

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


@@ -126,18 +160,18 @@ fi
 #
 # Check if backup dir already exists
 #
 #
 # Check if backup dir already exists
 #

-if [ ! -d "${backupdir}" ]
+if [ ! -d "${backupDir}" ]

 then
 then

-       mkdir -p "${backupdir}"
+       mkdir -p "${backupDir}"

 else
 else

-       errorecho "ERROR: The backup directory ${backupdir} already exists!"
+       errorecho "ERROR: The backup directory ${backupDir} already exists!"

        exit 1
 fi
 
 #
 # Set maintenance mode
 #
        exit 1
 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
 sudo -u "${webserverUser}" php ${nextcloudFileDir}/occ maintenance:mode --on
 echo "Done"
 echo


@@ -145,7 +179,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


@@ -153,56 +187,80 @@ echo
 #
 # Backup file directory
 #
 #
 # Backup file directory
 #

-echo "Creating backup of Nextcloud file directory..."
-tar -cpzf "${backupdir}/${fileNameBackupFileDir}" -C "${nextcloudFileDir}" .
+echo "$(date +"%H:%M:%S"): Creating backup of Nextcloud file directory..."
+
+if [ "$useCompression" = true ] ; then
+       `$compressionCommand "${backupDir}/${fileNameBackupFileDir}" -C "${nextcloudFileDir}" .`
+else
+       tar -cpf "${backupDir}/${fileNameBackupFileDir}" -C "${nextcloudFileDir}" .
+fi
+

 echo "Done"
 echo
 
 #
 # Backup data directory
 #
 echo "Done"
 echo
 
 #
 # Backup data directory
 #

-echo "Creating backup of Nextcloud data directory..."
+echo "$(date +"%H:%M:%S"): Creating backup of Nextcloud data directory..."

 
 if [ "$ignoreUpdaterBackups" = true ] ; then
 
 if [ "$ignoreUpdaterBackups" = true ] ; then

-        echo "Ignoring updater backup directory"
-        tar -cpzf "${backupdir}/${fileNameBackupDataDir}"  --exclude="updater-*/backups/*" -C "${nextcloudDataDir}" .
+       echo "Ignoring updater backup directory"
+
+       if [ "$useCompression" = true ] ; then
+               `$compressionCommand "${backupDir}/${fileNameBackupDataDir}"  --exclude="updater-*/backups/*" -C "${nextcloudDataDir}" .`
+       else
+               tar -cpf "${backupDir}/${fileNameBackupDataDir}"  --exclude="updater-*/backups/*" -C "${nextcloudDataDir}" .
+       fi

 else
 else

-        tar -cpzf "${backupdir}/${fileNameBackupDataDir}"  -C "${nextcloudDataDir}" .
+       if [ "$useCompression" = true ] ; then
+               `$compressionCommand "${backupDir}/${fileNameBackupDataDir}"  -C "${nextcloudDataDir}" .`
+       else
+               tar -cpf "${backupDir}/${fileNameBackupDataDir}"  -C "${nextcloudDataDir}" .
+       fi

 fi
 
 echo "Done"
 echo
 
 fi
 
 echo "Done"
 echo
 

+#

 # Backup local external storage.
 # 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
+#
+if [ ! -z "${nextcloudLocalExternalDataDir+x}" ] ; then
+       echo "$(date +"%H:%M:%S"): Creating backup of Nextcloud local external storage directory..."
+
+       if [ "$useCompression" = true ] ; then
+               `$compressionCommand "${backupDir}/${fileNameBackupExternalDataDir}"  -C "${nextcloudLocalExternalDataDir}" .`
+       else
+               tar -cpf "${backupDir}/${fileNameBackupExternalDataDir}"  -C "${nextcloudLocalExternalDataDir}" .
+       fi
+
+       echo "Done"
+       echo
+fi

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

-       echo "Backup Nextcloud database (MySQL/MariaDB)..."
+       echo "$(date +"%H:%M:%S"): Backup Nextcloud database (MySQL/MariaDB)..."

 
        if ! [ -x "$(command -v mysqldump)" ]; then
                errorecho "ERROR: MySQL/MariaDB not installed (command mysqldump not found)."
                errorecho "ERROR: No backup of database possible!"
        else
 
        if ! [ -x "$(command -v mysqldump)" ]; then
                errorecho "ERROR: MySQL/MariaDB not installed (command mysqldump not found)."
                errorecho "ERROR: No backup of database possible!"
        else

-               mysqldump --single-transaction -h localhost -u "${dbUser}" -p"${dbPassword}" "${nextcloudDatabase}" > "${backupdir}/${fileNameBackupDb}"
+               mysqldump --single-transaction -h localhost -u "${dbUser}" -p"${dbPassword}" "${nextcloudDatabase}" > "${backupDir}/${fileNameBackupDb}"

        fi
 
        echo "Done"
        echo
 elif [ "${databaseSystem,,}" = "postgresql" ] || [ "${databaseSystem,,}" = "pgsql" ]; then
        fi
 
        echo "Done"
        echo
 elif [ "${databaseSystem,,}" = "postgresql" ] || [ "${databaseSystem,,}" = "pgsql" ]; then

-       echo "Backup Nextcloud database (PostgreSQL)..."
+       echo "$(date +"%H:%M:%S"): 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
 
        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}"
+               PGPASSWORD="${dbPassword}" pg_dump "${nextcloudDatabase}" -h localhost -U "${dbUser}" -f "${backupDir}/${fileNameBackupDb}"

        fi
        
        echo "Done"
        fi
        
        echo "Done"


@@ -212,7 +270,7 @@ fi
 #
 # 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


@@ -229,9 +287,9 @@ if [ ${maxNrOfBackups} != 0 ]
 then
        nrOfBackups=$(ls -l ${backupMainDir} | grep -c ^d)
 
 then
        nrOfBackups=$(ls -l ${backupMainDir} | grep -c ^d)
 

-       if [[ ${nrOfBackups} > ${maxNrOfBackups} ]]
+       if [ ${nrOfBackups} -gt ${maxNrOfBackups} ]

        then
        then

-               echo "Removing old backups..."
+               echo "$(date +"%H:%M:%S"): Removing old backups..."

                ls -t ${backupMainDir} | tail -$(( nrOfBackups - maxNrOfBackups )) | while read -r dirToRemove; do
                        echo "${dirToRemove}"
                        rm -r "${backupMainDir}/${dirToRemove:?}"
                ls -t ${backupMainDir} | tail -$(( nrOfBackups - maxNrOfBackups )) | while read -r dirToRemove; do
                        echo "${dirToRemove}"
                        rm -r "${backupMainDir}/${dirToRemove:?}"


@@ -243,4 +301,4 @@ fi
 
 echo
 echo "DONE!"
 
 echo
 echo "DONE!"

-echo "Backup created: ${backupdir}"
+echo "$(date +"%H:%M:%S"): Backup created: ${backupDir}"