christom/soundbored repository overview

⁠Prerequisites

1. A bot token with the following permissions:

• Send Messages
• Read Message History
• View Channels
• Connect
• Speak

NOTE: Also remember to go under Bot and select PRESENCE INTENT, SERVER MEMBERS INTENT and MESSAGE CONTENT INTENT

You then need to invite the bot to your server by going to Oauth2, checking bot and then checking the same permisions as above. You can then take the generated URL at the bottom and invite the bot.

1. If you want to host publicly, a domain name is required so people can access your Soundbored instance.

2. Under Redirect in Oauth2 put your domain like https://your.domain.com/auth/discord/callback in the Discord Developer Portal. Copy the Client ID and Client Secret as you will need them for the environment variables below.

3. You will need to host this publicly somewhere for other users to be able to use it. I recommend using Digital Ocean⁠ for this as its cheap and you can deploy Docker images directly.

⁠Setup

The Docker needs the following environment variables, check .env.example:

DISCORD_TOKEN=your_actual_discord_token
DISCORD_CLIENT_ID=your_actual_client_id
DISCORD_CLIENT_SECRET=your_actual_client_secret
# Change this to your domain or to localhost if you're running locally
PHX_HOST=your.domain.com
# change this to http if running locally
SCHEME=https
# Change these to password protect your soundboard
BASIC_AUTH_USERNAME=admin
BASIC_AUTH_PASSWORD=admin

⁠Deployment

The application is containerized and published to Docker Hub. You can pull it with docker pull christom/soundbored:latest. Or run immediately in localhost with: docker run -d -p 4000:4000 --env-file ./.env christom/soundbored.