GITBOOK-39: change request with no subject merged in GitBook

Author: alexjustesen

.gitbook/assets/dashboard_screenshot.jpg

@@ -6,12 +6,12 @@ description: >-
 
 # Introduction
 
-
-
 {% hint style="info" %}
-These docs are up-to-date for version: `v0.11.18`
+These docs are up-to-date for version: `v0.12.beta.6`
 {% endhint %}
 
+<figure><img src=".gitbook/assets/dashboard_screenshot.jpg" alt=""><figcaption></figcaption></figure>
+
 ### Introduction
 
 Speedtest Tracker is a self-hosted internet performance tracking application that runs speedtest checks against Ookla's Speedtest service.

.gitbook/assets/login_screenshot.jpg

@@ -7,13 +7,21 @@
 
 ## 🚀 Getting Started
 
-* [Installation](getting-started/installation.md)
+* [Installation](getting-started/installation/README.md)
+  * [Using Docker or Docker Compose](getting-started/installation/installation.md)
+  * [Using Synology](getting-started/installation/installation-1.md)
+  * [Using Unraid](getting-started/installation/installation-2.md)
 * [Environment Variables](getting-started/environment-variables.md)
+* [Page](getting-started/page.md)
+
+## 🔑 Security
+
+* [Authentication](security/authentication.md)
+* [Authorization](security/authorization.md)
 
 ## ⚙ Settings
 
-* [Authentication](settings/authentication.md)
-* [Data Platforms](settings/data-platforms/README.md)
+* [Data Integrations](settings/data-platforms/README.md)
   * [InfluxDB2](settings/data-platforms/influxdb2.md)
 * [Notifications](settings/notifications/README.md)
   * [Database](settings/notifications/database.md)

.gitbook/assets/results_screenshot.jpg

@@ -4,13 +4,54 @@ description: A running list of frequently ask questions and their answers.
 
 # Frequently Asked Questions
 
+### Docker
+
+<details>
+
+<summary>I get a warning on container start up that the <code>APP_KEY</code> is missing</summary>
+
+As of `v0.12.0` the app key is generated on start-up and it is **OK to ignore this warning**. To set a persisted key follow the steps below
+
+1. Open the CLI of the Speedtest Docker container
+2. Run `php artisan key:generate --show`
+3. Add the generated string to your environment variables attached to `APP_KEY=generatedstringgoeshere`
+4. Restart the container
+
+</details>
+
 ### Notifications
 
 <details>
 
-<summary>Links in emails don't point to the correct url</summary>
+<summary>Links in emails don't point to the correct URL</summary>
 
-Make sure `APP_URL` is updated to the correct url as the links in emails are based off this as the base url.
+1. Set the correct URL as the `APP_URL` environment variable
+2. Restart the container
 
 </details>
 
