Skip to content

Latest commit

 

History

History
103 lines (72 loc) · 2.89 KB

README.md

File metadata and controls

103 lines (72 loc) · 2.89 KB
Raw

Kitan

License Python 3.9+ Version

🌟 Kitan

Kitan is a Telegram bot that helps keep your group safe by verifying that users are real people. It's open-source and built with Python and Vue.

Invite the bot to your group

🚀 Why Kitan?

Many traditional verification methods like captchas and questions can be bypassed with human help. Plus, not all spammers are bots—some are real people.

Kitan uses modern methods to verify users, ensuring they're genuine. It combines biometric authentication and puzzles to verify users and employs AI to monitor user behavior for risks.

🛡️ How It Works

  • Biometric Live Authentication: Confirms the user is a real, living person.
  • Puzzle Verification: Ensures users solve a puzzle to prove they're human.
  • Cloudflare Turnstile: Blocks users who exhibit risky behavior. If the biometric API is unavailable, fallback methods like Cloudflare's protection and puzzle verification are used.
  • OCR Trash Message Detection: Identifies and intercepts spam messages using OCR.

📚 Getting Started

  1. Add Kitan to your Telegram group.
  2. Make Kitan an administrator with the right permissions.
  3. Kitan will automatically screen new members.

This keeps your group safe by ensuring only approved users can join.

🛣️ Roadmap

  • Basic verification
  • Risk control and ban monitoring
  • Group consensus features

📦 Deploying Kitan

To deploy Kitan yourself, you'll need a server, Redis (optional), MongoDB, a domain, and a Telegram bot.

Docker

git clone https://github.com/TelechaBot/Kitan
cd Kitan
chmod +x docker-build.sh
nano docker-build.sh
# Change the environment variables
./docker-build.sh

check docker-build.sh for more information.

Clone the Repository

git clone https://github.com/TelechaBot/Kitan
cd Kitan

Frontend Setup

See /frontend/README.MD.

cd frontend
npm install
env VITE_BACKEND_URL="https://api.example.com"
# env VITE_CLOUDFLARE_SITE_KEY="optional"
npm run build
# Deploy to your server

Backend Setup

See /backend/README.MD.

cd backend

cp .env.example .env
nano .env

pip install pdm
pdm install
pdm run python main.py
# Press Ctrl + C to exit
pm2 start pm2.json

anime

This image is decorative and not part of the project.