Server Configuration

Directory Structure

After the initial installation the YarraServer folder has the following directory structure:

Path Purpose
fail/ Target folder for failed reconstruction tasks
finished/ Target folder for completed tasks (if data should be kept)
install/ Folder with supplementary files for the installation
log/ Folder for log files
modes/ Folder with definitions of reconstruction modes
modules/ Folder with binaries of core processing modules (shipped with Yarra)
modules_user/ Folder with binaries of custom-developed modules
queue/ Queue directory with incoming reconstruction tasks
webgui/ Folder for the web-based user interface
work/ Working directory for temporary files during processing

By default, these folders are local subfolders in the ~/yarra installation directory. However, if necessary because of a special server configuration, the paths of these directories can also be overwritten in the file YarraServer.ini (see next section). In this way, it is possible, for example, to read the reconstruction-mode files from a remote directory shared across multiple servers, which can make it easier to manage installations with multiple processing servers. Adapting the paths is also necessary when the local drives have been configured such that only limited disk space is available in the home folder for the user yarraserver. Note: To run the server, it is necessary that sufficient disk space is available in the fail, finished, queue, and work folders (disk space in the order of 1TB is recommended).


Main Configuration File

The main settings of the YarraServer are defined in the file YarraServer.ini, which is located in the installation folder /yarra. This file can be edited with any texteditor, e.g. gedit. After changing the settings in this file, it is necessary to reboot the server (see section Usage). Most settings in the file are optional. If they are not set, a default value will be used. To overwrite settings, remove the semicolon in front of the entries and write the desired value behind the equal sign.

The following box shows the default file with descriptions of the possible settings:


Queue Configuration File

In addition to the main configuration file, the queue directory contains the file YarraServer.cfg, which also contains the name of the server (and server type for future use). The purpose of this file is to provide the server information to the Yarra clients. By default, this file is write locked. To edit the file, it is necessary to first change the file permissions to (this should be done when logged in with the user yarraserver):

The following shows the content of the file. The settings should matched with the file YarraServer.ini, as described above.

After editing the file, the permission should be set back to read-only by typing:


Installing the Server as Daemon

It is possible to run the server either as normal command-shell application or as Linux daemon (system service). The latter is highly recommended when using the server routinely. When running YarraServer as daemon, it will be started automatically when the server is booted. In addition, it will be automatically restarted in the case that the software should crash for some reason. Running YarraServer as daemon is also necessary when using the Yarra WebGUI.

To install the YarraServer as daemon, open a terminal with administrator rights (admin accounts). Edit the file yarra.conf, which is located in the /install subfolder (there are separate files for different Ubuntu versions). By default, this file should read:

Depending on the location of your YarraServer installation, it is necessary to adjust the path in the line “env DIR=”. Possibly, it might also be necessary to adapt the lines “env QTLIB” (if a different QT version or installation location was used) and “env USER” (if a different user name for running YarraServer was chosen).

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

Copy the yarra.conf file to the directory /etc/init/ (this can only be done using administrator rights)

Finally, edit file /etc/sudoers by typing:

and adding the following lines at the end of the file:

Now, the configuration of the YarraServer is (almost) completed. Usage information can be found here.