Deploy guide updated

Author: DiegoMzmn

README.md

@@ -31,6 +31,6 @@ Note that this roadmap may change throughout development.
 
 ## Development & Installation ##
 
-For information on how to get the the app working [CLICK HERE](/documentation/installation.md)
+For information on how to get the the app working [CLICK HERE](/documentation/deploy.md)
 For information on how to develop the app [CLICK HERE](/documentation/development.md)
 

docker/composed/docker-compose.yml

@@ -12,7 +12,7 @@ services:
     openvidu-teaching:
         image: diegomzmn/openviduteaching:latest
         volumes:
-            - C:\Users\diego\OneDrive\Documentos\GitHub\2019-OpenViduTeaching\backend\src\main\resources\json\initialData.json:/initialData.json
+            - /path/to/initialData.json:/initialData.json
         ports:
             - "8080:8080"
         environment:

docker/dockerTeaching.bat

@@ -1,2 +1,2 @@
 docker kill openviduteaching 
-docker run --name openviduteaching -p 8080:8080 -e openvidu.url="https://192.168.1.38:4443/" -e initialDataFile="/initialData.json" -v %cd%\build\initialData.json:/initialData.json --rm diegomzmn/openviduteaching
+docker run --name openviduteaching -p 8080:8080 -e openvidu.url="https://192.168.1.38:4443/" -e openvidu.secret=MY_SECRET -e initialDataFile="/initialData.json" -v %cd%\build\initialData.json:/initialData.json --rm diegomzmn/openviduteaching

documentation/deploy.md

@@ -3,21 +3,11 @@ You have three options for deploying the app:
 
 ### OpenViduTeaching standalone Docker container ###
 
-You only need [Docker CE](https://hub.docker.com/search?type=edition&offering=community) and the standalone container:
-`docker run --name openviduteaching -p 4443:4443 -p 8080:8080 --rm -e openvidu.secret=MY_SECRET diegomzmn/openviduteaching-standalone`
+* You only need [Docker CE](https://hub.docker.com/search?type=edition&offering=community) and the standalone container: `docker run -p 4443:4443 -p 8080:8080 -e openvidu.secret=MY_SECRET -e initialDataFile="/initialData.json" -v /path/to/initialData.json:/initialData.json --rm diegomzmn/openviduteaching-standalone`
 
-**TODO**
+	* You can choose your secret however you like. Check the [OpenVidu tutorials](https://openvidu.io/docs/tutorials/) for more info.
 
-### JAR + Openvidu+KMS Docker container ###
-
-* You need to have the OpenVidu server running. For that you can use the Docker container that wraps the openvidu-server and Kurento Media Server:
-	`docker run -p 4443:4443 --rm -e openvidu.secret=MY_SECRET openvidu/openvidu-server-kms:2.11.0`
-	You can choose your port and secret however you like.
-	Check the [OpenVidu tutorials](https://openvidu.io/docs/tutorials/) for more info.
-
-* Get the jar file for the latest release from the [GitHub repository](https://github.com/codeurjc-students/2019-OpenViduTeaching).
-
-	* Data is initialized from a json file. You will have to add the absolute path to it as an argument for the jar file (otherwise it will use the [default file](https://github.com/codeurjc-students/2019-OpenViduTeaching/blob/master/backend/src/main/resources/json/initialData.json))
+	* Data is initialized from a json file. You will have to mount the file into the container and add and enviroment variable with the absolute path to where it was mounted (otherwise it will use the [default file](https://github.com/codeurjc-students/2019-OpenViduTeaching/blob/master/backend/src/main/resources/json/initialData.json)). In the example above we mount it to `/initialData.json` and add `-e initialDataFile="/initialData.json"`.
 	Here is an example of a valid json for the initial rooms and users:
 	~~~~ json
 	{
@@ -55,17 +45,25 @@ You only need [Docker CE](https://hub.docker.com/search?type=edition&offering=co
 		]
 	}
 	~~~~
-	As you can see, the moddedRooms, presentedRooms and participatedRooms properties are optional.
+	As you can see, the moddedRooms, presentedRooms and participatedRooms properties are optional. A user can have a different role for each room, so each user can have none, one or multiple rooms of each type in the json.
+
 
-	* You also have to set the OpenVidu server url and secret when executing the jar (the following values are the default ones for those two arguments):
-	`java -jar OpenViduTeaching-1.0.0.jar --initialDataFile="/fakepath/initialData.json" --openvidu.url="https://localhost:4443/" --openvidu.secret="MY_SECRET"`
+### JAR + Openvidu+KMS Docker container ###
+
+* You need to have the OpenVidu server running. For that you can use the Docker container that wraps the openvidu-server and Kurento Media Server:
+`docker run -p 4443:4443 --rm -e openvidu.secret=MY_SECRET openvidu/openvidu-server-kms:2.11.0`
+
+* Get the jar file for the latest release from the [GitHub repository](https://github.com/codeurjc-students/2019-OpenViduTeaching).
+
+	* You may also set the OpenVidu server url and secret when executing the jar (the following values are the default ones for those two arguments):
+	`java -jar OpenViduTeaching-1.0.0.jar --initialDataFile="/path/to/initialData.json" --openvidu.url="https://localhost:4443/" --openvidu.secret="MY_SECRET"`
 	For additional customizable values take a look at the [application.properties file](https://github.com/codeurjc-students/2019-OpenViduTeaching/blob/master/backend/src/main/resources/application.properties).
 
 
 ### OpenViduTeaching Docker container + Openvidu+KMS Docker container ###
 
-* Firstly get the openvidu-server + KMS container running (same as in the previous section).
-
-* Then, get the OpenViduTeaching running:
+* You can simply make a docker-compose.yml. Take [this one](https://github.com/codeurjc-students/2019-OpenViduTeaching/blob/master/docker/composed/docker-compose.yml) as an example. You have to set the ports as specified (you can change 8080 in openvidu-teaching), mount the volume and use an enviroment variable for the path (same as in first option). You MUST use the variable for the url (localhost will not work).
 
-**TODO**
+* You can also start both manually. Here's how you run both independently with the same configuration as in the compose example.
+`docker run -p 4443:4443 --rm -e openvidu.secret=SECRET openvidu/openvidu-server-kms:2.11.0`
+`docker run -p 8080:8080 -e openvidu.url="https://192.168.1.38:4443/" -e openvidu.secret=SECRET -e initialDataFile="/initialData.json" -v /path/to/initialData.json:/initialData.json --rm diegomzmn/openviduteaching`

documentation/development.md

@@ -9,13 +9,13 @@ You will need both the OpenVidu server and OpenViduTeaching server.
     ~~~~ shell
     docker run -p 4443:4443 --rm -e openvidu.secret=MY_SECRET openvidu/openvidu-server-kms:2.11.0
     ~~~~
-    You can choose your port and secret however you like.
+    You can choose the secret however you like.
     Check the [OpenVidu tutorials](https://openvidu.io/docs/tutorials/) for more info.
 
 * The OpenViduTeaching backend uses Spring Boot v2.1.9. To start developing open the "backend" folder with the IDE of your choice as a Spring Boot project.
     The database is H2, so you don't need to download anything else for that.
     The first users and rooms are initialized from the file initialData.json located in resources/json.
-    You may change your OpenVidu url and secret in the application.properties file inside the resources folder.
+    You may change your OpenVidu url and secret in the application.properties file inside the resources folder (if you change the port you must change it in the frontend and OpenVidu server too).
     To start the server:
     ~~~~ shell
     cd backend