Description of the bot's work

The bot helps quickly and silently ban spammers.

Group members notify administrators of spam messages themselves using the /spam command. The command should be sent in response to a spam message.

All administrators receive a copy of the inspected message with the ability to check whether the member has correctly pointed to the spam message. If it is indeed a spam message, the member's rating is increased. The bot can send a notification that the admins need to decide if it is a spammer, or notify the admins that the spammer is banned with the option to rollback, or even silently ban, if the likelihood of a ban is high enough based on some factors. The bot can also preventively ban spammers. If the inspected message is incorrectly identified as a spam, the member's rating is downgraded.

In order for the bot to receive a list of administrators in a group or in case of deleting or adding a new one, it is necessary to send the /update command from any of the current administrators. Due to the fact that these commands are instantly deleted by the bot itself in the group, reports and updates occur unnoticed by users

How to Set Up the bot in Your Group

How to connect the bot @Moderator_Helper_Robot (or your own instance) to your group:

1. Add the bot to your group.
2. Grant it admin privileges (with ban and add member permissions).
3. Run the command /update in the group (or /update@Moderator_Helper_Robot if there are other bots with similar commands in the group).
4. The bot will start working. All admins must open a chat with the bot so it can send them notifications.

Installing a .deb package (your own service instance)

If you want to run your own instance instead of the public bot, you can install the Debian package and configure the daemon as a system service.

1. Install required packages:

   sudo apt-get update
   sudo apt-get install -y mariadb-server jq openssl

2. Install tgadmin package:

   sudo dpkg -i ./tgadmin_<version>_amd64.deb

3. Edit the bot config and set Telegram credentials:

   sudoedit /etc/tgadmin/tgadmin.json

   Fill in at least:
   • AdminHelperBot.Telegram.Token
   • AdminHelperBot.Telegram.UserName
   • ServiceAdmin (Telegram user id of service owner/admin)
4. (Optional) Run service under a custom Linux account by editing:

   sudoedit /etc/default/tgadmin

   Supported keys:
   • TGADMIN_SERVICE_USER
   • TGADMIN_SERVICE_GROUP
5. Enable and start the service:

   sudo systemctl daemon-reload
   sudo systemctl enable --now tgadmin
   sudo systemctl status tgadmin --no-pager

6. If database bootstrap was skipped during installation, run:

   sudo dpkg-reconfigure tgadmin

Useful paths:

• Service unit: /lib/systemd/system/tgadmin.service
• Runtime config: /etc/tgadmin/tgadmin.json
• Service identity override: /etc/default/tgadmin
• Data directory: /var/lib/tgadmin
• Logs directory: /var/log/tgadmin

Spam classifier

A spam classifier has been added to the bot (you can turn it off in the service config), which can be trained and used to automatically notify administrators (and in the case of high spam probability can be automatically to ban) about suspicious messages. The algorithm of the Naive Bayesian Classifier is used. In addition, messages in which the number of emojis exceeds the specified number can also be automatically marked as spam by this filter

Architecture

The software implements the telegram bot as a web server in webhook mode

Dependencies

• fp-telegram (Telegram bots API wrapper) https://github.com/Al-Muhandis/fp-telegram
• brook-telegram (Plugin for BrookFoFreePascal) https://github.com/Al-Muhandis/brook-telegram/
• BrookForFreePascal & BrookFramework (HTTP server) https://github.com/risoflora/brookfreepascal & https://github.com/risoflora/brookframework
• dOPF (ORM) https://github.com/pascal-libs/dopf Notes: BrookFreePascal can be used without BrookFramework in broker mode