Selaa lähdekoodia

update readme

hmt 4 vuotta sitten
vanhempi
sitoutus
7d6e7710ff
1 muutettua tiedostoa jossa 20 lisäystä ja 10 poistoa
  1. 20 10
      README.md

+ 20 - 10
README.md

@@ -7,22 +7,32 @@ Since ended meetings are garbage collected by BBB this technique seems ok and st
 
 To get this load balancer to work you need a server that runs Deno. In most cases you should be ok to just run the installer script: https://deno.land/manual/getting_started/installation
 
-Then clone this repository:
-
-    git clone https://github.com/hmt/tinyscale.git
-    cd tinyscale
-
-edit servers.json (there is a servers.json.example) to your needs
-and then start the script with a free port and a secret:
+Then create a `servers.json` file like this here:
+
+```json
+[
+  {
+    "host": "http://bbb1.schule.de",
+    "secret": "secret_string"
+  },
+  {
+    "host": "http://bbb2.schule.de",
+    "secret": "secret_string"
+  }
+]
+```
+
+Now you are ready to start the script with setting a port and a secret:
     
-    PORT=3005 TINYSCALE_SECRET=some_secret_string deno run --allow-net --allow-read --allow-env mod.ts
+    PORT=3005 TINYSCALE_SECRET=some_secret_string deno run --allow-net --allow-read --allow-env https://deno.land/x/tinyscale@v1.0.0/mod.ts
 
-Now tinyscales runs on port 3005 and you will have to set up your reverse proxy so that it can pick up requests or you leave it on that port.
+tinyscales then runs on port 3005 and you will have to set up your reverse proxy so that it can pick up requests or you leave it on that port.
 
 Next you replace your existing BBB settings with the new tinyscale url in your third party apps.
 
 tinyscale has been tested to work with NextCloud and Moodle.
-It has only been tested with meetings. Since I don't use recordings I have no idea if they work or not.
+
+If you want to use recordings they will work but you cannot get a list of all recordings. tinyscale will only respond with the next available server since it is a call to bbb without a `meetingID`. The same goes for the call to get infos on all meetings.
 
 __This is alpha software. Use at your own risk.__