Änderungen von Dokument 03 Projekt Setupguide ONYX
Zuletzt geändert von Carina Enke am 19.02.2024
Von Version 365.1
bearbeitet von tleu
am 17.12.2014
am 17.12.2014
Änderungskommentar:
Es gibt keinen Kommentar für diese Version
Auf Version 376.1
bearbeitet von Carina Enke
am 19.12.2023
am 19.12.2023
Änderungskommentar:
Es gibt keinen Kommentar für diese Version
Zusammenfassung
-
Seiteneigenschaften (3 geändert, 0 hinzugefügt, 0 gelöscht)
-
Objekte (1 geändert, 0 hinzugefügt, 0 gelöscht)
Details
- Seiteneigenschaften
-
- Übergeordnete Seite
-
... ... @@ -1,0 +1,1 @@ 1 +ONYX.Systeminformationen.WebHome - Dokument-Autor
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. tleu1 +XWiki.carina - Inhalt
-
... ... @@ -1,43 +6,10 @@ 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}} 2 +{{layout}} 3 +{{layout-section ac:type="single"}} 4 +{{layout-cell}}{{/layout-cell}} 38 38 {{/layout-section}} 39 39 40 -{{layout-section ac:type=" single"}}7 +{{layout-section ac:type="two_right_sidebar"}} 41 41 {{layout-cell}} 42 42 == System requirements == 43 43 ... ... @@ -47,15 +47,15 @@ 47 47 Linux-based OS 48 48 ))) 49 49 * ((( 50 - OracleJava8(latest update)17 +Java 17 51 51 ))) 52 52 * ((( 53 -Apache Tomcat 8(latest update)20 +Apache Tomcat 9 (latest update) 54 54 ))) 55 55 56 -=== ONYX WebEditor (additionally) ===23 +=== ONYX Editor (additionally) === 57 57 58 -* Post GreSQL(8.4.21or later)25 +* PostgreSQL 12 59 59 * Java unlimited security enabled 60 60 61 61 {{code}} ... ... @@ -66,18 +66,35 @@ 66 66 === Build process === 67 67 68 68 * Linux-based OS 69 -* OracleJava7(latest update)36 +* Java 11 (latest update, Oracle or OpenJDK) 70 70 * Eclipse for JEE (Kepler or later) 71 71 * Maven2 72 72 * Eclipse Maven integration (m2) 40 +{{/layout-cell}} 73 73 42 +{{layout-cell}} 43 + 44 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}} 45 + 46 + 47 +{{toc/}} 48 + 49 +** 50 +** 51 +{{/panel}} 52 + 53 +{{/layout-cell}} 54 +{{/layout-section}} 55 + 56 +{{layout-section ac:type="single"}} 57 +{{layout-cell}} 74 74 == Steps for build == 75 75 76 76 All ONYX parts are delivered as Eclipse projects 77 77 78 - 62 +\\ 79 79 80 -* pre WebOnyx (ONYX QTI test player)64 +* preOnyx (ONYX QTI test player) 81 81 * preWebEditor (ONYX QTI test editor) 82 82 * onyx (ONYX QTI core) 83 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) ... ... @@ -99,7 +99,7 @@ 99 99 100 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 101 102 -(% style="line-height: 1.4285715;" %)**Setup database for ONYX WebEditor**86 +(% style="line-height: 1.4285715;" %)**Setup database for ONYX Editor** 103 103 104 104 * Locate setupdatabase.postgre.sql 105 105 * Log on to Postgres ... ... @@ -107,7 +107,7 @@ 107 107 * Create database owe and assign to user owe 108 108 * Import setupdatabase.postgre.sql to this database 109 109 110 - 94 +\\ 111 111 112 112 Hint: you may use other user/database names, change configuration in 113 113 ... ... @@ -125,7 +125,7 @@ 125 125 126 126 * Locate onyxplugin.default.config.xml, copy it to a classpath folder and rename to //onyxplugin.config.xml// 127 127 * Configure as needed 128 -* Service provider named “preview” is required if used as preview instance for ONYX WebEditor112 +* Service provider named “preview” is required if used as preview instance for ONYX Editor 129 129 130 130 **preWebEditor** 131 131 ... ... @@ -149,51 +149,21 @@ 149 149 150 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 151 152 -In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with ** 4GB each**.136 +In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with **8 GB each**. 153 153 154 154 ** 155 155 ** 156 156 {{/layout-cell}} 157 157 {{/layout-section}} 142 +{{/layout}} 158 158 159 -{{layout-section ac:type="two_right_sidebar"}} 160 -{{layout-cell}} 161 -====== untergeordnete Seiten: ====== 162 162 163 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 178 {{layout}} 179 -{{layout-section ac:type="two_e qual"}}147 +{{layout-section ac:type="two_right_sidebar"}} 180 180 {{layout-cell}} 181 -== ====Content:======149 +== System requirements == 182 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 197 === All components === 198 198 199 199 * ((( ... ... @@ -200,15 +200,15 @@ 200 200 Linux-based OS 201 201 ))) 202 202 * ((( 203 - OracleJava8(latest update)157 +Java 17 204 204 ))) 205 205 * ((( 206 -Apache Tomcat 8(latest update)160 +Apache Tomcat 9 207 207 ))) 208 208 209 209 === ONYX WebEditor (additionally) === 210 210 211 -* Post GreSQL(8.4.21or later)165 +* PostgreSQL 12 212 212 * Java unlimited security enabled 213 213 214 214 {{code}} ... ... @@ -219,36 +219,58 @@ 219 219 === Build process === 220 220 221 221 * Linux-based OS 222 -* OracleJava7(latestupdate)176 +* Java 11 (Oracle or OpenJDK) 223 223 * Eclipse for JEE (Kepler or later) 224 224 * Maven2 225 225 * Eclipse Maven integration (m2) 180 +{{/layout-cell}} 226 226 227 - == Steps for build ==182 +{{layout-cell}} 228 228 229 - All ONYXparts are deliveredas Eclipse projects184 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}} 230 230 231 - 232 232 233 -* preWebOnyx (ONYX QTI test player) 234 -* preWebEditor (ONYX QTI test editor) 235 -* onyx (ONYX QTI core) 187 +{{toc maxLevel="4"/}} 188 + 189 +** 190 +** 191 +{{/panel}} 192 + 193 +{{/layout-cell}} 194 +{{/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 + 236 236 * ((( 203 +preWebOnyx (ONYX QTI test player) 204 +))) 205 +* ((( 206 +preWebEditor (ONYX QTI test editor) 207 +))) 208 +* ((( 209 +onyx (ONYX QTI core) 210 +))) 211 +* ((( 237 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 240 ))) 241 241 242 -* Use Eclipse 243 -* Import -> Existing project, start with LaTeXRenderer project 244 -* Import all four projects 215 +Use Eclipse: 245 245 217 +* ((( 218 +Import -> Existing project, start with LaTeXRenderer project 219 +))) 220 +* ((( 221 +Import all four projects 222 +))) 223 + 246 246 Due to license restrictions the **project LaTeXRenderer** is not linked or integrated by default. This must be done manually. 247 247 248 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 - 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) 252 252 {{/code}} 253 253 254 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,13 +255,23 @@ 255 255 256 256 **Setup database for ONYX WebEditor** 257 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 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 +))) 263 263 264 - 250 +\\ 265 265 266 266 Hint: you may use other user/database names, change configuration in 267 267 ... ... @@ -269,42 +269,68 @@ 269 269 applicationContext.xml (see below) 270 270 {{/code}} 271 271 272 - ==Changes on ONYX QTI core==258 +Changes on ONYX QTI core 273 273 274 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 275 276 - ==Configuration==262 +Configuration 277 277 278 278 **preWebOnyx** 279 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 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 +))) 283 283 284 284 **preWebEditor** 285 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 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 +))) 291 291 292 - ==Deployment==294 +Deployment 293 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 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 +))) 299 299 300 - ==Important notes==312 +Important notes 301 301 302 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 303 304 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 305 306 -In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with 4GB each**.318 +In server environment ONYX applications uses memory strongly dependent from load and users activities. BPS runs them with **8 GB each**. 307 307 {{/layout-cell}} 308 308 {{/layout-section}} 309 309 {{/layout}} 310 - {{/sv-translation}}322 +
- Confluence.Code.ConfluencePageClass[0]
-
- id
-
... ... @@ -1,1 +1,1 @@ 1 -3342 9561 +3342771 - url
-
... ... @@ -1,1 +1,1 @@ 1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342 956/Projekt Setupguide ONYX1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342771/Projekt Setupguide ONYX