Cloud proxy

Large organizations commonly deploy firewalls to meet their stringent security requirements. To ensure uninterrupted access to Agora services for users behind firewalls, Agora offers a firewall allowlist and Cloud proxy services.

To enable SDK use in network-restricted environments, administrators can add specific IP addresses and ports to the firewall allowlist. Developers then configure the Cloud proxy service by calling the appropriate APIs.

Cloud proxy works as follows:

1. On-Premise Recording SDK initiates a request to Cloud proxy.
2. Cloud proxy returns the corresponding proxy information.
3. The Agora SDK sends data to Cloud proxy, which forwards it to the Agora SD-RTN™.
4. The SD-RTN™ sends the response back to Cloud proxy, which then returns it to the SDK.

Cloud proxy workflow

Before you begin, complete the Quickstart to integrate the On-Premise Recording SDK and set up basic recording functionality.

To implement Cloud proxy in your app, follow these steps:

1. Request access to Cloud proxy

   Contact Agora support and provide the following information:

   • App ID
   • Region where you want to use Cloud proxy
   • Expected concurrency scale
   • Network operator and other relevant details

2. Allow traffic through the firewall

   After your request is approved, Agora provides a list of IP addresses and ports. Add these to your firewall allowlist to enable communication through Cloud proxy.

3. Enable the cloud proxy in your code

   Set the private parameter rtc.enable_proxy to true.

4. Test your setup

   Record audio and video to confirm the proxy configuration is working as expected.

5. Disable cloud proxy

   To stop using Cloud proxy, set rtc.enable_proxy to false.

This section contains content that completes the information on this page, or points you to documentation that explains other aspects to this product.

• getAgoraParameter