simono41/prometheus-paperless-exporter
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
12 commits 1 branch 4 tags 82 KiB
Go 97.7%
Shell 1.3%
Dockerfile 1%
Find a file
dependabot[bot] 532cd0413e Bump github.com/hansmi/paperhooks from 0.0.5 to 0.0.6 
Bumps [github.com/hansmi/paperhooks](https://github.com/hansmi/paperhooks) from 0.0.5 to 0.0.6.
- [Commits](https://github.com/hansmi/paperhooks/compare/v0.0.5...v0.0.6)

---
updated-dependencies:
- dependency-name: github.com/hansmi/paperhooks
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-12-21 00:04:48 +01:00
.github Switch to versioned workflow for GoReleaser 2023-12-11 23:10:18 +01:00
contrib Initial commit 2023-07-03 00:16:08 +02:00
internal Initial commit 2023-07-03 00:16:08 +02:00
.gitignore Initial commit 2023-07-03 00:16:08 +02:00
.goreleaser.yml Initial commit 2023-07-03 00:16:08 +02:00
collector.go Initial commit 2023-07-03 00:16:08 +02:00
collector_test.go Initial commit 2023-07-03 00:16:08 +02:00
correspondent.go Bump github.com/hansmi/paperhooks from 0.0.3 to 0.0.4 2023-07-27 00:14:04 +02:00
correspondent_test.go Bump github.com/hansmi/paperhooks from 0.0.3 to 0.0.4 2023-07-27 00:14:04 +02:00
documenttype.go Bump github.com/hansmi/paperhooks from 0.0.3 to 0.0.4 2023-07-27 00:14:04 +02:00
documenttype_test.go Bump github.com/hansmi/paperhooks from 0.0.3 to 0.0.4 2023-07-27 00:14:04 +02:00
go.mod Bump github.com/hansmi/paperhooks from 0.0.5 to 0.0.6 2023-12-21 00:04:48 +01:00
go.sum Bump github.com/hansmi/paperhooks from 0.0.5 to 0.0.6 2023-12-21 00:04:48 +01:00
LICENSE Initial commit 2023-07-03 00:16:08 +02:00
log.go Initial commit 2023-07-03 00:16:08 +02:00
log_test.go Initial commit 2023-07-03 00:16:08 +02:00
main.go Initial commit 2023-07-03 00:16:08 +02:00
multicollector.go Initial commit 2023-07-03 00:16:08 +02:00
README.md Initial commit 2023-07-03 00:16:08 +02:00
storagepath.go Bump github.com/hansmi/paperhooks from 0.0.3 to 0.0.4 2023-07-27 00:14:04 +02:00
storagepath_test.go Bump github.com/hansmi/paperhooks from 0.0.3 to 0.0.4 2023-07-27 00:14:04 +02:00
tag.go Bump github.com/hansmi/paperhooks from 0.0.3 to 0.0.4 2023-07-27 00:14:04 +02:00
tag_test.go Bump github.com/hansmi/paperhooks from 0.0.3 to 0.0.4 2023-07-27 00:14:04 +02:00
task.go Initial commit 2023-07-03 00:16:08 +02:00
task_test.go Initial commit 2023-07-03 00:16:08 +02:00

README.md

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.