Skip to content

Latest commit

 

History

History
93 lines (60 loc) · 3.07 KB

README.md

File metadata and controls

93 lines (60 loc) · 3.07 KB
Raw

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
  2. Zoom Account
  3. Zoom Meeting SDK Credentials (Instructions below)
    1. Client ID
    2. Client Secret
  4. AssemblyAI Key
  5. Anthropic Key

1. Clone the Repository

# Clone down this repository
git clone [email protected]: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 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.

Copy the sample config file

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

docker compose up

That's it! You can use the --help argument in 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 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

Keeping secrets secret

Remember, credentials should never be stored in a plaintext file for production use cases.

⚠️ 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 or our Developer Forum. Priority support is also available with Premier Developer Support plans.

Documentation

Make sure to review our documentation as a reference when building with the Zoom Meeting SDK for Linux.