Add a docker-compose example for using the exporter

README.md

@@ -61,6 +61,17 @@ 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/

contrib/docker-compose/.env

@@ -0,0 +1 @@
+COMPOSE_PROJECT_NAME=prometheus-paperless-exporter

contrib/docker-compose/config/auth-token.txt

@@ -0,0 +1 @@
+insecuretoken

contrib/docker-compose/docker-compose.yml

@@ -0,0 +1,14 @@
+---
+version: "3.7"
+services:
+  exporter:
+    image: ghcr.io/hansmi/prometheus-paperless-exporter:latest
+    restart: on-failure
+    init: true
+    ports:
+      - 127.0.0.1:8081:8081
+    env_file: exporter.env
+    volumes:
+      - ./config/:/etc/exporter:ro
+
+# vim: set sw=2 sts=2 et :

contrib/docker-compose/exporter.env

@@ -0,0 +1,5 @@
+PAPERLESS_URL=https://paperless.example.com
+PAPERLESS_AUTH_TOKEN_FILE=/etc/exporter/auth-token.txt
+PAPERLESS_SERVER_TIMEZONE=Australia/Sydney
+
+# vim: set sw=2 sts=2 et :