[FEAT] Clarify timezone configuration (TZ vs APP_TIMEZONE vs DISPLAY_TIMEZONE) in README
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 1/5
- Tempo stimato
- Meno di un'ora
- Idoneità per principianti
- 88/100
- Tipo di issue
- Documentazione
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Attiva
- Stack tecnologico
- docker, laravel
- Ambito
- documentation
Direzione di ricerca
Inizia in readme-vars.yml esaminando opt_param_env_vars e app_setup_block. Aggiorna le descrizioni delle variabili del fuso orario e aggiungi la spiegazione delle tre variabili, quindi verifica che la documentazione del README distingua chiaramente tra TZ, APP_TIMEZONE e DISPLAY_TIMEZONE e raccomandi un’impostazione coerente.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Is this a new feature request?
- I have searched the existing issues
Wanted change
Improve the README's documentation around timezone configuration. Speedtest-tracker reads three separate timezone environment variables, and the interaction between them isn't obvious from the current README:
TZ— container OS timezone (cron, system logs)APP_TIMEZONE— Laravel's internal timezone (config/app.php→env('APP_TIMEZONE', 'UTC'))DISPLAY_TIMEZONE— timezone shown in the web UI (config/app.php→env('DISPLAY_TIMEZONE', 'UTC'))
Currently:
APP_TIMEZONEisn't listed inreadme-vars.ymlat all.DISPLAY_TIMEZONEis listed as optional with the description "Timezone for the UI." and no guidance.
Users following the standard LSIO pattern of only setting TZ end up with a UI that displays UTC times regardless of their TZ value, which is a common source of confusion.
Reason for change
This trips up users (myself included) who reasonably expect TZ alone to control displayed times, as it does in most other LSIO images. A short note in Application Setup that all three should generally be set to the same value would save a lot of head-scratching and forum/Discord traffic.
Proposed code change
A small, documentation-only change to readme-vars.yml:
- Add
APP_TIMEZONEtoopt_param_env_vars. - Expand the
DISPLAY_TIMEZONEdescription to recommend matchingTZ. - Add a "Timezone configuration" subsection to
app_setup_blockexplaining the three variables and recommending they all be set to the same value.
--- a/readme-vars.yml
+++ b/readme-vars.yml
@@ -33,13 +33,24 @@ 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: "APP_TIMEZONE", env_value: "Etc/UTC", desc: "Timezone Laravel uses internally for scheduling and stored timestamps. Recommended to match `TZ`."}
+ - {env_var: "DISPLAY_TIMEZONE", env_value: "Etc/UTC", desc: "Timezone shown in the web UI. Recommended to match `TZ` so displayed times line up with the container clock."}
- {env_var: "PRUNE_RESULTS_OLDER_THAN", env_value: "0", desc: "Days to keep test results."}
# application setup block
app_setup_block_enabled: true
app_setup_block: |
Access the web UI at `<your-ip>:80`, the default credentials are [email protected] / password
+ ### Timezone configuration
+
+ Speedtest-tracker reads three separate timezone variables and they each control a different layer:
+
+ * `TZ` sets the container OS timezone, used by cron and system logs.
+ * `APP_TIMEZONE` sets the timezone Laravel uses internally for scheduling and stored timestamps.
+ * `DISPLAY_TIMEZONE` sets the timezone shown in the web UI.
+
+ Setting only `TZ` (the common pattern with other LinuxServer.io images) will leave the application and UI on UTC. For consistent behaviour set all three to the same value, e.g. `Europe/London`.
+
For more information check out the [project documentation](https://docs.speedtest-tracker.dev/).
I have this change prepared locally on a branch. Happy to open a PR if you'd like — just wanted to check first since CONTRIBUTING.md asks for an issue rather than a PR for small doc fixes. Let me know which you'd prefer.
- Lingua principale
- Dockerfile
- Stelle
- 186
- Fork
- 8
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
- Include un Dockerfile o un file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di linuxserver/docker-speedtest-tracker
-
no-issue-activity
Difficoltà 4/5 3-5 giorni Idoneità per principianti 38/100
linuxserver/docker-speedtest-tracker#81 · 6 commenti ·
-
no-issue-activity
Difficoltà 4/5 3-5 giorni Idoneità per principianti 45/100
linuxserver/docker-speedtest-tracker#80 · 4 commenti ·
-
no-issue-activity
Difficoltà 4/5 3-5 giorni Idoneità per principianti 48/100
linuxserver/docker-speedtest-tracker#79 · 7 commenti ·
Tutte le issue di linuxserver/docker-speedtest-tracker
Issue simili
-
Broken links found in docsApertadocs pydanty:is-working
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
pydantic/pydantic-ai#8863 ·
I maintainer di solito rispondono entro 1 giorno
-
documentation from-review-extraction github-actions priority: low severity:nit
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 92/100
LearningCircuit/local-deep-research#6946 ·
I maintainer di solito rispondono entro 1 giorno
-
enhancement
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 88/100
esphome/device-builder#2856 ·
I maintainer di solito rispondono entro 1 giorno
-
documentation good first issue
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 95/100
-
Difficoltà 1/5 1-3 ore Idoneità per principianti 78/100
mantinedev/mantine#9223 ·
I maintainer di solito rispondono entro 6 giorni