#14 Präsentation: Quickstart-Dokumentation & config.example.yaml aktualisieren #14

New issue

Open

opened 2026-02-20 23:11:23 +01:00 by ppfeiffer · 0 comments

ppfeiffer commented

2026-02-20 23:11:23 +01:00

Owner

Ziel

Jemand, der das Repo klont, soll das Dashboard in unter 5 Minuten lokal (oder auf einem Server) zum Laufen bringen – ohne Kenntnisse der Interna.

config.example.yaml

Auf v0.09.00 aktualisieren
Alle Felder mit Inline-Kommentar erklärt
auth.secret_key: Hinweis auf python3 -c "import secrets; print(secrets.token_urlsafe(32))"
SMTP-Felder als optional kennzeichnen

README.md – Quickstart-Abschnitt

Neuen Abschnitt Schnellstart (Docker) einfügen:

Repo klonen
cp config/config.example.yaml config/config.yaml + Werte eintragen
docker compose up -d
Ersten Admin anlegen via docker compose exec meshdd python ...
Dashboard öffnen

Aufgaben

config/config.example.yaml kommentiert, Stand v0.09.00
README.md: Schnellstart-Docker-Abschnitt
README.md: Tabelle der drei YAML-Dateien (Zweck, Pfad)
Hinweis: Konfiguration nach dem Start bequem über /config im Browser editierbar
Ersten Admin via exec-Einzeiler dokumentieren

Abhängigkeit

Blockiert durch #12.

Akzeptanzkriterium

Eine fremde Person kann dem README folgen und das Dashboard ohne weitere Anleitung starten.

## Ziel Jemand, der das Repo klont, soll das Dashboard in unter 5 Minuten lokal (oder auf einem Server) zum Laufen bringen – ohne Kenntnisse der Interna. ## config.example.yaml - Auf v0.09.00 aktualisieren - Alle Felder mit Inline-Kommentar erklärt - `auth.secret_key`: Hinweis auf `python3 -c "import secrets; print(secrets.token_urlsafe(32))"` - SMTP-Felder als optional kennzeichnen ## README.md – Quickstart-Abschnitt Neuen Abschnitt **Schnellstart (Docker)** einfügen: 1. Repo klonen 2. `cp config/config.example.yaml config/config.yaml` + Werte eintragen 3. `docker compose up -d` 4. Ersten Admin anlegen via `docker compose exec meshdd python ...` 5. Dashboard öffnen ## Aufgaben - [ ] `config/config.example.yaml` kommentiert, Stand v0.09.00 - [ ] `README.md`: Schnellstart-Docker-Abschnitt - [ ] `README.md`: Tabelle der drei YAML-Dateien (Zweck, Pfad) - [ ] Hinweis: Konfiguration nach dem Start bequem über `/config` im Browser editierbar - [ ] Ersten Admin via exec-Einzeiler dokumentieren ## Abhängigkeit Blockiert durch #12. ## Akzeptanzkriterium Eine fremde Person kann dem README folgen und das Dashboard ohne weitere Anleitung starten.

No labels

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: ppfeiffer/MeshDD-Bot#14

No description provided.