Skip to content

Commit 1ff7475

Browse files
committed
Added guide for testing TURN on your cloud instance
Added guide for testing TURN on your cloud instance
1 parent dc3a8ee commit 1ff7475

File tree

3 files changed

+62
-1
lines changed

3 files changed

+62
-1
lines changed

FAQ.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,4 +228,6 @@ media.peerconnection.ice.relay_only
228228

229229
This will force all connections to use the TURN relay.
230230

231-
4. Try and connect to your application in a new tab. If the TURN server is working properly, it should connect. If it does not, it will likely get stuck and fail to connect.
231+
4. Try and connect to your application in a new tab. If the TURN server is working properly, it should connect. If it does not, it will likely get stuck and fail to connect.
232+
233+
Alternatively, you can see our page on doing a STUN/TURN Debug using pion/turn [here](ICE%20Debugging.md).

ICE Debugging.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Debugging ICE Connections Using Pion/TURN
2+
3+
This guide is designed to help you test your STUN/TURN connectivity using [Pion/TURN](https://github.com/pion/turn/tree/master/examples).
4+
5+
This guide is broken up into the following steps:
6+
7+
1. Setting up Pion/TURN Server on your cloud machine
8+
9+
2. Run a ICE Trickle test using your fresh new Pion/TURN server details
10+
11+
3. Ping your Pion/TURN using the Pion/TURN client ping utility
12+
13+
## 1. Setting up Pion/TURN on your cloud instance
14+
15+
1. Log into your cloud Instance
16+
17+
2. Download and unzip your relevant OS folder from [here](https://github.com/pion/turn/releases/tag/v2.0.2)
18+
19+
3. Open cmd in directory and run:
20+
21+
`turn-server-simple.exe -public-ip $INSTANCE_PUBLIC_IP -users username=password`
22+
23+
## 2. Setting up Ice Trickle Test
24+
25+
1. To set up ice trickle test for new custom turn server, head to: https://webrtc.github.io/samples/src/content/peerconnection/trickle-ice/
26+
27+
2. Click Remove server to clear the current default
28+
29+
3. Enter the following into the relevant fields:
30+
31+
* Enter turn:publicip:port in the TURN URI category
32+
* Enter "username" in username field
33+
* Enter "password" in password field
34+
35+
4. Click add server.
36+
37+
5. Click "Gather candidates"
38+
39+
6. Successful results will show "Relay candidates"
40+
41+
42+
## 3. Ping your TURN server
43+
44+
1. Unzip the same files from the instance on your local machine
45+
46+
2. Open cmd in the directory
47+
48+
3. Run the following command:
49+
50+
`turn-client-udp.exe -host $INSTANCE_PUBLIC_IP -user=username=password -ping`
51+
52+
4. Successful ping will show standard ping output (e.g. Reply from IP)
53+
54+
For more details about additional commands you can run, please see the provider page here:
55+
56+
https://github.com/pion/turn/tree/master/examples

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@ This repository isn't a channel to request support with Pixel Streaming. If you'
2828

2929
[Pixel Streaming on GCP (Windows)](Pixel%20Streaming%20on%20GCP%20(Windows).md)
3030

31+
## Test Tools
32+
[Pion/TURN ICE Candidate Debugging](ICE%20Debugging.md)
33+
3134

3235
## Legal
3336

0 commit comments

Comments
 (0)