Deployment
When deploying in a cloud environment (like Hugging Face Spaces, EC2, etc), you need to set up a TURN server to relay the WebRTC traffic.
Twilio API
The easiest way to do this is to use a service like Twilio.
Create a free account and the install the twilio
package with pip (pip install twilio
). You can then connect from the WebRTC component like so:
from twilio.rest import Client
import os
account_sid = os.environ.get("TWILIO_ACCOUNT_SID")
auth_token = os.environ.get("TWILIO_AUTH_TOKEN")
client = Client(account_sid, auth_token)
token = client.tokens.create()
rtc_configuration = {
"iceServers": token.ice_servers,
"iceTransportPolicy": "relay",
}
with gr.Blocks() as demo:
...
rtc = WebRTC(rtc_configuration=rtc_configuration, ...)
...
Self Hosting
We have developed a script that can automatically deploy a TURN server to Amazon Web Services (AWS). You can follow the instructions here or this guide.
Prerequisites
Clone the following repository and install the aws
cli if you have not done so already (pip install awscli
).
Log into your AWS account and create an IAM user with the following permissions:
Create a key pair for this user and write down the "access key" and "secret access key". Then log into the aws cli with these credentials (aws configure
).
Finally, create an ec2 keypair (replace your-key-name
with the name you want to give it).
aws ec2 create-key-pair --key-name your-key-name --query 'KeyMaterial' --output text > your-key-name.pem
Running the script
Open the parameters.json
file and fill in the correct values for all the parameters:
KeyName
: The key file we just created, e.g.your-key-name
(omit.pem
).TurnUserName
: The username needed to connect to the server.TurnPassword
: The password needed to connect to the server.InstanceType
: One of the following valuest3.micro
,t3.small
,t3.medium
,c4.large
,c5.large
.
Then run the deployment script:
aws cloudformation create-stack \
--stack-name turn-server \
--template-body file://deployment.yml \
--parameters file://parameters.json \
--capabilities CAPABILITY_IAM
You can then wait for the stack to come up with:
Next, grab your EC2 server's public ip with:
aws cloudformation describe-stacks \
--stack-name turn-server \
--query 'Stacks[0].Outputs' > server-info.json
The server-info.json
file will have the server's public IP and public DNS:
[
{
"OutputKey": "PublicIP",
"OutputValue": "35.173.254.80",
"Description": "Public IP address of the TURN server"
},
{
"OutputKey": "PublicDNS",
"OutputValue": "ec2-35-173-254-80.compute-1.amazonaws.com",
"Description": "Public DNS name of the TURN server"
}
]
Finally, you can connect to your EC2 server from the gradio WebRTC component via the rtc_configuration
argument: