Skip to content

How to run

Jack Belford edited this page Jan 2, 2022 · 11 revisions

Requirements

  • Linux Environment
  • Node 16 LTS
  • Yarn
  • Mongo
  • YouTube API key
  • Spotify API key
  • Discord token

Note: Bot may not work in non-linux environments. Using Docker may be easier to run for self-hosting

Optional

  • Bing API key (improves Spotify stream results)
  • SoundCloud Api key (sort of optional. Bot will respond with error if user attempts to stream soundcloud)

Steps

  1. Clone this project
  2. yarn install
  3. Set environment variables.
    • See src\common\env.ts for the full list of environment variables
    • This project uses DotEnv so you can add them to a .env file in the project root
  4. yarn run build
  5. yarn start

Troubleshooting

How to get SoundCloud key?

You will need a client id and secret. However, SoundCloud does not accept new API application. You can use placeholder values for these environment variables and the bot will still work. However, anytime the bot tries to do something with SoundCloud it will fail.

Docker Alternative

Docker may be a faster way to get up and running and will avoid installation issues.

Simply build the image and run the container. You will still need to pass the required environment variables when running the container.

Docker Example

docker build . -t eolian:latest
docker run --env-file ./.env -d -p 80:80 eolian:latest