Commit 25eb1d37 authored by Francesc Guasch's avatar Francesc Guasch
Browse files

doc: improved distributions install

parent 027fda3b
......@@ -7,10 +7,10 @@ Requirements
OS
--
Ravada works in any Linux distribution but we only support the package for `Ubuntu <https://www.ubuntu.com/download/>`_ server
Ravada works in any Linux distribution but we only support the package for `Ubuntu <https://www.ubuntu.com/download/>`_ , Debian
and `Fedora <https://getfedora.org/es/>`_ server.
Follow this `guide <http://disbauxes.upc.es/code/installing-and-using-ravadavdi-on-debian-jessie/>`_ if you prefer Debian Jessie.
You can also install Ravada using Docker.
Hardware
--------
......@@ -22,7 +22,8 @@ Memory
RAM is the main issue. Multiply the number of concurrent workstations by
the amount of memory each one requires and that is the total RAM the server
must have.
must have. However, recent virtualization improvements allow you to overcommit
the memory.
Disks
~~~~~
......@@ -36,125 +37,12 @@ Install 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 18.04 LTS (bionic).
We provide *deb* Ubuntu packages. Download it from the `UPC ETSETB
repository <http://infoteleco.upc.edu/img/debian/>`__.
Install *libmojolicious-plugin-renderfile-perl* package:
.. prompt:: bash $
sudo apt-get install libmojolicious-plugin-renderfile-perl
Then install the ravada package. Choose the one that matches your OS release:
- ravada_0.5.1_ubuntu-18.04_all.deb
- ravada_0.5.1_ubuntu-18.10_all.deb
- ravada_0.5.1_ubuntu-19.04_all.deb
- ravada_0.5.1_debian-10_all.deb
When you run dpkg now it may show some errors, it is ok, keep reading.
.. prompt:: bash $
wget http://infoteleco.upc.edu/img/debian/ravada_0.5.1_ubuntu-18.04_all.deb
sudo dpkg -i ravada_0.5.1_ubuntu-18.04_all.deb
The last command will show a warning about missing dependencies. Install
them running:
.. prompt:: bash $
sudo apt-get update
sudo apt-get -f install
Debian Release
~~~~~~~~~~~~~~
If you are using the Debian release you must enable spice KVM manually:
.. prompt:: bash $
sudo ln -s /usr/bin/kvm /usr/bin/kvm-spice
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 mysql-server
After completion of mysql installation, run command:
.. prompt:: bash $
sudo mysql_secure_installation
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.
.. Warning:: When installing MySQL you wont be asked for a password, you can set a password for the root user in MySQL via *mysql_secure_installation* or type your user's password when it ask's you for a password.
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 $
Ravada can be installed from package or using docker.
sudo /usr/sbin/rvd_back --add-user user.name
* `Ubuntu<http://ravada.readthedocs.io/en/latest/docs/INSTALL_ubuntu.html>`_
* `Debian<http://ravada.readthedocs.io/en/latest/docs/INSTALL_debian.html>`_
* `RedHat Fedora<http://ravada.readthedocs.io/en/latest/docs/INSTALL_fedora.html>`_
* `Docker<http://ravada.readthedocs.io/en/latest/docs/INSTALLfromDockers.rst>`_
Client
------
......@@ -165,7 +53,7 @@ package for linux and it can also be downloaded for windows.
Run
---
The Ravada server is now installed, learn
When Ravada is installed, learn
`how to run and use it <http://ravada.readthedocs.io/en/latest/docs/production.html>`__.
Help
......
Install Ravada in Debian
========================
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.
Debian
------
This is the guide to install Ravada in Debian Buster.
Follow this `guide <http://disbauxes.upc.es/code/installing-and-using-ravadavdi-on-debian-jessie/>`_ if you prefer Debian Jessie.
We provide *deb* packages. Download it from the `UPC ETSETB
repository <http://infoteleco.upc.edu/img/debian/>`__.
Install *libmojolicious-plugin-renderfile-perl* package:
.. prompt:: bash $
sudo apt-get install libmojolicious-plugin-renderfile-perl
Then install the ravada package. Choose the one that matches your OS release:
- ravada_0.5.1_debian-10_all.deb
When you run dpkg now it may show some errors, it is ok, keep reading.
.. prompt:: bash $
wget http://infoteleco.upc.edu/img/debian/ravada_0.5.1_debian-10_all.deb
sudo dpkg -i ravada_0.5.1_debian-10_all.deb
The last command will show a warning about missing dependencies. Install
them running:
.. prompt:: bash $
sudo apt-get update
sudo apt-get -f install
Debian KVM
~~~~~~~~~~
You must enable spice KVM manually:
.. prompt:: bash $
sudo ln -s /usr/bin/kvm /usr/bin/kvm-spice
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 mysql-server
After completion of mysql installation, run command:
.. prompt:: bash $
sudo mysql_secure_installation
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.
.. Warning:: When installing MySQL you wont be asked for a password, you can set a password for the root user in MySQL via *mysql_secure_installation* or type your user's password when it ask's you for a password.
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 user.name
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.
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 18.04 LTS (bionic).
We provide *deb* Ubuntu packages. Download it from the `UPC ETSETB
repository <http://infoteleco.upc.edu/img/debian/>`__.
Install *libmojolicious-plugin-renderfile-perl* package:
.. prompt:: bash $
sudo apt-get install libmojolicious-plugin-renderfile-perl
Then install the ravada package. Choose the one that matches your OS release:
- ravada_0.5.1_ubuntu-18.04_all.deb
- ravada_0.5.1_ubuntu-18.10_all.deb
- ravada_0.5.1_ubuntu-19.04_all.deb
When you run dpkg now it may show some errors, it is ok, keep reading.
.. prompt:: bash $
wget http://infoteleco.upc.edu/img/debian/ravada_0.5.1_ubuntu-18.04_all.deb
sudo dpkg -i ravada_0.5.1_ubuntu-18.04_all.deb
The last command will 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 mysql-server
After completion of mysql installation, run command:
.. prompt:: bash $
sudo mysql_secure_installation
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.
.. Warning:: When installing MySQL you wont be asked for a password, you can set a password for the root user in MySQL via *mysql_secure_installation* or type your user's password when it ask's you for a password.
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 user.name
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.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment