jibri: use new configuration file

2026-04-02 15:51:05 +02:00 · 2021-10-13 19:41:20 +05:30 · 2021-10-13 19:41:20 +05:30 · bee4b6a124
commit bee4b6a124
parent 76a16a8b78
5 changed files with 255 additions and 72 deletions
--- a/jibri.yml
+++ b/jibri.yml
@ -13,12 +13,15 @@ services:
        devices:
            - /dev/snd:/dev/snd
        environment:
-            - PUBLIC_URL
-            - XMPP_AUTH_DOMAIN
-            - XMPP_INTERNAL_MUC_DOMAIN
-            - XMPP_RECORDER_DOMAIN
-            - XMPP_SERVER
-            - XMPP_DOMAIN
+            - CHROMIUM_FLAGS
+            - DISPLAY=:0
+            - ENABLE_STATS_D
+            - JIBRI_FFMPEG_AUDIO_SOURCE
+            - JIBRI_FFMPEG_AUDIO_DEVICE
+            - JIBRI_HTTP_API_EXTERNAL_PORT
+            - JIBRI_HTTP_API_INTERNAL_PORT
+            - JIBRI_RECORDING_RESOLUTION
+            - JIBRI_USAGE_TIMEOUT
            - JIBRI_XMPP_USER
            - JIBRI_XMPP_PASSWORD
            - JIBRI_BREWERY_MUC
@ -28,8 +31,14 @@ services:
            - JIBRI_FINALIZE_RECORDING_SCRIPT_PATH
            - JIBRI_STRIP_DOMAIN_JID
            - JIBRI_LOGS_DIR
-            - DISPLAY=:0
+            - PUBLIC_URL
            - TZ
+            - XMPP_AUTH_DOMAIN
+            - XMPP_DOMAIN
+            - XMPP_INTERNAL_MUC_DOMAIN
+            - XMPP_RECORDER_DOMAIN
+            - XMPP_SERVER
+            - XMPP_TRUST_ALL_CERTS
        depends_on:
            - jicofo
        networks:
