Zum Inhalt springen

Änderungen von Dokument 03 Projekt Setupguide ONYX

Zuletzt geändert von Carina Enke am 19.02.2024
Von Version 166.1
bearbeitet von Carina Enke
am 08.03.2022
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 286.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,10 +168,10 @@
168 168  Linux-based OS
169 169  )))
170 170  * (((
171 -Java 11 (Oracle or OpenJDK)
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) ===
... ... @@ -187,58 +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 -{{scroll-ignore}}
198 -{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
199 -
200 -
201 -{{toc maxLevel="4"/}}
202 -
203 -**
204 -**
205 -{{/panel}}
206 -{{/scroll-ignore}}
207 -{{/layout-cell}}
208 -{{/layout-section}}
209 -
210 -{{layout-section ac:type="single"}}
211 -{{layout-cell}}
212 212  == Steps for build ==
213 213  
214 214  All ONYX parts are delivered as Eclipse projects:
215 215  
197 +* preWebOnyx (ONYX QTI test player)
198 +* preWebEditor (ONYX QTI test editor)
199 +* onyx (ONYX QTI core)
216 216  * (((
217 -preWebOnyx (ONYX QTI test player)
218 -)))
219 -* (((
220 -preWebEditor (ONYX QTI test editor)
221 -)))
222 -* (((
223 -onyx (ONYX QTI core)
224 -)))
225 -* (((
226 226  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)
227 227  )))
228 228  
229 229  Use Eclipse:
230 230  
231 -* (((
232 -Import -> Existing project, start with LaTeXRenderer project
233 -)))
234 -* (((
235 -Import all four projects
236 -)))
206 +* Import -> Existing project, start with LaTeXRenderer project
207 +* Import all four projects
237 237  
238 238  Due to license restrictions the **project LaTeXRenderer** is not linked or integrated by default. This must be done manually.
239 239  
240 240  {{code}}
241 -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 +
242 242  {{/code}}
243 243  
244 244  **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)
... ... @@ -245,23 +245,13 @@
245 245  
246 246  **Setup database for ONYX WebEditor**
247 247  
248 -* (((
249 -Locate setupdatabase.postgre.sql
250 -)))
251 -* (((
252 -Log on to Postgres
253 -)))
254 -* (((
255 -Create user owe with password owe
256 -)))
257 -* (((
258 -Create database owe and assign to user owe
259 -)))
260 -* (((
261 -Import setupdatabase.postgre.sql to this database
262 -)))
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
263 263  
264 -\\
227 +
265 265  
266 266  Hint: you may use other user/database names, change configuration in
267 267  
... ... @@ -269,67 +269,43 @@
269 269  applicationContext.xml (see below)
270 270  {{/code}}
271 271  
272 -Changes on ONYX QTI core
235 +== Changes on ONYX QTI core ==
273 273  
274 274  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.
275 275  
276 -Configuration
239 +== Configuration ==
277 277  
278 278  **preWebOnyx**
279 279  
280 -* (((
281 -Locate onyxplugin.default.config.xml, copy it to a classpath folder and rename to//onyxplugin.config.xml//
282 -)))
283 -* (((
284 -Configure as needed
285 -)))
286 -* (((
287 -Service provider named “preview” is required if used as preview instance for ONYX WebEditor
288 -)))
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
289 289  
290 290  **preWebEditor**
291 291  
292 -* (((
293 -applicationContext.xml: general configurations (database, mail configuration, preview ONYX (you can change this to your local installation), ...)
294 -)))
295 -* (((
296 -metadataConfigurationContext.xml: normally no changes needed as long as no further metadata are required
297 -)))
298 -* (((
299 -moduleConfigurationContext.xml: repository configuration
300 -)))
301 -* (((
302 -pageModelContext.xml: normally no changes required, defines the main tabs in shown application
303 -)))
304 -* (((
305 -webServiceContext.xml: reporter statistics connection, can be changed to your local ONYX installation
306 -)))
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
307 307  
308 -Deployment
255 +== Deployment ==
309 309  
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)
310 310  * (((
311 -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)
312 -)))
313 -* (((
314 -Configure Tomcat deployment to use different ports
315 -)))
316 -* (((
317 -Check path the applications are mounted to
318 -)))
319 -* (((
320 -Start Tomcat(s)
321 -)))
322 -* (((
323 323  Call http:~/~/localhost:<port>/<path> in browser
324 324  )))
325 325  
326 -Important notes
265 +== Important notes ==
327 327  
328 328  **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.
329 329  
330 330  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.
331 331  
332 -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**.
333 333  {{/layout-cell}}
334 334  {{/layout-section}}
335 335  {{/layout}}
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -545783843
1 +226230703
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/545783843/Projekt Setupguide ONYX
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/226230703/Projekt Setupguide ONYX