tmatis / gradient

A discord music bot with a cool dashboard

Gradient

A discord music bot with a cool dashboard.

Setup instructions

requirements

• Docker
• Docker Compose

setup

clone the repository

git clone https://github.com/tmatis/gradient.git
cd gradient

setup environment variables

Copy the following environment variables into a file named .env in the root of the project.

DOMAIN_NAME=
EMAIL=
DISCORD_TOKEN=
JWT_SECRET=
YOUTUBE_API_KEY=

• DOMAIN_NAME is the domain name of the server. your need to have a DNS record pointing to the server. to generate a certificate for the domain name, certbot is used.
• EMAIL is the email address used to generate the certificate.
• DISCORD_TOKEN is the token of the discord bot. see here for more information.
• JWT_SECRET is the secret used to sign the JWT tokens. it can be any string. it is recommended to use a random string.
• YOUTUBE_API_KEY is the API key used to fetch the videos from youtube. see here for more information. Note: the youtube API key is required to fetch channel content but is not required to fetch playlist, search results or videos.

start the app

Start the server with the following command.

docker-compose up

if you don't see any error you can detach from the process with Ctrl + C and run the following command to start the server in the background.

docker-compose up -d

stop the app

docker-compose down

update the app

git pull
docker-compose down
docker-compose up -d