[mirotalksfu] - typo

هذا الالتزام موجود في:
Miroslav Pejic
2022-06-19 12:39:51 +02:00
الأصل 08b6191e72
التزام 290b11f31a
2 ملفات معدلة مع 33 إضافات و7 حذوفات

عرض الملف

@@ -2,9 +2,7 @@
If you want to expose MiroTalk SFU from your `Local PC` to outside in `HTTPS`, you need to do 2 things: If you want to expose MiroTalk SFU from your `Local PC` to outside in `HTTPS`, you need to do 2 things:
1. Add the [Ngrok](https://ngrok.com) `authToken` and change the `announcedIp` 1. Add the [Ngrok](https://ngrok.com) `authToken` and change the `announcedIp` on `app/src/config.js`.
In `app/src/` copy config.template.js to `config.js` then edit it
```js ```js
/* /*
@@ -18,6 +16,8 @@ In `app/src/` copy config.template.js to `config.js` then edit it
announcedIp: 'Your-Public-Static-IP-here' <--- take it from https://api.ipify.org announcedIp: 'Your-Public-Static-IP-here' <--- take it from https://api.ipify.org
``` ```
---
2. You need to do a `port forwarding` on your router, something like this: 2. You need to do a `port forwarding` on your router, something like this:
| Name | Protocol | Port Wan | Port Lan | IP Destination | | Name | Protocol | Port Wan | Port Lan | IP Destination |
@@ -35,12 +35,14 @@ server_tunnel: 'https://xxxxxxxxxxxxxxxxxx.ngrok.io'
So open it in your browser, join in the room, share it to whom you want and wait participants to join. So open it in your browser, join in the room, share it to whom you want and wait participants to join.
<br/> <br />
---
## Do you find MiroTalk useful? ## Do you find MiroTalk useful?
Show your appreciation by becoming a [backer or sponsor](https://github.com/sponsors/miroslavpejic85) Show your appreciation by becoming a [backer or sponsor](https://github.com/sponsors/miroslavpejic85)
Thank you for your support! ❤️ Thank you for your support!
--- ---

عرض الملف

@@ -6,6 +6,8 @@ Requirments:
- [Node.js](https://nodejs.org/en/) at least 12x, better `16.15.1 LTS` - [Node.js](https://nodejs.org/en/) at least 12x, better `16.15.1 LTS`
- Your domain example: `your.domain.name` (Set a DNS A record for that domain that point to Your Server public IPv4) - Your domain example: `your.domain.name` (Set a DNS A record for that domain that point to Your Server public IPv4)
---
Install the requirements (Note: Many of the installation steps require `root` or `sudo` access) Install the requirements (Note: Many of the installation steps require `root` or `sudo` access)
```bash ```bash
@@ -27,6 +29,8 @@ $ apt-get install -y nodejs
$ npm install -g npm@latest $ npm install -g npm@latest
``` ```
---
Quick start Quick start
```bash ```bash
@@ -38,6 +42,8 @@ $ cd mirotalksfu
$ cp app/src/config.template.js app/src/config.js $ cp app/src/config.template.js app/src/config.js
``` ```
---
Change the `announcedIp` with your `Server public IPv4` on `app/src/config.js` Change the `announcedIp` with your `Server public IPv4` on `app/src/config.js`
```js ```js
@@ -55,6 +61,8 @@ Set the `inbound rules` if you have the Firewall enalbled
| 40000-40100 | TCP | 0.0.0.0/0 | RTC port ranges tcp | | 40000-40100 | TCP | 0.0.0.0/0 | RTC port ranges tcp |
| 40000-40100 | UDP | 0.0.0.0/0 | RTC port ranges udp | | 40000-40100 | UDP | 0.0.0.0/0 | RTC port ranges udp |
---
```bash ```bash
# Install dependencies - be patient, the first time will take a few minutes, in the meantime have a good coffee ;) # Install dependencies - be patient, the first time will take a few minutes, in the meantime have a good coffee ;)
$ npm install $ npm install
@@ -64,6 +72,8 @@ $ npm start
Check if is correctly installed: https://your.domain.name:3010 Check if is correctly installed: https://your.domain.name:3010
---
Using [PM2](https://pm2.keymetrics.io) to run it as deamon Using [PM2](https://pm2.keymetrics.io) to run it as deamon
```bash ```bash
@@ -71,7 +81,9 @@ $ npm install -g pm2
$ pm2 start app/src/Server.js $ pm2 start app/src/Server.js
``` ```
If you want to use Docker ---
If you want to use `Docker`
```bash ```bash
# Install docker and docker-compose # Install docker and docker-compose
@@ -90,6 +102,8 @@ $ docker-compose up -d
Check if is correctly installed: https://your.domain.name:3010 Check if is correctly installed: https://your.domain.name:3010
---
In order to use it without the port number at the end, and to have encrypted communications, we going to install [nginx](https://www.nginx.com) and [certbot](https://certbot.eff.org) In order to use it without the port number at the end, and to have encrypted communications, we going to install [nginx](https://www.nginx.com) and [certbot](https://certbot.eff.org)
```bash ```bash
@@ -169,6 +183,8 @@ $ sudo certbot certificates
Check Your MiroTalk SFU instance: https://your.domain.name/ Check Your MiroTalk SFU instance: https://your.domain.name/
---
## Update script ## Update script
In order to have always Your MiroTalk SFU updated to latest, we going to create a script In order to have always Your MiroTalk SFU updated to latest, we going to create a script
@@ -178,6 +194,8 @@ In order to have always Your MiroTalk SFU updated to latest, we going to create
$ vim sfuUpdate.sh $ vim sfuUpdate.sh
``` ```
---
If you use `PM2`, paste this: If you use `PM2`, paste this:
```bash ```bash
@@ -190,6 +208,8 @@ sudo npm install
pm2 start app/src/Server.js pm2 start app/src/Server.js
``` ```
---
If you use `Docker`, paste this: If you use `Docker`, paste this:
```bash ```bash
@@ -203,6 +223,8 @@ docker images |grep '<none>' |awk '{print $3}' |xargs docker rmi
docker-compose up -d docker-compose up -d
``` ```
---
Make the script executable Make the script executable
```bash ```bash
@@ -219,10 +241,12 @@ To update your instance of MiroTalk SFU at latest commit, execute:
<br/> <br/>
---
## Do you find MiroTalk useful? ## Do you find MiroTalk useful?
Show your appreciation by becoming a [backer or sponsor](https://github.com/sponsors/miroslavpejic85) Show your appreciation by becoming a [backer or sponsor](https://github.com/sponsors/miroslavpejic85)
Thank you for your support! ❤️ Thank you for your support!
--- ---