GITBOOK-34: change request with no subject merged in GitBook

Author: alexjustesen

README.md

@@ -24,7 +24,7 @@ _...also some of us just like a lot of data._
 
 #### What about that other Speedtest Tracker?
 
-As far as I can tell [https://github.com/henrywhitaker3/Speedtest-Tracker](https://github.com/henrywhitaker3/Speedtest-Tracker) was abandoned. This version is meant to be an actively maintained replacement with an improved UI and [feature](getting-started/features.md) set.
+As far as I can tell [https://github.com/henrywhitaker3/Speedtest-Tracker](https://github.com/henrywhitaker3/Speedtest-Tracker) was abandoned. This version is meant to be an actively maintained replacement with an improved UI and [feature](features.md) set.
 
 #### Do you have a demo?
 

SUMMARY.md

@@ -1,13 +1,14 @@
 # Table of contents
 
 * [Introduction](README.md)
+* [Features](features.md)
 * [Frequently Asked Questions](faqs.md)
 * [Data Dictionary](data-dictionary.md)
 
 ## 🚀 Getting Started
 
 * [Installation](getting-started/installation.md)
-* [Features](getting-started/features.md)
+* [Environment Variables](getting-started/environment-variables.md)
 
 ## ⚙ Settings
 

data-dictionary.md

@@ -4,18 +4,4 @@
 
 #### Results
 
-| Field         | Type                 | Description                                  |
-| ------------- | -------------------- | -------------------------------------------- |
-| `id`          | primary key          |                                              |
-| `ping`        | double               | As milliseconds                              |
-| `download`    | unsigned big integer | As bytes                                     |
-| `upload`      | unsigned big integer | As bytes                                     |
-| `server_id`   | integer              | ID of the speedtest server                   |
-| `server_host` | string               | Host/URL of the speedtest server             |
-| `server_name` | string               | Name of the speedtest server                 |
-| `url`         | string               | URL to the result on speedtest.net           |
-| `comments`    | text                 | User added comments                          |
-| `scheduled`   | boolean              | Was the result scheduled?                    |
-| `successful`  | boolean              | Was the result successful?                   |
-| `data`        | json                 | The raw data received from the Speedtest CLI |
-| `created_at`  | timestamp            |                                              |
+<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>

features.md

@@ -0,0 +1,9 @@
+---
+description: A full list of implemented features and those that are planned.
+---
+
+# Features
+
+<figure><img src="https://github.com/alexjustesen/speedtest-tracker/blob/main/.github/screenshots/dashboard_screenshot.png?raw=true" alt=""><figcaption><p><em>Dashboard</em></p></figcaption></figure>
+
+<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>

getting-started/environment-variables.md

@@ -0,0 +1,3 @@
+# Environment Variables
+
+<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.<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.<br><br>- Default: <code>1000</code></td></tr><tr><td><code>DASHBOARD_POLLING</code></td><td>Frequency charts and stats refresh on the dashboard. Can be represented using a string in seconds or <code>false</code> to disable.<br><br>- Default: <code>5s</code></td></tr><tr><td><code>RESULTS_POLLING</code></td><td>Frequency data refreshes in the results table. Can be represented using a string in seconds or <code>false</code> to disable.<br><br>- Default: <code>5s</code></td></tr></tbody></table>