Änderungen von Dokument 03 Projekt Setupguide ONYX

Zuletzt geändert von Carina Enke am 24.11.2025

Von Version 280.1
bearbeitet von Carina Enke
am 08.05.2019
Änderungskommentar: Mittels Scroll Versions veröffentlicht aus dem Bereich ONYXintern und Version 8.7.
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
Inhalt
... ... @@ -1,26 +2,6 @@
1 -{{sv-translation language="de"}}
2 2  {{layout}}
3 3  {{layout-section ac:type="two_right_sidebar"}}
4 4  {{layout-cell}}
5 -
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}}
20 -{{/layout-section}}
21 -
22 -{{layout-section ac:type="single"}}
23 -{{layout-cell}}
24 24  == System requirements ==
25 25  
26 26  === All components ===
... ... @@ -29,7 +29,7 @@
29 29  Linux-based OS
30 30  )))
31 31  * (((
32 -Java 11 (latest update, Oracle or OpenJDK)
12 +Java 17
33 33  )))
34 34  * (((
35 35  Apache Tomcat 9 (latest update)
... ... @@ -37,7 +37,7 @@
37 37  
38 38  === ONYX Editor (additionally) ===
39 39  
40 -* PostGreSQL (8.4.21 or later)
20 +* PostgreSQL 12
41 41  * Java unlimited security enabled
42 42  
43 43  {{code}}
... ... @@ -52,19 +52,29 @@
52 52  * Eclipse for JEE (Kepler or later)
53 53  * Maven2
54 54  * Eclipse Maven integration (m2)
35 +{{/layout-cell}}
55 55  
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}}
56 56  == Steps for build ==
57 57  
58 58  All ONYX parts are delivered as Eclipse projects
59 59  
60 -
61 61  
62 62  * preOnyx (ONYX QTI test player)
63 63  * preWebEditor (ONYX QTI test editor)
64 64  * onyx (ONYX QTI core)
65 65  * 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)
66 -
67 -
57 +\\
68 68  
69 69  * Use Eclipse
70 70  * Import -> Existing project, start with LaTeXRenderer project
... ... @@ -79,9 +79,9 @@
79 79  
80 80  {{/code}}
81 81  
82 -(% 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)
83 83  
84 -(% style="line-height: 1.4285715;" %)**Setup database for ONYX Editor**
74 +(% style="line-height:1.4285715" %)**Setup database for ONYX Editor**
85 85  
86 86  * Locate setupdatabase.postgre.sql
87 87  * Log on to Postgres
... ... @@ -89,8 +89,6 @@
89 89  * Create database owe and assign to user owe
90 90  * Import setupdatabase.postgre.sql to this database
91 91  
92 -
93 -
94 94  Hint: you may use other user/database names, change configuration in
95 95  
96 96  {{code}}
... ... @@ -132,32 +132,13 @@
132 132  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.
133 133  
134 134  In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with **8 GB each**.
135 -
136 -**
137 -**
138 138  {{/layout-cell}}
139 139  {{/layout-section}}
140 140  {{/layout}}
141 -{{/sv-translation}}
142 142  
143 -{{sv-translation language="en"}}
144 144  {{layout}}
145 -{{layout-section ac:type="two_equal"}}
128 +{{layout-section ac:type="two_right_sidebar"}}
146 146  {{layout-cell}}
147 -====== Content: ======
148 -
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 161  == System requirements ==
162 162  
163 163  === All components ===
... ... @@ -166,15 +166,15 @@
166 166  Linux-based OS
167 167  )))
168 168  * (((
169 -Oracle Java8 (latest update)
138 +Java 17
170 170  )))
171 171  * (((
172 -Apache Tomcat8 (latest update)
141 +Apache Tomcat 9
173 173  )))
174 174  
175 175  === ONYX WebEditor (additionally) ===
176 176  
177 -* PostGreSQL (8.4.21 or later)
146 +* PostgreSQL 12
178 178  * Java unlimited security enabled
179 179  
180 180  {{code}}
... ... @@ -185,33 +185,53 @@
185 185  === Build process ===
186 186  
187 187  * Linux-based OS
188 -* Oracle Java7 (latest update)
157 +* Java 11 (Oracle or OpenJDK)
189 189  * Eclipse for JEE (Kepler or later)
190 190  * Maven2
191 191  * Eclipse Maven integration (m2)
161 +{{/layout-cell}}
192 192  
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}}
193 193  == Steps for build ==
194 194  
195 195  All ONYX parts are delivered as Eclipse projects:
196 196  
197 -* preWebOnyx (ONYX QTI test player)
198 -* preWebEditor (ONYX QTI test editor)
199 -* onyx (ONYX QTI core)
200 200  * (((
179 +preWebOnyx (ONYX QTI test player)
180 +)))
181 +* (((
182 +preWebEditor (ONYX QTI test editor)
183 +)))
184 +* (((
185 +onyx (ONYX QTI core)
186 +)))
187 +* (((
201 201  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)
202 202  )))
203 203  
204 204  Use Eclipse:
205 205  
206 -* Import -> Existing project, start with LaTeXRenderer project
207 -* Import all four projects
193 +* (((
194 +Import -> Existing project, start with LaTeXRenderer project
195 +)))
196 +* (((
197 +Import all four projects
198 +)))
208 208  
209 209  Due to license restrictions the **project LaTeXRenderer** is not linked or integrated by default. This must be done manually.
210 210  
211 211  {{code}}
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 -
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)
215 215  {{/code}}
216 216  
217 217  **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)
... ... @@ -218,14 +218,22 @@
218 218  
219 219  **Setup database for ONYX WebEditor**
220 220  
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
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 +)))
226 226  
227 -
228 -
229 229  Hint: you may use other user/database names, change configuration in
230 230  
231 231  {{code}}
... ... @@ -232,44 +232,67 @@
232 232  applicationContext.xml (see below)
233 233  {{/code}}
234 234  
235 -== Changes on ONYX QTI core ==
232 +Changes on ONYX QTI core
236 236  
237 237  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.
238 238  
239 -== Configuration ==
236 +Configuration
240 240  
241 241  **preWebOnyx**
242 242  
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
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 +)))
246 246  
247 247  **preWebEditor**
248 248  
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
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 +)))
254 254  
255 -== Deployment ==
268 +Deployment
256 256  
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)
261 261  * (((
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 +* (((
262 262  Call http:~/~/localhost:<port>/<path> in browser
263 263  )))
264 264  
265 -== Important notes ==
286 +Important notes
266 266  
267 267  **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.
268 268  
269 269  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.
270 270  
271 -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**.
272 272  {{/layout-cell}}
273 273  {{/layout-section}}
274 274  {{/layout}}
275 -{{/sv-translation}}
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -226231098
1 +3342771
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/226231098/Projekt Setupguide ONYX
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342771/Projekt Setupguide ONYX