Code autogenerated from Kurento/doc-kurento@8114822

NOTICE

@@ -1,4 +1,4 @@
-(C) Copyright 2018 Kurento (https://www.kurento.org/)
+(C) Copyright 2018 Kurento (https://kurento.openvidu.io/)
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

README.md

@@ -7,7 +7,7 @@
 
 Copyright 2018 [Kurento]. Licensed under [Apache 2.0 License].
 
-[Kurento]: https://www.kurento.org/
+[Kurento]: https://kurento.openvidu.io/
 [KurentoImage]: https://secure.gravatar.com/avatar/21a2a12c56b2a91c8918d5779f1778bf?s=120
 [Apache 2.0 License]: https://www.apache.org/licenses/LICENSE-2.0
 
@@ -25,7 +25,7 @@ For **how to build** and **style conventions**: Read the [Writing this documenta
 About Kurento
 =============
 
-Kurento is an Open Source software project providing a platform suitable for creating modular applications with advanced real-time communication capabilities. For knowing more about Kurento, please visit the Kurento project website: https://www.kurento.org/.
+Kurento is an Open Source software project providing a platform suitable for creating modular applications with advanced real-time communication capabilities. For knowing more about Kurento, please visit the Kurento project website: https://kurento.openvidu.io/.
 
 Kurento is part of [FIWARE]. For further information on the relationship of FIWARE and Kurento check the [Kurento FIWARE Catalog Entry]. Kurento is also part of the [NUBOMEDIA] research initiative.
 
@@ -40,7 +40,7 @@ Documentation
 
 The Kurento project provides detailed [documentation] including tutorials, installation and development guides. The [Open API specification], also known as *Kurento Protocol*, is available on [apiary.io].
 
-[documentation]: https://www.kurento.org/documentation
+[documentation]: https://kurento.openvidu.io/documentation
 [Open API specification]: https://kurento.github.io/doc-kurento/
 [apiary.io]: https://streamoriented.docs.apiary.io/
 
@@ -62,7 +62,7 @@ Issues:
 
 News:
 
-* [Kurento Blog](https://www.kurento.org/blog)
+* [Kurento Blog](https://kurento.openvidu.io/blog)
 * [Google Groups](https://groups.google.com/forum/#!forum/kurento)
 
 

source/dev/release.rst

@@ -275,7 +275,7 @@ Release steps
           local RELEASE_ENTRY="* $COMMIT_MSG"
 
           DEBFULLNAME="Kurento" \
-          DEBEMAIL="info@kurento.org" \
+          DEBEMAIL="kurento@openvidu.io" \
           gbp dch \
               --ignore-branch \
               --git-author \
@@ -335,7 +335,7 @@ The version number (as opposed to the Debian revision) is only changed when the
        local COMMIT_MSG="Bump development version to $PACKAGE_VERSION"
 
        DEBFULLNAME="Kurento" \
-       DEBEMAIL="info@kurento.org" \
+       DEBEMAIL="kurento@openvidu.io" \
        gbp dch \
              --ignore-branch \
              --git-author \

source/glossary.rst

@@ -101,7 +101,7 @@ This is a glossary of terms that often appear in discussion about multimedia tra
        `JSON-RPC <https://www.jsonrpc.org/>`__ is a simple remote procedure call protocol encoded in JSON. JSON-RPC allows for notifications and for multiple calls to be sent to the server which may be answered out of order.
 
    Kurento
-       `Kurento <https://www.kurento.org/>`__ is a platform for the development of multimedia-enabled applications. Kurento is the Esperanto term for the English word 'stream'. We chose this name because we believe the Esperanto principles are inspiring for what the multimedia community needs: simplicity, openness and universality. Some components of Kurento are the :term:`Kurento Media Server`, the :term:`Kurento API`, the :term:`Kurento Protocol`, and the :term:`Kurento Client`.
+       `Kurento <https://kurento.openvidu.io/>`__ is a platform for the development of multimedia-enabled applications. Kurento is the Esperanto term for the English word 'stream'. We chose this name because we believe the Esperanto principles are inspiring for what the multimedia community needs: simplicity, openness and universality. Some components of Kurento are the :term:`Kurento Media Server`, the :term:`Kurento API`, the :term:`Kurento Protocol`, and the :term:`Kurento Client`.
 
    Kurento API
         An object oriented API to create media pipelines to control media. It can be seen as and interface to Kurento Media Server. It can be used from the Kurento Protocol or from Kurento Clients.

source/knowledge/selfsigned_certs.rst

@@ -113,15 +113,27 @@ This technique is very handy, because practically all modern platforms include a
 Trusting a self-signed certificate
 ==================================
 
-Most browsers will not trust a self-signed certificate, showing a security warning page (or rejecting access altogether, like iOS Safari). However, you can override this by installing your Root CA in the device. Then, the self-signed certificate will be trusted just like if it had been issued by a reputable Authority.
+Most if not all clients of any kind, will not trust a self-signed certificate when they connect to a server that uses one. What the client will do is to block the connection with an error message (this is what iOS Safari does, also Node.js apps); or show a security warning page (Chrome and Firefox web browsers).
 
-On desktop browsers, installing the Root CA is easy because *mkcert* does it for you:
+Normally, there is some way to override this behavior. Either by installing your Root CA in the device's root storage, or by setting some configuration. Then, the self-signed certificate will be trusted just like if it had been issued by a reputable Authority.
+
+
+
+On desktop browsers
+-------------------
+
+Installing the Root CA is easy because *mkcert* does it for you. In the terminal, go to the dir where your ``rootCA.pem`` file is located, and run:
 
 .. code-block:: shell
 
    CAROOT="$PWD" mkcert -install
 
-On mobile devices, installing the Root CA is a bit more difficult:
+
+
+On mobile devices
+-----------------
+
+Installing the Root CA is a bit more difficult:
 
 * With iOS, you can either email the ``rootCA.pem`` file to yourself, use AirDrop, or serve it from an HTTP server. Normally, a dialog should pop up asking if you want to install the new certificate; afterwards, you must `enable full trust in it <https://support.apple.com/en-nz/HT204477>`__. When finished, your self-signed certs will be trusted by the system, and iOS Safari will allow accessing pages on the ``*.home.arpa`` subdomain.
 
@@ -130,3 +142,16 @@ On mobile devices, installing the Root CA is a bit more difficult:
      Only AirDrop, Apple Mail, or Safari are allowed to download and install certificates on iOS. Other applications will not work for this.
 
 * With Android, you'll have to install the Root CA and then enable user roots in the development build of your app. See `this StackOverflow answer <https://stackoverflow.com/a/22040887/749014>`__.
+
+
+
+On Node.js applications
+-----------------------
+
+Node.js does not use the system root store, so it won't accept mkcert certificates automatically. Instead, you will have to set the [`NODE_EXTRA_CA_CERTS`](https://nodejs.org/api/cli.html#cli_node_extra_ca_certs_file) environment variable:
+
+.. code-block:: shell
+
+   export NODE_EXTRA_CA_CERTS="/path/to/rootCA.pem"
+
+One good way to do this is by adding the export to the file ``~/.profile``, so it will get automatically set on every system startup.

source/langdoc/client-javadoc/org/kurento/client/class-use/IceComponentState.html

@@ -96,21 +96,21 @@ <h3>Uses of <a href="../../../../org/kurento/client/IceComponentState.html" titl
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code><a href="../../../../org/kurento/client/IceComponentState.html" title="enum in org.kurento.client">IceComponentState</a></code></td>
-<td class="colLast"><span class="typeNameLabel">IceComponentStateChangedEvent.</span><code><span class="memberNameLink"><a href="../../../../org/kurento/client/IceComponentStateChangedEvent.html#getState--">getState</a></span>()</code>
-<div class="block">Getter for the state property</div>
+<td class="colLast"><span class="typeNameLabel">IceConnection.</span><code><span class="memberNameLink"><a href="../../../../org/kurento/client/IceConnection.html#getState--">getState</a></span>()</code>
+<div class="block">get The state of the component</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code><a href="../../../../org/kurento/client/IceComponentState.html" title="enum in org.kurento.client">IceComponentState</a></code></td>
-<td class="colLast"><span class="typeNameLabel">IceComponentStateChangeEvent.</span><code><span class="memberNameLink"><a href="../../../../org/kurento/client/IceComponentStateChangeEvent.html#getState--">getState</a></span>()</code>
-<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
+<td class="colLast"><span class="typeNameLabel">IceComponentStateChangedEvent.</span><code><span class="memberNameLink"><a href="../../../../org/kurento/client/IceComponentStateChangedEvent.html#getState--">getState</a></span>()</code>
 <div class="block">Getter for the state property</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code><a href="../../../../org/kurento/client/IceComponentState.html" title="enum in org.kurento.client">IceComponentState</a></code></td>
-<td class="colLast"><span class="typeNameLabel">IceConnection.</span><code><span class="memberNameLink"><a href="../../../../org/kurento/client/IceConnection.html#getState--">getState</a></span>()</code>
-<div class="block">get The state of the component</div>
+<td class="colLast"><span class="typeNameLabel">IceComponentStateChangeEvent.</span><code><span class="memberNameLink"><a href="../../../../org/kurento/client/IceComponentStateChangeEvent.html#getState--">getState</a></span>()</code>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
+<div class="block">Getter for the state property</div>
 </td>
 </tr>
 <tr class="altColor">
@@ -144,21 +144,21 @@ <h3>Uses of <a href="../../../../org/kurento/client/IceComponentState.html" titl
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>void</code></td>
-<td class="colLast"><span class="typeNameLabel">IceComponentStateChangedEvent.</span><code><span class="memberNameLink"><a href="../../../../org/kurento/client/IceComponentStateChangedEvent.html#setState-org.kurento.client.IceComponentState-">setState</a></span>(<a href="../../../../org/kurento/client/IceComponentState.html" title="enum in org.kurento.client">IceComponentState</a>&nbsp;state)</code>
-<div class="block">Setter for the state property</div>
+<td class="colLast"><span class="typeNameLabel">IceConnection.</span><code><span class="memberNameLink"><a href="../../../../org/kurento/client/IceConnection.html#setState-org.kurento.client.IceComponentState-">setState</a></span>(<a href="../../../../org/kurento/client/IceComponentState.html" title="enum in org.kurento.client">IceComponentState</a>&nbsp;state)</code>
+<div class="block">set The state of the component</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>void</code></td>
-<td class="colLast"><span class="typeNameLabel">IceComponentStateChangeEvent.</span><code><span class="memberNameLink"><a href="../../../../org/kurento/client/IceComponentStateChangeEvent.html#setState-org.kurento.client.IceComponentState-">setState</a></span>(<a href="../../../../org/kurento/client/IceComponentState.html" title="enum in org.kurento.client">IceComponentState</a>&nbsp;state)</code>
-<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
+<td class="colLast"><span class="typeNameLabel">IceComponentStateChangedEvent.</span><code><span class="memberNameLink"><a href="../../../../org/kurento/client/IceComponentStateChangedEvent.html#setState-org.kurento.client.IceComponentState-">setState</a></span>(<a href="../../../../org/kurento/client/IceComponentState.html" title="enum in org.kurento.client">IceComponentState</a>&nbsp;state)</code>
 <div class="block">Setter for the state property</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>void</code></td>
-<td class="colLast"><span class="typeNameLabel">IceConnection.</span><code><span class="memberNameLink"><a href="../../../../org/kurento/client/IceConnection.html#setState-org.kurento.client.IceComponentState-">setState</a></span>(<a href="../../../../org/kurento/client/IceComponentState.html" title="enum in org.kurento.client">IceComponentState</a>&nbsp;state)</code>
-<div class="block">set The state of the component</div>
+<td class="colLast"><span class="typeNameLabel">IceComponentStateChangeEvent.</span><code><span class="memberNameLink"><a href="../../../../org/kurento/client/IceComponentStateChangeEvent.html#setState-org.kurento.client.IceComponentState-">setState</a></span>(<a href="../../../../org/kurento/client/IceComponentState.html" title="enum in org.kurento.client">IceComponentState</a>&nbsp;state)</code>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
+<div class="block">Setter for the state property</div>
 </td>
 </tr>
 </tbody>

source/langdoc/client-javadoc/org/kurento/client/class-use/MediaElement.html

@@ -217,14 +217,14 @@ <h3>Uses of <a href="../../../../org/kurento/client/MediaElement.html" title="in
 <tbody>
 <tr class="altColor">
 <td class="colFirst"><code><a href="../../../../org/kurento/client/MediaElement.html" title="interface in org.kurento.client">MediaElement</a></code></td>
-<td class="colLast"><span class="typeNameLabel">ElementConnectedEvent.</span><code><span class="memberNameLink"><a href="../../../../org/kurento/client/ElementConnectedEvent.html#getSink--">getSink</a></span>()</code>
-<div class="block">Getter for the sink property</div>
+<td class="colLast"><span class="typeNameLabel">ElementConnectionData.</span><code><span class="memberNameLink"><a href="../../../../org/kurento/client/ElementConnectionData.html#getSink--">getSink</a></span>()</code>
+<div class="block">get The sink element in the connection</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code><a href="../../../../org/kurento/client/MediaElement.html" title="interface in org.kurento.client">MediaElement</a></code></td>
-<td class="colLast"><span class="typeNameLabel">ElementConnectionData.</span><code><span class="memberNameLink"><a href="../../../../org/kurento/client/ElementConnectionData.html#getSink--">getSink</a></span>()</code>
-<div class="block">get The sink element in the connection</div>
+<td class="colLast"><span class="typeNameLabel">ElementConnectedEvent.</span><code><span class="memberNameLink"><a href="../../../../org/kurento/client/ElementConnectedEvent.html#getSink--">getSink</a></span>()</code>
+<div class="block">Getter for the sink property</div>
 </td>
 </tr>
 <tr class="altColor">
@@ -462,14 +462,14 @@ <h3>Uses of <a href="../../../../org/kurento/client/MediaElement.html" title="in
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>void</code></td>
-<td class="colLast"><span class="typeNameLabel">ElementConnectedEvent.</span><code><span class="memberNameLink"><a href="../../../../org/kurento/client/ElementConnectedEvent.html#setSink-org.kurento.client.MediaElement-">setSink</a></span>(<a href="../../../../org/kurento/client/MediaElement.html" title="interface in org.kurento.client">MediaElement</a>&nbsp;sink)</code>
-<div class="block">Setter for the sink property</div>
+<td class="colLast"><span class="typeNameLabel">ElementConnectionData.</span><code><span class="memberNameLink"><a href="../../../../org/kurento/client/ElementConnectionData.html#setSink-org.kurento.client.MediaElement-">setSink</a></span>(<a href="../../../../org/kurento/client/MediaElement.html" title="interface in org.kurento.client">MediaElement</a>&nbsp;sink)</code>
+<div class="block">set The sink element in the connection</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>void</code></td>
-<td class="colLast"><span class="typeNameLabel">ElementConnectionData.</span><code><span class="memberNameLink"><a href="../../../../org/kurento/client/ElementConnectionData.html#setSink-org.kurento.client.MediaElement-">setSink</a></span>(<a href="../../../../org/kurento/client/MediaElement.html" title="interface in org.kurento.client">MediaElement</a>&nbsp;sink)</code>
-<div class="block">set The sink element in the connection</div>
+<td class="colLast"><span class="typeNameLabel">ElementConnectedEvent.</span><code><span class="memberNameLink"><a href="../../../../org/kurento/client/ElementConnectedEvent.html#setSink-org.kurento.client.MediaElement-">setSink</a></span>(<a href="../../../../org/kurento/client/MediaElement.html" title="interface in org.kurento.client">MediaElement</a>&nbsp;sink)</code>
+<div class="block">Setter for the sink property</div>
 </td>
 </tr>
 <tr class="altColor">