From 04226a49c4492bd87a51ae573dd90e378f8aec25 Mon Sep 17 00:00:00 2001 From: thespad Date: Sun, 20 Oct 2024 23:38:54 +0100 Subject: [PATCH] Add missing APP_URL to readme --- README.md | 3 +++ readme-vars.yml | 1 + 2 files changed, 4 insertions(+) diff --git a/README.md b/README.md index bf27149..53e0708 100644 --- a/README.md +++ b/README.md @@ -78,6 +78,7 @@ services: - PGID=1000 - TZ=Etc/UTC - APP_KEY= + - APP_URL= - DB_CONNECTION=sqlite - SPEEDTEST_SCHEDULE= - SPEEDTEST_SERVERS= @@ -104,6 +105,7 @@ docker run -d \ -e PGID=1000 \ -e TZ=Etc/UTC \ -e APP_KEY= \ + -e APP_URL= \ -e DB_CONNECTION=sqlite \ -e SPEEDTEST_SCHEDULE= \ -e SPEEDTEST_SERVERS= \ @@ -131,6 +133,7 @@ Containers are configured using parameters passed at runtime (such as those abov | `-e PGID=1000` | for GroupID - see below for explanation | | `-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 APP_URL=` | The IP:port or URL your application will be accessed on (ie. `http://192.168.1.1:6875` or `https://bookstack.mydomain.com` | | `-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 run -it --rm --entrypoint /bin/bash lscr.io/linuxserver/speedtest-tracker:latest list-servers` to get a list of nearby servers. | diff --git a/readme-vars.yml b/readme-vars.yml index 1449afe..3f7537d 100644 --- a/readme-vars.yml +++ b/readme-vars.yml @@ -17,6 +17,7 @@ param_container_name: "{{ project_name }}" 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: "APP_URL", env_value: "", desc: "The IP:port or URL your application will be accessed on (ie. `http://192.168.1.1:6875` or `https://bookstack.mydomain.com`"} - { 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 run -it --rm --entrypoint /bin/bash lscr.io/linuxserver/speedtest-tracker:latest list-servers` to get a list of nearby servers." }