Deployment Overview of BigBlueButton on Server¶

Prerequisites and Basic Requirements¶

To ensure a successful deployment, the server must meet the following requirements:

• Operating System: Ubuntu or Debian.

• Privileges: Root or sudo access is required for installation.

• Docker: Docker must be installed and running on the host.

• Domain Name: A valid FQDN configured with appropriate DNS records.

• Ports: The following ports must be open to allow traffic:

• 80/tcp (HTTP)

• 443/tcp (HTTPS)

FQDN of the final panel on the hostkey.in domain¶

The application is accessible via a specific subdomain template within the hostkey.in zone.

Application installation process¶

The application is installed using a dedicated installation script and the following steps:

1. Environment Preparation: The system ensures that Docker is installed on the host machine.

2. Script Acquisition: The bbb-install.sh script is downloaded from the official BigBlueButton repository to the /root/ directory.

3. Installation Execution: The installation script is executed with specific parameters:

4. Version: jammy-300

5. Domain: The configured FQDN (e.g., bbb{Server_ID}.hostkey.in).

6. Email: The administrative contact email.

7. Flags: -w -g are used to automate the setup and include Greenlight components.

8. Greenlight Initialization: After the main installation, the system waits for the Greenlight service to become responsive via HTTP/HTTPS.

9. Administrator Setup: An administrator account is automatically created within the Greenlight container using a specific email ([email protected]) and secure credentials to allow immediate management of the panel.

Docker Containers and Their Deployment¶

The deployment utilizes Docker containers for managing the application interface and administrative features.

Greenlight Container¶

• Image Name: greenlight-v3 (managed via internal container orchestration)

• Purpose: Provides the web-based user interface and management dashboard for BigBlueButton.

• Management: Managed via docker exec commands during initial setup to configure administrative users.

Custom Scripts and Additional Setup¶

The following actions are performed during or after the primary installation:

• Installation Script: /root/bbb-install.sh is used to automate the complex configuration of BigBlueButton components, including dependencies and service configurations.

• User Provisioning: A custom command is executed within the greenlight-v3 container to inject an Administrator user into the database via the Rails runner.

Application Update Instructions¶

To update the main application, follow the procedure relevant to your installation method:

• If using the official installer script, re-run the installation script with the desired version flag to apply updates and configuration changes.

• For components managed via Docker, use the following command to pull new images and restart services:

  docker compose pull && docker compose up -d
  

Location of configuration files and data¶

• Installation Script: /root/bbb-install.sh

• Application Data: Managed within Docker volumes associated with the Greenlight container.

• System Logs: Standard system logs and Docker container logs.

Available ports for connection¶

The following ports are utilized by the application: