Skip to content

Feature enhanced backup #2798

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
LKuemmel merged 3 commits into from
Nov 11, 2025
Merged

Feature enhanced backup #2798

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d0954ae
change file suffix to "openwb-backup"
benderl Oct 21, 2025
1b16af0
add version to filename
benderl Oct 21, 2025
08da9ce
optionally encrypt backup file
benderl Oct 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions runs/backup.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ TEMPDIR=$(mktemp -d --tmpdir openwb_backup_XXXXXX)
LOGDIR="$OPENWBBASEDIR/data/log"
LOGFILE="$LOGDIR/backup.log"
HOMEDIR="/home/openwb"
KEYFILE="backup.key"
VAR_LIB="/var/lib"

# Mosquitto DB files to monitor
Expand All @@ -21,7 +22,7 @@ DB_FILES=(
DB_TIMEOUT=5

useExtendedFilename=$1
FILENAMESUFFIX=".tar.gz"
FILENAMESUFFIX=".openwb-backup"

generate_filename() {
# generate filename
Expand All @@ -30,7 +31,7 @@ generate_filename() {
if ((useExtendedFilename == 1)); then
# only use characters supported in most OS!
# for Win see https://learn.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-shares--directories--files--and-metadata
FILENAME="openWB_backup_$(date +"%Y-%m-%d_%H-%M-%S")"
FILENAME="$(date +"%Y-%m-%d_%H-%M-%S")_$(<"$OPENWBBASEDIR"/web/version)"
else
FILENAME="backup"
fi
Expand Down Expand Up @@ -245,6 +246,20 @@ create_archive() {
gzip --verbose --suffix "$FILENAMESUFFIX" "$BACKUPFILE"
}

encrypt_backup() {
# encrypt backup file with gpg
if [[ -f "$HOMEDIR/$KEYFILE" ]]; then
echo "encrypting backup file"
gpg --batch --yes --passphrase-file "$HOMEDIR/$KEYFILE" \
--symmetric --cipher-algo AES256 "$BACKUPFILE$FILENAMESUFFIX"
echo "removing unencrypted backup file"
rm -v "$BACKUPFILE$FILENAMESUFFIX"
FILENAMESUFFIX="$FILENAMESUFFIX.gpg"
else
echo "No key found at '$HOMEDIR/$KEYFILE', skipping encryption!"
fi
}

fix_permissions() {
echo "setting permissions of new backup file"
sudo chown openwb:www-data "$BACKUPFILE$FILENAMESUFFIX"
Expand All @@ -254,6 +269,7 @@ create_archive() {
create_backup
calculate_checksums
cleanup_and_compress
encrypt_backup
fix_permissions
}

Expand Down