BigBlueButton/bigbluebutton-Github
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #19302 from antobinary/docs-30

Browse Source 
docs: init changes for BBB 3.0
This commit is contained in:
Anton Georgiev 2023-12-07 15:31:45 -05:00 committed by GitHub
commit eb74f0e8a8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 715 additions and 9275 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
docs/README.md
View File

@ -5,11 +5,34 @@ and GitHub Actions (see [deploy-docs.yml](../.github/workflows/deploy-docs.yml))
## Local Development
To test build the docs locally you can either use `yarn` or `npm`.
To test build the docs locally use:
```bash
$ npm ci # install docusaurus and dependencies (based on the package-lock.json file)
$ npx docusaurus start # start local dev server
```
By default `docusaurus.config.js` contains instructions for the building of a few extra branches. You may want to drop all but the current branch. For example:
```
$ yarn install # install docusaurus and dependencies
$ yarn start # start local dev server
diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
index 50b72b12ec..04f360a955 100644
--- a/docs/docusaurus.config.js
+++ b/docs/docusaurus.config.js
@@ -38,12 +38,6 @@ const config = {
lastVersion: '2.7',
includeCurrentVersion: false,
versions: {
- '2.5-legacy': {
- banner: 'none'
- },
- '2.6': {
- banner: 'none'
- },
'2.7': {
banner: 'none'
},
```
The last command starts a local development server and opens up a browser window.
@ -23,15 +46,15 @@ otherwise git will refuse to change branches.
This step is optional and if you don't run it, docusaurus will only build the
currently checkout out version which is recommended for local development
(building all the versions locally can lead to problems with the live
updates when using `yarn start`).
updates when using `npx docusaurus start`).
### Build
If you only want to build the docs you can run:
```
$ yarn clear # ensure cached content is not interfering with your changes
$ yarn build
$ npm clear # ensure cached content is not interfering with your changes
$ npx docusaurus build
```
This command generates static content into the `build` directory
@ -44,7 +67,7 @@ in development or when building the docs.
To avoid this you can run:
```
$ yarn clear # ensure cached content is not interfering with your changes
$ npx docusaurus clear # ensure cached content is not interfering with your changes
$ rm -r versioned_docs versioned_sidebars versions.json # if you build multiple versions
```

170
docs/docs/administration/install.md
View File

