2018-09-25 08:21:25 +00:00
# Quick Jibri Installer
2020-10-08 15:38:39 +00:00
Bash installer for Jibri on **Ubuntu LTS** based systems using **nginx** as default webserver.
2018-09-25 08:21:25 +00:00
2020-06-30 06:41:38 +00:00
## Usage
2020-10-08 15:38:39 +00:00
As for our current latest release, as we have integrated more and more features, we highly recommend to use a purpose specific-newly spawn server to host the jitsi-meet framework, making sure you stick to the requirements and recommendations as much as possible, in order to avoid issues.
### Main Server
Login into your clean server, clone git repository and run the installer,
2020-06-30 06:41:38 +00:00
```
git clone https://github.com/switnet-ltd/quick-jibri-installer
cd quick-jibri-installer
bash quick-jibri-installer.sh
```
2020-10-08 15:38:39 +00:00
### Add Jibri node
2021-01-05 07:09:54 +00:00
Copy the modified `add-jibri-node.sh` file from your early cloned installation directory once the installation is completed, to the new server meant to be a jibri node using your preferred method, then run it
2020-10-08 15:38:39 +00:00
**WARNING:** This file contains sensitive information from your setup, please handle with care.
```
bash add-jibri-node.sh
```
2021-01-05 07:09:54 +00:00
### Add JVB2 node
Copy the modified `add-jvb2-node.sh` file from your early cloned installation directory once the installation is completed, to the new server meant to be a jibri node using your preferred method, then run it
**WARNING:** This file contains sensitive information from your setup, please handle with care.
```
bash add-jvb2-node.sh
```
2020-10-08 15:38:39 +00:00
Check more details on our wiki.
2020-06-30 06:41:38 +00:00
2020-04-13 18:52:22 +00:00
## Requirements
* Clean VM/VPS/Server using Ubuntu LTS
2020-04-14 03:22:00 +00:00
* Valid domain with DNS record, **mandatory** for SSL certs via Let's Encrypt.
* Ports open for ACME (SSL) interaction & validation.
2020-10-08 15:38:39 +00:00
* Highly recommended: 8 GB RAM / 4 Cores.
2020-04-13 18:52:22 +00:00
* Webcam
2020-06-30 06:41:38 +00:00
### Jigasi Transcript
* SIP account
* Google Cloud Account with Billing setup.
2020-10-08 15:38:39 +00:00
2020-06-30 06:41:38 +00:00
### Jibri Recodings Access via Nextcloud
* Valid domain with DNS record for Nextcloud SSL.
2020-10-08 15:38:39 +00:00
## Kernel warning
For AWS users or any cloud service provider that might use their own kernel on their products (servers/vm/vps), might cause Jibri failure to start due not allowing `snd_aloop` module.
Make sure that you update your grub to boot the right one.
2020-12-22 00:30:51 +00:00
Feel free to use our `test-jibri-env.sh` tool to find some details on your current setup.
2020-06-30 06:41:38 +00:00
2018-09-25 08:21:25 +00:00
## Features
2020-10-08 15:38:39 +00:00
* Enabled Session Recording using Jibri
2018-11-06 04:43:41 +00:00
* Enabled Jitsi Electron app detection server side.
2019-04-03 18:12:41 +00:00
* Standalone SSL Certbot/LE implementation
2020-04-11 10:20:42 +00:00
* Jigasi Transcript - Speech to Text powered by Google API
2020-07-20 03:50:54 +00:00
* JRA (Jibri Recordings Access) via Nextcloud
* Improved recurring updater
2020-09-10 04:23:49 +00:00
* Customized brandless mode
2020-10-08 15:38:39 +00:00
* Setting up custom interface_config.js
* Grafana Dashboard
2021-01-05 07:09:54 +00:00
* Lobby Rooms via
* Local (Secure Rooms) auth
* JWT auth
* None
* Conference Duration via
* Local (Secure Rooms) auth
* JWT auth
* None
2020-12-20 06:40:03 +00:00
* Automatic Jibri nodes network sync ([see more](https://github.com/switnet-ltd/quick-jibri-installer/wiki/Setup-and-Jibri-Nodes)).
* (New) JVB2 nodes network.
* (New) JWT auth.
2018-09-25 08:21:25 +00:00
2020-10-08 15:38:39 +00:00
## Tools (New)
2020-12-22 00:30:51 +00:00
* Jibri Environment Tester
* Jibri Conf Upgrader (late 2020).
2020-12-20 06:40:03 +00:00
* (New) Selenium Grid via Docker
2018-09-25 08:21:25 +00:00
2020-04-14 03:22:00 +00:00
## Optional custom changes
* Optional default language
* Option to enable Secure Rooms
* Option to enable Welcome Page
2020-12-20 06:40:03 +00:00
### Modes
* (New) Custom High Performance config
2019-02-25 06:15:25 +00:00
## Custom changes
2019-03-04 12:31:34 +00:00
* Start with video muted by default
* Start with audio muted but moderator
2019-04-03 18:12:41 +00:00
* Set displayname as not required since jibri can't set it up.
2020-09-10 04:23:49 +00:00
* Disabled BETA Blur my background
2019-02-25 06:15:25 +00:00
2020-04-14 03:22:00 +00:00
## Documentation
2020-09-10 04:23:49 +00:00
* Please check our [wiki ](https://github.com/switnet-ltd/quick-jibri-installer/wiki ) for further documentation.
2020-04-14 03:22:00 +00:00
2018-11-06 04:43:41 +00:00
Please note: This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY.
2018-09-25 08:21:25 +00:00
2020-04-11 10:20:42 +00:00
SwITNet Ltd © - 2020, https://switnet.net/
