Connect through restricted networks with Cloud Proxy
Large enterprises, hospitals, universities, banks, and other institutions commonly deploy firewalls to meet their stringent security requirements. To ensure uninterrupted access to its services for enterprise users behind firewalls, Agora offers firewall whitelist and Cloud Proxy services.
Admins enable users to use Voice SDK in network-restricted environments by adding specific IP addresses and ports to the firewall whitelist. Users make API calls to configure the Cloud Proxy service.
Understand the tech
Cloud Proxy works as follows:
- Voice SDK initiates a request to Cloud Proxy.
- Cloud Proxy returns the corresponding proxy information.
- Agora SDK sends data to Cloud Proxy. Cloud Proxy receives the data and transmits it to Agora SD-RTN™.
- Agora SD-RTN™ returns data to Cloud Proxy. Cloud Proxy receives the data and sends it to the SDK.
Cloud proxy workflow
Prerequisites
Ensure that you have implemented the SDK quickstart in your project.
Implement Cloud Proxy
Take the following steps to implement the use of Cloud Proxy in your app:
-
Contact Agora support and provide the following information to request Cloud Proxy service:
- App ID
- Cloud Proxy service usage area
- Concurrency scale
- Network operator and other relevant information
-
After receiving the request, Agora provides the IP addresses and ports used for Cloud Proxy.
-
Add the IP addresses and ports provided by Agora to your firewall whitelist.
-
Call
setCloudProxy
and setproxyType
toTRANSPORT_TYPE_UDP_PROXY
orTRANSPORT_TYPE_TCP_PROXY
to enable Cloud Proxy. -
Test if you can initiate audio and video calls or live broadcasts normally.
-
To stop using Cloud Proxy, call
setCloudProxy
and setproxyType
toTRANSPORT_TYPE_NONE_PROXY
. -
To update the current
proxyType
, callsetCloudProxy(TRANSPORT_TYPE_NONE_PROXY)
first, then callsetCloudProxy
again with the newproxyType
.
Call setCloudProxy
outside the channel. Its settings are valid within the RtcEngine
life cycle.
Reference
This section contains content that completes the information on this page, or points you to documentation that explains other aspects to this product.
IP addresses for Cloud Proxy
To use Agora Cloud Proxy, your end users must first configure their firewalls to trust the following IP address and port ranges.
- If a user is in an intranet firewall environment and uses
TRANSPORT_TYPE_UDP_PROXY
, the services for Media Push and Co-hosting across channels are not available.