Skip to main content

​
Quickstart

1
Invite Guardian to your server
2
Click the button below and select your server. The bot requires the following permissions to function correctly — do not uncheck any of them.
3
4
Guardian needs Administrator permission at setup time to create roles and channels. Once setup is complete you can reduce permissions to the minimum required list (see Minimal Permission Set below).
5
Run /setup
6
In any channel where Guardian can speak, type:
7
/setup
8
Guardian will automatically:
9
  • Create a Guardian-Quarantine role (no permissions — restricts new accounts)
  • Create a #guardian-logs private staff channel
  • Configure multi-window raid detection thresholds
  • Connect to phishing databases (PhishTank, Google Safe Browsing, VirusTotal)
  • Enable the 24-hour account quarantine system
    • 10
    The entire process takes less than 5 seconds.
    11
    Run /guardian doctor after setup to verify that every component is healthy and that the role hierarchy is correct.
    12
    Verify with /guardian health
    13
    /guardian health
    14
    You should see a Security Score above 80/100. If any module shows a warning, the doctor command will tell you exactly what to fix.

    ​
    What Happens Next (Automatically)

    Once /setup completes, you don’t need to do anything else. Guardian works silently in the background:
    EventGuardian’s Response
    Member joins with account < 24 hQuarantine role applied immediately
    Raid detected (multiple rapid joins)Lock triggered; suspicious members flagged
    Member posts a phishing linkMessage deleted; member warned or banned
    Member submits /report with a confirmed linkInstant Global Ban across the network
    Admin deletes channels rapidlySnapshot triggered; restore button sent to staff

    ​
    Minimal Permission Set

    After the initial setup, you can restrict Guardian’s permissions to:
    PermissionWhy it’s needed
    Manage RolesApply/remove quarantine role
    Manage ChannelsRestore deleted channels from snapshots
    Ban MembersExecute Global Ban when phishing is confirmed
    Kick MembersRemove quarantined members who fail verification
    View ChannelsMonitor all channels for phishing links
    Send MessagesPost alerts and embeds
    Embed LinksRich embed alerts
    Read Message HistoryScan recent messages on join
    Administrator is only required during /setup to create the initial role/channel structure. You can remove it immediately after.

    ​
    Docker Self-Hosting (Optional)

    If you prefer to host Guardian yourself: 
    # 1. Clone the repository
git clone https://github.com/your-org/guardianbot.git && cd guardianbot

# 2. Configure environment
cp .env.example .env
nano .env   # Fill in DISCORD_TOKEN and DB_PASSWORD at minimum

# 3. Start all services
docker compose up -d

# 4. Check logs
docker compose logs -f guardian-bot
    Set a strong REDIS_PASSWORD and DB_PASSWORD in your .env before starting. The default values in .env.example are placeholders only.
    The only ports exposed to the internet are 80 and 443 (Nginx). Everything else — the bot, the dashboard, Redis, PostgreSQL — communicates on an isolated internal Docker network.