Skip to content

A superhero bot that saves group chats from shitty spam reported by good members.

License

Notifications You must be signed in to change notification settings

derogab/poop-cleaner

Repository files navigation

poop-cleaner

A superhero bot that saves group chats from shitty spam reported by good members

Docker Pulls

Info

Poop Cleaner Bot is a bot that helps you manage spam on a telegram group thanks to the support of group members. When a message gets a predetermined number of reactions of type "💩" the bot deletes the message from the group.

Bot

First of all you need to create a bot with BotFather.
Then, you need to:

  • disable privacy mode for the bot (through Bot Father), to allow the bot to read all messages.
  • add the bot to your group as admin (only deletion permission required).

Configuration

Copy .env.sample in .env and edit the file with own configs.

ADMIN_USERNAME=here_your_telegram_username
ADMIN_LIGHTNING_ADDRESS=here_your_lightning_address
BOT_TOKEN=here_your_telegram_bot_token
DEBUG=0
POOP_THRESHOLD=10

ADMIN_USERNAME: (optional) your personal telegram username.
ADMIN_LIGHTNING_ADDRESS: (optional) your personal lightning network address.
BOT_TOKEN: (mandatory) the token of your telegram bot.
DEBUG: (optional) enable/disable debug mode (0 for False, 1 for True).
POOP_THRESHOLD: (mandatory) minimum number of reaction for deleting a message.

Usage

The easiest way to use the bot is via the docker compose file. When ready, run:

docker compose up -d 

Tip

If you like this project or directly benefit from it, please consider buying me a coffee:
🔗 bc1qd0qatgz8h62uvnr74utwncc6j5ckfz2v2g4lef
⚡️ derogab@sats.mobi
💶 Sponsor on GitHub

Credits

poop-cleaner is made with ♥ by derogab and it's released under the MIT license.