ferrisbot-for-discord

Rustbot

Inviting the bot

Some permissions are required:

Send Messages: base command functionality
Manage Roles: for ?rustify command
Manage Messages: for ?cleanup command
Add Reactions: for ?rustify command feedback Furthermore, the applications.commands OAuth2 scope is required for slash commands.

Here's an invite link to an instance hosted by me on my Raspberry Pi, with the permissions and scopes incorporated: https://discord.com/oauth2/authorize?client_id=804340127433752646&permissions=268445760&scope=bot%20applications.commands

Adjust the client_id in the URL for your own hosted instances of the bot.

Hosting the bot

The bot requires Server Members Intent enabled in the Applications > $YOUR_BOTS_NAME > Bot settings of Discord's developer portal.

Run the bot using cargo run --release.

You will need to provide several environment variables. A convenient way to do this is to copy the .env.example file to .env and fill out the values. Then run the bot with the .env file applied.

Also set SQLX_OFFLINE to true if you're running the bot for the first time. Otherwise, SQLx will try to call into the database to check query correctness, which fails if the database hasn't been set up yet.

Example command-line for Linux: set -a && source .env && set +a && SQLX_OFFLINE=true cargo run --release

Docker

This project has a Containerfile, so you can use Docker or Podman to run this bot if you wish. For that, rename the .env.example file into .env, fill out the values, and run the command:

docker-compose -f container-compose.yaml up -d --build

Currently we're using Docker to run it, but eventually we'll make it work with just podman.

Credits