Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Zoom installation docs update #245

Merged
merged 12 commits into from
Jan 10, 2022
Merged

Zoom installation docs update #245

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
bdaf948
Add files via upload
justinegeffen Dec 7, 2021
bc5692c
Update mattermost-setup.md
justinegeffen Dec 7, 2021
9d4a599
Update install-zoom-plugin.md
justinegeffen Dec 7, 2021
e376d2b
Update install-zoom-plugin.md
justinegeffen Dec 7, 2021
7a8170a
Update mattermost-setup.md
justinegeffen Dec 7, 2021
0d63c45
Update README.md
justinegeffen Dec 7, 2021
b7b4b10
Update webhook-configuration.md
justinegeffen Dec 7, 2021
9bad518
Update zoom-setup-jwt.md
justinegeffen Dec 7, 2021
b96f4d4
Merge branch 'master' into justinegeffen-zoom-config
justinegeffen Jan 10, 2022
a6de481
Update install-zoom-plugin.md
justinegeffen Jan 10, 2022
9d1fb5f
Update README.md
justinegeffen Jan 10, 2022
be118c6
Update webhook-configuration.md
justinegeffen Jan 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/.gitbook/assets/zoom-plugin-configuration.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 11 additions & 10 deletions docs/installation/install-zoom-plugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,20 @@ description: Get the Mattermost plugin installed as a first step

# Install Zoom Plugin

## Install via Plugin Marketplace \(Recommended\)
## Install via Marketplace \(Recommended\)

1. Go to **Main Menu > Plugin Marketplace** in Mattermost.
2. Search for "Zoom" or manually find the plugin from the list and click **Install**.
1. Go to **Main Menu > Plugin Marketplace** in Mattermost.
2. Search for "Zoom" or manually find the plugin from the list and select **Install**.
3. After the plugin has downloaded and been installed, follow the instructions on [Zoom Configuration](zoom-configuration/).
4. After finishing the [Zoom Configuration](zoom-configuration/), follow the instructions on [Mattermost Setup](mattermost-setup.md).

## \(Alternative\) Install via Manual Upload
## \(Alternative\) Install via manual upload

If your server doesn't have internet access, you can download the [latest plugin binary release](https://github.com/mattermost/mattermost-plugin-zoom/releases) and upload it to your server via **System Console > Plugin Management**. The binary releases on the page above, are the same as used by the Plugin Marketplace.

1. Go to **Main Menu > Plugin Marketplace** in Mattermost.
2. Search for "Zoom" or manually find the plugin from the list and click **Install**.
3. After the plugin has downloaded and been installed, follow the instructions on [Zoom Configuration](zoom-configuration/).
4. After finishing the [Zoom Configuration](zoom-configuration/), follow the instructions on [Mattermost Setup](mattermost-setup.md).
If your server doesn't have internet access, you can download the [latest plugin binary release](https://github.com/mattermost/mattermost-plugin-zoom/releases) and upload it to your server via **System Console > Plugin Management**. The binary releases on the page above, are the same as used by the Marketplace.

1. Go to **Main Menu > Marketplace** in Mattermost.
justinegeffen marked this conversation as resolved.
Show resolved Hide resolved
2. Select **Choose File** and select the downloaded file.
3. Choose **Upload**.
4. When the plugin has been uploaded, navigate to **Plugins > Zoom**, choose **Enable Plugin > true**, then select **Save**
5. Next, follow the instructions on [Zoom Configuration](zoom-configuration/).
6. After finishing the [Zoom Configuration](zoom-configuration/), follow the instructions on [Mattermost Setup](mattermost-setup.md).
11 changes: 5 additions & 6 deletions docs/installation/mattermost-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@ description: Configuration steps for the Mattermost server

# Mattermost Setup

## Zoom Plugin Setup Guide
## Zoom plugin setup guide

**Note:** You need a paid Zoom account to use the plugin.

### First steps

