Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Installation

Speedtest Tracker can be run on a variety of platforms including using Docker and Docker Compose along with Synology NAS devices and on Unraid OS.

{% hint style="info" %} Docker Compose is the recommended platform. {% endhint %}

Environment Variables

Core

NameDescription
PUID

(required)
Used to set the user the container should run as. To find your UID run id username on the host machine.

- Default: 1000
PGID

(required)
Used to set the group the container should run as. To find your GID run id username on the host machine.

- Default: 1000
APP_KEYKey used to encrypt and decrypt data. To create a key to persist follow the directions in the FAQ.

Currently not used and generated at random on startup of the container.
APP_DEBUGUsed to help narrow down issues in a running container, see FAQ for when to use it.

- Default: false
DB_CONNECTION

(required)
Type of database to be used for storing data. Accepted values are sqlite, mysql and pgsql.
DB_HOST

(required)
FQDN or container name where the database is located.
DB_PORTPort used to connect to the host where the database is located. Only needs to be defined if the database is running on a different port.

- Default: 3306 when using MySQL or MariaDB
- Default: 5432 when using Postgresql
DB_DATABASE

(required)
Name of the database.
DB_USERNAME

(required)
Database user used to connect to the database. Needs read/write access.
DB_PASSWORD

(required)
Password for the user specified to connect to the database.
FORCE_HTTPSEnforces the user of https protocol when viewing the UI, port 443 must be mapped to the container for this to work.

- Default: false

Functional

NameDescription
CONTENT_WIDTHWidth of the content section of each page. Can be set to any value found in the Filament docs.

- Default: 7xl
DASHBOARD_POLLINGFrequency charts and stats refresh on the dashboard. Can be represented using a string in seconds or false to disable.

- Default: 60s
NOTIFICATION_POLLINGFrequency database notifications are polled. Can be represented using a string in seconds or false to disable.

- Default: 60s
RESULTS_POLLINGFrequency data refreshes in the results table. Can be represented using a string in seconds or false to disable.

- Default: false
ALLOW_EMBEDSCan be a comma separated list of URLs that the application will allow to be embedded in.

- Default: null

Port Mapping

ProtocolExternal port (default)Internal port
HTTP8080
HTTPS443443