SparkyFitness: add garmin microservice (#12642)

* feat(sparkyfitness): add garmin microservice * chore(sparkyfitness): add note to json * chore(sparkyfitness): set garmin url * feat(sparkyfitness): add garmin install option to update menu * fix(sparkyfitness): typo * chore(sparkyfitness): streamline naming and refactor menu * feat: add sparlkyfitness garmin addon * fix: remove EOF * fix: update uninstall * chore: update telemetry * fix: app name * chore: update env vars * fix: typo * chore: update default port * fix: message format * fix: update uninstall * fix: rename functions * fix: remove custom header_info * fix: add header file * chore: revert function naming
2026-03-31 06:24:02 -04:00 · 2026-03-26 12:34:28 +01:00
parent 83cfa0b5b4
commit ee66508879
3 changed files with 180 additions and 0 deletions
--- a/install/sparkyfitness-install.sh
+++ b/install/sparkyfitness-install.sh
@@ -40,6 +40,7 @@ sed \
  -e "s|^SPARKY_FITNESS_SERVER_HOST=.*|SPARKY_FITNESS_SERVER_HOST=localhost|" \
  -e "s|^SPARKY_FITNESS_SERVER_PORT=.*|SPARKY_FITNESS_SERVER_PORT=3010|" \
  -e "s|^SPARKY_FITNESS_FRONTEND_URL=.*|SPARKY_FITNESS_FRONTEND_URL=http://${LOCAL_IP}:80|" \
+  -e "s|^GARMIN_MICROSERVICE_URL=.*|GARMIN_MICROSERVICE_URL=http://${LOCAL_IP}:8000|" \
  -e "s|^SPARKY_FITNESS_API_ENCRYPTION_KEY=.*|SPARKY_FITNESS_API_ENCRYPTION_KEY=$(openssl rand -hex 32)|" \
  -e "s|^BETTER_AUTH_SECRET=.*|BETTER_AUTH_SECRET=$(openssl rand -hex 32)|" \
  "/etc/sparkyfitness/.env"
--- a/tools/addon/sparkyfitness-garmin.sh
+++ b/tools/addon/sparkyfitness-garmin.sh
@@ -0,0 +1,173 @@
+#!/usr/bin/env bash
+
+# Copyright (c) 2021-2026 community-scripts ORG
+# Author: Tom Frenzel (tomfrenzel)
+# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
+# Source: https://github.com/CodeWithCJ/SparkyFitness
+
+if ! command -v curl &>/dev/null; then
+  printf "\r\e[2K%b" '\033[93m Setup Source \033[m' >&2
+  apt-get update >/dev/null 2>&1
+  apt-get install -y curl >/dev/null 2>&1
+fi
+source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/core.func)
+source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/tools.func)
+source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/error_handler.func)
+source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/api.func) 2>/dev/null || true
+declare -f init_tool_telemetry &>/dev/null && init_tool_telemetry "sparkyfitness-garmin" "addon"
+
+# Enable error handling
+set -Eeuo pipefail
+trap 'error_handler' ERR
+load_functions
+
+# ==============================================================================
+# CONFIGURATION
+# ==============================================================================
+APP="SparkyFitness Garmin Microservice"
+APP_TYPE="addon"
+INSTALL_PATH="/opt/sparkyfitness-garmin"
+CONFIG_PATH="/etc/sparkyfitness-garmin/.env"
+SERVICE_PATH="/etc/systemd/system/sparkyfitness-garmin.service"
+DEFAULT_PORT=8000
+
+# ==============================================================================
+# OS DETECTION
+# ==============================================================================
+if ! grep -qE 'ID=debian|ID=ubuntu' /etc/os-release 2>/dev/null; then
+  echo -e "${CROSS} Unsupported OS detected. This script only supports Debian and Ubuntu."
+  exit 238
+fi
+
+# ==============================================================================
+# SparkyFitness LXC DETECTION
+# ==============================================================================
+if [[ ! -d /opt/sparkyfitness ]]; then
+  echo -e "${CROSS} No SparkyFitness installation detected. This addon must be installed within a container that already has SparkyFitness installed."
+  exit 238
+fi
+
+# ==============================================================================
+# UNINSTALL
+# ==============================================================================
+function uninstall() {
+  msg_info "Uninstalling ${APP}"
+  systemctl disable --now sparkyfitness-garmin.service &>/dev/null || true
+  rm -rf "$SERVICE_PATH" "$CONFIG_PATH" "$INSTALL_PATH" ~/.sparkyfitness-garmin
+  msg_ok "${APP} has been uninstalled"
+}
+
+# ==============================================================================
+# UPDATE
+# ==============================================================================
+function update() {
+  if check_for_gh_release "sparkyfitness-garmin" "CodeWithCJ/SparkyFitness"; then
+    PYTHON_VERSION="3.13" setup_uv
+
+    msg_info "Stopping service"
+    systemctl stop sparkyfitness-garmin.service &>/dev/null || true
+    msg_ok "Stopped service"
+
+    CLEAN_INSTALL=1 fetch_and_deploy_gh_release "sparkyfitness-garmin" "CodeWithCJ/SparkyFitness" "tarball" "latest" $INSTALL_PATH
+
+    msg_info "Starting service"
+    systemctl start sparkyfitness-garmin
+    msg_ok "Started service"
+    msg_ok "Updated successfully"
+    exit
+  fi
+}
+
+# ==============================================================================
+# INSTALL
+# ==============================================================================
+function install() {
+  PYTHON_VERSION="3.13" setup_uv
+  fetch_and_deploy_gh_release "sparkyfitness-garmin" "CodeWithCJ/SparkyFitness" "tarball" "latest" $INSTALL_PATH
+
+  msg_info "Setting up ${APP}"
+  mkdir -p "/etc/sparkyfitness-garmin"
+  cp "/opt/sparkyfitness-garmin/docker/.env.example" $CONFIG_PATH
+  cd $INSTALL_PATH/SparkyFitnessGarmin
+  $STD uv venv --clear .venv
+  $STD uv pip install -r requirements.txt
+  sed -i -e "s|^#\?GARMIN_MICROSERVICE_URL=.*|GARMIN_MICROSERVICE_URL=http://${LOCAL_IP}:${DEFAULT_PORT}|" $CONFIG_PATH
+  cat <<EOF >/etc/systemd/system/sparkyfitness-garmin.service
+[Unit]
+Description=${APP}
+After=network.target sparkyfitness-server.service
+Requires=sparkyfitness-server.service
+
+[Service]
+Type=simple
+WorkingDirectory=$INSTALL_PATH/SparkyFitnessGarmin
+EnvironmentFile=$CONFIG_PATH
+ExecStart=$INSTALL_PATH/SparkyFitnessGarmin/.venv/bin/python3 -m uvicorn main:app --host 0.0.0.0 --port ${DEFAULT_PORT}
+Restart=always
+RestartSec=5
+
+[Install]
+WantedBy=multi-user.target
+EOF
+  systemctl enable -q --now sparkyfitness-garmin
+  msg_ok "Set up ${APP} - reachable at http://${LOCAL_IP}:${DEFAULT_PORT}"
+  msg_ok "You might need to update the GARMIN_MICROSERVICE_URL in your SparkyFitness .env file to http://${LOCAL_IP}:${DEFAULT_PORT}"
+}
+
+# ==============================================================================
+# MAIN
+# ==============================================================================
+header_info
+ensure_usr_local_bin_persist
+get_lxc_ip
+
+# Handle type=update (called from update script)
+if [[ "${type:-}" == "update" ]]; then
+  if [[ -d "$INSTALL_PATH" ]]; then
+    update
+  else
+    msg_error "${APP} is not installed. Nothing to update."
+    exit 233
+  fi
+  exit 0
+fi
+
+# Check if already installed
+if [[ -d "$INSTALL_PATH" && -n "$(ls -A "$INSTALL_PATH" 2>/dev/null)" ]]; then
+  msg_warn "${APP} is already installed."
+  echo ""
+
+  echo -n "${TAB}Uninstall ${APP}? (y/N): "
+  read -r uninstall_prompt
+  if [[ "${uninstall_prompt,,}" =~ ^(y|yes)$ ]]; then
+    uninstall
+    exit 0
+  fi
+
+  echo -n "${TAB}Update ${APP}? (y/N): "
+  read -r update_prompt
+  if [[ "${update_prompt,,}" =~ ^(y|yes)$ ]]; then
+    update
+    exit 0
+  fi
+
+  msg_warn "No action selected. Exiting."
+  exit 0
+fi
+
+# Fresh installation
+msg_warn "${APP} is not installed."
+echo ""
+echo -e "${TAB}${INFO} This will install:"
+echo -e "${TAB}  - UV (Python Version Manager)"
+echo -e "${TAB}  - SparkyFitness Garmin Microservice"
+echo ""
+
+echo -n "${TAB}Install ${APP}? (y/N): "
+read -r install_prompt
+if [[ "${install_prompt,,}" =~ ^(y|yes)$ ]]; then
+  install
+else
+  msg_warn "Installation cancelled. Exiting."
+  exit 0
+fi
--- a/tools/headers/sparkyfitnessgarmin
+++ b/tools/headers/sparkyfitnessgarmin
@@ -0,0 +1,6 @@
+   _____                  __         _______ __                          ______                     _          __  ____                                      _         
+  / ___/____  ____ ______/ /____  __/ ____(_) /_____  ___  __________   / ____/___ __________ ___  (_)___     /  |/  (_)_____________  ________  ______   __(_)_______ 
+  \__ \/ __ \/ __ `/ ___/ //_/ / / / /_  / / __/ __ \/ _ \/ ___/ ___/  / / __/ __ `/ ___/ __ `__ \/ / __ \   / /|_/ / / ___/ ___/ __ \/ ___/ _ \/ ___/ | / / / ___/ _ \
+ ___/ / /_/ / /_/ / /  / ,< / /_/ / __/ / / /_/ / / /  __(__  |__  )  / /_/ / /_/ / /  / / / / / / / / / /  / /  / / / /__/ /  / /_/ (__  )  __/ /   | |/ / / /__/  __/
+/____/ .___/\__,_/_/  /_/|_|\__, /_/   /_/\__/_/ /_/\___/____/____/   \____/\__,_/_/  /_/ /_/ /_/_/_/ /_/  /_/  /_/_/\___/_/   \____/____/\___/_/    |___/_/\___/\___/ 
+    /_/                    /____/