Add garmin-grafana scripts
This commit is contained in:
Aliaksei Pilko
parent
83f9822902
commit
89cf0e3b52
112
ct/garmin-grafana.sh
Normal file
112
ct/garmin-grafana.sh
Normal file
@ -0,0 +1,112 @@
|
||||
#!/usr/bin/env bash
|
||||
source <(curl -fsSL https://raw.githubusercontent.com/aliaksei135/ProxmoxVE/refs/heads/garmin-grafana/misc/build.func)
|
||||
# Copyright (c) 2021-2025 community-scripts ORG
|
||||
# Author: aliaksei135
|
||||
# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
|
||||
# Source: https://github.com/arpanghosh8453/garmin-grafana
|
||||
|
||||
APP="garmin-grafana"
|
||||
var_tags="${var_tags:-sports;visualization}"
|
||||
var_cpu="${var_cpu:-2}"
|
||||
var_ram="${var_ram:-2048}"
|
||||
var_disk="${var_disk:-8}"
|
||||
var_os="${var_os:-debian}"
|
||||
var_version="${var_version:-12}"
|
||||
var_unprivileged="${var_unprivileged:-1}"
|
||||
|
||||
header_info "$APP"
|
||||
variables
|
||||
color
|
||||
catch_errors
|
||||
|
||||
# this only updates garmin-grafana, not influxdb or grafana, which are upgraded with apt
|
||||
function update_script() {
|
||||
header_info
|
||||
check_container_storage
|
||||
check_container_resources
|
||||
|
||||
# Check if installation is present | -f for file, -d for folder
|
||||
if [[ ! -d /opt/garmin-grafana/ ]]; then
|
||||
msg_error "No ${APP} Installation Found!"
|
||||
exit
|
||||
fi
|
||||
|
||||
# Crawling the new version and checking whether an update is required
|
||||
RELEASE=$(curl -fsSL https://api.github.com/repos/arpanghosh8453/garmin-grafana/releases/latest | grep "tag_name" | awk '{print substr($2, 2, length($2)-3) }')
|
||||
if [[ ! -d /opt/garmin-grafana/ ]] || [[ "${RELEASE}" != "$(cat /opt/${APP}_version.txt)" ]] || [[ ! -f /opt/${APP}_version.txt ]]; then
|
||||
# Stopping Services
|
||||
msg_info "Stopping $APP"
|
||||
systemctl stop garmin-grafana
|
||||
systemctl stop grafana-server
|
||||
systemctl stop influxdb
|
||||
msg_ok "Stopped $APP"
|
||||
|
||||
# Get required environment variables from the .env file
|
||||
if [[ ! -f /opt/garmin-grafana/.env ]]; then
|
||||
msg_error "No .env file found in /opt/garmin-grafana/.env"
|
||||
exit
|
||||
fi
|
||||
source /opt/garmin-grafana/.env
|
||||
if [[ -z "${INFLUXDB_USER}" || -z "${INFLUXDB_PASSWORD}" || -z "${INFLUXDB_NAME}" ]]; then
|
||||
msg_error "INFLUXDB_USER, INFLUXDB_PASSWORD, or INFLUXDB_NAME not set in .env file"
|
||||
exit
|
||||
fi
|
||||
|
||||
# Creating Backup
|
||||
msg_info "Creating Backup"
|
||||
tar -czf "/opt/${APP}_backup_$(date +%F).tar.gz" /opt/garmin-grafana/.garminconnect /opt/garmin-grafana/.env
|
||||
mv /opt/garmin-grafana/ /opt/garmin-grafana-backup/
|
||||
msg_ok "Backup Created"
|
||||
|
||||
# Execute Update
|
||||
msg_info "Updating $APP to v${RELEASE}"
|
||||
curl -fsSL -o "${RELEASE}.zip" "https://github.com/arpanghosh8453/garmin-grafana/archive/refs/tags/${RELEASE}.zip"
|
||||
unzip -q "${RELEASE}.zip"
|
||||
mv "garmin-grafana-${RELEASE}/" "/opt/garmin-grafana"
|
||||
rm -f "${RELEASE}.zip"
|
||||
# Install python dependencies with uv
|
||||
$STD uv sync --locked --project /opt/garmin-grafana/
|
||||
# Setup grafana provisioning configs
|
||||
# shellcheck disable=SC2016
|
||||
sed -i 's/\${DS_GARMIN_STATS}/garmin_influxdb/g' /opt/garmin-grafana/Grafana_Dashboard/Garmin-Grafana-Dashboard.json
|
||||
sed -i 's/influxdb:8086/localhost:8086/' /opt/garmin-grafana/Grafana_Datasource/influxdb.yaml
|
||||
sed -i "s/influxdb_user/${INFLUXDB_USER}/" /opt/garmin-grafana/Grafana_Datasource/influxdb.yaml
|
||||
sed -i "s/influxdb_secret_password/${INFLUXDB_PASSWORD}/" /opt/garmin-grafana/Grafana_Datasource/influxdb.yaml
|
||||
sed -i "s/GarminStats/${INFLUXDB_NAME}/" /opt/garmin-grafana/Grafana_Datasource/influxdb.yaml
|
||||
# Copy across grafana data
|
||||
cp -r /opt/garmin-grafana/Grafana_Datasource/* /etc/grafana/provisioning/datasources
|
||||
cp -r /opt/garmin-grafana/Grafana_Dashboard/* /etc/grafana/provisioning/dashboards
|
||||
# Copy back the env and token files
|
||||
cp /opt/garmin-grafana-backup/.env /opt/garmin-grafana/.env
|
||||
cp -r /opt/garmin-grafana-backup/.garminconnect /opt/garmin-grafana/.garminconnect
|
||||
msg_ok "Updated $APP to v${RELEASE}"
|
||||
|
||||
# Starting Services
|
||||
msg_info "Starting $APP"
|
||||
systemctl start garmin-grafana
|
||||
systemctl start grafana-server
|
||||
systemctl start influxdb
|
||||
msg_ok "Started $APP"
|
||||
|
||||
# Cleaning up
|
||||
msg_info "Cleaning Up"
|
||||
rm -rf /opt/garmin-grafana-backup
|
||||
msg_ok "Cleanup Completed"
|
||||
|
||||
# Last Action
|
||||
echo "${RELEASE}" >/opt/${APP}_version.txt
|
||||
msg_ok "Update Successful"
|
||||
else
|
||||
msg_ok "No update required. ${APP} is already at v${RELEASE}"
|
||||
fi
|
||||
exit
|
||||
}
|
||||
|
||||
start
|
||||
build_container
|
||||
description
|
||||
|
||||
msg_ok "Completed Successfully!\n"
|
||||
echo -e "${CREATING}${GN}${APP} setup has been successfully initialized!${CL}"
|
||||
echo -e "${INFO}${YW} Access it using the following URL:${CL}"
|
||||
echo -e "${TAB}${GATEWAY}${BGN}http://${IP}:3000${CL}"
|
||||
44
frontend/public/json/garmin-grafana.json
Normal file
44
frontend/public/json/garmin-grafana.json
Normal file
@ -0,0 +1,44 @@
|
||||
{
|
||||
"name": "garmin-grafana",
|
||||
"slug": "garmin-grafana",
|
||||
"categories": [
|
||||
24
|
||||
],
|
||||
"date_created": "2025-05-08",
|
||||
"type": "ct",
|
||||
"updateable": true,
|
||||
"privileged": false,
|
||||
"interface_port": 3000,
|
||||
"documentation": "https://github.com/arpanghosh8453/garmin-grafana",
|
||||
"config_path": "",
|
||||
"website": "https://github.com/arpanghosh8453/garmin-grafana",
|
||||
"logo": "https://github.com/arpanghosh8453/garmin-grafana/raw/refs/heads/main/Extra/Garmin-Grafana-Logo.svg",
|
||||
"description": "A docker container to fetch data from Garmin servers and store the data in a local influxdb database for appealing visualization with Grafana.",
|
||||
"install_methods": [
|
||||
{
|
||||
"type": "default",
|
||||
"script": "ct/garmin-grafana.sh",
|
||||
"resources": {
|
||||
"cpu": 2,
|
||||
"ram": 2,
|
||||
"hdd": 8,
|
||||
"os": "Debian",
|
||||
"version": "12"
|
||||
}
|
||||
}
|
||||
],
|
||||
"default_credentials": {
|
||||
"username": null,
|
||||
"password": null
|
||||
},
|
||||
"notes": [
|
||||
{
|
||||
"text": "Show login and database credentials: `cat ~/.garmin-grafana.creds`",
|
||||
"type": "info"
|
||||
},
|
||||
{
|
||||
"text": "`garmin-grafana` only imports the past 7 days by default. To import historical data, use the `~/bulk-import.sh` script after installation.",
|
||||
"type": "info"
|
||||
}
|
||||
]
|
||||
}
|
||||
226
install/garmin-grafana-install.sh
Normal file
226
install/garmin-grafana-install.sh
Normal file
@ -0,0 +1,226 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
# Copyright (c) 2021-2025 community-scripts ORG
|
||||
# Author: aliaksei135
|
||||
# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
|
||||
# Source: https://github.com/arpanghosh8453/garmin-grafana
|
||||
|
||||
# Import Functions und Setup
|
||||
source /dev/stdin <<<"$FUNCTIONS_FILE_PATH"
|
||||
color
|
||||
verb_ip6
|
||||
catch_errors
|
||||
setting_up_container
|
||||
network_check
|
||||
update_os
|
||||
|
||||
# Installing Dependencies
|
||||
msg_info "Installing Dependencies"
|
||||
# Grafana dependencies
|
||||
$STD apt-get install -y gnupg
|
||||
$STD apt-get install -y apt-transport-https
|
||||
$STD apt-get install -y software-properties-common
|
||||
# Influx dependencies
|
||||
$STD apt-get install -y lsb-base
|
||||
$STD apt-get install -y lsb-release
|
||||
$STD apt-get install -y gnupg2
|
||||
# garmin-grafana dependencies
|
||||
$STD apt-get install -y python3
|
||||
$STD apt-get install -y python3-requests
|
||||
$STD apt-get install -y python3-dotenv
|
||||
setup_uv
|
||||
msg_ok "Installed Dependencies"
|
||||
|
||||
msg_info "Setting up InfluxDB Repository"
|
||||
curl -fsSL "https://repos.influxdata.com/influxdata-archive_compat.key" | gpg --dearmor >/etc/apt/trusted.gpg.d/influxdata-archive_compat.gpg
|
||||
echo "deb [signed-by=/etc/apt/trusted.gpg.d/influxdata-archive_compat.gpg] https://repos.influxdata.com/debian stable main" >/etc/apt/sources.list.d/influxdata.list
|
||||
msg_ok "Set up InfluxDB Repository"
|
||||
|
||||
# garmin-grafana recommends influxdb v1
|
||||
# this install chronograf, which is the UI for influxdb. this might be overkill?
|
||||
msg_info "Installing InfluxDB"
|
||||
$STD apt-get update
|
||||
$STD apt-get install -y influxdb
|
||||
curl -fsSL "https://dl.influxdata.com/chronograf/releases/chronograf_1.10.7_amd64.deb" -o "$(basename "https://dl.influxdata.com/chronograf/releases/chronograf_1.10.7_amd64.deb")"
|
||||
$STD dpkg -i chronograf_1.10.7_amd64.deb
|
||||
msg_ok "Installed InfluxDB"
|
||||
|
||||
msg_info "Setting up InfluxDB"
|
||||
# Patch the config file to use the tsi1 index
|
||||
$STD sed -i 's/# index-version = "inmem"/index-version = "tsi1"/' /etc/influxdb/influxdb.conf
|
||||
|
||||
# Create InfluxDB user and database
|
||||
INFLUXDB_USER="garmin_grafana_user"
|
||||
INFLUXDB_PASSWORD=$(openssl rand -base64 18 | tr -dc 'a-zA-Z0-9' | cut -c1-13)
|
||||
INFLUXDB_NAME="GarminStats"
|
||||
$STD influx -execute "CREATE DATABASE ${INFLUXDB_NAME}"
|
||||
$STD influx -execute "CREATE USER ${INFLUXDB_USER} WITH PASSWORD '${INFLUXDB_PASSWORD}'"
|
||||
$STD influx -execute "GRANT ALL ON ${INFLUXDB_NAME} TO ${INFLUXDB_USER}"
|
||||
# Start the service
|
||||
$STD systemctl enable --now influxdb
|
||||
msg_ok "Set up InfluxDB"
|
||||
|
||||
msg_info "Setting up Grafana Repository"
|
||||
curl -fsSL "https://apt.grafana.com/gpg.key" -o "/usr/share/keyrings/grafana.key"
|
||||
sh -c 'echo "deb [signed-by=/usr/share/keyrings/grafana.key] https://apt.grafana.com stable main" > /etc/apt/sources.list.d/grafana.list'
|
||||
msg_ok "Set up Grafana Repository"
|
||||
|
||||
msg_info "Installing Grafana"
|
||||
$STD apt-get update
|
||||
$STD apt-get install -y grafana
|
||||
systemctl start grafana-server
|
||||
systemctl daemon-reload
|
||||
systemctl enable --now -q grafana-server.service
|
||||
# This avoids the "database is locked" error when running the grafana-cli
|
||||
sleep 20
|
||||
msg_ok "Installed Grafana"
|
||||
|
||||
msg_info "Setting up Grafana"
|
||||
GRAFANA_USER="admin"
|
||||
GRAFANA_PASS=$(openssl rand -base64 18 | tr -dc 'a-zA-Z0-9' | cut -c1-13)
|
||||
# Create Grafana user
|
||||
$STD grafana-cli admin reset-admin-password "${GRAFANA_PASS}"
|
||||
# # Install plugins
|
||||
$STD grafana-cli plugins install marcusolsson-hourly-heatmap-panel
|
||||
$STD systemctl restart grafana-server
|
||||
# Output credentials to file
|
||||
{
|
||||
echo "Grafana Credentials"
|
||||
echo "Grafana User: ${GRAFANA_USER}"
|
||||
echo "Grafana Password: ${GRAFANA_PASS}"
|
||||
} >>~/garmin-grafana.creds
|
||||
msg_ok "Set up Grafana"
|
||||
|
||||
# Setup App
|
||||
msg_info "Installing garmin-grafana"
|
||||
RELEASE=$(curl -fsSL https://api.github.com/repos/arpanghosh8453/garmin-grafana/releases/latest | grep "tag_name" | awk '{print substr($2, 2, length($2)-3) }')
|
||||
curl -fsSL -o "${RELEASE}.zip" "https://github.com/arpanghosh8453/garmin-grafana/archive/refs/tags/${RELEASE}.zip"
|
||||
unzip -q "${RELEASE}.zip"
|
||||
# Remove the v prefix to RELEASE if it exists
|
||||
if [[ "${RELEASE}" == v* ]]; then
|
||||
RELEASE="${RELEASE:1}"
|
||||
fi
|
||||
mv "garmin-grafana-${RELEASE}/" "/opt/garmin-grafana"
|
||||
# Create dir for garmin tokens
|
||||
mkdir -p /opt/garmin-grafana/.garminconnect
|
||||
# Install python dependencies with uv
|
||||
$STD uv sync --locked --project /opt/garmin-grafana/
|
||||
# Setup grafana provisioning configs
|
||||
# shellcheck disable=SC2016
|
||||
sed -i 's/\${DS_GARMIN_STATS}/garmin_influxdb/g' /opt/garmin-grafana/Grafana_Dashboard/Garmin-Grafana-Dashboard.json
|
||||
sed -i 's/influxdb:8086/localhost:8086/' /opt/garmin-grafana/Grafana_Datasource/influxdb.yaml
|
||||
sed -i "s/influxdb_user/${INFLUXDB_USER}/" /opt/garmin-grafana/Grafana_Datasource/influxdb.yaml
|
||||
sed -i "s/influxdb_secret_password/${INFLUXDB_PASSWORD}/" /opt/garmin-grafana/Grafana_Datasource/influxdb.yaml
|
||||
sed -i "s/GarminStats/${INFLUXDB_NAME}/" /opt/garmin-grafana/Grafana_Datasource/influxdb.yaml
|
||||
# Copy across grafana data
|
||||
cp -r /opt/garmin-grafana/Grafana_Datasource/* /etc/grafana/provisioning/datasources
|
||||
cp -r /opt/garmin-grafana/Grafana_Dashboard/* /etc/grafana/provisioning/dashboards
|
||||
echo "${RELEASE}" >"/opt/garmin-grafana_version.txt"
|
||||
msg_ok "Installed garmin-grafana"
|
||||
|
||||
msg_info "Setting up garmin-grafana"
|
||||
# Check if using Chinese garmin servers
|
||||
read -rp "Are you using Garmin in mainland China? (y/N): " prompt
|
||||
if [[ "${prompt,,}" =~ ^(y|yes|Y)$ ]]; then
|
||||
GARMIN_CN="True"
|
||||
else
|
||||
GARMIN_CN="False"
|
||||
fi
|
||||
|
||||
# Setup environment variables
|
||||
cat <<EOF >/opt/garmin-grafana/.env
|
||||
INFLUXDB_HOST=localhost
|
||||
INFLUXDB_PORT=8086
|
||||
INFLUXDB_ENDPOINT_IS_HTTP=True
|
||||
INFLUXDB_USERNAME=${INFLUXDB_USER}
|
||||
INFLUXDB_PASSWORD=${INFLUXDB_PASSWORD}
|
||||
INFLUXDB_DATABASE=${INFLUXDB_NAME}
|
||||
GARMIN_IS_CN=${GARMIN_CN}
|
||||
TOKEN_DIR=/opt/garmin-grafana/.garminconnect
|
||||
EOF
|
||||
|
||||
# garmin-grafana usually prompts the user for email and password (and MFA) on first run,
|
||||
# then stores a refreshable token. We try to avoid storing user credentials in the env vars
|
||||
if [ -z "$(ls -A /opt/garmin-grafana/.garminconnect)" ]; then
|
||||
# Get the email and password from the user
|
||||
read -r -p "Please enter your Garmin Connect Email: " GARMIN_EMAIL
|
||||
read -r -p "Please enter your Garmin Connect Password (this is used to generate a token and NOT stored): " GARMIN_PASSWORD
|
||||
read -r -p "Please enter your MFA Code (if applicable, leave blank if not): " GARMIN_MFA
|
||||
# Run the script once to prompt for credential
|
||||
msg_info "Creating Garmin credentials, this will timeout in 60 seconds"
|
||||
timeout 60s uv run --env-file /opt/garmin-grafana/.env --project /opt/garmin-grafana/ /opt/garmin-grafana/src/garmin_grafana/garmin_fetch.py <<EOF
|
||||
${GARMIN_EMAIL}
|
||||
${GARMIN_PASSWORD}
|
||||
${GARMIN_MFA}
|
||||
EOF
|
||||
# Clear the credentials from the terminal
|
||||
unset GARMIN_EMAIL
|
||||
unset GARMIN_PASSWORD
|
||||
unset GARMIN_MFA
|
||||
# Check if there is anything in the token dir now
|
||||
if [ -z "$(ls -A /opt/garmin-grafana/.garminconnect)" ]; then
|
||||
msg_error "Failed to create a token"
|
||||
exit
|
||||
fi
|
||||
fi
|
||||
|
||||
# Restart Grafana to pick up the provisioned data sources and dashboards
|
||||
$STD systemctl restart grafana-server
|
||||
|
||||
# Add a script to make the manual bulk data import easier
|
||||
cat <<EOF >~/bulk-import.sh
|
||||
#!/usr/bin/env bash
|
||||
if [[ -z \$1 ]]; then
|
||||
echo "Usage: \$0 <start_date> <end_date>"
|
||||
echo "Example: \$0 2023-01-01 2023-01-31"
|
||||
echo "Date format: YYYY-MM-DD"
|
||||
echo "This will import data from the start_date to the end_date (inclusive)"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
START_DATE="\$1"
|
||||
if [[ -z \$2 ]]; then
|
||||
END_DATE="\$(date +%Y-%m-%d)"
|
||||
echo "No end date provided, using today as end date: \${END_DATE}"
|
||||
else
|
||||
END_DATE="\$2"
|
||||
fi
|
||||
|
||||
# Stop the service if running
|
||||
systemctl stop garmin-grafana
|
||||
|
||||
MANUAL_START_DATE="\${START_DATE}" MANUAL_END_DATE="\${END_DATE}" uv run --env-file /opt/garmin-grafana/.env --project /opt/garmin-grafana/ /opt/garmin-grafana/src/garmin_grafana/garmin_fetch.py
|
||||
|
||||
# Restart the service
|
||||
systemctl start garmin-grafana
|
||||
EOF
|
||||
chmod +x ~/bulk-import.sh
|
||||
msg_ok "Set up garmin-grafana"
|
||||
|
||||
# Creating Service (if needed)
|
||||
msg_info "Creating Service"
|
||||
cat <<EOF >/etc/systemd/system/garmin-grafana.service
|
||||
[Unit]
|
||||
Description=garmin-grafana Service
|
||||
After=network.target
|
||||
|
||||
[Service]
|
||||
ExecStart=uv run --project /opt/garmin-grafana/ /opt/garmin-grafana/src/garmin_grafana/garmin_fetch.py
|
||||
Restart=always
|
||||
EnvironmentFile=/opt/garmin-grafana/.env
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
EOF
|
||||
systemctl enable -q --now garmin-grafana
|
||||
msg_ok "Created Service"
|
||||
|
||||
motd_ssh
|
||||
customize
|
||||
|
||||
# Cleanup
|
||||
msg_info "Cleaning up"
|
||||
rm -f "${RELEASE}".zip
|
||||
$STD apt-get -y autoremove
|
||||
$STD apt-get -y autoclean
|
||||
msg_ok "Cleaned"
|
||||
Loading…
x
Reference in New Issue
Block a user