diff --git a/docs/ngrok.md b/docs/ngrok.md index dfc4e122..38470b15 100644 --- a/docs/ngrok.md +++ b/docs/ngrok.md @@ -1,4 +1,6 @@ -## MiroTalk SFU - Ngrok +# MiroTalk SFU - Ngrok + +![ngrok](../public/images/ngrok.png) If you want to expose MiroTalk SFU from your `Local PC` to outside in `HTTPS`, you need to do 2 things: diff --git a/docs/self-hosting.md b/docs/self-hosting.md index a5348a48..c85ba685 100644 --- a/docs/self-hosting.md +++ b/docs/self-hosting.md @@ -1,6 +1,6 @@ -## MiroTalk SFU - Self Hosting +# MiroTalk SFU - Self Hosting -Requirments: +## Requirments - Recommended: [Hetzner](https://www.hetzner.com/cloud) (`CPX11` it's enough, OS: `Ubuntu 20.04`) - [Node.js](https://nodejs.org/en/) at least 12x, better `16.15.1 LTS` @@ -31,7 +31,7 @@ $ npm install -g npm@latest --- -Quick start +## Quick start ```bash # Clone this repo @@ -74,6 +74,10 @@ Check if is correctly installed: https://your.domain.name:3010 --- +## PM2 + +![pm2](../public/images/pm2.png) + Using [PM2](https://pm2.keymetrics.io) to run it as deamon ```bash @@ -83,6 +87,10 @@ $ pm2 start app/src/Server.js --- +## Docker + +![docker](../public/images/docker.png) + If you want to use `Docker` Repo: https://hub.docker.com/r/mirotalk/sfu @@ -106,6 +114,10 @@ Check if is correctly installed: https://your.domain.name:3010 --- +## Nginx & Certbot + +![nginx](../public/images/nginx.png) + 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 diff --git a/public/images/nginx.png b/public/images/nginx.png new file mode 100644 index 00000000..f59edfb2 Binary files /dev/null and b/public/images/nginx.png differ diff --git a/public/images/ngrok.png b/public/images/ngrok.png new file mode 100644 index 00000000..174048b3 Binary files /dev/null and b/public/images/ngrok.png differ diff --git a/public/images/pm2.png b/public/images/pm2.png new file mode 100644 index 00000000..70a1a6fd Binary files /dev/null and b/public/images/pm2.png differ