--- a/jibri/rootfs/defaults/config.json
+++ b/jibri/rootfs/defaults/config.json
@ -1,62 +0,0 @@
-{
-    "recording_directory":"{{ .Env.JIBRI_RECORDING_DIR }}",
-    // The path to the script which will be run on completed recordings
-{{ if .Env.JIBRI_FINALIZE_RECORDING_SCRIPT_PATH -}}
-    "finalize_recording_script_path": "{{ .Env.JIBRI_FINALIZE_RECORDING_SCRIPT_PATH }}",
-{{ end -}}
-    "xmpp_environments": [
-        {
-            // A friendly name for this environment which can be used
-            //  for logging, stats, etc.
-            "name": "prod environment",
-            // The hosts of the XMPP servers to connect to as part of
-            //  this environment
-            "xmpp_server_hosts": [
-                "{{ .Env.XMPP_SERVER }}"
-            ],
-            "xmpp_domain": "{{ .Env.XMPP_DOMAIN }}",
-            // An (optional) base url the Jibri will join if it is set
-            "baseUrl": "{{ .Env.PUBLIC_URL }}",
-            // Jibri will login to the xmpp server as a privileged user 
-            "control_login": {
-                "domain": "{{ .Env.XMPP_AUTH_DOMAIN }}",
-                // The credentials for logging in
-                "username": "{{ .Env.JIBRI_XMPP_USER }}",
-                "password": "{{ .Env.JIBRI_XMPP_PASSWORD }}"
-            },
-            // Using the control_login information above, Jibri will join 
-            //  a control muc as a means of announcing its availability 
-            //  to provide services for a given environment
-            "control_muc": {
-                "domain": "{{ .Env.XMPP_INTERNAL_MUC_DOMAIN }}",
-                "room_name": "{{ .Env.JIBRI_BREWERY_MUC }}",
-                // MUST be unic for every instanse
-                "nickname": "jibri-instanse-{{ .Env.JIBRI_INSTANCE_ID }}"
-            },
-            // All participants in a call join a muc so they can exchange
-            //  information.  Jibri can be instructed to join a special muc
-            //  with credentials to give it special abilities (e.g. not being
-            //  displayed to other users like a normal participant)
-            "call_login": {
-                "domain": "{{ .Env.XMPP_RECORDER_DOMAIN }}",
-                "username": "{{ .Env.JIBRI_RECORDER_USER }}",
-                "password": "{{ .Env.JIBRI_RECORDER_PASSWORD }}"
-            },
-            // When jibri gets a request to start a service for a room, the room
-            //  jid will look like:
-            //  roomName@optional.prefixes.subdomain.xmpp_domain
-            // We'll build the url for the call by transforming that into:
-            //  https://xmpp_domain/subdomain/roomName
-            // So if there are any prefixes in the jid (like jitsi meet, which
-            //  has its participants join a muc at conference.xmpp_domain) then
-            //  list that prefix here so it can be stripped out to generate
-            //  the call url correctly
-            "room_jid_domain_string_to_strip_from_start": "{{ .Env.JIBRI_STRIP_DOMAIN_JID }}.",
-            // The amount of time, in minutes, a service is allowed to continue.
-            //  Once a service has been running for this long, it will be
-            //  stopped (cleanly).  A value of 0 means an indefinite amount
-            //  of time is allowed
-            "usage_timeout": "0"
-        }
-    ]
-}
--- a/jibri/rootfs/defaults/jibri.conf
+++ b/jibri/rootfs/defaults/jibri.conf
@ -0,0 +1,112 @@
+{{ $JIBRI_USAGE_TIMEOUT := .Env.JIBRI_USAGE_TIMEOUT | default "0" -}}
+{{ $XMPP_TRUST_ALL_CERTS := .Env.XMPP_TRUST_ALL_CERTS | default "true" | toBool -}}
+
+jibri {
+    // A unique identifier for this Jibri
+    id = "{{ .Env.JIBRI_INSTANCE_ID }}"
+
+    api {
+      {{ if or .Env.JIBRI_HTTP_API_EXTERNAL_PORT .Env.JIBRI_HTTP_API_INTERNAL_PORT -}}
+      http {
+        {{ if .Env.JIBRI_HTTP_API_EXTERNAL_PORT -}}
+        external-api-port = {{ .Env.JIBRI_HTTP_API_EXTERNAL_PORT }}
+        {{ end -}}
+        {{ if .Env.JIBRI_HTTP_API_INTERNAL_PORT -}}
+        internal-api-port = {{ .Env.JIBRI_HTTP_API_INTERNAL_PORT }}
+        {{ end -}}
+      }
+      {{ end -}}
+      xmpp {
+        // See example_xmpp_envs.conf for an example of what is expected here
+        environments = [
+            {
+                // A user-friendly name for this environment
+                name = "{{ .Env.XMPP_ENV_NAME }}"
+    
+                // A list of XMPP server hosts to which we'll connect
+                xmpp-server-hosts = [ 
+                    "{{ .Env.XMPP_SERVER }}"
+                ]
+    
+                // The base XMPP domain
+                xmpp-domain = "{{ .Env.XMPP_DOMAIN }}"
+
+                {{ if .Env.PUBLIC_URL -}}
+                // An (optional) base url the Jibri will join if it is set
+                base-url = "{{ .Env.PUBLIC_URL }}"
+                {{ end -}}
+                
+                // The MUC we'll join to announce our presence for
+                // recording and streaming services
+                control-muc {
+                    domain = "{{ .Env.XMPP_INTERNAL_MUC_DOMAIN }}"
+                    room-name = "{{ .Env.JIBRI_BREWERY_MUC }}"
+                    nickname = "{{ .Env.JIBRI_INSTANCE_ID }}"
+                }
+    
+                // The login information for the control MUC
+                control-login {
+                    domain = "{{ .Env.XMPP_AUTH_DOMAIN }}"
+                    username = "{{ .Env.JIBRI_XMPP_USER }}"
+                    password = "{{ .Env.JIBRI_XMPP_PASSWORD }}"
+                }
+
+                // The login information the selenium web client will use
+                call-login {
+                    domain = "{{ .Env.XMPP_RECORDER_DOMAIN }}"
+                    username = "{{ .Env.JIBRI_RECORDER_USER }}"
+                    password = "{{ .Env.JIBRI_RECORDER_PASSWORD }}"
+                }
+                
+                // The value we'll strip from the room JID domain to derive
+                // the call URL
+                strip-from-room-domain = "{{ .Env.JIBRI_STRIP_DOMAIN_JID }}."
+    
+                // 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 = "{{ $JIBRI_USAGE_TIMEOUT }}"
+                
+                // Whether or not we'll automatically trust any cert on
+                // this XMPP domain
+                trust-all-xmpp-certs = {{ $XMPP_TRUST_ALL_CERTS }}
+            }
+        ]
+      }
+    }
+    recording {
+      recordings-directory = "{{ .Env.JIBRI_RECORDING_DIR }}"
+      {{ if .Env.JIBRI_FINALIZE_RECORDING_SCRIPT_PATH -}}
+      finalize-script = "{{ .Env.JIBRI_FINALIZE_RECORDING_SCRIPT_PATH }}"
+      {{ end -}}
+    }
+
+    ffmpeg {
+      {{ if .Env.JIBRI_RECORDING_RESOLUTION -}}
+      resolution =  "{{ .Env.JIBRI_RECORDING_RESOLUTION }}"
+      {{ end -}}
+      {{ if .Env.JIBRI_FFMPEG_AUDIO_SOURCE -}}
+      // The audio source that will be used to capture audio on Linux
+      audio-source = "{{ .Env.JIBRI_FFMPEG_AUDIO_SOURCE }}"
+      {{ end -}}
+      {{ if .Env.JIBRI_FFMPEG_AUDIO_DEVICE -}}
+      // The audio device that will be used to capture audio on Linux
+      audio-device =  "{{ .Env.JIBRI_FFMPEG_AUDIO_DEVICE }}"
+      {{ end -}}
+    }
+
+    {{ if .Env.CHROMIUM_FLAGS -}}
+    chrome {
+      // The flags which will be passed to chromium when launching
+      flags = [
+        "{{ join "\",\"" (splitList "," .Env.CHROMIUM_FLAGS) }}"
+      ]
+    }
+    {{ end -}}
+
+    {{ if .Env.ENABLE_STATS_D -}}
+    stats {
+      enable-stats-d = {{ .Env.ENABLE_STATS_D }}
+    }
+    {{ end -}}
+}
--- a/jibri/rootfs/defaults/xorg-video-dummy.conf
+++ b/jibri/rootfs/defaults/xorg-video-dummy.conf
@ -0,0 +1,123 @@
+# This xorg configuration file is meant to be used by xpra
+# to start a dummy X11 server.
+# For details, please see:
+# https://xpra.org/Xdummy.html
+
+Section "ServerFlags"
+  Option "DontVTSwitch" "true"
+  Option "AllowMouseOpenFail" "true"
+  Option "PciForceNone" "true"
+  Option "AutoEnableDevices" "false"
+  Option "AutoAddDevices" "false"
+EndSection
+
+Section "Device"
+  Identifier "dummy_videocard"
+  Driver "dummy"
+  Option "ConstantDPI" "true"
+  #VideoRam 4096000
+  #VideoRam 256000
+  VideoRam 192000
+EndSection
+
+Section "Monitor"
+  Identifier "dummy_monitor"
+  HorizSync   5.0 - 1000.0
+  VertRefresh 5.0 - 200.0
+  #This can be used to get a specific DPI, but only for the default resolution:
+  #DisplaySize 508 317
+  #NOTE: the highest modes will not work without increasing the VideoRam
+  # for the dummy video card.
+  Modeline "32768x32768" 15226.50 32768 35800 39488 46208 32768 32771 32781 32953
+  Modeline "32768x16384" 7516.25 32768 35544 39192 45616 16384 16387 16397 16478
+  Modeline "16384x8192" 2101.93 16384 16416 24400 24432 8192 8390 8403 8602
+  Modeline "8192x4096" 424.46 8192 8224 9832 9864 4096 4195 4202 4301
+  Modeline "5496x1200" 199.13 5496 5528 6280 6312 1200 1228 1233 1261
+  Modeline "5280x1080" 169.96 5280 5312 5952 5984 1080 1105 1110 1135
+  Modeline "5280x1200" 191.40 5280 5312 6032 6064 1200 1228 1233 1261
+  Modeline "5120x3200" 199.75 5120 5152 5904 5936 3200 3277 3283 3361
+  Modeline "4800x1200" 64.42 4800 4832 5072 5104 1200 1229 1231 1261
+  Modeline "3840x2880" 133.43 3840 3872 4376 4408 2880 2950 2955 3025
+  Modeline "3840x2560" 116.93 3840 3872 4312 4344 2560 2622 2627 2689
+  Modeline "3840x2048" 91.45 3840 3872 4216 4248 2048 2097 2101 2151
+  Modeline "3840x1080" 100.38 3840 3848 4216 4592 1080 1081 1084 1093
+  Modeline "3600x1200" 106.06 3600 3632 3984 4368 1200 1201 1204 1214
+  Modeline "3288x1080" 39.76 3288 3320 3464 3496 1080 1106 1108 1135
+  Modeline "2048x2048" 49.47 2048 2080 2264 2296 2048 2097 2101 2151
+  Modeline "2048x1536" 80.06 2048 2104 2312 2576 1536 1537 1540 1554
+  Modeline "2560x1600" 47.12 2560 2592 2768 2800 1600 1639 1642 1681
+  Modeline "2560x1440" 42.12 2560 2592 2752 2784 1440 1475 1478 1513
+  Modeline "1920x1440" 69.47 1920 1960 2152 2384 1440 1441 1444 1457
+  Modeline "1920x1200" 26.28 1920 1952 2048 2080 1200 1229 1231 1261
+  Modeline "1920x1080" 23.53 1920 1952 2040 2072 1080 1106 1108 1135
+  Modeline "1680x1050" 20.08 1680 1712 1784 1816 1050 1075 1077 1103
+  Modeline "1600x1200" 22.04 1600 1632 1712 1744 1200 1229 1231 1261
+  Modeline "1600x900" 33.92 1600 1632 1760 1792 900 921 924 946
+  Modeline "1440x900" 30.66 1440 1472 1584 1616 900 921 924 946
+  ModeLine "1366x768" 72.00 1366 1414 1446 1494  768 771 777 803
+  Modeline "1280x1024" 31.50 1280 1312 1424 1456 1024 1048 1052 1076
+  Modeline "1280x800" 24.15 1280 1312 1400 1432 800 819 822 841
+  Modeline "1280x768" 23.11 1280 1312 1392 1424 768 786 789 807
+  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
+
+
+  #common resolutions for android devices (both orientations):
+  Modeline "800x1280" 25.89 800 832 928 960 1280 1310 1315 1345
+  Modeline "1280x800" 24.15 1280 1312 1400 1432 800 819 822 841
+  Modeline "720x1280" 30.22 720 752 864 896 1280 1309 1315 1345
+  Modeline "1280x720" 27.41 1280 1312 1416 1448 720 737 740 757
+  Modeline "768x1024" 24.93 768 800 888 920 1024 1047 1052 1076
+  Modeline "1024x768" 23.77 1024 1056 1144 1176 768 785 789 807
+  Modeline "600x1024" 19.90 600 632 704 736 1024 1047 1052 1076
+  Modeline "1024x600" 18.26 1024 1056 1120 1152 600 614 617 631
+  Modeline "536x960" 16.74 536 568 624 656 960 982 986 1009
+  Modeline "960x536" 15.23 960 992 1048 1080 536 548 551 563
+  Modeline "600x800" 15.17 600 632 688 720 800 818 822 841
+  Modeline "800x600" 14.50 800 832 880 912 600 614 617 631
+  Modeline "480x854" 13.34 480 512 560 592 854 873 877 897
+  Modeline "848x480" 12.09 848 880 920 952 480 491 493 505
+  Modeline "480x800" 12.43 480 512 552 584 800 818 822 841
+  Modeline "800x480" 11.46 800 832 872 904 480 491 493 505
+  #resolutions for android devices (both orientations)
+  #minus the status bar
+  #38px status bar (and width rounded up)
+  Modeline "800x1242" 25.03 800 832 920 952 1242 1271 1275 1305
+  Modeline "1280x762" 22.93 1280 1312 1392 1424 762 780 783 801
+  Modeline "720x1242" 29.20 720 752 856 888 1242 1271 1276 1305
+  Modeline "1280x682" 25.85 1280 1312 1408 1440 682 698 701 717
+  Modeline "768x986" 23.90 768 800 888 920 986 1009 1013 1036
+  Modeline "1024x730" 22.50 1024 1056 1136 1168 730 747 750 767
+  Modeline "600x986" 19.07 600 632 704 736 986 1009 1013 1036
+  Modeline "1024x562" 17.03 1024 1056 1120 1152 562 575 578 591
+  Modeline "536x922" 16.01 536 568 624 656 922 943 947 969
+  Modeline "960x498" 14.09 960 992 1040 1072 498 509 511 523
+  Modeline "600x762" 14.39 600 632 680 712 762 779 783 801
+  Modeline "800x562" 13.52 800 832 880 912 562 575 578 591
+  Modeline "480x810" 12.59 480 512 552 584 810 828 832 851
+  Modeline "848x442" 11.09 848 880 920 952 442 452 454 465
+  Modeline "480x762" 11.79 480 512 552 584 762 779 783 801
+EndSection
+
+Section "Screen"
+  Identifier "dummy_screen"
+  Device "dummy_videocard"
+  Monitor "dummy_monitor"
+  DefaultDepth 24
+  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"
+    {{ if .Env.JIBRI_RECORDING_RESOLUTION -}}
+    Virtual {{ join " " (splitList "x" .Env.JIBRI_RECORDING_RESOLUTION) }}
+    {{ else -}}
+    Virtual 1920 1080
+    {{ end -}}
+  EndSubSection
+EndSection
+
+Section "ServerLayout"
+  Identifier   "dummy_layout"
+  Screen       "dummy_screen"
+EndSection
--- a/jibri/rootfs/etc/cont-init.d/10-config
+++ b/jibri/rootfs/etc/cont-init.d/10-config
@ -43,12 +43,13 @@ usermod -aG ${host_audio_group} jibri
 && [ ! -x "${JIBRI_FINALIZE_RECORDING_SCRIPT_PATH}" ] \
 && chmod +x ${JIBRI_FINALIZE_RECORDING_SCRIPT_PATH}

-# set rundom jibri nickname for the instance if is not set
-[ -z "${JIBRI_INSTANCE_ID}" ] && export JIBRI_INSTANCE_ID=$(date +%N)
+# set random jibri nickname for the instance if is not set
+[ -z "${JIBRI_INSTANCE_ID}" ] && export JIBRI_INSTANCE_ID="jibri-$(date +%N)"

 # always recreate configs
-tpl /defaults/config.json > /etc/jitsi/jibri/config.json
+tpl /defaults/jibri.conf > /etc/jitsi/jibri/jibri.conf
 tpl /defaults/logging.properties > /etc/jitsi/jibri/logging.properties
+tpl /defaults/xorg-video-dummy.conf > /etc/jitsi/jibri/xorg-video-dummy.conf

 # make recording dir
 [ -z "${JIBRI_RECORDING_DIR}" ] && export JIBRI_RECORDING_DIR=/config/recordings