diff --git a/.DS_Store b/.DS_Store deleted file mode 100644 index 040b436ffbc376e7a8800ad7f0a1384559a3737a..0000000000000000000000000000000000000000 Binary files a/.DS_Store and /dev/null differ diff --git a/.gitignore b/.gitignore index adf7a64ae918f5bbd153c9596531ce9b0f913fd2..cd05b45a5dd4d2d0471a144cd042231f12a156ee 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ .env +.ds_store *.yml *.code-workspace *.iml \ No newline at end of file diff --git a/README.md b/README.md index d726e0d1ac1302e2b076a286bf5b9de4a4ffe2cc..3e87320982aa61719397f09a29bc6f1b42f6f0da 100644 --- a/README.md +++ b/README.md @@ -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. -#### Required +#### Required settings * 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) -#### Optional +#### Optional settings * 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) -### Chat options -* BBB_ENABLE_CHAT - Enable Chat +#### Chat settings +* BBB_ENABLE_CHAT - Enable Chat feedback channel * 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) ### 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) * docker-compose up -d * docker-compose down diff --git a/examples/.DS_Store b/examples/.DS_Store deleted file mode 100644 index 061191090bf0ca855938b42988da20a9784a760d..0000000000000000000000000000000000000000 Binary files a/examples/.DS_Store and /dev/null differ diff --git a/docker-compose.yml b/examples/docker-compose.yml.development similarity index 100% rename from docker-compose.yml rename to examples/docker-compose.yml.development diff --git a/examples/example_player_and_chat.php b/examples/player_and_chat.php similarity index 100% rename from examples/example_player_and_chat.php rename to examples/player_and_chat.php