From 2e2741a37c049e35f259333653d0d6e2cac2f49f Mon Sep 17 00:00:00 2001
From: Martin Schrott <martin.schrott@aau.at>
Date: Sat, 9 May 2020 10:34:56 +0200
Subject: [PATCH] cleaned up files and updated documentation

---
 .DS_Store                                        | Bin 8196 -> 0 bytes
 .gitignore                                       |   1 +
 README.md                                        |  10 +++++-----
 examples/.DS_Store                               | Bin 6148 -> 0 bytes
 .../docker-compose.yml.development               |   0
 ...e_player_and_chat.php => player_and_chat.php} |   0
 6 files changed, 6 insertions(+), 5 deletions(-)
 delete mode 100644 .DS_Store
 delete mode 100644 examples/.DS_Store
 rename docker-compose.yml => examples/docker-compose.yml.development (100%)
 rename examples/{example_player_and_chat.php => player_and_chat.php} (100%)

diff --git a/.DS_Store b/.DS_Store
deleted file mode 100644
index 040b436ffbc376e7a8800ad7f0a1384559a3737a..0000000000000000000000000000000000000000
GIT binary patch
literal 0
HcmV?d00001

literal 8196
zcmZQzU|@7AO)+F(kYHe7;9!8z0^AH(0Z1N%F(jFwBElf^7#IW?Jah7slXCKt7(g7T
z<R~>70;3@?8UmvsFd71*Auy;yfDz&v4jlD9M0S)M4S~@R7?B|WDjyUeZF>d>DBS>|
zK~fBi3=H5d03!nf3oL*bp-q2A1_qE;kQ$Iy5Dn7GzzAZ2%>Zj<V1#OA1b0Ii7#JA@
zz(z4bv@<Y*Z3c;hwKFh+ZDwF#glK1Agxbsq?V&J2v@<Y*ZD(L$1ltZaa+DYifzc2^
z3jt8yorOV<A(bJIp$xVE&M3~nz@YIT48XcT>e3l98A{O9wK6a;a)6cn2dm>^&|?6r
zW5{GkXUJp7XDDJwMbq;cO^*yi5*Wra6f=~7)H5V9<T7M3<T0c(=rJTS<TIo&q%!C-
zl!HynW+-MTU`S+0#%3<V3?#R(GbA%)FeEaRFz7K9FjS(tg25Wihe8Y~4EYSn4A~5+
z3`GpOV0&{J3K;SkiWyQF^cX4`av5^a%vgzLh6tJ&ppXUms1j@r$VVWz6f<O?n#0(N
zW)2sF3zA#X7%~}hu=*A`hBz2f87jabR{&DYP>gB^!!rg3hR;Z$gP}gDytn{5f^#yd
zASbi9#K7P>BNH<VD;qlp2NwqyFIQ}EMt*s4Nn%N9u~TAEG>8|FSdx(hWryVF=fK&C
zNnx3(<?#X{&iQ#IiJ5t+MIhzDnJKABiA6EtnRzMs<xcsfc`3zUbD$C&9Go1S@d6Un
z)h5QqhB^wyCbc>W)#l~~ItnJnX0^4P9O9~mww?*Ol~vU>wRJPWi4I;fFz`e8aB>!S
zj0-Jba?%Zhlk;;6;Hp65U}$P`^Icq^fx$6HVaAUAMu!}+nU$NLLX^6K48nGn1sCPz
z<maV>t4Ib0VNjxFhzDngLWWX?OfV}KoLx&8iW&46N*F58GbA`!BWD6mh9Cx421f=L
z244nO20eych7`1f0ZPQkI{3iZFp;5%p@bnADMRWpU?yBpF@da?6Rfw0Ar+huv1B`N
zQitn+RN$laKT=8@WsZgb9YTN^Vuu8%|L@AcfNT68qH2^J4S~@R7?vTx$l?<0;skAR
zVDllUuMO%?CqN}ZeQ;2BoDtM7hv)+-0d?)cwK*fGF@;bI(h8CTcf}bQ7(iM_2Lhns
MGfItyz(9lm07t<(8UO$Q

diff --git a/.gitignore b/.gitignore
index adf7a64..cd05b45 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 d726e0d..3e87320 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
GIT binary patch
literal 0
HcmV?d00001

literal 6148
zcmZQzU|@7AO)+F(5MW?n;9!8zOq>i@0Z1N%F(jFwB5WY@z-H(%Br{|%Br=pR#6#sq
zslgorptuuc&|^qt$YUsDK#spuh6;v6hFpdMh8%`e&z$_^q@4UDXi{0pz`&sK9}K|W
z<3Tb3pT7GH3=9v!+W!Cl&%nSS&yd29&ydWJ&5+7a#GuQN%#aVZF`uEBA(cUop^_n&
zA%|F3F^Z$PN{UF+@wwO<%}i+q6x9sz;P6Rgs08~Uo*|JTk0FI29-a^M7z!9N7z&WX
z59WUu&A`AQ4E8Tbr!zGF_%ft26f+bvBr>FfLjuDT1_s7fG`E4HVw4ySfzc2c4FMuT
zfDxjGgBwDRlA|Fo8Umvs01p9B`Je!4+cP*o=>`Z5l44+FU;uXk7#SE?V44`g{Qw4#
z97rpO25AM+Agv6HAQspRuvP{}s8&XBHw2^))FlDYVC@WyV4FdFuyzJUu+0n%j1cV%
zj8K~yp*<8vh;{}>h;{}>u<bC{jnbnbFd71|5MYKd1VHt_D+2?r{y#+3C^;GeqaiRX
zLx7RRCD_FYTq$GsAE>Sc)u#ziX;2*us*V{!^)f;XTop4x1{5Wr!l3FNq!mPit71k5
U29Va#h5#&pM(NQI7=RD}04h$0)Bpeg

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
-- 
GitLab