Unverified Commit 44b28b8c authored by mtsonline's avatar mtsonline Committed by GitHub
Browse files

Merge pull request #6 from mtsonline/preparing_beta2

cleaned up files and updated documentation
parents 6a07ffbc 2e2741a3
File deleted
.env .env
.ds_store
*.yml *.yml
*.code-workspace *.code-workspace
*.iml *.iml
\ No newline at end of file
...@@ -12,24 +12,24 @@ All you need is Docker running on your machine and a media server to stream to. ...@@ -12,24 +12,24 @@ All you need is Docker running on your machine and a media server to stream to.
You need to set some environment variables to run the container. You need to set some environment variables to run the container.
#### Required #### Required settings
* BBB_URL - URL to BBB including http/https e.g. https://your_BigBlueButton_server/bigbluebutton/api * 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_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_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) * BBB_STREAM_URL - Stream URL to your streaming server including rtmp. (e.g. rtmp://media_server_url/stream/stream_key)
#### Optional #### Optional settings
* BBB_AS_MODERATOR - if set to "true" the meeting will be joined as moderator * BBB_AS_MODERATOR - if set to "true" the meeting will be joined as moderator
* BBB_USER_NAME - the username to join the meeting. (Default: Live) * BBB_USER_NAME - the username to join the meeting. (Default: Live)
### Chat options #### Chat settings
* BBB_ENABLE_CHAT - Enable Chat * BBB_ENABLE_CHAT - Enable Chat feedback channel
* BBB_REDIS_HOST - Set REDIS host (Default: redis) * BBB_REDIS_HOST - Set REDIS host (Default: redis)
* BBB_REDIS_CHANNEL - Set REDIS channel (Default: chat) * BBB_REDIS_CHANNEL - Set REDIS channel (Default: chat)
* BBB_CHAT_NAME - the username to join the meeting for chatting. (Default: Chat) * BBB_CHAT_NAME - the username to join the meeting for chatting. (Default: Chat)
### Starting liveStreaming ### Starting liveStreaming
* wget -O docker-compose.yml https://github.com/aau-zid/BigBlueButton-liveStreaming/raw/master/docker-compose.yml.example * wget -O docker-compose.yml https://raw.github.com/aau-zid/BigBlueButton-liveStreaming/1.0.0-beta.2/examples/docker-compose.yml.example
* (change configuration) * (change configuration)
* docker-compose up -d * docker-compose up -d
* docker-compose down * docker-compose down
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment