Skip to content

Commit 2e75298

Browse files
authored
Merge pull request alexjustesen#48 from svenvg93/main
Rework Installation Guide
2 parents 9582d9e + cce4095 commit 2e75298

22 files changed

+283
-202
lines changed

.gitbook/assets/dashboard.png

490 KB
Loading
-192 KB
Binary file not shown.

.gitbook/assets/image (2).png

-125 KB
Binary file not shown.
-18.6 KB
Binary file not shown.
129 KB
Loading

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,9 @@ description: >-
1111
Docs are up to date through version: `0.24.x`
1212
{% endhint %}
1313

14-
<figure><img src=".gitbook/assets/image (2).png" alt=""><figcaption><p>V0.20.6 Dashboard</p></figcaption></figure>
14+
<figure><img src=".gitbook/assets/dashboard.png" alt=""><figcaption></figcaption></figure>
1515

16-
### Introduction
1716

18-
Speedtest Tracker is a self-hosted application that monitors the performance and uptime of your internet connection.
1917

2018
#### Why might I want this?
2119

SUMMARY.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@
77
## 🚀 Getting Started
88

99
* [Installation](getting-started/installation/README.md)
10-
* [Using Docker or Docker Compose](getting-started/installation/installation.md)
11-
* [Using Kubernetes](getting-started/installation/kubernetes.md)
12-
* [Using QNAP](getting-started/installation/qnap.md)
13-
* [Using Synology](getting-started/installation/synology.md)
14-
* [Using Unraid](getting-started/installation/unraid.md)
15-
* [Database Drivers](getting-started/database-drivers.md)
10+
* [Using Docker or Docker Compose](getting-started/installation/using-docker.md)
11+
* [Using Kubernetes](getting-started/installation/using-kubernetes.md)
12+
* [Using QNAP](getting-started/installation/using-qnap.md)
13+
* [Using Synology](getting-started/installation/using-synology.md)
14+
* [Using Unraid](getting-started/installation/using-unraid.md)
1615
* [Environment Variables](getting-started/environment-variables.md)
16+
* [Database Drivers](getting-started/database-drivers.md)
1717

1818
## 🆘 Help
1919

@@ -28,7 +28,7 @@
2828
## ⚙️ Settings
2929

3030
* [Data Integrations](settings/data-platforms/README.md)
31-
* [InfluxDB2](settings/data-platforms/influxdb2.md)
31+
* [InfluxDB v2](settings/data-platforms/influxdb2.md)
3232
* [Notifications](settings/notifications/README.md)
3333
* [Database](settings/notifications/database.md)
3434
* [Mail](settings/notifications/mail.md)
@@ -46,7 +46,6 @@
4646
* [Embed Dashboard](other/embed-dashboard.md)
4747
* [Health Check](other/health-check.md)
4848
* [Community Projects](other/community-projects.md)
49-
* [Stream Deck](other/stream-deck.md)
5049

5150
## 🖥️ API
5251

@@ -62,5 +61,5 @@
6261
* [Source Code](https://github.com/alexjustesen/speedtest-tracker)
6362
* [Releases](https://github.com/alexjustesen/speedtest-tracker/releases)
6463
* [Update the Docs](https://github.com/alexjustesen/speedtest-tracker-docs)
65-
* [About Me](https://alexjustesen.com/?utm\_campaign=oss-projects\&utm\_source=speedtest-tracker-docs\&utm\_medium=textlink)
64+
* [About Me](https://alexjustesen.com/?utm_campaign=oss-projects\&utm_source=speedtest-tracker-docs\&utm_medium=textlink)
6665
* [Donate](https://github.com/sponsors/alexjustesen)

features.md

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

55
# Features
66

7-
<figure><img src=".gitbook/assets/dashboard_screenshot.jpg" alt="Dashboard page"><figcaption><p>Dashboard page</p></figcaption></figure>
8-
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 <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>
7+
<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

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,39 +8,43 @@ description: >-
88

99
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.
1010

11-
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.
11+
SQLite ships as the default driver but you can also use MySQL/MariaDB/Postgres.&#x20;
12+
13+
> While SQL Server is supported by Laravel it hasn't been tested with Speedtest Tracker so no support will be provided for that driver.
1214
1315
***
1416

1517
### Driver Options
1618

1719
#### SQLite (Default)
1820

19-
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.
20-
21-
To use SQLite follow the steps below to create your database file:&#x20;
22-
23-
1. Create a volume called `speedtest-tracker` or mount a directory to the container.
24-
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.
25-
3. Update your environment variables to only include the following environment variable in the table below.
26-
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.
21+
SQLite is a good option for simple installs. The database will be create automatically inside the docker volume.&#x20;
2722

2823
| Environment Variable | Value |
2924
| -------------------- | -------- |
3025
| `DB_CONNECTION` | `sqlite` |
3126

32-
#### MySQL/MariaDB
27+
#### MariaDB
28+
29+
| Environment Variable | Value |
30+
| -------------------- | -------------------------------------------------------- |
31+
| `DB_CONNECTION` | `mariadb` |
32+
| `DB_HOST` | The FQDN or address to the database instance. |
33+
| `DB_PORT` | `3306` is the default port but can depend on your setup. |
34+
| `DB_DATABASE` | Name of the database you'll connect to. |
35+
| `DB_USERNAME` | User that'll be used to connect to the database. |
36+
| `DB_PASSWORD` | Password for the user above. |
3337

34-
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.
38+
#### MySQL
3539

36-
| Environment Variable | Value |
37-
| -------------------- | -------------------------------------------------------------------------------------------------------------- |
38-
| `DB_CONNECTION` | <p><code>mysql</code> </p><p></p><p>The <code>mysql</code> driver can be used for both MySQL and MariaDB.</p> |
39-
| `DB_HOST` | The FQDN or address to the database instance. |
40-
| `DB_PORT` | `3306` is the default port but can depend on your setup. |
41-
| `DB_DATABASE` | Name of the database you'll connect to. |
42-
| `DB_USERNAME` | User that'll be used to connect to the database. |
43-
| `DB_PASSWORD` | Password for the user above. |
40+
| Environment Variable | Value |
41+
| -------------------- | -------------------------------------------------------- |
42+
| `DB_CONNECTION` | `mysql` |
43+
| `DB_HOST` | The FQDN or address to the database instance. |
44+
| `DB_PORT` | `3306` is the default port but can depend on your setup. |
45+
| `DB_DATABASE` | Name of the database you'll connect to. |
46+
| `DB_USERNAME` | User that'll be used to connect to the database. |
47+
| `DB_PASSWORD` | Password for the user above. |
4448

4549
#### Postgres
4650

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,2 @@
11
# Installation
22

3-
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).
4-
5-
{% hint style="info" %}
6-
Docker Compose is the recommended platform.
7-
{% endhint %}
8-
9-
### Port Mapping
10-
11-
<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>
12-

0 commit comments

Comments
 (0)