Install Guide 135x5g

torotools.es Install Guide Version 2.0.1 – ir0011 – ird0010_en

1

Index 1 Overview....................................................................................................................................... 3 2 Installing torotools on JBoss ......................................................................................................... 3 Deploying EAR.............................................................................................................................. 3 Configuring JAAS.......................................................................................................................... 3 Properties file (optional)................................................................................................................ 3 Database (optional)....................................................................................................................... 4 3 Starting torotools .......................................................................................................................... 5 4 Appendix A: ed Third-Party Software................................................................................8 Database Management System.................................................................................................... 8 Database - Oracle (charset UTF-8)..........................................................................................8 Database - PostgreSQL (charset UTF-8) ................................................................................8 Application Server ........................................................................................................................ 8 Operating System.................................................................................................................... 8 Java Development Kit.............................................................................................................. 8 JBoss ...................................................................................................................................... 8 Web Browsers............................................................................................................................... 9 Recommended......................................................................................................................... 9 Others ed..................................................................................................................... 9 Web Browsers Mobile................................................................................................................... 9 Recommended......................................................................................................................... 9 5 Appendix B: JBoss Configuration................................................................................................ 10 6 Appendix C: Installing torotools with Oracle & PostgreSQL.........................................................11 Oracle..................................................................................................................................... 11 PostgreSQL ........................................................................................................................... 12 7 Appendix D: Known issues.......................................................................................................... 14 Jboss 6.1.0.Final.................................................................................................................... 14 Jboss 6.1.0.Final + atmosphere............................................................................................. 14

2

1

Overview

This document provides the instructions needed for installing torotools into JBoss Application Server.

2

Installing torotools on JBoss

Please follow the steps bellow. Make sure you already read the Appendix-A for third party software required. Please, also read the known issues appendix.

Deploying EAR •

Copy the BUDU_J2EE.ear file into JBOSS_HOME/server/default/deploy

Configuring JAAS torotools uses JAAS for authentication purposes. Of course, you can create and use your own JAAS module if needed, but torotools comes with a default JAAS module to configure security inside the product. To configure JAAS default module, open the file JBOSS_HOME/server/default/conf/config.xml and add the following lines: <-module code="es.torotools.jaas.ToroModule" flag="required"> <module-option name="debug">true -module>

Properties file (optional) All s stored in database are encrypted. For security reasons, the key-string for encryption is not stored on database, so you have to create a new file named JBOSS_HOME/bin/torotools.properties containing a key_string with the appropriate format, for instance:

KEY_STRING=190-145-238-77-134-55-123-201

3

The key_string listed is an example, modify it for your security. If you do not provide this key, a default value will be used, but please understand that once the server is installed, the key_string cannot be changed.

Database (optional) torotools includes a built-in HSQLDB (HyperSQL DataBase) database for testing purposes. For production environments, we highly recommend to configure torotools to use an external database. Please review Appendix C for instructions about configuring torotools with Oracle or PostgreSQL.

4

3

Starting torotools

Execute JBOSS_HOME\bin\run.sh -b 0.0.0.0 on Linux. Execute JBOSS_HOME/bin/run.bat -b 0.0.0.0 on Windows. (by default JBoss will only listen on the localhost network adapter. Starting JBoss with the -b 0.0.0.0 option will override this). Open a browser in the server where JBoss is installed and access the following URL: http://localhost:8080/torotools The following screen will appear:

Please, read the license (just an standard AGPL) and proceed with next step.

5

For some minutes the database will be installing. Please stand by and proceed to next step as soon as it gets to 100%

torotools needs a local directory for compilation and temporal data store purposes. If you don’t provide this information all that info will be stored inside JBOSS_HOME/bin, so we highly recommend to specify a separate directory in Work Directory field. Please also specify the url and port for that will be used for accessing the server in Server Address, for instance: http://yourcompany.org:8080

6

JBoss default port is 8080. If you have changed the default port, you should specify it here. Alter clicking on Save button, yourself as in the page:

using as name and as . If you need help on Server istration click in the PDF icon to the Server Guide in the Server istration Page. From now on you can access torotools in the following URL: http://yourcompany.org:8080/torotools both in computer or mobile Web Page. Please, help us: •

If you like our software, please give us good on sourceforge.

•

If you find any error, please notify it in the tickets section of sourceforge.

7

4

Appendix A: ed Third-Party Software

This section specify the software requirements for torotools

Database Management System Database - Oracle (charset UTF-8) •

Oracle 10.0.2 Enterprise and Standard Editions

•

Oracle JDBC Thin Driver 10g

Database - PostgreSQL (charset UTF-8) •

PostgreSQL 9.0

•

PostgreSQL JDBC Thin Driver

Application Server Operating System •

Linux (tested on Ubuntu 12)

•

Windows (tested on windows 10)

Java Development Kit •

Oracle Java 2 JDK 1.6.0_24. You can from:

http://www.oracle.com/technetwork/java/javase/s/java-archive-sjavase6-419409.html

JBoss •

JBoss Application Server 6.1.0.Final. You can from: http://jbossas.jboss.org/s

