You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: getting-started/installation/README.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,10 @@
2
2
3
3
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).
4
4
5
+
{% hint style="danger" %}
6
+
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.
7
+
{% endhint %}
8
+
5
9
Use the install guides listed below to install Speedtest Tracker:
Copy file name to clipboardExpand all lines: help/error-messages.md
+128-5Lines changed: 128 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,84 @@
1
1
# Error Messages
2
2
3
-
### Speedtest errors
3
+
### Troubleshooting
4
+
5
+
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;
6
+
7
+
`docker logs speedtest-tracker` 
8
+
9
+
or any other equivalent command for your setup. 
10
+
11
+
<details>
12
+
13
+
<summary>Enable Debugging</summary>
14
+
15
+
By default `APP_DEBUG` is set to `false` in production to prevent verbose error outputs. To debug the issue follow the steps below.
16
+
17
+
1. Set `APP_DEBUG=true` as a environment variable
18
+
2. Restart the container
19
+
3. Reproduce the error by visiting the page or performing the action that caused the error
20
+
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
21
+
5. In the output the line that starts with `[timestamp] production.ERROR:` is the error the server ran into
22
+
6. Once the issue is resolved you can remove the `APP_DEBUG` environment variable
23
+
24
+
</details>
25
+
26
+
### Application
27
+
28
+
<details>
29
+
30
+
<summary>I'm getting a <code>500 | SERVER ERROR</code> error</summary>
31
+
32
+
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.
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).
41
+
42
+
</details>
43
+
44
+
### Speedtest Process
45
+
46
+
<details>
47
+
48
+
<summary>Failed to connected to hostname</summary>
49
+
50
+
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
51
+
52
+
**Possible reasons**:
53
+
54
+
* There is a docker network problem or no internet connection.
55
+
* 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.
56
+
*_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.
57
+
58
+
**Configuration options**
59
+
60
+
* Use available [Environment Variables](../getting-started/environment-variables.md#speed-tests) to change the endpoint to your liking
61
+
62
+
</details>
4
63
5
64
<details>
6
65
7
-
<summary>Tests are saying there is no internet while there is.</summary>
66
+
<summary>Failed to fetch external IP address</summary>
67
+
68
+
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.
69
+
70
+
**Possible reasons**:
8
71
9
-
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.
72
+
* There is a docker network problem or no internet connection.
73
+
* 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.
10
74
11
-
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.
75
+
**Configuration options**
76
+
77
+
* 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.
12
78
13
79
</details>
14
80
15
-
### Ookla errors
81
+
### Ookla Related
16
82
17
83
<details>
18
84
@@ -37,3 +103,60 @@ This usually means the defined server is no longer available. Remove it from you
37
103
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.
38
104
39
105
</details>
106
+
107
+
<details>
108
+
109
+
<summary>Unable to retrieve Ookla servers, check internet connection and see logs.</summary>
110
+
111
+
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). 
112
+
113
+
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. 
114
+
115
+
</details>
116
+
117
+
### InfluxDB
118
+
119
+
<details>
120
+
121
+
<summary>Failed to bulk write to InfluxDB</summary>
122
+
123
+
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. 
124
+
125
+
**Possible reasons:**
126
+
127
+
* Connectivity problem to InfluxDB
128
+
* Problem with authentication
129
+
* Specified bucket does not exist in InfluxDB
130
+
131
+
</details>
132
+
133
+
<details>
134
+
135
+
<summary>Failed to write test data to InfluxDB.</summary>
136
+
137
+
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. 
138
+
139
+
**Possible reasons:**
140
+
141
+
* Connectivity problem to influxdb
142
+
* Problem with authentication
143
+
* Specified bucket does not exist in InfluxDB
144
+
145
+
</details>
146
+
147
+
<details>
148
+
149
+
<summary>Failed to write to InfluxDB.</summary>
150
+
151
+
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. 
Copy file name to clipboardExpand all lines: help/faqs.md
+8-17Lines changed: 8 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,6 +25,14 @@ You need a `APP_KEY` for the encryption. See the [installation docs](../getting-
25
25
26
26
</details>
27
27
28
+
<details>
29
+
30
+
<summary>I'm getting duplicate message via Apprise</summary>
31
+
32
+
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
33
+
34
+
</details>
35
+
28
36
### Time zones
29
37
30
38
<details>
@@ -55,20 +63,3 @@ Once set restart the container.
55
63
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.
56
64
57
65
</details>
58
-
59
-
### Other
60
-
61
-
<details>
62
-
63
-
<summary>I'm getting a <code>500 | SERVER ERROR</code> error</summary>
64
-
65
-
By default `APP_DEBUG` is set to `false` in production to prevent verbose error outputs. To debug the issue follow the steps below.
66
-
67
-
1. Set `APP_DEBUG=true` as a environment variable
68
-
2. Restart the container
69
-
3. Reproduce the error by visiting the page or performing the action that caused the error
70
-
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
71
-
5. In the output the line that starts with `[timestamp] production.ERROR:` is the error the server ran into
72
-
6. Once the issue is resolved you can remove the `APP_DEBUG` environment variable
Copy file name to clipboardExpand all lines: settings/notifications/apprise.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,25 +8,25 @@ Apprise allows the application to sent notifications to a wide variety of servic
8
8
9
9
### Apprise Server
10
10
11
-
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.
12
-
13
11
{% hint style="info" %}
14
-
We don't offer support on setting up Apprise, incase of any problems with the Apprise Container please reach out to the Apprise team. 
12
+
We don't offer support on setting up Apprise, incase of any problems with the Apprise Container please reach out to the Apprise team.
15
13
{% endhint %}
16
14
15
+
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.
16
+
17
17
### Notification Channels
18
18
19
-
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. 
19
+
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.
20
20
21
21
### Tips and Tricks
22
22
23
23
#### Format
24
24
25
-
By default the format used for message is `markdown`This allows us to do some formatting on the message like bold text etc.
25
+
By default the format used for message is `markdown` This allows us to do some formatting on the message like bold text etc.
26
26
27
27
#### Preview Images
28
28
29
-
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. 
29
+
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.
0 commit comments