GroupButler Download - GroupButler Quellcode Download

GroupButler

AI-Quellcode

1.0.0

Herunterladen

Gruppe Butler

Kurze Einführung

Group Butler hilft Menschen, ihre Gruppen zu verwalten und umfasst viele andere nützliche Tools.

Gruppe Butler wurde als Otouto V3.1 ( @mokubot ) geboren, wurde aber seitdem in einen Verwaltungsbot verwandelt.

Gruppe Butler auf Telegramm:

@GroupButler_bot
- Zweig : master
- Kanal : @GroupButler_ch .
@GBReborn_bot
- Zweig : develop
- Kanal : @GroupButler_beta .

Aufstellen

Schauen Sie sich zunächst Ihre Bot -Einstellungen an

Stellen Sie sicher, dass die Privatsphäre deaktiviert ist (weitere Informationen finden Sie auf der FAQ -Seite der offiziellen Bots). Senden /setprivacy an @BotFather senden, um den aktuellen Status dieser Einstellung zu überprüfen.

Erstellen Sie eine einfache Textdatei mit dem Namen .env mit Folgendem:

Setzen Sie TG_TOKEN auf das Authentifizierungs -Token, das Sie von @BotFather erhalten haben.
Stellen Sie SUPERADMINS als JSON -Array mit Ihrer numerischen Telegramm -ID ein. Andere Superadmins können ebenfalls hinzugefügt werden. Es ist wichtig, dass Sie die numerische ID und keine Zeichenfolge einfügen.
Setzen Sie LOG_CHAT (die ID des Chats, in der der Bot alle aus Telegramm empfangenen schlechten Anfragen sendet) und Ihr LOG_ADMIN (die ID des Benutzers, die Ausführungsfehler erhält).

Ihre .env -Datei sollte jetzt etwas so aussehen:

 TG_TOKEN=123456789:ABCDefGhw3gUmZOq36-D_46_AMwGBsfefbcQ
SUPERADMINS=[12345678]
LOG_CHAT=12345678
LOG_ADMIN=12345678

Setup (mit Docker)

Anforderungen:

Docker 18.02.0-CE
Docker-Compose 1.21.0
Optional: Docker Swarm Cluster für die Bereitstellung

Ausführen (Dev -Modus)

Run make dev_polling . Docker wird die erforderlichen Bilder ziehen und erstellen, sodass Sie diesen Befehl zum ersten Mal ausführen sollten. Danach sollte der Bot in Betrieb sein.

Der Code ist auf dem Bot -Container montiert, sodass Sie Änderungen vornehmen und den Bot wie gewohnt neu starten können.

Redis Standard -Port ist zum Host montiert, nur für den Fall, dass Sie etwas mithilfe von Tools, die im Host verfügbar sind, debuggen möchten.

Der Redis -Container ist im Develmodus nicht auf persistische Daten festgelegt .

Laufen (Produktionsmodus)

Es gibt eine Reihe von Möglichkeiten, wie Sie Docker für die Bereitstellung in die Produktion verwenden können.

Dateien mit dem Namen docker-compose.*.yml docker-compose.yml

Der Bot unterstützt auch das Lesen von Docker -Geheimnissen (kann auch mit anderen Gewölben funktionieren). Überprüfen Sie lua/config.lua um zu sehen, welche Variablen aus Geheimnissen gelesen werden können.

Beispiel

Sie können Group Butler durch Ausführen bereitstellen:

make easy_deploy

Schwarm Beispiel

Angenommen, Sie haben Redis in z. B. staging ( docker stack deploy … oder docker service create … ) eingesetzt und die erforderlichen Umgebungsvariablen (wie $TG_TOKEN …) exportiert, können Sie Group Butler durch Ausführen bereitstellen:

docker stack deploy staging -c docker-compose.yml

Setup (ohne Docker)

Liste der erforderlichen Pakete:

libreadline-dev
redis-server
lua5.1
liblua5.1dev
libssl-dev
git
make
unzip
curl
libcurl4-gnutls-dev

Sie benötigen auch einige andere LuA -Module, die über den Lua -Paketmanager Luarocks installiert werden können (und sollten).

Installation

Sie können Group Butler problemlos installieren, indem Sie die folgenden Befehle ausführen:

 # Tested on Ubuntu 16.04

$ wget https://raw.githubusercontent.com/group-butler/GroupButler/master/install.sh
$ bash install.sh

oder

 # Tested on Ubuntu 14.04, 15.04 and 16.04, Debian 7, Linux Mint 17.2

$ sudo apt-get update
$ sudo apt-get upgrade
$ sudo apt-get install libreadline-dev libssl-dev lua5.1 liblua5.1-dev git make unzip redis-server curl libcurl4-gnutls-dev

# We are going now to install LuaRocks and the required Lua modules

