This repository has been archived on 2024-07-28. You can view files and clone it, but cannot push or open issues or pull requests.
moderator-bot/README.md

48 lines
1.5 KiB
Markdown
Raw Normal View History

2022-08-07 04:43:50 -04:00
## About
This bot is designed to simplify the moderation and management of Telegram groups.
<p align="center">
<img src="https://img.shields.io/badge/license-GPL-blue">
</p>
## Features
2022-11-28 04:40:52 -05:00
2022-12-11 09:18:11 -05:00
* Admin commands
2022-11-28 04:37:31 -05:00
* Member roles
* Report users
2022-12-11 09:18:11 -05:00
* Silent commands
2022-11-28 04:37:31 -05:00
* User complaints
* Save admin actions in database
2022-08-07 04:43:50 -04:00
## Installation
2022-11-28 04:40:52 -05:00
2023-01-04 15:10:35 -05:00
- Required: python3.x, poetry/pip
2022-11-28 04:48:02 -05:00
- Clone this repo
- Telegram API Service on port 5326
- Move the .env.dist text template to .env and configure him
2022-08-07 04:43:50 -04:00
- First start use `!reload` for parsing members and permissions
2023-01-04 15:10:35 -05:00
2022-08-07 04:43:50 -04:00
## Configuration .env
2022-11-26 11:12:09 -05:00
| environment variables | description |
|-----------------------------------|----------------------------------|
2022-11-28 04:49:43 -05:00
| `bot_token` | telegram bot token |
| `telegram_bot_api_server` | telegram bot api server |
| `db_url` | connection info to database |
| `api_id` and `api_hash` | telegram application data |
| `group_id` | group id |
| `second_group_id` | seconds group for admins |
2022-08-07 04:43:50 -04:00
## TODO
2022-11-28 04:37:31 -05:00
2022-11-28 04:31:42 -05:00
- [ ] Docker
2022-11-28 04:40:52 -05:00
- [ ] Systemd unit
2022-12-11 09:13:40 -05:00
- [ ] Write antithrotling midlware middleware(anti flood system)
- [ ] Site for group moderator(in development)
2022-08-07 04:43:50 -04:00
## Support
2022-12-11 09:18:11 -05:00
2022-08-07 04:43:50 -04:00
Every investition helps in maintaining this project and making it better.
<img src="https://img.shields.io/badge/btc-bc1qzp7q3rghzcx70534e7xf6tj0ns3dqvvnex80kf-green?logo=bitcoin">