Readme

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

diff --git a/NextcloudBackup.sh b/NextcloudBackup.sh
index 5a7e091215e05b4e875b1e2c6f4c47ba82873d05..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.2.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,8 +25,11 @@
 # 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)


@@ -31,7 +41,7 @@ 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
 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.
 
 # TODO: Use compression for file/data dir
 # When this is the only script for backups, it's recommend to enable compression.


@@ -39,6 +49,10 @@ backupdir="${backupMainDir}/${currentDate}/"
 # you should probably disable compression here and only enable compression of your main backup script.
 useCompression=true
 
 # 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'
 


@@ -146,11 +160,11 @@ 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
 
        exit 1
 fi
 


@@ -176,9 +190,9 @@ echo
 echo "$(date +"%H:%M:%S"): Creating backup of Nextcloud file directory..."
 
 if [ "$useCompression" = true ] ; then
 echo "$(date +"%H:%M:%S"): Creating backup of Nextcloud file directory..."
 
 if [ "$useCompression" = true ] ; then

-       tar -I pigz -cpf "${backupdir}/${fileNameBackupFileDir}" -C "${nextcloudFileDir}" .
+       `$compressionCommand "${backupDir}/${fileNameBackupFileDir}" -C "${nextcloudFileDir}" .`

 else
 else

-       tar -cpf "${backupdir}/${fileNameBackupFileDir}" -C "${nextcloudFileDir}" .
+       tar -cpf "${backupDir}/${fileNameBackupFileDir}" -C "${nextcloudFileDir}" .

 fi
 
 echo "Done"
 fi
 
 echo "Done"


@@ -193,15 +207,15 @@ if [ "$ignoreUpdaterBackups" = true ] ; then
        echo "Ignoring updater backup directory"
 
        if [ "$useCompression" = true ] ; then
        echo "Ignoring updater backup directory"
 
        if [ "$useCompression" = true ] ; then

-               tar -I pigz -cpf "${backupdir}/${fileNameBackupDataDir}"  --exclude="updater-*/backups/*" -C "${nextcloudDataDir}" .
+               `$compressionCommand "${backupDir}/${fileNameBackupDataDir}"  --exclude="updater-*/backups/*" -C "${nextcloudDataDir}" .`

        else
        else

-               tar -cpf "${backupdir}/${fileNameBackupDataDir}"  --exclude="updater-*/backups/*" -C "${nextcloudDataDir}" .
+               tar -cpf "${backupDir}/${fileNameBackupDataDir}"  --exclude="updater-*/backups/*" -C "${nextcloudDataDir}" .

        fi
 else
        if [ "$useCompression" = true ] ; then
        fi
 else
        if [ "$useCompression" = true ] ; then

-        tar -I pigz -cpf "${backupdir}/${fileNameBackupDataDir}"  -C "${nextcloudDataDir}" .
+               `$compressionCommand "${backupDir}/${fileNameBackupDataDir}"  -C "${nextcloudDataDir}" .`

        else
        else

-               tar -cpf "${backupdir}/${fileNameBackupDataDir}"  -C "${nextcloudDataDir}" .
+               tar -cpf "${backupDir}/${fileNameBackupDataDir}"  -C "${nextcloudDataDir}" .

        fi
 fi
 
        fi
 fi
 


@@ -215,9 +229,9 @@ if [ ! -z "${nextcloudLocalExternalDataDir+x}" ] ; then
        echo "$(date +"%H:%M:%S"): Creating backup of Nextcloud local external storage directory..."
 
        if [ "$useCompression" = true ] ; then
        echo "$(date +"%H:%M:%S"): Creating backup of Nextcloud local external storage directory..."
 
        if [ "$useCompression" = true ] ; then

-               tar -I pigz -cpf "${backupdir}/${fileNameBackupExternalDataDir}"  -C "${nextcloudLocalExternalDataDir}" .
+               `$compressionCommand "${backupDir}/${fileNameBackupExternalDataDir}"  -C "${nextcloudLocalExternalDataDir}" .`

        else
        else

-               tar -cpf "${backupdir}/${fileNameBackupExternalDataDir}"  -C "${nextcloudLocalExternalDataDir}" .
+               tar -cpf "${backupDir}/${fileNameBackupExternalDataDir}"  -C "${nextcloudLocalExternalDataDir}" .

        fi
 
        echo "Done"
        fi
 
        echo "Done"


@@ -234,7 +248,7 @@ if [ "${databaseSystem,,}" = "mysql" ] || [ "${databaseSystem,,}" = "mariadb" ];
                errorecho "ERROR: MySQL/MariaDB not installed (command mysqldump not found)."
                errorecho "ERROR: No backup of database possible!"
        else
                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"
        fi
 
        echo "Done"


@@ -246,7 +260,7 @@ elif [ "${databaseSystem,,}" = "postgresql" ] || [ "${databaseSystem,,}" = "pgsq
                errorecho "ERROR: PostgreSQL not installed (command pg_dump not found)."
                errorecho "ERROR: No backup of database possible!"
        else
                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"


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

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