23 lines (14 loc) · 6.32 KB

description
A complete inventory of all environment variables for configuring Speedtest Tracker.

Environment Variables

Application

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. See the install docs to generate a key.
`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`
`ALLOWED_IPS`	false	Block requests to the application unless from the allowed addresses.	`127.0.0.1,127.0.0.2`
`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`

Speedtest

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.
`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_CHECKINTERNET_URL`	false	Set the URL used for checking of an active internet connection. We check only for an `HTTP 200` response ocde.
`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`

API

Name	Required	Description	Example
`API_RATE_LIMIT`	false	Number of requests per minute to the API. - Default: `60`	`100`