[mirotalksfu] - update readme
هذا الالتزام موجود في:
Miroslav Pejic
42
README.md
42
README.md
@@ -6,7 +6,7 @@
|
||||
[](https://m.do.co/c/1070207afbb1)
|
||||
[](https://github.com/prettier/prettier)
|
||||
|
||||
Powered by `WebRTC` and [SFU](https://mediasoup.org) integrated server.
|
||||
Powered by `WebRTC` and powerful [SFU](https://mediasoup.org) integrated media server.
|
||||
|
||||
Open the app with the following **supported browsers** and many more.
|
||||
|
||||
@@ -40,24 +40,12 @@ Open the app with the following **supported browsers** and many more.
|
||||
- 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 a `MiroTalk SFU` instance on `your dedicated droplet`, or for other needs, don't hesitate to contact me at miroslav.pejic.85@gmail.com
|
||||
|
||||
[](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)
|
||||
|
||||
[](https://sfu.mirotalk.org/)
|
||||
|
||||
## Run it locally
|
||||
## Quick Start
|
||||
|
||||
- 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.
|
||||
- `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).
|
||||
|
||||
```bash
|
||||
@@ -75,6 +63,8 @@ $ npm start
|
||||
|
||||
- Open https://localhost:3010 in browser
|
||||
|
||||
---
|
||||
|
||||
## Docker
|
||||
|
||||
- Install docker engine: https://docs.docker.com/engine/install/
|
||||
@@ -95,6 +85,8 @@ $ docker-compose down
|
||||
|
||||
- Open https://localhost:3010 in browser
|
||||
|
||||
---
|
||||
|
||||
## 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).
|
||||
@@ -121,6 +113,24 @@ $ curl -X POST "https://sfu.mirotalk.org/api/v1/join" -H "authorization: mirotal
|
||||
| video | boolean | enable / disable |
|
||||
| notify | boolean | enable / disable |
|
||||
|
||||
---
|
||||
|
||||
## 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 a `MiroTalk SFU` instance on `your dedicated droplet`, or for other needs, don't hesitate to contact me at miroslav.pejic.85@gmail.com
|
||||
|
||||
[](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)
|
||||
|
||||
[](https://sfu.mirotalk.org/)
|
||||
|
||||
---
|
||||
|
||||
## 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).
|
||||
|
||||
المرجع في مشكلة جديدة
حظر مستخدم