From 56a8338239e5fd0544e4a869158aaaea3d53f43d Mon Sep 17 00:00:00 2001 From: Miroslav Pejic Date: Sat, 23 Apr 2022 19:31:32 +0200 Subject: [PATCH] [mirotalksfu] - update readme --- README.md | 168 +++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 121 insertions(+), 47 deletions(-) diff --git a/README.md b/README.md index 9316ed87..dbf14e64 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,21 @@ -# MiroTalk SFU +#

MiroTalk SFU

-[![Author](https://img.shields.io/badge/Author-Miroslav-brightgreen.svg)](https://www.linkedin.com/in/miroslav-pejic-976a07101/) -[![License: AGPLv3](https://img.shields.io/badge/License-AGPLv3-blue.svg)](https://github.com/miroslavpejic85/mirotalksfu/blob/main/LICENSE) -[![PayPal](https://img.shields.io/badge/Support-PayPal-brightgreen.svg)](https://paypal.me/MiroslavPejic?locale.x=it_IT) -[![Digital Ocean](https://img.shields.io/badge/Powered%20by-DigitalOcean-blue)](https://m.do.co/c/1070207afbb1) -[![Code style: prettier](https://img.shields.io/badge/Code_style-Prettier-ff69b4.svg?)](https://github.com/prettier/prettier) -[![Discord](https://img.shields.io/badge/chat-discord-green)](https://discord.gg/rgGYfeYW3N) +

Free WebRTC - SFU - Simple, Secure, Scalable Real-Time Video Conferences Up to 4k, compatible with all browsers and platforms.

-Powered by `WebRTC` and powerful [SFU](https://mediasoup.org) integrated media server. +
-Open the app with the following **supported browsers** and many more. +

+ + + +

-[![Foo](public/images/browsers.png)](https://sfu.mirotalk.org/) +
-## https://sfu.mirotalk.org/ +
+Features -
- -[![mirotalksfu](public/images/mirotalksfu-header.gif)](https://sfu.mirotalk.org/) - -## Features +
- Is `100% Free` - `Open Source` - `Self Hosted` - `No download`, `plug-in` or `login` required, entirely browser-based @@ -44,17 +40,43 @@ Open the app with the following **supported browsers** and many more. - Supports [REST API](app/api/README.md) (Application Programming Interface) - [Sentry](https://sentry.io/) error reporting ---- +
-## Presentation +
+Presentation -https://www.canva.com/design/DAE693uLOIU/view +
-## Quick Start +MiroTalk presentation -- 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). +
+ +
+Quick Start + +
+ +- You will need to have `NodeJS` and all [requirements](https://mediasoup.org/documentation/v3/mediasoup/installation/#requirements) 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/). + +Requirements install example for `Ubuntu 20.04` + +```bash +# gcc g++ make +$ apt-get update +$ apt-get install -y build-essential +# Python 3.8 and pip +$ DEBIAN_FRONTEND=noninteractive apt-get install -y tzdata +$ apt install -y software-properties-common +$ add-apt-repository ppa:deadsnakes/ppa +$ apt update +$ apt install -y python3.8 python3-pip +# NodeJS 14.X and npm +$ apt install -y curl dirmngr apt-transport-https lsb-release ca-certificates +$ curl -sL https://deb.nodesource.com/setup_14.x | bash - +$ apt-get install -y nodejs +``` + +Start the project ```bash # Clone this repo @@ -71,9 +93,12 @@ $ npm start - Open https://localhost:3010 in browser ---- +
-## Docker +
+Docker + +
- Install docker engine: https://docs.docker.com/engine/install/ - Install docker compose: https://docs.docker.com/compose/install/ @@ -93,9 +118,12 @@ $ docker-compose down - Open https://localhost:3010 in browser ---- +
-## API +
+Rest API + +
- The API documentation uses [swagger](https://swagger.io/) at https://localhost:3010/api/v1/docs or check it on live [here](https://sfu.mirotalk.org/api/v1/docs). @@ -108,7 +136,12 @@ $ curl -X POST "http://localhost:3010/api/v1/join" -H "authorization: mirotalksf $ 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","notify":"0"}' ``` -## Direct Join +
+ +
+Direct Join + +
- You can also `join` directly to your `room` by going to - https://sfu.mirotalk.org/join?room=test&name=mirotalksfu&audio=0&video=0¬ify=0 @@ -121,9 +154,12 @@ $ curl -X POST "https://sfu.mirotalk.org/api/v1/join" -H "authorization: mirotal | video | boolean | enable / disable | | notify | boolean | enable / disable | ---- +
-## Embed a meeting +
+Embed a meeting + +
Embedding a meeting into a service or app using an iframe. @@ -135,9 +171,12 @@ Embedding a meeting into a service or app using an iframe. > ``` ---- +
-## DigitalOcean +
+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/). @@ -145,40 +184,71 @@ If you want to deploy a `MiroTalk SFU` instance on `your dedicated droplet`, or [![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) -## Live Demo +
+ +
+Live Demo + +
https://sfu.mirotalk.org [![mirotalksfu-qr](public/images/mirotalksfu-qr.png)](https://sfu.mirotalk.org/) ---- +
-## Https +
+Https + +
You can start videoconferencing directly from your Local PC, and be reachable from any device outside your network, simply by following [these steps](https://github.com/miroslavpejic85/mirotalksfu/issues/26#issuecomment-986309051). -## Notes +
+ +
+Notes + +
- Run the project on a `Linux or Mac` system as the `mediasoup` installation could have issues on `Windows`. -## Credits +
+ +
+Credits + +
- [Davide Pacilio](https://cruip.com/demos/solid/) (html template) - [Dirk Vanbeveren](https://github.com/Dirvann) (sfu logic) - [Mediasoup](https://mediasoup.org) (sfu server) -## Contributing +
+ +
+Contributing + +
- Contributions are welcome and greatly appreciated! - Just run before `npm run lint` -## Discussions +
-- For discussions about the project, join with us on [Discord](https://discord.gg/rgGYfeYW3N) +
+Discussions and support
-## License +- For discussions & support about the project, join with us on [Discord](https://discord.gg/rgGYfeYW3N) + +
+ +
+License + +
[![AGPLv3](public/images/AGPLv3.png)](LICENSE) @@ -186,22 +256,26 @@ MiroTalk is free and can be modified and forked. But the conditions of the AGPLv For a MiroTalk license under conditions other than AGPLv3, please contact us at info.mirotalk@gmail.com. ---- +
+ +
+Sponsors
-# Sponsors - Support this project by [becoming a sponsor](https://github.com/sponsors/miroslavpejic85). Your logo will show up here with a link to your website. [![BroadcastX](public/sponsors/BroadcastX.png)](https://broadcastx.de/) ---- +

-## MiroTalk P2P +
+MiroTalk P2P + +
Try also [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). ---- +