Installation

This page explains how to install ClusterBot on your own Slack workspace. You first need to create a new Slack App and install it in your workspace. Then you need to retrieve your authentication token and store on the computer which is used to send messages to Slack. This has to be done only once. Multiple users can then install the Python package and send messages to the same workspace with the generated authentication token.

Install the Slack App

1. Go to https://api.slack.com/apps?new_app=1 to create a new Slack app. Call it as you like (e.g. ClusterBot).
2. On the app settings page, add the following features:
3. Bot User: On the sidebar, go to Features -> Bot Users and add a bot user (e.g. call ClusterBot).
4. Permissions: On the sidebar, go to Features -> OAuth & Permissions. Scroll down to Scopes and the following OAuth Scopes:
   • bot
   • channels:read
   • chat:write:bot
5. Install the Slack app (sidebar: Settings -> Install App)
6. Copy the Bot User OAuth Access Token from the Features -> OAuth & Permission page.
7. Store the token in a config file on your computer. slack-clusterbot searches two locations for config files. First the system config file is loaded (default location: /etc/slack-clusterbot). If you have multiple users who will use slack-clusterbot to communicate with the same Slack workspace, this is the location where you want to store your token. The file would look like this:

   [SLACK]
   token = 'xoxb-...'

   If you don't have access to the system config file, you can also store the token in the user config file (default location: ~/.slack-clusterbot).

Install the Python package

Python package installation and usage instruction can be found on the repository main page.