diff --git "a/.gitbook/assets/Scherm\302\255afbeelding 2024-06-13 om 19.49.40.png" "b/.gitbook/assets/Scherm\302\255afbeelding 2024-06-13 om 19.49.40.png" new file mode 100644 index 0000000..6e91159 Binary files /dev/null and "b/.gitbook/assets/Scherm\302\255afbeelding 2024-06-13 om 19.49.40.png" differ diff --git a/.gitbook/assets/image (2).png b/.gitbook/assets/image (2).png new file mode 100644 index 0000000..2896fa8 Binary files /dev/null and b/.gitbook/assets/image (2).png differ diff --git a/README.md b/README.md index 75be9b3..e182bc5 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ description: >- Docs are up to date through version: `0.20.x` {% endhint %} -
+

V0.20.6 Dashboard

### Introduction diff --git a/SUMMARY.md b/SUMMARY.md index d877a81..6e50f3d 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -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 diff --git a/features.md b/features.md index 2aab85d..1daaf89 100644 --- a/features.md +++ b/features.md @@ -6,4 +6,4 @@ description: A full list of implemented features and those that are planned.
Dashboard page

Dashboard page

-
FeaturesStatus
Install options
Docker images for x86Done
Docker images for arm64Done
unRAID Community AppDone
Dashboard
Show the most recent resultsDone
Pretty graphsDone
Results
History of failed and successful resultsDone
Filter by scheduled and successfulDone
Export selected results to CSVDone
Speedtest options
Scheduled testsDone
Adhoc testDone
Manually specify a serverDone
Manually specify a list of serversDone
Threshold alertsDone
Ping options
Ping a domain or list of domainsPlanned
Database support
SQLite (default)Done
MariaDB / MySQLDone
PostgresqlDone
InfluxDB v1Planned
InfluxDB v2Done
PrometheusPlanned
Notification Channels
In-appDone
MailDone
DiscordPlanned
GotifyPlanned
SlackPlanned
TelegramDone
WebhooksDone
Application Monitoring
https://ohdear.app/Planned
https://thenping.me/Planned
https://healthchecks.io/Planned
Other
Backup / RestorePlanned
Import data from https://github.com/henrywhitaker3/Speedtest-TrackerPlanned
+
FeaturesStatus
Install options
Docker images for x86Done
Docker images for arm64Done
unRAID Community AppDone
Dashboard
Show the most recent resultsDone
Pretty graphsDone
Results
History of failed and successful resultsDone
Filter by scheduled and successfulDone
Export selected results to CSVDone
Speedtest options
Scheduled testsDone
Adhoc testDone
Manually specify a serverDone
Manually specify a list of serversDone
Threshold alertsDone
Ping options
Ping a domain or list of domainsPlanned
Database support
SQLite (default)Done
MariaDB / MySQLDone
PostgresqlDone
InfluxDB v1Planned
InfluxDB v2Done
PrometheusPlanned
Notification Channels
In-appDone
MailDone
DiscordDone
GotifyPlanned
SlackPlanned
TelegramDone
WebhooksDone
Application Monitoring
https://ohdear.app/Planned
https://thenping.me/Planned
https://healthchecks.io/Planned
Other
Backup / RestorePlanned
Import data from https://github.com/henrywhitaker3/Speedtest-TrackerPlanned
diff --git a/getting-started/installation/installation.md b/getting-started/installation/installation.md index e12eb55..e8fbafe 100644 --- a/getting-started/installation/installation.md +++ b/getting-started/installation/installation.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 %} + diff --git a/getting-started/installation/qnap.md b/getting-started/installation/qnap.md index 106f2aa..41027f3 100644 --- a/getting-started/installation/qnap.md +++ b/getting-started/installation/qnap.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 diff --git a/other/proxies.md b/other/proxies.md index df26bdb..86d6eef 100644 --- a/other/proxies.md +++ b/other/proxies.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 ``` -
Added compose part Description
APP_URLURL you want to access the WebGui on.
traefik.enable=trueExplicitly tell Traefik to expose this container
traefik.http.routers.speedtest-tracker.rule=Host(`speedtest.yourdomain.com`)The domain the service will respond to
traefik.http.routers.speedtest-tracker.entrypoints=websecureAllow request only from the predefined entry point
traefik.http.routers.speedtest-tracker.tls=trueWhen a TLS section is specified, it instructs Traefik that the current router is dedicated to HTTPS requests only
traefik.http.routers.speedtest-tracker.tls.certresolver=yourresolverExplicitly tell Traefik which Certificate provider to use matching your Traefik configuration
traefik.http.services.speedtest-tracker.loadbalancer.server.port=80Explicitly tell Traefik port to use to connect to the container
\ No newline at end of file +
Added compose partDescription
APP_URLURL you want to access the WebGui on.
traefik.enable=trueExplicitly tell Traefik to expose this container
traefik.http.routers.speedtest-tracker.rule=Host(`speedtest.yourdomain.com`)The domain the service will respond to
traefik.http.routers.speedtest-tracker.entrypoints=websecureAllow request only from the predefined entry point
traefik.http.routers.speedtest-tracker.tls=trueWhen a TLS section is specified, it instructs Traefik that the current router is dedicated to HTTPS requests only
traefik.http.routers.speedtest-tracker.tls.certresolver=yourresolverExplicitly tell Traefik which Certificate provider to use matching your Traefik configuration
traefik.http.services.speedtest-tracker.loadbalancer.server.port=80Explicitly tell Traefik port to use to connect to the container