Merge pull request alexjustesen#32 from svenvg93/main

Update and fix docs

Author: alexjustesen

.gitbook/assets/Scherm­afbeelding 2024-06-13 om 19.49.40.png

@@ -10,7 +10,7 @@ description: >-
 Docs are up to date through version: `0.20.x`
 {% endhint %}
 
-<figure><img src=".gitbook/assets/dashboard_screenshot.jpg" alt=""><figcaption></figcaption></figure>
+<figure><img src=".gitbook/assets/image (2).png" alt=""><figcaption><p>V0.20.6 Dashboard</p></figcaption></figure>
 
 ### Introduction
 

.gitbook/assets/image (2).png

@@ -42,6 +42,8 @@
 * [Embed Dashboard](other/embed-dashboard.md)
 * [Health Check](other/health-check.md)
 * [Stream Deck](other/stream-deck.md)
+* [Proxies](other/proxies.md)
+
 
 ## 🖥️ API
 

README.md

@@ -6,4 +6,4 @@ description: A full list of implemented features and those that are planned.
 
 <figure><img src=".gitbook/assets/dashboard_screenshot.jpg" alt="Dashboard page"><figcaption><p>Dashboard page</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></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 <code>successful</code></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>
+<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 <code>successful</code></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"><a href="https://github.com/alexjustesen/speedtest-tracker/pull/1196">Done</a></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>

SUMMARY.md

@@ -13,14 +13,16 @@ Setting up your environment with Docker Compose is the recommended infrastructur
 If you would like to provide your own SSL keys, they must be named `cert.crt` (full chain) and `cert.key` (private key), and mounted in the container folder `/config/keys`.
 
 {% hint style="info" %}
