Merge pull request 'README.md: update Jigasi mention now using Vosk.' (#117 ) from Ark74/quick-jibri-installer:upd_readme_jigasi into master

Reviewed-on: switnet/quick-jibri-installer#117
README.md: update Jigasi mention now using Vosk.
2024-08-30 01:10:31 +00:00 · 2024-08-29 19:09:35 -06:00 · 2024-08-30 00:51:27 +00:00 · 2024-08-29 23:48:16 +00:00 · 2024-08-29 04:45:19 +00:00 · 2024-08-28 23:05:36 +00:00
9 changed files with 525 additions and 190 deletions
--- a/README.md
+++ b/README.md
@ -56,9 +56,8 @@ Check more details on our wiki.
 ### Jibri Recodings Access via Nextcloud
 * Valid domain with DNS record for Nextcloud SSL.
 
-### Jigasi Transcript (stalled)
-* SIP account
-* Google Cloud Account with Billing setup.
+### Jigasi Transcript
+* Enough disk space to run Vosk backend via docker container.



@ -79,7 +78,7 @@ Feel free to use our `test-jibri-env.sh` tool to find some details on your curre
 * Etherpad via docker install
 * Authentication
  1. Local
-  2. JWT
+  2. JWT ([#87](https://forge.switnet.net/switnet/quick-jibri-installer/issues/87))
  3. None
 * Lobby Rooms
 * Conference Duration
@ -90,7 +89,7 @@ Feel free to use our `test-jibri-env.sh` tool to find some details on your curre
 * Enabled Jitsi Electron app detection server side.
 * Standalone SSL Certbot/LE implementation
 * Improved recurring updater
-* Jigasi Transcript - Speech to Text powered by Google API (stalled)
+* Jigasi Transcript - vía Vosk speech recognition toolkit.

 ## Tools
 * Jibri Environment Tester
--- a/etherpad-docker.sh
+++ b/etherpad-docker.sh
@ -66,7 +66,8 @@ echo "Add Docker repo"
 if [ "$DOCKER_CE_REPO" = "stable" ]; then
    echo "Docker repository already installed"
 else
-    echo "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" > /etc/apt/sources.list.d/docker-ce.list
+    echo "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" > \
+        /etc/apt/sources.list.d/docker-ce.list
    wget -qO - https://download.docker.com/linux/ubuntu/gpg | \
    gpg --dearmor | tee /etc/apt/trusted.gpg.d/docker-gpg-key.gpg  >/dev/null
    apt -q2 update
@ -74,6 +75,9 @@ fi

 read -p "Set your etherpad docker admin password: " -r ETHERPAD_ADMIN_PASS

+# Make sure we can rely on the match strings.
+printf "> Testing match strings on config files.\n"
+test_match "$WS_MATCH1" "$WS_CONF"

 # Install required packages
 install_ifnot docker-ce
@ -118,10 +122,14 @@ elif [ -f "$WS_CONF" ]; then
    echo "> Setting up webserver configuration file..."
    sed -i "/$WS_CONF_MATCH1/i \ \ \ \ #Etherpad block" "$WS_CONF"
    sed -i "/$WS_CONF_MATCH1/i \ \ \ \ location \^\~\ \/etherpad\/ {" "$WS_CONF"
-    sed -i "/$WS_CONF_MATCH1/i \ \ \ \ \ \ \ \ proxy_pass http:\/\/localhost:9001\/;" "$WS_CONF"
+    sed -i "/$WS_CONF_MATCH1/i \ \ \ \ \ \ \ \ proxy_http_version 1.1;" "$WS_CONF"
+    sed -i "/$WS_CONF_MATCH1/i \ \ \ \ \ \ \ \ proxy_set_header Upgrade \$http_upgrade;" "$WS_CONF"
+    sed -i "/$WS_CONF_MATCH1/i \ \ \ \ \ \ \ \ proxy_set_header Connection \$connection_upgrade;" "$WS_CONF"
    sed -i "/$WS_CONF_MATCH1/i \ \ \ \ \ \ \ \ proxy_set_header X-Forwarded-For \$remote_addr;" "$WS_CONF"
    sed -i "/$WS_CONF_MATCH1/i \ \ \ \ \ \ \ \ proxy_buffering off;" "$WS_CONF"
+    sed -i "/$WS_CONF_MATCH1/i \ \ \ \ \ \ \ \ proxy_redirect off;" "$WS_CONF"
    sed -i "/$WS_CONF_MATCH1/i \ \ \ \ \ \ \ \ proxy_set_header       Host \$host;" "$WS_CONF"
+    sed -i "/$WS_CONF_MATCH1/i \ \ \ \ \ \ \ \ proxy_pass http:\/\/localhost:9001\/;" "$WS_CONF"
    sed -i "/$WS_CONF_MATCH1/i \ \ \ \ }" "$WS_CONF"
    sed -i "/$WS_CONF_MATCH1/i \\\n" "$WS_CONF"
 else
@ -134,7 +142,7 @@ if [ "$(grep -c "etherpad_base" "$WS_CONF")" != 0 ]; then
    echo -e "> $MEET_CONF seems configured, skipping...\n"
 else
    echo -e "> Setting etherpad domain at $MEET_CONF...\n"
-    sed -i "/ openSharedDocumentOnJoin:/a\ \ \ \ etherpad_base: \'https://$DOMAIN/etherpad/p/\'," "$MEET_CONF"
+    sed -i "s|// etherpad_base: .*|etherpad_base: \'https://$DOMAIN/etherpad/p/\',|" "$MEET_CONF"
 fi

 echo "> Checking nginx configuration..."
--- a/files/jibri.conf
+++ b/files/jibri.conf
@ -0,0 +1,109 @@
+// XMPP environment config.
+jibri {
+    streaming {
+        // A list of regex patterns for allowed RTMP URLs.  The RTMP URL used
+        // when starting a stream must match at least one of the patterns in
+        // this list.
+        rtmp-allow-list = [
+          // By default, all services are allowed
+          ".*"
+        ]
+    }
+    ffmpeg {
+        resolution = JIBRI_RES_CONF
+    }
+    chrome {
+        // The flags which will be passed to chromium when launching
+        flags = [
+          "--use-fake-ui-for-media-stream",
+          "--start-maximized",
+          "--kiosk",
+          "--enabled",
+          "--disable-infobars",
+          "--autoplay-policy=no-user-gesture-required",
+          "--ignore-certificate-errors",
+          "--disable-dev-shm-usage"
+        ]
+    }
+    stats {
+        enable-stats-d = true
+    }
+    call-status-checks {
+        // If all clients have their audio and video muted and if Jibri does not
+        // detect any data stream (audio or video) comming in, it will stop
+        // recording after NO_MEDIA_TIMEOUT expires.
+        no-media-timeout = 30 seconds
+
+        // If all clients have their audio and video muted, Jibri consideres this
+        // as an empty call and stops the recording after ALL_MUTED_TIMEOUT expires.
+        all-muted-timeout = 10 minutes
+
+        // When detecting if a call is empty, Jibri takes into consideration for how
+        // long the call has been empty already. If it has been empty for more than
+        // DEFAULT_CALL_EMPTY_TIMEOUT, it will consider it empty and stop the recording.
+        default-call-empty-timeout = 30 seconds
+    }
+    recording {
+         recordings-directory = "DIR_RECORD"
+         finalize-script = "REC_DIR"
+    }
+    api {
+        xmpp {
+            environments = [
+                {
+                // A user-friendly name for this environment
+                name = "JB_NAME"
+
+                // A list of XMPP server hosts to which we'll connect
+                xmpp-server-hosts = [ "DOMAIN" ]
+
+                // The base XMPP domain
+                xmpp-domain = "DOMAIN"
+
+                // The MUC we'll join to announce our presence for
+                // recording and streaming services
+                control-muc {
+                    domain = "internal.auth.DOMAIN"
+                    room-name = "JibriBrewery"
+                    nickname = "Live"
+                }
+
+                // The login information for the control MUC
+                control-login {
+                    domain = "auth.DOMAIN"
+                    username = "jibri"
+                    password = "JB_AUTH_PASS"
+                }
+
+                // An (optional) MUC configuration where we'll
+                // join to announce SIP gateway services
+            //    sip-control-muc {
+            //        domain = "domain"
+            //        room-name = "room-name"
+            //        nickname = "nickname"
+            //    }
+
+                // The login information the selenium web client will use
+                call-login {
+                    domain = "recorder.DOMAIN"
+                    username = "recorder"
+                    password = "JB_REC_PASS"
+                }
+
+                // The value we'll strip from the room JID domain to derive
+                // the call URL
+                strip-from-room-domain = "conference."
+
+                // How long Jibri sessions will be allowed to last before
+                // they are stopped.  A value of 0 allows them to go on
+                // indefinitely
+                usage-timeout = 0 hour
+
+                // Whether or not we'll automatically trust any cert on
+                // this XMPP domain
+                trust-all-xmpp-certs = true
+                }
+            ]
+        }
+    }
+}
--- a/jigasi-vosk-backend.sh
+++ b/jigasi-vosk-backend.sh
@ -0,0 +1,128 @@
+#!/bin/bash
+# Quick Jigasi Installer with VOSK backend - *buntu (LTS) based systems.
+# SwITNet Ltd © - 2024, https://switnet.net/
+# GPLv3 or later.
+
+#Check if user is root
+if ! [ "$(id -u)" = 0 ]; then
+   echo "You need to be root or have sudo privileges!"
+   exit 0
+fi
+exit_if_not_installed() {
+if [ "$(dpkg-query -W -f='${Status}' "$1" 2>/dev/null | grep -c "ok installed")" != "1" ]; then
+    echo " This instance doesn't have $1 installed, exiting..."
+    echo " If you think this is an error, please report to:
+    -> https://forge.switnet.net/switnet/quick-jibri-installer/issues "
+    exit
+fi
+}
+
+clear
+echo ''
+echo '########################################################################'
+echo '                       Jigasi Transcript addon'
+echo '########################################################################'
+echo '                    by Software, IT & Networks Ltd'
+echo ''
+
+exit_if_not_installed jitsi-meet
+
+DOMAIN="$(find /etc/prosody/conf.d/ -name \*.lua|awk -F'.cfg' '!/localhost/{print $1}'|xargs basename)"
+JIG_TRANSC_PASWD="$(tr -dc "a-zA-Z0-9#*=" < /dev/urandom | fold -w 16 | head -n1)"
+JIG_SIP_PROP="/etc/jitsi/jigasi/sip-communicator.properties"
+export DOMAIN
+export JIG_TRANSC_PASWD
+
+apt-get -q2 update
+
+# Disable SIP account prompt by default
+echo "jigasi	jigasi/sip-account	string	''" | debconf-set-selections
+echo "jigasi	jigasi/sip-password	password	''" | debconf-set-selections
+
+echo "Installing Jigasi, SIP configuration disabled by default."
+apt-get -y install gettext-base jigasi docker.io
+
+echo "Please select a language for the VOSK transcription model:"
+echo "1) Chinese"
+echo "2) English"
+echo "3) French"
+echo "4) German"
+echo "5) Hindi"
+echo "6) Japanese"
+echo "7) Russian"
+echo "8) Spanish"
+
+read -p "Enter the number corresponding to your language choice: " -r lang_choice
+
+case $lang_choice in
+    1)
+        echo "You selected Chinese."
+        VOSK_DOCKER_MODEL="alphacep/kaldi-cn"
+        ;;
+    2)
+        echo "You selected English."
+        VOSK_DOCKER_MODEL="alphacep/kaldi-en"
+        ;;
+    3)
+        echo "You selected French."
+        VOSK_DOCKER_MODEL="alphacep/kaldi-fr"
+        ;;
+    4)
+        echo "You selected German."
+        VOSK_DOCKER_MODEL="alphacep/kaldi-de"
+        ;;
+    5)
+        echo "You selected Hindi."
+        VOSK_DOCKER_MODEL="alphacep/kaldi-hi"
+        ;;
+    6)
+        echo "You selected Japanese."
+        VOSK_DOCKER_MODEL="alphacep/kaldi-ja"
+        ;;
+    7)
+        echo "You selected Russian."
+        VOSK_DOCKER_MODEL="alphacep/kaldi-ru"
+        ;;
+    8)
+        echo "You selected Spanish."
+        VOSK_DOCKER_MODEL="alphacep/kaldi-es"
+        ;;
+    *)
+        echo "Invalid selection. Please choose a number between 1 and 8."
+        ;;
+esac
+
+# Running selected VOSK docker model.
+docker run -d --restart always -p 2700:2700 ${VOSK_DOCKER_MODEL}:latest
+
+echo "Setting up Jigasi transcript with current platform..."
+
+# Jitsi Meet
+echo "> Patching Jitsi Meet's config.js for Transcription support."
+echo "  Read more at patches/jigasi/001-jigasi-meet-config.patch file"
+envsubst < patches/jigasi/001-jigasi-meet-config.patch | \
+  patch --no-backup-if-mismatch -d / -p1
+
+# Jigasi
+echo "> Patching jigasi's sip-communicator.properties configuration."
+echo "  Read more at patches/jigasi/002-jigasi-sip-properties.patch file"
+cp "$JIG_SIP_PROP" ${JIG_SIP_PROP}-dpkg-file
+envsubst < patches/jigasi/002-jigasi-sip-properties.patch | \
+  patch --no-backup-if-mismatch -d / -p1
+
+# Create transcribe user on hidden domain.
+prosodyctl register transcriber recorder."$DOMAIN" "$JIG_TRANSC_PASWD"
+
+# Restart services.
+systemctl restart prosody \
+                  jicofo \
+                  jigasi \
+                  jibri* \
+                  jitsi-videobridge2
+
+echo ""
+echo "Full transcript files are available at:"
+echo "--> /var/lib/jigasi/transcripts/"
+echo ""
+echo "Happy transcripting!"
+echo ""
--- a/patches/jigasi/001-jigasi-meet-config.patch
+++ b/patches/jigasi/001-jigasi-meet-config.patch
@ -0,0 +1,40 @@
+# Quick Jigasi Installer with VOSK backend - *buntu (LTS) based systems.
+# SwITNet Ltd © - 2024, https://switnet.net/
+# GPLv3 or later.
+
+Enable transcription on jitsi meet config.js file.
+
+diff --git a/etc/jitsi/meet/${DOMAIN}-config.js b/etc/jitsi/meet/${DOMAIN}-config.js
+index f412891..f704157 100644
+--- a/etc/jitsi/meet/${DOMAIN}-config.js
+++ b/etc/jitsi/meet/${DOMAIN}-config.js
+@@ -426,9 +426,9 @@ var config = {
+     // autoCaptionOnRecord: false,
+ 
+     // Transcription options.
+-    // transcription: {
+    transcription: {
+     //     // Whether the feature should be enabled or not.
+-    //     enabled: false,
+        enabled: true,
+ 
+     //     // Translation languages.
+     //     // Available languages can be found in
+@@ -443,7 +443,7 @@ var config = {
+     //     // detected based on the environment, e.g. if the app is opened in a chrome instance which
+     //     // is using french as its default language then transcriptions for that participant will be in french.
+     //     // Defaults to true.
+-    //     useAppLanguage: true,
+        useAppLanguage: true,
+ 
+     //     // Transcriber language. This settings will only work if "useAppLanguage"
+     //     // is explicitly set to false.
+@@ -453,7 +453,7 @@ var config = {
+ 
+     //     // Enables automatic turning on transcribing when recording is started
+     //     autoTranscribeOnRecord: false,
+-    // },
+    },
+ 
+     // Misc
+ 
--- a/patches/jigasi/002-jigasi-sip-properties.patch
+++ b/patches/jigasi/002-jigasi-sip-properties.patch
@ -0,0 +1,80 @@
+# Quick Jigasi Installer with VOSK backend - *buntu (LTS) based systems.
+# SwITNet Ltd © - 2024, https://switnet.net/
+# GPLv3 or later.
+
+Modify sip-communicator.properties to run Jigasi along with VOSK Models.
+
+diff --git a/etc/jitsi/jigasi/sip-communicator.properties b/etc/jitsi/jigasi/sip-communicator.properties
+index 7a8d0f3..ae5369a 100644
+--- a/etc/jitsi/jigasi/sip-communicator.properties
+++ b/etc/jitsi/jigasi/sip-communicator.properties
+@@ -165,12 +165,12 @@ org.jitsi.jigasi.xmpp.acc.USE_DEFAULT_STUN_SERVER=false
+ 
+ # If you want jigasi to perform authenticated login instead of anonymous login
+ # to the XMPP server, you can set the following properties.
+-# org.jitsi.jigasi.xmpp.acc.USER_ID=SOME_USER@SOME_DOMAIN
+-# org.jitsi.jigasi.xmpp.acc.PASS=SOME_PASS
+-# org.jitsi.jigasi.xmpp.acc.ANONYMOUS_AUTH=false
+org.jitsi.jigasi.xmpp.acc.USER_ID=transcriber@recorder.${DOMAIN}
+org.jitsi.jigasi.xmpp.acc.PASS=${JIG_TRANSC_PASWD}
+org.jitsi.jigasi.xmpp.acc.ANONYMOUS_AUTH=false
+ 
+ # To fix SSL/TLS required by client but not supported by server
+-#org.jitsi.jigasi.xmpp.acc.ALLOW_NON_SECURE=true
+org.jitsi.jigasi.xmpp.acc.ALLOW_NON_SECURE=true
+ 
+ # Can be used in combination with jitsi-meet module mod_auth_jitsi-shared-secret
+ # To have jigasi use a random username on every call
+@@ -187,7 +187,7 @@ org.jitsi.jigasi.xmpp.acc.USE_DEFAULT_STUN_SERVER=false
+ # Activate this property if you are using self-signed certificates or other
+ # type of non-trusted certicates. In this mode your service trust in the
+ # remote certificates always.
+-# net.java.sip.communicator.service.gui.ALWAYS_TRUST_MODE_ENABLED=true
+net.java.sip.communicator.service.gui.ALWAYS_TRUST_MODE_ENABLED=true
+ 
+ # Enable this property to be able to shutdown gracefully jigasi using
+ # a rest command
+@@ -196,31 +196,31 @@ org.jitsi.jigasi.xmpp.acc.USE_DEFAULT_STUN_SERVER=false
+ # Options regarding Transcription. Read the README for a detailed description
+ # about each property
+ 
+-#org.jitsi.jigasi.ENABLE_TRANSCRIPTION=false
+-#org.jitsi.jigasi.ENABLE_SIP=true
+org.jitsi.jigasi.ENABLE_TRANSCRIPTION=true
+org.jitsi.jigasi.ENABLE_SIP=false
+ 
+ # whether to use the more expensive, but better performing
+ # "video" model when doing transcription
+ # org.jitsi.jigasi.transcription.USE_VIDEO_MODEL = false
+ 
+ # delivering final transcript
+-# org.jitsi.jigasi.transcription.DIRECTORY=/var/lib/jigasi/transcripts
+-# org.jitsi.jigasi.transcription.BASE_URL=http://localhost/
+-# org.jitsi.jigasi.transcription.jetty.port=-1
+-# org.jitsi.jigasi.transcription.ADVERTISE_URL=false
+org.jitsi.jigasi.transcription.DIRECTORY=/var/lib/jigasi/transcripts
+org.jitsi.jigasi.transcription.BASE_URL=http://localhost/
+org.jitsi.jigasi.transcription.jetty.port=-1
+org.jitsi.jigasi.transcription.ADVERTISE_URL=false
+ 
+ # save formats
+-# org.jitsi.jigasi.transcription.SAVE_JSON=false
+-# org.jitsi.jigasi.transcription.SAVE_TXT=true
+org.jitsi.jigasi.transcription.SAVE_JSON=false
+org.jitsi.jigasi.transcription.SAVE_TXT=true
+ 
+ # send formats
+-# org.jitsi.jigasi.transcription.SEND_JSON=true
+-# org.jitsi.jigasi.transcription.SEND_TXT=false
+org.jitsi.jigasi.transcription.SEND_JSON=true
+org.jitsi.jigasi.transcription.SEND_TXT=false
+ 
+ # Vosk server
+-# org.jitsi.jigasi.transcription.customService=org.jitsi.jigasi.transcription.VoskTranscriptionService
+org.jitsi.jigasi.transcription.customService=org.jitsi.jigasi.transcription.VoskTranscriptionService
+ # org.jitsi.jigasi.transcription.vosk.websocket_url={"en": "ws://localhost:2700", "fr": "ws://localhost:2710"}
+-# org.jitsi.jigasi.transcription.vosk.websocket_url=ws://localhost:2700
+org.jitsi.jigasi.transcription.vosk.websocket_url=ws://localhost:2700
+ 
+ # Whisper live transcription server
+ # org.jitsi.jigasi.transcription.customService=org.jitsi.jigasi.transcription.WhisperTranscriptionService
--- a/patches/jitsi-meet/001-jitsi-meet-enable-livestreaming-and-recording.patch
+++ b/patches/jitsi-meet/001-jitsi-meet-enable-livestreaming-and-recording.patch
@ -0,0 +1,66 @@
+# Quick Jibri Installer - *buntu (LTS) based systems.
+# SwITNet Ltd © - 2024, https://switnet.net/
+# GPLv3 or later.
+
+Patch jitsi-meet config.js to enable recording and livestreaming by default.
+
+diff --git a/etc/jitsi/meet/${DOMAIN}-config.js b/etc/jitsi/meet/${DOMAIN}-config.js
+index dcb860b..8f64c7c 100644
+--- a/etc/jitsi/meet/${DOMAIN}-config.js
+++ b/etc/jitsi/meet/${DOMAIN}-config.js
+@@ -343,12 +343,12 @@ var config = {
+     //    // showPrejoinWarning: true,
+     // },
+ 
+-    // recordingService: {
+    recordingService: {
+     //     // When integrations like dropbox are enabled only that will be shown,
+     //     // by enabling fileRecordingsServiceEnabled, we show both the integrations
+     //     // and the generic recording service (its configuration and storage type
+     //     // depends on jibri configuration)
+-    //     enabled: false,
+        enabled: true,
+ 
+     //     // Whether to show the possibility to share file recording with other people
+     //     // (e.g. meeting participants), based on the actual implementation
+@@ -357,7 +357,7 @@ var config = {
+ 
+     //     // Hide the warning that says we only store the recording for 24 hours.
+     //     hideStorageWarning: false,
+-    // },
+    },
+ 
+     // DEPRECATED. Use recordingService.enabled instead.
+     // fileRecordingsServiceEnabled: false,
+@@ -368,7 +368,7 @@ var config = {
+     // Local recording configuration.
+     // localRecording: {
+     //     // Whether to disable local recording or not.
+-    //     disable: false,
+    //     disable: true,
+ 
+     //     // Whether to notify all participants when a participant is recording locally.
+     //     notifyAllParticipants: false,
+@@ -378,9 +378,9 @@ var config = {
+     // },
+ 
+     // Customize the Live Streaming dialog. Can be modified for a non-YouTube provider.
+-    // liveStreaming: {
+    liveStreaming: {
+     //    // Whether to enable live streaming or not.
+-    //    enabled: false,
+       enabled: true,
+     //    // Terms link
+     //    termsLink: 'https://www.youtube.com/t/terms',
+     //    // Data privacy link
+@@ -388,8 +388,8 @@ var config = {
+     //    // RegExp string that validates the stream key input field
+     //    validatorRegExpString: '^(?:[a-zA-Z0-9]{4}(?:-(?!$)|$)){4}',
+     //    // Documentation reference for the live streaming feature.
+-    //    helpLink: 'https://jitsi.org/live'
+-    // },
+       helpLink: 'https://forge.switnet.net/switnet/quick-jibri-installer'
+    },
+ 
+     // DEPRECATED. Use liveStreaming.enabled instead.
+     // liveStreamingEnabled: false,
--- a/patches/jitsi-meet/002-jitsi-meet-welcome-page-on-off.patch
+++ b/patches/jitsi-meet/002-jitsi-meet-welcome-page-on-off.patch
@ -0,0 +1,31 @@
+# Quick Jibri Installer - *buntu (LTS) based systems.
+# SwITNet Ltd © - 2024, https://switnet.net/
+# GPLv3 or later.
+
+Patch jitsi-meet config.js to enable/disable welcome page.
+
+diff --git a/etc/jitsi/meet/${DOMAIN}-config.js b/etc/jitsi/meet/${DOMAIN}-config.js
+index dcb860b..2094287 100644
+--- a/etc/jitsi/meet/${DOMAIN}-config.js
+++ b/etc/jitsi/meet/${DOMAIN}-config.js
+@@ -664,13 +664,13 @@ var config = {
+     // enableWelcomePage: true,
+ 
+     // Configs for welcome page.
+-    // welcomePage: {
+-    //     // Whether to disable welcome page. In case it's disabled a random room
+-    //     // will be joined when no room is specified.
+-    //     disabled: false,
+-    //     // If set, landing page will redirect to this URL.
+-    //     customUrl: ''
+-    // },
+    welcomePage: {
+        // Whether to disable welcome page. In case it's disabled a random room
+        // will be joined when no room is specified.
+        disabled: ${ENABLE_WELCP_BOL},
+        // If set, landing page will redirect to this URL.
+        customUrl: ''
+    },
+ 
+     // Configs for the lobby screen.
+     // lobby: {
--- a/quick_jibri_installer.sh
+++ b/quick_jibri_installer.sh
@ -538,19 +538,20 @@ JB_NAME="Jibri Sessions"
 LE_RENEW_LOG="/var/log/letsencrypt/renew.log"
 MOD_LISTU="https://prosody.im/files/mod_listusers.lua"
 MOD_LIST_FILE="/usr/lib/prosody/modules/mod_listusers.lua"
-ENABLE_SA="yes"
 MJS_RAND_TAIL="$(tr -dc "a-zA-Z0-9" < /dev/urandom | fold -w 4 | head -n1)"
 MJS_USER="jbsync_$MJS_RAND_TAIL"
 MJS_USER_PASS="$(tr -dc "a-zA-Z0-9#_*=" < /dev/urandom | fold -w 32 | head -n1)"
 FQDN_HOST="fqdn"
 JIBRI_XORG_CONF="/etc/jitsi/jibri/xorg-video-dummy.conf"
 WS_MATCH1="# ensure all static content can always be found first"
+WS_MATCH2="external_api.js"
 MEET_MATCH1="disable simulcast support."
-#GC_SDK_REL_FILE="http://packages.cloud.google.com/apt/dists/cloud-sdk-$(lsb_release -sc)/Release"
+export DOMAIN

 # Make sure we can rely on the match strings.
 printf "> Testing match strings on config files.\n"
 test_match "$WS_MATCH1" "$WS_CONF"
+test_match "$WS_MATCH2" "$WS_CONF"
 test_match "$MEET_MATCH1" "$MEET_CONF"

 # Rename hostname for jitsi server
@ -699,24 +700,16 @@ do
 done
 sleep .1
 ##Jigasi
-#if [ "$(curl -s -o /dev/null -w "%{http_code}" "$GC_SDK_REL_FILE" )" == "404" ]; then
-    #printf "> Sorry Google SDK doesn't have support yet for %s,
-    #thus, Jigasi Transcript can't be enable.\n\n" "$(lsb_release -sd)"
-#elif [ "$(curl -s -o /dev/null -w "%{http_code}" "$GC_SDK_REL_FILE" )" == "200" ]; then
-    #while [ "$ENABLE_TRANSCRIPT" != "yes" ] && [ "$ENABLE_TRANSCRIPT" != "no" ]
-    #do
-        #read -p "> Do you want to setup Jigasi Transcription: (yes or no)
+while [ "$ENABLE_TRANSCRIPT" != "yes" ] && [ "$ENABLE_TRANSCRIPT" != "no" ]
+do
+    read -p "> Do you want to setup Jigasi Transcription: (yes or no)
 #( Please check requirements at: https://forge.switnet.net/switnet/quick-jibri-installer )$NL" -r ENABLE_TRANSCRIPT
-        #if [ "$ENABLE_TRANSCRIPT" = "no" ]; then
-            #printf " - Jigasi Transcription won't be enabled.\n\n"
-        #elif [ "$ENABLE_TRANSCRIPT" = "yes" ]; then
-            #printf " - Jigasi Transcription will be enabled.\n\n"
-        #fi
-    #done
-#else
-    #echo "No valid option for Jigasi. Please report this to
-#https://forge.switnet.net/switnet/quick-jibri-installer/issues"
-#fi
+    if [ "$ENABLE_TRANSCRIPT" = "no" ]; then
+        printf " - Jigasi Transcription won't be enabled.\n\n"
+    elif [ "$ENABLE_TRANSCRIPT" = "yes" ]; then
+        printf " - Jigasi Transcription will be enabled.\n\n"
+    fi
+done
 sleep .1
 #Grafana
 while [ "$ENABLE_GRAFANA_DSH" != "yes" ] && [ "$ENABLE_GRAFANA_DSH" != "no" ]
@ -860,22 +853,17 @@ BREWERY

 # Jibri tweaks for /etc/jitsi/meet/$DOMAIN-config.js
 sed -i "s|conference.$DOMAIN|internal.auth.$DOMAIN|" "$MEET_CONF"
-#New recording implementation.
-sed -i "s|// recordingService:|recordingService:|" "$MEET_CONF"
-sed -i "/recordingService/,/hideStorageWarning/s|//     enabled: false,|       enabled: true,|" "$MEET_CONF"
-sed -i "/hideStorageWarning: false/,/Local recording configuration/s|// },|},|" "$MEET_CONF"
+
+#Enable recording & livestreaming by default.
+echo "> Patching config.js to enable recording and livestreaming by default..."
+echo "  Read more about patches at the patches folder."
+envsubst < \
+  patches/jitsi-meet/001-jitsi-meet-enable-livestreaming-and-recording.patch | \
+  patch --no-backup-if-mismatch -d / -p1
+
+#Prepare hidden domain for jibri/jigasi silent users.
 sed -i "/fileRecordingsServiceEnabled: false,/a \\
    hiddenDomain: \'recorder.$DOMAIN\'," "$MEET_CONF"
-
-##Setup main language
-#if [ -z "$JB_LANG" ] || [ "$JB_LANG" = "en" ]; then
-    #echo "Leaving English (en) as default language..."
-    #sed -i "s|// defaultLanguage: 'en',|defaultLanguage: 'en',|" "$MEET_CONF"
-#else
-    #echo "Changing default language to: $JB_LANG"
-    #sed -i "s|// defaultLanguage: 'en',|defaultLanguage: \'$JB_LANG\',|" "$MEET_CONF"
-#fi
-
 # Recording directory
 if [ ! -d "$DIR_RECORD" ]; then
    mkdir "$DIR_RECORD"
@ -894,8 +882,8 @@ echo "or storage provider, etc.) in this script" >> /tmp/finalize.out

 chmod -R 770 \$RECORDINGS_DIR

-LJF_PATH="\$(find \$RECORDINGS_DIR -exec stat --printf="%Y\t%n\n" {} \; | sort -n -r|awk '{print\$2}'| grep -v "meta\|-" | head -n1)"
-NJF_NAME="\$(find \$LJF_PATH |grep -e "-"|sed "s|\$LJF_PATH/||"|cut -d "." -f1)"
+LJF_PATH="\$(find \$RECORDINGS_DIR -exec stat --printf="%Y\t%n\n" {} \; | sort -nr|sed 1d|awk '{print\$2}'| grep -v "meta\|_" | head -n1)"
+NJF_NAME="\$(find \$LJF_PATH |grep "mp4"|sed "s|\$LJF_PATH/||"|cut -d "." -f1)"
 NJF_PATH="\$RECORDINGS_DIR/\$NJF_NAME"
 mv \$LJF_PATH \$NJF_PATH

@ -906,117 +894,15 @@ chmod +x "$REC_DIR"

 ## New Jibri Config (2020)
 mv "$JIBRI_CONF" ${JIBRI_CONF}-dpkg-file
-cat << NEW_CONF > "$JIBRI_CONF"
-// New XMPP environment config.
-jibri {
-    streaming {
-        // A list of regex patterns for allowed RTMP URLs.  The RTMP URL used
-        // when starting a stream must match at least one of the patterns in
-        // this list.
-        rtmp-allow-list = [
-          // By default, all services are allowed
-          ".*"
-        ]
-    }
-    ffmpeg {
-        resolution = $JIBRI_RES_CONF
-    }
-    chrome {
-        // The flags which will be passed to chromium when launching
-        flags = [
-          "--use-fake-ui-for-media-stream",
-          "--start-maximized",
-          "--kiosk",
-          "--enabled",
-          "--disable-infobars",
-          "--autoplay-policy=no-user-gesture-required",
-          "--ignore-certificate-errors",
-          "--disable-dev-shm-usage"
-        ]
-    }
-    stats {
-        enable-stats-d = true
-    }
-    call-status-checks {
-        // If all clients have their audio and video muted and if Jibri does not
-        // detect any data stream (audio or video) comming in, it will stop
-        // recording after NO_MEDIA_TIMEOUT expires.
-        no-media-timeout = 30 seconds
-
-        // If all clients have their audio and video muted, Jibri consideres this
-        // as an empty call and stops the recording after ALL_MUTED_TIMEOUT expires.
-        all-muted-timeout = 10 minutes
-
-        // When detecting if a call is empty, Jibri takes into consideration for how
-        // long the call has been empty already. If it has been empty for more than
-        // DEFAULT_CALL_EMPTY_TIMEOUT, it will consider it empty and stop the recording.
-        default-call-empty-timeout = 30 seconds
-    }
-    recording {
-         recordings-directory = "$DIR_RECORD"
-         finalize-script = "$REC_DIR"
-    }
-    api {
-        xmpp {
-            environments = [
-                {
-                // A user-friendly name for this environment
-                name = "$JB_NAME"
-
-                // A list of XMPP server hosts to which we'll connect
-                xmpp-server-hosts = [ "$DOMAIN" ]
-
-                // The base XMPP domain
-                xmpp-domain = "$DOMAIN"
-
-                // The MUC we'll join to announce our presence for
-                // recording and streaming services
-                control-muc {
-                    domain = "internal.auth.$DOMAIN"
-                    room-name = "$JibriBrewery"
-                    nickname = "Live"
-                }
-
-                // The login information for the control MUC
-                control-login {
-                    domain = "auth.$DOMAIN"
-                    username = "jibri"
-                    password = "$JB_AUTH_PASS"
-                }
-
-                // An (optional) MUC configuration where we'll
-                // join to announce SIP gateway services
-            //    sip-control-muc {
-            //        domain = "domain"
-            //        room-name = "room-name"
-            //        nickname = "nickname"
-            //    }
-
-                // The login information the selenium web client will use
-                call-login {
-                    domain = "recorder.$DOMAIN"
-                    username = "recorder"
-                    password = "$JB_REC_PASS"
-                }
-
-                // The value we'll strip from the room JID domain to derive
-                // the call URL
-                strip-from-room-domain = "conference."
-
-                // How long Jibri sessions will be allowed to last before
-                // they are stopped.  A value of 0 allows them to go on
-                // indefinitely
-                usage-timeout = 0 hour
-
-                // Whether or not we'll automatically trust any cert on
-                // this XMPP domain
-                trust-all-xmpp-certs = true
-                }
-            ]
-        }
-    }
-}
-NEW_CONF
+cp files/jibri.conf "$JIBRI_CONF"
+sed -i "s|JIBRI_RES_CONF|$JIBRI_RES_CONF|g" "$JIBRI_CONF"
+sed -i "s|DIR_RECORD|$DIR_RECORD|g" "$JIBRI_CONF"
+sed -i "s|REC_DIR|$REC_DIR|g" "$JIBRI_CONF"
+sed -i "s|JB_NAME|$JB_NAME|g" "$JIBRI_CONF"
+sed -i "s|DOMAIN|$DOMAIN|g" "$JIBRI_CONF"
+sed -i "s|JibriBrewery|$JibriBrewery|g" "$JIBRI_CONF"
+sed -i "s|JB_AUTH_PASS|$JB_AUTH_PASS|g" "$JIBRI_CONF"
+sed -i "s|JB_REC_PASS|$JB_REC_PASS|g" "$JIBRI_CONF"

 #Jibri xorg resolution
 sed -i "s|[[:space:]]Virtual .*|Virtual $JIBRI_RES_XORG_CONF|" "$JIBRI_XORG_CONF"
@ -1091,28 +977,6 @@ sed -i "s|MJS_USER=.*|MJS_USER=\"$MJS_USER\"|" add-jvb2-node.sh
 sed -i "s|MJS_USER_PASS=.*|MJS_USER_PASS=\"$MJS_USER_PASS\"|" add-jvb2-node.sh
 ##--

-#Tune webserver for Jitsi App control
-if [ -f "$WS_CONF" ]; then
-    sed -i "/$WS_MATCH1/i \\\n" "$WS_CONF"
-    sed -i "/$WS_MATCH1/i \ \ \ \ location = \/external_api.min.js {" "$WS_CONF"
-    sed -i "/$WS_MATCH1/i \ \ \ \ \ \ \ \ alias \/usr\/share\/jitsi-meet\/libs\/external_api.min.js;" "$WS_CONF"
-    sed -i "/$WS_MATCH1/i \ \ \ \ }" "$WS_CONF"
-    sed -i "/$WS_MATCH1/i \\\n" "$WS_CONF"
-    systemctl reload nginx
-else
-    echo "No app configuration done to server file, please report to:"
-    echo "  -> https://forge.switnet.net/switnet/quick-jibri-installer/issues"
-fi
-#Static avatar
-if [ "$ENABLE_SA" = "yes" ] && [ -f "$WS_CONF" ]; then
-    cp images/avatar2.png /usr/share/jitsi-meet/images/
-    sed -i "/location \/external_api.min.js/i \ \ \ \ location \~ \^\/avatar\/\(.\*\)\\\.png {" "$WS_CONF"
-    sed -i "/location \/external_api.min.js/i \ \ \ \ \ \ \ \ alias /usr/share/jitsi-meet/images/avatar2.png;" "$WS_CONF"
-    sed -i "/location \/external_api.min.js/i \ \ \ \ }\\
-\ " "$WS_CONF"
-    sed -i "/RANDOM_AVATAR_URL_PREFIX/ s|false|\'https://$DOMAIN/avatar/\'|" "$INT_CONF"
-    sed -i "/RANDOM_AVATAR_URL_SUFFIX/ s|false|\'.png\'|" "$INT_CONF"
-fi
 #nginx -tlsv1/1.1
 if [ "$DROP_TLS1" = "yes" ];then
    printf "\nDropping TLSv1/1.1\n\n"
@ -1180,22 +1044,23 @@ fi
 sed -i "s|// startWithVideoMuted: false,|startWithVideoMuted: true,|" "$MEET_CONF"

 #Start with audio muted but admin
-sed -i "s|// startAudioMuted: 10,|startAudioMuted: 1,|" "$MEET_CONF"
+sed -i "s|// startAudioMuted: 10,|startAudioMuted: 2,|" "$MEET_CONF"

 #Disable/enable welcome page
-if [ "$ENABLE_WELCP" = "yes" ]; then
-    sed -i "/ welcomePage: {/,/},/s|// ||" "$MEET_CONF"
-    sed -i "/ welcomePage: {/,/},/s|disabled: .*,|disabled: true,|" "$MEET_CONF"
-elif [ "$ENABLE_WELCP" = "no" ]; then
-    sed -i "/ welcomePage: {/,/},/s|// ||" "$MEET_CONF"
-    sed -i "/ welcomePage: {/,/},/s|disabled: .*,|disabled: false,|" "$MEET_CONF"
-fi
+[ "$ENABLE_WELCP" = "yes" ] && ENABLE_WELCP_BOL=true
+[ "$ENABLE_WELCP" = "no" ] && ENABLE_WELCP_BOL=false
+export ENABLE_WELCP_BOL
+echo "> Patching config.js to modify welcompage behavior..."
+echo "  Read more about patches at the patches folder."
+envsubst < \
+  patches/jitsi-meet/002-jitsi-meet-welcome-page-on-off.patch | \
+  patch --no-backup-if-mismatch -d / -p1
+
 #Enable close page
-if [ "$ENABLE_CLOCP" = "yes" ]; then
-    sed -i "s|.*enableClosePage:.*|    enableClosePage: true,|" "$MEET_CONF"
-elif [ "$ENABLE_CLOCP" = "no" ]; then
-    sed -i "s|.*enableClosePage:.*|    enableClosePage: false,|" "$MEET_CONF"
-fi
+[ "$ENABLE_CLOCP" = "yes" ] && \
+    sed -i "s|// enableClosePage:.*|enableClosePage: true,|" "$MEET_CONF"
+[ "$ENABLE_CLOCP" = "no" ] && \
+    sed -i "s|// enableClosePage:.*|enableClosePage: false,|" "$MEET_CONF"

 #Add pre-join screen by default, since it improves YouTube autoplay capabilities
 #pre-join screen by itself don't require autorization by moderator, don't confuse with lobby which does.
@ -1297,7 +1162,16 @@ if [ "$ENABLE_NC_ACCESS" = "yes" ]; then
    fi
 fi
 sleep .1
-
+#Jigasi w/VOSK backend.
+if [ "$ENABLE_TRANSCRIPT" = "yes" ]; then
+    printf "\nJigasi with VOSK backend will be enabled."
+    if [ "$MODE" = "debug" ]; then
+        bash "$PWD"/jigasi-vosk-backend.sh -m debug
+    else
+        bash "$PWD"/jigasi-vosk-backend.sh
+    fi
+fi
+sleep .1
 #Grafana Dashboard
 if [ "$ENABLE_GRAFANA_DSH" = "yes" ]; then
    printf "\nGrafana Dashboard will be enabled."
Author	SHA1	Message	Date
Luis Guzmán	8eeb286def	Merge pull request 'README.md: update Jigasi mention now using Vosk.' (#117 ) from Ark74/quick-jibri-installer:upd_readme_jigasi into master Reviewed-on: switnet/quick-jibri-installer#117	2024-08-30 01:10:31 +00:00
Luis Guzmán	61698d06b4	README.md: update Jigasi mention now using Vosk.	2024-08-29 19:09:35 -06:00
Luis Guzmán	6b1e50f7b5	jigasi: update jigasi configuration. (#115 ) Reviewed-on: switnet/quick-jibri-installer#115 Co-authored-by: Ark74 <ark@switnet.org> Co-committed-by: Ark74 <ark@switnet.org>	2024-08-30 00:51:27 +00:00
Luis Guzmán	0a7fd8dfd9	quick_jibri_installer.sh: start migration to configure via patches. (#116 ) Reviewed-on: switnet/quick-jibri-installer#116 Co-authored-by: Ark74 <ark@switnet.org> Co-committed-by: Ark74 <ark@switnet.org>	2024-08-29 23:48:16 +00:00
Luis Guzmán	b9b5d2e326	jigasi: re-enable jigasi now powered by VOSK backend. (#114 ) - quick_jibri_installer.sh: re-enable jigasi on the main QJI - jigasi: re-enable jigasi now powered by VOSK backend. Reviewed-on: switnet/quick-jibri-installer#114 Co-authored-by: Ark74 <ark@switnet.org> Co-committed-by: Ark74 <ark@switnet.org>	2024-08-29 04:45:19 +00:00
Luis Guzmán	11c261959f	Merge pull request 'quick_jibri_installer.sh: fix change on folder naming scheme.' (#113 ) from Ark74/quick-jibri-installer:fix_jibri_rename_folder into master Reviewed-on: switnet/quick-jibri-installer#113	2024-08-28 23:05:36 +00:00
Luis Guzmán	33f1967c6d	quick_jibri_installer.sh: fix change on folder naming scheme.	2024-08-28 17:02:32 -06:00
Luis Guzmán	22c1b881ae	v7.4.1 (#112 ) * fix etherpad nginx configuration * fix live streaming not enabled by default Reviewed-on: switnet/quick-jibri-installer#112 Co-authored-by: Ark74 <ark@switnet.org> Co-committed-by: Ark74 <ark@switnet.org>	2024-07-17 02:14:37 +00:00
Luis Guzmán	40b84218fc	v7.4 final (#111 ) - misc: strip jibri.conf file, remove deprecated functions, improve style. Co-authored-by: Ark74 <ark@switnet.org> Co-committed-by: Ark74 <ark@switnet.org>	2024-07-06 22:23:38 +00:00