Files
Tobias GesellchenandClaude Opus 4.8 2e6e88dd8c feat(scripts): add Raspberry Pi uninstallers + fix stale install-web.sh docs
soundtouch-web was renamed to soundtouch-player and the web UI merged into
soundtouch-service, so the player is now optional. The Raspberry Pi / host
installers had no matching uninstaller (removal was only documented as manual
commands), and users who installed the old soundtouch-web have a leftover
service with no scripted way to remove it.

Add three uninstallers under scripts/raspberry-pi/, each mirroring its
installer's conventions and tolerant of already-missing pieces:

- uninstall.sh        — soundtouch-service; preserves the data directory by
                        default, --purge / PURGE_DATA=true to delete it.
- uninstall-player.sh — soundtouch-player (stateless).
- uninstall-web.sh    — leftover soundtouch-web; points users at install-player.sh.

The shared soundtouch:soundtouch user/group is removed only once no other
soundtouch-{service,player,web} install remains on the host.

Docs: the README and guides still told users to fetch install-web.sh to install
the player. Switch those to install-player.sh, keep but improve the manual
removal commands (note the service datastore is preserved unless explicitly
deleted), document the new uninstallers, and add a "Migrating from soundtouch-web"
section.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-25 09:47:19 +02:00

126 lines
3.8 KiB
Bash
Executable File

#!/usr/bin/env bash
set -euo pipefail
# ==============================================================================
# Bose-SoundTouch soundtouch-service uninstaller (systemd, headless)
#
# Reverses scripts/raspberry-pi/install.sh: stops and disables the systemd
# service, removes the unit, binary, and config directory.
#
# Usage:
# sudo bash uninstall.sh # remove service, KEEP the data directory
# sudo PURGE_DATA=true bash uninstall.sh # also delete the data directory
# sudo bash uninstall.sh --purge # same as PURGE_DATA=true
#
# Notes:
# - The data directory (${DATA_DIR}) holds your datastore: presets, device
# registrations, and certificates. It is PRESERVED by default; deleting it is
# opt-in via PURGE_DATA=true (or --purge).
# - The shared soundtouch:soundtouch user/group is removed only when no other
# soundtouch-{service,player,web} install remains on this host.
# - Safe to re-run; every step tolerates already-missing pieces.
# ==============================================================================
PURGE_DATA="${PURGE_DATA:-false}"
for arg in "$@"; do
case "$arg" in
--purge) PURGE_DATA="true" ;;
esac
done
SERVICE_NAME="${SERVICE_NAME:-soundtouch-service}"
BIN_PATH="${BIN_PATH:-/usr/local/bin/soundtouch-service}"
CONFIG_DIR="${CONFIG_DIR:-/etc/soundtouch-service}"
DATA_DIR="${DATA_DIR:-/var/lib/soundtouch-service}"
SERVICE_USER="${SERVICE_USER:-soundtouch}"
SERVICE_GROUP="${SERVICE_GROUP:-soundtouch}"
log() { printf "\n==> %s\n" "$*"; }
die() { echo "ERROR: $*" >&2; exit 1; }
need_root() {
[[ "${EUID}" -eq 0 ]] || die "Please run as root (e.g. sudo bash $0)."
}
ensure_cmd() {
command -v "$1" >/dev/null 2>&1 || die "Missing required command: $1"
}
stop_remove_service() {
log "Stopping and disabling ${SERVICE_NAME}.service"
systemctl disable --now "${SERVICE_NAME}.service" 2>/dev/null || true
local unit="/etc/systemd/system/${SERVICE_NAME}.service"
if [[ -f "${unit}" ]]; then
log "Removing systemd unit: ${unit}"
rm -f "${unit}"
fi
systemctl daemon-reload
systemctl reset-failed "${SERVICE_NAME}.service" 2>/dev/null || true
}
remove_binary() {
if [[ -e "${BIN_PATH}" || -e "${BIN_PATH}.old" ]]; then
log "Removing binary: ${BIN_PATH} (and ${BIN_PATH}.old)"
rm -f "${BIN_PATH}" "${BIN_PATH}.old"
fi
}
remove_config() {
if [[ -d "${CONFIG_DIR}" ]]; then
log "Removing config directory: ${CONFIG_DIR}"
rm -rf "${CONFIG_DIR}"
fi
}
handle_data_dir() {
if [[ ! -d "${DATA_DIR}" ]]; then
return
fi
if [[ "${PURGE_DATA}" == "true" ]]; then
log "Removing data directory: ${DATA_DIR}"
rm -rf "${DATA_DIR}"
else
log "Preserving data directory: ${DATA_DIR}"
echo " This holds your datastore (presets, device registrations, certs)."
echo " To delete it as well, run: sudo rm -rf ${DATA_DIR}"
echo " (or re-run this uninstaller with --purge / PURGE_DATA=true)"
fi
}
# Remove the shared soundtouch:soundtouch user/group only when no other
# soundtouch-{service,player,web} install remains on this host.
remove_user_group_if_unused() {
local n
for n in service player web; do
if [[ -f "/etc/systemd/system/soundtouch-${n}.service" ]] || \
[[ -e "/usr/local/bin/soundtouch-${n}" ]]; then
log "Keeping ${SERVICE_USER}:${SERVICE_GROUP} — still used by soundtouch-${n}."
return
fi
done
if id -u "${SERVICE_USER}" >/dev/null 2>&1; then
log "No other soundtouch installs remain; removing user ${SERVICE_USER}"
userdel "${SERVICE_USER}" 2>/dev/null || true
fi
if getent group "${SERVICE_GROUP}" >/dev/null 2>&1; then
groupdel "${SERVICE_GROUP}" 2>/dev/null || true
fi
}
main() {
need_root
ensure_cmd systemctl
stop_remove_service
remove_binary
remove_config
handle_data_dir
remove_user_group_if_unused
log "✅ soundtouch-service has been removed."
}
main "$@"