Update Dockerfile

.github/dependabot.yml

@@ -0,0 +1,13 @@
+version: 2
+updates:
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+  # Enable version updates for Docker
+  - package-ecosystem: "docker"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/docker-build-publish.yml

@@ -0,0 +1,97 @@
+name: build & publish docker image
+
+on:
+  push:
+  schedule:
+    # every sunday at midnight
+    - cron: '0 0 * * 0'
+  workflow_dispatch:
+
+env:
+  IMAGE_NAME: dotwee/fritzbox-prometheus-exporter
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+      # This is used to complete the identity challenge
+      # with sigstore/fulcio when running outside of PRs.
+      id-token: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      # Install the cosign tool except on PR
+      # https://github.com/sigstore/cosign-installer
+      - name: Install cosign
+        uses: sigstore/[email protected]
+        with:
+          cosign-release: 'v1.6.0'
+
+      - name: Setup QEMU binaries
+        uses: docker/[email protected]
+
+      - name: Setup Docker buildx
+        uses: docker/[email protected]
+        with:
+          buildkitd-flags: --debug
+
+      - name: Log into Docker Hub
+        uses: docker/[email protected]
+        with:
+          username: dotwee
+          password: ${{ secrets.DOCKER_REGISTRY_TOKEN }}
+
+      - name: Log into GitHub registry
+        uses: docker/[email protected]
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      # Extract metadata (tags, labels) for Docker
+      # https://github.com/docker/metadata-action
+      - name: Extract Docker metadata
+        id: meta
+        uses: docker/[email protected]
+        with:
+          images: |
+            ${{ env.IMAGE_NAME }}
+            ghcr.io/${{ env.IMAGE_NAME }}
+          tags: |
+            type=ref,event=branch
+            type=raw,value=latest,enable=${{ github.ref == format('refs/heads/{0}', github.event.repository.default_branch) }}
+          flavor: |
+            latest=true
+
+      # Build and push Docker image with Buildx (don't push on PR)
+      # https://github.com/docker/build-push-action
+      - name: Build and push Docker image
+        id: build-and-push
+        uses: docker/[email protected]
+        with:
+          build-args: REPO=${{ github.repository }}
+          context: .
+          platforms: linux/amd64,linux/arm64,linux/arm/v7,linux/arm/v6
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+
+      # // SET IMAGE SIGNING ON ICE UNTIL DOCKERHUB'S KEYSTORE GETS FIXED // 
+      # Sign the resulting Docker image digest except on PRs.
+      # This will only write to the public Rekor transparency log when the Docker
+      # repository is public to avoid leaking data.  If you would like to publish
+      # transparency data even for private images, pass --force to cosign below.
+      # https://github.com/sigstore/cosign
+      # - name: Sign the published Docker image
+      #   env:
+      #     COSIGN_EXPERIMENTAL: "true"
+      #   # This step uses the identity token to provision an ephemeral certificate
+      #   # against the sigstore community Fulcio instance.
+      #   run: cosign sign ${{ env.IMAGE_NAME }}@${{ steps.build-and-push.outputs.digest }}

Dockerfile

@@ -1,13 +1,37 @@
-FROM golang:rc-alpine3.13 AS builder
-RUN go get github.com/sberk42/fritzbox_exporter/
-
-FROM alpine:latest
-ARG USERNAME PASSWORD GWURL
-ENV USERNAME ${USERNAME} && \
-PASSWORD ${PASSWORD} && \
-GWURL ${GWURL}
-WORKDIR /root/
-COPY --from=builder /go/bin/fritzbox_exporter . 
-COPY metrics.json metrics-lua.json ./
+# syntax=docker/dockerfile:1
+
+# Build Image
+FROM golang:alpine3.15 AS builder
+RUN go install github.com/sberk42/fritzbox_exporter@latest \
+    && mkdir /app \
+    && mv /go/bin/fritzbox_exporter /app
+
+WORKDIR /app
+
+COPY metrics.json metrics-lua.json /app/
+
+# Runtime Image
+FROM alpine:3.20.3 as runtime-image
+
+ARG REPO=sberk42/fritzbox_exporter
+
+LABEL org.opencontainers.image.source https://github.com/${REPO}
+
+ENV USERNAME username
+ENV PASSWORD password
+ENV GATEWAY_URL http://fritz.box:49000
+ENV LISTEN_ADDRESS 0.0.0.0:9042
+
+RUN mkdir /app \
+    && addgroup -S -g 1000 fritzbox \
+    && adduser -S -u 1000 -G fritzbox fritzbox \
+    && chown -R fritzbox:fritzbox /app
+
+WORKDIR /app
+
+COPY --chown=fritzbox:fritzbox --from=builder /app /app
+
 EXPOSE 9042
-ENTRYPOINT ./fritzbox_exporter -gateway-url ${GWURL} -password ${PASSWORD} -username ${USERNAME} -listen-address 0.0.0.0:9042
+
+ENTRYPOINT [ "sh", "-c", "/app/fritzbox_exporter" ]
+CMD [ "-username", "${USERNAME}", "-password", "${PASSWORD}", "-gateway-url", "${GATEWAY_URL}", "-listen-address", "${LISTEN_ADDRESS}" ]

README.md

