No description

Find a file

dependabot[bot] 70cb721d80 Bump github.com/prometheus/common from 0.49.0 to 0.50.0 Bumps [github.com/prometheus/common](https://github.com/prometheus/common) from 0.49.0 to 0.50.0. - [Release notes](https://github.com/prometheus/common/releases) - [Commits](https://github.com/prometheus/common/compare/v0.49.0...v0.50.0) --- updated-dependencies: - dependency-name: github.com/prometheus/common dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>		2024-03-12 21:36:04 +01:00
.github	Bump hansmi/ghactions-go-test-workflow from 0.1 to 0.2	2024-02-19 20:01:25 +01:00
contrib	Add a docker-compose example for using the exporter	2024-01-06 10:07:20 +01: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/prometheus/common from 0.49.0 to 0.50.0	2024-03-12 21:36:04 +01:00
go.sum	Bump github.com/prometheus/common from 0.49.0 to 0.50.0	2024-03-12 21:36:04 +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	Bump github.com/prometheus/common from 0.49.0 to 0.50.0	2024-03-12 21:36:04 +01:00
multicollector.go	Initial commit	2023-07-03 00:16:08 +02:00
README.md	Add a docker-compose example for using the exporter	2024-01-06 10:07:20 +01: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

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.

Permissions

Since late 2023 Paperless-ngx supports object permissions. The metrics user requires view permissions on the following types:

Admin (for logs)
Correspondent
Document
DocumentType
PaperlessTask
StoragePath
Tag

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.

Docker Compose

An example configuration for Docker Compose is available in contrib/docker-compose:

env --chdir contrib/docker-compose docker-compose up