quick-jibri-installer/README.md

121 lines
4.5 KiB
Markdown
Raw Normal View History

2018-09-25 08:21:25 +00:00
# Quick Jibri Installer
2021-05-03 18:18:37 +00:00
Bash installer for Jitsi Meet standalone along with Jibri on supported **Ubuntu LTS** based systems using **nginx** as default webserver.
2018-09-25 08:21:25 +00:00
## Usage
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.
**WARNING:** Please, avoid using this installer on your everyday GNU/Linux system, as this is an unsupported use and it will likely BREAK YOUR SYSTEM, so please don't.
### Main Server
Login into your clean server, clone git repository and run the installer,
```
git clone https://github.com/switnet-ltd/quick-jibri-installer
cd quick-jibri-installer
bash quick-jibri-installer.sh
```
2021-05-03 18:17:00 +00:00
If your server meet the necessary resources, then at the end on the installer you should have a working Jitsi Meet Server along with a Jibri server ready to record.
Additional jibris need to be set on separate servers, only necesary on simultaneous recordings for that please use add-jibri-node.sh.
### 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
**WARNING:** This file contains sensitive information from your setup, please handle with care.
```
bash add-jibri-node.sh
```
2021-05-03 18:17:00 +00:00
Please remember that on newer versions, jibri will record on FHD (1920x1080) so please make sure your server have enough CPU power in orther to handle the encoding load.
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
```
Check more details on our wiki.
2020-04-13 18:52:22 +00:00
## Requirements
2021-05-16 21:18:51 +00:00
1. Clean VM/VPS/Server using a supported Ubuntu LTS
2. Valid domain with DNS record, **mandatory** for SSL certs via Let's Encrypt.
3. open ports for JMS interaction, [see wiki](https://github.com/switnet-ltd/quick-jibri-installer/wiki/Firewall).
4. Starting at 8 GB RAM / 4 Cores @ ~3.0GHz
* Adding resources as your audience or features you require, so your experience don't suffer from the lack of resources.
5. Webcam
2020-04-13 18:52:22 +00:00
2021-05-16 21:18:51 +00:00
### Jibri Recodings Access via Nextcloud
* Valid domain with DNS record for Nextcloud SSL.
### Jigasi Transcript (stalled)
* SIP account
* Google Cloud Account with Billing setup.
2021-05-16 21:18:51 +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.
2018-09-25 08:21:25 +00:00
## Features
2021-05-16 21:18:51 +00:00
* Enabled Session Recording via Jibri
* Rename Jibri folder with name room + date.
* Jibri node network.
* Automatic Jibri nodes network sync ([see more](https://github.com/switnet-ltd/quick-jibri-installer/wiki/Setup-and-Jibri-Nodes)).
2020-07-20 03:50:54 +00:00
* JRA (Jibri Recordings Access) via Nextcloud
2021-05-16 21:18:51 +00:00
* Grafana Dashboard
* Etherpad via docker install
* Authentication
1. Local
2. JWT
3. None
* Lobby Rooms
* Conference Duration
2020-09-10 04:23:49 +00:00
* Customized brandless mode
2021-04-28 16:23:46 +00:00
* Setting up custom interface_config.js (to be deprecated by upstream)
2021-04-18 19:18:47 +00:00
* JVB2 nodes network.
2021-05-16 21:18:51 +00:00
* Enabled Jitsi Electron app detection server side.
* Standalone SSL Certbot/LE implementation
* Improved recurring updater
* Jigasi Transcript - Speech to Text powered by Google API (stalled)
2018-09-25 08:21:25 +00:00
2021-04-18 19:18:47 +00:00
## Tools
2020-12-22 00:30:51 +00:00
* Jibri Environment Tester
* Jibri Conf Upgrader (late 2020).
2021-04-18 19:18:47 +00:00
* Selenium Grid via Docker
2021-05-16 21:18:51 +00:00
* Start over, installation cleansing tool.
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
2021-04-28 16:23:46 +00:00
* Option to enable Welcome page
* Option to enable Close page
* Option to set domain as hostname on JMS
2020-04-14 03:22:00 +00:00
2020-12-20 06:40:03 +00:00
### Modes
2021-04-18 19:18:47 +00:00
* Custom High Performance config
2020-12-20 06:40:03 +00:00
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
2021-04-28 21:32:28 +00:00
* Set pre-join screen by default.
2021-04-28 16:23:46 +00:00
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
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
2021-04-28 16:23:46 +00:00
SwITNet Ltd © - 2021, https://switnet.net/