diff --git a/.gitignore b/.gitignore index cdecf3f..2a09fea 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,4 @@ node_modules .idea/ *.swp config.json +README.html diff --git a/README.md b/README.md index 16213d2..9147b90 100644 --- a/README.md +++ b/README.md @@ -1 +1,91 @@ -README will be added soon... +# ffffng – Freifunk Knotenverwaltung + + +## Motivation / Disclaimer + +TODO + + +## Features + +TODO + + +## Screenshots + +### Startseite der Knotenverwaltung + +![](doc/start.png?raw=true "Startseite der Knotenverwaltung") + + +### Formular zur Erfassung der Knotendaten + +![](doc/knotendaten.png?raw=true "Formular zur Erfassung der Knotendaten") + + +### Option zum automatischen Versand von Monitoring-E-Mails + +![](doc/monitoring.png?raw=true "Option zum automatischen Versand von Monitoring-E-Mails") + + +### Bestätigungsseite nach dem Speichern + +![](doc/geschafft.png?raw=true "Bestätigungsseite nach dem Speichern") + + +### Statistiken im Admin-Panel + +![](doc/admin-statistik.png?raw=true "Statistiken im Admin-Panel") + + +### Knotenübersicht im Admin-Panel + +![](doc/admin-knoten.png?raw=true "Knotenübersicht im Admin-Panel") + + +## Installation / Konfiguration + +TODO + + +## Administration + +Das Admin-Panel ist dann entsprechend erreichbar unter: [https://formular.musterstadt.freifunk.net/internal/admin](). +(Die Domain muss natürlich angepasst werden.) + +Das Admin-Panel besteht aus folgenden Bereichen: + +* Dashboard / Statistics: Übersichtsseite. +* Nodes: Liste aller in der Knotenverwaltung registrierten Knoten. +* Monitoring: Liste aller aus der Karte bekannten Knoten inkl. Online- und Monitoring-Status. +* Mail-Queue: Liste der als nächste zu versendenden E-Mails. E-Mails werden bis zu 5 mal versucht zu versenden. Sollte + der Versand dann immer noch nicht geklappt haben, können sie hier gelöscht oder resettet werden (werden dann erneut + versendet). +* Background-Jobs: Übersicht über alle in der Knotenverwaltung laufenden Background-Jobs. Diese können dort bei Bedarf + auch manuell gestartet, aktiviert und deaktiviert werden. **ACHTUNG**, das Deaktivieren von Jobs kann dazu führen, + dass die Knotenverwaltung nicht mehr korrekt arbeitet. Die Jobs bleiben nur bis zum nächsten Neustart des Servers + deaktiviert. +* Logs: Verlinkung auf eine Übersicht der Knotenverwaltungs-Logs. Diese ist nicht wirklich stabil und kann bei großen + Log-Dateien schnell den Browser überfordern. + + +## gluon Config-Mode + +Soll das Formular zum Anlegen neuer Knoten im gluon Config-Mode verlinkt werden, so bietet es sich an, die +Übersetzungsdateien der Firmware unter `i18n/` so ähnlich wie hier unten anzupassen: + +``` +msgid "gluon-config-mode:pubkey" +msgstr "" +... +"&key=<%=pubkey%>&mac=<%= sysconfig.primary_mac %>\" target=\"_blank\">https://formular.musterstadt.freifunk.net/ ein.

" +"
" +" # <%= hostname %>" +"
" +"<%= pubkey %>" +... +"
" +``` + +Auf diese Weise landet der Nutzer direkt im teilweise vorausgefüllten Formular und muss nicht mehr den Knotennamen, +fastd-Key und die MAC-Adresse angeben. diff --git a/doc/admin-knoten.png b/doc/admin-knoten.png new file mode 100644 index 0000000..dd4802d Binary files /dev/null and b/doc/admin-knoten.png differ diff --git a/doc/admin-statistik.png b/doc/admin-statistik.png new file mode 100644 index 0000000..1136290 Binary files /dev/null and b/doc/admin-statistik.png differ diff --git a/doc/geschafft.png b/doc/geschafft.png new file mode 100644 index 0000000..a0cbf5c Binary files /dev/null and b/doc/geschafft.png differ diff --git a/doc/knotendaten.png b/doc/knotendaten.png new file mode 100644 index 0000000..dd8b409 Binary files /dev/null and b/doc/knotendaten.png differ diff --git a/doc/monitoring.png b/doc/monitoring.png new file mode 100644 index 0000000..78e1b7c Binary files /dev/null and b/doc/monitoring.png differ diff --git a/doc/start.png b/doc/start.png new file mode 100644 index 0000000..6c7cc7c Binary files /dev/null and b/doc/start.png differ