🔍

Complete Setup Guide

This guide covers all aspects of setting up and configuring BeefyGuard for your Telegram group.

Prerequisites

  • A Telegram group where you have admin permissions
  • The ability to add bots and grant admin permissions

Initial Setup

1. Add Bot to Group

Add @beefyguard_bot to your Telegram group using the group's "Add Members" feature.

2. Grant Admin Permissions

The bot requires admin permissions to function properly:

Required Permissions:

  • Delete messages
  • Ban users
  • Restrict members (for mute/kick actions)

Optional Permissions:

  • Add new admins (only if you want to use admin sync feature)
  • Pin messages (for announcement auto-pinning)

3. Verify Bot Status

Use the /botinfo command in your group to verify:

  • Bot is present and has admin permissions
  • All required permissions are granted
  • Bot is active and responding

Configuration Methods

BeefyGuard can be configured in two ways:

Method 1: Web Dashboard (Recommended)

  1. Use /dashboard command to get dashboard link
  2. Open the link in your browser
  3. Configure all settings through the web interface
  4. Changes are saved automatically

Advantages:

  • Visual interface with organized tabs
  • See all settings at once
  • Easy to understand and configure
  • Real-time updates

Method 2: Bot Commands

  1. Use commands like /add_flagged <name> in the group
  2. Commands are available for most settings
  3. See Bot Commands for complete list

Advantages:

  • Quick changes without leaving Telegram
  • Works directly in group chat
  • Good for simple adjustments

Essential Settings

Detection Settings

Configure how the bot detects impersonators:

  • Check on Join: Enable to check new members immediately
  • Check on Name Change: Detect when users change their name to match admins
  • Similarity Threshold: Set how similar names must be (0.0-1.0, default: 0.85)
  • Auto Ban on Match: Automatically ban detected impersonators

Admin Management

  1. Use /sync_admins to automatically track all current group admins
  2. Or manually add admins using /add_admin <name>
  3. View tracked admins with /list_admins

Flagged Names

Add names that should trigger alerts:

  1. Use /add_flagged <name> to add a flagged name
  2. Use /show_flagged to see all flagged names
  3. Use /remove_flagged <name> to remove a name

Advanced Configuration

Log Channel

Set up a log channel to receive all bot activity:

  1. Create a Telegram channel
  2. Add the bot as an admin to the channel
  3. Get the channel ID (use /groupinfo in the channel)
  4. Set it in dashboard under "Detection Settings" → "Log Channel ID"

Announcements

Forward announcements from channels to your group:

  1. Add bot to your announcement channel as admin
  2. In dashboard, go to "Announcements" tab
  3. Set the "Announcement Channel ID"
  4. Enable "Announcement Forwarding"
  5. Optionally enable auto-pinning

Testing Your Setup

  1. Test Detection: Have a test user change their name to match an admin
  2. Test Commands: Try /settings to see current configuration
  3. Test Dashboard: Make a change in dashboard and verify it works
  4. Test Logging: If log channel is set, verify messages appear there

Troubleshooting

If something isn't working:

  1. Check bot permissions with /botinfo
  2. Verify bot is admin with required permissions
  3. Check dashboard settings are saved
  4. See Troubleshooting Guide

Next Steps