Merge tag 'tags/stable-9646-ems.1' into openshift

matrix-org · Sep 11, 2024 · fd92e1b · fd92e1b
2 parents 0d665b9 + f8405e4
commit fd92e1b
Show file tree

Hide file tree

Showing 41 changed files with 1,017 additions and 67 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,6 @@
 *.swp
 .env*
 docker-compose.override.yml
+log-analyser/grafana
+**/.DS_Store
+**/.idea
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,52 @@
+## stable-9646
+
+Based on stable release 9646.
+
+* 0dad31d fix(jicofo) enable jigasi brewery with ENABLE_TRANSCRIPTIONS
+* fae66ad fix(jibri): IGNORE_CERTIFICATE_ERRORS as boolean
+* 54baee2 feat(prosody): custom metrics of stanza counts for prosody service implemented (#1862)
+* a88dd8b feat(jvb) default to using dcSCTP
+* d2c26aa fix(jigasi) add missing variables to jigasi.yml
+* 41559d6 feat(log-analyser): added grafana dashboard provisioning (#1855)
+* 2e9e6ca misc: working on unstable
+
+## stable-9584-1
+
+Based on stable release 9584-1.
+
+* 29a4523 feat(jvb) add JVB_CC_TRUST_BWE environment variable
+* 0f7be54 feat(prometheus): Prometheus container and basic scraping configuration  (#1838)
+* 9c87bba feat(jitsi-meet): added grafana loki and otel integration for log analysis (#1844)
+* fcb90ba fix(web): whiteboard config.js syntax error (#1851)
+* 811518b misc: working on unstable
+
+## stable-9584
+
+Based on stable release 9584.
+
+* b4604f3 feat(whiteboard) add builtin whiteboard integration
+* 49bd165 feat(jibri) update Chrome to 126
+* 980703b fix(jibri): display modes in xorg config
+* c65d2bd feat(jigasi,jicofo,jvb,jibri,prosody): add healthcheck.sh scripts and prosody http_health mod
+* d2ac43d feat(jigasi): Add new environment variables for jigasi configuration (#1841)
+* fbc250e feat(prosody): openmetrics module support (#1832)
+* 2adac72 feat(prosody): Drop non existing config.
+* e22b4f3 feat(jibri): Adds more fonts.
+* 982e577 feat(jicofo,jvb,web) default to using SCTP based datachannels
+* 55c975f fix(jicofo): use integer for port value to fix addition (#1826)
+* 7c8763f base: update tpl to version 1.3.0
+* 1d3c0f1 jibri: fail to start if the SYS_ADMIN cap is missing (#1816)
+* cacee4e jvb: adds autoscaler sidecar hook to signal final shutdown (#1809)
+* 726b0f0 jibri: adds autoscaler sidecar hook to signal final shutdown (#1810)
+* f2b2cc4 etherpad: update image version and settings
+* 731d6d1 base: update tpl to make toBool more resilient
+* 59c4eb2 jvb: add fallback WS server ID
+* 9a54843 jvb: add ability to configure the TLS option for colibri WS
+* 79a4635 jvb: add ability to disable XMPP
+* 77ce86a jvb: add ability to enable SCTP datachannels
+* 76ffaa7 jicofo, jvb: fix OCTO + SCTP behaviour
+* 0298a30 misc: working on unstable
+
 ## stable-9457-2
 
 Based on stable release 9457-2.

diff --git a/base/Dockerfile b/base/Dockerfile
@@ -13,8 +13,16 @@ RUN \
         *) echo "unsupported architecture"; exit 1 ;; \
     esac && \
     apt-dpkg-wrap apt-get update && \
-    apt-dpkg-wrap apt-get install -y apt-transport-https apt-utils ca-certificates gnupg wget && \
-    wget -qO /usr/bin/tpl https://github.com/jitsi/tpl/releases/download/v1.1.1/tpl-linux-${TPL_ARCH} && \
+    apt-dpkg-wrap apt-get install -y apt-transport-https apt-utils ca-certificates gnupg wget curl && \
+    wget -qO /usr/bin/tpl https://github.com/jitsi/tpl/releases/download/v1.3.0/tpl-linux-${TPL_ARCH} && \
+    # Workaround S6 bug when /bin is a symlink
+    wget -qO /tmp/s6.tar.gz https://github.com/just-containers/s6-overlay/releases/download/v1.22.1.0/s6-overlay-${S6_ARCH}.tar.gz && \
+    mkdir /tmp/s6 && \
+    tar xfz /tmp/s6.tar.gz -C /tmp/s6 && \
+    tar hxfz /tmp/s6.tar.gz -C / && \
+    rm -f /usr/bin/execlineb && \
+    cp /tmp/s6/bin/execlineb /usr/bin/ && \
+    rm -rf /tmp/s6* && \
     wget -qO - https://download.jitsi.org/jitsi-key.gpg.key | gpg --dearmour > /etc/apt/trusted.gpg.d/jitsi.gpg && \
     echo "deb https://download.jitsi.org $JITSI_RELEASE/" > /etc/apt/sources.list.d/jitsi.list && \
     echo "deb http://ftp.debian.org/debian bookworm-backports main" > /etc/apt/sources.list.d/backports.list && \

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -3,7 +3,7 @@ version: '3.5'
 services:
     # Frontend
     web:
-        image: jitsi/web:${JITSI_IMAGE_VERSION:-stable-9457-2}
+        image: jitsi/web:${JITSI_IMAGE_VERSION:-stable-9646}
         restart: ${RESTART_POLICY:-unless-stopped}
         ports:
             - '${HTTP_PORT}:80'
@@ -171,16 +171,16 @@ services:
             - XMPP_MUC_DOMAIN
             - XMPP_RECORDER_DOMAIN
             - XMPP_PORT
-            - WHITEBOARD_ENABLED
             - WHITEBOARD_COLLAB_SERVER_PUBLIC_URL
+            - WHITEBOARD_COLLAB_SERVER_URL_BASE
         networks:
             meet.jitsi:
         depends_on:
             - jvb
 
                 # XMPP server
     prosody:
-        image: jitsi/prosody:${JITSI_IMAGE_VERSION:-stable-9457-2}
+        image: jitsi/prosody:${JITSI_IMAGE_VERSION:-stable-9646}
         restart: ${RESTART_POLICY:-unless-stopped}
         expose:
             - '${XMPP_PORT:-5222}'
@@ -261,10 +261,13 @@ services:
             - PROSODY_RESERVATION_ENABLED
             - PROSODY_RESERVATION_REST_BASE_URL
             - PROSODY_ENABLE_RATE_LIMITS
+            - PROSODY_ENABLE_STANZA_COUNTS
             - PROSODY_ENABLE_S2S
+            - PROSODY_ENABLE_METRICS
             - PROSODY_GUEST_AUTH_TYPE
             - PROSODY_HTTP_PORT
             - PROSODY_LOG_CONFIG
+            - PROSODY_METRICS_ALLOWED_CIDR
             - PROSODY_MODE
             - PROSODY_RATE_LIMIT_LOGIN_RATE
             - PROSODY_RATE_LIMIT_SESSION_RATE
@@ -313,7 +316,7 @@ services:
 
     # Focus component
     jicofo:
-        image: jitsi/jicofo:${JITSI_IMAGE_VERSION:-stable-9457-2}
+        image: jitsi/jicofo:${JITSI_IMAGE_VERSION:-stable-9646}
         restart: ${RESTART_POLICY:-unless-stopped}
         ports:
             - '127.0.0.1:${JICOFO_REST_PORT:-8888}:8888'
@@ -397,7 +400,7 @@ services:
 
                 # Video bridge
     jvb:
-        image: jitsi/jvb:${JITSI_IMAGE_VERSION:-stable-9457-2}
+        image: jitsi/jvb:${JITSI_IMAGE_VERSION:-stable-9646}
         restart: ${RESTART_POLICY:-unless-stopped}
         ports:
             - '${JVB_PORT:-10000}:${JVB_PORT:-10000}/udp'
@@ -418,12 +421,15 @@ services:
             - ENABLE_COLIBRI_WEBSOCKET
             - ENABLE_JVB_XMPP_SERVER
             - ENABLE_OCTO
+            - ENABLE_SCTP
             - JVB_ADVERTISE_IPS
             - JVB_ADVERTISE_PRIVATE_CANDIDATES
             - JVB_AUTH_USER
             - JVB_AUTH_PASSWORD
             - JVB_BREWERY_MUC
+            - JVB_CC_TRUST_BWE
             - JVB_DISABLE_STUN
+            - JVB_DISABLE_XMPP
             - JVB_INSTANCE_ID
             - JVB_PORT
             - JVB_MUC_NICKNAME
@@ -433,6 +439,7 @@ services:
             - JVB_OCTO_REGION
             - JVB_OCTO_RELAY_ID
             - JVB_REQUIRE_VALID_ADDRESS
+            - JVB_USE_USRSCTP
             - JVB_WS_DOMAIN
             - JVB_WS_SERVER_ID
             - JVB_ENABLE_WS_COMPRESSION

diff --git a/env.example b/env.example
@@ -73,23 +73,22 @@ TZ=UTC
 # Etherpad integration (for document sharing)
 #
 
-# Set etherpad-lite URL in docker local network (uncomment to enable)
+# Set the etherpad-lite URL in the docker local network (uncomment to enable)
 #ETHERPAD_URL_BASE=http://etherpad.meet.jitsi:9001
 
 # Set etherpad-lite public URL, including /p/ pad path fragment (uncomment to enable)
 #ETHERPAD_PUBLIC_URL=https://etherpad.my.domain/p/
 
-# Name your etherpad instance!
-ETHERPAD_TITLE="Video Chat"
 
-# The default text of a pad
-ETHERPAD_DEFAULT_PAD_TEXT="Welcome to Web Chat!\n\n"
+#
+# Whiteboard integration
+#
 
-# Name of the skin for etherpad
-ETHERPAD_SKIN_NAME=colibris
+# Set the excalidraw-backend URL in the docker local network (uncomment to enable)
+#WHITEBOARD_COLLAB_SERVER_URL_BASE=http://whiteboard.meet.jitsi
 
-# Skin variants for etherpad
-ETHERPAD_SKIN_VARIANTS="super-light-toolbar super-light-editor light-background full-width-editor"
+# Set the excalidraw-backend public URL (uncomment to enable)
+#WHITEBOARD_COLLAB_SERVER_PUBLIC_URL=https://whiteboard.meet.my.domain
 
 
 #

diff --git a/etherpad.yml b/etherpad.yml
@@ -3,13 +3,13 @@ version: '3.5'
 services:
     # Etherpad: real-time collaborative document editing
     etherpad:
-        image: etherpad/etherpad:1.9.6
+        image: etherpad/etherpad:2.0.3
         restart: ${RESTART_POLICY:-unless-stopped}
         environment:
-            - TITLE=${ETHERPAD_TITLE}
-            - DEFAULT_PAD_TEXT=${ETHERPAD_DEFAULT_PAD_TEXT}
-            - SKIN_NAME=${ETHERPAD_SKIN_NAME}
-            - SKIN_VARIANTS=${ETHERPAD_SKIN_VARIANTS}
+            - TITLE=${ETHERPAD_TITLE:-""}
+            - DEFAULT_PAD_TEXT=${ETHERPAD_DEFAULT_PAD_TEXT:-""}
+            - SKIN_NAME=${ETHERPAD_SKIN_NAME:-colibris}
+            - SKIN_VARIANTS=${ETHERPAD_SKIN_VARIANTS:-"super-light-toolbar super-light-editor light-background full-width-editor"}
             - SUPPRESS_ERRORS_IN_PAD_TEXT=true
         networks:
             meet.jitsi:

diff --git a/grafana.yml b/grafana.yml
@@ -0,0 +1,13 @@
+version: '3.5'
+
+services:
+  # Grafana: used for visualization of metrics and log data through customizable dashboards.
+  grafana:
+    image: grafana/grafana:10.2.0
+    environment:
+      - GF_ANALYTICS_REPORTING_ENABLED=false
+    volumes:
+      - ./log-analyser/grafana:/var/lib/grafana
+      - ./log-analyser/grafana-provisioning/dashboards/:/etc/grafana/provisioning/dashboards/
+    ports:
+      - "3000:3000"
diff --git a/jibri.yml b/jibri.yml
@@ -2,7 +2,7 @@ version: '3.5'
 
 services:
     jibri:
-        image: jitsi/jibri:${JITSI_IMAGE_VERSION:-stable-9457-2}
+        image: jitsi/jibri:${JITSI_IMAGE_VERSION:-stable-9646}
         restart: ${RESTART_POLICY:-unless-stopped}
         volumes:
             - ${CONFIG}/jibri:/config:Z

diff --git a/jibri/Dockerfile b/jibri/Dockerfile
@@ -11,12 +11,26 @@ LABEL org.opencontainers.image.documentation="https://jitsi.github.io/handbook/"
 ARG USE_CHROMIUM=0
 #ARG CHROME_RELEASE=latest
 # https://googlechromelabs.github.io/chrome-for-testing/
-ARG CHROME_RELEASE=121.0.6167.85
+ARG CHROME_RELEASE=126.0.6478.126
 
 COPY rootfs/ /
 
 RUN apt-dpkg-wrap apt-get update && \
-    apt-dpkg-wrap apt-get install -y -o Dpkg::Options::="--force-confdef" -o Dpkg::Options::="--force-confold" jibri libgl1-mesa-dri procps jitsi-upload-integrations jitsi-autoscaler-sidecar jq pulseaudio dbus dbus-x11 rtkit unzip fonts-noto && \
+    apt-dpkg-wrap apt-get install -y -o Dpkg::Options::="--force-confdef" -o Dpkg::Options::="--force-confold" \
+        jibri \
+        libgl1-mesa-dri \
+        procps \
+        jitsi-upload-integrations \
+        jitsi-autoscaler-sidecar \
+        jq \
+        pulseaudio \
+        dbus \
+        dbus-x11 \
+        rtkit \
+        unzip \
+        fonts-noto \
+        fonts-noto-cjk \
+        libcap2-bin && \
     /usr/bin/install-chrome.sh && \
     apt-cleanup && \
     adduser jibri rtkit && \

diff --git a/jibri/rootfs/defaults/autoscaler-sidecar.config b/jibri/rootfs/defaults/autoscaler-sidecar.config
@@ -5,7 +5,7 @@ export SHUTDOWN_POLLING_INTERVAL={{ $SHUTDOWN_POLLING_INTERVAL }}
 export STATS_POLLING_INTERVAL={{ $STATS_POLLING_INTERVAL }}
 export PORT={{ .Env.AUTOSCALER_SIDECAR_PORT }}
 export GRACEFUL_SHUTDOWN_SCRIPT="/opt/jitsi/jibri/wait_graceful_shutdown.sh"
-export TERMINATE_SCRIPT="/opt/jitsi/jibri/shutdown.sh"
+export TERMINATE_SCRIPT="/opt/jitsi/shutdown.sh"
 export ENABLE_REPORT_STATS=true
 export POLLING_URL="{{ .Env.AUTOSCALER_URL  }}/sidecar/poll"
 export STATUS_URL="{{ .Env.AUTOSCALER_URL }}/sidecar/status"

diff --git a/jibri/rootfs/defaults/jibri.conf b/jibri/rootfs/defaults/jibri.conf
@@ -1,3 +1,4 @@
+{{ $IGNORE_CERTIFICATE_ERRORS := .Env.IGNORE_CERTIFICATE_ERRORS | default "false" | toBool -}}
 {{ $ENABLE_PROMETHEUS := .Env.JIBRI_ENABLE_PROMETHEUS | default "false" | toBool -}}
 {{ $JIBRI_RECORDING_RESOLUTION := .Env.JIBRI_RECORDING_RESOLUTION | default "1280x720" -}}
 {{ $JIBRI_RECORDING_VIDEO_ENCODE_PRESET := .Env.JIBRI_RECORDING_VIDEO_ENCODE_PRESET | default "veryfast" -}}
@@ -64,7 +65,7 @@ jibri {
         "{{ join "\",\"" (splitList "," .Env.CHROMIUM_FLAGS) }}"
       ]
     }
-    {{ else if .Env.IGNORE_CERTIFICATE_ERRORS -}}
+    {{ else if $IGNORE_CERTIFICATE_ERRORS -}}
     chrome {
       flags = [
         "--use-fake-ui-for-media-stream",

diff --git a/jibri/rootfs/defaults/xorg-video-dummy.conf b/jibri/rootfs/defaults/xorg-video-dummy.conf
@@ -1,6 +1,6 @@
 {{ $JIBRI_RECORDING_RESOLUTION := .Env.JIBRI_RECORDING_RESOLUTION | default "1280x720" -}}
-{{ $JIBRI_HORIZ_SYNC := .Env.JIBRI_XORG_HORIZ_SYNC | default "43.0 - 47.0" -}}
-{{ $JIBRI_VERT_REFRESH := .Env.JIBRI_XORG_VERT_REFRESH | default "58.0 - 62.0" -}}
+{{ $JIBRI_HORIZ_SYNC := .Env.JIBRI_XORG_HORIZ_SYNC | default "5.0 - 1000.0" -}}
+{{ $JIBRI_VERT_REFRESH := .Env.JIBRI_XORG_VERT_REFRESH | default "5.0 - 200.0" -}}
 
 # This xorg configuration file is meant to be used by xpra
 # to start a dummy X11 server.
@@ -65,7 +65,6 @@ Section "Monitor"
   Modeline "1360x768" 24.49 1360 1392 1480 1512 768 786 789 807
   Modeline "1024x768" 18.71 1024 1056 1120 1152 768 786 789 807
   Modeline "768x1024" 19.50 768 800 872 904 1024 1048 1052 1076
-  Modeline "1280x720@60" 73.78 1280 1312 1592 1624 720 735 742 757
 
 
   #common resolutions for android devices (both orientations):
@@ -113,8 +112,7 @@ Section "Screen"
   SubSection "Display"
     Viewport 0 0
     Depth 24
-    Modes "5120x3200" "3840x2880" "3840x2560" "3840x2048" "2048x2048" "2560x1600" "1920x1440" "1920x1200" "1920x1080" "1600x1200" "1680x1050" "1600x900" "1400x1050" "1440x900" "1280x1024" "1366x768" "1280x800" "1024x768" "1024x600" "800x600" "320x200"
-    Virtual {{ join " " (splitList "x" $JIBRI_RECORDING_RESOLUTION) }}
+    Modes {{ $JIBRI_RECORDING_RESOLUTION | quote }}
   EndSubSection
 EndSection
 

diff --git a/jibri/rootfs/opt/jitsi/shutdown.sh b/jibri/rootfs/opt/jitsi/shutdown.sh
@@ -0,0 +1,11 @@
+#!/usr/bin/with-contenv bash
+# notify the sidecar of imminent shutdown
+PORT=${AUTOSCALER_SIDECAR_PORT:-6000}
+curl -d '{}' -v 0:$PORT/hook/v1/shutdown
+sleep 10
+
+# signal jibri to shutdown via rest api
+/opt/jitsi/jibri/shutdown.sh
+
+# shutdown everything else
+s6-svscanctl -t /var/run/s6/services
diff --git a/jibri/rootfs/usr/bin/init_jitsi_jibri b/jibri/rootfs/usr/bin/init_jitsi_jibri
@@ -1,5 +1,11 @@
 #!/bin/bash
 
+# Check if the SYS_ADMIN cap is set
+if ! capsh --has-p=cap_sys_admin; then
+    echo "Required capability SYS_ADMIN is missing"
+    exit 1
+fi
+
 # Check if /dev/shm is large enough (2GB at least)
 if ! shm-check; then
     echo "/dev/shm must be at least 2GB in size"

diff --git a/jicofo/rootfs/defaults/jicofo.conf b/jicofo/rootfs/defaults/jicofo.conf
@@ -4,15 +4,16 @@
 {{ $AUTH_TYPE := .Env.AUTH_TYPE | default "internal" -}}
 {{ $JICOFO_AUTH_TYPE := .Env.JICOFO_AUTH_TYPE | default $AUTH_TYPE -}}
 {{ $JICOFO_AUTH_LIFETIME := .Env.JICOFO_AUTH_LIFETIME | default "24 hours" -}}
-{{ $ENABLE_SCTP := .Env.ENABLE_SCTP | default "0" | toBool -}}
+{{ $ENABLE_SCTP := .Env.ENABLE_SCTP | default "1" | toBool -}}
 {{ $ENABLE_RECORDING := .Env.ENABLE_RECORDING | default "0" | toBool -}}
 {{ $ENABLE_OCTO := .Env.ENABLE_OCTO | default "0" | toBool -}}
-{{ $ENABLE_OCTO_SCTP := .Env.ENABLE_OCTO_SCTP | default (.Env.ENABLE_SCTP | default "0") | toBool -}}
+{{ $ENABLE_OCTO_SCTP := .Env.ENABLE_OCTO_SCTP | default $ENABLE_SCTP | toBool -}}
 {{ $ENABLE_AUTO_LOGIN := .Env.ENABLE_AUTO_LOGIN | default "1" | toBool -}}
 {{ $ENABLE_REST := .Env.JICOFO_ENABLE_REST | default "0" | toBool -}}
 {{ $ENABLE_JVB_XMPP_SERVER := .Env.ENABLE_JVB_XMPP_SERVER | default "0" | toBool -}}
 {{ $HEALTH_CHECKS_USE_PRESENCE := .Env.JICOFO_HEALTH_CHECKS_USE_PRESENCE | default "0" | toBool -}}
 {{ $JIBRI_BREWERY_MUC := .Env.JIBRI_BREWERY_MUC | default "jibribrewery" -}}
+{{ $ENABLE_TRANSCRIPTIONS := .Env.ENABLE_TRANSCRIPTIONS | default "0" | toBool -}}
 {{ $JIGASI_BREWERY_MUC := .Env.JIGASI_BREWERY_MUC | default "jigasibrewery" -}}
 {{ $JVB_BREWERY_MUC := .Env.JVB_BREWERY_MUC | default "jvbbrewery" -}}
 {{ $JIBRI_PENDING_TIMEOUT := .Env.JIBRI_PENDING_TIMEOUT | default "90 seconds" -}}
@@ -27,7 +28,7 @@
 {{ $VISITORS_XMPP_DOMAIN := .Env.VISITORS_XMPP_DOMAIN | default "meet.jitsi" -}}
 {{ $VISITORS_XMPP_SERVER := .Env.VISITORS_XMPP_SERVER | default "" -}}
 {{ $VISITORS_XMPP_SERVERS := splitList "," $VISITORS_XMPP_SERVER -}}
-{{ $VISITORS_XMPP_PORT := .Env.VISITORS_XMPP_PORT | default "52220" }}
+{{ $VISITORS_XMPP_PORT := .Env.VISITORS_XMPP_PORT | default 52220 }}
 {{ $XMPP_AUTH_DOMAIN := .Env.XMPP_AUTH_DOMAIN | default "auth.meet.jitsi" -}}
 {{ $XMPP_MUC_DOMAIN := .Env.XMPP_MUC_DOMAIN | default "muc.meet.jitsi" -}}
 {{ $XMPP_INTERNAL_MUC_DOMAIN := .Env.XMPP_INTERNAL_MUC_DOMAIN | default "internal-muc.meet.jitsi" -}}
@@ -204,7 +205,7 @@ jicofo {
     }
     {{ end }}
 
-    {{ if and .Env.JIGASI_SIP_URI $JIGASI_BREWERY_MUC }}
+    {{ if or .Env.JIGASI_SIP_URI $ENABLE_TRANSCRIPTIONS }}
     jigasi {
       brewery-jid = "{{ $JIGASI_BREWERY_MUC }}@{{ $XMPP_INTERNAL_MUC_DOMAIN }}"
     }
@@ -290,8 +291,8 @@ jicofo {
         disable-certificate-verification = true
       }
       {{ end }}
-      
+
       trusted-domains = [ {{ range $index, $element := $TRUSTED_DOMAINS }}{{ if gt $index 0 }},{{ end }}"{{ $element }}"{{ end}} ]
-      
+
     }
 }
diff --git a/jicofo/rootfs/usr/local/bin/healthcheck.sh b/jicofo/rootfs/usr/local/bin/healthcheck.sh
@@ -0,0 +1,3 @@
+#!/bin/bash
+
+curl --fail-with-body http://127.0.0.1:8888/about/health