Skip to content

Commit 980ee6f

Browse files
alexjustesengitbook-bot
authored andcommitted
GITBOOK-102: No subject
1 parent c584891 commit 980ee6f

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,25 @@
11
---
22
description: >-
3-
A Docker image to check your internet speed using Ookla's Speedtest service.
4-
Build using Laravel and the Speedtest CLI.
3+
Speedtest Tracker is a self-hosted application that monitors the performance
4+
and uptime of your internet connection. Build using Laravel and Speedtest CLI
5+
from Ookla®, deployable with Docker.
56
---
67

78
# Introduction
89

910
{% hint style="info" %}
10-
Docs are up to date through version: `0.21.x`
11+
Docs are up to date through version: `0.22.x`
1112
{% endhint %}
1213

1314
<figure><img src=".gitbook/assets/image (2).png" alt=""><figcaption><p>V0.20.6 Dashboard</p></figcaption></figure>
1415

1516
### Introduction
1617

17-
Speedtest Tracker is a self-hosted internet performance tracking application that runs speedtest checks against Ookla's Speedtest service.
18+
Speedtest Tracker is a self-hosted application that monitors the performance and uptime of your internet connection.
1819

1920
#### Why might I want this?
2021

21-
The main use case for Speedtest Tracker is to build a history of your internet's performance so that you can be informed when you're not receiving your ISP's advertised rates.
22+
The main use case for Speedtest Tracker is to build a history of your internet performance and ISP's uptime so you can be informed when you're not receiving your ISP's advertised rates.
2223

2324
_...also some of us just like a lot of data._
2425

getting-started/environment-variables.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ description: >-
1212

1313
### Speedtest
1414

15-
<table><thead><tr><th width="221">Name</th><th data-type="checkbox">Required</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><code>SPEEDTEST</code><br><code>_PING_URL</code></td><td>false</td><td>IP address or URL used to check for an internet connection prior to running a test.</td><td><code>1.1.1.1</code></td></tr><tr><td><code>SPEEDTEST</code><br><code>_SCHEDULE</code></td><td>false</td><td>Cron expression used to run speedtests on a scheduled basis. https://crontab.guru/ is a helpful tool.</td><td><code>6 */2 * * *</code><br>(<em>At minute 6 past every 2nd hour)</em></td></tr><tr><td><code>SPEEDTEST</code><br><code>_SERVERS</code></td><td>false</td><td>Comma separated list of server IDs to randomly use for speedtests, use this page to find the best servers for your ISP/location https://c.speedtest.net/speedtest-servers-static.php.</td><td><code>52365</code> or <code>36998,52365</code></td></tr><tr><td><code>PRUNE_RESULTS</code><br><code>_OLDER_THAN</code></td><td>false</td><td>Set the value to greated than zero to prune stored results. This value should be represented in days, e.g. <code>7</code> will purge all results over 7 days old.</td><td><code>7</code></td></tr></tbody></table>
15+
<table><thead><tr><th width="221">Name</th><th data-type="checkbox">Required</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><code>SPEEDTEST</code><br><code>_PING_URL</code></td><td>false</td><td>IP address or URL used to check for an internet connection prior to running a test.</td><td><code>1.1.1.1</code></td></tr><tr><td><code>SPEEDTEST_SKIP_IPS</code></td><td>false</td><td>A comma separated list of public IP addresses where tests will be skipped when present.</td><td><code>127.0.0.1</code> or <code>127.0.0.0/16</code></td></tr><tr><td><code>SPEEDTEST</code><br><code>_SCHEDULE</code></td><td>false</td><td>Cron expression used to run speedtests on a scheduled basis. https://crontab.guru/ is a helpful tool.</td><td><code>6 */2 * * *</code><br>(<em>At minute 6 past every 2nd hour)</em></td></tr><tr><td><code>SPEEDTEST</code><br><code>_SERVERS</code></td><td>false</td><td>Comma separated list of server IDs to randomly use for speedtests, use this page to find the best servers for your ISP/location https://c.speedtest.net/speedtest-servers-static.php.</td><td><code>52365</code> or <code>36998,52365</code></td></tr><tr><td><code>PRUNE_RESULTS</code><br><code>_OLDER_THAN</code></td><td>false</td><td>Set the value to greated than zero to prune stored results. This value should be represented in days, e.g. <code>7</code> will purge all results over 7 days old.</td><td><code>7</code></td></tr></tbody></table>

0 commit comments

Comments
 (0)