Zum Inhalt springen

Änderungen von Dokument 03 Projekt Setupguide ONYX

Zuletzt geändert von Carina Enke am 19.02.2024
Von Version 367.1
bearbeitet von sandra_riediger
am 15.12.2014
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 374.1
bearbeitet von Carina Enke
am 19.12.2023
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Titel
... ... @@ -1,1 +1,1 @@
1 -ONYX project setup guide
1 +Projekt Setupguide ONYX
Übergeordnete Seite
... ... @@ -1,0 +1,1 @@
1 +ONYX.Systeminformationen.WebHome
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.sandra_riediger
1 +XWiki.carina
Inhalt
... ... @@ -1,42 +5,10 @@
1 -{{layout}}
2 -{{layout-section ac:type="two_right_sidebar"}}
3 -{{layout-cell}}
4 -====== Inhalt: ======
5 5  
6 -
7 -
8 -{{toc style="square" maxLevel="5" outline="true" absoluteUrl="true"/}}
9 -{{/layout-cell}}
10 -
11 -{{layout-cell}}
12 -|=(% colspan="1" %)(% colspan="1" %)
13 -(((
14 -Programmversion
15 -)))|(% colspan="1" %)(% colspan="1" %)
16 -(((
17 -
18 -)))
19 -|=(((
20 -Status
21 -)))|(((
22 -(% class="status-macro aui-lozenge aui-lozenge-error" %)ENTWURF
23 -)))
24 -|=(((
25 -Aufgaben
26 -)))|(((
27 -
28 -
29 -
30 -)))
31 -|=(((
32 -JIRA
33 -)))|(((
34 -
35 -)))
36 -{{/layout-cell}}
2 +{{layout}}
3 +{{layout-section ac:type="single"}}
4 +{{layout-cell}}{{/layout-cell}}
37 37  {{/layout-section}}
38 38  
39 -{{layout-section ac:type="single"}}
7 +{{layout-section ac:type="two_right_sidebar"}}
40 40  {{layout-cell}}
41 41  == System requirements ==
42 42  
... ... @@ -46,39 +46,54 @@
46 46  Linux-based OS
47 47  )))
48 48  * (((
49 -Oracle Java7 (latest update)
17 +Java 17
50 50  )))
51 51  * (((
52 -Apache Tomcat7 (latest update)
20 +Apache Tomcat 9 (latest update)
53 53  )))
54 54  
55 -=== ONYX WebEditor (additionally) ===
23 +=== ONYX Editor (additionally) ===
56 56  
57 -* PostGreSQL (8.4.21 or later)
58 -
25 +* PostgreSQL 12
59 59  * Java unlimited security enabled
60 60  
61 -{{section border="true"}}
62 -[[http:~~/~~/stackoverflow.com/questions/6481627/java-security-illegal-key-size-or-default-parameters>>url:http://stackoverflow.com/questions/6481627/java-security-illegal-key-size-or-default-parameters||shape="rect"]]
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}}
63 63  
64 -Download from [[http:~~/~~/www.oracle.com/technetwork/java/javase/downloads/jce-7-download->>url:http://www.oracle.com/technetwork/java/javase/downloads/jce-7-download-||shape="rect"]][[432124.html>>url:http://www.oracle.com/technetwork/java/javase/downloads/jce-7-download-432124.html||shape="rect"]]
65 -{{/section}}
66 -
67 67  === Build process ===
68 68  
69 69  * Linux-based OS
70 -* Oracle Java7 (latest update)
36 +* Java 11 (latest update, Oracle or OpenJDK)
71 71  * Eclipse for JEE (Kepler or later)
72 72  * Maven2
73 73  * Eclipse Maven integration (m2)
40 +{{/layout-cell}}
74 74  
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}}
75 75  == Steps for build ==
76 76  
77 77  All ONYX parts are delivered as Eclipse projects
78 78  
79 -
62 +\\
80 80  
81 -* preWebOnyx (ONYX QTI test player)
64 +* preOnyx (ONYX QTI test player)
82 82  * preWebEditor (ONYX QTI test editor)
83 83  * onyx (ONYX QTI core)
84 84  * 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)
... ... @@ -91,29 +91,249 @@
91 91  
92 92  Due to license restrictions the **project LaTeXRenderer** is not linked or integrated by default. This must be done manually.
93 93  
94 -{{section}}
95 -1. Ensure that project dependency from preWebOnyx and preWebEditor to LaTeXRenderer is fulfilled.
96 -1. 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)
97 -{{/section}}
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)
98 98  
99 99  
100 -**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)
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 +**
101 101  {{/layout-cell}}
102 102  {{/layout-section}}
142 +{{/layout}}
103 103  
144 +
145 +
146 +{{layout}}
104 104  {{layout-section ac:type="two_right_sidebar"}}
105 105  {{layout-cell}}
106 -====== untergeordnete Seiten: ======
149 +== System requirements ==
107 107  
151 +=== All components ===
108 108  
153 +* (((
154 +Linux-based OS
155 +)))
156 +* (((
157 +Java 17
158 +)))
159 +* (((
160 +Apache Tomcat 9
161 +)))
109 109  
110 -{{children all="true"/}}
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)
111 111  {{/layout-cell}}
112 112  
113 113  {{layout-cell}}
114 -====== relevante Links: ======
183 +{{scroll-ignore}}
184 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
115 115  
116 -* [[lorem ipsum>>url:https://www.bps-system.de/help/display/OPAL/Handbuch+OPAL||shape="rect"]]
186 +
187 +{{toc maxLevel="4"/}}
188 +
189 +**
190 +**
191 +{{/panel}}
192 +{{/scroll-ignore}}
117 117  {{/layout-cell}}
118 118  {{/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}}
119 119  {{/layout}}
322 +
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -3342779
1 +3342771
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342779/ONYX project setup guide
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342771/Projekt Setupguide ONYX