[FEAT] Clarify timezone configuration (TZ vs APP_TIMEZONE vs DISPLAY_TIMEZONE) in README
まだ誰も着手していません。
評価
- 難易度
- 1/5
- 見積もり時間
- 1時間未満
- 初心者へのやさしさ
- 88/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- docker, laravel
調査の方向性
readme-vars.yml で opt_param_env_vars と app_setup_block の確認から始めます。タイムゾーン変数の説明を更新し、3 つの変数についての説明を追加します。その後、README のドキュメントで TZ、APP_TIMEZONE、DISPLAY_TIMEZONE の違いが明確に示され、一貫した設定が推奨されていることを確認します。
索引モデルが issue の本文から書いたものです。
説明
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.
- 主要言語
- Dockerfile
- スター
- 186
- フォーク
- 8
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
linuxserver/docker-speedtest-tracker のほかの issue
-
no-issue-activity
難易度 4/5 3〜5日 初心者へのやさしさ 38/100
linuxserver/docker-speedtest-tracker#81 · コメント 7 件 ·
-
no-issue-activity
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
linuxserver/docker-speedtest-tracker#80 · コメント 4 件 ·
-
no-issue-activity
難易度 4/5 3〜5日 初心者へのやさしさ 48/100
linuxserver/docker-speedtest-tracker#79 · コメント 7 件 ·
linuxserver/docker-speedtest-tracker の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
obra/superpowers#2422 ·
メンテナーはふだん 6 日以内に返信
-
triage
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
AdobeDocs/workfront.en#69 ·
-
integration: water_heater
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
home-assistant/home-assistant.io#48527 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
bytedance/trae-agent#532 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信