From 37f2e96dcccaa075cd60cc9ce70879c82dabb161 Mon Sep 17 00:00:00 2001 From: Miroslav Pejic Date: Sun, 2 Jan 2022 20:39:42 +0100 Subject: [PATCH] [mirotalksfu] - update readme --- README.md | 35 +++++++++++++++++------------------ 1 file changed, 17 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index f1faf54..b90df6e 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Powered by `WebRTC` and [SFU](https://mediasoup.org) integrated server. -Open the app with the following **supported browsers** & many more... +Open the app with the following **supported browsers** and many more. [![Foo](public/images/browsers.png)](https://sfu.mirotalk.org/) @@ -21,28 +21,28 @@ Open the app with the following **supported browsers** & many more... ## Features - Is `100% Free` - `Open Source` - `Self Hosted` -- `No download`, `plug-in` or `login` required, entirely browser based +- `No download`, `plug-in` or `login` required, entirely browser-based - `Unlimited` number of `conference rooms` and `users`, `without` call `time limitation` - Desktop and Mobile compatible -- Optimized Room URL Sharing (share it to your participants, wait them to join) +- Optimized Room URL Sharing (share it to your participants, wait for them to join) - Possibility to Lock/Unlock the Room for the meeting - Webcam Streaming up to 4K quality (Front - Rear for mobile) - Echo cancellation and noise suppression that makes your audio crystal clear - Screen Sharing to present documents, slides, and more ... - File Sharing, share any files to your participants in the room -- Chat with Emoji Picker to show you feeling and possibility to Save the conversations +- Chat with Emoji Picker to show you feeling and the possibility to Save the conversations - Advance collaborative whiteboard for the teachers - Select Microphone - Speaker and Video source -- Recording your Screen, Audio or Video -- Share any YouTube video in real time to your participants -- Full Screen Mode on mouse click on the Video element +- Recording your Screen, Audio, or Video +- Share any YouTube video in real-time to your participants +- Full-Screen Mode on mouse click on the Video element - Supports [REST API](app/api/README.md) (Application Programming Interface) ## DigitalOcean This application is running just for `demonstration purposes` on [DigitalOcean](https://m.do.co/c/1070207afbb1) `droplet Ubuntu 20.04 (LTS) x64 [1 vCPU - 1GB Ram]`, with [Ngnix](https://www.nginx.com/) and [Let's Encrypt](https://letsencrypt.org/). -If you want to deploy an `MiroTalk SFU` instance on `your own dedicated droplet`, or for other needs, don't hesitate to contact me at miroslav.pejic.85@gmail.com +If you want to deploy a `MiroTalk SFU` instance on `your dedicated droplet`, or for other needs, don't hesitate to contact me at miroslav.pejic.85@gmail.com [![DigitalOcean Referral Badge](https://web-platforms.sfo2.cdn.digitaloceanspaces.com/WWW/Badge%201.svg)](https://www.digitalocean.com/?refcode=1070207afbb1&utm_campaign=Referral_Invite&utm_medium=Referral_Program&utm_source=badge) @@ -55,8 +55,7 @@ If you want to deploy an `MiroTalk SFU` instance on `your own dedicated droplet` ## Run it locally - You will need to have `NodeJS` installed, this project has been tested with Node version [12.X](https://nodejs.org/en/blog/release/v12.22.1/) and [14.X](https://nodejs.org/en/blog/release/v14.17.5/), `python3-pip DEB package`, `build-essential DEB package` and `python version >= 3.6 with PIP`. - -The `requirements` can also be found [here](https://mediasoup.org/documentation/v3/mediasoup/installation/#requirements). +- The `requirements` can also be found [here](https://mediasoup.org/documentation/v3/mediasoup/installation/#requirements). ```bash # Clone this repo @@ -101,7 +100,7 @@ $ docker-compose down # The response will give you a entrypoint / Room URL for your meeting. $ curl -X POST "http://localhost:3010/api/v1/meeting" -H "authorization: mirotalksfu_default_secret" -H "Content-Type: application/json" $ curl -X POST "https://sfu.mirotalk.org/api/v1/meeting" -H "authorization: mirotalksfu_default_secret" -H "Content-Type: application/json" -# The response will give you a entrypoint / URL for the direct join. +# The response will give you a entrypoint / URL for the direct join to the meeting. $ curl -X POST "http://localhost:3010/api/v1/join" -H "authorization: mirotalksfu_default_secret" -H "Content-Type: application/json" --data '{"room":"test","name":"mirotalksfu","audio":"0","video":"0"}' $ curl -X POST "https://sfu.mirotalk.org/api/v1/join" -H "authorization: mirotalksfu_default_secret" -H "Content-Type: application/json" --data '{"room":"test","name":"mirotalksfu","audio":"0","video":"0"}' ``` @@ -111,12 +110,12 @@ $ curl -X POST "https://sfu.mirotalk.org/api/v1/join" -H "authorization: mirotal - You can also `join` directly to your `room` by going to - https://sfu.mirotalk.org/join?room=test&name=mirotalksfu&audio=0&video=0 -| Params | Description | Value | -| ------ | ---------------------- | ----------------- | -| room | Room Id | test | -| name | Your name | mirotalksfu | -| audio | Enable / Disable audio | 0/1 or true/false | -| video | Enable / Disable video | 0/1 or true/false | +| Params | Type | Description | +| ------ | ------- | ---------------- | +| room | string | room Id | +| name | string | your name | +| audio | boolean | enable / disable | +| video | boolean | enable / disable | ## Notes @@ -141,4 +140,4 @@ $ curl -X POST "https://sfu.mirotalk.org/api/v1/join" -H "authorization: mirotal ### MiroTalk P2P -You can try also [MiroTalk P2P](https://github.com/miroslavpejic85/mirotalk), The difference between the 2 projects you can found [here](https://github.com/miroslavpejic85/mirotalksfu/issues/14#issuecomment-932701999). +You can also try [MiroTalk P2P](https://github.com/miroslavpejic85/mirotalk), The difference between the two projects you can found [here](https://github.com/miroslavpejic85/mirotalksfu/issues/14#issuecomment-932701999).