* Enable settings for [overriding usernames](https://docs.mattermost.com/administration/config-settings.html#enable-integrations-to-override-usernames) and [overriding profile picture icons](https://docs.mattermost.com/administration/config-settings.html#enable-integrations-to-override-profile-picture-icons).
* Go to **System Console > Plugins > Zoom** to configure the Zoom Plugin.
* Go to **System Console > Plugins > Zoom** to configure the Zoom Plugin.

![](../.gitbook/assets/image%20%281%29%20%282%29.png)
![zoom plugin configuration](../.gitbook/assets/zoom-plugin-configuration.png)

### Plugin configuration

Expand All @@ -27,7 +27,7 @@ description: Configuration steps for the Mattermost server
* **OAuth?**
* Set **Enable OAuth** to `true`.
* Use the Client ID and Client Secret generated during [Zoom Configuration](zoom-configuration/zoom-setup-oauth.md) to fill in the fields **Zoom OAuth Client ID** and **Zoom OAuth Client Secret**.
* Click the **Regenerate** button next to the field **At Rest Token Encryption Key**.
* Select **Regenerate** next to the field **At Rest Token Encryption Key**.
* Make sure **Enable Password based authentication** is set to `false`.
* Ignore **API Key** and **API Secret** fields.
* **JWT/Password?**
Expand All @@ -36,5 +36,4 @@ description: Configuration steps for the Mattermost server
* Set **Enable Password based authentication** to `true`.
* Use the API Key and API Secret generated during [Zoom Configuration](https://github.com/mattermost/mattermost-plugin-zoom/tree/8cc104ee70b0b51ac7e4c8c73715f25c42c782e0/docs/installation/zoom-configuration/zoom-setup-jwt.md) to fill in the fields **API Key** and **API Secret**.
* If you are using Webhooks or Deauthorization, make sure you hit the **Regenerate** button on **Webhook Secret** field.
* Click **Save**.

* Select **Save**.
22 changes: 11 additions & 11 deletions docs/installation/zoom-configuration/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,21 @@ description: >-

# Zoom Configuration

Zoom version 1.5 supports one authentication method for users to connect Mattermost and Zoom: OAuth

* There are two types of OAuth Zoom Apps you can create. You can use either one with this Zoom plugin depending on your organization's security and UX preferences. \(**Account** or **User** Level Apps\)
* **Account-Level App**
* Users do not need to authorize their Zoom accounts before starting their first Zoom meeting. The only requirement is that their Mattermost account uses the same email address as their Zoom account.
* Users cannot connect their Mattermost/Zoom accounts if their emails do not match.
* **User Level App**
* Each user will need to connect their Zoom account with their Mattermost account before they can use the integration. When they try to create a meeting for the first time, they'll receive a message to connect their account, and will need to click **Approve** on the pop-up confirmation notice.
Zoom version 1.5 supports one authentication method for users to connect Mattermost and Zoom: OAuth.

* There are two types of OAuth Zoom apps you can create - **Account** or **User** level apps. You can use either one with this Zoom plugin depending on your organization's security and UX preferences.

* **Account-level app**
* Users don't need to authorize their Zoom accounts before starting their first Zoom meeting. The only requirement is that their Mattermost account uses the same email address as their Zoom account.
* Users can't connect their Mattermost/Zoom accounts if their emails do not match.
* **User-level app**
* Each user needs to connect their Zoom account with their Mattermost account before they can use the integration. When they try to create a meeting for the first time, they'll receive a message to connect their account, and will need to click **Approve** on the pop-up confirmation notice.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if worth it, but the actual flow is:

  • They try to create a meeting
  • They must follow a link
  • The link will redirect to a zoom owned website
  • On this site, if they are not logged in, they will be asked to log in into zoom
  • Once they are logged in, they will see the "approve" button.

Probably with what is already written, everything is clear, but wanted to make sure.

* Users **can** connect their Mattermost/Zoom accounts **even if their emails do not match**.

## Upgrading From a Previous Version
## Upgrading from a previous version

If you've been using Zoom prior to v1.4, you likely have a legacy webhook-type app configured in Zoom.

Legacy webhook apps are no longer supported by Zoom or Mattermost and are not compatible with Zoom plugin v1.4. You may experience issues with the meeting status message information not being updated when a meeting ends. This is because the webhook endpoint expects a JSON format request and newer webhooks use different formats.
Legacy webhook apps are no longer supported by Zoom or Mattermost and are not compatible with Zoom plugin v1.4 onwards. You may experience issues with the meeting status message information not being updated when a meeting ends. This is because the webhook endpoint expects a JSON format request and newer webhooks use different formats.

From Zoom v1.4, you can configure and associate your webhooks with an app you've already created. First, remove the previous webhook app. Then follow the steps provided [here](https://mattermost.gitbook.io/plugin-zoom/installation/zoom-configuration/webhook-configuration) to configure the new webhook.

13 changes: 6 additions & 7 deletions docs/installation/zoom-configuration/webhook-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,20 @@
# Webhook Configuration

## Configure Webhook Events
## Configure webhook events

When a Zoom meeting ends, the original link shared in the channel can be changed to indicate the meeting has ended and how long it lasted. To enable this functionality, we need to create a webhook subscription in Zoom that tells the Mattermost server every time a meeting ends. The Mattermost server then updates the original Zoom message.
When a Zoom meeting ends, the original link shared in the channel can be changed to indicate the meeting has ended and how long it lasted. To enable this functionality, you can create a webhook subscription in Zoom that tells the Mattermost server every time a meeting ends. The Mattermost server then updates the original Zoom message.

1. Click on **Feature**.
1. Select **Feature**.
2. Enable **Event Subscriptions**.
3. Click **Add New Event Subscription** and give it a name \(e.g. "Meeting Ended"\).
3. Select **Add New Event Subscription** and give it a name \(e.g. "Meeting Ended"\).
4. Enter a valid **Event notification endpoint URL** \(`https://SITEURL/plugins/zoom/webhook?secret=WEBHOOKSECRET`\).
* `SITEURL` should be your Mattermost server URL.
* `WEBHOOKSECRET` is generated during [Mattermost Setup](../mattermost-setup.md).

![Feature screen](../../.gitbook/assets/screenshot-from-2020-06-05-19-51-56%20%284%29.png)

* Click **Add events** and select the **End Meeting** event.
* Select **Add events** and select the **End Meeting** event.
justinegeffen marked this conversation as resolved.
Show resolved Hide resolved

![Event types screen](../../.gitbook/assets/screenshot-from-2020-06-05-20-43-04%20%282%29%20%281%29.png)

* Click **Done** and then save your app.

* Select **Done** and then save your app.
justinegeffen marked this conversation as resolved.
Show resolved Hide resolved
24 changes: 12 additions & 12 deletions docs/installation/zoom-configuration/zoom-setup-jwt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,26 @@ The **API Key** and **API Secret** are generated by Zoom and used to create meet

* Go to [https://marketplace.zoom.us](https://marketplace.zoom.us) and log in.

## Create an App for Mattermost
## Create an app for Mattermost

* In the top left click on **Develop** and then **Build App**.
* Select **JWT** in **Choose your app type** section.
* Enter a name for your app.
1. In the top left select **Develop** and then **Build App**.
2. Select **JWT** in **Choose your app type** section.
3. Enter a name for your app.

## Configure your App to work with Mattermost
## Configure your app to work with Mattermost

* Click **Information**.
* Enter the **Company Name** and **Developer Contact Information** for your app.
* Click **App Credentials**.
* Here you'll find your **API Key** and **API Secret**.
1. Select **Information**.
2. Enter the **Company Name** and **Developer Contact Information** for your app.
3. Click **App Credentials**.
4. Here you'll find your **API Key** and **API Secret**.
* These need to be copied and pasted into the Zoom Plugin configuration screen.

![App credentials screen](https://github.com/mattermost/docs/raw/master/source/images/zoom_api_key.png)

* Click **Activation** and activate the app.
5. Select **Activation** and activate the app.

Users will need to sign up for their own Zoom account using the same email address that they use for Mattermost. If the user attempts to start a Zoom meeting without a Zoom account, they will see the following error message: "We could not verify your Mattermost account in Zoom. Please ensure that your Mattermost email address matches your Zoom email address." In addition, the user must be added to the admin's Zoom account to quickly start a meeting.
Users will need to sign up for their own Zoom account using the same email address that they use for Mattermost. If the user attempts to start a Zoom meeting without a Zoom account, they'll see the following error message: "We could not verify your Mattermost account in Zoom. Please ensure that your Mattermost email address matches your Zoom email address." In addition, the user must be added to the admin's Zoom account to quickly start a meeting.

## Finish Setting up the Mattermost Server
## Finish setting up the Mattermost server

* Follow the instructions for [Mattermost Setup](../mattermost-setup.md)