Plugin: Zoom: Add instructions to configure in README file

pull/4167/head
Angel Fernando Quiroz Campos 4 years ago
parent 8f0ba889bd
commit 4e7c71f3b9
  1. 33
      plugin/zoom/README.md

@ -1,5 +1,36 @@
This plugin adds Zoom meetings, user registration to meetings and meeting recordings.
> This plugin requires a Zoom account to manage meetings.
Once enabled, it will show as an additional course tool in all courses' homepage: teachers will be able to launch a
conference and student to join it.
## Configuration
The Zoom API uses JSON Web Tokens (JWT) to authenticate account-level access. JWT apps provide an API Key and Secret
required to authenticate with JWT. To get them, create a JWT App:
1. Log into your [Zoom profile page]()
2. Click on Advanced / Application Marketplace
3. Click on [Develop / build App](https://marketplace.zoom.us/develop/create)
4. Choose JWT / Create
5. Information: Fill in fields about your "App" (application and company names, contact name and email address)
6. Click on Continue
7. App Credentials: Copy your API Key and Secret to these fields below
8. Click on Continue
9. Feature: enable Event Subscriptions to add a new one with endpoint
URL https://your.chamilo.url/plugin/zoom/endpoint.php and add these event types:
- Start Meeting
- End Meeting
- Participant/Host joined meeting
- Participant/Host left meeting
- All Recordings have completed
- Recording transcript files have completed
Then click on Done then on Save and copy your Verification Token to the field below.
11. click on Continue
## Meetings
A **meeting** can be linked to a local **user** and/or a local **course**/**session**:
@ -30,7 +61,7 @@ Recordings and user registration are only available to paying Zoom customers.
For a non-paying Zoom user, this plugin still works but participants will join anonymously.
The user that starts the meeting will be identified as the zoom account that is define in the plugin. Socreate a generic account that works for all the users that start meetings.
The user that starts the meeting will be identified as the Zoom account that is defined in the plugin. Socreate a generic account that works for all the users that start meetings.
# Contributing

Loading…
Cancel
Save