forked from freifunk-franken/docs
WIP: Add firmware installation guide
Mostly merged from - https://wiki.freifunk-franken.de/w/Firmware_installieren - https://wiki.freifunk-franken.de/w/Firmware_aktualisieren .. but heavily revised.
This commit is contained in:
parent
6b56b1a9a9
commit
6194a25055
|
|
@ -0,0 +1,30 @@
|
|||
---
|
||||
title: "Einleitung"
|
||||
date: 2022-11-17T23:07:49+01:00
|
||||
---
|
||||
|
||||
## Der wichtigste Hinweis zuerst
|
||||
{{< hint info >}}
|
||||
Einen Freifunkrouter stellt man nicht einfach hin und überlässt ihn sich selbst – wie es eigentlich für sämtliche am Internet angeschlossene Geräte gilt, wenn es auch oft genug nicht beachtet wird –, sondern man übernimmt langfristig Verantwortung, vor allem was regelmäßige Updates und Übernahme größerer Änderungen im Netzwerk angeht. Diese werden mit hinreichend großem Vorlauf angekündigt. Wenn diese trotzdem nicht beachtet werden, läuft man Gefahr, dass der Router irgendwann nicht mehr funktioniert oder, wenn er Störungen im Netz produziert, gesperrt wird. Das gilt gerade auch für Freifunkrouter, wo eigene Modifikationen – die wir explizit unterstützen, solange sie das Netz nicht stören und kompatibel zu unseren Netz sind – vorgenommen wurden.
|
||||
|
||||
**Der Routeraufsteller/Betreiber ist für seinen Router verantwortlich. Dies gilt auch für Einstellungen wie beispielsweise die Sendeleistung.**
|
||||
|
||||
Auch sollte man zumindest grundlegendes Interesse an der Technik mitbringen. Aber keine Panik: Freifunkrouter sind im Allgemeinen sehr pflegeleicht.
|
||||
|
||||
Durch das Betreiben eines Freifunkrouters stimmt man dem [Pico Peering Agreement](https://wiki.freifunk-franken.de/w/PicoPeeringAgreement) (PPA) zu.
|
||||
{{< /hint >}}
|
||||
|
||||
## Hardware auswählen
|
||||
|
||||
Die [Hardwareseite](https://wiki.freifunk-franken.de/w/Hardware) enthält eine Liste unserer unterstützten Geräte.
|
||||
|
||||
Wenn du dir nicht sicher bist welche Hardware für deinen Anwendungszweck gut geeignet ist, nimm [Kontakt](https://wiki.freifunk-franken.de/w/Kommunikation) mit der Community auf, um ein passendes Modell zu finden.
|
||||
|
||||
## Firmware-Variante auswählen
|
||||
|
||||
Seit dem Firmware-Release 20191224 vom 24.12.2019 gibt es nun 2 verschiedene Varianten der Firmware:
|
||||
|
||||
- die [Layer-3 Firmware](https://wiki.freifunk-franken.de/w/Layer_3_Firmware), für dezentrale Router
|
||||
- die Node Firmware, die mit dem zentralen [KeyXchange v2](https://wiki.freifunk-franken.de/w/KeyXchangeV2) läuft
|
||||
|
||||
Vorteile und Nachteile von "zentral" und "dezentral" werden [hier](https://wiki.freifunk-franken.de/w/Layer_3_Firmware#Redundanz) beschrieben.
|
||||
|
|
@ -0,0 +1,42 @@
|
|||
---
|
||||
title: "Installation"
|
||||
date: 2022-11-17T23:07:49+01:00
|
||||
---
|
||||
|
||||
## Einleitung
|
||||
|
||||
## OpenWrt Installationsanleitung
|
||||
Da die Freifunk Franken Firmware auf OpenWrt basiert, kann jedes unterstützte Gerät auch nach der OpenWrt-Anleitung erstinstalliert werden.
|
||||
|
||||
Deshalb ist es häufig hilfreich auch die Geräteseite im [OpenWrt-Wiki](https://openwrt.org/toh/start) im Blick zu haben.
|
||||
|
||||
## Gerätespezifische Installationsanleitung
|
||||
Die Installation ist je nach Modell sehr unterschiedlich, hier eine Liste diverser Modelle:
|
||||
|
||||
### Ubiquiti
|
||||
- [EdgeRouter-X / EdgeRouter-X-SFP / EdgePoint-R6](/firmware/hardware/ubiquiti-edgerouter-x/)
|
||||
- [EdgeRouter 4](https://wiki.freifunk-franken.de/w/Firmwareinstallation/edgerouter4)
|
||||
- [AP-AC-Mesh](https://wiki.freifunk-franken.de/w/Firmwareinstallation/UbiquitiUnifiACMesh)
|
||||
- [Diverse weitere Geräte](https://wiki.freifunk-franken.de/w/Firmwareinstallation/Ubiquiti)
|
||||
|
||||
### AVM
|
||||
- [FRITZ!Box 4040](Firmwareinstallation/Fritzbox_4040 "wikilink")
|
||||
|
||||
### Xiaomi
|
||||
- [Mi Router 4A (Gigabit)](Firmwareinstallation/Xiaomi_Mi_Router_4A "wikilink")
|
||||
|
||||
### TP-Link
|
||||
- [TL-WR841 und TL-WR1043](Firmwareinstallation/wr841 "wikilink") (gilt für viele TP-Link Geräte)
|
||||
|
||||
### GL.inet
|
||||
- [GL-AR150](Firmwareinstallation/GL-Inet_AR-150 "wikilink")
|
||||
|
||||
### x86
|
||||
- [x86 PC und VM](Firmwareinstallation/x86 "wikilink")
|
||||
|
||||
|
||||
Die Liste ist nicht abschließend und darf gerne erweitert werden. Allgemein ist es sehr hilfreich im [OpenWrt](OpenWrt "wikilink")-Wiki zu gucken, dort wird eigentlich für jedes Gerät eine Installationsanleitung angeboten. Da unsere Firmware auf OpenWrt basiert, ist ein Flashen nach dieser Anleitung immer möglich, erst ab der Einrichtung/Konfiguration unterscheidet sich die Freifunk Franken Firmware deutlich von OpenWrt.
|
||||
|
||||
## Nach der Installation
|
||||
Nach erfolgreicher Installation muss die Firmware konfiguriert werden.
|
||||
[Hier gehts weiter](/firmware/konfiguration/).
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
---
|
||||
title: "Konfiguration"
|
||||
date: 2022-11-17T23:07:49+01:00
|
||||
---
|
||||
|
||||
## Einleitung
|
||||
Nach erfolgreicher Installation der Firmware muss diese noch für den eigenen Anwendungszweck konfiguriert werden.
|
||||
|
||||
|
||||
## Varianten-spezifische Konfiguration
|
||||
|
||||
### Layer-3
|
||||
Dies ist aktuell hier beschrieben:
|
||||
|
||||
- [Ablauf einer Installation](Layer3Firmware#Typischer_Ablauf_einer_Installation "wikilink")
|
||||
- [Schritt für Schritt Anleitung](Anbindung#Anbindung_an_das_Layer-3_Netz "wikilink")
|
||||
|
||||
Zur Konfiguration gibt es hier eine Hilfe:
|
||||
|
||||
- [Layer-3 Firmware Konfiguration](Layer3Firmware_Config "wikilink")
|
||||
|
||||
### Node Firmware
|
||||
- [Node Firmware](Anleitungen/Node_Firmware "wikilink")
|
||||
|
||||
## Probleme bei der Konfiguration
|
||||
Melde dich bei unserer Mailingliste! Die Infos dazu gibt es unter [Kommunikation](Portal:Kommunikation "wikilink"). Dort gibt es auch Hilfe und Support bei der Installation.
|
||||
|
||||
## Nach der Konfiguration
|
||||
Lerne das Freifunknetz und die Community kennen! Finde heraus, wie das Netz funktioniert, und wie du daraus einen Nutzen ziehen kannst.
|
||||
Versuche dich mit Nachbarn zu verbinden, baue dazu [Richtfunkstrecken](Richtfunk "wikilink") auf oder wirf einfach ein Kabel über den Gartenzaun.
|
||||
|
||||
Denke daran deinen Router auf dem aktuellen Stand zu halten, in dem du regelmäßig die [Firmware aktualisiert](/firmware/update/).
|
||||
|
|
@ -0,0 +1,108 @@
|
|||
---
|
||||
title: "Update"
|
||||
date: 2022-11-17T23:07:49+01:00
|
||||
---
|
||||
|
||||
## Einleitung
|
||||
Bitte halte deinen Router auf einem aktuellen Stand. Ein altes System kann Sicherheitslücken enthalten und Probleme für dich, aber auch für andere Freiunk-Teilnehmer verursachen. Dies gilt eigentlich sowieso für alle an das Internet angeschlossen Geräte, aber es schadet nicht das einmal häufiger zu erwähnen.
|
||||
|
||||
- [Anleitung:FirmwareUpdate](https://wiki.freifunk-franken.de/w/Anleitung:FirmwareUpdate)
|
||||
- [Gefahren beim Update von Keyxchange v1 auf v2](https://wiki.freifunk-franken.de/w/KeyXchangeV2#Gefahren_eines_Updates_vom_alten_System)
|
||||
|
||||
Die Freifunk Franken Firmware hat keinen Autoupdater. Wir erwarten von jedem Freifunker, der einen Freifunkrouter betreibt, dass er sich um seinen Router kümmert. Du bist für deinen Router selbst verantwortlich.
|
||||
|
||||
## Aktuelle Version herausfinden
|
||||
Welche Firmwareversion installiert ist kann entweder dem [Monitoring](https://monitoring.freifunk-franken.de/) oder dem Webinterface des Routers entnommen werden.
|
||||
Außerdem wird die aktuelle installierte Version auch beim [Verbinden per SSH](https://wiki.freifunk-franken.de/w/Anleitungen#SSH) im Banner angezeigt.
|
||||
|
||||
## Vor dem Update
|
||||
Bei diversen älteren Firmware-Versionen gab es kleinere Bugs oder Gemeinheiten, die beim Update beachtet werden müssen.
|
||||
Vor dem Update müssen daher unbedingt die [versionsspezifischen Hinweise](Anleitung:FirmwareUpdate#Besonderheiten_beim_Update "wikilink") für die aktuelle Version des Routers und die Zielversion des Updates gelesen werden.
|
||||
|
||||
Bei einem Update wird **sämtliche OpenWrt Konfiguration** (sowie auch alle anderen Dateien) **verworfen** und aus der Freifunk Konfiguration neu erzeugt. Per Kommandozeile erfolgte manuelle Anpassungen an der OpenWrt Konfiguration müssen nach dem Update erneut vorgenommen werden.
|
||||
|
||||
## Update herunterladen
|
||||
Egal welche Variante gewählt wird: Wenn bereits eine frühere Freifunk Franken Firmware oder ein anderes OpenWrt auf dem Gerät installiert ist muss immer das **`sysupgrade`** Firmware-Image verwendet werden.
|
||||
|
||||
Die **`sysupgrade`** Firmware-Images können für beide Firmware-Varianten auf [dev.freifunk-franken.de](https://dev.freifunk-franken.de) heruntergeladen werden und sind auch auf den [Geräteseiten](/firmware/hardware) verlinkt.
|
||||
|
||||
## Update installieren
|
||||
Es gibt drei Möglichkeiten die aktuellste Version zu installieren
|
||||
- Über das Webinterface
|
||||
- Über die Kommandozeile (automatisch)
|
||||
- Über die Kommandozeile (manuell)
|
||||
|
||||
In jedem Fall muss der Router erreichbar sein, damit das Webinterface oder die Kommandozeile geöffnet werden können.
|
||||
Dazu muss der eigene Rechner mit den Freifunk-Netz verbunden sein.
|
||||
|
||||
Mit dem Webinterface oder der Kommandozeile verbinden: [Anleitung](https://wiki.freifunk-franken.de/w/Anleitungen#Zugriff_auf_den_Router)
|
||||
|
||||
### Möglichkeit 1: Webinterface
|
||||
1. Webinterface öffnen und einloggen
|
||||
2. Im Menü auf `Upgrade` klicken
|
||||
3. Das sysupgrade Firmware-Image hochladen
|
||||
4. `Upgrade`-Button klicken
|
||||
|
||||
Die Option **`Konfiguration behalten`** bewirkt, dass alle Freifunk-Einstellungen (Passwort, Position, Beschreibung etc.) beim Update übernommen werden.
|
||||
|
||||
|
||||
### Möglichkeit 2: Update-Skript
|
||||
Dies ist die schnellste Möglichkeit die aktuellste Version zu installieren, da der Router die Firmware selbstständig herunterlädt.
|
||||
Die Freifunk-Einstellungen werden immer übernommen.
|
||||
|
||||
1. Per SSH auf dem Router einloggen
|
||||
2. `fff-upgrade.sh` ausführen
|
||||
3. Rückfragen mit `y`/`n` und `Enter` bestätigen
|
||||
|
||||
Selten kann es passieren, dass der Router das Firmware-Image nicht findet. Dabei handelt es sich um einen gerätespezifischen Bug. Bitte an die Community melden, am besten per E-Mail.
|
||||
|
||||
### Möglichkeit 3: Kommandozeile
|
||||
Zuerst die Firmware per SCP auf den Router kopieren:
|
||||
{{< tabs "uniqueid" >}}
|
||||
{{< tab "Windows" >}}
|
||||
Die Firmware kann mit [WinSCP](https://winscp.net/eng/download.php) auf den Router kopiert werden
|
||||
|
||||
1. WinSCP starten und als Übertragungsprotokoll `SCP` währen
|
||||
2. Die IP-Adresse des Routers eintragen
|
||||
3. Zugangsdaten eintragen (User: `root`)
|
||||
4. Die Firmware per Drag-and-Drop in das Verzeichnis `/tmp` auf dem Router kopieren
|
||||
|
||||
TODO: Bild einfügen: Winscp-connection-settings.jpg
|
||||
TODO: Bild einfügen: Winscp-copy-firmware.jpg
|
||||
|
||||
Statt WinSCP kann auch [PSCP](http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html) verwendet werden:
|
||||
```sh
|
||||
pscp -scp -6 fff-variante-version-geraet-sysupgrade.bin root@[fdff::1]:/tmp/firmware.bin
|
||||
```
|
||||
{{< /tab >}}
|
||||
{{< tab "macOS" >}}
|
||||
Im Terminal ausführen:
|
||||
```sh
|
||||
scp ~/Downloads/fff-variante-version-geraet-sysupgrade.bin root@[fdff::1]:/tmp/firmware.bin
|
||||
```
|
||||
{{< /tab >}}
|
||||
{{< tab "Linux" >}}
|
||||
Im Terminal ausführen:
|
||||
```sh
|
||||
scp -O ~/Downloads/fff-variante-version-geraet-sysupgrade.bin root@[fdff::1]:/tmp/firmware.bin
|
||||
```
|
||||
|
||||
Die Option `-O` ist bei aktuellen Versionen von OpenSSH nötig, da sonst `sftp` für die Übertragung genutzt wird, was mit OpenWrt aber nicht funktioniert.
|
||||
{{< /tab >}}
|
||||
{{< tab "Direktdownload" >}}
|
||||
1. Per SSH auf dem Router einloggen
|
||||
2. Das Verzeichnis `/tmp` öffnen
|
||||
3. Firmware herunterladen
|
||||
```sh
|
||||
cd /tmp
|
||||
curl -o firmware.bin https://dev.freifunk-franken.de/layer3/current/fff-variante-version-geraet-sysupgrade.bin
|
||||
```
|
||||
{{< /tab >}}
|
||||
{{< /tabs >}}
|
||||
|
||||
Das Image auf dem Gerät installieren:
|
||||
1. Per SSH auf dem Router einloggen
|
||||
2. `sysupgrade /tmp/firmware.bin` ausführen
|
||||
|
||||
Die Einstellungen werden dabei behalten.
|
||||
Mit `sysupgrade -n /tmp/firmware.bin` wird die Firmware installiert und die Einstellungen verworfen.
|
||||
Loading…
Reference in New Issue