Download GroupButler - download do código -fonte GroupButler

GroupButler

Código-Fonte de IA

1.0.0

Baixar

Grupo Butler

Curta introdução

O grupo Butler ajuda as pessoas a administrar seus grupos e inclui muitas outras ferramentas úteis.

O grupo Butler nasceu como um Otouto v3.1 ( @mokubot ), mas desde então foi transformado em um bot da administração.

Grupo Butler no Telegram:

@GroupButler_bot
- Ramo : master
- Canal : @GroupButler_ch .
@GBReborn_bot
- ramo : develop
- Canal : @GroupButler_beta .

Configurar

Primeiro de tudo, dê uma olhada nas suas configurações de bot

Verifique se a privacidade está desativada (mais informações podem ser encontradas indo para a página Oficial de FAQ BOTS). Send /setprivacy para @Botfather para verificar o status atual desta configuração.

Crie um arquivo de texto simples chamado .env com o seguinte:

Defina TG_TOKEN com o token de autenticação que você recebeu do @BotFather .
Defina SUPERADMINS como uma matriz JSON que contém seu ID de telegrama numérico. Outros superadminas também podem ser adicionados. É importante que você insira o ID numérico e não uma string.
Defina LOG_CHAT (o ID do bate -papo, onde o bot enviará todas as solicitações ruins recebidas do Telegram) e seu LOG_ADMIN (o ID do usuário que receberá erros de execução).

Seu arquivo .env agora deve parecer um pouco assim:

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

Configuração (usando o Docker)

Requisitos:

Docker 18.02.0-CE
Docker-Compose 1.21.0
Opcional: cluster de enxame do Docker para implantação

Executando (modo dev)

Run make dev_polling . O Docker puxará e construirá as imagens necessárias; portanto, a primeira vez que você executa esse comando deve demorar um pouco. Depois disso, o bot deve estar em funcionamento.

O código é montado no contêiner de bot, para que você possa fazer alterações e reiniciar o bot como normalmente faria.

A porta padrão do Redis é montada para hospedar, caso você queira depurar algo usando ferramentas disponíveis no host.

O contêiner Redis está definido para não persistir dados enquanto estiver no modo dev .

Running (modo de produção)

Há várias maneiras de usar o Docker para implantar na produção.

Os arquivos chamados docker-compose.*.yml são gitignorados, caso você sinta a necessidade de substituir docker-compose.yml ou escrever algo completamente diferente.

O bot também suporta segredos de leitura do Docker (pode trabalhar com outros cofres também). Verifique lua/config.lua para ver quais variáveis podem ser lidas a partir de segredos.

Compor exemplo

Você pode implantar o grupo Butler executando:

make easy_deploy

Exemplo de enxame

Supondo que você tenha implantado o Redis, por exemplo, staging ( docker stack deploy … ou docker service create … ) e exportou as variáveis de ambiente necessárias (como $TG_TOKEN …), você pode implantar o grupo Butler executando:

docker stack deploy staging -c docker-compose.yml

Configuração (sem usar o Docker)

Lista de pacotes necessários:

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

Você também precisará de outros módulos da Lua, que podem ser (e devem ser) instalados através dos Luarocks Lua Manager Luarocks.

Instalação

Você pode instalar facilmente o Butler do grupo executando os seguintes comandos:

 # 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

Antes de iniciar o bot, você deve iniciar o processo Redis.

 # Start Redis

$ sudo service redis-server start

Iniciando o processo

Para iniciar o bot, execute ./launch.sh . Para parar o bot, pressione Controle Ctrl + C duas vezes.

Você também pode iniciar o bot com ./polling.lua , no entanto, ele não reiniciará automaticamente. Você também precisará encontrar outra maneira de exportar as variáveis de ambiente necessárias.

Algo que você deveria conhecer antes de executar o bot

Você pode alterar algumas configurações do bot. Todas as configurações são colocadas em config.lua , na tabela bot_settings
- cache_time.adminlist : a permanência em segundos do adminList no cache. O BOT cache o administrador para evitar atingir limites de telegrama
- notify_bug : se true , o bot enviará uma mensagem que notifica que um bug ocorreu ao usuário atual, quando um plug -in é executado e um erro acontece
- log_api_errors : se true , o bot enviará o LOG_CHAT com todos os erros relevantes retornados por uma solicitação de API para telegrama
- stream_commands : se true , quando uma atualização aciona um plug -in, a partida será impressa no console
Existem outros campos úteis que podem ser adicionados a .env que você pode encontrar em config.lua , por exemplo
- REDIS_DB : o banco de dados Redis selecionado (se você estiver executando o Redis com a configuração padrão, os bancos de dados disponíveis são 16). O banco de dados será selecionado em cada Iniciar/Recarregar. Padrão: 0
Outras coisas que podem ser úteis
- Os comandos dos administradores começam por $ . Eles não estão documentados, veja os gatilhos de plugins/admin.lua plugin para toda a lista
- Se a principal função de um plug -in retornar true , o bot continuará tentando corresponder ao texto da mensagem com os gatilhos ausentes da tabela de plugins
- Você pode se enviar um backup da pasta de bot zipped com o comando $backup
- A API do Telegram Bot tem alguns "comportamentos estranhos" sem documentos que você pode notar ao usar este bot
  - Nos supergrupos, o método kickChatMember retorna sempre uma resposta positiva se o user_id fizer parte do grupo pelo menos uma vez, não importa se o usuário não estiver no grupo quando você usa esse método
  - Nos supergrupos, o método unbanChatMember retorna sempre uma resposta positiva se o user_id fizer parte do grupo pelo menos uma vez, não importa se o usuário não estiver no grupo ou não estiver na lista negra do grupo

Algumas notas sobre o banco de dados

Tudo é armazenado no Redis, e a maneira mais rápida de editar seu banco de dados é através da CLI Redis.

Você pode encontrar um backup do seu banco de dados Redis em /etc/redis/dump.rdb . O nome deste arquivo e a frequência de salvamentos dependem do seu arquivo de configuração Redis.

Tradutores

Se você quiser ajudar a traduzir o bot, siga as instruções abaixo. Partes do grupo Butler usam ferramentas do getText. No entanto, não usamos formato binário *.mo por uma questão de simplicidade. O bot analisa os arquivos *.po no diretório locales em tempo de execução.

Recomendamos traduções contribuindo para o nosso projeto Crowdin.

Nota para desenvolvedores : atualize o arquivo de maconha sempre que alterar uma string e não se esqueça de usar a função i18n() para que seja traduzível. Para atualizar o arquivo de maconha, você precisará instalar o getText e depois executar: