Browse Source

Adds information about the docker build.

master
Christian Fritz 4 years ago
parent
commit
11f6517cbf
No known key found for this signature in database GPG Key ID: AB40486FCA9FA29C
  1. 25
      README.md

25
README.md

@ -28,6 +28,7 @@ Other changes:
## Table of Contents ## Table of Contents
- [Building](#building) - [Building](#building)
- [Running](#running) - [Running](#running)
- [Running with docker](#running-with-docker)
- [Exported metrics](#exported-metrics) - [Exported metrics](#exported-metrics)
- [Output of `-test`](#output-of--test) - [Output of `-test`](#output-of--test)
- [Customizing metrics](#customizing-metrics) - [Customizing metrics](#customizing-metrics)
@ -42,6 +43,13 @@ go mod download
go build go build
``` ```
Alternatively there is a [`Dockerfile`](Dockerfile) to build a docker
image.
```shell script
docker build -t fritzbox-exporter .
```
## Running ## Running
In the configuration of the Fritzbox the option `Statusinformationen 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 <user> -test; unset PASSWORD read -rs PASSWORD && export PASSWORD && ./fritzbox_exporter -username <user> -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 <https://hub.docker.com/r/chrfritz/fritzbox-exporter>.
## Exported metrics ## Exported metrics
Start the exporter and run: Start the exporter and run:

Loading…
Cancel
Save