2020-07-22 00:57:51 +02:00
# bbb-docker Development
2022-05-09 12:21:50 +02:00
## Basics
2023-12-07 19:16:47 +01:00
normally people start BBB with the pre-built docker images, but for developing you need to build them by yourself. For that you need to ensure that the submodules are also checked out
2022-05-09 12:21:50 +02:00
```sh
2023-12-07 19:16:47 +01:00
$ git clone --recurse-submodules https://github.com/bigbluebutton/docker.git bbb-dev
$ cd bbb-dev
2022-05-09 12:21:50 +02:00
```
2020-07-22 00:57:51 +02:00
## Running
2023-12-07 19:16:47 +01:00
you can now run bbb-docker locally by simply starting
2020-07-22 00:57:51 +02:00
2023-12-07 19:16:47 +01:00
```sh
$ ./scripts/dev
2020-07-22 00:57:51 +02:00
```
2023-12-07 19:16:47 +01:00
### Hints
- the html5 component will watch and automatically reload on any changes 🚀
- if you change anything in the other components, you need to
* manually rebuilt it \
`$ docker compose build CONTAINERNAME`
* restart it \
`$ docker compose up -d CONTAINERNAME`
- if you change any variable in .env, always run following to rebuild the `docker-compose.yml` `
2021-02-11 15:34:57 +01:00
`$ ./scripts/generate-compose`
2020-07-22 00:57:51 +02:00
- view the logs with \
2023-05-07 11:07:09 +02:00
`$ docker compose logs -f`
2020-07-22 00:57:51 +02:00
- and access the API via \
https://mconf.github.io/api-mate/#server=https://10.7.7.1/bigbluebutton/api& sharedSecret=SuperSecret
* At some point your browser will warn you about an invalid certificate, but you can press _"Accept the Risk and Continue" / "Proceed to 10.7.7.1 (unsafe)"_
2021-03-27 18:50:57 +01:00
2020-10-20 21:43:23 +02:00
## Notes
2023-03-24 23:01:50 +01:00
- Due to the self signed ssl certificate it is currently not possible to notify greenlight about recordings in dev mode
2020-10-20 21:43:23 +02:00
2021-03-27 18:50:57 +01:00
## How to do create a new update for a newer BBB release?
This always consists out of following steps
1. **Get an understanding about changes that happened and find out what changes to bbb-docker that require.** \
2022-05-09 12:21:50 +02:00
* main source for that are the release notes in https://github.com/bigbluebutton/bigbluebutton/releases
2021-03-27 18:50:57 +01:00
2. **Apply these changes to this project.**
2023-11-29 22:17:49 +01:00
* Often you only need to checkout the git submodules to the specific release tag
* List of all submodules: `git submodule`
2021-03-27 18:50:57 +01:00
3. Test everything (with firefox **and** chromium/chrome)
* Audio
* Video
* Presentation upload
* Shared Notes
4. Create a `CHANGELOG.md` entry
5. Create a Pull Request
6. Receive big thanks from @alangecker