diff --git a/README.md b/README.md index f6a0d5a..318cf5f 100644 --- a/README.md +++ b/README.md @@ -81,11 +81,39 @@ Every device is contacted once during each Prometheus scrape. Choose a scrape in ## Docker +You can use the latest pre-built image from the registry: + +```sh +docker pull gitea.lostak.dev/lostakj/shelly-exporter:latest +``` + +Or build it locally: + ```sh docker build --rm -t shelly-exporter:latest . +``` + +Run the container: + +```sh docker run --rm -p 9090:9090 \ -v "$PWD/config.yaml:/opt/shelly-exporter/config.yaml:ro" \ - shelly-exporter:latest + gitea.lostak.dev/lostakj/shelly-exporter:latest +``` + +Example with docker-compose: + +```yaml +version: '3.8' + +services: + shelly-exporter: + image: gitea.lostak.dev/lostakj/shelly-exporter:latest + ports: + - "9090:9090" + volumes: + - ./config.yaml:/opt/shelly-exporter/config.yaml:ro + restart: unless-stopped ``` ## Scope