Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jwigley/docker-smokeping-speedtest
Docker image containing smokeping with speedtest-cli and smokeping-speedtest probe
https://github.com/jwigley/docker-smokeping-speedtest
docker smokeping speedtest
Last synced: about 2 months ago
JSON representation
Docker image containing smokeping with speedtest-cli and smokeping-speedtest probe
- Host: GitHub
- URL: https://github.com/jwigley/docker-smokeping-speedtest
- Owner: jwigley
- License: gpl-3.0
- Created: 2019-06-23T08:25:26.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-06-23T02:11:45.000Z (6 months ago)
- Last Synced: 2024-08-01T15:36:41.426Z (5 months ago)
- Topics: docker, smokeping, speedtest
- Language: Dockerfile
- Size: 62.5 KB
- Stars: 15
- Watchers: 3
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# docker-smokeping-speedtest
[](https://hub.docker.com/r/jwigley/smokeping-speedtest/)
Smokeping docker image with [smokeping-speedtest](https://github.com/mad-ady/smokeping-speedtest) probe and [speedtest-cli](https://github.com/sivel/speedtest-cli), built upon linuxserver's [docker-smokeping](https://github.com/linuxserver/docker-smokeping) image.
## docker repositories
[jwigley/smokeping-speedtest](https://hub.docker.com/r/jwigley/smokeping-speedtest) (docker hub)
[ghcr.io/jwigley/smokeping-speedtest](https://github.com/jwigley/docker-smokeping-speedtest/pkgs/container/smokeping-speedtest) (github)
## usage
```bash
docker run \
-d \
--name=smokeping-speedtest \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Europe/London \
-p 80:80 \
-v /path/to/smokeping/config:/config \
-v /path/to/smokeping/data:/data \
--restart unless-stopped \
jwigley/smokeping-speedtest
```
The default speedtest configuration will poll downloads/uploads every hour to your closest speedtest.net server.
Results are displayed under the 'Speed Tests' menu in Smokeping.
This can be modified by via the Probes and Targets config files as per the instructions at https://github.com/mad-ady/smokeping-speedtest.
The default configuration runs speed tests with the official Ookla speedtest cli tool. The tool requires you to accept a license on first use. Alternatively you can add the `--accept-license` flag to the `extraargs` parameter in your Probes config.
Smokeping-speedtest can also be configured to use [Sivel's speedtest-cli](https://github.com/sivel/speedtest-cli) tool. See the example config in your Targets config file. For best performance and reliable test results, it is recommended to use the official Ookla cli tool for testing internet speeds greater than 100Mbps.
## ssh probe
This image also contains a working version of the [SSH Probe](https://oss.oetiker.ch/smokeping/probe/SSH.en.html), which is [currently broken](https://github.com/linuxserver/docker-smokeping/issues/142) in the underlying linuxserver image.
If you add an SSH probe to your configuration, you must also set the `SSH_PROBE_INIT_TARGET` environment variable to a valid host running SSH. During initialisation, the probe will ask the target for its public key and verify it can parse the output.
eg.
```bash
docker run \
-d \
--name=smokeping-speedtest \
-e SSH_PROBE_INIT_TARGET=my.host \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Europe/London \
-p 80:80 \
-v /path/to/smokeping/config:/config \
-v /path/to/smokeping/data:/data \
--restart unless-stopped \
jwigley/smokeping-speedtest
```
## credits
This docker image just pieces the bits together. The real work is all done by:
- [mad-ady](https://github.com/mad-ady)'s [smokeping-speedtest](https://github.com/mad-ady/smokeping-speedtest)
- [sivel](https://github.com/sivel)'s [speedtest-cli](https://github.com/sivel/speedtest-cli)
- [linuxserver](https://github.com/linuxserver)'s [docker-smokeping](https://github.com/linuxserver/docker-smokeping)