You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openmeetings.apache.org by se...@apache.org on 2022/04/26 07:29:05 UTC

[openmeetings] branch feature/OPENMEETINGS-2728-update-kms-docu created (now 439542e6f)

This is an automated email from the ASF dual-hosted git repository.

sebawagner pushed a change to branch feature/OPENMEETINGS-2728-update-kms-docu
in repository https://gitbox.apache.org/repos/asf/openmeetings.git


      at 439542e6f OPENMEETINGS-2728 Fix KMS Media Website docu only.

This branch includes the following new commits:

     new 439542e6f OPENMEETINGS-2728 Fix KMS Media Website docu only.

The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.



[openmeetings] 01/01: OPENMEETINGS-2728 Fix KMS Media Website docu only.

Posted by se...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

sebawagner pushed a commit to branch feature/OPENMEETINGS-2728-update-kms-docu
in repository https://gitbox.apache.org/repos/asf/openmeetings.git

commit 439542e6fa37134d9e163cee6d70581e4c02d609
Author: Sebastian <se...@apache.org>
AuthorDate: Tue Apr 26 19:28:50 2022 +1200

    OPENMEETINGS-2728 Fix KMS Media Website docu only.
---
 .../src/site/markdown/InstallMediaServer.md        | 54 ++++++++++++++++++++--
 1 file changed, 51 insertions(+), 3 deletions(-)

diff --git a/openmeetings-server/src/site/markdown/InstallMediaServer.md b/openmeetings-server/src/site/markdown/InstallMediaServer.md
index 3d71f4e8e..73b2ec476 100644
--- a/openmeetings-server/src/site/markdown/InstallMediaServer.md
+++ b/openmeetings-server/src/site/markdown/InstallMediaServer.md
@@ -5,12 +5,60 @@ Licensed under the Apache License, Version 2.0 (the "License") http://www.apache
 # Media Server Installation
 
 ## Install Kurento Media server
-
+Each instance of OpenMeetings requires a running Kurento Media Server (KMS). There is a complete list of installation modes here: 
 <a href="https://doc-kurento.readthedocs.io/en/stable/user/installation.html">Install Kurento Media server</a>
+
+The default config of OpenMeetings and Kurento Media Server is a 1:1 mapping. Each OpenMeetings instance is mapped exactly to 1 KMS instance as well as OpenMeetings and KMS running on the same host.
+
 <div class="bd-callout bd-callout-danger">
-	It should be run under same user as OM
+	If running on the same host OpenMeetings and KMS should be run under same user.
 </div>
 
+
+The quickest and easiest way to run KMS is via Docker. But running the following commands you can run KMS locally.
+```
+// for example /home/$user/work/openmeetings
+export OM_HOME=$YOUR_PATH
+// for example export OM_HOME=/Users/wagns1/Documents/apache/openmeetings/_REPO/openmeetings/openmeetings-web/target/openmeetings-web-5.0.0-M5-SNAPSHOT
+ 
+docker run -v $OM_HOME/data:$OM_HOME/data -p 8888:8888 kurento/kurento-media-server
+```
+Assuming OpenMeetings runs on your machine locally above will work without any config changes in OpenMeetings and is the most common way to spin up a development environment. 
+
 ## Specify/Install Turn server
 
-<div class="bd-callout bd-callout-warning">Only local installation will work without TURN server</div>
+<div class="bd-callout bd-callout-warning">Only local installation will work without TURN server - also you require a valid SSL certificate for doing webRTC Audio/Video for anything other then local installations</div>
+
+See the installation instructions at <a href="https://doc-kurento.readthedocs.io/en/stable/user/installation.html">Install Kurento Media server</a> for the relevant section on CoTurn.
+
+Once installed update the CoTurn relevant sections in the OpenMeetings configuration:
+```
+################## Kurento ##################
+kurento.ws.url=ws://127.0.0.1:8888/kurento
+kurento.turn.url=
+kurento.turn.user=
+kurento.turn.secret=
+kurento.turn.mode=rest
+## minutes
+kurento.turn.ttl=60
+## milliseconds
+kurento.check.timeout=10000
+## milliseconds
+kurento.object.check.timeout=200
+kurento.watch.thread.count=10
+kurento.flowout.timeout=5
+## please ensure this one is unique, better to regenerate it from time to time
+## can be generated for ex. here https://www.uuidtools.com
+kurento.kuid=df992960-e7b0-11ea-9acd-337fb30dd93d
+## this list can be space and/or comma separated
+kurento.ignored.kuids=
+## See https://doc-kurento.readthedocs.io/en/latest/features/security.html#media-plane-security-dtls
+## possible values: RSA, or ECDSA (capital-case)
+kurento.certificateType=
+```
+
+in your local $OM_HOME/webapps/openmeetings/WEB-INF/classes/openmeetings.properties file. A server restart is required in order for changes to take affect.
+
+## Other installation and configuration resources 
+
+See the Wiki for much more detailed and linux distribution specific instructions: <a href="https://cwiki.apache.org/confluence/display/openmeetings/tutorials+for+installing+openmeetings+and+tools">https://cwiki.apache.org/confluence/display/openmeetings/tutorials+for+installing+openmeetings+and+tools</a>