Docker Guide¶

Prerequisites¶

Docker Core Engine
Docker Compose (optional, but recommended)

Creating a Discord Bot & Getting Credentials

Creating your own Discord bot¶

This guide will show you how to create your own discord bot, invite it to your server, and obtain the credentials needed to run it.

Go to the Discord developer application page.
Log in with your Discord account.
Click New Application.
Fill out the Name field however you like, accept the terms, and confirm.
Go to the Bot tab on the left sidebar.
Click on the Add a Bot button and confirm that you do want to add a bot to this app.
Optional: Add bot's avatar and description.
Copy your Token to creds.yml as shown above.
Scroll down to the Privileged Gateway Intents section
- You MUST enable the following:
  - PRESENCE INTENT
  - SERVER MEMBERS INTENT
  - MESSAGE CONTENT INTENT

Inviting your bot to your server¶

Invite the bot to your server

On the General Information tab, copy your Application ID from your applications page.
Replace the YOUR_CLIENT_ID_HERE in this link: https://discordapp.com/oauth2/authorize?client_id=YOUR_CLIENT_ID_HERE&scope=bot&permissions=66186303 with your Client ID
The link should now look something like this: https://discordapp.com/oauth2/authorize?client_id=123123123123&scope=bot&permissions=66186303
Access that newly created link, pick your Discord server, click Authorize and confirm with the captcha at the end
The bot should now be in your server

Installing NadekoBot with Docker¶

When deploying NadekoBot with Docker, you have two options: using Docker or Docker Compose. The following sections provide step-by-step instructions for both methods.

DockerDocker Compose

Deploying NadekoBot with Docker¶

Move to a directory where you want your Nadekobot's data folder to be (data folder will keep the database and config files) and create a data folder there.
```
cd ~ && mkdir nadeko && cd nadeko && mkdir data
```
Mount the newly created empty data folder as a volume while starting your docker container. Replace YOUR_TOKEN_HERE with the bot token obtained from the creds guide above.
```
docker run -d --name nadeko ghcr.io/nadeko-bot/nadekobot:v6 -e bot_token=YOUR_TOKEN_HERE -v "./data:/app/data" && docker logs -f --tail 500 nadeko
```
Enjoy! 🎉

Updating your bot¶

If you want to update nadekobot to the latest version, all you have to do is pull the latest image and re-run.

Pull the latest image

docker pull ghcr.io/nadeko-bot/nadekobot:v6

Re-run your bot the same way you did before

docker run -d --name nadeko ghcr.io/nadeko-bot/nadekobot:v6 -e bot_token=YOUR_TOKEN_HERE -v "./data:/app/data" && docker logs -f --tail 500 nadeko

Done! 🎉

Choose Your Workspace: Select a directory where you'll set up your NadekoBot stack. Use your terminal to navigate to this directory. For the purpose of this guide, we'll use /opt/stacks/nadeko/ as an example, but you can choose any directory that suits your needs.
Create a Docker Compose File: In this directory, create a Docker Compose file named docker-compose.yml. You can use any text editor for this task. For instance, to use the nano editor, type nano docker-compose.yml.

Configure Your Docker Compose File: Populate your Docker Compose file with the following configuration:

services:
  nadeko:
    image: ghcr.io/nadeko-bot/nadekobot:v6
    container_name: nadeko
    restart: unless-stopped
    environment:
      TZ: Europe/Rome # Modify this to your timezone
      bot_token: YOUR_TOKEN_HERE
    volumes:
      - /opt/stacks/nadeko/data:/app/data
networks: {}

Launch Your Bot: Now, you're ready to run Docker Compose. Use the following command: docker compose up -d.
Navigate to Your Directory: Use cd /opt/stacks/nadeko/ to go to the directory containing your Docker Compose file.
Pull the Latest Images: Use docker compose pull to fetch the latest images.
Restart Your Containers: Use docker compose up -d to restart the containers.