diff --git a/getting-started/environment-variables.md b/getting-started/environment-variables.md index c1eba47..7631f73 100644 --- a/getting-started/environment-variables.md +++ b/getting-started/environment-variables.md @@ -20,7 +20,7 @@ description: >- ### Speed tests -
| Name | Required | Description | Example |
|---|---|---|---|
SPEEDTEST_SKIP_IPS | false | A comma separated list of public IP addresses where tests will be skipped when present. | 127.0.0.1 or 127.0.0.0/16 |
SPEEDTEST_SCHEDULE | false | Cron expression used to run speedtests on a scheduled basis. https://crontab.guru/ is a helpful tool. | 6 */2 * * *(At minute 6 past every 2nd hour) |
SPEEDTEST_SERVERS | false | Comma separated list of server IDs to randomly use for speedtest. To find servers near you visit: https://c.speedtest.net/speedtest-servers-static.php | 52365 or 36998,52365 |
SPEEDTEST_BLOCKED_SERVERS | false | Comma separated list of server IDs that should not be used when running an Ookla Speedtest. | |
SPEEDTEST_INTERFACE | false | Set the network interface to use for the test. This need to be the network interface available inside the container | eth0 |
SPEEDTEST_EXTERNAL_IP_URL | false | URL of a service used to get the external WAN IP address. | |
SPEEDTEST_INTERNET_CHECK_HOSTNAME | false | Hostname used to ping for an active internet connection. | |
THRESHOLD_ENABLED | false | Enable the thresholds. Note: Only effective during initial setup. | true |
THRESHOLD_DOWNLOAD | false | Set the Download Threshold Note: Only effective during initial setup. | 900 |
THRESHOLD_UPLOAD | false | Set the Upload Threshold Note: Only effective during initial setup. | 900 |
THRESHOLD_PING | false | Set the Ping Threshold Note: Only effective during initial setup. | 25 |
PRUNE_RESULTS_OLDER_THAN | false | Set the value to greater than zero to prune stored results. This value should be represented in days, e.g. 7 will purge all results over 7 days old. | 7 |
| Name | Required | Description | Example |
|---|---|---|---|
SPEEDTEST_SKIP_IPS | false | A comma separated list of public IP addresses where tests will be skipped when present. | 127.0.0.1 or 127.0.0.0/16 |
SPEEDTEST_SCHEDULE | false | Cron expression used to run speedtests on a scheduled basis. https://crontab.guru/ is a helpful tool. | 6 */2 * * *(At minute 6 past every 2nd hour) |
SPEEDTEST_SERVERS | false | Comma separated list of server IDs to randomly use for speedtest. To find servers near you visit: https://www.speedtest.net/api/js/servers | 52365 or 36998,52365 |
SPEEDTEST_BLOCKED_SERVERS | false | Comma separated list of server IDs that should not be used when running an Ookla Speedtest. | |
SPEEDTEST_INTERFACE | false | Set the network interface to use for the test. This need to be the network interface available inside the container | eth0 |
SPEEDTEST_EXTERNAL_IP_URL | false | URL of a service used to get the external WAN IP address. URL should contain the protocol i.e. https:// | https://icanhazip.com |
SPEEDTEST_INTERNET_CHECK_HOSTNAME | false | Hostname used to ping for an active internet connection. | |
THRESHOLD_ENABLED | false | Enable the thresholds. Note: Only effective during initial setup. | true |
THRESHOLD_DOWNLOAD | false | Set the Download Threshold Note: Only effective during initial setup. | 900 |
THRESHOLD_UPLOAD | false | Set the Upload Threshold Note: Only effective during initial setup. | 900 |
THRESHOLD_PING | false | Set the Ping Threshold Note: Only effective during initial setup. | 25 |
PRUNE_RESULTS_OLDER_THAN | false | Set the value to greater than zero to prune stored results. This value should be represented in days, e.g. 7 will purge all results over 7 days old. | 7 |