rename

ct/prometheus-paperless-ngx-exporter.sh

@@ -1,52 +0,0 @@
-#!/usr/bin/env bash
-source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/build.func)
-# 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
-
-APP="Prometheus-Paperless-NGX-Exporter"
-var_tags="${var_tags:-monitoring;alerting}"
-var_cpu="${var_cpu:-1}"
-var_ram="${var_ram:-256}"
-var_disk="${var_disk:-2}"
-var_os="${var_os:-debian}"
-var_version="${var_version:-13}"
-var_unprivileged="${var_unprivileged:-1}"
-
-header_info "$APP"
-variables
-color
-catch_errors
-
-function update_script() {
-  header_info
-  check_container_storage
-  check_container_resources
-  if [[ ! -f /etc/systemd/system/prometheus-paperless-ngx-exporter.service ]]; then
-    msg_error "No ${APP} Installation Found!"
-    exit
-  fi
-  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"
-
-    msg_info "Starting Service"
-    systemctl start prometheus-paperless-ngx-exporter
-    msg_ok "Started Service"
-    msg_ok "Updated successfully!"
-  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}:8081/metrics${CL}"

frontend/public/json/prometheus-paperless-ngx-exporter.json

@@ -1,44 +1,35 @@
 {
-    "name": "Prometheus Paperless NGX Exporter",
+  "name": "Prometheus Paperless NGX Exporter",
-    "slug": "prometheus-paperless-ngx-exporter",
+  "slug": "prometheus-paperless-ngx-exporter",
-    "categories": [
+  "categories": [
-        9
+    9
-    ],
+  ],
-    "date_created": "2025-02-07",
+  "date_created": "2025-02-07",
-    "type": "ct",
+  "type": "addon",
-    "updateable": true,
+  "updateable": true,
-    "privileged": false,
+  "privileged": false,
-    "interface_port": 8081,
+  "interface_port": 8081,
-    "documentation": null,
+  "documentation": "https://github.com/hansmi/prometheus-paperless-exporter",
-    "website": "https://github.com/hansmi/prometheus-paperless-exporter",
+  "website": "https://github.com/hansmi/prometheus-paperless-exporter",
-    "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/paperless-ngx.webp",
+  "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/paperless-ngx.webp",
-    "config_path": "",
+  "config_path": "/etc/prometheus-paperless-ngx-exporter/config.env",
-    "description": "Prometheus metrics exporter for Paperless-NGX, a document management system transforming physical documents into a searchable online archive. The exporter relies on Paperless' REST API.",
+  "description": "Prometheus metrics exporter for Paperless-NGX, a document management system transforming physical documents into a searchable online archive. The exporter relies on Paperless' REST API.",
-    "install_methods": [
+  "install_methods": [
-        {
+    {
-            "type": "default",
+      "type": "default",
-            "script": "ct/prometheus-paperless-ngx-exporter.sh",
+      "script": "tools/addon/prometheus-paperless-ngx-exporter.sh",
-            "resources": {
+      "resources": {
-                "cpu": 1,
+        "cpu": null,
-                "ram": 256,
+        "ram": null,
-                "hdd": 2,
+        "hdd": null,
-                "os": "debian",
+        "os": null,
-                "version": "13"
+        "version": null
-            }
+      }
-        }
+    }
-    ],
+  ],
-    "default_credentials": {
+  "default_credentials": {
-        "username": null,
+    "username": null,
-        "password": null
+    "password": null
-    },
+  },
-    "notes": [
+  "notes": []
-        {
-            "text": "Please adjust the Paperless URL in the systemd unit file: /etc/systemd/system/prometheus-paperless-ngx-exporter.service",
-            "type": "info"
-        },
-        {
-            "text": "Please adjust the Paperless authentication token in the configuration file: /etc/prometheus-paperless-ngx-exporter/paperless_auth_token_file",
-            "type": "info"
-        }
-    ]
 }

install/prometheus-paperless-ngx-exporter-install.sh

@@ -1,47 +0,0 @@
-#!/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 /dev/stdin <<<"$FUNCTIONS_FILE_PATH"
-color
-verb_ip6
-catch_errors
-setting_up_container
-network_check
-update_os
-
-fetch_and_deploy_gh_release "prom-paperless-exp" "hansmi/prometheus-paperless-exporter" "binary"
-
-msg_info "Configuring Prometheus Paperless NGX Exporter"
-mkdir -p /etc/prometheus-paperless-ngx-exporter
-echo "SECRET_AUTH_TOKEN" >/etc/prometheus-paperless-ngx-exporter/paperless_auth_token_file
-msg_ok "Configured Prometheus Paperless NGX Exporter"
-
-msg_info "Creating Service"
-cat <<EOF >/etc/systemd/system/prometheus-paperless-ngx-exporter.service
-[Unit]
-Description=Prometheus Paperless NGX Exporter
-Wants=network-online.target
-After=network-online.target
-
-[Service]
-User=root
-Restart=always
-Type=simple
-ExecStart=/usr/bin/prometheus-paperless-exporter \
-    --paperless_url=http://paperless.example.org \
-    --paperless_auth_token_file=/etc/prometheus-paperless-ngx-exporter/paperless_auth_token_file
-ExecReload=/bin/kill -HUP \$MAINPID
-
-[Install]
-WantedBy=multi-user.target
-EOF
-systemctl enable -q --now prometheus-paperless-ngx-exporter
-msg_ok "Created Service"
-
-motd_ssh
-customize
-cleanup_lxc

tools/addon/prometheus-paperless-ngx-exporter.sh

@@ -0,0 +1,188 @@
+#!/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)
+
+# Enable error handling
+set -Eeuo pipefail
+trap 'error_handler' ERR
+load_functions
+
+# ==============================================================================
+# 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