Zum Inhalt springen

Änderungen von Dokument 03 Projekt Setupguide ONYX

Zuletzt geändert von Carina Enke am 19.02.2024
Von Version 271.1
bearbeitet von Carina Enke
am 22.01.2020
Änderungskommentar: Mittels Scroll Versions veröffentlicht aus dem Bereich ONYXintern und Version 8.9.
Auf 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.

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -1,10 +1,22 @@
1 1  {{sv-translation language="de"}}
2 2  {{layout}}
3 -{{layout-section ac:type="single"}}
4 -{{layout-cell}}{{/layout-cell}}
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}}
5 5  {{/layout-section}}
6 6  
7 -{{layout-section ac:type="two_right_sidebar"}}
19 +{{layout-section ac:type="single"}}
8 8  {{layout-cell}}
9 9  == System requirements ==
10 10  
... ... @@ -14,10 +14,10 @@
14 14  Linux-based OS
15 15  )))
16 16  * (((
17 -Java 11 (latest update, Oracle or OpenJDK)
29 +Oracle Java8 (latest update)
18 18  )))
19 19  * (((
20 -Apache Tomcat 9 (latest update)
32 +Apache Tomcat8 (latest update)
21 21  )))
22 22  
23 23  === ONYX Editor (additionally) ===
... ... @@ -33,33 +33,16 @@
33 33  === Build process ===
34 34  
35 35  * Linux-based OS
36 -* Java 11 (latest update, Oracle or OpenJDK)
48 +* Oracle Java7 (latest update)
37 37  * Eclipse for JEE (Kepler or later)
38 38  * Maven2
39 39  * Eclipse Maven integration (m2)
40 -{{/layout-cell}}
41 41  
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}}
58 58  == Steps for build ==
59 59  
60 60  All ONYX parts are delivered as Eclipse projects
61 61  
62 -\\
57 +
63 63  
64 64  * preOnyx (ONYX QTI test player)
65 65  * preWebEditor (ONYX QTI test editor)
... ... @@ -91,7 +91,7 @@
91 91  * Create database owe and assign to user owe
92 92  * Import setupdatabase.postgre.sql to this database
93 93  
94 -\\
89 +
95 95  
96 96  Hint: you may use other user/database names, change configuration in
97 97  
... ... @@ -133,7 +133,7 @@
133 133  
134 134  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.
135 135  
136 -In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with **8 GB each**.
131 +In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with **4GB each**.
137 137  
138 138  **
139 139  **
... ... @@ -144,10 +144,24 @@
144 144  
145 145  {{sv-translation language="en"}}
146 146  {{layout}}
147 -{{layout-section ac:type="two_right_sidebar"}}
142 +{{layout-section ac:type="two_equal"}}
148 148  {{layout-cell}}
149 -== System requirements ==
144 +====== Content: ======
150 150  
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 +
151 151  === All components ===
152 152  
153 153  * (((
... ... @@ -154,10 +154,10 @@
154 154  Linux-based OS
155 155  )))
156 156  * (((
157 -Java 11 (Oracle or OpenJDK)
166 +Oracle Java8 (latest update)
158 158  )))
159 159  * (((
160 -Apache Tomcat 9
169 +Apache Tomcat8 (latest update)
161 161  )))
162 162  
163 163  === ONYX WebEditor (additionally) ===
... ... @@ -173,58 +173,33 @@
173 173  === Build process ===
174 174  
175 175  * Linux-based OS
176 -* Java 11 (Oracle or OpenJDK)
185 +* Oracle Java7 (latest update)
177 177  * Eclipse for JEE (Kepler or later)
178 178  * Maven2
179 179  * Eclipse Maven integration (m2)
180 -{{/layout-cell}}
181 181  
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}}
198 198  == Steps for build ==
199 199  
200 200  All ONYX parts are delivered as Eclipse projects:
201 201  
194 +* preWebOnyx (ONYX QTI test player)
195 +* preWebEditor (ONYX QTI test editor)
196 +* onyx (ONYX QTI core)
202 202  * (((
203 -preWebOnyx (ONYX QTI test player)
204 -)))
205 -* (((
206 -preWebEditor (ONYX QTI test editor)
207 -)))
208 -* (((
209 -onyx (ONYX QTI core)
210 -)))
211 -* (((
212 212  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)
213 213  )))
214 214  
215 215  Use Eclipse:
216 216  
217 -* (((
218 -Import -> Existing project, start with LaTeXRenderer project
219 -)))
220 -* (((
221 -Import all four projects
222 -)))
203 +* Import -> Existing project, start with LaTeXRenderer project
204 +* Import all four projects
223 223  
224 224  Due to license restrictions the **project LaTeXRenderer** is not linked or integrated by default. This must be done manually.
225 225  
226 226  {{code}}
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)
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 +
228 228  {{/code}}
229 229  
230 230  **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)
... ... @@ -231,23 +231,13 @@
231 231  
232 232  **Setup database for ONYX WebEditor**
233 233  
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 -)))
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
249 249  
250 -\\
224 +
251 251  
252 252  Hint: you may use other user/database names, change configuration in
253 253  
... ... @@ -255,67 +255,43 @@
255 255  applicationContext.xml (see below)
256 256  {{/code}}
257 257  
258 -Changes on ONYX QTI core
232 +== Changes on ONYX QTI core ==
259 259  
260 260  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.
261 261  
262 -Configuration
236 +== Configuration ==
263 263  
264 264  **preWebOnyx**
265 265  
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 -)))
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
275 275  
276 276  **preWebEditor**
277 277  
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 -)))
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
293 293  
294 -Deployment
252 +== Deployment ==
295 295  
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)
296 296  * (((
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 -* (((
309 309  Call http:~/~/localhost:<port>/<path> in browser
310 310  )))
311 311  
312 -Important notes
262 +== Important notes ==
313 313  
314 314  **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.
315 315  
316 316  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.
317 317  
318 -In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with **8 GB each**.
268 +In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with **4GB each**.
319 319  {{/layout-cell}}
320 320  {{/layout-section}}
321 321  {{/layout}}
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -313230527
1 +226230564
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/313230527/Projekt Setupguide ONYX
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/226230564/Projekt Setupguide ONYX