Zum Inhalt springen

Änderungen von Dokument 03 Projekt Setupguide ONYX

Zuletzt geändert von Carina Enke am 19.02.2024
Von Version 344.1
bearbeitet von tleu
am 17.04.2015
Änderungskommentar: Mittels Scroll Versions veröffentlicht aus dem Bereich ONYXintern und Version 1.0.
Auf Version 376.1
bearbeitet von Carina Enke
am 19.12.2023
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Übergeordnete Seite
... ... @@ -1,0 +1,1 @@
1 +ONYX.Systeminformationen.WebHome
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.tleu
1 +XWiki.carina
Inhalt
... ... @@ -1,43 +6,10 @@
1 -{{sv-translation language="de"}}
2 -{{layout}}
3 -{{layout-section ac:type="two_right_sidebar"}}
4 -{{layout-cell}}
5 -====== Inhalt: ======
6 6  
7 -
8 -
9 -{{toc maxLevel="5" style="square" outline="true" absoluteUrl="true"/}}
10 -{{/layout-cell}}
11 -
12 -{{layout-cell}}
13 -|=(% colspan="1" %)(% colspan="1" %)
14 -(((
15 -Programmversion
16 -)))|(% colspan="1" %)(% colspan="1" %)
17 -(((
18 -
19 -)))
20 -|=(((
21 -Status
22 -)))|(((
23 -(% class="status-macro aui-lozenge aui-lozenge-error" %)ENTWURF
24 -)))
25 -|=(((
26 -Aufgaben
27 -)))|(((
28 -
29 -
30 -
31 -)))
32 -|=(((
33 -JIRA
34 -)))|(((
35 -
36 -)))
37 -{{/layout-cell}}
2 +{{layout}}
3 +{{layout-section ac:type="single"}}
4 +{{layout-cell}}{{/layout-cell}}
38 38  {{/layout-section}}
39 39  
40 -{{layout-section ac:type="single"}}
7 +{{layout-section ac:type="two_right_sidebar"}}
41 41  {{layout-cell}}
42 42  == System requirements ==
43 43  
... ... @@ -47,15 +47,15 @@
47 47  Linux-based OS
48 48  )))
49 49  * (((
50 -Oracle Java8 (latest update)
17 +Java 17
51 51  )))
52 52  * (((
53 -Apache Tomcat8 (latest update)
20 +Apache Tomcat 9 (latest update)
54 54  )))
55 55  
56 56  === ONYX Editor (additionally) ===
57 57  
58 -* PostGreSQL (8.4.21 or later)
25 +* PostgreSQL 12
59 59  * Java unlimited security enabled
60 60  
61 61  {{code}}
... ... @@ -66,16 +66,33 @@
66 66  === Build process ===
67 67  
68 68  * Linux-based OS
69 -* Oracle Java7 (latest update)
36 +* Java 11 (latest update, Oracle or OpenJDK)
70 70  * Eclipse for JEE (Kepler or later)
71 71  * Maven2
72 72  * Eclipse Maven integration (m2)
40 +{{/layout-cell}}
73 73  
42 +{{layout-cell}}
43 +
44 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
45 +
46 +
47 +{{toc/}}
48 +
49 +**
50 +**
51 +{{/panel}}
52 +
53 +{{/layout-cell}}
54 +{{/layout-section}}
55 +
56 +{{layout-section ac:type="single"}}
57 +{{layout-cell}}
74 74  == Steps for build ==
75 75  
76 76  All ONYX parts are delivered as Eclipse projects
77 77  
78 -
62 +\\
79 79  
80 80  * preOnyx (ONYX QTI test player)
81 81  * preWebEditor (ONYX QTI test editor)
... ... @@ -107,7 +107,7 @@
107 107  * Create database owe and assign to user owe
108 108  * Import setupdatabase.postgre.sql to this database
109 109  
110 -
94 +\\
111 111  
112 112  Hint: you may use other user/database names, change configuration in
113 113  
... ... @@ -149,7 +149,7 @@
149 149  
150 150  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.
151 151  
152 -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**.
153 153  
154 154  **
155 155  **
... ... @@ -156,28 +156,14 @@
156 156  {{/layout-cell}}
157 157  {{/layout-section}}
158 158  {{/layout}}
159 -{{/sv-translation}}
160 160  
161 -{{sv-translation language="en"}}
162 -{{layout}}
163 -{{layout-section ac:type="two_equal"}}
164 -{{layout-cell}}
165 -====== Content: ======
166 166  
167 167  
168 -
169 -{{toc maxLevel="5" style="square" outline="true" absoluteUrl="true"/}}
170 -{{/layout-cell}}
171 -
146 +{{layout}}
147 +{{layout-section ac:type="two_right_sidebar"}}
172 172  {{layout-cell}}
173 -
174 -{{/layout-cell}}
175 -{{/layout-section}}
149 +== System requirements ==
176 176  
177 -{{layout-section ac:type="single"}}
178 -{{layout-cell}}
179 -== System requirements ==
180 -
181 181  === All components ===
182 182  
183 183  * (((
... ... @@ -184,15 +184,15 @@
184 184  Linux-based OS
185 185  )))
186 186  * (((
187 -Oracle Java8 (latest update)
157 +Java 17
188 188  )))
189 189  * (((
190 -Apache Tomcat8 (latest update)
160 +Apache Tomcat 9
191 191  )))
192 192  
193 193  === ONYX WebEditor (additionally) ===
194 194  
195 -* PostGreSQL (8.4.21 or later)
165 +* PostgreSQL 12
196 196  * Java unlimited security enabled
197 197  
198 198  {{code}}
... ... @@ -203,33 +203,58 @@
203 203  === Build process ===
204 204  
205 205  * Linux-based OS
206 -* Oracle Java7 (latest update)
176 +* Java 11 (Oracle or OpenJDK)
207 207  * Eclipse for JEE (Kepler or later)
208 208  * Maven2
209 209  * Eclipse Maven integration (m2)
180 +{{/layout-cell}}
210 210  
182 +{{layout-cell}}
183 +
184 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
185 +
186 +
187 +{{toc maxLevel="4"/}}
188 +
189 +**
190 +**
191 +{{/panel}}
192 +
193 +{{/layout-cell}}
194 +{{/layout-section}}
195 +
196 +{{layout-section ac:type="single"}}
197 +{{layout-cell}}
211 211  == Steps for build ==
212 212  
213 213  All ONYX parts are delivered as Eclipse projects:
214 214  
215 -* preWebOnyx (ONYX QTI test player)
216 -* preWebEditor (ONYX QTI test editor)
217 -* onyx (ONYX QTI core)
218 218  * (((
203 +preWebOnyx (ONYX QTI test player)
204 +)))
205 +* (((
206 +preWebEditor (ONYX QTI test editor)
207 +)))
208 +* (((
209 +onyx (ONYX QTI core)
210 +)))
211 +* (((
219 219  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)
220 220  )))
221 221  
222 222  Use Eclipse:
223 223  
224 -* Import -> Existing project, start with LaTeXRenderer project
225 -* Import all four projects
217 +* (((
218 +Import -> Existing project, start with LaTeXRenderer project
219 +)))
220 +* (((
221 +Import all four projects
222 +)))
226 226  
227 227  Due to license restrictions the **project LaTeXRenderer** is not linked or integrated by default. This must be done manually.
228 228  
229 229  {{code}}
230 -Ensure that project dependency from preWebOnyx and preWebEditor to LaTeXRenderer is fulfilled.
231 -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)
232 -
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)
233 233  {{/code}}
234 234  
235 235  **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)
... ... @@ -236,13 +236,23 @@
236 236  
237 237  **Setup database for ONYX WebEditor**
238 238  
239 -* Locate setupdatabase.postgre.sql
240 -* Log on to Postgres
241 -* Create user owe with password owe
242 -* Create database owe and assign to user owe
243 -* 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 +)))
244 244  
245 -
250 +\\
246 246  
247 247  Hint: you may use other user/database names, change configuration in
248 248  
... ... @@ -250,44 +250,68 @@
250 250  applicationContext.xml (see below)
251 251  {{/code}}
252 252  
253 -== Changes on ONYX QTI core ==
258 +Changes on ONYX QTI core
254 254  
255 255  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.
256 256  
257 -== Configuration ==
262 +Configuration
258 258  
259 259  **preWebOnyx**
260 260  
261 -* Locate onyxplugin.default.config.xml, copy it to a classpath folder and rename to//onyxplugin.config.xml//
262 -* Configure as needed
263 -* 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 +)))
264 264  
265 265  **preWebEditor**
266 266  
267 -* applicationContext.xml: general configurations (database, mail configuration, preview ONYX (you can change this to your local installation), ...)
268 -* metadataConfigurationContext.xml: normally no changes needed as long as no further metadata are required
269 -* moduleConfigurationContext.xml: repository configuration
270 -* pageModelContext.xml: normally no changes required, defines the main tabs in shown application
271 -* 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 +)))
272 272  
273 -== Deployment ==
294 +Deployment
274 274  
275 -* 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)
276 -* Configure Tomcat deployment to use different ports
277 -* Check path the applications are mounted to
278 -* Start Tomcat(s)
279 279  * (((
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 +* (((
280 280  Call http:~/~/localhost:<port>/<path> in browser
281 281  )))
282 282  
283 -== Important notes ==
312 +Important notes
284 284  
285 285  **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.
286 286  
287 287  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.
288 288  
289 -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**.
290 290  {{/layout-cell}}
291 291  {{/layout-section}}
292 292  {{/layout}}
293 -{{/sv-translation}}
322 +
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -6924841
1 +3342771
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/6924841/Projekt Setupguide ONYX
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342771/Projekt Setupguide ONYX