simono41/prometheus-paperless-exporter
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
prometheus-paperless-exporter/README.md
Michael Hanselmann f2cc188833
Some checks failed
Run tests / test (push) Has been cancelled
Details
Release / release (push) Has been cancelled
Details
Initial commit 
Signed-off-by: Michael Hanselmann <public@hansmi.ch>
2023-07-03 00:16:08 +02:00

2.3 KiB
Raw Blame History

Paperless-ngx metrics for Prometheus

Latest release Release workflow CI workflow Go reference

This repository hosts a 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.

An implementation using the API was chosen to provide the same perspective as web browsers.

Usage

prometheus-paperless-exporter listens on TCP port 8081 by default. To listen on another address use the -web.listen-address flag (e.g. -web.listen-address=127.0.0.1:3000).

TLS and HTTP basic authentication is supported through the Prometheus exporter toolkit. A configuration file can be passed to the -web.config flag (documentation).

See the --help output for more flags.

Installation

Pre-built binaries are provided for all releases:

  • Binary archives (.tar.gz)
  • Debian/Ubuntu (.deb)
  • RHEL/Fedora (.rpm)
  • Microsoft Windows (.zip)

Docker images via GitHub's container registry:

docker pull ghcr.io/hansmi/prometheus-paperless-exporter

With the source being available it's also possible to produce custom builds directly using Go or GoReleaser.