Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/MasterGroosha/telegram-report-bot

A simple bot to handle reports from users in your chat
https://github.com/MasterGroosha/telegram-report-bot

aiogram aiogram3 moderation python telegram telegram-bot

Last synced: 3 months ago
JSON representation

A simple bot to handle reports from users in your chat

Awesome Lists containing this project

README 

        
# Report bot for Telegram



 



This repository contains source code of a small yet rather powerful bot for Telegram, which handles reports from users and passes them to admins. 

Uses [aiogram](https://github.com/aiogram/aiogram) framework.  

The main goal is to build a bot with no external database needed. Thus, it may lack some features, but hey, it's open source!



#### Screenshot



![Left - main group. Right - group for admins only. If you don't see this image, please check GitHub repo](screenshots/cover.png)



#### Features

* `/report` command to gather reports from users;  

* Reports can be sent to a dedicated chat or to dialogues with admins;  

* `/ro` command to set user "read-only" and `/nomedia` to allow text messages only;

* [optional] Automatically remove "user joined" service messages;  

* [optional] Automatically ban channels (since 

[December 2021](https://telegram.org/blog/protected-content-delete-by-date-and-more#anonymous-posting-in-public-groups) 

users can write on behalf of their channels);  

* If text message starts with `@admin`, admins are notified;  

* A simple interface for admins to choose one of actions on reported message;  

* English and Russian languages are built-in.



#### Requirements

* Python 3.9 and above;  

* Tested on Linux, should work on Windows, no platform-specific code is used;  

* Systemd (you can use it to enable autostart and autorestart) or Docker.



#### Installation  

1. Go to [@BotFather](https://t.me/telegram), create a new bot, write down its token, add it to your existing group 

and **make bot an admin**. You also need to give it "Delete messages" permission.  

2. Create a separate group where report messages will be sent and add all group admins there. 

**Remember**: anyone who is in that group may perform actions like "Delete", "Ban" and so on, so be careful.  

3. Use some bot like [@my_id_bot](https://t.me/my_id_bot) to get IDs of these two groups;  

4. Clone this repo and `cd` into it;  

5. Copy `env_dist` to `.env` (with dot). **Warning**: files starting with dot may be hidden in Linux, 

so don't worry if you stop seeing this file, it's still here!  

6. Replace default values with your own;  

7. Now choose installation method: **systemd** or **Docker**



##### systemd

1. Create a venv (virtual environment): `python3.9 -m venv venv` (or any other Python 3.7+ version);  

2. `source venv/bin/activate && pip install -r requirements.txt`;

3. Rename  `reportbot.service.example` to `reportbot.service` and move it to `/etc/systemd/system`;  

4. Open that file and change values for `WorkingDirectory`, `ExecStart` and `EnvironmentFile` providing the correct 

path values;  

5. Start your bot and enable its autostart: `sudo systemctl enable reportbot.service --now`;  

6.Check your bot's status and logs: `systemctl status reportbot.service`.



##### Docker

1. Build and run your container: `docker-compose up -d`.



Alternatively, check [docker-compose.yml](docker-compose.yml) file from this repo.