docker/README.md

2.2 KiB

bbb-docker-banner

📦 BigBlueButton 3.0 Docker

Version: 3.0.0-alpha.1 | Changelog | Issues | Upgrading | Development

Features

  • Easy installation
  • Greenlight included
  • TURN server included
  • Fully automated HTTPS certificates
  • Full IPv6 support
  • Runs on any major linux distributon (Debian, Ubuntu, CentOS,...)

Requirements

  • 4GB of RAM
  • Linux (it will not work under Windows/WSL)
  • Root access (bbb-docker uses host networking, so it won't work with Kubernetes, any "CaaS"-Service, etc.)
  • Public IPv4 (expect issues with a firewall / NAT)

What is not implemented yet

  • bbb-lti

Install

  1. Ensure the requirements above are fulfilled (it really doesn't work without them)
  2. Install docker-ce & docker-compose-plugin
    1. follow instructions
    2. Ensure docker works with $ docker run hello-world
    3. Ensure you use a docker version ≥ 23.0 : $ docker --version
  3. Clone this repository
    $ git clone https://github.com/bigbluebutton/docker.git bbb-docker
    $ cd bbb-docker
    
    # use the more stable main branch (sometimes older)
    $ git checkout main 
    
  4. Run setup:
    $ ./scripts/setup
    
  5. (optional) Make additional configuration adjustments
    $ nano .env
    # always recreate the docker-compose.yml file after making any changes
    $ ./scripts/generate-compose
    
  6. Start containers:
    $ docker compose up -d --no-build
    
  7. If you use greenlight, you can create an admin account with:
    $ docker compose exec greenlight bundle exec rake admin:create
    

Further How-To's