05 Installation ONYX Player und Reporter

Zuletzt geändert von Carina Enke am 13.02.2024

Requirements

Java 17 (Oracle or OpenJDK) and Apache Tomcat 9
Apache Webserver with proxy_ajp and mod_rewrite (optional)
MAXIMA for the use of calculations (mandatory)

Inhalt

Requirements
Download
- Download and install libraries
Deployment
Configuration of additional features

Download

Download and install OpenJDK 17 (https://jdk.java.net/java-se-ri/17 ) or Oracle JDK17 (https://jdk.java.net/17)

tar xfz jdk-xyz-linux-x64.tar.gz -C /opt

Let the environment variable $JAVA_HOME point to the JDK directory:

export JAVA_HOME=/opt/jdkX.Y.Z

Download and install Tomcat 9: https://tomcat.apache.org/download-90.cgi

tar xfz apache-tomcat-X.Y.Z.tar.gz -C /opt

Download and install libraries

yum install atk nss at-spi2-atk libXcomposite alsa-lib libXrandr libxkbcommon libXdamage cups-libs

Deployment

Stop your Tomcat
In case of an update, delete old ONYX war-files and dirs from ${TOMCAT_HOME}/webapps
It might be useful to clear the work and temp directory of the Tomcat Server:

rm -rf ${TOMCAT_HOME}/temp/* ${TOMCAT_HOME}/work/*

Copy the onyx-player-X.X.war to ${TOMCAT_HOME}/webapps
Start your Tomcat
Open the following URL in your browser: http://localhost:8080/onyx-player-X.X/demo

Configuration of additional features

Show example tests on your ONYX Player start page

Save the zip-files in /src/main/resources/tests
Set showinternaltests to true (onyxplugin.config.xml)

Provide an upload functionality for tests on your ONYX Player start page

Define a folder in onyxplugin.config.xml where uploaded tests should be stored: <uploaddir>/tmp/</uploaddir>
Note that this folder must exist and be writable or it must be allowed to create it.
You can upload tests on your ONYX Player start page and access the tests directly via a static URL.

Install MAXIMA, if you like to use calculations

Installation on RHEL/Fedora/CentOS:

sudo yum install maxima

Installation on Debian/Ubuntu/Mint:

sudo yum install maxima

Or visit http://maxima.sourceforge.net/ and download the MAXIMA files

Save user results

ONYX allows saving user results on the hard disk additionally to the transmission to the LMS. This may be useful in case results cannot be transmitted due to errors in the LMS or during the transmission process. To activate this function enter the tag
of the file onyxplugin.config.xml and adjust the indicated directory to your server. Tomcat needs a writing permission for this directory. The result files are sorted in a sub folder by date and will not be deleted. In case the result files are no longer required, deletion can be done only by administrators.

<resultsdir>/tmp/onyxresults/</resultsdir> in the section <playerconfig>...</playerconfig>

You may configure ONYX Player to automatically remove these result file copies after a certain time span. The following option can be added to the configuration to activate this. Please configure a valid days number, after which all results older than this age will be removed. This is checked and executed once after ONYX startup and will run in a background task. If not configured, this is done after 30 days.

onyxplugin.config.xml

<playerconfig>
        ...
       
       <resultsdirCleanupAfterDays>30</resultsdirCleanupAfterDays>
        ...
</playerconfig>
{code}