Zum Inhalt springen

Wiki-Quellcode von Projekt Setupguide ONYX

Version 371.6 von Carina Enke am 18.12.2023
Zeige letzte Bearbeiter
1 {{sv-translation language="de"}}
2 {{layout}}
3 {{layout-section ac:type="single"}}
4 {{layout-cell}}{{/layout-cell}}
5 {{/layout-section}}
6
7 {{layout-section ac:type="two_right_sidebar"}}
8 {{layout-cell}}
9 == System requirements ==
10
11 === All components ===
12
13 * (((
14 Linux-based OS
15 )))
16 * (((
17 Java 17
18 )))
19 * (((
20 Apache Tomcat 9 (latest update)
21 )))
22
23 === ONYX Editor (additionally) ===
24
25 * PostgreSQL 12
26 * Java unlimited security enabled
27
28 {{code}}
29 http://stackoverflow.com/questions/6481627/java-security-illegal-key-size-or-default-parameters
30 Download from http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html
31 {{/code}}
32
33 === Build process ===
34
35 * Linux-based OS
36 * Java 11 (latest update, Oracle or OpenJDK)
37 * Eclipse for JEE (Kepler or later)
38 * Maven2
39 * Eclipse Maven integration (m2)
40 {{/layout-cell}}
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 == Steps for build ==
59
60 All ONYX parts are delivered as Eclipse projects
61
62 \\
63
64 * preOnyx (ONYX QTI test player)
65 * preWebEditor (ONYX QTI test editor)
66 * onyx (ONYX QTI core)
67 * 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)
68
69
70
71 * Use Eclipse
72 * Import -> Existing project, start with LaTeXRenderer project
73 * Import all four projects
74
75 Due to license restrictions the **project LaTeXRenderer** is not linked or integrated by default. This must be done manually.
76
77 {{code}}
78 Ensure that project dependency from preWebOnyx and preWebEditor to LaTeXRenderer is fulfilled.
79 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)
80
81
82 {{/code}}
83
84 (% 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)
85
86 (% style="line-height: 1.4285715;" %)**Setup database for ONYX Editor**
87
88 * Locate setupdatabase.postgre.sql
89 * Log on to Postgres
90 * Create user owe with password owe
91 * Create database owe and assign to user owe
92 * Import setupdatabase.postgre.sql to this database
93
94 \\
95
96 Hint: you may use other user/database names, change configuration in
97
98 {{code}}
99 applicationContext.xml (see below)
100 {{/code}}
101
102 == Changes on ONYX QTI core ==
103
104 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.
105
106 == Configuration ==
107
108 **preWebOnyx**
109
110 * Locate onyxplugin.default.config.xml, copy it to a classpath folder and rename to //onyxplugin.config.xml//
111 * Configure as needed
112 * Service provider named “preview” is required if used as preview instance for ONYX Editor
113
114 **preWebEditor**
115
116 * applicationContext.xml: general configurations (database, mail configuration, preview ONYX (you can change this to your local installation), ...)
117 * metadataConfigurationContext.xml: normally no changes needed as long as no further metadata are required
118 * moduleConfigurationContext.xml: repository configuration
119 * pageModelContext.xml: normally no changes required, defines the main tabs in shown application
120 * webServiceContext.xml: reporter statistics connection, can be changed to your local ONYX installation
121
122 == Deployment ==
123
124 * 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)
125 * Configure Tomcat deployment to use different ports
126 * Check path the applications are mounted to
127 * Start Tomcat(s)
128 * Call http:~/~/localhost:<port>/<path> in browser
129
130 == Important notes ==
131
132 **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.
133
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
136 In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with **8 GB each**.
137
138 **
139 **
140 {{/layout-cell}}
141 {{/layout-section}}
142 {{/layout}}
143 {{/sv-translation}}
144
145 {{sv-translation language="en"}}
146 {{layout}}
147 {{layout-section ac:type="two_right_sidebar"}}
148 {{layout-cell}}
149 == System requirements ==
150
151 === All components ===
152
153 * (((
154 Linux-based OS
155 )))
156 * (((
157 Java 17
158 )))
159 * (((
160 Apache Tomcat 9
161 )))
162
163 === ONYX WebEditor (additionally) ===
164
165 * PostgreSQL 12
166 * Java unlimited security enabled
167
168 {{code}}
169 http://stackoverflow.com/questions/6481627/java-security-illegal-key-size-or-default-parameters
170 Download from http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html
171 {{/code}}
172
173 === Build process ===
174
175 * Linux-based OS
176 * Java 11 (Oracle or OpenJDK)
177 * Eclipse for JEE (Kepler or later)
178 * Maven2
179 * Eclipse Maven integration (m2)
180 {{/layout-cell}}
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 == Steps for build ==
199
200 All ONYX parts are delivered as Eclipse projects:
201
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 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 )))
214
215 Use Eclipse:
216
217 * (((
218 Import -> Existing project, start with LaTeXRenderer project
219 )))
220 * (((
221 Import all four projects
222 )))
223
224 Due to license restrictions the **project LaTeXRenderer** is not linked or integrated by default. This must be done manually.
225
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)
228 {{/code}}
229
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
232 **Setup database for ONYX WebEditor**
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 )))
249
250 \\
251
252 Hint: you may use other user/database names, change configuration in
253
254 {{code}}
255 applicationContext.xml (see below)
256 {{/code}}
257
258 Changes on ONYX QTI core
259
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
262 Configuration
263
264 **preWebOnyx**
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 )))
275
276 **preWebEditor**
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 )))
293
294 Deployment
295
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 Call http:~/~/localhost:<port>/<path> in browser
310 )))
311
312 Important notes
313
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
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
318 In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with **8 GB each**.
319 {{/layout-cell}}
320 {{/layout-section}}
321 {{/layout}}
322 {{/sv-translation}}