87 lines
3.1 KiB
Markdown
87 lines
3.1 KiB
Markdown
# Paperless-ngx metrics for Prometheus
|
|
|
|
[][releases]
|
|
[](https://github.com/hansmi/prometheus-paperless-exporter/actions/workflows/release.yaml)
|
|
[](https://github.com/hansmi/prometheus-paperless-exporter/actions/workflows/ci.yaml)
|
|
[](https://pkg.go.dev/github.com/hansmi/prometheus-paperless-exporter)
|
|
|
|
This repository hosts a Prometheus metrics exporter for
|
|
[Paperless-ngx][paperless], a document management system transforming physical
|
|
documents into a searchable online archive. The exporter relies on [Paperless'
|
|
REST API][paperless-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][toolkit]. A configuration file can be passed to the `-web.config` flag
|
|
([documentation][toolkitconfig]).
|
|
|
|
See the `--help` output for more flags.
|
|
|
|
|
|
## Permissions
|
|
|
|
Since late 2023 Paperless-ngx [supports object
|
|
permissions][paperless-permissions]. The metrics user requires _view_
|
|
permissions on the following types:
|
|
|
|
* Admin
|
|
* Required for log analysis.
|
|
* Starting with version 2.8 there is no distinction between different access
|
|
modes ([paperless-ngx#6380](https://github.com/paperless-ngx/paperless-ngx/pull/6380)).
|
|
* Correspondent
|
|
* Document
|
|
* DocumentType
|
|
* PaperlessTask
|
|
* StoragePath
|
|
* Tag
|
|
|
|
|
|
## Installation
|
|
|
|
Pre-built binaries are provided for [all releases][releases]:
|
|
|
|
* Binary archives (`.tar.gz`)
|
|
* Debian/Ubuntu (`.deb`)
|
|
* RHEL/Fedora (`.rpm`)
|
|
* Microsoft Windows (`.zip`)
|
|
|
|
Docker images via GitHub's container registry:
|
|
|
|
```shell
|
|
docker pull ghcr.io/hansmi/prometheus-paperless-exporter
|
|
```
|
|
|
|
With the source being available it's also possible to produce custom builds
|
|
directly using [Go][golang] or [GoReleaser][goreleaser].
|
|
|
|
|
|
### Docker Compose
|
|
|
|
An example configuration for [Docker Compose][dockercompose] is available in
|
|
`contrib/docker-compose`:
|
|
|
|
```shell
|
|
env --chdir contrib/docker-compose docker-compose up
|
|
```
|
|
|
|
|
|
[dockercompose]: https://docs.docker.com/compose/
|
|
[golang]: https://golang.org/
|
|
[goreleaser]: https://goreleaser.com/
|
|
[paperless-api]: https://docs.paperless-ngx.com/api/
|
|
[paperless]: https://docs.paperless-ngx.com/
|
|
[paperless-permissions]: https://docs.paperless-ngx.com/usage/#permissions
|
|
[releases]: https://github.com/hansmi/prometheus-paperless-exporter/releases/latest
|
|
[toolkit]: https://github.com/prometheus/exporter-toolkit
|
|
[toolkitconfig]: https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md
|
|
|
|
<!-- vim: set sw=2 sts=2 et : -->
|