[mirotalksfu] - add docs

هذا الالتزام موجود في:
Miroslav Pejic
2022-06-19 11:49:13 +02:00
الأصل cb9037b7ac
التزام 08b6191e72
5 ملفات معدلة مع 284 إضافات و23 حذوفات

46
docs/ngrok.md Normal file
عرض الملف

@@ -0,0 +1,46 @@
## MiroTalk SFU - Ngrok
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`
In `app/src/` copy config.template.js to `config.js` then edit it
```js
/*
Ngrok
1. Goto https://ngrok.com
2. Get started for free
3. Copy YourNgrokAuthToken: https://dashboard.ngrok.com/get-started/your-authtoken
*/
ngrokAuthToken: 'YourNgrokAuthToken', <--- put it here
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:
| Name | Protocol | Port Wan | Port Lan | IP Destination |
| ------------- | --------- | ----------- | ----------- | --------------- |
| `MiroTalkSfu` | `TCP/UDP` | 40000:40100 | 40000:40100 | `Your Local IP` |
| `MiroTalkSfu` | `TCP` | 3010 | 3010 | `Your Local IP` |
Make sure your firewall not blocking rtcPorts `range: 40000:40100`
Then, when you run it with `npm start`, you should see in the console log this line
```bash
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.
<br/>
## Do you find MiroTalk useful?
Show your appreciation by becoming a [backer or sponsor](https://github.com/sponsors/miroslavpejic85)
Thank you for your support! ❤️
---