Skip to content

Commit

Permalink
Update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
Denis Krivak committed Sep 4, 2023
1 parent 585f691 commit ce578c5
Showing 1 changed file with 35 additions and 2 deletions.
37 changes: 35 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand Down

0 comments on commit ce578c5

Please sign in to comment.