From 48f8e6333637d0bc576055b0fc413063e64a2f09 Mon Sep 17 00:00:00 2001
From: Stefan Hoffmann <stefan@freifunk-troisdorf.de>
Date: Sun, 14 May 2023 09:25:51 +0000
Subject: [PATCH] Update 'README.md'

---
 README.md | 86 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 83 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index e8688cb..95258a5 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,85 @@
-# ubnt-api-devices
+## Config
 
-Geräte des Unifi Controller und UNMS die auf der Map map.freifunk-troisdorf.de angezeigt werden sollen.
+### Unifi Access Points (unifi_devices.json)
 
-Siehe: https://git.freifunk-rhein-sieg.net/Freifunk-Troisdorf/ubnt-freifunk-map-api
+In der Datei unifi_devices.json können die Access Points gepflegt werden, die auf der Freifunk Map erscheinen sollen.
+
+Hierzu muss die Datei im json Format erweitert werden.
+
+Für jedes Gerät muss dieser Block angelegt werden:
+```json
+{
+    "name": "ROUTERNAME",
+    "mac": "00:00:00:00:00",
+    "gateway_nexthop": "1234567890",
+    "gateway": "1234567890",
+    "linked_to": "18:e8:29:24:17:0a",
+    "domain": "unifi",
+    "location": {
+      "longitude":7.148406208,
+      "latitude":50.817093402
+},
+```
+Erklärung:
+* name:   Dient nur zur Wiedererkennung. Auf der Map erscheint der Name aus dem Unifi Controller
+* mac:    Die MAC Adresse des Access Points. Zu finden im Controller. (Statistik Übersicht in der Geräteansicht)
+* gateway_nexthop:    Die Node ID (MAC ohne :) des Freifunk Routers an den der AP angeschlossen ist.
+* gateway:    Im Normalfall die NodeID des Supernodes (zu finden in der MAP)
+* linked_to: (Optional) Die MAC Adresse des Routers an dem der AP angeschlossen ist. Normalerweise gateway_nexthop mit Doppelpunkten. Wenn nicht gesetzt wird kein Link auf der Map angezeigt.
+* domain: Die Domain in der sich der AP befindet. (tdf, inn, flu)
+
+### UISP Richtfunkstrecken
+
+In der Datei rifu_devices.json können die Richtfunkstrecken gepflegt werden, die auf der Freifunk Map erscheinen sollen.
+
+```json
+{
+  "name": "Rathaus2Bahnhof",
+  "mac": "18:E8:29:8E:C6:4D",
+  "gateway_nexthop": "18e8292f7de6",
+  "gateway": "a28cae6ff604",
+  "domain": "rifu",
+  "location": {
+    "longitude":7.148406208,
+    "latitude":50.817093402
+  }
+}
+```
+Erklärung:
+* name:   Dient nur zur Wiedererkennung. Auf der Map erscheint der Name aus dem UNMS Controller
+* mac:    Die MAC Adresse des Gerätes. Zu finden im Controller.
+* gateway_nexthop:    Die Node ID (MAC ohne :) des Freifunk Routers an dem das Gerät angeschlossen ist.
+* gateway:    Im Normalfall die NodeID des Supernodes (zu finden in der MAP)
+* domain: Die Domain in der sich der AP befindet. (tdf, inn, flu)
+
+### UISP Router
+
+In dieser datei werden die Router (meist ER-X) gepflegt. Diese Daten werden dann ebenfalls aus der UISP API Importiert.
+
+```json
+{
+        "name": "Rathaus Uplink",
+        "mac": "18:e8:29:ad:9a:34",
+        "gateway_nexthop": "18e8292f7de6",
+        "gateway": "a28cae6ff604",
+        "domain": "tdf",
+        "location": {
+          "longitude":7.149406208,
+          "latitude":50.817093402
+        }
+      },
+```
+
+### Gateways.json
+
+Hier werden Statische Geräte eingetragen die auf dem Proxmox Cluster laufen.
+
+```json
+{
+      "name": "VPN01",
+      "fqdn": "vpn01.fftdf.de",
+      "mac": "00:00:00:00:00:01",
+      "domain": "VPN1",
+      "adresses": ["5.9.220.114"]
+    },
+```