Skip to content

Commit eb100d8

Browse files
Bot Updating Templated Files
1 parent 5dfd199 commit eb100d8

File tree

1 file changed

+78
-26
lines changed

1 file changed

+78
-26
lines changed

readme-vars.yml

Lines changed: 78 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -5,48 +5,100 @@ project_url: "https://github.com/alexjustesen/speedtest-tracker"
55
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/speedtest-tracker-logo.png"
66
project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) is a self-hosted internet performance tracking application that runs speedtest checks against Ookla's Speedtest service."
77
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
8-
98
# supported architectures
109
available_architectures:
11-
- { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
12-
- { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
13-
10+
- {arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
11+
- {arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
1412
# container parameters
1513
common_param_env_vars_enabled: true
1614
param_container_name: "{{ project_name }}"
1715
param_usage_include_env: true
1816
param_env_vars:
19-
- { 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)" }
20-
- { 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`"}
21-
- { env_var: "DB_CONNECTION", env_value: "sqlite", desc: "Set the database type to use. `sqlite`, `pgsql`, or `mysql`" }
22-
- { env_var: "SPEEDTEST_SCHEDULE", env_value: "", desc: "Set the test schedule in cron format. e.g. `0 */6 * * *`" }
23-
- { 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." }
17+
- {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)"}
18+
- {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`"}
19+
- {env_var: "DB_CONNECTION", env_value: "sqlite", desc: "Set the database type to use. `sqlite`, `pgsql`, or `mysql`"}
20+
- {env_var: "SPEEDTEST_SCHEDULE", env_value: "", desc: "Set the test schedule in cron format. e.g. `0 */6 * * *`"}
21+
- {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."}
2422
param_usage_include_vols: true
2523
param_volumes:
26-
- { vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/data", desc: "Contains speedtest-tracker config and database, if using sqlite." }
24+
- {vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/data", desc: "Contains speedtest-tracker config and database, if using sqlite."}
2725
param_usage_include_ports: true
2826
param_ports:
29-
- { external_port: "80", internal_port: "80", port_desc: "Web UI" }
30-
27+
- {external_port: "80", internal_port: "80", port_desc: "Web UI"}
3128
opt_param_usage_include_env: true
3229
opt_param_env_vars:
33-
- { env_var: "DB_HOST", env_value: "", desc: "Database hostname (postgres/mysql)." }
34-
- { env_var: "DB_PORT", env_value: "", desc: "Database port (postgres/mysql)." }
35-
- { env_var: "DB_DATABASE", env_value: "", desc: "Database name (postgres/mysql)." }
36-
- { env_var: "DB_USERNAME", env_value: "", desc: "Database username (postgres/mysql)." }
37-
- { env_var: "DB_PASSWORD", env_value: "", desc: "Database password (postgres/mysql)." }
38-
- { env_var: "DISPLAY_TIMEZONE", env_value: "Etc/UTC", desc: "Timezone for the UI." }
39-
- { env_var: "PRUNE_RESULTS_OLDER_THAN", env_value: "0", desc: "Days to keep test results." }
40-
30+
- {env_var: "DB_HOST", env_value: "", desc: "Database hostname (postgres/mysql)."}
31+
- {env_var: "DB_PORT", env_value: "", desc: "Database port (postgres/mysql)."}
32+
- {env_var: "DB_DATABASE", env_value: "", desc: "Database name (postgres/mysql)."}
33+
- {env_var: "DB_USERNAME", env_value: "", desc: "Database username (postgres/mysql)."}
34+
- {env_var: "DB_PASSWORD", env_value: "", desc: "Database password (postgres/mysql)."}
35+
- {env_var: "DISPLAY_TIMEZONE", env_value: "Etc/UTC", desc: "Timezone for the UI."}
36+
- {env_var: "PRUNE_RESULTS_OLDER_THAN", env_value: "0", desc: "Days to keep test results."}
4137
# application setup block
4238
app_setup_block_enabled: true
4339
app_setup_block: |
4440
Access the web UI at `<your-ip>:80`, for more information check out the [project documentation](https://docs.speedtest-tracker.dev/).
45-
41+
# init diagram
42+
init_diagram: |
43+
"speedtest-tracker:latest": {
44+
docker-mods
45+
base {
46+
fix-attr +\nlegacy cont-init
47+
}
48+
docker-mods -> base
49+
legacy-services
50+
custom services
51+
init-services -> legacy-services
52+
init-services -> custom services
53+
custom services -> legacy-services
54+
legacy-services -> ci-service-check
55+
init-migrations -> init-adduser
56+
init-nginx-end -> init-config
57+
init-os-end -> init-config
58+
init-config -> init-config-end
59+
init-speedtest-tracker-config -> init-config-end
60+
init-os-end -> init-crontab-config
61+
init-mods-end -> init-custom-files
62+
base -> init-envfile
63+
init-os-end -> init-folders
64+
init-php -> init-keygen
65+
base -> init-migrations
66+
base -> init-mods
67+
init-config-end -> init-mods
68+
init-version-checks -> init-mods
69+
init-mods -> init-mods-end
70+
init-mods-package-install -> init-mods-end
71+
init-mods -> init-mods-package-install
72+
init-samples -> init-nginx
73+
init-permissions -> init-nginx-end
74+
base -> init-os-end
75+
init-adduser -> init-os-end
76+
init-envfile -> init-os-end
77+
init-migrations -> init-os-end
78+
init-keygen -> init-permissions
79+
init-nginx -> init-php
80+
init-folders -> init-samples
81+
init-custom-files -> init-services
82+
init-mods-end -> init-services
83+
init-nginx-end -> init-speedtest-tracker-config
84+
init-config-end -> init-version-checks
85+
init-services -> svc-cron
86+
svc-cron -> legacy-services
87+
init-services -> svc-nginx
88+
svc-nginx -> legacy-services
89+
init-services -> svc-php-fpm
90+
svc-php-fpm -> legacy-services
91+
init-services -> svc-speedtest-tracker
92+
svc-speedtest-tracker -> legacy-services
93+
}
94+
Base Images: {
95+
"baseimage-alpine-nginx:3.20" <- "baseimage-alpine:3.20"
96+
}
97+
"speedtest-tracker:latest" <- Base Images
4698
# changelog
4799
changelogs:
48-
- { date: "07.06.24:", desc: "Cache Filament components and added APP_KEY as a required param." }
49-
- { date: "27.05.24:", desc: "Existing users should update their nginx confs to avoid http2 deprecation warnings." }
50-
- { date: "24.05.24:", desc: "Rebase to Alpine 3.20." }
51-
- { date: "16.04.24:", desc: "Rebase to Alpine 3.19, upgrade to php 8.3." }
52-
- { date: "10.02.24:", desc: "Initial Release." }
100+
- {date: "07.06.24:", desc: "Cache Filament components and added APP_KEY as a required param."}
101+
- {date: "27.05.24:", desc: "Existing users should update their nginx confs to avoid http2 deprecation warnings."}
102+
- {date: "24.05.24:", desc: "Rebase to Alpine 3.20."}
103+
- {date: "16.04.24:", desc: "Rebase to Alpine 3.19, upgrade to php 8.3."}
104+
- {date: "10.02.24:", desc: "Initial Release."}

0 commit comments

Comments
 (0)