Skip to content

Commit 4c84d69

Browse files
authored
Update README.md
1 parent 6796d21 commit 4c84d69

1 file changed

Lines changed: 22 additions & 10 deletions

File tree

README.md

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1-
# Balkonkraftwerk Analytics
1+
# Balkonkraftwerk Analytics Dashboard
22

33
Ein intelligentes Monitoring-System für Balkonkraftwerke. Es kombiniert Echtzeit-Daten via MQTT mit Wettervorhersagen von Open-Meteo, um mittels Machine Learning den Ertrag der nächsten Tage vorherzusagen.
44

55

6-
76
## 🚀 Features
87

98
* **Echtzeit-Monitoring:** Empfängt sekündliche Live-Werte (Leistung/Watt, Strom/Ampere, Spannung/Volt, Temperatur) des Wechselrichters via MQTT (OpenDTU/AhoyDTU).
@@ -136,19 +135,32 @@ sudo systemctl enable --now balkonkraftwerk
136135
sudo systemctl enable --now balkonkraftwerk-staging
137136
```
138137

139-
### ⚠️ Wichtig: GitHub Actions konfigurieren
140-
Damit das automatische Deployment funktioniert, müssen die Pfade in deinen `.github/workflows/*.yml` Dateien mit der Serverstruktur übereinstimmen:
138+
### ⚠️ Wichtig: GitHub Actions & CI/CD Setup
139+
140+
Damit das automatische Deployment funktioniert, müssen zwei Dinge konfiguriert sein:
141+
142+
#### 1. Pfade in den Workflows
143+
Stelle sicher, dass die Zielverzeichnisse in deinen `.github/workflows/*.yml` Dateien exakt mit der Serverstruktur übereinstimmen:
144+
* **deploy-staging.yml:** Zielpfad `/home/ubuntu/balkonkraftwerk-staging`
145+
* **deploy.yml:** Zielpfad `/home/ubuntu/balkonkraftwerk`
141146

142-
* **deploy-staging.yml:** Muss auf das Verzeichnis `/home/ubuntu/balkonkraftwerk-staging` zeigen.
143-
* **deploy.yml:** Muss auf das Verzeichnis `/home/ubuntu/balkonkraftwerk` zeigen.
147+
#### 2. GitHub Secrets
148+
Hinterlege in deinem GitHub-Repository unter `Settings > Secrets and variables > Actions` folgende Secrets, damit die Action auf deinen Server zugreifen kann:
144149

145-
Stelle sicher, dass dein SSH-User Schreibrechte für beide Verzeichnisse besitzt.
150+
| Secret Name | Beschreibung |
151+
| :--- | :--- |
152+
| `SERVER_IP` | Die IP-Adresse deines Ubuntu-Servers |
153+
| `SERVER_USER` | Dein Benutzername (z. B. `ubuntu`) |
154+
| `SSH_PRIVATE_KEY` | Dein privater SSH-Schlüssel (für den passwortlosen Login) |
155+
156+
---
146157

147158
## 🧪 Entwicklung & Staging
148159
Das Projekt nutzt einen automatisierten **Staging-Workflow** via GitHub Actions:
149-
* **Entwicklung:** Änderungen werden in den `dev` Branch gepusht. Die GitHub Action führt einen Deploy auf dem Server im Verzeichnis `/home/ubuntu/balkonkraftwerk-staging` aus.
150-
* **Vorschau:** Änderungen sind sofort unter `http://deine-ip:5001` sichtbar.
151-
* **Production:** Nach einem erfolgreichen Merge von `dev` in den `main` Branch aktualisiert die Action das Verzeichnis `/home/ubuntu/balkonkraftwerk` und startet den Live-Dienst neu.
160+
161+
1. **Entwicklung:** Änderungen werden in den `dev` Branch gepusht. Die GitHub Action führt einen Deploy auf dem Server im Verzeichnis `/home/ubuntu/balkonkraftwerk-staging` aus.
162+
2. **Vorschau:** Änderungen sind sofort unter `http://deine-ip:5001` sichtbar.
163+
3. **Production:** Nach einem erfolgreichen Merge von `dev` in den `main` Branch aktualisiert die Action das Live-Verzeichnis und startet den Dienst `balkonkraftwerk.service` neu.
152164

153165
**Staging-URL:** `http://deine-ip:5001`
154166
**Live-URL:** `http://deine-ip:5000`

0 commit comments

Comments
 (0)