From 8a16a8633bb6c841e4ebbff4458015f6d49f963c Mon Sep 17 00:00:00 2001 From: stephan Date: Sun, 28 Dec 2025 23:39:10 +0100 Subject: [PATCH] docs: add update client config keys --- CHANGELOG.md | 1 + README.md | 4 ++++ env.example | 4 ++++ project-management/requirements/tasks/TASK_000027.md | 10 +++++----- 4 files changed, 14 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c139e2e..c13e86e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -22,6 +22,7 @@ By: Codex (GPT-5) | 28.12.2025 | 🏗️ Planning | ID: Update-Service URL auf update.wlkns.org festgelegt. By: Codex (GPT-5) | | 28.12.2025 | 🏗️ Planning | ID: EPIC_000009 Update Webservice (External Team) dokumentiert. By: Codex (GPT-5) | | 28.12.2025 | 🏗️ Planning | ID: TASK_000027-TASK_000029 fuer EPIC_000008 ausgearbeitet. By: Codex (GPT-5) | +| 28.12.2025 | ⚙️ Code | ID: Update-Config Keys in Settings/ENV/README definiert. By: Codex (GPT-5) | --- ## Legende diff --git a/README.md b/README.md index 1563bac..4a5dbd0 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,10 @@ Set in `/etc/skd/env` (see `env.example`): - `SKD_DEFAULT_COUNTDOWN`, `SKD_DEFAULT_SOUND`, `SKD_NOTIFY_TIMEOUT`: behavior defaults. - `SKD_DRY_RUN=true` to test without real account changes or shutdown. - `SKD_SOUND_PLAYER`/`SKD_SOUND_FILE`, `SKD_NOTIFY_SEND_PATH` if defaults differ. +- Update client: + - `SKD_UPDATE_URL` (default `https://update.wlkns.org`) + - `SKD_UPDATE_TOKEN` (API token for update service) + - `SKD_UPDATE_INTERVAL` (seconds; default 3600) Notes: - `./scripts/install.sh` will create `/etc/skd/env` from `env.example` if missing (edit afterwards) and ensure the `skd` service user/group exist. diff --git a/env.example b/env.example index 41120b9..9c7368b 100644 --- a/env.example +++ b/env.example @@ -21,5 +21,9 @@ SKD_OIDC_STATE_COOKIE_NAME=skd_oidc_state SKD_DEFAULT_COUNTDOWN=60 SKD_DEFAULT_SOUND=false SKD_NOTIFY_TIMEOUT=5 +# Update client configuration +SKD_UPDATE_URL=https://update.wlkns.org +SKD_UPDATE_TOKEN= +SKD_UPDATE_INTERVAL=3600 # Set to true to test without performing real system changes SKD_DRY_RUN=false diff --git a/project-management/requirements/tasks/TASK_000027.md b/project-management/requirements/tasks/TASK_000027.md index 2e6d2a4..35f6b95 100644 --- a/project-management/requirements/tasks/TASK_000027.md +++ b/project-management/requirements/tasks/TASK_000027.md @@ -1,4 +1,4 @@ -ID: TASK_000027 | Version: 0.1.0 | Status: Draft +ID: TASK_000027 | Version: 0.1.0 | Status: In Progress By: Codex (GPT-5) # TASK_000027: Update endpoint config @@ -10,11 +10,11 @@ Client kennt Update-Endpoint, Auth und Polling-Konfiguration. US_000026 ## Beschreibung -- Konfigurationskeys definieren (z.B. `SKD_UPDATE_URL`, `SKD_UPDATE_TOKEN`, `SKD_UPDATE_INTERVAL`). +- Konfigurationskeys definieren (`SKD_UPDATE_URL`, `SKD_UPDATE_TOKEN`, `SKD_UPDATE_INTERVAL`). - Default auf `https://update.wlkns.org` festlegen. - Lesen der Config in Settings/ENV beschreiben. ## Definition of Done (DoD) -- Konfigurations-Keys dokumentiert. -- Default-URL ist festgelegt. -- Client kann Update-Endpoint ueber Konfiguration aufloesen. +- Konfigurations-Keys dokumentiert (`env.example`, README). +- Default-URL ist festgelegt (`https://update.wlkns.org`). +- Settings laden die Update-Konfiguration aus ENV.