Buddy Bot

Instructions on using our most important tool

What is Buddy Bot?

Buddy bot is a lightweight tool written in Typescript that reminds Reclass members to clock in and out with style.

How to use buddy bot

Like all our greatest tools, buddy bot runs in a docker container and can be pulled from our repo:

docker pull projectreclass/buddy-bot:latest

Running Buddy Bot

First you'll need to mount a file to buddy bot you can use our default config by running wget on the following: https://raw.githubusercontent.com/Project-Reclass/buddy-bot-slack/master/default-config.json

From here you can mount the file to image:

docker run -d -v $(pwd)/default-config.json:/app/dist/default-config.json \
-e $SLACK_TOKEN --name buddy-bot projectreclass/buddy-bot:latest

The above runs a new container with docker run

The -d runs the container in the background

The -v flag sets the volume option to be mounted. This creates a directory but can be a directory or file

Afterwards we specify the file location to mounted, and a place to mount it within the container $(pwd)/default-config.json:/app/dist/default-config.json

Then, we add our slack token so it can talk to the channels specified the -e $SLACK_TOKEN creates an environment variable within the container

Next, we name the container buddy_bot with --name buddy_bot

Finally, this command requires an image for an argument in this case it can be the image ID or the image and tag. We use the image name and tag for simplcity: projectreclass/buddy-bot:latest