README.md 1.53 KB
Newer Older
mikosche's avatar
mikosche committed
1
2
# BBB Live Streaming

Michael Koscher's avatar
Michael Koscher committed
3
4
5
6
Streams a given BBB Meeting to an RTMP Server.

## Getting Started

Martin Schrott's avatar
Martin Schrott committed
7
### Prerequisites
Michael Koscher's avatar
Michael Koscher committed
8

Martin Schrott's avatar
Martin Schrott committed
9
10
11
All you need is Docker running on your machine and a media server to stream to.

### Configuration
Michael Koscher's avatar
Michael Koscher committed
12
13
14

You need to set some environment variables to run the container.

15
#### Required settings
Martin Schrott's avatar
Martin Schrott committed
16
17
18
19
* BBB_URL - URL to BBB including http/https e.g. https://your_BigBlueButton_server/bigbluebutton/api
* BBB_MEETING_ID - ID of the BBB Meeting (You can get the ID via an API call: https://your_bbb_server/bigbluebutton/api/getMeetings?checksum=<checksum>)
* BBB_SECRET - Secret of your BBB installation (You can get the secret with: bbb-conf --secret)
* BBB_STREAM_URL - Stream URL to your streaming server including rtmp. (e.g. rtmp://media_server_url/stream/stream_key)
Michael Koscher's avatar
Michael Koscher committed
20

21
#### Optional settings
Martin Schrott's avatar
Martin Schrott committed
22
* BBB_AS_MODERATOR - if set to "true" the meeting will be joined as moderator
23
24
* BBB_USER_NAME - the username to join the meeting. (Default: Live)

25
26
#### Chat settings
* BBB_ENABLE_CHAT - Enable Chat feedback channel
27
28
29
* BBB_REDIS_HOST - Set REDIS host (Default: redis)
* BBB_REDIS_CHANNEL - Set REDIS channel (Default: chat)
* BBB_CHAT_NAME - the username to join the meeting for chatting. (Default: Chat)
Martin Schrott's avatar
Martin Schrott committed
30
31

### Starting liveStreaming
32
* wget -O docker-compose.yml https://raw.github.com/aau-zid/BigBlueButton-liveStreaming/1.0.0-beta.2/examples/docker-compose.yml.example
Martin Schrott's avatar
Martin Schrott committed
33
34
* (change configuration)
* docker-compose up -d
35
* docker-compose down 
Martin Schrott's avatar
Martin Schrott committed
36
37
38
39

## Known Limitations
* You must extract and provide the meetingID, which is not visible within the room.
* ffmpeg settings to be improved