Install Ravada in Ubuntu
========================

Upgrade Ravada
--------------

Follow `this guide <http://ravada.readthedocs.io/en/latest/docs/update.html>`_
if you are only upgrading Ravada from a previous version already installed.

Ubuntu
------

.. note:: We only provide support for Ubuntu 22.04 and 24.04.

We provide *deb* Ubuntu packages on the `UPC ETSETB
repository <http://infoteleco.upc.edu/img/debian/>`__.


Install the ravada package. Choose the one that matches your OS release:

- ravada_2.4.6_ubuntu-20.04_all.deb
- ravada_2.4.6_ubuntu-22.04_all.deb
- ravada_2.4.6_ubuntu-24.04_all.deb

In this example we download for Ubuntu 24.

.. prompt:: bash $

     wget http://infoteleco.upc.edu/img/debian/ravada_2.4.6_ubuntu-24.04_all.deb
     sudo apt-get update
     sudo apt install ./ravada_2.4.6_ubuntu-24.04_all.deb

The last command may show a warning about missing dependencies. Install
them running:

.. prompt:: bash $

     sudo apt-get update
     sudo apt-get -f install

Mysql Database
--------------

MySQL server
~~~~~~~~~~~~
.. Warning::  MySql required minimum version 5.6

It is required a MySQL server, it can be installed in another host or in
the same one as the ravada package.

.. prompt:: bash $

     sudo apt-get install mariadb-server

MySQL database and user
~~~~~~~~~~~~~~~~~~~~~~~

It is required a database for internal use. In this examples we call it *ravada*.
We also need an user and a password to connect to the database. It is customary to call it *rvd_user*.
In this stage the system wants you to set a password for the sql connection.

Create the database:

.. prompt:: bash $

     sudo mysqladmin -u root -p create ravada

Grant all permissions on this database to the *rvd_user*:

.. prompt:: bash $

     sudo mysql -u root -p ravada -e "create user 'rvd_user'@'localhost' identified by 'Pword12345*'"
     sudo mysql -u root -p ravada -e "grant all on ravada.* to 'rvd_user'@'localhost'"

The password chosen must fulfill the following characteristics:

    - At least 8 characters.
    - At least 1 number.
    - At least 1 special character.

Config file
~~~~~~~~~~~

Create a config file at /etc/ravada.conf with the username and password
you just declared at the previous step. Please note that you need to
edit the user and password via an editor. Here, we present Vi as an
example.

::

     sudo vi /etc/ravada.conf
    db:
      user: rvd_user
      password: Pword12345*

Ravada web user
---------------

Add a new user for the ravada web. Use rvd\_back to create it. It will perform some initialization duties in the database the very first time this script is executed.

When asked if this user is admin answer *yes*.

.. prompt:: bash $

     sudo /usr/sbin/rvd_back --add-user admin

It is possible to change the password in case you either do not remember or simply want to change it.

When prompted for the username, enter the user whose password you want to change.

.. prompt:: bash $

   sudo rvd_back --change-password

Client
------

The client must have a spice viewer such as virt-viewer. There is a
package for linux and it can also be downloaded for windows.

Run
---

The Ravada server is now installed, learn
`how to run and use it <http://ravada.readthedocs.io/en/latest/docs/production.html>`__.

Help
----

Struggling with the installation procedure ? We tried to make it easy but
let us know if you need `assistance <http://ravada.upc.edu/#help>`__.

There is also a `troubleshooting <troubleshooting.html>`__ page with common problems that
admins may face.