Zum Inhalt springen

Änderungen von Dokument 03 Projekt Setupguide ONYX

Zuletzt geändert von Carina Enke am 19.02.2024
Von Version 164.1
bearbeitet von Carina Enke
am 08.03.2022
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 282.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,12 +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 -\\
5 +
6 6  {{/layout-cell}}
7 +
8 +{{layout-cell}}
9 +{{scroll-ignore}}
10 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
11 +
12 +
13 +{{toc/}}
14 +
15 +**
16 +**
17 +{{/panel}}
18 +{{/scroll-ignore}}
19 +{{/layout-cell}}
7 7  {{/layout-section}}
8 8  
9 -{{layout-section ac:type="two_right_sidebar"}}
22 +{{layout-section ac:type="single"}}
10 10  {{layout-cell}}
11 11  == System requirements ==
12 12  
... ... @@ -16,7 +16,7 @@
16 16  Linux-based OS
17 17  )))
18 18  * (((
19 -Java 17
32 +Java 11 (latest update, Oracle or OpenJDK)
20 20  )))
21 21  * (((
22 22  Apache Tomcat 9 (latest update)
... ... @@ -24,7 +24,7 @@
24 24  
25 25  === ONYX Editor (additionally) ===
26 26  
27 -* PostgreSQL 12
40 +* PostGreSQL (8.4.21 or later)
28 28  * Java unlimited security enabled
29 29  
30 30  {{code}}
... ... @@ -39,41 +39,12 @@
39 39  * Eclipse for JEE (Kepler or later)
40 40  * Maven2
41 41  * Eclipse Maven integration (m2)
42 -{{/layout-cell}}
43 43  
44 -{{layout-cell}}
45 -(% class="auto-cursor-target" %)
46 -\\
47 -
48 -{{scroll-ignore}}
49 -(% class="auto-cursor-target" %)
50 -\\
51 -
52 -{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
53 -
54 -
55 -{{toc/}}
56 -
57 -**
58 -**
59 -{{/panel}}
60 -
61 -(% class="auto-cursor-target" %)
62 -\\
63 -{{/scroll-ignore}}
64 -
65 -(% class="auto-cursor-target" %)
66 -\\
67 -{{/layout-cell}}
68 -{{/layout-section}}
69 -
70 -{{layout-section ac:type="single"}}
71 -{{layout-cell}}
72 72  == Steps for build ==
73 73  
74 74  All ONYX parts are delivered as Eclipse projects
75 75  
76 -\\
60 +
77 77  
78 78  * preOnyx (ONYX QTI test player)
79 79  * preWebEditor (ONYX QTI test editor)
... ... @@ -105,7 +105,7 @@
105 105  * Create database owe and assign to user owe
106 106  * Import setupdatabase.postgre.sql to this database
107 107  
108 -\\
92 +
109 109  
110 110  Hint: you may use other user/database names, change configuration in
111 111  
... ... @@ -158,10 +158,24 @@
158 158  
159 159  {{sv-translation language="en"}}
160 160  {{layout}}
161 -{{layout-section ac:type="two_right_sidebar"}}
145 +{{layout-section ac:type="two_equal"}}
162 162  {{layout-cell}}
163 -== System requirements ==
147 +====== Content: ======
164 164  
149 +
150 +
151 +{{toc maxLevel="5" outline="true" absoluteUrl="true" style="square"/}}
152 +{{/layout-cell}}
153 +
154 +{{layout-cell}}
155 +
156 +{{/layout-cell}}
157 +{{/layout-section}}
158 +
159 +{{layout-section ac:type="single"}}
160 +{{layout-cell}}
161 +== System requirements ==
162 +
165 165  === All components ===
166 166  
167 167  * (((
... ... @@ -168,15 +168,15 @@
168 168  Linux-based OS
169 169  )))
170 170  * (((
171 -Java 17
169 +Oracle Java8 (latest update)
172 172  )))
173 173  * (((
174 -Apache Tomcat 9
172 +Apache Tomcat8 (latest update)
175 175  )))
176 176  
177 177  === ONYX WebEditor (additionally) ===
178 178  
179 -* PostgreSQL 12
177 +* PostGreSQL (8.4.21 or later)
180 180  * Java unlimited security enabled
181 181  
182 182  {{code}}
... ... @@ -187,70 +187,33 @@
187 187  === Build process ===
188 188  
189 189  * Linux-based OS
190 -* Java 11 (Oracle or OpenJDK)
188 +* Oracle Java7 (latest update)
191 191  * Eclipse for JEE (Kepler or later)
192 192  * Maven2
193 193  * Eclipse Maven integration (m2)
194 -{{/layout-cell}}
195 195  
196 -{{layout-cell}}
197 -(% class="auto-cursor-target" %)
198 -\\
199 -
200 -{{scroll-ignore}}
201 -(% class="auto-cursor-target" %)
202 -\\
203 -
204 -{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
205 -
206 -
207 -{{toc maxLevel="4"/}}
208 -
209 -**
210 -**
211 -{{/panel}}
212 -
213 -(% class="auto-cursor-target" %)
214 -\\
215 -{{/scroll-ignore}}
216 -
217 -(% class="auto-cursor-target" %)
218 -\\
219 -{{/layout-cell}}
220 -{{/layout-section}}
221 -
222 -{{layout-section ac:type="single"}}
223 -{{layout-cell}}
224 224  == Steps for build ==
225 225  
226 226  All ONYX parts are delivered as Eclipse projects:
227 227  
197 +* preWebOnyx (ONYX QTI test player)
198 +* preWebEditor (ONYX QTI test editor)
199 +* onyx (ONYX QTI core)
228 228  * (((
229 -preWebOnyx (ONYX QTI test player)
230 -)))
231 -* (((
232 -preWebEditor (ONYX QTI test editor)
233 -)))
234 -* (((
235 -onyx (ONYX QTI core)
236 -)))
237 -* (((
238 238  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)
239 239  )))
240 240  
241 241  Use Eclipse:
242 242  
243 -* (((
244 -Import -> Existing project, start with LaTeXRenderer project
245 -)))
246 -* (((
247 -Import all four projects
248 -)))
206 +* Import -> Existing project, start with LaTeXRenderer project
207 +* Import all four projects
249 249  
250 250  Due to license restrictions the **project LaTeXRenderer** is not linked or integrated by default. This must be done manually.
251 251  
252 252  {{code}}
253 -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 +Ensure that project dependency from preWebOnyx and preWebEditor to LaTeXRenderer is fulfilled.
213 +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)
214 +
254 254  {{/code}}
255 255  
256 256  **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)
... ... @@ -257,23 +257,13 @@
257 257  
258 258  **Setup database for ONYX WebEditor**
259 259  
260 -* (((
261 -Locate setupdatabase.postgre.sql
262 -)))
263 -* (((
264 -Log on to Postgres
265 -)))
266 -* (((
267 -Create user owe with password owe
268 -)))
269 -* (((
270 -Create database owe and assign to user owe
271 -)))
272 -* (((
273 -Import setupdatabase.postgre.sql to this database
274 -)))
221 +* Locate setupdatabase.postgre.sql
222 +* Log on to Postgres
223 +* Create user owe with password owe
224 +* Create database owe and assign to user owe
225 +* Import setupdatabase.postgre.sql to this database
275 275  
276 -\\
227 +
277 277  
278 278  Hint: you may use other user/database names, change configuration in
279 279  
... ... @@ -281,67 +281,43 @@
281 281  applicationContext.xml (see below)
282 282  {{/code}}
283 283  
284 -Changes on ONYX QTI core
235 +== Changes on ONYX QTI core ==
285 285  
286 286  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.
287 287  
288 -Configuration
239 +== Configuration ==
289 289  
290 290  **preWebOnyx**
291 291  
292 -* (((
293 -Locate onyxplugin.default.config.xml, copy it to a classpath folder and rename to//onyxplugin.config.xml//
294 -)))
295 -* (((
296 -Configure as needed
297 -)))
298 -* (((
299 -Service provider named “preview” is required if used as preview instance for ONYX WebEditor
300 -)))
243 +* Locate onyxplugin.default.config.xml, copy it to a classpath folder and rename to//onyxplugin.config.xml//
244 +* Configure as needed
245 +* Service provider named “preview” is required if used as preview instance for ONYX WebEditor
301 301  
302 302  **preWebEditor**
303 303  
304 -* (((
305 -applicationContext.xml: general configurations (database, mail configuration, preview ONYX (you can change this to your local installation), ...)
306 -)))
307 -* (((
308 -metadataConfigurationContext.xml: normally no changes needed as long as no further metadata are required
309 -)))
310 -* (((
311 -moduleConfigurationContext.xml: repository configuration
312 -)))
313 -* (((
314 -pageModelContext.xml: normally no changes required, defines the main tabs in shown application
315 -)))
316 -* (((
317 -webServiceContext.xml: reporter statistics connection, can be changed to your local ONYX installation
318 -)))
249 +* applicationContext.xml: general configurations (database, mail configuration, preview ONYX (you can change this to your local installation), ...)
250 +* metadataConfigurationContext.xml: normally no changes needed as long as no further metadata are required
251 +* moduleConfigurationContext.xml: repository configuration
252 +* pageModelContext.xml: normally no changes required, defines the main tabs in shown application
253 +* webServiceContext.xml: reporter statistics connection, can be changed to your local ONYX installation
319 319  
320 -Deployment
255 +== Deployment ==
321 321  
257 +* 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)
258 +* Configure Tomcat deployment to use different ports
259 +* Check path the applications are mounted to
260 +* Start Tomcat(s)
322 322  * (((
323 -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)
324 -)))
325 -* (((
326 -Configure Tomcat deployment to use different ports
327 -)))
328 -* (((
329 -Check path the applications are mounted to
330 -)))
331 -* (((
332 -Start Tomcat(s)
333 -)))
334 -* (((
335 335  Call http:~/~/localhost:<port>/<path> in browser
336 336  )))
337 337  
338 -Important notes
265 +== Important notes ==
339 339  
340 340  **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.
341 341  
342 342  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.
343 343  
344 -In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with **8 GB each**.
271 +In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with **4GB each**.
345 345  {{/layout-cell}}
346 346  {{/layout-section}}
347 347  {{/layout}}
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -554041427
1 +226230926
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/554041427/Projekt Setupguide ONYX
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/226230926/Projekt Setupguide ONYX