[mirotalk] - update readme
This commit is contained in:
@@ -106,6 +106,19 @@ $ docker-compose down
|
||||
|
||||
---
|
||||
|
||||
## Setup Turn
|
||||
|
||||
`Recommended`, more info about Turn you can find [here](https://webrtc.org/getting-started/turn-server).
|
||||
|
||||
```bash
|
||||
# copy .env.template to .env
|
||||
$ cp .env.template .env
|
||||
```
|
||||
|
||||
Then edit [this part](https://github.com/miroslavpejic85/mirotalk/blob/master/.env.template#L9) on your `.env`.
|
||||
|
||||
---
|
||||
|
||||
## API
|
||||
|
||||
```bash
|
||||
@@ -121,6 +134,8 @@ The API documentation uses [swagger](https://swagger.io/) at http://localhost:30
|
||||
|
||||
---
|
||||
|
||||
## 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 on `.env` file) or expose it directly on [https](ssl/README.md) or deploy it on:
|
||||
|
||||
<br>
|
||||
|
||||
+2
-2
@@ -18,10 +18,10 @@
|
||||
"dependencies": {
|
||||
"compression": "^1.7.4",
|
||||
"cors": "^2.8.5",
|
||||
"dotenv": "^10.0.0",
|
||||
"dotenv": "^12.0.3",
|
||||
"express": "^4.17.2",
|
||||
"ngrok": "^4.2.2",
|
||||
"socket.io": "^4.4.0",
|
||||
"socket.io": "^4.4.1",
|
||||
"swagger-ui-express": "^4.3.0",
|
||||
"uuid": "8.3.2",
|
||||
"yamljs": "^0.3.0"
|
||||
|
||||
Reference in New Issue
Block a user