diff --git a/getting-started/environment-variables.md b/getting-started/environment-variables.md index e2f36f6..c90fee8 100644 --- a/getting-started/environment-variables.md +++ b/getting-started/environment-variables.md @@ -10,15 +10,11 @@ description: >-
NameRequiredDescriptionExample
PUIDtrueUsed to set the user the container should run as.1000
PGIDtrueUsed to set the group the container should run as.1000
APP_NAMEfalseUsed to define the application's name in the dashboard and in notifications.
APP_KEYtrueKey used to encrypt and decrypt data. See the install docs to generate a key.
ADMIN_NAMEfalseName of the initial admin user.
Note: Only effective during initial setup.
Admin
ADMIN_EMAILfalseEmail of the initial admin user.
Note: Only effective during initial setup.
admin@example.com
ADMIN_PASSWORDfalsePassword of the initial admin user.
Note: Only effective during initial setup.
password
APP_URLfalseURL used for links in emails and notifications.https://speedtest.example.com
ASSET_URLfalseURL used for assets, needed when using a reverse proxy.https://speedtest.example.com
APP_TIMEZONEfalseApplication timezone should be set if your database does not use UTC as its default timezone.Europe/London
CHART_BEGIN_AT_ZEROfalseBegin the dashboard axis charts at zero.

- Default: true
true or false
CHART_DATETIME_FORMATfalseSet 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_FORMATfalseSet 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_TIMEZONEfalseDisplay timestamps in your local time.America/New_York
CONTENT_WIDTHfalseWidth of the content section of each page. Can be set to any value found in the Filament docs.

- Default:7xl
PUBLIC_DASHBOARDfalseEnables the public dashboard for guest (unauthenticated) users.

- Default:false
- - *** ### Speedtest -
NameRequiredDescriptionExample
SPEEDTEST_SKIP_IPSfalseA 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_SCHEDULEfalseCron 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_SERVERSfalse

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_SERVERSfalseComma separated list of server IDs that should not be used when running speedtests.
SPEEDTEST_INTERFACEfalseSet the network interface to use for the test. This need to be the network interface available inside the containereth0
THRESHOLD_ENABLEDfalseEnable the thresholds. Note: Only effective during initial setup.true
THRESHOLD_DOWNLOADfalse

Set the Download Threshold

Note: Only effective during initial setup.

900
THRESHOLD_UPLOADfalse

Set the Upload Threshold

Note: Only effective during initial setup.

900
THRESHOLD_PINGfalse

Set the Ping Threshold

Note: Only effective during initial setup.

25
PRUNE_RESULTS_OLDER_THANfalseSet 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
- - +
NameRequiredDescriptionExample
SPEEDTEST_SKIP_IPSfalseA 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_SCHEDULEfalseCron 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_SERVERSfalse

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_SERVERSfalseComma separated list of server IDs that should not be used when running speedtests.
SPEEDTEST_INTERFACEfalseSet the network interface to use for the test. This need to be the network interface available inside the containereth0
SPEEDTEST_CHECKINTERNET_URLfalseSet the URL used for checking of an active internet connection. We check only for an HTTP 200 response ocde.
THRESHOLD_ENABLEDfalseEnable the thresholds. Note: Only effective during initial setup.true
THRESHOLD_DOWNLOADfalse

Set the Download Threshold

Note: Only effective during initial setup.

900
THRESHOLD_UPLOADfalse

Set the Upload Threshold

Note: Only effective during initial setup.

900
THRESHOLD_PINGfalse

Set the Ping Threshold

Note: Only effective during initial setup.

25
PRUNE_RESULTS_OLDER_THANfalseSet 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
***