Compare commits

..
23 Commits
Author SHA256 Message Date
spacefreak ee86603dcd forward extra arguments to proxmox-backup-client backup 2026-08-22 06:37:37 +02:00
spacefreak 1eee4b2d1d remove no-op return from the pbc-* wrappers 2026-08-22 06:35:53 +02:00
spacefreak 7555745704 install pbc with an explicit mode and owner 2026-08-22 06:26:20 +02:00
spacefreak 49d2e35106 parse gitea tags without jq 2026-08-22 06:24:26 +02:00
spacefreak 9722741bfd check EUID instead of whoami for root 2026-08-22 06:21:31 +02:00
spacefreak 22abaf6431 rename TMPDIR to WORK_DIR 2026-08-22 06:19:51 +02:00
spacefreak 4e24ee218c send usage to stderr on error paths 2026-08-22 06:17:51 +02:00
spacefreak acac5b685b show usage when no command is given 2026-08-22 06:15:59 +02:00
spacefreak 3869ca5a95 install example config with a restrictive mode 2026-08-22 06:12:38 +02:00
spacefreak 3d5757effc check config file permissions before sourcing 2026-08-22 06:10:50 +02:00
spacefreak 6c7db396b2 make apt-get install non-interactive 2026-08-22 06:07:40 +02:00
spacefreak eeb0c9cb47 install client binary instead of cp 2026-08-22 06:06:29 +02:00
spacefreak 44cc111b3d fix version sorting when determining debian pkg to download 2026-08-22 06:03:06 +02:00
spacefreak f0610091bb fail curl on http errors 2026-08-22 06:00:44 +02:00
spacefreak f93f647504 add guard to may_select in case stdin is not a terminal 2026-08-22 05:54:50 +02:00
spacefreak 32e88beedc fix argument iteration 2026-08-22 05:48:23 +02:00
spacefreak 6b2847fec7 make full_usage aware of possible PBC setting in config 2026-08-22 05:46:16 +02:00
spacefreak 127fb83567 fix executable checks 2026-08-22 05:37:25 +02:00
spacefreak bfa15561d8 use local keywords only once for version variable 2026-08-22 05:34:26 +02:00
spacefreak 22675d1be3 fix error handling 2026-08-22 05:31:27 +02:00
spacefreak 62f6865a06 fix pkg install status check with apt-cache and mention pbs-client repos 2026-08-22 05:20:23 +02:00
spacefreak 331f75a943 replace whish -s with command -v 2026-08-22 05:15:25 +02:00
spacefreak d1791cfcc8 fix exit code and output to stderr in backup-cron command 2026-08-22 05:09:15 +02:00
2 changed files with 92 additions and 85 deletions
+13 -13
View File
@@ -1,12 +1,12 @@
#!/usr/bin/env bash #!/usr/bin/env bash
[ "$(whoami)" != "root" ] && echo "Error: installation only works as root!" >&2 && exit 1 (( EUID != 0 )) && echo "Error: installation only works as root!" >&2 && exit 1
API_ENDPOINT="https://git.ccc-rheintal.ch/api/v1/repos/spacefreak/pbc" API_ENDPOINT="https://git.ccc-rheintal.ch/api/v1/repos/spacefreak/pbc"
TMPDIR='' WORK_DIR=''
function cleanup_tmpdir() { function cleanup_work_dir() {
[ -n "$TMPDIR" -a -d "$TMPDIR" ] && rm -r "$TMPDIR" [ -n "$WORK_DIR" ] && [ -d "$WORK_DIR" ] && rm -r "$WORK_DIR"
trap - EXIT trap - EXIT
} }
@@ -15,10 +15,10 @@ function download_files() {
local query_params='' local query_params=''
[ -n "$GIT_TAG" ] && query_params="?ref=$GIT_TAG" [ -n "$GIT_TAG" ] && query_params="?ref=$GIT_TAG"
while [ -n "$1" ]; do while (( $# > 0 )); do
path=$1 path=$1
shift shift
curl -s --output-dir "$TMPDIR/" --remote-name "$API_ENDPOINT/raw/$path$query_params" curl -fsSL --output-dir "$WORK_DIR/" --remote-name "$API_ENDPOINT/raw/$path$query_params"
rc=$? rc=$?
if (( $rc != 0 )); then if (( $rc != 0 )); then
return $rc return $rc
@@ -26,27 +26,27 @@ function download_files() {
done done
} }
GIT_TAG=$(curl -s "$API_ENDPOINT/tags" | jq -r '.[] | .name' | sort --version-sort | tail -n 1) GIT_TAG=$(curl -fsSL "$API_ENDPOINT/tags" | grep -o '{"name":"[^"]*"' | sed 's/^{"name":"//;s/"$//' | sort --version-sort | tail -n 1)
if [ -n "$GIT_TAG" ]; then if [ -n "$GIT_TAG" ]; then
echo "Info: installing pbc version $GIT_TAG" echo "Info: installing pbc version $GIT_TAG"
else else
echo "Warning: no Git tag found, installing from repository default branch" >&2 echo "Warning: no Git tag found, installing from repository default branch" >&2
fi fi
TMPDIR=$(mktemp -d) WORK_DIR=$(mktemp -d)
trap cleanup_tmpdir EXIT trap cleanup_work_dir EXIT
! download_files config.example pbc && echo "Error downloading files!" >&2 && exit 10 ! download_files config.example pbc && echo "Error downloading files!" >&2 && exit 10
chmod +x "$TMPDIR/pbc" chmod +x "$WORK_DIR/pbc"
chmod o= "$TMPDIR/config.example" chmod o= "$WORK_DIR/config.example"
"$TMPDIR/pbc" install "$WORK_DIR/pbc" install
rc=$? rc=$?
if (( $rc != 0 )); then if (( $rc != 0 )); then
echo "Error installing pbc requirements!" >&2 echo "Error installing pbc requirements!" >&2
exit $rc exit $rc
fi fi
! mv "$TMPDIR/pbc" /usr/local/bin/pbc && echo 'Error moving file!' >&2 && exit 20 ! install -m 0755 -o root -g root "$WORK_DIR/pbc" /usr/local/bin/pbc && echo 'Error installing file!' >&2 && exit 20
echo "Success!" echo "Success!"
+79 -72
View File
@@ -34,53 +34,34 @@ EOF
function full_usage() { function full_usage() {
usage true usage true
[ ! -e "$PBC" ] && echo "Error: $PBC is not executable!" >&2 && return 254 [ ! -x "$PBC" ] && echo "Error: $PBC is not executable!" >&2 && return 254
echo "Commands of proxmox-backup-client:" echo "Commands of proxmox-backup-client:"
echo echo
"$PBC" help | tail -n +3 "$PBC" help | tail -n +3
echo
return $?
} }
function pbc-version() { function pbc-version() {
local vers_info=$("$PBC" version) local vers_info rc
local rc=$? vers_info=$("$PBC" version)
(( $rc != 0 )) && echo "Error running $PBC version ... exited with rc=$rc" >&2 && return $rc rc=$?
(( rc != 0 )) && echo "Error running $PBC version ... exited with rc=$rc" >&2 && return $rc
echo "$vers_info" | grep client echo "$vers_info" | grep client
rc=$? rc=$?
(( $rc != 0 )) && echo "Error reading client version, output was:" >&2 && echo "$vers_info" >&2 (( rc != 0 )) && echo "Error reading client version, output was:" >&2 && echo "$vers_info" >&2
return $rc return $rc
} }
function pbc-backup() { function pbc-backup() { "$PBC" backup --ns "$PBS_NAMESPACE" "${BACKUP[@]}" "$@"; }
"$PBC" backup --ns "$PBS_NAMESPACE" "${BACKUP[@]}"
return $?
}
function pbc-list() { function pbc-list() { "$PBC" list --ns "$PBS_NAMESPACE" "$@"; }
"$PBC" list --ns "$PBS_NAMESPACE" "$@"
return $?
}
function pbc-snapshot-list() { function pbc-snapshot-list() { "$PBC" snapshot list --ns "$PBS_NAMESPACE" "$@"; }
"$PBC" snapshot list --ns "$PBS_NAMESPACE" "$@"
return $?
}
function pbc-files() { function pbc-files() { "$PBC" files --ns "$PBS_NAMESPACE" "$@"; }
"$PBC" files --ns "$PBS_NAMESPACE" "$@"
return $?
}
function pbc-catalog-shell() { function pbc-catalog-shell() { "$PBC" catalog shell --ns "$PBS_NAMESPACE" "$@"; }
"$PBC" catalog shell --ns "$PBS_NAMESPACE" "$@"
return $?
}
function pbc-mount() { function pbc-mount() { "$PBC" mount --ns "$PBS_NAMESPACE" "$@"; }
"$PBC" mount --ns "$PBS_NAMESPACE" "$@"
return $?
}
function get_group_names() { function get_group_names() {
pbc-list --output-format json | jq -r '.[] | "\(.["backup-type"])/\(.["backup-id"])"' pbc-list --output-format json | jq -r '.[] | "\(.["backup-type"])/\(.["backup-id"])"'
@@ -97,27 +78,27 @@ function get_snapshot_files() {
function apt_get_install() { function apt_get_install() {
local package=$1 local package=$1
echo "Installing $package using package manager ..." echo "Installing $package using package manager ..."
apt-get install "$package" >/dev/null DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends "$package" >/dev/null
local rc=$? local rc=$?
(( $rc != 0 )) && echo "Error installing package!" >&2 (( $rc != 0 )) && echo "Error installing package!" >&2
return $rc return $rc
} }
TMPDIR='' WORK_DIR=''
function cleanup_tmpdir() { function cleanup_work_dir() {
[ -n "$TMPDIR" -a -d "$TMPDIR" ] && rm -r "$TMPDIR" [ -n "$WORK_DIR" ] && [ -d "$WORK_DIR" ] && rm -r "$WORK_DIR"
trap - EXIT trap - EXIT
} }
function install_proxmox_backup_client() { function install_proxmox_backup_client() {
local update=${1:-false} local update=${1:-false}
local version
[ -f "$PBC" ] && local installed=true || local installed=false [ -f "$PBC" ] && local installed=true || local installed=false
! $installed && update=false ! $installed && update=false
if $installed && ! $update; then if $installed && ! $update; then
local version=$("$PBC" version | head -n 1) version=$(pbc-version) || return 10
(( $? != 0 )) && echo "Error running $PBC version: exited with rc=$?" >&2 && return 10
echo "Info: skip installation of proxmox-backup-client, already installed ($version)" echo "Info: skip installation of proxmox-backup-client, already installed ($version)"
return 0 return 0
fi fi
@@ -127,34 +108,37 @@ function install_proxmox_backup_client() {
return 0 return 0
fi fi
if apt-get search proxmox-backup-client &>/dev/null; then if apt-cache show proxmox-backup-client &>/dev/null; then
apt_get_install proxmox-backup-client apt_get_install proxmox-backup-client
return $? return $?
fi fi
echo "Info: proxmox-backup-client is not available from any configured apt repository"
echo "Info: add the Proxmox pbs-client repository to install a signed, apt-managed package"
$update && local action='Updating' || local action='Installing' $update && local action='Updating' || local action='Installing'
echo "$action proxmox-backup-client-static binary ..." echo "$action proxmox-backup-client-static binary ..."
local pkgfile=$(curl -s "$PBC_DOWNLOAD_URL/" | grep proxmox-backup-client-static_ | tail -n 1 | sed 's#.*href="##g;s#".*##g;') local pkgfile=$(curl -fsSL "$PBC_DOWNLOAD_URL/" | grep proxmox-backup-client-static_ | sed 's#.*href="##g;s#".*##g;' | sort --version-sort | tail -n 1)
[ -z "$pkgfile" ] && echo "Unable to determine current package file!" >&2 && return 30 [ -z "$pkgfile" ] && echo "Unable to determine current package file!" >&2 && return 30
TMPDIR=$(mktemp -d) WORK_DIR=$(mktemp -d)
trap cleanup_tmpdir EXIT trap cleanup_work_dir EXIT
echo "Info: downloading $PBC_DOWNLOAD_URL/$pkgfile ..." echo "Info: downloading $PBC_DOWNLOAD_URL/$pkgfile ..."
! curl -s -o "$TMPDIR/$pkgfile" "$PBC_DOWNLOAD_URL/$pkgfile" && echo "Error downloading file!" >&2 && return 40 ! curl -fsSL -o "$WORK_DIR/$pkgfile" "$PBC_DOWNLOAD_URL/$pkgfile" && echo "Error downloading file!" >&2 && return 40
echo "Info: extracting $pkgfile ..." echo "Info: extracting $pkgfile ..."
! dpkg-deb -x "$TMPDIR/$pkgfile" "$TMPDIR/" && echo "Error extracting file!" >&2 && return 50 ! dpkg-deb -x "$WORK_DIR/$pkgfile" "$WORK_DIR/" && echo "Error extracting file!" >&2 && return 50
echo "Info: copying proxmox-backup-client static binary to $PBC ..." echo "Info: installing proxmox-backup-client static binary to $PBC ..."
! cp "$TMPDIR/usr/bin/proxmox-backup-client" "$PBC" && echo "Error copying binary!" >&2 && return 60 ! install -m 0755 -D "$WORK_DIR/usr/bin/proxmox-backup-client" "$PBC" && echo "Error installing binary!" >&2 && return 60
local version=$(pbc-version) || return $? version=$(pbc-version) || return $?
$update && action='updated' || action='installed' $update && action='updated' || action='installed'
echo "Info: successfully $action proxmox-backup-$version" echo "Info: successfully $action proxmox-backup-$version"
cleanup_tmpdir cleanup_work_dir
} }
@@ -162,7 +146,7 @@ function arr_contains() {
local search=$1 local search=$1
shift shift
[ -z "$search" ] && return 1 [ -z "$search" ] && return 1
while [ -n "$1" ]; do while (( $# > 0 )); do
[ "$1" == "$search" ] && return 0 [ "$1" == "$search" ] && return 0
shift shift
done done
@@ -178,8 +162,12 @@ function may_select() {
if [ -z "$value" ]; then if [ -z "$value" ]; then
if (( $# == 1 )); then if (( $# == 1 )); then
value=$1 value=$1
elif [ ! -t 0 ]; then
echo "Error: no value given and stdin is not a terminal" >&2
return 1
else else
local sorted=($(printf "%s\n" "$@" | sort)) local sorted
readarray -t sorted < <(printf '%s\n' "$@" | sort)
select value in "${sorted[@]}"; do select value in "${sorted[@]}"; do
[ -n "$value" ] && break [ -n "$value" ] && break
done done
@@ -188,8 +176,8 @@ function may_select() {
return 1 return 1
fi fi
[ -z "$value" ] && return 1
echo "$value" echo "$value"
return 0
} }
@@ -197,15 +185,17 @@ SCRIPT_PATH=$(realpath -s "$0")
SCRIPT_DIR=$(dirname "$SCRIPT_PATH") SCRIPT_DIR=$(dirname "$SCRIPT_PATH")
SCRIPT=$(basename "$SCRIPT_PATH") SCRIPT=$(basename "$SCRIPT_PATH")
PBC=$(which proxmox-backup-client) PBC=$(command -v proxmox-backup-client)
PBC_DOWNLOAD_URL='http://download.proxmox.com/debian/pbs-client/dists/trixie/main/binary-amd64' PBC_DOWNLOAD_URL='http://download.proxmox.com/debian/pbs-client/dists/trixie/main/binary-amd64'
ETC_DIR="/etc/$SCRIPT" ETC_DIR="/etc/$SCRIPT"
FULL_HELP=false
action='' action=''
cfgfile="$ETC_DIR/config" cfgfile="$ETC_DIR/config"
args=() args=()
while [ -n "$1" ]; do while (( $# > 0 )); do
opt=$1 opt=$1
shift shift
if [ -z "$action" ]; then if [ -z "$action" ]; then
@@ -213,20 +203,19 @@ while [ -n "$1" ]; do
-c|--config) -c|--config)
cfgfile=$1 cfgfile=$1
shift shift
[ -z "$cfgfile" ] && usage && exit 255 [ -z "$cfgfile" ] && echo "Error: missing argument for $opt" >&2 && usage >&2 && exit 255
;; ;;
-h|--help) -h|--help)
usage usage
exit 0 exit 0
;; ;;
-H|--full-help) -H|--full-help)
full_usage FULL_HELP=true
exit 0
;; ;;
-*) -*)
echo "Error: invalid option: $opt" >&2 echo "Error: invalid option: $opt" >&2
echo echo >&2
usage usage >&2
exit 255 exit 255
;; ;;
*) *)
@@ -240,14 +229,14 @@ while [ -n "$1" ]; do
;; ;;
-*) -*)
echo "Error: invalid option: $opt" >&2 echo "Error: invalid option: $opt" >&2
echo echo >&2
usage usage >&2
exit 255 exit 255
;; ;;
*) *)
echo "Error: invalid argument: $opt" >&2 echo "Error: invalid argument: $opt" >&2
echo echo >&2
usage usage >&2
exit 255 exit 255
;; ;;
esac esac
@@ -257,33 +246,51 @@ while [ -n "$1" ]; do
done done
if [ -f "$cfgfile" ]; then
perms=$(stat -c '%a' "$cfgfile")
(( 8#$perms & 0022 )) && echo "Error: $cfgfile is writable by group or others!" >&2 && exit 202
(( 8#$perms & 0007 )) && echo "Warning: $cfgfile is readable by others!" >&2
fi
if $FULL_HELP; then
[ -f "$cfgfile" ] && source "$cfgfile"
PBC=${PBC:-/usr/local/bin/proxmox-backup-client}
full_usage
exit $?
fi
[ -z "$action" ] && usage >&2 && exit 255
if [ "$action" == 'install' ]; then if [ "$action" == 'install' ]; then
if [ -f "$cfgfile" ]; then if [ -f "$cfgfile" ]; then
source "$cfgfile" || exit $? source "$cfgfile" || exit $?
fi fi
PBC=${PBC:-/usr/local/bin/proxmox-backup-client} PBC=${PBC:-/usr/local/bin/proxmox-backup-client}
for exe in apt-get dpkg dpkg-deb curl; do for exe in apt-cache apt-get dpkg dpkg-deb curl; do
! which -s "$exe" && echo "Error: $exe executable not found!" >&2 && exit 200 ! command -v "$exe" >/dev/null && echo "Error: $exe executable not found!" >&2 && exit 200
done done
else else
[ ! -f "$cfgfile" ] && echo "Error: $cfgfile: no such file" >&2 && exit 201
[ ! -r "$cfgfile" ] && echo "Error: $cfgfile: not readable" >&2 && exit 201
source "$cfgfile" || exit $? source "$cfgfile" || exit $?
PBC=${PBC:-/usr/local/bin/proxmox-backup-client} PBC=${PBC:-/usr/local/bin/proxmox-backup-client}
[ ! -f "$PBC" ] && echo "Error: $PBC: no such file" >&2 && exit 200 [ ! -f "$PBC" ] && echo "Error: $PBC: no such file" >&2 && exit 200
[ ! -e "$PBC" ] && echo "Error: $PBC: not executable" >&2 && exit 200 [ ! -x "$PBC" ] && echo "Error: $PBC: not executable" >&2 && exit 200
! which -s jq && echo "Error: jq executable not found!" >&2 && exit 200 ! command -v jq >/dev/null && echo "Error: jq executable not found!" >&2 && exit 200
fi fi
export PBS_REPOSITORY="$PBS_USER@${PBS_SERVER:-8007}:$PBS_DATASTORE" export PBS_REPOSITORY="$PBS_USER@$PBS_SERVER:$PBS_DATASTORE"
export PBS_PASSWORD="$PBS_PASSWORD" export PBS_PASSWORD="$PBS_PASSWORD"
case "$action" in case "$action" in
backup) backup)
pbc-backup || exit $? pbc-backup "${args[@]}" || exit $?
;; ;;
backup-cron) backup-cron)
output=$(pbc-backup 2>&1) output=$(pbc-backup "${args[@]}" 2>&1)
rc=$? rc=$?
(( $rc != 0 )) && echo "$output" (( rc != 0 )) && echo "$output" >&2
exit $rc
;; ;;
list) list)
pbc-list "${args[@]}" || exit $? pbc-list "${args[@]}" || exit $?
@@ -369,7 +376,7 @@ case "$action" in
install) install)
update=${args[0]:-false} update=${args[0]:-false}
[ "$(whoami)" != "root" ] && echo "Error: installation only works as root!" >&2 && exit 1 (( EUID != 0 )) && echo "Error: installation only works as root!" >&2 && exit 1
install_proxmox_backup_client "$update" || exit $? install_proxmox_backup_client "$update" || exit $?
@@ -388,8 +395,8 @@ case "$action" in
if [ -f "$SCRIPT_DIR/config.example" ]; then if [ -f "$SCRIPT_DIR/config.example" ]; then
if $update || [ ! -f "$ETC_DIR/config.example" ]; then if $update || [ ! -f "$ETC_DIR/config.example" ]; then
echo "Copy example config to $ETC_DIR/config.example ..." echo "Install example config to $ETC_DIR/config.example ..."
! cp "$SCRIPT_DIR/config.example" "$ETC_DIR/config.example" && echo "Error copying file!" >&2 && exit 4 ! install -m 0640 "$SCRIPT_DIR/config.example" "$ETC_DIR/config.example" && echo "Error installing file!" >&2 && exit 4
fi fi
fi fi