3ce3c6f613
* core: add progress; fix exit status Introduce post_progress_to_api() in alpine-install.func and install.func to send a lightweight, fire-and-forget telemetry ping (HTTP POST) that updates an existing telemetry record to "configuring" when DIAGNOSTICS=yes and RANDOM_UUID is set. The function is non-blocking (curl -m 5, errors ignored) and is invoked during container setup and after OS updates to signal active progress. Also adjust api_exit_script() in build.func to report success (post_update_to_api "done" "0") for cases where the script exited normally but a completion status wasn't posted, instead of reporting failure. * Safer tools.func load and improved error handling Replace process-substitution sourcing of tools.func with an explicit curl -> variable -> source via /dev/stdin, adding failure messages and a check that expected functions (e.g. fetch_and_deploy_gh_release) are present (misc/alpine-install.func, misc/install.func). Add categorize_error mapping for exit code 10 -> "config" (misc/api.func). Tweak build.func: minor pipeline formatting and change the ERR trap to capture the actual exit code and only call ensure_log_on_host/post_update on non-zero exits, preventing erroneous failure reporting. * tools: add data init and auto-reporting to tools and pve section Introduce telemetry helpers in misc/api.func: _telemetry_report_exit (reports success/failure via post_tool_to_api/post_addon_to_api) and init_tool_telemetry (reads DIAGNOSTICS, starts install timer and installs an EXIT trap to auto-report). Integrate telemetry into many tools/addon and tools/pve scripts by sourcing the remote api.func and calling init_tool_telemetry (guarded with declare -f). Also apply a minor arithmetic formatting tweak in misc/build.func for RECOVERY_ATTEMPT.
191 lines
6.5 KiB
Bash
191 lines
6.5 KiB
Bash
#!/usr/bin/env bash
|
|
|
|
# Copyright (c) 2021-2026 community-scripts ORG
|
|
# Author: Andy Grunwald (andygrunwald)
|
|
# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
|
|
# Source: https://github.com/hansmi/prometheus-paperless-exporter
|
|
|
|
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
|
|
|
|
# Enable error handling
|
|
set -Eeuo pipefail
|
|
trap 'error_handler' ERR
|
|
load_functions
|
|
init_tool_telemetry "" "addon"
|
|
|
|
# ==============================================================================
|
|
# CONFIGURATION
|
|
# ==============================================================================
|
|
VERBOSE=${var_verbose:-no}
|
|
APP="prometheus-paperless-ngx-exporter"
|
|
APP_TYPE="tools"
|
|
BINARY_PATH="/usr/bin/prometheus-paperless-exporter"
|
|
CONFIG_PATH="/etc/prometheus-paperless-ngx-exporter/config.env"
|
|
SERVICE_PATH="/etc/systemd/system/prometheus-paperless-ngx-exporter.service"
|
|
AUTH_TOKEN_FILE="/etc/prometheus-paperless-ngx-exporter/paperless_auth_token_file"
|
|
|
|
# ==============================================================================
|
|
# 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 1
|
|
fi
|
|
|
|
# ==============================================================================
|
|
# UNINSTALL
|
|
# ==============================================================================
|
|
function uninstall() {
|
|
msg_info "Uninstalling Prometheus-Paperless-NGX-Exporter"
|
|
systemctl disable -q --now prometheus-paperless-ngx-exporter
|
|
|
|
if dpkg -l | grep -q prometheus-paperless-exporter; then
|
|
$STD apt-get remove -y prometheus-paperless-exporter || $STD dpkg -r prometheus-paperless-exporter
|
|
fi
|
|
|
|
rm -f "$SERVICE_PATH"
|
|
rm -rf /etc/prometheus-paperless-ngx-exporter
|
|
rm -f "/usr/local/bin/update_prometheus-paperless-ngx-exporter"
|
|
rm -f "$HOME/.prometheus-paperless-ngx-exporter"
|
|
msg_ok "Prometheus-Paperless-NGX-Exporter has been uninstalled"
|
|
}
|
|
|
|
# ==============================================================================
|
|
# UPDATE
|
|
# ==============================================================================
|
|
function update() {
|
|
if check_for_gh_release "prom-paperless-exp" "hansmi/prometheus-paperless-exporter"; then
|
|
msg_info "Stopping service"
|
|
systemctl stop prometheus-paperless-ngx-exporter
|
|
msg_ok "Stopped service"
|
|
|
|
fetch_and_deploy_gh_release "prom-paperless-exp" "hansmi/prometheus-paperless-exporter" "binary" "latest"
|
|
|
|
msg_info "Starting service"
|
|
systemctl start prometheus-paperless-ngx-exporter
|
|
msg_ok "Started service"
|
|
msg_ok "Updated successfully!"
|
|
exit
|
|
fi
|
|
}
|
|
|
|
# ==============================================================================
|
|
# INSTALL
|
|
# ==============================================================================
|
|
function install() {
|
|
read -erp "Enter URL of Paperless-NGX, example: (http://127.0.0.1:8000): " PAPERLESS_URL
|
|
read -rsp "Enter Paperless-NGX authentication token: " PAPERLESS_AUTH_TOKEN
|
|
printf "\n"
|
|
|
|
fetch_and_deploy_gh_release "prom-paperless-exp" "hansmi/prometheus-paperless-exporter" "binary" "latest"
|
|
|
|
msg_info "Creating configuration"
|
|
mkdir -p /etc/prometheus-paperless-ngx-exporter
|
|
cat <<EOF >"$CONFIG_PATH"
|
|
# https://github.com/hansmi/prometheus-paperless-exporter
|
|
PAPERLESS_URL="${PAPERLESS_URL}"
|
|
EOF
|
|
echo "${PAPERLESS_AUTH_TOKEN}" >"$AUTH_TOKEN_FILE"
|
|
chmod 600 "$AUTH_TOKEN_FILE"
|
|
msg_ok "Created configuration"
|
|
|
|
msg_info "Creating service"
|
|
cat <<EOF >"$SERVICE_PATH"
|
|
[Unit]
|
|
Description=Prometheus Paperless NGX Exporter
|
|
Wants=network-online.target
|
|
After=network-online.target
|
|
|
|
[Service]
|
|
User=root
|
|
EnvironmentFile=$CONFIG_PATH
|
|
ExecStart=$BINARY_PATH \\
|
|
--paperless_url=\${PAPERLESS_URL} \\
|
|
--paperless_auth_token_file=$AUTH_TOKEN_FILE
|
|
Restart=always
|
|
|
|
[Install]
|
|
WantedBy=multi-user.target
|
|
EOF
|
|
systemctl daemon-reload
|
|
systemctl enable -q --now prometheus-paperless-ngx-exporter
|
|
msg_ok "Created and started service"
|
|
|
|
# Create update script
|
|
msg_info "Creating update script"
|
|
ensure_usr_local_bin_persist
|
|
cat <<'UPDATEEOF' >/usr/local/bin/update_prometheus-paperless-ngx-exporter
|
|
#!/usr/bin/env bash
|
|
# prometheus-paperless-ngx-exporter Update Script
|
|
type=update bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/tools/addon/prometheus-paperless-ngx-exporter.sh)"
|
|
UPDATEEOF
|
|
chmod +x /usr/local/bin/update_prometheus-paperless-ngx-exporter
|
|
msg_ok "Created update script (/usr/local/bin/update_prometheus-paperless-ngx-exporter)"
|
|
|
|
echo ""
|
|
msg_ok "Prometheus-Paperless-NGX-Exporter installed successfully"
|
|
msg_ok "Metrics: ${BL}http://${LOCAL_IP}:8081/metrics${CL}"
|
|
msg_ok "Config: ${BL}${CONFIG_PATH}${CL}"
|
|
}
|
|
|
|
# ==============================================================================
|
|
# MAIN
|
|
# ==============================================================================
|
|
header_info
|
|
ensure_usr_local_bin_persist
|
|
get_lxc_ip
|
|
|
|
# Handle type=update (called from update script)
|
|
if [[ "${type:-}" == "update" ]]; then
|
|
if [[ -f "$BINARY_PATH" ]]; then
|
|
update
|
|
else
|
|
msg_error "Prometheus-Paperless-NGX-Exporter is not installed. Nothing to update."
|
|
exit 1
|
|
fi
|
|
exit 0
|
|
fi
|
|
|
|
# Check if already installed
|
|
if [[ -f "$BINARY_PATH" ]]; then
|
|
msg_warn "Prometheus-Paperless-NGX-Exporter is already installed."
|
|
echo ""
|
|
|
|
echo -n "${TAB}Uninstall Prometheus-Paperless-NGX-Exporter? (y/N): "
|
|
read -r uninstall_prompt
|
|
if [[ "${uninstall_prompt,,}" =~ ^(y|yes)$ ]]; then
|
|
uninstall
|
|
exit 0
|
|
fi
|
|
|
|
echo -n "${TAB}Update Prometheus-Paperless-NGX-Exporter? (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 "Prometheus-Paperless-NGX-Exporter is not installed."
|
|
echo ""
|
|
echo -e "${TAB}${INFO} This will install:"
|
|
echo -e "${TAB} - Prometheus Paperless NGX Exporter (binary)"
|
|
echo -e "${TAB} - Systemd service"
|
|
echo ""
|
|
|
|
echo -n "${TAB}Install Prometheus-Paperless-NGX-Exporter? (y/N): "
|
|
read -r install_prompt
|
|
if [[ "${install_prompt,,}" =~ ^(y|yes)$ ]]; then
|
|
install
|
|
else
|
|
msg_warn "Installation cancelled. Exiting."
|
|
exit 0
|
|
fi
|