simono41/prometheus-paperless-exporter
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Document required permissions

Browse source
This commit is contained in:
Michael Hanselmann 2024-01-06 09:48:40 +01:00
parent 1ea94be58d
commit 468acf13c1
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -27,6 +27,21 @@ toolkit][toolkit]. A configuration file can be passed to the `-web.config` flag
See the `--help` output for more flags. 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 (for logs)
* Correspondent
* Document
* DocumentType
* PaperlessTask
* StoragePath
* Tag
## Installation ## Installation
Pre-built binaries are provided for [all releases][releases]: Pre-built binaries are provided for [all releases][releases]:
@ -50,6 +65,7 @@ directly using [Go][golang] or [GoReleaser][goreleaser].
[goreleaser]: https://goreleaser.com/ [goreleaser]: https://goreleaser.com/
[paperless-api]: https://docs.paperless-ngx.com/api/ [paperless-api]: https://docs.paperless-ngx.com/api/
[paperless]: https://docs.paperless-ngx.com/ [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 [releases]: https://github.com/hansmi/prometheus-paperless-exporter/releases/latest
[toolkit]: https://github.com/prometheus/exporter-toolkit [toolkit]: https://github.com/prometheus/exporter-toolkit
[toolkitconfig]: https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md [toolkitconfig]: https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md