You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update README.md - all 2.7.x instances updated to 3.0.x
The links, versions and information in the md file was updated to match the release version i.e. 3.0.x
corrected bbb release and wget link - updated the example commands with correct .sh file link and the correct bbb release
Copy file name to clipboardExpand all lines: README.md
+33-29Lines changed: 33 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ Naming convention:
7
7
8
8
Please use `bbb-install.sh` to install or upgrade BigBlueButton.
9
9
10
-
For example use `bbb-install.sh` with the parameter `-v focal-270` to install BigBlueButton 2.7 or upgrade to that release. Check https://docs.bigbluebutton.org for the latest production ready release of BigBlueButton.
10
+
For example use `bbb-install.sh` with the parameter `-v jammy-300` to install BigBlueButton 3.0 or upgrade to that release. Check https://docs.bigbluebutton.org for the latest production ready release of BigBlueButton.
11
11
12
12
There are checks within the scripts that will inform you if the upgrade is not possible (i.e. operating system changed between the releases, or some really significant changes were made that prevent us from supporting an upgrade).
13
13
etc.
@@ -19,15 +19,16 @@ To help you set up a new BigBlueButton server (or upgrade from an earlier versio
19
19
The full source code for the installation scripts can be found [here](https://github.com/bigbluebutton/bbb-install).
20
20
21
21
22
-
So, to install the latest iteration of BigBlueButton 2.7 on a new 64-bit Ubuntu 20.04 server with a public IP address, a hostname (such as `bbb.example.com`) that resolves to the public IP address, and an email address (such as `[email protected]`), log into your new server via SSH and run the following command as root.
22
+
So, to install the latest iteration of BigBlueButton 3.0 on a new 64-bit Ubuntu 22.04 server with a public IP address, a hostname (such as `bbb.example.com`) that resolves to the public IP address, and an email address (such as `[email protected]`), log into your new server via SSH and run the following command as root.
This command pulls down the latest version of `bbb-install.sh` from BigBlueButton 2.7 branch , sends it to the Bash shell interpreter, and installs BigBlueButton using the parameters provided:
28
+
This command pulls down the latest version of `bbb-install.sh` from BigBlueButton 3.0 branch , sends it to the Bash shell interpreter, and installs BigBlueButton using the parameters provided:
29
29
30
30
*`-w` installs the uncomplicated firewall (UFW) to restrict access to TCP/IP ports 22, 80, and 443, and UDP ports in range 16384-32768.
31
+
*`-v jammy-300` installs the latest iteration of BigBlueButton 3.0.x .
31
32
*`-v focal-270` installs the latest iteration of BigBlueButton 2.7.x .
32
33
*`-s` sets the server's hostname to be `bbb.example.com`.
33
34
*`-e` provides an email address for Let's Encrypt to generate a valid SSL certificate for the host.
@@ -112,16 +113,16 @@ We make a distinction here between the firewall installed with `-w` and the exte
112
113
You can get help by passing the `-h` option.
113
114
114
115
~~~
115
-
Script for installing a BigBlueButton 2.7 server in under 30 minutes. It also supports upgrading a BigBlueButton server to version 2.7 (from version 2.6.0+ or an earlier 2.7.x version)
116
+
Script for installing a BigBlueButton 3.0 server in under 30 minutes. It also supports upgrading a BigBlueButton server to version 3.0 (from version 2.6.0+ or an earlier 2.7.x version)
116
117
117
118
This script also supports installation of a coturn (TURN) server on a separate server.
@@ -205,7 +209,7 @@ Note: we're using `bbb.example.com` as an example hostname and `[email protected]
205
209
With just these two pieces of information (FQDN and email address) you can use `bbb-install.sh` to automate the configuration of the BigBlueButton server with a TLS/SSL certificate. For example, to install BigBlueButton with a TLS/SSL certificate from Let's Encrypt using `bbb.example.com` and `[email protected]`, enter the following command:
> [options] is a placeholder for one or more [options](#command-options) that you may use.
@@ -220,7 +224,7 @@ The default installation is meant to be for servers that are publicly available.
220
224
When installing BigBlueButton in a private network, it is possible to validate the FQDN manually, by adding the option `-x` to the command line. As in:
> [options] is a placeholder for one or more [options](#command-options) that you may use.
@@ -288,7 +292,7 @@ More on Greenlight can be found [here](https://docs.bigbluebutton.org/greenlight
288
292
To [install Greenlight](https://docs.bigbluebutton.org/greenlight/v3/install#bbb-install-script) you can simply use the `bbb-install.sh` command `-g` option:
Note: You don't need to re-use the `-k` to update Keycloak if already installed, using `-g` updates both of Greenlight and Keycloak as the latter is considered as a dependency to the project.
@@ -366,7 +370,7 @@ The Broker is a Web Application that acts as a LTI Broker for connecting Tool Co
366
370
To install the LTI framework you can simply use the `bbb-install.sh` command `-t` option while providing a `KEY:SECRET` which you'll use when deploying the BigBlueButton LTI applications to your platform, for more details about the integration of a tool to your platform please refer to the official documentation of your solution:
> [options] is a placeholder for one or more [options](#command-options) that you may use.
@@ -439,7 +443,7 @@ This allows users to store the contents of /`var/bigbluebutton`, which can get q
439
443
If you want to set up BigBlueButton with a TLS/SSL certificate, [GreenLight](#install-greenlight), [Keycloak](https://docs.bigbluebutton.org/greenlight/v3/external-authentication#installing-keycloak) and [BigBlueButton LTI](#install-bigbluebutton-lti-framework) with LTI credentials `MY_KEY:MY_SECRET` , you can do this all with a single command:
Note: You'd need to substitute your FQDN, email address and LTI credentials.
@@ -449,12 +453,12 @@ Note: You'd need to substitute your FQDN, email address and LTI credentials.
449
453
-`-t` will install the latest version the BigBlueButton LTI framework.
450
454
451
455
### Update the system
452
-
Furthermore, you can re-run the same `bbb-install.sh` command used for installation later to update your server to the latest version of BigBlueButton 2.7 along with any other installed applications like [Greenlight](#install-greenlight) or [BigBlueButton LTI](#install-bigbluebutton-lti-frameworkfo).
456
+
Furthermore, you can re-run the same `bbb-install.sh` command used for installation later to update your server to the latest version of BigBlueButton 3.0 along with any other installed applications like [Greenlight](#install-greenlight) or [BigBlueButton LTI](#install-bigbluebutton-lti-frameworkfo).
453
457
454
458
So to update the system in [Doing everything with a single command](#doing-everything-with-a-single-command) example you'd re-run the same command with the same options:
-`-g` will update Greenlight **and Keycloak** to the latest stable version.
@@ -470,7 +474,7 @@ Running the BigBlueButton client requires a wide range of UDP ports to be availa
470
474
471
475
If you have setup your BigBlueButton on the internet, and you have users accessing the BigBlueButton server behind a restrictive firewall that blocks UDP connections, then setting up a separate TURN server will allow users to have the TURN server (connected via port 443) proxy their UDP-based WebRTC media (audio, webcam, and screen share) to the BigBlueButton server.
472
476
473
-
We recommend Ubuntu 20.04 as it has a newer version of [coturn](https://github.com/coturn/coturn) than Ubuntu 18.04. The server does not need to be very powerful as it will only relay communications from the BigBlueButton client to the BigBlueButton server when necessary. A dual core server on Digital Ocean should be sufficient for a dozen BigBlueButton servers.
477
+
We recommend Ubuntu 22.04 as it has a newer version of [coturn](https://github.com/coturn/coturn) than Ubuntu 18.04. The server does not need to be very powerful as it will only relay communications from the BigBlueButton client to the BigBlueButton server when necessary. A dual core server on Digital Ocean should be sufficient for a dozen BigBlueButton servers.
474
478
475
479
The server should have the following additional ports available:
476
480
@@ -493,18 +497,18 @@ Before running `bbb-install.sh` to setup the TURN server (which installs and con
493
497
With the above in place, you can set up a TURN server for BigBlueButton using the command
Note, we've omitted the `-v` option, which causes `bbb-install.sh` to just install and configure coturn. For example, using `turn.example.com` as the FQDN, `1234abcd` as the shared secret, and `[email protected]` as the email address (you would need to substitute your own values), logging into the server via SSH and running the following command as root
* Install the latest version of coturn available for Ubuntu 20.04
511
+
* Install the latest version of coturn available for Ubuntu 22.04
508
512
* Provide a minimal configuration for `/etc/turnserver.conf`
509
513
* Add a systemd override to ensure coturn can bind to port 443
510
514
* Configure logging to `/var/log/turnserver/turnserver.log`
@@ -517,7 +521,7 @@ With a SSL certificate in place, coturn can relay access to your BigBlueButton s
517
521
After the TURN server is setup, you can configure your BigBlueButton server to use the TURN server by running the `bbb-install.sh` command again and add the parameter `-c <FQDN>:<SECRET>` (this tells `bbb-install.sh` to set up the configuration for the TURN server running at <FQDN> using the share secret <SECRET>. For example,
You can re-use a single TURN server for multiple BigBlueButton installations.
@@ -567,4 +571,4 @@ If you encounter an error with the script (such as it not completing or throwing
567
571
568
572
If you are running your BigBlueButton behind a firewall, such as on EC2, this script will not configure your firewall. You'll need to [configure the firewall](#configuring-the-external-firewall) manually.
569
573
570
-
If you are upgrading from a very old version BigBlueButton (running on an older Operating System), we recommend you set up a new server for BigBlueButton's latest stable version and copy over your configuration settings and [transfer recordings](https://docs.bigbluebutton.org/admin/customize.html#transfer-recordings) from the previous version.
574
+
If you are upgrading from a very old version BigBlueButton (running on an older Operating System), we recommend you set up a new server for BigBlueButton's latest stable version and copy over your configuration settings and [transfer recordings](https://docs.bigbluebutton.org/admin/customize.html#transfer-recordings) from the previous version.
0 commit comments