Skip to content

Commit

Permalink
regen site page
Browse files Browse the repository at this point in the history
  • Loading branch information
umputun committed Dec 7, 2023
1 parent 5d9e42f commit d4f1b91
Showing 1 changed file with 14 additions and 13 deletions.
27 changes: 14 additions & 13 deletions site/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,31 @@
# tg-spam

Anti-Spam bot for Telegram.
TG-Spam is a self-hosted anti-spam bot designed for Telegram, offering a seamless and effective solution to keep unwanted spam at bay. Carefully engineered to minimize disruptions for legitimate users while being a formidable barrier against spam bots. TG-Spam utilizes advanced detection techniques to maintain a spam-free environment.

<div align="center">
<img class="logo" src="logo.png" width="400px" alt="TG-Spam | Spam Hunter"/>
</div>

## What is it and how it works?
<div align="center">

The bot is designed to run as a docker container. It requires a token and a group name/id to work. The bot will listen to all messages in the group and ban users who post spam.

Spam detection based on several factors:
- similarity to known spam messages
- number of emojis in the message
- check user against [Combot Anti-Spam System](https://cas.chat) (CAS)
- check the overall similarity of the message to the known spam messages
- compare with the list of stop words

If the message is considered spam, the bot will delete it and ban the user.
</div>

----
<div align="center">
## What is it and how it works?

TG-Spam is a sophisticated anti-spam bot tailored for Telegram groups, designed to run seamlessly as a Docker container. It is simple to set up, requiring only a telegram token and a group name or ID to begin its operation. Once deployed, TG-Spam diligently monitors all messages, employing a robust spam detection system to identify and eliminate spam content.

### Key Features of Spam Detection

</div>
TG-Spam's spam detection algorithm is multifaceted, incorporating several criteria to ensure high accuracy and efficiency:

- Message Analysis: It evaluates messages for similarities to known spam, flagging those that match typical spam characteristics.
- Integration with Combot Anti-Spam System (CAS): It cross-references users with the Combot Anti-Spam System, a reputable external anti-spam database.
- Spam Message Similarity Check: TG-Spam assesses the overall resemblance of each message to known spam patterns.
- Stop Words Comparison: Messages are compared against a curated list of stop words commonly found in spam.
- Emoji Count: Messages with an excessive number of emojis are scrutinized, as this is a common trait in spam messages.
- Automated Action: If a message is flagged as spam, TG-Spam takes immediate action by deleting the message and banning the responsible user.

## Admin chat/group

Expand Down

0 comments on commit d4f1b91

Please sign in to comment.