https://github.com/JonasBonno/docker-discordbot

Discord bot made by Twentysix
https://github.com/JonasBonno/docker-discordbot

Last synced: 5 days ago
JSON representation

Discord bot made by Twentysix

• Host: GitHub
• URL: https://github.com/JonasBonno/docker-discordbot
• Owner: JonasBonno
• License: mit
• Created: 2019-04-01T15:15:56.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-08-28T20:09:43.000Z (3 months ago)
• Last Synced: 2024-08-28T21:40:10.318Z (3 months ago)
• Language: Dockerfile
• Homepage: https://github.com/Twentysix26/Red-DiscordBot/tree/develop
• Size: 103 KB
• Stars: 8
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# discordbot

Red Discord Bot

made by the Cog creators at https://github.com/Cog-Creators/Red-DiscordBot

NOTE: Server config reset is required when upgrading from v1 to v3.0 or higher.

#### *Music, Moderation, Trivia, Stream Alerts and Fully Modular*  



### Setup

Running Red Discord Bot data container: 

- docker run --name [name of your data container] jonasbonno/discordbot echo 'Data-only container'

Running Red Discord Bot container: 

- docker run --tty=true --interactive=true --detach=true --restart unless-stopped --name [name of your container] --volumes-from [name of your data container] --env TOKEN="[your discord bot token]" jonasbonno/discordbot

### Obtain your Discord bot token

You can use this guide: https://docs.discord.red/en/stable/bot_application_guide.html?highlight=application%20page#creating-the-bot-application

### Environment variables

--env TOKEN=[your discord bot token] - The Discord token the Red-DiscordBot will use.

--env PREFIX=! - The prefix Red-DiscordBot will use. Default set to "!" if you don't specify it.

### On first start

- Grant the bot privileged intents: https://docs.discord.red/en/stable/bot_application_guide.html?highlight=Enabling%20Privileged%20Intents#enabling-privileged-intents

- Accept "Invite URL", run command to show it: docker logs [name of your container]

- Set bot permissions: https://docs.discord.red/en/stable/getting_started.html?highlight=moderator%20Administrator#administrator

### Upgrading container

The container is created with a volume exposed that is able to be mounted elsewhere containing the Red Discord Bot data folder so when running the two containers as described in the setup-section upgrading is done simply by creating a new docker container:

- docker stop [name of your CURRENT container]

- docker image pull jonasbonno/discordbot

- docker run --tty=true --interactive=true --detach=true --restart unless-stopped --name [name of your NEW container] --volumes-from [name of your CURRENT data container] --env TOKEN="[your discord bot token]" jonasbonno/discordbot

After verifying the upgrade succeeded you can safely delete the old container with the following command: docker container rm [name of your OLD container]

### Overview

Red is a fully modular bot – meaning all features and commands can be enabled/disabled to your liking, making it completely customizable. This is a self-hosted bot – meaning you will need to host and maintain your own instance. You can turn Red into an admin bot, music bot, trivia bot, new best friend or all of these together!

### Tips

- Set admin role: !set addadminrole [your discord admin group]

- Set moderator role: !set addmodrole [your discord moderator group]

- Show loaded and unloaded cogs: !cogs

- Load music cog: !load music

**The default set of modules includes and is not limited to:**

- Moderation features (kick/ban/softban/hackban, mod-log, filter, chat cleanup)

- Trivia (lists are included and can be easily added)

- Music features (YouTube, SoundCloud, local files, playlists, queues)

- Stream alerts (Twitch, Youtube, Hitbox, Picarto)

- Bank (slot machine, user credits)

- Custom commands

- Imgur/gif search

- Admin automation (self-role assignment, cross-server announcements, mod-mail reports)

- Customisable command permissions