Enable and Configure Interactive Whiteboard Service

Last updated 2022/02/17 09:42:40

To use Agora Interactive Whiteboard, you need to enable and configure the whiteboard service in Agora Console.

Prerequisites

Before enabling the whiteboard feature, ensure that you meet the following requirements:

A valid Agora account. If you have a Netless account, you must complete the account migration first. See Migrate from Netless to Agora.
Active Agora projects. If you have not created a project, see Manage Projects.

Follow these steps to enable the whiteboard service in Agora Console:

Log in to Agora Console, and click the Project Management icon on the left navigation panel.
On the Project Management page, click Config for the project for which you want to enable the whiteboard service.
Under Real-time engagement extensions, find Whiteboard, and click Enable.
Read the pop-up prompt carefully, and click Confirm.
The Enable button changes to the Config button, which allows you to configure the whiteboard service.

Agora Console assigns the following security credentials to each whiteboard project:

AppIdentifier: The unique App Identifier, which is required for initializing the whiteboard SDK.
AK and SK: A pair of access keys, which you can use to generate whiteboard tokens. See Generate a Token at App Server.
sdkToken: An SDK Token (a dynamic key) for test purpose. In a production environment, you need to generate an SDK token at your app server either by using the code samples or calling the RESTful API.

To get the security credentials, do the following steps:

On the Project Management page in Agora Console, find the project that has the whiteboard feature enabled, and click Edit.
On the Edit Project page, find Whiteboard, and click Config.
Navigate to the Basic information section, click the eye icons to copy the AppIdentifier, AK, and SK. Save them to a secure location.
Click Generate sdk Token, read the pop-up prompt carefully, and then click Copy sdkToken. Save the SDK Token to a secure location.

Unexpected exposure of the security credentials can cause severe security problems. To enhance security, Agora recommends the following practices:

Do not send the AK and SK to your app clients or hard-code them in your app. Ensure that only your app server is allowed to read the keys from the configuration file.
Because the SDK Token generated at the Console grants a high level of permission, do not send them to your app clients; otherwise, there might be a risk of leakage.

Agora Interactive Whiteboard sets up five data centers and each data center provides the following server-side features:

File conversion, including Docs to Picture and Docs to web.
After enabling the file conversion feature, you can call the RESTful APIs to launch a file conversion task or query the conversion progress.
Agora charges for the file-conversion feature. See Pricing.
Screenshot. After enabling the screenshot feature, you can call the RESTful APIs to take screenshots.

Follow these steps to enable one or more features and configure the storage settings:

Go to the Project Management page in Agora Console, find the project that has the whiteboard feature enabled, and click Edit.
On the Edit Project page, find Whiteboard, and click Config.
Under Services, select a data center, and click Config. The data center must be the same as the one you fill in the region field when calling the Create a room API; otherwise, the service configurations do not take effect.

On the Services configuration page, select Enabled for Docs to Picture, Docs to web, or Screenshot.

Click the arrowhead to the right of Storage, and select a previously configured storage space in the drop-down list.
Click Create to add a new storage space. You need to fill in the following information:
- Name: (Required) The name of your storage space.
- Vendor: (Required) The third-party cloud storage vendor.
- Region: (Required) The location of the data center you specified when creating a bucket.
- accessKey: (Required) The Access Key provided by the third-party cloud storage vendor, which is used by the vendor to identify visitors.
- secretKey: (Required) The Secret Key provided by the third-party cloud storage vendor, which is used to authenticate signatures.
- bucket: (Required) The name of the bucket.
- Storage path: The path used to save the resources in the storage space. The default is the root directory.
- Domain: The domain name used to access the third-party cloud storage service.
  - To get the above information about a third-party storage service, see the documentation provided by the vendor.
  - You should enable public access or higher permission for third-party storage spaces so that your app clients can access files saved in the space.

After enabling the whiteboard service, you can refer to the following documents to use its functions:

Is this page helpful?

Yes