Page tree
Skip to end of metadata
Go to start of metadata




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


 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
tar xfz apache-tomcat-X.Y.Z.tar.gz -C /opt


  • 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/*

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:
MAXIMA für RHEL/Fedora/CentOS
sudo yum install maxima
  • Installation on Debian/Ubuntu/Mint:
MAXIMA für Debian/Ubuntu/Mint
sudo yum install maxima

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

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

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.

  • No labels