From 5bb25d3088cf285c63b79b7914f307a0530b9c57 Mon Sep 17 00:00:00 2001 From: Luis Guzman Date: Mon, 13 Apr 2020 22:22:00 -0500 Subject: [PATCH] Update README.md --- README.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 394c6eb..85d4fb6 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,8 @@ Bash installer for Jibri on *buntu LTS based systems ## Requirements * Clean VM/VPS/Server using Ubuntu LTS -* Valid domain with DNS record. +* Valid domain with DNS record, **mandatory** for SSL certs via Let's Encrypt. +* Ports open for ACME (SSL) interaction & validation. * Minimum recommended for video recording: 8 GB RAM / 2 Cores. * Dropbox developer App key & redirect url configured (if you choose to enable Dropbox upload). * Webcam @@ -12,10 +13,6 @@ Bash installer for Jibri on *buntu LTS based systems * Enabled Session (video) Recording using Jibri * Enabled Jitsi Electron app detection server side. * Standalone SSL Certbot/LE implementation -* Option to enable Local audio recording using flac. -* Option to enable Secure Rooms -* Option to enable Welcome Page -* Option to setup UI language * Jigasi Transcript - Speech to Text powered by Google API * (New) JRA (Jibri Recordings Access) via Nextcloud * (New) Customized brandless mode @@ -24,15 +21,26 @@ Bash installer for Jibri on *buntu LTS based systems ### Jigasi Transcript * SIP account * Google Cloud Account with Billing setup. + ### Jibri Recodings Access via Nextcloud * Valid domain with DNS record for Nextcloud SSL. +## Optional custom changes +* Optional default language +* Option to enable Secure Rooms +* Option to enable Welcome Page +* Option to enable Local audio recording using flac. +* Option to use Rodentia static avatar (icon credit: sixsixfive). + ## Custom changes * Start with video muted by default * Start with audio muted but moderator -* Rodentia static avatar (icon credit: sixsixfive) + * Set displayname as not required since jibri can't set it up. +## Documentation +* Please check our wiki for further documentation. + Please note: This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY. SwITNet Ltd © - 2020, https://switnet.net/