Rework Installation Guide

README.md

@@ -11,11 +11,9 @@ description: >-
 Docs are up to date through version: `0.24.x`
 {% endhint %}
 
-<figure><img src=".gitbook/assets/image (2).png" alt=""><figcaption><p>V0.20.6 Dashboard</p></figcaption></figure>
+<figure><img src=".gitbook/assets/dashboard.png" alt=""><figcaption></figcaption></figure>
 
-### Introduction
 
-Speedtest Tracker is a self-hosted application that monitors the performance and uptime of your internet connection.
 
 #### Why might I want this?
 

SUMMARY.md

@@ -7,13 +7,13 @@
 ## 🚀 Getting Started
 
 * [Installation](getting-started/installation/README.md)
-  * [Using Docker or Docker Compose](getting-started/installation/installation.md)
-  * [Using Kubernetes](getting-started/installation/kubernetes.md)
-  * [Using QNAP](getting-started/installation/qnap.md)
-  * [Using Synology](getting-started/installation/synology.md)
-  * [Using Unraid](getting-started/installation/unraid.md)
-* [Database Drivers](getting-started/database-drivers.md)
+  * [Using Docker or Docker Compose](getting-started/installation/using-docker.md)
+  * [Using Kubernetes](getting-started/installation/using-kubernetes.md)
+  * [Using QNAP](getting-started/installation/using-qnap.md)
+  * [Using Synology](getting-started/installation/using-synology.md)
+  * [Using Unraid](getting-started/installation/using-unraid.md)
 * [Environment Variables](getting-started/environment-variables.md)
+* [Database Drivers](getting-started/database-drivers.md)
 
 ## 🆘 Help
 
@@ -28,7 +28,7 @@
 ## ⚙️ Settings
 
 * [Data Integrations](settings/data-platforms/README.md)
-  * [InfluxDB2](settings/data-platforms/influxdb2.md)
+  * [InfluxDB v2](settings/data-platforms/influxdb2.md)
 * [Notifications](settings/notifications/README.md)
   * [Database](settings/notifications/database.md)
   * [Mail](settings/notifications/mail.md)
@@ -46,7 +46,6 @@
 * [Embed Dashboard](other/embed-dashboard.md)
 * [Health Check](other/health-check.md)
 * [Community Projects](other/community-projects.md)
-* [Stream Deck](other/stream-deck.md)
 
 ## 🖥️ API
 
