https://github.com/zoom/meetingsdk-headless-linux-sample
A demo on creating a headless meeting bot using the Zoom Meeting SDK for Linux and Docker
https://github.com/zoom/meetingsdk-headless-linux-sample
Last synced: 8 months ago
JSON representation
A demo on creating a headless meeting bot using the Zoom Meeting SDK for Linux and Docker
- Host: GitHub
- URL: https://github.com/zoom/meetingsdk-headless-linux-sample
- Owner: zoom
- License: mit
- Created: 2023-12-07T20:38:46.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-07T00:51:58.000Z (over 1 year ago)
- Last Synced: 2024-11-07T01:19:51.201Z (over 1 year ago)
- Language: C++
- Homepage:
- Size: 184 KB
- Stars: 35
- Watchers: 13
- Forks: 17
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Zoom Meeting SDK for Linux Headless Bot Sample
This sample demonstrates how you can run the Zoom Meeting SDK for Linux within a Docker container and configure it for a
variety of use cases through an intuitive CLI or through a configuration file.
## Prerequisites
1. [Docker](https://www.docker.com/)
1. [Zoom Account](https://support.zoom.us/hc/en-us/articles/207278726-Plan-Types-)
1. [Zoom Meeting SDK Credentials](#config:-sdk-credentials) (Instructions below)
1. Client ID
1. Client Secret
1. [AssemblyAI Key](https://www.assemblyai.com/)
1. [Anthropic Key](https://www.anthropic.com/)
## 1. Clone the Repository
```bash
# Clone down this repository
git clone git@github.com:zoom/meetingsdk-headless-linux-sample.git
```
## 2. Download the Zoom Linux SDK
Download the latest version of the Zoom SDK for Linux from the Zoom Marketplace and place it in
the [lib/zoomsdk](lib/zoomsdk) folder of this repository.
## 3. Configure the Bot
If you don't already have them, follow the section on how
to [Get your Zoom Meeting SDK Credentials](#get-your-zoom-meeting-sdk-credentials).
#### Copy the sample config file
```bash
cp sample.config.toml config.toml
```
#### Fill out the config.toml
Here, you can set any of the CLI options so that the bot has them available when it runs. Start by adding your Client ID and Client Secret in the relevant fields.
**At a minimum, you need to provide an Client ID and Client Secret along with information about the meeting you would like to join.**
You can either provide a Join URL, or a Meeting ID and Password.
## 4. Run the Bot
Run the Docker container in order to build and run the bot
```shell
docker compose up
```
That's it! You can use the --help argument in [entry.sh](bin/entry.sh) to see the available CLI and config.toml options.
___
### Get your Zoom Meeting SDK Credentials
In your web browser, navigate to [Zoom Developer Portal](https://developers.zoom.us/) and register/log into your
developer account.
Click the "Build App" button at the top and choose to "Meeting SDK" application.
1. Name your app
2. Choose whether to list your app on the marketplace or not
3. Click "Create"
4. Fill out the prerequisite information
5. Copy the Client ID and Client Secret to the config.toml file
For more information, you can follow [this guide](https://developers.zoom.us/docs/meeting-sdk/developer-accounts/)
### Keeping secrets secret
Remember, credentials should never be stored in a plaintext file for production use cases.
> :warning: **Never commit config.toml to version control:** The file likely contains Zoom SDK and Zoom OAuth
> Credentials
### Testing
At this time there are no tests.
## Need help?
If you're looking for help, try [Developer Support](https://devsupport.zoom.us) or
our [Developer Forum](https://devforum.zoom.us). Priority support is also available
with [Premier Developer Support](https://zoom.us/docs/en-us/developer-support-plans.html) plans.
### Documentation
Make sure to review [our documentation](https://developers.zoom.us/docs/meeting-sdk/linux/) as a reference when building
with the Zoom Meeting SDK for Linux.