Skip to content

Commit 388cce6

Browse files
alexjustesengitbook-bot
authored andcommitted
GITBOOK-69: change request with no subject merged in GitBook
1 parent ba998c0 commit 388cce6

File tree

7 files changed

+11
-5
lines changed

7 files changed

+11
-5
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: >-
77
# Introduction
88

99
{% hint style="info" %}
10-
These docs are up-to-date for version: `v0.15.4`
10+
Docs are up to date through version: `0.16.0`
1111
{% endhint %}
1212

1313
<figure><img src=".gitbook/assets/dashboard_screenshot.jpg" alt=""><figcaption></figcaption></figure>

SUMMARY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
* [Introduction](README.md)
44
* [Features](features.md)
5-
* [Frequently Asked Questions](faqs.md)
65
* [Changelog](changelog.md)
76

87
## 🚀 Getting Started
@@ -18,6 +17,7 @@
1817
## 🆘 Help
1918

2019
* [Error Messages](help/error-messages.md)
20+
* [Frequently Asked Questions](help/faqs.md)
2121

2222
## 🔑 Security
2323

changelog.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ A complete history of all changes can be found on GitHub in the [releases](https
1010

1111
### 2024
1212

13+
#### Feb. 19th, 2024 - Data Quality Release
14+
15+
`v0.16.0` fixes a hand full of data quality issues that have been around for a while and also adds some nice new features like a more robust export method and automatic pruning of older results.
16+
17+
Read more: [https://github.com/alexjustesen/speedtest-tracker/releases/tag/v0.16.0](https://github.com/alexjustesen/speedtest-tracker/releases/tag/v0.16.0)
18+
1319
#### Feb. 9th, 2024 - LinuxServer.io Docker image now available!
1420

1521
The fantastic gents over at [LinuxServer.io](https://www.linuxserver.io/) have build an [image](https://fleet.linuxserver.io/image?name=linuxserver/speedtest-tracker) that is 3-4x faster and 1/2 the build size of the current image! For more details check out the published [issue](https://github.com/alexjustesen/speedtest-tracker/issues/1117) on GitHub.

features.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ description: A full list of implemented features and those that are planned.
66

77
<figure><img src=".gitbook/assets/dashboard_screenshot.jpg" alt="Dashboard page"><figcaption><p>Dashboard page</p></figcaption></figure>
88

9-
<table><thead><tr><th width="563">Features</th><th align="right">Status</th></tr></thead><tbody><tr><td><strong>Install options</strong></td><td align="right"></td></tr><tr><td> Docker images for x86</td><td align="right">Done</td></tr><tr><td> Docker images for arm64</td><td align="right">Done</td></tr><tr><td> unRAID Community App</td><td align="right">Done</td></tr><tr><td> Bare metal</td><td align="right">Planned</td></tr><tr><td></td><td align="right"></td></tr><tr><td><strong>Dashboard</strong></td><td align="right"></td></tr><tr><td> Show the most recent results</td><td align="right">Done</td></tr><tr><td> Pretty graphs</td><td align="right"><a href="https://github.com/alexjustesen/speedtest-tracker/pull/213">Done</a></td></tr><tr><td></td><td align="right"></td></tr><tr><td><strong>Results</strong></td><td align="right"></td></tr><tr><td> History of failed and successful results</td><td align="right">Done</td></tr><tr><td> Filter by <code>scheduled</code> and `successful</td><td align="right"><a href="https://github.com/alexjustesen/speedtest-tracker/pull/318">Done</a></td></tr><tr><td> Export selected results to CSV</td><td align="right"><a href="https://github.com/alexjustesen/speedtest-tracker/pull/370">Done</a></td></tr><tr><td></td><td align="right"></td></tr><tr><td><strong>Speedtest options</strong></td><td align="right"></td></tr><tr><td> Scheduled tests</td><td align="right">Done</td></tr><tr><td> Adhoc test</td><td align="right">Done</td></tr><tr><td> Manually specify a server</td><td align="right"><a href="https://github.com/alexjustesen/speedtest-tracker/pull/216">Done</a></td></tr><tr><td> Manually specify a list of servers</td><td align="right"><a href="https://github.com/alexjustesen/speedtest-tracker/pull/216">Done</a></td></tr><tr><td> Threshold alerts</td><td align="right">Done</td></tr><tr><td></td><td align="right"></td></tr><tr><td><strong>Ping options</strong></td><td align="right"></td></tr><tr><td> Ping a domain or list of domains</td><td align="right">Planned</td></tr><tr><td></td><td align="right"></td></tr><tr><td><strong>Database support</strong></td><td align="right"></td></tr><tr><td> SQLite (default)</td><td align="right">Done</td></tr><tr><td> MariaDB / MySQL</td><td align="right">Done</td></tr><tr><td> Postgresql</td><td align="right">Done</td></tr><tr><td> InfluxDB v1</td><td align="right">Planned</td></tr><tr><td> InfluxDB v2</td><td align="right">Done</td></tr><tr><td> Prometheus</td><td align="right">Planned</td></tr><tr><td></td><td align="right"></td></tr><tr><td><strong>Notification Channels</strong></td><td align="right"></td></tr><tr><td> In-app</td><td align="right"><a href="https://github.com/alexjustesen/speedtest-tracker/releases/tag/v0.1.0">Done</a></td></tr><tr><td> Mail</td><td align="right"><a href="https://github.com/alexjustesen/speedtest-tracker/releases/tag/v0.4.0">Done</a></td></tr><tr><td> Discord</td><td align="right">Planned</td></tr><tr><td> Gotify</td><td align="right">Planned</td></tr><tr><td> Slack</td><td align="right">Planned</td></tr><tr><td> Telegram</td><td align="right"><a href="https://github.com/alexjustesen/speedtest-tracker/pull/265">Done</a></td></tr><tr><td></td><td align="right"></td></tr><tr><td><strong>Application Monitoring</strong></td><td align="right"></td></tr><tr><td> <a href="https://ohdear.app/">https://ohdear.app/</a></td><td align="right">Planned</td></tr><tr><td> <a href="https://thenping.me/">https://thenping.me/</a></td><td align="right">Planned</td></tr><tr><td> <a href="https://healthchecks.io/">https://healthchecks.io/</a></td><td align="right">Planned</td></tr><tr><td></td><td align="right"></td></tr><tr><td><strong>Other</strong></td><td align="right"></td></tr><tr><td> Backup / Restore</td><td align="right">Planned</td></tr><tr><td> Import data from <a href="https://github.com/henrywhitaker3/Speedtest-Tracker">https://github.com/henrywhitaker3/Speedtest-Tracker</a></td><td align="right">Planned</td></tr></tbody></table>
9+
<table><thead><tr><th width="563">Features</th><th align="right">Status</th></tr></thead><tbody><tr><td><strong>Install options</strong></td><td align="right"></td></tr><tr><td> Docker images for x86</td><td align="right">Done</td></tr><tr><td> Docker images for arm64</td><td align="right">Done</td></tr><tr><td> unRAID Community App</td><td align="right">Done</td></tr><tr><td></td><td align="right"></td></tr><tr><td><strong>Dashboard</strong></td><td align="right"></td></tr><tr><td> Show the most recent results</td><td align="right">Done</td></tr><tr><td> Pretty graphs</td><td align="right"><a href="https://github.com/alexjustesen/speedtest-tracker/pull/213">Done</a></td></tr><tr><td></td><td align="right"></td></tr><tr><td><strong>Results</strong></td><td align="right"></td></tr><tr><td> History of failed and successful results</td><td align="right">Done</td></tr><tr><td> Filter by <code>scheduled</code> and `successful</td><td align="right"><a href="https://github.com/alexjustesen/speedtest-tracker/pull/318">Done</a></td></tr><tr><td> Export selected results to CSV</td><td align="right">Done</td></tr><tr><td></td><td align="right"></td></tr><tr><td><strong>Speedtest options</strong></td><td align="right"></td></tr><tr><td> Scheduled tests</td><td align="right">Done</td></tr><tr><td> Adhoc test</td><td align="right">Done</td></tr><tr><td> Manually specify a server</td><td align="right"><a href="https://github.com/alexjustesen/speedtest-tracker/pull/216">Done</a></td></tr><tr><td> Manually specify a list of servers</td><td align="right"><a href="https://github.com/alexjustesen/speedtest-tracker/pull/216">Done</a></td></tr><tr><td> Threshold alerts</td><td align="right">Done</td></tr><tr><td></td><td align="right"></td></tr><tr><td><strong>Ping options</strong></td><td align="right"></td></tr><tr><td> Ping a domain or list of domains</td><td align="right">Planned</td></tr><tr><td></td><td align="right"></td></tr><tr><td><strong>Database support</strong></td><td align="right"></td></tr><tr><td> SQLite (default)</td><td align="right">Done</td></tr><tr><td> MariaDB / MySQL</td><td align="right">Done</td></tr><tr><td> Postgresql</td><td align="right">Done</td></tr><tr><td> InfluxDB v1</td><td align="right">Planned</td></tr><tr><td> InfluxDB v2</td><td align="right">Done</td></tr><tr><td> Prometheus</td><td align="right">Planned</td></tr><tr><td></td><td align="right"></td></tr><tr><td><strong>Notification Channels</strong></td><td align="right"></td></tr><tr><td> In-app</td><td align="right"><a href="https://github.com/alexjustesen/speedtest-tracker/releases/tag/v0.1.0">Done</a></td></tr><tr><td> Mail</td><td align="right"><a href="https://github.com/alexjustesen/speedtest-tracker/releases/tag/v0.4.0">Done</a></td></tr><tr><td> Discord</td><td align="right">Planned</td></tr><tr><td> Gotify</td><td align="right">Planned</td></tr><tr><td> Slack</td><td align="right">Planned</td></tr><tr><td> Telegram</td><td align="right"><a href="https://github.com/alexjustesen/speedtest-tracker/pull/265">Done</a></td></tr><tr><td> Webhooks</td><td align="right"><a href="https://github.com/alexjustesen/speedtest-tracker/releases/tag/v0.15.0">Done</a></td></tr><tr><td></td><td align="right"></td></tr><tr><td><strong>Application Monitoring</strong></td><td align="right"></td></tr><tr><td> <a href="https://ohdear.app/">https://ohdear.app/</a></td><td align="right">Planned</td></tr><tr><td> <a href="https://thenping.me/">https://thenping.me/</a></td><td align="right">Planned</td></tr><tr><td> <a href="https://healthchecks.io/">https://healthchecks.io/</a></td><td align="right">Planned</td></tr><tr><td></td><td align="right"></td></tr><tr><td><strong>Other</strong></td><td align="right"></td></tr><tr><td> Backup / Restore</td><td align="right">Planned</td></tr><tr><td> Import data from <a href="https://github.com/henrywhitaker3/Speedtest-Tracker">https://github.com/henrywhitaker3/Speedtest-Tracker</a></td><td align="right">Planned</td></tr></tbody></table>

getting-started/installation/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Docker Compose is the recommended platform.
1010

1111
#### Core
1212

13-
<table><thead><tr><th width="225">Name</th><th>Description</th></tr></thead><tbody><tr><td><code>PUID</code><br><br>(required)</td><td>Used to set the user the container should run as. To find your UID run <code>id username</code> on the host machine.<br><br>- Default: <code>1000</code></td></tr><tr><td><code>PGID</code><br><br>(required)</td><td>Used to set the group the container should run as. To find your GID run <code>id username</code> on the host machine.<br><br>- Default: <code>1000</code></td></tr><tr><td><code>APP_KEY</code></td><td>Key used to encrypt and decrypt data. To create a key to persist follow the directions in the <a href="../../faqs.md#i-get-a-warning-on-container-start-up-that-the-app_key-is-missing">FAQ</a>.<br><br><em>Currently not used and generated at random on startup of the container</em>.</td></tr><tr><td><code>APP_DEBUG</code></td><td>Used to help narrow down issues in a running container, see <a href="../../faqs.md#im-getting-a-500-or-server-error-error">FAQ</a> for when to use it.<br><br>- Default: <code>false</code></td></tr><tr><td><code>DB_CONNECTION</code><br><br>(required)</td><td>Type of database to be used for storing data. Accepted values are <code>sqlite</code>, <code>mysql</code> and <code>pgsql</code>.</td></tr><tr><td><code>DB_HOST</code><br><br>(required)</td><td>FQDN or container name where the database is located.</td></tr><tr><td><code>DB_PORT</code></td><td>Port used to connect to the host where the database is located. Only needs to be defined if the database is running on a different port.<br><br>- Default: <code>3306</code> when using MySQL or MariaDB<br>- Default: <code>5432</code> when using Postgresql</td></tr><tr><td><code>DB_DATABASE</code><br><br>(required)</td><td>Name of the database.</td></tr><tr><td><code>DB_USERNAME</code><br><br>(required)</td><td>Database user used to connect to the database. Needs <code>read/write</code> access.</td></tr><tr><td><code>DB_PASSWORD</code><br><br>(required)</td><td>Password for the user specified to connect to the database.</td></tr><tr><td><code>FORCE_HTTPS</code></td><td>Enforces the user of <code>https</code> protocol when viewing the UI, port 443 must be mapped to the container for this to work.<br><br>- Default: <code>false</code></td></tr></tbody></table>
13+
<table><thead><tr><th width="225">Name</th><th>Description</th></tr></thead><tbody><tr><td><code>PUID</code><br><br>(required)</td><td>Used to set the user the container should run as. To find your UID run <code>id username</code> on the host machine.<br><br>- Default: <code>1000</code></td></tr><tr><td><code>PGID</code><br><br>(required)</td><td>Used to set the group the container should run as. To find your GID run <code>id username</code> on the host machine.<br><br>- Default: <code>1000</code></td></tr><tr><td><code>APP_KEY</code></td><td>Key used to encrypt and decrypt data. To create a key to persist follow the directions in the <a href="../../help/faqs.md#i-get-a-warning-on-container-start-up-that-the-app_key-is-missing">FAQ</a>.<br><br><em>Currently not used and generated at random on startup of the container</em>.</td></tr><tr><td><code>APP_DEBUG</code></td><td>Used to help narrow down issues in a running container, see <a href="../../help/faqs.md#im-getting-a-500-or-server-error-error">FAQ</a> for when to use it.<br><br>- Default: <code>false</code></td></tr><tr><td><code>DB_CONNECTION</code><br><br>(required)</td><td>Type of database to be used for storing data. Accepted values are <code>sqlite</code>, <code>mysql</code> and <code>pgsql</code>.</td></tr><tr><td><code>DB_HOST</code><br><br>(required)</td><td>FQDN or container name where the database is located.</td></tr><tr><td><code>DB_PORT</code></td><td>Port used to connect to the host where the database is located. Only needs to be defined if the database is running on a different port.<br><br>- Default: <code>3306</code> when using MySQL or MariaDB<br>- Default: <code>5432</code> when using Postgresql</td></tr><tr><td><code>DB_DATABASE</code><br><br>(required)</td><td>Name of the database.</td></tr><tr><td><code>DB_USERNAME</code><br><br>(required)</td><td>Database user used to connect to the database. Needs <code>read/write</code> access.</td></tr><tr><td><code>DB_PASSWORD</code><br><br>(required)</td><td>Password for the user specified to connect to the database.</td></tr><tr><td><code>FORCE_HTTPS</code></td><td>Enforces the user of <code>https</code> protocol when viewing the UI, port 443 must be mapped to the container for this to work.<br><br>- Default: <code>false</code></td></tr></tbody></table>
1414

1515
#### Functional
1616

File renamed without changes.

other/data-dictionary.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@
44

55
#### Results
66

7-
<table><thead><tr><th width="181.66666666666666">Field</th><th width="188">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>id</code></td><td>primary key</td><td></td></tr><tr><td><code>ping</code></td><td>double</td><td>As milliseconds</td></tr><tr><td><code>download</code></td><td>unsigned big integer</td><td>As bytes</td></tr><tr><td><code>upload</code></td><td>unsigned big integer</td><td>As bytes</td></tr><tr><td><code>server_id</code></td><td>integer</td><td>ID of the speedtest server</td></tr><tr><td><code>server_host</code></td><td>string</td><td>Host/URL of the speedtest server</td></tr><tr><td><code>server_name</code></td><td>string</td><td>Name of the speedtest server</td></tr><tr><td><code>url</code></td><td>string</td><td>URL to the result on speedtest.net</td></tr><tr><td><code>comments</code></td><td>text</td><td>User added comments</td></tr><tr><td><code>scheduled</code></td><td>boolean</td><td>Was the result scheduled?</td></tr><tr><td><code>successful</code></td><td>boolean</td><td>Was the result successful?</td></tr><tr><td><code>data</code></td><td>json</td><td>The raw data received from the Speedtest CLI</td></tr><tr><td><code>created_at</code></td><td>timestamp</td><td></td></tr></tbody></table>
7+
<table><thead><tr><th width="181.66666666666666">Field</th><th width="188">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>id</code></td><td>primary key</td><td></td></tr><tr><td><code>service</code></td><td>string</td><td>Service user to run the speedtest.</td></tr><tr><td><code>ping</code></td><td>double</td><td>As milliseconds</td></tr><tr><td><code>download</code></td><td>unsigned big int</td><td>As bytes</td></tr><tr><td><code>upload</code></td><td>unsigned big int</td><td>As bytes</td></tr><tr><td><code>comments</code></td><td>text</td><td>User added comments.</td></tr><tr><td><code>data</code></td><td>json</td><td>The raw response from the speedtest.</td></tr><tr><td><code>status</code></td><td>string</td><td><ul><li><strong>Completed</strong> - a speedtest that ran successfully.</li><li><strong>Failed</strong> - a speedtest that failed to run successfully.</li><li><strong>Started</strong> - a speedtest that has been started but has not finished running.</li></ul></td></tr><tr><td><code>scheduled</code></td><td>boolean</td><td>Was the result scheduled.</td></tr><tr><td><code>created_at</code></td><td>timestamp</td><td>When the record was created.</td></tr><tr><td><code>updated_at</code></td><td>timestamp</td><td>When the record was last updated.</td></tr></tbody></table>

0 commit comments

Comments
 (0)