Zum Inhalt springen

Änderungen von Dokument 03 Projekt Setupguide ONYX

Zuletzt geändert von Carina Enke am 19.02.2024
Von Version 147.1
bearbeitet von Carina Enke
am 08.03.2022
Änderungskommentar: Mittels Scroll Versions veröffentlicht aus dem Bereich ONYXintern und Version 9.8.
Auf Version 277.1
bearbeitet von Carina Enke
am 08.05.2019
Änderungskommentar: Mittels Scroll Versions veröffentlicht aus dem Bereich ONYXintern und Version 8.7.

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -1,76 +1,25 @@
1 1  {{sv-translation language="de"}}
2 2  {{layout}}
3 -{{layout-section ac:type="single"}}
3 +{{layout-section ac:type="two_right_sidebar"}}
4 4  {{layout-cell}}
5 +
6 +{{/layout-cell}}
5 5  
8 +{{layout-cell}}
9 +{{scroll-ignore}}
10 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
6 6  
7 -{{details}}
8 -(% class="wrapped" %)
9 -|=(((
10 -Verantwortlicher
11 -)))|(((
12 -\\
13 -)))
14 -|=(% colspan="1" %)(% colspan="1" %)
15 -(((
16 -Status
17 -)))|(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)
18 -(((
19 -(% class="content-wrapper" %)
20 -(((
21 -{{sv-metadata type="workflow-status"/}}
22 22  
23 -{{status colour="Green" title="Fertig"/}}
24 -)))
25 -)))
26 -|=(% colspan="1" %)(% colspan="1" %)
27 -(((
28 -Varianten
29 -)))|(% colspan="1" %)(% colspan="1" %)
30 -(((
31 -(% class="content-wrapper" %)
32 -(((
33 -{{sv-metadata type="variants"/}}
34 -)))
35 -)))
36 -|=(% colspan="1" %)(% colspan="1" %)
37 -(((
38 -Attribute
39 -)))|(% colspan="1" %)(% colspan="1" %)
40 -(((
41 -(% class="content-wrapper" %)
42 -(((
43 -{{sv-metadata type="attributes"/}}
44 -)))
45 -)))
46 -|=(% colspan="1" %)(% colspan="1" %)
47 -(((
48 -Pagekey
49 -)))|(% colspan="1" %)(% colspan="1" %)
50 -(((
51 -(% class="content-wrapper" %)
52 -(((
53 -{{sv-metadata type="pagekey"/}}
54 -)))
55 -)))
56 -|=(% colspan="1" %)(% colspan="1" %)
57 -(((
58 -TODOs
59 -)))|(% colspan="1" %)(% colspan="1" %)
60 -(((
61 -(% class="task-list" %)
62 -(((
63 -{{task reference="/Tasks/Task_2" status="Done"}}
64 -carina [[ADM-8583>>url:https://www.bps-system.de/devel/browse/ADM-8583||shape="rect"]] DE/EN
13 +{{toc/}}
65 65  
66 -{{/task}}
67 -)))
68 -)))
69 -{{/details}}
15 +**
16 +**
17 +{{/panel}}
18 +{{/scroll-ignore}}
70 70  {{/layout-cell}}
71 71  {{/layout-section}}
72 72  
73 -{{layout-section ac:type="two_right_sidebar"}}
22 +{{layout-section ac:type="single"}}
74 74  {{layout-cell}}
75 75  == System requirements ==
76 76  
... ... @@ -80,7 +80,7 @@
80 80  Linux-based OS
81 81  )))
82 82  * (((
83 -Java 17
32 +Java 11 (latest update, Oracle or OpenJDK)
84 84  )))
85 85  * (((
86 86  Apache Tomcat 9 (latest update)
... ... @@ -88,7 +88,7 @@
88 88  
89 89  === ONYX Editor (additionally) ===
90 90  
91 -* PostgreSQL 12
40 +* PostGreSQL (8.4.21 or later)
92 92  * Java unlimited security enabled
93 93  
94 94  {{code}}
... ... @@ -103,29 +103,12 @@
103 103  * Eclipse for JEE (Kepler or later)
104 104  * Maven2
105 105  * Eclipse Maven integration (m2)
106 -{{/layout-cell}}
107 107  
108 -{{layout-cell}}
109 -{{scroll-ignore}}
110 -{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
111 -
112 -
113 -{{toc/}}
114 -
115 -**
116 -**
117 -{{/panel}}
118 -{{/scroll-ignore}}
119 -{{/layout-cell}}
120 -{{/layout-section}}
121 -
122 -{{layout-section ac:type="single"}}
123 -{{layout-cell}}
124 124  == Steps for build ==
125 125  
126 126  All ONYX parts are delivered as Eclipse projects
127 127  
128 -\\
60 +
129 129  
130 130  * preOnyx (ONYX QTI test player)
131 131  * preWebEditor (ONYX QTI test editor)
... ... @@ -157,7 +157,7 @@
157 157  * Create database owe and assign to user owe
158 158  * Import setupdatabase.postgre.sql to this database
159 159  
160 -\\
92 +
161 161  
162 162  Hint: you may use other user/database names, change configuration in
163 163  
... ... @@ -210,10 +210,29 @@
210 210  
211 211  {{sv-translation language="en"}}
212 212  {{layout}}
213 -{{layout-section ac:type="two_right_sidebar"}}
145 +{{layout-section ac:type="two_equal"}}
214 214  {{layout-cell}}
215 -== System requirements ==
147 +
148 +{{/layout-cell}}
216 216  
150 +{{layout-cell}}
151 +{{scroll-ignore}}
152 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
153 +
154 +
155 +{{toc maxLevel="4"/}}
156 +
157 +**
158 +**
159 +{{/panel}}
160 +{{/scroll-ignore}}
161 +{{/layout-cell}}
162 +{{/layout-section}}
163 +
164 +{{layout-section ac:type="single"}}
165 +{{layout-cell}}
166 +== System requirements ==
167 +
217 217  === All components ===
218 218  
219 219  * (((
... ... @@ -220,7 +220,7 @@
220 220  Linux-based OS
221 221  )))
222 222  * (((
223 -Java 17
174 +Java 11 (Oracle or OpenJDK)
224 224  )))
225 225  * (((
226 226  Apache Tomcat 9
... ... @@ -228,7 +228,7 @@
228 228  
229 229  === ONYX WebEditor (additionally) ===
230 230  
231 -* PostgreSQL 12
182 +* PostGreSQL (8.4.21 or later)
232 232  * Java unlimited security enabled
233 233  
234 234  {{code}}
... ... @@ -243,54 +243,29 @@
243 243  * Eclipse for JEE (Kepler or later)
244 244  * Maven2
245 245  * Eclipse Maven integration (m2)
246 -{{/layout-cell}}
247 247  
248 -{{layout-cell}}
249 -{{scroll-ignore}}
250 -{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
251 -
252 -
253 -{{toc maxLevel="4"/}}
254 -
255 -**
256 -**
257 -{{/panel}}
258 -{{/scroll-ignore}}
259 -{{/layout-cell}}
260 -{{/layout-section}}
261 -
262 -{{layout-section ac:type="single"}}
263 -{{layout-cell}}
264 264  == Steps for build ==
265 265  
266 266  All ONYX parts are delivered as Eclipse projects:
267 267  
202 +* preWebOnyx (ONYX QTI test player)
203 +* preWebEditor (ONYX QTI test editor)
204 +* onyx (ONYX QTI core)
268 268  * (((
269 -preWebOnyx (ONYX QTI test player)
270 -)))
271 -* (((
272 -preWebEditor (ONYX QTI test editor)
273 -)))
274 -* (((
275 -onyx (ONYX QTI core)
276 -)))
277 -* (((
278 278  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)
279 279  )))
280 280  
281 281  Use Eclipse:
282 282  
283 -* (((
284 -Import -> Existing project, start with LaTeXRenderer project
285 -)))
286 -* (((
287 -Import all four projects
288 -)))
211 +* Import -> Existing project, start with LaTeXRenderer project
212 +* Import all four projects
289 289  
290 290  Due to license restrictions the **project LaTeXRenderer** is not linked or integrated by default. This must be done manually.
291 291  
292 292  {{code}}
293 -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)
217 +Ensure that project dependency from preWebOnyx and preWebEditor to LaTeXRenderer is fulfilled.
218 +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)
219 +
294 294  {{/code}}
295 295  
296 296  **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)
... ... @@ -297,23 +297,13 @@
297 297  
298 298  **Setup database for ONYX WebEditor**
299 299  
300 -* (((
301 -Locate setupdatabase.postgre.sql
302 -)))
303 -* (((
304 -Log on to Postgres
305 -)))
306 -* (((
307 -Create user owe with password owe
308 -)))
309 -* (((
310 -Create database owe and assign to user owe
311 -)))
312 -* (((
313 -Import setupdatabase.postgre.sql to this database
314 -)))
226 +* Locate setupdatabase.postgre.sql
227 +* Log on to Postgres
228 +* Create user owe with password owe
229 +* Create database owe and assign to user owe
230 +* Import setupdatabase.postgre.sql to this database
315 315  
316 -\\
232 +
317 317  
318 318  Hint: you may use other user/database names, change configuration in
319 319  
... ... @@ -321,61 +321,37 @@
321 321  applicationContext.xml (see below)
322 322  {{/code}}
323 323  
324 -Changes on ONYX QTI core
240 +== Changes on ONYX QTI core ==
325 325  
326 326  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.
327 327  
328 -Configuration
244 +== Configuration ==
329 329  
330 330  **preWebOnyx**
331 331  
332 -* (((
333 -Locate onyxplugin.default.config.xml, copy it to a classpath folder and rename to//onyxplugin.config.xml//
334 -)))
335 -* (((
336 -Configure as needed
337 -)))
338 -* (((
339 -Service provider named “preview” is required if used as preview instance for ONYX WebEditor
340 -)))
248 +* Locate onyxplugin.default.config.xml, copy it to a classpath folder and rename to//onyxplugin.config.xml//
249 +* Configure as needed
250 +* Service provider named “preview” is required if used as preview instance for ONYX WebEditor
341 341  
342 342  **preWebEditor**
343 343  
344 -* (((
345 -applicationContext.xml: general configurations (database, mail configuration, preview ONYX (you can change this to your local installation), ...)
346 -)))
347 -* (((
348 -metadataConfigurationContext.xml: normally no changes needed as long as no further metadata are required
349 -)))
350 -* (((
351 -moduleConfigurationContext.xml: repository configuration
352 -)))
353 -* (((
354 -pageModelContext.xml: normally no changes required, defines the main tabs in shown application
355 -)))
356 -* (((
357 -webServiceContext.xml: reporter statistics connection, can be changed to your local ONYX installation
358 -)))
254 +* applicationContext.xml: general configurations (database, mail configuration, preview ONYX (you can change this to your local installation), ...)
255 +* metadataConfigurationContext.xml: normally no changes needed as long as no further metadata are required
256 +* moduleConfigurationContext.xml: repository configuration
257 +* pageModelContext.xml: normally no changes required, defines the main tabs in shown application
258 +* webServiceContext.xml: reporter statistics connection, can be changed to your local ONYX installation
359 359  
360 -Deployment
260 +== Deployment ==
361 361  
262 +* 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)
263 +* Configure Tomcat deployment to use different ports
264 +* Check path the applications are mounted to
265 +* Start Tomcat(s)
362 362  * (((
363 -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)
364 -)))
365 -* (((
366 -Configure Tomcat deployment to use different ports
367 -)))
368 -* (((
369 -Check path the applications are mounted to
370 -)))
371 -* (((
372 -Start Tomcat(s)
373 -)))
374 -* (((
375 375  Call http:~/~/localhost:<port>/<path> in browser
376 376  )))
377 377  
378 -Important notes
270 +== Important notes ==
379 379  
380 380  **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.
381 381  
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -666501613
1 +301073193
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/666501613/Projekt Setupguide ONYX
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/301073193/Projekt Setupguide ONYX