GitHub/matterbridge
3
0
Fork 0
mirror of https://github.com/42wim/matterbridge.git synced 2024-11-15 00:19:24 +01:00
Code Issues Projects Releases Wiki Activity

Adding images for the new Slack setup guide

Duco van Amstel 2018-11-18 00:15:02 +00:00
parent 775c3324c4
commit ee88a1f313
1 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
Slack-bot-setup.md

@ -4,10 +4,15 @@ Slack's model for bot users and other third-party integrations revolves around S
## Create the Slack App ## Create the Slack App
1. Navigate to [your Apps page](https://api.slack.com/apps). You'll need to be logged in with an account that has administrative permissions over the Slack Workspace (server) that you want to sync with Matterbridge. 1. Navigate to [your Apps page](https://api.slack.com/apps). You'll need to be logged in with an account that has administrative permissions over the Slack Workspace (server) that you want to sync with Matterbridge.
![Slack's App page](https://github.com/42wim/matterbridge/blob/master/img/slack-setup-app-page.png)
2. Click on the `Create App` button and fill in the app's name and select the right Slack Workspace before validating. 2. Click on the `Create App` button and fill in the app's name and select the right Slack Workspace before validating.
![Create a Slack App](https://github.com/42wim/matterbridge/blob/master/img/slack-setup-create-app.png)
3. Navigate to the `Bot Users` page via the menu on the left side of the page. Click on the `Add a Bot User`, fill in the bot's details and validate to create the required bot. 3. Navigate to the `Bot Users` page via the menu on the left side of the page. Click on the `Add a Bot User`, fill in the bot's details and validate to create the required bot.
![Add a Bot User](https://github.com/42wim/matterbridge/blob/master/img/slack-setup-create-bot.png)
## Grant scopes and install the Slack App ## Grant scopes and install the Slack App
@ -17,12 +22,18 @@ Now that we have a bot we need to give your new Slack App (and thus the bot) the
2. Successively add the following permission scopes to your app: 2. Successively add the following permission scopes to your app:
* Modify your public channels (`channels:write`) * Modify your public channels (`channels:write`)
* Send messages as <App name> (`chat:write:bot`) * Send messages as \<App name\> (`chat:write:bot`)
* Send messages as user (`chat:write:user`) * Send messages as user (`chat:write:user`)
Click on the `Save changes` button below the scopes once all scopes have been added. Click on the `Save changes` button below the scopes once all scopes have been added.
![Add permission scopes]( https://github.com/42wim/matterbridge/blob/master/img/slack-setup-add-scopes.png)
3. Scroll to the top of the same `OAuth & Permissions` page and click on the `Install App` (or `Reinstall App`) button. This will give a pop-up menu summarising the permission scopes that you just added and will ask for your confirmation to add the new App with its bot to your Workspace. 3. Scroll to the top of the same `OAuth & Permissions` page and click on the `Install App` (or `Reinstall App`) button. This will give a pop-up menu summarising the permission scopes that you just added and will ask for your confirmation to add the new App with its bot to your Workspace.
![Install the new Slack App](https://github.com/42wim/matterbridge/blob/master/img/slack-setup-install-app.png)
4. Once the App has been installed the top of the `OAuth & Permissions` page will show two tokens: an `OAuth Access Token` starting with `xoxp-...` and a `Bot User OAuth Access Token` starting with `xoxb-...`. You will need to use the second in your Matterbridge configuration.
## Invite the bot to channels synced with Matterbridge ## Invite the bot to channels synced with Matterbridge
@ -30,8 +41,14 @@ The only thing that remains now is to set up the newly created bot on the Slack
1. On your Slack server you need to add the newly created bot to the relevant channels. Simply use the `/invite @<botname>` command in the chatbox. 1. On your Slack server you need to add the newly created bot to the relevant channels. Simply use the `/invite @<botname>` command in the chatbox.
![Invite the bot user to a channel](https://github.com/42wim/matterbridge/blob/master/img/slack-setup-invite-bot.png)
2. Repeat the invite process for each channel that Matterbridge needs to sync. 2. Repeat the invite process for each channel that Matterbridge needs to sync.
Now you are all set to go. Just configure and start your Matterbridge instance and see the messages flowing.
![All done!](https://github.com/42wim/matterbridge/blob/master/img/slack-setup-finished.png)
# Legacy setup # Legacy setup