Add new vars to readme

linuxserver · Jun 7, 2024 · 769db0a · 769db0a
1 parent e22556d
commit 769db0a
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -79,11 +79,15 @@ services:
       - TZ=Etc/UTC
       - APP_KEY=
       - DB_CONNECTION=sqlite
+      - SPEEDTEST_SCHEDULE=
+      - SPEEDTEST_SERVERS=
       - DB_HOST= #optional
       - DB_PORT= #optional
       - DB_DATABASE= #optional
       - DB_USERNAME= #optional
       - DB_PASSWORD= #optional
+      - DISPLAY_TIMEZONE=Etc/UTC #optional
+      - PRUNE_RESULTS_OLDER_THAN=0 #optional
     volumes:
       - /path/to/data:/config
     ports:
@@ -101,11 +105,15 @@ docker run -d \
   -e TZ=Etc/UTC \
   -e APP_KEY= \
   -e DB_CONNECTION=sqlite \
+  -e SPEEDTEST_SCHEDULE= \
+  -e SPEEDTEST_SERVERS= \
   -e DB_HOST= `#optional` \
   -e DB_PORT= `#optional` \
   -e DB_DATABASE= `#optional` \
   -e DB_USERNAME= `#optional` \
   -e DB_PASSWORD= `#optional` \
+  -e DISPLAY_TIMEZONE=Etc/UTC `#optional` \
+  -e PRUNE_RESULTS_OLDER_THAN=0 `#optional` \
   -p 80:80 \
   -v /path/to/data:/config \
   --restart unless-stopped \
@@ -124,11 +132,15 @@ Containers are configured using parameters passed at runtime (such as those abov
 | `-e TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
 | `-e APP_KEY=` | App key used for encrypting stored data. You can generate a key at [https://speedtest-tracker.dev](https://speedtest-tracker.dev) |
 | `-e DB_CONNECTION=sqlite` | Set the database type to use. `sqlite`, `pgsql`, or `mysql` |
+| `-e SPEEDTEST_SCHEDULE=` | Set the test schedule in cron format. e.g. `0 */6 * * *` |
+| `-e SPEEDTEST_SERVERS=` | A comma-separated list of server IDs to test against. Run `docker exec speedtest-tracker php /app/www/artisan app:ookla-list-servers` to get a list of nearby servers. |
 | `-e DB_HOST=` | Database hostname (postgres/mysql). |
 | `-e DB_PORT=` | Database port (postgres/mysql). |
 | `-e DB_DATABASE=` | Database name (postgres/mysql). |
 | `-e DB_USERNAME=` | Database username (postgres/mysql). |
 | `-e DB_PASSWORD=` | Database password (postgres/mysql). |
+| `-e DISPLAY_TIMEZONE=Etc/UTC` | Timezone for the UI. |
+| `-e PRUNE_RESULTS_OLDER_THAN=0` | Days to keep test results. |
 | `-v /config` | Contains speedtest-tracker config and database, if using sqlite. |
 
 ## Environment variables from files (Docker secrets)

diff --git a/readme-vars.yml b/readme-vars.yml
@@ -22,6 +22,8 @@ param_usage_include_env: true
 param_env_vars:
   - { env_var: "APP_KEY", env_value: "", desc: "App key used for encrypting stored data. You can generate a key at [https://speedtest-tracker.dev](https://speedtest-tracker.dev)" }
   - { env_var: "DB_CONNECTION", env_value: "sqlite", desc: "Set the database type to use. `sqlite`, `pgsql`, or `mysql`" }
+  - { env_var: "SPEEDTEST_SCHEDULE", env_value: "", desc: "Set the test schedule in cron format. e.g. `0 */6 * * *`" }
+  - { env_var: "SPEEDTEST_SERVERS", env_value: "", desc: "A comma-separated list of server IDs to test against. Run `docker exec speedtest-tracker php /app/www/artisan app:ookla-list-servers` to get a list of nearby servers." }
 param_usage_include_vols: true
 param_volumes:
   - { vol_path: "/config", vol_host_path: "/path/to/data", desc: "Contains speedtest-tracker config and database, if using sqlite." }
@@ -36,6 +38,8 @@ opt_param_env_vars:
   - { env_var: "DB_DATABASE", env_value: "", desc: "Database name (postgres/mysql)." }
   - { env_var: "DB_USERNAME", env_value: "", desc: "Database username (postgres/mysql)." }
   - { env_var: "DB_PASSWORD", env_value: "", desc: "Database password (postgres/mysql)." }
+  - { env_var: "DISPLAY_TIMEZONE", env_value: "Etc/UTC", desc: "Timezone for the UI." }
+  - { env_var: "PRUNE_RESULTS_OLDER_THAN", env_value: "0", desc: "Days to keep test results." }
 
 # application setup block
 app_setup_block_enabled: true