Skip to content

Commit

Permalink
Code autogenerated from Kurento/doc-kurento@0f95e81
Browse files Browse the repository at this point in the history
  • Loading branch information
@jenkinskurento
jenkinskurento committed Jun 1, 2022
1 parent 395512d commit 9a8423a
Show file tree
Hide file tree
Showing 7 changed files with 126 additions and 112 deletions.
7 changes: 2 additions & 5 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,9 @@ Copyright 2018 [Kurento]. Licensed under [Apache 2.0 License].
doc-kurento
===========

Kurento Documentation. Made with [Sphinx] and [Read the Docs].
Kurento Documentation. Made with [Sphinx](https://www.sphinx-doc.org/) and [Read the Docs](https://docs.readthedocs.io/).

To learn the style conventions and how to build these docs, read here: [Writing this documentation](https://doc-kurento.readthedocs.io/en/latest/dev/writing_documentation.html).

[Sphinx]: https://www.sphinx-doc.org/
[Read the Docs]: https://docs.readthedocs.io
For **how to build** and **style conventions**: Read the [Writing this documentation](https://doc-kurento.readthedocs.io/en/latest/dev/writing_documentation.html) section.



Expand Down
8 changes: 4 additions & 4 deletions source/dev/release.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -384,7 +384,7 @@ Preparation: kurento-module-creator

* If *kurento-maven-plugin* is getting a new version, edit the file ``kurento-module-creator/src/main/templates/maven/model_pom_xml.ftl`` to update it:

.. code-block:: xml
.. code-block:: diff
<groupId>org.kurento</groupId>
<artifactId>kurento-maven-plugin</artifactId>
Expand Down Expand Up @@ -814,7 +814,7 @@ Preparation: kurento-java

* If *kurento-qa-pom* is getting a new version, edit the file ``kurento-parent-pom/pom.xml`` to update it:

.. code-block:: xml
.. code-block:: diff
<parent>
<groupId>org.kurento</groupId>
Expand All @@ -825,15 +825,15 @@ Preparation: kurento-java
* If *kurento-maven-plugin* is getting a new version, edit the file ``kurento-parent-pom/pom.xml`` to update it:

.. code-block:: xml
.. code-block:: diff
- <version.kurento-maven-plugin>1.0.0</version.kurento-maven-plugin>
+ <version.kurento-maven-plugin>1.1.0</version.kurento-maven-plugin>
* If *kurento-utils-js* is getting a new version, edit the file ``kurento-parent-pom/pom.xml`` to update it:

.. code-block:: xml
.. code-block:: diff
- <version.kurento-utils-js>1.0.0</version.kurento-utils-js>
+ <version.kurento-utils-js>1.1.0</version.kurento-utils-js>
Expand Down
2 changes: 1 addition & 1 deletion source/dev/testing.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ Kurento Media Server (KMS) is the heart of Kurento and therefore it must be prop
| | - *remote*: KMS is a remote host (use *kms.login* and *kms.passwd*, or *kms.pem*, to access using SSH to the remote machine). | |
| | - *docker*: Request the docker daemon to start a KMS container based in the image specified by *test.kms.docker.image.name*. Test will fail if daemon is unable to start KMS container. In order to use this scope, a Docker server should be installed in the machine running tests. In addition, the Docker REST should be available for Docker client (used in test). | |
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+
| *test.kms.docker.image.name* | KMS docker image used to start a new docker container when KMS service is internally managed by test (``-Dtest.kms.autostart=test`` or ``testsuite``) with docker scope (``-Dtest.kms.scope=docker``). Ignored if *test.kms.autostart* is *false*. See available Docker images for KMS in `Docker Hub <https://hub.docker.com/r/kurento/kurento-media-server-dev/tags/>`__. | *kurento/kurento-media-server-dev:latest* |
| *test.kms.docker.image.name* | KMS docker image used to start a new docker container when KMS service is internally managed by test (``-Dtest.kms.autostart=test`` or ``testsuite``) with docker scope (``-Dtest.kms.scope=docker``). Ignored if *test.kms.autostart* is *false*. See available Docker images for KMS in `Docker Hub <https://hub.docker.com/r/kurento/kurento-media-server/tags>`__. | *kurento/kurento-media-server:latest* |
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+
| *kms.ws.uri* | URL of a KMS service. This property is mandatory when service is externally managed (``-Dtest.kms.autostart=false``) and ignored otherwise. Notice this URL must be reachable from Selenium nodes as well as from tests. | ``ws://localhost:8888/kurento`` |
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+
Expand Down
2 changes: 1 addition & 1 deletion source/langdoc/client-jsdoc/test__common.js.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,7 @@ <h1 class="page-title">Source: test/_common.js</h1>
var hostIp = ip;
console.log("Docker IP:", hostIp);
docker = new Docker();
docker.run('kurento/kurento-media-server-dev:latest', [], [
docker.run('kurento/kurento-media-server:dev', [], [
process.stdout,
process.stderr
], {
Expand Down
201 changes: 108 additions & 93 deletions source/user/installation_dev.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Kurento Media Server
Docker image
------------

While official release Docker images are published as `kurento/kurento-media-server <https://hub.docker.com/r/kurento/kurento-media-server>`__, nightly builds with the latest development progress are available as `kurento/kurento-media-server-dev <https://hub.docker.com/r/kurento/kurento-media-server-dev>`__ (notice the ``-dev``). Other than that, these images behave exactly like the release ones. For usage instructions check out this section: :ref:`installation-docker`.
While official Kurento releases are published as Docker images and tagged with a release number, the latest development progress is tagged with `dev`: `kurento/kurento-media-server <https://hub.docker.com/r/kurento/kurento-media-server/tags>`__ (notice the ``dev-*`` tags). Other than that, these images behave exactly like the release ones. For usage instructions check out this section: :ref:`installation-docker`.



Expand Down Expand Up @@ -84,108 +84,55 @@ Kurento Java Client
Development builds of Kurento Java packages are uploaded to the `GitHub Maven Repository <https://github.com/orgs/Kurento/packages>`__.
This repository can be added to the Maven configuration at the **Project**, **User**, or **System** levels.
This repo can be configured once per-User (by editing Maven's global ``settings.xml``), or it can be added per-Project, to every ``pom.xml``. We recommend using the first method.
For more information about adding a snapshots repository to Maven, check the official documentation: `Guide to Testing Development Versions of Plugins <https://maven.apache.org/guides/development/guide-testing-development-plugins.html>`__.
Project level
-------------
Per-User config
---------------
This adds access to development builds only for a single project. Open the project's ``pom.xml`` and include this:
.. code-block:: xml
<project>
...
<repositories>
<repository>
<id>kurento-github-public</id>
<name>Kurento GitHub Maven packages (public access)</name>
<url>https://public:&#103;hp_tFHDdd4Nh9GqKSaoPjnFIXrb0PFsUh258gzV@maven.pkg.github.com/kurento/*</url>
<releases>
<enabled>false</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>kurento-github-public</id>
<name>Kurento GitHub Maven packages (public access)</name>
<url>https://public:&#103;hp_tFHDdd4Nh9GqKSaoPjnFIXrb0PFsUh258gzV@maven.pkg.github.com/kurento/*</url>
<releases>
<enabled>false</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
</pluginRepository>
</pluginRepositories>
...
</project>
Afterwards, in the same ``pom.xml``, look for the desired dependency and change its version to a snapshot one. For example:
.. code-block:: xml
<dependency>
<groupId>org.kurento</groupId>
<artifactId>kurento-client</artifactId>
<version>6.12.0-SNAPSHOT</version>
</dependency>
Add the snapshots repository to your Maven settings file: ``$HOME/.m2/settings.xml``. If this file doesn't exist yet, you can copy it from ``/etc/maven/settings.xml``, which offers a nice default template to get you started.
User and System levels
----------------------
Add the snapshots repository to either of your *User* or *System* ``settings.xml`` file:
- At ``$HOME/.m2/settings.xml``, the configuration applies only to the current user.
- At ``/etc/maven/settings.xml``, the configuration applies to all users on the machine.
Edit one of the mentioned settings files, and include this:
Edit the settings file to include this:
.. code-block:: xml
<settings>
...
<profiles>
<profile>
<id>snapshot</id>
<repositories>
<repository>
<id>kurento-github-public</id>
<name>Kurento GitHub Maven packages (public access)</name>
<url>https://public:&#103;hp_tFHDdd4Nh9GqKSaoPjnFIXrb0PFsUh258gzV@maven.pkg.github.com/kurento/*</url>
<releases>
<enabled>false</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>kurento-github-public</id>
<name>Kurento GitHub Maven packages (public access)</name>
<url>https://public:&#103;hp_tFHDdd4Nh9GqKSaoPjnFIXrb0PFsUh258gzV@maven.pkg.github.com/kurento/*</url>
<releases>
<enabled>false</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
</pluginRepository>
</pluginRepositories>
</profile>
</profiles>
...
...
<profiles>
<profile>
<id>snapshot</id>
<repositories>
<repository>
<id>kurento-github-public</id>
<name>Kurento GitHub Maven packages (public access)</name>
<url>https://public:&#103;hp_tFHDdd4Nh9GqKSaoPjnFIXrb0PFsUh258gzV@maven.pkg.github.com/kurento/*</url>
<releases>
<enabled>false</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>kurento-github-public</id>
<name>Kurento GitHub Maven packages (public access)</name>
<url>https://public:&#103;hp_tFHDdd4Nh9GqKSaoPjnFIXrb0PFsUh258gzV@maven.pkg.github.com/kurento/*</url>
<releases>
<enabled>false</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
</pluginRepository>
</pluginRepositories>
</profile>
</profiles>
...
</settings>
..
Expand All @@ -196,7 +143,7 @@ Edit one of the mentioned settings files, and include this:
anonymous downloads from their Maven package registry.
More details here: https://github.community/t/download-from-github-package-registry-without-authentication/14407/111
Then use the ``-Psnapshot`` argument in your next Maven run, to enable the new profile. For example:
Then use the ``-Psnapshot`` argument in your Maven commands, to enable the new profile. For example:
.. code-block:: shell
Expand All @@ -206,6 +153,74 @@ Then use the ``-Psnapshot`` argument in your next Maven run, to enable the new p
mvn dependency:get -Psnapshot -Dartifact='org.kurento:kurento-client:6.12.0-SNAPSHOT'
If you don't want to change all your Maven commands, it is possible to mark the profile as active by default. This way, a ``-Psnapshot`` argument will always be implicitly added, so all calls to Maven will already use the profile:
.. code-block:: xml
<settings>
...
<profiles>
<profile>
<id>snapshot</id>
...
</profile>
</profiles>
<activeProfiles>
<activeProfile>snapshot</activeProfile>
</activeProfiles>
...
</settings>
Per-Project config
------------------
This method consists on explicitly adding access to the snapshots repository, for a specific project. Open the project's ``pom.xml`` and include this:
.. code-block:: xml
<project>
...
<repositories>
<repository>
<id>kurento-github-public</id>
<name>Kurento GitHub Maven packages (public access)</name>
<url>https://public:&#103;hp_tFHDdd4Nh9GqKSaoPjnFIXrb0PFsUh258gzV@maven.pkg.github.com/kurento/*</url>
<releases>
<enabled>false</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>kurento-github-public</id>
<name>Kurento GitHub Maven packages (public access)</name>
<url>https://public:&#103;hp_tFHDdd4Nh9GqKSaoPjnFIXrb0PFsUh258gzV@maven.pkg.github.com/kurento/*</url>
<releases>
<enabled>false</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
</pluginRepository>
</pluginRepositories>
...
</project>
Afterwards, in the same ``pom.xml``, look for the desired dependency and change its version to a snapshot one. For example:
.. code-block:: xml
<dependency>
<groupId>org.kurento</groupId>
<artifactId>kurento-client</artifactId>
<version>6.12.0-SNAPSHOT</version>
</dependency>
Kurento JavaScript Client
Expand Down
2 changes: 1 addition & 1 deletion source/user/troubleshooting.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Then, please provide us with information about the crash:

* Finally, if a developer suspects that the crash might be due to a memory corruption error, we could ask you to run with a special build of Kurento that comes bundled with support for `AddressSanitizer <https://github.com/google/sanitizers/wiki/AddressSanitizer>`__, a memory access error detector.

To do this, you'll need to run a `Kurento Docker image with AddressSanitizer <https://hub.docker.com/r/kurento/kurento-media-server-dev/tags?name=asan>`__. If we ask for it, you would have to provide the `Docker logs <https://docs.docker.com/engine/reference/commandline/logs/>`__ from running this image.
To do this, you'll need to run a `Kurento Docker image with AddressSanitizer <https://hub.docker.com/r/kurento/kurento-media-server/tags?name=asan>`__. If we ask for it, you would have to provide the `Docker logs <https://docs.docker.com/engine/reference/commandline/logs/>`__ from running this image.

For this reason (and also for better test repeatability), it's a very good idea that you have your services planned in a way that it's possible to **run Kurento Media Server from Docker**, at any time, regardless of what is your normal / usual method of deploying Kurento.

Expand Down
16 changes: 9 additions & 7 deletions source/user/writing_modules.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -314,13 +314,15 @@ Finally, to actually use the module in your Maven project, you have to add the d
.. code-block:: xml
<project>
<dependencies>
<dependency>
<groupId>org.kurento.module</groupId>
<artifactId>{modulename}</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>
</dependencies>
...
<dependencies>
<dependency>
<groupId>org.kurento.module</groupId>
<artifactId>{modulename}</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>
</dependencies>
...
</project>
Note that ``{modulename}`` is the name of your module in all lowercase.
Expand Down

0 comments on commit 9a8423a

Please sign in to comment.