2022-08-07 04:43:50 -04:00
|
|
|
## About
|
|
|
|
|
This bot is designed to simplify the moderation and management of Telegram groups.
|
|
|
|
|
|
|
|
|
|
## 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
|
2023-01-04 15:23:49 -05:00
|
|
|
* Automatic user data update
|
2022-11-28 04:37:31 -05:00
|
|
|
* 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
|
2023-01-05 05:17:06 -05:00
|
|
|
- Telegram API Service on port 5326(you can run systemd unit in systemd/)
|
2022-11-28 04:48:02 -05:00
|
|
|
- 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
|
|
|
|
|
|
2023-01-04 15:32:37 -05:00
|
|
|
| environment variables | description |
|
|
|
|
|
|-------------------------------|----------------------------------|
|
|
|
|
|
| `bot_token` | telegram bot token |
|
|
|
|
|
| `api_id` and `api_hash` | telegram application data |
|
|
|
|
|
| `group_id` | group id |
|
|
|
|
|
| `second_group_id` | seconds group for admins |
|
|
|
|
|
| `telegram_bot_api_server` | telegram bot api server |
|
|
|
|
|
| `db_url` | connection info to database |
|
|
|
|
|
| `limit_of_warns` | limit user warnings |
|
|
|
|
|
| `update_interval` | interval for update of user data |
|
2022-08-07 04:43:50 -04:00
|
|
|
|
|
|
|
|
## TODO
|
2022-11-28 04:37:31 -05:00
|
|
|
|
2023-02-18 08:27:28 -05:00
|
|
|
- [x] Migrate to aiogram dev-3.0b6
|
2022-11-28 04:31:42 -05:00
|
|
|
- [ ] Docker
|
2023-02-18 08:20:21 -05:00
|
|
|
- [ ] Write antithrotling middleware(anti flood system)
|
2022-12-11 09:13:40 -05:00
|
|
|
- [ ] 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">
|
2023-01-04 15:23:49 -05:00
|
|
|
|
|
|
|
|
Don't donate to this wallet yet, I've lost access to it. Wait until I restore the wallet or create a new one.
|
