#
# Bash script for creating backups of Nextcloud.
#
-# Version 1.0.0
+# Version 2.1.3
#
# Usage:
# - With backup directory specified in the script: ./NextcloudBackup.sh
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
-echo "Backup directory: $backupMainDir"
-
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: 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
+
# TODO: The directory of your Nextcloud installation (this is a directory under your web root)
nextcloudFileDir='/var/www/nextcloud'
# TODO: Your web server user
webserverUser='www-data'
-# TODO: The name of the database system (ome of: mysql, mariadb, postgresql)
+# TODO: The name of the database system (one of: mysql, mariadb, postgresql)
databaseSystem='mariadb'
# TODO: Your Nextcloud database name
# TODO: The maximum number of backups to keep (when set to 0, all backups are kept)
maxNrOfBackups=0
+# TODO: Ignore updater's backup directory in the data directory to save space
+# Set to true to ignore the backup directory
+ignoreUpdaterBackups=false
+
# 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
+
+fileNameBackupExternalDataDir=''
+
+if [ ! -z "${nextcloudLocalExternalDataDir+x}" ] ; then
+ fileNameBackupExternalDataDir='nextcloud-external-datadir.tar'
-# TOOD: Uncomment if you use local external storage
-#fileNameBackupExternalDataDir='nextcloud-external-datadir.tar.gz'
+ if [ "$useCompression" = true ] ; then
+ fileNameBackupExternalDataDir='nextcloud-external-datadir.tar.gz'
+ fi
+fi
fileNameBackupDb='nextcloud-db.sql'
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
echo "Maintenance mode still enabled."
fi
+ echo "Starting web server..."
+ systemctl start "${webserverServiceName}"
+ echo "Done"
+ echo
+
exit 1
}
+#
+# Print information
+#
+echo "Backup directory: ${backupMainDir}"
+
#
# Check for root
#
#
# 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
#
# Stop web server
#
-echo "Stopping web server..."
+echo "$(date +"%H:%M:%S"): Stopping web server..."
systemctl stop "${webserverServiceName}"
echo "Done"
echo
#
# 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
+ tar -I pigz -cpf "${backupdir}/${fileNameBackupFileDir}" -C "${nextcloudFileDir}" .
+else
+ tar -cpf "${backupdir}/${fileNameBackupFileDir}" -C "${nextcloudFileDir}" .
+fi
+
echo "Done"
echo
#
# Backup data directory
#
-echo "Creating backup of Nextcloud data directory..."
-tar -cpzf "${backupdir}/${fileNameBackupDataDir}" -C "${nextcloudDataDir}" .
+echo "$(date +"%H:%M:%S"): Creating backup of Nextcloud data directory..."
+
+if [ "$ignoreUpdaterBackups" = true ] ; then
+ echo "Ignoring updater backup directory"
+
+ if [ "$useCompression" = true ] ; then
+ tar -I pigz -cpf "${backupdir}/${fileNameBackupDataDir}" --exclude="updater-*/backups/*" -C "${nextcloudDataDir}" .
+ else
+ tar -cpf "${backupdir}/${fileNameBackupDataDir}" --exclude="updater-*/backups/*" -C "${nextcloudDataDir}" .
+ fi
+else
+ if [ "$useCompression" = true ] ; then
+ tar -I pigz -cpf "${backupdir}/${fileNameBackupDataDir}" -C "${nextcloudDataDir}" .
+ else
+ tar -cpf "${backupdir}/${fileNameBackupDataDir}" -C "${nextcloudDataDir}" .
+ fi
+fi
+
echo "Done"
echo
+#
# 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
+ tar -I pigz -cpf "${backupdir}/${fileNameBackupExternalDataDir}" -C "${nextcloudLocalExternalDataDir}" .
+ else
+ tar -cpf "${backupdir}/${fileNameBackupExternalDataDir}" -C "${nextcloudLocalExternalDataDir}" .
+ fi
+
+ echo "Done"
+ echo
+fi
#
# 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)."
echo "Done"
echo
-elif [ "${databaseSystem,,}" = "postgresql" ]; then
- echo "Backup Nextcloud database (PostgreSQL)..."
+elif [ "${databaseSystem,,}" = "postgresql" ] || [ "${databaseSystem,,}" = "pgsql" ]; then
+ 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: 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}"
#
# Start web server
#
-echo "Starting web server..."
+echo "$(date +"%H:%M:%S"): Starting web server..."
systemctl start "${webserverServiceName}"
echo "Done"
echo
then
nrOfBackups=$(ls -l ${backupMainDir} | grep -c ^d)
- if [[ ${nrOfBackups} > ${maxNrOfBackups} ]]
+ if [ ${nrOfBackups} -gt ${maxNrOfBackups} ]
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:?}"
echo
echo "DONE!"
-echo "Backup created: ${backupdir}"
\ No newline at end of file
+echo "$(date +"%H:%M:%S"): Backup created: ${backupdir}"