Merge pull request #16 from switnet-ltd/unstable

4.0 release merge
Mayor update allowing a jibri install along with sync among a jibri nodes network.

README.md

@@ -1,49 +1,75 @@
 # Quick Jibri Installer
-Bash installer for Jibri on **\*buntu LTS** based systems using **nginx** as default webserver.
+Bash installer for Jibri on **Ubuntu LTS** based systems using **nginx** as default webserver.
 
 ## Usage
+As for our current latest release, as we have integrated more and more features, we highly recommend to use a purpose specific-newly spawn server to host the jitsi-meet framework, making sure you stick to the requirements and recommendations as much as possible, in order to avoid issues.
+
+
+### Main Server
+Login into your clean server, clone git repository and run the installer,
 
 ```
 git clone https://github.com/switnet-ltd/quick-jibri-installer
 cd quick-jibri-installer
 bash quick-jibri-installer.sh
 ```
-Please check more details on our wiki.
+
+### Add Jibri node
+
+Copy the modified `add-jibri-node.sh` file from your early cloned installation directory once it's completed to the new server meant to be a jibri node using your preferred method, then run it
+
+**WARNING:** This file contains sensitive information from your setup, please handle with care.
+
+```
+bash add-jibri-node.sh
+```
+
+
+Check more details on our wiki.
 
 ## Requirements
 * Clean VM/VPS/Server using Ubuntu LTS
 * 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 / 4 Cores.
+* Highly recommended: 8 GB RAM / 4 Cores.
 * Webcam
 
 ### Jigasi Transcript
 * SIP account
 * Google Cloud Account with Billing setup.
+
 ### Jibri Recodings Access via Nextcloud
 * Valid domain with DNS record for Nextcloud SSL.
 
+## Kernel warning
+For AWS users or any cloud service provider that might use their own kernel on their products (servers/vm/vps), might cause Jibri failure to start due not allowing `snd_aloop` module.
+
+Make sure that you update your grub to boot the right one.
+
+Feel free to use our (new) `test-jibri-env.sh` tool to find some details on your current setup.
 
 ## Features
-* Enabled Session (video) Recording using Jibri
+* Enabled Session Recording using Jibri
 * Enabled Jitsi Electron app detection server side.
 * Standalone SSL Certbot/LE implementation
 * Jigasi Transcript - Speech to Text powered by Google API
 * JRA (Jibri Recordings Access) via Nextcloud
 * Improved recurring updater
 * Customized brandless mode
-  * (New) Setting up custom interface_config.js
-* (New) Grafana Dashboard
-* (New) Lobby Rooms - Secure Rooms
-* (New) Conference Duration - Secure Rooms
+  * Setting up custom interface_config.js
+* Grafana Dashboard
+* Lobby Rooms - Secure Rooms
+* Conference Duration - Secure Rooms
+* (New) Automatic Jibri nodes network sync ([see more](https://github.com/switnet-ltd/quick-jibri-installer/wiki/Jibri-Nodes)).
 
+## Tools (New)
+* (New) Jibri Environment Tester
+ * (New) Jibri Conf Upgrader (late 2020).
 
 ## 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) - Legacy
 
 ## Custom changes
 * Start with video muted by default