[mirotalk] - typo

This commit is contained in:
Miroslav Pejic
2022-06-19 12:43:33 +02:00
parent b913090dc3
commit 1dfe6300df
2 changed files with 25 additions and 3 deletions
+3 -1
View File
@@ -23,10 +23,12 @@ So open it in your browser, join in the room, share it to whom you want and wait
<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! ❤️
Thank you for your support!
---
+22 -2
View File
@@ -7,6 +7,8 @@ Requirments:
- Set own TURN server (recommended) or use third party STUN/TURN servers (configurable on `.env` file)
- 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)
```bash
@@ -18,6 +20,8 @@ $ sudo apt-get install -y nodejs
$ npm install -g npm@latest
```
---
Quick start
```bash
@@ -35,6 +39,8 @@ $ npm start
Check if is correctly installed: https://your.domain.name:3000
---
Using [PM2](https://pm2.keymetrics.io) to run it as deamon
```bash
@@ -42,7 +48,9 @@ $ npm install -g pm2
$ pm2 start app/src/server.js
```
If you want to use Docker
---
If you want to use `Docker`
```bash
# Install docker and docker-compose
@@ -59,6 +67,8 @@ $ docker-compose up -d
Check if is correctly installed: https://your.domain.name:3000
---
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
@@ -138,6 +148,8 @@ $ sudo certbot certificates
Check Your MiroTalk P2P instance: https://your.domain.name
---
## Update script
In order to have always Your MiroTalk P2P updated to latest, we going to create a script
@@ -147,6 +159,8 @@ In order to have always Your MiroTalk P2P updated to latest, we going to create
$ vim p2pUpdate.sh
```
---
If you use `PM2`, paste this:
```bash
@@ -159,6 +173,8 @@ sudo npm install
pm2 start app/src/server.js
```
---
If you use `Docker`, paste this:
```bash
@@ -172,6 +188,8 @@ docker images |grep '<none>' |awk '{print $3}' |xargs docker rmi
docker-compose up -d
```
---
Make the script executable
```bash
@@ -188,10 +206,12 @@ To update Your MiroTalk P2P instance at latest commit, execute:
<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! ❤️
Thank you for your support!
---