From b7349d0363d9617ecca7d37570d15eb80a67ba99 Mon Sep 17 00:00:00 2001 From: Miroslav Pejic Date: Thu, 28 Jul 2022 17:53:19 +0200 Subject: [PATCH] [mirotalksfu] - update readme & docs --- README.md | 7 ++++--- docs/ngrok.md | 10 ++-------- docs/self-hosting.md | 21 ++++++++------------- 3 files changed, 14 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 9185c264..c872a706 100644 --- a/README.md +++ b/README.md @@ -112,14 +112,15 @@ $ npm start - Install docker engine: https://docs.docker.com/engine/install/ - Install docker compose: https://docs.docker.com/compose/install/ +- Repository docker hub: https://hub.docker.com/repository/docker/mirotalk/sfu ```bash -# Copy app/src/config.template.js in app/src/config.js and edit it if needed +# Copy app/src/config.template.js in app/src/config.js IMPORTANT (edit it according to your needs) $ cp app/src/config.template.js app/src/config.js # Copy docker-compose.template.yml in docker-compose.yml and edit it if needed $ cp docker-compose.template.yml docker-compose.yml -# Build or rebuild services - be patient, the first time will take a few minutes, in the meantime have a good coffee ;) -$ docker-compose build +# Get official image from Docker Hub +$ docker pull mirotalk/sfu:latest # Create and start containers $ docker-compose up # -d # Stop and remove resources diff --git a/docs/ngrok.md b/docs/ngrok.md index f4cc1195..dfc4e122 100644 --- a/docs/ngrok.md +++ b/docs/ngrok.md @@ -35,14 +35,8 @@ 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. -
- --- -## Do you find MiroTalk useful? +## Support -Show your appreciation by becoming a [backer or sponsor](https://github.com/sponsors/miroslavpejic85) - -Thank you for your support! - ---- +[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/mirotalk/mirotalk-sfu-free-video-calls-messaging-screen-sharing-recording) diff --git a/docs/self-hosting.md b/docs/self-hosting.md index 2466c86e..d574acaf 100644 --- a/docs/self-hosting.md +++ b/docs/self-hosting.md @@ -85,17 +85,19 @@ $ pm2 start app/src/Server.js If you want to use `Docker` +Repo: https://hub.docker.com/repository/docker/mirotalk/sfu + ```bash # Install docker and docker-compose $ sudo apt install docker.io $ sudo apt install docker-compose -# Copy app/src/config.template.js in app/src/config.js and edit it if needed +# Copy app/src/config.template.js in app/src/config.js IMPORTANT (edit it according to your needs) $ cp app/src/config.template.js app/src/config.js # Copy docker-compose.template.yml in docker-compose.yml and edit it if needed $ cp docker-compose.template.yml docker-compose.yml -# Build or rebuild services - be patient, the first time will take a few minutes, in the meantime have a good coffee ;) -$ docker-compose build +# Get official image from Docker Hub +$ docker pull mirotalk/sfu:latest # Create and start containers as deamon $ docker-compose up -d ``` @@ -221,8 +223,7 @@ If you use `Docker`, paste this: cd mirotalksfu git pull -docker-compose down -docker-compose build +docker pull mirotalk/sfu:latest docker images |grep '' |awk '{print $3}' |xargs docker rmi docker-compose up -d ``` @@ -243,14 +244,8 @@ To update your instance of MiroTalk SFU at latest commit, execute: ./sfuUpdate.sh ``` -
- --- -## Do you find MiroTalk useful? +## Support -Show your appreciation by becoming a [backer or sponsor](https://github.com/sponsors/miroslavpejic85) - -Thank you for your support! - ---- +[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/mirotalk/mirotalk-sfu-free-video-calls-messaging-screen-sharing-recording)