Skip to content

Commit 238b3c8

Browse files
svenvg93gitbook-bot
authored andcommitted
GITBOOK-2: No subject
1 parent a5b9749 commit 238b3c8

File tree

8 files changed

+107
-47
lines changed

8 files changed

+107
-47
lines changed

.gitbook/assets/cf-tunnel.png

649 KB
Loading

SUMMARY.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,15 @@
3636

3737
## 👀 Other
3838

39+
* [Proxies](other/proxies/README.md)
40+
* [Cloudflare Tunnel (Zero Trust)](other/proxies/cloudflare-tunnel-zero-trust.md)
41+
* [Traefik](other/proxies/traefik.md)
3942
* [Caching](other/caching.md)
4043
* [Commands](other/commands.md)
4144
* [Data Dictionary](other/data-dictionary.md)
4245
* [Embed Dashboard](other/embed-dashboard.md)
4346
* [Health Check](other/health-check.md)
4447
* [Stream Deck](other/stream-deck.md)
45-
* [Proxies](other/proxies.md)
46-
4748

4849
## 🖥️ API
4950

features.md

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

77
<figure><img src=".gitbook/assets/dashboard_screenshot.jpg" alt="Dashboard page"><figcaption><p>Dashboard page</p></figcaption></figure>
88

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">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>
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>

getting-started/environment-variables.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: >-
88

99
### Application
1010

11-
<table><thead><tr><th width="233">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>APP_NAME</code></td><td>Used to define the application's name in the dashboard and in notifications.<br></td></tr><tr><td><code>APP_KEY</code><br><br>(required)</td><td><p>Key used to encrypt and decrypt data.</p><p>You can generate a key at <a href="https://speedtest-tracker.dev">https://speedtest-tracker.dev</a>.</p></td></tr><tr><td><code>APP_URL</code></td><td>URL used for assets and links in emails and notifications.</td></tr><tr><td><code>APP_TIMEZONE</code></td><td>Application timezone should be set if your database does not use UTC as it's default timezone.</td></tr><tr><td><code>CHART_DATETIME</code><br><code>_FORMAT</code></td><td>Set the formatting of timestamps in charts.<br><br>Formatting: <a href="https://www.php.net/manual/en/datetime.format.php">https://www.php.net/manual/en/datetime.format.php</a></td></tr><tr><td><code>DATETIME_FORMAT</code></td><td>Set the formatting of timestamps in tables and notifications.<br><br>Formatting: <a href="https://www.php.net/manual/en/datetime.format.php">https://www.php.net/manual/en/datetime.format.php</a></td></tr><tr><td><code>DISPLAY_TIMEZONE</code></td><td>Display timestamps in your local time.</td></tr><tr><td><code>CONTENT_WIDTH</code></td><td>Width of the content section of each page. Can be set to any value found in the Filament <a href="https://filamentphp.com/docs/3.x/panels/configuration#customizing-the-maximum-content-width">docs</a>.<br><br>- Default:<code>7xl</code></td></tr><tr><td><code>PUBLIC_DASHBOARD</code></td><td>Enables the public dashboard for guest (unauthenticated) users.<br><br>- Default:<code>false</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>60s</code></td></tr><tr><td><code>NOTIFICATION</code><br><code>_POLLING</code></td><td>Frequency database notifications are polled. Can be represented using a string in seconds or<code>false</code>to disable.<br><br>- Default:<code>60s</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>false</code></td></tr><tr><td><code>CHART_DEFAULT_DATE_RANGE</code></td><td>The default time range the charts will use.<br><br>- Default: 7</td></tr><tr><td><code>CHART_BEGIN_AT_ZERO</code></td><td>Wheter the charts should starts at zero (0) or not.<br><br>- Default: <code>true</code></td></tr></tbody></table>
11+
<table><thead><tr><th width="233">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>APP_NAME</code></td><td>Used to define the application's name in the dashboard and in notifications.<br></td></tr><tr><td><code>APP_KEY</code><br><br>(required)</td><td><p>Key used to encrypt and decrypt data.</p><p>You can generate a key at <a href="https://speedtest-tracker.dev">https://speedtest-tracker.dev</a>.</p></td></tr><tr><td><code>APP_URL</code></td><td>URL used for links in emails and notifications.</td></tr><tr><td><code>ASSET_URL</code></td><td>URL used for assets, needed when using a reverse proxy.</td></tr><tr><td><code>APP_TIMEZONE</code></td><td>Application timezone should be set if your database does not use UTC as it's default timezone.</td></tr><tr><td><code>CHART_DATETIME</code><br><code>_FORMAT</code></td><td>Set the formatting of timestamps in charts.<br><br>Formatting: <a href="https://www.php.net/manual/en/datetime.format.php">https://www.php.net/manual/en/datetime.format.php</a></td></tr><tr><td><code>DATETIME_FORMAT</code></td><td>Set the formatting of timestamps in tables and notifications.<br><br>Formatting: <a href="https://www.php.net/manual/en/datetime.format.php">https://www.php.net/manual/en/datetime.format.php</a></td></tr><tr><td><code>DISPLAY_TIMEZONE</code></td><td>Display timestamps in your local time.</td></tr><tr><td><code>CONTENT_WIDTH</code></td><td>Width of the content section of each page. Can be set to any value found in the Filament <a href="https://filamentphp.com/docs/3.x/panels/configuration#customizing-the-maximum-content-width">docs</a>.<br><br>- Default:<code>7xl</code></td></tr><tr><td><code>PUBLIC_DASHBOARD</code></td><td>Enables the public dashboard for guest (unauthenticated) users.<br><br>- Default:<code>false</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>60s</code></td></tr><tr><td><code>NOTIFICATION</code><br><code>_POLLING</code></td><td>Frequency database notifications are polled. Can be represented using a string in seconds or<code>false</code>to disable.<br><br>- Default:<code>60s</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>false</code></td></tr><tr><td><code>CHART_DEFAULT_DATE_RANGE</code></td><td>The default time range the charts will use.<br><br>- Default: 7</td></tr><tr><td><code>CHART_BEGIN_AT_ZERO</code></td><td>Wheter the charts should starts at zero (0) or not.<br><br>- Default: <code>true</code></td></tr></tbody></table>
1212

1313
### Speedtest
1414

other/proxies.md

Lines changed: 0 additions & 43 deletions
This file was deleted.

other/proxies/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
description: >-
3+
Installation guides for when using Reverse Proxies. These configurations are
4+
provided by the community.
5+
---
6+
7+
# Proxies
8+
9+
```
10+
```

0 commit comments

Comments
 (0)