diff --git a/getting-started/installation/README.md b/getting-started/installation/README.md index d54bcb5..21bf6b6 100644 --- a/getting-started/installation/README.md +++ b/getting-started/installation/README.md @@ -6,18 +6,6 @@ Speedtest Tracker can be run on a variety of platforms including using [Docker a 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
diff --git a/getting-started/installation/installation.md b/getting-started/installation/installation.md index 9a5504d..e12eb55 100644 --- a/getting-started/installation/installation.md +++ b/getting-started/installation/installation.md @@ -12,6 +12,11 @@ Setting up your environment with Docker Compose is the recommended infrastructur If you would like to provide your own SSL keys, they must be named `cert.crt` (full chain) and `cert.key` (private key), and mounted in the container folder `/config/keys`. +{% hint style="info" %} +Complete overview of the Environment Variables can be found here +[environment-variables.md](environment-variables.md "mention"). +{% endhint %} + {% tabs %} {% tab title="SQLite" %} ```yaml @@ -29,6 +34,10 @@ services: - DB_CONNECTION=sqlite - SPEEDTEST_SCHEDULE= - SPEEDTEST_SERVERS= + - PRUNE_RESULTS_OLDER_THAN= + - CHART_DATETIME_FORMAT= + - DATETIME_FORMAT= + - APP_TIMEZONE= volumes: - /path/to/data:/config - /path/to-custom-ssl-keys:/config/keys @@ -58,6 +67,10 @@ services: - DB_PASSWORD=password - SPEEDTEST_SCHEDULE= - SPEEDTEST_SERVERS= + - PRUNE_RESULTS_OLDER_THAN= + - CHART_DATETIME_FORMAT= + - DATETIME_FORMAT= + - APP_TIMEZONE= volumes: - /path/to/data:/config - /path/to-custom-ssl-keys:/config/keys @@ -101,6 +114,10 @@ services: - DB_PASSWORD=password - SPEEDTEST_SCHEDULE= - SPEEDTEST_SERVERS= + - PRUNE_RESULTS_OLDER_THAN= + - CHART_DATETIME_FORMAT= + - DATETIME_FORMAT= + - APP_TIMEZONE= volumes: - /path/to/data:/config - /path/to-custom-ssl-keys:/config/keys @@ -143,6 +160,10 @@ docker run -d --name speedtest-tracker --restart unless-stopped \ -e DB_CONNECTION=sqlite \ -e SPEEDTEST_SCHEDULE= \ -e SPEEDTEST_SERVERS= \ + -e PRUNE_RESULTS_OLDER_THAN= \ + -e CHART_DATETIME_FORMAT= \ + -e DATETIME_FORMAT= \ + -e APP_TIMEZONE= \ -v /path/to/data:/config \ -v /path/to-custom-ssl-keys:/config/keys \ lscr.io/linuxserver/speedtest-tracker:latest @@ -187,6 +208,10 @@ docker run -d --name speedtest-tracker --restart unless-stopped \ -e DB_PASSWORD= \ -e SPEEDTEST_SCHEDULE= \ -e SPEEDTEST_SERVERS= \ + -e PRUNE_RESULTS_OLDER_THAN= \ + -e CHART_DATETIME_FORMAT= \ + -e DATETIME_FORMAT= \ + -e APP_TIMEZONE= \ -v /path/to/data:/config \ -v /path/to-custom-ssl-keys:/config/keys \ lscr.io/linuxserver/speedtest-tracker:latest diff --git a/getting-started/installation/qnap.md b/getting-started/installation/qnap.md index 5526c4d..106f2aa 100644 --- a/getting-started/installation/qnap.md +++ b/getting-started/installation/qnap.md @@ -35,6 +35,10 @@ services: - DB_PASSWORD=password - SPEEDTEST_SCHEDULE= - SPEEDTEST_SERVERS= + - PRUNE_RESULTS_OLDER_THAN= + - CHART_DATETIME_FORMAT= + - DATETIME_FORMAT= + - APP_TIMEZONE= volumes: - /path/to-data:/config - /path/to-custom-ssl-keys:/config/keys