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 provides prebuilt packages for common Linux distributions so you can install it without building from source. Packages are published with each release on the GitHub releases page in two variants: a generic package that bundles all dependencies, and a nodeps package for advanced users who prefer to manage Node.js and NPM themselves.
If you are new to SudoBot, start with the generic package. It includes Node.js and all other required dependencies and is the easiest path to a working installation.

​
Debian and Ubuntu

1

Add the NodeSource repository (recommended)

The NodeSource repository provides up-to-date Node.js builds for Debian-based systems. Adding it ensures you have a compatible Node.js version even if the system package is outdated:
curl -fsSL https://deb.nodesource.com/setup_24.x | sudo bash -
2

Download the package

Go to the GitHub releases page and download the .deb file for the latest release. Choose sudobot_<version>_all.deb for the generic package or sudobot-nodeps_<version>_all.deb for the nodeps variant.
3

Install the package

# Generic package (includes dependencies)
sudo apt install ./sudobot_<version>_all.deb

# nodeps package (you manage Node.js separately)
sudo apt install ./sudobot-nodeps_<version>_all.deb
Replace <version> with the actual version number from the filename you downloaded.

​
Fedora, RHEL, and CentOS

1

Download the package

Go to the GitHub releases page and download the .rpm file. Choose sudobot-<version>.noarch.rpm for the generic package or sudobot-nodeps-<version>.noarch.rpm for the nodeps variant.
2

Install the package

# Generic package (includes dependencies)
sudo dnf install ./sudobot-<version>.noarch.rpm

# nodeps package (you manage Node.js separately)
sudo dnf install ./sudobot-nodeps-<version>.noarch.rpm

​
Other Linux distributions

For distributions that do not use .deb or .rpm packages, SudoBot is also released as a .tar.gz archive containing precompiled JavaScript files. Download the archive from the GitHub releases page, extract it, and install Node.js and NPM from your distribution’s package manager or from the Node.js website.

​
After installation

Once the package is installed, configure SudoBot before starting it. Set your environment variables (bot token, database URL, etc.) in the configuration file placed by the installer, and ensure your SUDO_PREFIX directory contains a valid config/config.json and config/system.json. Then start the bot using your init system.
Most modern Linux distributions use systemd. The package registers a sudobot service automatically.
# Start the bot
sudo systemctl start sudobot

# Check service status
sudo systemctl status sudobot

# Enable auto-start on boot
sudo systemctl enable sudobot

# Disable auto-start on boot
sudo systemctl disable sudobot

​
Manual foreground mode

To run SudoBot directly in the foreground without an init system — useful for debugging — use: 
sudo su sudobot -s /bin/sh -c /usr/bin/sudobot
Press Ctrl+C to stop the process.

​
Next steps

After the bot is running, register your slash commands and set up custom emojis:

Quickstart guide

See the full setup guide including command registration and emoji setup.

Environment variables

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

Build docs developers (and LLMs) love

Get started for freeTalk to us