Zum Inhalt springen

Änderungen von Dokument 03 Projekt Setupguide ONYX

Zuletzt geändert von Carina Enke am 19.02.2024
Von Version 360.1
bearbeitet von sandra_riediger
am 17.12.2014
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 377.1
bearbeitet von Carina Enke
am 13.02.2024
Ä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.sandra_riediger
1 +XWiki.carina
Inhalt
... ... @@ -1,44 +2,6 @@
1 -{{sv-translation language="de"}}
2 2  {{layout}}
3 3  {{layout-section ac:type="two_right_sidebar"}}
4 4  {{layout-cell}}
5 -====== Inhalt: ======
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}}
38 -{{/layout-section}}
39 -
40 -{{layout-section ac:type="single"}}
41 -{{layout-cell}}
42 42  == System requirements ==
43 43  
44 44  === All components ===
... ... @@ -47,15 +47,15 @@
47 47  Linux-based OS
48 48  )))
49 49  * (((
50 -Oracle Java8 (latest update)
12 +Java 17
51 51  )))
52 52  * (((
53 -Apache Tomcat8 (latest update)
15 +Apache Tomcat 9 (latest update)
54 54  )))
55 55  
56 -=== ONYX WebEditor (additionally) ===
18 +=== ONYX Editor (additionally) ===
57 57  
58 -* PostGreSQL (8.4.21 or later)
20 +* PostgreSQL 12
59 59  * Java unlimited security enabled
60 60  
61 61  {{code}}
... ... @@ -66,23 +66,33 @@
66 66  === Build process ===
67 67  
68 68  * Linux-based OS
69 -* Oracle Java7 (latest update)
31 +* Java 11 (latest update, Oracle or OpenJDK)
70 70  * Eclipse for JEE (Kepler or later)
71 71  * Maven2
72 72  * Eclipse Maven integration (m2)
35 +{{/layout-cell}}
73 73  
37 +{{layout-cell}}
38 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
39 +{{toc start="2"/}}
40 +
41 +
42 +{{/panel}}
43 +{{/layout-cell}}
44 +{{/layout-section}}
45 +
46 +{{layout-section ac:type="single"}}
47 +{{layout-cell}}
74 74  == Steps for build ==
75 75  
76 76  All ONYX parts are delivered as Eclipse projects
77 77  
78 -
79 79  
80 -* preWebOnyx (ONYX QTI test player)
53 +* preOnyx (ONYX QTI test player)
81 81  * preWebEditor (ONYX QTI test editor)
82 82  * onyx (ONYX QTI core)
83 83  * 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)
84 -
85 -
57 +\\
86 86  
87 87  * Use Eclipse
88 88  * Import -> Existing project, start with LaTeXRenderer project
... ... @@ -97,9 +97,9 @@
97 97  
98 98  {{/code}}
99 99  
100 -(% style="line-height: 1.4285715;" %)**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)
72 +(% style="line-height:1.4285715" %)**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)
101 101  
102 -(% style="line-height: 1.4285715;" %)**Setup database for ONYX WebEditor**
74 +(% style="line-height:1.4285715" %)**Setup database for ONYX Editor**
103 103  
104 104  * Locate setupdatabase.postgre.sql
105 105  * Log on to Postgres
... ... @@ -107,8 +107,6 @@
107 107  * Create database owe and assign to user owe
108 108  * Import setupdatabase.postgre.sql to this database
109 109  
110 -
111 -
112 112  Hint: you may use other user/database names, change configuration in
113 113  
114 114  {{code}}
... ... @@ -125,7 +125,7 @@
125 125  
126 126  * Locate onyxplugin.default.config.xml, copy it to a classpath folder and rename to //onyxplugin.config.xml//
127 127  * Configure as needed
128 -* Service provider named “preview” is required if used as preview instance for ONYX WebEditor
98 +* Service provider named “preview” is required if used as preview instance for ONYX Editor
129 129  
130 130  **preWebEditor**
131 131  
... ... @@ -149,49 +149,14 @@
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**.
153 -
154 -**
155 -**
122 +In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with **8 GB each**.
156 156  {{/layout-cell}}
157 157  {{/layout-section}}
158 -
159 -{{layout-section ac:type="two_right_sidebar"}}
160 -{{layout-cell}}
161 -====== untergeordnete Seiten: ======
162 -
163 -
164 -
165 -{{children all="true"/}}
166 -{{/layout-cell}}
167 -
168 -{{layout-cell}}
169 -====== relevante Links: ======
170 -
171 -* [[lorem ipsum>>url:https://www.bps-system.de/help/display/OPAL/Handbuch+OPAL||shape="rect"]]
172 -{{/layout-cell}}
173 -{{/layout-section}}
174 174  {{/layout}}
175 -{{/sv-translation}}
176 176  
177 -{{sv-translation language="en"}}
178 178  {{layout}}
179 -{{layout-section ac:type="two_equal"}}
128 +{{layout-section ac:type="two_right_sidebar"}}
180 180  {{layout-cell}}
181 -====== Content: ======
182 -
183 -
184 -
185 -{{toc style="square" maxLevel="5" outline="true" absoluteUrl="true"/}}
186 -{{/layout-cell}}
187 -
188 -{{layout-cell}}
189 -
190 -{{/layout-cell}}
191 -{{/layout-section}}
192 -
193 -{{layout-section ac:type="single"}}
194 -{{layout-cell}}
195 195  == System requirements ==
196 196  
197 197  === All components ===
... ... @@ -200,15 +200,15 @@
200 200  Linux-based OS
201 201  )))
202 202  * (((
203 -Oracle Java8 (latest update)
138 +Java 17
204 204  )))
205 205  * (((
206 -Apache Tomcat8 (latest update)
141 +Apache Tomcat 9
207 207  )))
208 208  
209 209  === ONYX WebEditor (additionally) ===
210 210  
211 -* PostGreSQL (8.4.21 or later)
146 +* PostgreSQL 12
212 212  * Java unlimited security enabled
213 213  
214 214  {{code}}
... ... @@ -219,35 +219,53 @@
219 219  === Build process ===
220 220  
221 221  * Linux-based OS
222 -* Oracle Java7 (latest update)
157 +* Java 11 (Oracle or OpenJDK)
223 223  * Eclipse for JEE (Kepler or later)
224 224  * Maven2
225 225  * Eclipse Maven integration (m2)
161 +{{/layout-cell}}
226 226  
163 +{{layout-cell}}
164 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
165 +{{toc maxLevel="4"/}}
166 +
167 +
168 +{{/panel}}
169 +{{/layout-cell}}
170 +{{/layout-section}}
171 +
172 +{{layout-section ac:type="single"}}
173 +{{layout-cell}}
227 227  == Steps for build ==
228 228  
229 -All ONYX parts are delivered as Eclipse projects
176 +All ONYX parts are delivered as Eclipse projects:
230 230  
231 -
178 +* (((
179 +preWebOnyx (ONYX QTI test player)
180 +)))
181 +* (((
182 +preWebEditor (ONYX QTI test editor)
183 +)))
184 +* (((
185 +onyx (ONYX QTI core)
186 +)))
187 +* (((
188 +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)
189 +)))
232 232  
233 -* preWebOnyx (ONYX QTI test player)
234 -* preWebEditor (ONYX QTI test editor)
235 -* onyx (ONYX QTI core)
236 -* 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)
237 -
238 -
191 +Use Eclipse:
239 239  
240 -* Use Eclipse
241 -* Import -> Existing project, start with LaTeXRenderer project
242 -* Import all four projects
193 +* (((
194 +Import -> Existing project, start with LaTeXRenderer project
195 +)))
196 +* (((
197 +Import all four projects
198 +)))
243 243  
244 244  Due to license restrictions the **project LaTeXRenderer** is not linked or integrated by default. This must be done manually.
245 245  
246 246  {{code}}
247 -Ensure that project dependency from preWebOnyx and preWebEditor to LaTeXRenderer is fulfilled.
248 -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)
249 -
250 -
203 +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)
251 251  {{/code}}
252 252  
253 253  **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)
... ... @@ -254,14 +254,22 @@
254 254  
255 255  **Setup database for ONYX WebEditor**
256 256  
257 -* Locate setupdatabase.postgre.sql
258 -* Log on to Postgres
259 -* Create user owe with password owe
260 -* Create database owe and assign to user owe
261 -* Import setupdatabase.postgre.sql to this database
210 +* (((
211 +Locate setupdatabase.postgre.sql
212 +)))
213 +* (((
214 +Log on to Postgres
215 +)))
216 +* (((
217 +Create user owe with password owe
218 +)))
219 +* (((
220 +Create database owe and assign to user owe
221 +)))
222 +* (((
223 +Import setupdatabase.postgre.sql to this database
224 +)))
262 262  
263 -
264 -
265 265  Hint: you may use other user/database names, change configuration in
266 266  
267 267  {{code}}
... ... @@ -268,42 +268,67 @@
268 268  applicationContext.xml (see below)
269 269  {{/code}}
270 270  
271 -== Changes on ONYX QTI core ==
232 +Changes on ONYX QTI core
272 272  
273 273  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.
274 274  
275 -== Configuration ==
236 +Configuration
276 276  
277 277  **preWebOnyx**
278 278  
279 -* Locate onyxplugin.default.config.xml, copy it to a classpath folder and rename to//onyxplugin.config.xml//
280 -* Configure as needed
281 -* Service provider named “preview” is required if used as preview instance for ONYX WebEditor
240 +* (((
241 +Locate onyxplugin.default.config.xml, copy it to a classpath folder and rename to//onyxplugin.config.xml//
242 +)))
243 +* (((
244 +Configure as needed
245 +)))
246 +* (((
247 +Service provider named “preview” is required if used as preview instance for ONYX WebEditor
248 +)))
282 282  
283 283  **preWebEditor**
284 284  
285 -* applicationContext.xml: general configurations (database, mail configuration, preview ONYX (you can change this to your local installation), ...)
286 -* metadataConfigurationContext.xml: normally no changes needed as long as no further metadata are required
287 -* moduleConfigurationContext.xml: repository configuration
288 -* pageModelContext.xml: normally no changes required, defines the main tabs in shown application
289 -* webServiceContext.xml: reporter statistics connection, can be changed to your local ONYX installation
252 +* (((
253 +applicationContext.xml: general configurations (database, mail configuration, preview ONYX (you can change this to your local installation), ...)
254 +)))
255 +* (((
256 +metadataConfigurationContext.xml: normally no changes needed as long as no further metadata are required
257 +)))
258 +* (((
259 +moduleConfigurationContext.xml: repository configuration
260 +)))
261 +* (((
262 +pageModelContext.xml: normally no changes required, defines the main tabs in shown application
263 +)))
264 +* (((
265 +webServiceContext.xml: reporter statistics connection, can be changed to your local ONYX installation
266 +)))
290 290  
291 -== Deployment ==
268 +Deployment
292 292  
293 -* 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)
294 -* Configure Tomcat deployment to use different ports
295 -* Check path the applications are mounted to
296 -* Start Tomcat(s)
297 -* Call http:~/~/localhost:<port>/<path> in browser
270 +* (((
271 +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)
272 +)))
273 +* (((
274 +Configure Tomcat deployment to use different ports
275 +)))
276 +* (((
277 +Check path the applications are mounted to
278 +)))
279 +* (((
280 +Start Tomcat(s)
281 +)))
282 +* (((
283 +Call http:~/~/localhost:<port>/<path> in browser
284 +)))
298 298  
299 -== Important notes ==
286 +Important notes
300 300  
301 301  **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.
302 302  
303 303  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.
304 304  
305 -In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with **4GB each**.
292 +In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with **8 GB each**.
306 306  {{/layout-cell}}
307 307  {{/layout-section}}
308 308  {{/layout}}
309 -{{/sv-translation}}
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -3342954
1 +3342771
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342954/Projekt Setupguide ONYX
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342771/Projekt Setupguide ONYX