415 lines
15 KiB
Bash
Executable File
415 lines
15 KiB
Bash
Executable File
#!/bin/bash
|
|
#
|
|
# .---. . .
|
|
# | | |
|
|
# |--- .--. .-. .-. .-.| .-. .--.--. |.-. .-. .--. .-.
|
|
# | | (.-' (.-' ( | ( )| | | | )( )| | (.-'
|
|
# ' ' --' --' -' - -' ' ' -' -' -' ' - --'
|
|
#
|
|
# Freedom in the Cloud
|
|
#
|
|
# Backup to local storage - typically a USB drive
|
|
|
|
# License
|
|
# =======
|
|
#
|
|
# Copyright (C) 2015-2016 Bob Mottram <bob@robotics.uk.to>
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Affero General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU Affero General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Affero General Public License
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
PROJECT_NAME='freedombone'
|
|
COMPLETION_FILE=$HOME/${PROJECT_NAME}-completed.txt
|
|
BACKUP_EXTRA_DIRECTORIES=/root/backup-extra-dirs.csv
|
|
ENABLE_BACKUP_VERIFICATION="no"
|
|
|
|
export TEXTDOMAIN=${PROJECT_NAME}-backup-local
|
|
export TEXTDOMAINDIR="/usr/share/locale"
|
|
|
|
# include utils which allow function_check and drive mount
|
|
UTILS_FILES=/usr/share/${PROJECT_NAME}/utils/${PROJECT_NAME}-utils-*
|
|
for f in $UTILS_FILES
|
|
do
|
|
source $f
|
|
done
|
|
|
|
USB_DRIVE=/dev/sdb1
|
|
USB_MOUNT=/mnt/usb
|
|
|
|
# get default USB from config file
|
|
CONFIG_FILE=$HOME/${PROJECT_NAME}.cfg
|
|
if [ -f $CONFIG_FILE ]; then
|
|
if grep -q "USB_DRIVE=" $CONFIG_FILE; then
|
|
USB_DRIVE=$(cat $CONFIG_FILE | grep "USB_DRIVE=" | awk -F '=' '{print $2}')
|
|
fi
|
|
fi
|
|
|
|
# get the version of Go being used
|
|
GO_VERSION=$(cat /usr/share/${PROJECT_NAME}/utils/${PROJECT_NAME}-utils-go | grep 'GO_VERSION=' | head -n 1 | awk -F '=' '{print $2}')
|
|
GVM_HOME=$(cat /usr/share/${PROJECT_NAME}/utils/${PROJECT_NAME}-utils-go | grep 'GVM_HOME=' | head -n 1 | awk -F '=' '{print $2}')
|
|
|
|
ADMIN_USERNAME=
|
|
ADMIN_NAME=
|
|
|
|
# The name of a currently suspended site
|
|
# Sites are suspended so that verification should work
|
|
SUSPENDED_SITE=
|
|
|
|
DATABASE_PASSWORD=''
|
|
if [ -f /root/dbpass ]; then
|
|
DATABASE_PASSWORD=$(cat /root/dbpass)
|
|
fi
|
|
|
|
function make_backup_directory {
|
|
# make a backup directory on the drive
|
|
if [ ! -d $USB_MOUNT/backup ]; then
|
|
mkdir $USB_MOUNT/backup
|
|
fi
|
|
if [ ! -d $USB_MOUNT/backup ]; then
|
|
echo $"There was a problem making the directory $USB_MOUNT/backup."
|
|
umount $USB_MOUNT
|
|
rm -rf $USB_MOUNT
|
|
exit 3
|
|
fi
|
|
}
|
|
|
|
function check_storage_space_remaining {
|
|
# Check space remaining on the usb drive
|
|
used_percent=$(df -k $USB_MOUNT | tail -n 1 | awk -F ' ' '{print $5}' | awk -F '%' '{print $1}')
|
|
if [ $used_percent -gt 95 ]; then
|
|
echo $"Less than 5% of space remaining on backup drive"
|
|
umount $USB_MOUNT
|
|
rm -rf $USB_MOUNT
|
|
exit 4
|
|
fi
|
|
}
|
|
|
|
function backup_users {
|
|
# Backup user files
|
|
for d in /home/*/ ; do
|
|
USERNAME=$(echo "$d" | awk -F '/' '{print $3}')
|
|
if [[ $USERNAME != "git" && $USERNAME != "mirrors" && $USERNAME != "sync" && $USERNAME != "tahoelafs" ]]; then
|
|
|
|
# Backup any gpg keys
|
|
if [ -d /home/$USERNAME/.gnupg ]; then
|
|
echo $"Backing up gpg keys for $USERNAME"
|
|
backup_directory_to_usb /home/$USERNAME/.gnupg gnupg/$USERNAME
|
|
fi
|
|
|
|
# Backup any personal settings
|
|
if [ -d /home/$USERNAME/personal ]; then
|
|
echo $"Backing up personal settings for $USERNAME"
|
|
backup_directory_to_usb /home/$USERNAME/personal personal/$USERNAME
|
|
fi
|
|
|
|
# Backup ssh keys
|
|
if [ -d /home/$USERNAME/.ssh ]; then
|
|
echo $"Backing up ssh keys for $USERNAME"
|
|
backup_directory_to_usb /home/$USERNAME/.ssh ssh/$USERNAME
|
|
fi
|
|
|
|
# Backup fin database if it exists
|
|
if [ -d /home/$USERNAME/.fin ]; then
|
|
echo $"Backing up fin files for $USERNAME"
|
|
backup_directory_to_usb /home/$USERNAME/.fin fin/$USERNAME
|
|
fi
|
|
|
|
# Backup syncthing
|
|
if [ -d /home/$USERNAME/Sync ]; then
|
|
echo $"Backing up syncthing files for $USERNAME"
|
|
backup_directory_to_usb /home/$USERNAME/Sync syncthing/$USERNAME
|
|
# ensure that device IDs will be backed up as part of user config settings
|
|
if [ ! -d /home/$USERNAME/.config/syncthing ]; then
|
|
mkdir -p /home/$USERNAME/.config/syncthing
|
|
chown -R $USERNAME:$USERNAME /home/$USERNAME/.config
|
|
fi
|
|
if [ -f /home/$USERNAME/.syncthing-server-id ]; then
|
|
cp /home/$USERNAME/.syncthing-server-id /home/$USERNAME/.config/syncthing
|
|
chown -R $USERNAME:$USERNAME /home/$USERNAME/.config
|
|
fi
|
|
if [ -f /home/$USERNAME/.syncthingids ]; then
|
|
cp /home/$USERNAME/.syncthingids /home/$USERNAME/.config/syncthing
|
|
chown -R $USERNAME:$USERNAME /home/$USERNAME/.config
|
|
fi
|
|
fi
|
|
|
|
# Backup emacs
|
|
if [ -d /home/$USERNAME/.emacs.d ]; then
|
|
echo $"Backing up Emacs config for $USERNAME"
|
|
if [ -f /home/$USERNAME/.emacs ]; then
|
|
cp /home/$USERNAME/.emacs /home/$USERNAME/.emacs.d/dotemacs
|
|
fi
|
|
backup_directory_to_usb /home/$USERNAME/.emacs.d config/$USERNAME
|
|
fi
|
|
|
|
# Backup user configs
|
|
if [ -d /home/$USERNAME/.config ]; then
|
|
echo $"Backing up config files for $USERNAME"
|
|
backup_directory_to_usb /home/$USERNAME/.config config/$USERNAME
|
|
fi
|
|
|
|
# Backup monkeysphere
|
|
if [ -d /home/$USERNAME/.monkeysphere ]; then
|
|
echo $"Backing up monkeysphere files for $USERNAME"
|
|
backup_directory_to_usb /home/$USERNAME/.monkeysphere monkeysphere/$USERNAME
|
|
fi
|
|
|
|
# Backup user local
|
|
if [ -d /home/$USERNAME/.local ]; then
|
|
echo $"Backing up local files for $USERNAME"
|
|
backup_directory_to_usb /home/$USERNAME/.local local/$USERNAME
|
|
fi
|
|
|
|
# Backup mutt
|
|
if [ -f /home/$USERNAME/.muttrc ]; then
|
|
echo $"Backing up Mutt settings for $USERNAME"
|
|
if [ ! -d /home/$USERNAME/tempbackup ]; then
|
|
mkdir -p /home/$USERNAME/tempbackup
|
|
fi
|
|
cp /home/$USERNAME/.muttrc /home/$USERNAME/tempbackup
|
|
if [ -f /etc/Muttrc ]; then
|
|
cp /etc/Muttrc /home/$USERNAME/tempbackup
|
|
fi
|
|
backup_directory_to_usb /home/$USERNAME/tempbackup mutt/$USERNAME
|
|
fi
|
|
|
|
# Backup email
|
|
if [ -d /home/$USERNAME/Maildir ]; then
|
|
echo $"Stopping mail server"
|
|
systemctl stop exim4
|
|
echo $"Creating an email archive for $USERNAME"
|
|
if [ ! -d /root/tempbackupemail/$USERNAME ]; then
|
|
mkdir -p /root/tempbackupemail/$USERNAME
|
|
fi
|
|
tar -czvf /root/tempbackupemail/$USERNAME/maildir.tar.gz /home/$USERNAME/Maildir
|
|
echo $"Restarting mail server"
|
|
systemctl start exim4
|
|
echo $"Backing up emails for $USERNAME"
|
|
backup_directory_to_usb /root/tempbackupemail/$USERNAME mail/$USERNAME
|
|
fi
|
|
|
|
# Backup spamassassin
|
|
if [ -d /home/$USERNAME/.spamassassin ]; then
|
|
echo $"Backing up spamassassin settings for $USERNAME"
|
|
backup_directory_to_usb /home/$USERNAME/.spamassassin spamassassin/$USERNAME
|
|
fi
|
|
|
|
# Backup procmail
|
|
if [ -f /home/$USERNAME/.procmailrc ]; then
|
|
echo $"Backing up procmail settings for $USERNAME"
|
|
if [ ! -d /home/$USERNAME/tempbackup ]; then
|
|
mkdir -p /home/$USERNAME/tempbackup
|
|
fi
|
|
cp /home/$USERNAME/.procmailrc /home/$USERNAME/tempbackup
|
|
backup_directory_to_usb /home/$USERNAME/tempbackup procmail/$USERNAME
|
|
fi
|
|
fi
|
|
done
|
|
}
|
|
|
|
function backup_directories {
|
|
export GVM_ROOT=$GVM_HOME
|
|
if [ -d $GVM_ROOT/bin ]; then
|
|
cd $GVM_ROOT/bin
|
|
[[ -s "$GVM_ROOT/scripts/gvm" ]] && source "$GVM_ROOT/scripts/gvm"
|
|
gvm use go${GO_VERSION} --default
|
|
systemctl set-environment GOPATH=$GOPATH
|
|
fi
|
|
|
|
# directories to be backed up (source,dest)
|
|
backup_dirs=(
|
|
"/etc/letsencrypt, letsencrypt"
|
|
"/etc/ssl, ssl"
|
|
"/var/spool/mlmmj, mailinglist"
|
|
"/etc/nginx/sites-available, web"
|
|
"/var/lib/tor, tor"
|
|
)
|
|
|
|
for dr in "${backup_dirs[@]}"
|
|
do
|
|
# if this directory exists then back it up to the given destination
|
|
source_directory=$(echo $dr | awk -F ',' '{print $1}' | sed -e 's/^[[:space:]]*//' -e 's/[[:space:]]*$//')
|
|
if [ -d $source_directory ]; then
|
|
dest_directory=$(echo $dr | awk -F ',' '{print $2}' | sed -e 's/^[[:space:]]*//' -e 's/[[:space:]]*$//')
|
|
echo $"Backing up $source_directory to $dest_directory"
|
|
backup_directory_to_usb $source_directory $dest_directory
|
|
fi
|
|
|
|
restart_site
|
|
done
|
|
}
|
|
|
|
function remove_backup_directory {
|
|
if [ $1 ]; then
|
|
if [[ $1 == "remove" ]]; then
|
|
if [ -d $USB_MOUNT/backup ]; then
|
|
rm -rf $USB_MOUNT/backup
|
|
echo $'Existing backup directory removed'
|
|
backup_unmount_drive
|
|
exit 0
|
|
fi
|
|
fi
|
|
fi
|
|
}
|
|
|
|
function prepare_directories {
|
|
export GVM_ROOT=$GVM_HOME
|
|
if [ -d $GVM_ROOT/bin ]; then
|
|
cd $GVM_ROOT/bin
|
|
[[ -s "$GVM_ROOT/scripts/gvm" ]] && source "$GVM_ROOT/scripts/gvm"
|
|
gvm use go${GO_VERSION} --default
|
|
systemctl set-environment GOPATH=$GOPATH
|
|
fi
|
|
|
|
# Some miscellaneous preparation for backing up directories
|
|
if [ -d $GOPATH/src/github.com/gogits ]; then
|
|
mv /home/git/gogs-repositories/*.git /home/git/gogs-repositories/$ADMIN_USERNAME
|
|
fi
|
|
if [ -d /var/lib/tox-bootstrapd ]; then
|
|
cp /etc/tox-bootstrapd.conf /var/lib/tox-bootstrapd
|
|
if [ -d /var/lib/tox-bootstrapd/Maildir ]; then
|
|
rm -rf /var/lib/tox-bootstrapd/Maildir
|
|
fi
|
|
fi
|
|
}
|
|
|
|
function backup_configuration {
|
|
echo $"Backing up ${PROJECT_NAME} configuration files"
|
|
temp_backup_dir=/root/tempbackupconfig
|
|
if [ ! -d $temp_backup_dir ]; then
|
|
mkdir -p $temp_backup_dir
|
|
fi
|
|
cp -f $CONFIG_FILE $temp_backup_dir
|
|
cp -f $COMPLETION_FILE $temp_backup_dir
|
|
if [ -f $BACKUP_EXTRA_DIRECTORIES ]; then
|
|
cp -f $BACKUP_EXTRA_DIRECTORIES $temp_backup_dir
|
|
fi
|
|
# nginx password hashes
|
|
if [ -f /etc/nginx/.htpasswd ]; then
|
|
cp -f /etc/nginx/.htpasswd $temp_backup_dir/htpasswd
|
|
fi
|
|
backup_directory_to_usb $temp_backup_dir config
|
|
}
|
|
|
|
function backup_admin_readme {
|
|
if [ -f /home/$ADMIN_USERNAME/README ]; then
|
|
echo $"Backing up README"
|
|
temp_backup_dir=/home/$ADMIN_USERNAME/tempbackup
|
|
if [ ! -d $temp_backup_dir ]; then
|
|
mkdir -p $temp_backup_dir
|
|
fi
|
|
cp -f /home/$ADMIN_USERNAME/README $temp_backup_dir
|
|
backup_directory_to_usb $temp_backup_dir readme
|
|
fi
|
|
}
|
|
|
|
function backup_mariadb {
|
|
if [ ${#DATABASE_PASSWORD} -gt 1 ]; then
|
|
temp_backup_dir=/root/tempmariadb
|
|
if [ ! -d $temp_backup_dir ]; then
|
|
mkdir $temp_backup_dir
|
|
fi
|
|
mysqldump --lock-tables --password="$DATABASE_PASSWORD" mysql user > $temp_backup_dir/mysql.sql
|
|
if [ ! -s $temp_backup_dir/mysql.sql ]; then
|
|
echo $"Unable to backup mysql settings"
|
|
rm -rf $temp_backup_dir
|
|
umount $USB_MOUNT
|
|
rm -rf $USB_MOUNT
|
|
exit 8
|
|
fi
|
|
echo "$DATABASE_PASSWORD" > $temp_backup_dir/db
|
|
chmod 400 $temp_backup_dir/db
|
|
backup_directory_to_usb $temp_backup_dir mariadb
|
|
fi
|
|
}
|
|
|
|
function valid_backup_destination {
|
|
destination_dir="$1"
|
|
is_valid="yes"
|
|
|
|
if [[ "$destination_dir" == "hubzilla" || \
|
|
"$destination_dir" == "hubzilladata" || \
|
|
"$destination_dir" == "gogs" || \
|
|
"$destination_dir" == "gogsrepos" || \
|
|
"$destination_dir" == "gogsssh" || \
|
|
"$destination_dir" == "gnusocial" || \
|
|
"$destination_dir" == "gnusocialdata" || \
|
|
"$destination_dir" == "mariadb" || \
|
|
"$destination_dir" == "config" || \
|
|
"$destination_dir" == "letsencrypt" || \
|
|
"$destination_dir" == "wiki" || \
|
|
"$destination_dir" == "wiki2" || \
|
|
"$destination_dir" == "xmpp" || \
|
|
"$destination_dir" == "ipfs" || \
|
|
"$destination_dir" == "dlna" || \
|
|
"$destination_dir" == "tox" || \
|
|
"$destination_dir" == "ssl" || \
|
|
"$destination_dir" == "ttrss" || \
|
|
"$destination_dir" == "blog" || \
|
|
"$destination_dir" == "syncthingconfig" || \
|
|
"$destination_dir" == "syncthingshared" || \
|
|
"$destination_dir" == "syncthing" || \
|
|
"$destination_dir" == "mediagoblin" || \
|
|
"$destination_dir" == "mailinglist" ]]; then
|
|
is_valid="no"
|
|
fi
|
|
|
|
echo $is_valid
|
|
}
|
|
|
|
function backup_extra_directories {
|
|
if [ ! -f $BACKUP_EXTRA_DIRECTORIES ]; then
|
|
return
|
|
fi
|
|
|
|
echo $"Backing up some additional directories"
|
|
while read backup_line
|
|
do
|
|
backup_dir=$(echo "$backup_line" | awk -F ',' '{print $1}' | sed -e 's/^[[:space:]]*//' -e 's/[[:space:]]*$//')
|
|
if [ -d "$backup_dir" ]; then
|
|
destination_dir=$(echo "$backup_line" | awk -F ',' '{print $2}' | sed -e 's/^[[:space:]]*//' -e 's/[[:space:]]*$//')
|
|
if [[ $(valid_backup_destination "$destination_dir") == "yes" ]]; then
|
|
backup_directory_to_usb "$backup_dir" "$destination_dir"
|
|
else
|
|
echo $"WARNING: The backup directory $destination_dir is already used."
|
|
echo $"Choose a different destination name for backing up $backup_dir"
|
|
fi
|
|
else
|
|
echo $"WARNING: Directory $backup_dir does not exist"
|
|
fi
|
|
done <$BACKUP_EXTRA_DIRECTORIES
|
|
}
|
|
|
|
# has the remove option been set ?
|
|
remove_option=$2
|
|
if [[ $1 == "remove" ]]; then
|
|
remove_option=$1
|
|
fi
|
|
|
|
backup_mount_drive $1 $2
|
|
remove_backup_directory $remove_option
|
|
make_backup_directory
|
|
check_storage_space_remaining
|
|
backup_users
|
|
prepare_directories
|
|
backup_directories
|
|
backup_apps local
|
|
backup_configuration
|
|
backup_admin_readme
|
|
backup_mariadb
|
|
backup_extra_directories
|
|
backup_unmount_drive $USB_DRIVE $USB_MOUNT
|
|
echo $"Backup to USB drive is complete. You can now unplug it."
|
|
|
|
exit 0
|