From 11f6517cbf688ea817f5ebe4900d868bc46979b5 Mon Sep 17 00:00:00 2001 From: Christian Fritz Date: Sat, 10 Oct 2020 12:26:59 +0200 Subject: [PATCH] Adds information about the docker build. --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index 10267f6..b426727 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,7 @@ Other changes: ## Table of Contents - [Building](#building) - [Running](#running) + - [Running with docker](#running-with-docker) - [Exported metrics](#exported-metrics) - [Output of `-test`](#output-of--test) - [Customizing metrics](#customizing-metrics) @@ -42,6 +43,13 @@ go mod download go build ``` +Alternatively there is a [`Dockerfile`](Dockerfile) to build a docker +image. + +```shell script +docker build -t fritzbox-exporter . +``` + ## Running In the configuration of the Fritzbox the option `Statusinformationen @@ -84,6 +92,23 @@ The password (needed for metrics from TR-064 API) can be passed over environment read -rs PASSWORD && export PASSWORD && ./fritzbox_exporter -username -test; unset PASSWORD ``` +### Running with docker + +The fritzbox-exporter will be built by the Docker Hub Infrastructure +which can be used with: + +```shell script +docker run -p 8080:8080 chrfritz/fritzbox-exporter +``` + +It supports all commandline arguments like the original one: + +```shell script +docker run chrfritz/fritzbox-exporter -h +``` + +See also . + ## Exported metrics Start the exporter and run: