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):
|
1 2 |
cd yarra unzip yarrawebgui_xx.zip |
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:
|
1 |
gedit yarrawebgui.conf |
By default, the file content should read:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
description "YarraWebGUI" start on (net-device-up and local-filesystems and runlevel [2345]) stop on runlevel [016] respawn env USER=yarraserver env DIR=/home/yarraserver/yarra/webgui/ env BIN=YarraWebGUI env QTLIB=/home/yarraserver/Qt5.2.1/5.2.1/gcc_64/lib script cd $DIR export LD_LIBRARY_PATH="$QTLIB:$LD_LIBRARY_PATH" exec su $USER -c "$DIR$BIN" emit yarrawebgui_running end script |
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).
Afterwards, copy the file to the directory /etc/init:
|
1 |
cp yarrawebgui.conf /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:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 |
;### Yarra WebGUI Configuration ### [Setup] ;# Specifies the port for the webgui (added to the URL in the browser) Port=8080 ;# Location of the Yarra installation on the server YarraPath=/home/yarraserver/yarra ;# Definition of user accounts (up to 100 users) ;# Level 3 = Administrators (includes rights to control the server) ;# Level 2 = Managers (includes rights to modify tasks) ;# Level 1 = Techs (view-only rights for the task queue) [User1] Name=admin Password=password Level=3 [User2] Name=account2 Password=password Level=2 |
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):
|
1 |
sudo start yarrawebgui |
If you need to stop (or restart) the WebGUI, type:
|
1 |
sudo stop yarrawebgui |
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).