|
|
@@ -1,15 +1,30 @@
|
|
|
# FFPB Status-Bot
|
|
|
|
|
|
-Der Bot benötigt Python 2 und basiert auf ["Willie"](http://willie.dftba.net) welcher unverändert als Git-Submodul eingebunden ist. Hinzugefügt wurde das Plugin "[ffpb](modules/ffpb.py)" und ein [Startup-Skript](bot.sh).
|
|
|
+Der Bot benötigt Python 2 und basiert auf ["Willie"](http://willie.dftba.net) welcher unverändert als Git-Submodul eingebunden ist. Hinzugefügt wurden mehrere Plugins (Haupt-Modul: "[ffpb](modules/ffpb.py)") und ein [Startup-Skript](bot.sh).
|
|
|
+
|
|
|
+Der Bot geht davon aus, dass er in einem "Maschinenraum"-IRC-Channel arbeitet - kann jedoch zusätzlich Informationen in einem öffentlichen Kanal bereitstellen. Die im Bot konfigurierten Admins haben erweiterte Berechtigungen auch in den ffpb-Plugins, wie z.B. Remote-Execution auf allen Knoten (sofern der SSH-Key des Bots dort hinterlegt ist).
|
|
|
|
|
|
## Funktionen
|
|
|
|
|
|
-1. Status zum Netz `!status`
|
|
|
-2. Ping von Peers `!ping ffpb-dev2`
|
|
|
-3. Remote-Execution auf Peers `!exec-on-peer ffpb-dev uptime`
|
|
|
-4. Willie-Standardfunktionen für owner/admin:
|
|
|
- * Neuladen des FFPB-Moduls: `!reload ffpb`
|
|
|
- * Nachricht in Channel schreiben: `!msg #channel Nachricht`
|
|
|
+1. Status-Abruf
|
|
|
+ * periodischer Abruf von nodes.json und ALFRED-Daten
|
|
|
+ * Anzahl Knoten und Clients: `!status`
|
|
|
+ * Highscore #Knoten und #Clients: `!highscore`
|
|
|
+2. Knoten-Information
|
|
|
+ * allg. Infos (insb. aus ALFRED): `!info <peer>`
|
|
|
+ * MAC und Link zur Statusseite: `!link <peer>`
|
|
|
+3. Knoten-Aktionen
|
|
|
+ * Ping von Peers: `!ping <peer>`
|
|
|
+ * Remote-Execution auf Peers: `!exec-on-peer <peer> <command>` (hierzu muss der SSH-Key des Bots auf dem Knoten hinterlegt sein)
|
|
|
+4. Monitoring
|
|
|
+ * Verwaltung: `!monitor add <peer>` bzw. `!monitor del <peer>`
|
|
|
+ * periodischer Ping aller Peers, Meldung falls sich eine Änderung ergibt
|
|
|
+5. Messaging
|
|
|
+ * bei entsprechender Konfiguration öffnet der Bot einen TCP-Port, die erste Zeile einer eingehenden Verbindung wird in den Channel geschickt
|
|
|
+ * Meldungen die mit "PUBLIC: " beginnen werden, sofern vorhanden, in den öffentlichen Kanal gepostet (ohne den Marker)
|
|
|
+6. Willie-Standardfunktionen für owner/admin:
|
|
|
+ * Neuladen des FFPB-Moduls: `!reload ffpb`
|
|
|
+ * Nachricht in Channel schreiben: `!msg #channel Nachricht`
|
|
|
|
|
|
## Installation
|
|
|
|
