Téléchargement GroupButler - Téléchargement du code source GroupButler

GroupButler

Code Source AI

1.0.0

Télécharger

Butler en groupe

Courte introduction

Group Butler aide les gens à administrer leurs groupes et comprennent de nombreux autres outils utiles.

Le groupe Butler est né en tant qu'Otouto v3.1 ( @mokubot ), mais il a depuis été transformé en bot administratif.

Butler de groupe sur Telegram:

@GroupButler_bot
- branche : master
- Channel : @GroupButler_ch .
@GBReborn_bot
- Branche : develop
- Channel : @GroupButler_beta .

Installation

Tout d'abord, jetez un œil à vos paramètres de bot

Assurez-vous que la confidentialité est désactivée (plus d'informations peuvent être trouvées en vous dirigeant vers la page officielle de FAQ des bots). Envoyer /setprivacy à @botfather pour vérifier l'état actuel de ce paramètre.

Créez un fichier texte brut nommé .env avec les suivants:

Définissez TG_TOKEN sur le jeton d'authentification que vous avez reçu de @BotFather .
Définissez SUPERADMINS comme un tableau JSON contenant votre identifiant de télégramme numérique. D'autres Superadmins peuvent également être ajoutés. Il est important que vous insériez l'ID numérique et non une chaîne.
SET LOG_CHAT (L'ID du chat où le bot enverra toutes les mauvaises demandes reçues de Telegram) et votre LOG_ADMIN (l'ID de l'utilisateur qui recevra des erreurs d'exécution).

Votre fichier .env devrait maintenant ressembler un peu à ceci:

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

Configuration (à l'aide de Docker)

Exigences:

Docker 18.02.0-CE
docker-compose 1.21.0
Facultatif: cluster d'essaims Docker pour le déploiement

Exécution (mode dev)

Run make dev_polling . Docker tirera et construira les images requises, de sorte que la première fois que vous exécutez cette commande devrait prendre un peu de temps. Après cela, le bot devrait être opérationnel.

Le code est monté sur le conteneur de bot, vous pouvez donc apporter des modifications et redémarrer le bot comme vous le feriez normalement.

Le port par défaut de Redis est monté pour héberger, juste au cas où vous souhaitez déboguer quelque chose en utilisant des outils disponibles chez l'hôte.

Le conteneur Redis est défini pour ne pas persister les données en mode Dev .

Running (mode de production)

Il existe plusieurs façons d'utiliser Docker pour le déployer dans la production.

Fichiers nommés docker-compose.*.yml sont gignorés, juste au cas où vous ressentiriez le besoin de remplacer docker-compose.yml ou d'écrire quelque chose d'autre.

Le BOT prend également en charge la lecture des secrets Docker (peut également fonctionner avec d'autres coffres). Vérifiez lua/config.lua pour voir quelles variables peuvent être lues à partir de secrets.

Composer l'exemple

Vous pouvez déployer Group Butler en fonctionnant:

make easy_deploy

Exemple d'essaim

En supposant que vous ayez déployé Redis en, par exemple staging ( docker stack deploy … ou docker service create … ) et exporté les variables d'environnement requises (comme $TG_TOKEN …), vous pouvez déployer le Butler de groupe en exécutant:

docker stack deploy staging -c docker-compose.yml

Configuration (sans utiliser docker)

Liste des packages requis:

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

Vous aurez également besoin d'autres modules LUA, qui peuvent être (et devraient être) installés via le LUA Package Manager Luarocks.

Installation

Vous pouvez facilement installer Group Butler en exécutant les commandes suivantes:

 # Tested on Ubuntu 16.04

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

ou

 # 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

Avant de commencer le bot, vous devez démarrer le processus Redis.

 # Start Redis

$ sudo service redis-server start

Démarrer le processus

Pour démarrer le bot, exécutez ./launch.sh . Pour arrêter le bot, appuyez deux fois sur contrôle Ctrl + C.

Vous pouvez également démarrer le bot avec ./polling.lua , mais il ne redémarrera pas automatiquement. Vous devrez également trouver un autre moyen d'exporter les variables environnementales requises.

Quelque chose que vous devriez savoir avant d'exécuter le bot

Vous pouvez modifier certains paramètres du bot. Tous les paramètres sont placés dans config.lua , dans le tableau bot_settings
- cache_time.adminlist : la permanence en secondes de la liste d'administration dans le cache. Le bot cache l'administration pour éviter de frapper les limites du télégramme
- notify_bug : si true , le bot enverra un message qui informe qu'un bogue est venu à l'utilisateur actuel, lorsqu'un plugin est exécuté et qu'une erreur se produit
- log_api_errors : Si true , le bot enverra le LOG_CHAT toutes les erreurs pertinentes renvoyées par une demande d'API vers le télégramme
- stream_commands : Si true , lorsqu'une mise à jour déclenche un plugin, le match sera imprimé sur la console
Il existe d'autres champs utiles qui peuvent être ajoutés à .env que vous pouvez trouver dans config.lua , par exemple
- REDIS_DB : la base de données Redis sélectionnée (si vous exécutez Redis avec la configuration par défaut, les bases de données disponibles sont 16). La base de données sera sélectionnée à chaque démarrage / rechargement. Par défaut: 0
D'autres choses qui peuvent être utiles
- Les commandes des administrateurs commencent pour $ . Ils ne sont pas documentés, regardez les déclencheurs du plugins/admin.lua Plugin pour toute la liste
- Si la fonction principale d'un plugin renvoie true , le bot continuera d'essayer de faire correspondre le texte du message avec les déclencheurs manquants de la table plugins
- Vous pouvez vous envoyer une sauvegarde du dossier de bot zippé avec la commande $backup
- L'API de Bot Telegram a des "comportements étranges" sans papiers que vous remarquerez peut-être tout en utilisant ce bot
  - Dans SuperGroups, la méthode kickChatMember renvoie toujours une réponse positive si l' user_id fait partie du groupe au moins une fois, peu importe si l'utilisateur n'est pas dans le groupe lorsque vous utilisez cette méthode
  - Dans SuperGroups, la méthode unbanChatMember renvoie toujours une réponse positive si l' user_id fait partie du groupe au moins une fois, peu importe si l'utilisateur n'est pas dans le groupe ou n'est pas dans la liste noire du groupe

Quelques notes sur la base de données

Tout est stocké sur Redis, et le moyen le plus rapide de modifier votre base de données est via le redis CLI.

Vous pouvez trouver une sauvegarde de votre base de données Redis dans /etc/redis/dump.rdb . Le nom de ce fichier et la fréquence des sauvegardes dépendent de votre fichier de configuration Redis.

Traducteurs

Si vous souhaitez aider à traduire le bot, suivez les instructions ci-dessous. Parties de groupe Butler utilisent des outils de GetText. Cependant, nous n'utilisons pas de format binaire *.mo pour des raisons de simplicité. Le bot analyse les fichiers *.po dans le répertoire locales au moment de l'exécution.

Nous vous recommandons de contribuer des traductions à notre projet Crowdin.

Remarque pour les développeurs : mettez à jour le fichier POT chaque fois que vous modifiez une chaîne, et n'oubliez pas d'utiliser la fonction i18n() afin qu'elle soit traduisible. Afin de mettre à jour le fichier POT, vous devrez installer GetText, puis exécuter: