Fish-Telegram-Captcha-bot

README

Fish-Telegram-Captcha-bot

A telegram bot running on vercel to verify if the user is a human.

Workflow

https://user-images.githubusercontent.com/19994286/189467303-d35ac426-fa06-4eef-a9e6-b3e5a87b7caa.mp4

Usage

Verification-After-Request Mode

Public group

1. Enable "Approve new members" in the group settings.
2. Add the bot to this group.
3. Promote the bot to admin.
4. Edit admin rights, minimum rights are recommended.

Private group

1. Go to "Group Settings" -> "Manage Invite Links".
2. Create a new invite link with "Request Admin Approval" enabled.
3. Add the bot to this group.
4. Promote the bot to admin.
5. Edit admin rights, minimum rights are recommended.

Notice: DO NOT Use the default invite link

There is a default invite link for a private groupchat in Telegram, which at the top of link list. The property of this invite link cannot be changes, which means that this bot cannot verify the new member joined with this invite link.

Verification-After-Join Mode

In the groups linked with a channel, you can use this mode to verify new members.

1. Add the bot to a group.
2. Promote the bot to admin.
3. Edit admin rights, minimum rights are recommended.

Notice: The permission of "Invite Users via Link" CAN NOT be enabled on verification-after-join mode.

The bot will automatically handle the verification process. New members will be restricted after joining the group until they pass the CAPTCHA.

How to deploy?

What you need:

• A vercel account
• The your telegram bot token
• The site-key and secret-key of your hCaptcha

Deploy to vercel

1. Create your telegram bot via @BotFather
2. Go to the Settings tab to get your secret key.
3. Go to the Sites tab and create a new site key.
4. Fork this repo or click the button below to deploy it to vercel.
5. Go to the Environment Variables tab and add the following variables:
   • BOT_TOKEN: The token of your telegram bot.
   • SECRET_KEY: The secret key of your hCaptcha account.
   • SITE_KEY: The site key of your active site.
6. Redeploy the project to make the environment variables take effect.
7. Set up the webhook by requesting https://api.telegram.org/bot[BOT_TOKEN]/setWebhook?url=https://[YOUR_DOMAIN]/webhook/[BOT_TOKEN]

Deploy to your own server

Due to the limitations of vercel, Verification-After-Join mode only can work on your own server.

1. Deploy the project to vercel, but skip the step on setting the webhook.
2. Get the latest build on GitHub Action.
3. Copy the url which assigned to your Production Deployment on vercel.
4. Run the bot on your server:

   FRONTEND_URL="YOUR_DEPLOYMENT_URL" \
   BOT_TOKEN="YOUR_BOT_TOKEN" \
   ./Fish-Telegram-Captcha-Bot