Corlink Discord Bot

This is the bot that allows for easy interaction with Corlink. Want to see the docs for the API? Click here.

Setup

There are 3 ways of setting up the Corlink Discord bot:

Create the Bot

  1. Go to the Discord Developer Portal.
  2. Click on New Application.
  3. Fill in the Name and click Create.
  4. Click on Bot in the left-hand menu.
  5. Click on Add Bot.
  6. Click on Copy under Token to copy the bot token.

Docker

This is one of the easiest ways to get the Corlink Discord bot up and running.

Prerequisites

  • Docker
  • A discord bot token. (See setup here(#create-the-bot))

Steps

  1. Pull the image.
docker pull ghcr.io/ruby-network/corlink-bot:latest
  1. Create a .env file with the following content:
DISCORD_TOKEN=your_discord_token
GUILD_ID=your_guild_id
LICENSING_SERVER_URL=your_licensing_server_url
LICENSING_SERVER_KEY=your_licensing_server_key
OWNER_ID=your_owner_id
  1. Run the image.
docker run -d --env-file .env ghcr.io/ruby-network/corlink-bot:latest

This is the recommended way of setting up the Corlink Discord bot. It is the easiest and fastest way to get the Corlink Discord bot up and running.

Prerequisites

Steps

  1. Acquire the docker-compose.yml file from the Corlink repository.
    • You can find the file here.
  2. Edit the docker-compose.yml files environment variables.
Make sure to change the DISCORD_TOKEN to your discord bot token.
VariableDescription
DISCORD_TOKENA discord token associated with a bot. (See setup here)
GUILD_IDThe guild ID of the discord server.
LICENSING_SERVER_URLThe URL of the licensing server.
LICENSING_SERVER_KEYThe key of the licensing server.
OWNER_IDThe owner ID of the discord bot (or the server).
  1. Run the docker-compose.yml file.
docker-compose up -d
  1. You should now have the Corlink Discord bot up and running.

Manual

This is the most complex way of setting up the Corlink Discord bot. It is not recommended for beginners.

Prerequisites

Steps

  1. Clone the repository.
git clone https://github.com/ruby-network/corlink.git
  1. Change directory to the bot folder.
cd corlink/bot
  1. Install the dependencies.
bundle install
  1. Edit the .env file with your content and credentials.
  2. Run the bot.
bundle exec ruby main.rb
  1. You should now have the Corlink Discord bot up and running.
Edit this page on GitHub
Table of Contents