| Features | Status |
|---|---|
| Install options | |
| Docker images for x86 | Done |
| Docker images for arm64 | Done |
| unRAID Community App | Done |
| Dashboard | |
| Show the most recent results | Done |
| Pretty graphs | Done |
| Results | |
| History of failed and successful results | Done |
Filter by scheduled and successful | Done |
| Export selected results to CSV | Done |
| Speedtest options | |
| Scheduled tests | Done |
| Adhoc test | Done |
| Manually specify a server | Done |
| Manually specify a list of servers | Done |
| Threshold alerts | Done |
| Ping options | |
| Ping a domain or list of domains | Planned |
| Database support | |
| SQLite (default) | Done |
| MariaDB / MySQL | Done |
| Postgresql | Done |
| InfluxDB v2 | Done |
| Prometheus | Planned |
| Notification Channels | |
| In-app | Done |
| Done | |
| Discord | Done |
| Gotify | Done |
| Slack | Done |
| Telegram | Done |
| Webhooks | Done |
| Ntfy | Done |
| Pushover | Done |
| HealthCheck.io | Done |
| Application Monitoring | |
| https://ohdear.app/ | Planned |
| https://thenping.me/ | Planned |
| https://healthchecks.io/ | Planned |
| Features | Status |
|---|---|
| Install options | |
| Docker images for x86 | Done |
| Docker images for arm64 | Done |
| unRAID Community App | Done |
| Dashboard | |
| Show the most recent results | Done |
| Pretty graphs | Done |
| Results | |
| History of failed and successful results | Done |
Filter by scheduled and successful | Done |
| Export selected results to CSV | Done |
| Speedtest options | |
| Scheduled tests | Done |
| Adhoc test | Done |
| Manually specify a server | Done |
| Manually specify a list of servers | Done |
| Threshold alerts | Done |
| Ping options | |
| Ping a domain or list of domains | Planned |
| Database support | |
| SQLite (default) | Done |
| MariaDB / MySQL | Done |
| Postgresql | Done |
| InfluxDB v2 | Done |
| Prometheus | Done |
| Notification Channels | |
| In-app | Done |
| Done | |
| Webhooks | Done |
| Apprise | Done |
| Application Monitoring | |
| https://ohdear.app/ | Planned |
| https://thenping.me/ | Planned |
| https://healthchecks.io/ | Planned |
| 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_NAME | false | Used to define the application's name in the dashboard and in notifications. | |
APP_KEY | true | Key used to encrypt and decrypt data. You can generate a key at https://speedtest-tracker.dev. | |
ADMIN_NAME | true | Name of the initial admin user. Note: Only effective during initial setup. | Admin |
ADMIN_EMAIL | true | Email of the initial admin user. Note: Only effective during initial setup. | admin@example.com |
ADMIN_PASSWORD | true | Password of the initial admin user. Note: Only effective during initial setup. | password |
APP_URL | false | URL used for links in emails and notifications. | https://speedtest.example.com |
ASSET_URL | false | URL used for assets, needed when using a reverse proxy. | https://speedtest.example.com |
APP_TIMEZONE | false | Application timezone should be set if your database does not use UTC as its default timezone. | Europe/London |
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 | |
DASHBOARD_POLLING | false | Frequency charts and stats refresh on the dashboard. Can be represented using a string in seconds orfalseto disable.- Default: 60s | |
NOTIFICATION_POLLING | false | Frequency database notifications are polled. Can be represented using a string in seconds orfalseto disable.- Default: 60s | |
RESULTS_POLLING | false | Frequency data refreshes in the results table. Can be represented using a string in seconds orfalseto disable.- Default: false |
| 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 |
|---|---|---|---|
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://c.speedtest.net/speedtest-servers-static.php | 52365 or 36998,52365 |
SPEEDTEST_BLOCKED_SERVERS | false | Comma separated list of server IDs that should not be used when running speedtests. | |
PRUNE_RESULTS_OLDER_THAN | false | Set the value to greated 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 |
|---|---|---|---|
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://c.speedtest.net/speedtest-servers-static.php | 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. | |
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 |
docker run -d --name speedtest-tracker --restart unless-stopped \
-p 8080:80 \
-p 8443:443 \
- -e PUID=1000 \
- -e PGID=1000 \
- -e APP_KEY= \
+ -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
-```
+500 | SERVER ERROR erroraes-128-cbc, aes-256-cbc, aes-128-gcm, aes-256-gcm.APP_KEY is missing500 | SERVER ERROR error| Command | Description |
|---|---|
app:install | Installs a fresh version of Speedtest Tracker. If you have an existing install this will delete all data. |
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. |
app:version | Sends a notification to the admin users when Speedtest Tracker is outdated. |
| 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. |
| 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. |
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. |
| 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. |
| User | Admin | |
|---|---|---|
| View any (list) | true | true |
| View (show) | true | true |
| Create | true | true |
| Update | true | true |
| Delete any (bulk) | false | true |
| Delete | false | true |
| 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 | |
|---|---|---|
| Trigger a manual Speedtest | true | true |
| User | Admin | |
|---|---|---|
| Manage API tokens | false | true |
| Trigger a manual Speedtest | true | true |
| 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 |
| 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 | Description |
|---|---|
| On completed speedtest | On each successful speedtest a notification will be send to the application. |
| On absolute threshold failure | On any absolute threshold failure a notification will be send to the application. |
| 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 | Description |
|---|---|
| On completed speedtest | On each successful speedtest a notification will be send to the application. |
| On absolute threshold failure | On any absolute threshold failure a notification will be send to the application. |
| 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. |
Telegram settings
| Name | Description |
|---|---|
| On completed speedtest | On each successful speedtest a notification will be send to the application. |
| On absolute threshold failure | On any absolute threshold failure 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. |