https://github.com/fracpete/bbb-render-docker
Docker images for the BigBlueButton render tool, to generate videos from recordings.
https://github.com/fracpete/bbb-render-docker
bigbluebutton docker renderer
Last synced: about 2 months ago
JSON representation
Docker images for the BigBlueButton render tool, to generate videos from recordings.
- Host: GitHub
- URL: https://github.com/fracpete/bbb-render-docker
- Owner: fracpete
- License: mit
- Created: 2021-01-25T22:30:31.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-02-15T23:53:25.000Z (over 2 years ago)
- Last Synced: 2024-10-19T12:16:06.473Z (7 months ago)
- Topics: bigbluebutton, docker, renderer
- Language: Shell
- Homepage:
- Size: 30.3 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# bbb-render-docker
Docker image for the [BigBlueButton render](https://github.com/plugorgau/bbb-render)
tool, which allows you to convert recorded [BigBlueButton](https://bigbluebutton.org/)
sessions into videos (e.g., `.mp4`).
## Docker
### Prerequisites
You need docker installed on your machine:
```bash
sudo apt-get install docker.io
```
### Version (for latest docker image)
Uses the following hash of the bbb-render repo:
```
f93f900aaa4cd469d3e1479e1027687c41d1c877
```
Timestamp: Apr 13, 2022
### Prebuilt images
The following images are available from docker hub:
```
fracpete/bbb-render:latest
fracpete/bbb-render:2022-04-13
fracpete/bbb-render:2021-06-10
fracpete/bbb-render:2020-12-27
```
### Build local image
* You can build the image locally like this:
```bash
docker build -t bbbr .
```
* Once built, you can run the image with this command:
```bash
docker run -u $(id -u):$(id -g) \
-v /local/dir:/workspace \
-it bbbr:latest
```
**NB:** `-v` maps a folder from the host into the container. You need this
for downloading the presentation and converting it into a video.
### Pushing local image to Docker Hub
The following steps push the image to Docker Hub (you need to adjust
the user name, of course):
* log into Docker Hub
```bash
docker login
```
* tag the image for the push
```bash
docker tag \
bbbr:latest \
fracpete/bbb-render:latest
```
* push the image
```bash
docker push fracpete/bbb-render:latest
```
* the image is then available from:
https://hub.docker.com/u/fracpete
### Scripts
The following scripts are available in the container:
* `bbbr_convert` - downloads and converts a presentation, use `-h` for a help screen
* `bbbr_download` - just downloads a presentation (wraps `download.py`)
* `bbbr_make_xges` - generates an xges project (wraps `make-xges.py`)
For launching the docker container and convert a presentation you can use this script
(use `-h` to see all available options):
* [scripts/bbbr_convert](scripts/bbbr_convert)
## Examples
### scripts/bbbr_convert
Prerequisites:
* Download the [scripts/bbbr_convert](scripts/bbbr_convert) script
* Place the script on a directory that is in your `$PATH` environment variable
(e.g., `$HOME/bin` or `/usr/local/bin`)
The following steps convert a presentation into an `.mp4` video:
* If necessary, create a working directory, e.g.:
```bash
$HOME/bbb
```
* Get the link from a recorded session by copying the link from the
*Presentation* button in the *Formats* column.
* Run the following command to generate the `PRESENTATION_NAME.mp4`
video file in the `$HOME/bbb` directory:
```bash
bbbr_convert -u "PRESENTATION_LINK" -n "PRESENTATION_NAME" -w "$HOME/bbb"
```
### Docker
The following steps demonstrate how to convert a presentation into an `.mp4` video:
* Create a directory to house all the files, e.g.:
```bash
$HOME/bbb
```
* Change into that directory:
```bash
cd $HOME/bbb
```
* Get the link from a recorded session by copying the link from the
*Presentation* button in the *Formats* column.
* Run the `bbbr_convert` command as follows (replace `PRESENTATION_LINK` with
the actual link and `PRESENTATION_NAME` with the name that you want for the
.mp4 file) to download and convert the BBB presentation:
```bash
docker run -u $(id -u):$(id -g) \
-v `pwd`:/workspace \
-t fracpete/bbb-render:latest \
bbbr_convert -u "PRESENTATION_LINK" -n PRESENTATION_NAME
```
The above command combines the following three commands:
* Download the presentation
```bash
bbbr_download "PRESENTATION_LINK" /workspace
```
* Create an xges project:
```bash
bbbr_make_xges /workspace /workspace/PRESENTATION_NAME.xges
```
* Convert the xges project into an `.mp4` video:
```bash
ges-launch-1.0 --load /workspace/PRESENTATION_NAME.xges -o /workspace/PRESENTATION_NAME.mp4
```