@@ -62,5 +61,5 @@
 * [Source Code](https://github.com/alexjustesen/speedtest-tracker)
 * [Releases](https://github.com/alexjustesen/speedtest-tracker/releases)
 * [Update the Docs](https://github.com/alexjustesen/speedtest-tracker-docs)
-* [About Me](https://alexjustesen.com/?utm\_campaign=oss-projects\&utm\_source=speedtest-tracker-docs\&utm\_medium=textlink)
+* [About Me](https://alexjustesen.com/?utm_campaign=oss-projects\&utm_source=speedtest-tracker-docs\&utm_medium=textlink)
 * [Donate](https://github.com/sponsors/alexjustesen)

features.md

@@ -4,6 +4,4 @@ description: A full list of implemented features and those that are planned.
 
 # Features
 
-<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"><a href="https://github.com/alexjustesen/speedtest-tracker/pull/1196">Done</a></td></tr><tr><td>Gotify</td><td align="right"><a href="https://github.com/alexjustesen/speedtest-tracker/pull/1561">Done</a></td></tr><tr><td>Slack</td><td align="right"><a href="https://github.com/alexjustesen/speedtest-tracker/pull/1522">Done</a></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>Ntfy</td><td align="right"><a href="https://github.com/alexjustesen/speedtest-tracker/pull/1579">Done</a></td></tr><tr><td>Pushover</td><td align="right"><a href="https://github.com/alexjustesen/speedtest-tracker/pull/1574">Done</a></td></tr><tr><td>HealthCheck.io</td><td align="right"><a href="https://github.com/alexjustesen/speedtest-tracker/pull/1567">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 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"><a href="https://github.com/alexjustesen/speedtest-tracker/pull/1561">Done</a></td></tr><tr><td>Slack</td><td align="right"><a href="https://github.com/alexjustesen/speedtest-tracker/pull/1522">Done</a></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>Ntfy</td><td align="right"><a href="https://github.com/alexjustesen/speedtest-tracker/pull/1579">Done</a></td></tr><tr><td>Pushover</td><td align="right"><a href="https://github.com/alexjustesen/speedtest-tracker/pull/1574">Done</a></td></tr><tr><td>HealthCheck.io</td><td align="right"><a href="https://github.com/alexjustesen/speedtest-tracker/pull/1567">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></tbody></table>

getting-started/database-drivers.md

@@ -8,39 +8,43 @@ description: >-
 
 Since Speedtest Tracker is built on the Laravel Framework any of the framework's supported database [drivers](https://laravel.com/docs/10.x/database#configuration) are also supported.
 
-SQLite ships as the default driver but you can also use MySQL/MariaDB and Postgres. While SQL Server is supported by Laravel it hasn't been tested with Speedtest Tracker so no support will be provided for that driver.
+SQLite ships as the default driver but you can also use MySQL/MariaDB/Postgres. 
+
+> While SQL Server is supported by Laravel it hasn't been tested with Speedtest Tracker so no support will be provided for that driver.
 
 ***
 
 ### Driver Options
 
 #### SQLite (Default)
 
-SQLite is a good option for simple installs and only not recommended because I think separating your application and the database into separate services is a better idea.
-
-To use SQLite follow the steps below to create your database file: 
-
-1. Create a volume called `speedtest-tracker` or mount a directory to the container.
-2. Create a file called `database.sqlite`, you can do this by running `touch database.sqlite` in the mounted volume or create it in the mounted directory.
-3. Update your environment variables to only include the following environment variable in the table below.
-4. On start-up the container will checked for the database on the file system, if it can find it errors will be thrown to the log.
+SQLite is a good option for simple installs. The database will be create automatically inside the docker volume. 
 
 | Environment Variable | Value    |
 | -------------------- | -------- |
 | `DB_CONNECTION`      | `sqlite` |
 
-#### MySQL/MariaDB
+#### MariaDB
+
+| Environment Variable | Value                                                    |
+| -------------------- | -------------------------------------------------------- |
+| `DB_CONNECTION`      | `mariadb`                                                |
+| `DB_HOST`            | The FQDN or address to the database instance.            |
+| `DB_PORT`            | `3306` is the default port but can depend on your setup. |
+| `DB_DATABASE`        | Name of the database you'll connect to.                  |
+| `DB_USERNAME`        | User that'll be used to connect to the database.         |
+| `DB_PASSWORD`        | Password for the user above.                             |
 
-MariaDB ships as the default database that's included in the `docker-compose.yml` configuration, it's functionally the same as MySQL just an open-source earlier fork.
+#### MySQL
 
-| Environment Variable | Value                                                                                                          |
-| -------------------- | -------------------------------------------------------------------------------------------------------------- |
-| `DB_CONNECTION`      | <p><code>mysql</code>  </p><p></p><p>The <code>mysql</code> driver can be used for both MySQL and MariaDB.</p> |
-| `DB_HOST`            | The FQDN or address to the database instance.                                                                  |
-| `DB_PORT`            | `3306` is the default port but can depend on your setup.                                                       |
-| `DB_DATABASE`        | Name of the database you'll connect to.                                                                        |
-| `DB_USERNAME`        | User that'll be used to connect to the database.                                                               |
-| `DB_PASSWORD`        | Password for the user above.                                                                                   |
+| Environment Variable | Value                                                    |
+| -------------------- | -------------------------------------------------------- |
+| `DB_CONNECTION`      | `mysql`                                                  |
+| `DB_HOST`            | The FQDN or address to the database instance.            |
+| `DB_PORT`            | `3306` is the default port but can depend on your setup. |
+| `DB_DATABASE`        | Name of the database you'll connect to.                  |
+| `DB_USERNAME`        | User that'll be used to connect to the database.         |
+| `DB_PASSWORD`        | Password for the user above.                             |
 
 #### Postgres
 

getting-started/installation/README.md

@@ -1,12 +1,2 @@
 # Installation
 
-Speedtest Tracker can be run on a variety of platforms including using [Docker and Docker Compose](installation.md) along with [Synology NAS](synology.md) devices and on [Unraid OS](unraid.md).
-
-{% hint style="info" %}
-Docker Compose is the recommended platform.
-{% endhint %}
-
-### Port Mapping
-
-<table><thead><tr><th>Protocol</th><th data-type="number">External port (default)</th><th data-type="number">Internal port</th></tr></thead><tbody><tr><td>HTTP</td><td>80</td><td>80</td></tr><tr><td>HTTPS</td><td>443</td><td>443</td></tr></tbody></table>
-