+### Other
+
+<details>
+
+<summary>I'm getting a <code>500 | SERVER ERROR</code> error</summary>
+
+By default `APP_DEBUG` is set to `false` in production to prevent verbose error outputs. To debug the issue follow the steps below.
+
+1. Set `APP_DEBUG=true` as a environment variable
+2. Restart the container
+3. Reproduce the error by visiting the page or performing the action that caused the error
+4. View the output in the UI or in the logs to help resolve the issue, if you can not resolve it open an issue in the [GitHub](https://github.com/alexjustesen/speedtest-tracker/issues) repository
+5. Once the issue is resolved you can remove the `APP_DEBUG` environment variable
+
+</details>
+
+### User
+
+<details>
+
+<summary></summary>
+
+
+
+</details>

README.md

@@ -4,6 +4,6 @@ description: A full list of implemented features and those that are planned.
 
 # Features
 
-<figure><img src="https://github.com/alexjustesen/speedtest-tracker/blob/main/.github/screenshots/dashboard_screenshot.png?raw=true" alt=""><figcaption><p><em>Dashboard</em></p></figcaption></figure>
+<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>    Bare metal</td><td align="right">Planned</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 `successful</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"><a href="https://github.com/alexjustesen/speedtest-tracker/pull/370">Done</a></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></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

@@ -0,0 +1,24 @@
+# Installation
+
+Speedtest Tracker can be run on a variety of platforms including using [Docker and Docker Compose](installation.md) along with [Synology NAS](installation-1.md) devices and on [Unraid OS](installation-2.md).
+
+{% hint style="info" %}
+Docker Compose is the recommended platform.
+{% endhint %}
+
+### Environment Variables
+
+#### Core
+
+<table><thead><tr><th width="225">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. To find your UID run <code>id username</code> on the host machine.<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. To find your GID run <code>id username</code> on the host machine.<br><br>- Default: <code>1000</code></td></tr><tr><td><code>APP_KEY</code></td><td>Key used to encrypt and decrypt data. To create a key to persist follow the directions in the <a href="../../faqs.md#i-get-a-warning-on-container-start-up-that-the-app_key-is-missing">FAQ</a>.<br><br><em>Currently not used and generated at random on startup of the container</em>.</td></tr><tr><td><code>APP_DEBUG</code></td><td>Used to help narrow down issues in a running container, see <a href="../../faqs.md#im-getting-a-500-or-server-error-error">FAQ</a> for when to use it.<br><br>- Default: <code>false</code></td></tr><tr><td><code>DB_CONNECTION</code><br><br>(required)</td><td>Type of database to be used for storing data. Accepted values are <code>sqlite</code>, <code>mysql</code> and <code>pgsql</code>.</td></tr><tr><td><code>DB_HOST</code><br><br>(required)</td><td>FQDN or container name where the database is located.</td></tr><tr><td><code>DB_PORT</code></td><td>Port used to connect to the host where the database is located. Only needs to be defined if the database is running on a different port.<br><br>- Default: <code>3306</code> when using MySQL or MariaDB<br>- Default: <code>5432</code> when using Postgresql</td></tr><tr><td>DB_DATABASE<br><br>(required)</td><td>Name of the database.</td></tr><tr><td><code>DB_USERNAME</code><br><br>(required)</td><td>Database user used to connect to the database. Needs <code>read/write</code> access.</td></tr><tr><td><code>DB_PASSWORD</code><br><br>(required)</td><td>Password for the user specified to connect to the database.</td></tr><tr><td><code>FORCE_HTTPS</code></td><td>Enforces the user of <code>https</code> protocol when viewing the UI, port 443 must be mapped to the container for this to work.<br><br>- Default: <code>false</code></td></tr></tbody></table>
+
+#### Functional
+
+<table><thead><tr><th width="225">Name</th><th>Description</th></tr></thead><tbody><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>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_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></tbody></table>
+
+***
+
+### 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>
+

faqs.md

@@ -0,0 +1,41 @@
+---
+description: >-
+  These instructions will run you through setting up the application on a
+  Synology NAS.
+---
+
+# Using Synology
+
+{% hint style="warning" %}
+These directions are out-of-date as Synology has changed the `Docker` application to `Container Manager.`
+{% endhint %}
+
+### Install on a Synology NAS
+
+Open the Docker interface of your Synology Device, search for `ajustesen/speedtest-tracker` in the Registry and download it.
+
+![download\_image](https://user-images.githubusercontent.com/92191413/210480118-b15f83af-6617-4a0d-b631-760f419425b9.png)
+
+Create a local directory (i.e. `/volume1/docker/speedtest-tracker`) which later can be mapped to the docker container.
+
+Launch the image once the download is completed.
+
+![launch\_image](https://user-images.githubusercontent.com/92191413/210480210-baa06b52-c3b0-41a4-b50e-ce7af82d683c.png)
+
+Map the ports to available ports.
+
+![port\_mapping](https://user-images.githubusercontent.com/92191413/210481629-6fa76992-403a-415e-9967-af7b00c97d87.png)
+
+{% hint style="info" %}
+Make sure the ports you choose are not used by any other application or DSM service on your device and remember to adjust the Synology Firewall settings accordingly.
+{% endhint %}
+
+Map the directory you created earlier to the mount path `/config`.
+
+![volume\_mapping](https://user-images.githubusercontent.com/92191413/210480901-069703e3-c6ab-446c-b53b-8c5ef3c87085.png)
+
+Review your settings and click "done".
+
+![summary](https://user-images.githubusercontent.com/92191413/210480977-3e24ba39-b23e-463f-acba-0a1aad1e57ec.png)
+
+You can now access Speedtest-Tracker via `http://YOUR_IP_ADDRESS:8080` or `https://YOUR_IP_ADDRESS:8443`.

features.md

@@ -0,0 +1,11 @@
+---
+description: >-
+  These instructions will run you through setting up the application on a server
+  running Unraid OS.
+---
+
+# Using Unraid
+
+### Install on Unraid OS
+
+The unRAID community app store contains an app template managed by ZappyZap. Search "Speedtest Tracker" to install. Template support can be found [here](https://forums.unraid.net/topic/130245-support-devzwf-speedtest-tracker/).