Browse Source

update documentation

Helge Jung 5 years ago
parent
commit
44d0751d98
2 changed files with 25 additions and 7 deletions
  1. 17 0
      Readme.md
  2. 8 7
      bot.cfg.example

+ 17 - 0
Readme.md

@@ -26,6 +26,23 @@ Der Bot geht davon aus, dass er in einem "Maschinenraum"-IRC-Channel arbeitet -
     * Neuladen des FFPB-Moduls: `!reload ffpb`
     * Nachricht in Channel schreiben: `!msg #channel Nachricht`
 
+## Module
+
+### ffpb
+
+Stellt Kern-Funktionalitäten bereit wie z.B. die periodische Abfrage der aktuellen ALFRED-Daten, Mapping von Name/MAC zu Knoten-Info, etc.
+
+### ffpb-monitoring
+
+Monitoring-Funktionen - periodischer Ping von Knoten sowie das Management-Kommando `!monitor`.
+### ffpb-netstatus
+
+Funktionen, die den Status des Netzwerks betreffen - z.B. `!status` und `!highscore`.
+
+### ffpb-nodeinfo
+
+Funktionen, die Auskunft über einzelne Knoten geben - z.B. `!info` und `!mesh`.
+
 ## Installation
 
 Dieses Git-Repository wird an beliebiger Stelle geklont (diese Dokumentation geht von /opt/ffpb-statusbot aus):

+ 8 - 7
bot.cfg.example

@@ -1,7 +1,7 @@
 [core]
-nick = ffpb-status
-user = ffpb-statusbot
-name = Status-Bot von Freifunk Paderborn - http://paderborn.freifunk.net
+nick = nick-des-bots
+user = botuser
+name = unser Status-Bot
 
 #host = irc.hackint.org
 host = kthx.de
@@ -10,12 +10,12 @@ use_ssl = True
 verify_ssl = False
 port = 9999
 
-owner = HeJ
-admins = oscar-, Barbarossa
+owner = bernd
+admins = alice, bob
 
 channels = #ffpb
 prefix = !
-enable = admin,ffpb,ffpb_fun,reload
+enable = admin,ffpb,ffpb_fun,ffpb_monitoring,ffpb_netstatus,ffpb_nodeinfo,reload
 timeout = 120
 
 extra = modules/
@@ -29,4 +29,5 @@ userdb_file = ffpb.sqlite
 [ffpb]
 msg_enable = 1
 msg_port = 2342
-msg_target = #ffpb
+msg_target = #ffpb-gurus
+msg_target_public = #ffpb