Skip to content

Commit f49594a

Browse files
committed
fix(docs): avoid secret-like API key examples
1 parent 52e45c7 commit f49594a

2 files changed

Lines changed: 4 additions & 6 deletions

File tree

README.de.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -404,11 +404,10 @@ Der Einstellungs-Dialog hat drei Tabs:
404404
405405
API-Keys werden niemals in `config.json` gespeichert — sie werden zur Laufzeit aus Umgebungsvariablen gelesen.
406406
407-
**Empfohlen: `secrets.env`.** Lege deine(n) Key(s) in `~/.config/blitztext-linux/secrets.env` ab, ein `NAME=WERT`-Paar pro Zeile, zum Beispiel:
407+
**Empfohlen: `secrets.env`.** Lege deine(n) Key(s) in `~/.config/blitztext-linux/secrets.env` ab, ein `NAME=WERT`-Paar pro Zeile — der Variablenname richtet sich nach dem unter **Einstellungen → KI-Workflows → „API-Key-Umgebung"** gewählten Anbieter (z. B. die OpenAI-Variable für OpenAI, die OpenRouter-Variable für OpenRouter), `WERT` ist der geheime Key von diesem Anbieter:
408408
409409
```bash
410-
OPENAI_API_KEY=sk-...
411-
# OPENROUTER_API_KEY=sk-or-...
410+
<VARIABLENNAME>=<dein-geheimer-wert>
412411
```
413412
414413
`./run.sh` und der systemd-User-Service laden diese Datei automatisch. `config.json` speichert nur den *Namen* der zu lesenden Umgebungsvariable (`openai_api_key_env`), niemals den Key selbst.

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -404,11 +404,10 @@ The settings dialog has three tabs:
404404
405405
API keys are never stored in `config.json` — they are read from environment variables at runtime.
406406
407-
**Recommended: `secrets.env`.** Place your key(s) in `~/.config/blitztext-linux/secrets.env`, one `NAME=VALUE` pair per line, for example:
407+
**Recommended: `secrets.env`.** Place your key(s) in `~/.config/blitztext-linux/secrets.env`, one `NAME=VALUE` pair per line — the variable name matches the provider selected under **Settings → AI Workflows → "API key environment"** (e.g. the OpenAI variable for OpenAI, the OpenRouter variable for OpenRouter), and `VALUE` is the secret key you got from that provider:
408408
409409
```bash
410-
OPENAI_API_KEY=sk-...
411-
# OPENROUTER_API_KEY=sk-or-...
410+
<VARIABLE_NAME>=<your-secret-value>
412411
```
413412
414413
`./run.sh` and the systemd user service load this file automatically. `config.json` only stores the *name* of the environment variable to read (`openai_api_key_env`), never the key itself.

0 commit comments

Comments
 (0)