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 designed for self-hosting and ships with everything you need to run it reliably in production. You can deploy it directly on a Linux server using Node.js and PM2, in a container with Docker Compose, or at scale on Kubernetes.

Deployment methods

Docker Compose

The fastest way to get SudoBot running. Starts the bot, PostgreSQL, and Adminer with a single command.

Kubernetes

Production-grade deployment with the included manifests for Deployments, Services, PVCs, and Secrets.

Process Management (PM2)

Run SudoBot directly on a Linux server with PM2 for automatic restarts and log management.

Manual (Node.js / Bun)

Run the bot directly for development or simple single-server setups.

Requirements

All deployment methods share the same core requirements:
RequirementDetails
PostgreSQLv14 or later. Can be on the same host, in a container, or a cloud service (Supabase, Neon, etc.)
Node.jsv21 or later (not needed for Docker deployments)
Bun (optional)v1.1.12 or later — faster alternative to Node.js
RAM512 MB minimum, 2 GB recommended for building from source
Disk~500 MB for bot and dependencies

Environment variables

Every deployment method requires the same core environment variables. See Environment Variables for the full reference. The minimum required set:
TOKEN=your-discord-bot-token
CLIENT_ID=your-discord-client-id
CLIENT_SECRET=your-discord-client-secret
HOME_GUILD_ID=your-home-guild-id
DB_URL=postgresql://user:password@host:5432/sudobot
JWT_SECRET=your-random-jwt-secret
SUDO_PREFIX=/path/to/storage

Choosing a deployment method

  • Just getting started? Use Docker Compose — it sets up the bot and database together.
  • Running in production on a single VM? Use PM2 with a managed database.
  • Need high availability or orchestration? Use Kubernetes.

Build docs developers (and LLMs) love