Wiki source code of Installation ONYX Player und Reporter
Last modified by Carina Enke on 05.03.2026
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
367.2 | 1 | {{section}} |
| 2 | {{column width="60%"}} | ||
| |
359.2 | 3 | == Requirements == |
| |
120.1 | 4 | |
| |
359.2 | 5 | * Java 17 (Oracle or OpenJDK) and Apache Tomcat 9 |
| 6 | * Apache Webserver with proxy_ajp and mod_rewrite (optional) | ||
| 7 | * MAXIMA for the use of calculations (mandatory) | ||
| |
367.2 | 8 | {{/column}} |
| |
120.1 | 9 | |
| |
367.2 | 10 | {{column width="30%"}} |
| |
371.1 | 11 | {{panel title="Content"}} |
| |
367.2 | 12 | {{toc start="2"/}} |
| |
359.2 | 13 | {{/panel}} |
| |
367.2 | 14 | {{/column}} |
| 15 | {{/section}} | ||
| 16 | |||
| |
120.1 | 17 | == Download == |
| 18 | |||
| |
359.2 | 19 | * Download and install OpenJDK 17 ([[https:~~/~~/jdk.java.net/java-se-ri/17>>url:https://jdk.java.net/java-se-ri/17||shape="rect"]] ) or Oracle JDK17 ([[https:~~/~~/jdk.java.net/17>>url:https://jdk.java.net/17||shape="rect"]]) |
| |
120.1 | 20 | |
| |
359.2 | 21 | {{code language="powershell"}} |
| 22 | tar xfz jdk-xyz-linux-x64.tar.gz -C /opt | ||
| |
120.1 | 23 | {{/code}} |
| 24 | |||
| 25 | * Let the environment variable $JAVA_HOME point to the JDK directory: | ||
| 26 | |||
| |
359.2 | 27 | {{code language="powershell"}} |
| 28 | export JAVA_HOME=/opt/jdkX.Y.Z | ||
| |
120.1 | 29 | {{/code}} |
| 30 | |||
| |
365.1 | 31 | * Download and install Tomcat 9: [[https:~~/~~/tomcat.apache.org/download-90.cgi>>url:https://tomcat.apache.org/download-90.cgi||rel="nofollow" shape="rect" title="Verknüpfung folgen"]] |
| |
120.1 | 32 | |
| |
359.2 | 33 | {{code language="powershell"}} |
| 34 | tar xfz apache-tomcat-X.Y.Z.tar.gz -C /opt | ||
| |
120.1 | 35 | {{/code}} |
| 36 | |||
| |
359.2 | 37 | === Download and install libraries === |
| 38 | |||
| 39 | {{code language="powershell"}} | ||
| 40 | yum install atk nss at-spi2-atk libXcomposite alsa-lib libXrandr libxkbcommon libXdamage cups-libs | ||
| 41 | {{/code}} | ||
| 42 | |||
| |
120.1 | 43 | == Deployment == |
| 44 | |||
| 45 | * Stop your Tomcat | ||
| 46 | * In case of an **update**, delete old ONYX war-files and dirs from ${TOMCAT_HOME}/webapps | ||
| 47 | * It might be useful to clear the work and temp directory of the Tomcat Server: | ||
| 48 | |||
| |
359.2 | 49 | {{code language="powershell"}} |
| |
120.1 | 50 | rm -rf ${TOMCAT_HOME}/temp/* ${TOMCAT_HOME}/work/* |
| 51 | {{/code}} | ||
| 52 | |||
| |
367.2 | 53 | |
| |
120.1 | 54 | * Copy the onyx-player-**X.X**.war to ${TOMCAT_HOME}/webapps |
| 55 | * Start your Tomcat | ||
| 56 | * Open the following URL in your browser: [[http:~~/~~/localhost:8080/onyx-player-X.X/demo>>url:http://localhost:8080/onyx-player-X.X/demo||shape="rect"]] | ||
| 57 | |||
| 58 | == Configuration of additional features == | ||
| 59 | |||
| |
359.2 | 60 | === Show example tests on your ONYX Player start page === |
| |
120.1 | 61 | |
| 62 | * Save the zip-files in /src/main/resources/tests | ||
| 63 | * Set showinternaltests to true (onyxplugin.config.xml) | ||
| 64 | |||
| |
359.2 | 65 | === Provide an upload functionality for tests on your ONYX Player start page === |
| |
120.1 | 66 | |
| 67 | * Define a folder in onyxplugin.config.xml where uploaded tests should be stored: <uploaddir>/tmp/</uploaddir> | ||
| 68 | * Note that this folder must exist and be writable or it must be allowed to create it. | ||
| 69 | * You can upload tests on your ONYX Player start page and access the tests directly via a static URL. | ||
| 70 | |||
 |
346.1 | 71 | === Install MAXIMA, if you like to use calculations === |
| |
120.1 | 72 | |
| |
346.1 | 73 | * Installation on RHEL/Fedora/CentOS: |
| |
120.1 | 74 | |
| |
359.2 | 75 | {{code language="powershell"}} |
| |
346.1 | 76 | sudo yum install maxima |
| 77 | {{/code}} | ||
| |
120.1 | 78 | |
| |
346.1 | 79 | * Installation on Debian/Ubuntu/Mint: |
| |
120.1 | 80 | |
| |
359.2 | 81 | {{code language="powershell"}} |
| |
346.1 | 82 | sudo yum install maxima |
| 83 | {{/code}} | ||
| |
120.1 | 84 | |
| |
346.1 | 85 | * Or visit [[http:~~/~~/maxima.sourceforge.net/>>url:http://maxima.sourceforge.net/||shape="rect"]] and download the MAXIMA files |
| |
120.1 | 86 | |
| |
346.1 | 87 | === Save user results === |
| |
120.1 | 88 | |
| |
359.2 | 89 | * 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 ((( |
| 90 | 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. | ||
| 91 | ))) | ||
| |
120.1 | 92 | |
| |
352.1 | 93 | {{code language="powershell"}} |
| |
346.1 | 94 | <resultsdir>/tmp/onyxresults/</resultsdir> in the section <playerconfig>...</playerconfig> |
| 95 | {{/code}} | ||
| |
120.1 | 96 | |
| |
359.2 | 97 | * 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. |
| |
346.1 | 98 | |
| |
359.2 | 99 | {{code title="onyxplugin.config.xml"}} |
| 100 | <playerconfig> | ||
| 101 | ... | ||
| 102 | <!-- The timespan in days after which the result configured in resultsdir are automatically removed --> | ||
| 103 | <resultsdirCleanupAfterDays>30</resultsdirCleanupAfterDays> | ||
| 104 | ... | ||
| 105 | </playerconfig> | ||
| |
371.1 | 106 | {code} |
| |
359.2 | 107 | {{/code}} |