8

Web Browsers Recommended •

Google Chrome (tested on version 46.0.2490.86 m )

Others ed •

Firefox (tested on version 42.0)

•

Opera (tested on Version 33.0.1990.58 ) From version 1.4 onwards, only Chromium based Opera browsers will be ed.

•

Internet Explorer 11 (tested on 11.0.9600.17239)

(Note: Some features may be deactivated in some browsers)

Web Browsers Mobile Recommended •

Google Chrome (tested on version )

•

Safari (tested on IOS 9.1 )

9

5

Appendix B: JBoss Configuration

JVM options Ensure that JBOSS_HOME\bin\run.sh[.bat] specifies appropriate JVM memory settings in JAVA_OPTS. For example, the following are minimums: set JAVA_OPTS=%JAVA_OPTS% -Xnoclassgc -Xms512m -Xmx1024m -XX:NewSize=340m -XX:MaxNewSize=340m -XX:MaxPermSize=256m

10

6

Appendix C: Installing torotools with Oracle & PostgreSQL

As explained, torotools can work with two different DMS (Oracle and PostgreSQL). At any case, you should request to your database a database for torotools.

Oracle If you select Oracle as database server, please proceed with the following instructions: •

Request the correct JDBC driver file to your database .

•

Copy Oracle JDBC driver file to JBOSS_HOME/server/default/lib

•

Create a datasource by creating the file on the following path JBOSS_HOME/server/default/deploy/budu-ds.xml with the following content:

<jndi-name>ToroToolsDS jdbc:oracle:thin:@address:port:SID oracle.jdbc.driver.OracleDriver <-name>name <> <min-pool-size>50 <max-pool-size>150 <metadata> Oracle9i

where name, and connection-url are the name, and database connection of the database that should be provided by your database . An example of database connection for Oracle is

11

jdbc:oracle:thin:@192.168.2.104:1521:TOROTOOLS

Please understand, the connection listed is an example, modify it with the data provided by your database .

PostgreSQL If you select PostgreSQL as database server, please proceed with the following instructions: •

the JDBC driver file (postgresql-9.2-1002.jdbc4.jar) from PostgeSQL

•

Copy PostgeSQL JDBC driver file to JBOSS_HOME/server/default/lib

•

Create a datasource by creating the file on the following path JBOSS_HOME/server/default/deploy/budu-ds.xml with the following content:

<jndi-name>ToroToolsDS connection-url org.postgresql.Driver <-name>name <> <min-pool-size>50 <max-pool-size>150 <metadata> PostgreSQL 9.0

where name, and connection-url are the name, and database connection of the database that should be provided by your database . An example of database conection for PostgreSQL is

12

jdbc:postgresql://192.168.2.104/TOROTOOLS

Please understand, the connection listed is an example, modify it with the data provided by your database .

13

7

Appendix D: Known issues

There are some known issues regarding Jboss Server that are easily solved. We are currently working hard to rotools to a more modern Application Server using EE 7 (target release 3.0). On the meanwhile, please follow this instructions.

Jboss 6.1.0.Final There are some problems when you install Jboss AS in a path containing a blank space. To avoid this error, just install JBoss in the root folder, for instance, install Jboss AS on the following path: C:\jboss-6.1.0.Final or \opt\jboss-6.1.0.Final If that is the case, torotools wont start and the following error will appear:

ERROR [ProfileServiceBootstrap] (Thread-2) Failed to load profile:: org.jboss.deployers.client.spi.IncompleteDeploymentException: Summary of incomplete deployments (SEE PREVIOUS ERRORS FOR DETAILS): DEPLOYMENTS IN ERROR: Deployment "vfs:///C:/jboss-6.1.0.Fi%20%20nal/server/default/deploy/BUDU_J2EE.ear" is in error due to the following reason(s): java.net.URISyntaxException: Illegal character in path at index 23: … and more ...

Jboss 6.1.0.Final + atmosphere When starting torotools server, atmosphere will try to use comet (not ed on Jboss AS) and an error will be displayed. Please, ignore it. ERROR o.a.container.JBossWebComet - HttpEvent is null, JBoss APR Not Properly installed INFORMACIÓN [STDOUT] (http-0.0.0.0-8080-7) 20:12:17.102 [http-0.0.0.0-8080-7] ERROR o.atmosphere.r.AtmosphereFramework - If you have more than one Connector enabled, make sure they both use the same protocol, e.g NIO/APR or HTTP for all. If not, org.atmosphere.container.BlockingIOComet will be used and cannot be changed. INFORMACIÓN [STDOUT] (http-0.0.0.0-8080-7) java.lang.IllegalStateException: JBoss failed to detect this is a Comet application because the APR Connector is not enabled. INFORMACIÓN [STDOUT] (http-0.0.0.0-8080-7) Make sure atmosphere-compat-jboss.jar is not under your WEB-INF/lib and You must use the atmosphere-native-runtime dependency in order to use native Comet INFORMACIÓN [STDOUT] (http-0.0.0.0-8080-7) there is no context.xml under WEB-INF

14