-Complete overview of the Environment Variables can be found here
-[environment-variables.md](environment-variables.md "mention").
+Complete overview of the Environment Variables can be found [here](../environment-variables.md) 
+{% endhint %}
+
+{% hint style="info" %}
+A full list of released versions can be found [here](https://fleet.linuxserver.io/image?name=linuxserver/speedtest-tracker)
 {% endhint %}
 
 {% tabs %}
 {% tab title="SQLite" %}
 ```yaml
-version: '3.4'
 services:
     speedtest-tracker:
         container_name: speedtest-tracker
@@ -41,14 +43,13 @@ services:
         volumes:
             - /path/to/data:/config
             - /path/to-custom-ssl-keys:/config/keys
-        image: lscr.io/linuxserver/speedtest-tracker:latest
+        image: lscr.io/linuxserver/speedtest-tracker:0.20.6
         restart: unless-stopped
 ```
 {% endtab %}
 
 {% tab title="MariaDB/MySQL" %}
 ```yaml
-version: '3.4'
 services:
     speedtest-tracker:
         container_name: speedtest-tracker
@@ -95,7 +96,6 @@ volumes:
 
 {% tab title="Postgres" %}
 ```yaml
-version: '3.4'
 services:
     speedtest-tracker:
         container_name: speedtest-tracker
@@ -148,6 +148,10 @@ volumes:
 These instructions assume you have an appropriate database instance that already exists.
 {% endhint %}
 
+{% hint style="info" %}
+A full list of released versions can be found [here](https://fleet.linuxserver.io/image?name=linuxserver/speedtest-tracker)
+{% endhint %}
+
 {% tabs %}
 {% tab title="SQLite" %}
 ```bash
@@ -166,7 +170,7 @@ docker run -d --name speedtest-tracker --restart unless-stopped \
     -e APP_TIMEZONE= \
     -v /path/to/data:/config \
     -v /path/to-custom-ssl-keys:/config/keys \
-    lscr.io/linuxserver/speedtest-tracker:latest
+    lscr.io/linuxserver/speedtest-tracker:0.20.6
 ```
 {% endtab %}
 
@@ -188,12 +192,13 @@ docker run -d --name speedtest-tracker --restart unless-stopped \
     -e SPEEDTEST_SERVERS= \
     -v /path/to/data:/config \
     -v /path/to-custom-ssl-keys:/config/keys \
-    lscr.io/linuxserver/speedtest-tracker:latest
+    lscr.io/linuxserver/speedtest-tracker:0.20.6
 ```
 {% endtab %}
 
 {% tab title="Postgres" %}
 ```bash
+
 docker run -d --name speedtest-tracker --restart unless-stopped \
     -p 8080:80 \
     -p 8443:443 \
@@ -214,7 +219,8 @@ docker run -d --name speedtest-tracker --restart unless-stopped \
     -e APP_TIMEZONE= \
     -v /path/to/data:/config \
     -v /path/to-custom-ssl-keys:/config/keys \
-    lscr.io/linuxserver/speedtest-tracker:latest
+    lscr.io/linuxserver/speedtest-tracker:0.20.6
 ```
 {% endtab %}
 {% endtabs %}
+

features.md

@@ -15,8 +15,11 @@ These instructions will run you through setting up the application on a QNAP NAS
 
 ### Example Docker Compose
 
+{% hint style="info" %}
+A full list of released versions can be found [here](https://fleet.linuxserver.io/image?name=linuxserver/speedtest-tracker)
+{% endhint %}
+
 ```yaml
-version: '3.4'
 services:
   speedtest-tracker:
     container_name: speedtest-tracker
@@ -42,7 +45,7 @@ services:
     volumes:
       - /path/to-data:/config
       - /path/to-custom-ssl-keys:/config/keys
-    image: lscr.io/linuxserver/speedtest-tracker:latest
+    image: lscr.io/linuxserver/speedtest-tracker:0.20.6
     networks:
       qnet-network:
         ipv4_address: 192.168.1.3

getting-started/installation/installation.md

@@ -1,5 +1,5 @@
 ---
-description: Setup for when using a Reserve Proxy 
+description: Installation guides for when using Reverse Proxies
 ---
 
 # Proxies
@@ -8,10 +8,13 @@ description: Setup for when using a Reserve Proxy
 
 Traefik can be used as a Reverse Proxy in front of Speedtest Tracker when you want to expose the Dashboard publicly with a trusted certificate. You will need at add the `APP_URL` envoirment and needed labels to the docker compose have treafik apply the certificate and routing.
 
+{% hint style="info" %}
+A full list of released versions can be found [here](https://fleet.linuxserver.io/image?name=linuxserver/speedtest-tracker)
+{% endhint %}
+
 Docker-Compose:
 
 ```yaml
-version: '3.4'
 services:
     speedtest-tracker:
         container_name: speedtest-tracker
@@ -33,8 +36,8 @@ services:
             - "traefik.http.routers.speedtest-tracker.tls=true"
             - "traefik.http.routers.speedtest-tracker.tls.certresolver=yourresolver"
             - "traefik.http.services.speedtest-tracker.loadbalancer.server.port=80"
-        image: lscr.io/linuxserver/speedtest-tracker:latest
+        image: lscr.io/linuxserver/speedtest-tracker:0.20.6
         restart: unless-stopped
 ```
 
-<table><thead><tr><th width="261">Added compose part </th><th>Description</th></tr></thead><tbody><tr><td><code>APP_URL</code></td><td>URL you want to access the WebGui on.</td></tr><tr><td><code>traefik.enable=true</code></td><td>Explicitly tell Traefik to expose this container</td></tr><tr><td><code>traefik.http.routers.speedtest-tracker.rule=Host(`speedtest.yourdomain.com`)</code></td><td>The domain the service will respond to</td></tr><tr><td><code>traefik.http.routers.speedtest-tracker.entrypoints=websecure</code></td><td>Allow request only from the predefined entry point</td></tr><tr><td><code>traefik.http.routers.speedtest-tracker.tls=true</code></td><td>When a TLS section is specified, it instructs Traefik that the current router is dedicated to HTTPS requests only</td></tr><tr><td><code>traefik.http.routers.speedtest-tracker.tls.certresolver=yourresolver</code></td><td>Explicitly tell Traefik which Certificate provider to use matching your Traefik configuration </td></tr><tr><td><code>traefik.http.services.speedtest-tracker.loadbalancer.server.port=80</code></td><td>Explicitly tell Traefik port to use to connect to the container </td></tr></tbody></table>
+<table><thead><tr><th width="261">Added compose part</th><th>Description</th></tr></thead><tbody><tr><td><code>APP_URL</code></td><td>URL you want to access the WebGui on.</td></tr><tr><td><code>traefik.enable=true</code></td><td>Explicitly tell Traefik to expose this container</td></tr><tr><td><code>traefik.http.routers.speedtest-tracker.rule=Host(`speedtest.yourdomain.com`)</code></td><td>The domain the service will respond to</td></tr><tr><td><code>traefik.http.routers.speedtest-tracker.entrypoints=websecure</code></td><td>Allow request only from the predefined entry point</td></tr><tr><td><code>traefik.http.routers.speedtest-tracker.tls=true</code></td><td>When a TLS section is specified, it instructs Traefik that the current router is dedicated to HTTPS requests only</td></tr><tr><td><code>traefik.http.routers.speedtest-tracker.tls.certresolver=yourresolver</code></td><td>Explicitly tell Traefik which Certificate provider to use matching your Traefik configuration</td></tr><tr><td><code>traefik.http.services.speedtest-tracker.loadbalancer.server.port=80</code></td><td>Explicitly tell Traefik port to use to connect to the container</td></tr></tbody></table>