From ce578c5a8dcf03b14ddfb7846b3f68b5b4afbb94 Mon Sep 17 00:00:00 2001 From: Denis Krivak Date: Mon, 4 Sep 2023 08:32:51 +0200 Subject: [PATCH] Update readme. --- README.md | 37 +++++++++++++++++++++++++++++++++++-- 1 file changed, 35 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d7b18e3..45de364 100644 --- a/README.md +++ b/README.md @@ -13,14 +13,47 @@ in the Netherlands. Mostly copied from [compal_CH7465LG_py](https://github.com/ties/compal_CH7465LG_py) and [connectbox-prometheus](https://github.com/mbugert/connectbox-prometheus). -## Build and run +## Run + +### Use docker + +Create a config file `config.yaml` +([example](https://github.com/tetafro/connectbox-exporter/blob/master/config.example.yaml)). + +```sh +docker run -d \ + --volume /host-dir/config.yaml:/etc/prometheus/connectbox-exporter.yaml \ + --publish 9119:9119 \ + --name connectbox-exporter \ + ghcr.io/tetafro/connectbox-exporter:latest +``` + +### Download binary + +Download and unpack latest [release](https://github.com/tetafro/connectbox-exporter/releases). + +Create a config file `config.yaml` +([example](https://github.com/tetafro/connectbox-exporter/blob/master/config.example.yaml)). + +Run +```sh +./connectbox-exporter -config config.yaml +``` + +### Build from sources + +Clone the repository +```sh +git clone git@github.com:tetafro/connectbox-exporter.git +cd connectbox-exporter +``` Copy and populate config ```sh cp config.example.yaml config.yaml ``` -Start +Build and run ```sh make build run ```