Skip to content

Aux Docs

Jibri

`services.jibri.config`

Jibri configuration. See https://github.com/jitsi/jibri/blob/master/src/main/resources/reference.conf for default configuration with comments.

Type: HOCON value

Default

{ }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/jibri/default.nix

`services.jibri.enable`

Whether to enable Jitsi BRoadcasting Infrastructure. Currently Jibri must be run on a host that is also running {option}services.jitsi-meet.enable, so for most use cases it will be simpler to run {option}services.jitsi-meet.jibri.enable. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/jibri/default.nix

`services.jibri.finalizeScript`

This script runs when jibri finishes recording a video of a conference.

Type: path

Default

`#!nix pkgs.writeScript "finalize_recording.sh" ''''

!/bin/sh

RECORDINGS_DIR=$1

echo "This is a dummy finalize script" > /tmp/finalize.out echo "The script was invoked with recordings directory $RECORDINGS_DIR." >> /tmp/finalize.out echo "You should put any finalize logic (renaming, uploading to a service" >> /tmp/finalize.out echo "or storage provider, etc.) in this script" >> /tmp/finalize.out

exit 0 ''''; `

Example

`#!nix pkgs.writeScript "finalize_recording.sh" ''''

!/bin/sh

RECORDINGS_DIR=$1 ${pkgs.rclone}/bin/rclone copy $RECORDINGS_DIR RCLONE_REMOTE:jibri-recordings/ -v --log-file=/var/log/jitsi/jibri/recording-upload.txt exit 0 ''''; `

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/jibri/default.nix

`services.jibri.ignoreCert`

Whether to enable the flag "--ignore-certificate-errors" for the Chromium browser opened by Jibri. Intended for use in automated tests or anywhere else where using a verified cert for Jitsi-Meet is not possible.

Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/jibri/default.nix

`services.jibri.xmppEnvironments`

XMPP servers to connect to.

Type: attribute set of (submodule)

Default

{ }

Example

`#!nix "jitsi-meet" = { xmppServerHosts = [ "localhost" ]; xmppDomain = config.services.jitsi-meet.hostName;

control.muc = { domain = "internal.${config.services.jitsi-meet.hostName}"; roomName = "JibriBrewery"; nickname = "jibri"; };

control.login = { domain = "auth.${config.services.jitsi-meet.hostName}"; username = "jibri"; passwordFile = "/var/lib/jitsi-meet/jibri-auth-secret"; };

call.login = { domain = "recorder.${config.services.jitsi-meet.hostName}"; username = "recorder"; passwordFile = "/var/lib/jitsi-meet/jibri-recorder-secret"; };

usageTimeout = "0"; disableCertificateVerification = true; stripFromRoomDomain = "conference."; }; `

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/jibri/default.nix

`services.jibri.xmppEnvironments.<name>.call.login.domain`

The domain part of the JID for the recorder.

Type: string

Example

"recorder.xmpp.example.org"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/jibri/default.nix

`services.jibri.xmppEnvironments.<name>.call.login.passwordFile`

File containing the password for the user.

Type: string

Example

"/run/keys/jibri-recorder-xmpp1"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/jibri/default.nix

`services.jibri.xmppEnvironments.<name>.call.login.username`

User part of the JID for the recorder.

Type: string

Default

"recorder"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/jibri/default.nix

`services.jibri.xmppEnvironments.<name>.control.login.domain`

The domain part of the JID for this Jibri instance.

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/jibri/default.nix

`services.jibri.xmppEnvironments.<name>.control.login.passwordFile`

File containing the password for the user.

Type: string

Example

"/run/keys/jibri-xmpp1"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/jibri/default.nix

`services.jibri.xmppEnvironments.<name>.control.login.username`

User part of the JID.

Type: string

Default

"jvb"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/jibri/default.nix

`services.jibri.xmppEnvironments.<name>.control.muc.domain`

The domain part of the MUC to connect to for control.

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/jibri/default.nix

`services.jibri.xmppEnvironments.<name>.control.muc.nickname`

The nickname for this Jibri instance in the MUC.

Type: string

Default

"jibri"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/jibri/default.nix

`services.jibri.xmppEnvironments.<name>.control.muc.roomName`

The room name of the MUC to connect to for control.

Type: string

Default

"JibriBrewery"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/jibri/default.nix

`services.jibri.xmppEnvironments.<name>.disableCertificateVerification`

Whether to skip validation of the server's certificate.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/jibri/default.nix

`services.jibri.xmppEnvironments.<name>.stripFromRoomDomain`

The prefix to strip from the room's JID domain to derive the call URL.

Type: string

Default

"0"

Example

"conference."

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/jibri/default.nix

`services.jibri.xmppEnvironments.<name>.usageTimeout`

The duration that the Jibri session can be. A value of zero means indefinitely.

Type: string

Default

"0"

Example

"1 hour"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/jibri/default.nix

`services.jibri.xmppEnvironments.<name>.xmppDomain`

The base XMPP domain.

Type: string

Example

"xmpp.example.org"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/jibri/default.nix

`services.jibri.xmppEnvironments.<name>.xmppServerHosts`

Hostnames of the XMPP servers to connect to.

Type: list of string

Example

["xmpp.example.org"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/jibri/default.nix