chore: update error messages and support guides

features.md

@@ -4,4 +4,4 @@ description: A full list of implemented features and those that are planned.
 
 # Features
 
-<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>
+<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">Done</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">Done</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">Done</td></tr><tr><td>Manually specify a list of servers</td><td align="right">Done</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">Done</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">Done</td></tr><tr><td>Mail</td><td align="right">Done</td></tr><tr><td>Webhooks</td><td align="right">Done</td></tr><tr><td>Apprise</td><td align="right">Done</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/installation/README.md

@@ -2,6 +2,10 @@
 
 Speedtest Tracker is containerized so you can run it anywhere you run your containers. The image is built by LinuxServer.io, build information can be found [here](https://fleet.linuxserver.io/image?name=linuxserver/speedtest-tracker).
 
+{% hint style="danger" %}
+Only the installation methods listed below are supported. Any other installation methods, such as bare metal setups or Proxmox LXCs, are **not supported** by this project.
+{% endhint %}
+
 Use the install guides listed below to install Speedtest Tracker:
 
 ### Docker

help/error-messages.md

@@ -1,18 +1,84 @@
 # Error Messages
 
-### Speedtest errors
+### Troubleshooting
+
+For all below errors there will be more information provided in the container logs. You can check the logs for more details by checking the container logs by running;
+
+`docker logs speedtest-tracker` 
+
+or any other equivalent command for your setup. 
+
+<details>
+
+<summary>Enable Debugging</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. In the output the line that starts with `[timestamp] production.ERROR:` is the error the server ran into
+6. Once the issue is resolved you can remove the `APP_DEBUG` environment variable
+
+</details>
+
+### Application
+
+<details>
+
+<summary>I'm getting a <code>500 | SERVER ERROR</code> error</summary>
+
+The `500 | SERVER ERROR` is caused by either a bug or a misconfiguration. You must e[nable debugging](error-messages.md#enable-debugging) to determine the exact cause of the error.
+
+</details>
+
+<details>
+
+<summary>Unsupported cipher or incorrect key length. Supported ciphers are: <code>aes-128-cbc</code>, <code>aes-256-cbc</code>, <code>aes-128-gcm,</code> <code>aes-256-gcm</code>.</summary>
+
+This error is shown when the `APP_KEY` is not set or not set correctly. Make suer you set the `APP_KEY`  as described in the [installation steps](../getting-started/installation/using-docker-compose.md#install-with-docker-compose).
+
+</details>
+
+### Speedtest Process
+
+<details>
+
+<summary>Failed to connected to hostname</summary>
+
+When a speedtest is being [processed](../other/speedtest-process.md) Speedtest Tracker will make a ICMP ping to [icanhazip.com](http://icanhazip.com) to check if there is an internet connection before starting the Speedtest
+
+**Possible reasons**:
+
+* There is a docker network problem or no internet connection.
+* Some DNS blocks lists will block this domain, if you're getting errors and your server has access to the internet you'll need to add this to your allow lists.
+* _Most_ Docker setups can send ICMP requests without needed elevated privileges on the host or in the container. That being said if your Docker user doesn't run with elevated permissions or doesn't belong to the Docker group you can get a failure on this step. To allow the user to send ICMP requests you need to add the permission to the container.
+
+**Configuration options**
+
+* Use available [Environment Variables](../getting-started/environment-variables.md#speed-tests) to change the endpoint to your liking
+
+</details>
 
 <details>
 
-<summary>Tests are saying there is no internet while there is.</summary>
+<summary>Failed to fetch external IP address</summary>
+
+When the `SPEEDTEST_SKIP_IPS` environment variable is  Speedtest Tracker will make a call to [http://icanhazip.com](http://icanhazip.com/) to get your external IP address. This is done check if your external IP address (WAN IP) should be skipped.
+
+**Possible reasons**:
 
-When a speedtest is being processed Speedtest Tracker will make a call to [http://icanhazip.com](http://icanhazip.com) to get your external IP address. This is done to determine if your server has access to the internet and to check if your external IP address (WAN IP) should be skipped.
+* There is a docker network problem or no internet connection.
+* Some DNS blocks lists will block this domain, if you're getting errors and your server has access to the internet you'll need to add this to your allow lists.
 
-Some DNS blocks lists will block this domain, if you're getting errors and your server has access to the internet you'll need to add this to your allow lists.
+**Configuration options**
+
+* Use available [Environment Variables](../getting-started/environment-variables.md#speed-tests) to change the endpoint to your liking. :warning: Whatever service you choose needs to only return an IP address in the body of the response for this to work.
 
 </details>
 
-### Ookla errors
+### Ookla Related
 
 <details>
 
@@ -37,3 +103,60 @@ This usually means the defined server is no longer available. Remove it from you
 Not 100% sure what causes this exception yet but it's likely when the CLI can't locate a local server. You should specify a list of servers to see if that addresses the issue.
 
 </details>
+
+<details>
+
+<summary>Unable to retrieve Ookla servers, check internet connection and see logs.</summary>
+
+This errors is shown when we try to retrieve the Ookla server list when selecting an server wehn running an manual speedtest. We get the list from: [https://www.speedtest.net/api/js/servers](https://www.speedtest.net/api/js/servers).&#x20;
+
+This error is useually caused by a docker network problem or no internet connection. You can check the [container logs](error-messages.md#troubleshooting) for more details.&#x20;
+
+</details>
+
+### InfluxDB
+
+<details>
+
+<summary>Failed to bulk write to InfluxDB</summary>
+
+When Speedtest Tracker fails to write data to InfluxDB this error is shown. The [container logs](error-messages.md#troubleshooting) will show more details on why it failed.&#x20;
+
+**Possible reasons:**
+
+* Connectivity problem to InfluxDB
+* Problem with authentication
+* Specified bucket does not exist in InfluxDB
+
+</details>
+
+<details>
+
+<summary>Failed to write test data to InfluxDB.</summary>
+
+When Speedtest Tracker fails to write data to InfluxDB this error is shown. The [container logs](error-messages.md#troubleshooting) will show more details on why it failed.&#x20;
+
+**Possible reasons:**
+
+* Connectivity problem to influxdb
+* Problem with authentication
+* Specified bucket does not exist in InfluxDB
+
+</details>
+
+<details>
+
+<summary>Failed to write to InfluxDB.</summary>
+
+When Speedtest Tracker fails to write data to InfluxDB this error is shown. The [container logs](error-messages.md#troubleshooting) will show more details on why it failed.&#x20;
+
+**Possible reasons:**
+
+* Connectivity problem to influxdb
+* Problem with authentication
+* Specified bucket does not exist in InfluxDB
+
+</details>
+
+
+

help/faqs.md

@@ -25,6 +25,14 @@ You need a `APP_KEY` for the encryption. See the [installation docs](../getting-
 
 </details>
 
+<details>
+
+<summary>I'm getting duplicate message via Apprise</summary>
+
+By default when sending an notifications via Apprise we wait up to 30 seconds for Apprise to respond back with any message. Incase this 30 seconds is exceeded, we will retry 3 times. In case of any very slow Apprise processing this might cause duplicated notifications. Please check the [logs](error-messages.md#troubleshooting) to see the the timeout happend
+
+</details>
+
 ### Time zones
 
 <details>
@@ -55,20 +63,3 @@ Once set restart the container.
 Starting your cron schedule at an off-peak minute can help reduce network congestion or avoid overloading a speed test server. This [comment](https://github.com/alexjustesen/speedtest-tracker/issues/552#issuecomment-2028532010) on this issue can help you get the formatting right.
 
 </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. In the output the line that starts with `[timestamp] production.ERROR:` is the error the server ran into
-6. Once the issue is resolved you can remove the `APP_DEBUG` environment variable
-
-</details>

settings/notifications/apprise.md

@@ -8,25 +8,25 @@ Apprise allows the application to sent notifications to a wide variety of servic
 
 ### Apprise Server
 
-To use Apprise, you’ll need to set up your own Apprise instance. This container isn’t created automatically, so make sure to include it in your deployment. See the Apprise [Github Repo](https://github.com/caronc/apprise-api) for the setup instructions. On the notification page you will need to define the location of your Apprise instance. Make sure this instance is reachable for the Speedtest Tracker.
-
 {% hint style="info" %}
-We don't offer support on setting up Apprise, incase of any problems with the Apprise Container please reach out to the Apprise team. 
+We don't offer support on setting up Apprise, incase of any problems with the Apprise Container please reach out to the Apprise team.
 {% endhint %}
 
+To use Apprise, you’ll need to set up your own Apprise instance. This container isn’t created automatically, so make sure to include it in your deployment. See the Apprise [Github Repo](https://github.com/caronc/apprise-api) for the setup instructions. On the notification page you will need to define the location of your Apprise instance. Make sure this instance is reachable for the Speedtest Tracker.
+
 ### Notification Channels
 
-Notification channels are the formatted URLs used by Apprise to send notifications to various services. Refer to the [Apprise documentation](https://github.com/caronc/apprise?tab=readme-ov-file#supported-notifications) for a full list of supported channels and their required formats. You can add as many different channels as you wish. The notifications will be sent to all of them. 
+Notification channels are the formatted URLs used by Apprise to send notifications to various services. Refer to the [Apprise documentation](https://github.com/caronc/apprise?tab=readme-ov-file#supported-notifications) for a full list of supported channels and their required formats. You can add as many different channels as you wish. The notifications will be sent to all of them.
 
 ### Tips and Tricks
 
 #### Format
 
-By default the format used for message is `markdown`  This allows us to do some formatting on the message like bold text etc.
+By default the format used for message is `markdown` This allows us to do some formatting on the message like bold text etc.
 
 #### Preview Images
 
-By default Apprise does not allow preview images for URLs. This is an default setting on the Apprise instance. Depending on the service used you can override this settings in the notification channel URL. Check the Apprise documentation to see if your service support this and how to set it. 
+By default Apprise does not allow preview images for URLs. This is an default setting on the Apprise instance. Depending on the service used you can override this settings in the notification channel URL. Check the Apprise documentation to see if your service support this and how to set it.
 
 ### Triggers