Prometheus Paperless-ngx Exporter | scripts-underground Prometheus Paperless-ngx Exporter | scripts-underground
⚠️
WARNING: Executing scripts from the internet without understanding what they do can be dangerous. This is an open frontier — always review the code before running it.

Prometheus Paperless-ngx Exporter

Runs inside an existing LXC container
bash -c "$(curl -fsSL https://raw.githubusercontent.com/scripts-underground/proxmox/main/scripts/addon/prometheus-paperless-ngx-exporter.sh)"

Prometheus Paperless-ngx Exporter

Prometheus exporter for Paperless-ngx. Scrapes the Paperless-ngx API and exposes document, tag, correspondent, storage path, task, and processing statistics as Prometheus metrics, ready to be scraped by a Prometheus server.

Notes

  • Runs inside an existing LXC container (Debian/Ubuntu only) — typically installed into the Paperless-ngx LXC itself
  • Prompts for the Paperless-ngx URL and an API authentication token (stored in /etc/prometheus-paperless-ngx-exporter/)
  • Metrics endpoint: http://<container-ip>:8081/metrics
  • Update with: update-prometheus-paperless-ngx-exporter — Uninstall with: uninstall-prometheus-paperless-ngx-exporter
  • Re-running the installer offers update/uninstall via the framework guard