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 free and open source Discord bot built for server moderation. Licensed under the GNU Affero General Public License v3.0, it gives you full ownership of your moderation setup — you can self-host it on your own infrastructure, inspect the code, and extend it however you need. It has been actively maintained since 2022 and runs on Node.js or Bun.

What SudoBot offers

SudoBot covers the full spectrum of Discord moderation, from everyday manual commands to sophisticated automated systems. Whether you run a small community or a large server, SudoBot provides the tools to keep it safe and well-managed.

Auto-moderation

Anti-spam, anti-raid, AI content filtering, and custom message rules that respond automatically.

Moderation commands

Ban, kick, mute, warn, soft-ban, timeout, and more — with full infraction tracking.

Permission system

Discord-based, level-based, or advanced role override permissions to control who can do what.

Extension API

Add custom functionality to your SudoBot instance using the built-in extension system.

Welcomer

Send customizable welcome messages to new members with support for randomized content.

AFK system

Let members declare AFK status with automatic mention tracking and return notifications.

Snippets

Define reusable text and attachment snippets your moderators can send with a command.

Reaction roles

Automatically assign or remove roles when members react to designated messages.

How to run SudoBot

SudoBot is designed for self-hosting. You build it from source using BlazeBuild, configure a .env file with your bot credentials and database URL, and run it with a single command. You can also deploy it using Docker or install it via Linux packages.

Quickstart

Clone, build, configure, and launch SudoBot step by step.

Docker setup

Run SudoBot and its PostgreSQL database together using Docker Compose.

Linux packages

Install SudoBot via .deb or .rpm packages for Debian, Ubuntu, Fedora, and RHEL.

Environment variables

Reference for all environment variables that control SudoBot’s behavior.

Community and support

If you run into issues or have questions, the following resources are available:
If you don’t want to self-host, you can contact @rakinar2 on Discord to request a free pre-hosted instance.

Project information

SudoBot is maintained by Ar Rakin and contributors. The source code is available on GitHub and the OSN Subversion repository. Release tarballs are distributed via the OSN download server. The bot is licensed under the GNU Affero General Public License v3.0. Custom emojis are licensed under CC BY 4.0.

Build docs developers (and LLMs) love