Aucune description

Helge Jung a5cee3bfb5 move ffpb.cfg to bot.cfg.example and require usage of 'bot.cfg' il y a 10 ans
modules 99e5719e6e convert to Python 3 il y a 10 ans
willie @ 015f8ae78e c6526821c7 add Python Willie IRC bot as submodule il y a 10 ans
.gitignore a5cee3bfb5 move ffpb.cfg to bot.cfg.example and require usage of 'bot.cfg' il y a 10 ans
.gitmodules c6526821c7 add Python Willie IRC bot as submodule il y a 10 ans
Readme.md b2d45380c0 adding ReadMe :) il y a 10 ans
bot.cfg.example a5cee3bfb5 move ffpb.cfg to bot.cfg.example and require usage of 'bot.cfg' il y a 10 ans
bot.sh a5cee3bfb5 move ffpb.cfg to bot.cfg.example and require usage of 'bot.cfg' il y a 10 ans

Readme.md

FFPB Status-Bot

Der Bot benötigt Python 3 und basiert auf "Willie" welcher unverändert als Git-Submodul eingebunden ist. Hinzugefügt wurde das Plugin "ffpb" und ein Startup-Skript.

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

Installation

Dieses Git-Repository wird an beliebiger Stelle geklont (diese Dokumentation geht von /opt/ffpb-statusbot aus):

git clone --recursive https://git.c3pb.de/freifunk-pb/status-bot.git /opt/ffpb-statusbot

Das Start-Up-Skript erfordert einen der Parameter "start", "stop" oder "status" und eignet sich als Init-Skript:

ln -s /opt/ffpb-statusbot/bot.sh /etc/init.d/ffpb-statusbot
update-rc.d ffpb-statusbot enable

Konfiguration

Die Datei bot.cfg.example enthält eine Beispiel-Konfiguration und muss für die Benutzung nach bot.cfg kopiert und angepasst werden. Die wichtigsten Parameter sind nachfolgend erklärt:

core

Willie-Standardkonfiguration (siehe auch)

Parameter Typ Beschreibung
nick String Nickname des Bots
user String Benutzername gegenüber dem IRC-Server
name String "Real Name" des Bots im IRC
host String Host des IRC-Servers
port Integer Port des IRC-Servers
owner String Nickname des Besitzer des Bots
admins Liste weiterer Bot-Admins (kommasepariert, keine Leerzeichen um das Komma setzen!)
channels Liste IRC-Channel die der Bot betritt

ffpb

Parameter für das ffpb-Zusatzmodul

Parameter Typ Beschreibung
msg_enable Boolean Soll der Messaging-Server aktiviert werden?
msg_port Integer TCP-Port auf dem der Messaging-Server lauscht (Default = 2342)
msg_target String Nutzer/Raum zu dem die Messaging-Zeilen geschickt werden