Zum Inhalt springen

Wiki-Quellcode von Projekt Setupguide ONYX

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