Install instructions

From GenosOrg

Jump to: navigation, search

This information refers to GMF version 1.3.1.


Contents

[edit] Requirements

Following servers are needed: 

- Mysql 5.x (with InnoDB storage support): http://www.mysql.com
- OpenLDAP: it can be download from http://www.openldap.org, or windows versions from http://download.bergmans.us/openldap/
- Tomcat 5.5: http://jakarta.apache.org/tomcat/index.html

Following components are also needed: 

- Mysql connector for Java v.3.0. It can be download from http://www.mysql.com/products/connector/j/ .
  The file mysql-connector-java-3.1.xx-bin.jar must be copied into $TOMCAT/common/lib
- Xalan.jar 2.7.x. It can be download from http://xml.apache.org/xalan-j/.
  The files xalan.jar and serializer.jar must be copied into $TOMCAT/common/lib
- Also activation.jar (from Sun JAF) and mail.jar (Sun JavaMail API) are needed in $TOMCAT/common/lib
- It seems that for Tomcat 5.5 you also need commons-collections-3.1.jar because it doesn't come with Tomcat anymore.
  You need to copy it into $TOMCAT/common/lib.

Following components are used by the application (they are already included in the distributed package): 

- XMLBeans: http://xmlbeans.apache.org
- Jasper Reports 1.1.1 http://jasperreports.sourceforge.net
- iReport: Reports are generated using iReport (http://ireport.sourceforge.net/)
- JFreeChart: http://sourceforge.net/projects/jfreechart
- Lucene: http://lucene.apache.org/ and support libraries for indexing files: poi, poi-scratchpad, PDFBox, tm-extractors
- Log4j: http://logging.apache.org/
- Quartz: http://www.opensymphony.com/quartz/
- JSCalendar, used to select dates: http://sourceforge.net/projects/jscalendar/

[edit] Installation

- Download latest GMFtgz file

- Copy the application 

- cd /usr/local/tomcat/webapps
- mkdir gmf
- cd gmf
- tar zxvf gmf-x.x war
- Tomcat5.5: cp WEB-INF/gmf.tomcat5.5.xml /usr/local/tomcat/conf/Catalina/localhost/gmf.xml
- edit gmf.xml to customize to your needs. It's important to set up a working database connection in this file.
- cd ..
- Be sure chown -R tomcat:tomcat gmf (change tomcat with the user tomcat is running as)
- If this is a clean installation, rename all gmf/WEB-INF/conf.dist to gmf/WEB-INF/conf
- edit gmf/WEB-INF/conf/gmf.conf
- edit gmf/WEB-INF/conf/log.properties
- Download mysql jdbc connector and cp mysql-connector-java-x.x.x.jar /usr/local/tomcat/common/lib
- Download xalan and cp xalan.jar /usr/local/tomcat/common/lib
- restart tomcat
- touch /var/log/gmf.log
- chown tomcat.tomcat /var/log/tomcat.log (tomcat user must have permissions to write to this file).

- Create the database: 

- edit WEB-INF/initapp.sql to correct your LDAP Server configuration
- Execute sql script: mysql --user=root < WEB-INF/initapp.sql
- You might also want to create an user with permissions over this database: 
       mysql --user=root
       >GRANT ALL ON gmf.* TO 'gmf'@'localhost' IDENTIFIED BY 'gmfpwd'
       You should edit the context definition (gmf.xml) accordingly.

- Initialize OpenLDAP 

- Get slapd.conf configured with correct basedn.
- edit gmf/WEB-INF/ldap1.ldif and ldap2.ldif to match real basedn
- load ldap1.ldif and ldap2.ldif with:
       ldapadd -x -D "cn=Manager,dc=<MY-DOMAIN>,dc=<COM>" -W -f ldap1.ldif
       ldapadd -x -D "cn=Manager,dc=<MY-DOMAIN>,dc=<COM>" -W -f ldap2.ldif

- Point your browser to http://server:8080/gmf/main, and login with user "admin", password "admin".

This is the only user after installing the application. You should change its password for security reasons.

[edit] Installation under Solaris 10

These are step by step instructions to install GMF under Solaris 10.

[edit] Installation as a portlet

It would be great to have someone wanting to try with other containers and write down some instructions for them (or at least, it would be great to know if it works or not). Anyone?

[edit] Problems

  • When executing a report I receive a "java.lang.InternalError: Can't connect to X11 window server using ':0.0' as the value of the DISPLAY variable." error. Run java with -Djava.awt.headless=true (adding it in catalina.sh, for example).
  • When working with large sets of resources I receive an OutOfMemoryError: first of all, try the Throughput Collector (parallel version of the young generation collector) adding -XX:+UseParallelGC parameter to JAVA_OPTS. This is generally good with GMF, even if you don't get OutOfMemoryError exceptions.
If this doesn't work, increase Tomcat heap size by adding a JAVA_OPTS=-Xmx1024m or a value that works for you.
If you're using Eclipse, add the option in Windows->Preferences->Tomcat->JVM Settings->JVM parameters.
Retrieved from "http://www.genos.org/index.php/Install_instructions"
Personal tools