First shot for the README
This commit is contained in:
parent
0309d8906a
commit
e166ac009b
1
.gitignore
vendored
1
.gitignore
vendored
|
@ -6,3 +6,4 @@ node_modules
|
||||||
.idea/
|
.idea/
|
||||||
*.swp
|
*.swp
|
||||||
config.json
|
config.json
|
||||||
|
README.html
|
||||||
|
|
92
README.md
92
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 ""
|
||||||
|
...
|
||||||
|
"<a href=\"https://formular.musterstadt.freifunk.net/#/new?hostname=<%=hostname%>&key=<%=pubkey%>&mac=<%= sysconfig.primary_mac %>\" target=\"_blank\">https://formular.musterstadt.freifunk.net/</a> ein.</p>"
|
||||||
|
"<div class=\"the-key\">"
|
||||||
|
" # <%= hostname %>"
|
||||||
|
" <br/>"
|
||||||
|
"<%= pubkey %>"
|
||||||
|
...
|
||||||
|
"</div>"
|
||||||
|
```
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
BIN
doc/admin-knoten.png
Normal file
BIN
doc/admin-knoten.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 202 KiB |
BIN
doc/admin-statistik.png
Normal file
BIN
doc/admin-statistik.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 55 KiB |
BIN
doc/geschafft.png
Normal file
BIN
doc/geschafft.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 77 KiB |
BIN
doc/knotendaten.png
Normal file
BIN
doc/knotendaten.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 539 KiB |
BIN
doc/monitoring.png
Normal file
BIN
doc/monitoring.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 115 KiB |
BIN
doc/start.png
Normal file
BIN
doc/start.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 57 KiB |
Loading…
Reference in a new issue