ghaymah_dev/codepill-sfu
2
0
نسخ 0
الشفرة المشكلات طلبات السحب Actions Packages المشاريع الإصدارات الويكي النشاط

[mirotalksfu] - update readme

تصفح المصدر
هذا الالتزام موجود في:
Miroslav Pejic
2023-10-15 22:07:52 +02:00
الأصل 4e58a07a3b
التزام a2b521b6f2
3 ملفات معدلة مع 69 إضافات و381 حذوفات
تنزيل ملف التصحيح تنزيل ملف الاختلاف توسيع جميع الملفات طي جميع الملفات

129
README.md
عرض الملف

@@ -1,11 +1,11 @@
# <p align="center">MiroTalk SFU</p>
<p align="center">Free WebRTC - SFU - Simple, Secure, Scalable Real-Time Video Conferences Up to 4k, compatible with all browsers and platforms.</p>
<p align="center">Free WebRTC - SFU - Simple, Secure, Scalable Real-Time Video Conferences with support for up to 4k resolution. It's compatible with all major browsers and platforms</p>
<hr />
<p align="center">
<a href="https://sfu.mirotalk.com/">sfu.mirotalk.com</a>
<a href="https://sfu.mirotalk.com/">Explore MiroTalk SFU</a>
</p>
<hr />
@@ -19,7 +19,7 @@
<hr />
<p align="center">
For questions, discussions, help & support, join with us on <a href="https://discord.gg/rgGYfeYW3N">discord</a>
Join our community for questions, discussions, and support on <a href="https://discord.gg/rgGYfeYW3N">Discord</a>
</p>
<hr />
@@ -29,43 +29,45 @@
<br/>
- Is `100% Free` - `Open Source` - `Self Hosted` and [PWA](https://en.wikipedia.org/wiki/Progressive_web_application)!
- No download, plug-in or login required, entirely browser-based.
- Unlimited number of conference rooms, without call time limitation.
- Desktop and Mobile compatible.
- Translated in 133 languages.
- Optimized Room URL Sharing for mobile.
- Possibility to Password protect the Room for the meeting.
- Lobby mode lets you protect your meeting by only allowing people to enter after a formal approval by a moderator.
- 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 (with drag-and-drop), share any files to your participants in the room.
- Take a snapshot from the video frame(screen/cam) to save it as an image on your device.
- Chat with Emoji Picker to show you feeling, private messages, Markdown support, possibility to Save the conversations, and many more.
- ChatGPT (openAI), designed to answer users' questions, provide relevant information, and connect them with relevant resources.
- Is `100% Free` - `Open Source (AGPLv3)` - `Self Hosted` and [PWA](https://en.wikipedia.org/wiki/Progressive_web_application)!
- Unlimited conference rooms with no time limitations.
- Translated into 133 languages.
- Host protection to prevent unauthorized access.
- Room password protection.
- Compatible with desktop and mobile devices.
- Optimized mobile room URL sharing.
- Webcam streaming with front and rear camera support for mobile devices.
- Crystal-clear audio streaming with speaking detection and volume indicators.
- Screen sharing for presentations.
- File sharing with drag-and-drop support.
- Choose your audio input, output, and video source.
- Supports video quality up to 4K.
- Supports advance Picture-in-Picture (PiP) offering a more streamlined and flexible viewing experience.
- Record your screen, audio, and video.
- Snapshot video frames and save them as PNG images.
- Chat with an Emoji Picker for expressing feelings, private messages, Markdown support, and conversation saving.
- ChatGPT (powered by OpenAI) for answering questions, providing information, and connecting users to relevant resources.
- Speech recognition, execute the app features simply with your voice.
- Push to talk, like a walkie-talkie.
- 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.
- Share any mp4, webm, ogg video in real-time to your participants with possibility to download it.
- Full-Screen Mode on mouse click on the Video element, Zoom In/Out on video mouse wheel.
- Possibility to Change UI Themes.
- Possibility to protect your Host with username and password (default disabled).
- Push-to-talk functionality, similar to a walkie-talkie.
- Advanced collaborative whiteboard for teachers.
- Real-time sharing of YouTube embed videos, video files (MP4, WebM, OGG), and audio files (MP3).
- Full-screen mode with one-click video element zooming and pin/unpin.
- Customizable UI themes.
- Right-click options on video elements for additional controls.
- Supports [REST API](app/api/README.md) (Application Programming Interface).
- [Slack](https://api.slack.com/apps/) API integration.
- [Sentry](https://sentry.io/) for error reporting.
- Integration with [Slack](https://api.slack.com/apps/) for enhanced communication.
- Utilizes [Sentry](https://sentry.io/) for error reporting.
- And much more...
</details>
<details>
<summary>About</summary>
- [Presentation](https://www.canva.com/design/DAE693uLOIU/view)
<br>
- [Video](https://www.youtube.com/watch?v=_IVn2aINYww)
- [Presentation](https://www.canva.com/design/DAE693uLOIU/view)
- [Video Overview](https://www.youtube.com/watch?v=_IVn2aINYww)
</details>
@@ -74,18 +76,18 @@
<br/>
- You can `join` directly to `room` by going to
- You can `directly join a room` by using link like:
- https://sfu.mirotalk.com/join?room=test&password=0&name=mirotalksfu&audio=0&video=0&screen=0&notify=0
| Params | Type | Description |
| -------- | -------------- | --------------- |
| room | string | room Id |
| password | string/boolean | room password |
| name | string | user name |
| audio | boolean | audio stream |
| video | boolean | video stream |
| screen | boolean | screen stream |
| notify | boolean | welcome message |
| room | string | Room Id |
| password | string/boolean | Room password |
| name | string | User name |
| audio | boolean | Audio stream |
| video | boolean | Video stream |
| screen | boolean | Screen stream |
| notify | boolean | Welcome message |
> **Note**
>
@@ -103,7 +105,7 @@
<br/>
Embedding a meeting into a service or app using an iframe.
To embed a meeting in `your service or app` using an iframe, use the following code:
```html
<iframe
@@ -120,7 +122,7 @@ Embedding a meeting into a service or app using an iframe.
<br/>
- 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 [16.X](https://nodejs.org/en/blog/release/v16.15.1/) and [18.X](https://nodejs.org/en/blog/release/v18.16.0).
- Before running MiroTalk SFU, ensure you have `Node.js` and all [requirements](https://mediasoup.org/documentation/v3/mediasoup/installation/#requirements) installed. This project has been tested with Node version [16.X](https://nodejs.org/en/blog/release/v16.15.1/) and [18.X](https://nodejs.org/en/download).
- Requirements install example for `Ubuntu 20.04`
@@ -158,7 +160,7 @@ $ npm start
$ PORT=3011 npm start
```
- Open in browser https://localhost:3010 or `:3011` if default port changed.
- Open [https://localhost:3010](https://localhost:3010) or `:3011` if the default port has been changed in your browser.
<br/>
@@ -174,8 +176,8 @@ $ PORT=3011 npm start
![docker](public/images/docker.png)
- Install [docker engine](https://docs.docker.com/engine/install/)
- Install [docker compose](https://docs.docker.com/compose/install/)
- Repository [docker hub](https://hub.docker.com/r/mirotalk/sfu)
- Install [docker engine](https://docs.docker.com/engine/install/) and [docker compose](https://docs.docker.com/compose/install/)
```bash
# Copy app/src/config.template.js in app/src/config.js IMPORTANT (edit it according to your needs)
@@ -190,8 +192,7 @@ $ docker-compose up # -d
$ docker-compose down
```
- Open in browser https://localhost:3010
- Repository [docker hub](https://hub.docker.com/r/mirotalk/sfu)
- Open [https://localhost:3010](https://localhost:3010) in your browser.
</details>
@@ -200,7 +201,7 @@ $ docker-compose down
<br/>
You can start videoconferencing directly from your Local PC, and be reachable from any device outside your network, simply by following [these documentation](docs/ngrok.md).
You can start a video conference directly from your local PC and make it accessible from any device outside your network by following [these instructions](docs/ngrok.md), or expose it directly on [HTTPS](app/ssl/README.md).
</details>
@@ -209,16 +210,7 @@ You can start videoconferencing directly from your Local PC, and be reachable fr
<br/>
To `Self-Host MiroTalk SFU` on `Your` dedicated `Server`, read [this documentation](docs/self-hosting.md).
</details>
<details>
<summary>Notes</summary>
<br/>
- Run the project on a `Linux or Mac` system as the `mediasoup` installation could have issues on `Windows`.
For `self-hosting MiroTalk SFU` on your own dedicated server, please refer to [this comprehensive guide](docs/self-hosting.md). It will provide you with all the necessary instructions to get your MiroTalk SFU instance up and running smoothly.
</details>
@@ -227,7 +219,7 @@ To `Self-Host MiroTalk SFU` on `Your` dedicated `Server`, read [this documentati
<br/>
- The API documentation uses [swagger](https://swagger.io/) at https://localhost:3010/api/v1/docs or check it on live [here](https://sfu.mirotalk.com/api/v1/docs).
- The [API documentation](https://docs.mirotalk.com/mirotalk-sfu/api/) uses [swagger](https://swagger.io/) at https://localhost:3010/api/v1/docs or check it on live [here](https://sfu.mirotalk.com/api/v1/docs).
```bash
# The response will give you a entrypoint / Room URL for your meeting.
@@ -255,7 +247,7 @@ Use [my personal link](https://hetzner.cloud/?ref=XdRifCzCK3bn) to receive `€
---
If you need help to deploy `MiroTalk SFU` instance on `your dedicated cloud server`, or for other needs, don't hesitate to contact us at sfu.mirotalk@gmail.com
To set up your own instance of `MiroTalk SFU` on a dedicated cloud server, please refer to our comprehensive [self-hosting documentation](https://docs.mirotalk.com/mirotalk-sfu/self-hosting/). This guide will walk you through the process step by step, ensuring a smooth and successful deployment.
</details>
@@ -268,8 +260,6 @@ If you need help to deploy `MiroTalk SFU` instance on `your dedicated cloud serv
For personal use, you can start with a single $5 a month cloud server and scale up as needed. You can use [this link](https://m.do.co/c/1070207afbb1) to get a `$100 credit for the first 60 days`.
If you need help to deploy `MiroTalk SFU` instance on `your dedicated cloud server`, or for other needs, don't hesitate to contact us at sfu.mirotalk@gmail.com
</details>
<details>
@@ -313,9 +303,9 @@ https://sfu.mirotalk.com
[![AGPLv3](public/images/AGPLv3.png)](LICENSE)
MiroTalk is free and can be modified and forked. But the conditions of the AGPLv3 (GNU Affero General Public License v3.0) need to be respected. In particular modifications need to be free as well and made available to the public. Get a quick overview of the license at [Choose an open source license](https://choosealicense.com/licenses/agpl-3.0/).
MiroTalk SFU is free and open-source under the terms of AGPLv3 (GNU Affero General Public License v3.0). Please `respect the license conditions`, In particular `modifications need to be free as well and made available to the public`. Get a quick overview of the license at [Choose an open source license](https://choosealicense.com/licenses/agpl-3.0/).
For a MiroTalk license under conditions other than AGPLv3, please contact us at license.mirotalk@gmail.com or [purchase directly from CodeCanyon](https://codecanyon.net/item/mirotalk-sfu-webrtc-realtime-video-conferences/40769970).
To obtain a [MiroTalk SFU license](https://docs.mirotalk.com/license/licensing-options/) with terms different from the AGPLv3, you can conveniently make your [purchase on CodeCanyon](https://codecanyon.net/item/mirotalk-sfu-webrtc-realtime-video-conferences/40769970). This allows you to tailor the licensing conditions to better suit your specific requirements.
</details>
@@ -324,9 +314,7 @@ For a MiroTalk license under conditions other than AGPLv3, please contact us at
<br/>
Do you find MiroTalk useful?
Support the project by [becoming a backer or sponsor](https://github.com/sponsors/miroslavpejic85). Your logo will show up here with a link to your website.
Do you find MiroTalk SFU indispensable for your needs? Join us in supporting this transformative project by [becoming a backer or sponsor](https://github.com/sponsors/miroslavpejic85). By doing so, not only will your logo prominently feature here, but you'll also drive the growth and sustainability of MiroTalk SFU. Your support is vital in ensuring that this valuable platform continues to thrive and remain accessible for all. Make an impact – back MiroTalk SFU today and be part of this exciting journey!
| | |
| --------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
@@ -356,6 +344,15 @@ Try also [MiroTalk C2C](https://github.com/miroslavpejic85/mirotalkc2c) cam 2 ca
</details>
<details>
<summary>MiroTalk BRO</summary>
<br>
Try also [MiroTalk BRO](https://github.com/miroslavpejic85/mirotalkbro) live broadcasting.
</details>
<details>
<summary>MiroTalk WEB</summary>