[mirotalk] - update readme

This commit is contained in:
Miroslav Pejic
2022-03-12 10:49:23 +01:00
parent 93d36cf150
commit 8e4ddcb2d7
2 changed files with 9 additions and 10 deletions
+4 -5
View File
@@ -7,6 +7,7 @@
[![Support](https://img.shields.io/badge/Support-PayPal-brightgreen.svg)](https://paypal.me/MiroslavPejic?locale.x=it_IT)
[![Digital Ocean](https://img.shields.io/badge/Tested%20on-DigitalOcean-blue)](https://m.do.co/c/1070207afbb1)
[![Code style: prettier](https://img.shields.io/badge/Code_style-Prettier-ff69b4.svg?)](https://github.com/prettier/prettier)
[![Discord](https://img.shields.io/badge/chat-discord-green)](https://discord.gg/rgGYfeYW3N)
Free `WebRTC` browser-based video calls, chat, and screen sharing, using google Stun and [numb](http://numb.viagenie.ca/) Turn. `MiroTalk` provides video quality and latency not available with traditional technology.
@@ -110,7 +111,7 @@ $ docker-compose down
## Setup Turn
- `Recommended`, for more info about the Turn check out [here](https://webrtc.org/getting-started/turn-server). Just edit [this part](https://github.com/miroslavpejic85/mirotalk/blob/master/.env.template#L9) on your `.env`.
`Recommended`, for more info about the Turn check out [here](https://webrtc.org/getting-started/turn-server). Just edit [this part](https://github.com/miroslavpejic85/mirotalk/blob/master/.env.template#L9) on your `.env`.
---
@@ -125,13 +126,13 @@ $ curl -X POST "https://mirotalk.herokuapp.com/api/v1/meeting" -H "authorization
## API Documentation
- The API documentation uses [swagger](https://swagger.io/) at http://localhost:3000/api/v1/docs. Or check it out on [railway](https://mirotalk.up.railway.app/api/v1/docs) & [heroku](https://mirotalk.herokuapp.com/api/v1/docs).
The API documentation uses [swagger](https://swagger.io/) at http://localhost:3000/api/v1/docs. Or check it out on [railway](https://mirotalk.up.railway.app/api/v1/docs) & [heroku](https://mirotalk.herokuapp.com/api/v1/docs).
---
## Live demo
- If you want `MiroTalk` to be `reachable` from the `outside` of your local network, you can use a service like [ngrok](https://ngrok.com/) (by editing the [Ngrok part](https://github.com/miroslavpejic85/mirotalk/blob/master/.env.template#L1) on `.env` file) or expose it directly on [HTTPS](app/ssl/README.md) or deploy it on:
If you want `MiroTalk` to be `reachable` from the `outside` of your local network, you can use a service like [ngrok](https://ngrok.com/) (by editing the [Ngrok part](https://github.com/miroslavpejic85/mirotalk/blob/master/.env.template#L1) on `.env` file) or expose it directly on [HTTPS](app/ssl/README.md) or deploy it on:
<br>
@@ -166,8 +167,6 @@ https://mirotalk.up.railway.app/
- For discussions about the project, join with us on [Discord](https://discord.gg/rgGYfeYW3N)
[![Discord](https://img.shields.io/badge/chat-discord-green)](https://discord.gg/rgGYfeYW3N)
## License
[![AGPLv3](public/images/AGPLv3.png)](LICENSE)
+5 -5
View File
@@ -300,15 +300,15 @@ async function ngrokStart() {
let tunnelHttps = pu0.startsWith('https') ? pu0 : pu1;
// server settings
log.debug('settings', {
server: host,
server_tunnel: tunnelHttps,
api_docs: api_docs,
api_key_secret: api_key_secret,
iceServers: iceServers,
ngrok: {
ngrok_enabled: ngrokEnabled,
ngrok_token: ngrokAuthToken,
},
server: host,
server_tunnel: tunnelHttps,
api_docs: api_docs,
api_key_secret: api_key_secret,
});
} catch (err) {
console.error('[Error] ngrokStart', err);
@@ -340,10 +340,10 @@ server.listen(port, null, () => {
} else {
// server settings
log.debug('settings', {
iceServers: iceServers,
server: host,
api_docs: api_docs,
api_key_secret: api_key_secret,
iceServers: iceServers,
});
}
});