My personal Butler in slack
Always wanted your own butler? Now you can!
Butler has the following features:
- 🚗 Traffic information (Netherlands)
- ☀️ Weather forecast
Butler is listening to the following commands / messages. It can depend per command where its available. Most of them work over per direct message.
Available in: Direct message.
Trigger: !traffic
To get the latest traffic information of the dutch roads.
Available in: Direct message.
Trigger: !traffic <roadnumber> (e.g. !traffic a1)
Same functionality as !traffic but lets you add a filter to it.
Available in: Direct message.
Trigger: !weather
Get a weather forecast of the upcoming week, including today.
Available in: Direct message.
Trigger: !weather <location> (e.g. !weather Amsterdam)
Get the weather forecast for a specific location.
Available in: Direct message.
Trigger: !chuck
Available in: Direct message.
Trigger: !momma
Get a random yo momma joke
To start the Butler simply run the start script inside the bin directory:
$ ./bin/start
Or npm install and npm start to launch the bot!
There is a Dockerfile if you want to build a docker image yourself. Run the following inside the project directory to build the image:
$ docker build -t butler .
And launch it with the following command:
$ docker run -d --name butler butler
Configuration of your bot can either be done using a config file or pass environment variables.
In the config folder there is a config.json.example file you can copy and rename to config.json. Once configured you are ready to start the bot.
If a config file is not ideal for your setup use environment variables. You can see in the table which env var to use for each config value.
| Description | ENV | Required |
|---|---|---|
| The slack token for this slackbot | BL_SLACK_KEY | ✓ |
| The name of the slackbot | BL_SLACK_NAME | ✓ |
| Forecast.IO Api key | BL_WEATHER_KEY | ✓ |
| Default location | BL_WEATHER_LAT | ✓ |
| Default location | BL_WEATHER_LONG | ✓ |