extern/docker
1
0
Fork 1
mirror of https://github.com/bigbluebutton/docker.git synced 2024-11-21 23:53:11 +01:00
Code Issues Packages Projects Releases Wiki Activity

README: remove docker-compose version check, repeat requirements again, more links on top

Browse Source
This commit is contained in:
chandi 2023-12-08 12:32:50 +01:00
parent 87e73d0edd
commit 8c0409fa53
1 changed files with 10 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -3,7 +3,7 @@
# 📦 BigBlueButton 2.7 Docker # 📦 BigBlueButton 2.7 Docker
Version: 2.7.3 | [Changelog](CHANGELOG.md) | [Issues](https://github.com/bigbluebutton/docker/issues) Version: 2.7.3 | [Changelog](CHANGELOG.md) | [Issues](https://github.com/bigbluebutton/docker/issues) | [Upgrading](docs/upgrading.md) | [Development](docs/development.md)
## Features ## Features
- Easy installation - Easy installation
@ -15,7 +15,7 @@ Version: 2.7.3 | [Changelog](CHANGELOG.md) | [Issues](https://github.com/bigblue
## Requirements ## Requirements
- 4GB of RAM - 4GB of RAM
- Linux (it will not work under WSL) - 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.) - 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) - Public IPv4 (expect issues with a firewall / NAT)
@ -23,16 +23,16 @@ Version: 2.7.3 | [Changelog](CHANGELOG.md) | [Issues](https://github.com/bigblue
- bbb-lti - bbb-lti
## Install ## Install
1. Install docker-ce & docker-compose-plugin 1. Ensure the requirements above are fulfilled (it really doesn't work without them)
2. Install docker-ce & docker-compose-plugin
1. follow instructions 1. follow instructions
* Debian: https://docs.docker.com/engine/install/debian/ * Debian: https://docs.docker.com/engine/install/debian/
* CentOS: https://docs.docker.com/engine/install/centos/ * CentOS: https://docs.docker.com/engine/install/centos/
* Fedora: https://docs.docker.com/engine/install/fedora/ * Fedora: https://docs.docker.com/engine/install/fedora/
* Ubuntu: https://docs.docker.com/engine/install/ubuntu/ * Ubuntu: https://docs.docker.com/engine/install/ubuntu/
2. Ensure docker works with `$ docker run hello-world` 2. Ensure docker works with `$ docker run hello-world`
3. Install docker compose V2: https://docs.docker.com/compose/install/ 3. Ensure you use a docker version ≥ 23.0 : `$ docker --version`
4. Ensure docker compose works and that you use a version ≥ 1.28 : `$ docker compose --version` 3. Clone this repository
2. Clone this repository
```sh ```sh
$ git clone https://github.com/bigbluebutton/docker.git bbb-docker $ git clone https://github.com/bigbluebutton/docker.git bbb-docker
$ cd bbb-docker $ cd bbb-docker
@ -40,28 +40,26 @@ Version: 2.7.3 | [Changelog](CHANGELOG.md) | [Issues](https://github.com/bigblue
# use the more stable main branch (sometimes older) # use the more stable main branch (sometimes older)
$ git checkout main $ git checkout main
``` ```
3. Run setup: 4. Run setup:
```bash ```bash
$ ./scripts/setup $ ./scripts/setup
``` ```
4. (optional) Make additional configuration adjustments 5. (optional) Make additional configuration adjustments
```bash ```bash
$ nano .env $ nano .env
# always recreate the docker-compose.yml file after making any changes # always recreate the docker-compose.yml file after making any changes
$ ./scripts/generate-compose $ ./scripts/generate-compose
``` ```
5. Start containers: 6. Start containers:
```bash ```bash
$ docker compose up -d --no-build $ docker compose up -d --no-build
``` ```
6. If you use greenlight, you can create an admin account with: 7. If you use greenlight, you can create an admin account with:
```bash ```bash
$ docker compose exec greenlight bundle exec rake admin:create $ docker compose exec greenlight bundle exec rake admin:create
``` ```
## Further How-To's ## Further How-To's
- [Upgrading](docs/upgrading.md)
- [Running behind NAT](docs/behind-nat.md) - [Running behind NAT](docs/behind-nat.md)
- [BBB-Docker Development](docs/development.md)
- [Integration into an existing web server](docs/existing-web-server.md) - [Integration into an existing web server](docs/existing-web-server.md)