jitsi

Module for installing Jitsi Server (via docker-compose) and Client (as AppImage)

Description

This module acts as a wrapper around a wrapper. On the server, it clones a stable version of the docker-composer file, performs some minor modifications and starts the server. By default it expects you to install a reverse proxy which exposes jitsi to the internet.

On the client it downloads a stable version of the AppImage from GitHub and saves it on /usr/local/bin.

Client and server classes are completely unrelated but, of course, deal with connected subjects.

Usage

Client

The class for the client does not need any further parameters but can work with the defaults. Just assign it to your node and it will download the AppImage from the GitHub Releases.

include jitsi::client

You can also specify the version you want to download. In that case make sure you also specify the corresponding checksum and checksum type.

class { 'jitsi::client':
  version       => 'v2.8.5',
  checksum      => 'a5a97217d72c7711efe9a1dffa51f75f93105cdfdf951e7dcc90724b89feb41b964cc664d7f9b6df5662ba6841a40e6b6613e07d6c9f08510ef32fadb1bdb242',
  checksum_type => 'sha512',

Containerized Server

To install the containerized version of the Jitsi server part no more input parameters are required. Secrets are determined automatically.

class { 'jitsi::containerized_server': }

You can set all parameters using hiera:

classes:
  - jitsi::containerized_server

There are several files governing the behaviour of your jitsi server. Most of the settings are passed to the containers as environment variable using the file .env Settings concerning the web frontend are changed in ${CONFIG_DIR}/web/config.js. Both are rendered from templates.

You can add environment variables (see Self-Hosting Guide - Docker) via custom_variables parameter, if they aren't represented as a parameter itself:

jitsi::containerized_server::custom_variables:
  DISABLE_AUDIO_LEVELS: 0
  ENABLE_END_CONFERENCE: 0

Changing ports

You can, for instance, change the ports the containers expose. By default they are running on 30799 for HTTP and 30800 for HTTPS. The HTTP port is relevant if you place your jitsi behind a reverse proxy. In that case it is also recommended to set your public url:

jitsi::containerized_server::http_port: 30032
jitsi::containerized_server::https_port: 30033
jitsi::containerized_server::public_url: "https://your.jitsi.domain

Note that so far, no testing of the Let's Encrypt Integration have been done.

Changing web frontend

On the server side we set several values:

• default video resolution is set to 720p
• layer suspension is enabled
• you have several options to control audio processing.

Jitsi by default does some audio processing. You can turn it off completely by passing

jitsi::containerized_server::disable_all_audio_processing: true

Note the inverse structure: The parameters are meant to disable features, so setting the parameters to false activates the function. By default this setup disables auto gain controll and high pass filters while enabling echo cancellation and noise suppression

jitsi::containerized_server::disable_echo_cancellation: false
jitsi::containerized_server::disable_noise_supression: false
jitsi::containerized_server::disable_auto_gain_control: true
jitsi::containerized_server::disable_high_pass_filter: true

Starting additional containers

You can add additional container to compose process (like Jigasi, Jibri and Etherpad) using these parameters:

jitsi::containerized_server::compose_jigasi: false
jitsi::containerized_server::compose_jibri: false
jitsi::containerized_server::compose_etherpad: false

Notes

This is an experiment on how to handle standalone containerized applications.

Reference

Table of Contents

Classes

• jitsi::client: Install the Jitsi client
• jitsi::containerized_server: Install Jitsi as a containerized service

Classes

jitsi::client

On Linux hosts this class installs the specified version of the standalone electron client for jitsi as an AppImage package.

Examples

include jitsi::client

Parameters

The following parameters are available in the jitsi::client class:

• version
• checksum
• checksum_type

version

Data type: String

Which version to install. Find available versions on https://github.com/jitsi/jitsi-meet-electron/releases. The default of this parameter gets updated regularly. When overriding the default make sure you also set the corresponding values for checksum and checksum_type. This is used to ensure you actually downloaded the file you want to have.

checksum

Data type: String

Part of the release assets for the Jitsi client is the file latest-linux.yaml. It contains the checksum and its type. Note that the checksum is encoded and you have to decode and convert it:

echo $value_from_yaml | base64 -d | xxd -p

checksum_type

Data type: String

Which hashing algorithm is used to calculate the checksum of the AppImage. By default this is sha512.

jitsi::containerized_server

This class downloads definitions from https://github.com/jitsi/docker-jitsi-meet and performs basic settings to produce a simple working setup of jitsi. The code in the repository uses docker-compose to start the services as containers.

Examples

include jitsi::containerized_server

Parameters

The following parameters are available in the jitsi::containerized_server class:

• http_port
• https_port
• timezone
• public_url
• domain
• version
• jibri_domain
• enable_breakout_rooms
• disable_all_audio_processing
• disable_echo_cancellation
• disable_noise_supression
• disable_auto_gain_control
• disable_high_pass_filter
• jwt_app_id
• jwt_app_secret
• allow_guests
• disable_third_party_requests
• noisy_mic_detection
• video_resolution
• start_muted
• start_without_video
• enable_prejoin_page
• enable_simulcast
• require_display_name
• channel_last_n
• custom_variables
• compose_jigasi
• compose_jibri
• compose_etherpad

http_port

Data type: Integer

Set the port on which you can reach the web frontend via HTTP. Defaults to 30799. This is required in particular if you run Jitsi behin a reverse proxy.

https_port

Data type: Integer

Set the port on which you can reach the web frontend via HTTPS. Defaults to 30800.

timezone

Data type: String

Set the timezone, your jitsi instance is running in. Defaults to Europe/Amsterdam.

public_url

Data type: String

Set the URL where your users can reach the web frontend.

domain

Data type: String

FQDN of your jitsi instance.

version

Data type: String

version of the container images used

jibri_domain

Data type: String

If using jibri for recording or streaming, it enters the meeting as an additional user. If it has the domain given in this parameter it will actually be hidden.

enable_breakout_rooms

Data type: Boolean

Enables breakout rooms

disable_all_audio_processing

Data type: Boolean

Set to True if you want to disable all audio processing. Overrides all of the subsequent parameters.

disable_echo_cancellation

Data type: Boolean

Set to True if you want to disable echo cancellation.

disable_noise_supression

Data type: Boolean

Set to True if you want to disable noise suppression.

disable_auto_gain_control

Data type: Boolean

Set to True if you want to disable auto gain control.

disable_high_pass_filter

Data type: Boolean

Set to True if you want to disable high pass filtering.

jwt_app_id

Data type: String

Define an id for embedding into jwt based authentication

jwt_app_secret

Data type: String

Secret for use with JWT authentication

allow_guests

Data type: Integer

If guests access is allowed

disable_third_party_requests

Data type: Boolean

when set to true, no third parties like gravatar will be called (default)

noisy_mic_detection

Data type: Boolean

set to false if you want to disable the detection of noisy mics

video_resolution

Data type: Integer

set the preferred video resolution

start_muted

Data type: Boolean

use this to define if a user shall start muted (true) or with audio enabled (false)

start_without_video

Data type: Boolean

use this to define if a user shall start without video activatedf (true)

enable_prejoin_page

Data type: Boolean

the prejoin page is shown to users right before joining, asking for a name and the audio/video settings. Set this value to true if you want such a page

enable_simulcast

Data type: Boolean

Unsure about the actual effects.

require_display_name

Data type: Boolean

Set to true if you require your users to select a name

channel_last_n

Data type: Integer

This value can help to save bandwidth on the server. If set to a positive integer, only this amount of videostreams is sent, representing the last N speakers.

custom_variables

Data type: Optional[Hash[String, Variant[Integer, String, Boolean]]]

Add custom environment variables which are documented at https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-docker/

compose_jigasi

Data type: Boolean

Compose and start Jigasi container, the SIP (audio only) gateway.

compose_jibri

Data type: Boolean

Compose and start Jibri container, the broadcasting infrastructure.

compose_etherpad

Data type: Boolean

Compose and start Etherpad container, a real-time collaborative editor.

Changelog

All notable changes to this project will be documented in this file.

2.0.0

• use docker compose v2 PR #5 - requires puppetlabs-docker >= 10.0.0
• use extlib for password creation - pass no more secrets or passwords to the class

1.8.0

• new server parameter:
  • possibility to add custom parameters PR #1
  • trigger additional compose files PR #2
• bump server to stable-8218
• bump client to 2022.12.0

1.7.3

• bump server to stable-8044
• bump client to 2022.10.1

1.7.2

• bump server to stable-7577-2

1.7.1

• bump client to 2022.7.1

1.7.0

• control of server mainly determined by custom facts
• bump server to stable-6865
• bump client to 2022.2.1

1.6.1

extend REFERENCE for new parameters

1.6.0

add new configuration options for jitsi server and change some defaults for a better experience

1.5.0

Version bump: server to 6826

1.4.1

• bugfix version (wrong variable spelling)

1.4.0

• Version bump: client to 2022.1.1
• add configuration options reguarding audio and video quality

1.3.7

Version bump: server to 6726-1

1.3.6

Version bump: client to 2021.12.2

1.3.5

Version bump: client to 2021.12.1 (apparently they changed versioning scheme)

1.3.4

Version bump: server to release stable-6433, client to 2.9.0

1.3.3

Version bump: client to 2.8.11

1.3.3

Version bump: server to release 6173

1.3.1

Version bump: server to release 5963, client to 2.8.10

1.3.0

• version bump:
  • server to release 5870
  • client to 2.8.6

1.2.0

• add documentation

1.1.0

• remove hardcoded passwords

1.0.0

• newer versions of server and client, add jibri URL for hide jibri

0.3.0

• just newer versions of server and client

0.2.0

• add handling of noise quality

0.1.0

• first working release