Installing from virtualbox image

This is a standalone installation of felyx containing the whole back-end and front-end.

run virtualbox:

virtualbox

Import the felyx virtual image from File > Import Appliance.

Two users are configured by default: * root (login: root, password: root) * felyx (login: felyx, password: felyx)

Note

unless you have to install system packages, you only have to connect with felyx login to use felyx.

Using shared folders

First you need to set up two shared folders (the existing storage space in the VM is too limited):

  • data for all the data to be read or written
  • index for the elasticsearch index (where the metrics and metadata are stored)

Warning

both shared folder must have read and write permissions from the VM.

Note

the database used by django framework in felyx front-end is stored in the VM.

To share a folder, click on Settings > Shared Folders, add a folder on your host machine (or mounted on your machine) and name it. These folders must have write permissions. Don’t select automount or read-only.

Important

You must use the names provided above (index and data) or they will not be mounted automatically when starting the virtual machine.

Here is an example of configuration of the shared folders:

_images/virtualbox_sharedfolder_index.png _images/virtualbox_sharedfolder_data.png

Setting up redirections

Setting up redirections allows to later access the felyx GUIs from your host environment. The virtualbox VM is a bareback installation and does not contain any graphical desktop environment.

We will set up redirections for the following GUIs:

  • the felyx configuration and analysis interface (port 80)
  • elasticsearch monitoring interface (port 9200)
  • rabbitMQ monitoring interface (port 15672)
  • ssh (port 22) in order to connect to the virtual machine from your host

In the network configuration of your virtualbox, click on Port forwarding, and add the following redirections:

_images/virtualbox_redirections.png

Set up your VM memory

Depending on the volume of the data you want to process, you should adjust the memory of your VM before starting it. We recommend at least 4-5 GB of memory. In case the memory amount is too low, the production of the miniprods will fail.

To adjust the memory, go to Settings > System.

Start felyx

Start your virtual machine.

Log in as felyx.

To check that you shared folders have been correctly mounted, type:

mount

You should get something like:

_images/virtualbox_mount.png

Start felyx:

./start_felyx

Some services (postgresql, nginx or elasticsearch) may not be started correctly. You can check if they are alive with ps aux command:

ps aux | grep elasticsearch

You can also start them individually, for instance:

sudo service elasticsearch restart

To access the felyx backend commands, you will have first to load the virtual environment. In a terminal on your virtual machine, enter:

source ./worker/bin/activate

Access felyx web GUI

Using the redirections set up above, you can now access the felyx main GUI at: http://localhost:7319