diff --git a/getting-started/environment-variables.md b/getting-started/environment-variables.md index 31025a8..bde5b3e 100644 --- a/getting-started/environment-variables.md +++ b/getting-started/environment-variables.md @@ -8,7 +8,9 @@ description: >- ### Application -
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_KEYtrue

Key used to encrypt and decrypt data.

You can generate a key at https://speedtest-tracker.dev.

base64:ZoOYTjS+LBwFtud8SArwhiw8V4Qi9J+MPiT7z8XjfMo=
(DONT USE THIS EXAMPLE)
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.Europe/London
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
DASHBOARD_POLLINGfalseFrequency charts and stats refresh on the dashboard. Can be represented using a string in seconds orfalseto disable.

- Default:60s
NOTIFICATION_POLLINGfalseFrequency database notifications are polled. Can be represented using a string in seconds orfalseto disable.

- Default:60s
RESULTS_POLLINGfalseFrequency data refreshes in the results table. Can be represented using a string in seconds orfalseto disable.

- Default:false
+ + +
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_KEYtrue

Key used to encrypt and decrypt data.

You can generate a key at https://speedtest-tracker.dev.

base64:ZoOYTjS+LBwFtud8SArwhiw8V4Qi9J+MPiT7z8XjfMo=
(DONT USE THIS EXAMPLE)
ADMIN_NAMEtrueName of the initial admin user.
Note: Only effective during initial setup.
Admin
ADMIN_EMAILtrueEmail of the initial admin user.
Note: Only effective during initial setup.
admin@example.com
ADMIN_PASSWORDtruePassword 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.Europe/London
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
DASHBOARD_POLLINGfalseFrequency charts and stats refresh on the dashboard. Can be represented using a string in seconds orfalseto disable.

- Default:60s
NOTIFICATION_POLLINGfalseFrequency database notifications are polled. Can be represented using a string in seconds orfalseto disable.

- Default:60s
RESULTS_POLLINGfalseFrequency data refreshes in the results table. Can be represented using a string in seconds orfalseto disable.

- Default:false
### Speedtest