Janus example #158
Merged
Janus example #158
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
levaitamas
reviewed
Sep 23, 2024
docs/examples/janus/README.md
Outdated
|
|
||
| The figure below shows Janus deployed into regular Kubernetes pods behind STUNner without the host-networking hack. Here, Janus is deployed behind STUNner in the [*media-plane deployment model*](../../DEPLOYMENT.md), so that STUNner acts as a "local" STUN/TURN server for Janus, saving the overhead of using public a 3rd party STUN/TURN server for NAT traversal. | ||
|
|
||
|  |
There was a problem hiding this comment.
Indeed it would be great to have an arch fig here, thanks!
docs/examples/janus/README.md
Outdated
|
|
||
| ## Installation | ||
|
|
||
| Let's start with a disclaimer. The Janus client-side application must work over a secure HTTPS connection, because [getUserMedia](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia#browser_compatibility) is available only in secure contexts. This implies that the client-server signaling connection must be secure too. In this demo, we will aim to obtain a proper CA-signed certificate (self-signed certificates haven't been tested). Obtaining a valid TLS certificate is a challenge. Thus, the majority of the below installation guide will be about securing client connections to Janus over TLS; as it turns out, once HTTPS is correctly working integrating Janus with STUNner is very simple. |
There was a problem hiding this comment.
perhaps move this paragraph to a NOTE?
docs/examples/janus/README.md
Outdated
| Endpoints: [10.76.1.4, 10.80.4.47] | ||
| ``` | ||
|
|
||
| Note that Janus itself will not use STUNner (that would amount to a less efficient [symmetric ICE mode](../../DEPLOYMENT.md)); with the above configuration we are just telling Janus Web to instruct its clients to use STUNner to reach the Janus Gateway server. |
There was a problem hiding this comment.
please clarify: Janus will not use STUNner as a TURN server
docs/examples/janus/README.md
Outdated
|
|
||
| ## Test | ||
|
|
||
| After installing everything, execute the following command to retrieve the URL of your fresh Janus demo app: |
There was a problem hiding this comment.
nitpicking: fresh -> freshly deployed?
| echo client-$INGRESSIP.nip.io | ||
| ``` | ||
|
|
||
| Copy the URL into your browser, and now you should be greeted with the About page. On the landing page navigate to the Video call plugin demo (`/demos/videocall.html`). Duplicate the tab and register two users in the system and make a call. If everything is set up correctly, you should be able to connect to a room. If you repeat the procedure in a separate browser tab you can enjoy a nice video-conferencing session with yourself, with the twist that all media between the browser tabs is flowing through STUNner and the Janus Gateway server deployed in you Kubernetes cluster. |
There was a problem hiding this comment.
Can you please add a Help section to the very end?
An example:
# Help
STUNner development is coordinated in Discord, feel free to [join](https://discord.gg/DyPgEsbwzc).
|
@levaitamas can you check one more time? Notice that I also added the dockerfiles and added a respective section also. |
|
LGTM. Thanks again! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds the Janus WebRTC server example. It includes a README file explaining all the steps to install Janus and STUNner into Kubernetes. It also comes with two yaml manifests containing configuration for the STUNner ecosystem and deployment manifests for the Janus ecosystem.
Self built Janus images are pushed under the l7mp org on Docker Hub. Janus Web Janus Gateway
TODO: Figure about the deployment in Kubernetes. The missing figure is highlighted in the README.
Tested ✔️
Someone else should test it before merging.