Version 362.1 von Carina Enke am 19.12.2023

Zeige letzte Bearbeiter
1
2 {{layout}}
3 {{layout-section ac:type="single"}}
4 {{layout-cell}}{{/layout-cell}}
5 {{/layout-section}}
6
7 {{layout-section ac:type="two_right_sidebar"}}
8 {{layout-cell}}
9 == Requirements ==
10
11 * Java 17 (Oracle or OpenJDK) and Apache Tomcat 9
12 * Apache Webserver with proxy_ajp and mod_rewrite (optional)
13 * MAXIMA for the use of calculations (mandatory)
14 {{/layout-cell}}
15
16 {{layout-cell}}
17 {{scroll-ignore}}
18 {{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
19
20
21 {{toc/}}
22
23 **
24 **
25 {{/panel}}
26 {{/scroll-ignore}}
27 {{/layout-cell}}
28 {{/layout-section}}
29
30 {{layout-section ac:type="single"}}
31 {{layout-cell}}
32 == Download ==
33
34 * 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"]])
35
36 {{code language="powershell"}}
37 tar xfz jdk-xyz-linux-x64.tar.gz -C /opt
38 {{/code}}
39
40 * Let the environment variable $JAVA_HOME point to the JDK directory:
41
42 {{code language="powershell"}}
43 export JAVA_HOME=/opt/jdkX.Y.Z
44 {{/code}}
45
46 * Download and install Tomcat 9: [[https:~~/~~/tomcat.apache.org/download-90.cgi>>url:https://tomcat.apache.org/download-90.cgi||title="Verknüpfung folgen" rel="nofollow" shape="rect"]]
47
48 {{code language="powershell"}}
49 tar xfz apache-tomcat-X.Y.Z.tar.gz -C /opt
50 {{/code}}
51
52 === Download and install libraries ===
53
54 {{code language="powershell"}}
55 yum install atk nss at-spi2-atk libXcomposite alsa-lib libXrandr libxkbcommon libXdamage cups-libs
56 {{/code}}
57
58 == Deployment ==
59
60 * Stop your Tomcat
61 * In case of an **update**, delete old ONYX war-files and dirs from ${TOMCAT_HOME}/webapps
62 * It might be useful to clear the work and temp directory of the Tomcat Server:
63
64 {{code language="powershell"}}
65 rm -rf ${TOMCAT_HOME}/temp/* ${TOMCAT_HOME}/work/*
66 {{/code}}
67
68 (% class="_mce_tagged_br" %)
69 * Copy the onyx-player-**X.X**.war to ${TOMCAT_HOME}/webapps
70 * Start your Tomcat
71 * 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"]]
72
73 == Configuration of additional features ==
74
75 === Show example tests on your ONYX Player start page ===
76
77 * Save the zip-files in /src/main/resources/tests
78 * Set showinternaltests to true (onyxplugin.config.xml)
79
80 === Provide an upload functionality for tests on your ONYX Player start page ===
81
82 * Define a folder in onyxplugin.config.xml where uploaded tests should be stored: <uploaddir>/tmp/</uploaddir>
83 * Note that this folder must exist and be writable or it must be allowed to create it.
84 * You can upload tests on your ONYX Player start page and access the tests directly via a static URL.
85
86 === Install MAXIMA, if you like to use calculations ===
87
88 * Installation on RHEL/Fedora/CentOS:
89
90 {{code language="powershell"}}
91 sudo yum install maxima
92 {{/code}}
93
94 * Installation on Debian/Ubuntu/Mint:
95
96 {{code language="powershell"}}
97 sudo yum install maxima
98 {{/code}}
99
100 * Or visit [[http:~~/~~/maxima.sourceforge.net/>>url:http://maxima.sourceforge.net/||shape="rect"]] and download the MAXIMA files
101
102 === Save user results ===
103
104 * 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 (((
105 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.
106 )))
107
108 {{code language="powershell"}}
109 <resultsdir>/tmp/onyxresults/</resultsdir> in the section <playerconfig>...</playerconfig>
110 {{/code}}
111
112 * 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.
113
114 {{code title="onyxplugin.config.xml"}}
115 <playerconfig>
116 ...
117 <!-- The timespan in days after which the result configured in resultsdir are automatically removed -->
118 <resultsdirCleanupAfterDays>30</resultsdirCleanupAfterDays>
119 ...
120 </playerconfig>
121 {code}
122 {{/code}}
123 {{/layout-cell}}
124 {{/layout-section}}
125 {{/layout}}
126
127
128
129 {{layout}}
130 {{layout-section ac:type="two_right_sidebar"}}
131 {{layout-cell}}
132 == Requirements ==
133
134 * Java 17 (Oracle or OpenJDK)
135 * Apache Tomcat 9
136 * Apache Webserver with proxy_ajp and mod_rewrite (optional)
137 * (((
138 MAXIMA for the use of calculations (mandatory)
139 )))
140 * (((
141 (% class="tw-data-text tw-text-large tw-ta" %)
142 (% class="Y2IQFc" lang="en" %)libraries
143 )))
144 {{/layout-cell}}
145
146 {{layout-cell}}
147 {{scroll-ignore}}
148 {{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
149
150
151 {{toc maxLevel="4"/}}
152
153 **
154 **
155 {{/panel}}
156 {{/scroll-ignore}}
157 {{/layout-cell}}
158 {{/layout-section}}
159
160 {{layout-section ac:type="single"}}
161 {{layout-cell}}
162 == Download ==
163
164 === Download and install Java ===
165
166 * 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"]])
167 \\
168
169 {{code language="powershell"}}
170 tar xfz jdk-xyz-linux-x64.tar.gz -C /opt
171 {{/code}}
172
173 * Let the environment variable $JAVA_HOME point to the JDK directory:
174
175 {{code language="powershell"}}
176 export JAVA_HOME=/opt/jdkX.Y.Z
177 {{/code}}
178
179 === Download and install Tomcat ===
180
181 * Download and install Tomcat 9: [[https:~~/~~/tomcat.apache.org/download-90.cgi>>url:https://tomcat.apache.org/download-90.cgi||title="Verknüpfung folgen" rel="nofollow" shape="rect"]]
182
183 {{code language="powershell"}}
184 tar xfz apache-tomcat-X.Y.Z.tar.gz -C /opt
185 {{/code}}
186
187 === Download and install libraries ===
188
189 {{code language="powershell"}}
190 yum install atk nss at-spi2-atk libXcomposite alsa-lib libXrandr libxkbcommon libXdamage cups-libs
191 {{/code}}
192
193 == (% style="line-height: 1.5;" %)Deployment(%%) ==
194
195 * Stop your Tomcat
196 * In case of an **update**, delete old ONYX war-files and dirs from ${TOMCAT_HOME}/webapps
197 * It might be useful to clear the work and temp directory of the Tomcat Server:
198
199 {{code language="powershell" title="Tomcat"}}
200 rm -rf ${TOMCAT_HOME}/temp/* ${TOMCAT_HOME}/work/*
201 {{/code}}
202
203 (% class="_mce_tagged_br" %)
204 * Copy the onyx-player-**X.X**.war to ${TOMCAT_HOME}/webapps
205 * Start your Tomcat
206 * 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"]]
207
208 == Configuration of additional features ==
209
210 === Show example tests on your ONYX Player start page ===
211
212 * Save the zip-files in /src/main/resources/tests
213 * Set showinternaltests to true (onyxplugin.config.xml)
214
215 === Provide an upload functionality for tests on your ONYX Player start page ===
216
217 * Define a folder in onyxplugin.config.xml where uploaded tests should be stored: <uploaddir>/tmp/</uploaddir>
218 * Note that this folder must exist and be writable or it must be allowed to create it.
219 * You can upload tests on your ONYX Player start page and access the tests directly via a static URL.
220
221 === Install MAXIMA, if you like to use calculations ===
222
223 * Installation on RHEL/Fedora/CentOS:
224
225 {{code language="powershell" title="MAXIMA für RHEL/Fedora/CentOS"}}
226 sudo yum install maxima
227 {{/code}}
228
229 * Installation on Debian/Ubuntu/Mint:
230
231 {{code language="powershell" title="MAXIMA für Debian/Ubuntu/Mint"}}
232 sudo yum install maxima
233 {{/code}}
234
235 * Or visit[[http:~~/~~/maxima.sourceforge.net/>>url:http://maxima.sourceforge.net/||shape="rect"]] and download the MAXIMA files
236
237 === Save user results ===
238
239 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
240
241 {{code language="powershell"}}
242 <resultsdir>/tmp/onyxresults/</resultsdir> in the section <playerconfig>...</playerconfig>
243 {{/code}}
244
245 of the file onyxplugin.config.xml and adjust the indicated directory to your server.
246
247 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.
248 {{/layout-cell}}
249 {{/layout-section}}
250 {{/layout}}