This page contains information on how to prepare the development environment before enabling a video call with the Agora Web SDK.

Prerequisites

  1. Install a browser supported by the Agora Web SDK as shown in the following table:
    Platform Chrome 58 or later Firefox 56 or later Safari 11 or later Opera 45 or later QQ Browser 360 Secure Browser WeChat Built-in Browser
    Android 4.1 or later ✔ ✘ N/A ✘ ✘ ✘ ✘
    iOS 11 or later ✘ ✘ ✔ ✘ ✘ ✘ ✘
    macOS 10 or later ✔ ✔ ✔ ✔ ✔ ✘ ✘
    Windows 7 or later ✔ ✔ N/A ✔ ✔ ✔ ✘
  • Upgrade to Agora Web SDK v2.6 in the following scenarios:
    • Safari on iOS 12.1.4 or later.
    • Safari 12.1 or later on macOS.
  • The Agora Web SDK v2.5 or later also supports Chrome 49 on Windows XP.
  1. Open the ports and whitelist the domains as specified in Firewall Requirements.
  2. Understand the limitations in Known Issues and FAQ.

Create an Agora Project and Get an App ID

  1. Sign up for a developer account at Agora Dashboard and follow the on-screen instructions to create a project.
  2. Click the Project Management icon in the left navigation panel.
  3. Find the corresponding App ID under the created project.

Import the Agora Web SDK to Your Project

Choose one of the following methods to obtain the Agora Web SDK:

Method 1: Get the SDK through npm

This method requires npm, see Install npm for details.

  1. Run the following command to install the SDK.
    npm install agora-rtc-sdk

  1. Add the following code to your project.

     import AgoraRTC from 'agora-rtc-sdk'

Method 2: Get the SDK through the CDN

Add the following code to the line above </body> in your project.

    <script src="https://cdn.agora.io/sdk/web/AgoraRTCSDK-2.6.1.js"></script>

Method 3: Get the SDK from the official Agora website

  1. Download the latest Agora Web SDK.

    ../_images/web_sdk_download.png

  2. Copy the AgoraRTCSDK-2.6.1.js file to your project.

  3. Reference the AgoraRTCSDK-2.6.1.js file in your project.

    ../_images/web_sdk_reference.jpeg

The screenshots are for reference only, please use the latest version of the SDK.

Preparing the Web Server

  1. Install a web server, such as Apache, Nginx, or Node.js.
  2. Import the downloaded Agora Web SDK to your web server.
  3. Set up your web server so that you can access the sample app page or your own app page on the supported browsers, see Prerequisites.

Next Steps

You have now set up the environment and can start a call/live broadcast following the steps under Quickstart Guide: