This is a private bot. To get this bot in your server, please host this yourself. It is very easy to do so and there are instructions on how to do so. The easiest approach is to host it on Heroku. The best approach would be to host it on a cloud VM.
Create a .env file in the root of your project folder. You can use .env.example as a starting point.
Fill in your own DISCORD_BOT_CLIENT_ID and DISCORD_BOT_TOKEN for development / your bot deployment.
Optional variables:
SLASH_COMMANDS_GUILD_ID, which will only be used in development environments for easier slash command testing.YOUTUBE_API_KEY, which is used to fetch playlist videos for the player commands.SPOTIFY_CLIENT_IDandSPOTIFY_CLIENT_SECRET, which are used to fetch playlist tracks for the player commands.
ENVIRONMENT=development
PORT=3000
DISCORD_BOT_CLIENT_ID=...
DISCORD_BOT_TOKEN=...
DATABASE_URL=postgres://user:password@utility-discord-bot-db:5432/utility-discord-bot-db
YOUTUBE_API_KEY=...
SPOTIFY_CLIENT_ID=...
SPOTIFY_CLIENT_SECRET=...
# Slash Commands in Development
SLASH_COMMANDS_GUILD_ID=...
If you are creating these environment variables for a cloud VM, make sure to change ENVIRONMENT to production, and replace DATABASE_URL with your production database URL (either the one from Heroku, or another service that you have set up).
-
If you want to contribute to the code, you will need to create a
.envfile in the root of the repository and use the template listed below. -
You will probably want to create two discord bots on the Discord Developer Portal (development and production) following steps 1 and 2 of previous section.
Use the development bot token for your local
.envfile an the production bot token in your Heroku config var. That way, your production bot won't collide with your development bot (listening/responding to events/commands). You may then want to create a test discord server and invite only your development bot into it. Any other servers can have the production bot invited to them. -
You can replace
DATABASE_URLin your.envfile with your Heroku database URL (look up your database credentials on the Heroku platform), but if you do this, make sure to also changeENVIRONMENTtoproduction(required to connect to database with the required SSL). -
Install Docker and run
docker-compose upto run the bot. That's it. -
You can opt to not use Docker and instead run
npm run dev. By doing this, Docker will no longer deploy Postgres for you, so you will have errors connecting to a database. To solve this, you can easily use your production database instead by following step 3.
The best way to run this bot on a VM (like an EC2 instance or GCE instance) is to run a docker container. This is not necessary for Heroku. Instructions for how to do this on AWS are in the AWS instructions.
If you would like to make your own code changes and build your own Docker images, instructions are here.
The platform architectures supported for Docker are: linux/amd64, linux/arm64, and linux/arm/v7.
This repository is linked to a Heroku app which automatically deploys updates to the privately hosted bot when commits are made to master. The following invites will only work for myself and whitelisted members.