Zum Inhalt springen

Wiki-Quellcode von Installation ONYX WebEditor

Version 417.1 von sandra_riediger am 15.12.2014
Zeige letzte Bearbeiter
1 {{sv-translation language="de"}}
2 {{layout}}
3 {{layout-section ac:type="single"}}
4 {{layout-cell}}
5 [[http:~~/~~/tomcat.apache.org/download-80.cgi>>url:http://tomcat.apache.org/download-80.cgi||title="Verknüpfung folgen" rel="nofollow" shape="rect"]]
6
7 ====== Inhalt: ======
8
9
10
11 {{toc style="none" maxLevel="5" outline="true"/}}
12 {{/layout-cell}}
13 {{/layout-section}}
14
15 {{layout-section ac:type="single"}}
16 {{layout-cell}}
17 Documentation to install ONYX Editor as a productive instance on a Linux server.
18
19 == Requirements ==
20
21 Oracle Java 8
22
23 Apache Tomcat 8
24
25 PostgreSQL 9
26
27 MAXIMA for the use of calculations (optional)
28
29 == Download AND Install of Requirements ==
30
31 === Download and install Oracle JDK 8 ===
32
33 [[http:~~/~~/www.oracle.com/technetwork/java/javase/downloads/>>url:http://www.oracle.com/technetwork/java/javase/downloads/||title="Verknüpfung folgen" rel="nofollow" shape="rect"]]
34
35 {{code language="powershell"}}
36 tar xfz jdk-8uX-linux-x64.tar.gz -C /opt
37 {{/code}}
38
39 **Let the environment variable $JAVA_HOME point to the JDK directory:**
40
41 {{code language="powershell"}}
42 export JAVA_HOME=/opt/jdk1.8.X
43 {{/code}}
44
45 === Download and install Tomcat 8 ===
46
47 [[http:~~/~~/tomcat.apache.org/download-80.cgi>>url:http://tomcat.apache.org/download-80.cgi||title="Verknüpfung folgen" rel="nofollow" shape="rect"]]
48
49 {{code language="powershell"}}
50 tar xfz apache-tomcat-8.X.X.tar.gz -C /opt
51 {{/code}}
52
53 === Download and install PostgreSQL 9 ===
54
55 [[http:~~/~~/www.enterprisedb.com/products-services-training/pgdownload>>url:http://www.enterprisedb.com/products-services-training/pgdownload||title="Verknüpfung folgen" rel="nofollow" shape="rect"]]
56
57 {{code language="powershell"}}
58 chmod u+x postgresql-9.X-linux-x64.run
59 ./postgresql-9.X-linux-x64.run 
60 {{/code}}
61
62 === Download and install MAXIMA (optional) ===
63
64 Install MAXIMA, if you like to use calculations
65
66 Installation on RHEL/Fedora/CentOS:
67
68 {{code language="powershell"}}
69 sudo yum install maxima
70 {{/code}}
71
72 Installation on Debian/Ubuntu/Mint:
73
74 {{code language="powershell"}}
75 sudo aptitude install maxima
76 {{/code}}
77
78 Or visit [[http:~~/~~/maxima.sourceforge.net/>>url:http://maxima.sourceforge.net/||shape="rect"]] and download the MAXIMA files
79
80 == Deployment ==
81
82 === New installation ===
83
84 Extract the webeditor-X.X.war to $ {TOMCAT_HOME}/webapps/webeditor
85
86 {{code language="powershell"}}
87 unzip webeditor-X.X.war -d /opt/apache-tomcat-X.X.XX/webapps/webeditor
88 {{/code}}
89
90 Create database user and database
91
92 {{code language="powershell"}}
93 su postgres
94 /opt/PostgreSQL/X.X/bin/createuser -P onyxeditor
95 /opt/PostgreSQL/X.X/bin/createdb -O onyxeditor onyxeditor 
96 {{/code}}
97
98 Initialize database
99
100 {{code language="sql"}}
101 psql -h localhost -U onyxeditor onyxeditor < /opt/apache-tomcat-X.X.XX/webapps/webeditor/WEB-INF/classes/database/setupdatabase.sql
102 {{/code}}
103
104 === Update installation ===
105
106 Delete old ONYX war-files and dirs from ${TOMCAT_HOME}/webapps
107
108 It might be useful to clear the work and temp directory of the Tomcat Server:
109
110 {{code}}
111 rm -rf ${TOMCAT_HOME}/temp/* ${TOMCAT_HOME}/work/*
112 {{/code}}
113
114 Start your Tomcat
115
116 {{code}}
117 /opt/apache-tomcat-7.X.XX/bin/startup.sh
118 {{/code}}
119
120 Open the following URL in your browser: [[http:~~/~~/localhost:8080/webeditor>>url:http://localhost:8080/webeditor||shape="rect"]]
121
122 === Create super user account ===
123
124 Register a new user on homescreen
125
126 Connect to database and select the new user
127
128 {{code}}
129 select * from users;
130 UPDATE users SET role=0 WHERE ID = XXX;
131 {{/code}}
132
133
134
135 === Configuration ===
136
137 The configuration files can be found inside the webeditor folder in your tomcat installation ( see " /opt/apache-tomcat-7.X.XX/webapps/webeditor/ " ).
138
139 **WEB-INF/classes/de/bps/onyx/context/moduleConfigurationContext.xml**
140
141 This file is the config for ONYX Editor repository configurations.
142
143 {{code language="xml"}}
144 ...
145 <bean id="de.bps.onyx.manager.RepositoryConfigurationManager" class="de.bps.onyx.manager.RepositoryConfigurationManager">
146 <property name="modules">
147 <map>
148 <entry key="FileSystemModule" value-ref="de.bps.onyx.manager.modules.FileSystemModule" />
149 <entry key="OLATRepoModule" value-ref="de.bps.onyx.manager.modules.OPALRepoModule" />
150 <entry key="PREOLATCERepoConfiguration" value-ref="de.bps.onyx.manager.modules.PREOLATCERepoConfiguration" />
151 </map>
152 </property>
153 <property name="defaultModule" ref="de.bps.onyx.manager.modules.OPALRepoModule" />
154 </bean>
155 ... 
156 {{/code}}
157
158 * defines the repositories available:
159 ** key defines the internal repository ID. It may be named as you want.
160 ** value-ref references the bean which defines the repository configuration:
161
162 {{code language="xml"}}
163 ...
164 <bean id="de.bps.onyx.manager.modules.FileSystemModule" class="de.bps.onyx.manager.modules.FileSystemModule">
165 <constructor-arg index="0" ref="FileSystemConfiguration" />
166 </bean>
167 ... 
168 {{/code}}
169
170 * instantiates the repository configuration depending on repository type:
171 ** de.bps.onyx.manager.modules.FileSystemModule: value-ref from above
172 ** class="...": One of:
173 *** de.bps.onyx.manager.modules.FileSystemModule (local file system repository)
174 *** de.bps.onyx.manager.modules.OPALRepoModule (uses an OLAT LMS as repository)
175 ** constructor-arg: ref references the configuration bean as follows:
176
177 ===== File system repository: =====
178
179 {{code language="xml"}}
180 ...
181 <bean id="FileSystemConfiguration" class="de.bps.onyx.model.repo.RepositoryModuleConfiguration">
182 <property name="name" value="FileSystemModule" />
183 <property name="typeKey" value="FileSystemModule" />
184 <property name="description" value="File system module" />
185 <property name="canHandleGuest" value="true" />
186 <property name="serviceTarget" value="/opt/owe/fsr" />
187 <property name="displayname" value="Repository PRE/OLATCE" />
188 </bean>
189 ... 
190 {{/code}}
191
192 * name: Name which is used internal in ONYX WebEditor as identifier (**must** match key in line <entry key="FileSystemModule" value-ref="de.bps.onyx.manager.modules.FileSystemModule" /> above)
193 * typeKey: Repository type definition
194 * description: Some description (not used at the moment)
195 * canHandleGuest: set to true if this repository can handle guest users (without logon)
196 * serviceTarget: File system path
197 * displayname: String to show as repository name in ONYX Editor (if not given, some internal translation will be done to show a generic and type dependent name)
198
199 ===== OLAT repository: =====
200
201 {{code language="powershell"}}
202 ...
203 <bean id="OPALRepoConfiguration" class="de.bps.onyx.model.repo.RepositoryModuleConfiguration">
204 ...
205 <property name="serviceTarget" value="https://next.bps-system.de/opal/services/" />
206 ...
207 </bean>
208 ... 
209 {{/code}}
210
211 * serviceTarget: OLAT URL
212 * Other properties as stated above for File system repository
213
214 **WEB-INF/classes/de/bps/onyx/context/applicationContext.xml**
215
216 This file contains the configuration for: the connection to ONYX Player. The ONYX Player is used for preview.
217
218 {{code language="xml"}}
219 ...
220 <property name="system" value="preonyxeditor" />
221 <property name="previewAddress" value="http://pre.bps-system.de/onyx"/>
222 ...
223 {{/code}}
224
225 In this example is the ONYX Player used at URL [[http:~~/~~/pre.bps-system.de/onyx>>url:http://pre.bps-system.de/onyx||rel="nofollow" shape="rect" class="external free"]] . The serviceprovider name (used by ONYX Player) is: preonyxeditor
226
227 The connection to database example:
228
229 {{code language="xml"}}
230 <property name="dbDriverClass" value="org.postgresql.Driver" />
231 <property name="dbConnectionUrl" value="jdbc:postgresql://localhost:5432/dbname" />
232 <property name="dbUserName" value="username" />
233 <property name="dbPassword" value="userpassword" />
234 <property name="dbDialect" value="org.hibernate.dialect.PostgreSQLDialect" /> 
235 {{/code}}
236
237 **WEB-INF/classes/de/bps/onyx/context/webServiceContext.xml**
238
239 This file contains the configuration for the connection of the ONYX Player. This ONYX Player is used for statistic issues.
240
241 Example:
242
243 {{code language="xml"}}
244 ...
245 <bean id="OnyxReporterTarget" class="de.bps.onyx.manager.reporter.service.OnyxReporterTarget">
246 <constructor-arg name="target" value="https://onyx.bps-system.de/preview/reporterservices" />
247 </bean>
248
249 <bean id="OnyxReporterProvider" class="de.bps.onyx.manager.reporter.service.OnyxReporterProvider">
250 <constructor-arg name="id" value="previewid" />
251 </bean>
252 ...
253 {{/code}}
254
255 In this example is the ONYX Player used at URL [[https:~~/~~/onyx.bps-system.de/preview/ .>>url:https://onyx.bps-system.de/preview/.&nbsp||rel="nofollow" shape="rect" class="external text"]] The serviceprovider name (used by ONYX Player) is: previewed
256
257 === Update installation ===
258
259 **Start your Tomcat**
260
261 {{code language="powershell"}}
262 /opt/apache-tomcat-7.X.XX/bin/startup.sh
263 {{/code}}
264
265
266
267 **Open the following URL in your browser:**
268
269 [[http:~~/~~/localhost:8080/webeditor>>url:http://localhost:8080/webeditor||rel="nofollow" shape="rect" class="external free"]]
270
271 == create super user account ==
272
273 1. register a new user on homescreen.
274 1. connect to database and select the new user:  'select * from users;'
275 1. UPDATE users SET role=0 WHERE ID = XXX;
276 {{/layout-cell}}
277 {{/layout-section}}
278 {{/layout}}
279 {{/sv-translation}}
280
281 {{sv-translation language="en"}}
282 {{layout}}
283 {{layout-section ac:type="single"}}
284 {{layout-cell}}
285 (% style="color: rgb(112,112,112);" %)Content:
286
287
288
289 {{toc outline="true"/}}
290 {{/layout-cell}}
291 {{/layout-section}}
292
293 {{layout-section ac:type="single"}}
294 {{layout-cell}}
295 Documentation to install ONYX Editor as a productive instance on a Linux server.
296
297 == Requirements ==
298
299 * Oracle Java 7
300 * Apache Tomcat 7
301 * PostgreSQL 9
302 * MAXIMA for the use of calculations (optional)
303
304 == Download AND Install of Requirements ==
305
306 === Download and install Oracle JDK 7 ===
307
308 [[http:~~/~~/www.oracle.com/technetwork/java/javase/downloads/>>url:http://www.oracle.com/technetwork/java/javase/downloads/||rel="nofollow" shape="rect" class="external free"]]
309
310 {{code language="powershell"}}
311 tar xfz jdk-7uX-linux-x64.tar.gz -C /opt 
312 {{/code}}
313
314 **Let the environment variable $JAVA_HOME point to the JDK directory:**
315
316 {{code language="powershell"}}
317 export JAVA_HOME=/opt/jdk1.7.X
318 {{/code}}
319
320 === Download and install Tomcat 7 ===
321
322 [[http:~~/~~/tomcat.apache.org/download-70.cgi>>url:http://tomcat.apache.org/download-70.cgi||rel="nofollow" shape="rect" class="external free"]]
323
324 {{code language="powershell"}}
325 tar xfz apache-tomcat-7.X.X.tar.gz -C /opt 
326 {{/code}}
327
328 === Download and install PostgreSQL 9 ===
329
330 [[http:~~/~~/www.enterprisedb.com/products-services-training/pgdownload>>url:http://www.enterprisedb.com/products-services-training/pgdownload||rel="nofollow" shape="rect" class="external free"]]
331
332 {{code language="powershell"}}
333 chmod u+x postgresql-9.X-linux-x64.run
334 ./postgresql-9.X-linux-x64.run 
335 {{/code}}
336
337 === Download and install MAXIMA (optional) ===
338
339 Install MAXIMA, if you like to use calculations
340
341 * Installation on RHEL/Fedora/CentOS:
342
343 {{code language="powershell"}}
344 sudo yum install maxima
345 {{/code}}
346
347 * Installation on Debian/Ubuntu/Mint:
348
349 {{code language="powershell"}}
350 sudo aptitude install maxima
351 {{/code}}
352
353 * Or visit [[http:~~/~~/maxima.sourceforge.net/>>url:http://maxima.sourceforge.net/||shape="rect"]] and download the MAXIMA files
354
355 == Deployment ==
356
357 === New installation ===
358
359 Extract the webeditor-X.X.war to ${TOMCAT_HOME}/webapps/webeditor
360
361 {{code language="powershell"}}
362 unzip webeditor-X.X.war -d /opt/apache-tomcat-7.X.XX/webapps/webeditor 
363 {{/code}}
364
365 Create database user and database
366
367 {{code language="powershell"}}
368 su postgres
369 /opt/PostgreSQL/9.X/bin/createuser -P onyxeditor
370 /opt/PostgreSQL/9.X/bin/createdb -O onyxeditor onyxeditor 
371 {{/code}}
372
373 Initialize database
374
375 {{code language="sql"}}
376 /opt/PostgreSQL/9.X/bin/psql -h localhost -U onyxeditor onyxeditor < /opt/apache-tomcat-7.X.XX/webapps/webeditor/WEB-INF/classes/database/setupdatabase.sql 
377 {{/code}}
378
379 === Configuration ===
380
381 The configuration files can be found inside the webeditor folder in your tomcat installation ( see " /opt/apache-tomcat-7.X.XX/webapps/webeditor/ " ).
382
383 **WEB-INF/classes/de/bps/onyx/context/moduleConfigurationContext.xml**
384
385 This file is the config for ONYX Editor repository configurations.
386
387 {{code language="xml"}}
388 ...
389 <bean id="de.bps.onyx.manager.RepositoryConfigurationManager" class="de.bps.onyx.manager.RepositoryConfigurationManager">
390 <property name="modules">
391 <map>
392 <entry key="FileSystemModule" value-ref="de.bps.onyx.manager.modules.FileSystemModule" />
393 <entry key="OLATRepoModule" value-ref="de.bps.onyx.manager.modules.OPALRepoModule" />
394 <entry key="PREOLATCERepoConfiguration" value-ref="de.bps.onyx.manager.modules.PREOLATCERepoConfiguration" />
395 </map>
396 </property>
397 <property name="defaultModule" ref="de.bps.onyx.manager.modules.OPALRepoModule" />
398 </bean>
399 ... 
400 {{/code}}
401
402 * defines the repositories available:
403 ** key defines the internal repository ID. It may be named as you want.
404 ** value-ref references the bean which defines the repository configuration:
405
406 {{code language="xml"}}
407 ...
408 <bean id="de.bps.onyx.manager.modules.FileSystemModule" class="de.bps.onyx.manager.modules.FileSystemModule">
409 <constructor-arg index="0" ref="FileSystemConfiguration" />
410 </bean>
411 ... 
412 {{/code}}
413
414 * instantiates the repository configuration depending on repository type:
415 ** de.bps.onyx.manager.modules.FileSystemModule: value-ref from above
416 ** class="...": One of:
417 *** de.bps.onyx.manager.modules.FileSystemModule (local file system repository)
418 *** de.bps.onyx.manager.modules.OPALRepoModule (uses an OLAT LMS as repository)
419 ** constructor-arg: ref references the configuration bean as follows:
420
421 ===== File system repository: =====
422
423 {{code language="xml"}}
424 ...
425 <bean id="FileSystemConfiguration" class="de.bps.onyx.model.repo.RepositoryModuleConfiguration">
426 <property name="name" value="FileSystemModule" />
427 <property name="typeKey" value="FileSystemModule" />
428 <property name="description" value="File system module" />
429 <property name="canHandleGuest" value="true" />
430 <property name="serviceTarget" value="/opt/owe/fsr" />
431 <property name="displayname" value="Repository PRE/OLATCE" />
432 </bean>
433 ... 
434 {{/code}}
435
436 * name: Name which is used internal in ONYX WebEditor as identifier (**must** match key in line <entry key="FileSystemModule" value-ref="de.bps.onyx.manager.modules.FileSystemModule" /> above)
437 * typeKey: Repository type definition
438 * description: Some description (not used at the moment)
439 * canHandleGuest: set to true if this repository can handle guest users (without logon)
440 * serviceTarget: File system path
441 * displayname: String to show as repository name in ONYX Editor (if not given, some internal translation will be done to show a generic and type dependent name)
442
443 ===== OLAT repository: =====
444
445 {{code language="powershell"}}
446 ...
447 <bean id="OPALRepoConfiguration" class="de.bps.onyx.model.repo.RepositoryModuleConfiguration">
448 ...
449 <property name="serviceTarget" value="https://next.bps-system.de/opal/services/" />
450 ...
451 </bean>
452 ... 
453 {{/code}}
454
455 * serviceTarget: OLAT URL
456 * Other properties as stated above for File system repository
457
458 **WEB-INF/classes/de/bps/onyx/context/applicationContext.xml**
459
460 This file contains the configuration for: the connection to ONYX Player. The ONYX Player is used for preview.
461
462 {{code language="xml"}}
463 ...
464 <property name="system" value="preonyxeditor" />
465 <property name="previewAddress" value="http://pre.bps-system.de/onyx"/>
466 ...
467 {{/code}}
468
469 In this example is the ONYX Player used at URL [[http:~~/~~/pre.bps-system.de/onyx>>url:http://pre.bps-system.de/onyx||rel="nofollow" shape="rect" class="external free"]] . The serviceprovider name (used by ONYX Player) is: preonyxeditor
470
471 The connection to database example:
472
473 {{code language="xml"}}
474 <property name="dbDriverClass" value="org.postgresql.Driver" />
475 <property name="dbConnectionUrl" value="jdbc:postgresql://localhost:5432/dbname" />
476 <property name="dbUserName" value="username" />
477 <property name="dbPassword" value="userpassword" />
478 <property name="dbDialect" value="org.hibernate.dialect.PostgreSQLDialect" /> 
479 {{/code}}
480
481 **WEB-INF/classes/de/bps/onyx/context/webServiceContext.xml**
482
483 This file contains the configuration for the connection of the ONYX Player. This ONYX Player is used for statistic issues.
484
485 Example:
486
487 {{code language="xml"}}
488 ...
489 <bean id="OnyxReporterTarget" class="de.bps.onyx.manager.reporter.service.OnyxReporterTarget">
490 <constructor-arg name="target" value="https://onyx.bps-system.de/preview/reporterservices" />
491 </bean>
492
493 <bean id="OnyxReporterProvider" class="de.bps.onyx.manager.reporter.service.OnyxReporterProvider">
494 <constructor-arg name="id" value="previewid" />
495 </bean>
496 ...
497 {{/code}}
498
499 In this example is the ONYX Player used at URL [[https:~~/~~/onyx.bps-system.de/preview/ .>>url:https://onyx.bps-system.de/preview/.&nbsp||rel="nofollow" shape="rect" class="external text"]] The serviceprovider name (used by ONYX Player) is: previewed
500
501 === Update installation ===
502
503 **Start your Tomcat**
504
505 {{code language="powershell"}}
506 /opt/apache-tomcat-7.X.XX/bin/startup.sh
507 {{/code}}
508
509
510
511 **Open the following URL in your browser:**
512
513 [[http:~~/~~/localhost:8080/webeditor>>url:http://localhost:8080/webeditor||rel="nofollow" shape="rect" class="external free"]]
514
515 == create super user account ==
516
517 1. register a new user on homescreen.
518 1. connect to database and select the new user:  'select * from users;'
519 1. UPDATE users SET role=0 WHERE ID = XXX;
520 {{/layout-cell}}
521 {{/layout-section}}
522 {{/layout}}
523 {{/sv-translation}}