From 6c0b9a29f90981a922cc0a464023ff390a05bc3b Mon Sep 17 00:00:00 2001 From: thespad Date: Tue, 15 Oct 2024 14:18:04 +0100 Subject: [PATCH] Add helper for server list --- README.md | 2 +- readme-vars.yml | 2 +- root/list-servers | 3 +++ 3 files changed, 5 insertions(+), 2 deletions(-) create mode 100755 root/list-servers diff --git a/README.md b/README.md index 4e08807..bf27149 100644 --- a/README.md +++ b/README.md @@ -133,7 +133,7 @@ Containers are configured using parameters passed at runtime (such as those abov | `-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 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. | | `-e DB_HOST=` | Database hostname (postgres/mysql). | | `-e DB_PORT=` | Database port (postgres/mysql). | | `-e DB_DATABASE=` | Database name (postgres/mysql). | diff --git a/readme-vars.yml b/readme-vars.yml index 75a9089..1449afe 100644 --- a/readme-vars.yml +++ b/readme-vars.yml @@ -19,7 +19,7 @@ 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." } + - { 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." } param_usage_include_vols: true param_volumes: - { vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/data", desc: "Contains speedtest-tracker config and database, if using sqlite." } diff --git a/root/list-servers b/root/list-servers new file mode 100755 index 0000000..b5b62ed --- /dev/null +++ b/root/list-servers @@ -0,0 +1,3 @@ +#!/bin/bash + +php /app/www/artisan app:ookla-list-servers