$ wget http://luarocks.org/releases/luarocks-2.2.2.tar.gz
$ tar zxpf luarocks-2.2.2.tar.gz
$ cd luarocks-2.2.2
$ ./configure ; sudo make bootstrap
$ sudo luarocks install luasec
$ sudo luarocks install luasocket
$ sudo luarocks install redis-lua
$ sudo luarocks install lua-term
$ sudo luarocks install serpent
$ sudo luarocks install lua-cjson
$ sudo luarocks install Lua-cURL
$ cd ..

# Clone the repository and give the launch script permissions to be executed
# If you want to clone the beta branch, use git clone with the [-b beta] option

$ git clone https://github.com/group-butler/GroupButler.git
$ cd GroupButler
$ sudo chmod +x launch.sh

Bevor Sie den Bot starten, müssen Sie den Redis -Prozess starten.

 # Start Redis

$ sudo service redis-server start

Den Prozess starten

Um den Bot zu starten, rennen Sie ./launch.sh . Um den Bot zu stoppen, drücken Sie zweimal die Steuerung Strg + C.

Sie können den Bot auch mit ./polling.lua starten, er wird jedoch nicht automatisch neu gestartet. Sie müssen auch eine andere Möglichkeit finden, um die erforderlichen Umgebungsvariablen zu exportieren.

Etwas, das Sie vor dem Ausführen des Bots kennen sollten

Sie können einige Einstellungen des Bots ändern. Alle Einstellungen sind in config.lua in der Tabelle bot_settings platziert
- cache_time.adminlist : Die Beständigkeit in Sekunden der Administratorliste im Cache. Der Bot rehrt die Administratorliste vor, um zu vermeiden, dass Telegrammgrenzen eingehen
- notify_bug : Wenn true , sendet der Bot eine Nachricht, die benachrichtigt, dass ein Fehler dem aktuellen Benutzer aufgetreten ist, wenn ein Plugin ausgeführt wird und ein Fehler auftritt
- log_api_errors : Wenn true , sendet der Bot alle relevanten Fehler in LOG_CHAT , die von einer API -Anfrage nach Telegramm zurückgegeben wurden
- stream_commands : Wenn ein Update ein true auslöst, wird das Spiel auf der Konsole gedruckt
Es gibt einige andere nützliche Felder, die zu .Env hinzugefügt werden können, die Sie beispielsweise in config.lua finden können
- REDIS_DB : Die ausgewählte Redis -Datenbank (wenn Sie Redis mit der Standardkonfiguration ausführen, sind die verfügbaren Datenbanken 16). Die Datenbank wird auf jedem Start/Reload ausgewählt. Standard: 0
Andere Dinge, die nützlich sein können
- Die Befehle von Administratoren beginnen für $ . Sie sind nicht dokumentiert, sehen Sie sich die Auslöser von plugins/admin.lua -Plugin für die gesamte Liste an
- Wenn die Hauptfunktion eines Plugins true zurückgibt, versucht plugins Bot weiter
- Sie können sich mit dem $backup -Befehl eine Sicherung des Ordners Reißverschluss schicken
- Die Telegramm -Bot -API hat einige "seltsame Verhaltensweisen" ohne Papiere, die Sie bei der Verwendung dieses Bots möglicherweise bemerken,
  - In Supergroups gibt die kickChatMember -Methode immer eine positive Antwort zurück, wenn der user_id mindestens einmal Teil der Gruppe war. Es spielt keine Rolle, ob sich der Benutzer nicht in der Gruppe befindet, wenn Sie diese Methode verwenden
  - In Supergruppen gibt die unbanChatMember -Methode immer eine positive Antwort zurück, wenn der user_id mindestens einmal Teil der Gruppe war. Es spielt keine Rolle, ob sich der Benutzer nicht in der Gruppe befindet oder nicht in der Gruppe Blacklist ist

Einige Notizen über die Datenbank

Alles wird auf Redis gespeichert, und der schnellste Weg, um Ihre Datenbank zu bearbeiten, ist über die Redis CLI.

Sie finden eine Sicherung Ihrer Redis -Datenbank in /etc/redis/dump.rdb . Der Name dieser Datei und die Häufigkeit von Speichern hängen von Ihrer Redis -Konfigurationsdatei ab.

Übersetzer

Wenn Sie helfen möchten, den Bot zu übersetzen, befolgen Sie die folgenden Anweisungen. Teile der Gruppe Butler verwenden Tools von GetText. Wir verwenden jedoch kein binäres Format *.mo , um der Einfachheit willen. Der Bot analysiert die *.po -Dateien zur Laufzeit im locales .

Wir empfehlen, Übersetzungen zu unserem Crowdin -Projekt beizutragen.

Hinweis für Entwickler : Aktualisieren Sie die POT -Datei, wenn Sie eine Zeichenfolge ändern, und vergessen Sie nicht, die Funktion i18n() zu verwenden, damit sie übersetzbar ist. Um die POT -Datei zu aktualisieren, müssen Sie GetText installieren und dann ausführen: