Freifunk Config Backup Tool (FCBT)
Im Netz des Freifunk Nordhessen e.V. waren im Jahr 2023 im Schnitt rund 1.500 Geräte täglich online. Den Zugang zum Netz ermöglichten ca. 650 Accesspoints (kurz: AP), Tendenz stark steigend. Insbesondere den APs mit unserer eigenen Freifunk-Firmware kommt beim Betrieb des Netzes eine besondere Bedeutung zu. Damit wir im Schadensfall einen Standort schnell wieder in Betrieb nehmen können, erstellen wir von ausgewählten Geräten automatisch softwareseitige Backups. Und gleichzeitig werten wir aus, ob mit dem Accesspoint auch sonst alles in Ordnung ist.
Im folgenden Beitrag erklären wir, wie Mitglieder des Vereins ihre Accesspoints in unser Freifunk Config Backup Tool mit aufnehmen können.
Wofür braucht man Backups von einem Accesspoint?
Zunächst einmal geht es beim Thema Backup nicht nur um Accesspoints im Sinne von Geräten, die WLAN ausstrahlen. Es geht hier auch um Router bzw. Offloader, die bei größeren Installationen im Einsatz sind. Alle diese Geräte haben eine softwaremäßige Konfiguration. Der Name des Geräts, der Standort auf der Freifunk Karte, mitunter auch die Sendeleistung oder die Liste der zugriffsberechtigten SSH-Schlüssel werden typischerweise für jedes Gerät individuell konfiguriert. Wenn ein Gerät ausfällt – aus welchem Grund auch immer – ist es für die Serviceleute vor Ort erheblich einfacher, wenn sie auf einen Blick sehen können, ob an diesem Standort bzw. an dem Gerät etwas besonderes eingestellt war.
Als Verein ist es uns wichtig, dass die von uns verantworteten Installationen auch dann noch betreut werden können, wenn derjenige nicht verfügbar ist, der die Geräte aufgebaut hat. Unser Backup Tool FCBT leistet dazu einen Beitrag.
Welche Geräte werden gesichert? Und welche nicht?
Grundsätzlich müssen drei Voraussetzungen erfüllt sein, damit wir ein Gerät in unseren Backupprozess aufnehmen:
- Es handelt sich um ein Gerät mit einer Firmware von Freifunk Nordhessen. Andere Geräte, die der Verein betreut, bspw. Richtfunkstrecken von Ubiquiti, laufen auf der sogenannten “Stock”-Firmware. Diese werden nicht über FCBT gesichert.
- Das zu sichernde Gerät muss in unserer Teams Cloud Dokumentation eingetragen sein.
- Auf dem zu sichernden Gerät muss unser vereinsseitiger SSH Servicekey hinterlegt sein.
Wo muss ich mein Gerät eintragen, damit es gesichert wird?
Vereinsmitglieder erhalten die Möglichkeit, die von ihnen betreuten Geräte in unserem Microsoft Teams Account zu hinterlegen. Unser Vereinsgebiet ist softwareseitig in verschiedene Regionen aufgeteilt, sogenannte Domänen.
Die Liste wächst regelmäßig an, die Grafik dient nur zu Veranschaulichung. Wie dem auch sei: innerhalb einer Domäne kann jedes Mitglied, dass dort Geräte betreibt, diese in einer eigenen Liste pflegen.
Machen wir es einmal konkret: Die Dokumentation für die Domäne “04 Bad Arolsen” enthält Listen von drei Operatoren, die im Stadtgebiet Accesspoints betreuen.
Zwingende Voraussetzung für den Zugriff auf diese Infrastruktur ist eine Vereinsmitgliedschaft und eine Verschwiegenheitserklärung. Der Aufwand hierfür ist schnell erklärt: Unsere Mitglieder stellen die wenigsten Accesspoints bei sich selbst auf – die allermeiste Hardware steht schlichtweg bei anderen Menschen. Und auch deren Kontaktdaten pflegen wir in diesen Listen – sei es der örtliche Schulhausmeister, der Betreuer vom Flüchtlingsheim oder die Telefonnummer von Tante Erna, die halt auch ein Gerät am Balkon hängen hat.
Zugang zu unserer Teams Cloud beantragt ihr per E-Mail direkt beim Vorstand.
Wie funktioniert diese Excel Liste?
Die benötigte Excel Vorlage für unser FCBT könnt ihr hier herunterladen.
Wir starten mit der Namenskonvention der Excel Datei: sie wir benannt nach dem Schema <Domäne>_<Adminkürzel>_<“routerliste”>.
Beispiel: Wenn du Tom Tester heißt und in der Domäne Bad Arolsen für den Verein Netzwerkinfrastruktur ausbringst, dann lautet deine Datei: badarolsen_tte_routerliste.xlsx. Wenn du jetzt die Datei in die Domäne hochlädst, für die du freigeschaltet bist, kann es im Prinzip schon losgehen.
Die Excel Vorlage kennt aktuell 22 Datenfelder. Sobald die Felder DeviceID und IP ausgefüllt sind, kann FCBT die Datei nutzen. Sofern FCBT Zugriff auf das Gerät hat, füllt es die folgenden 10 Datenfelder pro Gerät automatisch aus:
- Name des Geräts
- Outdoor Modus aktiviert
- zugehörige Domäne
- VPN Mesh aktiviert
- Speedlimit gesetzt
- Firmware Branch
- Autoupdate aktiviert
- Anzahl der hinterlegten SSH Keys
- Firmware Release
- Letztes Backup vom
Neben diesen 10 automatisch befüllten Datenfeldern gibt es weitere 10 Felder, die vom Vereinsmitglied ausgefüllt werden können. Die Felder sind optional, allerdings empfehlen wir, sie im Sinne der sauberen Dokumentation zu nutzen:
- Gerätetyp
- Eigentümer des Geräts (im Sinne vom: wem gehört es)
- In welchem Stadtteil/Ortsteil steht es
- An welcher Adresse steht es
- Wer ist der örtliche Ansprechpartner für das Vereinsmitglied
- Wie lautet die Telefonnummer des örtlichen Ansprechpartners
- Wie lautet die E-Mailadresse des örtlichen Ansprechpartners
- Bemerkung – was gibt es wissenswertes über dieses Gerät
- Link des Geräts auf die Freifunk Karte
- VLAN ID des Geräts (falls manuell gesetzt)
Was hat es mit diesem SSH Servicekey auf sich, den man installieren muss?
Unser offizieller Servicekey muss in /etc/dropbear/authorized_keys hinterlegt werden. Der SSH Key lautet:
ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDu6hqF6XZZchwCsbMn7qG5Wpf/ti2TpFhaWn6MBRLWa7QgcoeJVQ6g0RsvHAOx3sEHFZqw6kChodahixcdyMjPVU3iiuiRovyDwsJbRO9VYpY32Dwmufc2sNsAUR8AkA6bPpd7WhP3d/XDgVBrImqDwGUVK0DpMh/BBgEEnZS+/a5cMrH9nvKfQm0pR8DUnT+xusvr7FMR9PJ7dSXAdfVBVqqtE+rXbgYilAzkexEXarRwERT/fJPRvTETXOk2xkvR0OhHbqp+J0OzGPOnIp6SXCoh9vTe00IewXu+hPN8h3iZG57Avy52cblRniY+x3c0JbSaRq/KVMgLuZwl0pk4xusMrmeWOICYPdY1+cv7eBEP/HzrjRwfvQluPthqP/+eihdbBOUoqY36j8LerQ/hUlNQSvxM8hWGU6CASQH1rlA8xjhhWlqcDP9eoudPr2t5o3JaZGNpx3KQb1nWyrtMn3DvuxWMyPcWd7oOUkrB0yWd6HMCVq6Wzkj89pc6xslvtkJuK+QJRwQBoAfhLhkVv38Bq5k0t1len1MzNrNZPK8e7KwhdG1cusZEa0DFbfMii4nA/EWM8RCxxBDAcPMzAOPk3D60WoOgE1yai6KCTD0sYG5YcUC2cpz7To58glK9YejEtnvcAJ6YK/kVeaVCBBSzxKrVnrZ+AL43LyCB/Q== Freifunk Nordhessen Backup-Key
Wie man den Key auf dem jeweiligen Gerät installiert, haben wir hier ausführlich beschrieben.
FCBT und das Freifunk Nordhessen Support Wiki
Die automatisch erhobenen Daten aus dem Backupprozess werden auch in unser Wiki übertragen. Der Vorteil dabei ist: während die Excel-Listen für Kontaktdaten, Standorte und ein paar hilfreiche Bemerkungen ausgelegt sind, können wir im Wiki in beliebiger Tiefe ins Detail gehen – ohne jedoch Daten doppelt pflegen zu müssen.
FAQs zum Freifunk Config Backup Tool
Was muss ich machen, um das Tool nutzen zu können?
1) Beantrage Zugriff beim Vorstand, 2) Liste ausfüllen & hochladen, 3) SSH Key auf Geräten hinterlegen.
Muss ich auf meinen Accesspoints irgendwelche Software installieren?
Nein. Lediglich der SSH Key muss auf den zu sicherenden Geräten hinterlegt sein.
Meine Accesspoints stehen in der Liste drin, werden aber nicht gesichert. Was läuft schief?
In 9 von 10 Fällen gibt es ein Problem mit der IP. Ist der Node überhaupt online? Hast du die richtige IPv6 Adresse eingetragen? Hast du die IP so reinkopiert, dass zum Beispiel noch Leerzeichen oder HTML Steuerzeichen enthalten sind. Das soll nicht sein. In den restlichen Fällen ist der SSH Schlüssel nicht richtig hinterlegt.
Wo finde ich denn die Backups, die das Tool anlegt?
Sie liegen in unserer Teams Cloud: Dokumentation > Deine Domäne > backups > Hostname > Datum
Meine liebevoll gepflegte Excel-Datei wurde von FCBT kaputt gemacht. Was nun??
Vorgekommen ist das zwar bisher noch nicht, aber sollte es jemals soweit kommen, tröst dich damit, dass wir eine Versionierung aktiviert haben. Wir können versehntlich gelöschte, zerstörte oder sonstwie verhunzte Listen zurücksetzen.
Ich habe den Eindruck, dass FCBT beim Befüllen der Liste einen Fehler macht. Wem kann ich Bescheid geben?
Bitte wende dich in solchen Fällen an unseren Maintainer Andreas W. Ditze.