Sign inSign up

kratochj/slack-george-bot

By kratochj

Updated over 9 years ago

Core slack bot - web + bot

Image
0

1.3K

kratochj/slack-george-bot repository overview

GeorgeBot

The GeorgeBot is a Slack bot that collects daily standups from team members.

Running the GeorgeBot

To run the GeorgeBot you must have an API token to authenticate the bot on your slack channel. Once you get it (instructions on the next paragraph) you just have to run:

BOT_API_KEY=somesecretkey node bin/bot.js

Getting the API token for your Slack channel

To allow the GeorgeBot to connect your Slack channel you must provide him an API key. To retrieve it you need to add a new Bot in your Slack organization by visiting the following url: https://yourorganization.slack.com/services/new/bot, where yourorganization must be substituted with the name of your organization (e.g. https://kratochvilovi.slack.com/services/new/bot). Ensure you are logged to your Slack organization in your browser and you have the admin rights to add a new bot.

You will find your API key under the field API Token, copy it in a safe place and get ready to use it.

Configuration

The GeorgeBot is configurable through environment variables. There are several variable available:

Environment variableDescription
BOT_API_KEYthis variable is mandatory and must be used to specify the API token needed by the bot to connect to your Slack organization
BOT_DB_PATHoptional variable that allows you to use a different database or to move the default one to a different path
BOT_NAMEthe name of your bot, it’s optional and it will default to georgebot

Launching the bot from source

If you downloaded the source code of the bot you can run it using NPM with:

$ npm start

Don't forget to set your BOT_API_KEY environment variable bedore doing so. Alternatively you can also create a file called token.js in the root folder and put your token there (you can use the token.js.example file as a reference).

Tag summary

Content type

Image

Digest

Size

103.2 MB

Last updated

over 9 years ago

docker pull kratochj/slack-george-bot