Skip to content

Commit

Permalink
update site docs
Browse files Browse the repository at this point in the history
  • Loading branch information
umputun committed Jun 23, 2024
1 parent 2c0b0ae commit 466cfa9
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions site/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,11 @@ This option is disabled by default. If set to `true`, the bot will check the mes

This option is disabled by default. If set to `true`, the bot will check the message for the presence of any image. If the message contains images but no text, it will be marked as spam.

**Multi-language words**

Using words that mix characters from multiple languages is a common spam technique. To detect such messages, the bot can check the message for the presence of such words. This option is disabled by default and can be enabled with the `--multi-lang=, [$MULTI_LANG]` parameter. Setting it to a number above `0` will enable this check, and the bot will mark the message as spam if it contains words with characters from more than one language in more than the specified number of words.


### Admin chat/group

Optionally, user can specify the admin chat/group name/id. In this case, the bot will send a message to the admin chat as soon as a spammer is detected. Admin can see all the spam and all banned users and could also unban the user, confirm the ban or get results of spam checks by clicking a button directly on the message.
Expand Down Expand Up @@ -233,6 +238,7 @@ Success! The new status is: DISABLED. /help
--min-msg-len= min message length to check (default: 50) [$MIN_MSG_LEN]
--max-emoji= max emoji count in message, -1 to disable check (default: 2) [$MAX_EMOJI]
--min-probability= min spam probability percent to ban (default: 50) [$MIN_PROBABILITY]
--multi-lang= number of words in different languages to consider as spam, 0 to disable (default: 0) [$MULTI_LANG]
--paranoid paranoid mode, check all messages [$PARANOID]
--first-messages-count= number of first messages to check (default: 1) [$FIRST_MESSAGES_COUNT]
--training training mode, passive spam detection only [$TRAINING]
Expand Down

0 comments on commit 466cfa9

Please sign in to comment.