Update README.md

This commit is contained in:
Luis Guzman 2020-04-13 22:22:00 -05:00 committed by GitHub
parent 9e30423980
commit 5bb25d3088
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 6 deletions

View File

@ -3,7 +3,8 @@ Bash installer for Jibri on *buntu LTS based systems
## Requirements ## Requirements
* Clean VM/VPS/Server using Ubuntu LTS * 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. * Minimum recommended for video recording: 8 GB RAM / 2 Cores.
* Dropbox developer App key & redirect url configured (if you choose to enable Dropbox upload). * Dropbox developer App key & redirect url configured (if you choose to enable Dropbox upload).
* Webcam * Webcam
@ -12,10 +13,6 @@ Bash installer for Jibri on *buntu LTS based systems
* Enabled Session (video) Recording using Jibri * Enabled Session (video) Recording using Jibri
* Enabled Jitsi Electron app detection server side. * Enabled Jitsi Electron app detection server side.
* Standalone SSL Certbot/LE implementation * 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 * Jigasi Transcript - Speech to Text powered by Google API
* (New) JRA (Jibri Recordings Access) via Nextcloud * (New) JRA (Jibri Recordings Access) via Nextcloud
* (New) Customized brandless mode * (New) Customized brandless mode
@ -24,15 +21,26 @@ Bash installer for Jibri on *buntu LTS based systems
### Jigasi Transcript ### Jigasi Transcript
* SIP account * SIP account
* Google Cloud Account with Billing setup. * Google Cloud Account with Billing setup.
### Jibri Recodings Access via Nextcloud ### Jibri Recodings Access via Nextcloud
* Valid domain with DNS record for Nextcloud SSL. * 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 ## Custom changes
* Start with video muted by default * Start with video muted by default
* Start with audio muted but moderator * Start with audio muted but moderator
* Rodentia static avatar (icon credit: sixsixfive)
* Set displayname as not required since jibri can't set it up. * 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. Please note: This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY.
SwITNet Ltd © - 2020, https://switnet.net/ SwITNet Ltd © - 2020, https://switnet.net/