Skip to content

DOCKER_README.md

Latest commit

 

History

History
104 lines (91 loc) · 4.21 KB

DOCKER_README.md

File metadata and controls

104 lines (91 loc) · 4.21 KB

Docker

Using docker run

Create and run the container (substitute your <values>):

docker run -d \
  --name=lizardbyte-support-bot \
  --restart=unless-stopped \
  -e DISCORD_BOT_TOKEN=<DISCORD_BOT_TOKEN> \
  -e DAILY_CHANNEL_ID=<DAILY_CHANNEL_ID> \
  -e DAILY_RELEASES=<DAILY_RELEASES> \
  -e DAILY_TASKS=<DAILY_TASKS> \
  -e DAILY_TASKS_UTC_HOUR=<DAILY_TASKS_UTC_HOUR> \
  -e GRAVATAR_EMAIL=<GRAVATAR_EMAIL> \
  -e IGDB_CLIENT_ID=<IGDB_CLIENT_ID> \
  -e IGDB_CLIENT_SECRET=<IGDB_CLIENT_SECRET> \
  -e PRAW_CLIENT_ID=<PRAW_CLIENT_ID> \
  -e PRAW_CLIENT_SECRET=<PRAW_CLIENT_SECRET> \
  -e PRAW_SUBREDDIT=<PRAW_SUBREDDIT> \
  -e DISCORD_WEBHOOK=<DISCORD_WEBHOOK> \
  -e GRAVATAR_EMAIL=<GRAVATAR_EMAIL> \
  -e REDIRECT_URI=<REDIRECT_URI> \
  -p 8080:8080 \
  lizardbyte/support-bot

To update the container it must be removed and recreated:

# Stop the container
docker stop lizardbyte-support-bot
# Remove the container
docker rm lizardbyte-support-bot
# Pull the latest update
docker pull lizardbyte/support-bot
# Run the container with the same parameters as before
docker run -d ...

Using docker-compose

Create a docker-compose.yml file with the following contents (substitute your <values>):

version: '3'
services:
  lizardbyte-discord-bot:
    image: lizardbyte/support-bot
    container_name: lizardbyte-support-bot
    restart: unless-stopped
    environment:
      - DISCORD_BOT_TOKEN=<DISCORD_BOT_TOKEN>
      - DAILY_CHANNEL_ID=<DAILY_CHANNEL_ID>
      - DAILY_RELEASES=<DAILY_RELEASES>
      - DAILY_TASKS=<DAILY_TASKS>
      - DAILY_TASKS_UTC_HOUR=<DAILY_TASKS_UTC_HOUR>
      - GRAVATAR_EMAIL=<GRAVATAR_EMAIL>
      - IGDB_CLIENT_ID=<IGDB_CLIENT_ID>
      - IGDB_CLIENT_SECRET=<IGDB_CLIENT_SECRET>
      - PRAW_CLIENT_ID=<PRAW_CLIENT_ID>
      - PRAW_CLIENT_SECRET=<PRAW_CLIENT_SECRET>
      - PRAW_SUBREDDIT=<PRAW_SUBREDDIT>
      - DISCORD_WEBHOOK=<DISCORD_WEBHOOK>
      - GRAVATAR_EMAIL=<GRAVATAR_EMAIL>
      - REDIRECT_URI=<REDIRECT_URI>
    ports:
      - 8080:8080

Create and start the container (run the command from the same folder as your docker-compose.yml file):

docker-compose up -d

To update the container:

# Pull the latest update
docker-compose pull
# Update and restart the container
docker-compose up -d

Parameters

You must substitute the <values> with your own settings.

Parameter Required Default Description
DISCORD_BOT_TOKEN True None Token from Bot page on discord developer portal.
DAILY_TASKS False true Daily tasks on or off.
DAILY_RELEASES False true Send a message for each game released on this day in history.
DAILY_CHANNEL_ID False None Required if daily_tasks is enabled.
DAILY_TASKS_UTC_HOUR False 12 The hour to run daily tasks.
GRAVATAR_EMAIL False None Gravatar email address for bot avatar.
IGDB_CLIENT_ID False None Required if daily_releases is enabled.
IGDB_CLIENT_SECRET False None Required if daily_releases is enabled.
PRAW_CLIENT_ID True None client_id from reddit app setup page.
PRAW_CLIENT_SECRET True None client_secret from reddit app setup page.
PRAW_SUBREDDIT True None Subreddit to monitor (reddit user should be moderator of the subreddit)
DISCORD_WEBHOOK False None URL of webhook to send discord notifications to
REDIRECT_URI True None The redirect URI entered during the reddit application setup

Further instructions can be found in the main readme.