cdist-type__jitsi_meet_domain(7)¶

NAME¶

cdist-type__jitsi_meet_domain - Setup a frontend for Jitsi-Meet.

DESCRIPTION¶

This type installs and configures the frontend for Jitsi-Meet.

Additionally to regular Jitsi-Meet, users can load DOMAIN/i/ and DOMAIN/i/ROOM for an interpreter-enabled interface; this is done with a patched version of Jitsi Simultaneous Interpretation (jsi; see references). At least a user with interpreter in their name must be present.

This type supports “multi-domain” installations.

New in April 2022: rooms are independent for each domain, that is: https://jitsi1.example.org/room1 and https://jitsi2.example.org/room1 are different rooms. Note however, that right now if using secured domains, users are still shared across any domains hosted in the same instance. One way to work around that could be to run multiple jicofos, but we do not want to bloat the servers. A better way is to patch jicofo, get in touch with the type authors if you want the gory details.

This assumes __jitsi_meet has already been ran on the target host, and, amongst others, that Jitsi was set up with __target_host as the Jitsi domain.

This type will take care of TLS settings, branding and client-side configuration for Jitsi.

This type only works on De{bi,vu}an systems.

REQUIRED PARAMETERS¶

object id: The domain that will be configured as a Jitsi-Meet instance.
admin-email: Where to send Let’s Encrypt emails like “certificate needs renewal”.

OPTIONAL PARAMETERS¶

analytics-settings: This goes inside the analytics part of config.js. Defaults to: disabled: true. See: https://github.com/jitsi/jitsi-meet/blob/master/config.js
channel-last-n: Default value for the “last N” attribute. Defaults to 20. Set to -1 for unlimited.
default-language: Default language for the user interface. Defaults to ‘en’.
notice-message: Message to show the users when they join a room.
start-video-muted: Every participant after the Nth will start video muted. Defaults to 10.
state: Whether the domain is ‘present’ or ‘absent’, defaults to ‘present’.
turn-server: The TURN server to be used. Defaults to __target_host.
video-constraints: w3c spec-compliant video constraints to use for video capture. Currently used by browsers that return true from lib-jitsi-meet’s util#browser#usesNewGumFlow. The constraints are independent from this config’s resolution value. Defaults to requesting an ideal resolution of 720p. It must not have a trailing comma, see constraints in __jitsi_meet_domain/files/config.js.sh.
branding-app-name: This will change Jitsi Meet in many places to the brand you desire. Defaults to Jitsi Meet.
branding-extra-body: This must be valid HTML, it will be included server-side and delivered to clients alongside the default index.html. This is useful if you would rather not replace the whole index, but still want the chance to do some heavier branding / add instructions / etc.
branding-json: Path to a JSON file that will be served as the dynamicBrandingUrl. For information on the format see dynamicBrandingUrl in __jitsi_meet_domain/files/config.js.sh. If not set, no branding will be set up.
branding-index: Path to an HTML file that will be served instead of Jitsi-Meet’s default one. If not set, the default index file will be used. If set to -, the type’s standard input will be used.
branding-watermark: Path to a png file that will be served instead of Jitsi-Meet’s default one. If not set, the default watermark will be used.

BOOLEAN PARAMETERS¶

disable-audio-levels: Disable measuring of audio levels. This has been reported to improve performance on clients.
enable-third-party-requests: This type disables third-party requests by default, this flag re-enables them, restoring Jitsi-Meet’s defaults. This affects things like avatars, callstats, …
secured-domains: Whether or not an authetnicated user will be required to start a meeting. You will need to create the users with __jitsi_meet_user(7).

EXAMPLES¶

# Setup a Jitsi frontend for jitsi.exo.cat
__jitsi_meet_domain "jitsi.exo.cat" \
  --admin-email "info@exo.cat" \
  --turn-server "turn.exo.cat" \
  --notice-message "Hola!" \
  --disable-audio-levels \
  --turn-secret "WeNeedGoodSecurity" \
  --video-constraints "$(cat <<-EOF
    constraints: {
         video: {
             height: {
                 ideal: 320,
                 max: 320,
                 min: 180
             }
         }
     }
EOF
)"

AUTHORS¶

Evilham <contact@evilham.com>