librespeed/README.tpl.md

15 lines
771 B
Markdown
Raw Permalink Normal View History

2020-07-16 22:58:22 +00:00
# Luzifer-docker / librespeed
2020-07-16 22:59:16 +00:00
This is a container setup for the [Go variant](https://github.com/librespeed/speedtest-go) of the [LibreSpeed speed test](https://librespeed.org/), fully configurable through environment variables and runnable out-of-the-box.
2020-07-16 22:58:22 +00:00
For security reasons the statistics password will be auto-generated every run of the container if not explicitly set.
To use your own configuration file make it available in the container as `/etc/speedtest/settings.toml` which will disable the config generator.
2020-07-16 22:58:22 +00:00
## Available configuration variables
For reference please refer to the [config example](https://github.com/librespeed/speedtest-go/blob/master/settings.toml) in the upstream repo.
2020-07-16 22:58:22 +00:00
| ENV Variable | Default Value |
| ------------ | ------------- |