Red

Applications
Report Issue

A multifunction Discord bot https://github.com/Cog-Creators/Red-DiscordBot

Contributors:
danielb@purpleflaghosting.com
README

Red-DiscordBot

From their Github

A multifunction Discord bot

Server Ports

No port are required to run Red.

if you want to use the internal Lavalink Server, you need to allocate port 2333 as primary

Additional Requirements

When using the Audio Cog the bot will attempt to save files to /tmp resulting in a disk space error. You may also see this same error when attempting to install a cog, due to pip using /tmp to build the requirements. To resolve this error you must increase the size of tmpfs using custom container policy.

For additional details see: https://pterodactyl.io/wings/1.0/configuration.html#other-values

Mods/Plugins may require ports to be added to the server

Docker Images (1)
Name Image
ghcr.io/ptero-eggs/yolks:bot_red ghcr.io/ptero-eggs/yolks:bot_red
Startup Command 
PATH=$PATH:/home/container/.local/bin redbot pterodactyl --token {{TOKEN}} --prefix {{PREFIX}}
Variables (3)

Discord Bot Token

Get your own token here - https://discordapp.com/developers/applications/

Environment:
TOKEN
Default:
GET_YOUR_OWN
User Viewable:
❌
User Editable:
❌
Rules:
required|string

Command Prefix

The prefix for commands from the bot.

Environment:
PREFIX
Default:
.
User Viewable:
❌
User Editable:
❌
Rules:
required|string

Owner

Owner of the Bot to use special commands

Environment:
OWNER
Default:
None
User Viewable:
❌
User Editable:
❌
Rules:
required|string|max:30
Installation Script
Container: python:3.11-slim
Entrypoint: bash
#!/bin/bash
# red-discordbot install script

## install deps
mkdir -p /usr/share/man/man1
apt update
apt -y install git ca-certificates dnsutils iproute2 make build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm libncurses5-dev xz-utils tk-dev libxml2-dev libxmlsec1-dev libffi-dev liblzma-dev libgdbm-dev uuid-dev git

## config folder layouts
echo -e "generating config folder layout"
mkdir -p /mnt/server/.config/{Red-DiscordBot,share}/ /mnt/server/.local/share/Red-DiscordBot/data/pterodactyl/
cd /mnt/server/
ln -s .local/share/Red-DiscordBot/data/pterodactyl/ ./configs

## install red
echo -e "add container user to install"
ln -s /mnt/server/ /home/container
useradd -m -d /home/container container
chown -R container /mnt/server/
echo -e "install red locally as user"
pip install --upgrade pip
su - container -c 'pip install -U pip wheel --no-warn-script-location'
su - container -c 'pip install -U Red-DiscordBot --no-warn-script-location'

## ensure the config is in place if it doesn't exist
if [ ! -f /mnt/server/.config/Red-DiscordBot/config.json ]; then
    curl https://raw.githubusercontent.com/ptero-eggs/application-eggs/main/bots/discord/redbot/config.json -o /mnt/server/.config/Red-DiscordBot/config.json
fi

echo "-------------------------------------------------------"
echo "Installation completed"
echo "-------------------------------------------------------"