Our lovely opinionated Slack bot. Find it in BcnEng Slack workspace as @candebot
.
/
) or mentioning the bot. See /cmd. For example:
coc
- Shows the Code of Conduct.netiquette
- Shows the Netiquette.staff
- Shows the list of staff members.echo
- Sending messages as the bot user. Only available to admins.candebirthday
- Days until @sdecandelario birthday! Something people cares.#hiring-job-board
channel via a form.Candebot can be configured via Toml file + environment variables. The need for setting up environment variables when using the Toml file is due to the fact that some of the configurations is sensitive and should not be stored in a file.
All environment variables are prefixed with BOT_
. For example, BOT_BOT_USER_TOKEN
. If you want to change the prefix, you can set -env-prefix <prefix>
flag when running the bot.
The following environment variables are needed in order to run the bot:
BOT_BOT_USER_TOKEN
- Slack bot user token. Used to authenticate the bot user.BOT_BOT_ADMIN_TOKEN
- Slack user token with admin rights. Used to authenticate the bot user when performing admin actions.BOT_BOT_SERVER_SIGNING_SECRET
- Slack app signing secret. Used to verify the authenticity of the requests.There are more environment variables that can be set. Please, check /bot/config.go.
By default, ./.bot.toml
is used as the configuration file. If you want to change the path, you can set -config <filepath>
flag when running the bot.
Please, use the following file as a reference.
go get -u github.com/bcneng/candebot
BOT_BOT_USER_TOKEN=<slack-bot-user-token> \
BOT_BOT_ADMIN_TOKEN=<slack-user-with-admin-rights-token> \
BOT_BOT_SERVER_SIGNING_SECRET=<slack-app-signing-secret> \
candebot
You can get your bot user token by creating a Slack app via https://api.slack.com/apps.
There is no preference for deployment. You can deploy it in any way you want. For example, using Docker. The files required will always be:
.bot.toml
file with the configuration.