docker run -d \
--name=speedtest-tracker \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Etc/UTC \
-e APP_KEY= \
- -e DB_CONNECTION=sqlite \
- -e SPEEDTEST_SCHEDULE= \
- -e SPEEDTEST_SERVERS= \
- -e DB_HOST= `#optional` \
- -e DB_PORT= `#optional` \
- -e DB_DATABASE= `#optional` \
- -e DB_USERNAME= `#optional` \
- -e DB_PASSWORD= `#optional` \
- -e DISPLAY_TIMEZONE=Etc/UTC `#optional` \
- -e PRUNE_RESULTS_OLDER_THAN=0 `#optional` \
- -p 80:80 \
- -v /path/to/speedtest-tracker/data:/config \
- --restart unless-stopped \
- lscr.io/linuxserver/speedtest-tracker:latest
-Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.
-p)¶| Parameter | Function |
|---|---|
80 | Web UI |
-e)¶| Env | Function |
|---|---|
PUID=1000 | for UserID - see below for explanation |
PGID=1000 | for GroupID - see below for explanation |
TZ=Etc/UTC | specify a timezone to use, see this list. |
APP_KEY= | App key used for encrypting stored data. You can generate a key at https://speedtest-tracker.dev |
DB_CONNECTION=sqlite | Set the database type to use. sqlite, pgsql, or mysql |
SPEEDTEST_SCHEDULE= | Set the test schedule in cron format. e.g. 0 */6 * * * |
SPEEDTEST_SERVERS= | A comma-separated list of server IDs to test against. Run docker run -it --rm --entrypoint /bin/bash lscr.io/linuxserver/speedtest-tracker:latest list-servers to get a list of nearby servers. |
DB_HOST= | Database hostname (postgres/mysql). |
DB_PORT= | Database port (postgres/mysql). |
DB_DATABASE= | Database name (postgres/mysql). |
DB_USERNAME= | Database username (postgres/mysql). |
DB_PASSWORD= | Database password (postgres/mysql). |
DISPLAY_TIMEZONE=Etc/UTC | Timezone for the UI. |
PRUNE_RESULTS_OLDER_THAN=0 | Days to keep test results. |
-v)¶| Volume | Function |
|---|---|
/config | Contains speedtest-tracker config and database, if using sqlite. |
| Parameter | Function |
|---|---|
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
-e FILE__MYVAR=/run/secrets/mysecretvariable
+ -e APP_URL= \
+ -e DB_CONNECTION=sqlite \
+ -e SPEEDTEST_SCHEDULE= \
+ -e SPEEDTEST_SERVERS= \
+ -e DB_HOST= `#optional` \
+ -e DB_PORT= `#optional` \
+ -e DB_DATABASE= `#optional` \
+ -e DB_USERNAME= `#optional` \
+ -e DB_PASSWORD= `#optional` \
+ -e DISPLAY_TIMEZONE=Etc/UTC `#optional` \
+ -e PRUNE_RESULTS_OLDER_THAN=0 `#optional` \
+ -p 80:80 \
+ -v /path/to/speedtest-tracker/data:/config \
+ --restart unless-stopped \
+ lscr.io/linuxserver/speedtest-tracker:latest
+Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.
-p)¶| Parameter | Function |
|---|---|
80 | Web UI |
-e)¶| Env | Function |
|---|---|
PUID=1000 | for UserID - see below for explanation |
PGID=1000 | for GroupID - see below for explanation |
TZ=Etc/UTC | specify a timezone to use, see this list. |
APP_KEY= | App key used for encrypting stored data. You can generate a key at https://speedtest-tracker.dev |
APP_URL= | The IP:port or URL your application will be accessed on (ie. http://192.168.1.1:6875 or https://bookstack.mydomain.com |
DB_CONNECTION=sqlite | Set the database type to use. sqlite, pgsql, or mysql |
SPEEDTEST_SCHEDULE= | Set the test schedule in cron format. e.g. 0 */6 * * * |
SPEEDTEST_SERVERS= | A comma-separated list of server IDs to test against. Run docker run -it --rm --entrypoint /bin/bash lscr.io/linuxserver/speedtest-tracker:latest list-servers to get a list of nearby servers. |
DB_HOST= | Database hostname (postgres/mysql). |
DB_PORT= | Database port (postgres/mysql). |
DB_DATABASE= | Database name (postgres/mysql). |
DB_USERNAME= | Database username (postgres/mysql). |
DB_PASSWORD= | Database password (postgres/mysql). |
DISPLAY_TIMEZONE=Etc/UTC | Timezone for the UI. |
PRUNE_RESULTS_OLDER_THAN=0 | Days to keep test results. |
-v)¶| Volume | Function |
|---|---|
/config | Contains speedtest-tracker config and database, if using sqlite. |
| Parameter | Function |
|---|---|
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable file.
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.
When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance PUID=1000 and PGID=1000, to find yours use id your_user as below:
Example output:
We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
Shell access whilst the container is running:
docker exec -it speedtest-tracker /bin/bash
@@ -66,4 +68,4 @@
--pull \
-t lscr.io/linuxserver/speedtest-tracker:latest .
The ARM variants can be built on x86_64 hardware and vice versa using lscr.io/linuxserver/qemu-static
Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.