Zum Inhalt springen

Änderungen von Dokument 03 Projekt Setupguide ONYX

Zuletzt geändert von Carina Enke am 19.02.2024
Von Version 288.1
bearbeitet von Carina Enke
am 05.03.2018
Änderungskommentar: Mittels Scroll Versions veröffentlicht aus dem Bereich ONYXintern und Version 8.6.
Auf Version 275.1
bearbeitet von Carina Enke
am 22.01.2020
Änderungskommentar: Mittels Scroll Versions veröffentlicht aus dem Bereich ONYXintern und Version 8.9.

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -1,22 +1,10 @@
1 1  {{sv-translation language="de"}}
2 2  {{layout}}
3 -{{layout-section ac:type="two_right_sidebar"}}
4 -{{layout-cell}}
5 -====== Inhalt: ======
6 -
7 -
8 -
9 -{{toc maxLevel="5" outline="true" absoluteUrl="true" style="square"/}}
10 -{{/layout-cell}}
11 -
12 -{{layout-cell}}
13 -
14 -
15 -
16 -{{/layout-cell}}
3 +{{layout-section ac:type="single"}}
4 +{{layout-cell}}{{/layout-cell}}
17 17  {{/layout-section}}
18 18  
19 -{{layout-section ac:type="single"}}
7 +{{layout-section ac:type="two_right_sidebar"}}
20 20  {{layout-cell}}
21 21  == System requirements ==
22 22  
... ... @@ -26,10 +26,10 @@
26 26  Linux-based OS
27 27  )))
28 28  * (((
29 -Oracle Java8 (latest update)
17 +Java 11 (latest update, Oracle or OpenJDK)
30 30  )))
31 31  * (((
32 -Apache Tomcat8 (latest update)
20 +Apache Tomcat 9 (latest update)
33 33  )))
34 34  
35 35  === ONYX Editor (additionally) ===
... ... @@ -45,16 +45,33 @@
45 45  === Build process ===
46 46  
47 47  * Linux-based OS
48 -* Oracle Java7 (latest update)
36 +* Java 11 (latest update, Oracle or OpenJDK)
49 49  * Eclipse for JEE (Kepler or later)
50 50  * Maven2
51 51  * Eclipse Maven integration (m2)
40 +{{/layout-cell}}
52 52  
42 +{{layout-cell}}
43 +{{scroll-ignore}}
44 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
45 +
46 +
47 +{{toc/}}
48 +
49 +**
50 +**
51 +{{/panel}}
52 +{{/scroll-ignore}}
53 +{{/layout-cell}}
54 +{{/layout-section}}
55 +
56 +{{layout-section ac:type="single"}}
57 +{{layout-cell}}
53 53  == Steps for build ==
54 54  
55 55  All ONYX parts are delivered as Eclipse projects
56 56  
57 -
62 +\\
58 58  
59 59  * preOnyx (ONYX QTI test player)
60 60  * preWebEditor (ONYX QTI test editor)
... ... @@ -86,7 +86,7 @@
86 86  * Create database owe and assign to user owe
87 87  * Import setupdatabase.postgre.sql to this database
88 88  
89 -
94 +\\
90 90  
91 91  Hint: you may use other user/database names, change configuration in
92 92  
... ... @@ -128,7 +128,7 @@
128 128  
129 129  When run from Eclipse/Tomcat ONYX applications may not shut down properly. In this case just “kill” them using the red “Terminate” button in console view.
130 130  
131 -In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with **4GB each**.
136 +In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with **8 GB each**.
132 132  
133 133  **
134 134  **
... ... @@ -139,24 +139,10 @@
139 139  
140 140  {{sv-translation language="en"}}
141 141  {{layout}}
142 -{{layout-section ac:type="two_equal"}}
147 +{{layout-section ac:type="two_right_sidebar"}}
143 143  {{layout-cell}}
144 -====== Content: ======
149 +== System requirements ==
145 145  
146 -
147 -
148 -{{toc maxLevel="5" outline="true" absoluteUrl="true" style="square"/}}
149 -{{/layout-cell}}
150 -
151 -{{layout-cell}}
152 -
153 -{{/layout-cell}}
154 -{{/layout-section}}
155 -
156 -{{layout-section ac:type="single"}}
157 -{{layout-cell}}
158 -== System requirements ==
159 -
160 160  === All components ===
161 161  
162 162  * (((
... ... @@ -163,10 +163,10 @@
163 163  Linux-based OS
164 164  )))
165 165  * (((
166 -Oracle Java8 (latest update)
157 +Java 11 (Oracle or OpenJDK)
167 167  )))
168 168  * (((
169 -Apache Tomcat8 (latest update)
160 +Apache Tomcat 9
170 170  )))
171 171  
172 172  === ONYX WebEditor (additionally) ===
... ... @@ -182,33 +182,58 @@
182 182  === Build process ===
183 183  
184 184  * Linux-based OS
185 -* Oracle Java7 (latest update)
176 +* Java 11 (Oracle or OpenJDK)
186 186  * Eclipse for JEE (Kepler or later)
187 187  * Maven2
188 188  * Eclipse Maven integration (m2)
180 +{{/layout-cell}}
189 189  
182 +{{layout-cell}}
183 +{{scroll-ignore}}
184 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
185 +
186 +
187 +{{toc maxLevel="4"/}}
188 +
189 +**
190 +**
191 +{{/panel}}
192 +{{/scroll-ignore}}
193 +{{/layout-cell}}
194 +{{/layout-section}}
195 +
196 +{{layout-section ac:type="single"}}
197 +{{layout-cell}}
190 190  == Steps for build ==
191 191  
192 192  All ONYX parts are delivered as Eclipse projects:
193 193  
194 -* preWebOnyx (ONYX QTI test player)
195 -* preWebEditor (ONYX QTI test editor)
196 -* onyx (ONYX QTI core)
197 197  * (((
203 +preWebOnyx (ONYX QTI test player)
204 +)))
205 +* (((
206 +preWebEditor (ONYX QTI test editor)
207 +)))
208 +* (((
209 +onyx (ONYX QTI core)
210 +)))
211 +* (((
198 198  LaTeXRenderer (LaTeX image renderer connector, used to render LaTeX math formulas to images, which can be included in PDFs. This project only offers an interface to connect whatever lib you want, e.g. jlatexmath (GPL, delivered as example)
199 199  )))
200 200  
201 201  Use Eclipse:
202 202  
203 -* Import -> Existing project, start with LaTeXRenderer project
204 -* Import all four projects
217 +* (((
218 +Import -> Existing project, start with LaTeXRenderer project
219 +)))
220 +* (((
221 +Import all four projects
222 +)))
205 205  
206 206  Due to license restrictions the **project LaTeXRenderer** is not linked or integrated by default. This must be done manually.
207 207  
208 208  {{code}}
209 -Ensure that project dependency from preWebOnyx and preWebEditor to LaTeXRenderer is fulfilled.
210 -Ensure that project LaTeXRenderer exports all libs in /libs folder (you may get ClassNotFoundExceptions in Tomcat otherwise, if you still get them add all libs from project LaTeXRenderer to Tomcat classpath manually)
211 -
227 +Ensure that project dependency from preWebOnyx and preWebEditor to LaTeXRenderer is fulfilled. Ensure that project LaTeXRenderer exports all libs in /libs folder (you may get ClassNotFoundExceptions in Tomcat otherwise, if you still get them add all libs from project LaTeXRenderer to Tomcat classpath manually)
212 212  {{/code}}
213 213  
214 214  **Maven will build all projects automatically** (you can do this manually on console, anyhow this is not tested in development environment and may disturb Eclipse Maven integration)
... ... @@ -215,13 +215,23 @@
215 215  
216 216  **Setup database for ONYX WebEditor**
217 217  
218 -* Locate setupdatabase.postgre.sql
219 -* Log on to Postgres
220 -* Create user owe with password owe
221 -* Create database owe and assign to user owe
222 -* Import setupdatabase.postgre.sql to this database
234 +* (((
235 +Locate setupdatabase.postgre.sql
236 +)))
237 +* (((
238 +Log on to Postgres
239 +)))
240 +* (((
241 +Create user owe with password owe
242 +)))
243 +* (((
244 +Create database owe and assign to user owe
245 +)))
246 +* (((
247 +Import setupdatabase.postgre.sql to this database
248 +)))
223 223  
224 -
250 +\\
225 225  
226 226  Hint: you may use other user/database names, change configuration in
227 227  
... ... @@ -229,43 +229,67 @@
229 229  applicationContext.xml (see below)
230 230  {{/code}}
231 231  
232 -== Changes on ONYX QTI core ==
258 +Changes on ONYX QTI core
233 233  
234 234  Since all ONYX components are managed by Maven, the ONYX QTI core from BPS Maven artifactory is used by default. If you want to change some code you are required to create a JAR from project onyx on your own and either adopt the pom.xml references in preWebOnyx and preWebEditor to your own artifactory or put the JAR in classpath.
235 235  
236 -== Configuration ==
262 +Configuration
237 237  
238 238  **preWebOnyx**
239 239  
240 -* Locate onyxplugin.default.config.xml, copy it to a classpath folder and rename to//onyxplugin.config.xml//
241 -* Configure as needed
242 -* Service provider named “preview” is required if used as preview instance for ONYX WebEditor
266 +* (((
267 +Locate onyxplugin.default.config.xml, copy it to a classpath folder and rename to//onyxplugin.config.xml//
268 +)))
269 +* (((
270 +Configure as needed
271 +)))
272 +* (((
273 +Service provider named “preview” is required if used as preview instance for ONYX WebEditor
274 +)))
243 243  
244 244  **preWebEditor**
245 245  
246 -* applicationContext.xml: general configurations (database, mail configuration, preview ONYX (you can change this to your local installation), ...)
247 -* metadataConfigurationContext.xml: normally no changes needed as long as no further metadata are required
248 -* moduleConfigurationContext.xml: repository configuration
249 -* pageModelContext.xml: normally no changes required, defines the main tabs in shown application
250 -* webServiceContext.xml: reporter statistics connection, can be changed to your local ONYX installation
278 +* (((
279 +applicationContext.xml: general configurations (database, mail configuration, preview ONYX (you can change this to your local installation), ...)
280 +)))
281 +* (((
282 +metadataConfigurationContext.xml: normally no changes needed as long as no further metadata are required
283 +)))
284 +* (((
285 +moduleConfigurationContext.xml: repository configuration
286 +)))
287 +* (((
288 +pageModelContext.xml: normally no changes required, defines the main tabs in shown application
289 +)))
290 +* (((
291 +webServiceContext.xml: reporter statistics connection, can be changed to your local ONYX installation
292 +)))
251 251  
252 -== Deployment ==
294 +Deployment
253 253  
254 -* Deploy preWebOnyx and preWebEditor to Tomcat in Eclipse (it is recommended to use two Tomcat servers in Eclipse to be able to restart both independently)
255 -* Configure Tomcat deployment to use different ports
256 -* Check path the applications are mounted to
257 -* Start Tomcat(s)
258 258  * (((
297 +Deploy preWebOnyx and preWebEditor to Tomcat in Eclipse (it is recommended to use two Tomcat servers in Eclipse to be able to restart both independently)
298 +)))
299 +* (((
300 +Configure Tomcat deployment to use different ports
301 +)))
302 +* (((
303 +Check path the applications are mounted to
304 +)))
305 +* (((
306 +Start Tomcat(s)
307 +)))
308 +* (((
259 259  Call http:~/~/localhost:<port>/<path> in browser
260 260  )))
261 261  
262 -== Important notes ==
312 +Important notes
263 263  
264 264  **Before running any ONYX application** in Eclipse/Tomcat, always **clean Tomcat Work Directory** first. This is also required in server environment after each update. Since ONYX creates large amounts of temporary files in server environment it is also strictly recommended to clean servers and tomcat temp directory before each application starts.
265 265  
266 266  When run from Eclipse/Tomcat ONYX applications may not shut down properly. In this case just “kill” them using the red “Terminate” button in console view.
267 267  
268 -In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with **4GB each**.
318 +In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with **8 GB each**.
269 269  {{/layout-cell}}
270 270  {{/layout-section}}
271 271  {{/layout}}
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -226230564
1 +301073241
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/226230564/Projekt Setupguide ONYX
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/301073241/Projekt Setupguide ONYX