diff --git a/README.md b/README.md index 5eadb04..6df28ef 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,37 @@ # Allnet Dashboard -Allnet Grafana Dashboard using InfluxDB as the Database. +Allnet Grafana Dashboard mit InfluxDB als Datenbank. -## Usage +## Einrichtung -- Projekt clonen -- `.env` erstellen und mit den Daten aus `.env.example` befüllen - - `INFLUXDB_TOKEN` mit einem zufälligen String befüllen -- Ausführen: `docker-compose up -d` +- Projekt clonen/[herunterladen]("https://github.com/LinoSchmidt/Allnet-Dashboard/archive/refs/heads/main.zip") +- `.env.example` in `.env` umbenennen und mit gewünschten Daten befüllen + - `INFLUXDB_TOKEN` mit einem zufällig generierten Passwort befüllen +- im Ordner per Terminal Ausführen: `docker-compose up -d` + +### Allnet Gerät + +- Allnet Gerät mit dem Netzwerk verbinden +- IP-Adresse des Geräts herausfinden und die Web-Oberfläche öffnen +- Das Modul `POST/GET` aktivieren +- Einstellungen des Moduls öffnen + - Adresse: `http://:8086` + - Protokoll: `http` + - Send Method: `POST` + - Auszuwertende Sensoren auswählen + +## Zugriff + +### Grafana (Dashboard) + +Das Dashboard ist unter `http://:3000` erreichbar. + +Falls Anderungen an Grafana vorgenommen werden sollen, kann dies durch das Login mit dem Benutzer `admin` und dem Passwort aus der `.env` Datei getan werden. + +Neue Dashboards können über Grafana erstellt werden und dann in den `grafana-provisioning/dashboards` Ordner gespeichert werden. + +### InfluxDB (Datenbank) + +Die InfluxDB ist unter `http://:8086` erreichbar. + +Logindaten werden in der `.env` Datei festgelegt.