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

Update screenshots and instructions, following Slack updates.

Chris Bobbe 2021-05-24 15:51:32 -04:00
parent 7aca588d63
commit 235e37f6f4
1 changed files with 21 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
Slack-bot-setup.md

@ -16,39 +16,45 @@ Slack Docs: [Bot user tokens](https://api.slack.com/docs/token-types#bot)
## Create the **classic** Slack App ## Create the **classic** Slack App
> **It's important that you create a "Slack App (Classic)". Don't use the "Create New App" button, and don't opt in to the "granular permissions" feature.** > **It's important that you create a "Slack App (Classic)". Don't use the "Create New App" button, and don't opt in to the "granular permissions" feature.**
1. Navigate to ["Your Apps" page](https://api.slack.com/apps) and log into an account that has administrative permissions over the Slack Workspace (server) that you want to sync with Matterbridge. 1. Navigate to Slack's ["Your Apps" page](https://api.slack.com/apps) and log into 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) <img alt="Slack's 'Your Apps' page" width=780 src="https://user-images.githubusercontent.com/22248748/119397026-9f1b7500-bca3-11eb-98e6-b3ea925333de.png" />
2. Use [_**THIS LINK**_](https://api.slack.com/apps?new_classic_app=1) to create a "Slack App (Classic)". Choose any name for your app and select the desired workspace before submitting. :warning: _**USE THE LINK AND DON'T CLICK THE "Create New App" BUTTON**_. 2. Use [_**THIS LINK**_](https://api.slack.com/apps?new_classic_app=1) to create a "Slack App (Classic)". Choose any name for your app and select the desired workspace, and then submit. :warning: _**USE THE LINK AND DON'T CLICK THE "Create New App" BUTTON**_.
![Create a Slack App](https://github.com/42wim/matterbridge/blob/master/img/slack-setup-create-app.png) <img alt="Create a 'Slack App (Classic)'" width=780 src="https://user-images.githubusercontent.com/22248748/119397031-9f1b7500-bca3-11eb-9eaa-cc2418adb9db.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 "App Home" page via the menu on the left. Click "Add Legacy Bot User", fill in the bot's details, and submit.
![Add a Bot User](https://github.com/42wim/matterbridge/blob/master/img/slack-setup-create-bot.png) <img alt="Add Legacy Bot User" width=780 src="https://user-images.githubusercontent.com/22248748/119397034-9fb40b80-bca3-11eb-8187-df62925c24f1.png" />
## Grant scopes and install the Slack App ## Grant scopes and install the Slack App
Now that we have a bot we need to give your new Slack App (and thus the bot) the right permissions on your Slack Workspace. You'll need to give your new Slack App (Classic), and thus the bot, the right permissions on your Slack Workspace.
1. Via the menu on the left side of the page navigate to the `OAuth & Permissions` page and scroll down to the `Scopes` section. 1. Click "OAuth & Permissions" in the menu on the left, and scroll down to the "Scopes" section. Don't click the prominent "Update Scopes" button. Instead, click "Add an OAuth Scope".
2. Successively add the following permission scopes to your app: <img alt="Add an OAuth Scope" width=780 src="https://user-images.githubusercontent.com/22248748/119397023-9dea4800-bca3-11eb-9957-c780e96f0960.png" />
2. 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`)
* Access user’s profile and workspace profile fields (`users.profile:read`) * Access user’s profile and workspace profile fields (`users.profile:read`)
Click on the `Save changes` button below the scopes once all scopes have been added. <img alt="App with scopes" width=780 src="https://user-images.githubusercontent.com/22248748/119397039-a17dcf00-bca3-11eb-9bf4-25cd24f96aaf.png" />
![Add permission scopes](https://imgur.com/kOnANiz.png) 3. Scroll to the top of the same "OAuth & Permissions" page and click on the "Install to Workspace" (or "Reinstall to Workspace") button:
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. <img alt="Install to Workspace" width=780 src="https://user-images.githubusercontent.com/22248748/119397036-a04ca200-bca3-11eb-99a8-545d74effde0.png" />
![Install the new Slack App](https://github.com/42wim/matterbridge/blob/master/img/slack-setup-install-app.png) Confirm that the authorizations you just added are OK:
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. <img alt="Confirm install" width=780 src="https://user-images.githubusercontent.com/22248748/119397035-a04ca200-bca3-11eb-9cf2-edac292fa06c.png" />
4. Once the App has been installed, the top of the `OAuth & Permissions` page will show two tokens: a "User OAuth Token" starting with `xoxp-...` and a "Bot User OAuth Token" starting with `xoxb-...`. You will need to use the second in your Matterbridge configuration:
<img alt="Bot User OAuth Token" width=780 src="https://user-images.githubusercontent.com/22248748/119397029-9f1b7500-bca3-11eb-9faa-0978a0b280e8.png" />
## Invite the bot to channels synced with Matterbridge ## Invite the bot to channels synced with Matterbridge
@ -58,7 +64,7 @@ The only thing that remains now is to set up the newly created bot on the Slack
![Invite the bot user to a channel](https://github.com/42wim/matterbridge/blob/master/img/slack-setup-invite-bot.png) ![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. Also, don't forget to do this in the future when you want to sync more channels. 2. Repeat the invite process for each channel that Matterbridge needs to sync. :warning: Also, don't forget to do this in the future when you want to sync more channels.
Now you are all set to go. Just configure and start your Matterbridge instance and see the messages flowing. Now you are all set to go. Just configure and start your Matterbridge instance and see the messages flowing.