jitsi
Version information
This version is compatible with:
- Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2016.4.x
- Puppet >= 4.10.0 < 7.0.0
- , ,
Start using this module
Add this module to your Puppetfile:
mod 'knoppi-jitsi', '1.3.0'
Learn more about managing modules with a PuppetfileDocumentation
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 it is required to define at least the XMPP secrets.
class { 'jitsi::containerized_server':
jicofo_component_secret => 84f617c4eacf104e70192fd76b970cc2,
jicofo_auth_password => 111139410e4b893aaab88d7bc405f760,
jvb_auth_password => cf766b3e73526a86963bc5083de2f880,
jigasi_xmpp_password => 7b115af382049d6b57e094d5fff0961a,
jibri_recorder_password => 58502b58498042df781f49882551848e,
jibri_xmpp_password => a402dd279a6f7bb21109532bb98e8863,
}
You can set all parameters using hiera:
classes:
- jitsi::containerized_server
jitsi::containerized_server::jicofo_component_secret: 84f617c4eacf104e70192fd76b970cc2
jitsi::containerized_server::jicofo_auth_password: 111139410e4b893aaab88d7bc405f760
jitsi::containerized_server::jvb_auth_password: cf766b3e73526a86963bc5083de2f880
jitsi::containerized_server::jigasi_xmpp_password: 7b115af382049d6b57e094d5fff0961a
jitsi::containerized_server::jibri_recorder_password: 58502b58498042df781f49882551848e
jitsi::containerized_server::jibri_xmpp_password: a402dd279a6f7bb21109532bb98e8863
To find suitable values you can determine them with any means, for instance openssl rand -hex 16
as the creators of the jitsi-docker-implementation recommend.
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.
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
Not 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
Notes
This is an experiment on how to handle standalone containerized applications.
Reference
Table of Contents
Classes
jitsi::client
: Install the Jitsi clientjitsi::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
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:
jicofo_component_secret
jicofo_auth_password
jvb_auth_password
jigasi_xmpp_password
jibri_recorder_password
jibri_xmpp_password
http_port
https_port
timezone
public_url
domain
version
jibri_domain
disable_all_audio_processing
disable_echo_cancellation
disable_noise_supression
disable_auto_gain_control
disable_high_pass_filter
jicofo_component_secret
Data type: String
(required) XMPP component password for Jicofo;
set it to random string as output by openssl rand -hex 16
jicofo_auth_password
Data type: String
(required) XMPP password for Jicofo client connections;
set it to random string as output by openssl rand -hex 16
jvb_auth_password
Data type: String
(required) XMPP password for JVB client connections;
set it to random string as output by openssl rand -hex 16
jigasi_xmpp_password
Data type: String
(required) XMPP password for Jigasi MUC client connections;
set it to random string as output by openssl rand -hex 16
jibri_recorder_password
Data type: String
(required) XMPP recorder password for Jibri client connections;
set it to random string as output by openssl rand -hex 16
jibri_xmpp_password
Data type: String
(required) XMPP password for Jibri client connections;
set it to random string as output by openssl rand -hex 16
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.
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.
Changelog
All notable changes to this project will be documented in this file.
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
Dependencies
- lwf/remote_file (>= 1.1.3 < 2.0)
- puppetlabs/vcsrepo (>= 3.2.0 < 5.0)
- puppetlabs/docker (>= 3.13.1 < 4.0)