{"id":21289434,"url":"https://github.com/hansmi/prometheus-paperless-exporter","last_synced_at":"2026-03-01T12:34:34.233Z","repository":{"id":178177627,"uuid":"661451790","full_name":"hansmi/prometheus-paperless-exporter","owner":"hansmi","description":"Paperless-ngx metrics for Prometheus","archived":false,"fork":false,"pushed_at":"2025-07-01T18:44:17.000Z","size":103,"stargazers_count":49,"open_issues_count":6,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-01T19:39:34.910Z","etag":null,"topics":["metrics","monitoring","paperless","paperless-ngx","prometheus-exporter"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hansmi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-07-02T22:13:43.000Z","updated_at":"2025-07-01T18:44:20.000Z","dependencies_parsed_at":null,"dependency_job_id":"6926a1e0-3c49-40ca-8d96-1a151b1e3906","html_url":"https://github.com/hansmi/prometheus-paperless-exporter","commit_stats":null,"previous_names":["hansmi/prometheus-paperless-exporter"],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/hansmi/prometheus-paperless-exporter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hansmi%2Fprometheus-paperless-exporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hansmi%2Fprometheus-paperless-exporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hansmi%2Fprometheus-paperless-exporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hansmi%2Fprometheus-paperless-exporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hansmi","download_url":"https://codeload.github.com/hansmi/prometheus-paperless-exporter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hansmi%2Fprometheus-paperless-exporter/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264833279,"owners_count":23670617,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["metrics","monitoring","paperless","paperless-ngx","prometheus-exporter"],"created_at":"2024-11-21T12:40:11.113Z","updated_at":"2026-03-01T12:34:33.854Z","avatar_url":"https://github.com/hansmi.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Paperless-ngx metrics for Prometheus\n\n[![Latest release](https://img.shields.io/github/v/release/hansmi/prometheus-paperless-exporter)][releases]\n[![Release workflow](https://github.com/hansmi/prometheus-paperless-exporter/actions/workflows/release.yaml/badge.svg)](https://github.com/hansmi/prometheus-paperless-exporter/actions/workflows/release.yaml)\n[![CI workflow](https://github.com/hansmi/prometheus-paperless-exporter/actions/workflows/ci.yaml/badge.svg)](https://github.com/hansmi/prometheus-paperless-exporter/actions/workflows/ci.yaml)\n[![Go reference](https://pkg.go.dev/badge/github.com/hansmi/prometheus-paperless-exporter.svg)](https://pkg.go.dev/github.com/hansmi/prometheus-paperless-exporter)\n\nThis repository hosts a Prometheus metrics exporter for\n[Paperless-ngx][paperless], a document management system transforming physical\ndocuments into a searchable online archive. The exporter relies on [Paperless'\nREST API][paperless-api].\n\nAn implementation using the API was chosen to provide the same perspective as\nweb browsers.\n\n\n## Usage\n\n`prometheus-paperless-exporter` listens on TCP port 8081 by default. To listen on\nanother address use the `-web.listen-address` flag (e.g.\n`-web.listen-address=127.0.0.1:3000`).\n\nTLS and HTTP basic authentication is supported through the [Prometheus exporter\ntoolkit][toolkit]. A configuration file can be passed to the `-web.config` flag\n([documentation][toolkitconfig]).\n\nSee the `--help` output for more flags.\n\n\n## Permissions\n\nThe metrics user requires [_view_ permissions][paperless-permissions] on the\nfollowing object types:\n\n* Admin\n  * Required for log analysis.\n  * Starting with version 2.8 there is no distinction between different access\n    modes ([paperless-ngx#6380](https://github.com/paperless-ngx/paperless-ngx/pull/6380)).\n* Correspondent\n* Document\n* DocumentType\n* Group\n* PaperlessTask\n* StoragePath\n* Tag\n* User\n\n\n## Installation\n\nPre-built binaries are provided for [all releases][releases]:\n\n* Binary archives (`.tar.gz`)\n* Debian/Ubuntu (`.deb`)\n* RHEL/Fedora (`.rpm`)\n* Microsoft Windows (`.zip`)\n\nDocker images via GitHub's container registry. The image supports Linux/AMD64\nand Linux/ARM64.\n\n```shell\ndocker pull ghcr.io/hansmi/prometheus-paperless-exporter\n```\n\nIt's also possible to produce custom builds directly using [Go][golang] or\n[GoReleaser][goreleaser].\n\n\n### Docker Compose\n\nAn example configuration for [Docker Compose][dockercompose] is available in\n`contrib/docker-compose`:\n\n```shell\nenv --chdir contrib/docker-compose docker-compose up\n```\n\n\n[dockercompose]: https://docs.docker.com/compose/\n[golang]: https://golang.org/\n[goreleaser]: https://goreleaser.com/\n[paperless-api]: https://docs.paperless-ngx.com/api/\n[paperless]: https://docs.paperless-ngx.com/\n[paperless-permissions]: https://docs.paperless-ngx.com/usage/#permissions\n[releases]: https://github.com/hansmi/prometheus-paperless-exporter/releases/latest\n[toolkit]: https://github.com/prometheus/exporter-toolkit\n[toolkitconfig]: https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md\n\n\u003c!-- vim: set sw=2 sts=2 et : --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhansmi%2Fprometheus-paperless-exporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhansmi%2Fprometheus-paperless-exporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhansmi%2Fprometheus-paperless-exporter/lists"}