From: Nirbheek Chauhan <nirbheek@centricular.com>
Date: Wed, 10 Mar 2021 03:43:27 +0000 (+0530)
Subject: webrtc/signalling: Document cert exception needed for browsers
X-Git-Tag: 1.19.3~487^2~11
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=2c3d78c9a6b6da354a179e99b63069f6d2bdb204;p=platform%2Fupstream%2Fgstreamer.git

webrtc/signalling: Document cert exception needed for browsers

Fixes https://gitlab.freedesktop.org/gstreamer/gst-examples/-/issues/28

Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-examples/-/merge_requests/34>
---

diff --git a/webrtc/signalling/README.md b/webrtc/signalling/README.md
index e17e938..e07ee3a 100644
--- a/webrtc/signalling/README.md
+++ b/webrtc/signalling/README.md
@@ -9,15 +9,23 @@ Read Protocol.md
 
 ## Example usage
 
-In three separate tabs, run consecutively:
+For dev usage, generate a self-signed certificate and run the server:
 
 ```console
 $ ./generate_cert.sh
 $ ./simple_server.py
 ```
 
+If you want to use this server from the browser (to use the JS example, for
+instance), you will need to go to `https://127.0.0.1:8443` and accept the
+self-signed certificate. This step is not required if you will be deploying on
+a server with a CA-signed certificate, in which case you should use
+`./simple_server.py --cert-path <cert path>`.
+
 ### Session Based
 
+In two new consoles, run these two commands:
+
 ```console
 $ ./session-client.py
 Our uid is 'ws-test-client-8f63b9'
@@ -28,14 +36,14 @@ $ ./session-client.py --call ws-test-client-8f63b9
 ```
 ### Room Based
 
+Or, if you want to test rooms, run these two in two new consoles:
+
 ```console
 $ ./room-client.py --room 123
 Our uid is 'ws-test-client-bdb5b9'
 Got ROOM_OK for room '123'
 ```
 
-Another window
-
 ```console
 $ ./room-client.py --room 123
 Our uid is 'ws-test-client-78b59a'
@@ -45,4 +53,4 @@ Sent: ROOM_PEER_MSG ws-test-client-bdb5b9 {"sdp": "initial sdp"}
 Got answer from 'ws-test-client-bdb5b9': {"sdp": "reply sdp"}
 ```
 
-.. and similar output with more clients in the same room.
+You will see similar output with more clients in the same room.