WebGUI Installation

Installation of the WebGUI

Download the Yarra WebGUI binary package from the Download page and extract the folder in our Yarra installation path (using a terminal shell with the yarraserver account):

This will create a subfolder called webgui in your Yarra installation path, where the binaries and support files of the WebGUI are located.

The WebGUI can be started by calling the executable YarraWebGUI. However, it is strongly recommended to install the WebGUI as Linux daemon instead (similar to the YarraServer itself). This ensures that the WebGUI is automatically started when the server is rebooted, and it ensures that the WebGUI is immediately restarted in the case that it should crash.

To install the WebGUI as Daemon, follow these steps: Open the file yarrawebgui.conf in an editor such as gedit:

By default, the file content should read:

Depending on the location of your YarraServer installation, it might be necessary to adjust the lines “env DIR=”, “env USER=”, and “env QTLIB=” (see also YarraServer Configuration).

Note: Ubuntu 14.04
Please see these notes regarding required changes for compatibility with Ubuntu 14.04 LTS.

Afterwards, copy the file to the directory /etc/init:

 

Configuration

All settings of the WebGUI are contained in the file YarraWebGUI.ini, which is located in the folder webgui. Below, you can see a sample configuration:

By default, the WebGUI runs on port 8080, which means that the WebGUI can be accessed from any browser by entering the URL http://x.x.x.x:8080 where x.x.x.x is the IP address of the Yarra server. If necessary, the port number can be modified.

When accessing the URL, it is necessary to login using a username  and password. Up to 100 different user accounts can be defined in the configuration file (using separate sections  with increasing index number [User1], [User2], [User3], …).

Three different access levels can be selected for each user. Level 1 is a view-only mode, which is intended, e.g., for technicians to monitor the reconstruction queue. Level 2 allows deleting or modifying scheduled tasks (e.g., changing the reconstruction mode or adding notification recipients), restarting failed tasks, or viewing log files. This mode should assigned to managers or researchers that Yarra for their studies. Finally, Level 3 allows controlling the server (shutdown / restart) and modifying the configuration. This user level should only be assigned to the administrators of the server.

 

Starting and Stopping the WebGUI

To start the WebGUI, type the following command (using the administrator account):

If you need to stop (or restart) the WebGUI, type:

Note that it is necessary to restart the WebGUI before changes to the configuration become effective. Starting and stopping the WebGUI with the above commands requires a shell under the administrator account. To enable this without the administrator password, add both commands to the /etc/sudoers file (see bottom of page YarraServer Configuration).