Wiki-Quellcode von Projekt Setupguide ONYX

Version 365.1 von tleu am 17.12.2014

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 style="square" maxLevel="5" 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 == 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 WebEditor (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 * preWebOnyx (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 WebEditor**
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 WebEditor
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
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 {{/layout}}
175 {{/sv-translation}}
176
177 {{sv-translation language="en"}}
178 {{layout}}
179 {{layout-section ac:type="two_equal"}}
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 == System requirements ==
196
197 === All components ===
198
199 * (((
200 Linux-based OS
201 )))
202 * (((
203 Oracle Java8 (latest update)
204 )))
205 * (((
206 Apache Tomcat8 (latest update)
207 )))
208
209 === ONYX WebEditor (additionally) ===
210
211 * PostGreSQL (8.4.21 or later)
212 * Java unlimited security enabled
213
214 {{code}}
215 http://stackoverflow.com/questions/6481627/java-security-illegal-key-size-or-default-parameters
216 Download from http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html
217 {{/code}}
218
219 === Build process ===
220
221 * Linux-based OS
222 * Oracle Java7 (latest update)
223 * Eclipse for JEE (Kepler or later)
224 * Maven2
225 * Eclipse Maven integration (m2)
226
227 == Steps for build ==
228
229 All ONYX parts are delivered as Eclipse projects
230
231
232
233 * preWebOnyx (ONYX QTI test player)
234 * preWebEditor (ONYX QTI test editor)
235 * onyx (ONYX QTI core)
236 * (((
237 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)
238
239
240 )))
241
242 * Use Eclipse
243 * Import -> Existing project, start with LaTeXRenderer project
244 * Import all four projects
245
246 Due to license restrictions the **project LaTeXRenderer** is not linked or integrated by default. This must be done manually.
247
248 {{code}}
249 Ensure that project dependency from preWebOnyx and preWebEditor to LaTeXRenderer is fulfilled.
250 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
252 {{/code}}
253
254 **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)
255
256 **Setup database for ONYX WebEditor**
257
258 * Locate setupdatabase.postgre.sql
259 * Log on to Postgres
260 * Create user owe with password owe
261 * Create database owe and assign to user owe
262 * Import setupdatabase.postgre.sql to this database
263
264
265
266 Hint: you may use other user/database names, change configuration in
267
268 {{code}}
269 applicationContext.xml (see below)
270 {{/code}}
271
272 == Changes on ONYX QTI core ==
273
274 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.
275
276 == Configuration ==
277
278 **preWebOnyx**
279
280 * Locate onyxplugin.default.config.xml, copy it to a classpath folder and rename to//onyxplugin.config.xml//
281 * Configure as needed
282 * Service provider named “preview” is required if used as preview instance for ONYX WebEditor
283
284 **preWebEditor**
285
286 * applicationContext.xml: general configurations (database, mail configuration, preview ONYX (you can change this to your local installation), ...)
287 * metadataConfigurationContext.xml: normally no changes needed as long as no further metadata are required
288 * moduleConfigurationContext.xml: repository configuration
289 * pageModelContext.xml: normally no changes required, defines the main tabs in shown application
290 * webServiceContext.xml: reporter statistics connection, can be changed to your local ONYX installation
291
292 == Deployment ==
293
294 * 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)
295 * Configure Tomcat deployment to use different ports
296 * Check path the applications are mounted to
297 * Start Tomcat(s)
298 * Call http:~/~/localhost:<port>/<path> in browser
299
300 == Important notes ==
301
302 **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.
303
304 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.
305
306 In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with **4GB each**.
307 {{/layout-cell}}
308 {{/layout-section}}
309 {{/layout}}
310 {{/sv-translation}}