Zum Inhalt springen

Änderungen von Dokument 03 Projekt Setupguide ONYX

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

Zusammenfassung

Details

Seiteneigenschaften
Ü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,61 +6,15 @@
1 -{{sv-translation language="de"}}
2 -{{layout}}
3 -{{layout-section ac:type="two_right_sidebar"}}
4 -{{layout-cell}}
5 -====== Inhalt: ======
6 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 42  == System requirements ==
43 43  
44 44  === All components ===
45 45  
46 -* (((
47 -Linux-based OS
48 -)))
49 -* (((
50 -Oracle Java8 (latest update)
51 -)))
52 -* (((
53 -Apache Tomcat8 (latest update)
54 -)))
6 +* Linux-based OS
7 +* Java 17
8 +* Apache Tomcat 9 (latest update)
55 55  
56 -=== ONYX WebEditor (additionally) ===
10 +=== ONYX Editor (additionally) ===
57 57  
58 -* PostGreSQL (8.4.21 or later)
12 +* PostgreSQL 12
59 59  * Java unlimited security enabled
60 60  
61 61  {{code}}
... ... @@ -66,205 +66,35 @@
66 66  === Build process ===
67 67  
68 68  * Linux-based OS
69 -* Oracle Java7 (latest update)
23 +* Java 11 (latest update, Oracle or OpenJDK)
70 70  * Eclipse for JEE (Kepler or later)
71 71  * Maven2
72 72  * Eclipse Maven integration (m2)
73 73  
74 -== Steps for build ==
75 75  
76 -All ONYX parts are delivered as Eclipse projects
29 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
30 +{{toc start="2"/}}
77 77  
78 78  
33 +{{/panel}}
79 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 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 maxLevel="5" style="square" outline="true" absoluteUrl="true"/}}
186 -{{/layout-cell}}
187 -
188 -{{layout-cell}}
189 -|=(% colspan="1" %)(% colspan="1" %)
190 -(((
191 -Programmversion
192 -)))|(% colspan="1" %)(% colspan="1" %)
193 -(((
194 -
195 -)))
196 -|=(((
197 -Status
198 -)))|(((
199 -(% class="status-macro aui-lozenge aui-lozenge-error" %)DRAFT
200 -)))
201 -|=(((
202 -Aufgaben
203 -)))|(((
204 -
205 -
206 -
207 -)))
208 -|=(((
209 -JIRA
210 -)))|(((
211 -
212 -)))
213 -{{/layout-cell}}
214 -{{/layout-section}}
215 -
216 -{{layout-section ac:type="single"}}
217 -{{layout-cell}}
218 -== System requirements ==
219 -
220 -=== All components ===
221 -
222 -* (((
223 -Linux-based OS
224 -)))
225 -* (((
226 -Oracle Java8 (latest update)
227 -)))
228 -* (((
229 -Apache Tomcat8 (latest update)
230 -)))
231 -
232 -=== ONYX WebEditor (additionally) ===
233 -
234 -* PostGreSQL (8.4.21 or later)
235 -* Java unlimited security enabled
236 -
237 -{{code}}
238 -http://stackoverflow.com/questions/6481627/java-security-illegal-key-size-or-default-parameters
239 -Download from http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html
240 -{{/code}}
241 -
242 -=== Build process ===
243 -
244 -* Linux-based OS
245 -* Oracle Java7 (latest update)
246 -* Eclipse for JEE (Kepler or later)
247 -* Maven2
248 -* Eclipse Maven integration (m2)
249 -
250 250  == Steps for build ==
251 251  
252 252  All ONYX parts are delivered as Eclipse projects
253 253  
254 -
255 255  
256 -* preWebOnyx (ONYX QTI test player)
41 +* preOnyx (ONYX QTI test player)
257 257  * preWebEditor (ONYX QTI test editor)
258 258  * onyx (ONYX QTI core)
259 259  * 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)
260 -
261 -
262 262  
46 +
263 263  * Use Eclipse
264 264  * Import -> Existing project, start with LaTeXRenderer project
265 265  * Import all four projects
266 266  
267 -Due to license restrictions the **project LaTeXRenderer** is not linked or integrated by default. This must be done manually.
51 +Due to license restrictions the **project LaTeXRenderer** is not linked or integrated by default. This must be done manually.
268 268  
269 269  {{code}}
270 270  Ensure that project dependency from preWebOnyx and preWebEditor to LaTeXRenderer is fulfilled.
... ... @@ -273,9 +273,9 @@
273 273  
274 274  {{/code}}
275 275  
276 -**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)
60 +(% 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)
277 277  
278 -**Setup database for ONYX WebEditor**
62 +(% style="line-height:1.4285715" %)**Setup database for ONYX Editor**
279 279  
280 280  * Locate setupdatabase.postgre.sql
281 281  * Log on to Postgres
... ... @@ -283,8 +283,6 @@
283 283  * Create database owe and assign to user owe
284 284  * Import setupdatabase.postgre.sql to this database
285 285  
286 -
287 -
288 288  Hint: you may use other user/database names, change configuration in
289 289  
290 290  {{code}}
... ... @@ -299,9 +299,9 @@
299 299  
300 300  **preWebOnyx**
301 301  
302 -* Locate onyxplugin.default.config.xml, copy it to a classpath folder and rename to//onyxplugin.config.xml//
84 +* Locate onyxplugin.default.config.xml, copy it to a classpath folder and rename to //onyxplugin.config.xml//
303 303  * Configure as needed
304 -* Service provider named “preview” is required if used as preview instance for ONYX WebEditor
86 +* Service provider named “preview” is required if used as preview instance for ONYX Editor
305 305  
306 306  **preWebEditor**
307 307  
... ... @@ -317,16 +317,12 @@
317 317  * Configure Tomcat deployment to use different ports
318 318  * Check path the applications are mounted to
319 319  * Start Tomcat(s)
320 -* Call http:~/~/localhost:<port>/<path> in browser
102 +* Call http:~/~/localhost:<port>/<path> in browser
321 321  
322 322  == Important notes ==
323 323  
324 -**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.
106 +**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.
325 325  
326 326  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.
327 327  
328 -In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with **4GB each**.
329 -{{/layout-cell}}
330 -{{/layout-section}}
331 -{{/layout}}
332 -{{/sv-translation}}
110 +In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with **8 GB each**.
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -3342923
1 +3342771
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342923/Projekt Setupguide ONYX
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342771/Projekt Setupguide ONYX