https://github.com/cybcon/docker.speedtest2mqtt
A small docker image to combine the speedtest-cli together with the mosquitto_pub client.
https://github.com/cybcon/docker.speedtest2mqtt
docker-image mosquitto-pub speedtest-cli
Last synced: about 2 months ago
JSON representation
A small docker image to combine the speedtest-cli together with the mosquitto_pub client.
- Host: GitHub
- URL: https://github.com/cybcon/docker.speedtest2mqtt
- Owner: cybcon
- License: mit
- Created: 2023-10-27T14:13:50.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-09T12:36:19.000Z (about 2 years ago)
- Last Synced: 2023-12-09T13:32:17.810Z (about 2 years ago)
- Topics: docker-image, mosquitto-pub, speedtest-cli
- Language: Shell
- Homepage: https://www.oberdorf-itc.de/
- Size: 20.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Quick reference
Maintained by: [Michael Oberdorf IT-Consulting](https://www.oberdorf-itc.de/)
Source code: [GitHub](https://github.com/cybcon/docker.speedtest2mqtt)
Container image: [DockerHub](https://hub.docker.com/r/oitc/speedtest2mqtt)
[![][github-action-test-shield]][github-action-test-link]
[![][github-action-release-shield]][github-action-release-link]
[![][github-release-shield]][github-release-link]
[![][github-releasedate-shield]][github-releasedate-link]
[![][github-stars-shield]][github-stars-link]
[![][github-forks-shield]][github-forks-link]
[![][github-issues-shield]][github-issues-link]
[![][github-license-shield]][github-license-link]
[![][docker-release-shield]][docker-release-link]
[![][docker-pulls-shield]][docker-pulls-link]
[![][docker-stars-shield]][docker-stars-link]
[![][docker-size-shield]][docker-size-link]
# Supported tags and respective `Dockerfile` links
* [`latest`, `1.1.4`](https://github.com/cybcon/docker.speedtest2mqtt/blob/v1.1.4/Dockerfile)
* [`1.1.3`](https://github.com/cybcon/docker.speedtest2mqtt/blob/v1.1.3/Dockerfile)
* [`1.1.2`](https://github.com/cybcon/docker.speedtest2mqtt/blob/v1.1.2/Dockerfile)
* [`1.1.1`](https://github.com/cybcon/docker.speedtest2mqtt/blob/v1.1.1/Dockerfile)
* [`1.1.0`](https://github.com/cybcon/docker.speedtest2mqtt/blob/v1.1.0/Dockerfile)
* [`1.0.1`](https://github.com/cybcon/docker.speedtest2mqtt/blob/v1.0.1/Dockerfile)
# Summary
The container image is based on Alpine Linux and combines the [speedtest-cli](https://github.com/sivel/speedtest-cli) and
the [mosquitto-client](https://mosquitto.org/) to trigger a simple internet speedtest and publish the json formatted output
to a MQTT server topic.
# Prerequisites to run the docker container
You need an MQTT server to send the data to it.
# Configuration
## Container configuration
The container grab the configuration via environment variables.
| Environment variable name | Description | Required | Default value |
|--|--|--|--|
| `MQTT_SERVER` | The MQTT server hostname or IP address | **OPTIONAL** | `localhost` |
| `MQTT_PORT` | The TCP port of the MQTT server | **OPTIONAL** | `1883` |
| `MQTT_TLS_enabled` | Should SSL communication be enabled (`true`) or not (`false`) | **OPTIONAL** | `false` |
| `MQTT_CACERT_FILE` | If TLS is enabled, the path to the CA certificate file to validate the MQTT server certificate | **OPTIONAL** | |
| `MQTT_TLS_no_hostname_validation` | If TLS is enabled, skip the hostname validation of the TLS certificate | **OPTIONAL** | `false` |
| `MQTT_USER` | The MQTT username for MQTT authentication | **OPTIONAL** | |
| `MQTT_PASSWORD_FILE` | The filepath where the MQTT password is stored for MQTT authentication | **OPTIONAL** | |
| `MQTT_TOPIC` | The MQTT topic to send the speedtest results to | **MANDATORY** | |
| `MQTT_RETAIN`| Set the retain flag when publishing the speedtest result to MQTT topic | **OPTIONAL** | `false` |
| `FREQUENCE` | Time in seconds between speedtests. If nothing is given, the container stops after 1 speedtest | **OPTIONAL** | |
# Docker compose configuration
```yaml
version: '3.8'
services:
speedtest2mqtt:
container_name: speedtest2mqtt
restart: "no"
read_only: true
user: 2536:2536
image: oitc/speedtest2mqtt
environment:
MQTT_SERVER: test.mosquitto.org
MQTT_PORT: 1883
MQTT_TOPIC: de/oberdorf-itc/speedtest2mqtt/results
FREQUENCE: 300
secrets:
- speedtest2mqtt_mqtt_password
tmpfs:
- /tmp
secrets:
speedtest2mqtt_mqtt_password:
file: /srv/docker/speedtest2mqtt/secrets/mqtt_password
```
# Donate
I would appreciate a small donation to support the further development of my open source projects.
# License
Copyright (c) 2023-2025 Michael Oberdorf IT-Consulting
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
[docker-pulls-link]: https://hub.docker.com/r/oitc/speedtest2mqtt
[docker-pulls-shield]: https://img.shields.io/docker/pulls/oitc/speedtest2mqtt?color=45cc11&labelColor=black&style=flat-square
[docker-release-link]: https://hub.docker.com/r/oitc/speedtest2mqtt
[docker-release-shield]: https://img.shields.io/docker/v/oitc/speedtest2mqtt?color=369eff&label=docker&labelColor=black&logo=docker&logoColor=white&style=flat-square
[docker-size-link]: https://hub.docker.com/r/oitc/speedtest2mqtt
[docker-size-shield]: https://img.shields.io/docker/image-size/oitc/speedtest2mqtt?color=369eff&labelColor=black&style=flat-square
[docker-stars-link]: https://hub.docker.com/r/oitc/speedtest2mqtt
[docker-stars-shield]: https://img.shields.io/docker/stars/oitc/speedtest2mqtt?color=45cc11&labelColor=black&style=flat-square
[github-action-release-link]: https://github.com/cybcon/docker.speedtest2mqtt/actions/workflows/release-from-label.yaml
[github-action-release-shield]: https://img.shields.io/github/actions/workflow/status/cybcon/docker.speedtest2mqtt/release-from-label.yaml?label=release&labelColor=black&logo=githubactions&logoColor=white&style=flat-square
[github-action-test-link]: https://github.com/cybcon/docker.speedtest2mqtt/actions/workflows/container-image-build-validation.yaml
[github-action-test-shield-original]: https://github.com/cybcon/docker.speedtest2mqtt/actions/workflows/container-image-build-validation.yaml/badge.svg
[github-action-test-shield]: https://img.shields.io/github/actions/workflow/status/cybcon/docker.speedtest2mqtt/container-image-build-validation.yaml?label=tests&labelColor=black&logo=githubactions&logoColor=white&style=flat-square
[github-forks-link]: https://github.com/cybcon/docker.speedtest2mqtt/network/members
[github-forks-shield]: https://img.shields.io/github/forks/cybcon/docker.speedtest2mqtt?color=8ae8ff&labelColor=black&style=flat-square
[github-issues-link]: https://github.com/cybcon/docker.speedtest2mqtt/issues
[github-issues-shield]: https://img.shields.io/github/issues/cybcon/docker.speedtest2mqtt?color=ff80eb&labelColor=black&style=flat-square
[github-license-link]: https://github.com/cybcon/docker.speedtest2mqtt/blob/main/LICENSE
[github-license-shield]: https://img.shields.io/badge/license-MIT-blue?labelColor=black&style=flat-square
[github-release-link]: https://github.com/cybcon/docker.speedtest2mqtt/releases
[github-release-shield]: https://img.shields.io/github/v/release/cybcon/docker.speedtest2mqtt?color=369eff&labelColor=black&logo=github&style=flat-square
[github-releasedate-link]: https://github.com/cybcon/docker.speedtest2mqtt/releases
[github-releasedate-shield]: https://img.shields.io/github/release-date/cybcon/docker.speedtest2mqtt?labelColor=black&style=flat-square
[github-stars-link]: https://github.com/cybcon/docker.speedtest2mqtt
[github-stars-shield]: https://img.shields.io/github/stars/cybcon/docker.speedtest2mqtt?color=ffcb47&labelColor=black&style=flat-square