Zum Inhalt springen

Wiki-Quellcode von Projekt Setupguide ONYX

Version 276.1 von Carina Enke am 08.05.2019
Zeige letzte Bearbeiter
1 {{sv-translation language="de"}}
2 {{layout}}
3 {{layout-section ac:type="two_right_sidebar"}}
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 == System requirements ==
25
26 === All components ===
27
28 * (((
29 Linux-based OS
30 )))
31 * (((
32 Java 11 (latest update, Oracle or OpenJDK)
33 )))
34 * (((
35 Apache Tomcat 9 (latest update)
36 )))
37
38 === ONYX Editor (additionally) ===
39
40 * PostGreSQL (8.4.21 or later)
41 * Java unlimited security enabled
42
43 {{code}}
44 http://stackoverflow.com/questions/6481627/java-security-illegal-key-size-or-default-parameters
45 Download from http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html
46 {{/code}}
47
48 === Build process ===
49
50 * Linux-based OS
51 * Java 11 (latest update, Oracle or OpenJDK)
52 * Eclipse for JEE (Kepler or later)
53 * Maven2
54 * Eclipse Maven integration (m2)
55
56 == Steps for build ==
57
58 All ONYX parts are delivered as Eclipse projects
59
60
61
62 * preOnyx (ONYX QTI test player)
63 * preWebEditor (ONYX QTI test editor)
64 * onyx (ONYX QTI core)
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
68
69 * Use Eclipse
70 * Import -> Existing project, start with LaTeXRenderer project
71 * Import all four projects
72
73 Due to license restrictions the **project LaTeXRenderer** is not linked or integrated by default. This must be done manually.
74
75 {{code}}
76 Ensure that project dependency from preWebOnyx and preWebEditor to LaTeXRenderer is fulfilled.
77 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)
78
79
80 {{/code}}
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)
83
84 (% style="line-height: 1.4285715;" %)**Setup database for ONYX Editor**
85
86 * Locate setupdatabase.postgre.sql
87 * Log on to Postgres
88 * Create user owe with password owe
89 * Create database owe and assign to user owe
90 * Import setupdatabase.postgre.sql to this database
91
92
93
94 Hint: you may use other user/database names, change configuration in
95
96 {{code}}
97 applicationContext.xml (see below)
98 {{/code}}
99
100 == Changes on ONYX QTI core ==
101
102 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.
103
104 == Configuration ==
105
106 **preWebOnyx**
107
108 * Locate onyxplugin.default.config.xml, copy it to a classpath folder and rename to //onyxplugin.config.xml//
109 * Configure as needed
110 * Service provider named “preview” is required if used as preview instance for ONYX Editor
111
112 **preWebEditor**
113
114 * applicationContext.xml: general configurations (database, mail configuration, preview ONYX (you can change this to your local installation), ...)
115 * metadataConfigurationContext.xml: normally no changes needed as long as no further metadata are required
116 * moduleConfigurationContext.xml: repository configuration
117 * pageModelContext.xml: normally no changes required, defines the main tabs in shown application
118 * webServiceContext.xml: reporter statistics connection, can be changed to your local ONYX installation
119
120 == Deployment ==
121
122 * 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)
123 * Configure Tomcat deployment to use different ports
124 * Check path the applications are mounted to
125 * Start Tomcat(s)
126 * Call http:~/~/localhost:<port>/<path> in browser
127
128 == Important notes ==
129
130 **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.
131
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
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 {{/layout-cell}}
139 {{/layout-section}}
140 {{/layout}}
141 {{/sv-translation}}
142
143 {{sv-translation language="en"}}
144 {{layout}}
145 {{layout-section ac:type="two_equal"}}
146 {{layout-cell}}
147
148 {{/layout-cell}}
149
150 {{layout-cell}}
151 {{scroll-ignore}}
152 {{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
153
154
155 {{toc maxLevel="4"/}}
156
157 **
158 **
159 {{/panel}}
160 {{/scroll-ignore}}
161 {{/layout-cell}}
162 {{/layout-section}}
163
164 {{layout-section ac:type="single"}}
165 {{layout-cell}}
166 == System requirements ==
167
168 === All components ===
169
170 * (((
171 Linux-based OS
172 )))
173 * (((
174 Java 11 (Oracle or OpenJDK)
175 )))
176 * (((
177 Apache Tomcat 9
178 )))
179
180 === ONYX WebEditor (additionally) ===
181
182 * PostGreSQL (8.4.21 or later)
183 * Java unlimited security enabled
184
185 {{code}}
186 http://stackoverflow.com/questions/6481627/java-security-illegal-key-size-or-default-parameters
187 Download from http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html
188 {{/code}}
189
190 === Build process ===
191
192 * Linux-based OS
193 * Java 11 (Oracle or OpenJDK)
194 * Eclipse for JEE (Kepler or later)
195 * Maven2
196 * Eclipse Maven integration (m2)
197
198 == Steps for build ==
199
200 All ONYX parts are delivered as Eclipse projects:
201
202 * preWebOnyx (ONYX QTI test player)
203 * preWebEditor (ONYX QTI test editor)
204 * onyx (ONYX QTI core)
205 * (((
206 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)
207 )))
208
209 Use Eclipse:
210
211 * Import -> Existing project, start with LaTeXRenderer project
212 * Import all four projects
213
214 Due to license restrictions the **project LaTeXRenderer** is not linked or integrated by default. This must be done manually.
215
216 {{code}}
217 Ensure that project dependency from preWebOnyx and preWebEditor to LaTeXRenderer is fulfilled.
218 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)
219
220 {{/code}}
221
222 **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)
223
224 **Setup database for ONYX WebEditor**
225
226 * Locate setupdatabase.postgre.sql
227 * Log on to Postgres
228 * Create user owe with password owe
229 * Create database owe and assign to user owe
230 * Import setupdatabase.postgre.sql to this database
231
232
233
234 Hint: you may use other user/database names, change configuration in
235
236 {{code}}
237 applicationContext.xml (see below)
238 {{/code}}
239
240 == Changes on ONYX QTI core ==
241
242 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.
243
244 == Configuration ==
245
246 **preWebOnyx**
247
248 * Locate onyxplugin.default.config.xml, copy it to a classpath folder and rename to//onyxplugin.config.xml//
249 * Configure as needed
250 * Service provider named “preview” is required if used as preview instance for ONYX WebEditor
251
252 **preWebEditor**
253
254 * applicationContext.xml: general configurations (database, mail configuration, preview ONYX (you can change this to your local installation), ...)
255 * metadataConfigurationContext.xml: normally no changes needed as long as no further metadata are required
256 * moduleConfigurationContext.xml: repository configuration
257 * pageModelContext.xml: normally no changes required, defines the main tabs in shown application
258 * webServiceContext.xml: reporter statistics connection, can be changed to your local ONYX installation
259
260 == Deployment ==
261
262 * 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)
263 * Configure Tomcat deployment to use different ports
264 * Check path the applications are mounted to
265 * Start Tomcat(s)
266 * (((
267 Call http:~/~/localhost:<port>/<path> in browser
268 )))
269
270 == Important notes ==
271
272 **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.
273
274 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.
275
276 In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with **8 GB each**.
277 {{/layout-cell}}
278 {{/layout-section}}
279 {{/layout}}
280 {{/sv-translation}}