< Magazine />


Portal: Getting started

Thursday, February 17, 2011 by Carsten Hufe   Tags:  devproof   portal   installation   guide 

There are two possibilities to install Devproof Portal. Either download the binary distribution or clone it from Github and build it with Gradle. If you build it from Github you can get current development releases. Additionally you can run Devproof Portal with the Tomcat 7 distribution.

Run binary distribution with Apache Tomcat 7

1. Download Devproof Portal with Tomcat 7
2. Untar the downloaded archive

tar xzvf
devproof-portal-<version>-with-tomcat7.tar.gz
cd devproof-portal-<version>-with-tomcat7/apache-tomcat-<version>/bin/
# for linux users
./startup.sh
# for windows user
startup.bat

3. Open the browser and enter the URL: http://localhost:8080/

 

Note: The distribution with the Apache Tomcat 7 uses the H2 database which should not used in productive environments.

Installation from binary distribution

Requirements

  • Java 1.6 or higher
  • Servlet Container
  • MySQL database and connector
  • Tar (Windows user can use 7zip)

1. Download Devproof Portal - Standalone WAR
2. Untar the downloaded archive

tar xzvf
devproof-portal-<version>-war.tar.gz
cd devproof-portal-<version>-war

3. Create a MySQL database schema (e.g. devproof) and install the SQL script

mysql -u devproof -p devproof < sql/install_mysql.sql

4. Install the web application

 

Devproof Portal was tested under Apache Tomcat and Jetty application server, but should work with any other Servlet compliant container.

Furthermore you need the MySQL driver (Connector/J). I am not allowed to provide it with the application because it runs under GPL. If you use the Apache Tomcat you must copy the mysql-connector-java-5.x.x-bin.jar into the apache-tomcat-7.xx/lib or apache-tomcat-6.xx/common/lib folder. 

The next step is to create JNDI bindings:

java:/comp/env/jdbc/devproof/portal (database
connection, must be a javax.sql.DataSource)

and

java:/comp/env/mail/Session (mail session connection pool)

After that you can copy the war/devproof-portal-<version>.war file to the Apache Tomcats /webapp/ folder and start the server (/bin/startup.sh).

If you are not firm with JNDI configuration or you are to lazy to confgure it, you can use the bundled configuration from /config/tomcat7/mysql folder.

Copy the config/tomcat7/mysql/ROOT.xml to /apache-tomcat-x.xx/conf/Catalina/localhost/ROOT.xml. After that you must replace the bold strings with your connection settings and path to the WAR file:

<?xml version='1.0' encoding='utf-8'?>
<Context docBase="/path/to/devproof-portal.war">
	<!-- Default set of monitored resources -->
	<Resource name="jdbc/devproof/portal" auth="Container"
		type="javax.sql.DataSource" maxActive="100" maxIdle="10" maxWait="10000"
		removeAbandoned="true" removeAbandonedTimeout="300" logAbandoned="true"
		testWhileIdle="true" timeBetweenEvictionRunsMillis="3600000"
		validationQuery="Select 1" username="DB_USER" password="DB_PASSWD"
		driverClassName="com.mysql.jdbc.Driver"
		url="jdbc:mysql://localhost:3306/DB_SCHEMA?autoReconnect=true" />

	<Resource name="mail/Session" auth="Container" type="javax.mail.Session"
		mail.smtp.host="localhost" mail.smtp.auth="false"
		mail.transport.protocol="smtp" mail.smtp.port="25" />
</Context>

Now you can start the Apache Tomcat: /bin/startup.sh

Installation from Git or SVN

If you want to install a current development release, you can check out and build it.

Additional requirements are:

  • Git or SVN
  • Gradle (optional, can be bootstrapped)
# Git users do
git clone git://github.com/devproof/portal.git devproof

# SVN users do
svn checkout https://svn.github.com/devproof/portal/ devproof

After checking out, build it:

cd devproof
# for linux and cygwin user
./gradlew build dist
# for windows user
gradle.bat build dist

After building the portal, you will find the following files:

portal-bundle/build/dist/devproof-portal-<version>-war/war/devproof-portal-<version>.war
portal-bundle/build/dist/devproof-portal-<version>-war/sql/ (concatinated SQL files)

The SQL files are dynamically concatinated for the selected modules, so that you do not have any unnecessary SQL stuff.

The portal-bundle/build/dist/ folder contains the full bundled distributions as you can download it on Google Code. This includes the standalone WAR file and the fully bundled Tomcat 7 distribution.

Finally you can follow the "Installation from binary distribution" from step 3 at the top. The ROOT.xml is located under:

portal-bundle/config/tomcat7/mysql/ROOT.xml

 

 

© 2009-2011 - www.devproof.org