Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/onesoft-sudo/sudobot/llms.txt

Use this file to discover all available pages before exploring further.

SudoBot is a powerful, open source Discord bot built for server moderation. It gives you full control over your moderation tools — from manual ban and mute commands to AI-powered auto-moderation, custom message rules, and a flexible extension system. Self-host it on your own infrastructure or use a pre-hosted instance.

Quick Start

Install SudoBot and get your bot running in minutes with step-by-step instructions.

Auto Moderation

Set up spam detection, raid protection, AI content filtering, and message rules.

Moderation Commands

Explore all available moderation commands: ban, kick, mute, warn, and more.

Permission System

Configure Discord-based, level-based, or advanced permission role overrides.

What SudoBot can do

SudoBot covers the full range of Discord server moderation needs, from routine command-based actions to sophisticated automated systems.

Welcomer System

Greet new members with customizable welcome messages and randomized content.

AFK System

Let members set AFK status with automatic mention tracking and notifications.

Snippets

Create reusable text and attachment snippets for quick responses.

Reaction Roles

Assign roles to members automatically when they react to messages.

Queues & Scheduling

Schedule moderation actions to run at a later time with the queue system.

Extensions

Extend SudoBot with custom functionality using the extension API.

Get started

1

Set up a Discord application

Go to the Discord Developer Portal, create a new application, and get your bot token and client ID.
2

Install and build SudoBot

Clone the repository and build SudoBot using BlazeBuild, the included build tool that automatically installs required dependencies.
3

Configure your environment

Create a .env file with your bot token, database URL, and other required settings. Copy the default config files to your storage prefix.
4

Run the bot

Start SudoBot with ./blazew run and register your slash commands. Your bot will appear online in your Discord server.
If you don’t want to self-host, you can request a free pre-hosted instance by contacting the maintainer on Discord.

Deploy SudoBot

Docker

Run SudoBot in a container with the official Docker image and Compose setup.

Kubernetes

Deploy SudoBot on Kubernetes with included manifests for production use.

Process Management

Use PM2 to keep SudoBot running continuously with automatic restarts.

Database Migrations

Manage your PostgreSQL schema with BlazeBuild’s migration tooling.

Build docs developers (and LLMs) love