diff --git a/README.md b/README.md index a9d9cae..b68b333 100644 --- a/README.md +++ b/README.md @@ -127,48 +127,64 @@ Wichtig: Die API laeuft im Container intern auf Port `8080`, wird aber nach auss ## Schnellstart mit Docker Compose +Du solltest WSL installiert haben. +Falls du das nicht hast: +```powershell + wsl --install Ubuntu +``` +Dann kannst du Docker Desktop installieren: + https://docs.docker.com/desktop/setup/install/windows-install/ +Die Installation einfach durchklicken und wenn du gefragt wirst ob du Hyper-V oder WSL verwenden möchtest, wähle WSL. + + ### 1. Repository vorbereiten +Wenn du git auf deinem rechner installiert hast, dann öffne eine Powershell in dem Ordner, in dem du das LTD-System haben willst. +(rechtsklick im Windowsexplorer ins leere --> "In Terminal öffnen") ```powershell -cd C:\Projects\SeLTD -copy .env.example .env +git clone https://git.portal.se-cloud.de/Hannes/SE-LTD +cd ./SeLTD ``` +Powershell nicht schließen, brauchst du gleich noch. -Passe danach mindestens diese Werte an: - -```env -JWT_SECRET=bitte-langen-zufaelligen-wert-setzen -ADMIN_USERNAME=admin -ADMIN_PASSWORD=ChangeMe123! -MARIADB_ROOT_PASSWORD=SE3112 -CORS_ORIGIN=http://localhost:5173 -VITE_API_PORT=18080 -``` ### 2. Stack bauen und starten -```powershell -docker compose up -d --build -``` - -Bei groesseren Aenderungen am Code oder wenn der Browser alten Code anzeigt: +Falls du Powershell geschlossen hast: +(rechtsklick im Windowsexplorer ins leere --> "In Terminal öffnen") ```powershell -docker compose down docker compose build --no-cache web api collector -docker compose up -d +docker compose up -d --force-recreate ``` +Die lokalen Images werden jetzt gebaut und die Onlineimages werden heruntrergeladen. +Wenn das fertig ist müssen alle 7 Container gestartet sein. + +Im Nachgang kannst du dies in der Powershell mit... +```powershell +docker ps -a +``` +...überprüfen ### 3. Aufrufen - -| Anwendung | URL | -| --- | --- | +Nun stehen dir mehrere Tools zur Verfügung: | Frontend | `http://localhost:5173` | -| API Healthcheck | `http://localhost:18080/api/health` | -| Collector Healthcheck | `http://localhost:18110/health` | -| Dockhand | `http://localhost:3000` | -| cAdvisor | `http://localhost:9090` | +--> Das ist die normale Weboberfläche zum anschauen, editieren und anpassen von Trends. +| API Healthcheck | `http://localhost:18080/api/health` | +--> hier kannst du schauen ob die API läuft + +| Collector Healthcheck | `http://localhost:18110/health` | +--> hier kannst du schauen ob der Collector läuft, was nur wichtig ist, wenn du Datenpunkte per OPC,KNX, Modbus oder Bacnet angebunden hast. + +| Dockhand | `http://localhost:3000` | +--> Dockhand ist Container verwaltungstool, dass es dir ermöglicht, auch grafisch den Zustand deiner Container und deines Stacks zu sehen. + Der Vorteil hier, im Gegensatz zur normalen Docker Desktopoberfläche: Du kannst es auf jedem beliebigen anderen Rechner, der auf dein Netzwerk zugriff hat, öffnen. + +| cAdvisor | `http://localhost:9090` | +--> Cadvisor stellt alle Containerdaten für Monitoring und Analyticprogramme bereit. + So kann bei einer größeren Anlage, das Dockersystem mitr Prometheus oder ähnlichem überwacht werden. + Cadvisor stellt di Daten per html bereit, kannst du dir gern anschauen, ist aber ziemlich unübersichtlich. ### 4. Standard-Login ```text