Skip to content
This repository has been archived by the owner on Jul 12, 2023. It is now read-only.

Commit

Permalink
install: minor clarifications to install instructions
Browse files Browse the repository at this point in the history
Also add some links to the Kurento Docker images
  • Loading branch information
j1elo committed Apr 22, 2020
1 parent c8ff233 commit 639c6fa
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 16 deletions.
22 changes: 13 additions & 9 deletions source/user/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,11 +86,7 @@ Local Installation

With this method, you will install Kurento Media Server from the native Ubuntu package repositories made available by the Kurento project. KMS has explicit support for two Long-Term Support (*LTS*) versions of Ubuntu: **Ubuntu 16.04 (Xenial)** and **Ubuntu 18.04 (Bionic)** (64-bits only).

.. note::

This section applies **only for a first time installation**. If you already have installed Kurento and want to upgrade it, follow instead the steps described here: :ref:`installation-local-upgrade`.

To install KMS, start from a clean machine (**with no KMS or any of its dependencies already installed**). Open a terminal, and follow these steps:
Open a terminal and run these commands:

1. Make sure that GnuPG is installed.

Expand Down Expand Up @@ -119,12 +115,16 @@ To install KMS, start from a clean machine (**with no KMS or any of its dependen
3. Install KMS:

.. note::

This step applies **only for a first time installation**. If you already have installed Kurento and want to upgrade it, follow instead the steps described here: :ref:`installation-local-upgrade`.

.. code-block:: text
sudo apt-get update && sudo apt-get install --no-install-recommends --yes \
kurento-media-server
This will install the release KMS version.
This will install the release version of Kurento Media Server.

The server includes service files which integrate with the Ubuntu init system, so you can use the following commands to start and stop it:

Expand All @@ -142,7 +142,7 @@ Log messages from KMS will be available in ``/var/log/kurento-media-server/``. F
Local Upgrade
=============

To upgrade a local installation of Kurento Media Server, you have to edit the file ``/etc/apt/sources.list.d/kurento.list`` that was created on :ref:`installation-local`, to write the new version number. After changing that file, you can choose between 2 options to actually apply the upgrade:
To upgrade a local installation of Kurento Media Server, you have to write the new version number into the file ``/etc/apt/sources.list.d/kurento.list``, which was created during :ref:`installation-local`. After editing that file, you can choose between 2 options to actually apply the upgrade:

A. **Upgrade all system packages**.

Expand All @@ -152,7 +152,7 @@ A. **Upgrade all system packages**.
sudo apt-get update && sudo apt-get dist-upgrade
However, don't do this inside a Docker container. Running *apt-get upgrade* or *apt-get dist-upgrade* is frowned upon by the `Docker best practices <https://docs.docker.com/develop/develop-images/dockerfile_best-practices/#apt-get>`__; instead, you should just move to a newer version of the Kurento Docker image.
However, don't do this inside a Docker container. Running *apt-get upgrade* or *apt-get dist-upgrade* is frowned upon by the `Docker best practices`_; instead, you should just move to a newer version of the `Kurento Docker images`_.

B. **Uninstall the old Kurento version**, before installing the new one.

Expand Down Expand Up @@ -298,10 +298,14 @@ You should get a response similar to this one:
HTTP/1.1 500 Internal Server Error
Server: WebSocket++/0.7.0
Ignore the error line: it is an expected error, because ``curl`` does not talk the Kurento protocol. We just checked that the ``WebSocket++`` server is actually up, and listening for connections. If you wanted, you could automate this check with a script similar to `healthchecker.sh`_, the one we use in Kurento Docker images.
Ignore the error line: it is an expected error, because ``curl`` does not talk the Kurento protocol. We just checked that the ``WebSocket++`` server is actually up, and listening for connections. If you wanted, you could automate this check with a script similar to `healthchecker.sh`_, the one we use in `Kurento Docker images`_.



.. Links
.. _Amazon Web Services: https://aws.amazon.com
.. _Coturn: https://github.com/coturn/coturn
.. _healthchecker.sh: https://github.com/Kurento/kurento-docker/blob/master/kurento-media-server/healthchecker.sh
.. _Docker best practices: https://docs.docker.com/develop/develop-images/dockerfile_best-practices/#apt-get
.. _Kurento Docker images: https://hub.docker.com/r/kurento/kurento-media-server
14 changes: 7 additions & 7 deletions source/user/installation_dev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,9 @@ Kurento's Docker Hub contains images built from each KMS nightly version. Just h
Local Installation
------------------

The steps to install a nightly version of Kurento Media Server are pretty much the same as those explained in :ref:`installation-local`, with the only change of using a different package repository.
The steps to install a nightly version of Kurento Media Server are pretty much the same as those explained in :ref:`installation-local` -- with the only change of using ``dev`` instead of a version number, in the file ``/etc/apt/sources.list.d/kurento.list``.

.. note::

This section applies **only for a first time installation**. If you already have installed Kurento and want to upgrade it, follow instead the steps described here: :ref:`installation-local-upgrade`.

To install KMS, start from a clean machine (**with no KMS or any of its dependencies already installed**). Open a terminal, and follow these steps:
Open a terminal and run these commands:

1. Make sure that GnuPG is installed.

Expand Down Expand Up @@ -77,12 +73,16 @@ To install KMS, start from a clean machine (**with no KMS or any of its dependen
3. Install KMS:

.. note::

This step applies **only for a first time installation**. If you already have installed Kurento and want to upgrade it, follow instead the steps described here: :ref:`installation-local-upgrade`.

.. code-block:: text
sudo apt-get update && sudo apt-get install --no-install-recommends --yes \
kurento-media-server
This will install the latest KMS nightly version.
This will install the nightly version of Kurento Media Server.



Expand Down

0 comments on commit 639c6fa

Please sign in to comment.