@ -1,18 +1,9 @@
---
id: install
slug: /administration/install
title: Install BigBlueButton
sidebar_position: 1
description: Install BigBlueButton
keywords:
- install
---
We have tools to make it easy for you, a system administrator, to install BigBlueButton on a dedicated linux server. This document shows you how to install.
## Before you install
We recommend installing BigBlueButton with a 'clean' and dedicated Ubuntu 20.04 64-bit server with no prior software installed. If you want to upgrade from an earlier version of BigBlueButton like 2.4, we recommend setting up a clean server for BigBlueButton 2.7 on Ubuntu 20.04 and, after setup, [migrate over your existing recordings](/administration/customize#transfer-published-recordings-from-another-server). We support upgrading a BigBlueButton 2.5 or 2.6 server to 2.7.
We recommend installing BigBlueButton with a 'clean' and dedicated Ubuntu 22.04 64-bit server with no prior software installed. If you want to upgrade from an earlier version of BigBlueButton like 2.7, we recommend setting up a clean server for BigBlueButton 3.0 on Ubuntu 22.04 and, after setup, [migrate over your existing recordings](/administration/customize#transfer-published-recordings-from-another-server).
A 'clean' server does not have any previous web servers installed (such as apache) or web applications (such as plesk or webadmin) that are [binding to port 80/443](/support/faq#we-recommend-running-bigbluebutton-on-port-80443). By 'dedicated' we mean that this server won't be used for anything else besides BigBlueButton (and possibly BigBlueButton-related applications such as [Greenlight](/greenlight/v3/install)).
@ -20,7 +11,7 @@ A 'clean' server does not have any previous web servers installed (such as apach
For production, we recommend the following minimum requirements
- Ubuntu 20.04 64-bit OS running Linux kernel 5.x
- Ubuntu 22.04 64-bit OS running Linux kernel 5.x
- Latest version of docker installed
- 16 GB of memory with swap enabled
- 8 CPU cores, with high single-thread performance
@ -45,7 +36,7 @@ Regardless of your environment, the setup steps will include configuring a SSL c
### Pre-installation checks
Got a Ubuntu 20.04 64-bit server ready for installation? Great! But, before jumping into the installation section below, let's do a few quick configuration checks to make sure your server meets the minimum requirements.
Got a Ubuntu 22.04 64-bit server ready for installation? Great! But, before jumping into the installation section below, let's do a few quick configuration checks to make sure your server meets the minimum requirements.
Doing these checks will significantly reduce the chances you'll hit a problem during installation.
@ -90,17 +81,17 @@ Here it shows 15G of memory (that's close enough as the server has 16 gigabytes
If you see a value for `Mem:` in the `total` column less than 15G, then your server has insufficient memory to run BigBlueButton in production. You need to increase the server's memory to (at least) 16G. (As stated above, if your running this in a development environment, 8G is fine.)
Next, check that the server has Ubuntu is 20.04 as its operating system.
Next, check that the server has Ubuntu is 22.04 as its operating system.
```bash
$ cat /etc/lsb-release
DISTRIB_ID=Ubuntu
DISTRIB_RELEASE=20.04
DISTRIB_CODENAME=focal
DISTRIB_DESCRIPTION="Ubuntu 20.04.4 LTS"
DISTRIB_RELEASE=22.04
DISTRIB_CODENAME=jammy
DISTRIB_DESCRIPTION="Ubuntu 22.04.3 LTS"
```
Next, check that your server is running the 64-bit version of Ubuntu 20.04.
Next, check that your server is running the 64-bit version of Ubuntu 22.04.
```bash
$ uname -m
@ -121,7 +112,7 @@ Next, check that your server is running Linux kernel 5.x.
```bash
$ uname -r
5.4.x-xx-generic
5.15.x-xx-generic
```
Next, check that your server has (at least) 8 CPU cores
@ -151,13 +142,13 @@ sudo ufw allow 80
sudo ufw allow 443
```
Sometimes we get asked "Why are you only supporting Ubuntu 20.04 64-bit?". The answer is based on choosing quality over quantity. Long ago we concluded that its better for the project to have solid, well-tested, well-documented installation for a specific version of Linux that works really, really well than to try and support may variants of Linux and have none of them work well.
Sometimes we get asked "Why are you only supporting Ubuntu 22.04 64-bit?". The answer is based on choosing quality over quantity. Long ago we concluded that its better for the project to have solid, well-tested, well-documented installation for a specific version of Linux that works really, really well than to try and support may variants of Linux and have none of them work well.
At the moment, the requirement for docker may preclude running 2.7 within some virtualized environments; however, it ensures libreoffice runs within a restricted sandbox for document conversion. We are exploring if we can run libreoffice within systemd (such as systemd-nspawn).
At the moment, the requirement for docker may preclude running 3.0 within some virtualized environments; however, it ensures libreoffice runs within a restricted sandbox for document conversion. We are exploring if we can run libreoffice within systemd (such as systemd-nspawn).
## Install
To install BigBlueButton, use [bbb-install.sh](https://github.com/bigbluebutton/bbb-install/blob/v2.7.x-release/bbb-install.sh) script. Notice that this command is slightly different than what we recommended in previous versions of BigBlueButton. The script now resides on a branch specifying the version of BigBlueButton, but otherwise the name of the script is identical accross different branches. This makes it more maintainable as patches done to the script in one branch can be easily applied to other branches.
To install BigBlueButton, use [bbb-install.sh](https://github.com/bigbluebutton/bbb-install/blob/v3.0.x-release/bbb-install.sh) script. Notice that this command is slightly different than what we recommended in previous versions of BigBlueButton. The script now resides on a branch specifying the version of BigBlueButton, but otherwise the name of the script is identical accross different branches. This makes it more maintainable as patches done to the script in one branch can be easily applied to other branches.
The above link gives detailed information on using the script. As an example, passing several arguments to the script you can easily have both BigBlueButton and Greenlight or LTI installed on the same server. You could specify if you would like a new certificate to be generated. A firewall could be enabled. For the most up-to-date information, please refer to the instructions in the script. Notice that as of BigBlueButton 2.6 we have retired the API demos. We recommend using Greenlight or [API MATE](https://mconf.github.io/api-mate/) instead.
@ -169,21 +160,20 @@ After the `bbb-install.sh` script finishes, you can check the status of your ser
$ sudo bbb-conf --check
root@test27:~# bbb-conf --check
BigBlueButton Server 2.7.0-alpha.1 (114)
Kernel version: 5.4.0-122-generic
Distribution: Ubuntu 20.04.6 LTS (64-bit)
Memory: 8148 MB
BigBlueButton Server 3.0.0-alpha.1 (68)
Kernel version: 5.15.0-67-generic
Distribution: Ubuntu 22.04.3 LTS (64-bit)
Memory: 8140 MB
CPU cores: 4
/etc/bigbluebutton/bbb-web.properties (override for bbb-web)
/usr/share/bbb-web/WEB-INF/classes/bigbluebutton.properties (bbb-web)
bigbluebutton.web.serverURL: https://test27.bigbluebutton.org
bigbluebutton.web.serverURL: https://test30.bigbluebutton.org
defaultGuestPolicy: ALWAYS_ACCEPT
defaultMeetingLayout: CUSTOM_LAYOUT
/etc/nginx/sites-available/bigbluebutton (nginx)
server_name: test27.bigbluebutton.org
server_name: dev30.bigbluebutton.org
port: 80, [::]:80127.0.0.1:82 http2 proxy_protocol, [::1]:82 http2127.0.0.1:81 proxy_protocol, [::1]:81
/opt/freeswitch/etc/freeswitch/vars.xml (FreeSWITCH)
@ -200,14 +190,13 @@ BigBlueButton Server 2.7.0-alpha.1 (114)
UDP port ranges
FreeSWITCH: 16384-24576
kurento: 24577-32768
bbb-webrtc-sfu: 24577-32768
bbb-webrtc-recorder: 24577-32768
bbb-webrtc-sfu: null-null
bbb-webrtc-recorder: null-null
/usr/local/bigbluebutton/core/scripts/bigbluebutton.yml (record and playback)
playback_host: test27.bigbluebutton.org
playback_host: dev30.bigbluebutton.org
playback_protocol: https
ffmpeg: 4.2.7-0ubuntu0.1
ffmpeg: 4.4.2-0ubuntu0.22.04.1
/usr/share/bigbluebutton/nginx/sip.nginx (sip.nginx)
proxy_pass: 143.198.37.212
@ -217,8 +206,6 @@ UDP port ranges
/etc/bigbluebutton/bbb-webrtc-sfu/production.yml (bbb-webrtc-sfu - override)
mediasoup.webrtc.*.announcedIp: 143.198.37.212
mediasoup.plainRtp.*.announcedIp: 143.198.37.212
kurento.ip: 143.198.37.212
kurento.url: ws://127.0.0.1:8888/kurento
freeswitch.sip_ip: 143.198.37.212
recordingAdapter: Kurento
recordScreenSharing: true
@ -234,7 +221,7 @@ UDP port ranges
/usr/share/meteor/bundle/programs/server/assets/app/config/settings.yml (HTML5 client)
/etc/bigbluebutton/bbb-html5.yml (HTML5 client config override)
build: 13
kurentoUrl: wss://test27.bigbluebutton.org/bbb-webrtc-sfu
kurentoUrl: wss://test30.bigbluebutton.org/bbb-webrtc-sfu
defaultFullAudioBridge: fullaudio
defaultListenOnlyBridge: fullaudio
sipjsHackViaWs: true
@ -250,27 +237,30 @@ You can also use `sudo bbb-conf --status` to check that all the BigBlueButton pr
```bash
$ sudo bbb-conf --status
nginx —————————————————► [✔ - active]
freeswitch ————————————► [✔ - active]
redis-server ——————————► [✔ - active]
bbb-apps-akka —————————► [✔ - active]
bbb-fsesl-akka ————————► [✔ - active]
mongod ————————————————► [✔ - active]
bbb-html5 —————————————► [✔ - active]
bbb-html5-backend@1 ———► [✔ - active]
bbb-html5-backend@2 ———► [✔ - active]
bbb-html5-frontend@1 ——► [✔ - active]
bbb-html5-frontend@2 ——► [✔ - active]
bbb-webrtc-sfu ————————► [✔ - active]
bbb-webrtc-recorder ———► [✔ - active]
kurento-media-server ——► [✔ - active]
etherpad ——————————————► [✔ - active]
bbb-web ———————————————► [✔ - active]
bbb-pads ——————————————► [✔ - active]
bbb-export-annotations ► [✔ - active]
bbb-rap-caption-inbox —► [✔ - active]
bbb-rap-resque-worker —► [✔ - active]
bbb-rap-starter ———————► [✔ - active]
nginx ————————————————————————————————► [✔ - active]
freeswitch ———————————————————————————► [✔ - active]
redis-server —————————————————————————► [✔ - active]
bbb-apps-akka ————————————————————————► [✔ - active]
bbb-fsesl-akka ———————————————————————► [✔ - active]
mongod ———————————————————————————————► [✔ - active]
bbb-html5 ————————————————————————————► [✔ - active]
bbb-html5-backend@1 ——————————————————► [✔ - active]
bbb-html5-backend@2 ——————————————————► [✔ - active]
bbb-html5-frontend@1 —————————————————► [✔ - active]
bbb-html5-frontend@2 —————————————————► [✔ - active]
bbb-graphql-actions-adapter-server ———► [✔ - active]
bbb-graphql-middleware ———————————————► [✔ - active]
bbb-graphql-server ———————————————————► [✔ - active]
bbb-webrtc-sfu ———————————————————————► [✔ - active]
bbb-webrtc-recorder ——————————————————► [✔ - active]
etherpad —————————————————————————————► [✔ - active]
bbb-web ——————————————————————————————► [✔ - active]
bbb-pads —————————————————————————————► [✔ - active]
bbb-export-annotations ———————————————► [✔ - active]
bbb-rap-caption-inbox ————————————————► [✔ - active]
bbb-rap-resque-worker ————————————————► [✔ - active]
bbb-rap-starter ——————————————————————► [✔ - active]
```
@ -278,25 +268,29 @@ You can also use `dpkg -l | grep bbb-` to list all the core BigBlueButton packag
```bash
# dpkg -l | grep bbb-
ii bbb-apps-akka 1:2.7-10 all BigBlueButton Apps (Akka)
ii bbb-config 1:2.7-14 amd64 BigBlueButton configuration utilities
ii bbb-etherpad 1:2.7-4 amd64 The EtherPad Lite components for BigBlueButton
ii bbb-export-annotations 1:2.7-7 amd64 BigBlueButton Export Annotations
ii bbb-freeswitch-core 2:2.7-3 amd64 BigBlueButton build of FreeSWITCH
ii bbb-freeswitch-sounds 1:2.7-3 amd64 FreeSWITCH Sounds
ii bbb-fsesl-akka 1:2.7-7 all BigBlueButton FS-ESL (Akka)
ii bbb-html5 1:2.7-13 amd64 The HTML5 components for BigBlueButton
ii bbb-html5-nodejs 1:2.7-4 amd64 Include a specific NodeJS version for bbb-html5
ii bbb-learning-dashboard 1:2.7-5 amd64 BigBlueButton bbb-learning-dashboard
ii bbb-libreoffice-docker 1:2.7-2 amd64 BigBlueButton setup for LibreOffice running in docker
ii bbb-mkclean 1:2.7-3 amd64 Clean and optimize Matroska and WebM files
ii bbb-pads 1:2.7-6 amd64 BigBlueButton Pads
ii bbb-playback 1:2.7-4 amd64 BigBlueButton playback
ii bbb-playback-presentation 1:2.7-3 amd64 BigBluebutton playback of presentation
ii bbb-record-core 1:2.7-4 amd64 BigBlueButton record and playback
ii bbb-web 1:2.7-8 amd64 BigBlueButton API
ii bbb-webrtc-recorder 1:2.7-2 amd64 BigBlueButton WebRTC Recorder
ii bbb-webrtc-sfu 1:2.7-9 amd64 BigBlueButton WebRTC SFU
ii bbb-apps-akka 1:3.0-7 all BigBlueButton Apps (Akka)
ii bbb-config 1:3.0-8 amd64 BigBlueButton configuration utilities
ii bbb-etherpad 1:3.0-1 amd64 The EtherPad Lite components for BigBlueButton
ii bbb-export-annotations 1:3.0-2 amd64 BigBlueButton Export Annotations
ii bbb-freeswitch-core 2:3.0-1 amd64 BigBlueButton build of FreeSWITCH
ii bbb-freeswitch-sounds 1:3.0-1 amd64 FreeSWITCH Sounds
ii bbb-fsesl-akka 1:3.0-5 all BigBlueButton FS-ESL (Akka)
ii bbb-graphql-actions-adapter-server 1:3.0-4 amd64 BigBlueButton GraphQL Actions Adapter Server
ii bbb-graphql-middleware 1:3.0-6 amd64 GraphQL middleware component for BigBlueButton
ii bbb-graphql-server 1:3.0-5 amd64 GraphQL server component for BigBlueButton
ii bbb-html5 1:3.0-10 amd64 The HTML5 components for BigBlueButton
ii bbb-html5-nodejs 1:3.0-1 amd64 Include a specific NodeJS version for bbb-html5
ii bbb-learning-dashboard 1:3.0-1 amd64 BigBlueButton bbb-learning-dashboard
ii bbb-libreoffice-docker 1:3.0-1 amd64 BigBlueButton setup for LibreOffice running in docker
ii bbb-mkclean 1:3.0-1 amd64 Clean and optimize Matroska and WebM files
ii bbb-pads 1:3.0-1 amd64 BigBlueButton Pads
ii bbb-playback 1:3.0-1 amd64 Player for BigBlueButton presentation format recordings
ii bbb-playback-presentation 1:3.0-1 amd64 BigBlueButton presentation recording format
ii bbb-record-core 1:3.0-1 amd64 BigBlueButton record and playback
ii bbb-web 1:3.0-6 amd64 BigBlueButton API
ii bbb-webrtc-recorder 1:3.0-1 amd64 BigBlueButton WebRTC Recorder
ii bbb-webrtc-sfu 1:3.0-1 amd64 BigBlueButton WebRTC SFU
```
@ -323,23 +317,15 @@ The link to API-Mate will open a page at [https://mconf.github.io/api-mate/](htt
Do you have a firewall between you and your users? If so, see [configuring your firewall](/administration/firewall-configuration).
### Upgrading BigBlueButton 2.7
### Upgrading BigBlueButton 3.0
You can upgrade by re-running the `bbb-install.sh` script again -- it will download and install the latest release of BigBlueButton 2.7.
You can upgrade by re-running the `bbb-install.sh` script again -- it will download and install the latest release of BigBlueButton 3.0.
### Upgrading from BigBlueButton 2.5 or 2.6
### Upgrading from BigBlueButton 2.6 or 2.7
You can upgrade in a few steps:
If you are upgrading BigBlueButton 2.6 or 2.7 we recommend you set up a new Ubuntu 22.04 server with BigBlueButton 3.0 and then [copy over your existing recordings from the old server](/administration/customize#transfer-published-recordings-from-another-server).
Make sure you don't have `bbb-demo` installed `sudo apt purge bbb-demo`
Then run the `bbb-install.sh` script -- it will download and install the latest release of BigBlueButton 2.7 on top of your old 2.5 version.
Make sure you read through the "what's new in 2.7" document <https://docs.bigbluebutton.org/2.7/new> and specifically <https://docs.bigbluebutton.org/2.7/new#other-notable-changes>
### Upgrading from BigBlueButton 2.4
If you are upgrading BigBlueButton 2.4 or 2.3 we recommend you set up a new Ubuntu 20.04 server with BigBlueButton 2.7 and then [copy over your existing recordings from the old server](/administration/customize#transfer-published-recordings-from-another-server).
Make sure you read through the "what's new in 3.0" document https://docs.bigbluebutton.org/3.0/new and especifically https://docs.bigbluebutton.org/3.0/new#other-notable-changes
### Restart your server
@ -367,7 +353,7 @@ If this server is intended for production, you should also
We provide publically accessible servers that you can use for testing:
- [https://demo.bigbluebutton.org](https://demo.bigbluebutton.org/) - a pool of BigBlueButton servers with the Greenlight front-end (sometimes the pool is a mix of different BigBlueButton releases)
- [https://test27.bigbluebutton.org](https://test27.bigbluebutton.org) - Runs the general build of BigBlueButton 2.7 - usually a few days behind the repository branch `v2.7.x-release`
- [https://test30.bigbluebutton.org](https://test30.bigbluebutton.org) - Runs the general build of BigBlueButton 3.0 - usually a few days behind the repository branch `v3.0.x-release`
To learn more about integrating BigBlueButton with your application, check out the [BigBlueButton API documentation](/development/api). To see videos of BigBlueButton HTML5 client, see [https://bigbluebutton.org/html5](https://bigbluebutton.org/html5).
@ -427,7 +413,7 @@ dpkg: error processing package bbb-libreoffice-docker (--configure):
installed bbb-libreoffice-docker package post-installation script subprocess returned error exit status 100
```
Ubuntu 20.04 uses systemd-resolved, which presents a local caching resolver and registers this at `/etc/resolv.conf`. If you get they above error and have a local name server, such as `10.11.12.13`, then try adding it with the hosts `resolv.conf`.
Ubuntu 22.04 uses systemd-resolved, which presents a local caching resolver and registers this at `/etc/resolv.conf`. If you get they above error and have a local name server, such as `10.11.12.13`, then try adding it with the hosts `resolv.conf`.
```
echo "nameserver 10.11.12.13" > /etc/resolv.conf
@ -437,4 +423,4 @@ For more details see [this issue](https://github.com/bigbluebutton/bbb-install/i
## Feedback and reporting bugs
If you found a reproducible bug, please report it in the [GitHub Issues section](https://github.com/bigbluebutton/bigbluebutton/issues) with steps to reproduce (this will make it easier for the developers to fix the bug). Indicate in the body of the bug report that this applies to BigBlueButton 2.7 and give us the client build number, which you can find either with `dpkg -l | grep bbb-html5` or within the client in the `Settings -> About` menu..
If you found a reproducible bug, please report it in the [GitHub Issues section](https://github.com/bigbluebutton/bigbluebutton/issues) with steps to reproduce (this will make it easier for the developers to fix the bug). Indicate in the body of the bug report that this applies to BigBlueButton 3.0 and give us the client build number, which you can find either with `dpkg -l | grep bbb-html5` or within the client in the `Settings -> About` menu..

2
docs/docs/administration/privacy.md
View File

@ -237,7 +237,7 @@ In Greenlight, room URLs contain the username of the owner, which might also be
### Terms of Service
Greenlight supports displaying of terms and conditions for registered users or upon registration. See [adding-terms-and-conditions](/greenlight/config#adding-terms-and-conditions)
Greenlight supports displaying of terms and conditions for registered users or upon registration.
### All recordings are always accessible

3
docs/docs/development/api.md
View File

@ -107,6 +107,9 @@ Updated in 2.7:
- **create** - **Added:** `preUploadedPresentation`, `preUploadedPresentationName`, `disabledFeatures` options`cameraAsContent`, `snapshotOfCurrentSlide`, `downloadPresentationOriginalFile`, `downloadPresentationConvertedToPdf`, `timer`.
- **join** - **Added:** `redirectErrorUrl`, `userdata-bbb_fullaudio_bridge`
Updated in 3.0:
## API Data Types
There are three types in the API.

17
docs/docs/development/dev-guide.md
View File

@ -1,21 +1,10 @@
---
id: guide
slug: /development/guide
title: Development Guide
sidebar_position: 2
description: BigBlueButton Development Guide
keywords:
- development
- developer
---
Welcome to the BigBlueButton Developer's Guide for BigBlueButton 3.0.
Welcome to the BigBlueButton Developer's Guide for BigBlueButton 2.7.
This document gives you an overview of how to set up a development environment for BigBlueButton 2.7.
This document gives you an overview of how to set up a development environment for BigBlueButton 3.0.
## Before you begin
You first need to set up a BigBlueButton 2.7 server. See the instructions at [Install BigBlueButton 2.7](/administration/install).
You first need to set up a BigBlueButton 3.0 server. See the instructions at [Install BigBlueButton 3.0](/administration/install).
## Overview

172
docs/docs/new-features.md
View File

@ -1,183 +1,89 @@
![BigBlueButton 2.7 runs on Ubuntu 20.04](/img/27_BBB_header.png)
![BigBlueButton 3.0 runs on Ubuntu 22.04](/img/30_BBB_header.png)
## Overview
BigBlueButton 2.7 offers users improved usability, increased engagement, and more performance.
### This document is still a draft, BigBlueButton 3.0 is under development
BigBlueButton 3.0 offers users improved usability, increased engagement, and more performance.
- **Usability** - making common functions (such as raise hand) easier
- **Engagement** - giving the instructor more ways to engage students
- **Performance** - increasing overall performance and scalability
Here's a breakdown of what's new in 2.7.
Here's a breakdown of what's new in 3.0.
### Usability
#### Grid layout
#### Upgraded whiteboard
We have enhanced the layout which is focused on webcams by providing a visual representation of each participant. This way whether a webcam was shared or not, you can more easily be aware of who is speaking, who is present etc.
We have done significant work to adopt the newly released version 2 of tl;draw. It comes with even more tools and capabilities and has allowed us to embark on more ambitious whiteboard projects, for example a prototype of an Infinite Canvas.
![Grid Layout](/img/27-grid-layout.png)
#### Camera as content
In hybrid learning (and not only) there is a frequently a need for displaying a physical whiteboard or draw the attention of students to a specific physical area. We now support using a webcam as the main content to occupy the presentation area.
![Share camera as content](/img/2.7-share-camera-as-content.png)
#### Disable viewing your own video stream
You can now disable the self viewing of your webcam to reduce fatigue of seeing your own webcam stream. This has been a common request in the recent months. When you disable the view you will see an image of yourself with an overlay reminding you that your webcam is still active and others see you.
![Disable self-view](/img/2.7-disable-self-view.png)
You can re-enable viewing your own webcam at any point.
![Re-enable self-view](/img/2.7-enable-self-view.png)
#### Restore downloading of original presentation
In BigBlueButton 2.4 and 2.5 we supported optional downloading of the entire presentation. In BigBlueButton 2.6 we replaced this option with the capability to download the presentation with all the annotations embedded in it. As of BigBlueButton 2.7 you are be able to do both! In fact, you could select between the presentation with the current state of the annotations, the original file that was uploaded, or in case BigBlueButton had to convert the presentation file to PDF, you could also select that intermediate PDF file to be downloaded.
![You can enable original presentation downloading from the upload dialog](/img/27-enable-download-orig-presentation.png)
The download button is overlayed on top of the presentation.
![Once downloading is enabled, everyone in the room can use it](/img/27-download-orig-presentation.png)
#### Timer and stopwatch
We have added the long requested option to display a count down (timer) or a count up (stopwatch) in the session. They are displayed to all participants and there is an audio notification when the timer elapses.
![The timer can be activated from the plus button menu](/img/27-activate-timer.png)
Setting up a timer for four minutes.
![Setting up a 4 minutes timer](/img/27-timer-4mins-start.png)
Everyone sees the timer as it counts down.
![Everyone seeing 4 minutes timer](/img/27-timer-4mins.png)
#### Wake lock
When using BigBlueButton on a mobile device you can now enable Wake lock (if your mobile browser supports the API). When enabled, your device's screen will remain on -- i.e. will not dim -- and therefore your media connections will not be interrupted.
![Enable Wake lock from the Settings modal](/img/27-enable-wake-lock.png)
#### New layouts for specific integration scenarios
Several new layouts have been added ("Cameras Only", "Presentation Only", and "Participants and Chat Only") to address various use cases of hybrid education - for example splitting views of the BigBlueButton session to be visible on different physical screens.
### Engagement
#### Reactions Bar
<!-- #### -->
The Reactions Bar aims to make it much easier for students to respond with emojis to the teacher. The emoji is displayed in the user avatar area for 1 minute (configurable). The bar remains visible once activated, and the emoji selected remains visible until it times out or is unselected. Modifying the configuration options (settings.yml) an additional set of emojis can be displayed, or the Reactions Bar can be substituted with the Status selecter we used in BigBlueButton 2.6 and prior.
![Reactions Bar remains visible once activated](/img/27-reactions-bar.png)
Others see your reactions in the participants list.
![Others see your reactions in the participants list](/img/27-reactions-thumbs-up.png)
<!-- ### Analytics -->
<!-- ### Performance -->
### Behind the scene
#### Introduction of plugins
We have made significant changes to the architecture of BigBlueButton and have introduced support to plugins -- optional custom modules included in the client which allow expanding the capabilities of BigBlueButton. A data channel is provided to allow for data exchange between clients. See the [HTML5 Plugin SDK](https://github.com/bigbluebutton/bigbluebutton-html-plugin-sdk) for examples and more information.
#### Replaced Akka framework with Pekko
Following the license change of Akka back in September 2022 we considered several options and decided to replace our use of Akka with [Apache Pekko](https://github.com/apache/incubator-pekko) More on the transition: https://github.com/bigbluebutton/bigbluebutton/pull/18694
#### Override client settings through API /create call
Administrators will appreciate that we now allow passing of custom client settings through the meeting create API call. You no longer need separate servers to accommodate for sessions requiring vastly different settings.yml configuration
#### Major strides in replacing Meteor
For years we have discussed internally the topic of replacing MeteorJS with other technologies in order to improve scalability, performance, etc. In the last year we have introduced several different new components which are to replace Meteor. The work is underway, it will span into BigBlueButton 3.0, 3.1, possibly 3.2 too.
These new components are: `bbb-graphql-server`, `bbb-graphql-middleware`, `bbb-graphql-actions`, database Postgres, GraphQL server Hasura. During the transition period, `bbb-html5-backend` and `bbb-html5-frontend` are still present, however, lots of what they used to do is now being carried out by the new components.
### Experimental
#### New camera and screen share recorder
<!-- #### LiveKit support -->
Kurento Media Server is still used in BigBlueButton as a recorder for mediasoup streams.
In 2.7, however, there's a new experimental recorder based on the Pion project: `bbb-webrtc-recorder`. This application is written in Go as a standalone service that can be used to record video and screen share streams.
The main goal is for `bbb-webrtc-recorder` to replace Kurento Media Server in BigBlueButton once production grade. Progress can be tracked in:
- [Issue 13999](https://github.com/bigbluebutton/bigbluebutton/issues/13999)
- [The bbb-webrtc-recorder repository](https://github.com/bigbluebutton/bbb-webrtc-recorder)
If you want to try the new recorder, you need to instruct `bbb-webrtc-sfu` to use it:
```bash
$ mkdir -p /etc/bigbluebutton/bbb-webrtc-sfu
$ if ! grep -q "recordingAdapter: bbb-webrtc-recorder" /etc/bigbluebutton/bbb-webrtc-sfu/production.yml; then echo "recordingAdapter: bbb-webrtc-recorder" >> /etc/bigbluebutton/bbb-webrtc-sfu/production.yml; fi
$ systemctl restart bbb-webrtc-sfu
```
Issues found during testing should be reported on [BigBlueButton's issue tracker](https://github.com/bigbluebutton/bigbluebutton/issues) or [issue 13999](https://github.com/bigbluebutton/bigbluebutton/issues/13999).
Reverting to the default recorder (Kurento) can be achieved by removing the `recordingAdapter` line from `/etc/bigbluebutton/bbb-webrtc-sfu/production.yml` and restarting `bbb-webrtc-sfu`.
#### Transparent listen only mode
We've added a new experimental audio mode called "transparent listen only".
The goal is to pave the way for a better audio experience in BigBlueButton by
removing the need for end users to pick between listen only and microphone modes while still
providing a scalable audio solution.
The motivation for this mode can be found in [issue 14021](https://github.com/bigbluebutton/bigbluebutton/issues/14021),
while the implementation details are available in [pull request 18461](https://github.com/bigbluebutton/bigbluebutton/pull/18461).
In version 2.7, we present the initial iteration of this audio mode, primarily focusing on the server side.
The primary objective is to assess the viability of the proposed approach and gather community feedback.
The new mode is *turned off by default* and is considered *experimental*. To enable it:
- To enable on clients:
* Server wide: configure `public.media.transparentListenOnly: true` in `/etc/bigbluebutton/bbb-html5.yml`, then restart `bbb-html5` (`systemctl restart bbb-html5`)
* Per user: utilize `userdata-bbb_transparent_listen_only=true`
### Upgraded components
Under the hood, BigBlueButton 2.7 installs on Ubuntu 20.04 64-bit, and the following key components have been upgraded
- Spring 2.7.12
- React 18
- NodeJS 18 (up from 16) for `bbb-pads`, `bbb-export-annotations`, `bbb-webrtc-sfu`, `bbb-etherpad`, `bbb-webhooks`
- Java 17 (up from 11) for `bbb-common-message`, `bbb-common-web`, `bigbluebutton-web`, `akka-bbb-apps`, `bbb-fsesl-client`, and `akka-bbb-fsesl`
- Meteor 2.13
- Grails 5.3.2
- GORM 7.3.1
- Groovy 3.0.11
Under the hood, BigBlueButton 3.0 installs on Ubuntu 22.04 64-bit, and the following key components have been upgraded
...
For full details on what is new in BigBlueButton 2.7, see the release notes.
For full details on what is new in BigBlueButton 3.0, see the release notes.
Recent releases:
- [2.7.1](https://github.com/bigbluebutton/bigbluebutton/releases/tag/v2.7.1)
- [2.7.0](https://github.com/bigbluebutton/bigbluebutton/releases/tag/v2.7.0)
- [2.7.0-rc.2](https://github.com/bigbluebutton/bigbluebutton/releases/tag/v2.7.0-rc.2)
- [2.7.0-rc.1](https://github.com/bigbluebutton/bigbluebutton/releases/tag/v2.7.0-rc.1)
- [2.7.0-beta.3](https://github.com/bigbluebutton/bigbluebutton/releases/tag/v2.7.0-beta.3)
- [2.7.0-beta.2](https://github.com/bigbluebutton/bigbluebutton/releases/tag/v2.7.0-beta.2)
- [2.7.0-beta.1](https://github.com/bigbluebutton/bigbluebutton/releases/tag/v2.7.0-beta.1)
- [2.7.0-alpha.3](https://github.com/bigbluebutton/bigbluebutton/releases/tag/v2.7.0-alpha.3)
- [2.7.0-alpha.2](https://github.com/bigbluebutton/bigbluebutton/releases/tag/v2.7.0-alpha.2)
- [2.7.0-alpha.1](https://github.com/bigbluebutton/bigbluebutton/releases/tag/v2.7.0-alpha.1)
...
### Other notable changes
#### Renaming (bigbluebutton/bbb-install)bbb-install-2.7.sh from master branch to bbb-install.sh on branch v2.7.x-release
#### Removal of Kurento
If you are using bbb-install to configure your servers, be aware that starting with BigBlueButton 2.6's version of bbb-install by default we install a local TURN server. For more information: https://github.com/bigbluebutton/bbb-install/pull/579 and https://docs.bigbluebutton.org/administration/turn-server
#### Changing the default setting `guestPolicyExtraAllowOptions`
Starting with BigBlueButton 2.7.0-beta.3 we are hiding by default a couple extra options in the guest approve panel. 'Allow all authenticated users' and 'Allow all guests' options will be hidden unless you override the option `app.public.guestPolicyExtraAllowOptions` in `bbb-html5` config file `settings.yml`. These extra options were not relevant to the vast majority of the use cases and when hidden, the interface becomes much simpler.
#### Changing the default setting `wakeLock`
Starting with BigBlueButton 2.7.0-beta.3 we are enabling wake lock feature by default. It can be disabled by overriding the option `public.app.wakeLock.enabled` in `bbb-html5` config file `settings.yml`.
We have removed all use of Kurento Media Server. For the live media transmission we still rely on mediasoup. For the recording portion we make use of our own component `bbb-webrtc-recorder`. BigBlueButton 3.0 is the first release where we do not even install Kurento.
### Development
For information on developing in BigBlueButton, see [setting up a development environment for 2.7](/development/guide).
For information on developing in BigBlueButton, see [setting up a development environment for 3.0](/development/guide).
The build scripts for packaging 2.7 (using fpm) are located in the GitHub repository [here](https://github.com/bigbluebutton/bigbluebutton/tree/v2.7.x-release/build).
The build scripts for packaging 3.0 (using fpm) are located in the GitHub repository [here](https://github.com/bigbluebutton/bigbluebutton/tree/v3.0.x-release/build).
### Contribution
We welcome contributors to BigBlueButton 2.7! The best ways to contribute at the current time are:
We welcome contributors to BigBlueButton 3.0! The best ways to contribute at the current time are:
<!-- - Help localize BigBlueButton 2.7 on [Transifex project for BBB 2.7](https://www.transifex.com/bigbluebutton/bigbluebutton-v27-html5-client/dashboard/) -->
<!-- - Help localize BigBlueButton 3.0 on [Transifex project for BBB 3.0](https://www.transifex.com/bigbluebutton/bigbluebutton-v30-html5-client/dashboard/) -->
- Try out [installing BigBlueButton 2.7](/administration/install) and see if you spot any issues.
- Help test a [2.7 pull request](https://github.com/bigbluebutton/bigbluebutton/pulls?q=is%3Aopen+is%3Apr+milestone%3A%22Release+2.7%22) in your development environment.
- Try out [installing BigBlueButton 3.0](/administration/install) and see if you spot any issues.
- Help test a [3.0 pull request](https://github.com/bigbluebutton/bigbluebutton/pulls?q=is%3Aopen+is%3Apr+milestone%3A%22Release+3.0%22) in your development environment.
<!-- TODO create a GitHub label for contributions-welcome and link here -->

9
docs/docusaurus.config.js
View File

@ -1,8 +1,8 @@
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion
const lightCodeTheme = require('prism-react-renderer/themes/github');
const darkCodeTheme = require('prism-react-renderer/themes/dracula');
const lightCodeTheme = require('prism-react-renderer').themes.github;
const darkCodeTheme = require('prism-react-renderer').themes.dracula;
/** @type {import('@docusaurus/types').Config} */
const config = {
@ -38,7 +38,7 @@ const config = {
lastVersion: '2.7',
includeCurrentVersion: false,
versions: {
'2.5-legacy': {
'2.5': {
banner: 'none'
},
'2.6': {
@ -47,6 +47,9 @@ const config = {
'2.7': {
banner: 'none'
},
'3.0': {
banner: 'none'
},
}
},
theme: {

1040
docs/package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

43
docs/package.json
View File

@ -3,32 +3,26 @@
"version": "0.0.1",
"private": false,
"scripts": {
"docusaurus": "docusaurus",
"start": "docusaurus start",
"build": "docusaurus build",
"swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy",
"clear": "docusaurus clear",
"serve": "docusaurus serve",
"write-translations": "docusaurus write-translations",
"write-heading-ids": "docusaurus write-heading-ids",
"typecheck": "tsc"
"docusaurus": "npx docusaurus",
"start": "npx docusaurus start",
"build": "npx docusaurus build",
"deploy": "npx docusaurus deploy",
"serve": "npx docusaurus serve"
},
"dependencies": {
"@cmfcmf/docusaurus-search-local": "^0.11.0",
"@docusaurus/core": "^3.0.1",
"@cmfcmf/docusaurus-search-local": "^1.1.0",
"@docusaurus/core": "3.0.1",
"@docusaurus/plugin-client-redirects": "^3.0.1",
"@docusaurus/preset-classic": "^3.0.1",
"@mdx-js/react": "^1.6.22",
"clsx": "^1.2.1",
"prism-react-renderer": "^1.3.5",
"react": "^18.0.2",
"react-dom": "^18.0.2"
"@docusaurus/preset-classic": "3.0.1",
"@mdx-js/react": "^3.0.0",
"clsx": "^2.0.0",
"prism-react-renderer": "^2.3.0",
"react": "^18.0.0",
"react-dom": "^18.0.0"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "^3.0.1",
"@tsconfig/docusaurus": "^1.0.6",
"typescript": "^4.9.4"
"@docusaurus/module-type-aliases": "3.0.1",
"@docusaurus/types": "3.0.1"
},
"browserslist": {
"production": [
@ -43,6 +37,11 @@
]
},
"engines": {
"node": ">=16.14"
"node": ">=18.0"
},
"overrides": {
"@cmfcmf/docusaurus-search-local": {
"@docusaurus/core": "^3.0.0-rc.0"
}
}
}

2
docs/src/components/HomepageFeatures/index.tsx
View File

@ -65,7 +65,7 @@ const FeatureList: FeatureItem[] = [
Svg: require('@site/static/img/icon_new.svg').default,
description: (
<>
Discover the new features of BigBlueButton in version 2.7.
Discover the new features of BigBlueButton in version 3.0 (under development).
</>
),
actionText: "Discover",

BIN
docs/static/img/30_BBB_header.png vendored Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 37 KiB

8495
docs/yarn.lock
View File

File diff suppressed because it is too large Load Diff