docker run -d --name speedtest-tracker --restart unless-stopped \\
-p 8080:80 \\
-p 8443:443 \\
-e PUID= \\
-e PGID= \\
-e APP\_KEY= \\
-e APP\_URL= \\
-e DB\_CONNECTION=sqlite \\
-v /path/to/data:/config \\
-v /path/to-custom-ssl-keys:/config/keys \\
lscr.io/linuxserver/speedtest-tracker:latest
| Name | Required | Description | Example |
|---|---|---|---|
PUID | true | Used to set the user the container should run as. | 1000 |
PGID | true | Used to set the group the container should run as. | 1000 |
APP\_KEY | true | Key used to encrypt and decrypt data. See the install docs to generate a key. | |
APP\_URL | true | URL used for links in emails and notifications. | https://speedtest.example.com |
APP\_NAME | false | Used to define the application's name in the dashboard and in notifications. | |
ADMIN\_NAME | false | Name of the initial admin user. Note: Only effective during initial setup. | Admin |
ADMIN\_EMAIL | false | Email of the initial admin user. Note: Only effective during initial setup. | admin@example.com |
ADMIN\_PASSWORD | false | Password of the initial admin user. Note: Only effective during initial setup. | password |
ASSET\_URL | false | URL used for assets, needed when using a reverse proxy. | https://speedtest.example.com |
APP\_LOCALE | false | Change the default language. | |
APP\_TIMEZONE | false | Application timezone should be set if your database does not use UTC as its default timezone. | Europe/London |
ALLOWED\_IPS | false | Block requests to the application unless from the allowed addresses. | 127.0.0.1,127.0.0.2 |
| Name | Required | Description | Example |
|---|---|---|---|
CHART\_BEGIN\_AT\_ZERO | false | Begin the dashboard axis charts at zero. - Default: true | true or false |
CHART\_DATETIME\_FORMAT | false | Set the formatting of timestamps in charts. Formatting: https://www.php.net/manual/en/datetime.format.php | j/m G:i(18/10 20:06) |
DATETIME\_FORMAT | false | Set the formatting of timestamps in tables and notifications. Formatting: https://www.php.net/manual/en/datetime.format.php | j M Y, G:i:s(18 Oct 2024, 20:06:01) |
DISPLAY\_TIMEZONE | false | Display timestamps in your local time. | America/New\_York |
CONTENT\_WIDTH | false | Width of the content section of each page. Can be set to any value found in the Filament docs. - Default: 7xl | |
PUBLIC\_DASHBOARD | false | Enables the public dashboard for guest (unauthenticated) users. - Default: false | |
DEFAULT\_CHART\_RANGE | false | Set the default time range for the dashboards - Default: 24h | Options: 24h, week or month |
| Name | Required | Description | Example |
|---|---|---|---|
SPEEDTEST\_SKIP\_IPS | false | A comma separated list of public IP addresses where tests will be skipped when present. | 127.0.0.1 or 127.0.0.0/16 |
SPEEDTEST\_SCHEDULE | false | Cron expression used to run speedtests on a scheduled basis. https://crontab.guru/ is a helpful tool. | 6 \*/2 \* \* \*(At minute 6 past every 2nd hour) |
SPEEDTEST\_SERVERS | false | Comma separated list of server IDs to randomly use for speedtest. To find servers near you visit: https://www.speedtest.net/api/js/servers | 52365 or 36998,52365 |
SPEEDTEST\_BLOCKED\_SERVERS | false | Comma separated list of server IDs that should not be used when running an Ookla Speedtest. | |
SPEEDTEST\_INTERFACE | false | Set the network interface to use for the test. This need to be the network interface available inside the container | eth0 |
SPEEDTEST\_EXTERNAL\_IP\_URL | false | URL of a service used to get the external WAN IP address. URL should contain the protocol i.e. https:// | https://icanhazip.com |
SPEEDTEST\_INTERNET\_CHECK\_HOSTNAME | false | Hostname used to ping for an active internet connection. | |
THRESHOLD\_ENABLED | false | Enable the thresholds. Note: Only effective during initial setup. | true |
THRESHOLD\_DOWNLOAD | false | Set the Download Threshold Note: Only effective during initial setup. | 900 |
THRESHOLD\_UPLOAD | false | Set the Upload Threshold Note: Only effective during initial setup. | 900 |
THRESHOLD\_PING | false | Set the Ping Threshold Note: Only effective during initial setup. | 25 |
PRUNE\_RESULTS\_OLDER\_THAN | false | Set the value to greater than zero to prune stored results. This value should be represented in days, e.g. 7 will purge all results over 7 days old. | 7 |
| Name | Required | Description | Example |
|---|---|---|---|
API\_RATE\_LIMIT | false | Number of requests per minute to the API. - Default: 60 | 100 |
API\_MAX\_RESULTS | false | Sets the maximum number of results returned by API. - Default 500 | 500 |
I get a warning on container start up that the APP\_KEY is missing
You need a \`APP\_KEY\` for the encryption. See the \[installation docs\](/getting-started/installation.md) how to generate one.
Links in emails don't point to the correct URL
1. Set the correct URL as the \`APP\_URL\` environment variable 2. Restart the containerI'm getting duplicate message via Apprise
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\](/help/error-messages.md#troubleshooting) to see the the timeout happendMy display timestamps or scheduled tests aren't correct.
Speedtest Tracker assumes your application and database containers are set to \`UTC\` by default. If your database instance has your local time zone set it needs to \*\*match\*\* that set in \`APP\_TIMEZONE\` and \`DISPLAY\_TIMEZONE\` environment variables. Once set restart the container.Scheduled tests give lower results then manual tests
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.Login page
| User | Admin | |
|---|---|---|
| View any (list) | true | true |
| View (show) | true | true |
| Create | false | false |
| Update | true | true |
| Delete any (bulk) | false | true |
| Delete | false | true |
| User | Admin | |
|---|---|---|
| View any (list) | false | true |
| View (show) | false | true |
| Create | false | true |
| Update | false | true |
| Delete any (bulk) | false | true |
| Delete | false | true |
| User | Admin | |
|---|---|---|
| Manage API tokens | false | true |
| Trigger a manual Speedtest | true | true |
| User | Admin | |
|---|---|---|
| Data integrations | false | true |
| Notifications | false | true |
| Thresholds | false | true |
Enable Debugging
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 variableI'm getting a 500 | SERVER ERROR error
The \`500 | SERVER ERROR\` is caused by either a bug or a misconfiguration. You must e\[nable debugging\](#enable-debugging) to determine the exact cause of the error.
Unsupported cipher or incorrect key length. Supported ciphers are: aes-128-cbc, aes-256-cbc, aes-128-gcm, aes-256-gcm.
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).
Failed to connected to hostname
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 likingFailed to fetch external IP address
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\*\*: \* 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. \*\*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.Configuration - Could not retrieve or read configuration (ConfigurationError)
This is usually thrown when the CLI fails to reach the internet (internet down) or the specified server.Configuration - No servers defined (NoServersException)
This usually means the defined server is no longer available. Remove it from your server list and try testing with a different server.Server Selection - Failed to find a working test server. (NoServers)
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.Unable to retrieve Ookla servers, check internet connection and see logs.
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:Failed to write to InfluxDB
When Speedtest Tracker fails to write data to InfluxDB this error is shown. The \[container logs\](#troubleshooting) will show more details on why it failed. \*\*Possible reasons:\*\* \* Connectivity problem to influxdb \* Problem with authentication \* Specified bucket does not exist in InfluxDB| Field | Type | Description |
|---|---|---|
id | primary key | |
service | string | Service user to run the speedtest. |
ping | double | As milliseconds |
download | unsigned big int | As bytes |
upload | unsigned big int | As bytes |
comments | text | User added comments. |
data | json | The raw response from the speedtest. |
benchmarks | json | Captures the speedtest's benchmarks at run time. |
healthy | boolean | Indicates if the speedtest was healthy compared to the benchmark. |
status | string |
|
scheduled | boolean | Was the result scheduled. |
created\_at | timestamp | When the record was created. |
updated\_at | timestamp | When the record was last updated. |
Mail settings
| Name | Description |
|---|---|
| on every scheduled speedtest run | On each successful scheduled speedtest a notification will be send to the application. |
| on threshold failures for scheduled speedtests | On any absolute threshold failure for scheduled speedtest a notification will be send to the application. |
Database settings
| Name | Description |
|---|---|
| on every scheduled speedtest run | On each successful scheduled speedtest a notification will be send to the application. |
| on threshold failures for scheduled speedtests | On any absolute threshold failure for scheduled speedtest a notification will be send to the application. |
Webhook settings
| Name | Description |
|---|---|
| on every scheduled speedtest run | On each successful scheduled speedtest a notification will be send to the application. |
| on threshold failures for scheduled speedtests | On any absolute threshold failure for scheduled speedtest a notification will be send to the application. |
| Command | Description |
|---|---|
about | Provides information on the current version of Speedtest Tracker, Laravel and Filament. |
| Command | Description |
|---|---|
app:ookla-list-servers | Get a list of local Ookla speedtest servers. |
app:user-change-role | Change the role for a user. |
app:user-reset-password | Change the password for a user. |
| Command | Description |
|---|---|
app:result-fix-statuses | Reviews the data payload of each result and corrects the status attribute. |
| Name | Description |
|---|---|
| on every scheduled speedtest run | On each successful scheduled speedtest a notification will be send to the application. |
| on threshold failures for scheduled speedtests | On any absolute threshold failure for scheduled speedtest a notification will be send to the application. |
| Name | |
|---|---|
app\_name | label |
isp | label |
server\_id | label |
server\_name | label |
server\_country | label |
server\_location | label |
healthy | label |
status | label |
scheduled | label |
download\_bytes | Metric |
upload\_bytes | Metric |
ping | Metric |
download\_bits | Metric |
upload\_bits | Metric |
download\_jitter | Metric |
upload\_jitter | Metric |
ping\_jitter | Metric |
download\_latency\_avg | Metric |
download\_latency\_high | Metric |
download\_latency\_low | Metric |
upload\_latency\_avg | Metric |
upload\_latency\_high | Metric |
upload\_latency\_low | Metric |
packet\_loss | Metric |
| Added compose part | Description |
|---|---|
APP\_URL | URL you want to access the WebGui on. |
ASSET\_URL | URL used for loading all the needed assets. Need to be the same as the APP\_URL. |
traefik.enable=true | Explicitly tell Traefik to expose this container |
traefik.http.routers.speedtest-tracker.rule=Host(\`speedtest.yourdomain.com\`) | The domain the service will respond to |
traefik.http.routers.speedtest-tracker.entrypoints=websecure | Allow request only from the predefined entry point |
traefik.http.routers.speedtest-tracker.tls=true | When a TLS section is specified, it instructs Traefik that the current router is dedicated to HTTPS requests only |
traefik.http.routers.speedtest-tracker.tls.certresolver=yourresolver | Explicitly tell Traefik which Certificate provider to use matching your Traefik configuration |
traefik.http.services.speedtest-tracker.loadbalancer.server.port=80 | Explicitly tell Traefik port to use to connect to the container |
| Added compose part | Description |
|---|---|
APP\_URL | URL you want to access the WebGui on. |
ASSET\_URL | URL used for loading all the needed assets. Need to be the same as the APP\_URL. |
| Name | Default | Description |
|---|---|---|
| URL | blank | FQDN or IP address to the InfluxDB2 instance |
| Org | blank | Organization on which you created your bucket in |
| Bucket | speedtest-tracker | The name of the bucket you created in your org |
| Token | blank | API token that has access to write to the org and bucket listed above |
Influxdb v2 Settings
| Name | Data Type | |
|---|---|---|
result\_id | String | Tag |
external\_ip | String | Tag |
isp | String | Tag |
service | String | Tag |
server\_id | String | Tag |
server\_name | String | Tag |
server\_country | String | Tag |
server\_location | String | Tag |
healthy | String | Tag |
status | String | Tag |
scheduled | String | Tag |
download | init | Field |
upload | init | Field |
ping | float | Field |
download\_bits | int | Field |
upload\_bits | int | Field |
download\_jitter | float | Field |
upload\_jitter | float | Field |
ping\_jitter | float | Field |
download\_latency\_avg | float | Field |
download\_latency\_high | float | Field |
download\_latency\_low | float | Field |
upload\_latency\_avg | float | Field |
upload\_latency\_high | float | Field |
upload\_latency\_low | float | Field |
packet\_loss | float | Field |