# Getting Started
> Security Bot is a powerful Discord security and moderation bot that protects your server from nukes, raids, and unauthorized actions.
## Overview
Security Bot provides comprehensive protection through:
* **Anti-Nuke** - Limits dangerous actions like bans, kicks, and channel deletions
* **Anti-Raid** - Detects and prevents mass join attacks
* **Beast Mode** - Global score-based protection system
* **Verification** - CAPTCHA-based verification for new members
* **Moderation** - Safe moderation commands with built-in limits
* **Whitelist** - Exempt trusted users, roles, and channels
## Quick Start
### Step 1: Add the Bot
Invite Security Bot to your server:
[**securitybot.gg/invite**](https://securitybot.gg/invite)
### Step 2: Position the Role
After adding Security, move its role to the highest position (or above all moderator roles). This is required for the bot to function properly.
### Step 3: Configure Settings
You can configure Security using:
* **Dashboard** - [securitybot.gg](https://securitybot.gg/)
* **Commands** - Use `/help` to see all available commands
## Next Steps
* [Manage Settings](/getting-started/manage-settings) - Learn how to configure the bot
* [Anti-Nuke](/anti-nuke/anti-nuke) - Set up action limits and punishments
* [Whitelist](/whitelist/whitelist) - Exempt trusted users and roles
* [Verification](/other-modules/verification) - Enable CAPTCHA verification
## Support
Need help? Join our Discord support server: [securitybot.gg/discord](https://securitybot.gg/discord)
# Manage Settings
Security Bot can be configured through two methods: the web dashboard or slash commands.
## Using the Dashboard
The dashboard provides a visual interface for all settings.
### How to Access
1. Go to [securitybot.gg](https://securitybot.gg/)
2. Click **Login**
3. Click **Authorize** to connect your Discord account
4. Select **Dashboard** (if not automatically redirected)
5. Choose your server from the list
### Dashboard Features
The dashboard allows you to:
* View and modify Anti-Nuke settings (limits, punishments, triggers)
* Manage whitelist entries (users, roles, channels)
* Configure Anti-Raid scores and thresholds
* Enable/disable Beast Mode
* Access Premium features (if subscribed)
## Using Commands
All settings can also be configured using slash commands directly in Discord.
### Quick Reference
| Task | Command |
| ---------------------- | ---------------- |
| View all commands | `/help` |
| View current settings | `/settings` |
| Set action limit | `/setlimit` |
| Set punishment | `/setpunishment` |
| Enable action trigger | `/enable` |
| Disable action trigger | `/disable` |
| Manage whitelist | `/whitelist` |
| Manage permissions | `/permission` |
### Getting Help
Use `/help` to see the complete list of available commands with descriptions.
## Which Method Should I Use?
* **Dashboard** - Best for initial setup and viewing all settings at once
* **Commands** - Best for quick changes and on-the-fly adjustments
Both methods sync automatically. Changes made in the dashboard appear in commands and vice versa.
# Premium Features
> Security Bot Premium unlocks advanced protection features for comprehensive server security.
## Feature Overview
| Feature | Description |
| ------------------------- | -------------------------------- |
| Anti Mention | Block unauthorized mass mentions |
| Anti Vanity Change | Protect custom invite URL |
| Anti Server Rename | Prevent server name changes |
| Anti Server Icon Change | Protect server icon |
| Anti Role Rename | Prevent role name changes |
| Anti Channel Rename | Prevent channel name changes |
| Anti Emoji Delete | Protect custom emojis |
| Anti Emoji Rename | Prevent emoji renaming |
| Anti Invite Delete | Protect invite links |
| Anti Ghost Ping | Detect deleted mentions |
| Anti Raid (Advanced) | Enhanced raid protection |
| Customizable Verification | Custom verification messages |
| Anti Spam | Configurable spam protection |
## Detailed Feature Descriptions
### Anti Mention
Prevents misuse of mass mentions like `@everyone` and `@here`. Unauthorized mass mentions are automatically blocked and the user is punished.
**Protects against:** Mention spam, disruption, notification abuse
### Anti Vanity Change
Protects your server's custom invite URL (vanity URL). Attempts to change it without authorization trigger automatic punishment.
**Protects against:** Vanity URL hijacking, branding tampering
### Anti Server Rename
Monitors and prevents unauthorized server name changes. Maintains consistent branding and recognition.
**Protects against:** Server identity tampering, defacement
### Anti Server Icon Change
Prevents unauthorized changes to your server icon. Maintains visual identity and branding.
**Protects against:** Icon defacement, branding tampering
### Anti Role Rename
Blocks unauthorized role renaming attempts. Maintains role organization and clarity.
**Protects against:** Role confusion, permission obfuscation
### Anti Channel Rename
Restricts unauthorized channel name changes. Prevents confusion and maintains server organization.
**Protects against:** Channel confusion, navigation disruption
### Anti Emoji Delete
Protects custom emojis from unauthorized deletion. Preserves community expressions and assets.
**Protects against:** Emoji vandalism, asset destruction
### Anti Emoji Rename
Prevents unauthorized emoji renaming. Preserves intended emoji meanings and organization.
**Protects against:** Emoji confusion, meaning tampering
### Anti Invite Delete
Safeguards invite links from unauthorized deletion. Ensures continuous member access.
**Protects against:** Invite sabotage, access disruption
### Anti Ghost Ping
Detects when users delete messages containing mentions (ghost pings). Reveals the deleted mention and notifies the server.
**Protects against:** Ghost pinging, harassment, disruptive behavior
### Anti Raid (Advanced)
Enhanced raid protection with advanced configuration options. Score-based detection system with server locking and automatic punishment.
**Protects against:** Mass join attacks, bot raids, coordinated attacks
See [Anti-Raid](/other-modules/anti-raid) for configuration details.
### Customizable Verification
Personalize your verification system with:
* Custom verification messages
* Custom banners and branding
* Enhanced CAPTCHA options
**Protects against:** Bot accounts, automated joins, spam accounts
See [Verification](/other-modules/verification) for setup details.
### Anti Spam
Configurable spam protection with customizable parameters:
* Message limit (e.g., 5 messages)
* Time window (e.g., 10 seconds)
* Automatic actions (lock, clear, punish)
**Protects against:** Message spam, chat flooding, copypasta attacks
## Getting Premium
* [Buying Premium](/premium/buying-premium) - How to purchase and activate
* [Premium+](/premium/premium+) - Custom bot branding setup
# Buying Premium
> Upgrade to Security Bot Premium for advanced protection features.
## Premium Plans
| Plan | Price | Description |
| --------------------- | -------------------------- | -------------------------------------- |
| **Security Premium** | $3.50/month per server | All premium features |
| **Security Premium+** | $8.50/month per custom bot | Premium features + custom bot branding |
## How to Subscribe
### Step 1: Purchase Premium
1. Visit the [Security Bot Premium page](https://securitybot.gg/premium)
2. Select your preferred plan
3. Complete the payment process
### Step 2: Connect Discord to Patreon
1. Go to the [Patreon Apps Page](https://www.patreon.com/settings/apps/discord)
2. Connect your Discord account
### Step 3: Add Your Server to Premium
1. Open the [Security Premium Servers Page](https://securitybot.gg/user/premium)
2. Add your server(s) to premium
### Step 4: Add the Premium Bot
1. Invite Security Premium using [this link](https://discord.com/oauth2/authorize?client_id=778607630515306497\&permissions=8\&scope=bot%20applications.commands)
2. Remove the free Security Bot from your server
3. Move the Security Premium role to the highest position
## Important Notes
* Premium is linked to your Patreon subscription
* You must keep your Discord connected to Patreon
* If your subscription lapses, premium features will be disabled
* Your settings are preserved if you resubscribe
## Troubleshooting
| Issue | Solution |
| ---------------------- | ----------------------------------------------- |
| Premium not activating | Verify Discord is connected to Patreon |
| Features not working | Ensure premium bot role is positioned correctly |
| Can't add server | Check that you have admin permissions |
## Need Help?
Join our [Discord support server](https://securitybot.gg/discord) for assistance.
## See Also
* [Premium Features](/premium/premium-features) - Full list of premium features
* [Premium+](/premium/premium+) - Custom bot branding setup
# Premium+
> Premium+ allows you to customize Security Bot with your own branding, including custom name, avatar, and status.
## What's Included
| Feature | Description |
| -------------------- | -------------------------------- |
| Custom Bot Name | Display your own bot name |
| Custom Avatar | Use your own bot profile picture |
| Custom Status | Set a custom bot status message |
| All Premium Features | Everything in standard Premium |
## Pricing
**$8.50/month** per custom bot (includes all premium features)
## Setup Guide
### Step 1: Connect Discord to Patreon
1. Visit the [Patreon Apps Page](https://www.patreon.com/settings/apps/discord)
2. Connect your Discord account
### Step 2: Add Your Server to Premium
1. Open the [Security Premium Servers Page](https://securitybot.gg/user/premium)
2. Add your server(s) to premium
### Step 3: Create Your Custom Bot
1. Go to the [Security Custom Bots Page](https://securitybot.gg/user/custom-bots)
2. Customize your bot:
* Set the bot name
* Upload a custom avatar
* Configure the status message
3. Add the custom bot to your server
### Step 4: Configure Your Server
1. Remove the standard Security Bot from your server
2. Move your custom bot's role to the highest position
## Customization Options
| Option | Requirements |
| -------- | --------------------------------------------- |
| Bot Name | 2-32 characters, follows Discord naming rules |
| Avatar | Square image, recommended 512x512 or larger |
| Status | Custom activity message |
## Important Notes
* Your custom bot is exclusive to your subscription
* Customizations can be changed anytime via the dashboard
* If your subscription lapses, the custom bot will go offline
* All standard premium features are included
## Need Help?
Join our [Discord support server](https://securitybot.gg/discord) for assistance.
## See Also
* [Premium Features](/premium/premium-features) - Full list of premium features
* [Buying Premium](/premium/buying-premium) - How to purchase standard premium
# Anti-Nuke Overview
> Anti-Nuke protects your server by limiting dangerous actions. When a user exceeds the allowed limit, they receive an automatic punishment.
## How It Works
Anti-Nuke monitors specific dangerous actions performed by moderators and admins. Each action type has a configurable limit. When someone exceeds their limit within the 10-minute window, Security automatically punishes them.
## Monitored Actions
| Action | Description |
| ---------------------------- | -------------------------------- |
| Banning members | Mass ban protection |
| Kicking members | Mass kick protection |
| Deleting channels | Channel deletion protection |
| Creating channels | Channel creation spam protection |
| Deleting roles | Role deletion protection |
| Creating roles | Role creation spam protection |
| Adding bots | Unauthorized bot protection |
| Giving dangerous permissions | Permission escalation protection |
| Adding dangerous roles | Role assignment protection |
| Pruning members | Mass prune protection |
## Reset Duration
Action counters reset every **10 minutes**. This duration is fixed and cannot be changed. Set your limits accordingly.
**Example:** If the ban limit is 3, a user can ban up to 3 members within any 10-minute window. After 10 minutes, their counter resets.
## Who Is Exempt from Punishment?
Users are **not punished** if any of these conditions apply:
| Condition | Description |
| ------------------------------------------------------ | ----------------------------- |
| User is whitelisted for the action | Specific action bypass |
| User is globally whitelisted | All actions bypass |
| User has a whitelisted role for the action | Role-based action bypass |
| User has a globally whitelisted role | Role-based all actions bypass |
| User is the server owner | Owners are always exempt |
| User's role is equal to or higher than Security's role | Role hierarchy protection |
| The action trigger is disabled | Action not being monitored |
## Configuration
* [Check Settings](/anti-nuke/anti-nuke/check-settings) - View current Anti-Nuke configuration
* [Changing Limits](/anti-nuke/anti-nuke/changing-limits) - Modify action limits
* [Changing Punishments](/anti-nuke/anti-nuke/changing-punishments) - Set punishment types
* [Enable/Disable Triggers](/anti-nuke/anti-nuke/enable-disable-action-triggers) - Toggle action monitoring
* [Dangerous Permissions](/anti-nuke/anti-nuke/dangerous-permissions) - Permission reference list
## Related
* [Whitelist](/whitelist/whitelist) - Exempt trusted users and roles
* [Beast Mode](/other-modules/beast-mode) - Global score-based protection
# Check Settings
View your current Anti-Nuke configuration including limits, punishments, and enabled triggers.
## Using the Dashboard
1. Go to [securitybot.gg](https://securitybot.gg/) and log in
2. Select your server from the dashboard
3. Navigate to the **Anti-Nuke** category
The dashboard displays all settings in a visual interface where you can see:
* Current limits for each action
* Punishment types configured
* Which triggers are enabled/disabled
## Using Commands
```
/settings
```
1. Type `/settings`
2. Select **Anti-Nuke** from the options
3. Send the command
The bot responds with your current Anti-Nuke configuration.
## What You Will See
The settings display includes:
| Setting | Description |
| ---------------- | -------------------------------------- |
| Action Limits | Maximum allowed actions per 10 minutes |
| Punishments | What happens when limits are exceeded |
| Triggers | Which actions are being monitored |
| Whitelist Status | Number of whitelisted users/roles |
# Changing Limits
Configure how many times each action can be performed within the 10-minute window before triggering punishment.
## Understanding Limits
Each dangerous action has a configurable limit:
* **Lower limits** = Stricter protection (recommended for sensitive servers)
* **Higher limits** = More lenient (for active moderation teams)
**Example:** Setting the ban limit to `3` means a user can ban up to 3 members in 10 minutes. The 4th ban triggers punishment.
## Using the Dashboard
1. Go to [securitybot.gg](https://securitybot.gg/) and log in
2. Select your server from the dashboard
3. Navigate to the **Anti-Nuke** category
4. Adjust the **Maximum/Punishment** values for each action
5. Click **Save**
## Using Commands
```
/setlimit
```
1. Type `/setlimit`
2. Select the action you want to modify (ban, kick, etc.)
3. Enter the new limit number
4. Send the command
## Recommended Limits
| Server Size | Ban | Kick | Channel Delete | Role Delete |
| ----------------- | ---- | ----- | -------------- | ----------- |
| Small (<500) | 2-3 | 3-5 | 1-2 | 1-2 |
| Medium (500-5000) | 3-5 | 5-10 | 2-3 | 2-3 |
| Large (5000+) | 5-10 | 10-15 | 3-5 | 3-5 |
> **Note:** These are suggestions. Adjust based on your moderation team's activity level.
## Tips
* Start with lower limits and increase if your moderators hit them during normal work
* Monitor your logs to see if limits are being reached legitimately
* Consider whitelisting trusted moderators instead of raising limits
# Changing Punishments
Configure what happens to users who exceed their action limits.
## Available Punishments
| Punishment | Description |
| ---------------- | -------------------------------------------- |
| **Ban** | Permanently removes the user from the server |
| **Kick** | Removes the user (they can rejoin) |
| **Remove Roles** | Strips all roles from the user |
| **Quarantine** | Restricts the user's permissions |
## Using the Dashboard
1. Go to [securitybot.gg](https://securitybot.gg/) and log in
2. Select your server from the dashboard
3. Navigate to the **Anti-Nuke** category
4. Select the punishment type for each action
5. Click **Save**
## Using Commands
```
/setpunishment
```
1. Type `/setpunishment`
2. Select the action (ban, kick, channel delete, etc.)
3. Select the punishment type
4. Send the command
## Choosing the Right Punishment
| Scenario | Recommended Punishment |
| -------------------------- | -------------------------- |
| High security servers | Ban |
| Moderate security | Remove Roles or Quarantine |
| Servers with trusted staff | Kick or Remove Roles |
| Testing/development | Quarantine |
## Tips
* **Ban** is the most secure but cannot be undone easily
* **Remove Roles** is effective and reversible
* **Quarantine** is useful when you want to investigate before taking permanent action
* Consider the severity of each action type when choosing punishments
## Example Configuration
A balanced setup might look like:
| Action | Punishment |
| --------------------- | ------------ |
| Mass Ban | Ban |
| Mass Kick | Remove Roles |
| Channel Delete | Ban |
| Role Delete | Ban |
| Adding Bots | Ban |
| Dangerous Permissions | Remove Roles |
# Enable/Disable Triggers
Control which actions Security monitors. Disabled triggers are not tracked or punished.
## What Are Triggers?
Triggers are the specific actions that Anti-Nuke monitors. When a trigger is:
* **Enabled** - Security tracks the action and enforces limits
* **Disabled** - Security ignores the action completely
## Available Triggers
| Trigger | What It Monitors |
| --------------------- | ----------------- |
| Ban | Member bans |
| Kick | Member kicks |
| Channel Delete | Channel deletions |
| Channel Create | Channel creations |
| Role Delete | Role deletions |
| Role Create | Role creations |
| Bot Add | Bot additions |
| Dangerous Permissions | Permission grants |
| Dangerous Roles | Role assignments |
| Prune | Member pruning |
## Using the Dashboard
1. Go to [securitybot.gg](https://securitybot.gg/) and log in
2. Select your server from the dashboard
3. Navigate to the **Anti-Nuke** category
4. Toggle triggers on (enabled) or off (disabled)
5. Click **Save**
## Using Commands
**To enable a trigger:**
```
/enable
```
**To disable a trigger:**
```
/disable
```
1. Type `/enable` or `/disable`
2. Select the action trigger
3. Send the command
## When to Disable Triggers
You might disable triggers if:
* Your server has legitimate high-volume moderation activity
* A specific action is handled by another bot
* You want to temporarily allow bulk operations
> **Warning:** Disabling triggers reduces protection. Only disable what you specifically need to.
## Best Practices
* Keep all triggers enabled by default
* Use whitelists instead of disabling triggers when possible
* Re-enable triggers after completing bulk operations
* Review your enabled triggers periodically
# Dangerous Permissions
Security monitors these Discord permissions because they can be used to damage or take over a server.
## Permission List
| Permission | Risk Level | Why It's Dangerous |
| -------------------- | ---------- | ------------------------------------------------- |
| **Administrator** | Critical | Grants all permissions, bypasses all restrictions |
| **Manage Server** | Critical | Can change server settings, region, and features |
| **Ban Members** | High | Can remove members permanently |
| **Kick Members** | High | Can remove members from the server |
| **Manage Channels** | High | Can delete/modify all channels |
| **Manage Roles** | High | Can create/delete roles and change permissions |
| **Manage Webhooks** | Medium | Can create webhooks to spam or impersonate |
| **Manage Messages** | Medium | Can delete messages in bulk |
| **Manage Threads** | Medium | Can delete/modify threads |
| **Manage Nicknames** | Low | Can change all member nicknames |
## How Security Uses This List
Security monitors when these permissions are:
1. **Granted to a role** - Triggers "Dangerous Permissions" action
2. **Role with these permissions assigned to a user** - Triggers "Dangerous Roles" action
## Protection Behavior
When someone grants dangerous permissions:
* The action counts toward their Anti-Nuke limit
* If they exceed the limit, they receive the configured punishment
* The action may be logged (if logging is enabled)
## Recommendations
* Only grant dangerous permissions to roles held by highly trusted users
* Use Security's permission system instead of Discord permissions for moderators
* Regularly audit who has dangerous permissions in your server
* Consider using the whitelist for administrators who need these permissions
## Related
* [Moderation](/other-modules/moderation) - Use Security's safe permission system
* [Whitelist](/whitelist/whitelist) - Exempt trusted users from monitoring
# Whitelist Overview
> Whitelist allows trusted users, roles, and channels to bypass Security's protection limits.
## What Is Whitelisting?
Whitelisting exempts specific entities from Anti-Nuke monitoring. Whitelisted users and roles can perform actions without triggering punishments, even if they exceed the configured limits.
## Whitelist Types
| Type | Description | Use Case |
| --------------------- | ------------------------------------ | --------------------------- |
| **User Whitelist** | Exempts specific members | Trusted administrators |
| **Role Whitelist** | Exempts all members with a role | Admin/mod teams |
| **Channel Whitelist** | Exempts actions in specific channels | Bot channels, spam channels |
## Whitelist Categories
You can whitelist for specific actions or globally:
| Category | What It Bypasses |
| ------------------------- | ---------------------- |
| **Global** | All Anti-Nuke actions |
| **Ban** | Ban limit only |
| **Kick** | Kick limit only |
| **Channel Delete** | Channel deletion limit |
| **Channel Create** | Channel creation limit |
| **Role Delete** | Role deletion limit |
| **Role Create** | Role creation limit |
| **Bot Add** | Bot addition limit |
| **Dangerous Permissions** | Permission grant limit |
| **Dangerous Roles** | Role assignment limit |
## Quick Reference
| Task | Command |
| ------------------------- | --------------------------- |
| View whitelisted users | `/whitelist view_users` |
| View whitelisted roles | `/whitelist view_roles` |
| View whitelisted channels | `/whitelist view_channels` |
| Add user | `/whitelist add_user` |
| Remove user | `/whitelist remove_user` |
| Add role | `/whitelist add_role` |
| Remove role | `/whitelist remove_role` |
| Add channel | `/whitelist add_channel` |
| Remove channel | `/whitelist remove_channel` |
## Detailed Guides
* [User Whitelist](/whitelist/whitelist/user-whitelist) - Exempt specific users
* [Role Whitelist](/whitelist/whitelist/role-whitelist) - Exempt roles
* [Channel Whitelist](/whitelist/whitelist/channel-whitelist) - Exempt channels
## Best Practices
* **Use role whitelisting** over user whitelisting when possible (easier to manage)
* **Whitelist for specific actions** rather than globally when feasible
* **Regularly audit** your whitelist to remove former staff
* **Document** why each entry is whitelisted
## Related
* [Anti-Nuke](/anti-nuke/anti-nuke) - Protection system that whitelists bypass
* [Beast Mode](/other-modules/beast-mode) - Global protection (has separate whitelist option)
# User Whitelist
Exempt specific users from Anti-Nuke limits.
## When to Use User Whitelist
* Server owner's alternate accounts
* Highly trusted administrators
* Bot accounts that perform moderation
> **Tip:** Consider using [Role Whitelist](/whitelist/whitelist/role-whitelist) instead for easier management of staff teams.
## View Whitelisted Users
### Using the Dashboard
1. Go to [securitybot.gg](https://securitybot.gg/) and log in
2. Select your server from the dashboard
3. Navigate to the **Whitelist** category
4. Find the action category and click **View**
### Using Commands
```
/whitelist view_users
```
1. Type `/whitelist view_users`
2. Select the category (Global, Ban, Kick, etc.)
3. Send the command
## Add a User
### Using the Dashboard
1. Go to [securitybot.gg](https://securitybot.gg/) and log in
2. Select your server from the dashboard
3. Navigate to the **Whitelist** category
4. Find the action category and click **Edit**
5. Add the user
6. Click **Save**
### Using Commands
```
/whitelist add_user
```
1. Type `/whitelist add_user`
2. Select the user
3. Select the category (Global, Ban, Kick, etc.)
4. Send the command
## Remove a User
### Using the Dashboard
1. Go to [securitybot.gg](https://securitybot.gg/) and log in
2. Select your server from the dashboard
3. Navigate to the **Whitelist** category
4. Find the action category and click **Edit**
5. Remove the user
6. Click **Save**
### Using Commands
```
/whitelist remove_user
```
1. Type `/whitelist remove_user`
2. Select the user
3. Select the category
4. Send the command
## Important Notes
* Whitelisted users can exceed limits without punishment
* User whitelist takes precedence over other restrictions
* Server owners are automatically exempt (no need to whitelist)
* Users with roles equal to or higher than Security's role are automatically exempt
# Role Whitelist
Exempt all members with a specific role from Anti-Nuke limits.
## When to Use Role Whitelist
* Administrator teams
* Moderator teams with legitimate high-volume activity
* Bot roles that perform moderation
> **Recommended:** Role whitelisting is easier to manage than user whitelisting. When staff changes, just modify role assignments.
## View Whitelisted Roles
### Using the Dashboard
1. Go to [securitybot.gg](https://securitybot.gg/) and log in
2. Select your server from the dashboard
3. Navigate to the **Whitelist** category
4. Find the action category and click **View**
### Using Commands
```
/whitelist view_roles
```
1. Type `/whitelist view_roles`
2. Select the category (Global, Ban, Kick, etc.)
3. Send the command
## Add a Role
### Using the Dashboard
1. Go to [securitybot.gg](https://securitybot.gg/) and log in
2. Select your server from the dashboard
3. Navigate to the **Whitelist** category
4. Find the action category and click **Edit**
5. Add the role
6. Click **Save**
### Using Commands
```
/whitelist add_role
```
1. Type `/whitelist add_role`
2. Select the role
3. Select the category (Global, Ban, Kick, etc.)
4. Send the command
## Remove a Role
### Using the Dashboard
1. Go to [securitybot.gg](https://securitybot.gg/) and log in
2. Select your server from the dashboard
3. Navigate to the **Whitelist** category
4. Find the action category and click **Edit**
5. Remove the role
6. Click **Save**
### Using Commands
```
/whitelist remove_role
```
1. Type `/whitelist remove_role`
2. Select the role
3. Select the category
4. Send the command
## Important Notes
* All members with the whitelisted role can exceed limits
* Role whitelist is cumulative (user with multiple whitelisted roles gets all bypasses)
* If a role is whitelisted globally, members bypass all actions
* Consider whitelisting for specific actions rather than globally for better security
# Channel Whitelist
Exempt specific channels from certain Anti-Nuke protections.
## View Whitelisted Channels
### Using the Dashboard
1. Go to [securitybot.gg](https://securitybot.gg/) and log in
2. Select your server from the dashboard
3. Navigate to the **Whitelist** category
4. Find the action category and click **View**
### Using Commands
```
/whitelist view_channels
```
1. Type `/whitelist view_channels`
2. Select the category
3. Send the command
## Add a Channel
### Using the Dashboard
1. Go to [securitybot.gg](https://securitybot.gg/) and log in
2. Select your server from the dashboard
3. Navigate to the **Whitelist** category
4. Find the action category and click **Edit**
5. Add the channel
6. Click **Save**
### Using Commands
```
/whitelist add_channel
```
1. Type `/whitelist add_channel`
2. Select the channel
3. Select the category
4. Send the command
## Remove a Channel
### Using the Dashboard
1. Go to [securitybot.gg](https://securitybot.gg/) and log in
2. Select your server from the dashboard
3. Navigate to the **Whitelist** category
4. Find the action category and click **Edit**
5. Remove the channel
6. Click **Save**
### Using Commands
```
/whitelist remove_channel
```
1. Type `/whitelist remove_channel`
2. Select the channel
3. Select the category
4. Send the command
## Important Notes
* Channel whitelist only affects actions related to that channel
* Does not exempt users performing actions in the channel from other limits
* Consider the security implications before whitelisting channels
# Beast Mode
> Beast Mode is a global protection system that activates when suspicious activity reaches a critical level, punishing anyone who performs dangerous actions.
## How It Works
Beast Mode uses a global score system:
1. Every dangerous action adds points to your server's current score
2. When the score reaches the configured limit, "the beast wakes up"
3. While active, Beast Mode punishes **anyone** performing dangerous actions
4. The beast calms down after 60 minutes of inactivity or manual intervention
**Key Difference from Anti-Nuke:** Anti-Nuke tracks individual user limits. Beast Mode tracks server-wide activity and punishes everyone when activated.
## Checking Beast Mode Status
### Using the Dashboard
1. Go to [securitybot.gg](https://securitybot.gg/) and log in
2. Select your server from the dashboard
3. Navigate to the **Beast Mode** category
The status indicator shows whether Beast Mode is enabled and if the beast is currently active.
## Enabling Beast Mode
1. Go to [securitybot.gg](https://securitybot.gg/) and log in
2. Select your server from the dashboard
3. Navigate to the **Beast Mode** category
4. Toggle **Beast Mode** to enabled (green)
5. Click **Save**
## Stopping an Active Beast
If the beast has awakened and is punishing users:
1. Open the dashboard
2. Go to the **Beast Mode** category
3. Click the **Calm Down** button
The beast will also calm down automatically after **60 minutes** of inactivity.
## Who Is Exempt?
Even when Beast Mode is active, these users are not punished:
| Exempt Users | Condition |
| -------------------------- | --------------------------------- |
| Higher role users | Role is above Security's role |
| Server owners | Always exempt |
| Whitelisted users (global) | If **Allow Whitelist** is enabled |
| Whitelisted users (action) | If **Allow Whitelist** is enabled |
| Whitelisted role (global) | If **Allow Whitelist** is enabled |
| Whitelisted role (action) | If **Allow Whitelist** is enabled |
> **Important:** The **Allow Whitelist** setting must be enabled for whitelist exemptions to apply during Beast Mode.
## Modifying Settings
1. Go to [securitybot.gg](https://securitybot.gg/) and log in
2. Select your server from the dashboard
3. Navigate to the **Beast Mode** category
4. Adjust your settings:
* Global score limit
* Punishment type
* Allow Whitelist toggle
5. Click **Save**
## When to Use Beast Mode
Beast Mode is ideal for:
* **High-value servers** that need maximum protection
* **Servers under active attack** where you want to lock down all activity
* **Secondary protection layer** alongside Anti-Nuke
## Related
* [Anti-Nuke](/anti-nuke/anti-nuke) - Individual user limit protection
* [Anti-Raid](/other-modules/anti-raid) - Protection against mass join attacks
* [Whitelist](/whitelist/whitelist) - Exempt trusted users and roles
# Anti-Raid
> Anti-Raid protects your server from mass join attacks using a configurable score-based detection system.
## How It Works
Anti-Raid assigns risk scores to new members based on account characteristics. When the combined score of recent joins exceeds your threshold, Security can lock the server and punish detected raiders.
## Score Calculation
Each new member is evaluated on these factors:
| Factor | Description | Risk Indicator |
| --------------- | ----------------------------------------- | ------------------------------------ |
| **Account Age** | How old the Discord account is | New accounts = higher risk |
| **Join Speed** | Time since the previous member joined | Rapid joins = higher risk |
| **Avatar** | Whether the account has a profile picture | No avatar = higher risk |
| **Normal Join** | Passes all checks above | Base score (can still assign points) |
You configure how many points each factor adds to a user's score.
## Score Limit
The score limit is your threshold for triggering raid protection:
* Security tracks the combined score of all users who joined in the last X minutes
* When this combined score reaches your limit, protection activates
* All flagged users can be punished automatically
* The server can be locked to prevent new joins
## Changing Scores
Configure scores through the dashboard:
1. Go to [securitybot.gg](https://securitybot.gg/) and log in
2. Select your server from the dashboard
3. Navigate to the **Anti-Raid** category
4. Adjust the score values in the third row
5. Click **Save**
## Bypass Options
Certain users can bypass Anti-Raid detection:
| Bypass Condition | Description |
| -------------------------- | --------------------------------------------------------- |
| **Discord Badge** | Users with specific Discord badges (Nitro, Partner, etc.) |
| **Account Created Before** | Users who created their account before a specific date |
> **Note:** All bypass options are optional and can be enabled/disabled based on your needs.
## Recommended Settings
| Server Type | Score Limit | Account Age Score | Rapid Join Score |
| ------------- | ----------- | ----------------- | ---------------- |
| High Security | 10-15 | 5 | 3 |
| Standard | 20-30 | 3 | 2 |
| Lenient | 40-50 | 2 | 1 |
## Tips
* Start with stricter settings and loosen them if you get false positives
* Enable the badge bypass to reduce false positives on legitimate users
* Monitor raid attempts in your logs to tune your settings
* Consider using [Verification](/other-modules/verification) alongside Anti-Raid for additional protection
## Related
* [Verification](/other-modules/verification) - CAPTCHA verification for new members
* [Beast Mode](/other-modules/beast-mode) - Global score-based protection
* [Anti-Nuke](/anti-nuke/anti-nuke) - Protection against internal threats
# Moderation
> Security provides moderation commands with a built-in permission system. Moderators can operate with zero Discord permissions while still being protected by Anti-Nuke limits.
## Why Use Security's Moderation?
| Feature | Benefit |
| ------------------------------ | --------------------------------------------------- |
| **Zero Permission Moderation** | Moderators don't need dangerous Discord permissions |
| **Limit Protection** | Anti-Nuke limits apply to all moderation commands |
| **Audit Trail** | All actions are logged for accountability |
| **Custom Permissions** | Grant specific command access per user |
## Available Commands
| Command | Description |
| ------------ | ------------------------------------------- |
| `/ban` | Permanently ban a member |
| `/kick` | Remove a member from the server |
| `/softban` | Ban and immediately unban (clears messages) |
| `/unban` | Remove a ban |
| `/mute` | Prevent a member from sending messages |
| `/unmute` | Remove a mute |
| `/lock` | Lock a specific channel |
| `/lockall` | Lock all channels |
| `/unlock` | Unlock a specific channel |
| `/unlockall` | Unlock all channels |
| `/clear` | Delete messages in bulk |
## Who Can Use Commands?
Commands can be used by:
1. **Users with Administrator permission** and a higher role than the target
2. **Users with the relevant Discord permission** (e.g., Ban Members) and a higher role
3. **Users with Security's custom permission** for that command
## Security's Permission System
The safest way to grant moderation access. Users with custom permissions:
* Don't need Discord permissions
* Can't bypass Anti-Nuke limits
* Can only use specifically granted commands
### Add Permission
```
/permission add
```
1. Type `/permission add`
2. Select the user
3. Select the permission to grant
4. Send the command
### Remove Permission
```
/permission remove
```
1. Type `/permission remove`
2. Select the user
3. Select the permission to remove
4. Send the command
### View User Permissions
```
/permission view_user
```
1. Type `/permission view_user`
2. Select the user
3. Send the command
### View Users with Permission
```
/permission view_permission
```
1. Type `/permission view_permission`
2. Select the permission
3. Send the command
### Reset User Permissions
```
/permission reset
```
1. Type `/permission reset` (or `/permission reset_id` for user ID)
2. Select the user or enter the ID
3. Send the command
## Best Practices
* **Use custom permissions** instead of Discord permissions for moderators
* **Grant only necessary permissions** - don't give ban access if they only need mute
* **Regularly audit permissions** to remove former staff
* **Set appropriate limits** in Anti-Nuke based on expected moderation volume
## Related
* [Anti-Nuke](/anti-nuke/anti-nuke) - Limits that apply to moderation commands
* [Whitelist](/whitelist/whitelist) - Exempt trusted moderators from limits
* [Logs](/other-modules/logs) - Track moderation actions
# Verification
> Verify new members with CAPTCHA challenges before they can access your server.
## How It Works
1. New members receive the **Unverified** role
2. They can only see the verification channel
3. They must complete a CAPTCHA to verify
4. Upon verification, the Unverified role is removed and they gain access
## Setup Guide
### Step 1: Enable Verification
```
/verification enable
```
1. Type `/verification enable`
2. Send the command
3. Follow the additional prompts
### Step 2: Create Unverified Role
```
/verification setup_role
```
1. Type `/verification setup_role`
2. Send the command
3. Go to **Server Settings** > **Roles**
4. Move the **Unverified** role above your normal member roles
> **Note:** Normal roles include auto-assigned roles, reaction roles, booster roles, and mute roles. The Unverified role must be above these so it can properly restrict access.
### Step 3: Create Verification Channel
```
/verification setup_channel
```
1. Type `/verification setup_channel`
2. Send the command
This creates a channel where unverified users can complete their CAPTCHA.
### Step 4: Set Verified Role (Optional)
```
/verification set_verified
```
1. Type `/verification set_verified`
2. Select the role to give upon verification
3. Send the command
This role is granted after successful verification.
## Maintenance
### Update Role Permissions
When you create new channels, update the Unverified role permissions:
```
/verification update_role
```
This ensures unverified users cannot see new channels.
### Manually Verify Users
```
/verification verify
```
1. Type `/verification verify`
2. Select the user
3. Send the command
Use this for users having trouble with the CAPTCHA.
### Disable Verification
```
/verification disable
```
Temporarily disables verification without deleting the role or channel.
### Reset Verification
```
/verification reset
```
Completely removes verification, including the Unverified role and verification channel.
## Command Reference
| Command | Description |
| ----------------------------- | ------------------------------------- |
| `/verification enable` | Enable the verification system |
| `/verification disable` | Temporarily disable verification |
| `/verification reset` | Remove all verification components |
| `/verification setup_role` | Create the Unverified role |
| `/verification setup_channel` | Create the verification channel |
| `/verification set_verified` | Set the role given after verification |
| `/verification update_role` | Update Unverified role permissions |
| `/verification verify` | Manually verify a user |
## For Users: How to Verify
If you need to verify in a server that uses Security Bot:
1. Go to [**securitybot.gg/user/verification**](https://securitybot.gg/user/verification)
2. Log in with your Discord account
3. Find the server you want to verify in
* If you cannot find the server, click the red **"CANNOT FIND THE SERVER"** text and select it manually
4. Complete the CAPTCHA
5. Click **Submit**
If verification still doesn't work, contact the admins of that server for assistance.
## Premium Features
With Premium, you can customize:
* Verification message content
* Custom verification banners
* Additional verification options
See [Premium Features](/premium/premium-features) for details.
## Related
* [Anti-Raid](/other-modules/anti-raid) - Additional protection against mass joins
* [Premium Features](/premium/premium-features) - Customizable verification
# Logs
> Security logs all protection events and moderation actions for transparency and auditing.
## What Gets Logged
Security tracks and logs the following events:
### Anti-Nuke Events
| Event | Description |
| ------------------ | -------------------------------------- |
| Limit reached | User hit their action limit |
| Punishment applied | User was punished for exceeding limits |
| Trigger activated | A monitored action was detected |
### Anti-Raid Events
| Event | Description |
| -------------- | ----------------------------------- |
| Raid detected | Score threshold was reached |
| Server locked | Server was locked due to raid |
| Users punished | Raiders were automatically punished |
### Beast Mode Events
| Event | Description |
| -------------- | ------------------------------------------- |
| Beast awakened | Global score limit reached |
| User punished | Someone was punished while beast was active |
| Beast calmed | Beast Mode deactivated |
### Moderation Actions
| Event | Description |
| ------------ | ------------------ |
| Ban | Member was banned |
| Kick | Member was kicked |
| Mute | Member was muted |
| Channel lock | Channel was locked |
## Best Practices
* **Review logs regularly** to identify potential threats
* **Check for false positives** when tuning protection settings
## Related
* [Anti-Nuke](/anti-nuke/anti-nuke) - View Anti-Nuke triggered events
* [Moderation](/other-modules/moderation) - View moderation action logs
* [Premium Features](/premium/premium-features) - Extended log retention
