2023-09-07 16:06:51 -04:00
#!/usr/bin/env bash
2026-01-06 13:28:12 +01:00
# Copyright (c) 2021-2026 tteck
2023-09-07 16:06:51 -04:00
# Author: tteck (tteckster)
# License: MIT
2024-11-02 08:48:05 +01:00
# https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
2023-09-07 16:06:51 -04:00
function header_info {
2023-09-09 16:50:45 -04:00
clear
cat <<"EOF"
2023-09-07 16:06:51 -04:00
__ __ __ ___ __
/ // /__ ___ / /_ / _ ) ___ _____/ /____ _____
/ _ / _ \( _-</ __/ / _ / _ ` / __/ ' _/ // / _ \
/_//_/\_ __/___/\_ _/ /____/\_ ,_/\_ _/_/\_ \\ _,_/ .__/
/_/
EOF
}
2026-02-17 16:36:20 +01:00
# Telemetry
source <( curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/api.func) 2>/dev/null || true
core: Execution ID & Telemetry Improvements (#12041)
* fix: send telemetry BEFORE log collection in signal handlers
- Swap ensure_log_on_host/post_update_to_api order in on_interrupt, on_terminate, api_exit_script, and inline SIGHUP/SIGINT/SIGTERM traps
- For signal exits (>128): send telemetry immediately, then best-effort log collection
- Add 2>/dev/null || true to all I/O in signal handlers to prevent SIGPIPE
- Fix on_exit: exit_code=0 now reports 'done' instead of 'failed 1'
- Root cause: pct pull hangs on dying containers blocked telemetry updates, leaving 595+ records stuck in 'installing' daily
* feat: add execution_id to all telemetry payloads
- Generate EXECUTION_ID from RANDOM_UUID in variables()
- Export EXECUTION_ID to container environment
- Add execution_id field to all 8 API payloads in api.func
- Add execution_id to post_progress_to_api in install.func and alpine-install.func
- Fallback to RANDOM_UUID when EXECUTION_ID not set (backward compat)
* fix: correct telemetry type values for PVE and addon scripts
- PVE scripts (tools/pve/*): change type 'tool' -> 'pve'
- Addon scripts (tools/addon/*): fix 4 scripts that wrongly used 'tool' -> 'addon'
(netdata, add-tailscale-lxc, add-netbird-lxc, all-templates)
- api.func: post_tool_to_api sends type='pve', default fallback 'pve'
- Aligns with PocketBase categories: lxc, vm, pve, addon
* fix: persist diagnostics opt-in inside containers for addon telemetry
- install.func + alpine-install.func: create /usr/local/community-scripts/diagnostics
inside the container when DIAGNOSTICS=yes (from build.func export)
- Enables addon scripts running later inside containers to find the opt-in
- Update init_tool_telemetry default type from 'tool' to 'pve'
* refactor: clean up diagnostics/telemetry opt-in system
- diagnostics_check(): deduplicate heredoc (was 2x 22 lines), improve whiptail
text with clear what/what-not collected, add telemetry + privacy links
- diagnostics_menu(): better UX with current status, clear enable/disable
buttons, note about existing containers
- variables(): change DIAGNOSTICS default from 'yes' to 'no' (safe: no
telemetry before user consents via diagnostics_check)
- install.func + alpine-install.func: persist BOTH yes AND no in container
so opt-out is explicit (not just missing file = no)
- Fix typo 'menue' -> 'menu' in config file comments
* fix: no pre-selection in telemetry dialog, link to telemetry-service README
- Add --defaultno so 'No, opt out' is focused by default (user must Tab to Yes)
- Change privacy link from discussions/1836 to telemetry-service#privacy--compliance
* fix: use radiolist for telemetry dialog (no pre-selection)
- Replace --yesno with --radiolist: user must actively SPACE-select an option
- Both options start as OFF (no pre-selection)
- Cancel/Exit defaults to 'no' (opt-out)
* simplify: inline telemetry dialog text like other whiptail dialogs
* improve: telemetry dialog with more detail, link to PRIVACY.md
- Add what we collect / don't collect sections back to dialog
- Link to telemetry-service/docs/PRIVACY.md instead of README anchor
- Update config file comment with same link
2026-02-18 10:24:06 +01:00
declare -f init_tool_telemetry & >/dev/null && init_tool_telemetry "host-backup" "pve"
2026-02-17 16:36:20 +01:00
2023-09-09 20:50:26 -04:00
# Function to perform backup
function perform_backup {
local BACKUP_PATH
local DIR
local DIR_DASH
local BACKUP_FILE
local selected_directories = ( )
2023-09-07 16:06:51 -04:00
2023-09-09 20:50:26 -04:00
# Get backup path from user
BACKUP_PATH = $( whiptail --backtitle "Proxmox VE Helper Scripts" --inputbox "\nDefaults to /root/\ne.g. /mnt/backups/" 11 68 --title "Directory to backup to:" 3>& 1 1>& 2 2>& 3) || return
2023-09-07 16:06:51 -04:00
2023-09-09 20:50:26 -04:00
# Default to /root/ if no input
BACKUP_PATH = " ${ BACKUP_PATH :- /root/ } "
2023-09-09 16:50:45 -04:00
2023-09-09 20:50:26 -04:00
# Get directory to work in from user
DIR = $( whiptail --backtitle "Proxmox VE Helper Scripts" --inputbox "\nDefaults to /etc/\ne.g. /root/, /var/lib/pve-cluster/ etc." 11 68 --title "Directory to work in:" 3>& 1 1>& 2 2>& 3) || return
# Default to /etc/ if no input
DIR = " ${ DIR :- /etc/ } "
2023-09-09 16:50:45 -04:00
DIR_DASH = $( echo " $DIR " | tr '/' '-' )
2023-09-09 19:02:27 -04:00
BACKUP_FILE = " $( hostname) ${ DIR_DASH } backup "
2023-09-09 16:50:45 -04:00
2023-09-09 20:50:26 -04:00
# Build a list of directories for backup
local CTID_MENU = ( )
2025-10-11 17:20:06 +02:00
CTID_MENU = ( "ALL" "Backup all folders" "OFF" )
2023-09-09 16:50:45 -04:00
while read -r dir; do
2023-09-09 20:50:26 -04:00
CTID_MENU += ( " $( basename " $dir " ) " " $dir " "OFF" )
done < <( ls -d " ${ DIR } " *)
2023-09-07 16:06:51 -04:00
2023-09-09 20:50:26 -04:00
# Allow the user to select directories
local HOST_BACKUP
2023-09-09 16:50:45 -04:00
while [ -z " ${ HOST_BACKUP : +x } " ] ; do
HOST_BACKUP = $( whiptail --backtitle "Proxmox VE Host Backup" --title " Working in the ${ DIR } directory " --checklist \
2023-09-09 20:50:26 -04:00
"\nSelect what files/directories to backup:\n" 16 $(( ( ${# DIRNAME } + 2 ) + 88 )) 6 " ${ CTID_MENU [@] } " 3>& 1 1>& 2 2>& 3) || return
2023-09-09 16:50:45 -04:00
for selected_dir in ${ HOST_BACKUP // \" / } ; do
2025-10-11 17:20:06 +02:00
if [ [ " $selected_dir " = = "ALL" ] ] ; then
# if ALL was chosen, secure all folders
selected_directories = ( " ${ DIR } " */)
break
else
selected_directories += ( " ${ DIR } $selected_dir " )
fi
2023-09-09 16:50:45 -04:00
done
2023-09-07 16:06:51 -04:00
done
2023-09-09 20:50:26 -04:00
# Perform the backup
2023-09-09 16:50:45 -04:00
header_info
2023-09-09 20:50:26 -04:00
echo -e " This will create a backup in\e[1;33m $BACKUP_PATH \e[0mfor these files and directories\e[1;33m ${ selected_directories [*] } \e[0m "
2023-09-09 16:50:45 -04:00
read -p "Press ENTER to continue..."
header_info
2023-09-09 17:07:58 -04:00
echo "Working..."
2025-10-11 17:20:06 +02:00
tar -czf " $BACKUP_PATH $BACKUP_FILE - $( date +%Y_%m_%dT%H_%M) .tar.gz " --absolute-names " ${ selected_directories [@] } "
2023-09-09 17:07:58 -04:00
header_info
2023-09-09 16:50:45 -04:00
echo -e "\nFinished"
2023-09-09 17:07:58 -04:00
echo -e "\e[1;33m \nA backup is rendered ineffective when it remains stored on the host.\n \e[0m"
2023-09-09 20:50:26 -04:00
sleep 2
2023-09-09 16:50:45 -04:00
}
2023-09-07 16:06:51 -04:00
2023-09-09 20:50:26 -04:00
# Main script execution loop
while true; do
if ( whiptail --backtitle "Proxmox VE Helper Scripts" --title "Proxmox VE Host Backup" --yesno "This will create backups for particular files and directories located within a designated directory. Proceed?" 10 88) ; then
perform_backup
else
break
fi
done