diff --git a/README.md b/README.md index cf9945f..1a5353d 100644 --- a/README.md +++ b/README.md @@ -1 +1,44 @@ # prometheus_upsc_exporter + +lightweight docker build for exporting nut's `upsc` into prometheus. + +container listens on `:9614` + +# Examples + +## simplest docker run example + +`docker run -p9614:9614 -d jzck/upsc-exporter -e UPS_TARGET=ups@localhost --network=host` + +Make sure an `upsd` server is running on the host so that `upsc` can contact it. + +## docker-compose with nut-upsd server + +basic compose setup with `upshift/nut-upsd` + +``` +services: + nut-upsd: + image: upshift/nut-upsd + user: root + restart: unless-stopped + privileged: true + expose: + - 3493 + environment: + - "SHUTDOWN_CMD=shutdown -h now" + - "API_USER=upsmon" + - "API_PASSWORD=secret" + + prom-upsc: + image: jzck/upsc_exporter + restart: unless-stopped + depends_on: + - nut-upsd + environment: + - "UPS_TARGET=ups@nut-upsd:3493" + expose: + - 9614 +``` + +Can also be used with another `upsd`, just make sure the container can see the