From 2d634470d98c654ad3b141d228234b85ae0b6dc7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20Lo=C5=A1=C5=A5=C3=A1k?= Date: Tue, 18 Aug 2026 00:52:04 +0200 Subject: [PATCH] Updated docs --- README.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index fc0a84a..3e0c703 100644 --- a/README.md +++ b/README.md @@ -75,26 +75,30 @@ topology with `cluster`, `node`, `pool`, `component`, `path`, and `leaf` labels: - `pve_node_zfs_write_errors` - `pve_node_zfs_checksum_errors` -## Build +## Pull the Latest Image + +The latest published version can be downloaded from the Gitea container registry: + +```sh +docker pull gitea.lostak.dev/lostakj/pve-exporter:latest +``` + +## Build Locally To build the Docker image for PVE Exporter, use the following command: ```sh -docker build --rm -t gitea.lostak.dev/lostakj/pve-exporter:version . +docker build --rm -t gitea.lostak.dev/lostakj/pve-exporter:latest . ``` -Replace `version` with the appropriate version tag you want to use. - ## Run -To run the Docker image, use the following command: +To run the downloaded or locally built image, use the following command: ```sh -docker run --rm -d -p 9090:9090 --name pve-exporter gitea.lostak.dev/lostakj/pve-exporter:version +docker run --rm -d -p 9090:9090 --name pve-exporter gitea.lostak.dev/lostakj/pve-exporter:latest ``` -Replace `version` with the appropriate version tag you used during the build. - ## Usage Once the Docker container is running, the exporter will be available on port `9090`. You can configure Prometheus to scrape metrics from the exporter by adding a new scrape configuration to your Prometheus configuration file.