From 21157e5fb45c05a28034945fb2b1b74bbe402fa9 Mon Sep 17 00:00:00 2001 From: Stefan Date: Sun, 14 May 2023 11:44:11 +0200 Subject: [PATCH] Readme angepasst --- README.md | 48 +++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 43 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 8b58f24..c493fb5 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,17 @@ # Freifunk Meshviewer Unifi Access Points und Richtfunkstrecken import -Dieses tool Importiert Nodes für die Freifunk Map aus den APIs UNMS (Richtfunk) & Unifi (Access Points) +Dieses tool Importiert Nodes für die Freifunk Map aus den APIs UISP (Richtfunk) & Unifi (Access Points). +Ebenfalls ist der Import statischer devices möglich. Da diese alle in unerem Proxmox cluster laufen, werden Statistikdaten aus der Proxmox InfluxDB geholt. + +Alle Config dateien müssen per http erreichbar sein (z.B. in einem Git) +Für Troisdorf werden diese Dateien hier gepflegt: https://git.freifunk-rhein-sieg.net/Freifunk-Troisdorf/ubnt-api-devices +Für die Rhein-Sieg-Map hier: https://git.freifunk-rhein-sieg.net/Freifunk-Rhein-Sieg/ubnt-api-devices ## Config -### Unifi Access Points (ucDevices.json) +### Unifi Access Points (unifi_devices.json) -In der Datei ucDevices.json können die Access Points gepflegt werden, die auf der Freifunk Map erscheinen sollen. +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. @@ -32,9 +37,9 @@ Erklärung: * 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) -### UNMS Richtfunkstrecken +### UISP Richtfunkstrecken -In der Datei devices.json können die Richtfunkstrecken gepflegt werden, die auf der Freifunk Map erscheinen sollen. +In der Datei rifu_devices.json können die Richtfunkstrecken gepflegt werden, die auf der Freifunk Map erscheinen sollen. ```json { @@ -56,11 +61,44 @@ Erklärung: * 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"] + }, +``` + ### Config.json Es gibt 3 Module die Ein/Ausgeschatet werden können: * UNMS * Unifi * Meshviewer +* Gateways Die Funktion Meshviewer importiert die vorhandenen meshviewer.json und manipuliert dort die Userzahlen. Sobald ein Access Point einen Node aus einer Meshviwer.json als "gateway_nexthop" eingetragen hat, werden die Clients an dem verbundenen Access Point und nicht mehr am Offloader angezeigt.