@@ -4,7 +4,7 @@ This exporter exports some variables from an
 [AVM Fritzbox](http://avm.de/produkte/fritzbox/)
 to prometheus.
 
-This exporter is tested with a Fritzbox 7590 software version 07.12, 07.20 and 07.21.
+This exporter is tested with a Fritzbox 7590 software version 07.12, 07.20, 07.21 and 07.25.
 
 The goal of the fork is:
   - [x] allow passing of username / password using evironment variable
@@ -17,46 +17,83 @@ The goal of the fork is:
 Other changes:
   - replaced digest authentication code with own implementation
   - improved error messages
-  - **New:** test mode prints details about all SOAP Actions and their parameters
-  - **New:** collect option to directly test collection of results
-  - **New:** additional metrics to collect details about connected hosts and DECT devices
-  - **New:** support to use results like hostname or MAC address as labels to metrics
-  - **New:** support for metrics from lua APIs (e.g. CPU temperature, utilization, ...)
+  - test mode prints details about all SOAP Actions and their parameters
+  - collect option to directly test collection of results
+  - additional metrics to collect details about connected hosts and DECT devices
+  - support to use results like hostname or MAC address as labels to metrics
+  - support for metrics from lua APIs (e.g. CPU temperature, utilization, ...)
 
 
 ## Building
 
-    go get github.com/sberk42/fritzbox_exporter/
-    cd $GOPATH/src/github.com/sberk42/fritzbox_exporter
-    go install
+    go install github.com/sberk42/fritzbox_exporter@latest
 
 ## Running
 
 In the configuration of the Fritzbox the option "Statusinformationen über UPnP übertragen" in the dialog "Heimnetz >
 Heimnetzübersicht > Netzwerkeinstellungen" has to be enabled.
 
+### Using docker
+
+First you have to build the container: `docker build --tag fritzbox-prometheus-exporter:latest .`
+
+Then start the container:
+
+```bash
+$ docker run -e 'USERNAME=your_fritzbox_username' \
+    -e 'PASSWORD=your_fritzbox_password' \
+    -e 'GATEWAY_URL="http://192.168.0.1:49000"' \
+    -e 'LISTEN_ADDRESS="0.0.0.0:9042"' \
+    fritzbox-prometheus-exporter:latest
+```
+
+I've you're getting `no such host` issues, define your FritzBox as DNS server for your docker container like this:
+
+```bash
+$ docker run --dns YOUR_FRITZBOX_IP \
+    -e 'USERNAME=your_fritzbox_username' \
+    -e 'PASSWORD=your_fritzbox_password' \
+    -e 'GATEWAY_URL="http://192.168.0.1:49000"' \
+    -e 'LISTEN_ADDRESS="0.0.0.0:9042"' \
+    fritzbox-prometheus-exporter:latest
+```
+
+### Using docker-compose
+
+Set your environment variables within the [docker-compose.yml](docker-compose.yml) file.  
+
+Then start up the container using `docker-compose up -d`.
+
+### Using the binary
+
 Usage:
 
     $GOPATH/bin/fritzbox_exporter -h
     Usage of ./fritzbox_exporter:
       -gateway-url string
         The URL of the FRITZ!Box (default "http://fritz.box:49000")
-      -listen-address string
-        The address to listen on for HTTP requests. (default "127.0.0.1:9042")
+      -gateway-luaurl string
+        The URL of the FRITZ!Box UI (default "http://fritz.box")
       -metrics-file string
         The JSON file with the metric definitions. (default "metrics.json")
-      -password string
-        The password for the FRITZ!Box UPnP service
+      -lua-metrics-file string
+        The JSON file with the lua metric definitions. (default "metrics-lua.json")
       -test
         print all available SOAP calls and their results (if call possible) to stdout
+      -json-out string
+        store metrics also to JSON file when running test   
       -testLua
         read luaTest.json file make all contained calls and dump results
       -collect
         collect metrics once print to stdout and exit
-      -json-out string
-        store metrics also to JSON file when running test   
+      -nolua
+        disable collecting lua metrics
       -username string
         The user for the FRITZ!Box UPnP service
+      -password string
+        The password for the FRITZ!Box UPnP service
+      -listen-address string
+        The address to listen on for HTTP requests. (default "127.0.0.1:9042")
 
     The password (needed for metrics from TR-064 API) can be passed over environment variables to test in shell:
     read -rs PASSWORD && export PASSWORD && ./fritzbox_exporter -username <user> -test; unset PASSWORD
@@ -73,13 +110,16 @@ These values are determined by parsing all services from http://fritz.box:49000/
 
 ## Customizing metrics
 
-The metrics to collect are no longer hard coded, but have been moved to the [metrics.json](metrics.json) file, so just adjust to your needs.
+The metrics to collect are no longer hard coded, but have been moved to the [metrics.json](metrics.json) and [metrics-lua.json](metrics-lua.json) files, so just adjust to your needs (for cable version also see [metrics-lua_cable.json](metrics-lua_cable.json)).
 For a list of all the available metrics just execute the exporter with -test (username and password are needed for the TR-064 API!)
+For lua metrics open UI in browser and check the json files used for the various screens.
 
 For a list of all available metrics, see the dumps below (the format is the same as in the metrics.json file, so it can be used to easily add further metrics to retrieve):
+- [FritzBox 6591 v7.29](all_available_metrics_6591_7.29.json)
 - [FritzBox 7590 v7.12](all_available_metrics_7590_7.12.json)
 - [FritzBox 7590 v7.20](all_available_metrics_7590_7.20.json)
-
+- [FritzBox 7590 v7.25](all_available_metrics_7590_7.25.json)
+- [FritzBox 7590 v7.29](all_available_metrics_7590_7.29.json)
 ## Grafana Dashboard
 
 The dashboard is now also published on [Grafana](https://grafana.com/grafana/dashboards/12579).