lucaspalomodevelop/indico-plugins
1
0
Fork 0
mirror of https://github.com/lucaspalomodevelop/indico-plugins.git synced 2026-03-17 01:04:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

VC/Zoom: make README nicer

Browse Source
This commit is contained in:
Pedro Ferreira 2020-11-10 15:17:32 +01:00
parent 4c23e59b54
commit 7a4f628f40
1 changed files with 38 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
vc_zoom/README.md
View File

@ -1,7 +1,41 @@
Indico Plugin for Zoom based on Vidyo plugin.
# Indico Plugin for Zoom
To obtain Api key and api secret, please visit [https://marketplace.zoom.us/docs/guides/auth/jwt](https://marketplace.zoom.us/docs/guides/auth/jwt)
## Features
Not ready for production.
* Creating Zoom meetings from Indico;
* Sharing Zoom meetings between more than one Indico event;
* Creating meetings on behalf of others;
* Changes of host possible after creation;
* Protection of Zoom link (only logged in, everyone or no one)
* Webinar mode;
Developed by Giovanni Mariano @ ENEA Frascati
## Implementation details
Rooms are created under the account of an *assistant user* which can be set using the **Assistant Zoom ID**
configuration setting. This account will also be added automatically as an assistant to every meeting host.
This is needed in order to allow for the host to be changed ([`scheduled_for`](
https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingcreate#request-body
) property in the Zoom API). The *assistant user* owns every Zoom meeting, with the `scheduled_for` property being
used to grant the required privileges to the desired hosts.
## Configuration
These are the most relevant configuration options:
* **Notification email addresses** - Additional e-mails which will receive notifications
* **E-mail domains** - Comma-separated list of e-mail domains which can be used for the Zoom API (e.g. `cern.ch`)
* **Asistant Zoom ID** - Zoom ID (or e-mail) of the account which shall be used as an assistant to all hosts and
shall own all meetings
### Zoom API key/secret
To obtain API key and API secret, please visit [https://marketplace.zoom.us/docs/guides/auth/jwt](https://marketplace.zoom.us/docs/guides/auth/jwt).
## Intellectual Property
Developed by Giovanni Mariano @ **ENEA Frascati**, based on the Vidyo Plugin by the Indico Team at **CERN**. Further
improvements and modifications added by the Indico Team.
This package is Open Source Software licensed under the [MIT License](https://opensource.org/licenses/MIT).
**© Copyright 2020 CERN and ENEA**